Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: support page url pattern in builder (#2674)

Bogdan Chadkin92ddfbd64ca1
diff --git a/apps/builder/app/builder/features/settings-panel/controls/json.tsx b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
index 31fffac191..60c9d0f1d0 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/json.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
@@ -55,7 +55,9 @@ export const JsonControl = ({
key={valueString}
readOnly={readOnly}
variables={emptyVariables}
- defaultValue={localValue.value}
+ // actual local value is not important because code editor
+ // is uncontrolled and has own local value
+ defaultValue={valueString}
onChange={localValue.set}
onBlur={localValue.save}
/>
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
index b69535cdfa..8dcdb7270e 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/settings.tsx
@@ -1,14 +1,16 @@
import { z } from "zod";
import {
- useState,
- useCallback,
type ComponentProps,
type FocusEventHandler,
+ useState,
+ useCallback,
+ Fragment,
} from "react";
import { useStore } from "@nanostores/react";
import { useDebouncedCallback } from "use-debounce";
import { useUnmount } from "react-use";
import slugify from "slugify";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
import {
type Page,
type Pages,
@@ -16,6 +18,7 @@ import {
HomePagePath,
PageTitle,
PagePath,
+ DataSource,
} from "@webstudio-is/sdk";
import { findPageByIdOrPath } from "@webstudio-is/project-build";
import {
@@ -56,6 +59,8 @@ import {
projectStore,
selectedInstanceSelectorStore,
selectedPageIdStore,
+ $dataSources,
+ $dataSourceVariables,
} from "~/shared/nano-states";
import { nanoid } from "nanoid";
import { removeByMutable } from "~/shared/array-utils";
@@ -67,6 +72,7 @@ import { SocialPreview } from "./social-preview";
import { useEffectEvent } from "~/builder/features/ai/hooks/effect-event";
import { CustomMetadata } from "./custom-metadata";
import env from "~/shared/env";
+import { compilePathnamePattern, parsePathnamePattern } from "./url-pattern";
const fieldDefaultValues = {
name: "Untitled",
@@ -96,6 +102,29 @@ type Errors = {
[fieldName in FieldName]?: string[];
};
+const LegacyPagePath = z
+ .string()
+ .refine((path) => path !== "", "Can't be empty")
+ .refine((path) => path !== "/", "Can't be just a /")
+ .refine((path) => path === "" || path.startsWith("/"), "Must start with a /")
+ .refine((path) => path.endsWith("/") === false, "Can't end with a /")
+ .refine((path) => path.includes("//") === false, "Can't contain repeating /")
+ .refine(
+ (path) => /^[-_a-z0-9\\/]*$/.test(path),
+ "Only a-z, 0-9, -, _, / are allowed"
+ )
+ .refine(
+ // We use /s for our system stuff like /s/css or /s/uploads
+ (path) => path !== "/s" && path.startsWith("/s/") === false,
+ "/s prefix is reserved for the system"
+ )
+ .refine(
+ // Remix serves build artefacts like JS bundles from /build
+ // And we cannot customize it due to bug in Remix: https://github.com/remix-run/remix/issues/2933
+ (path) => path !== "/build" && path.startsWith("/build/") === false,
+ "/build prefix is reserved for the system"
+ );
+
const HomePageValues = z.object({
name: PageName,
path: HomePagePath,
@@ -105,7 +134,7 @@ const HomePageValues = z.object({
const PageValues = z.object({
name: PageName,
- path: PagePath,
+ path: isFeatureEnabled("bindings") ? PagePath : LegacyPagePath,
title: PageTitle,
description: z.string().optional(),
});
@@ -224,12 +253,14 @@ const CopyPageDomainAndPathButton = ({
const FormFields = ({
disabled,
autoSelect,
+ pathVariableId,
errors,
values,
onChange,
}: {
disabled?: boolean;
autoSelect?: boolean;
+ pathVariableId?: DataSource["id"];
errors: Errors;
values: Values;
onChange: (
@@ -258,7 +289,15 @@ const FormFields = ({
const publishedUrl = new URL(`https://${domain}`);
- const pageDomainAndPath = [publishedUrl.host, values?.path]
+ const pathParamNames = parsePathnamePattern(values.path);
+ const dataSourceVariables = useStore($dataSourceVariables);
+ const params =
+ pathVariableId !== undefined
+ ? (dataSourceVariables.get(pathVariableId) as Record<string, string>)
+ : undefined;
+
+ const compiledPath = compilePathnamePattern(values.path ?? "", params ?? {});
+ const pageDomainAndPath = [publishedUrl.host, compiledPath]
.filter(Boolean)
.join("/")
.replace(/\/+/g, "/");
@@ -350,6 +389,36 @@ const FormFields = ({
}}
/>
</InputErrorsTooltip>
+ {pathVariableId !== undefined &&
+ pathParamNames.map((name) => (
+ <Fragment key={name}>
+ <Label htmlFor={`${fieldIds.path}-${name}`}>{name}</Label>
+ <InputField
+ tabIndex={1}
+ id={`${fieldIds.path}-${name}`}
+ name="path"
+ value={params?.[name] ?? ""}
+ onChange={(event) => {
+ if (pathVariableId === undefined) {
+ return;
+ }
+ const dataSourceVariables = new Map(
+ $dataSourceVariables.get()
+ );
+ // delete stale fields
+ const newParams: Record<string, string> = {};
+ for (const name of pathParamNames) {
+ if (params?.[name]) {
+ newParams[name] = params[name];
+ }
+ }
+ newParams[name] = event.target.value;
+ dataSourceVariables.set(pathVariableId, newParams);
+ $dataSourceVariables.set(dataSourceVariables);
+ }}
+ />
+ </Fragment>
+ ))}
<CopyPageDomainAndPathButton
pageDomainAndPath={pageDomainAndPath}
/>
@@ -718,40 +787,55 @@ const updatePage = (pageId: Page["id"], values: Partial<Values>) => {
}
};
- serverSyncStore.createTransaction([pagesStore], (pages) => {
- if (pages === undefined) {
- return;
- }
+ serverSyncStore.createTransaction(
+ [pagesStore, $dataSources],
+ (pages, dataSources) => {
+ if (pages === undefined) {
+ return;
+ }
- // swap home page
- if (values.isHomePage && pages.homePage.id !== pageId) {
- const newHomePageIndex = pages.pages.findIndex(
- (page) => page.id === pageId
- );
+ // swap home page
+ if (values.isHomePage && pages.homePage.id !== pageId) {
+ const newHomePageIndex = pages.pages.findIndex(
+ (page) => page.id === pageId
+ );
- if (newHomePageIndex === -1) {
- throw new Error(`Page with id ${pageId} not found`);
- }
+ if (newHomePageIndex === -1) {
+ throw new Error(`Page with id ${pageId} not found`);
+ }
- const tmp = pages.homePage;
- pages.homePage = pages.pages[newHomePageIndex];
+ const tmp = pages.homePage;
+ pages.homePage = pages.pages[newHomePageIndex];
- pages.homePage.path = "";
- pages.pages[newHomePageIndex] = tmp;
+ pages.homePage.path = "";
+ pages.pages[newHomePageIndex] = tmp;
- tmp.path = nameToPath(pages, tmp.name);
- }
+ tmp.path = nameToPath(pages, tmp.name);
+ }
- if (pages.homePage.id === pageId) {
- updatePageMutable(pages.homePage, values);
- }
+ if (pages.homePage.id === pageId) {
+ updatePageMutable(pages.homePage, values);
+ }
- for (const page of pages.pages) {
- if (page.id === pageId) {
- updatePageMutable(page, values);
+ for (const page of pages.pages) {
+ if (page.id === pageId) {
+ // create "Page params" variable when pattern is specified in path
+ const paramNames = parsePathnamePattern(page.path);
+ if (paramNames.length > 0 && page.pathVariableId === undefined) {
+ page.pathVariableId = nanoid();
+ dataSources.set(page.pathVariableId, {
+ id: page.pathVariableId,
+ // scope new variable to body
+ scopeInstanceId: page.rootInstanceId,
+ type: "parameter",
+ name: "Page params",
+ });
+ }
+ updatePageMutable(page, values);
+ }
}
}
- });
+ );
};
const deletePage = (pageId: Page["id"]) => {
@@ -881,6 +965,7 @@ export const PageSettings = ({
return (
<PageSettingsView
+ pathVariableId={page.pathVariableId}
onClose={onClose}
onDelete={hanldeDelete}
onDuplicate={() => {
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.test.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.test.ts
new file mode 100644
index 0000000000..ae39b6a28d
--- /dev/null
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.test.ts
@@ -0,0 +1,68 @@
+import { expect, test } from "@jest/globals";
+import { compilePathnamePattern, parsePathnamePattern } from "./url-pattern";
+
+test("parse keys from pathname pattern", () => {
+ expect(parsePathnamePattern("/blog/:id/:date")).toEqual(["id", "date"]);
+});
+
+test("parse wildcard and named wildcard from pathname pattern", () => {
+ expect(parsePathnamePattern("/blog/*/:slug*/*")).toEqual(["0", "1", "slug"]);
+});
+
+test("compile pathname pattern with named values", () => {
+ expect(
+ compilePathnamePattern("/blog/:id/:date", { id: "my-id", date: "my-date" })
+ ).toEqual("/blog/my-id/my-date");
+});
+
+test("compile pathname pattern with named wildcard", () => {
+ expect(
+ compilePathnamePattern("/blog/:slug*/:date*", {
+ slug: "my-slug",
+ date: "my-date",
+ })
+ ).toEqual("/blog/my-slug/my-date");
+});
+
+test("compile pathname pattern with indexed wildcard", () => {
+ expect(
+ compilePathnamePattern("/blog/*/:slug*/*", {
+ // use random order
+ 1: "one",
+ slug: "my-slug",
+ 0: "zero",
+ })
+ ).toEqual("/blog/zero/my-slug/one");
+});
+
+test("compile pathname pattern with many indexed wildcards (more than 10)", () => {
+ expect(
+ compilePathnamePattern("/blog/*/*/*/*/*/*/*/*/*/*/*/*", {
+ // use random order
+ 11: "eleven",
+ 10: "ten",
+ 9: "nine",
+ 8: "eight",
+ 7: "seven",
+ 6: "six",
+ 5: "five",
+ 4: "four",
+ 3: "three",
+ 2: "two",
+ 1: "one",
+ 0: "zero",
+ })
+ ).toEqual(
+ "/blog/zero/one/two/three/four/five/six/seven/eight/nine/ten/eleven"
+ );
+});
+
+test("ignore compiling empty values", () => {
+ expect(
+ compilePathnamePattern("/blog/*/:slug", {
+ // use random order
+ slug: "",
+ 0: "",
+ })
+ ).toEqual("/blog/*/:slug");
+});
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.ts
new file mode 100644
index 0000000000..3c27a47df1
--- /dev/null
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/url-pattern.ts
@@ -0,0 +1,40 @@
+import { URLPattern } from "urlpattern-polyfill";
+
+const baseUrl = "http://url";
+
+export const parsePathnamePattern = (pathname: string) => {
+ try {
+ const pattern = new URLPattern(pathname, baseUrl);
+ // match path with itself to figure out if some parameters are specified
+ const fakeParams = pattern.exec(pathname, baseUrl)?.pathname.groups;
+ return Object.keys(fakeParams ?? {});
+ } catch {
+ return [];
+ }
+};
+
+const indexRegex = /^\d+$/;
+
+// @todo prevent replacing with empty strigs
+export const compilePathnamePattern = (
+ pathname: string,
+ values: Record<string, string>
+) => {
+ const entries = Object.entries(values)
+ .sort(
+ // sort only indexes, names order is not important
+ ([leftName], [rightName]) => Number(leftName) - Number(rightName)
+ )
+ .filter(([_name, value]) => value.length > 0);
+ for (const [name, value] of entries) {
+ pathname = pathname.replaceAll(`:${name}*`, value);
+ pathname = pathname.replaceAll(`:${name}`, value);
+ }
+ for (const [name, value] of entries) {
+ if (indexRegex.test(name)) {
+ // replace only first occurence
+ pathname = pathname.replace(`*`, value);
+ }
+ }
+ return pathname;
+};
diff --git a/apps/builder/app/shared/nano-states/props.test.ts b/apps/builder/app/shared/nano-states/props.test.ts
index 2f85291d20..ff72478204 100644
--- a/apps/builder/app/shared/nano-states/props.test.ts
+++ b/apps/builder/app/shared/nano-states/props.test.ts
@@ -329,3 +329,48 @@ test("compute expression from collection items", () => {
cleanStores($propValuesByInstanceSelector);
});
+
+test("access parameter value from variables values", () => {
+ $instances.set(
+ toMap([
+ {
+ id: "body",
+ type: "instance",
+ component: "Body",
+ children: [],
+ },
+ ])
+ );
+ selectPageRoot("body");
+ $dataSources.set(
+ toMap([
+ {
+ id: "parameterId",
+ type: "parameter",
+ name: "paramName",
+ },
+ ])
+ );
+ $dataSourceVariables.set(new Map([["parameterId", "paramValue"]]));
+ $props.set(
+ toMap([
+ {
+ id: "parameterPropId",
+ name: "param",
+ instanceId: "body",
+ type: "expression",
+ value: "$ws$dataSource$parameterId",
+ },
+ ])
+ );
+ expect($propValuesByInstanceSelector.get()).toEqual(
+ new Map([
+ [
+ JSON.stringify(["body"]),
+ new Map<string, unknown>([["param", "paramValue"]]),
+ ],
+ ])
+ );
+
+ cleanStores($propValuesByInstanceSelector);
+});
diff --git a/apps/builder/app/shared/nano-states/props.ts b/apps/builder/app/shared/nano-states/props.ts
index d6138790fa..7bfdcebc5b 100644
--- a/apps/builder/app/shared/nano-states/props.ts
+++ b/apps/builder/app/shared/nano-states/props.ts
@@ -34,23 +34,38 @@ export const getIndexedInstanceId = (
const $dataSourcesLogic = computed(
[$dataSources, $dataSourceVariables, $props],
(dataSources, dataSourceVariables, props) => {
+ const scope = createScope(["_getVariable", "_setVariable", "_output"]);
const { variables, body, output } = generateDataSources({
- scope: createScope(["_getVariable", "_setVariable", "_output"]),
+ scope,
dataSources,
props,
});
let generatedCode = "";
+ // render state variables
for (const [dataSourceId, variable] of variables) {
const { valueName, setterName } = variable;
const initialValue = JSON.stringify(variable.initialValue);
generatedCode += `let ${valueName} = _getVariable("${dataSourceId}") ?? ${initialValue};\n`;
generatedCode += `let ${setterName} = (value) => _setVariable("${dataSourceId}", value);\n`;
}
+ // render parameters
+ for (const [dataSourceId, dataSource] of dataSources) {
+ if (dataSource.type === "parameter") {
+ const variableName = scope.getName(dataSourceId, dataSource.name);
+ generatedCode += `let ${variableName} = _getVariable("${dataSourceId}");\n`;
+ }
+ }
generatedCode += body;
generatedCode += `let _output = new Map();\n`;
for (const [dataSourceId, variableName] of output) {
generatedCode += `_output.set('${dataSourceId}', ${variableName})\n`;
}
+ for (const [dataSourceId, dataSource] of dataSources) {
+ if (dataSource.type === "parameter") {
+ const variableName = scope.getName(dataSourceId, dataSource.name);
+ generatedCode += `_output.set('${dataSourceId}', ${variableName})\n`;
+ }
+ }
generatedCode += `return _output\n`;
try {
diff --git a/apps/builder/package.json b/apps/builder/package.json
index 52113ad428..4e280a24dd 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -77,6 +77,7 @@
"debug": "^4.3.4",
"detect-font": "^0.1.5",
"downshift": "^6.1.7",
+ "fast-deep-equal": "^3.1.3",
"hono": "^3.7.3",
"hyphenate-style-name": "^1.0.4",
"immer": "^10.0.3",
@@ -110,6 +111,7 @@
"strip-indent": "^4.0.0",
"title-case": "^4.1.0",
"untruncate-json": "^0.0.1",
+ "urlpattern-polyfill": "^9.0.0",
"use-debounce": "^9.0.4",
"uuid": "^9.0.0",
"warn-once": "^0.1.1",
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index 5c9c9bf096..1696817516 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -1,4 +1,4 @@
-import { z, type ZodType } from "zod";
+import { z } from "zod";
const MIN_TITLE_LENGTH = 2;
@@ -32,6 +32,7 @@ const commonPageFields = {
.optional(),
}),
rootInstanceId: z.string(),
+ pathVariableId: z.optional(z.string()),
} as const;
export const HomePagePath = z
@@ -43,38 +44,28 @@ const HomePage = z.object({
path: HomePagePath,
});
-export const pathValidators = (
- baseValidator: ZodType<string>
-): ZodType<string> =>
- baseValidator
- .refine((path) => path !== "", "Can't be empty")
- .refine((path) => path !== "/", "Can't be just a /")
- .refine(
- (path) => path === "" || path.startsWith("/"),
- "Must start with a /"
- )
- .refine((path) => path.endsWith("/") === false, "Can't end with a /")
- .refine(
- (path) => path.includes("//") === false,
- "Can't contain repeating /"
- )
- .refine(
- (path) => /^[-_a-z0-9\\/]*$/.test(path),
- "Only a-z, 0-9, -, _ and / are allowed"
- )
- .refine(
- // We use /s for our system stuff like /s/css or /s/uploads
- (path) => path !== "/s" && path.startsWith("/s/") === false,
- "/s prefix is reserved for the system"
- )
- .refine(
- // Remix serves build artefacts like JS bundles from /build
- // And we cannot customize it due to bug in Remix: https://github.com/remix-run/remix/issues/2933
- (path) => path !== "/build" && path.startsWith("/build/") === false,
- "/build prefix is reserved for the system"
- );
-
-export const PagePath = pathValidators(z.string());
+export const PagePath = z
+ .string()
+ .refine((path) => path !== "", "Can't be empty")
+ .refine((path) => path !== "/", "Can't be just a /")
+ .refine((path) => path === "" || path.startsWith("/"), "Must start with a /")
+ .refine((path) => path.endsWith("/") === false, "Can't end with a /")
+ .refine((path) => path.includes("//") === false, "Can't contain repeating /")
+ .refine(
+ (path) => /^[-_a-z0-9*:\\/]*$/.test(path),
+ "Only a-z, 0-9, -, _, /, : and * are allowed"
+ )
+ .refine(
+ // We use /s for our system stuff like /s/css or /s/uploads
+ (path) => path !== "/s" && path.startsWith("/s/") === false,
+ "/s prefix is reserved for the system"
+ )
+ .refine(
+ // Remix serves build artefacts like JS bundles from /build
+ // And we cannot customize it due to bug in Remix: https://github.com/remix-run/remix/issues/2933
+ (path) => path !== "/build" && path.startsWith("/build/") === false,
+ "/build prefix is reserved for the system"
+ );
const Page = z.object({
...commonPageFields,
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index fbfeb9282b..17868ef213 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -232,6 +232,9 @@ importers:
downshift:
specifier: ^6.1.7
version: 6.1.7([email protected])
+ fast-deep-equal:
+ specifier: ^3.1.3
+ version: 3.1.3
hono:
specifier: ^3.7.3
version: 3.7.3
@@ -331,6 +334,9 @@ importers:
untruncate-json:
specifier: ^0.0.1
version: 0.0.1
+ urlpattern-polyfill:
+ specifier: ^9.0.0
+ version: 9.0.0
use-debounce:
specifier: ^9.0.4
version: 9.0.4([email protected])
@@ -16994,6 +17000,10 @@ packages:
resolution: {integrity: sha512-DOE84vZT2fEcl9gqCUTcnAw5ZY5Id55ikUcziSUntuEFL3pRvavg5kwDmTEUJkeCHInTlV/HexFomgYnzO5kdQ==}
dev: true
+ resolution: {integrity: sha512-WHN8KDQblxd32odxeIgo83rdVDE2bvdkb86it7bMhYZwWKJz0+O0RK/eZiHYnM+zgt/U7hAHOlCQGfjjvSkw2g==}
+ dev: false
+
resolution: {integrity: sha512-3FT9PRuRdbB9HfXhEq35u4oZkvpJ5kuYbpqhCfmiZyReuRgpnhDlbr2ZEnnuS0RrJAPn6l23xjFg9kpDM+Ms7w==}
engines: {node: '>=10'}