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.

fix: Bind dynamic page metadata expressions (#6110)

Oleg Isonen463a6b4fcc65
diff --git a/packages/project-build/src/contracts/__generated__/runtime-operation-contracts.ts b/packages/project-build/src/contracts/__generated__/runtime-operation-contracts.ts
index b2334a5573..4503cad7ed 100644
--- a/packages/project-build/src/contracts/__generated__/runtime-operation-contracts.ts
+++ b/packages/project-build/src/contracts/__generated__/runtime-operation-contracts.ts
@@ -769,7 +769,7 @@ export const runtimeOperationContractData = [
required: ["pageId", "rootInstanceId"],
additionalProperties: {},
},
- readNamespaces: ["pages"],
+ readNamespaces: ["pages", "instances", "dataSources"],
writeNamespaces: ["pages", "instances"],
invalidatesNamespaces: ["pages", "instances"],
retryOnConflict: false,
@@ -948,7 +948,7 @@ export const runtimeOperationContractData = [
required: ["pageId"],
additionalProperties: {},
},
- readNamespaces: ["pages"],
+ readNamespaces: ["pages", "instances", "dataSources"],
writeNamespaces: ["pages"],
invalidatesNamespaces: ["pages"],
retryOnConflict: true,
@@ -1068,7 +1068,7 @@ export const runtimeOperationContractData = [
required: ["pageId"],
additionalProperties: {},
},
- readNamespaces: ["pages"],
+ readNamespaces: ["pages", "instances", "dataSources"],
writeNamespaces: ["pages"],
invalidatesNamespaces: ["pages"],
retryOnConflict: true,
diff --git a/packages/project-build/src/project-session.test.ts b/packages/project-build/src/project-session.test.ts
index a553dc6a1b..7a8fa7ced4 100644
--- a/packages/project-build/src/project-session.test.ts
+++ b/packages/project-build/src/project-session.test.ts
@@ -1242,7 +1242,9 @@ describe("project session", () => {
expect.objectContaining({ code: "CONFLICT_REFRESHED" }),
expect.objectContaining({ code: "CONFLICT_RETRY" }),
]);
- expect(transport.loadedNamespaces).toEqual([["pages"]]);
+ expect(transport.loadedNamespaces).toEqual([
+ ["pages", "instances", "dataSources"],
+ ]);
expect(transport.commits).toHaveLength(2);
});
diff --git a/packages/project-build/src/runtime/expression-scope.ts b/packages/project-build/src/runtime/expression-scope.ts
index 100521e694..ef7a6ee0f1 100644
--- a/packages/project-build/src/runtime/expression-scope.ts
+++ b/packages/project-build/src/runtime/expression-scope.ts
@@ -3,7 +3,7 @@ import { bindExpressionToInstanceScope, findAvailableVariables } from "./data";
import { getExpressionWarnings } from "./expression-validation";
export const bindExpressionInput = (
- state: BuilderState,
+ state: Pick<BuilderState, "instances" | "dataSources">,
instanceId: string,
expression: string
) => {
diff --git a/packages/project-build/src/runtime/pages.test.ts b/packages/project-build/src/runtime/pages.test.ts
index e6f6a8f5a9..4df2c88927 100644
--- a/packages/project-build/src/runtime/pages.test.ts
+++ b/packages/project-build/src/runtime/pages.test.ts
@@ -2,6 +2,7 @@ import { describe, expect, test } from "vitest";
import { createDefaultPages } from "@webstudio-is/project-build";
import { migratePages } from "@webstudio-is/project-migrations/pages";
import {
+ encodeDataVariableId,
elementComponent,
isRootFolder,
ROOT_FOLDER_ID,
@@ -1936,6 +1937,57 @@ describe("createPage", () => {
});
describe("updatePage", () => {
+ test("binds readable page metadata variables to the page scope", () => {
+ const pages = createPages();
+ const instances = new Map([
+ ["pageBody", createPageRootInstance("pageBody")],
+ ]);
+ const dataSources = new Map([
+ [
+ "postForSlugId",
+ {
+ id: "postForSlugId",
+ scopeInstanceId: "pageBody",
+ name: "postForSlug",
+ type: "resource" as const,
+ resourceId: "postResourceId",
+ },
+ ],
+ ]);
+
+ expect(
+ updatePage(
+ { pages, instances, dataSources },
+ {
+ pageId: "page",
+ values: {
+ title: '"Slug: " + system.params.slug',
+ meta: {
+ description:
+ "postForSlug.data.at(0).field.Slug === system.params.slug ? postForSlug.data.at(0).field.Description : undefined",
+ },
+ },
+ }
+ ).payload
+ ).toEqual([
+ {
+ namespace: "pages",
+ patches: [
+ {
+ op: "replace",
+ path: ["pages", "page", "title"],
+ value: `"Slug: " + ${encodeDataVariableId(":system")}.params.slug`,
+ },
+ {
+ op: "add",
+ path: ["pages", "page", "meta", "description"],
+ value: `${encodeDataVariableId("postForSlugId")}.data.at(0).field.Slug === ${encodeDataVariableId(":system")}.params.slug ? ${encodeDataVariableId("postForSlugId")}.data.at(0).field.Description : undefined`,
+ },
+ ],
+ },
+ ]);
+ });
+
test("sets and clears draft", () => {
const pages = createPages();
diff --git a/packages/project-build/src/runtime/pages.ts b/packages/project-build/src/runtime/pages.ts
index 103f075637..6cc5134185 100644
--- a/packages/project-build/src/runtime/pages.ts
+++ b/packages/project-build/src/runtime/pages.ts
@@ -45,6 +45,7 @@ import {
type SemanticValidationIssue,
} from "./errors";
import { getNamedExpressionValidationIssues } from "./expression-validation";
+import { bindExpressionInput } from "./expression-scope";
import { runtimeGeneratedIdInput } from "./generated-id-input";
import { paginateOutput, type PaginatedOutputInput } from "./output";
import {
@@ -1032,6 +1033,37 @@ const normalizePageFieldsExpressionInputs = <
meta: normalizePageMetaExpressionInputs(input.meta),
});
+const bindPageFieldsExpressionInputs = <Input extends PageFieldsPatchInput>({
+ state,
+ input,
+ rootInstanceId,
+}: {
+ state: Pick<BuilderState, "instances" | "dataSources">;
+ input: Input;
+ rootInstanceId: string;
+}): Input => {
+ const bound: Input = { ...input };
+ if (typeof input.title === "string") {
+ bound.title = bindExpressionInput(state, rootInstanceId, input.title);
+ }
+ if (input.meta === undefined) {
+ return bound;
+ }
+ const meta: PageMetaPatchInput = { ...input.meta };
+ for (const name of pageMetaExpressionFields) {
+ const value = meta[name];
+ if (typeof value === "string") {
+ meta[name] = bindExpressionInput(state, rootInstanceId, value);
+ }
+ }
+ meta.custom = meta.custom?.map((customMeta) => ({
+ ...customMeta,
+ content: bindExpressionInput(state, rootInstanceId, customMeta.content),
+ }));
+ bound.meta = meta;
+ return bound;
+};
+
const pageMetaInputBase = z.object({
description: pageExpressionStringInput.optional(),
language: pageExpressionStringInput.optional(),
@@ -1847,7 +1879,7 @@ export const createPageUpdatePayload = (
};
export const createPage = (
- state: Pick<BuilderState, "pages">,
+ state: Pick<BuilderState, "pages" | "instances" | "dataSources">,
input: z.infer<typeof pageCreateInput>,
context: BuilderRuntimeContext
) => {
@@ -1888,16 +1920,21 @@ export const createPage = (
);
}
const rootInstanceId = context.createId();
+ const boundInput = bindPageFieldsExpressionInputs({
+ state,
+ input: normalizedInput,
+ rootInstanceId,
+ });
const page = createPageValue({
pageId,
- name: normalizedInput.name ?? input.name,
- path: normalizedInput.path ?? input.path,
- title: normalizedInput.title,
+ name: boundInput.name ?? input.name,
+ path: boundInput.path ?? input.path,
+ title: boundInput.title,
rootInstanceId,
meta:
- normalizedInput.meta === undefined
+ boundInput.meta === undefined
? {}
- : (pageMetaToPatchValue(normalizedInput.meta) as Page["meta"]),
+ : (pageMetaToPatchValue(boundInput.meta) as Page["meta"]),
});
const rootInstance = createPageRootInstance(rootInstanceId);
return createRuntimeMutation({
@@ -1913,7 +1950,7 @@ export const createPage = (
};
export const updatePage = (
- state: Pick<BuilderState, "pages">,
+ state: Pick<BuilderState, "pages" | "instances" | "dataSources">,
input: z.infer<typeof pageUpdateInput>
) => {
const pages = getRequiredPages(state);
@@ -1970,9 +2007,14 @@ export const updatePage = (
getFolderOrThrow(pages, normalizedValues.parentFolderId);
getParentFolderIdOrThrow(pages, page.id);
}
+ const boundValues = bindPageFieldsExpressionInputs({
+ state,
+ input: normalizedValues,
+ rootInstanceId: page.rootInstanceId,
+ });
return createRuntimeMutation({
payload: createPageUpdatePayload({
- input: normalizedValues,
+ input: boundValues,
page,
pages,
}),
@@ -2065,7 +2107,7 @@ export const getPageSettingsUpdateData = ({
};
export const updatePageSettings = (
- state: Pick<BuilderState, "pages">,
+ state: Pick<BuilderState, "pages" | "instances" | "dataSources">,
input: z.infer<typeof pageSettingsUpdateInput>
) => {
const pages = getRequiredPages(state);
diff --git a/packages/project-build/src/runtime/registry.test.ts b/packages/project-build/src/runtime/registry.test.ts
index cddc656433..420eb28db1 100644
--- a/packages/project-build/src/runtime/registry.test.ts
+++ b/packages/project-build/src/runtime/registry.test.ts
@@ -240,6 +240,17 @@ test("keeps generated runtime contracts in sync with the registry", () => {
);
});
+test.each(["pages.create", "pages.update", "pages.updateSettings"])(
+ "%s loads the page expression scope",
+ (operationId) => {
+ expect(getBuilderRuntimeOperation(operationId).readNamespaces).toEqual([
+ "pages",
+ "instances",
+ "dataSources",
+ ]);
+ }
+);
+
test("requires an output schema for every runtime operation", () => {
expect(
builderRuntimeOperations
diff --git a/packages/project-build/src/runtime/registry.ts b/packages/project-build/src/runtime/registry.ts
index 95fa6fc61f..74b9e76875 100644
--- a/packages/project-build/src/runtime/registry.ts
+++ b/packages/project-build/src/runtime/registry.ts
@@ -308,6 +308,7 @@ const mutationContract = (input: {
}): MutationContract => ({ kind: "mutation", ...input });
const pageNamespaces = ["pages", "instances"] as const;
+const pageExpressionNamespaces = ["pages", "instances", "dataSources"] as const;
const instanceReadNamespaces = ["pages", "instances", "props"] as const;
const styleNamespaces = [
"styles",
@@ -440,7 +441,7 @@ export const builderRuntimeOperations = [
"pages.create",
api("create-page", "createPage"),
mutationContract({
- readNamespaces: ["pages"],
+ readNamespaces: pageExpressionNamespaces,
writeNamespaces: pageNamespaces,
}),
pages.pageCreateInput,
@@ -450,7 +451,7 @@ export const builderRuntimeOperations = [
"pages.update",
api("update-page", "updatePage"),
mutationContract({
- readNamespaces: ["pages"],
+ readNamespaces: pageExpressionNamespaces,
writeNamespaces: ["pages"],
retryOnConflict: true,
}),
@@ -461,7 +462,7 @@ export const builderRuntimeOperations = [
"pages.updateSettings",
api("update-page-settings", "updatePageSettings"),
mutationContract({
- readNamespaces: ["pages"],
+ readNamespaces: pageExpressionNamespaces,
writeNamespaces: ["pages"],
retryOnConflict: true,
}),