From 657704340c5ad8c1b8614278c9cb9f6ae83441fe Mon Sep 17 00:00:00 2001
From: ajnart
Date: Thu, 30 Jul 2026 16:24:11 +0200
Subject: [PATCH] refactor: trim v2 release hardening
---
.dockerignore | 1 +
.env.example | 2 -
Dockerfile | 2 +-
apps/docs/README.md | 4 +-
.../advanced/development/getting-started.mdx | 11 +-
.../advanced/environment-variables/index.mdx | 15 +-
apps/docs/docs/management/workshop/index.mdx | 10 +-
apps/docs/docusaurus.config.ts | 9 +-
.../src/components/workshop/DetailPage.tsx | 7 +-
.../src/components/workshop/WorkshopAdmin.tsx | 5 +-
.../src/components/workshop/WorkshopApp.tsx | 11 +-
apps/docs/src/lib/runtime-config.ts | 21 -
apps/docs/src/pages/workshop/admin/index.tsx | 7 +-
apps/docs/src/pages/workshop/index.tsx | 3 +-
apps/docs/static/workshop-runtime-config.js | 1 -
apps/nextjs/src/app/[locale]/layout.tsx | 1 -
apps/nextjs/src/app/api/[...trpc]/route.ts | 4 +-
.../configuration-request/[token]/route.ts | 4 +-
.../src/app/api/mcp/[transport]/route.spec.ts | 10 +-
.../src/app/api/mcp/[transport]/route.ts | 4 +-
apps/nextjs/src/app/api/trpc/[trpc]/route.ts | 4 +-
apps/workshop/.env.example | 2 -
apps/workshop/Dockerfile | 28 +-
apps/workshop/Dockerfile.dockerignore | 7 +
apps/workshop/README.md | 5 +-
apps/workshop/docker-compose.yml | 11 +-
apps/workshop/entrypoint.sh | 61 ---
apps/workshop/pb_hooks/workshop.pb.js | 11 +-
apps/workshop/test.sh | 137 +-----
apps/workshop/tests/entrypoint-url.mjs | 72 ----
apps/workshop/tests/workshop-contracts.mjs | 103 +----
apps/workshop/tests/workshop-oauth-hook.mjs | 168 --------
.../tests/workshop-rollback.integration.mjs | 261 -----------
apps/workshop/workshop-url.awk | 111 -----
e2e/custom-widgets-custom-jsx-v2.spec.ts | 404 ++----------------
e2e/onboarding.spec.ts | 91 ++--
e2e/shared/actions/onboarding-actions.ts | 5 +-
e2e/shared/mock-api-server.ts | 25 +-
packages/api/package.json | 1 -
.../api/src/custom-widget-configuration.ts | 1 -
packages/api/src/custom-widget-state-mode.ts | 4 -
.../custom-widget/configuration-requests.ts | 4 +-
.../custom-widget/custom-widget-router.ts | 3 +-
.../custom-widget/management-queries.ts | 43 +-
.../preview-action-procedures.ts | 67 ++-
.../custom-widget/preview-query-procedures.ts | 86 ++--
.../router/custom-widget/preview-sessions.ts | 3 +-
.../router/custom-widget/request-executor.ts | 71 +--
.../router/custom-widget/request-limits.ts | 14 +-
.../router/custom-widget/response-cache.ts | 296 -------------
.../request-execution-limits.spec.ts | 118 -----
.../response-cache-redis.spec.ts | 58 ---
.../test/custom-widget/response-cache.spec.ts | 91 ----
.../test/custom-widget/state-mode.spec.ts | 16 -
.../api/src/router/test/trpc-context.spec.ts | 46 --
.../router/test/widgets/custom-api-v2.spec.ts | 243 +----------
packages/api/src/router/widgets/custom-api.ts | 178 +++-----
packages/api/src/trpc.ts | 4 +-
packages/common/src/request.ts | 30 +-
.../scripts/ai-evaluation-cases.ts | 143 +------
.../custom-widgets/scripts/ai-evaluation.ts | 90 +---
.../scripts/evaluate-ai-authoring.ts | 11 +-
.../scripts/generate-component-metadata.ts | 5 +-
.../src/runtime/refresh-button.tsx | 3 +-
packages/custom-widgets/src/runtime/types.ts | 2 -
packages/custom-widgets/src/server/index.ts | 1 +
.../src/server/request-executor.ts | 43 +-
.../src/test/ai-evaluation.spec.ts | 76 ----
.../custom-widgets/src/test/runtime.spec.tsx | 21 +-
packages/widgets/src/custom-api/component.tsx | 1 -
.../custom-jsx-display-refresh.spec.tsx | 139 ------
.../src/custom-api/custom-jsx-display.tsx | 1 -
.../custom-api/widget-definition-context.tsx | 99 +----
.../custom-api/widget-invalidation.spec.ts | 58 ---
.../src/custom-api/widget-invalidation.ts | 27 --
packages/workshop/src/schema.spec.ts | 18 -
packages/workshop/src/schema.ts | 13 -
pnpm-lock.yaml | 3 -
turbo.json | 14 +-
79 files changed, 405 insertions(+), 3378 deletions(-)
delete mode 100644 apps/docs/src/lib/runtime-config.ts
delete mode 100644 apps/docs/static/workshop-runtime-config.js
create mode 100644 apps/workshop/Dockerfile.dockerignore
delete mode 100644 apps/workshop/tests/entrypoint-url.mjs
delete mode 100644 apps/workshop/tests/workshop-oauth-hook.mjs
delete mode 100644 apps/workshop/tests/workshop-rollback.integration.mjs
delete mode 100644 apps/workshop/workshop-url.awk
delete mode 100644 packages/api/src/custom-widget-state-mode.ts
delete mode 100644 packages/api/src/router/custom-widget/response-cache.ts
delete mode 100644 packages/api/src/router/test/custom-widget/request-execution-limits.spec.ts
delete mode 100644 packages/api/src/router/test/custom-widget/response-cache-redis.spec.ts
delete mode 100644 packages/api/src/router/test/custom-widget/response-cache.spec.ts
delete mode 100644 packages/api/src/router/test/custom-widget/state-mode.spec.ts
delete mode 100644 packages/api/src/router/test/trpc-context.spec.ts
delete mode 100644 packages/widgets/src/custom-api/custom-jsx-display-refresh.spec.tsx
delete mode 100644 packages/widgets/src/custom-api/widget-invalidation.spec.ts
delete mode 100644 packages/widgets/src/custom-api/widget-invalidation.ts
diff --git a/.dockerignore b/.dockerignore
index 532d857ed..521c55109 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -17,6 +17,7 @@ coverage
dev
.build
e2e
+apps/docs
apps/nextjs/.next
.env
.env.*
diff --git a/.env.example b/.env.example
index 14c729c92..997d60865 100644
--- a/.env.example
+++ b/.env.example
@@ -71,10 +71,8 @@ HOMARR_WEBSITE_URL=https://homarr.dev
# WORKSHOP_WEB_URL=https://homarr.dev/workshop
# Documentation and PocketBase deployment settings.
-# DOCS_BASE_URL=/
# WORKSHOP_PUBLIC_ORIGIN=https://homarr.dev
# PB_ALLOWED_ORIGINS=*
-# WORKSHOP_REQUIRE_OAUTH=false
# Local Workshop stack:
# HOMARR_WEBSITE_URL=http://127.0.0.1:3003
diff --git a/Dockerfile b/Dockerfile
index 40ba325ae..8f4c5e49a 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -37,7 +37,7 @@ RUN --mount=type=secret,id=TURBO_API,env=TURBO_API \
--mount=type=secret,id=TURBO_TEAM,env=TURBO_TEAM \
--mount=type=secret,id=TURBO_TOKEN,env=TURBO_TOKEN \
--mount=type=secret,id=TURBO_REMOTE_CACHE_SIGNATURE_KEY,env=TURBO_REMOTE_CACHE_SIGNATURE_KEY \
- TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" pnpm turbo build --filter='!@homarr/docs'
+ TURBO_PLATFORM="${TARGETPLATFORM:-linux/amd64}" pnpm build
FROM base AS runner
WORKDIR /app
diff --git a/apps/docs/README.md b/apps/docs/README.md
index 15639cee1..ede750aa7 100644
--- a/apps/docs/README.md
+++ b/apps/docs/README.md
@@ -26,8 +26,8 @@ pnpm dev
WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs
```
-The standalone docs use `WORKSHOP_API_URL` for PocketBase, `HOMARR_WEBSITE_URL` for the public site origin, and
-`DOCS_BASE_URL` for the deployment path. The old `WORKSHOP_URL` name is a deprecated one-release alias.
+The standalone docs use `WORKSHOP_API_URL` for PocketBase and `HOMARR_WEBSITE_URL` for the public site origin. The old
+`WORKSHOP_URL` name is a deprecated one-release alias.
## Build
diff --git a/apps/docs/docs/advanced/development/getting-started.mdx b/apps/docs/docs/advanced/development/getting-started.mdx
index f8cb00e24..3a8639f74 100644
--- a/apps/docs/docs/advanced/development/getting-started.mdx
+++ b/apps/docs/docs/advanced/development/getting-started.mdx
@@ -85,17 +85,16 @@ Restart `pnpm dev` after changing `.env`. GitHub OAuth is optional locally. See
[`apps/workshop/README.md`](https://github.com/homarr-labs/homarr/blob/HEAD/apps/workshop/README.md) for OAuth,
Workshop moderator promotion, logs, tests, backup, restore, stopping, and intentional volume reset.
-### URL and base-path testing
+### URL testing
-Docusaurus reads `HOMARR_WEBSITE_URL`, `WORKSHOP_API_URL`, `WORKSHOP_WEB_URL`, and `DOCS_BASE_URL` at startup/build.
-Homarr renders its public URL values into the page at server startup, so Docker overrides do not rely on
-`NEXT_PUBLIC_*` build variables. Test a separate API origin and non-root documentation path before release:
+Docusaurus reads `HOMARR_WEBSITE_URL` and `WORKSHOP_API_URL` when it starts or builds. Homarr also reads
+`WORKSHOP_WEB_URL` when its server starts, so these values do not rely on `NEXT_PUBLIC_*` build variables. Test a
+separate API origin before release:
```sh
HOMARR_WEBSITE_URL=http://127.0.0.1:3003 \
WORKSHOP_API_URL=http://127.0.0.1:8090 \
-WORKSHOP_WEB_URL=http://127.0.0.1:3003/docs-site/workshop \
-DOCS_BASE_URL=/docs-site/ \
+WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop \
pnpm dev:docs
```
diff --git a/apps/docs/docs/advanced/environment-variables/index.mdx b/apps/docs/docs/advanced/environment-variables/index.mdx
index a42729a8a..e740884fc 100644
--- a/apps/docs/docs/advanced/environment-variables/index.mdx
+++ b/apps/docs/docs/advanced/environment-variables/index.mdx
@@ -108,15 +108,12 @@ External redis is currently not supported with Proxmox Community Scripts
The advanced deployments environment variables should only be used if you know what you are doing.
:::
-| Environment Variable | Description |
-| -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
-| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
-| `DOCS_BASE_URL` | Docusaurus deployment path. It must start with `/` and is normalized with a trailing slash. Default: `/`. |
-| `WORKSHOP_PUBLIC_ORIGIN` | Origin used in PocketBase-generated links and email. It must be set explicitly in production. |
-| `WORKSHOP_REQUIRE_PUBLIC_ORIGIN` | Require `WORKSHOP_PUBLIC_ORIGIN` at startup. The production Workshop image enables this automatically. |
-| `PB_ALLOWED_ORIGINS` | Browser origins accepted by PocketBase. The central public community defaults to `*` so self-hosted Homarr instances can use OAuth. |
-| `WORKSHOP_REQUIRE_OAUTH` | Fail Workshop production readiness when GitHub OAuth is disabled. Both GitHub OAuth credentials are always required together. |
+| Environment Variable | Description |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------- |
+| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts. |
+| `WORKSHOP_PUBLIC_ORIGIN` | Origin used in PocketBase-generated links and email. It must be set explicitly in production. |
+| `PB_ALLOWED_ORIGINS` | Browser origins accepted by PocketBase. The central public community defaults to `*` so self-hosted Homarr instances can use OAuth. |
All public URL variables reject non-HTTP protocols, embedded credentials, query strings, and fragments, and normalize
-trailing slashes at startup. The Docusaurus-only `WORKSHOP_URL` name is accepted as a deprecated alias for
+trailing slashes when Homarr or Docusaurus starts. The Docusaurus-only `WORKSHOP_URL` name is accepted as a deprecated alias for
`WORKSHOP_API_URL` for one release. `WORKSHOP_API_URL` takes precedence.
diff --git a/apps/docs/docs/management/workshop/index.mdx b/apps/docs/docs/management/workshop/index.mdx
index a490afbc6..4170d1681 100644
--- a/apps/docs/docs/management/workshop/index.mdx
+++ b/apps/docs/docs/management/workshop/index.mdx
@@ -94,8 +94,8 @@ irreversible development reset.
GitHub needs only the central callback `https:///api/oauth2-redirect`. Keep PocketBase origins unrestricted
unless every self-hosted Homarr caller is explicitly listed. Configure both `GITHUB_CLIENT_ID` and
-`GITHUB_CLIENT_SECRET`; supplying only one is a startup error. Production also requires
-`WORKSHOP_PUBLIC_ORIGIN`. Configure SMTP for comment, report, and removal notices.
+`GITHUB_CLIENT_SECRET`; supplying only one is a startup error. Set `WORKSHOP_PUBLIC_ORIGIN` in production so generated
+links and email use the public host. Configure SMTP for comment, report, and removal notices.
The public URL contract is:
@@ -104,13 +104,11 @@ The public URL contract is:
| `HOMARR_WEBSITE_URL` | Documentation/site base used by Homarr links | `https://homarr.dev` |
| `WORKSHOP_API_URL` | PocketBase API used by Homarr and standalone docs | `HOMARR_WEBSITE_URL` |
| `WORKSHOP_WEB_URL` | Public Workshop page linked from Homarr | `HOMARR_WEBSITE_URL/workshop` |
-| `DOCS_BASE_URL` | Docusaurus deployment path | `/` |
| `WORKSHOP_PUBLIC_ORIGIN` | PocketBase-generated links and email | Required in production |
| `PB_ALLOWED_ORIGINS` | PocketBase browser origins | `*` for the central community |
-The deprecated docs-only `WORKSHOP_URL` alias remains for one release; `WORKSHOP_API_URL` takes precedence. Homarr
-server-renders runtime values for the browser, and the combined image writes a public runtime config at container
-startup. Restart services after changes.
+The deprecated docs-only `WORKSHOP_URL` alias remains for one release; `WORKSHOP_API_URL` takes precedence. Restart
+services after changing these values.
Back up application and PocketBase data before deployment. Publish the combined image by immutable digest, test the
exact digest in staging, rehearse application rollback and PocketBase restore, then promote that same digest.
diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts
index 6aa775d91..0d26722f6 100644
--- a/apps/docs/docusaurus.config.ts
+++ b/apps/docs/docusaurus.config.ts
@@ -1,7 +1,7 @@
import type * as Preset from "@docusaurus/preset-classic";
import type { Config } from "@docusaurus/types";
import { themes as prismThemes } from "prism-react-renderer";
-import { normalizeDocsBaseUrl, resolveHomarrUrlConfig } from "@homarr/workshop/schema";
+import { resolveHomarrUrlConfig } from "@homarr/workshop/schema";
const a11yEmoji = require("@fec/remark-a11y-emoji");
const deprecatedWorkshopUrl = process.env.WORKSHOP_URL;
@@ -12,24 +12,19 @@ if (deprecatedWorkshopUrl && !process.env.WORKSHOP_API_URL) {
const publicUrls = resolveHomarrUrlConfig({
homarrWebsiteUrl: process.env.HOMARR_WEBSITE_URL,
workshopApiUrl: process.env.WORKSHOP_API_URL ?? deprecatedWorkshopUrl,
- workshopWebUrl: process.env.WORKSHOP_WEB_URL,
});
-const docsBaseUrl = normalizeDocsBaseUrl(process.env.DOCS_BASE_URL);
-
const config: Config = {
title: "Homarr documentation",
tagline: "A simple yet powerful dashboard for your server.",
url: publicUrls.homarrWebsiteUrl,
- baseUrl: docsBaseUrl,
+ baseUrl: "/",
trailingSlash: undefined,
favicon: "img/logo.png",
organizationName: "homarr-labs",
projectName: "homarr",
customFields: {
workshopUrl: publicUrls.workshopApiUrl,
- workshopWebUrl: publicUrls.workshopWebUrl,
},
- scripts: [{ src: `${docsBaseUrl}workshop-runtime-config.js` }],
i18n: {
defaultLocale: "en",
locales: ["en"],
diff --git a/apps/docs/src/components/workshop/DetailPage.tsx b/apps/docs/src/components/workshop/DetailPage.tsx
index 69452a002..7d5c3c360 100644
--- a/apps/docs/src/components/workshop/DetailPage.tsx
+++ b/apps/docs/src/components/workshop/DetailPage.tsx
@@ -2,11 +2,9 @@ import React, { useCallback, useEffect, useMemo, useRef, useState } from "react"
import BrowserOnly from "@docusaurus/BrowserOnly";
import Link from "@docusaurus/Link";
import { useLocation } from "@docusaurus/router";
-import useBaseUrl from "@docusaurus/useBaseUrl";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import Layout from "@theme/Layout";
-import { getRuntimeWorkshopApiUrl } from "@site/src/lib/runtime-config";
import {
IconArrowBigDown,
IconArrowBigUp,
@@ -179,7 +177,6 @@ const WidgetSafetySummary = ({ widget }: { widget: HomarrCustomWidgetV2 }) => {
const MarketplaceDetail = ({ workshopUrl }: { workshopUrl: string }) => {
const location = useLocation();
- const workshopHomeUrl = useBaseUrl("/workshop/");
const submissionId = parseSubmissionId(location.pathname);
const backend = useMemo(() => getWorkshopBackend(workshopUrl), [workshopUrl]);
@@ -329,7 +326,7 @@ const MarketplaceDetail = ({ workshopUrl }: { workshopUrl: string }) => {
if (!submission) return;
try {
await backend.delete(submission.id);
- window.location.href = workshopHomeUrl;
+ window.location.href = "/workshop/";
} catch (caught) {
setError(errorMessage(caught, "Failed to delete submission"));
}
@@ -1027,7 +1024,7 @@ export default function MarketplaceDetailPage() {
}>
{() => (
-
+
)}
diff --git a/apps/docs/src/components/workshop/WorkshopAdmin.tsx b/apps/docs/src/components/workshop/WorkshopAdmin.tsx
index e5fd61f99..ec4428115 100644
--- a/apps/docs/src/components/workshop/WorkshopAdmin.tsx
+++ b/apps/docs/src/components/workshop/WorkshopAdmin.tsx
@@ -1,5 +1,4 @@
import { useCallback, useEffect, useMemo, useState } from "react";
-import Link from "@docusaurus/Link";
import {
IconBrandGithub,
IconExternalLink,
@@ -125,7 +124,7 @@ export function WorkshopAdmin({ workshopUrl }: { workshopUrl?: string }) {
-
}>
+
}>
Back to Workshop
{!user && (
@@ -266,7 +265,7 @@ export function WorkshopAdmin({ workshopUrl }: { workshopUrl?: string }) {
variant="outline"
size="sm"
nativeButton={false}
- render={
}
+ render={
}
>
Inspect submission
diff --git a/apps/docs/src/components/workshop/WorkshopApp.tsx b/apps/docs/src/components/workshop/WorkshopApp.tsx
index a8c316626..ced2158cf 100644
--- a/apps/docs/src/components/workshop/WorkshopApp.tsx
+++ b/apps/docs/src/components/workshop/WorkshopApp.tsx
@@ -1,5 +1,4 @@
import React, { useMemo, useState } from "react";
-import Link from "@docusaurus/Link";
import {
IconAlertCircle,
IconArrowBigDown,
@@ -324,7 +323,7 @@ const SubmissionCard = ({ submission, backend, userVote, onVote }: SubmissionCar
return (
-
+
{hasScreenshots ? (
)}
-
+
-
+
{submission.title}
-
+
{!hasScreenshots && (
@@ -424,7 +423,7 @@ const SubmissionCard = ({ submission, backend, userVote, onVote }: SubmissionCar
className="h-10 sm:h-7"
size="sm"
nativeButton={false}
- render={}
+ render={}
>
View details
diff --git a/apps/docs/src/lib/runtime-config.ts b/apps/docs/src/lib/runtime-config.ts
deleted file mode 100644
index 7d1498f49..000000000
--- a/apps/docs/src/lib/runtime-config.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-interface HomarrRuntimeConfig {
- homarrWebsiteUrl?: string;
- workshopApiUrl?: string;
- workshopWebUrl?: string;
-}
-
-declare global {
- interface Window {
- homarrRuntimeConfig?: Readonly;
- }
-}
-
-export const getRuntimeWorkshopApiUrl = (configuredUrl: string): string => {
- if (typeof window === "undefined") return configuredUrl;
- return window.homarrRuntimeConfig?.workshopApiUrl || configuredUrl || window.location.origin;
-};
-
-export const getRuntimeWorkshopWebUrl = (configuredUrl: string): string => {
- if (typeof window === "undefined") return configuredUrl;
- return window.homarrRuntimeConfig?.workshopWebUrl || configuredUrl || `${window.location.origin}/workshop`;
-};
diff --git a/apps/docs/src/pages/workshop/admin/index.tsx b/apps/docs/src/pages/workshop/admin/index.tsx
index c9680cf4f..a8baf5bcf 100644
--- a/apps/docs/src/pages/workshop/admin/index.tsx
+++ b/apps/docs/src/pages/workshop/admin/index.tsx
@@ -1,19 +1,14 @@
import React from "react";
-import BrowserOnly from "@docusaurus/BrowserOnly";
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
import Layout from "@theme/Layout";
import { WorkshopAdmin } from "@site/src/components/workshop/WorkshopAdmin";
-import { getRuntimeWorkshopApiUrl } from "@site/src/lib/runtime-config";
-
export default function WorkshopAdminRoute() {
const { siteConfig } = useDocusaurusContext();
const workshopUrl = (siteConfig.customFields?.workshopUrl as string | undefined) ?? "";
return (
-
- {() => }
-
+
);
}
diff --git a/apps/docs/src/pages/workshop/index.tsx b/apps/docs/src/pages/workshop/index.tsx
index e7b8e3a82..f7fadabf8 100644
--- a/apps/docs/src/pages/workshop/index.tsx
+++ b/apps/docs/src/pages/workshop/index.tsx
@@ -5,7 +5,6 @@ import Layout from "@theme/Layout";
import { WorkshopApp, WorkshopListingFallback } from "@site/src/components/workshop/WorkshopApp";
import { WorkshopErrorBoundary } from "@site/src/components/workshop/WorkshopErrorBoundary";
-import { getRuntimeWorkshopApiUrl } from "@site/src/lib/runtime-config";
export default function WorkshopPage() {
const { siteConfig } = useDocusaurusContext();
@@ -17,7 +16,7 @@ export default function WorkshopPage() {
}>
{() => (
-
+
)}
diff --git a/apps/docs/static/workshop-runtime-config.js b/apps/docs/static/workshop-runtime-config.js
deleted file mode 100644
index 88207dea8..000000000
--- a/apps/docs/static/workshop-runtime-config.js
+++ /dev/null
@@ -1 +0,0 @@
-globalThis.homarrRuntimeConfig = Object.freeze({});
diff --git a/apps/nextjs/src/app/[locale]/layout.tsx b/apps/nextjs/src/app/[locale]/layout.tsx
index 9d94da2aa..d394d9c31 100644
--- a/apps/nextjs/src/app/[locale]/layout.tsx
+++ b/apps/nextjs/src/app/[locale]/layout.tsx
@@ -148,7 +148,6 @@ export default async function Layout(props: {
-
diff --git a/apps/nextjs/src/app/api/[...trpc]/route.ts b/apps/nextjs/src/app/api/[...trpc]/route.ts
index 9ce92e1ac..1ae1e5e92 100644
--- a/apps/nextjs/src/app/api/[...trpc]/route.ts
+++ b/apps/nextjs/src/app/api/[...trpc]/route.ts
@@ -5,7 +5,7 @@ import { createOpenApiFetchHandler } from "trpc-to-openapi";
import { createTRPCContext } from "@homarr/api";
import { openApiRouter } from "@homarr/api/open-api";
import { API_KEY_HEADER_NAME, getSessionFromApiKeyAsync } from "@homarr/auth/api-key";
-import { rateLimitAddressFromHeaders } from "@homarr/common/server";
+import { ipAddressFromHeaders } from "@homarr/common/server";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
import { db } from "@homarr/db";
@@ -14,7 +14,7 @@ const logger = createLogger({ module: "trpcOpenApiRoute" });
const handlerAsync = async (req: NextRequest) => {
const apiKeyHeaderValue = req.headers.get(API_KEY_HEADER_NAME);
- const ipAddress = rateLimitAddressFromHeaders(req.headers);
+ const ipAddress = ipAddressFromHeaders(req.headers);
const { ua } = userAgent(req);
logger.info(
diff --git a/apps/nextjs/src/app/api/custom-widgets/configuration-request/[token]/route.ts b/apps/nextjs/src/app/api/custom-widgets/configuration-request/[token]/route.ts
index 7ca7a4fe3..7a294ebf4 100644
--- a/apps/nextjs/src/app/api/custom-widgets/configuration-request/[token]/route.ts
+++ b/apps/nextjs/src/app/api/custom-widgets/configuration-request/[token]/route.ts
@@ -7,10 +7,10 @@ import {
configureCustomWidgetSourceFromRequest,
configurePreviewSessionSource,
getCustomWidgetConfigurationRequest,
- invalidateCustomWidgetResponseCache,
releaseCustomWidgetConfigurationRequest,
} from "@homarr/api/custom-widget-configuration";
import { customWidgetSourceSchema } from "@homarr/custom-widgets/core";
+import { invalidateCustomWidgetResponseCache } from "@homarr/custom-widgets/server";
import { db } from "@homarr/db";
import { requireCustomWidgetAdmin } from "../../admin";
@@ -94,7 +94,7 @@ export async function POST(request: NextRequest, context: RouteContext) {
sourceResult.data,
secrets,
);
- await invalidateCustomWidgetResponseCache([`custom-jsx:preview:${claimed.target.id}:`]);
+ invalidateCustomWidgetResponseCache([`custom-jsx:preview:${claimed.target.id}:`]);
} else {
const result = await configureCustomWidgetSourceFromRequest(db, {
definitionId: claimed.target.id,
diff --git a/apps/nextjs/src/app/api/mcp/[transport]/route.spec.ts b/apps/nextjs/src/app/api/mcp/[transport]/route.spec.ts
index bea9ad1fa..1fdb4e536 100644
--- a/apps/nextjs/src/app/api/mcp/[transport]/route.spec.ts
+++ b/apps/nextjs/src/app/api/mcp/[transport]/route.spec.ts
@@ -4,7 +4,7 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
const mocks = vi.hoisted(() => ({
authenticate: vi.fn(),
- rateLimitAddress: vi.fn(() => "127.0.0.1"),
+ ipAddress: vi.fn(() => "127.0.0.1"),
toolProcedure: vi.fn(),
loggerWarn: vi.fn(),
buildPrompt: vi.fn((request?: string, documentationUrl?: string) =>
@@ -23,7 +23,7 @@ vi.mock("@homarr/auth/api-key", () => ({
getSessionFromApiKeyAsync: mocks.authenticate,
}));
vi.mock("@homarr/common", () => ({ extractBaseUrlFromHeaders: () => "http://localhost" }));
-vi.mock("@homarr/common/server", () => ({ rateLimitAddressFromHeaders: mocks.rateLimitAddress }));
+vi.mock("@homarr/common/server", () => ({ ipAddressFromHeaders: mocks.ipAddress }));
vi.mock("@homarr/core/infrastructure/logs", () => ({
createLogger: () => ({ info: vi.fn(), warn: mocks.loggerWarn, error: vi.fn() }),
}));
@@ -75,8 +75,8 @@ beforeEach(() => {
mocks.authenticate.mockResolvedValue({ user: { id: "user-1", permissions: ["admin"] } });
mocks.buildPrompt.mockClear();
mocks.getComponent.mockClear();
- mocks.rateLimitAddress.mockClear();
- mocks.rateLimitAddress.mockReturnValue("127.0.0.1");
+ mocks.ipAddress.mockClear();
+ mocks.ipAddress.mockReturnValue("127.0.0.1");
mocks.toolProcedure.mockReset();
mocks.toolProcedure.mockResolvedValue([]);
mocks.loggerWarn.mockClear();
@@ -122,7 +122,7 @@ describe("authenticated MCP prompt protocol", () => {
serverInfo: { name: "homarr", version: "test-version" },
});
expect(mocks.authenticate).toHaveBeenCalledWith({}, "key.secret", "127.0.0.1", "MCP route test");
- expect(mocks.rateLimitAddress).toHaveBeenCalledWith(expect.any(Headers));
+ expect(mocks.ipAddress).toHaveBeenCalledWith(expect.any(Headers));
});
test("lists and interpolates the custom-widget authoring prompt", async () => {
diff --git a/apps/nextjs/src/app/api/mcp/[transport]/route.ts b/apps/nextjs/src/app/api/mcp/[transport]/route.ts
index 2015cbbd5..048bdcbef 100644
--- a/apps/nextjs/src/app/api/mcp/[transport]/route.ts
+++ b/apps/nextjs/src/app/api/mcp/[transport]/route.ts
@@ -16,7 +16,7 @@ import {
import { createTRPCContext, mcpRouter } from "@homarr/api/mcp";
import { API_KEY_HEADER_NAME, getSessionFromApiKeyAsync } from "@homarr/auth/api-key";
import { extractBaseUrlFromHeaders } from "@homarr/common";
-import { rateLimitAddressFromHeaders } from "@homarr/common/server";
+import { ipAddressFromHeaders } from "@homarr/common/server";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { buildCustomWidgetMcpPrompt } from "@homarr/custom-widgets/authoring-prompt";
import {
@@ -390,7 +390,7 @@ function jsonErrorResponse(status: number, body: Record, extraHe
const handler = async (req: NextRequest) => {
const apiKeyValue = extractApiKeyValue(req);
- const ipAddress = rateLimitAddressFromHeaders(req.headers);
+ const ipAddress = ipAddressFromHeaders(req.headers);
const { ua } = userAgent(req);
if (!checkAuthRateLimit(ipAddress)) {
diff --git a/apps/nextjs/src/app/api/trpc/[trpc]/route.ts b/apps/nextjs/src/app/api/trpc/[trpc]/route.ts
index f0819e006..735d83e7d 100644
--- a/apps/nextjs/src/app/api/trpc/[trpc]/route.ts
+++ b/apps/nextjs/src/app/api/trpc/[trpc]/route.ts
@@ -5,7 +5,7 @@ import { appRouter, createTRPCContext } from "@homarr/api";
import { trpcPath } from "@homarr/api/shared";
import { API_KEY_HEADER_NAME, getSessionFromApiKeyAsync } from "@homarr/auth/api-key";
import { auth } from "@homarr/auth/next";
-import { rateLimitAddressFromHeaders } from "@homarr/common/server";
+import { ipAddressFromHeaders } from "@homarr/common/server";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { ErrorWithMetadata } from "@homarr/core/infrastructure/logs/error";
import { db } from "@homarr/db";
@@ -34,7 +34,7 @@ export function OPTIONS() {
const handler = auth(async (req) => {
// Try API key auth first, fall back to session cookie
const apiKeyHeader = req.headers.get(API_KEY_HEADER_NAME);
- const ipAddress = rateLimitAddressFromHeaders(req.headers);
+ const ipAddress = ipAddressFromHeaders(req.headers);
const { ua } = userAgent(req);
diff --git a/apps/workshop/.env.example b/apps/workshop/.env.example
index 566a7aec2..a67c02ff7 100644
--- a/apps/workshop/.env.example
+++ b/apps/workshop/.env.example
@@ -6,8 +6,6 @@ WORKSHOP_PUBLIC_ORIGIN=http://127.0.0.1:3003
HOMARR_WEBSITE_URL=http://127.0.0.1:3003
WORKSHOP_API_URL=http://127.0.0.1:8090
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop
-DOCS_BASE_URL=/
-WORKSHOP_REQUIRE_OAUTH=false
# Optional local GitHub OAuth application.
# GITHUB_CLIENT_ID=
diff --git a/apps/workshop/Dockerfile b/apps/workshop/Dockerfile
index e825366cb..a11dd5c3b 100644
--- a/apps/workshop/Dockerfile
+++ b/apps/workshop/Dockerfile
@@ -13,48 +13,28 @@ COPY packages/custom-widgets ./packages/custom-widgets
COPY packages/definitions ./packages/definitions
COPY packages/workshop ./packages/workshop
COPY tooling/typescript ./tooling/typescript
-RUN pnpm config set store-dir /pnpm/store && pnpm install --filter @homarr/docs... --frozen-lockfile
+RUN --mount=type=cache,id=workshop-pnpm-store,target=/pnpm/store pnpm config set store-dir /pnpm/store && pnpm install --filter @homarr/docs... --frozen-lockfile
FROM dependencies AS website
ARG HOMARR_WEBSITE_URL=https://homarr.dev
ARG WORKSHOP_API_URL=https://homarr.dev
-ARG WORKSHOP_WEB_URL=https://homarr.dev/workshop
-ARG DOCS_BASE_URL=/
ENV HOMARR_WEBSITE_URL=$HOMARR_WEBSITE_URL
ENV WORKSHOP_API_URL=$WORKSHOP_API_URL
-ENV WORKSHOP_WEB_URL=$WORKSHOP_WEB_URL
-ENV DOCS_BASE_URL=$DOCS_BASE_URL
-RUN CI=true SKIP_ENV_VALIDATION=true pnpm turbo build --filter=@homarr/docs \
- && mkdir -p /app/workshop-public \
- && docs_path="$(printf '%s' "$DOCS_BASE_URL" | sed 's#^/*##; s#/*$##')" \
- && if [ -z "$docs_path" ]; then \
- cp -R /app/apps/docs/build/. /app/workshop-public/; \
- else \
- mkdir -p "/app/workshop-public/$docs_path" \
- && cp -R /app/apps/docs/build/. "/app/workshop-public/$docs_path/" \
- && cp /app/apps/docs/build/index.html /app/workshop-public/index.html; \
- fi
+RUN CI=true SKIP_ENV_VALIDATION=true pnpm turbo build --filter=@homarr/docs
FROM ${POCKETBASE_IMAGE} AS pocketbase-runtime
ENV PORT=8090
RUN addgroup -S pocketbase && adduser -S -G pocketbase pocketbase
COPY apps/workshop/entrypoint.sh /usr/local/bin/workshop-entrypoint
-COPY apps/workshop/workshop-url.awk /usr/local/lib/workshop-url.awk
-RUN chmod 755 /usr/local/bin/workshop-entrypoint \
- && chmod 644 /usr/local/lib/workshop-url.awk \
- && mkdir -p /pb_data /pb_public \
- && chown pocketbase:pocketbase /pb_data /pb_public
+RUN chmod +x /usr/local/bin/workshop-entrypoint && mkdir -p /pb_data /pb_public && chown pocketbase:pocketbase /pb_data
ENTRYPOINT ["workshop-entrypoint"]
FROM pocketbase-runtime AS development
-COPY --chown=pocketbase:pocketbase apps/workshop/pb_migrations /pb_migrations
-COPY --chown=pocketbase:pocketbase apps/workshop/pb_hooks /pb_hooks
EXPOSE 8090
HEALTHCHECK --interval=10s --timeout=5s --start-period=15s --retries=6 CMD wget -q --spider "http://127.0.0.1:${PORT}/api/health" || exit 1
FROM pocketbase-runtime AS production
-ENV WORKSHOP_REQUIRE_PUBLIC_ORIGIN=true
-COPY --from=website /app/workshop-public /pb_public
+COPY --from=website /app/apps/docs/build /pb_public
COPY apps/workshop/pb_migrations /pb_migrations
COPY apps/workshop/pb_hooks /pb_hooks
RUN chown -R pocketbase:pocketbase /pb_hooks /pb_migrations /pb_public
diff --git a/apps/workshop/Dockerfile.dockerignore b/apps/workshop/Dockerfile.dockerignore
new file mode 100644
index 000000000..ff07f074e
--- /dev/null
+++ b/apps/workshop/Dockerfile.dockerignore
@@ -0,0 +1,7 @@
+.git
+.next
+.turbo
+**/node_modules
+**/pb_data
+apps/docs/build
+coverage
diff --git a/apps/workshop/README.md b/apps/workshop/README.md
index 7fca34508..59878a24b 100644
--- a/apps/workshop/README.md
+++ b/apps/workshop/README.md
@@ -69,8 +69,8 @@ pnpm dev
```
`WORKSHOP_API_URL` controls API calls. `WORKSHOP_WEB_URL` controls links from Homarr. `HOMARR_WEBSITE_URL` is the
-documentation/site base. All three must be absolute HTTP(S) URLs. `DOCS_BASE_URL` configures a Docusaurus path such as
-`/docs-site/`. The old Docusaurus-only `WORKSHOP_URL` variable remains a deprecated alias for one release.
+documentation/site base. All three must be absolute HTTP(S) URLs. The old Docusaurus-only `WORKSHOP_URL` variable
+remains a deprecated alias for one release.
## Optional GitHub OAuth
@@ -158,7 +158,6 @@ WORKSHOP_API_URL=https://homarr.dev
WORKSHOP_WEB_URL=https://homarr.dev/workshop
WORKSHOP_PUBLIC_ORIGIN=https://homarr.dev
PB_ALLOWED_ORIGINS=*
-WORKSHOP_REQUIRE_OAUTH=true
```
Build and smoke-test the combined image locally:
diff --git a/apps/workshop/docker-compose.yml b/apps/workshop/docker-compose.yml
index f36e20c79..c6eac0034 100644
--- a/apps/workshop/docker-compose.yml
+++ b/apps/workshop/docker-compose.yml
@@ -10,17 +10,16 @@ services:
environment:
PB_ALLOWED_ORIGINS: ${PB_ALLOWED_ORIGINS:-*}
PORT: ${PB_EXPOSE_PORT:-8090}
- HOMARR_WEBSITE_URL: ${HOMARR_WEBSITE_URL:-http://localhost:3003}
- WORKSHOP_API_URL: ${WORKSHOP_API_URL:-http://localhost:8090}
WORKSHOP_WEB_URL: ${WORKSHOP_WEB_URL:-http://localhost:3003/workshop}
GITHUB_CLIENT_ID: ${GITHUB_CLIENT_ID:-}
GITHUB_CLIENT_SECRET: ${GITHUB_CLIENT_SECRET:-}
- WORKSHOP_REQUIRE_OAUTH: ${WORKSHOP_REQUIRE_OAUTH:-false}
WORKSHOP_PUBLIC_ORIGIN: ${WORKSHOP_PUBLIC_ORIGIN:-http://localhost:3003}
ports:
- "127.0.0.1:${PB_EXPOSE_PORT:-8090}:${PB_EXPOSE_PORT:-8090}"
volumes:
- pb_data:/pb_data
+ - ./pb_hooks:/pb_hooks:ro
+ - ./pb_migrations:/pb_migrations:ro
security_opt:
- no-new-privileges:true
@@ -34,18 +33,12 @@ services:
args:
HOMARR_WEBSITE_URL: ${HOMARR_WEBSITE_URL:-http://localhost:3003}
WORKSHOP_API_URL: ${WORKSHOP_API_URL:-http://localhost:3003}
- WORKSHOP_WEB_URL: ${WORKSHOP_WEB_URL:-http://localhost:3003/workshop}
- DOCS_BASE_URL: ${DOCS_BASE_URL:-/}
environment:
PB_ALLOWED_ORIGINS: ${PB_ALLOWED_ORIGINS:-*}
PORT: ${DOCS_EXPOSE_PORT:-3003}
- HOMARR_WEBSITE_URL: ${HOMARR_WEBSITE_URL:-http://localhost:3003}
- WORKSHOP_API_URL: ${WORKSHOP_API_URL:-http://localhost:3003}
WORKSHOP_WEB_URL: ${WORKSHOP_WEB_URL:-http://localhost:3003/workshop}
- DOCS_BASE_URL: ${DOCS_BASE_URL:-/}
GITHUB_CLIENT_ID: ${GITHUB_CLIENT_ID:-}
GITHUB_CLIENT_SECRET: ${GITHUB_CLIENT_SECRET:-}
- WORKSHOP_REQUIRE_OAUTH: ${WORKSHOP_REQUIRE_OAUTH:-false}
WORKSHOP_PUBLIC_ORIGIN: ${WORKSHOP_PUBLIC_ORIGIN:-http://localhost:3003}
ports:
- "127.0.0.1:${DOCS_EXPOSE_PORT:-3003}:${DOCS_EXPOSE_PORT:-3003}"
diff --git a/apps/workshop/entrypoint.sh b/apps/workshop/entrypoint.sh
index 6f9b7913f..84a04ade4 100644
--- a/apps/workshop/entrypoint.sh
+++ b/apps/workshop/entrypoint.sh
@@ -1,72 +1,11 @@
#!/bin/sh
set -eu
-normalize_http_url() {
- variable_name=$1
- value=$2
- printf '%s\n' "$value" | awk \
- -v variable_name="$variable_name" \
- -f "${WORKSHOP_URL_VALIDATOR_PATH:-/usr/local/lib/workshop-url.awk}"
-}
-
-normalize_docs_base_url() {
- value=$1
- case "$value" in
- /*) ;;
- *)
- echo "DOCS_BASE_URL must start with '/'" >&2
- return 1
- ;;
- esac
- case "${value%/}/" in
- *[!A-Za-z0-9._~/-]* | */./* | */../*)
- echo "DOCS_BASE_URL must be a safe URL path without traversal" >&2
- return 1
- ;;
- esac
- printf '/%s\n' "$(printf '%s' "$value" | sed 's#^/*##; s#/*$##')"
-}
-
-if [ "${1:-}" = "--validate-url" ]; then
- normalize_http_url "${2:-URL}" "${3:-}"
- exit
-fi
-
-if [ "${1:-}" = "--validate-docs-base-url" ]; then
- normalize_docs_base_url "${2:-}"
- exit
-fi
-
-HOMARR_WEBSITE_URL=$(normalize_http_url HOMARR_WEBSITE_URL "${HOMARR_WEBSITE_URL:-https://homarr.dev}")
-WORKSHOP_API_URL=$(normalize_http_url WORKSHOP_API_URL "${WORKSHOP_API_URL:-$HOMARR_WEBSITE_URL}")
-WORKSHOP_WEB_URL=$(normalize_http_url WORKSHOP_WEB_URL "${WORKSHOP_WEB_URL:-$HOMARR_WEBSITE_URL/workshop}")
-if [ "${WORKSHOP_REQUIRE_PUBLIC_ORIGIN:-false}" = "true" ] && [ -z "${WORKSHOP_PUBLIC_ORIGIN:-}" ]; then
- echo "WORKSHOP_PUBLIC_ORIGIN must be set explicitly in production" >&2
- exit 1
-fi
-if [ -n "${WORKSHOP_PUBLIC_ORIGIN:-}" ]; then
- WORKSHOP_PUBLIC_ORIGIN=$(normalize_http_url WORKSHOP_PUBLIC_ORIGIN "$WORKSHOP_PUBLIC_ORIGIN")
-fi
-export HOMARR_WEBSITE_URL WORKSHOP_API_URL WORKSHOP_WEB_URL WORKSHOP_PUBLIC_ORIGIN
-
if [ "$(id -u)" -eq 0 ]; then
chown -R pocketbase:pocketbase /pb_data
exec su -p -s /bin/sh pocketbase -c 'exec /usr/local/bin/workshop-entrypoint'
fi
-if [ -d /pb_public ]; then
- docs_base_url=$(normalize_docs_base_url "${DOCS_BASE_URL:-/}")
- runtime_directory="/pb_public${docs_base_url%/}"
- mkdir -p "$runtime_directory"
- cat >"$runtime_directory/workshop-runtime-config.js" < {
const clientId = String($os.getenv("GITHUB_CLIENT_ID") || "").trim();
const clientSecret = String($os.getenv("GITHUB_CLIENT_SECRET") || "").trim();
- const requireOAuth = ["1", "true", "yes", "on"].includes(
- String($os.getenv("WORKSHOP_REQUIRE_OAUTH") || "")
- .trim()
- .toLowerCase(),
- );
if (Boolean(clientId) !== Boolean(clientSecret)) {
console.log(JSON.stringify({ event: "workshop_oauth_configuration_rejected", reason: "partial_credentials" }));
throw new Error("GitHub OAuth requires both GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET");
}
const configured = Boolean(clientId && clientSecret);
- if (requireOAuth && !configured) {
- console.log(JSON.stringify({ event: "workshop_oauth_configuration_rejected", reason: "required_but_disabled" }));
- throw new Error("GitHub OAuth is required but no credentials were configured");
- }
event.next();
const users = event.app.findCollectionByNameOrId("users");
users.oauth2.enabled = configured;
users.oauth2.providers = configured ? [{ name: "github", clientId, clientSecret }] : [];
event.app.save(users);
- console.log(JSON.stringify({ event: "workshop_oauth_synchronized", enabled: configured, required: requireOAuth }));
+ console.log(JSON.stringify({ event: "workshop_oauth_synchronized", enabled: configured }));
});
onRecordAuthWithOAuth2Request((event) => {
diff --git a/apps/workshop/test.sh b/apps/workshop/test.sh
index d9dc136f0..b010a45ca 100644
--- a/apps/workshop/test.sh
+++ b/apps/workshop/test.sh
@@ -3,67 +3,17 @@ set -eu
WORKSHOP_TEST_PORT=${WORKSHOP_TEST_PORT:-18090}
WORKSHOP_TEST_PROJECT="homarr-workshop-test-$$"
-WORKSHOP_ROLLBACK_PORT=${WORKSHOP_ROLLBACK_PORT:-$((WORKSHOP_TEST_PORT + 1))}
-WORKSHOP_ROLLBACK_PROJECT="homarr-workshop-rollback-$$"
-WORKSHOP_ROLLBACK_SNAPSHOT="/tmp/$WORKSHOP_ROLLBACK_PROJECT.json"
-WORKSHOP_MIGRATION_COUNT=$(
- node -e "const fs = require('node:fs'); console.log(fs.readdirSync('apps/workshop/pb_migrations').filter((name) => name.endsWith('.js')).length)"
-)
-ROLLBACK_CONTAINER=""
node apps/workshop/tests/workshop-contracts.mjs
node apps/workshop/tests/workshop-migration.mjs
-node apps/workshop/tests/entrypoint-url.mjs
node apps/workshop/tests/workshop-identity.mjs
-node apps/workshop/tests/workshop-oauth-hook.mjs
cleanup() {
- if [ -n "$ROLLBACK_CONTAINER" ]; then
- docker stop "$ROLLBACK_CONTAINER" >/dev/null 2>&1 || true
- fi
- docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml down --volumes --remove-orphans >/dev/null 2>&1 || true
PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
-f apps/workshop/docker-compose.yml down --volumes --remove-orphans >/dev/null 2>&1 || true
- rm -f "$WORKSHOP_ROLLBACK_SNAPSHOT"
}
trap cleanup EXIT
-wait_for_workshop() {
- port=$1
- for attempt in $(seq 1 60); do
- if curl --fail --silent "http://127.0.0.1:$port/api/health" >/dev/null; then
- return
- fi
- if [ "$attempt" -eq 60 ]; then
- return 1
- fi
- sleep 1
- done
-}
-
-start_rollback_server() {
- ROLLBACK_CONTAINER=$(
- PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml run --rm -d --service-ports --no-deps \
- --entrypoint pocketbase workshop \
- serve --http="0.0.0.0:$WORKSHOP_ROLLBACK_PORT" --origins="*" --dir=/pb_data \
- --hooksDir=/tmp --migrationsDir=/tmp --publicDir=/pb_public --automigrate=false
- )
- wait_for_workshop "$WORKSHOP_ROLLBACK_PORT"
-}
-
-stop_rollback_server() {
- docker stop "$ROLLBACK_CONTAINER" >/dev/null
- ROLLBACK_CONTAINER=""
-}
-
-run_rollback_assertion() {
- WORKSHOP_TEST_URL="http://127.0.0.1:$WORKSHOP_ROLLBACK_PORT" \
- WORKSHOP_ROLLBACK_SNAPSHOT="$WORKSHOP_ROLLBACK_SNAPSHOT" \
- node apps/workshop/tests/workshop-rollback.integration.mjs "$1"
-}
-
PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
-f apps/workshop/docker-compose.yml up --build -d
@@ -101,90 +51,11 @@ for client_id in workshop-test-client workshop-rotated-client; do
node apps/workshop/tests/oauth-sync.integration.mjs
done
-GITHUB_CLIENT_ID="workshop-partial-client" GITHUB_CLIENT_SECRET="" WORKSHOP_REQUIRE_OAUTH=false \
- PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
- -f apps/workshop/docker-compose.yml up -d --force-recreate workshop
-partial_rejected=false
-for attempt in $(seq 1 30); do
- if PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
- -f apps/workshop/docker-compose.yml logs --no-color workshop | grep -q "partial_credentials"; then
- partial_rejected=true
- break
- fi
- sleep 1
-done
-if [ "$partial_rejected" != true ]; then
- echo "Workshop accepted a partial GitHub OAuth configuration"
- exit 1
-fi
-
-GITHUB_CLIENT_ID="" GITHUB_CLIENT_SECRET="" WORKSHOP_REQUIRE_OAUTH=true PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" \
- docker compose -p "$WORKSHOP_TEST_PROJECT" -f apps/workshop/docker-compose.yml \
- up -d --force-recreate workshop
-required_rejected=false
-for attempt in $(seq 1 30); do
- if PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
- -f apps/workshop/docker-compose.yml logs --no-color workshop | grep -q "required_but_disabled"; then
- required_rejected=true
- break
- fi
- sleep 1
-done
-if [ "$required_rejected" != true ]; then
- echo "Workshop started without OAuth while WORKSHOP_REQUIRE_OAUTH=true"
- exit 1
-fi
-
PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
-f apps/workshop/docker-compose.yml stop workshop
-
-WORKSHOP_IMAGE_ID=$(
- docker compose -p "$WORKSHOP_TEST_PROJECT" -f apps/workshop/docker-compose.yml images -q workshop
-)
-docker image tag "$WORKSHOP_IMAGE_ID" "$WORKSHOP_ROLLBACK_PROJECT-workshop:latest"
-PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml run --rm --no-deps --workdir /tmp --entrypoint pocketbase workshop \
- superuser create workshop-rollback@example.invalid 'WorkshopRollback123!' --dir=/pb_data \
- --hooksDir=/tmp --migrationsDir=/tmp --automigrate=false
-
-start_rollback_server
-run_rollback_assertion fresh-prepare
-stop_rollback_server
-
-PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
+printf 'y\n' | PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
-f apps/workshop/docker-compose.yml run --rm --no-deps --entrypoint pocketbase workshop \
- migrate up --dir=/pb_data --migrationsDir=/pb_migrations --hooksDir=/tmp --automigrate=false
-start_rollback_server
-run_rollback_assertion fresh-migrated
-stop_rollback_server
-
-printf 'y\n' | PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
+ migrate down 1 --dir=/pb_data --migrationsDir=/pb_migrations
+PB_EXPOSE_PORT="$WORKSHOP_TEST_PORT" docker compose -p "$WORKSHOP_TEST_PROJECT" \
-f apps/workshop/docker-compose.yml run --rm --no-deps --entrypoint pocketbase workshop \
- migrate down "$WORKSHOP_MIGRATION_COUNT" --dir=/pb_data --migrationsDir=/pb_migrations \
- --hooksDir=/tmp --automigrate=false
-start_rollback_server
-run_rollback_assertion fresh-restored
-run_rollback_assertion prepare
-stop_rollback_server
-
-PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml run --rm --no-deps --entrypoint pocketbase workshop \
- migrate up --dir=/pb_data --migrationsDir=/pb_migrations --hooksDir=/tmp --automigrate=false
-start_rollback_server
-run_rollback_assertion migrated
-stop_rollback_server
-
-printf 'y\n' | PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml run --rm --no-deps --entrypoint pocketbase workshop \
- migrate down "$WORKSHOP_MIGRATION_COUNT" --dir=/pb_data --migrationsDir=/pb_migrations \
- --hooksDir=/tmp --automigrate=false
-start_rollback_server
-run_rollback_assertion restored
-stop_rollback_server
-
-PB_EXPOSE_PORT="$WORKSHOP_ROLLBACK_PORT" docker compose -p "$WORKSHOP_ROLLBACK_PROJECT" \
- -f apps/workshop/docker-compose.yml run --rm --no-deps --entrypoint pocketbase workshop \
- migrate up --dir=/pb_data --migrationsDir=/pb_migrations --hooksDir=/tmp --automigrate=false
-start_rollback_server
-run_rollback_assertion migrated
-stop_rollback_server
+ migrate up --dir=/pb_data --migrationsDir=/pb_migrations
diff --git a/apps/workshop/tests/entrypoint-url.mjs b/apps/workshop/tests/entrypoint-url.mjs
deleted file mode 100644
index ff434a370..000000000
--- a/apps/workshop/tests/entrypoint-url.mjs
+++ /dev/null
@@ -1,72 +0,0 @@
-import { spawnSync } from "node:child_process";
-import { resolve } from "node:path";
-
-const entrypoint = resolve("apps/workshop/entrypoint.sh");
-const validator = resolve("apps/workshop/workshop-url.awk");
-
-const validate = (value) =>
- spawnSync("sh", [entrypoint, "--validate-url", "TEST_URL", value], {
- encoding: "utf8",
- env: { ...process.env, WORKSHOP_URL_VALIDATOR_PATH: validator },
- });
-
-const validateDocsBaseUrl = (value) =>
- spawnSync("sh", [entrypoint, "--validate-docs-base-url", value], {
- encoding: "utf8",
- });
-
-for (const [value, expected] of [
- ["http://127.0.0.1:8090/", "http://127.0.0.1:8090"],
- ["https://example.com/docs/", "https://example.com/docs"],
- ["https://example.com:0/", "https://example.com:0"],
- ["https://[::1]:8090/workshop/", "https://[::1]:8090/workshop"],
-]) {
- const result = validate(value);
- if (result.status !== 0 || result.stdout.trim() !== expected) {
- throw new Error(`Expected valid runtime URL ${value}: ${result.stderr || result.stdout}`);
- }
-}
-
-for (const value of [
- "",
- "http://",
- "http:///docs",
- "https://:",
- "https://example.com:65536",
- "https://::1",
- "https://[:::1]",
- "http://[:1:2:3:4:5:6:7:8]",
- "http://[1:2:3:4:5:6:7:8:]",
- "https://1.2.3.4.5",
- "http://09.0.0.1",
- "http://099.0.0.1",
- "http://[::ffff:192.168.001.001]",
- "http://[::ffff:192.168.1.01]",
- "http://[fe80::1%25eth0]",
- "https://user:password@example.com",
- "https://example.com/workshop?token=secret",
- "https://example.com/workshop#fragment",
- "https://example.com/\tworkshop",
- "https://example.com/\nworkshop",
-]) {
- const result = validate(value);
- if (result.status === 0) throw new Error(`Expected invalid runtime URL to be rejected: ${JSON.stringify(value)}`);
-}
-
-for (const [value, expected] of [
- ["/", "/"],
- ["/docs/", "/docs"],
- ["/docs..preview", "/docs..preview"],
-]) {
- const result = validateDocsBaseUrl(value);
- if (result.status !== 0 || result.stdout.trim() !== expected) {
- throw new Error(`Expected valid DOCS_BASE_URL ${value}: ${result.stderr || result.stdout}`);
- }
-}
-
-for (const value of ["docs", "/../docs", "/docs/../private", "/./docs", "/docs?preview=1"]) {
- const result = validateDocsBaseUrl(value);
- if (result.status === 0) throw new Error(`Expected invalid DOCS_BASE_URL to be rejected: ${JSON.stringify(value)}`);
-}
-
-console.log("Workshop runtime URL validation passed");
diff --git a/apps/workshop/tests/workshop-contracts.mjs b/apps/workshop/tests/workshop-contracts.mjs
index 7796ea2ad..7219fe970 100644
--- a/apps/workshop/tests/workshop-contracts.mjs
+++ b/apps/workshop/tests/workshop-contracts.mjs
@@ -9,78 +9,33 @@ if (typeof clientExport !== "string") throw new Error("Workshop client export is
await access(resolve("packages/workshop", clientExport));
const hook = await read("apps/workshop/pb_hooks/workshop.pb.js");
-const dockerfile = await read("apps/workshop/Dockerfile");
-const workshopApp = await read("apps/docs/src/components/workshop/WorkshopApp.tsx");
-const workshopAdmin = await read("apps/docs/src/components/workshop/WorkshopAdmin.tsx");
-const workshopDetail = await read("apps/docs/src/components/workshop/DetailPage.tsx");
if (!hook.includes("require(`${__hooks}/workshop-utils.js`)")) {
throw new Error("Workshop handlers must load shared helpers inside their isolated PocketBase contexts");
}
if (!hook.includes("onBootstrap") || !hook.includes("users.oauth2.providers = configured")) {
throw new Error("Workshop OAuth settings must be synchronized at every bootstrap");
}
-if (!hook.includes("WORKSHOP_REQUIRE_OAUTH") || !hook.includes("partial_credentials")) {
- throw new Error("Workshop OAuth bootstrap must reject partial and required-but-disabled configurations");
+if (hook.includes("validateAndNormalizeSubmission")) {
+ throw new Error("PocketBase must store Workshop submissions without interpreting their content");
}
-if (
- !hook.includes("onRecordAuthWithOAuth2Request") ||
- !hook.includes("deriveGithubIdentity") ||
- !hook.includes("event.oauth2User") ||
- hook.includes("event.oAuth2User") ||
- !hook.includes("event.createData.displayName = identity.displayName") ||
- !hook.includes('event.record.set("displayName", identity.displayName)') ||
- !hook.includes("workshop_oauth_identity_synchronized")
-) {
- throw new Error("Workshop GitHub identity must be synchronized for first and returning OAuth logins");
-}
-if (!hook.includes("workshop_report_reopened") || !hook.includes("status = 'dismissed'")) {
- throw new Error("Workshop must permit a fresh report after a previous report was dismissed");
-}
-if (hook.includes("validateAndNormalizeSubmission") || hook.includes("workshop_submission_rejected")) {
- throw new Error("PocketBase must not interpret or validate Workshop submission content");
-}
-for (const removedValidator of [
+for (const artifact of [
"apps/workshop/pb_hooks/widget-validator.js",
"apps/workshop/pb_hooks/widget-validator.bundle.cjs",
"packages/workshop/src/pocketbase-validator.ts",
"scripts/build-workshop-validator.mjs",
]) {
- let artifactExists = true;
- try {
- await access(resolve(removedValidator));
- } catch (error) {
- if (typeof error === "object" && error !== null && "code" in error && error.code === "ENOENT") {
- artifactExists = false;
- } else {
+ await access(resolve(artifact))
+ .then(() => {
+ throw new Error(`Workshop validator artifact must stay removed: ${artifact}`);
+ })
+ .catch((error) => {
+ if (error instanceof Error && "code" in error && error.code === "ENOENT") return;
throw error;
- }
- }
- if (artifactExists) throw new Error(`Workshop validator artifact must stay removed: ${removedValidator}`);
-}
-if (!dockerfile.includes("WORKSHOP_REQUIRE_PUBLIC_ORIGIN=true")) {
- throw new Error("The production Workshop image must require an explicit public origin");
-}
-if (dockerfile.includes("widget-validator") || dockerfile.includes("build-workshop-validator")) {
- throw new Error("The Workshop image must not build or copy a submission validator");
+ });
}
if (hook.includes('findAllRecords("users")') || !hook.includes('findRecordsByFilter("users"')) {
throw new Error("Workshop report notifications must use a filtered, bounded administrator query");
}
-if (!hook.includes("WORKSHOP_WEB_URL")) {
- throw new Error("PocketBase-generated Workshop links must use the configured public web URL");
-}
-for (const [name, source] of [
- ["Workshop listing", workshopApp],
- ["Workshop moderation", workshopAdmin],
- ["Workshop detail", workshopDetail],
-]) {
- if (/]*\bhref=["']\/workshop/u.test(source)) {
- throw new Error(`${name} must use base-path-aware Docusaurus links`);
- }
- if (/window\.location(?:\.href)?\s*=\s*["']\/workshop/u.test(source)) {
- throw new Error(`${name} must use a base-path-aware redirect`);
- }
-}
const migration = await read("apps/workshop/pb_migrations/1784240000_workshop_widgets.js");
for (const required of [
@@ -96,44 +51,6 @@ for (const required of [
if (!migration.includes(required)) throw new Error(`Workshop rollback is missing state restoration: ${required}`);
}
-for (const protectedField of [
- "email:changed",
- "displayName:changed",
- "avatarUrl:changed",
- "githubUsername:changed",
- "githubProfileUrl:changed",
-]) {
- if (!migration.includes(protectedField)) {
- throw new Error(`Workshop OAuth identity field remains caller-controlled: ${protectedField}`);
- }
-}
-if (migration.includes("@request.body.avatar:changed")) {
- throw new Error("Workshop access rules must not use the unsupported :changed modifier for file fields");
-}
-if (
- !hook.includes('getUnsavedFiles("avatar")') ||
- !hook.includes('original().getString("avatar")') ||
- !hook.includes("Workshop avatars are managed by GitHub OAuth")
-) {
- throw new Error("Workshop avatar updates must be rejected by the user update request hook");
-}
-for (const protectedField of [
- "title:changed",
- "description:changed",
- "content:changed",
- "changelog:changed",
- "screenshots:changed",
-]) {
- if (!migration.includes(protectedField)) {
- throw new Error(`Workshop moderators can still rewrite submissions: ${protectedField}`);
- }
-}
-for (const protectedField of ["category:changed", "explanation:changed"]) {
- if (!migration.includes(protectedField)) {
- throw new Error(`Workshop moderators can still rewrite reports: ${protectedField}`);
- }
-}
-
const workflow = await read(".github/workflows/workshop.yml");
if (/\n\s+paths:/u.test(workflow)) throw new Error("Workshop workflow must not filter out Docker build inputs");
diff --git a/apps/workshop/tests/workshop-oauth-hook.mjs b/apps/workshop/tests/workshop-oauth-hook.mjs
deleted file mode 100644
index 61d4985f4..000000000
--- a/apps/workshop/tests/workshop-oauth-hook.mjs
+++ /dev/null
@@ -1,168 +0,0 @@
-import { createRequire } from "node:module";
-import { readFile } from "node:fs/promises";
-import vm from "node:vm";
-
-const nodeRequire = createRequire(import.meta.url);
-const workshopUtils = nodeRequire("../pb_hooks/workshop-utils.js");
-const hookSource = await readFile("apps/workshop/pb_hooks/workshop.pb.js", "utf8");
-let oauthHook;
-let userUpdateHook;
-
-const ignoreHook = () => {};
-vm.runInNewContext(hookSource, {
- __hooks: "/pb_hooks",
- console: { log: () => {} },
- onBootstrap: ignoreHook,
- onRecordAfterCreateSuccess: ignoreHook,
- onRecordCreateRequest: ignoreHook,
- onRecordDeleteRequest: ignoreHook,
- onRecordUpdateRequest: (handler, collection) => {
- if (collection === "users") userUpdateHook = handler;
- },
- onRecordAuthWithOAuth2Request: (handler, collection) => {
- if (collection !== "users") throw new Error(`OAuth hook targets unexpected collection: ${collection}`);
- oauthHook = handler;
- },
- require: (specifier) => {
- if (specifier !== "/pb_hooks/workshop-utils.js") {
- throw new Error(`OAuth hook loaded unexpected dependency: ${specifier}`);
- }
- return {
- ...workshopUtils,
- rejectRequest: (message) => {
- throw new Error(message);
- },
- };
- },
-});
-
-if (typeof oauthHook !== "function") throw new Error("Workshop OAuth request hook was not registered");
-if (typeof userUpdateHook !== "function") throw new Error("Workshop user update hook was not registered");
-
-const oauth2User = {
- id: "provider-user-123",
- name: "Octo Cat",
- username: "octocat",
- avatarURL: "https://avatars.githubusercontent.com/u/1?v=4",
- rawUser: {},
-};
-const createData = {};
-let createNextCalls = 0;
-oauthHook({
- app: { save: () => Promise.reject(new Error("New OAuth users must not be saved before PocketBase creates them")) },
- createData,
- next: () => {
- createNextCalls += 1;
- },
- oauth2User,
- providerName: "github",
- record: null,
-});
-if (
- createNextCalls !== 1 ||
- createData.displayName !== "Octo Cat" ||
- createData.avatarUrl !== "https://avatars.githubusercontent.com/u/1?v=4" ||
- createData.githubUsername !== "octocat" ||
- createData.githubProfileUrl !== "https://github.com/octocat"
-) {
- throw new Error(`First GitHub OAuth login did not synchronize trusted identity: ${JSON.stringify(createData)}`);
-}
-
-const returningValues = new Map();
-const returningRecord = {
- id: "returning-user-123",
- set: (name, value) => returningValues.set(name, value),
-};
-let savedRecord;
-let returningNextCalls = 0;
-oauthHook({
- app: {
- save: (record) => {
- savedRecord = record;
- },
- },
- createData: {},
- next: () => {
- returningNextCalls += 1;
- },
- oauth2User,
- providerName: "github",
- record: returningRecord,
-});
-if (
- savedRecord !== returningRecord ||
- returningNextCalls !== 1 ||
- returningValues.get("displayName") !== "Octo Cat" ||
- returningValues.get("avatar") !== "" ||
- returningValues.get("avatarUrl") !== "https://avatars.githubusercontent.com/u/1?v=4" ||
- returningValues.get("githubUsername") !== "octocat" ||
- returningValues.get("githubProfileUrl") !== "https://github.com/octocat"
-) {
- throw new Error("Returning GitHub OAuth login did not refresh trusted identity");
-}
-
-const ignoredCreateData = {};
-let ignoredNextCalls = 0;
-oauthHook({
- app: {},
- createData: ignoredCreateData,
- next: () => {
- ignoredNextCalls += 1;
- },
- oauth2User,
- providerName: "oidc",
- record: null,
-});
-if (ignoredNextCalls !== 1 || Object.keys(ignoredCreateData).length !== 0) {
- throw new Error("Non-GitHub OAuth providers must pass through without GitHub identity synchronization");
-}
-
-let unchangedAvatarNextCalls = 0;
-userUpdateHook({
- next: () => {
- unchangedAvatarNextCalls += 1;
- },
- record: {
- getString: () => "provider-avatar.png",
- getUnsavedFiles: () => [],
- original: () => ({ getString: () => "provider-avatar.png" }),
- },
-});
-if (unchangedAvatarNextCalls !== 1) {
- throw new Error("User updates that leave the provider avatar unchanged must pass through");
-}
-
-for (const avatarChange of [
- {
- name: "upload",
- current: "provider-avatar.png",
- original: "provider-avatar.png",
- unsavedFiles: [{ name: "forged-avatar.png" }],
- },
- {
- name: "removal",
- current: "",
- original: "provider-avatar.png",
- unsavedFiles: [],
- },
-]) {
- let nextCalls = 0;
- try {
- userUpdateHook({
- next: () => {
- nextCalls += 1;
- },
- record: {
- getString: () => avatarChange.current,
- getUnsavedFiles: () => avatarChange.unsavedFiles,
- original: () => ({ getString: () => avatarChange.original }),
- },
- });
- throw new Error(`Workshop user avatar ${avatarChange.name} was accepted`);
- } catch (error) {
- if (!String(error).includes("managed by GitHub OAuth")) throw error;
- }
- if (nextCalls !== 0) throw new Error(`Rejected avatar ${avatarChange.name} continued the update request`);
-}
-
-console.log("Workshop OAuth hook contract passed");
diff --git a/apps/workshop/tests/workshop-rollback.integration.mjs b/apps/workshop/tests/workshop-rollback.integration.mjs
deleted file mode 100644
index 45815459d..000000000
--- a/apps/workshop/tests/workshop-rollback.integration.mjs
+++ /dev/null
@@ -1,261 +0,0 @@
-import assert from "node:assert/strict";
-import { readFile, writeFile } from "node:fs/promises";
-
-const baseUrl = process.env.WORKSHOP_TEST_URL;
-const snapshotPath = process.env.WORKSHOP_ROLLBACK_SNAPSHOT;
-const phase = process.argv[2];
-if (!baseUrl) throw new Error("WORKSHOP_TEST_URL is required");
-if (!snapshotPath) throw new Error("WORKSHOP_ROLLBACK_SNAPSHOT is required");
-if (!["fresh-prepare", "fresh-migrated", "fresh-restored", "prepare", "migrated", "restored"].includes(phase)) {
- throw new Error("Unknown Workshop rollback test phase");
-}
-
-const superuser = {
- email: "workshop-rollback@example.invalid",
- password: "WorkshopRollback123!",
-};
-const baselineUser = {
- email: "rollback-user@example.invalid",
- password: "WorkshopRollbackUser123!",
- note: "retained across the Workshop migration chain",
-};
-const workshopCollections = [
- "workshop_migration_state",
- "submissions",
- "votes",
- "comments",
- "reports",
- "workshop_listings",
-];
-const workshopUserFields = ["displayName", "avatarUrl", "avatar", "githubUsername", "githubProfileUrl", "isAdmin"];
-
-const request = async (path, init = {}) => {
- const response = await fetch(`${baseUrl}${path}`, {
- ...init,
- headers: { "content-type": "application/json", ...init.headers },
- });
- const body = await response.json().catch(() => null);
- if (!response.ok) throw new Error(`${response.status} ${path}: ${JSON.stringify(body)}`);
- return body;
-};
-
-const auth = await request("/api/collections/_superusers/auth-with-password", {
- method: "POST",
- body: JSON.stringify({ identity: superuser.email, password: superuser.password }),
-});
-const rootHeaders = { authorization: `Bearer ${auth.token}` };
-
-const collectionList = async () => {
- const result = await request("/api/collections?perPage=200", { headers: rootHeaders });
- return new Map(result.items.map((collection) => [collection.name, collection]));
-};
-const collection = (name) => request(`/api/collections/${name}`, { headers: rootHeaders });
-const records = (name) =>
- request(`/api/collections/${name}/records?perPage=200`, {
- headers: rootHeaders,
- });
-const normalized = (value) => JSON.parse(JSON.stringify(value));
-const publicOauthConfig = (oauth2) => {
- const value = normalized(oauth2);
- value.providers = value.providers?.map(({ clientSecret: _clientSecret, ...provider }) => provider);
- return value;
-};
-const userConfig = (users) => ({
- rules: {
- listRule: users.listRule,
- viewRule: users.viewRule,
- createRule: users.createRule,
- updateRule: users.updateRule,
- deleteRule: users.deleteRule,
- },
- passwordAuth: normalized(users.passwordAuth),
- oauth2: publicOauthConfig(users.oauth2),
- fieldNames: users.fields.map((field) => field.name).toSorted(),
-});
-const readSnapshot = async () => JSON.parse(await readFile(snapshotPath, "utf8"));
-
-const assertBaselineData = async () => {
- const userRecords = await records("users");
- const retainedUser = userRecords.items.find((record) => record.email === baselineUser.email);
- assert.equal(retainedUser?.baselineNote, baselineUser.note, "Baseline user data was not retained");
-
- const sentinelRecords = await records("rollback_sentinel");
- assert.equal(sentinelRecords.items.length, 1, "Unrelated baseline record count changed");
- assert.equal(sentinelRecords.items[0]?.value, "keep-me", "Unrelated baseline data changed");
-};
-
-const assertMigrated = async () => {
- const before = await readSnapshot();
- const collections = await collectionList();
- for (const name of [...workshopCollections, "users", "rollback_sentinel"]) {
- assert.ok(collections.has(name), `Migrated database is missing collection ${name}`);
- }
-
- const users = await collection("users");
- assert.equal(users.passwordAuth?.enabled, false, "Workshop migration must disable password authentication");
- assert.deepEqual(
- publicOauthConfig(users.oauth2),
- before.users.oauth2,
- "Workshop migration changed existing OAuth settings",
- );
- for (const name of workshopUserFields) {
- assert.ok(
- users.fields.some((field) => field.name === name),
- `Workshop user field ${name} is missing`,
- );
- }
- assert.match(
- users.updateRule ?? "",
- /githubProfileUrl:changed = false/u,
- "OAuth identity update rule is not hardened",
- );
-
- const stateRecords = await records("workshop_migration_state");
- assert.equal(stateRecords.items.length, 1, "Workshop migration state snapshot is missing");
- const migrationState = JSON.parse(stateRecords.items[0].snapshot);
- assert.equal(migrationState.usersExisted, true, "Workshop migration did not recognize the existing users collection");
- assert.deepEqual(migrationState.users.passwordAuth, before.users.passwordAuth);
- assert.deepEqual(publicOauthConfig(migrationState.users.oauth2), before.users.oauth2);
- assert.deepEqual(
- {
- listRule: migrationState.users.listRule,
- viewRule: migrationState.users.viewRule,
- createRule: migrationState.users.createRule,
- updateRule: migrationState.users.updateRule,
- deleteRule: migrationState.users.deleteRule,
- },
- before.users.rules,
- "Workshop migration state did not snapshot the original user rules",
- );
- assert.equal(
- migrationState.users.oauth2.providers.find((provider) => provider.name === "github")?.clientSecret,
- "rollback-baseline-secret",
- "Workshop migration state did not retain the OAuth secret required for rollback",
- );
- await assertBaselineData();
-};
-
-if (phase === "fresh-prepare") {
- let collections = await collectionList();
- if (collections.has("users")) {
- await request("/api/collections/users", { method: "DELETE", headers: rootHeaders });
- collections = await collectionList();
- }
- for (const name of [...workshopCollections, "users", "rollback_sentinel"]) {
- assert.ok(!collections.has(name), `Fresh database unexpectedly contains collection ${name}`);
- }
- await writeFile(snapshotPath, "{}", { mode: 0o600 });
- console.log("Workshop fresh rollback baseline captured");
-} else if (phase === "fresh-migrated") {
- const collections = await collectionList();
- for (const name of [...workshopCollections, "users"]) {
- assert.ok(collections.has(name), `Fresh migration is missing collection ${name}`);
- }
- const users = await collection("users");
- for (const name of workshopUserFields) {
- assert.ok(
- users.fields.some((field) => field.name === name),
- `Fresh migration is missing user field ${name}`,
- );
- }
- const stateRecords = await records("workshop_migration_state");
- assert.equal(stateRecords.items.length, 1, "Fresh migration state snapshot is missing");
- const migrationState = JSON.parse(stateRecords.items[0].snapshot);
- assert.equal(migrationState.usersExisted, false, "Fresh migration incorrectly recorded an existing users collection");
- assert.equal(migrationState.users, null, "Fresh migration retained nonexistent user settings");
- console.log("Workshop fresh migration chain verified");
-} else if (phase === "fresh-restored") {
- const collections = await collectionList();
- for (const name of [...workshopCollections, "users", "rollback_sentinel"]) {
- assert.ok(!collections.has(name), `Fresh rollback left collection ${name}`);
- }
- assert.ok(collections.has("_superusers"), "Fresh rollback removed PocketBase superuser data");
- console.log("Workshop fresh rollback state verified");
-} else if (phase === "prepare") {
- const collections = await collectionList();
- for (const name of [...workshopCollections, "users", "rollback_sentinel"]) {
- assert.ok(!collections.has(name), `Fresh rollback fixture unexpectedly contains collection ${name}`);
- }
-
- await request("/api/collections", {
- method: "POST",
- headers: rootHeaders,
- body: JSON.stringify({
- type: "auth",
- name: "users",
- listRule: "@request.auth.id != ''",
- viewRule: "id = @request.auth.id",
- createRule: "@request.body.email != ''",
- updateRule: "id = @request.auth.id",
- deleteRule: "id = @request.auth.id",
- passwordAuth: { enabled: true, identityFields: ["email"] },
- oauth2: {
- enabled: true,
- providers: [
- {
- name: "github",
- clientId: "rollback-baseline-client",
- clientSecret: "rollback-baseline-secret",
- },
- ],
- },
- fields: [{ type: "text", name: "baselineNote", max: 200 }],
- }),
- });
- await request("/api/collections", {
- method: "POST",
- headers: rootHeaders,
- body: JSON.stringify({
- type: "base",
- name: "rollback_sentinel",
- listRule: null,
- viewRule: null,
- createRule: null,
- updateRule: null,
- deleteRule: null,
- fields: [{ type: "text", name: "value", required: true, max: 100 }],
- }),
- });
- await request("/api/collections/users/records", {
- method: "POST",
- headers: rootHeaders,
- body: JSON.stringify({
- email: baselineUser.email,
- emailVisibility: false,
- verified: true,
- password: baselineUser.password,
- passwordConfirm: baselineUser.password,
- baselineNote: baselineUser.note,
- }),
- });
- await request("/api/collections/rollback_sentinel/records", {
- method: "POST",
- headers: rootHeaders,
- body: JSON.stringify({ value: "keep-me" }),
- });
-
- const users = await collection("users");
- assert.equal(users.passwordAuth?.enabled, true);
- assert.equal(users.oauth2?.enabled, true);
- assert.ok(users.oauth2?.providers?.some((provider) => provider.name === "github"));
- await assertBaselineData();
- await writeFile(snapshotPath, JSON.stringify({ users: userConfig(users) }), { mode: 0o600 });
- console.log("Workshop rollback baseline prepared");
-} else if (phase === "migrated") {
- await assertMigrated();
- console.log("Workshop full migration chain verified");
-} else {
- const before = await readSnapshot();
- const collections = await collectionList();
- for (const name of workshopCollections) {
- assert.ok(!collections.has(name), `Rollback left Workshop collection ${name}`);
- }
- for (const name of ["users", "rollback_sentinel"]) {
- assert.ok(collections.has(name), `Rollback removed baseline collection ${name}`);
- }
-
- const users = await collection("users");
- assert.deepEqual(userConfig(users), before.users, "Rollback did not restore user rules, fields, password, or OAuth");
- await assertBaselineData();
- console.log("Workshop full rollback state verified");
-}
diff --git a/apps/workshop/workshop-url.awk b/apps/workshop/workshop-url.awk
deleted file mode 100644
index 2f2dd04d1..000000000
--- a/apps/workshop/workshop-url.awk
+++ /dev/null
@@ -1,111 +0,0 @@
-function reject(message) {
- print variable_name " " message > "/dev/stderr"
- failed = 1
- exit 1
-}
-
-function valid_port(value, number) {
- if (value !~ /^[0-9]+$/ || length(value) > 5) return 0
- number = value + 0
- return number >= 0 && number <= 65535
-}
-
-function valid_ipv4(value, parts, count, part_index) {
- if (value !~ /^[0-9.]+$/) return 0
- count = split(value, parts, ".")
- if (count != 4) return 0
- for (part_index = 1; part_index <= count; part_index++) {
- if (length(parts[part_index]) > 1 && substr(parts[part_index], 1, 1) == "0") return 0
- if (parts[part_index] == "" || parts[part_index] + 0 < 0 || parts[part_index] + 0 > 255) return 0
- }
- return 1
-}
-
-function valid_hostname(value, labels, count, label_index) {
- if (value == "" || length(value) > 253 || value !~ /^[A-Za-z0-9._-]+$/) return 0
- if (value ~ /^[0-9.]+$/) return valid_ipv4(value)
- count = split(value, labels, ".")
- for (label_index = 1; label_index <= count; label_index++) {
- if (labels[label_index] == "" || length(labels[label_index]) > 63) return 0
- if (labels[label_index] ~ /^-/ || labels[label_index] ~ /-$/) return 0
- }
- return 1
-}
-
-function valid_ipv6(value, percent, address, starts_single_colon, ends_single_colon, collapsed, parts, count, groups, part_index) {
- percent = index(value, "%")
- if (percent) return 0
- address = value
- if (address !~ /:/ || address ~ /:::/ || address !~ /^[0-9A-Fa-f:.]+$/) return 0
- starts_single_colon = substr(address, 1, 1) == ":" && substr(address, 1, 2) != "::"
- ends_single_colon = substr(address, length(address), 1) == ":" && substr(address, length(address) - 1) != "::"
- if (starts_single_colon || ends_single_colon) return 0
- collapsed = address
- sub(/::/, "", collapsed)
- if (collapsed ~ /::/) return 0
-
- count = split(address, parts, ":")
- groups = 0
- for (part_index = 1; part_index <= count; part_index++) {
- if (parts[part_index] == "") continue
- if (parts[part_index] ~ /\./) {
- if (part_index != count || !valid_ipv4(parts[part_index])) return 0
- groups += 2
- } else {
- if (parts[part_index] !~ /^[0-9A-Fa-f]+$/ || length(parts[part_index]) > 4) return 0
- groups++
- }
- }
- return address ~ /::/ ? groups < 8 : groups == 8
-}
-
-{
- if (NR != 1) reject("must be a single-line URL")
- value = $0
- if (value ~ /[[:cntrl:][:space:]]/ || index(value, "\"") || index(value, "\\")) {
- reject("must not contain control characters, whitespace, quotes, or backslashes")
- }
- if (value !~ /^https?:\/\//) reject("must be an absolute HTTP(S) URL")
- if (value ~ /[?#]/) reject("must not contain a query string or fragment")
-
- rest = value
- sub(/^https?:\/\//, "", rest)
- slash = index(rest, "/")
- authority = slash ? substr(rest, 1, slash - 1) : rest
- if (authority == "") reject("must include a host")
- if (authority ~ /@/) reject("must not contain credentials")
-
- port = ""
- if (authority ~ /^\[/) {
- close_index = index(authority, "]")
- if (!close_index) reject("contains an invalid IPv6 host")
- host = substr(authority, 2, close_index - 2)
- suffix = substr(authority, close_index + 1)
- if (!valid_ipv6(host)) reject("contains an invalid IPv6 host")
- if (suffix != "") {
- if (suffix !~ /^:/) reject("contains an invalid host")
- port = substr(suffix, 2)
- }
- } else {
- host_with_port = authority
- colon_count = gsub(/:/, ":", host_with_port)
- if (colon_count > 1) reject("must wrap IPv6 hosts in brackets")
- colon = index(authority, ":")
- host = colon ? substr(authority, 1, colon - 1) : authority
- port = colon ? substr(authority, colon + 1) : ""
- if (!valid_hostname(host)) reject("contains an invalid host")
- }
- if (port != "" && !valid_port(port)) reject("contains an invalid port")
-
- while (length(value) > 0 && substr(value, length(value), 1) == "/") {
- value = substr(value, 1, length(value) - 1)
- }
- print value
-}
-
-END {
- if (!failed && NR != 1) {
- print variable_name " must be a single-line URL" > "/dev/stderr"
- exit 1
- }
-}
diff --git a/e2e/custom-widgets-custom-jsx-v2.spec.ts b/e2e/custom-widgets-custom-jsx-v2.spec.ts
index 313c88863..dbd66d005 100644
--- a/e2e/custom-widgets-custom-jsx-v2.spec.ts
+++ b/e2e/custom-widgets-custom-jsx-v2.spec.ts
@@ -1,183 +1,18 @@
-import { createServer } from "node:http";
-
import { chromium, expect } from "@playwright/test";
import type { Browser } from "@playwright/test";
-import { stringify as stringifySuperJson } from "superjson";
import type { StartedTestContainer } from "testcontainers";
import { describe, test } from "vitest";
-import { eq } from "drizzle-orm";
-import {
- customWidgetDefinitions,
- customWidgetSecrets,
- legacyCustomWidgetDefinitions,
- legacyCustomWidgetSecrets,
-} from "../packages/db/schema/sqlite";
-import type { HomarrCustomWidgetV2Input } from "../packages/custom-widgets/src/core";
-
import { createHomarrContainer } from "./shared/create-homarr-container";
import { createSqliteDbFileAsync } from "./shared/e2e-db";
import type { MockApiServer } from "./shared/mock-api-server";
-import { exposeHostPortToContainersAsync, startMockApiServerAsync } from "./shared/mock-api-server";
+import { startMockApiServerAsync } from "./shared/mock-api-server";
import { seedAdminUserAsync } from "./shared/seed-admin-user";
const adminCredentials = { username: "admin", password: "Comp(exP4sswOrd" };
const initialTemplate =
"{data.status?.title}{data.status?.status}";
const updatedTemplate = "{data.status?.title}{data.status?.value}";
-const workshopWidgetName = "Workshop E2E widget";
-const legacyWidgetName = "Legacy E2E Widget";
-const legacyWidgetId = "legacy-e2e-widget";
-
-interface WorkshopMockServer {
- url: string;
- close(): Promise;
-}
-
-const startWorkshopMockServerAsync = async (widget: HomarrCustomWidgetV2Input): Promise => {
- const submissionId = "e2eworkshop0001";
- const timestamp = "2026-07-28T10:00:00.000Z";
- const listing = {
- id: submissionId,
- collectionId: "workshop-listings",
- collectionName: "workshop_listings",
- type: "customWidget",
- title: workshopWidgetName,
- description: "Installed from the Workshop and rendered on a Homarr board.",
- widgetSchema: "homarr-custom-widget-v2",
- screenshots: [],
- author: "e2e-author",
- authorName: "E2E Workshop author",
- authorAvatar: "",
- authorAvatarUrl: "",
- authorGithubUsername: "",
- authorGithubProfileUrl: "",
- score: 1,
- upvotes: 1,
- downvotes: 0,
- commentCount: 0,
- reportCount: 0,
- revision: 1,
- changelog: "Initial E2E submission",
- outdated: false,
- created: timestamp,
- updated: timestamp,
- };
- const submission = {
- id: submissionId,
- collectionId: "submissions",
- collectionName: "submissions",
- type: listing.type,
- title: listing.title,
- description: listing.description,
- widgetSchema: listing.widgetSchema,
- content: JSON.stringify(widget),
- revision: listing.revision,
- changelog: listing.changelog,
- outdated: listing.outdated,
- screenshots: listing.screenshots,
- author: listing.author,
- created: timestamp,
- updated: timestamp,
- };
-
- const server = createServer((request, response) => {
- response.setHeader("Access-Control-Allow-Origin", "*");
- response.setHeader("Access-Control-Allow-Headers", "*");
- response.setHeader("Access-Control-Allow-Methods", "GET, OPTIONS");
- response.setHeader("Access-Control-Allow-Private-Network", "true");
- response.setHeader("Content-Type", "application/json");
-
- if (request.method === "OPTIONS") {
- response.writeHead(204);
- response.end();
- return;
- }
-
- const pathname = new URL(request.url ?? "/", "http://127.0.0.1").pathname;
- if (request.method === "GET" && pathname === "/api/collections/workshop_listings/records") {
- response.end(
- JSON.stringify({
- page: 1,
- perPage: 24,
- totalItems: 1,
- totalPages: 1,
- items: [listing],
- }),
- );
- return;
- }
- if (request.method === "GET" && pathname === `/api/collections/workshop_listings/records/${submissionId}`) {
- response.end(JSON.stringify(listing));
- return;
- }
- if (request.method === "GET" && pathname === `/api/collections/submissions/records/${submissionId}`) {
- response.end(JSON.stringify(submission));
- return;
- }
-
- response.writeHead(404);
- response.end(JSON.stringify({ code: 404, message: "Not found.", data: {} }));
- });
-
- await new Promise((resolve, reject) => {
- server.once("error", reject);
- server.listen(0, "0.0.0.0", () => {
- server.off("error", reject);
- resolve();
- });
- });
- const address = server.address();
- if (!address || typeof address === "string") throw new Error("Workshop mock server did not bind to a TCP port");
-
- try {
- return {
- url: await exposeHostPortToContainersAsync(address.port),
- close: () =>
- new Promise((resolve, reject) => {
- server.close((error) => (error ? reject(error) : resolve()));
- server.closeAllConnections();
- }),
- };
- } catch (error) {
- server.closeAllConnections();
- server.close();
- throw error;
- }
-};
-
-const loginAsAdmin = async (browser: Browser, baseUrl: string, clipboard = false) => {
- const context = await browser.newContext({
- permissions: clipboard ? ["clipboard-read", "clipboard-write"] : [],
- });
- const page = await context.newPage();
- await page.goto(`${baseUrl}/auth/login`);
- await page.waitForLoadState("networkidle");
- await page.getByLabel("Username").fill(adminCredentials.username);
- await page.locator("#password").fill(adminCredentials.password);
- await page.locator("button[type='submit']").click();
- await page.waitForURL(baseUrl, { timeout: 15_000 });
- return page;
-};
-
-const addCustomWidgetToBoard = async (
- page: Awaited>,
- baseUrl: string,
- name: string,
-) => {
- await page.goto(baseUrl);
- await page.getByRole("button", { name: "Edit", exact: true }).click();
- await page.getByRole("button", { name: "New item", exact: true }).click();
- await page.getByRole("menuitem", { name: "New item", exact: true }).click();
- const picker = page.getByRole("dialog").last();
- const customWidgetCard = picker.getByText(name, { exact: true }).locator("xpath=../../..");
- await customWidgetCard.hover();
- await customWidgetCard.getByRole("button", { name: "Add to board" }).click();
- const addDialog = page.getByRole("dialog", { name: `Edit item - ${name}`, exact: true });
- await expect(addDialog).toBeVisible();
- await addDialog.getByRole("button", { name: "Save changes", exact: true }).click();
- await page.getByRole("button", { name: "Save", exact: true }).click();
-};
describe("Custom JSX v2 workbench", () => {
test("creates, previews, edits, and immediately adds a widget to a board", async () => {
@@ -195,7 +30,14 @@ describe("Custom JSX v2 workbench", () => {
}).start();
const baseUrl = `http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`;
browser = await chromium.launch();
- const page = await loginAsAdmin(browser, baseUrl);
+ const page = await browser.newPage();
+
+ await page.goto(`${baseUrl}/auth/login`);
+ await page.waitForLoadState("networkidle");
+ await page.getByLabel("Username").fill(adminCredentials.username);
+ await page.locator("#password").fill(adminCredentials.password);
+ await page.locator("button[type='submit']").click();
+ await page.waitForURL(baseUrl, { timeout: 15_000 });
await page.goto(`${baseUrl}/manage/custom-widgets/new`);
await page.locator('input[data-path="name"]:visible').fill("E2E Custom JSX v2");
@@ -232,222 +74,24 @@ describe("Custom JSX v2 workbench", () => {
await page.getByRole("button", { name: "Save", exact: true }).last().click();
await expect(page.getByText('Widget "E2E Custom JSX v2" updated successfully.')).toBeVisible({ timeout: 15_000 });
- await addCustomWidgetToBoard(page, baseUrl, "E2E Custom JSX v2");
- await expect(page.getByText("E2E Widget")).toBeVisible({ timeout: 15_000 });
- await expect(page.getByText("42", { exact: true })).toBeVisible({ timeout: 15_000 });
+ await page.goto(baseUrl);
+ await page.getByRole("button", { name: "Edit", exact: true }).click();
+ await page.getByRole("button", { name: "New item", exact: true }).click();
+ await page.getByRole("menuitem", { name: "New item", exact: true }).click();
+ const picker = page.getByRole("dialog").last();
+ const customWidgetCard = picker.getByText("E2E Custom JSX v2", { exact: true }).locator("xpath=../../..");
+ await customWidgetCard.hover();
+ await customWidgetCard.getByRole("button", { name: "Add to board" }).click();
+ const addDialog = page.getByRole("dialog").last();
+ await expect(addDialog.getByText("E2E Custom JSX v2")).toBeVisible();
+ await addDialog.getByRole("button", { name: "Save changes", exact: true }).click();
+
await expect(page.getByText("Widget definition not found")).not.toBeVisible();
+ await page.getByRole("button", { name: "Save", exact: true }).click();
+ await expect(page.getByText("E2E Widget")).toBeVisible({ timeout: 15_000 });
+ await expect(page.getByText("42")).toBeVisible({ timeout: 15_000 });
} finally {
await Promise.allSettled([browser?.close(), homarrContainer?.stop(), mockApi?.close()]);
}
}, 180_000);
-
- test("installs a Workshop widget, places it on a board, and renders its query", async () => {
- let mockApi: MockApiServer | undefined;
- let workshopMock: WorkshopMockServer | undefined;
- let homarrContainer: StartedTestContainer | undefined;
- let browser: Browser | undefined;
-
- try {
- mockApi = await startMockApiServerAsync({ title: "Workshop query result", status: "online", value: 73 });
- const workshopWidget = {
- $schema: "homarr-custom-widget-v2",
- name: workshopWidgetName,
- description: "A Workshop installation exercised by the integrated E2E suite.",
- sources: {
- default: {
- name: "E2E API",
- baseUrl: mockApi.url,
- networkScope: "private",
- auth: "none",
- },
- },
- requests: { status: { path: "/status" } },
- options: {},
- template: updatedTemplate,
- } satisfies HomarrCustomWidgetV2Input;
- workshopMock = await startWorkshopMockServerAsync(workshopWidget);
- const { db, localMountPath } = await createSqliteDbFileAsync();
- await seedAdminUserAsync(db, adminCredentials);
- homarrContainer = await createHomarrContainer({
- environment: {
- AUTH_PROVIDERS: "credentials",
- WORKSHOP_API_URL: workshopMock.url,
- },
- mounts: { "/appdata": localMountPath },
- }).start();
- const baseUrl = `http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`;
- browser = await chromium.launch();
- const page = await loginAsAdmin(browser, baseUrl);
-
- await page.goto(`${baseUrl}/manage/workshop`);
- await expect(page.getByText(workshopWidgetName, { exact: true })).toBeVisible({ timeout: 15_000 });
- await page.getByRole("button", { name: "Inspect widget" }).click();
- const workshopDialog = page.getByRole("dialog", { name: workshopWidgetName });
- await expect(
- workshopDialog.getByText("Installed from the Workshop and rendered on a Homarr board."),
- ).toBeVisible();
- await workshopDialog.getByRole("button", { name: "Install widget" }).click();
-
- const importDialog = page.getByRole("dialog", { name: "Review custom widget import" });
- await importDialog
- .getByRole("checkbox", {
- name: "I confirm that this server URL is correct for my Homarr installation",
- })
- .check();
- await importDialog.getByRole("button", { name: "Import widget" }).click();
- await expect(page.getByText("Widget imported successfully.")).toBeVisible({ timeout: 15_000 });
- await page.waitForURL("**/manage/custom-widgets/edit/**", { timeout: 15_000 });
-
- await addCustomWidgetToBoard(page, baseUrl, workshopWidgetName);
- await expect(page.getByText("Workshop query result")).toBeVisible({ timeout: 15_000 });
- await expect(page.getByText("73")).toBeVisible({ timeout: 15_000 });
- await expect(page.getByText("Widget definition not found")).not.toBeVisible();
- } finally {
- await Promise.allSettled([browser?.close(), homarrContainer?.stop(), workshopMock?.close(), mockApi?.close()]);
- }
- }, 180_000);
-
- test("migrates a redacted preserved v1 widget and resurfaces it when the v2 replacement is deleted", async () => {
- let homarrContainer: StartedTestContainer | undefined;
- let browser: Browser | undefined;
-
- const encryptedValue = "preserved.ciphertext" as `${string}.${string}`;
- const migratedWidget = {
- $schema: "homarr-custom-widget-v2",
- name: legacyWidgetName,
- description: "Validated v2 replacement for the preserved legacy widget.",
- sources: {
- default: {
- name: "Legacy API",
- baseUrl: "https://legacy-api.homarr.dev/api",
- networkScope: "public",
- auth: { type: "apiKeyHeader", name: "X-E2E-Key" },
- },
- },
- requests: { status: { path: "/status" } },
- options: {},
- template: "{data.status?.value}",
- } satisfies HomarrCustomWidgetV2Input;
-
- try {
- const { db, localMountPath } = await createSqliteDbFileAsync();
- const { userId } = await seedAdminUserAsync(db, adminCredentials);
- await db.insert(legacyCustomWidgetDefinitions).values({
- id: legacyWidgetId,
- name: legacyWidgetName,
- description: "Preserved v1 fixture",
- url: "https://legacy-user:super-secret@legacy-api.homarr.dev/api/status?token=token-value#fragment",
- authType: "apiKeyHeader",
- headerName: "X-E2E-Key",
- method: "POST",
- requestBody: JSON.stringify({ password: "nested-secret", filters: ["private-filter"] }),
- displayType: "singleValue",
- displayConfig: stringifySuperJson({ type: "singleValue", jsonPath: "$.value" }),
- enabled: true,
- creatorId: userId,
- });
- await db.insert(legacyCustomWidgetSecrets).values({
- definitionId: legacyWidgetId,
- kind: "apiKey",
- encryptedValue,
- updatedAt: new Date(0),
- });
-
- homarrContainer = await createHomarrContainer({
- environment: { AUTH_PROVIDERS: "credentials" },
- mounts: { "/appdata": localMountPath },
- }).start();
- const baseUrl = `http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`;
- browser = await chromium.launch();
- const page = await loginAsAdmin(browser, baseUrl, true);
-
- await page.goto(`${baseUrl}/manage/custom-widgets`);
- const legacyCard = page
- .getByText(legacyWidgetName, { exact: true })
- .locator("xpath=ancestor::*[contains(@class, 'mantine-Card-root')]");
- await expect(legacyCard.getByText("Migration required", { exact: true })).toBeVisible();
- await legacyCard.getByRole("button", { name: "Actions" }).click();
- await page.getByRole("menuitem", { name: "Copy LLM migration prompt" }).click();
- await expect(page.getByText(/A redacted migration prompt was copied/u)).toBeVisible({ timeout: 15_000 });
- const prompt = await page.evaluate(() => navigator.clipboard.readText());
- expect(prompt).toContain("[REDACTED]");
- expect(prompt).not.toContain("legacy-user");
- expect(prompt).not.toContain("super-secret");
- expect(prompt).not.toContain("token-value");
- expect(prompt).not.toContain("nested-secret");
- expect(prompt).not.toContain("private-filter");
-
- await page.evaluate((widget) => navigator.clipboard.writeText(JSON.stringify(widget)), migratedWidget);
- await legacyCard.getByRole("button", { name: "Actions" }).click();
- await page.getByRole("menuitem", { name: "Paste migrated widget" }).click();
- const migrationDialog = page.getByRole("dialog", { name: "Review migrated v2 replacement" });
- await migrationDialog.getByRole("button", { name: "Confirm v2 replacement" }).click();
- await expect(
- page.getByText("Legacy widget migrated successfully. Existing board placements now use the v2 definition."),
- ).toBeVisible({ timeout: 15_000 });
-
- expect(
- await db.query.legacyCustomWidgetDefinitions.findFirst({
- where: eq(legacyCustomWidgetDefinitions.id, legacyWidgetId),
- }),
- ).toMatchObject({ id: legacyWidgetId, name: legacyWidgetName });
- expect(
- await db.query.legacyCustomWidgetSecrets.findFirst({
- where: eq(legacyCustomWidgetSecrets.definitionId, legacyWidgetId),
- }),
- ).toMatchObject({ definitionId: legacyWidgetId, encryptedValue });
- expect(
- await db.query.customWidgetDefinitions.findFirst({
- where: eq(customWidgetDefinitions.id, legacyWidgetId),
- }),
- ).toMatchObject({ id: legacyWidgetId, name: legacyWidgetName });
- expect(
- await db.query.customWidgetSecrets.findFirst({
- where: eq(customWidgetSecrets.definitionId, legacyWidgetId),
- }),
- ).toMatchObject({
- definitionId: legacyWidgetId,
- sourceId: "default",
- kind: "apiKey",
- encryptedValue,
- });
-
- await page.reload();
- const migratedCard = page
- .getByRole("main")
- .getByText(legacyWidgetName, { exact: true })
- .locator("xpath=ancestor::*[contains(@class, 'mantine-Card-root')]");
- await expect(migratedCard.getByText("Migration required", { exact: true })).not.toBeVisible();
- await migratedCard.getByRole("button", { name: "Actions" }).click();
- await page.getByRole("menuitem", { name: "Delete Custom Widget" }).click();
- const deleteDialog = page.getByRole("dialog", { name: "Delete Custom Widget" });
- await deleteDialog.getByRole("button", { name: "Confirm", exact: true }).click();
- await expect(page.getByText(`Widget "${legacyWidgetName}" deleted.`)).toBeVisible({ timeout: 15_000 });
-
- expect(
- await db.query.customWidgetDefinitions.findFirst({
- where: eq(customWidgetDefinitions.id, legacyWidgetId),
- }),
- ).toBeUndefined();
- expect(
- await db.query.legacyCustomWidgetDefinitions.findFirst({
- where: eq(legacyCustomWidgetDefinitions.id, legacyWidgetId),
- }),
- ).toMatchObject({ id: legacyWidgetId, name: legacyWidgetName });
- expect(
- await db.query.legacyCustomWidgetSecrets.findFirst({
- where: eq(legacyCustomWidgetSecrets.definitionId, legacyWidgetId),
- }),
- ).toMatchObject({ definitionId: legacyWidgetId, encryptedValue });
-
- await page.reload();
- const resurfacedLegacyCard = page
- .getByRole("main")
- .getByText(legacyWidgetName, { exact: true })
- .locator("xpath=ancestor::*[contains(@class, 'mantine-Card-root')]");
- await expect(resurfacedLegacyCard.getByText("Migration required", { exact: true })).toBeVisible();
- } finally {
- await Promise.allSettled([browser?.close(), homarrContainer?.stop()]);
- }
- }, 180_000);
});
diff --git a/e2e/onboarding.spec.ts b/e2e/onboarding.spec.ts
index 941f08335..a8a09773e 100644
--- a/e2e/onboarding.spec.ts
+++ b/e2e/onboarding.spec.ts
@@ -1,5 +1,4 @@
import { chromium } from "@playwright/test";
-import type { Browser } from "@playwright/test";
import { describe, test } from "vitest";
import { OnboardingActions } from "./shared/actions/onboarding-actions";
@@ -17,32 +16,31 @@ describe("Onboarding", () => {
},
}).start();
- let browser: Browser | undefined;
- try {
- browser = await chromium.launch();
- const context = await browser.newContext();
- const page = await context.newPage();
- const actions = new OnboardingActions(page, db);
- const assertions = new OnboardingAssertions(page, db);
+ const browser = await chromium.launch();
+ const context = await browser.newContext();
+ const page = await context.newPage();
+ const actions = new OnboardingActions(page, db);
+ const assertions = new OnboardingAssertions(page, db);
- // Act
- await page.goto(`http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`);
- await actions.startOnboardingAsync("scratch");
- await actions.processUserStepAsync({
- username: "admin",
- password: "Comp(exP4sswOrd",
- confirmPassword: "Comp(exP4sswOrd",
- });
- await actions.processSettingsStepAsync();
- await actions.processIntegrationsStepAsync();
+ // Act
+ await page.goto(`http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`);
+ await actions.startOnboardingAsync("scratch");
+ await actions.processUserStepAsync({
+ username: "admin",
+ password: "Comp(exP4sswOrd",
+ confirmPassword: "Comp(exP4sswOrd",
+ });
+ await actions.processSettingsStepAsync();
+ await actions.processIntegrationsStepAsync();
- // Assert
- await assertions.assertFinishStepVisibleAsync();
- await assertions.assertUserAndAdminGroupInsertedAsync("admin");
- await assertions.assertDbOnboardingStepAsync("finish");
- } finally {
- await Promise.allSettled([browser?.close(), homarrContainer.stop()]);
- }
+ // Assert
+ await assertions.assertFinishStepVisibleAsync();
+ await assertions.assertUserAndAdminGroupInsertedAsync("admin");
+ await assertions.assertDbOnboardingStepAsync("finish");
+
+ // Cleanup
+ await browser.close();
+ await homarrContainer.stop();
}, 60_000);
test("External provider onboarding setup should be successful", async () => {
@@ -62,29 +60,28 @@ describe("Onboarding", () => {
}).start();
const externalGroupName = "oidc-admins";
- let browser: Browser | undefined;
- try {
- browser = await chromium.launch();
- const context = await browser.newContext();
- const page = await context.newPage();
- const actions = new OnboardingActions(page, db);
- const assertions = new OnboardingAssertions(page, db);
+ const browser = await chromium.launch();
+ const context = await browser.newContext();
+ const page = await context.newPage();
+ const actions = new OnboardingActions(page, db);
+ const assertions = new OnboardingAssertions(page, db);
- // Act
- await page.goto(`http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`);
- await actions.startOnboardingAsync("scratch");
- await actions.processExternalGroupStepAsync({
- name: externalGroupName,
- });
- await actions.processSettingsStepAsync();
- await actions.processIntegrationsStepAsync();
+ // Act
+ await page.goto(`http://${homarrContainer.getHost()}:${homarrContainer.getMappedPort(7575)}`);
+ await actions.startOnboardingAsync("scratch");
+ await actions.processExternalGroupStepAsync({
+ name: externalGroupName,
+ });
+ await actions.processSettingsStepAsync();
+ await actions.processIntegrationsStepAsync();
- // Assert
- await assertions.assertFinishStepVisibleAsync();
- await assertions.assertExternalGroupInsertedAsync(externalGroupName);
- await assertions.assertDbOnboardingStepAsync("finish");
- } finally {
- await Promise.allSettled([browser?.close(), homarrContainer.stop()]);
- }
+ // Assert
+ await assertions.assertFinishStepVisibleAsync();
+ await assertions.assertExternalGroupInsertedAsync(externalGroupName);
+ await assertions.assertDbOnboardingStepAsync("finish");
+
+ // Cleanup
+ await browser.close();
+ await homarrContainer.stop();
}, 60_000);
});
diff --git a/e2e/shared/actions/onboarding-actions.ts b/e2e/shared/actions/onboarding-actions.ts
index 0fa2ff24b..56c09aba7 100644
--- a/e2e/shared/actions/onboarding-actions.ts
+++ b/e2e/shared/actions/onboarding-actions.ts
@@ -28,12 +28,11 @@ export class OnboardingActions {
}
public async startOnboardingAsync(type: "scratch" | "before 1.0") {
- const name = type === "scratch" ? "Start from scratch" : "Import from Homarr before 1.0";
- await this.page.getByRole("button", { name, exact: true }).click();
+ await this.page.locator("button", { hasText: type }).click();
}
public async processUserStepAsync(input: { username: string; password: string; confirmPassword: string }) {
- await this.page.getByLabel("Username").waitFor({ state: "visible" });
+ await this.page.waitForSelector("text=administrator user");
await this.page.getByLabel("Username").fill(input.username);
await this.page.getByLabel("Password", { exact: true }).fill(input.password);
diff --git a/e2e/shared/mock-api-server.ts b/e2e/shared/mock-api-server.ts
index 55891e779..10ccbcaab 100644
--- a/e2e/shared/mock-api-server.ts
+++ b/e2e/shared/mock-api-server.ts
@@ -10,19 +10,6 @@ export interface MockApiServer {
close: () => Promise;
}
-export async function exposeHostPortToContainersAsync(port: number): Promise {
- await TestContainers.exposeHostPorts(port);
- const client = await getContainerRuntimeClient();
- const forwarder = (await client.container.list()).find(
- (container) => container.State === "running" && container.Labels[TESTCONTAINERS_SSHD_LABEL] === "true",
- );
- const forwarderAddress = forwarder
- ? Object.values(forwarder.NetworkSettings.Networks).find((network) => network.IPAddress)?.IPAddress
- : undefined;
- if (!forwarderAddress) throw new Error("Failed to locate the Testcontainers host-port forwarder");
- return `http://${forwarderAddress}:${port}`;
-}
-
export async function startMockApiServerAsync(responseBody: unknown): Promise {
const body = JSON.stringify(responseBody);
const server: Server = await new Promise((resolve) => {
@@ -39,8 +26,18 @@ export async function startMockApiServerAsync(responseBody: unknown): Promise container.State === "running" && container.Labels[TESTCONTAINERS_SSHD_LABEL] === "true",
+ );
+ const forwarderAddress = forwarder
+ ? Object.values(forwarder.NetworkSettings.Networks).find((network) => network.IPAddress)?.IPAddress
+ : undefined;
+ if (!forwarderAddress) throw new Error("Failed to locate the Testcontainers host-port forwarder");
+
return {
- url: await exposeHostPortToContainersAsync(address.port),
+ url: `http://${forwarderAddress}:${address.port}`,
close: () =>
new Promise((resolve, reject) => {
server.close((error) => (error ? reject(error) : resolve()));
diff --git a/packages/api/package.json b/packages/api/package.json
index a682b6334..ddfb78b57 100644
--- a/packages/api/package.json
+++ b/packages/api/package.json
@@ -63,7 +63,6 @@
},
"devDependencies": {
"@homarr/tsconfig": "workspace:^0.1.0",
- "ioredis": "catalog:",
"typescript": "catalog:"
}
}
diff --git a/packages/api/src/custom-widget-configuration.ts b/packages/api/src/custom-widget-configuration.ts
index e636f5fd0..7e527dc99 100644
--- a/packages/api/src/custom-widget-configuration.ts
+++ b/packages/api/src/custom-widget-configuration.ts
@@ -1,6 +1,5 @@
export * from "./router/custom-widget/configuration-requests";
export { configurePreviewSessionSource } from "./router/custom-widget/preview-sessions";
-export { invalidateCustomWidgetResponseCache } from "./router/custom-widget/request-executor";
export {
parseStoredCustomWidgetDefinition,
serializeCustomWidgetDefinition,
diff --git a/packages/api/src/custom-widget-state-mode.ts b/packages/api/src/custom-widget-state-mode.ts
deleted file mode 100644
index dffe69eac..000000000
--- a/packages/api/src/custom-widget-state-mode.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-export function useProcessLocalCustomWidgetState(runtime: { CI?: string; NODE_ENV?: string } = process.env): boolean {
- if (runtime.NODE_ENV === "production") return false;
- return runtime.NODE_ENV === "test" || runtime.CI === "true";
-}
diff --git a/packages/api/src/router/custom-widget/configuration-requests.ts b/packages/api/src/router/custom-widget/configuration-requests.ts
index cc54e85a3..a138374cd 100644
--- a/packages/api/src/router/custom-widget/configuration-requests.ts
+++ b/packages/api/src/router/custom-widget/configuration-requests.ts
@@ -4,8 +4,6 @@ import type { RedisClient } from "@homarr/core/infrastructure/redis";
import type { CustomWidgetSecretKind } from "@homarr/custom-widgets/core";
import type { CustomWidgetSource } from "@homarr/custom-widgets/core";
-import { useProcessLocalCustomWidgetState } from "../../custom-widget-state-mode";
-
const CONFIGURATION_REQUEST_TTL_MS = 10 * 60_000;
const CONFIGURATION_REQUEST_PREFIX = "custom-widget:configuration-request:";
const CONFIGURATION_REQUEST_LOCK_PREFIX = "custom-widget:configuration-request-lock:";
@@ -28,7 +26,7 @@ const localLocks = new Set();
let redis: RedisClient | undefined;
function getRedis() {
- if (useProcessLocalCustomWidgetState()) return undefined;
+ if (process.env.CI !== undefined || process.env.NODE_ENV === "test") return undefined;
redis ??= createRedisClient();
return redis;
}
diff --git a/packages/api/src/router/custom-widget/custom-widget-router.ts b/packages/api/src/router/custom-widget/custom-widget-router.ts
index 7edfe83e7..83c6bb080 100644
--- a/packages/api/src/router/custom-widget/custom-widget-router.ts
+++ b/packages/api/src/router/custom-widget/custom-widget-router.ts
@@ -12,9 +12,8 @@ import {
customWidgetUpdateSchema,
} from "@homarr/custom-widgets/core";
-import { createTRPCRouter } from "../../trpc";
+import { createTRPCRouter, permissionRequiredProcedure } from "../../trpc";
import { insertCustomWidgetDefinition } from "./definition-insert";
-import { permissionRequiredProcedure } from "../../trpc";
import { managementQueryProcedures } from "./management-queries";
import { metadataProcedures } from "./metadata-procedures";
import { previewActionProcedures } from "./preview-action-procedures";
diff --git a/packages/api/src/router/custom-widget/management-queries.ts b/packages/api/src/router/custom-widget/management-queries.ts
index 8431322e8..ef4022e7d 100644
--- a/packages/api/src/router/custom-widget/management-queries.ts
+++ b/packages/api/src/router/custom-widget/management-queries.ts
@@ -6,8 +6,8 @@ import { eq, or } from "@homarr/db";
import { boards, customWidgetDefinitions, legacyCustomWidgetDefinitions } from "@homarr/db/schema";
import { collectCustomWidgetRequestReferences } from "@homarr/custom-widgets/core";
-import { throwIfActionForbiddenAsync } from "../board/board-access";
import { permissionRequiredProcedure } from "../../trpc";
+import { throwIfActionForbiddenAsync } from "../board/board-access";
import { parseStoredCustomWidgetDefinition } from "./stored-definition";
import { executeCustomWidgetRequest } from "./request-executor";
import {
@@ -143,10 +143,16 @@ export const managementQueryProcedures = {
await throwIfActionForbiddenAsync(ctx, eq(boards.id, input.boardId), request.permission);
const source = definition.sources[request.source];
if (!source) throw new TRPCError({ code: "NOT_FOUND", message: "Option query source not found" });
- const values = resolveOptionRequestValues(request, input.params);
- const authType = typeof source.auth === "string" ? source.auth : source.auth.type;
- const response = await executeCustomWidgetRequest(
- {
+ const release = await acquireCustomWidgetRequestLimit({
+ category: "query",
+ userId: ctx.session.user.id,
+ itemId: `configuration:${input.boardId}`,
+ definitionId: input.definitionId,
+ });
+ try {
+ const values = resolveOptionRequestValues(request, input.params);
+ const authType = typeof source.auth === "string" ? source.auth : source.auth.type;
+ const response = await executeCustomWidgetRequest({
baseUrl: source.baseUrl,
targetUrl: renderRequestTarget(source.baseUrl, request, values),
method: request.method,
@@ -171,23 +177,16 @@ export const managementQueryProcedures = {
kind: "query",
cacheKey: `custom-widget:options:${input.definitionId}:${getCustomWidgetCacheVersion(stored)}:${request.id}:${hashRuntimeParams(values)}`,
cacheTtlSeconds: request.cacheSeconds ?? 30,
- },
- {
- acquireRequestLimit: () =>
- acquireCustomWidgetRequestLimit({
- category: "query",
- userId: ctx.session.user.id,
- itemId: `configuration:${input.boardId}`,
- definitionId: input.definitionId,
- }),
- },
- );
- return {
- ok: response.ok,
- status: response.status,
- data: response.data,
- error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
- };
+ });
+ return {
+ ok: response.ok,
+ status: response.status,
+ data: response.data,
+ error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
+ };
+ } finally {
+ await release();
+ }
}),
};
diff --git a/packages/api/src/router/custom-widget/preview-action-procedures.ts b/packages/api/src/router/custom-widget/preview-action-procedures.ts
index 39f37e188..a4e50dd4a 100644
--- a/packages/api/src/router/custom-widget/preview-action-procedures.ts
+++ b/packages/api/src/router/custom-widget/preview-action-procedures.ts
@@ -45,9 +45,15 @@ export const previewActionProcedures = {
if ((request.confirmation || request.method === "DELETE") && input.confirmed !== true) {
throw new TRPCError({ code: "PRECONDITION_FAILED", message: "This action requires confirmation" });
}
+ const release = await acquireCustomWidgetRequestLimit({
+ category: request.method === "DELETE" ? "delete" : "action",
+ userId: ctx.session.user.id,
+ itemId: `preview:${session.id}`,
+ definitionId: session.definitionId ?? `preview:${session.id}`,
+ });
const startedAt = Date.now();
- const response = await executeCustomWidgetRequest(
- {
+ try {
+ const response = await executeCustomWidgetRequest({
baseUrl: resolved.source.baseUrl,
targetUrl,
method: request.method,
@@ -56,38 +62,31 @@ export const previewActionProcedures = {
auth: request.auth === "none" ? undefined : resolved.auth,
networkScope: resolved.source.networkScope,
kind: "action",
- },
- {
- acquireRequestLimit: () =>
- acquireCustomWidgetRequestLimit({
- category: request.method === "DELETE" ? "delete" : "action",
- userId: ctx.session.user.id,
- itemId: `preview:${session.id}`,
- definitionId: session.definitionId ?? `preview:${session.id}`,
- }),
- },
- );
- if (response.ok && request.invalidates?.length) {
- await invalidateCustomWidgetResponseCache(
- request.invalidates.map((requestId) => `custom-jsx:preview:${session.id}:${requestId}:`),
- );
+ });
+ if (response.ok && request.invalidates?.length) {
+ invalidateCustomWidgetResponseCache(
+ request.invalidates.map((requestId) => `custom-jsx:preview:${session.id}:${requestId}:`),
+ );
+ }
+ await recordPreviewJournal(session, {
+ requestId: request.id,
+ kind: "action",
+ method: request.method,
+ path: request.path,
+ status: response.status,
+ durationMs: Date.now() - startedAt,
+ simulated: false,
+ });
+ return {
+ ok: response.ok,
+ status: response.status,
+ statusText: response.statusText,
+ data: response.data,
+ error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
+ simulated: false as const,
+ };
+ } finally {
+ await release();
}
- await recordPreviewJournal(session, {
- requestId: request.id,
- kind: "action",
- method: request.method,
- path: request.path,
- status: response.status,
- durationMs: Date.now() - startedAt,
- simulated: false,
- });
- return {
- ok: response.ok,
- status: response.status,
- statusText: response.statusText,
- data: response.data,
- error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
- simulated: false as const,
- };
}),
};
diff --git a/packages/api/src/router/custom-widget/preview-query-procedures.ts b/packages/api/src/router/custom-widget/preview-query-procedures.ts
index b266f17d6..18e527c72 100644
--- a/packages/api/src/router/custom-widget/preview-query-procedures.ts
+++ b/packages/api/src/router/custom-widget/preview-query-procedures.ts
@@ -9,7 +9,6 @@ import {
resolvePreviewRequestParams,
} from "./preview-procedure-helpers";
import { executeCustomWidgetRequest } from "./request-executor";
-import { invalidateCustomWidgetResponseCache } from "./request-executor";
import { hashRuntimeParams, renderRequestBody, renderRequestTarget } from "./request-manifest";
import { acquireCustomWidgetRequestLimit } from "./request-limits";
import { getPreviewJournal, getPreviewSession, setPreviewSessionLiveActions } from "./preview-sessions";
@@ -35,9 +34,15 @@ export const previewQueryProcedures = {
const params = resolvePreviewRequestParams(request, session.options, input.params);
const targetUrl = renderRequestTarget(resolved.source.baseUrl, request, params);
const body = renderRequestBody(request, params);
+ const release = await acquireCustomWidgetRequestLimit({
+ category: "query",
+ userId: ctx.session.user.id,
+ itemId: `preview:${session.id}`,
+ definitionId: session.definitionId ?? `preview:${session.id}`,
+ });
const startedAt = Date.now();
- const response = await executeCustomWidgetRequest(
- {
+ try {
+ const response = await executeCustomWidgetRequest({
baseUrl: resolved.source.baseUrl,
targetUrl,
method: request.method,
@@ -48,67 +53,26 @@ export const previewQueryProcedures = {
kind: "query",
cacheKey: `custom-jsx:preview:${session.id}:${request.id}:${hashRuntimeParams(params)}`,
cacheTtlSeconds: request.cacheSeconds,
- },
- {
- acquireRequestLimit: () =>
- acquireCustomWidgetRequestLimit({
- category: "query",
- userId: ctx.session.user.id,
- itemId: `preview:${session.id}`,
- definitionId: session.definitionId ?? `preview:${session.id}`,
- }),
- },
- );
- await recordPreviewJournal(session, {
- requestId: request.id,
- kind: "query",
- method: request.method,
- path: request.path,
- status: response.status,
- durationMs: Date.now() - startedAt,
- simulated: false,
- });
- return {
- ok: response.ok,
- status: response.status,
- statusText: response.statusText,
- data: response.data,
- error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
- };
- }),
-
- previewRefresh: permissionRequiredProcedure
- .requiresPermission("admin")
- .input(
- z.object({
- sessionId: z.string().min(1),
- requestIds: z.array(z.string().min(1).max(64)).max(64).default([]),
- all: z.boolean().default(false),
- }),
- )
- .mutation(async ({ ctx, input }) => {
- const session = await getPreviewSession(input.sessionId, ctx.session.user.id);
- const queryRequestIds = Object.entries(session.requests).flatMap(([requestId, request]) =>
- request.kind === "query" ? [requestId] : [],
- );
- const requested = new Set(input.all ? queryRequestIds : input.requestIds);
- const requestIds = queryRequestIds.filter((requestId) => requested.has(requestId));
- if (requestIds.length === 0) return { requestIds };
-
- const release = await acquireCustomWidgetRequestLimit({
- category: "query",
- userId: ctx.session.user.id,
- itemId: `preview:${session.id}`,
- definitionId: session.definitionId ?? `preview:${session.id}`,
- });
- try {
- await invalidateCustomWidgetResponseCache(
- requestIds.map((requestId) => `custom-jsx:preview:${session.id}:${requestId}:`),
- );
+ });
+ await recordPreviewJournal(session, {
+ requestId: request.id,
+ kind: "query",
+ method: request.method,
+ path: request.path,
+ status: response.status,
+ durationMs: Date.now() - startedAt,
+ simulated: false,
+ });
+ return {
+ ok: response.ok,
+ status: response.status,
+ statusText: response.statusText,
+ data: response.data,
+ error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
+ };
} finally {
await release();
}
- return { requestIds };
}),
setPreviewLiveActions: permissionRequiredProcedure
diff --git a/packages/api/src/router/custom-widget/preview-sessions.ts b/packages/api/src/router/custom-widget/preview-sessions.ts
index 6cbe0c733..289247213 100644
--- a/packages/api/src/router/custom-widget/preview-sessions.ts
+++ b/packages/api/src/router/custom-widget/preview-sessions.ts
@@ -10,7 +10,6 @@ import type {
PreviewSessionStore,
} from "@homarr/custom-widgets/server";
-import { useProcessLocalCustomWidgetState } from "../../custom-widget-state-mode";
import { toTrpcError } from "./domain-error";
const SESSION_PREFIX = "custom-widget:preview-session:";
@@ -70,7 +69,7 @@ class RedisPreviewSessionStore implements PreviewSessionStore {
let service: CustomWidgetPreviewSessionService | undefined;
function getService() {
if (service) return service;
- const useLocal = useProcessLocalCustomWidgetState();
+ const useLocal = process.env.CI !== undefined || process.env.NODE_ENV === "test";
service = new CustomWidgetPreviewSessionService({
createId,
encrypt: encryptSecret,
diff --git a/packages/api/src/router/custom-widget/request-executor.ts b/packages/api/src/router/custom-widget/request-executor.ts
index 5f687b3d8..a00946eb8 100644
--- a/packages/api/src/router/custom-widget/request-executor.ts
+++ b/packages/api/src/router/custom-widget/request-executor.ts
@@ -1,11 +1,10 @@
-import { TRPCError } from "@trpc/server";
-
import { createLogger } from "@homarr/core/infrastructure/logs";
import {
assertJsonBudget as assertDomainJsonBudget,
assertSafeStaticHeaders as assertDomainSafeStaticHeaders,
classifyAddress,
executeCustomWidgetRequest as executeDomainRequest,
+ invalidateCustomWidgetResponseCache as invalidateDomainResponseCache,
MAX_REQUEST_BODY_BYTES,
MAX_RESPONSE_BODY_BYTES,
MAX_RESPONSE_JSON_DEPTH,
@@ -15,10 +14,8 @@ import {
validateCustomWidgetUrl as validateDomainUrl,
} from "@homarr/custom-widgets/server";
import type { CustomWidgetHttpRequest, CustomWidgetHttpResponse } from "@homarr/custom-widgets/server";
-import { CustomWidgetDomainError } from "@homarr/custom-widgets/server";
import { toTrpcError } from "./domain-error";
-import { invalidateCustomWidgetResponseCache, withCustomWidgetResponseCache } from "./response-cache";
export type {
CustomWidgetAuthConfig,
@@ -35,10 +32,6 @@ export {
const logger = createLogger({ module: "custom-widget:http" });
-export interface CustomWidgetRequestExecutionOptions {
- acquireRequestLimit?: () => Promise<() => Promise>;
-}
-
export function assertJsonBudget(value: unknown): void {
try {
assertDomainJsonBudget(value);
@@ -79,64 +72,16 @@ export async function resolveAndValidateHost(hostname: string, scope: CustomWidg
}
}
-export async function executeCustomWidgetRequest(
- input: CustomWidgetHttpRequest,
- options: CustomWidgetRequestExecutionOptions = {},
-): Promise {
+export async function executeCustomWidgetRequest(input: CustomWidgetHttpRequest): Promise {
try {
- return await withCustomWidgetResponseCache(input, async () => {
- const release = await options.acquireRequestLimit?.();
- try {
- return await executeDomainRequest({
- ...input,
- cacheKey: undefined,
- cacheTtlSeconds: undefined,
- logError: (event) => {
- if (event.reason === "timeout") return;
- logger.error("Custom widget request failed", {
- event: "custom_widget_request_failed",
- ...event,
- });
- },
- });
- } finally {
- await release?.();
- }
+ return await executeDomainRequest({
+ ...input,
+ logError: (event) => logger.error("Custom widget request failed", event),
});
} catch (error) {
- if (error instanceof CustomWidgetDomainError) {
- logger.warn("Custom widget request rejected", {
- event:
- error.reason === "timeout"
- ? "custom_widget_request_timeout"
- : error.code === "FORBIDDEN"
- ? "custom_widget_network_scope_rejected"
- : error.code === "BAD_GATEWAY"
- ? "custom_widget_upstream_failed"
- : "custom_widget_request_rejected",
- code: error.code,
- origin: safeOrigin(input.baseUrl),
- method: input.method,
- });
- toTrpcError(error);
- }
- if (error instanceof TRPCError) throw error;
- logger.error("Custom widget request failed", {
- event: "custom_widget_request_failed",
- errorName: "UnexpectedTransportError",
- origin: safeOrigin(input.baseUrl),
- method: input.method,
- });
- throw new TRPCError({ code: "BAD_GATEWAY", message: "External request failed" });
+ toTrpcError(error);
}
}
-export { invalidateCustomWidgetResponseCache };
-
-function safeOrigin(value: string): string {
- try {
- return new URL(value).origin;
- } catch {
- return "invalid";
- }
-}
+export const invalidateCustomWidgetResponseCache = (prefixes: readonly string[]) =>
+ invalidateDomainResponseCache(prefixes);
diff --git a/packages/api/src/router/custom-widget/request-limits.ts b/packages/api/src/router/custom-widget/request-limits.ts
index e6ffde04e..b92615f3e 100644
--- a/packages/api/src/router/custom-widget/request-limits.ts
+++ b/packages/api/src/router/custom-widget/request-limits.ts
@@ -1,10 +1,9 @@
import { createLogger } from "@homarr/core/infrastructure/logs";
import { createRedisClient } from "@homarr/core/infrastructure/redis";
import type { RedisClient } from "@homarr/core/infrastructure/redis";
-import { CustomWidgetDomainError, CustomWidgetRequestLimiter } from "@homarr/custom-widgets/server";
+import { CustomWidgetRequestLimiter } from "@homarr/custom-widgets/server";
import type { RequestLimitInput, RequestLimitStore } from "@homarr/custom-widgets/server";
-import { useProcessLocalCustomWidgetState } from "../../custom-widget-state-mode";
import { toTrpcError } from "./domain-error";
const logger = createLogger({ module: "custom-widget:limits" });
@@ -46,13 +45,12 @@ class RedisRequestLimitStore implements RequestLimitStore {
let limiter: CustomWidgetRequestLimiter | undefined;
function getLimiter() {
if (limiter) return limiter;
- const useLocal = useProcessLocalCustomWidgetState();
+ const useLocal = process.env.CI !== undefined || process.env.NODE_ENV === "test";
const store = useLocal ? undefined : new RedisRequestLimitStore(createRedisClient());
limiter = new CustomWidgetRequestLimiter({
store,
onStoreError: (error) =>
logger.error("Custom widget rate limiter is unavailable", {
- event: "custom_widget_rate_limit_store_unavailable",
errorName: error instanceof Error ? error.name : "UnknownError",
}),
});
@@ -72,14 +70,6 @@ export async function acquireCustomWidgetRequestLimit(input: RequestLimitInput):
}
};
} catch (error) {
- if (error instanceof CustomWidgetDomainError && error.code === "TOO_MANY_REQUESTS") {
- logger.warn("Rejected custom widget request at rate or concurrency limit", {
- event: "custom_widget_rate_limit_rejected",
- category: input.category,
- authenticated: Boolean(input.userId),
- retryAfterMs: error.retryAfterMs,
- });
- }
toTrpcError(error);
}
}
diff --git a/packages/api/src/router/custom-widget/response-cache.ts b/packages/api/src/router/custom-widget/response-cache.ts
deleted file mode 100644
index 2ef47f48c..000000000
--- a/packages/api/src/router/custom-widget/response-cache.ts
+++ /dev/null
@@ -1,296 +0,0 @@
-import { Buffer } from "node:buffer";
-import { createHash } from "node:crypto";
-
-import { createLogger } from "@homarr/core/infrastructure/logs";
-import { createRedisClient } from "@homarr/core/infrastructure/redis";
-import type { RedisClient } from "@homarr/core/infrastructure/redis";
-import type { CustomWidgetHttpRequest, CustomWidgetHttpResponse } from "@homarr/custom-widgets/server";
-
-import { useProcessLocalCustomWidgetState } from "../../custom-widget-state-mode";
-
-const CACHE_KEY_PREFIX = "homarr:custom-widget:response:v1:";
-const VERSION_KEY_PREFIX = "homarr:custom-widget:response-version:v1:";
-const CACHE_INDEX_KEY = "homarr:custom-widget:response-index:v1";
-const MAX_CACHE_ENTRIES = 1_000;
-const MAX_CACHE_TTL_SECONDS = 3_600;
-const MAX_CACHE_VALUE_BYTES = 1024 * 1024 + 1024;
-const VERSION_TTL_SECONDS = MAX_CACHE_TTL_SECONDS * 2;
-
-const logger = createLogger({ module: "custom-widget:response-cache" });
-
-interface ResponseCacheStore {
- getVersions(namespaces: readonly string[]): Promise;
- incrementVersion(namespace: string): Promise;
- get(key: string): Promise;
- set(key: string, namespace: string, value: string, ttlSeconds: number): Promise;
-}
-
-class RedisResponseCacheStore implements ResponseCacheStore {
- public constructor(private readonly redis: RedisClient) {}
-
- public async getVersions(namespaces: readonly string[]): Promise {
- const values = await this.redis.mget(...namespaces.map(getVersionKey));
- return values.map((value) => {
- const parsed = Number(value ?? 0);
- return Number.isSafeInteger(parsed) && parsed >= 0 ? parsed : 0;
- });
- }
-
- public async incrementVersion(namespace: string): Promise {
- const key = getVersionKey(namespace);
- await this.redis.multi().incr(key).expire(key, VERSION_TTL_SECONDS).exec();
- }
-
- public get(key: string): Promise {
- return this.redis.get(key);
- }
-
- public async set(key: string, _namespace: string, value: string, ttlSeconds: number): Promise {
- await this.redis.eval(
- `
- redis.call("SET", KEYS[1], ARGV[1], "EX", ARGV[2])
- redis.call("ZADD", KEYS[2], ARGV[3] + (ARGV[2] * 1000), KEYS[1])
- redis.call("ZREMRANGEBYSCORE", KEYS[2], "-inf", ARGV[3])
- local count = redis.call("ZCARD", KEYS[2])
- local maximum = tonumber(ARGV[4])
- if count > maximum then
- local victims = redis.call("ZRANGE", KEYS[2], 0, count - maximum - 1)
- for _, victim in ipairs(victims) do
- redis.call("DEL", victim)
- redis.call("ZREM", KEYS[2], victim)
- end
- end
- redis.call("EXPIRE", KEYS[2], ARGV[5])
- return 1
- `,
- 2,
- key,
- CACHE_INDEX_KEY,
- value,
- ttlSeconds,
- Date.now(),
- MAX_CACHE_ENTRIES,
- VERSION_TTL_SECONDS,
- );
- }
-}
-
-class LocalResponseCacheStore implements ResponseCacheStore {
- private readonly versions = new Map();
- private readonly responses = new Map();
-
- public async getVersions(namespaces: readonly string[]): Promise {
- return namespaces.map((namespace) => this.versions.get(namespace) ?? 0);
- }
-
- public async incrementVersion(namespace: string): Promise {
- this.versions.set(namespace, (this.versions.get(namespace) ?? 0) + 1);
- }
-
- public async get(key: string): Promise {
- const response = this.responses.get(key);
- if (!response) return null;
- if (response.expiresAt <= Date.now()) {
- this.responses.delete(key);
- return null;
- }
- return response.value;
- }
-
- public async set(key: string, namespace: string, value: string, ttlSeconds: number): Promise {
- for (const [candidate, response] of this.responses) {
- if (response.expiresAt <= Date.now()) this.responses.delete(candidate);
- }
- while (this.responses.size >= MAX_CACHE_ENTRIES) {
- const oldest = this.responses.keys().next().value as string | undefined;
- if (!oldest) break;
- this.responses.delete(oldest);
- }
- this.responses.set(key, {
- namespace,
- value,
- expiresAt: Date.now() + ttlSeconds * 1000,
- });
- }
-}
-
-let defaultStore: ResponseCacheStore | undefined;
-let defaultController: CustomWidgetResponseCacheController | undefined;
-
-function getDefaultStore(): ResponseCacheStore {
- if (defaultStore) return defaultStore;
- const useLocal = useProcessLocalCustomWidgetState();
- defaultStore = useLocal ? new LocalResponseCacheStore() : new RedisResponseCacheStore(createRedisClient());
- return defaultStore;
-}
-
-export interface CustomWidgetResponseCacheController {
- withCache(
- input: CustomWidgetHttpRequest,
- execute: () => Promise,
- ): Promise;
- invalidate(prefixes: readonly string[]): Promise;
-}
-
-class ResponseCacheController implements CustomWidgetResponseCacheController {
- private readonly inFlight = new Map>();
- private readonly pendingInvalidations = new Set();
-
- public constructor(private readonly store: ResponseCacheStore) {}
-
- public async withCache(
- input: CustomWidgetHttpRequest,
- execute: () => Promise,
- ): Promise {
- const ttlSeconds = Math.min(Math.max(input.cacheTtlSeconds ?? 0, 0), MAX_CACHE_TTL_SECONDS);
- if (input.kind !== "query" || !input.cacheKey || ttlSeconds <= 0) return execute();
-
- const namespace = getCacheNamespace(input.cacheKey);
- if (!namespace) {
- logger.warn("Rejected malformed custom widget response cache key", {
- event: "custom_widget_cache_key_rejected",
- });
- return execute();
- }
-
- let responseKey: string;
- let pending: Promise | undefined;
- let cached: CustomWidgetHttpResponse | null = null;
- try {
- await this.flushPendingInvalidations();
- const invalidationNamespaces = getInvalidationNamespaces(namespace);
- const versions = await this.store.getVersions(invalidationNamespaces);
- responseKey = getResponseKey(input.cacheKey, versions);
- pending = this.inFlight.get(responseKey);
- if (!pending) {
- cached = parseCachedResponse(await this.store.get(responseKey));
- if (!cached) pending = this.inFlight.get(responseKey);
- }
- } catch (error) {
- logger.warn("Custom widget response cache unavailable; executing without cache", {
- event: "custom_widget_cache_unavailable",
- errorName: error instanceof Error ? error.name : "UnknownError",
- });
- return execute();
- }
-
- if (pending) return pending;
- if (cached) return cached;
-
- let request: Promise;
- request = Promise.resolve()
- .then(execute)
- .then(async (response) => {
- if (!response.ok) return response;
- try {
- const serialized = JSON.stringify(response);
- if (Buffer.byteLength(serialized, "utf8") > MAX_CACHE_VALUE_BYTES) {
- logger.warn("Skipped oversized custom widget response cache entry", {
- event: "custom_widget_cache_entry_rejected",
- cacheNamespace: namespace,
- });
- return response;
- }
- await this.store.set(responseKey, namespace, serialized, ttlSeconds);
- } catch (error) {
- logger.warn("Failed to store custom widget response cache entry", {
- event: "custom_widget_cache_write_failed",
- errorName: error instanceof Error ? error.name : "UnknownError",
- });
- }
- return response;
- })
- .finally(() => {
- if (this.inFlight.get(responseKey) === request) this.inFlight.delete(responseKey);
- });
- this.inFlight.set(responseKey, request);
- return request;
- }
-
- public async invalidate(prefixes: readonly string[]): Promise {
- const namespaces = [...new Set(prefixes.filter((prefix) => prefix.length > 0))];
- if (namespaces.length === 0) return;
- try {
- await Promise.all(namespaces.map((namespace) => this.store.incrementVersion(namespace)));
- for (const namespace of namespaces) this.pendingInvalidations.delete(namespace);
- } catch (error) {
- namespaces.forEach((namespace) => this.pendingInvalidations.add(namespace));
- logger.error("Failed to invalidate custom widget response cache", {
- event: "custom_widget_cache_invalidation_failed",
- invalidationCount: namespaces.length,
- errorName: error instanceof Error ? error.name : "UnknownError",
- });
- }
- }
-
- private async flushPendingInvalidations(): Promise {
- if (this.pendingInvalidations.size === 0) return;
- const namespaces = [...this.pendingInvalidations];
- await Promise.all(namespaces.map((namespace) => this.store.incrementVersion(namespace)));
- namespaces.forEach((namespace) => this.pendingInvalidations.delete(namespace));
- }
-}
-
-function getDefaultController(): CustomWidgetResponseCacheController {
- defaultController ??= new ResponseCacheController(getDefaultStore());
- return defaultController;
-}
-
-export function createRedisCustomWidgetResponseCache(redis: RedisClient): CustomWidgetResponseCacheController {
- return new ResponseCacheController(new RedisResponseCacheStore(redis));
-}
-
-export function withCustomWidgetResponseCache(
- input: CustomWidgetHttpRequest,
- execute: () => Promise,
-): Promise {
- return getDefaultController().withCache(input, execute);
-}
-
-export function invalidateCustomWidgetResponseCache(prefixes: readonly string[]): Promise {
- return getDefaultController().invalidate(prefixes);
-}
-
-function getCacheNamespace(key: string): string | null {
- const separator = key.lastIndexOf(":");
- if (separator <= 0 || separator === key.length - 1) return null;
- return key.slice(0, separator + 1);
-}
-
-function getInvalidationNamespaces(namespace: string): string[] {
- const namespaces: string[] = [];
- for (let separator = namespace.indexOf(":"); separator >= 0; separator = namespace.indexOf(":", separator + 1)) {
- namespaces.push(namespace.slice(0, separator + 1));
- }
- return namespaces;
-}
-
-function getResponseKey(key: string, versions: readonly number[]): string {
- return `${CACHE_KEY_PREFIX}${hash(`${versions.join(".")}:${key}`)}`;
-}
-
-function getVersionKey(namespace: string): string {
- return `${VERSION_KEY_PREFIX}${hash(namespace)}`;
-}
-
-function hash(value: string): string {
- return createHash("sha256").update(value).digest("hex");
-}
-
-function parseCachedResponse(value: string | null): CustomWidgetHttpResponse | null {
- if (!value) return null;
- try {
- const parsed = JSON.parse(value) as Partial;
- if (
- typeof parsed.ok !== "boolean" ||
- typeof parsed.status !== "number" ||
- typeof parsed.statusText !== "string" ||
- !("data" in parsed)
- ) {
- return null;
- }
- return parsed as CustomWidgetHttpResponse;
- } catch {
- return null;
- }
-}
diff --git a/packages/api/src/router/test/custom-widget/request-execution-limits.spec.ts b/packages/api/src/router/test/custom-widget/request-execution-limits.spec.ts
deleted file mode 100644
index 62b90fe84..000000000
--- a/packages/api/src/router/test/custom-widget/request-execution-limits.spec.ts
+++ /dev/null
@@ -1,118 +0,0 @@
-import { createId } from "@homarr/common";
-import type * as CustomWidgetServer from "@homarr/custom-widgets/server";
-import { beforeEach, describe, expect, test, vi } from "vitest";
-
-const mocks = vi.hoisted(() => ({
- executeDomainRequest: vi.fn(async () => ({
- ok: true,
- status: 200,
- statusText: "OK",
- data: { value: 42 },
- })),
- logger: {
- debug: vi.fn(),
- error: vi.fn(),
- info: vi.fn(),
- warn: vi.fn(),
- },
-}));
-
-vi.mock("@homarr/core/infrastructure/logs", () => ({
- createLogger: () => mocks.logger,
-}));
-
-vi.mock("@homarr/custom-widgets/server", async (importOriginal) => {
- const actual = await importOriginal();
- return {
- ...actual,
- executeCustomWidgetRequest: mocks.executeDomainRequest,
- };
-});
-
-import { executeCustomWidgetRequest } from "../../custom-widget/request-executor";
-
-describe("custom widget request execution limits", () => {
- beforeEach(() => {
- mocks.executeDomainRequest.mockClear();
- mocks.logger.error.mockClear();
- });
-
- test("acquires capacity only for a query cache miss", async () => {
- const release = vi.fn(async () => undefined);
- const acquireRequestLimit = vi.fn(async () => release);
- const input = {
- baseUrl: "https://example.com",
- targetUrl: "https://example.com/status",
- method: "GET" as const,
- networkScope: "public" as const,
- kind: "query" as const,
- cacheKey: `custom-jsx:${createId()}:version:status:params`,
- cacheTtlSeconds: 60,
- };
-
- await executeCustomWidgetRequest(input, { acquireRequestLimit });
- await executeCustomWidgetRequest(input, { acquireRequestLimit });
-
- expect(mocks.executeDomainRequest).toHaveBeenCalledOnce();
- expect(acquireRequestLimit).toHaveBeenCalledOnce();
- expect(release).toHaveBeenCalledOnce();
- });
-
- test("keeps every action inside request accounting", async () => {
- const release = vi.fn(async () => undefined);
- const acquireRequestLimit = vi.fn(async () => release);
- const input = {
- baseUrl: "https://example.com",
- targetUrl: "https://example.com/action",
- method: "POST" as const,
- networkScope: "public" as const,
- kind: "action" as const,
- };
-
- await executeCustomWidgetRequest(input, { acquireRequestLimit });
- await executeCustomWidgetRequest(input, { acquireRequestLimit });
-
- expect(mocks.executeDomainRequest).toHaveBeenCalledTimes(2);
- expect(acquireRequestLimit).toHaveBeenCalledTimes(2);
- expect(release).toHaveBeenCalledTimes(2);
- });
-
- test("replaces an unexpected apiKeyQuery transport error with safe public and loggable metadata", async () => {
- const apiKey = "api-key-query-secret";
- const tokenizedUrl = `https://example.com/status?access_token=${apiKey}`;
- const transportFailure = new Error(`Transport failed for ${tokenizedUrl}`);
- transportFailure.name = `SocketError:${tokenizedUrl}`;
- mocks.executeDomainRequest.mockRejectedValueOnce(transportFailure);
-
- const error = await executeCustomWidgetRequest({
- baseUrl: "https://example.com",
- targetUrl: "https://example.com/status",
- method: "GET",
- networkScope: "public",
- kind: "query",
- auth: {
- type: "apiKeyQuery",
- headerName: "access_token",
- secrets: [{ kind: "apiKey", value: apiKey }],
- },
- }).then(
- () => undefined,
- (cause: unknown) => cause,
- );
-
- expect(error).toMatchObject({
- code: "BAD_GATEWAY",
- message: "External request failed",
- });
- expect((error as Error).cause).toBeUndefined();
- expect(mocks.logger.error).toHaveBeenCalledWith("Custom widget request failed", {
- event: "custom_widget_request_failed",
- errorName: "UnexpectedTransportError",
- origin: "https://example.com",
- method: "GET",
- });
- expect(JSON.stringify(mocks.logger.error.mock.calls)).not.toContain(apiKey);
- expect(JSON.stringify(mocks.logger.error.mock.calls)).not.toContain("access_token");
- expect(String(error)).not.toContain(apiKey);
- });
-});
diff --git a/packages/api/src/router/test/custom-widget/response-cache-redis.spec.ts b/packages/api/src/router/test/custom-widget/response-cache-redis.spec.ts
deleted file mode 100644
index 90c822380..000000000
--- a/packages/api/src/router/test/custom-widget/response-cache-redis.spec.ts
+++ /dev/null
@@ -1,58 +0,0 @@
-import { randomUUID } from "node:crypto";
-
-import { RedisContainer } from "@testcontainers/redis";
-import type { StartedRedisContainer } from "@testcontainers/redis";
-import { Redis } from "ioredis";
-import { afterAll, beforeAll, describe, expect, test } from "vitest";
-
-import { createRedisCustomWidgetResponseCache } from "../../custom-widget/response-cache";
-
-describe("custom widget response cache across replicas", () => {
- let container: StartedRedisContainer | undefined;
- let redisA: Redis | undefined;
- let redisB: Redis | undefined;
-
- beforeAll(async () => {
- container = await new RedisContainer("redis:7.4-alpine").start();
- redisA = new Redis(container.getConnectionUrl());
- redisB = new Redis(container.getConnectionUrl());
- await Promise.all([redisA.ping(), redisB.ping()]);
- }, 60_000);
-
- afterAll(async () => {
- await Promise.all([redisA?.quit(), redisB?.quit()]);
- await container?.stop();
- }, 30_000);
-
- test("an action on one replica invalidates a query cached by another replica", async () => {
- if (!redisA || !redisB) throw new Error("Redis test clients were not initialized");
- const cacheA = createRedisCustomWidgetResponseCache(redisA);
- const cacheB = createRedisCustomWidgetResponseCache(redisB);
- const itemNamespace = `custom-jsx:${randomUUID()}:`;
- const namespace = `${itemNamespace}definition-v1:status:`;
- const input = {
- baseUrl: "https://example.com",
- method: "GET" as const,
- networkScope: "public" as const,
- kind: "query" as const,
- cacheKey: `${namespace}same-options`,
- cacheTtlSeconds: 60,
- };
- let calls = 0;
- const execute = async () => ({
- ok: true,
- status: 200,
- statusText: "OK",
- data: { calls: ++calls },
- });
-
- await expect(cacheA.withCache(input, execute)).resolves.toMatchObject({ data: { calls: 1 } });
- await expect(cacheB.withCache(input, execute)).resolves.toMatchObject({ data: { calls: 1 } });
- expect(calls).toBe(1);
-
- await cacheB.invalidate([itemNamespace]);
-
- await expect(cacheA.withCache(input, execute)).resolves.toMatchObject({ data: { calls: 2 } });
- expect(calls).toBe(2);
- });
-});
diff --git a/packages/api/src/router/test/custom-widget/response-cache.spec.ts b/packages/api/src/router/test/custom-widget/response-cache.spec.ts
deleted file mode 100644
index 09cf8002f..000000000
--- a/packages/api/src/router/test/custom-widget/response-cache.spec.ts
+++ /dev/null
@@ -1,91 +0,0 @@
-import { describe, expect, test, vi } from "vitest";
-
-import { invalidateCustomWidgetResponseCache, withCustomWidgetResponseCache } from "../../custom-widget/response-cache";
-
-const response = (calls: number) => ({
- ok: true,
- status: 200,
- statusText: "OK",
- data: { calls },
-});
-
-describe("custom widget shared response cache", () => {
- test("deduplicates queries and invalidates them with a versioned namespace", async () => {
- const itemNamespace = "custom-jsx:test-item:";
- const namespace = `${itemNamespace}test-version:status:`;
- const input = {
- baseUrl: "https://example.com",
- method: "GET" as const,
- networkScope: "public" as const,
- kind: "query" as const,
- cacheKey: `${namespace}test-params`,
- cacheTtlSeconds: 60,
- };
- let calls = 0;
- const execute = async () => response(++calls);
-
- await expect(
- Promise.all([withCustomWidgetResponseCache(input, execute), withCustomWidgetResponseCache(input, execute)]),
- ).resolves.toEqual([response(1), response(1)]);
- await expect(withCustomWidgetResponseCache(input, execute)).resolves.toEqual(response(1));
-
- await invalidateCustomWidgetResponseCache([itemNamespace]);
-
- await expect(withCustomWidgetResponseCache(input, execute)).resolves.toEqual(response(2));
- });
-
- test("does not cache actions or zero-TTL queries", async () => {
- let calls = 0;
- const execute = async () => response(++calls);
- const baseInput = {
- baseUrl: "https://example.com",
- method: "GET" as const,
- networkScope: "public" as const,
- cacheKey: "custom-jsx:no-cache:version:status:params",
- cacheTtlSeconds: 0,
- };
-
- await withCustomWidgetResponseCache({ ...baseInput, kind: "query" }, execute);
- await withCustomWidgetResponseCache({ ...baseInput, kind: "query" }, execute);
- await withCustomWidgetResponseCache({ ...baseInput, kind: "action" }, execute);
- await withCustomWidgetResponseCache({ ...baseInput, kind: "action" }, execute);
-
- expect(calls).toBe(4);
- });
-
- test("does not retry a rejected query execution", async () => {
- const failure = new Error("upstream failed");
- const execute = vi.fn(async () => {
- throw failure;
- });
- const input = {
- baseUrl: "https://example.com",
- method: "GET" as const,
- networkScope: "public" as const,
- kind: "query" as const,
- cacheKey: "custom-jsx:rejected:version:status:params",
- cacheTtlSeconds: 60,
- };
-
- await expect(withCustomWidgetResponseCache(input, execute)).rejects.toBe(failure);
- expect(execute).toHaveBeenCalledOnce();
- });
-
- test("does not retry a synchronous query execution failure", async () => {
- const failure = new Error("failed before returning a promise");
- const execute = vi.fn(() => {
- throw failure;
- });
- const input = {
- baseUrl: "https://example.com",
- method: "GET" as const,
- networkScope: "public" as const,
- kind: "query" as const,
- cacheKey: "custom-jsx:synchronous-failure:version:status:params",
- cacheTtlSeconds: 60,
- };
-
- await expect(withCustomWidgetResponseCache(input, execute)).rejects.toBe(failure);
- expect(execute).toHaveBeenCalledOnce();
- });
-});
diff --git a/packages/api/src/router/test/custom-widget/state-mode.spec.ts b/packages/api/src/router/test/custom-widget/state-mode.spec.ts
deleted file mode 100644
index 687c24c60..000000000
--- a/packages/api/src/router/test/custom-widget/state-mode.spec.ts
+++ /dev/null
@@ -1,16 +0,0 @@
-import { describe, expect, test } from "vitest";
-
-import { useProcessLocalCustomWidgetState } from "../../../custom-widget-state-mode";
-
-describe("Custom Widget shared-state selection", () => {
- test.each([
- [{ NODE_ENV: "test", CI: undefined }, true],
- [{ NODE_ENV: "development", CI: "true" }, true],
- [{ NODE_ENV: "development", CI: "false" }, false],
- [{ NODE_ENV: "production", CI: "true" }, false],
- [{ NODE_ENV: "production", CI: "false" }, false],
- [{ NODE_ENV: "production", CI: undefined }, false],
- ])("uses process-local state only in tests: %o", (runtime, expected) => {
- expect(useProcessLocalCustomWidgetState(runtime)).toBe(expected);
- });
-});
diff --git a/packages/api/src/router/test/trpc-context.spec.ts b/packages/api/src/router/test/trpc-context.spec.ts
deleted file mode 100644
index 9f889aa43..000000000
--- a/packages/api/src/router/test/trpc-context.spec.ts
+++ /dev/null
@@ -1,46 +0,0 @@
-import { describe, expect, test } from "vitest";
-
-import { ipAddressFromHeaders, rateLimitAddressFromHeaders } from "@homarr/common/server";
-
-import { createTRPCContext } from "../../trpc";
-
-describe("tRPC client address context", () => {
- test("does not use a forged forwarded address as the anonymous rate-limit identity", () => {
- const headers = new Headers({
- "user-agent": "vitest",
- "x-forwarded-for": " 198.51.100.10, 10.0.0.2 ",
- "x-real-ip": "203.0.113.20",
- });
-
- expect(ipAddressFromHeaders(headers)).toBe("198.51.100.10");
- expect(rateLimitAddressFromHeaders(headers)).toBe("203.0.113.20");
- expect(createTRPCContext({ headers, session: null }).clientAddress).toBe("203.0.113.20");
- });
-
- test("canonicalizes a trusted IPv6 address", () => {
- const headers = new Headers({
- "user-agent": "vitest",
- "x-real-ip": " 2001:0DB8:0000:0000:0000:0000:0000:0001 ",
- });
-
- expect(rateLimitAddressFromHeaders(headers)).toBe("2001:db8::1");
- expect(createTRPCContext({ headers, session: null }).clientAddress).toBe("2001:db8::1");
- });
-
- test("uses a shared anonymous bucket without a valid trusted address", () => {
- const headers = new Headers({
- "user-agent": "vitest",
- "x-forwarded-for": "198.51.100.10",
- "x-real-ip": "not-an-ip",
- });
-
- expect(rateLimitAddressFromHeaders(headers)).toBeNull();
- expect(createTRPCContext({ headers, session: null }).clientAddress).toBeUndefined();
- });
-
- test("retains the general client-address helper for existing API-key behavior", () => {
- const headers = new Headers({ "user-agent": "vitest", "x-real-ip": " 203.0.113.20 " });
-
- expect(ipAddressFromHeaders(headers)).toBe("203.0.113.20");
- });
-});
diff --git a/packages/api/src/router/test/widgets/custom-api-v2.spec.ts b/packages/api/src/router/test/widgets/custom-api-v2.spec.ts
index cd7c40ff9..a5e6f3c50 100644
--- a/packages/api/src/router/test/widgets/custom-api-v2.spec.ts
+++ b/packages/api/src/router/test/widgets/custom-api-v2.spec.ts
@@ -3,47 +3,22 @@ import { beforeEach, describe, expect, test, vi } from "vitest";
import type { Session } from "@homarr/auth";
import { createId } from "@homarr/common";
-import { encryptSecret } from "@homarr/common/server";
import { eq } from "@homarr/db";
-import {
- boardUserPermissions,
- boards,
- customWidgetDefinitions,
- customWidgetSecrets,
- items,
- legacyCustomWidgetDefinitions,
- users,
-} from "@homarr/db/schema";
+import { boardUserPermissions, boards, customWidgetDefinitions, items, users } from "@homarr/db/schema";
import { createDb } from "@homarr/db/test";
import type { HomarrCustomWidgetV2 } from "@homarr/custom-widgets/core";
-const mocks = vi.hoisted(() => {
- const executeRequestImplementation = async (
- _input: unknown,
- options?: { acquireRequestLimit?: () => Promise<() => Promise> },
- ) => {
- const release = await options?.acquireRequestLimit?.();
- try {
- return { ok: true, status: 200, statusText: "OK", data: { value: 42 } };
- } finally {
- await release?.();
- }
- };
- return {
- acquireRequestLimit: vi.fn(async () => async () => undefined),
- invalidateCache: vi.fn(async () => undefined),
- executeRequestImplementation,
- executeRequest: vi.fn(executeRequestImplementation),
- };
-});
+const mocks = vi.hoisted(() => ({
+ executeRequest: vi.fn(async () => ({ ok: true, status: 200, statusText: "OK", data: { value: 42 } })),
+}));
vi.mock("../../custom-widget/request-executor", () => ({
executeCustomWidgetRequest: mocks.executeRequest,
- invalidateCustomWidgetResponseCache: mocks.invalidateCache,
+ invalidateCustomWidgetResponseCache: vi.fn(),
}));
vi.mock("../../custom-widget/request-limits", () => ({
- acquireCustomWidgetRequestLimit: mocks.acquireRequestLimit,
+ acquireCustomWidgetRequestLimit: vi.fn(async () => async () => undefined),
}));
import { serializeCustomWidgetDefinition } from "../../custom-widget/stored-definition";
@@ -79,15 +54,6 @@ const definition: HomarrCustomWidgetV2 = {
permission: "view",
trigger: "manual",
},
- "private-status": {
- source: "default",
- kind: "query",
- method: "GET",
- path: "/private-status",
- auth: "inherit",
- permission: "modify",
- trigger: "manual",
- },
toggle: {
source: "default",
kind: "action",
@@ -118,7 +84,7 @@ const createSession = (userId: string): Session => ({
expires: new Date(Date.now() + 60_000).toISOString(),
});
-async function setup(isPublic = true, customDefinition = definition, apiKey?: string) {
+async function setup(isPublic = true) {
const db = createDb();
const ownerId = createId();
const boardId = createId();
@@ -128,18 +94,9 @@ async function setup(isPublic = true, customDefinition = definition, apiKey?: st
await db.insert(boards).values({ id: boardId, name: createId(), creatorId: ownerId, isPublic });
await db.insert(customWidgetDefinitions).values({
id: definitionId,
- ...serializeCustomWidgetDefinition(customDefinition),
+ ...serializeCustomWidgetDefinition(definition),
creatorId: ownerId,
});
- if (apiKey) {
- await db.insert(customWidgetSecrets).values({
- definitionId,
- sourceId: "default",
- kind: "apiKey",
- encryptedValue: encryptSecret(apiKey),
- updatedAt: new Date(),
- });
- }
await db.insert(items).values({
id: itemId,
boardId,
@@ -150,21 +107,11 @@ async function setup(isPublic = true, customDefinition = definition, apiKey?: st
}
describe("Custom JSX v2 board router", () => {
- beforeEach(() => {
- mocks.acquireRequestLimit.mockClear();
- mocks.executeRequest.mockReset();
- mocks.executeRequest.mockImplementation(mocks.executeRequestImplementation);
- mocks.invalidateCache.mockClear();
- });
+ beforeEach(() => mocks.executeRequest.mockClear());
test("allows public queries only through the definition placed on an accessible board", async () => {
const { db, itemId } = await setup();
- const caller = customApiRouter.createCaller({
- db,
- deviceType: undefined,
- session: null,
- clientAddress: "198.51.100.10",
- });
+ const caller = customApiRouter.createCaller({ db, deviceType: undefined, session: null });
await expect(caller.queryRequest({ itemId, requestId: "status", params: { name: "homarr" } })).resolves.toEqual(
expect.objectContaining({ ok: true, data: { value: 42 } }),
@@ -173,156 +120,6 @@ describe("Custom JSX v2 board router", () => {
code: "NOT_FOUND",
});
expect(mocks.executeRequest).toHaveBeenCalledOnce();
- expect(mocks.acquireRequestLimit).toHaveBeenCalledWith(
- expect.objectContaining({ userId: undefined, anonymousId: "198.51.100.10" }),
- );
- });
-
- test("redacts apiKeyQuery transport details from anonymous load and manual query results", async () => {
- const apiKey = "api-key-query-secret";
- const credentialedDefinition: HomarrCustomWidgetV2 = {
- ...definition,
- sources: {
- default: {
- name: "API",
- baseUrl: "https://example.com",
- networkScope: "public",
- auth: { type: "apiKeyQuery", name: "access_token" },
- },
- },
- };
- const { db, itemId } = await setup(true, credentialedDefinition, apiKey);
- mocks.executeRequest.mockImplementation(async (input) => {
- const request = input as {
- targetUrl: URL;
- auth?: { headerName?: string | null; secrets: Array<{ kind: string; value: string }> };
- };
- const secret = request.auth?.secrets.find(({ kind }) => kind === "apiKey")?.value;
- const tokenizedUrl = new URL(request.targetUrl);
- tokenizedUrl.searchParams.set(request.auth?.headerName ?? "api_key", secret ?? "");
- const failure = new Error(`Transport failed for ${tokenizedUrl.toString()}`);
- failure.name = `SocketError:${tokenizedUrl.toString()}`;
- throw failure;
- });
- const caller = customApiRouter.createCaller({
- db,
- deviceType: undefined,
- session: null,
- clientAddress: "198.51.100.10",
- });
-
- const loadResult = await caller.getData({ itemId });
- const queryError = await caller.queryRequest({ itemId, requestId: "status", params: { name: "homarr" } }).then(
- () => undefined,
- (cause: unknown) => cause,
- );
-
- expect(loadResult.status["load-status"]).toMatchObject({
- ok: false,
- status: 0,
- error: "Request failed",
- });
- expect(queryError).toMatchObject({
- code: "BAD_GATEWAY",
- message: "External request failed",
- });
- expect((queryError as Error).cause).toBeUndefined();
- expect(mocks.executeRequest).toHaveBeenCalledWith(
- expect.objectContaining({
- auth: expect.objectContaining({
- type: "apiKeyQuery",
- headerName: "access_token",
- secrets: [{ kind: "apiKey", value: apiKey }],
- }),
- }),
- expect.any(Object),
- );
- expect(JSON.stringify(loadResult)).not.toContain(apiKey);
- expect(JSON.stringify(loadResult)).not.toContain("access_token");
- expect(String(queryError)).not.toContain(apiKey);
- expect(String(queryError)).not.toContain("access_token");
- });
-
- test("requires authentication before invalidating board-authorized query caches", async () => {
- const { db, itemId } = await setup();
- const viewerId = createId();
- await db.insert(users).values({ id: viewerId });
- const anonymous = customApiRouter.createCaller({
- db,
- deviceType: undefined,
- session: null,
- clientAddress: "198.51.100.10",
- });
-
- await expect(anonymous.refreshQueries({ itemId, all: true })).rejects.toMatchObject({ code: "UNAUTHORIZED" });
- expect(mocks.invalidateCache).not.toHaveBeenCalled();
-
- const authenticated = customApiRouter.createCaller({
- db,
- deviceType: undefined,
- session: createSession(viewerId),
- clientAddress: "198.51.100.10",
- });
- await expect(authenticated.refreshQueries({ itemId, all: true })).resolves.toEqual({
- requestIds: ["load-status", "status"],
- });
- expect(mocks.invalidateCache).toHaveBeenCalledOnce();
- expect(mocks.invalidateCache).toHaveBeenCalledWith([
- expect.stringMatching(new RegExp(`^custom-jsx:${itemId}:.+:load-status:$`, "u")),
- expect.stringMatching(new RegExp(`^custom-jsx:${itemId}:.+:status:$`, "u")),
- ]);
- expect(mocks.acquireRequestLimit).toHaveBeenCalledWith(
- expect.objectContaining({
- category: "query",
- userId: viewerId,
- itemId,
- }),
- );
- expect(mocks.executeRequest).not.toHaveBeenCalled();
- });
-
- test("queues valid load requests within the per-viewer concurrency limit", async () => {
- const requests = Object.fromEntries(
- Array.from({ length: 6 }, (_, index) => [
- `load-${index}`,
- {
- source: "default",
- kind: "query" as const,
- method: "GET" as const,
- path: `/status/${index}`,
- auth: "inherit" as const,
- permission: "view" as const,
- trigger: "load" as const,
- },
- ]),
- );
- const { db, itemId } = await setup(true, { ...definition, requests });
- let active = 0;
- let maximumActive = 0;
- mocks.executeRequest.mockImplementation(async (_input, options) => {
- const release = await options?.acquireRequestLimit?.();
- active += 1;
- maximumActive = Math.max(maximumActive, active);
- try {
- await new Promise((resolve) => setTimeout(resolve, 5));
- return { ok: true, status: 200, statusText: "OK", data: { value: active } };
- } finally {
- active -= 1;
- await release?.();
- }
- });
- const caller = customApiRouter.createCaller({
- db,
- deviceType: undefined,
- session: null,
- clientAddress: "198.51.100.10",
- });
-
- const result = await caller.getData({ itemId });
-
- expect(Object.keys(result.data)).toHaveLength(6);
- expect(mocks.executeRequest).toHaveBeenCalledTimes(6);
- expect(maximumActive).toBe(4);
});
test("hides private boards and disabled definitions before executing a request", async () => {
@@ -357,25 +154,6 @@ describe("Custom JSX v2 board router", () => {
expect(mocks.executeRequest).not.toHaveBeenCalled();
});
- test("surfaces a real preserved v1 placement as migration-required", async () => {
- const { db, itemId, definitionId, ownerId } = await setup();
- await db.delete(customWidgetDefinitions).where(eq(customWidgetDefinitions.id, definitionId));
- await db.insert(legacyCustomWidgetDefinitions).values({
- id: definitionId,
- name: "Legacy weather",
- url: "https://example.com/weather",
- displayConfig: stringifySuperJson({ type: "singleValue", jsonPath: "$.temperature" }),
- creatorId: ownerId,
- });
- const caller = customApiRouter.createCaller({ db, deviceType: undefined, session: null });
-
- await expect(caller.getData({ itemId })).rejects.toMatchObject({
- code: "PRECONDITION_FAILED",
- message: "LEGACY_CUSTOM_WIDGET_MIGRATION_REQUIRED",
- });
- expect(mocks.executeRequest).not.toHaveBeenCalled();
- });
-
test("rejects request-kind and parameter mismatches", async () => {
const { db, itemId, ownerId } = await setup();
const caller = customApiRouter.createCaller({ db, deviceType: undefined, session: createSession(ownerId) });
@@ -402,7 +180,6 @@ describe("Custom JSX v2 board router", () => {
);
expect(mocks.executeRequest).toHaveBeenCalledWith(
expect.objectContaining({ method: "POST", body: '{"enabled":true}' }),
- expect.objectContaining({ acquireRequestLimit: expect.any(Function) }),
);
});
diff --git a/packages/api/src/router/widgets/custom-api.ts b/packages/api/src/router/widgets/custom-api.ts
index fd8c6c767..ac8462a73 100644
--- a/packages/api/src/router/widgets/custom-api.ts
+++ b/packages/api/src/router/widgets/custom-api.ts
@@ -12,7 +12,6 @@ import {
validateCustomWidgetOptions,
} from "@homarr/custom-widgets/core";
import type { CustomJsxRequest, CustomWidgetSource } from "@homarr/custom-widgets/core";
-import { CUSTOM_WIDGET_USER_ITEM_CONCURRENCY_LIMIT } from "@homarr/custom-widgets/server";
import { createTRPCRouter, protectedProcedure, publicProcedure } from "../../trpc";
import { throwIfActionForbiddenAsync } from "../board/board-access";
@@ -33,10 +32,6 @@ const namedRequestInputSchema = itemInputSchema.extend({
requestId: z.string().min(1).max(64),
params: runtimeParamsSchema.default({}),
});
-const refreshQueriesInputSchema = itemInputSchema.extend({
- requestIds: z.array(z.string().min(1).max(64)).max(64).default([]),
- all: z.boolean().default(false),
-});
interface CustomWidgetItemOptions {
definitionId: string;
@@ -45,7 +40,7 @@ interface CustomWidgetItemOptions {
refreshInterval?: number;
}
-type RouterContext = Parameters[0] & { clientAddress?: string };
+type RouterContext = Parameters[0];
type ResolvedDefinition = Awaited>;
const parseItemOptions = (raw: string): CustomWidgetItemOptions => {
@@ -147,35 +142,28 @@ const getAuth = (resolved: ResolvedDefinition, source: IdentifiedSource, mode: "
};
};
-const acquireRequestLimit = (ctx: RouterContext, resolved: ResolvedDefinition, request: IdentifiedRequest) =>
- acquireCustomWidgetRequestLimit({
+const withRequestLimit = async (
+ ctx: RouterContext,
+ resolved: ResolvedDefinition,
+ request: IdentifiedRequest,
+ callback: () => Promise,
+) => {
+ const release = await acquireCustomWidgetRequestLimit({
category: request.kind === "query" ? "query" : request.method === "DELETE" ? "delete" : "action",
userId: ctx.session?.user.id,
- anonymousId: ctx.clientAddress,
itemId: resolved.item.id,
definitionId: resolved.stored.id,
});
+ try {
+ return await callback();
+ } finally {
+ await release();
+ }
+};
const getCacheKey = (resolved: ResolvedDefinition, request: IdentifiedRequest, params: Record) =>
`custom-jsx:${resolved.item.id}:${getCustomWidgetCacheVersion(resolved.stored)}:${request.id}:${hashRuntimeParams(params)}`;
-async function mapLoadRequests(
- requests: readonly T[],
- execute: (request: T) => Promise,
-): Promise {
- const results: TResult[] = [];
- for (let index = 0; index < requests.length; index += CUSTOM_WIDGET_USER_ITEM_CONCURRENCY_LIMIT) {
- results.push(
- ...(await Promise.all(
- requests
- .slice(index, index + CUSTOM_WIDGET_USER_ITEM_CONCURRENCY_LIMIT)
- .map(async (request) => await execute(request)),
- )),
- );
- }
- return results;
-}
-
const executeRequest = async (
ctx: RouterContext,
resolved: ResolvedDefinition,
@@ -186,28 +174,20 @@ const executeRequest = async (
const source = findSource(resolved, request.source);
const values = resolveCustomWidgetRequestValues(request, resolved.configuration, params);
const targetUrl = renderRequestTarget(source.baseUrl, request, values);
- try {
- return await executeCustomWidgetRequest(
- {
- baseUrl: source.baseUrl,
- targetUrl,
- method: request.method,
- body: renderRequestBody(request, values),
- staticHeaders: request.headers,
- auth: getAuth(resolved, source, request.auth),
- networkScope: source.networkScope,
- kind: request.kind,
- cacheKey: request.kind === "query" ? getCacheKey(resolved, request, values) : undefined,
- cacheTtlSeconds: request.cacheSeconds,
- },
- {
- acquireRequestLimit: () => acquireRequestLimit(ctx, resolved, request),
- },
- );
- } catch (error) {
- if (error instanceof TRPCError) throw error;
- throw new TRPCError({ code: "BAD_GATEWAY", message: "External request failed" });
- }
+ return withRequestLimit(ctx, resolved, request, () =>
+ executeCustomWidgetRequest({
+ baseUrl: source.baseUrl,
+ targetUrl,
+ method: request.method,
+ body: renderRequestBody(request, values),
+ staticHeaders: request.headers,
+ auth: getAuth(resolved, source, request.auth),
+ networkScope: source.networkScope,
+ kind: request.kind,
+ cacheKey: request.kind === "query" ? getCacheKey(resolved, request, values) : undefined,
+ cacheTtlSeconds: request.cacheSeconds,
+ }),
+ );
};
export const customApiRouter = createTRPCRouter({
@@ -216,37 +196,39 @@ export const customApiRouter = createTRPCRouter({
const loadRequests = Object.entries(resolved.definition.requests).filter(
([, request]) => request.kind === "query" && request.trigger === "load",
);
- const entries = await mapLoadRequests(loadRequests, async ([requestId, request]) => {
- try {
- const response = await executeRequest(ctx, resolved, { id: requestId, ...request }, {});
- return [
- requestId,
- {
- data: response.data,
- status: {
- loading: false,
- ok: response.ok,
- status: response.status,
- statusText: response.statusText,
- error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
+ const entries = await Promise.all(
+ loadRequests.map(async ([requestId, request]) => {
+ try {
+ const response = await executeRequest(ctx, resolved, { id: requestId, ...request }, {});
+ return [
+ requestId,
+ {
+ data: response.data,
+ status: {
+ loading: false,
+ ok: response.ok,
+ status: response.status,
+ statusText: response.statusText,
+ error: response.ok ? undefined : `HTTP ${response.status}: ${response.statusText}`,
+ },
},
- },
- ] as const;
- } catch {
- return [
- requestId,
- {
- data: null,
- status: {
- loading: false,
- ok: false,
- status: 0,
- error: "Request failed",
+ ] as const;
+ } catch (error) {
+ return [
+ requestId,
+ {
+ data: null,
+ status: {
+ loading: false,
+ ok: false,
+ status: 0,
+ error: error instanceof Error ? error.message : "Request failed",
+ },
},
- },
- ] as const;
- }
- });
+ ] as const;
+ }
+ }),
+ );
return {
type: "customJsx" as const,
@@ -282,46 +264,6 @@ export const customApiRouter = createTRPCRouter({
};
}),
- refreshQueries: protectedProcedure.input(refreshQueriesInputSchema).mutation(async ({ ctx, input }) => {
- const resolved = await resolvePlacedDefinitionAsync(ctx, input.itemId);
- const available = Object.entries(resolved.definition.requests).flatMap(([requestId, request]) =>
- request.kind === "query" ? [{ id: requestId, ...request }] : [],
- );
- const requested = new Set(input.all ? available.map(({ id }) => id) : input.requestIds);
- const authorized: IdentifiedRequest[] = [];
- for (const request of available) {
- if (!requested.has(request.id)) continue;
- try {
- await throwIfActionForbiddenAsync(
- ctx,
- eq(boards.id, resolved.item.boardId),
- request.permission as BoardPermission,
- );
- authorized.push(request);
- } catch (error) {
- if (!(error instanceof TRPCError) || error.code !== "NOT_FOUND") throw error;
- }
- }
- if (authorized.length === 0) return { requestIds: [] };
-
- const release = await acquireCustomWidgetRequestLimit({
- category: "query",
- userId: ctx.session?.user.id,
- anonymousId: ctx.clientAddress,
- itemId: resolved.item.id,
- definitionId: resolved.stored.id,
- });
- try {
- const version = getCustomWidgetCacheVersion(resolved.stored);
- await invalidateCustomWidgetResponseCache(
- authorized.map((request) => `custom-jsx:${resolved.item.id}:${version}:${request.id}:`),
- );
- } finally {
- await release();
- }
- return { requestIds: authorized.map(({ id }) => id) };
- }),
-
executeAction: protectedProcedure
.input(namedRequestInputSchema.extend({ confirmed: z.boolean().optional() }))
.mutation(async ({ ctx, input }) => {
@@ -333,7 +275,7 @@ export const customApiRouter = createTRPCRouter({
}
const response = await executeRequest(ctx, resolved, request, input.params);
if (response.ok && request.invalidates?.length) {
- await invalidateCustomWidgetResponseCache(
+ invalidateCustomWidgetResponseCache(
request.invalidates.flatMap((requestId) => [
`custom-jsx:${resolved.item.id}:${getCustomWidgetCacheVersion(resolved.stored)}:${requestId}:`,
`custom-widget:options:${resolved.stored.id}:${getCustomWidgetCacheVersion(resolved.stored)}:${requestId}:`,
diff --git a/packages/api/src/trpc.ts b/packages/api/src/trpc.ts
index 0e78f794b..b3fe7ae4d 100644
--- a/packages/api/src/trpc.ts
+++ b/packages/api/src/trpc.ts
@@ -14,7 +14,7 @@ import { ZodError } from "zod/v4";
import type { Session } from "@homarr/auth";
import { extractBaseUrlFromHeaders, FlattenError } from "@homarr/common";
-import { rateLimitAddressFromHeaders, userAgent } from "@homarr/common/server";
+import { userAgent } from "@homarr/common/server";
import type { DeviceType } from "@homarr/common/server";
import { createLogger } from "@homarr/core/infrastructure/logs";
import { db } from "@homarr/db";
@@ -41,7 +41,6 @@ interface ApiContext {
session: Session | null;
deviceType: DeviceType;
baseUrl?: `${string}://${string}`;
- clientAddress?: string;
db: typeof db;
}
@@ -59,7 +58,6 @@ export const createTRPCContext = (opts: { headers: Headers; session: Session | n
session,
deviceType: userAgent(opts.headers).device.type,
baseUrl: extractBaseUrlFromHeaders(opts.headers),
- clientAddress: rateLimitAddressFromHeaders(opts.headers) ?? undefined,
db,
};
};
diff --git a/packages/common/src/request.ts b/packages/common/src/request.ts
index 1040d34cd..f90d91945 100644
--- a/packages/common/src/request.ts
+++ b/packages/common/src/request.ts
@@ -1,5 +1,3 @@
-import { isIP } from "node:net";
-
import { userAgent as userAgentNextServer } from "next/server";
import type { Modify } from "./types";
@@ -13,31 +11,5 @@ export const userAgent = (headers: Headers) => {
export type DeviceType = "console" | "mobile" | "tablet" | "smarttv" | "wearable" | "embedded" | undefined;
export const ipAddressFromHeaders = (headers: Headers): string | null => {
- const forwardedAddress = headers.get("x-forwarded-for")?.split(",", 1)[0]?.trim();
- if (forwardedAddress) return forwardedAddress;
-
- const realAddress = headers.get("x-real-ip")?.trim();
- return realAddress || null;
+ return headers.get("x-forwarded-for");
};
-
-const canonicalizeIpAddress = (value: string | null): string | null => {
- const trimmed = value?.trim();
- if (!trimmed) return null;
-
- const unwrapped = trimmed.startsWith("[") && trimmed.endsWith("]") ? trimmed.slice(1, -1) : trimmed;
- const family = isIP(unwrapped);
- if (family === 4) return unwrapped;
- if (family !== 6) return null;
-
- const hostname = new URL(`http://[${unwrapped}]/`).hostname;
- return hostname.slice(1, -1);
-};
-
-/**
- * Returns the canonical address supplied by Homarr's trusted ingress for
- * abuse-control buckets. Do not fall back to X-Forwarded-For here: clients can
- * prepend arbitrary values to that chain. Deployments without a trusted
- * X-Real-IP header deliberately share the anonymous fallback bucket.
- */
-export const rateLimitAddressFromHeaders = (headers: Headers): string | null =>
- canonicalizeIpAddress(headers.get("x-real-ip"));
diff --git a/packages/custom-widgets/scripts/ai-evaluation-cases.ts b/packages/custom-widgets/scripts/ai-evaluation-cases.ts
index c564c4ef9..975598ebb 100644
--- a/packages/custom-widgets/scripts/ai-evaluation-cases.ts
+++ b/packages/custom-widgets/scripts/ai-evaluation-cases.ts
@@ -3,20 +3,6 @@ export interface CustomWidgetAiEvaluationCase {
request: string;
documentationUrl: string;
apiNotes: string;
- acceptance: {
- sourceAuth?: { type: "none" | "bearer" | "apiKeyHeader" | "apiKeyQuery"; name?: string };
- requestRules: ReadonlyArray<{
- label: string;
- pathIncludes: string;
- kind?: "query" | "action";
- method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
- trigger?: "load" | "manual";
- optionReference?: string;
- parameterReference?: string;
- invalidatesRequest?: string;
- }>;
- templateComponents: readonly string[];
- };
}
export const CUSTOM_WIDGET_AI_EVALUATION_CASES: readonly CustomWidgetAiEvaluationCase[] = [
@@ -27,20 +13,6 @@ export const CUSTOM_WIDGET_AI_EVALUATION_CASES: readonly CustomWidgetAiEvaluatio
"Create a polished Pokédex browser with searchable Pokémon, a responsive result grid, manual detail loading, sprites, types, abilities, base-stat progress bars, and clear loading, empty, and failure states.",
apiNotes:
"Use GET /api/v2/pokemon?limit=