Compare commits
19
Commits
No files matched your search
@@ -33,9 +33,6 @@ body:
|
||||
options:
|
||||
# The below comment is used to insert a new version with on-release.yml
|
||||
#NEXT_VERSION#
|
||||
- 1.57.1
|
||||
- 1.57.0
|
||||
- 1.56.1
|
||||
- 1.56.0
|
||||
- 1.55.0
|
||||
- 1.54.0
|
||||
|
||||
@@ -15,11 +15,11 @@ runs:
|
||||
with:
|
||||
persist-credentials: false
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build docker image for ${{ inputs.architecture }}
|
||||
id: build
|
||||
uses: docker/build-push-action@v7
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
push: false
|
||||
load: true
|
||||
|
||||
@@ -31,12 +31,6 @@
|
||||
automerge: false,
|
||||
},
|
||||
],
|
||||
// Updates lockfile for prebuilt-debian after if package.json is updated, otherwise only root lockfile is updated
|
||||
postUpgradeTasks: {
|
||||
commands: ["cd deployments/prebuilt-debian && pnpm install --ignore-workspace --lockfile-only"],
|
||||
fileFilters: ["deployments/prebuilt-debian/pnpm-lock.yaml"],
|
||||
executionMode: "update",
|
||||
},
|
||||
updateInternalDeps: true,
|
||||
rangeStrategy: "bump",
|
||||
automerge: false,
|
||||
|
||||
@@ -15,7 +15,7 @@ jobs:
|
||||
uses: actions/checkout@v6
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
|
||||
|
||||
@@ -89,7 +89,7 @@ jobs:
|
||||
uses: ./tooling/github/setup
|
||||
- name: Build docker image
|
||||
id: build-docker-image
|
||||
uses: docker/build-push-action@v7
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
platforms: linux/amd64
|
||||
context: .
|
||||
|
||||
@@ -19,7 +19,7 @@ jobs:
|
||||
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.CROWDIN_APP_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.CROWDIN_APP_ID }}
|
||||
|
||||
@@ -50,7 +50,7 @@ jobs:
|
||||
- name: Obtain token
|
||||
if: env.SKIP_RELEASE == 'false'
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
|
||||
@@ -60,12 +60,12 @@ jobs:
|
||||
if: env.SKIP_RELEASE == 'false'
|
||||
with:
|
||||
persist-credentials: false
|
||||
- uses: pnpm/action-setup@v5
|
||||
- uses: pnpm/action-setup@v4
|
||||
if: env.SKIP_RELEASE == 'false'
|
||||
- uses: actions/setup-node@v6
|
||||
if: env.SKIP_RELEASE == 'false'
|
||||
with:
|
||||
node-version: 24.14.1
|
||||
node-version: 24.14.0
|
||||
cache: "pnpm"
|
||||
- run: npm i -g pnpm
|
||||
if: env.SKIP_RELEASE == 'false'
|
||||
@@ -123,7 +123,7 @@ jobs:
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v6
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: "${{ env.GHCR_REPO }}"
|
||||
|
||||
@@ -135,11 +135,11 @@ jobs:
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build and push by digest
|
||||
id: build
|
||||
uses: docker/build-push-action@v7
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
network: host
|
||||
@@ -162,7 +162,7 @@ jobs:
|
||||
|
||||
- name: Docker meta
|
||||
id: meta
|
||||
uses: docker/metadata-action@v6
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: "${{ env.GHCR_REPO }}"
|
||||
|
||||
@@ -174,11 +174,11 @@ jobs:
|
||||
password: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v4
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build and push by digest
|
||||
id: build
|
||||
uses: docker/build-push-action@v7
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: .
|
||||
network: host
|
||||
@@ -231,7 +231,7 @@ jobs:
|
||||
- name: Obtain token
|
||||
if: needs.release.outputs.skipped == 'false'
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
|
||||
|
||||
@@ -50,7 +50,7 @@ jobs:
|
||||
args: "Created a release PR ${{ steps.create-pull-request.outputs.url }} for version ${{ steps.semver.outputs.next }} (new behaviour: ${{ steps.semver.outputs.bump }})"
|
||||
- name: Obtain token
|
||||
id: obtainApprovalToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_APPROVE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_APPROVE_APP_ID }}
|
||||
@@ -62,7 +62,7 @@ jobs:
|
||||
gh pr review --approve --body "Automatically approved by GitHub Action"
|
||||
- name: Obtain token
|
||||
id: obtainMergeToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
|
||||
|
||||
@@ -12,7 +12,7 @@ jobs:
|
||||
steps:
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.HOMARR_DOCS_RELEASE_APP_PRIVATE_KEY }}
|
||||
app-id: ${{ vars.HOMARR_DOCS_RELEASE_APP_ID }}
|
||||
@@ -45,7 +45,7 @@ jobs:
|
||||
steps:
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.RENOVATE_MERGE_PRIVATE_KEY }}
|
||||
app-id: ${{ secrets.RENOVATE_MERGE_APP_ID }}
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
steps:
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
|
||||
app-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
|
||||
@@ -33,7 +33,7 @@ jobs:
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ steps.obtainToken.outputs.token }}
|
||||
|
||||
- uses: pnpm/action-setup@v5
|
||||
- uses: pnpm/action-setup@v4
|
||||
- name: Use Node.js ${{ matrix.node-version }}
|
||||
uses: actions/setup-node@v6
|
||||
with:
|
||||
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
steps:
|
||||
- name: Obtain token
|
||||
id: obtainToken
|
||||
uses: actions/create-github-app-token@v3
|
||||
uses: actions/create-github-app-token@v2
|
||||
with:
|
||||
private-key: ${{ secrets.HOMARR_UPDATE_CONTRIBUTORS_PRIVATE_KEY }}
|
||||
app-id: ${{ vars.HOMARR_UPDATE_CONTRIBUTORS_APP_ID }}
|
||||
|
||||
+5
-1
@@ -57,6 +57,7 @@ apps/tasks/tasks.cjs
|
||||
apps/tasks/tasks.css
|
||||
apps/websocket/wssServer.cjs
|
||||
apps/websocket/wssServer.css
|
||||
apps/nextjs/customServer.cjs
|
||||
apps/nextjs/.million/
|
||||
packages/cli/cli.cjs
|
||||
|
||||
@@ -67,4 +68,7 @@ e2e/shared/tmp
|
||||
apps/nextjs/public/images/background.png
|
||||
|
||||
# next-intl
|
||||
en.d.json.ts
|
||||
en.d.json.ts
|
||||
|
||||
# Custom server build artifacts
|
||||
apps/nextjs/customServer.css
|
||||
+369
@@ -0,0 +1,369 @@
|
||||
# Memory Optimization Approaches
|
||||
|
||||
This document describes the approaches tried and considered for reducing the RAM footprint of Homarr's server processes.
|
||||
|
||||
## Baseline Architecture (Before)
|
||||
|
||||
Homarr runs **three separate Node.js processes**:
|
||||
|
||||
| Process | Port | Purpose |
|
||||
|---|---|---|
|
||||
| `apps/nextjs` (Next.js) | 3000 | Web UI + API routes |
|
||||
| `apps/websocket` (WS server) | 3001 | tRPC WebSocket subscriptions |
|
||||
| `apps/tasks` (Tasks/Cron server) | 3002 | Cron job scheduling + management API |
|
||||
|
||||
Each process loads its own V8 heap, duplicates shared dependencies (`@homarr/db`, `@homarr/auth`, etc.), and runs its own event loop.
|
||||
|
||||
**Measured baseline (dev mode, idle):** ~2,954 MB total RSS
|
||||
|
||||
---
|
||||
|
||||
## Approach 1: Integrate WebSocket Server into Next.js Custom Server
|
||||
|
||||
**Status:** ✅ Implemented
|
||||
|
||||
Eliminates `apps/websocket` by handling WebSocket upgrades inside a [Next.js custom server](https://nextjs.org/docs/pages/guides/custom-server):
|
||||
|
||||
```ts
|
||||
const app = next({ dev, hostname, port, dir });
|
||||
const upgradeHandler = app.getUpgradeHandler();
|
||||
|
||||
server.on("upgrade", (req, socket, head) => {
|
||||
if (req.url?.startsWith("/websockets")) {
|
||||
wss.handleUpgrade(req, socket, head, (ws) => wss.emit("connection", ws, req));
|
||||
} else {
|
||||
upgradeHandler(req, socket, head); // HMR, etc.
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### PROs
|
||||
- Eliminates one V8 heap (~208 MB)
|
||||
- WebSocket runs on same port as HTTP (simpler networking/proxying)
|
||||
- Shared `@homarr/db` connection pool and module cache
|
||||
- `getUpgradeHandler()` properly delegates HMR to Next.js in dev mode
|
||||
|
||||
### CONs
|
||||
- Custom server disables some Next.js optimizations (automatic static optimization still works with `output: "standalone"`)
|
||||
- WebSocket errors could affect the main server process
|
||||
- Slightly more complex startup code
|
||||
|
||||
---
|
||||
|
||||
## Approach 2: Integrate Tasks/Cron Server into Next.js Custom Server
|
||||
|
||||
**Status:** ✅ Implemented (combined with Approach 1)
|
||||
|
||||
Eliminates `apps/tasks` by running the Fastify tRPC cron API and job scheduler inside the same process:
|
||||
|
||||
```ts
|
||||
async function startTasksServer() {
|
||||
const tasksServer = fastify({ maxParamLength: 5000 });
|
||||
tasksServer.register(fastifyTRPCPlugin, { ... });
|
||||
await cleanupSessionsAsync();
|
||||
await invalidateUpdateCheckerCacheAsync();
|
||||
await jobGroup.initializeAsync();
|
||||
await jobGroup.startAllAsync();
|
||||
await tasksServer.listen({ port: CRON_JOB_API_PORT });
|
||||
return tasksServer;
|
||||
}
|
||||
```
|
||||
|
||||
### PROs
|
||||
- Eliminates another V8 heap (~328 MB)
|
||||
- Shared database connection pool across Next.js API routes and cron jobs
|
||||
- Single process to manage (simpler Docker, `run.sh`, monitoring)
|
||||
- Cron jobs can directly share in-memory state with the web server
|
||||
|
||||
### CONs
|
||||
- A misbehaving cron job could affect web request latency
|
||||
- Fastify still binds to port 3002 for internal tRPC communication (minor overhead)
|
||||
- More dependencies in the custom server bundle
|
||||
|
||||
---
|
||||
|
||||
## Combined Result (Approaches 1 + 2)
|
||||
|
||||
| Component | Separate (before) | Integrated (after) |
|
||||
|---|---|---|
|
||||
| WebSocket server | ~208 MB | — |
|
||||
| Tasks/Cron server | ~328 MB | — |
|
||||
| Next.js (incl. workers) | ~2,418 MB | — |
|
||||
| Custom Server (all-in-one) | — | ~2,007 MB |
|
||||
| **Total RSS** | **~2,954 MB** | **~2,007 MB** |
|
||||
| **Savings** | — | **~947 MB (~32%)** |
|
||||
|
||||
---
|
||||
|
||||
## Approach 3: Eliminate Fastify — Direct Function Calls for Cron API
|
||||
|
||||
**Status:** 📋 Considered, not implemented
|
||||
|
||||
Since the cron job API client (`cronJobApi`) is only used from Next.js API routes (same process now), we could replace the HTTP+tRPC client with direct function calls to `JobManager`:
|
||||
|
||||
```ts
|
||||
// Before: HTTP call to localhost:3002/trpc
|
||||
await cronJobApi.trigger.mutate({ name: "myJob" });
|
||||
|
||||
// After: direct call in same process
|
||||
await jobManager.triggerAsync("myJob");
|
||||
```
|
||||
|
||||
### PROs
|
||||
- Eliminates Fastify dependency and port 3002 listener entirely
|
||||
- Zero network overhead for cron API calls
|
||||
- Simpler architecture (no internal HTTP, no API key needed)
|
||||
|
||||
### CONs
|
||||
- Requires refactoring `packages/api/src/router/cron-jobs.ts` and `packages/cron-job-api`
|
||||
- Breaks the clean separation between Next.js API and tasks concerns
|
||||
- If the architecture ever splits back to separate processes, this would need to be reverted
|
||||
- API key authentication for cron operations would need a different mechanism
|
||||
|
||||
---
|
||||
|
||||
## Approach 4: Node.js `--max-old-space-size` Flag
|
||||
|
||||
**Status:** 📋 Considered, available as user override
|
||||
|
||||
Setting `NODE_OPTIONS=--max-old-space-size=N` limits V8 heap growth and forces more aggressive garbage collection.
|
||||
|
||||
```dockerfile
|
||||
# Example: limit heap to 512 MB
|
||||
ENV NODE_OPTIONS="--max-old-space-size=512"
|
||||
```
|
||||
|
||||
### PROs
|
||||
- Can reduce peak memory usage in constrained environments
|
||||
- Easy to configure via environment variable
|
||||
- No code changes required
|
||||
|
||||
### CONs
|
||||
- Too low a value causes OOM crashes under load
|
||||
- Doesn't reduce actual memory *needed*, just forces earlier GC
|
||||
- Default Node.js behavior (~1.7 GB limit on 64-bit) is reasonable for most deployments
|
||||
- Different deployments have different memory constraints — no single good default
|
||||
|
||||
**Recommendation:** Don't set a default in the Dockerfile. Document as a tuning option for users running on low-memory hosts (e.g., `docker run -e NODE_OPTIONS="--max-old-space-size=512"`).
|
||||
|
||||
---
|
||||
|
||||
## Approach 5: Next.js `output: "standalone"` (Already in Use)
|
||||
|
||||
**Status:** ✅ Already configured
|
||||
|
||||
The `next.config.ts` already uses `output: "standalone"`, which:
|
||||
- Traces only the files needed for production
|
||||
- Creates a minimal `.next/standalone` directory
|
||||
- Avoids shipping full `node_modules`
|
||||
|
||||
This is already optimized and no further action needed.
|
||||
|
||||
---
|
||||
|
||||
## Approach 6: Shared Redis Connection Pooling
|
||||
|
||||
**Status:** 📋 Considered, not implemented
|
||||
|
||||
With all services in one process, Redis connection pools could be shared. Currently, each module may create its own Redis client instance.
|
||||
|
||||
### PROs
|
||||
- Fewer open connections to Redis
|
||||
- Slightly less memory for connection buffers
|
||||
|
||||
### CONs
|
||||
- Marginal memory savings (Redis connections are lightweight)
|
||||
- Requires auditing all Redis usage across packages
|
||||
- Risk of connection contention under high load
|
||||
|
||||
---
|
||||
|
||||
## Summary of Recommendations
|
||||
|
||||
| Approach | Impact | Effort | Status |
|
||||
|---|---|---|---|
|
||||
| 1. Integrate WS server | ~208 MB saved | Low | ✅ Done |
|
||||
| 2. Integrate Tasks server | ~328 MB saved | Medium | ✅ Done |
|
||||
| 3. Eliminate Fastify | ~10-30 MB saved | High | 📋 Future |
|
||||
| 4. `--max-old-space-size` | Configurable | None | 📋 User option |
|
||||
| 5. Standalone output | Already optimal | None | ✅ Already done |
|
||||
| 6. Shared Redis pools | ~5-10 MB saved | Medium | 📋 Future |
|
||||
| 7. Redis-backed initial query data | Faster page loads | Medium | 📋 POC documented |
|
||||
| 8. Client-side rendering with ISR shell | Faster TTFB | High | 📋 POC documented |
|
||||
|
||||
---
|
||||
|
||||
## Approach 7: Redis-Backed TanStack Query Initial Data
|
||||
|
||||
**Status:** 📋 POC documented
|
||||
|
||||
### Problem
|
||||
|
||||
Currently, the dashboard page (`/`) is fully server-rendered on every request:
|
||||
|
||||
1. Server calls `api.board.getHomeBoard()` (database query)
|
||||
2. Server prefetches all widget data via `prefetchForKindAsync()` (multiple database/integration queries)
|
||||
3. Server renders the full React tree with hydration boundary
|
||||
4. Client hydrates and takes over
|
||||
|
||||
Each page load triggers a cascade: **Client → Next.js Server → tRPC → Database → Back**. For data that doesn't change often (board layout, widget configurations), this is wasteful.
|
||||
|
||||
### Approach
|
||||
|
||||
Use Redis as a shared cache layer between cron jobs and page loads. Cron jobs already populate Redis with integration data. The idea is to:
|
||||
|
||||
1. **Cron jobs write to Redis** (already happening via `createItemAndIntegrationChannel`)
|
||||
2. **Server reads from Redis first** instead of hitting the database for widget data
|
||||
3. **Pass Redis data as `initialData`** to TanStack Query on the client
|
||||
4. **Client-side queries take over** with stale-while-revalidate behavior
|
||||
|
||||
```tsx
|
||||
// POC: In _creator.tsx, read from Redis cache first for widget prefetching
|
||||
import { createItemAndIntegrationChannel } from "@homarr/redis";
|
||||
|
||||
// Instead of always calling the database:
|
||||
const cachedData = await redisChannel.getAsync();
|
||||
if (cachedData) {
|
||||
// Use cached data as initial query data - skip the database call
|
||||
queryClient.setQueryData(queryKey, cachedData.data);
|
||||
} else {
|
||||
// Fall back to normal prefetch
|
||||
await prefetchForKindAsync(kind, queryClient, items);
|
||||
}
|
||||
```
|
||||
|
||||
On the client side, TanStack Query's `initialData` option lets us hydrate from cache:
|
||||
|
||||
```tsx
|
||||
// Client component using cached initial data
|
||||
const { data } = useQuery({
|
||||
queryKey: ["widget", widgetId],
|
||||
queryFn: () => fetchWidgetData(widgetId),
|
||||
initialData: cachedWidgetData, // From Redis via server props
|
||||
staleTime: 30_000, // Consider fresh for 30s
|
||||
});
|
||||
```
|
||||
|
||||
### How TanStack Query Initial Data Works
|
||||
|
||||
From the [TanStack Query docs](https://tanstack.com/query/v5/docs/framework/react/guides/initial-query-data):
|
||||
|
||||
- `initialData` pre-populates the query cache before the component mounts
|
||||
- The query still revalidates in the background (stale-while-revalidate)
|
||||
- Combined with `staleTime`, the query won't refetch until the data is considered stale
|
||||
- This means the page renders instantly with cached data, then silently updates
|
||||
|
||||
### PROs
|
||||
- **Faster page loads**: Redis reads are ~1ms vs ~50-200ms for database queries with joins
|
||||
- **Reduced database load**: Most page views hit Redis instead of SQLite/MySQL/PostgreSQL
|
||||
- **Leverages existing infrastructure**: Cron jobs already write widget data to Redis channels
|
||||
- **Graceful degradation**: Falls back to normal database queries on cache miss
|
||||
- **Non-breaking**: Can be adopted incrementally per widget type
|
||||
- **Shared across users**: Non-personal data (board layout, widget data) is the same for all users viewing the same board
|
||||
|
||||
### CONs
|
||||
- **Cache staleness**: Data may be up to one cron interval old (typically 1-5 minutes)
|
||||
- **Cache invalidation complexity**: Need to invalidate Redis when boards are edited
|
||||
- **Memory usage**: More data stored in Redis (marginal since it's already stored for pub/sub)
|
||||
- **Serialization overhead**: superjson parse/stringify on every cache read
|
||||
- **Testing complexity**: Need to test cache hit/miss/stale scenarios
|
||||
|
||||
### Estimated Impact
|
||||
|
||||
| Metric | Before | After (cache hit) | Improvement |
|
||||
|---|---|---|---|
|
||||
| Dashboard TTFB | ~200-500ms | ~50-100ms | 2-5x faster |
|
||||
| Database queries per page load | 5-20 (depending on widgets) | 0-2 (board + auth only) | ~90% reduction |
|
||||
| Redis reads per page load | 0 | 5-20 | Acceptable (~1ms each) |
|
||||
|
||||
### Implementation Path
|
||||
|
||||
1. Create a `createBoardCacheChannel(boardId)` in `@homarr/redis`
|
||||
2. Populate it when boards are saved and when cron jobs update widget data
|
||||
3. In `_creator.tsx`, check cache before `prefetchForKindAsync()`
|
||||
4. Set `staleTime` to match cron interval for each widget type
|
||||
5. Add cache invalidation when boards are edited (`board.saveBoard` mutation)
|
||||
|
||||
---
|
||||
|
||||
## Approach 8: Client-Side Rendering with ISR Static Shell
|
||||
|
||||
**Status:** 📋 POC documented (not recommended for Homarr's use case)
|
||||
|
||||
### Concept
|
||||
|
||||
Instead of server-rendering the entire dashboard on each request, serve a **static HTML shell** via Next.js ISR (Incremental Static Regeneration) and let the client fetch all dynamic content via TanStack Query.
|
||||
|
||||
```tsx
|
||||
// Hypothetical ISR dashboard page
|
||||
export const revalidate = 60; // Regenerate every 60 seconds
|
||||
|
||||
export default function DashboardPage() {
|
||||
// Return a static shell - no server-side data fetching
|
||||
return (
|
||||
<DashboardShell>
|
||||
<Suspense fallback={<BoardSkeleton />}>
|
||||
<ClientBoard /> {/* Fetches via useQuery on mount */}
|
||||
</Suspense>
|
||||
</DashboardShell>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
The client component would then fetch everything:
|
||||
|
||||
```tsx
|
||||
"use client";
|
||||
|
||||
function ClientBoard() {
|
||||
const { data: board, isLoading } = clientApi.board.getHomeBoard.useQuery(undefined, {
|
||||
initialData: undefined, // Could be populated from Redis via API route
|
||||
});
|
||||
|
||||
if (isLoading) return <BoardSkeleton />;
|
||||
return <BoardContent board={board} />;
|
||||
}
|
||||
```
|
||||
|
||||
### How Next.js ISR Works
|
||||
|
||||
- On first request, Next.js generates the page and caches it
|
||||
- Subsequent requests serve the cached HTML instantly (TTFB ~0ms for CDN)
|
||||
- After `revalidate` seconds, the next request triggers background regeneration
|
||||
- The stale page is served until the new one is ready (stale-while-revalidate)
|
||||
|
||||
### PROs
|
||||
- **Near-instant TTFB**: Static HTML served from disk/CDN cache
|
||||
- **Reduced server CPU**: No React SSR on every request
|
||||
- **Scalable**: Static pages can be served by any CDN or reverse proxy
|
||||
- **Good for public boards**: Shared boards viewed by many users benefit most
|
||||
|
||||
### CONs
|
||||
- **Layout shift (CLS)**: Dashboard appears empty then fills in — bad UX for dashboards
|
||||
- **No SSR for SEO**: Not relevant for Homarr (it's a private dashboard app)
|
||||
- **Slower perceived load**: Users see a skeleton for 200-500ms while queries run
|
||||
- **Authentication complexity**: ISR pages must be the same for all users. Homarr's dashboard is user-specific (permissions, board access), making ISR caching ineffective for the page itself
|
||||
- **Breaks existing hydration pattern**: The current `HydrationBoundary` + `dehydrate()` pattern works well and ensures no layout shift
|
||||
- **WebSocket subscriptions delayed**: Real-time updates don't start until client JS loads and connects
|
||||
|
||||
### Benchmark Comparison (Theoretical)
|
||||
|
||||
| Metric | Current (SSR) | Approach 7 (Redis initial data) | Approach 8 (ISR + CSR) |
|
||||
|---|---|---|---|
|
||||
| TTFB | 200-500ms | 50-100ms | ~10ms (static) |
|
||||
| Time to Interactive | 200-500ms | 50-100ms | 200-500ms (same) |
|
||||
| Largest Contentful Paint | 200-500ms | 50-100ms | 400-800ms (worse) |
|
||||
| Cumulative Layout Shift | ~0 | ~0 | 0.1-0.3 (worse) |
|
||||
| Server CPU per request | High | Low | Near zero |
|
||||
|
||||
### Recommendation
|
||||
|
||||
**Approach 7 (Redis-backed initial data) is recommended over Approach 8 (ISR)** for Homarr because:
|
||||
|
||||
1. **Dashboards are personalized**: Board access depends on user permissions, making ISR page-level caching ineffective
|
||||
2. **No layout shift**: Users expect the dashboard to appear fully rendered
|
||||
3. **Existing infrastructure**: Redis + cron jobs already provide the cache layer needed
|
||||
4. **Incremental adoption**: Can be applied per-widget without changing the overall rendering strategy
|
||||
5. **ISR is designed for content sites**: Blog posts, documentation pages, product pages — not interactive dashboards with real-time WebSocket subscriptions
|
||||
|
||||
ISR could still be useful for specific Homarr pages like `/manage/about` or documentation pages that don't depend on user state, but the main dashboard is not a good candidate.
|
||||
-112
@@ -1,115 +1,3 @@
|
||||
## [1.58.0](https://github.com/homarr-labs/homarr/compare/v1.57.1...v1.58.0) (2026-04-03)
|
||||
|
||||
### Features
|
||||
|
||||
* **integrations:** add search.ch integration with timetable widget ([#5180](https://github.com/homarr-labs/homarr/issues/5180)) ([abb2dfc](https://github.com/homarr-labs/homarr/commit/abb2dfc92ab51b16e7172374cfee8b9c0c752454))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **boards:** unable to click on links at settings page ([#5230](https://github.com/homarr-labs/homarr/issues/5230)) ([6a200c3](https://github.com/homarr-labs/homarr/commit/6a200c39afaa1a9a1057643612065a40ad1cdd82))
|
||||
* **deps:** update dependency @ctrl/deluge to ^7.5.3 ([#5365](https://github.com/homarr-labs/homarr/issues/5365)) ([9c134c5](https://github.com/homarr-labs/homarr/commit/9c134c5ceb742b21b021ef3b49de8cc0d526d460))
|
||||
* **deps:** update dependency @ctrl/deluge to v8 ([#5367](https://github.com/homarr-labs/homarr/issues/5367)) ([e88e3d1](https://github.com/homarr-labs/homarr/commit/e88e3d17c01dab8836bec11d2ac01195f06cdc2e))
|
||||
* **deps:** update dependency @immich/sdk to ^2.6.2 ([#5370](https://github.com/homarr-labs/homarr/issues/5370)) ([4a5bafa](https://github.com/homarr-labs/homarr/commit/4a5bafa79092b209e94a56f72362011f416bf115))
|
||||
* **deps:** update dependency @immich/sdk to ^2.6.3 ([#5380](https://github.com/homarr-labs/homarr/issues/5380)) ([2dd3c90](https://github.com/homarr-labs/homarr/commit/2dd3c906c4215b55e23f4b15ba4b423e23be8376))
|
||||
* **deps:** update dependency @tabler/icons-react to ^3.41.0 ([#5384](https://github.com/homarr-labs/homarr/issues/5384)) ([a9bcc9d](https://github.com/homarr-labs/homarr/commit/a9bcc9d04bdfcf28ea561cd590ca2a4bd775593c))
|
||||
* **deps:** update dependency better-sqlite3 to ^12.8.0 ([#5266](https://github.com/homarr-labs/homarr/issues/5266)) ([46db8b6](https://github.com/homarr-labs/homarr/commit/46db8b6ab32406fb4ff7a7a9938692954778a070))
|
||||
* **deps:** update dependency drizzle-orm to ^0.45.2 ([#5388](https://github.com/homarr-labs/homarr/issues/5388)) ([0a78e3f](https://github.com/homarr-labs/homarr/commit/0a78e3f12aa99509f42d7af647a478c5abaf5c96))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.9 ([#5359](https://github.com/homarr-labs/homarr/issues/5359)) ([189806b](https://github.com/homarr-labs/homarr/commit/189806b5a2b8e67f925cc8def6bc8ddefdc5bfc4))
|
||||
* **deps:** update dependency fastify to ^5.8.4 ([#5351](https://github.com/homarr-labs/homarr/issues/5351)) ([728f7e4](https://github.com/homarr-labs/homarr/commit/728f7e489aa499bcd7e97c7ec8571e29e7e2cab3))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.7.0 ([#5366](https://github.com/homarr-labs/homarr/issues/5366)) ([c2b54dd](https://github.com/homarr-labs/homarr/commit/c2b54ddfaab93daa4e65c0c38bf5c27e4402a492))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.7.1 ([#5369](https://github.com/homarr-labs/homarr/issues/5369)) ([8d1ff40](https://github.com/homarr-labs/homarr/commit/8d1ff4065d669268f0e6a03f2b68c1ba728a756a))
|
||||
* **deps:** update dependency jotai to ^2.19.0 ([#5368](https://github.com/homarr-labs/homarr/issues/5368)) ([14d8717](https://github.com/homarr-labs/homarr/commit/14d87178b5a93bdc6fb74793feed95d014814d0b))
|
||||
* **deps:** update dependency node-ical to ^0.23.1 - abandoned ([#4856](https://github.com/homarr-labs/homarr/issues/4856)) ([b07c545](https://github.com/homarr-labs/homarr/commit/b07c545f17f4dafa62167047baa9eed4b7ee4395))
|
||||
* **deps:** update dependency typescript-eslint to ^8.57.2 ([#5360](https://github.com/homarr-labs/homarr/issues/5360)) ([cefbf0e](https://github.com/homarr-labs/homarr/commit/cefbf0e2715e9adbc72cdb0b83d84c309e3257d6))
|
||||
* **deps:** update dependency undici to v7.24.6 ([#5374](https://github.com/homarr-labs/homarr/issues/5374)) ([4f2cc9a](https://github.com/homarr-labs/homarr/commit/4f2cc9af2a42e19624def3bdea60fcb00334c483))
|
||||
* **deps:** update dependency zod to ^4.3.5 - abandoned ([#4803](https://github.com/homarr-labs/homarr/issues/4803)) ([2b4c83d](https://github.com/homarr-labs/homarr/commit/2b4c83dccac168ffa6f9b6e184ed004659373cf7))
|
||||
* **deps:** update dependency zod to ^4.3.6 ([#5376](https://github.com/homarr-labs/homarr/issues/5376)) ([a9582f0](https://github.com/homarr-labs/homarr/commit/a9582f04edb0e161d1fab6e64b13d0ce463ef341))
|
||||
* **deps:** update tanstack-query monorepo to ^5.95.0 ([#5325](https://github.com/homarr-labs/homarr/issues/5325)) ([b11bf36](https://github.com/homarr-labs/homarr/commit/b11bf367d0567e4c8b9068804442ebd200dab01c))
|
||||
* **deps:** update tanstack-query monorepo to ^5.95.1 ([#5355](https://github.com/homarr-labs/homarr/issues/5355)) ([332b6b4](https://github.com/homarr-labs/homarr/commit/332b6b4f42e7c90570cd4c25a6e6a331a76c660f))
|
||||
* **deps:** update tanstack-query monorepo to ^5.95.2 ([#5357](https://github.com/homarr-labs/homarr/issues/5357)) ([6820991](https://github.com/homarr-labs/homarr/commit/682099189b689ea17e16af41fd280a72ed68016f))
|
||||
* **deps:** update tiptap monorepo to v3.20.5 ([#5371](https://github.com/homarr-labs/homarr/issues/5371)) ([6820f8a](https://github.com/homarr-labs/homarr/commit/6820f8afea622587c1ee18b13d13a041ca0572ee))
|
||||
* **deps:** update tiptap monorepo to v3.21.0 ([#5386](https://github.com/homarr-labs/homarr/issues/5386)) ([b30dbaf](https://github.com/homarr-labs/homarr/commit/b30dbafbbbad468ff37ff11237a64ec29df62345))
|
||||
* **deps:** update trpc monorepo to ^11.15.0 ([#5354](https://github.com/homarr-labs/homarr/issues/5354)) ([2fb2981](https://github.com/homarr-labs/homarr/commit/2fb2981d2fb79ca2ca6a9bc5c08d91c8fa5710e7))
|
||||
* **deps:** update trpc monorepo to ^11.15.1 ([#5381](https://github.com/homarr-labs/homarr/issues/5381)) ([451e68a](https://github.com/homarr-labs/homarr/commit/451e68ab57551e23dd7ae772b7483cc56d57ebbb))
|
||||
* **deps:** update trpc monorepo to ^11.16.0 ([#5392](https://github.com/homarr-labs/homarr/issues/5392)) ([72a93e6](https://github.com/homarr-labs/homarr/commit/72a93e681f3701459176692857220730c279f80b))
|
||||
* **deps:** update turbo monorepo to ^2.8.21 ([#5391](https://github.com/homarr-labs/homarr/issues/5391)) ([fa40b6b](https://github.com/homarr-labs/homarr/commit/fa40b6b647b884a7f10c268a22330e0e68b50d4d))
|
||||
* honor trusted certificates in Immich integration requests ([#5275](https://github.com/homarr-labs/homarr/issues/5275)) ([7679553](https://github.com/homarr-labs/homarr/commit/7679553f16ff2945a3eb6cb668ca3a701d13d5ce)), closes [#5242](https://github.com/homarr-labs/homarr/issues/5242)
|
||||
* node-ical prevents many trpc queries from loading ([#5395](https://github.com/homarr-labs/homarr/issues/5395)) ([c977b84](https://github.com/homarr-labs/homarr/commit/c977b84e2d84d5724219f5ff5f99bc550438e168))
|
||||
|
||||
## [1.57.1](https://github.com/homarr-labs/homarr/compare/v1.57.0...v1.57.1) (2026-03-27)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* dashdot gpu ([#5347](https://github.com/homarr-labs/homarr/issues/5347)) ([192a43a](https://github.com/homarr-labs/homarr/commit/192a43a031eb9431da2c11395eda69a6c7236b9b))
|
||||
* **deps:** update dependency @t3-oss/env-nextjs to ^0.13.11 ([#5345](https://github.com/homarr-labs/homarr/issues/5345)) ([49d9394](https://github.com/homarr-labs/homarr/commit/49d9394cd78b2a1146c8dc00dd982215a2f9a580))
|
||||
* **deps:** update dependency dockerode to ^4.0.10 ([#5327](https://github.com/homarr-labs/homarr/issues/5327)) ([42a3791](https://github.com/homarr-labs/homarr/commit/42a3791e6b5664a0f28d3ee4d29d5257ef3765f6))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.8 ([#5324](https://github.com/homarr-labs/homarr/issues/5324)) ([7982938](https://github.com/homarr-labs/homarr/commit/798293813cf82e38d7059069823f927b7cdfb3b8))
|
||||
|
||||
## [1.57.0](https://github.com/homarr-labs/homarr/compare/v1.56.1...v1.57.0) (2026-03-27)
|
||||
|
||||
### Features
|
||||
|
||||
* add "allowModals" option for iframe widget ([#5339](https://github.com/homarr-labs/homarr/issues/5339)) ([2fefd9d](https://github.com/homarr-labs/homarr/commit/2fefd9da01c827160fa5fd9b63a38615ea9969e2))
|
||||
* add GPU monitoring support via Glances integration ([#5255](https://github.com/homarr-labs/homarr/issues/5255)) ([003dac4](https://github.com/homarr-labs/homarr/commit/003dac4744f2e23535f1cbb7494187201af4b164)), closes [#5102](https://github.com/homarr-labs/homarr/issues/5102)
|
||||
* add nextcloud notification provider ([#5343](https://github.com/homarr-labs/homarr/issues/5343)) ([f88bf95](https://github.com/homarr-labs/homarr/commit/f88bf9582e1cf45a6b7fd898e12d227869a3849f))
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **deps:** update dependency @immich/sdk to ^2.6.0 ([#5318](https://github.com/homarr-labs/homarr/issues/5318)) ([20a9b3d](https://github.com/homarr-labs/homarr/commit/20a9b3d556a15e6fdf7d1dbd78b677b5ce219c75))
|
||||
* **deps:** update dependency @immich/sdk to ^2.6.1 ([#5319](https://github.com/homarr-labs/homarr/issues/5319)) ([feaf022](https://github.com/homarr-labs/homarr/commit/feaf022965cf4a27112c7e3bcb9ef3ad0dd5c281))
|
||||
* **deps:** update dependency @next/eslint-plugin-next to v16.1.7 ([#5289](https://github.com/homarr-labs/homarr/issues/5289)) ([237d11d](https://github.com/homarr-labs/homarr/commit/237d11d2c021e28d58b0d627d2802d509d4c1b2b))
|
||||
* **deps:** update dependency @tanstack/react-query to ^5.91.0 ([#5305](https://github.com/homarr-labs/homarr/issues/5305)) ([13b99d0](https://github.com/homarr-labs/homarr/commit/13b99d021b46fe0541ce9b42ba66756fafd26c30))
|
||||
* **deps:** update dependency @tanstack/react-query to ^5.91.2 ([#5314](https://github.com/homarr-labs/homarr/issues/5314)) ([6fa6ba3](https://github.com/homarr-labs/homarr/commit/6fa6ba385e6691fefbb9f045a0ff976bcd85de16))
|
||||
* **deps:** update dependency drizzle-kit to ^0.31.10 ([#5291](https://github.com/homarr-labs/homarr/issues/5291)) ([09227a3](https://github.com/homarr-labs/homarr/commit/09227a3884d291032f1012b59ce06babc3c87103))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.6 ([#5297](https://github.com/homarr-labs/homarr/issues/5297)) ([991044e](https://github.com/homarr-labs/homarr/commit/991044ebd78288bea7b441d3c14b159b5e66915b))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.7 ([#5315](https://github.com/homarr-labs/homarr/issues/5315)) ([2336f9e](https://github.com/homarr-labs/homarr/commit/2336f9ee5e35f7b610743dee55b91caf8434c1e4))
|
||||
* **deps:** update dependency ioredis to v5.10.1 ([#5316](https://github.com/homarr-labs/homarr/issues/5316)) ([47b2d36](https://github.com/homarr-labs/homarr/commit/47b2d36f7a0933b6a6bbb61a449888be9304e1c5))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.4.0 ([#5292](https://github.com/homarr-labs/homarr/issues/5292)) ([6276449](https://github.com/homarr-labs/homarr/commit/62764499e7bbc9995ecf3de7351c9224d6aee4b6))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.5.0 ([#5299](https://github.com/homarr-labs/homarr/issues/5299)) ([b6b11c3](https://github.com/homarr-labs/homarr/commit/b6b11c39d2b4a33c5732ae239d7c1aaba6003cc6))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.5.1 ([#5300](https://github.com/homarr-labs/homarr/issues/5300)) ([94dfddf](https://github.com/homarr-labs/homarr/commit/94dfddf8bde2966b46bcd2d30e5e4f886ebe4605))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.6.0 ([#5334](https://github.com/homarr-labs/homarr/issues/5334)) ([8d64cb8](https://github.com/homarr-labs/homarr/commit/8d64cb8a5e276677b033774152c921aedc1e6c8a))
|
||||
* **deps:** update dependency mysql2 to v3.20.0 ([#5283](https://github.com/homarr-labs/homarr/issues/5283)) ([4fb48c2](https://github.com/homarr-labs/homarr/commit/4fb48c23a2ccb1c047bab0d354933561e81cc3ed))
|
||||
* **deps:** update dependency swagger-ui-react to ^5.32.1 ([#5296](https://github.com/homarr-labs/homarr/issues/5296)) ([63c55ce](https://github.com/homarr-labs/homarr/commit/63c55cec5711c41544c65ab83f24d09e63b10354))
|
||||
* **deps:** update dependency trpc-to-openapi to ^3.2.0 ([#5320](https://github.com/homarr-labs/homarr/issues/5320)) ([22f5d3b](https://github.com/homarr-labs/homarr/commit/22f5d3b95959cf0a835c9750b41106eaafc4432e))
|
||||
* **deps:** update dependency typescript-eslint to ^8.57.1 ([#5286](https://github.com/homarr-labs/homarr/issues/5286)) ([d4e4c96](https://github.com/homarr-labs/homarr/commit/d4e4c9669d648632a055b5ec0515821b50821142))
|
||||
* **deps:** update dependency undici to v7.24.5 ([#5338](https://github.com/homarr-labs/homarr/issues/5338)) ([22bbef9](https://github.com/homarr-labs/homarr/commit/22bbef9d8e03215abddf6c6e26a5df45f252626d))
|
||||
* **deps:** update dependency ws to ^8.20.0 ([#5337](https://github.com/homarr-labs/homarr/issues/5337)) ([d53c922](https://github.com/homarr-labs/homarr/commit/d53c922688606bd7d9494089e1ec43b930ad9923))
|
||||
* **deps:** update mantine monorepo to ^8.3.18 ([#5298](https://github.com/homarr-labs/homarr/issues/5298)) ([6f8e629](https://github.com/homarr-labs/homarr/commit/6f8e62963a4eb47cb3095dff46ee0e759e1cbd3c))
|
||||
* **deps:** update nextjs monorepo to v16.2.0 ([#5309](https://github.com/homarr-labs/homarr/issues/5309)) ([8831613](https://github.com/homarr-labs/homarr/commit/883161357dab4d94ff794f9444040d88074c464c))
|
||||
* **deps:** update nextjs monorepo to v16.2.1 ([#5330](https://github.com/homarr-labs/homarr/issues/5330)) ([e23a397](https://github.com/homarr-labs/homarr/commit/e23a397a80e4409f5da50c737aeb26b295ce79fc))
|
||||
* **deps:** update testcontainers-node monorepo to ^11.13.0 ([#5293](https://github.com/homarr-labs/homarr/issues/5293)) ([c009dd7](https://github.com/homarr-labs/homarr/commit/c009dd7de649bf24ab9bcf5ea25c65ebd18540bb))
|
||||
* **deps:** update tiptap monorepo to v3.20.4 ([#5287](https://github.com/homarr-labs/homarr/issues/5287)) ([369b4d4](https://github.com/homarr-labs/homarr/commit/369b4d486327d0eaa04b70dd692c426f9a39afd7))
|
||||
* **deps:** update trpc monorepo to ^11.14.1 ([#5328](https://github.com/homarr-labs/homarr/issues/5328)) ([d7f0596](https://github.com/homarr-labs/homarr/commit/d7f0596db8e44e2e79bb26095abd142b50675cc3))
|
||||
* **deps:** update turbo monorepo to ^2.8.18 ([#5308](https://github.com/homarr-labs/homarr/issues/5308)) ([24694b9](https://github.com/homarr-labs/homarr/commit/24694b92411aae818b97a3a5c9add97d707a2f38))
|
||||
* **deps:** update turbo monorepo to ^2.8.19 ([#5310](https://github.com/homarr-labs/homarr/issues/5310)) ([7537184](https://github.com/homarr-labs/homarr/commit/7537184a8168a4837d0a83a925a70c938555f199))
|
||||
* **deps:** update turbo monorepo to ^2.8.20 ([#5317](https://github.com/homarr-labs/homarr/issues/5317)) ([5b4e6fc](https://github.com/homarr-labs/homarr/commit/5b4e6fcc11c877815c4730607de84ab70d630fb8))
|
||||
* handle null ports in Docker container table ([#5313](https://github.com/homarr-labs/homarr/issues/5313)) ([1639da5](https://github.com/homarr-labs/homarr/commit/1639da57794d2555426e56030b4b34e2cc201aa9)), closes [#5311](https://github.com/homarr-labs/homarr/issues/5311)
|
||||
* warnings in code ([4f2b821](https://github.com/homarr-labs/homarr/commit/4f2b8217f819b91ec4b05e32aebd6bc5473db155))
|
||||
|
||||
## [1.56.1](https://github.com/homarr-labs/homarr/compare/v1.56.0...v1.56.1) (2026-03-20)
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **deps:** update dependency dayjs to ^1.11.20 ([#5253](https://github.com/homarr-labs/homarr/issues/5253)) ([615062c](https://github.com/homarr-labs/homarr/commit/615062c6b141fa1e4bc91d2fab505fa1652608d2))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.1 ([#5246](https://github.com/homarr-labs/homarr/issues/5246)) ([91a9b6b](https://github.com/homarr-labs/homarr/commit/91a9b6bec9438e9a812960b829cea343e8478c63))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.3 ([#5251](https://github.com/homarr-labs/homarr/issues/5251)) ([d1d8659](https://github.com/homarr-labs/homarr/commit/d1d8659f951cdd22bf4a22b407a4f3027f036ec2))
|
||||
* **deps:** update dependency fast-xml-parser to ^5.5.5 ([#5270](https://github.com/homarr-labs/homarr/issues/5270)) ([2423ecd](https://github.com/homarr-labs/homarr/commit/2423ecdce57353dd50d678444da800c02a246223))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.1.0 ([#5239](https://github.com/homarr-labs/homarr/issues/5239)) ([63f91b6](https://github.com/homarr-labs/homarr/commit/63f91b6352e9ba58a0823434d86915371f1c1d30))
|
||||
* **deps:** update dependency isomorphic-dompurify to ^3.3.0 ([#5252](https://github.com/homarr-labs/homarr/issues/5252)) ([e8f6876](https://github.com/homarr-labs/homarr/commit/e8f6876d2477fb0e1936006b81f7324b90b6eb33))
|
||||
* **deps:** update dependency jotai to ^2.18.1 ([#5238](https://github.com/homarr-labs/homarr/issues/5238)) ([729b49f](https://github.com/homarr-labs/homarr/commit/729b49ffa9b1f91ebd7bcd2300febba4d9d0fbb9))
|
||||
* **deps:** update dependency mysql2 to v3.19.1 ([#5240](https://github.com/homarr-labs/homarr/issues/5240)) ([1040eca](https://github.com/homarr-labs/homarr/commit/1040ecac04fd0b10e101495d5230a3fa4898097a))
|
||||
* **deps:** update dependency next to v16.1.7 [security] ([#5263](https://github.com/homarr-labs/homarr/issues/5263)) ([3bbde3c](https://github.com/homarr-labs/homarr/commit/3bbde3cbb8eb3aa528485f17d40817cb982a8687))
|
||||
* **deps:** update dependency sass to ^1.98.0 ([#5247](https://github.com/homarr-labs/homarr/issues/5247)) ([f995cba](https://github.com/homarr-labs/homarr/commit/f995cba157c9954b6f266bd5b2bb8d60a08f51f1))
|
||||
* **deps:** update dependency typescript-eslint to ^8.57.0 ([#5241](https://github.com/homarr-labs/homarr/issues/5241)) ([7841b58](https://github.com/homarr-labs/homarr/commit/7841b58f0fdd4a4494b6f3d61881a1efb4c9eba3))
|
||||
* **deps:** update mantine monorepo to ^8.3.17 ([#5271](https://github.com/homarr-labs/homarr/issues/5271)) ([6fa9087](https://github.com/homarr-labs/homarr/commit/6fa9087a119334dee63e4ca4ed51276b25c4564a))
|
||||
* **deps:** update tiptap monorepo to v3.20.2 ([#5279](https://github.com/homarr-labs/homarr/issues/5279)) ([55cf3c7](https://github.com/homarr-labs/homarr/commit/55cf3c72a3d9cd9f702e802716d549d7d2644105))
|
||||
* **deps:** update trpc monorepo to ^11.13.2 ([#5273](https://github.com/homarr-labs/homarr/issues/5273)) ([7d93b10](https://github.com/homarr-labs/homarr/commit/7d93b1003245ab89fdba7175b0b4f745041cd1fe))
|
||||
* **deps:** update trpc monorepo to ^11.13.3 ([#5276](https://github.com/homarr-labs/homarr/issues/5276)) ([0e0b857](https://github.com/homarr-labs/homarr/commit/0e0b857905a7b5196dbf529520f86467aa94d8ce))
|
||||
* **deps:** update trpc monorepo to ^11.13.4 ([#5278](https://github.com/homarr-labs/homarr/issues/5278)) ([9648d9e](https://github.com/homarr-labs/homarr/commit/9648d9e99f02be8ba16a5238bd47866f7303724d))
|
||||
* **deps:** update turbo monorepo to ^2.8.15 ([#5243](https://github.com/homarr-labs/homarr/issues/5243)) ([1bd924e](https://github.com/homarr-labs/homarr/commit/1bd924ea9917949ac64ab754d97964b12c083b82))
|
||||
* **deps:** update turbo monorepo to ^2.8.16 ([#5250](https://github.com/homarr-labs/homarr/issues/5250)) ([ac80008](https://github.com/homarr-labs/homarr/commit/ac80008ce0796cb6927642c83ff2e667f6e9d24c))
|
||||
* **deps:** update turbo monorepo to ^2.8.17 ([#5265](https://github.com/homarr-labs/homarr/issues/5265)) ([d2f438f](https://github.com/homarr-labs/homarr/commit/d2f438f294df3093b249213ac0a018b770705e3b))
|
||||
|
||||
## [1.56.0](https://github.com/homarr-labs/homarr/compare/v1.55.0...v1.56.0) (2026-03-13)
|
||||
|
||||
### Features
|
||||
|
||||
+2
-3
@@ -1,4 +1,4 @@
|
||||
FROM node:24.14.1-alpine AS base
|
||||
FROM node:24.14.0-alpine AS base
|
||||
|
||||
FROM base AS builder
|
||||
RUN apk add --no-cache libc6-compat
|
||||
@@ -43,8 +43,7 @@ RUN mkdir -p /var/cache/nginx && \
|
||||
COPY --from=builder /app/apps/nextjs/next.config.ts .
|
||||
COPY --from=builder /app/apps/nextjs/package.json .
|
||||
|
||||
COPY --from=builder /app/apps/tasks/tasks.cjs ./apps/tasks/tasks.cjs
|
||||
COPY --from=builder /app/apps/websocket/wssServer.cjs ./apps/websocket/wssServer.cjs
|
||||
COPY --from=builder /app/apps/nextjs/customServer.cjs ./apps/nextjs/customServer.cjs
|
||||
COPY --from=builder /app/node_modules/better-sqlite3/build/Release/better_sqlite3.node /app/build/better_sqlite3.node
|
||||
|
||||
COPY --from=builder /app/packages/db/migrations ./db/migrations
|
||||
|
||||
+35
-24
@@ -4,12 +4,13 @@
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"build": "pnpm with-env next build",
|
||||
"build": "pnpm with-env next build && pnpm build:custom-server",
|
||||
"build:custom-server": "esbuild server.ts --bundle --platform=node --outfile=customServer.cjs --external:next --external:fastify --external:bcrypt --external:@opentelemetry/api --external:deasync --external:cpu-features --loader:.html=text --loader:.scss=text --loader:.node=text",
|
||||
"clean": "git clean -xdf .next .turbo node_modules",
|
||||
"dev": "pnpm with-env next dev",
|
||||
"dev": "pnpm with-env tsx ./server.ts",
|
||||
"format": "prettier --check . --ignore-path ../../.gitignore",
|
||||
"lint": "eslint",
|
||||
"start": "pnpm with-env next start",
|
||||
"start": "pnpm with-env node customServer.cjs",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"with-env": "dotenv -e ../../.env --"
|
||||
},
|
||||
@@ -25,7 +26,10 @@
|
||||
"@homarr/boards": "workspace:^0.1.0",
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/core": "workspace:^0.1.0",
|
||||
"@homarr/cron-job-api": "workspace:^0.1.0",
|
||||
"@homarr/cron-job-status": "workspace:^0.1.0",
|
||||
"@homarr/cron-jobs": "workspace:^0.1.0",
|
||||
"@homarr/cron-jobs-core": "workspace:^0.1.0",
|
||||
"@homarr/db": "workspace:^0.1.0",
|
||||
"@homarr/definitions": "workspace:^0.1.0",
|
||||
"@homarr/docker": "workspace:^0.1.0",
|
||||
@@ -40,7 +44,9 @@
|
||||
"@homarr/notifications": "workspace:^0.1.0",
|
||||
"@homarr/old-import": "workspace:^0.1.0",
|
||||
"@homarr/old-schema": "workspace:^0.1.0",
|
||||
"@homarr/ping": "workspace:^0.1.0",
|
||||
"@homarr/redis": "workspace:^0.1.0",
|
||||
"@homarr/request-handler": "workspace:^0.1.0",
|
||||
"@homarr/server-settings": "workspace:^0.1.0",
|
||||
"@homarr/settings": "workspace:^0.1.0",
|
||||
"@homarr/spotlight": "workspace:^0.1.0",
|
||||
@@ -48,46 +54,48 @@
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@homarr/widgets": "workspace:^0.1.0",
|
||||
"@mantine/colors-generator": "^8.3.18",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/dropzone": "^8.3.18",
|
||||
"@mantine/hooks": "^8.3.18",
|
||||
"@mantine/modals": "^8.3.18",
|
||||
"@mantine/tiptap": "^8.3.18",
|
||||
"@mantine/colors-generator": "^8.3.16",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@mantine/dropzone": "^8.3.16",
|
||||
"@mantine/hooks": "^8.3.16",
|
||||
"@mantine/modals": "^8.3.16",
|
||||
"@mantine/tiptap": "^8.3.16",
|
||||
"@million/lint": "1.0.14",
|
||||
"@tabler/icons-react": "^3.41.0",
|
||||
"@tanstack/react-query": "^5.95.2",
|
||||
"@tanstack/react-query-devtools": "^5.95.2",
|
||||
"@tanstack/react-query-next-experimental": "^5.95.2",
|
||||
"@trpc/client": "^11.16.0",
|
||||
"@trpc/next": "^11.16.0",
|
||||
"@trpc/react-query": "^11.16.0",
|
||||
"@trpc/server": "^11.16.0",
|
||||
"@tabler/icons-react": "^3.40.0",
|
||||
"@tanstack/react-query": "^5.90.21",
|
||||
"@tanstack/react-query-devtools": "^5.91.3",
|
||||
"@tanstack/react-query-next-experimental": "^5.91.0",
|
||||
"@trpc/client": "^11.12.0",
|
||||
"@trpc/next": "^11.12.0",
|
||||
"@trpc/react-query": "^11.12.0",
|
||||
"@trpc/server": "^11.12.0",
|
||||
"@xterm/addon-canvas": "^0.7.0",
|
||||
"@xterm/addon-fit": "0.11.0",
|
||||
"@xterm/xterm": "^6.0.0",
|
||||
"babel-plugin-react-compiler": "^1.0.0",
|
||||
"chroma-js": "^3.2.0",
|
||||
"clsx": "^2.1.1",
|
||||
"dayjs": "^1.11.20",
|
||||
"dayjs": "^1.11.19",
|
||||
"dotenv": "^17.3.1",
|
||||
"fastify": "^5.7.4",
|
||||
"flag-icons": "^7.5.0",
|
||||
"glob": "^13.0.6",
|
||||
"isomorphic-dompurify": "^3.7.1",
|
||||
"jotai": "^2.19.0",
|
||||
"isomorphic-dompurify": "^3.1.0",
|
||||
"jotai": "^2.18.1",
|
||||
"mantine-react-table": "2.0.0-beta.9",
|
||||
"next": "16.2.1",
|
||||
"next": "16.1.6",
|
||||
"postcss-preset-mantine": "^1.18.0",
|
||||
"prismjs": "^1.30.0",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"react-error-boundary": "^6.1.1",
|
||||
"react-simple-code-editor": "^0.14.1",
|
||||
"sass": "^1.98.0",
|
||||
"sass": "^1.97.3",
|
||||
"superjson": "2.2.6",
|
||||
"swagger-ui-react": "^5.32.1",
|
||||
"swagger-ui-react": "^5.32.0",
|
||||
"use-deep-compare-effect": "^1.8.1",
|
||||
"zod": "^4.3.6"
|
||||
"ws": "^8.19.0",
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
@@ -99,10 +107,13 @@
|
||||
"@types/react": "19.2.14",
|
||||
"@types/react-dom": "19.2.3",
|
||||
"@types/swagger-ui-react": "^5.18.0",
|
||||
"@types/ws": "^8.18.1",
|
||||
"concurrently": "^9.2.1",
|
||||
"esbuild": "^0.27.3",
|
||||
"eslint": "^9.39.4",
|
||||
"node-loader": "^2.1.0",
|
||||
"prettier": "^3.8.1",
|
||||
"tsx": "4.20.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,318 @@
|
||||
// Must be imported first to set up globalThis.AsyncLocalStorage for Next.js
|
||||
import "next/dist/server/node-environment-baseline";
|
||||
|
||||
// Set up undici HTTP agent override (from tasks app)
|
||||
import { setGlobalDispatcher } from "undici";
|
||||
import { UndiciHttpAgent } from "@homarr/core/infrastructure/http";
|
||||
setGlobalDispatcher(new UndiciHttpAgent());
|
||||
|
||||
import { createServer } from "http";
|
||||
import path from "path";
|
||||
import next from "next";
|
||||
import { parse } from "url";
|
||||
import { applyWSSHandler } from "@trpc/server/adapters/ws";
|
||||
import { WebSocketServer } from "ws";
|
||||
import type { FastifyTRPCPluginOptions } from "@trpc/server/adapters/fastify";
|
||||
import { fastifyTRPCPlugin } from "@trpc/server/adapters/fastify";
|
||||
import fastify from "fastify";
|
||||
|
||||
import { appRouter, createTRPCContext } from "@homarr/api/websocket";
|
||||
import { getSessionFromToken, sessionTokenCookieName } from "@homarr/auth";
|
||||
import { env as authEnv } from "@homarr/auth/env";
|
||||
import { parseCookies } from "@homarr/common";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
|
||||
import type { JobRouter } from "@homarr/cron-job-api";
|
||||
import { jobRouter } from "@homarr/cron-job-api";
|
||||
import { CRON_JOB_API_KEY_HEADER, CRON_JOB_API_PATH, CRON_JOB_API_PORT } from "@homarr/cron-job-api/constants";
|
||||
import { jobGroup } from "@homarr/cron-jobs";
|
||||
import { db, eq, inArray } from "@homarr/db";
|
||||
import { cronJobConfigurations, sessions, users } from "@homarr/db/schema";
|
||||
import { supportedAuthProviders } from "@homarr/definitions";
|
||||
import { updateCheckerRequestHandler } from "@homarr/request-handler/update-checker";
|
||||
import { schedule, validate as validateCron } from "node-cron";
|
||||
|
||||
const logger = createLogger({ module: "customServer" });
|
||||
|
||||
// --- JobManager (from apps/tasks/src/job-manager.ts) ---
|
||||
import type { IJobManager } from "@homarr/cron-job-api";
|
||||
import type { jobGroup as CronJobGroup, JobGroupKeys } from "@homarr/cron-jobs";
|
||||
import type { Database, InferInsertModel } from "@homarr/db";
|
||||
|
||||
class JobManager implements IJobManager {
|
||||
constructor(
|
||||
private db: Database,
|
||||
private jobGroup: typeof CronJobGroup,
|
||||
) {}
|
||||
|
||||
public async startAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.startAsync(name);
|
||||
}
|
||||
public async triggerAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.runManuallyAsync(name);
|
||||
}
|
||||
public async stopAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.stopAsync(name);
|
||||
}
|
||||
public async updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void> {
|
||||
logger.info("Updating cron job interval", { name, expression: cron });
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
if (!validateCron(cron)) {
|
||||
throw new Error(`Invalid cron expression: ${cron}`);
|
||||
}
|
||||
if (job.preventCustomInterval && cron !== job.cronExpression) {
|
||||
throw new Error(`Custom cron expressions are not allowed for job ${name}`);
|
||||
}
|
||||
|
||||
await this.updateConfigurationAsync(name, { cronExpression: cron });
|
||||
await this.jobGroup.getTask(name)?.destroy();
|
||||
|
||||
this.jobGroup.setTask(
|
||||
name,
|
||||
schedule(cron, () => void job.executeAsync(), {
|
||||
name,
|
||||
}),
|
||||
);
|
||||
logger.info("Cron job interval updated", { name, expression: cron });
|
||||
}
|
||||
public async disableAsync(name: JobGroupKeys): Promise<void> {
|
||||
logger.info("Disabling cron job", { name });
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
|
||||
await this.updateConfigurationAsync(name, { isEnabled: false });
|
||||
await this.jobGroup.stopAsync(name);
|
||||
logger.info("Cron job disabled", { name });
|
||||
}
|
||||
public async enableAsync(name: JobGroupKeys): Promise<void> {
|
||||
logger.info("Enabling cron job", { name });
|
||||
await this.updateConfigurationAsync(name, { isEnabled: true });
|
||||
await this.jobGroup.startAsync(name);
|
||||
logger.info("Cron job enabled", { name });
|
||||
}
|
||||
|
||||
private async updateConfigurationAsync(
|
||||
name: JobGroupKeys,
|
||||
configuration: Omit<Partial<InferInsertModel<typeof cronJobConfigurations>>, "name">,
|
||||
) {
|
||||
const existingConfig = await this.db.query.cronJobConfigurations.findFirst({
|
||||
where: (table, { eq }) => eq(table.name, name),
|
||||
});
|
||||
|
||||
if (existingConfig) {
|
||||
await this.db
|
||||
.update(cronJobConfigurations)
|
||||
.set({ ...configuration, name: undefined })
|
||||
.where(eq(cronJobConfigurations.name, name));
|
||||
return;
|
||||
}
|
||||
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
|
||||
await this.db.insert(cronJobConfigurations).values({
|
||||
name,
|
||||
cronExpression: configuration.cronExpression ?? job.cronExpression,
|
||||
isEnabled: configuration.isEnabled ?? true,
|
||||
});
|
||||
}
|
||||
|
||||
public async getAllAsync(): Promise<
|
||||
{
|
||||
name: JobGroupKeys;
|
||||
cron: string;
|
||||
preventManualExecution: boolean;
|
||||
preventCustomInterval: boolean;
|
||||
isEnabled: boolean;
|
||||
}[]
|
||||
> {
|
||||
const configurations = await this.db.query.cronJobConfigurations.findMany();
|
||||
|
||||
return [...this.jobGroup.getJobRegistry().entries()].map(([name, job]) => {
|
||||
const config = configurations.find((config) => config.name === name);
|
||||
return {
|
||||
name,
|
||||
cron: config?.cronExpression ?? job.cronExpression,
|
||||
preventManualExecution: job.preventManualExecution,
|
||||
preventCustomInterval: job.preventCustomInterval,
|
||||
isEnabled: config?.isEnabled ?? true,
|
||||
};
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// --- On-start functions (from apps/tasks/src/on-start/) ---
|
||||
async function cleanupSessionsAsync() {
|
||||
try {
|
||||
const currentAuthProviders = authEnv.AUTH_PROVIDERS;
|
||||
const inactiveAuthProviders = supportedAuthProviders.filter((provider) => !currentAuthProviders.includes(provider));
|
||||
const subQuery = db
|
||||
.select({ id: users.id })
|
||||
.from(users)
|
||||
.where(inArray(users.provider, inactiveAuthProviders))
|
||||
.as("sq");
|
||||
const sessionsWithInactiveProviders = await db
|
||||
.select({ userId: sessions.userId })
|
||||
.from(sessions)
|
||||
.rightJoin(subQuery, eq(sessions.userId, subQuery.id));
|
||||
|
||||
const userIds = sessionsWithInactiveProviders.map(({ userId }) => userId).filter((value) => value !== null);
|
||||
await db.delete(sessions).where(inArray(sessions.userId, userIds));
|
||||
|
||||
if (sessionsWithInactiveProviders.length > 0) {
|
||||
logger.info("Deleted sessions for inactive providers", { count: userIds.length });
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(new Error("Failed to clean up sessions", { cause: error }));
|
||||
}
|
||||
}
|
||||
|
||||
async function invalidateUpdateCheckerCacheAsync() {
|
||||
try {
|
||||
const handler = updateCheckerRequestHandler.handler({});
|
||||
await handler.invalidateAsync();
|
||||
logger.debug("Update checker cache invalidated");
|
||||
} catch (error) {
|
||||
logger.error(new Error("Failed to invalidate update checker cache", { cause: error }));
|
||||
}
|
||||
}
|
||||
|
||||
// --- Tasks/Cron Fastify server setup ---
|
||||
async function startTasksServer() {
|
||||
const tasksLogger = createLogger({ module: "tasksMain" });
|
||||
|
||||
const tasksServer = fastify({ maxParamLength: 5000 });
|
||||
tasksServer.register(fastifyTRPCPlugin, {
|
||||
prefix: CRON_JOB_API_PATH,
|
||||
trpcOptions: {
|
||||
router: jobRouter,
|
||||
createContext: ({ req }) => ({
|
||||
manager: new JobManager(db, jobGroup),
|
||||
apiKey: req.headers[CRON_JOB_API_KEY_HEADER] as string | undefined,
|
||||
}),
|
||||
onError({ path, error }) {
|
||||
tasksLogger.error(new ErrorWithMetadata("Error in tasks tRPC handler", { path }, { cause: error }));
|
||||
},
|
||||
} satisfies FastifyTRPCPluginOptions<JobRouter>["trpcOptions"],
|
||||
});
|
||||
|
||||
// Run on-start tasks
|
||||
await cleanupSessionsAsync();
|
||||
await invalidateUpdateCheckerCacheAsync();
|
||||
|
||||
// Initialize and start cron jobs
|
||||
await jobGroup.initializeAsync();
|
||||
await jobGroup.startAllAsync();
|
||||
|
||||
try {
|
||||
await tasksServer.listen({ port: CRON_JOB_API_PORT });
|
||||
tasksLogger.info("Tasks web server started successfully", { port: CRON_JOB_API_PORT });
|
||||
} catch (err) {
|
||||
tasksLogger.error(
|
||||
new ErrorWithMetadata("Failed to start tasks web server", { port: CRON_JOB_API_PORT }, { cause: err }),
|
||||
);
|
||||
}
|
||||
|
||||
return tasksServer;
|
||||
}
|
||||
|
||||
// --- Main server setup ---
|
||||
const dev = process.env.NODE_ENV !== "production";
|
||||
const hostname = process.env.HOSTNAME || "localhost";
|
||||
const port = parseInt(process.env.PORT || "3000", 10);
|
||||
// Resolve the directory of this file so Next.js can find the app/pages dirs
|
||||
const dir = path.resolve(__dirname);
|
||||
|
||||
const app = next({ dev, hostname, port, dir });
|
||||
const handle = app.getRequestHandler();
|
||||
const upgradeHandler = app.getUpgradeHandler();
|
||||
|
||||
app.prepare().then(async () => {
|
||||
const server = createServer((req, res) => {
|
||||
const parsedUrl = parse(req.url!, true);
|
||||
handle(req, res, parsedUrl);
|
||||
});
|
||||
|
||||
// Create WebSocket server in noServer mode so we handle upgrade manually
|
||||
const wss = new WebSocketServer({ noServer: true });
|
||||
|
||||
const wssHandler = applyWSSHandler({
|
||||
wss,
|
||||
router: appRouter,
|
||||
// eslint-disable-next-line no-restricted-syntax
|
||||
createContext: async ({ req }) => {
|
||||
try {
|
||||
const headers = Object.entries(req.headers).map(
|
||||
([key, value]) => [key, typeof value === "string" ? value : value?.[0]] as [string, string],
|
||||
);
|
||||
const nextHeaders = new Headers(headers);
|
||||
|
||||
const store = parseCookies(nextHeaders.get("cookie") ?? "");
|
||||
const sessionToken = store[sessionTokenCookieName];
|
||||
|
||||
const session = await getSessionFromToken(db, sessionToken);
|
||||
|
||||
return createTRPCContext({
|
||||
headers: nextHeaders,
|
||||
session,
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
return createTRPCContext({
|
||||
headers: new Headers(),
|
||||
session: null,
|
||||
});
|
||||
}
|
||||
},
|
||||
keepAlive: {
|
||||
enabled: true,
|
||||
pingMs: 30000,
|
||||
pongWaitMs: 5000,
|
||||
},
|
||||
});
|
||||
|
||||
// Handle upgrade requests: route /websockets to our WS server,
|
||||
// delegate everything else (e.g. HMR _next/webpack-hmr) to Next.js
|
||||
server.on("upgrade", (req, socket, head) => {
|
||||
if (req.url?.startsWith("/websockets")) {
|
||||
wss.handleUpgrade(req, socket, head, (ws) => {
|
||||
wss.emit("connection", ws, req);
|
||||
});
|
||||
} else {
|
||||
upgradeHandler(req, socket, head);
|
||||
}
|
||||
});
|
||||
|
||||
wss.on("connection", (websocket, incomingMessage) => {
|
||||
logger.info(`➕ Connection (${wss.clients.size}) ${incomingMessage.method} ${incomingMessage.url}`);
|
||||
websocket.once("close", (code, reason) => {
|
||||
logger.info(`➖ Connection (${wss.clients.size}) ${code} ${reason.toString()}`);
|
||||
});
|
||||
});
|
||||
|
||||
// Start the integrated tasks/cron server
|
||||
const tasksServer = await startTasksServer();
|
||||
|
||||
server.once("error", (err) => {
|
||||
logger.error(new ErrorWithMetadata("Server error", {}, { cause: err }));
|
||||
wssHandler.broadcastReconnectNotification();
|
||||
wss.close();
|
||||
tasksServer.close().catch((closeError) => logger.error("Failed to close tasks server", closeError));
|
||||
server.close(() => process.exit(1));
|
||||
});
|
||||
|
||||
server.listen(port, () => {
|
||||
logger.info(`✅ Custom server ready on http://${hostname}:${port}`);
|
||||
logger.info(`✅ WebSocket Server integrated on ws://${hostname}:${port}/websockets`);
|
||||
logger.info(`✅ Tasks/Cron server integrated on port ${CRON_JOB_API_PORT}`);
|
||||
});
|
||||
|
||||
process.on("SIGTERM", () => {
|
||||
logger.info("SIGTERM");
|
||||
wssHandler.broadcastReconnectNotification();
|
||||
wss.close();
|
||||
tasksServer.close().catch((closeError) => logger.error("Failed to close tasks server", closeError));
|
||||
server.close();
|
||||
});
|
||||
});
|
||||
@@ -32,13 +32,12 @@ const getWebSocketProtocol = () => {
|
||||
};
|
||||
|
||||
const constructWebsocketUrl = () => {
|
||||
const fallback = `${getWebSocketProtocol()}://localhost:3001/websockets`;
|
||||
if (typeof window === "undefined") {
|
||||
return fallback;
|
||||
return `${getWebSocketProtocol()}://localhost:3000/websockets`;
|
||||
}
|
||||
|
||||
if (env.NODE_ENV === "development") {
|
||||
return fallback;
|
||||
return `${getWebSocketProtocol()}://localhost:3000/websockets`;
|
||||
}
|
||||
|
||||
return `${getWebSocketProtocol()}://${window.location.hostname}:${window.location.port}/websockets`;
|
||||
|
||||
@@ -13,7 +13,6 @@ import type { useForm } from "@homarr/form";
|
||||
import { useZodForm } from "@homarr/form";
|
||||
import { showErrorNotification, showSuccessNotification } from "@homarr/notifications";
|
||||
import { useScopedI18n } from "@homarr/translation/client";
|
||||
import { sanitizeRedirectionUrl } from "@homarr/validation/redirection-url";
|
||||
import { userSignInSchema } from "@homarr/validation/user";
|
||||
|
||||
type Provider = "credentials" | "ldap" | "oidc";
|
||||
@@ -71,7 +70,7 @@ export const LoginForm = ({ providers, oidcClientName, isOidcAutoLoginEnabled, c
|
||||
|
||||
// Redirect to the callback URL if the response is defined and comes from a credentials provider (ldap or credentials). oidc is redirected automatically.
|
||||
await revalidatePathActionAsync("/");
|
||||
router.push(sanitizeRedirectionUrl(callbackUrl));
|
||||
router.push(callbackUrl);
|
||||
},
|
||||
[t, router, callbackUrl],
|
||||
);
|
||||
|
||||
@@ -4,7 +4,6 @@ import { Card, Center, Stack, Text, Title } from "@mantine/core";
|
||||
import { env } from "@homarr/auth/env";
|
||||
import { auth } from "@homarr/auth/next";
|
||||
import { getScopedI18n } from "@homarr/translation/server";
|
||||
import { sanitizeRedirectionUrl } from "@homarr/validation/redirection-url";
|
||||
|
||||
import { HomarrLogoWithTitle } from "~/components/layout/logo/homarr-logo";
|
||||
import { LoginForm } from "./_login-form";
|
||||
@@ -20,7 +19,7 @@ export default async function Login(props: LoginProps) {
|
||||
const session = await auth();
|
||||
|
||||
if (session) {
|
||||
redirect(sanitizeRedirectionUrl(searchParams.callbackUrl));
|
||||
redirect(searchParams.callbackUrl ?? "/");
|
||||
}
|
||||
|
||||
const t = await getScopedI18n("user.page.login");
|
||||
|
||||
@@ -264,5 +264,6 @@ const usePreventLeaveWithDirty = (isDirty: boolean) => {
|
||||
window.removeEventListener("popstate", handlePopState);
|
||||
window.removeEventListener("beforeunload", handleBeforeUnload);
|
||||
};
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [isDirty]);
|
||||
};
|
||||
@@ -27,6 +27,7 @@ export const BoardReadyProvider = ({ children }: PropsWithChildren) => {
|
||||
|
||||
useEffect(() => {
|
||||
setReadySections((previous) => previous.filter((id) => board.sections.some((section) => section.id === id)));
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [board.sections.length, setReadySections]);
|
||||
|
||||
const markAsReady = useCallback((id: string) => {
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
import { useEffect, useRef } from "react";
|
||||
import { Button, Grid, Group, Loader, Stack, TextInput } from "@mantine/core";
|
||||
import { useDebouncedValue, useDocumentTitle } from "@mantine/hooks";
|
||||
import { useDebouncedValue, useDocumentTitle, useFavicon } from "@mantine/hooks";
|
||||
|
||||
import { useUpdateBoard } from "@homarr/boards/updater";
|
||||
import { useZodForm } from "@homarr/form";
|
||||
@@ -10,7 +10,6 @@ import { IconPicker } from "@homarr/forms-collection";
|
||||
import { useI18n } from "@homarr/translation/client";
|
||||
import { boardSavePartialSettingsSchema } from "@homarr/validation/board";
|
||||
|
||||
import { homarrLogoPath } from "~/components/layout/logo/homarr-logo";
|
||||
import { createMetaTitle } from "~/metadata";
|
||||
import type { Board } from "../../_types";
|
||||
import { useSavePartialSettingsMutation } from "./_shared";
|
||||
@@ -54,6 +53,7 @@ export const GeneralSettingsContent = ({ board }: Props) => {
|
||||
);
|
||||
|
||||
useLogoPreview(form.values.logoImageUrl);
|
||||
useFaviconPreview(form.values.faviconImageUrl);
|
||||
const metaTitleStatus = useMetaTitlePreview(form.values.metaTitle);
|
||||
|
||||
// Cleanup for not applied changes of the page title and logo image URL
|
||||
@@ -75,7 +75,6 @@ export const GeneralSettingsContent = ({ board }: Props) => {
|
||||
pageTitle: values.pageTitle,
|
||||
logoImageUrl: values.logoImageUrl,
|
||||
};
|
||||
updateFavicon(values.faviconImageUrl ?? homarrLogoPath);
|
||||
savePartialSettings({
|
||||
id: board.id,
|
||||
...values,
|
||||
@@ -147,13 +146,7 @@ const useMetaTitlePreview = (title: string | null) => {
|
||||
};
|
||||
};
|
||||
|
||||
// Previously we used the useFavicon hook from Mantine
|
||||
// However if the user tried to click on a link to a different page
|
||||
// it caused an error "Cannot read properties of null (reading 'removeChild')"
|
||||
// Probably because the head element was null (https://github.com/mantinedev/mantine/blob/b90d9b81031f45f5d15e75f25138ed6477f65bce/packages/%40mantine/hooks/src/use-favicon/use-favicon.ts#L21)
|
||||
// See https://github.com/homarr-labs/homarr/issues/4905
|
||||
const updateFavicon = (url: string) => {
|
||||
const link: HTMLLinkElement | null = document.querySelector('link[rel="icon"]');
|
||||
if (!link) return;
|
||||
link.href = url;
|
||||
const useFaviconPreview = (url: string | null) => {
|
||||
const [faviconDebounced] = useDebouncedValue(url ?? "", 500);
|
||||
useFavicon(faviconDebounced);
|
||||
};
|
||||
@@ -14,7 +14,7 @@ import { ApiKeysManagement } from "./components/api-keys";
|
||||
|
||||
export async function generateMetadata() {
|
||||
const session = await auth();
|
||||
if (!session?.user.permissions.includes("admin")) {
|
||||
if (!session?.user || !session.user.permissions.includes("admin")) {
|
||||
return {};
|
||||
}
|
||||
|
||||
@@ -27,7 +27,7 @@ export async function generateMetadata() {
|
||||
|
||||
export default async function ApiPage() {
|
||||
const session = await auth();
|
||||
if (!session?.user.permissions.includes("admin")) {
|
||||
if (!session?.user || !session.user.permissions.includes("admin")) {
|
||||
notFound();
|
||||
}
|
||||
const document = openApiDocument(extractBaseUrlFromHeaders(await headers()));
|
||||
|
||||
@@ -76,7 +76,6 @@ const createColumns = (
|
||||
accessorKey: "ports",
|
||||
header: t("docker.field.ports.label"),
|
||||
Cell({ cell }) {
|
||||
if (!cell.row.original.ports) return null;
|
||||
if (!cell.row.original.ports.length) return null;
|
||||
return (
|
||||
<OverflowBadge overflowCount={1} data={cell.row.original.ports.map((port) => port.PrivatePort.toString())} />
|
||||
|
||||
@@ -18,7 +18,7 @@ import { LogContextProvider } from "./log-context";
|
||||
|
||||
export async function generateMetadata() {
|
||||
const session = await auth();
|
||||
if (!session?.user.permissions.includes("admin")) {
|
||||
if (!session?.user || !session.user.permissions.includes("admin")) {
|
||||
return {};
|
||||
}
|
||||
const t = await getScopedI18n("management");
|
||||
@@ -30,7 +30,7 @@ export async function generateMetadata() {
|
||||
|
||||
export default async function LogsManagementPage() {
|
||||
const session = await auth();
|
||||
if (!session?.user.permissions.includes("other-view-logs")) {
|
||||
if (!session?.user || !session.user.permissions.includes("other-view-logs")) {
|
||||
notFound();
|
||||
}
|
||||
|
||||
|
||||
@@ -75,6 +75,7 @@ const executeHealthCheckSafelyAsync = async (
|
||||
},
|
||||
};
|
||||
} catch (error) {
|
||||
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
||||
logger.error(new ErrorWithMetadata("Healthcheck failed", { name }, { cause: error }));
|
||||
return {
|
||||
status: "unhealthy",
|
||||
|
||||
@@ -117,6 +117,7 @@ const InnerContent = ({ item, ...dimensions }: InnerContentProps) => {
|
||||
when={
|
||||
widgetSupportsIntegrations &&
|
||||
item.integrationIds.length === 0 &&
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
(!("integrationsRequired" in definition) || definition.integrationsRequired !== false)
|
||||
}
|
||||
/>
|
||||
|
||||
@@ -206,6 +206,7 @@ export const useGridstack = (section: Omit<Section, "items">, itemIds: string[])
|
||||
}
|
||||
|
||||
// Only run this effect when the section items change
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, [itemIds.length, columnCount]);
|
||||
|
||||
/**
|
||||
|
||||
@@ -14,5 +14,5 @@
|
||||
"tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
|
||||
},
|
||||
"include": [".", ".next/types/**/*.ts"],
|
||||
"exclude": ["node_modules", ".next"]
|
||||
"exclude": ["node_modules", ".next", "customServer.cjs", "customServer.css"]
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
import baseConfig from "@homarr/eslint-config/base";
|
||||
|
||||
/** @type {import('typescript-eslint').Config} */
|
||||
export default [
|
||||
{
|
||||
ignores: ["tasks.cjs"],
|
||||
},
|
||||
...baseConfig,
|
||||
];
|
||||
@@ -1,58 +0,0 @@
|
||||
{
|
||||
"name": "@homarr/tasks",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"license": "Apache-2.0",
|
||||
"type": "module",
|
||||
"exports": {
|
||||
".": "./src/index.ts"
|
||||
},
|
||||
"main": "./src/main.ts",
|
||||
"types": "./src/main.ts",
|
||||
"scripts": {
|
||||
"build": "esbuild src/main.ts --bundle --platform=node --loader:.scss=text --external:*.node --external:@opentelemetry/api --external:deasync --external:bcrypt --outfile=tasks.cjs",
|
||||
"clean": "rm -rf .turbo node_modules",
|
||||
"dev": "pnpm with-env tsx ./src/main.ts",
|
||||
"format": "prettier --check . --ignore-path ../../.gitignore",
|
||||
"lint": "eslint",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"with-env": "dotenv -e ../../.env --"
|
||||
},
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@homarr/analytics": "workspace:^0.1.0",
|
||||
"@homarr/auth": "workspace:^0.1.0",
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/core": "workspace:^",
|
||||
"@homarr/cron-job-api": "workspace:^0.1.0",
|
||||
"@homarr/cron-jobs": "workspace:^0.1.0",
|
||||
"@homarr/cron-jobs-core": "workspace:^0.1.0",
|
||||
"@homarr/db": "workspace:^0.1.0",
|
||||
"@homarr/definitions": "workspace:^0.1.0",
|
||||
"@homarr/icons": "workspace:^0.1.0",
|
||||
"@homarr/integrations": "workspace:^0.1.0",
|
||||
"@homarr/ping": "workspace:^0.1.0",
|
||||
"@homarr/redis": "workspace:^0.1.0",
|
||||
"@homarr/request-handler": "workspace:^0.1.0",
|
||||
"@homarr/server-settings": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@homarr/widgets": "workspace:^0.1.0",
|
||||
"dayjs": "^1.11.20",
|
||||
"dotenv": "^17.3.1",
|
||||
"fastify": "^5.8.4",
|
||||
"superjson": "2.2.6",
|
||||
"undici": "7.24.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"@types/node": "^24.12.0",
|
||||
"dotenv-cli": "^11.0.0",
|
||||
"esbuild": "^0.27.4",
|
||||
"eslint": "^9.39.4",
|
||||
"prettier": "^3.8.1",
|
||||
"tsx": "4.20.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
@@ -1,128 +0,0 @@
|
||||
import { schedule, validate as validateCron } from "node-cron";
|
||||
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import type { IJobManager } from "@homarr/cron-job-api";
|
||||
import type { jobGroup as cronJobGroup, JobGroupKeys } from "@homarr/cron-jobs";
|
||||
import type { Database, InferInsertModel } from "@homarr/db";
|
||||
import { eq } from "@homarr/db";
|
||||
import { cronJobConfigurations } from "@homarr/db/schema";
|
||||
|
||||
const logger = createLogger({ module: "jobManager" });
|
||||
|
||||
export class JobManager implements IJobManager {
|
||||
constructor(
|
||||
private db: Database,
|
||||
private jobGroup: typeof cronJobGroup,
|
||||
) {}
|
||||
|
||||
public async startAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.startAsync(name);
|
||||
}
|
||||
public async triggerAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.runManuallyAsync(name);
|
||||
}
|
||||
public async stopAsync(name: JobGroupKeys): Promise<void> {
|
||||
await this.jobGroup.stopAsync(name);
|
||||
}
|
||||
public async updateIntervalAsync(name: JobGroupKeys, cron: string): Promise<void> {
|
||||
logger.info("Updating cron job interval", { name, expression: cron });
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
if (!validateCron(cron)) {
|
||||
throw new Error(`Invalid cron expression: ${cron}`);
|
||||
}
|
||||
if (job.preventCustomInterval && cron !== job.cronExpression) {
|
||||
throw new Error(`Custom cron expressions are not allowed for job ${name}`);
|
||||
}
|
||||
|
||||
await this.updateConfigurationAsync(name, { cronExpression: cron });
|
||||
await this.jobGroup.getTask(name)?.destroy();
|
||||
|
||||
this.jobGroup.setTask(
|
||||
name,
|
||||
schedule(cron, () => void job.executeAsync(), {
|
||||
name,
|
||||
}),
|
||||
);
|
||||
logger.info("Cron job interval updated", { name, expression: cron });
|
||||
}
|
||||
public async disableAsync(name: JobGroupKeys): Promise<void> {
|
||||
logger.info("Disabling cron job", { name });
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
|
||||
await this.updateConfigurationAsync(name, { isEnabled: false });
|
||||
await this.jobGroup.stopAsync(name);
|
||||
logger.info("Cron job disabled", { name });
|
||||
}
|
||||
public async enableAsync(name: JobGroupKeys): Promise<void> {
|
||||
logger.info("Enabling cron job", { name });
|
||||
await this.updateConfigurationAsync(name, { isEnabled: true });
|
||||
await this.jobGroup.startAsync(name);
|
||||
logger.info("Cron job enabled", { name });
|
||||
}
|
||||
|
||||
private async updateConfigurationAsync(
|
||||
name: JobGroupKeys,
|
||||
configuration: Omit<Partial<InferInsertModel<typeof cronJobConfigurations>>, "name">,
|
||||
) {
|
||||
const existingConfig = await this.db.query.cronJobConfigurations.findFirst({
|
||||
where: (table, { eq }) => eq(table.name, name),
|
||||
});
|
||||
|
||||
logger.debug("Updating cron job configuration", {
|
||||
name,
|
||||
configuration: JSON.stringify(configuration),
|
||||
exists: Boolean(existingConfig),
|
||||
});
|
||||
|
||||
if (existingConfig) {
|
||||
await this.db
|
||||
.update(cronJobConfigurations)
|
||||
// prevent updating the name, as it is the primary key
|
||||
.set({ ...configuration, name: undefined })
|
||||
.where(eq(cronJobConfigurations.name, name));
|
||||
logger.debug("Cron job configuration updated", {
|
||||
name,
|
||||
configuration: JSON.stringify(configuration),
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
const job = this.jobGroup.getJobRegistry().get(name);
|
||||
if (!job) throw new Error(`Job ${name} not found`);
|
||||
|
||||
await this.db.insert(cronJobConfigurations).values({
|
||||
name,
|
||||
cronExpression: configuration.cronExpression ?? job.cronExpression,
|
||||
isEnabled: configuration.isEnabled ?? true,
|
||||
});
|
||||
logger.debug("Cron job configuration updated", {
|
||||
name,
|
||||
configuration: JSON.stringify(configuration),
|
||||
});
|
||||
}
|
||||
|
||||
public async getAllAsync(): Promise<
|
||||
{
|
||||
name: JobGroupKeys;
|
||||
cron: string;
|
||||
preventManualExecution: boolean;
|
||||
preventCustomInterval: boolean;
|
||||
isEnabled: boolean;
|
||||
}[]
|
||||
> {
|
||||
const configurations = await this.db.query.cronJobConfigurations.findMany();
|
||||
|
||||
return [...this.jobGroup.getJobRegistry().entries()].map(([name, job]) => {
|
||||
const config = configurations.find((config) => config.name === name);
|
||||
return {
|
||||
name,
|
||||
cron: config?.cronExpression ?? job.cronExpression,
|
||||
preventManualExecution: job.preventManualExecution,
|
||||
preventCustomInterval: job.preventCustomInterval,
|
||||
isEnabled: config?.isEnabled ?? true,
|
||||
};
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,52 +0,0 @@
|
||||
// This import has to be the first import in the file so that the agent is overridden before any other modules are imported.
|
||||
import "./overrides";
|
||||
|
||||
import type { FastifyTRPCPluginOptions } from "@trpc/server/adapters/fastify";
|
||||
import { fastifyTRPCPlugin } from "@trpc/server/adapters/fastify";
|
||||
import fastify from "fastify";
|
||||
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
|
||||
import type { JobRouter } from "@homarr/cron-job-api";
|
||||
import { jobRouter } from "@homarr/cron-job-api";
|
||||
import { CRON_JOB_API_KEY_HEADER, CRON_JOB_API_PATH, CRON_JOB_API_PORT } from "@homarr/cron-job-api/constants";
|
||||
import { jobGroup } from "@homarr/cron-jobs";
|
||||
import { db } from "@homarr/db";
|
||||
|
||||
import { JobManager } from "./job-manager";
|
||||
import { onStartAsync } from "./on-start";
|
||||
|
||||
const logger = createLogger({ module: "tasksMain" });
|
||||
|
||||
const server = fastify({
|
||||
maxParamLength: 5000,
|
||||
});
|
||||
server.register(fastifyTRPCPlugin, {
|
||||
prefix: CRON_JOB_API_PATH,
|
||||
trpcOptions: {
|
||||
router: jobRouter,
|
||||
createContext: ({ req }) => ({
|
||||
manager: new JobManager(db, jobGroup),
|
||||
apiKey: req.headers[CRON_JOB_API_KEY_HEADER] as string | undefined,
|
||||
}),
|
||||
onError({ path, error }) {
|
||||
logger.error(new ErrorWithMetadata("Error in tasks tRPC handler", { path }, { cause: error }));
|
||||
},
|
||||
} satisfies FastifyTRPCPluginOptions<JobRouter>["trpcOptions"],
|
||||
});
|
||||
|
||||
void (async () => {
|
||||
await onStartAsync();
|
||||
await jobGroup.initializeAsync();
|
||||
await jobGroup.startAllAsync();
|
||||
|
||||
try {
|
||||
await server.listen({ port: CRON_JOB_API_PORT });
|
||||
logger.info("Tasks web server started successfully", { port: CRON_JOB_API_PORT });
|
||||
} catch (err) {
|
||||
logger.error(
|
||||
new ErrorWithMetadata("Failed to start tasks web server", { port: CRON_JOB_API_PORT }, { cause: err }),
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
})();
|
||||
@@ -1,7 +0,0 @@
|
||||
import { invalidateUpdateCheckerCacheAsync } from "./invalidate-update-checker-cache";
|
||||
import { cleanupSessionsAsync } from "./session-cleanup";
|
||||
|
||||
export async function onStartAsync() {
|
||||
await cleanupSessionsAsync();
|
||||
await invalidateUpdateCheckerCacheAsync();
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { updateCheckerRequestHandler } from "@homarr/request-handler/update-checker";
|
||||
|
||||
const logger = createLogger({ module: "invalidateUpdateCheckerCache" });
|
||||
|
||||
/**
|
||||
* Invalidates the update checker cache on startup to ensure fresh data.
|
||||
* It is important as we want to avoid showing pending updates after the update to latest version.
|
||||
*/
|
||||
export async function invalidateUpdateCheckerCacheAsync() {
|
||||
try {
|
||||
const handler = updateCheckerRequestHandler.handler({});
|
||||
await handler.invalidateAsync();
|
||||
logger.debug("Update checker cache invalidated");
|
||||
} catch (error) {
|
||||
logger.error(new Error("Failed to invalidate update checker cache", { cause: error }));
|
||||
}
|
||||
}
|
||||
@@ -1,41 +0,0 @@
|
||||
import { env } from "@homarr/auth/env";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { db, eq, inArray } from "@homarr/db";
|
||||
import { sessions, users } from "@homarr/db/schema";
|
||||
import { supportedAuthProviders } from "@homarr/definitions";
|
||||
|
||||
const logger = createLogger({ module: "sessionCleanup" });
|
||||
|
||||
/**
|
||||
* Deletes sessions for users that have inactive auth providers.
|
||||
* Sessions from other providers are deleted so they can no longer be used.
|
||||
*/
|
||||
export async function cleanupSessionsAsync() {
|
||||
try {
|
||||
const currentAuthProviders = env.AUTH_PROVIDERS;
|
||||
|
||||
const inactiveAuthProviders = supportedAuthProviders.filter((provider) => !currentAuthProviders.includes(provider));
|
||||
const subQuery = db
|
||||
.select({ id: users.id })
|
||||
.from(users)
|
||||
.where(inArray(users.provider, inactiveAuthProviders))
|
||||
.as("sq");
|
||||
const sessionsWithInactiveProviders = await db
|
||||
.select({ userId: sessions.userId })
|
||||
.from(sessions)
|
||||
.rightJoin(subQuery, eq(sessions.userId, subQuery.id));
|
||||
|
||||
const userIds = sessionsWithInactiveProviders.map(({ userId }) => userId).filter((value) => value !== null);
|
||||
await db.delete(sessions).where(inArray(sessions.userId, userIds));
|
||||
|
||||
if (sessionsWithInactiveProviders.length > 0) {
|
||||
logger.info("Deleted sessions for inactive providers", {
|
||||
count: userIds.length,
|
||||
});
|
||||
} else {
|
||||
logger.debug("No sessions to delete");
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(new Error("Failed to clean up sessions", { cause: error }));
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
import { setGlobalDispatcher } from "undici";
|
||||
|
||||
import { UndiciHttpAgent } from "@homarr/core/infrastructure/http";
|
||||
|
||||
setGlobalDispatcher(new UndiciHttpAgent());
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"extends": "@homarr/tsconfig/base.json",
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"~/*": ["src/*"],
|
||||
"@homarr/node-unifi": ["../../node_modules/@types/node-unifi"]
|
||||
},
|
||||
"tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
|
||||
},
|
||||
"include": ["."],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
import baseConfig from "@homarr/eslint-config/base";
|
||||
|
||||
/** @type {import('typescript-eslint').Config} */
|
||||
export default [
|
||||
{
|
||||
ignores: ["wssServer.cjs"],
|
||||
},
|
||||
...baseConfig,
|
||||
];
|
||||
@@ -1,42 +0,0 @@
|
||||
{
|
||||
"name": "@homarr/websocket",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"license": "Apache-2.0",
|
||||
"type": "module",
|
||||
"main": "./src/main.ts",
|
||||
"types": "./src/main.ts",
|
||||
"scripts": {
|
||||
"build": "esbuild src/main.ts --bundle --platform=node --outfile=wssServer.cjs --external:bcrypt --external:@opentelemetry/api --external:deasync --external:cpu-features --loader:.html=text --loader:.scss=text --loader:.node=text",
|
||||
"clean": "rm -rf .turbo node_modules",
|
||||
"dev": "pnpm with-env tsx ./src/main.ts",
|
||||
"format": "prettier --check . --ignore-path ../../.gitignore",
|
||||
"lint": "eslint",
|
||||
"typecheck": "tsc --noEmit",
|
||||
"with-env": "dotenv -e ../../.env --"
|
||||
},
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@homarr/api": "workspace:^0.1.0",
|
||||
"@homarr/auth": "workspace:^0.1.0",
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/core": "workspace:^",
|
||||
"@homarr/db": "workspace:^0.1.0",
|
||||
"@homarr/definitions": "workspace:^0.1.0",
|
||||
"@homarr/redis": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"dotenv": "^17.3.1",
|
||||
"tsx": "4.20.4",
|
||||
"ws": "^8.20.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"@types/ws": "^8.18.1",
|
||||
"esbuild": "^0.27.4",
|
||||
"eslint": "^9.39.4",
|
||||
"prettier": "^3.8.1",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
}
|
||||
@@ -1,66 +0,0 @@
|
||||
import { applyWSSHandler } from "@trpc/server/adapters/ws";
|
||||
import { WebSocketServer } from "ws";
|
||||
|
||||
import { appRouter, createTRPCContext } from "@homarr/api/websocket";
|
||||
import { getSessionFromToken, sessionTokenCookieName } from "@homarr/auth";
|
||||
import { parseCookies } from "@homarr/common";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { db } from "@homarr/db";
|
||||
|
||||
const logger = createLogger({ module: "websocketMain" });
|
||||
|
||||
const wss = new WebSocketServer({
|
||||
port: 3001,
|
||||
});
|
||||
const handler = applyWSSHandler({
|
||||
wss,
|
||||
router: appRouter,
|
||||
// ignore error on next line because the createContext must be set with this name
|
||||
// eslint-disable-next-line no-restricted-syntax
|
||||
createContext: async ({ req }) => {
|
||||
try {
|
||||
const headers = Object.entries(req.headers).map(
|
||||
([key, value]) => [key, typeof value === "string" ? value : value?.[0]] as [string, string],
|
||||
);
|
||||
const nextHeaders = new Headers(headers);
|
||||
|
||||
const store = parseCookies(nextHeaders.get("cookie") ?? "");
|
||||
const sessionToken = store[sessionTokenCookieName];
|
||||
|
||||
const session = await getSessionFromToken(db, sessionToken);
|
||||
|
||||
return createTRPCContext({
|
||||
headers: nextHeaders,
|
||||
session,
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(error);
|
||||
return createTRPCContext({
|
||||
headers: new Headers(),
|
||||
session: null,
|
||||
});
|
||||
}
|
||||
},
|
||||
// Enable heartbeat messages to keep connection open (disabled by default)
|
||||
keepAlive: {
|
||||
enabled: true,
|
||||
// server ping message interval in milliseconds
|
||||
pingMs: 30000,
|
||||
// connection is terminated if pong message is not received in this many milliseconds
|
||||
pongWaitMs: 5000,
|
||||
},
|
||||
});
|
||||
|
||||
wss.on("connection", (websocket, incomingMessage) => {
|
||||
logger.info(`➕ Connection (${wss.clients.size}) ${incomingMessage.method} ${incomingMessage.url}`);
|
||||
websocket.once("close", (code, reason) => {
|
||||
logger.info(`➖ Connection (${wss.clients.size}) ${code} ${reason.toString()}`);
|
||||
});
|
||||
});
|
||||
logger.info("✅ WebSocket Server listening on ws://localhost:3001");
|
||||
|
||||
process.on("SIGTERM", () => {
|
||||
logger.info("SIGTERM");
|
||||
handler.broadcastReconnectNotification();
|
||||
wss.close();
|
||||
});
|
||||
@@ -1,13 +0,0 @@
|
||||
{
|
||||
"extends": "@homarr/tsconfig/base.json",
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"~/*": ["src/*"],
|
||||
"@homarr/node-unifi": ["../../node_modules/@types/node-unifi"]
|
||||
},
|
||||
"tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
|
||||
},
|
||||
"include": ["."],
|
||||
"exclude": ["node_modules"]
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
FROM node:24.14.1-trixie AS base
|
||||
FROM node:24.14.0-trixie AS base
|
||||
WORKDIR /app
|
||||
COPY package.json .
|
||||
COPY pnpm-lock.yaml .
|
||||
|
||||
@@ -2,12 +2,12 @@
|
||||
"name": "homarr-prebuilt-debian",
|
||||
"private": true,
|
||||
"dependencies": {
|
||||
"better-sqlite3": "^12.8.0"
|
||||
"better-sqlite3": "^12.6.2"
|
||||
},
|
||||
"packageManager": "pnpm@10.33.0",
|
||||
"packageManager": "pnpm@10.32.0",
|
||||
"engines": {
|
||||
"node": ">=24.14.1",
|
||||
"pnpm": ">=10.33.0"
|
||||
"node": ">=24.14.0",
|
||||
"pnpm": ">=10.32.0"
|
||||
},
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": [
|
||||
|
||||
+5
-6
@@ -9,16 +9,16 @@ importers:
|
||||
.:
|
||||
dependencies:
|
||||
better-sqlite3:
|
||||
specifier: ^12.8.0
|
||||
version: 12.8.0
|
||||
specifier: ^12.6.2
|
||||
version: 12.6.2
|
||||
|
||||
packages:
|
||||
|
||||
base64-js@1.5.1:
|
||||
resolution: {integrity: sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==}
|
||||
|
||||
better-sqlite3@12.8.0:
|
||||
resolution: {integrity: sha512-RxD2Vd96sQDjQr20kdP+F+dK/1OUNiVOl200vKBZY8u0vTwysfolF6Hq+3ZK2+h8My9YvZhHsF+RSGZW2VYrPQ==}
|
||||
better-sqlite3@12.6.2:
|
||||
resolution: {integrity: sha512-8VYKM3MjCa9WcaSAI3hzwhmyHVlH8tiGFwf0RlTsZPWJ1I5MkzjiudCo4KC4DxOaL/53A5B1sI/IbldNFDbsKA==}
|
||||
engines: {node: 20.x || 22.x || 23.x || 24.x || 25.x}
|
||||
|
||||
bindings@1.5.0:
|
||||
@@ -93,7 +93,6 @@ packages:
|
||||
prebuild-install@7.1.3:
|
||||
resolution: {integrity: sha512-8Mf2cbV7x1cXPUILADGI3wuhfqWvtiLA1iclTDbFRZkgRQS0NqsPZphna9V+HyTEadheuPmjaJMsbzKQFOzLug==}
|
||||
engines: {node: '>=10'}
|
||||
deprecated: No longer maintained. Please contact the author of the relevant native addon; alternatives are available.
|
||||
hasBin: true
|
||||
|
||||
pump@3.0.3:
|
||||
@@ -148,7 +147,7 @@ snapshots:
|
||||
|
||||
base64-js@1.5.1: {}
|
||||
|
||||
better-sqlite3@12.8.0:
|
||||
better-sqlite3@12.6.2:
|
||||
dependencies:
|
||||
bindings: 1.5.0
|
||||
prebuild-install: 7.1.3
|
||||
|
||||
+6
-13
@@ -302,13 +302,6 @@
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr><td align="center">
|
||||
<a href="https://homarr.dev/docs/integrations/search-ch" target="_blank" rel="noreferrer noopener">
|
||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/search-ch.png" alt="Search.ch" width="90" height="90" />
|
||||
<br/>
|
||||
<p align="center">Search.ch</p>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://homarr.dev/docs/integrations/seerr" target="_blank" rel="noreferrer noopener">
|
||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/seerr.svg" alt="Seerr" width="90" height="90" />
|
||||
<br/>
|
||||
@@ -349,22 +342,22 @@
|
||||
<br/>
|
||||
<p align="center">Transmission</p>
|
||||
</a>
|
||||
</td></tr>
|
||||
<tr><td align="center">
|
||||
</td>
|
||||
<td align="center">
|
||||
<a href="https://homarr.dev/docs/integrations/truenas" target="_blank" rel="noreferrer noopener">
|
||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/truenas.svg" alt="TrueNAS" width="90" height="90" />
|
||||
<br/>
|
||||
<p align="center">TrueNAS</p>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
</td></tr>
|
||||
<tr><td align="center">
|
||||
<a href="https://homarr.dev/docs/integrations/unifi-controller" target="_blank" rel="noreferrer noopener">
|
||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/unifi.png" alt="Unifi Controller" width="90" height="90" />
|
||||
<br/>
|
||||
<p align="center">Unifi<br/>Controller</p>
|
||||
</a>
|
||||
</td>
|
||||
<td align="center">
|
||||
</td></tr>
|
||||
<tr><td align="center">
|
||||
<a href="https://homarr.dev/docs/integrations/unraid" target="_blank" rel="noreferrer noopener">
|
||||
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/unraid.svg" alt="Unraid" width="90" height="90" />
|
||||
<br/>
|
||||
|
||||
+2
-2
@@ -7,9 +7,9 @@ http {
|
||||
listen 7575;
|
||||
listen [::]:7575;
|
||||
|
||||
# Route websockets traffic to port 3001
|
||||
# Route websockets traffic to port 3000 (integrated custom server)
|
||||
location /websockets {
|
||||
proxy_pass http://${HOSTNAME}:3001;
|
||||
proxy_pass http://${HOSTNAME}:3000;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "Upgrade";
|
||||
|
||||
+29
-26
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "homarr",
|
||||
"version": "1.58.0",
|
||||
"version": "1.56.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"build": "cross-env CI=true turbo build",
|
||||
@@ -17,6 +17,9 @@
|
||||
"db:studio": "pnpm -F db studio",
|
||||
"dev": "turbo dev --parallel",
|
||||
"docker:dev": "docker compose -f ./development/development.docker-compose.yml up",
|
||||
"docker:build": "docker build -t homarr:test .",
|
||||
"docker:test": "bash scripts/docker-test.sh",
|
||||
"docker:test:skip-build": "bash scripts/docker-test.sh --skip-build",
|
||||
"format": "turbo format --continue -- --cache --cache-location node_modules/.cache/.prettiercache",
|
||||
"format:fix": "turbo format --continue -- --write --cache --cache-location node_modules/.cache/.prettiercache",
|
||||
"lint": "turbo lint --continue -- --cache --cache-location node_modules/.cache/.eslintcache",
|
||||
@@ -26,7 +29,7 @@
|
||||
"release": "semantic-release",
|
||||
"scripts:update-bug-report-template": "tsx ./scripts/update-bug-report-template.mts",
|
||||
"scripts:update-readme-integrations": "tsx ./scripts/update-integration-list.mts",
|
||||
"start": "concurrently \"pnpm with-env node apps/tasks/tasks.cjs\" \"pnpm with-env node apps/websocket/wssServer.cjs\" \"pnpm -F nextjs start\"",
|
||||
"start": "pnpm -F nextjs start",
|
||||
"test": "cross-env NODE_ENV=development CI=true vitest run --exclude e2e --coverage.enabled ",
|
||||
"test:e2e": "cross-env NODE_ENV=development CI=true vitest e2e",
|
||||
"test:ui": "cross-env NODE_ENV=development CI=true vitest --exclude e2e --ui --coverage.enabled",
|
||||
@@ -42,27 +45,27 @@
|
||||
"@semantic-release/github": "^12.0.6",
|
||||
"@semantic-release/npm": "^13.1.5",
|
||||
"@semantic-release/release-notes-generator": "^14.1.0",
|
||||
"@testcontainers/redis": "^11.13.0",
|
||||
"@turbo/gen": "^2.8.21",
|
||||
"@vitejs/plugin-react": "^5.2.0",
|
||||
"@vitest/coverage-v8": "^4.1.2",
|
||||
"@vitest/ui": "^4.1.2",
|
||||
"conventional-changelog-conventionalcommits": "^9.3.1",
|
||||
"@testcontainers/redis": "^11.12.0",
|
||||
"@turbo/gen": "^2.8.15",
|
||||
"@vitejs/plugin-react": "^5.1.4",
|
||||
"@vitest/coverage-v8": "^4.0.18",
|
||||
"@vitest/ui": "^4.0.18",
|
||||
"conventional-changelog-conventionalcommits": "^9.3.0",
|
||||
"cross-env": "^10.1.0",
|
||||
"jsdom": "^29.0.1",
|
||||
"jsdom": "^28.1.0",
|
||||
"json5": "^2.2.3",
|
||||
"prettier": "^3.8.1",
|
||||
"semantic-release": "^25.0.3",
|
||||
"testcontainers": "^11.13.0",
|
||||
"turbo": "^2.8.21",
|
||||
"testcontainers": "^11.12.0",
|
||||
"turbo": "^2.8.15",
|
||||
"typescript": "^5.9.3",
|
||||
"vite-tsconfig-paths": "^6.1.1",
|
||||
"vitest": "^4.1.2"
|
||||
"vitest": "^4.0.18"
|
||||
},
|
||||
"packageManager": "pnpm@10.33.0",
|
||||
"packageManager": "pnpm@10.32.0",
|
||||
"engines": {
|
||||
"node": ">=24.14.1",
|
||||
"pnpm": ">=10.33.0"
|
||||
"node": ">=24.14.0",
|
||||
"pnpm": ">=10.32.0"
|
||||
},
|
||||
"pnpm": {
|
||||
"onlyBuiltDependencies": [
|
||||
@@ -77,25 +80,25 @@
|
||||
"tree-sitter-json"
|
||||
],
|
||||
"overrides": {
|
||||
"@babel/helpers@<7.26.10": ">=7.29.2",
|
||||
"@babel/runtime@<7.26.10": ">=7.29.2",
|
||||
"axios@>=1.0.0 <1.8.2": ">=1.14.0",
|
||||
"brace-expansion@>=2.0.0 <=2.0.1": ">=5.0.5",
|
||||
"brace-expansion@>=1.0.0 <=1.1.11": ">=5.0.5",
|
||||
"esbuild@<=0.24.2": ">=0.27.4",
|
||||
"@babel/helpers@<7.26.10": ">=7.28.6",
|
||||
"@babel/runtime@<7.26.10": ">=7.28.6",
|
||||
"axios@>=1.0.0 <1.8.2": ">=1.13.6",
|
||||
"brace-expansion@>=2.0.0 <=2.0.1": ">=5.0.4",
|
||||
"brace-expansion@>=1.0.0 <=1.1.11": ">=5.0.4",
|
||||
"esbuild@<=0.24.2": ">=0.27.3",
|
||||
"form-data@>=4.0.0 <4.0.4": ">=4.0.5",
|
||||
"hono@<4.6.5": ">=4.12.9",
|
||||
"hono@<4.6.5": ">=4.12.7",
|
||||
"linkifyjs@<4.3.2": ">=4.3.2",
|
||||
"nanoid@>=4.0.0 <5.0.9": ">=5.1.7",
|
||||
"nanoid@>=4.0.0 <5.0.9": ">=5.1.6",
|
||||
"prismjs@<1.30.0": ">=1.30.0",
|
||||
"proxmox-api>undici": "7.24.6",
|
||||
"proxmox-api>undici": "7.19.2",
|
||||
"react-is": "^19.2.4",
|
||||
"rollup@>=4.0.0 <4.22.4": ">=4.60.0",
|
||||
"rollup@>=4.0.0 <4.22.4": ">=4.59.0",
|
||||
"sha.js@<=2.4.11": ">=2.4.12",
|
||||
"tar-fs@>=3.0.0 <3.0.9": ">=3.1.2",
|
||||
"tar-fs@>=2.0.0 <2.1.3": ">=3.1.2",
|
||||
"tmp@<=0.2.3": ">=0.2.5",
|
||||
"vite@>=5.0.0 <=5.4.18": ">=8.0.3"
|
||||
"vite@>=5.0.0 <=5.4.18": ">=7.3.1"
|
||||
},
|
||||
"patchedDependencies": {
|
||||
"@types/node-unifi": "patches/@types__node-unifi.patch",
|
||||
|
||||
@@ -41,18 +41,18 @@
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@kubernetes/client-node": "^1.4.0",
|
||||
"@tanstack/react-query": "^5.95.2",
|
||||
"@trpc/client": "^11.16.0",
|
||||
"@trpc/react-query": "^11.16.0",
|
||||
"@trpc/server": "^11.16.0",
|
||||
"@trpc/tanstack-react-query": "^11.16.0",
|
||||
"@tanstack/react-query": "^5.90.21",
|
||||
"@trpc/client": "^11.12.0",
|
||||
"@trpc/react-query": "^11.12.0",
|
||||
"@trpc/server": "^11.12.0",
|
||||
"@trpc/tanstack-react-query": "^11.12.0",
|
||||
"lodash.clonedeep": "^4.5.0",
|
||||
"next": "16.2.1",
|
||||
"next": "16.1.6",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"superjson": "2.2.6",
|
||||
"trpc-to-openapi": "^3.2.0",
|
||||
"zod": "^4.3.6"
|
||||
"trpc-to-openapi": "^3.1.0",
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -140,7 +140,7 @@ interface DockerContainer {
|
||||
id: string;
|
||||
state: ContainerState;
|
||||
image: string;
|
||||
ports: Port[] | undefined;
|
||||
ports: Port[];
|
||||
iconUrl: string | null;
|
||||
cpuUsage: number;
|
||||
memoryUsage: number;
|
||||
|
||||
@@ -1,13 +1,11 @@
|
||||
import { TRPCError } from "@trpc/server";
|
||||
import type { MySqlRawQueryResult } from "drizzle-orm/mysql2";
|
||||
import type { QueryResult } from "pg";
|
||||
import { z } from "zod/v4";
|
||||
|
||||
import { createSaltAsync, hashPasswordAsync } from "@homarr/auth";
|
||||
import { createId } from "@homarr/common";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import type { Database } from "@homarr/db";
|
||||
import { and, eq, handleTransactionsAsync, like } from "@homarr/db";
|
||||
import { and, eq, like } from "@homarr/db";
|
||||
import { getMaxGroupPositionAsync } from "@homarr/db/queries";
|
||||
import { boards, groupMembers, groupPermissions, groups, invites, users } from "@homarr/db/schema";
|
||||
import { selectUserSchema } from "@homarr/db/validationSchemas";
|
||||
@@ -92,60 +90,15 @@ export const userRouter = createTRPCRouter({
|
||||
|
||||
await checkUsernameAlreadyTakenAndThrowAsync(ctx.db, "credentials", input.username);
|
||||
|
||||
const salt = await createSaltAsync();
|
||||
const hashedPassword = await hashPasswordAsync(input.password, salt);
|
||||
await createUserAsync(ctx.db, input);
|
||||
|
||||
const userId = createId();
|
||||
const user = {
|
||||
id: userId,
|
||||
name: input.username,
|
||||
password: hashedPassword,
|
||||
salt,
|
||||
};
|
||||
|
||||
await handleTransactionsAsync(ctx.db, {
|
||||
async handleAsync(db, schema) {
|
||||
await db.transaction(async (trx) => {
|
||||
await trx.insert(schema.users).values(user);
|
||||
|
||||
// Delete invite as it's used
|
||||
const queryResult = (await trx.delete(schema.invites).where(inviteWhere)) as
|
||||
| QueryResult
|
||||
| MySqlRawQueryResult;
|
||||
let count = 0;
|
||||
if (Array.isArray(queryResult)) {
|
||||
count = queryResult[0].affectedRows;
|
||||
} else {
|
||||
count = queryResult.rowCount ?? 0;
|
||||
}
|
||||
if (count === 0) {
|
||||
throw new TRPCError({
|
||||
code: "FORBIDDEN",
|
||||
message: "Invalid invite",
|
||||
});
|
||||
}
|
||||
});
|
||||
},
|
||||
handleSync(db) {
|
||||
db.transaction((trx) => {
|
||||
trx.insert(users).values(user).run();
|
||||
// Delete invite as it's used
|
||||
const result = trx.delete(invites).where(inviteWhere).run();
|
||||
|
||||
if (result.changes === 0) {
|
||||
throw new TRPCError({
|
||||
code: "FORBIDDEN",
|
||||
message: "Invalid invite",
|
||||
});
|
||||
}
|
||||
});
|
||||
},
|
||||
});
|
||||
// Delete invite as it's used
|
||||
await ctx.db.delete(invites).where(inviteWhere);
|
||||
}),
|
||||
create: permissionRequiredProcedure
|
||||
.requiresPermission("admin")
|
||||
.meta({ openapi: { method: "POST", path: "/api/users", tags: ["users"], protect: true } })
|
||||
.input(convertIntersectionToZodObject(userCreateSchema))
|
||||
.input(userCreateSchema)
|
||||
.output(z.void())
|
||||
.mutation(async ({ ctx, input }) => {
|
||||
throwIfCredentialsDisabled();
|
||||
@@ -376,7 +329,7 @@ export const userRouter = createTRPCRouter({
|
||||
await ctx.db.delete(users).where(eq(users.id, input.userId));
|
||||
}),
|
||||
changePassword: protectedProcedure
|
||||
.input(convertIntersectionToZodObject(userChangePasswordApiSchema))
|
||||
.input(userChangePasswordApiSchema)
|
||||
.output(z.void())
|
||||
.meta({ openapi: { method: "PATCH", path: "/api/users/{userId}/changePassword", tags: ["users"], protect: true } })
|
||||
.mutation(async ({ ctx, input }) => {
|
||||
|
||||
@@ -26,6 +26,5 @@ export const widgetRouter = createTRPCRouter({
|
||||
networkController: lazy(() => import("./network-controller").then((mod) => mod.networkControllerRouter)),
|
||||
firewall: lazy(() => import("./firewall").then((mod) => mod.firewallRouter)),
|
||||
notifications: lazy(() => import("./notifications").then((mod) => mod.notificationsRouter)),
|
||||
timetable: lazy(() => import("./timetable").then((mod) => mod.timetableRouter)),
|
||||
tracearr: lazy(() => import("./tracearr").then((mod) => mod.tracearrRouter)),
|
||||
});
|
||||
@@ -1,43 +0,0 @@
|
||||
import z from "zod";
|
||||
|
||||
import { getIntegrationKindsByCategory } from "@homarr/definitions";
|
||||
import { timetableOptionsSchema } from "@homarr/integrations/types";
|
||||
import {
|
||||
timetableGetTimetableRequestHandler,
|
||||
timetableSearchStationsRequestHandler,
|
||||
} from "@homarr/request-handler/timetable";
|
||||
|
||||
import { createOneIntegrationMiddleware } from "../../middlewares/integration";
|
||||
import { createTRPCRouter, publicProcedure } from "../../trpc";
|
||||
|
||||
export const timetableRouter = createTRPCRouter({
|
||||
getTimetable: publicProcedure
|
||||
.concat(createOneIntegrationMiddleware("query", ...getIntegrationKindsByCategory("timetable")))
|
||||
.input(timetableOptionsSchema)
|
||||
.query(async ({ input, ctx }) => {
|
||||
const innerHandler = timetableGetTimetableRequestHandler.handler(ctx.integration, {
|
||||
stationId: input.stationId,
|
||||
limit: input.limit,
|
||||
});
|
||||
|
||||
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
|
||||
|
||||
return data;
|
||||
}),
|
||||
searchStations: publicProcedure
|
||||
.concat(createOneIntegrationMiddleware("query", ...getIntegrationKindsByCategory("timetable")))
|
||||
.input(
|
||||
z.object({
|
||||
query: z.string(),
|
||||
}),
|
||||
)
|
||||
.query(async ({ input, ctx }) => {
|
||||
const innerHandler = timetableSearchStationsRequestHandler.handler(ctx.integration, {
|
||||
query: input.query,
|
||||
});
|
||||
|
||||
const { data } = await innerHandler.getCachedOrUpdatedDataAsync({ forceUpdate: false });
|
||||
|
||||
return data;
|
||||
}),
|
||||
});
|
||||
@@ -34,11 +34,11 @@
|
||||
"bcrypt": "^6.0.0",
|
||||
"cookies": "^0.9.1",
|
||||
"ldapts": "8.1.7",
|
||||
"next": "16.2.1",
|
||||
"next": "16.1.6",
|
||||
"next-auth": "5.0.0-beta.30",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"esbuild": "^0.27.4",
|
||||
"esbuild": "^0.27.3",
|
||||
"eslint": "^9.39.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
|
||||
@@ -29,13 +29,13 @@
|
||||
"@homarr/core": "workspace:^0.1.0",
|
||||
"@paralleldrive/cuid2": "^3.3.0",
|
||||
"cookie": "1.1.1",
|
||||
"dayjs": "^1.11.20",
|
||||
"next": "16.2.1",
|
||||
"dayjs": "^1.11.19",
|
||||
"next": "16.1.6",
|
||||
"octokit": "^5.0.5",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"undici": "7.24.6",
|
||||
"zod": "^4.3.6",
|
||||
"undici": "7.18.2",
|
||||
"zod": "^4.2.1",
|
||||
"zod-validation-error": "^5.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -37,23 +37,23 @@
|
||||
},
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@t3-oss/env-nextjs": "^0.13.11",
|
||||
"better-sqlite3": "^12.8.0",
|
||||
"@t3-oss/env-nextjs": "^0.13.10",
|
||||
"better-sqlite3": "^12.6.2",
|
||||
"dns-caching": "^0.2.9",
|
||||
"drizzle-orm": "^0.45.2",
|
||||
"ioredis": "5.10.1",
|
||||
"mysql2": "3.20.0",
|
||||
"drizzle-orm": "^0.45.1",
|
||||
"ioredis": "5.10.0",
|
||||
"mysql2": "3.19.1",
|
||||
"pg": "^8.20.0",
|
||||
"superjson": "2.2.6",
|
||||
"winston": "3.19.0",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"@types/better-sqlite3": "7.6.13",
|
||||
"@types/pg": "^8.20.0",
|
||||
"@types/pg": "^8.18.0",
|
||||
"eslint": "^9.39.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
|
||||
@@ -28,13 +28,13 @@
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/core": "workspace:^0.1.0",
|
||||
"@homarr/cron-jobs": "workspace:^0.1.0",
|
||||
"@tanstack/react-query": "^5.95.2",
|
||||
"@trpc/client": "^11.16.0",
|
||||
"@trpc/server": "^11.16.0",
|
||||
"@trpc/tanstack-react-query": "^11.16.0",
|
||||
"@tanstack/react-query": "^5.90.21",
|
||||
"@trpc/client": "^11.12.0",
|
||||
"@trpc/server": "^11.12.0",
|
||||
"@trpc/tanstack-react-query": "^11.12.0",
|
||||
"node-cron": "^4.2.1",
|
||||
"react": "19.2.4",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -18,7 +18,6 @@ import { mediaServerJob } from "./jobs/integrations/media-server";
|
||||
import { mediaTranscodingJob } from "./jobs/integrations/media-transcoding";
|
||||
import { networkControllerJob } from "./jobs/integrations/network-controller";
|
||||
import { refreshNotificationsJob } from "./jobs/integrations/notifications";
|
||||
import { timetableJob } from "./jobs/integrations/timetable";
|
||||
import { tracearrJob } from "./jobs/integrations/tracearr";
|
||||
import { minecraftServerStatusJob } from "./jobs/minecraft-server-status";
|
||||
import { pingJob } from "./jobs/ping";
|
||||
@@ -52,7 +51,6 @@ export const jobGroup = createCronJobGroup({
|
||||
firewallInterfaces: firewallInterfacesJob,
|
||||
refreshNotifications: refreshNotificationsJob,
|
||||
weather: weatherJob,
|
||||
timetable: timetableJob,
|
||||
tracearr: tracearrJob,
|
||||
});
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
import { EVERY_5_MINUTES } from "@homarr/cron-jobs-core/expressions";
|
||||
import { createRequestIntegrationJobHandler } from "@homarr/request-handler/lib/cached-request-integration-job-handler";
|
||||
import { timetableGetTimetableRequestHandler } from "@homarr/request-handler/timetable";
|
||||
|
||||
import { createCronJob } from "../../lib";
|
||||
|
||||
export const timetableJob = createCronJob("timetable", EVERY_5_MINUTES).withCallback(
|
||||
createRequestIntegrationJobHandler(timetableGetTimetableRequestHandler.handler, {
|
||||
widgetKinds: ["timetable"],
|
||||
getInput: {
|
||||
timetable: (options) =>
|
||||
options.station
|
||||
? {
|
||||
stationId: options.station.value,
|
||||
limit: 10,
|
||||
}
|
||||
: [],
|
||||
},
|
||||
}),
|
||||
);
|
||||
@@ -47,16 +47,16 @@
|
||||
"@homarr/core": "workspace:^0.1.0",
|
||||
"@homarr/definitions": "workspace:^0.1.0",
|
||||
"@homarr/server-settings": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@paralleldrive/cuid2": "^3.3.0",
|
||||
"@testcontainers/mysql": "^11.13.0",
|
||||
"@testcontainers/postgresql": "^11.13.0",
|
||||
"better-sqlite3": "^12.8.0",
|
||||
"@testcontainers/mysql": "^11.12.0",
|
||||
"@testcontainers/postgresql": "^11.12.0",
|
||||
"better-sqlite3": "^12.6.2",
|
||||
"dotenv": "^17.3.1",
|
||||
"drizzle-kit": "^0.31.10",
|
||||
"drizzle-orm": "^0.45.2",
|
||||
"drizzle-kit": "^0.31.9",
|
||||
"drizzle-orm": "^0.45.1",
|
||||
"drizzle-zod": "^0.8.3",
|
||||
"mysql2": "3.20.0",
|
||||
"mysql2": "3.19.1",
|
||||
"pg": "^8.20.0",
|
||||
"superjson": "2.2.6"
|
||||
},
|
||||
@@ -65,9 +65,9 @@
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"@types/better-sqlite3": "7.6.13",
|
||||
"@types/pg": "^8.20.0",
|
||||
"@types/pg": "^8.18.0",
|
||||
"dotenv-cli": "^11.0.0",
|
||||
"esbuild": "^0.27.4",
|
||||
"esbuild": "^0.27.3",
|
||||
"eslint": "^9.39.4",
|
||||
"prettier": "^3.8.1",
|
||||
"tsx": "4.20.4",
|
||||
|
||||
@@ -24,8 +24,8 @@
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"fast-xml-parser": "^5.5.9",
|
||||
"zod": "^4.3.6"
|
||||
"fast-xml-parser": "^5.4.2",
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -217,7 +217,7 @@ export const integrationDefs = {
|
||||
name: "Nextcloud",
|
||||
secretKinds: [["username", "password"]],
|
||||
iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/nextcloud.svg",
|
||||
category: ["calendar", "notifications"],
|
||||
category: ["calendar"],
|
||||
documentationUrl: createDocumentationLink("/docs/integrations/nextcloud"),
|
||||
},
|
||||
unifiController: {
|
||||
@@ -334,15 +334,6 @@ export const integrationDefs = {
|
||||
// @ts-expect-error - docs page will be created when integration is merged
|
||||
documentationUrl: createDocumentationLink("/docs/integrations/coolify"),
|
||||
},
|
||||
searchCh: {
|
||||
name: "Search.ch",
|
||||
secretKinds: [[]],
|
||||
iconUrl: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/png/search-ch.png",
|
||||
defaultUrl: "https://search.ch",
|
||||
category: ["timetable"],
|
||||
// @ts-expect-error - docs page will be created when integration is merged
|
||||
documentationUrl: createDocumentationLink("/docs/integrations/search-ch"),
|
||||
},
|
||||
immich: {
|
||||
name: "Immich",
|
||||
secretKinds: [["apiKey"]],
|
||||
@@ -443,7 +434,6 @@ export const integrationCategories = [
|
||||
"releasesProvider",
|
||||
"notifications",
|
||||
"firewall",
|
||||
"timetable",
|
||||
"photoService",
|
||||
"mediaMonitoring",
|
||||
] as const;
|
||||
|
||||
@@ -31,7 +31,6 @@ export const widgetKinds = [
|
||||
"systemResources",
|
||||
"coolify",
|
||||
"systemDisks",
|
||||
"timetable",
|
||||
"immich-serverStats",
|
||||
"immich-albumCarousel",
|
||||
"tracearr",
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
"dependencies": {
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/core": "workspace:^0.1.0",
|
||||
"dockerode": "^4.0.10"
|
||||
"dockerode": "^4.0.9"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -26,9 +26,9 @@
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@mantine/form": "^8.3.18",
|
||||
"@mantine/form": "^8.3.16",
|
||||
"mantine-form-zod-resolver": "^1.3.0",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -30,9 +30,9 @@
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"react": "19.2.4",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
},
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@ctrl/deluge": "^8.0.0",
|
||||
"@ctrl/deluge": "^7.5.2",
|
||||
"@ctrl/qbittorrent": "^9.11.2",
|
||||
"@ctrl/transmission": "^7.4.0",
|
||||
"@gitbeaker/rest": "^43.8.0",
|
||||
@@ -38,18 +38,18 @@
|
||||
"@homarr/redis": "workspace:^0.1.0",
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@immich/sdk": "^2.6.3",
|
||||
"@immich/sdk": "^2.5.6",
|
||||
"@jellyfin/sdk": "^0.13.0",
|
||||
"@octokit/auth-app": "^8.2.0",
|
||||
"ical.js": "^2.2.1",
|
||||
"maria2": "^0.4.1",
|
||||
"node-ical": "^0.22.1",
|
||||
"octokit": "^5.0.5",
|
||||
"proxmox-api": "1.1.1",
|
||||
"timezones-ical-library": "^2.1.3",
|
||||
"tsdav": "^2.1.8",
|
||||
"undici": "7.24.6",
|
||||
"undici": "7.18.2",
|
||||
"xml2js": "^0.6.2",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -40,7 +40,6 @@ import { PlexIntegration } from "../plex/plex-integration";
|
||||
import { ProwlarrIntegration } from "../prowlarr/prowlarr-integration";
|
||||
import { ProxmoxIntegration } from "../proxmox/proxmox-integration";
|
||||
import { QuayIntegration } from "../quay/quay-integration";
|
||||
import { SearchChIntegration } from "../search-ch/search-ch-integration";
|
||||
import { SeerrIntegration } from "../seerr/seerr-integration";
|
||||
import { TracearrIntegration } from "../tracearr/tracearr-integration";
|
||||
import { TrueNasIntegration } from "../truenas/truenas-integration";
|
||||
@@ -115,7 +114,6 @@ export const integrationCreators = {
|
||||
coolify: CoolifyIntegration,
|
||||
tracearr: TracearrIntegration,
|
||||
glances: GlancesIntegration,
|
||||
searchCh: SearchChIntegration,
|
||||
immich: ImmichIntegration,
|
||||
} satisfies Record<IntegrationKind, IntegrationInstance | [(input: IntegrationInput) => Promise<Integration>]>;
|
||||
|
||||
|
||||
@@ -33,7 +33,6 @@ export class DashDotIntegration extends Integration implements ISystemHealthMoni
|
||||
const memoryLoad = await this.getCurrentMemoryLoadAsync();
|
||||
const storageLoad = await this.getCurrentStorageLoadAsync();
|
||||
const networkLoad = await this.getCurrentNetworkLoadAsync();
|
||||
const gpuLoad = await this.getCurrentGpuLoadAsync();
|
||||
|
||||
const channel = this.getChannel();
|
||||
const history = await channel.getSliceUntilTimeAsync(dayjs().subtract(15, "minutes").toDate());
|
||||
@@ -57,14 +56,6 @@ export class DashDotIntegration extends Integration implements ISystemHealthMoni
|
||||
availablePkgUpdates: 0,
|
||||
rebootRequired: false,
|
||||
smart: [], // API endpoint does not provide S.M.A.R.T data.
|
||||
gpu: gpuLoad.map((gpu, index) => ({
|
||||
gpuId: `gpu-${index}`,
|
||||
name: info.gpuNames[index] ?? `GPU ${index}`,
|
||||
memoryUtilization: gpu.memory ?? 0,
|
||||
processorUtilization: gpu.load ?? 0,
|
||||
temperature: null,
|
||||
fanSpeed: null,
|
||||
})),
|
||||
uptime: info.uptime,
|
||||
version: `${info.operatingSystemVersion}`,
|
||||
loadAverage: {
|
||||
@@ -85,7 +76,6 @@ export class DashDotIntegration extends Integration implements ISystemHealthMoni
|
||||
cpuModel: serverInfo.cpu.model,
|
||||
operatingSystemVersion: `${serverInfo.os.distro} ${serverInfo.os.release} (${serverInfo.os.kernel})`,
|
||||
uptime: serverInfo.os.uptime,
|
||||
gpuNames: serverInfo.gpu.layout.map((gpu) => gpu.brand),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -160,17 +150,6 @@ export class DashDotIntegration extends Integration implements ISystemHealthMoni
|
||||
return await networkLoadApi.parseAsync(JSON.parse(result));
|
||||
}
|
||||
|
||||
private async getCurrentGpuLoadAsync() {
|
||||
try {
|
||||
const response = await fetchWithTrustedCertificatesAsync(this.url("/load/gpu"));
|
||||
const result = await response.json();
|
||||
const data = await gpuLoadApi.parseAsync(result);
|
||||
return data.layout;
|
||||
} catch {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
private getChannel() {
|
||||
return createChannelEventHistoryOld<z.infer<typeof cpuLoadPerCoreApiList>>(
|
||||
`integration:${this.integration.id}:history:cpu`,
|
||||
@@ -219,25 +198,6 @@ const internalServerInfoApi = z.object({
|
||||
),
|
||||
}),
|
||||
),
|
||||
gpu: z.object({
|
||||
layout: z
|
||||
.array(
|
||||
z.object({
|
||||
brand: z.string(),
|
||||
model: z.string().optional(),
|
||||
}),
|
||||
)
|
||||
.default([]),
|
||||
}),
|
||||
});
|
||||
|
||||
const cpuLoadPerCoreApiList = z.array(cpuLoadPerCoreApi);
|
||||
|
||||
const gpuLoadApi = z.object({
|
||||
layout: z.array(
|
||||
z.object({
|
||||
load: z.number().min(0).optional(),
|
||||
memory: z.number().min(0).optional(),
|
||||
}),
|
||||
),
|
||||
});
|
||||
@@ -59,14 +59,6 @@ export class GlancesIntegration extends Integration implements ISystemHealthMoni
|
||||
loadAverage: null,
|
||||
smart: [],
|
||||
cpuTemp: undefined,
|
||||
gpu: stats.gpu.map((gpu) => ({
|
||||
gpuId: gpu.gpu_id,
|
||||
name: gpu.name,
|
||||
memoryUtilization: gpu.mem ?? 0,
|
||||
processorUtilization: gpu.proc ?? 0,
|
||||
temperature: gpu.temperature ?? null,
|
||||
fanSpeed: gpu.fan_speed ?? null,
|
||||
})),
|
||||
};
|
||||
}
|
||||
|
||||
@@ -158,16 +150,4 @@ const allSchema = z.object({
|
||||
quicklook: z.object({
|
||||
cpu_name: z.string(),
|
||||
}),
|
||||
gpu: z
|
||||
.array(
|
||||
z.object({
|
||||
gpu_id: z.string(),
|
||||
name: z.string(),
|
||||
mem: z.number().nullable().optional(),
|
||||
proc: z.number().nullable().optional(),
|
||||
temperature: z.number().nullable().optional(),
|
||||
fan_speed: z.number().nullable().optional(),
|
||||
}),
|
||||
)
|
||||
.default([]),
|
||||
});
|
||||
@@ -1,6 +1,5 @@
|
||||
import { getAlbumInfo, getAllAlbums, getMyUser, getServerStatistics, init, searchUsers } from "@immich/sdk";
|
||||
|
||||
import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
import { ImageProxy } from "@homarr/image-proxy";
|
||||
|
||||
@@ -42,10 +41,7 @@ export class ImmichIntegration extends Integration {
|
||||
|
||||
public async getServerStatsAsync(): Promise<ImmichServerStats> {
|
||||
this.initClient();
|
||||
const [statistics, users] = await Promise.all([
|
||||
getServerStatistics(this.getRequestOptions()),
|
||||
searchUsers(this.getRequestOptions()),
|
||||
]);
|
||||
const [statistics, users] = await Promise.all([getServerStatistics(), searchUsers()]);
|
||||
return {
|
||||
photoCount: statistics.photos,
|
||||
userCount: users.length,
|
||||
@@ -56,7 +52,7 @@ export class ImmichIntegration extends Integration {
|
||||
|
||||
public async getAlbumAsync(albumId: string): Promise<ImmichAlbum> {
|
||||
this.initClient();
|
||||
const album = await getAlbumInfo({ id: albumId }, this.getRequestOptions());
|
||||
const album = await getAlbumInfo({ id: albumId });
|
||||
const imageProxy = new ImageProxy();
|
||||
return {
|
||||
albumName: album.albumName,
|
||||
@@ -93,24 +89,17 @@ export class ImmichIntegration extends Integration {
|
||||
}[]
|
||||
> {
|
||||
this.initClient();
|
||||
const albums = await getAllAlbums({}, this.getRequestOptions());
|
||||
const albums = await getAllAlbums({});
|
||||
return albums.map((album) => ({ id: album.id, albumName: album.albumName, assetCount: album.assetCount }));
|
||||
}
|
||||
|
||||
protected async testingAsync(input: IntegrationTestingInput): Promise<TestingResult> {
|
||||
protected async testingAsync(_: IntegrationTestingInput): Promise<TestingResult> {
|
||||
this.initClient();
|
||||
const user = await getMyUser(this.getRequestOptions(input.fetchAsync));
|
||||
const user = await getMyUser();
|
||||
logger.debug(`Logged in as ${user.name} (${user.id})`);
|
||||
return { success: true };
|
||||
}
|
||||
|
||||
private getRequestOptions(fetchAsync = fetchWithTrustedCertificatesAsync) {
|
||||
return {
|
||||
// Undici and node types are not the same
|
||||
fetch: fetchAsync as unknown as typeof fetch,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the credentials and prepares the client for calls.
|
||||
* Must be called before any other functions.
|
||||
|
||||
@@ -31,14 +31,6 @@ export interface SystemHealthMonitoring {
|
||||
overallStatus: string;
|
||||
healthy: boolean;
|
||||
}[];
|
||||
gpu: {
|
||||
gpuId: string;
|
||||
name: string;
|
||||
memoryUtilization: number;
|
||||
processorUtilization: number;
|
||||
temperature: number | null;
|
||||
fanSpeed: number | null;
|
||||
}[];
|
||||
}
|
||||
|
||||
// TODO: in the future decouple this from the Proxmox integration
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
import type { Station, Timetable, TimetableOptions } from "./timetable-types";
|
||||
|
||||
export interface TimetableIntegration {
|
||||
searchStationsAsync(query: string): Promise<Station[]>;
|
||||
getTimetableAsync(options: TimetableOptions): Promise<Timetable>;
|
||||
}
|
||||
@@ -1,33 +0,0 @@
|
||||
import z from "zod";
|
||||
|
||||
export interface Station {
|
||||
id: string;
|
||||
name: string;
|
||||
}
|
||||
|
||||
export const timetableOptionsSchema = z.object({
|
||||
stationId: z.string(),
|
||||
limit: z.number().default(10),
|
||||
});
|
||||
|
||||
export type TimetableOptions = z.infer<typeof timetableOptionsSchema>;
|
||||
|
||||
export interface TimetableEntry {
|
||||
timestamp: Date;
|
||||
delay: number;
|
||||
line: {
|
||||
name: string;
|
||||
color: string | null;
|
||||
} | null;
|
||||
location: string;
|
||||
platform: {
|
||||
name: string;
|
||||
hasChanged: boolean;
|
||||
} | null;
|
||||
}
|
||||
|
||||
export interface Timetable {
|
||||
stationId: string;
|
||||
timestamp: Date;
|
||||
entries: TimetableEntry[];
|
||||
}
|
||||
@@ -36,16 +36,6 @@ export class SystemHealthMonitoringMockService implements ISystemHealthMonitorin
|
||||
healthy: true,
|
||||
},
|
||||
],
|
||||
gpu: [
|
||||
{
|
||||
gpuId: "mock0",
|
||||
name: "Mock GPU RTX 4090",
|
||||
memoryUtilization: Math.floor(Math.random() * 100),
|
||||
processorUtilization: Math.floor(Math.random() * 100),
|
||||
temperature: Math.floor(Math.random() * 90),
|
||||
fanSpeed: Math.floor(Math.random() * 2000),
|
||||
},
|
||||
],
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -2,14 +2,11 @@ import type { Agent } from "https";
|
||||
import dayjs from "dayjs";
|
||||
import timezone from "dayjs/plugin/timezone";
|
||||
import utc from "dayjs/plugin/utc";
|
||||
import ICAL from "ical.js";
|
||||
import type { RequestInit as NodeFetchRequestInit } from "node-fetch";
|
||||
import { tzlib_get_ical_block, tzlib_get_timezones } from "timezones-ical-library";
|
||||
import * as ical from "node-ical";
|
||||
import { DAVClient } from "tsdav";
|
||||
import { z } from "zod";
|
||||
|
||||
import { ResponseError } from "@homarr/common/server";
|
||||
import { createHttpsAgentAsync, fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
|
||||
import { createHttpsAgentAsync } from "@homarr/core/infrastructure/http";
|
||||
import { createLogger } from "@homarr/core/infrastructure/logs";
|
||||
|
||||
import { HandleIntegrationErrors } from "../base/errors/decorator";
|
||||
@@ -19,35 +16,6 @@ import { Integration } from "../base/integration";
|
||||
import type { TestingResult } from "../base/test-connection/test-connection-service";
|
||||
import type { ICalendarIntegration } from "../interfaces/calendar/calendar-integration";
|
||||
import type { CalendarEvent } from "../interfaces/calendar/calendar-types";
|
||||
import type { Notification } from "../interfaces/notifications/notification-types";
|
||||
import type { INotificationsIntegration } from "../interfaces/notifications/notifications-integration";
|
||||
|
||||
// Register all existing timezones
|
||||
if (ICAL.TimezoneService.count === 0) {
|
||||
const timezones = tzlib_get_timezones() as string[];
|
||||
for (const tzid of timezones) {
|
||||
ICAL.TimezoneService.register(
|
||||
new ICAL.Timezone({
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-non-null-assertion
|
||||
component: new ICAL.Component(ICAL.parse((tzlib_get_ical_block(tzid) as string[])[0]!)),
|
||||
tzid,
|
||||
}),
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const notificationSchema = z.object({
|
||||
ocs: z.object({
|
||||
data: z.array(
|
||||
z.object({
|
||||
notification_id: z.number(),
|
||||
datetime: z.string(),
|
||||
subject: z.string(),
|
||||
message: z.string(),
|
||||
}),
|
||||
),
|
||||
}),
|
||||
});
|
||||
|
||||
const logger = createLogger({ module: "nextcloudIntegration" });
|
||||
|
||||
@@ -55,7 +23,7 @@ dayjs.extend(utc);
|
||||
dayjs.extend(timezone);
|
||||
|
||||
@HandleIntegrationErrors([integrationTsdavHttpErrorHandler])
|
||||
export class NextcloudIntegration extends Integration implements ICalendarIntegration, INotificationsIntegration {
|
||||
export class NextcloudIntegration extends Integration implements ICalendarIntegration {
|
||||
protected async testingAsync(input: IntegrationTestingInput): Promise<TestingResult> {
|
||||
const client = await this.createCalendarClientAsync(await createHttpsAgentAsync(input.options));
|
||||
await client.login();
|
||||
@@ -83,64 +51,42 @@ export class NextcloudIntegration extends Integration implements ICalendarIntegr
|
||||
|
||||
return calendarEvents
|
||||
.map((event) => {
|
||||
if (typeof event.data !== "string") {
|
||||
return [];
|
||||
}
|
||||
const comp = ICAL.Component.fromString(event.data);
|
||||
const veventComponent = comp.getFirstSubcomponent("vevent");
|
||||
// @ts-expect-error the typescript definitions for this package are wrong
|
||||
// eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-member-access
|
||||
const icalData = ical.default.parseICS(event.data) as ical.CalendarResponse;
|
||||
const veventObject = Object.values(icalData).find((data) => data.type === "VEVENT");
|
||||
|
||||
if (!veventComponent) {
|
||||
return [];
|
||||
if (!veventObject) {
|
||||
throw new Error(`Invalid event data object: ${JSON.stringify(event.data)}. Unable to process the calendar.`);
|
||||
}
|
||||
|
||||
const veventObject = new ICAL.Event(veventComponent);
|
||||
|
||||
logger.debug(`Converting VEVENT event to ${event.etag} from Nextcloud: ${JSON.stringify(veventObject)}`);
|
||||
|
||||
const eventUrlWithoutHost = new URL(event.url).pathname;
|
||||
const eventSlug = Buffer.from(eventUrlWithoutHost).toString("base64url");
|
||||
|
||||
const durationMs = veventObject.duration.toSeconds() * 1000;
|
||||
const startDates = veventObject.rrule ? veventObject.rrule.between(start, end) : [veventObject.start];
|
||||
|
||||
// Handle recurring events
|
||||
let startDates: Date[];
|
||||
if (veventObject.isRecurring()) {
|
||||
const iterator = veventObject.iterator();
|
||||
startDates = [];
|
||||
|
||||
// Iterate through occurrences within the time range
|
||||
let next: ICAL.Time | undefined;
|
||||
// next actually returns undefined when there are no more occurrences
|
||||
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
||||
while ((next = iterator.next())) {
|
||||
const nextStartDate = next.convertToZone(ICAL.Timezone.utcTimezone).toJSDate();
|
||||
if (nextStartDate > end) break;
|
||||
const nextEndDate = new Date(nextStartDate.getTime() + durationMs);
|
||||
if (nextEndDate < start) continue;
|
||||
|
||||
startDates.push(nextStartDate);
|
||||
}
|
||||
} else {
|
||||
startDates = [veventObject.startDate.convertToZone(ICAL.Timezone.utcTimezone).toJSDate()];
|
||||
}
|
||||
const durationMs = veventObject.end.getTime() - veventObject.start.getTime();
|
||||
|
||||
return startDates.map((startDate) => {
|
||||
const endDate = new Date(startDate.getTime() + durationMs);
|
||||
const dateInMillis = startDate.valueOf();
|
||||
|
||||
// Get color property from the component
|
||||
const colorProperty = veventComponent.getFirstProperty("color");
|
||||
const color = colorProperty?.getFirstValue() as string | undefined;
|
||||
const timezoneOffsetMinutes = veventObject.rrule?.origOptions.tzid
|
||||
? dayjs(startDate).tz(veventObject.rrule.origOptions.tzid).utcOffset()
|
||||
: 0;
|
||||
const utcStartDate = new Date(startDate.getTime() - timezoneOffsetMinutes * 60 * 1000);
|
||||
const endDate = new Date(utcStartDate.getTime() + durationMs);
|
||||
const dateInMillis = utcStartDate.valueOf();
|
||||
|
||||
return {
|
||||
title: veventObject.summary,
|
||||
subTitle: null,
|
||||
description: veventObject.description || null,
|
||||
startDate,
|
||||
description: veventObject.description,
|
||||
startDate: utcStartDate,
|
||||
endDate,
|
||||
image: null,
|
||||
location: veventObject.location || null,
|
||||
indicatorColor: color ?? "#ff8600",
|
||||
indicatorColor:
|
||||
"color" in veventObject && typeof veventObject.color === "string" ? veventObject.color : "#ff8600",
|
||||
links: [
|
||||
{
|
||||
href: this.externalUrl(
|
||||
@@ -158,29 +104,6 @@ export class NextcloudIntegration extends Integration implements ICalendarIntegr
|
||||
.flat();
|
||||
}
|
||||
|
||||
public async getNotificationsAsync(): Promise<Notification[]> {
|
||||
const url = this.url("/ocs/v2.php/apps/notifications/api/v2/notifications", { format: "json" });
|
||||
const response = await fetchWithTrustedCertificatesAsync(url, {
|
||||
headers: {
|
||||
Authorization: `Basic ${Buffer.from(
|
||||
`${this.getSecretValue("username")}:${this.getSecretValue("password")}`,
|
||||
).toString("base64")}`,
|
||||
"OCS-APIRequest": "true",
|
||||
},
|
||||
});
|
||||
|
||||
if (!response.ok) throw new ResponseError(response);
|
||||
|
||||
const json = notificationSchema.parse(await response.json());
|
||||
|
||||
return json.ocs.data.map((notification) => ({
|
||||
id: String(notification.notification_id),
|
||||
time: new Date(notification.datetime),
|
||||
title: notification.subject,
|
||||
body: notification.message,
|
||||
}));
|
||||
}
|
||||
|
||||
private async createCalendarClientAsync(agent?: Agent) {
|
||||
return new DAVClient({
|
||||
serverUrl: this.integration.url,
|
||||
|
||||
@@ -86,7 +86,6 @@ export class OpenMediaVaultIntegration extends Integration implements ISystemHea
|
||||
cpuTemp: cpuTempResult.success ? cpuTempResult.data.response.cputemp : undefined,
|
||||
fileSystem,
|
||||
smart,
|
||||
gpu: [], // OpenMediaVault does not expose GPU monitoring via its RPC API.
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -1,141 +0,0 @@
|
||||
import z from "zod";
|
||||
|
||||
import { ResponseError } from "@homarr/common/server";
|
||||
import { fetchWithTrustedCertificatesAsync } from "@homarr/core/infrastructure/http";
|
||||
|
||||
import type { IntegrationTestingInput } from "../base/integration";
|
||||
import { Integration } from "../base/integration";
|
||||
import { TestConnectionError } from "../base/test-connection/test-connection-error";
|
||||
import type { TestingResult } from "../base/test-connection/test-connection-service";
|
||||
import type { TimetableIntegration } from "../interfaces/timetable/timetable-integration";
|
||||
import type { Station, Timetable, TimetableOptions } from "../interfaces/timetable/timetable-types";
|
||||
|
||||
const supportedStationTypes = ["bus", "tram", "train", "ship", "cablecar", "funicular", "chairlift"];
|
||||
|
||||
export class SearchChIntegration extends Integration implements TimetableIntegration {
|
||||
protected async testingAsync(input: IntegrationTestingInput): Promise<TestingResult> {
|
||||
const response = await input.fetchAsync(this.url("/timetable/api/completion.json", { term: "Zürich" }));
|
||||
|
||||
if (!response.ok) {
|
||||
return TestConnectionError.StatusResult(response);
|
||||
}
|
||||
|
||||
return {
|
||||
success: true,
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Searches for stations matching the given query.
|
||||
* @param query The search query for station names.
|
||||
* @returns A list of stations matching the search query.
|
||||
* @docs https://search.ch/fahrplan/api/help
|
||||
*/
|
||||
public async searchStationsAsync(query: string): Promise<Station[]> {
|
||||
const response = await fetchWithTrustedCertificatesAsync(
|
||||
this.url("/timetable/api/completion.json", {
|
||||
term: query,
|
||||
show_ids: 1,
|
||||
nofavorites: 1,
|
||||
}),
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
throw new ResponseError(response);
|
||||
}
|
||||
|
||||
const data = await searchSchema.parseAsync(await response.json());
|
||||
|
||||
return (
|
||||
data
|
||||
// Remove completions like addresses, we only want stations.
|
||||
.filter((item) => supportedStationTypes.some((type) => item.iconclass.endsWith(type)))
|
||||
.map((item) => (item.id !== undefined ? { id: item.id, name: item.label } : null))
|
||||
.filter((item) => item !== null)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the departure timetable for a given station.
|
||||
* @param options Timetable options including station ID and limit.
|
||||
* @returns timetable for the given station.
|
||||
* @docs https://search.ch/fahrplan/api/help
|
||||
*/
|
||||
public async getTimetableAsync(options: TimetableOptions): Promise<Timetable> {
|
||||
const now = new Date();
|
||||
// The following format is used [01.01.2000, 23:59:00]. The API allows usage of DD.MM.YYYY format and HH:mm format
|
||||
const [date, time] = now.toLocaleString("en-CH", { timeZone: "Europe/Zurich" }).split(", ") as [string, string];
|
||||
|
||||
const response = await fetchWithTrustedCertificatesAsync(
|
||||
this.url("/timetable/api/stationboard.json", {
|
||||
stop: options.stationId,
|
||||
limit: options.limit,
|
||||
show_delays: 1,
|
||||
show_tracks: 1,
|
||||
date,
|
||||
time: time.substring(0, 5), // Only keep the HH:mm part of the time, as that's what the API expects
|
||||
}),
|
||||
);
|
||||
|
||||
if (!response.ok) {
|
||||
throw new ResponseError(response);
|
||||
}
|
||||
|
||||
const data = await timetableSchema.parseAsync(await response.json());
|
||||
|
||||
return {
|
||||
stationId: options.stationId,
|
||||
timestamp: now,
|
||||
entries: data.connections.map((connection) => {
|
||||
// Color is in format A35~F10~ for foreground and background color. Some only have ~~ and therefore no color
|
||||
const color = connection.color.split("~")[0];
|
||||
|
||||
return {
|
||||
timestamp: connection.time,
|
||||
line: connection.line
|
||||
? {
|
||||
name: connection.line,
|
||||
color: color && color.length >= 1 ? `#${color}` : null,
|
||||
}
|
||||
: null,
|
||||
location: connection.terminal.name,
|
||||
delay: connection.dep_delay,
|
||||
platform: connection.track
|
||||
? {
|
||||
// If the track name contains "!", it indicates a change in the track
|
||||
// so we remove the "!" from the name and set hasChanged to true
|
||||
name: connection.track.replace("!", ""),
|
||||
hasChanged: connection.track.includes("!"),
|
||||
}
|
||||
: null,
|
||||
};
|
||||
}),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
const timetableSchema = z.object({
|
||||
connections: z.array(
|
||||
z.object({
|
||||
time: z.string().transform((str) => new Date(str)),
|
||||
line: z.string().optional(),
|
||||
color: z.string(),
|
||||
terminal: z.object({
|
||||
name: z.string(),
|
||||
}),
|
||||
track: z.string().optional(),
|
||||
dep_delay: z
|
||||
.string()
|
||||
.optional()
|
||||
.transform((str) => (str ? parseInt(str) : 0)),
|
||||
}),
|
||||
),
|
||||
});
|
||||
|
||||
const searchSchema = z.array(
|
||||
z.object({
|
||||
id: z.string().optional(),
|
||||
label: z.string(),
|
||||
iconclass: z.string(), // This is in format sl-icon-type-{type}
|
||||
}),
|
||||
);
|
||||
@@ -297,7 +297,6 @@ export class TrueNasIntegration extends Integration implements ISystemHealthMoni
|
||||
version: systemInformation.version,
|
||||
cpuModelName: systemInformation.model,
|
||||
rebootRequired: false,
|
||||
gpu: [],
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -12,5 +12,4 @@ export * from "./unifi-controller/unifi-controller-types";
|
||||
export * from "./opnsense/opnsense-types";
|
||||
export * from "./interfaces/media-releases";
|
||||
export * from "./coolify/coolify-types";
|
||||
export * from "./interfaces/timetable/timetable-types";
|
||||
export * from "./tracearr/tracearr-types";
|
||||
@@ -70,7 +70,6 @@ export class UnraidIntegration extends Integration implements ISystemHealthMonit
|
||||
// See ArrayDiskStatus from https://studio.apollographql.com/public/Unraid-API/variant/current/explorer
|
||||
healthy: disk.status === "DISK_OK",
|
||||
})),
|
||||
gpu: [],
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
@@ -1,454 +0,0 @@
|
||||
/* eslint-disable @typescript-eslint/no-non-null-assertion */
|
||||
import type { StartedTestContainer } from "testcontainers";
|
||||
import { GenericContainer, getContainerRuntimeClient, ImageName, Wait } from "testcontainers";
|
||||
import { afterAll, beforeAll, describe, expect, test, vi } from "vitest";
|
||||
|
||||
import { createId } from "@homarr/common";
|
||||
import { createDb } from "@homarr/db/test";
|
||||
|
||||
import { NextcloudIntegration } from "../src";
|
||||
|
||||
// Mock the database
|
||||
vi.mock("@homarr/db", async (importActual) => {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
|
||||
const actual = await importActual<typeof import("@homarr/db")>();
|
||||
return {
|
||||
...actual,
|
||||
db: createDb(),
|
||||
};
|
||||
});
|
||||
|
||||
// Mock certificate verification
|
||||
vi.mock("@homarr/core/infrastructure/certificates", async (importActual) => {
|
||||
// eslint-disable-next-line @typescript-eslint/consistent-type-imports
|
||||
const actual = await importActual<typeof import("@homarr/core/infrastructure/certificates")>();
|
||||
return {
|
||||
...actual,
|
||||
getTrustedCertificateHostnamesAsync: vi.fn().mockImplementation(() => {
|
||||
return Promise.resolve([]);
|
||||
}),
|
||||
};
|
||||
});
|
||||
|
||||
const IMAGE_NAME = "nextcloud:latest";
|
||||
const DEFAULT_USERNAME = "admin";
|
||||
const DEFAULT_PASSWORD = "admin123";
|
||||
|
||||
interface CalendarTestEvent {
|
||||
summary: string;
|
||||
description?: string;
|
||||
location?: string;
|
||||
color?: string;
|
||||
dtstart: string;
|
||||
dtend: string;
|
||||
rrule?: string;
|
||||
timezone?: string;
|
||||
}
|
||||
|
||||
describe("Nextcloud integration", () => {
|
||||
let startedContainer: StartedTestContainer | null = null;
|
||||
let nextcloudIntegration: NextcloudIntegration | null = null;
|
||||
|
||||
beforeAll(async () => {
|
||||
const containerRuntimeClient = await getContainerRuntimeClient();
|
||||
await containerRuntimeClient.image.pull(ImageName.fromString(IMAGE_NAME));
|
||||
|
||||
startedContainer = await prepareNextcloudContainerAsync();
|
||||
nextcloudIntegration = createNextcloudIntegration(startedContainer);
|
||||
}, 100_000);
|
||||
|
||||
afterAll(async () => {
|
||||
if (startedContainer) {
|
||||
await startedContainer.stop();
|
||||
startedContainer = null;
|
||||
}
|
||||
});
|
||||
|
||||
describe("Test connection", () => {
|
||||
test("Test connection > Should work with valid credentials", async () => {
|
||||
// Act
|
||||
const result = await nextcloudIntegration!.testConnectionAsync();
|
||||
|
||||
// Assert
|
||||
expect(result.success).toBe(true);
|
||||
}, 20_000);
|
||||
|
||||
test("Test connection > Should fail with invalid credentials", async () => {
|
||||
// Arrange
|
||||
const invalidIntegration = createNextcloudIntegration(startedContainer!, "wrong-user", "wrong-pass");
|
||||
|
||||
// Act
|
||||
const result = await invalidIntegration.testConnectionAsync();
|
||||
|
||||
// Assert
|
||||
expect(result.success).toBe(false);
|
||||
}, 20_000);
|
||||
});
|
||||
|
||||
describe("Retrieve calendar events", () => {
|
||||
test("Retrieve calendar events > Should retrieve all fields correctly", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Test Meeting",
|
||||
description: "This is a test meeting",
|
||||
location: "Conference Room A",
|
||||
color: "#FF5733",
|
||||
dtstart: "20260415T140000Z",
|
||||
dtend: "20260415T150000Z",
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
const retrievedEvent = relevantEvents[0];
|
||||
expect(retrievedEvent).toMatchObject({
|
||||
title: testEvent.summary,
|
||||
description: testEvent.description,
|
||||
location: testEvent.location,
|
||||
indicatorColor: testEvent.color,
|
||||
});
|
||||
expect(retrievedEvent!.startDate.toISOString()).toBe("2026-04-15T14:00:00.000Z");
|
||||
expect(retrievedEvent!.endDate?.toISOString()).toBe("2026-04-15T15:00:00.000Z");
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with only required fields", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Simple Event",
|
||||
dtstart: "20260415T140000Z",
|
||||
dtend: "20260415T150000Z",
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
const retrievedEvent = relevantEvents[0];
|
||||
expect(retrievedEvent?.location).toBeNull();
|
||||
expect(retrievedEvent?.description).toBeNull();
|
||||
expect(retrievedEvent?.indicatorColor).toBe("#ff8600"); // Default color
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with timezone specified", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Timezone Event",
|
||||
dtstart: "20260415T140000",
|
||||
dtend: "20260415T150000",
|
||||
timezone: "Asia/Tokyo",
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
const retrievedEvent = relevantEvents[0];
|
||||
|
||||
expect(retrievedEvent!.startDate.toISOString()).toBe("2026-04-15T05:00:00.000Z"); // 14:00 in Tokyo is 05:00 UTC
|
||||
expect(retrievedEvent!.endDate?.toISOString()).toBe("2026-04-15T06:00:00.000Z"); // 15:00 in Tokyo is 06:00 UTC
|
||||
}, 120_000);
|
||||
test("Retrieve calendar events > Should work with event that starts before the range but ends within the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Early Meeting",
|
||||
dtstart: "20260401T230000Z", // Starts before the range
|
||||
dtend: "20260402T010000Z", // Ends within the range
|
||||
};
|
||||
const start = new Date("2026-04-02T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with event that starts within the range but ends after the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Late Meeting",
|
||||
dtstart: "20260430T230000Z", // Starts within the range
|
||||
dtend: "20260501T010000Z", // Ends after the range
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should not retrieve events outside the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Out of Range Meeting",
|
||||
dtstart: "20260301T140000Z", // Starts before the range
|
||||
dtend: "20260301T150000Z", // Ends before the range
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(0);
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with events that begin before the range and end after the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Spanning Meeting",
|
||||
dtstart: "20260330T230000Z", // Starts before the range
|
||||
dtend: "20260501T010000Z", // Ends after the range
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(1);
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with recurring events first occurrence before the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Recurring Meeting",
|
||||
dtstart: "20260330T140000Z", // First occurrence starts before the range
|
||||
dtend: "20260330T150000Z",
|
||||
rrule: "FREQ=DAILY;COUNT=5", // Daily for 5 occurrences
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(3);
|
||||
}, 20_000);
|
||||
test("Retrieve calendar events > Should work with recurring events that go beyond the range", async () => {
|
||||
// Arrange
|
||||
const calendarName = createId();
|
||||
const testEvent: CalendarTestEvent = {
|
||||
summary: "Working Week",
|
||||
dtstart: "20260302T090000Z",
|
||||
dtend: "20260306T170000Z",
|
||||
rrule: "FREQ=WEEKLY;COUNT=10",
|
||||
};
|
||||
const start = new Date("2026-04-01T00:00:00Z");
|
||||
const end = new Date("2026-04-30T23:59:59Z");
|
||||
|
||||
await createCalendarAsync(startedContainer!, calendarName);
|
||||
await createCalendarEventAsync(startedContainer!, calendarName, testEvent);
|
||||
|
||||
// Act
|
||||
const events = await nextcloudIntegration!.getCalendarEventsAsync(start, end);
|
||||
|
||||
// Assert
|
||||
const relevantEvents = events.filter((event) => event.title === testEvent.summary);
|
||||
expect(relevantEvents).toHaveLength(5);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
/**
|
||||
* Prepares a Nextcloud container with proper configuration
|
||||
*/
|
||||
async function prepareNextcloudContainerAsync(): Promise<StartedTestContainer> {
|
||||
const container = createNextcloudContainer();
|
||||
const startedContainer = await container.start();
|
||||
|
||||
return startedContainer;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Nextcloud container with proper configuration
|
||||
*/
|
||||
function createNextcloudContainer() {
|
||||
return new GenericContainer(IMAGE_NAME)
|
||||
.withEnvironment({
|
||||
NEXTCLOUD_ADMIN_USER: DEFAULT_USERNAME,
|
||||
NEXTCLOUD_ADMIN_PASSWORD: DEFAULT_PASSWORD,
|
||||
NEXTCLOUD_TRUSTED_DOMAINS: "*",
|
||||
SQLITE_DATABASE: "nextcloud", // Use SQLite for faster startup
|
||||
})
|
||||
.withExposedPorts(80)
|
||||
.withWaitStrategy(Wait.forHttp("/status.php", 80).forStatusCode(200))
|
||||
.withStartupTimeout(120_000);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a Nextcloud integration instance
|
||||
*/
|
||||
function createNextcloudIntegration(
|
||||
container: StartedTestContainer,
|
||||
username?: string,
|
||||
password?: string,
|
||||
): NextcloudIntegration {
|
||||
return new NextcloudIntegration({
|
||||
id: "1",
|
||||
decryptedSecrets: [
|
||||
{
|
||||
kind: "username",
|
||||
value: username ?? DEFAULT_USERNAME,
|
||||
},
|
||||
{
|
||||
kind: "password",
|
||||
value: password ?? DEFAULT_PASSWORD,
|
||||
},
|
||||
],
|
||||
name: "Nextcloud",
|
||||
url: `http://${container.getHost()}:${container.getMappedPort(80)}`,
|
||||
externalUrl: null,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a calendar in Nextcloud via OCS API
|
||||
*/
|
||||
async function createCalendarAsync(container: StartedTestContainer, calendarName: string): Promise<void> {
|
||||
const host = container.getHost();
|
||||
const port = container.getMappedPort(80);
|
||||
const url = `http://${host}:${port}/remote.php/dav/calendars/${DEFAULT_USERNAME}/${calendarName}`;
|
||||
|
||||
const auth = Buffer.from(`${DEFAULT_USERNAME}:${DEFAULT_PASSWORD}`).toString("base64");
|
||||
|
||||
const response = await fetch(url, {
|
||||
method: "MKCALENDAR",
|
||||
headers: {
|
||||
Authorization: `Basic ${auth}`,
|
||||
"Content-Type": "application/xml",
|
||||
},
|
||||
body: `<?xml version="1.0" encoding="UTF-8"?>
|
||||
<c:mkcalendar xmlns:c="urn:ietf:params:xml:ns:caldav" xmlns:d="DAV:">
|
||||
<d:set>
|
||||
<d:prop>
|
||||
<d:displayname>${calendarName}</d:displayname>
|
||||
</d:prop>
|
||||
</d:set>
|
||||
</c:mkcalendar>`,
|
||||
});
|
||||
|
||||
if (!response.ok && response.status !== 201) {
|
||||
throw new Error(`Failed to create calendar: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a calendar event in Nextcloud via CalDAV
|
||||
*/
|
||||
async function createCalendarEventAsync(
|
||||
container: StartedTestContainer,
|
||||
calendarName: string,
|
||||
event: CalendarTestEvent,
|
||||
): Promise<void> {
|
||||
const host = container.getHost();
|
||||
const port = container.getMappedPort(80);
|
||||
const id = createId();
|
||||
const url = `http://${host}:${port}/remote.php/dav/calendars/${DEFAULT_USERNAME}/${calendarName}/${id}.ics`;
|
||||
|
||||
const auth = Buffer.from(`${DEFAULT_USERNAME}:${DEFAULT_PASSWORD}`).toString("base64");
|
||||
|
||||
// Build iCalendar format
|
||||
const icalData = buildICalEvent(id, event);
|
||||
|
||||
const response = await fetch(url, {
|
||||
method: "PUT",
|
||||
headers: {
|
||||
Authorization: `Basic ${auth}`,
|
||||
"Content-Type": "text/calendar",
|
||||
},
|
||||
body: icalData,
|
||||
});
|
||||
|
||||
if (!response.ok && response.status !== 201) {
|
||||
throw new Error(`Failed to create event: ${response.status} ${response.statusText}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds an iCalendar format string from event data
|
||||
*/
|
||||
function buildICalEvent(uid: string, event: CalendarTestEvent): string {
|
||||
const lines = [
|
||||
"BEGIN:VCALENDAR",
|
||||
"VERSION:2.0",
|
||||
"PRODID:-//Homarr Tests//EN",
|
||||
"BEGIN:VEVENT",
|
||||
`UID:${uid}`,
|
||||
`DTSTAMP:${new Date().toISOString().replace(/[-:]/g, "").split(".")[0]}Z`,
|
||||
`DTSTART${event.timezone ? `;TZID=${event.timezone}` : ""}:${event.dtstart}`,
|
||||
`DTEND${event.timezone ? `;TZID=${event.timezone}` : ""}:${event.dtend}`,
|
||||
`SUMMARY:${event.summary}`,
|
||||
];
|
||||
|
||||
if (event.description) {
|
||||
lines.push(`DESCRIPTION:${event.description}`);
|
||||
}
|
||||
|
||||
if (event.location) {
|
||||
lines.push(`LOCATION:${event.location}`);
|
||||
}
|
||||
|
||||
if (event.color) {
|
||||
lines.push(`COLOR:${event.color}`);
|
||||
}
|
||||
|
||||
if (event.rrule) {
|
||||
lines.push(`RRULE:${event.rrule}`);
|
||||
}
|
||||
|
||||
lines.push("END:VEVENT", "END:VCALENDAR");
|
||||
|
||||
return lines.join("\r\n");
|
||||
}
|
||||
@@ -33,13 +33,13 @@
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@tabler/icons-react": "^3.41.0",
|
||||
"dayjs": "^1.11.20",
|
||||
"next": "16.2.1",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@tabler/icons-react": "^3.40.0",
|
||||
"dayjs": "^1.11.19",
|
||||
"next": "16.1.6",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -57,12 +57,10 @@ export const AddBoardModal = createModal(({ actions }) => {
|
||||
{...form.getInputProps("name")}
|
||||
description={
|
||||
boardNameStatus.description ? (
|
||||
<span>
|
||||
<Group c={boardNameStatus.description.color} gap="xs" align="center">
|
||||
{boardNameStatus.description.icon ? <boardNameStatus.description.icon size={16} /> : null}
|
||||
<span>{boardNameStatus.description.label}</span>
|
||||
</Group>
|
||||
</span>
|
||||
<Group c={boardNameStatus.description.color} gap="xs" align="center">
|
||||
{boardNameStatus.description.icon ? <boardNameStatus.description.icon size={16} /> : null}
|
||||
<span>{boardNameStatus.description.label}</span>
|
||||
</Group>
|
||||
) : null
|
||||
}
|
||||
/>
|
||||
|
||||
@@ -21,7 +21,7 @@ export const AddDockerAppToHomarrModal = createModal<AddDockerAppToHomarrProps>(
|
||||
{
|
||||
initialValues: {
|
||||
containerUrls: innerProps.selectedContainers.map((container) => {
|
||||
if (Array.isArray(container.ports) && container.ports[0]) {
|
||||
if (container.ports[0]) {
|
||||
return `http://${container.ports[0].IP}:${container.ports[0].PublicPort}`;
|
||||
}
|
||||
|
||||
|
||||
@@ -24,8 +24,8 @@
|
||||
"dependencies": {
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/hooks": "^8.3.18",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@mantine/hooks": "^8.3.16",
|
||||
"react": "19.2.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -24,8 +24,8 @@
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@mantine/notifications": "^8.3.18",
|
||||
"@tabler/icons-react": "^3.41.0"
|
||||
"@mantine/notifications": "^8.3.16",
|
||||
"@tabler/icons-react": "^3.40.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -37,21 +37,21 @@
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@homarr/validation": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/hooks": "^8.3.18",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@mantine/hooks": "^8.3.16",
|
||||
"adm-zip": "0.5.16",
|
||||
"next": "16.2.1",
|
||||
"next": "16.1.6",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"superjson": "2.2.6",
|
||||
"zod": "^4.3.6",
|
||||
"zod": "^4.2.1",
|
||||
"zod-form-data": "^3.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
"@homarr/prettier-config": "workspace:^0.1.0",
|
||||
"@homarr/tsconfig": "workspace:^0.1.0",
|
||||
"@types/adm-zip": "0.5.8",
|
||||
"@types/adm-zip": "0.5.7",
|
||||
"eslint": "^9.39.4",
|
||||
"typescript": "^5.9.3"
|
||||
}
|
||||
|
||||
@@ -101,7 +101,6 @@ const optionMapping: OptionMapping = {
|
||||
allowMicrophone: (oldOptions) => oldOptions.allowMicrophone,
|
||||
allowGeolocation: (oldOptions) => oldOptions.allowGeolocation,
|
||||
allowScrolling: (oldOptions) => oldOptions.allowScrolling,
|
||||
allowModals: () => undefined,
|
||||
},
|
||||
video: {
|
||||
feedUrl: (oldOptions) => oldOptions.FeedUrl,
|
||||
@@ -162,7 +161,6 @@ const optionMapping: OptionMapping = {
|
||||
sectionIndicatorRequirement: (oldOptions) =>
|
||||
"sectionIndicatorColor" in oldOptions ? oldOptions.sectionIndicatorColor : undefined,
|
||||
showUptime: () => undefined,
|
||||
gpu: () => undefined,
|
||||
visibleClusterSections: (oldOptions) => {
|
||||
if (!("showNode" in oldOptions)) return undefined;
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@
|
||||
"prettier": "@homarr/prettier-config",
|
||||
"dependencies": {
|
||||
"@homarr/common": "workspace:^0.1.0",
|
||||
"zod": "^4.3.6"
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
"@homarr/core": "workspace:^",
|
||||
"@homarr/db": "workspace:^",
|
||||
"@homarr/definitions": "workspace:^",
|
||||
"ioredis": "5.10.1",
|
||||
"ioredis": "5.10.0",
|
||||
"superjson": "2.2.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import type { LogLevel } from "@homarr/core/infrastructure/logs/constants";
|
||||
|
||||
import { createListChannel, createQueueChannel, createSubPubChannel } from "./lib/channel";
|
||||
import { createCacheChannel, createListChannel, createQueueChannel, createSubPubChannel } from "./lib/channel";
|
||||
|
||||
export {
|
||||
createCacheChannel,
|
||||
@@ -40,3 +40,14 @@ export interface LoggerMessage {
|
||||
}
|
||||
|
||||
export const loggingChannel = createSubPubChannel<LoggerMessage>("logging");
|
||||
|
||||
/**
|
||||
* POC: Redis cache for widget prefetch data.
|
||||
* Caches serialized query data per widget kind to avoid database queries on every page load.
|
||||
* Default TTL: 5 minutes (matches existing cron job intervals).
|
||||
*
|
||||
* Usage: see packages/widgets/src/prefetch.ts
|
||||
* This can be reverted by reverting this commit.
|
||||
*/
|
||||
export const createWidgetPrefetchCache = (widgetKind: string) =>
|
||||
createCacheChannel<Record<string, unknown>>(`widget-prefetch:${widgetKind}`, 5 * 60 * 1000);
|
||||
@@ -30,11 +30,11 @@
|
||||
"@homarr/docker": "workspace:^0.1.0",
|
||||
"@homarr/integrations": "workspace:^0.1.0",
|
||||
"@homarr/redis": "workspace:^0.1.0",
|
||||
"dayjs": "^1.11.20",
|
||||
"dayjs": "^1.11.19",
|
||||
"octokit": "^5.0.5",
|
||||
"superjson": "2.2.6",
|
||||
"undici": "7.24.6",
|
||||
"zod": "^4.3.6"
|
||||
"undici": "7.18.2",
|
||||
"zod": "^4.2.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@homarr/eslint-config": "workspace:^0.2.0",
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import dayjs from "dayjs";
|
||||
import type { ContainerInfo, ContainerStats } from "dockerode";
|
||||
import type Dockerode from "dockerode";
|
||||
|
||||
import { db, like, or } from "@homarr/db";
|
||||
import { icons } from "@homarr/db/schema";
|
||||
@@ -73,7 +72,7 @@ async function getContainersWithStatsAsync() {
|
||||
cpuUsage,
|
||||
memoryUsage,
|
||||
image: container.Image,
|
||||
ports: container.Ports as Dockerode.Port[] | undefined,
|
||||
ports: container.Ports,
|
||||
};
|
||||
});
|
||||
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
import dayjs from "dayjs";
|
||||
|
||||
import type { IntegrationKindByCategory } from "@homarr/definitions";
|
||||
import { createIntegrationAsync } from "@homarr/integrations";
|
||||
import type { Station, Timetable } from "@homarr/integrations/types";
|
||||
|
||||
import { createCachedIntegrationRequestHandler } from "./lib/cached-integration-request-handler";
|
||||
|
||||
export const timetableSearchStationsRequestHandler = createCachedIntegrationRequestHandler<
|
||||
Station[],
|
||||
IntegrationKindByCategory<"timetable">,
|
||||
{ query: string }
|
||||
>({
|
||||
async requestAsync(integration, input) {
|
||||
const integrationInstance = await createIntegrationAsync(integration);
|
||||
return await integrationInstance.searchStationsAsync(input.query);
|
||||
},
|
||||
queryKey: "timetableSearchStations",
|
||||
cacheDuration: dayjs.duration(1, "day"),
|
||||
});
|
||||
|
||||
export const timetableGetTimetableRequestHandler = createCachedIntegrationRequestHandler<
|
||||
Timetable,
|
||||
IntegrationKindByCategory<"timetable">,
|
||||
{ stationId: string; limit: number }
|
||||
>({
|
||||
async requestAsync(integration, input) {
|
||||
const integrationInstance = await createIntegrationAsync(integration);
|
||||
return await integrationInstance.getTimetableAsync({
|
||||
stationId: input.stationId,
|
||||
limit: input.limit,
|
||||
});
|
||||
},
|
||||
queryKey: "timetableGetTimetable",
|
||||
cacheDuration: dayjs.duration(1, "minute"),
|
||||
});
|
||||
@@ -25,8 +25,8 @@
|
||||
"dependencies": {
|
||||
"@homarr/db": "workspace:^0.1.0",
|
||||
"@homarr/server-settings": "workspace:^0.1.0",
|
||||
"@mantine/dates": "^8.3.18",
|
||||
"next": "16.2.1",
|
||||
"@mantine/dates": "^8.3.16",
|
||||
"next": "16.1.6",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4"
|
||||
},
|
||||
|
||||
@@ -33,12 +33,12 @@
|
||||
"@homarr/settings": "workspace:^0.1.0",
|
||||
"@homarr/translation": "workspace:^0.1.0",
|
||||
"@homarr/ui": "workspace:^0.1.0",
|
||||
"@mantine/core": "^8.3.18",
|
||||
"@mantine/hooks": "^8.3.18",
|
||||
"@mantine/spotlight": "^8.3.18",
|
||||
"@tabler/icons-react": "^3.41.0",
|
||||
"jotai": "^2.19.0",
|
||||
"next": "16.2.1",
|
||||
"@mantine/core": "^8.3.16",
|
||||
"@mantine/hooks": "^8.3.16",
|
||||
"@mantine/spotlight": "^8.3.16",
|
||||
"@tabler/icons-react": "^3.40.0",
|
||||
"jotai": "^2.18.1",
|
||||
"next": "16.1.6",
|
||||
"react": "19.2.4",
|
||||
"react-dom": "19.2.4",
|
||||
"use-deep-compare-effect": "^1.8.1"
|
||||
|
||||
Loaded 100 of 165 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user