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.

experimental: add system variable (#2997)

Bogdan Chadkin39ee44b94ed6
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
index 29207c1843..930e50eaf3 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
@@ -1,5 +1,5 @@
import { useState } from "react";
-import type { Instance, Prop, Asset } from "@webstudio-is/sdk";
+import type { Instance, Prop, Asset, Page } from "@webstudio-is/sdk";
import type { PropMeta } from "@webstudio-is/react-sdk";
import { textVariants } from "@webstudio-is/design-system";
import { PropsSection } from "./props-section";
@@ -25,17 +25,21 @@ const unique = () => `${++id}`;
const instanceId = unique();
const projectId = unique();
-const page = (name: string, path: string) => ({
+const page = (name: string, path: string): Page => ({
id: unique(),
name,
title: name,
path,
meta: {},
rootInstanceId: unique(),
+ systemDataSourceId: unique(),
});
$pages.set({
- ...createDefaultPages({ rootInstanceId: unique() }),
+ ...createDefaultPages({
+ rootInstanceId: unique(),
+ systemDataSourceId: unique(),
+ }),
homePage: page("Home", "/"),
pages: [
page("About", "/about"),
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
index d9b5fd8b2e..ecbee4b99d 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
@@ -23,7 +23,9 @@ $instances.set(
])
);
$selectedPageId.set("home");
-$pages.set(createDefaultPages({ rootInstanceId: "root" }));
+$pages.set(
+ createDefaultPages({ rootInstanceId: "root", systemDataSourceId: "system" })
+);
export const VariablesSection: StoryObj = {
render: () => (
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
index eab6d67735..44a4cbfb3e 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.stories.tsx
@@ -41,7 +41,10 @@ $assets.set(
])
);
-const pages = createDefaultPages({ rootInstanceId: "root-instance-id" });
+const pages = createDefaultPages({
+ rootInstanceId: "root-instance-id",
+ systemDataSourceId: "systemDataSourceId",
+});
pages.meta = {
siteName: "Project name",
faviconAssetId: "imageId",
@@ -54,6 +57,7 @@ pages.pages.push({
name: "page-name",
meta: {},
rootInstanceId: "root-instance-id",
+ systemDataSourceId: "systemDataSourceId",
});
const rootFolder = pages.folders.find(isRoot);
rootFolder?.children.push("pageId");
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
index f16c8dce17..3edc1dc935 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
@@ -1191,18 +1191,20 @@ const NewPageSettingsView = ({
const createPage = (pageId: Page["id"], values: Values) => {
serverSyncStore.createTransaction(
- [$pages, $instances],
- (pages, instances) => {
+ [$pages, $instances, $dataSources],
+ (pages, instances, dataSources) => {
if (pages === undefined) {
return;
}
const rootInstanceId = nanoid();
+ const systemDataSourceId = nanoid();
pages.pages.push({
id: pageId,
name: values.name,
path: values.path,
title: values.title,
rootInstanceId,
+ systemDataSourceId,
meta: {},
});
@@ -1212,6 +1214,12 @@ const createPage = (pageId: Page["id"], values: Values) => {
component: "Body",
children: [],
});
+ dataSources.set(systemDataSourceId, {
+ id: systemDataSourceId,
+ scopeInstanceId: rootInstanceId,
+ name: "system",
+ type: "parameter",
+ });
registerFolderChildMutable(pages.folders, pageId, values.parentFolderId);
$selectedInstanceSelector.set(undefined);
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
index f83cdebb90..5b57003dcd 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
@@ -1,7 +1,7 @@
import { describe, expect, test } from "@jest/globals";
import type { Project } from "@webstudio-is/project";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { isRoot, type Folder, Instance } from "@webstudio-is/sdk";
+import { isRoot, type Folder, Instance, DataSource } from "@webstudio-is/sdk";
import {
cleanupChildRefsMutable,
deleteFolderWithChildrenMutable,
@@ -37,6 +37,7 @@ describe("toTreeData", () => {
test("initial pages always has home pages and a root folder", () => {
const pages = createDefaultPages({
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
const tree = toTreeData(pages);
@@ -53,6 +54,7 @@ describe("toTreeData", () => {
name: "Home",
path: "",
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
id: "homePageId",
@@ -65,6 +67,7 @@ describe("toTreeData", () => {
test("add empty folder", () => {
const pages = createDefaultPages({
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
pages.folders.push({
@@ -89,6 +92,7 @@ describe("toTreeData", () => {
name: "Home",
path: "",
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
id: "homePageId",
@@ -108,6 +112,7 @@ describe("toTreeData", () => {
test("add a page inside a folder", () => {
const pages = createDefaultPages({
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
pages.pages.push({
@@ -116,6 +121,7 @@ describe("toTreeData", () => {
name: "Page",
path: "/page",
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
title: `"Page"`,
});
pages.folders.push({
@@ -141,6 +147,7 @@ describe("toTreeData", () => {
name: "Home",
path: "",
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
id: "homePageId",
@@ -161,6 +168,7 @@ describe("toTreeData", () => {
name: "Page",
path: "/page",
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
title: `"Page"`,
},
},
@@ -173,6 +181,7 @@ describe("toTreeData", () => {
test("nest a folder", () => {
const pages = createDefaultPages({
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
const rootFolder = pages.folders.find(isRoot);
@@ -206,6 +215,7 @@ describe("toTreeData", () => {
title: `"Home"`,
meta: {},
rootInstanceId: "id",
+ systemDataSourceId: "systemDataSourceId",
},
},
{
@@ -234,6 +244,7 @@ describe("reparentOrphansMutable", () => {
test("reparent orphans to the root", () => {
const pages = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
pages.pages.push({
@@ -242,6 +253,7 @@ describe("reparentOrphansMutable", () => {
name: "Page",
path: "/page",
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
title: `"Page"`,
});
pages.folders.push({
@@ -265,6 +277,7 @@ describe("cleanupChildRefsMutable", () => {
test("cleanup refs", () => {
const { folders } = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
folders.push({
@@ -288,6 +301,7 @@ describe("cleanupChildRefsMutable", () => {
describe("isSlugUsed", () => {
const { folders } = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
folders.push({
@@ -333,6 +347,7 @@ describe("registerFolderChildMutable", () => {
test("register a folder child in the root via fallback", () => {
const { folders } = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
registerFolderChildMutable(folders, "folderId");
@@ -343,6 +358,7 @@ describe("registerFolderChildMutable", () => {
test("register a folder child in a provided folder", () => {
const { folders } = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
const folder = {
@@ -359,6 +375,7 @@ describe("registerFolderChildMutable", () => {
test("register in a provided folder & cleanup old refs", () => {
const { folders } = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
const folder = {
@@ -486,6 +503,7 @@ describe("filterSelfAndChildren", () => {
describe("getExistingRoutePaths", () => {
const pages = createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
});
@@ -496,6 +514,7 @@ describe("getExistingRoutePaths", () => {
name: "Page",
path: "/page",
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
title: `"Page"`,
});
@@ -505,6 +524,7 @@ describe("getExistingRoutePaths", () => {
name: "Blog",
path: "/blog/:id",
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
title: `"Blog"`,
});
@@ -516,9 +536,21 @@ describe("getExistingRoutePaths", () => {
describe("duplicate page", () => {
$project.set({ id: "projectId" } as Project);
- test("home page with new root instance", () => {
+ test("home page with new root instance and system data source", () => {
$instances.set(
- toMap([{ type: "instance", id: "body", component: "Body", children: [] }])
+ toMap<Instance>([
+ { type: "instance", id: "body", component: "Body", children: [] },
+ ])
+ );
+ $dataSources.set(
+ toMap<DataSource>([
+ {
+ id: "system",
+ scopeInstanceId: "body",
+ name: "system",
+ type: "parameter",
+ },
+ ])
);
$pages.set({
homePage: {
@@ -528,19 +560,42 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
+ systemDataSourceId: "system",
},
pages: [],
folders: [],
});
duplicatePage("pageId");
- expect($pages.get()?.pages[0]).toEqual({
+ const newPage = $pages.get()?.pages[0];
+ if (newPage === undefined) {
+ throw Error("New page does not exist");
+ }
+ expect(newPage).toEqual({
id: expect.not.stringMatching("pageId"),
name: "My Name (1)",
path: "/copy-1",
title: `"My Title"`,
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
+ systemDataSourceId: expect.not.stringMatching("system"),
});
+ expect($dataSources.get()).toEqual(
+ toMap<DataSource>([
+ {
+ id: "system",
+ scopeInstanceId: "body",
+ name: "system",
+ type: "parameter",
+ },
+ {
+ // @todo remove cast after releasing system variable migration
+ id: newPage.systemDataSourceId!,
+ scopeInstanceId: newPage.rootInstanceId,
+ name: "system",
+ type: "parameter",
+ },
+ ])
+ );
expect($instances.get()).toEqual(
toMap<Instance>([
{
@@ -551,7 +606,7 @@ describe("duplicate page", () => {
},
{
type: "instance",
- id: expect.not.stringMatching("body") as unknown as string,
+ id: newPage.rootInstanceId,
component: "Body",
children: [],
},
@@ -571,6 +626,7 @@ describe("duplicate page", () => {
title: `"Home"`,
meta: {},
rootInstanceId: "home",
+ systemDataSourceId: "homeSystem",
},
pages: [
{
@@ -580,6 +636,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
+ systemDataSourceId: "pageSystem",
},
],
folders: [],
@@ -607,6 +664,7 @@ describe("duplicate page", () => {
title: `"Home"`,
meta: {},
rootInstanceId: "home",
+ systemDataSourceId: "system",
},
pages: [
{
@@ -616,6 +674,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
+ systemDataSourceId: "system",
},
{
id: "pageId2",
@@ -625,6 +684,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
+ systemDataSourceId: "system",
},
],
folders: [],
@@ -638,6 +698,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
+ systemDataSourceId: expect.not.stringMatching("system"),
});
expect($pages.get()?.pages[3]).toEqual({
id: expect.not.stringMatching("pageId2"),
@@ -646,6 +707,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
+ systemDataSourceId: expect.not.stringMatching("system"),
});
});
@@ -661,6 +723,7 @@ describe("duplicate page", () => {
title: `"Home"`,
meta: {},
rootInstanceId: "home",
+ systemDataSourceId: "system",
},
pages: [
{
@@ -670,6 +733,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: "body",
+ systemDataSourceId: "system",
},
],
folders: [
@@ -689,6 +753,7 @@ describe("duplicate page", () => {
title: `"My Title"`,
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
+ systemDataSourceId: expect.not.stringMatching("system"),
});
});
@@ -725,6 +790,7 @@ describe("duplicate page", () => {
],
},
rootInstanceId: "body",
+ systemDataSourceId: "system",
},
pages: [],
folders: [],
@@ -750,6 +816,7 @@ describe("duplicate page", () => {
],
},
rootInstanceId: expect.not.stringMatching("body"),
+ systemDataSourceId: expect.not.stringMatching("system"),
});
});
@@ -776,6 +843,7 @@ describe("duplicate page", () => {
meta: {},
rootInstanceId: "body",
pathParamsDataSourceId: "pathParamsId",
+ systemDataSourceId: "system",
},
pages: [],
folders: [],
@@ -791,6 +859,7 @@ describe("duplicate page", () => {
meta: {},
rootInstanceId: expect.not.stringMatching("body"),
pathParamsDataSourceId: newDataSource.id,
+ systemDataSourceId: expect.not.stringMatching("system"),
});
});
});
@@ -799,6 +868,7 @@ test("page root scope should rely on editing page", () => {
const pages = createDefaultPages({
rootInstanceId: "homeRootId",
homePageId: "homePageId",
+ systemDataSourceId: "system",
});
pages.pages.push({
id: "pageId",
@@ -807,6 +877,7 @@ test("page root scope should rely on editing page", () => {
path: "/",
title: `"My Title"`,
meta: {},
+ systemDataSourceId: "system",
});
$pages.set(pages);
$selectedPageId.set("homePageId");
@@ -841,6 +912,7 @@ test("page root scope should use variable and resource values", () => {
createDefaultPages({
rootInstanceId: "homeRootId",
homePageId: "homePageId",
+ systemDataSourceId: "system",
})
);
$editingPagesItemId.set("homePageId");
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
index e8f5e5e53b..683b6c8503 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
@@ -432,6 +432,12 @@ export const duplicatePage = (pageId: Page["id"]) => {
page.pathParamsDataSourceId === undefined
? undefined
: newDataSourceIds.get(page.pathParamsDataSourceId);
+ // @todo simplify after releasing migration with system variable
+ const newSystemDataSourceId =
+ page.systemDataSourceId === undefined
+ ? undefined
+ : newDataSourceIds.get(page.systemDataSourceId);
+
if (newRootInstanceId === undefined) {
return;
}
@@ -440,6 +446,8 @@ export const duplicatePage = (pageId: Page["id"]) => {
id: newPageId,
rootInstanceId: newRootInstanceId,
pathParamsDataSourceId: newPathParamsDataSourceId,
+ systemDataSourceId: newSystemDataSourceId,
+ // @todo create new data source
name: newName,
path: deduplicatePath(pages, page),
title: replaceDataSources(page.title, newDataSourceIds),
diff --git a/apps/builder/app/builder/shared/commands.test.ts b/apps/builder/app/builder/shared/commands.test.ts
index b96f867930..6bd54e628e 100644
--- a/apps/builder/app/builder/shared/commands.test.ts
+++ b/apps/builder/app/builder/shared/commands.test.ts
@@ -23,7 +23,7 @@ const createInstancePair = (
const metas = new Map(Object.entries(baseMetas));
-$pages.set(createDefaultPages({ rootInstanceId: "" }));
+$pages.set(createDefaultPages({ rootInstanceId: "", systemDataSourceId: "" }));
describe("deleteInstance", () => {
// body
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
index fbf3e75cb7..4f62fe9c1d 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
@@ -40,7 +40,11 @@ $registeredComponentMetas.set(
);
$project.set({ id: "my-project" } as Project);
$pages.set(
- createDefaultPages({ homePageId: "home-page", rootInstanceId: "body0" })
+ createDefaultPages({
+ homePageId: "home-page",
+ rootInstanceId: "body0",
+ systemDataSourceId: "",
+ })
);
$selectedPageId.set("home-page");
diff --git a/apps/builder/app/shared/instance-utils.test.ts b/apps/builder/app/shared/instance-utils.test.ts
index c7838a277a..3eff13fcdf 100644
--- a/apps/builder/app/shared/instance-utils.test.ts
+++ b/apps/builder/app/shared/instance-utils.test.ts
@@ -56,7 +56,7 @@ import { createDefaultPages } from "@webstudio-is/project-build";
enableMapSet();
registerContainers();
-$pages.set(createDefaultPages({ rootInstanceId: "" }));
+$pages.set(createDefaultPages({ rootInstanceId: "", systemDataSourceId: "" }));
const defaultMetasMap = new Map(Object.entries(defaultMetas));
$registeredComponentMetas.set(defaultMetasMap);
@@ -973,7 +973,7 @@ describe("reparent instance", () => {
const getWebstudioDataStub = (
data?: Partial<WebstudioData>
): WebstudioData => ({
- pages: createDefaultPages({ rootInstanceId: "" }),
+ pages: createDefaultPages({ rootInstanceId: "", systemDataSourceId: "" }),
assets: new Map(),
dataSources: new Map(),
resources: new Map(),
diff --git a/apps/builder/app/shared/nano-states/props.test.ts b/apps/builder/app/shared/nano-states/props.test.ts
index 9efbd5e628..84db49d3a1 100644
--- a/apps/builder/app/shared/nano-states/props.test.ts
+++ b/apps/builder/app/shared/nano-states/props.test.ts
@@ -40,6 +40,7 @@ const selectPageRoot = (rootInstanceId: Instance["id"]) => {
homePageId: "pageId",
homePagePath: "/my-page",
rootInstanceId,
+ systemDataSourceId: "system",
});
$pages.set(defaultPages);
$selectedPageId.set(defaultPages.homePage.id);
diff --git a/apps/builder/app/shared/nano-states/props.ts b/apps/builder/app/shared/nano-states/props.ts
index 3e5ce0802d..280d0b6c13 100644
--- a/apps/builder/app/shared/nano-states/props.ts
+++ b/apps/builder/app/shared/nano-states/props.ts
@@ -29,6 +29,7 @@ import { groupBy } from "../array-utils";
import type { InstanceSelector } from "../tree-utils";
import { $params } from "~/canvas/stores";
import { restResourcesLoader } from "../router-utils";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
export const getIndexedInstanceId = (
instanceId: Instance["id"],
@@ -344,6 +345,12 @@ export const $variableValuesByInstanceSelector = computed(
const variables = variablesByInstanceId.get(instanceId);
if (variables) {
for (const variable of variables) {
+ if (
+ variable.id === page.systemDataSourceId &&
+ isFeatureEnabled("cms") === false
+ ) {
+ continue;
+ }
if (variable.type === "variable") {
const value = dataSourceVariables.get(variable.id);
variableValues.set(variable.id, value ?? variable.value.value);
diff --git a/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/migration.ts b/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/migration.ts
new file mode 100644
index 0000000000..95df46e695
--- /dev/null
+++ b/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/migration.ts
@@ -0,0 +1,143 @@
+import { nanoid } from "nanoid";
+import { PrismaClient } from "./client";
+
+type DataSource = {
+ type: "parameter";
+ id: string;
+ scopeInstanceId?: string;
+ name: string;
+};
+
+type Page = {
+ id: string;
+ name: string;
+ path: string;
+ title: string;
+ meta: {
+ description?: string;
+ title?: string;
+ excludePageFromSearch?: string;
+ language?: string;
+ socialImageAssetId?: string;
+ socialImageUrl?: string;
+ status?: string;
+ redirect?: string;
+ custom?: Array<{
+ property: string;
+ content: string;
+ }>;
+ };
+ rootInstanceId: string;
+ pathParamsDataSourceId?: string;
+ systemDataSourceId?: string;
+};
+
+type Pages = {
+ homePage: Page;
+ pages: Page[];
+};
+
+export default async () => {
+ const client = new PrismaClient({
+ // Uncomment to see the queries in console as the migration runs
+ // log: ["query", "info", "warn", "error"],
+ });
+
+ await client.$transaction(
+ async (prisma) => {
+ const chunkSize = 1000;
+ let cursor: undefined | string = undefined;
+ let hasNext = true;
+
+ while (hasNext) {
+ console.log("CHUNK", cursor);
+ console.time("read");
+
+ const cursorOptions: {} = cursor
+ ? {
+ skip: 1, // Skip the cursor
+ cursor: { id: cursor },
+ }
+ : {};
+
+ const builds = await prisma.build.findMany({
+ select: {
+ id: true,
+ pages: true,
+ dataSources: true,
+ },
+ take: chunkSize,
+ orderBy: {
+ id: "asc",
+ },
+ //where: { id: "d55ce7ea-6853-40af-8a65-b63b79dde0f9" },
+ ...cursorOptions,
+ });
+ console.timeEnd("read");
+
+ console.time("parse-change");
+ cursor = builds.at(-1)?.id;
+ hasNext = builds.length === chunkSize;
+ const changedBuilds: typeof builds = [];
+
+ for (const build of builds) {
+ const pages: Pages = JSON.parse(build.pages);
+ const dataSources: DataSource[] = JSON.parse(build.dataSources);
+ // Already migrated
+ if (pages.homePage.systemDataSourceId) {
+ continue;
+ }
+ const updatePage = (page: Page) => {
+ const dataSource: DataSource = {
+ id: nanoid(),
+ scopeInstanceId: page.rootInstanceId,
+ name: "system",
+ type: "parameter",
+ };
+ dataSources.push(dataSource);
+ page.systemDataSourceId = dataSource.id;
+ };
+ try {
+ updatePage(pages.homePage);
+ for (const page of pages.pages) {
+ updatePage(page);
+ }
+ build.pages = JSON.stringify(pages);
+ build.dataSources = JSON.stringify(dataSources);
+ changedBuilds.push(build);
+ } catch {
+ console.info(`build ${build.id} cannot be converted`);
+ }
+ }
+
+ if (changedBuilds.length === 0) {
+ return;
+ }
+
+ console.timeEnd("parse-change");
+ console.log("changedBuilds.length", changedBuilds.length);
+ console.time("update");
+
+ const sql = `
+ UPDATE "Build"
+ SET
+ "pages" = data."pages",
+ "dataSources" = data."dataSources"
+ FROM unnest(ARRAY[$1], ARRAY[$2], ARRAY[$3]) as data(id, pages, "dataSources")
+ WHERE "Build"."id" = data."id"
+ `;
+
+ const res = await prisma.$executeRawUnsafe(
+ sql,
+ changedBuilds.map((changedBuild) => changedBuild.id),
+ changedBuilds.map((changedBuild) => changedBuild.pages),
+ changedBuilds.map((changedBuild) => changedBuild.dataSources)
+ );
+
+ console.timeEnd("update");
+ console.log("res", res);
+ }
+ },
+ { timeout: 3600000 }
+ );
+};
diff --git a/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/schema.prisma b/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/schema.prisma
new file mode 100644
index 0000000000..9e871a0f76
--- /dev/null
+++ b/packages/prisma-client/prisma/migrations/20240309212641_page_system_variable/schema.prisma
@@ -0,0 +1,331 @@
+// DO NOT EDIT THIS FILE!
+// This is a copy of your schema.prisma that corresponds to the state of the database
+// when all migrations up until this one are applied.
+// It's used to generate a Prisma Client for the migration.
+
+// This is your Prisma schema file,
+// learn more about it in the docs: https://pris.ly/d/prisma-schema
+
+generator client {
+ provider = "prisma-client-js"
+ previewFeatures = ["views"]
+ // see commands.ts
+ output = "client"
+}
+
+datasource db {
+ provider = "postgres"
+ url = env("DATABASE_URL")
+ directUrl = env("DIRECT_URL")
+}
+
+model Team {
+ id String @id @default(uuid())
+ users User[]
+}
+
+enum UploadStatus {
+ UPLOADING
+ UPLOADED
+}
+
+model File {
+ name String @id
+ format String
+ size Int
+ description String?
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+ meta String @default("{}")
+ status UploadStatus @default(UPLOADING)
+ isDeleted Boolean @default(false)
+ uploaderProject Project? @relation(fields: [uploaderProjectId], references: [id])
+ uploaderProjectId String?
+ assets Asset[]
+}
+
+model Asset {
+ id String @default(uuid()) // not unique!
+ projectId String
+ file File @relation(fields: [name], references: [name])
+ name String
+ Project Project[]
+ DashboardProject DashboardProject[]
+
+ @@id([id, projectId])
+}
+
+model User {
+ id String @id @default(uuid())
+ email String? @unique
+ provider String?
+ image String?
+ username String?
+ createdAt DateTime @default(now())
+ team Team? @relation(fields: [teamId], references: [id])
+ teamId String?
+ projects Project[]
+ clientReferences ClientReferences[]
+ checkout TransactionLog[]
+ products UserProduct[]
+}
+
+// User client references in external services like stripe etc
+model ClientReferences {
+ reference String @default(dbgenerated())
+ service String
+ createdAt DateTime @default(now())
+ user User @relation(fields: [userId], references: [id])
+ userId String
+
+ @@id([userId, service])
+ @@unique([reference, service])
+}
+
+model Product {
+ id String @id
+ name String
+ description String?
+ features String[]
+ images String[]
+ meta Json
+
+ createdAt DateTime @default(now())
+ checkout TransactionLog[]
+ userProducts UserProduct[]
+}
+
+model TransactionLog {
+ // Stripe event id (debug and idempotency purposes)
+ eventId String @id
+ userId String?
+ user User? @relation(fields: [userId], references: [id])
+
+ productId String?
+ product Product? @relation(fields: [productId], references: [id])
+
+ createdAt DateTime @default(now())
+
+ eventData Json? @default(dbgenerated())
+
+ eventType String? @default(dbgenerated())
+ eventCreated Int? @default(dbgenerated())
+
+ // paid
+ status String? @default(dbgenerated())
+
+ customerId String? @default(dbgenerated())
+ customerEmail String? @default(dbgenerated())
+
+ subscriptionId String? @default(dbgenerated())
+
+ // Used for Refund
+ paymentIntent String? @default(dbgenerated())
+
+ @@unique([eventId, productId])
+}
+
+view UserProduct {
+ userId String
+ user User @relation(fields: [userId], references: [id])
+ productId String
+ product Product @relation(fields: [productId], references: [id])
+ // subscriptionId and customerId not null for subscriptions
+ subscriptionId String?
+ customerId String?
+ // Easier to debug
+ customerEmail String?
+
+ @@unique([userId, productId])
+}
+
+model Project {
+ id String @id @default(uuid())
+ createdAt DateTime @default(now())
+ title String
+ domain String @unique
+ user User? @relation(fields: [userId], references: [id])
+ userId String?
+ build Build[]
+ isDeleted Boolean @default(false)
+ files File[]
+ projectDomain ProjectDomain[]
+ latestBuild LatestBuildPerProject?
+ authorizationToken AuthorizationToken[]
+ previewImageAsset Asset? @relation(fields: [previewImageAssetId, id], references: [id, projectId])
+ previewImageAssetId String?
+ marketplaceApprovalStatus MarketplaceApprovalStatus @default(UNLISTED)
+
+ @@unique([id, isDeleted])
+ @@unique([domain, isDeleted])
+ @@unique([id, domain])
+}
+
+enum PublishStatus {
+ PENDING
+ PUBLISHED
+ FAILED
+}
+
+enum MarketplaceApprovalStatus {
+ UNLISTED
+ PENDING
+ APPROVED
+ REJECTED
+}
+
+model Build {
+ id String @unique @default(uuid())
+ version Int @default(0)
+ lastTransactionId String?
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+ pages String
+
+ project Project @relation(fields: [projectId], references: [id])
+ projectId String
+
+ breakpoints String @default("[]")
+ styles String @default("[]")
+ styleSources String @default("[]")
+ styleSourceSelections String @default("[]")
+ props String @default("[]")
+ dataSources String @default("[]")
+ resources String @default("[]")
+ instances String @default("[]")
+ marketplaceProduct String @default("{}")
+
+ deployment String?
+ publishStatus PublishStatus @default(PENDING)
+
+ latestBuildPerProject LatestBuildPerProject?
+
+ @@id([id, projectId])
+}
+
+enum AuthorizationRelation {
+ viewers
+ editors
+ builders
+ administrators
+}
+
+model AuthorizationToken {
+ token String @default(uuid())
+ projectId String
+ project Project @relation(fields: [projectId], references: [id])
+ name String @default("")
+ relation AuthorizationRelation @default(viewers)
+ createdAt DateTime @default(now())
+
+ @@id([token, projectId])
+ @@unique([token])
+}
+
+enum DomainStatus {
+ INITIALIZING
+ ACTIVE
+ ERROR
+ PENDING
+}
+
+// Domains + last known status and last known txtRecord
+// In the future we can update this table using queue, n8n or temporal workflows.
+// As of now updates are done during UI interactions
+model Domain {
+ id String @id @default(uuid())
+ domain String @unique
+ createdAt DateTime @default(now())
+ updatedAt DateTime @default(now()) @updatedAt
+
+ ProjectDomain ProjectDomain[]
+ // Last known txtRecord of the domain (to check domain ownership)
+ txtRecord String?
+ // create, init, pending, active, error
+ status DomainStatus @default(INITIALIZING)
+ // In case of status="error", this will contain the error message
+ error String?
+
+ projectWithDomain ProjectWithDomain[]
+}
+
+model ProjectDomain {
+ projectId String
+ project Project @relation(fields: [projectId], references: [id])
+ domainId String
+ domain Domain @relation(fields: [domainId], references: [id])
+ createdAt DateTime @default(now())
+ // Generated txt record to check domain ownership
+ txtRecord String @unique @default(uuid())
+
+ // CNAME record to point to the domain
+ cname String
+
+ @@id([projectId, domainId])
+ @@index([domainId])
+}
+
+view ProjectWithDomain {
+ projectId String
+
+ domainId String
+ domain Domain @relation(fields: [domainId], references: [id])
+ txtRecord String
+
+ createdAt DateTime
+
+ // CNAME record to point to the domain
+ cname String
+
+ verified Boolean
+ // To count statistics per user
+ userId String?
+
+ // We can deploy on per domain basis, here for each project domain we have latest build
+ latestBuid LatestBuildPerProjectDomain?
+
+ @@id([projectId, domainId])
+}
+
+view LatestBuildPerProjectDomain {
+ domainId String
+ buildId String
+ projectId String
+ projectWithDomain ProjectWithDomain @relation(fields: [projectId, domainId], references: [projectId, domainId])
+
+ isLatestBuild Boolean
+ publishStatus PublishStatus
+ updatedAt DateTime
+
+ @@id([projectId, domainId])
+}
+
+view LatestBuildPerProject {
+ buildId String
+ build Build @relation(fields: [buildId, projectId], references: [id, projectId])
+
+ projectId String
+ domain String
+ project Project @relation(fields: [projectId, domain], references: [id, domain])
+
+ isLatestBuild Boolean
+ publishStatus PublishStatus
+ updatedAt DateTime
+
+ @@id([projectId, domain])
+ @@unique([buildId, projectId])
+}
+
+// Dashboard
+view DashboardProject {
+ id String @id @default(uuid())
+ createdAt DateTime @default(now())
+ title String
+ domain String
+ userId String?
+ previewImageAsset Asset? @relation(fields: [previewImageAssetId, id], references: [id, projectId])
+ previewImageAssetId String?
+ isDeleted Boolean @default(false)
+ isPublished Boolean
+ marketplaceApprovalStatus MarketplaceApprovalStatus @default(UNLISTED)
+}
diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.ts
index d3c317007d..13fff7aa64 100644
--- a/packages/project-build/src/db/build.ts
+++ b/packages/project-build/src/db/build.ts
@@ -199,8 +199,19 @@ export const createBuild = async (
const newInstances = createNewPageInstances();
const [rootInstanceId] = newInstances[0];
+ const systemDataSource: DataSource = {
+ id: nanoid(),
+ scopeInstanceId: rootInstanceId,
+ name: "system",
+ type: "parameter",
+ };
- const defaultPages = Pages.parse(createDefaultPages({ rootInstanceId }));
+ const defaultPages = Pages.parse(
+ createDefaultPages({
+ rootInstanceId,
+ systemDataSourceId: systemDataSource.id,
+ })
+ );
await client.build.create({
data: {
@@ -210,6 +221,9 @@ export const createBuild = async (
new Map(createInitialBreakpoints())
),
instances: serializeData<Instance>(new Map(newInstances)),
+ dataSources: serializeData<DataSource>(
+ new Map([[systemDataSource.id, systemDataSource]])
+ ),
},
});
};
diff --git a/packages/project-build/src/shared/pages-utils.test.ts b/packages/project-build/src/shared/pages-utils.test.ts
index 9882b4008b..317e8c56e6 100644
--- a/packages/project-build/src/shared/pages-utils.test.ts
+++ b/packages/project-build/src/shared/pages-utils.test.ts
@@ -5,6 +5,7 @@ test("createDefaultPages", () => {
expect(
createDefaultPages({
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
homePageId: "homePageId",
})
).toEqual({
@@ -16,6 +17,7 @@ test("createDefaultPages", () => {
title: `"Home"`,
meta: {},
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
},
pages: [],
folders: [
diff --git a/packages/project-build/src/shared/pages-utils.ts b/packages/project-build/src/shared/pages-utils.ts
index 459308f7ba..f5b33ff46e 100644
--- a/packages/project-build/src/shared/pages-utils.ts
+++ b/packages/project-build/src/shared/pages-utils.ts
@@ -1,5 +1,11 @@
-import { type Pages, type Folder, ROOT_FOLDER_ID } from "@webstudio-is/sdk";
import { nanoid } from "nanoid";
+import {
+ type Pages,
+ type Folder,
+ ROOT_FOLDER_ID,
+ Instance,
+ DataSource,
+} from "@webstudio-is/sdk";
export const createRootFolder = (
children: Folder["children"] = []
@@ -12,10 +18,12 @@ export const createRootFolder = (
export const createDefaultPages = ({
rootInstanceId,
+ systemDataSourceId,
homePageId = nanoid(),
homePagePath = "",
}: {
- rootInstanceId: string;
+ rootInstanceId: Instance["id"];
+ systemDataSourceId: DataSource["id"];
homePageId?: string;
homePagePath?: string;
}): Pages => {
@@ -30,6 +38,7 @@ export const createDefaultPages = ({
title: `"Home"`,
meta: {},
rootInstanceId,
+ systemDataSourceId,
},
pages: [],
folders: [rootFolder],
diff --git a/packages/sdk/src/page-utilts.test.ts b/packages/sdk/src/page-utilts.test.ts
index 03d7d3e265..d432db6678 100644
--- a/packages/sdk/src/page-utilts.test.ts
+++ b/packages/sdk/src/page-utilts.test.ts
@@ -14,6 +14,7 @@ const pages = {
name: "Home",
title: "Home",
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
meta: {},
},
pages: [
@@ -23,6 +24,7 @@ const pages = {
name: "Page",
title: "Page",
rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
meta: {},
},
],
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index fc4c2038bf..91ce994d50 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -60,6 +60,8 @@ const commonPageFields = {
}),
rootInstanceId: z.string(),
pathParamsDataSourceId: z.optional(z.string()),
+ // @todo make required after releasing migration
+ systemDataSourceId: z.optional(z.string()),
} as const;
export const HomePagePath = z