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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
Add root instance id to page schema (#1142)
Bogdan Chadkindf4c2e0384fc
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsxindex 5381783ad2..38258d0180 100644--- a/apps/builder/app/canvas/canvas.tsx+++ b/apps/builder/app/canvas/canvas.tsx@@ -32,6 +32,7 @@ import {useSubscribeScrollState,useIsPreviewMode,useSetAssets,+ useSetSelectedPage,} from "~/shared/nano-states";import { usePublishScrollState } from "./shared/use-publish-scroll-state";import { useDragAndDrop } from "./shared/use-drag-drop";@@ -107,6 +108,7 @@ export const Canvas = ({useSetStyleSources(data.build.styleSources);useSetStyleSourceSelections(data.build.styleSourceSelections);useSetInstances(data.tree.instances);+ useSetSelectedPage(data.page);setParams(data.params ?? null);useCanvasStore(publish);const [isPreviewMode] = useIsPreviewMode();@@ -120,7 +122,7 @@ export const Canvas = ({useSharedShortcuts();useEffect(() => {- const rootInstanceId = data.tree?.instances[0]?.[0];+ const rootInstanceId = data.page.rootInstanceId;if (rootInstanceId !== undefined) {setDataCollapsed(rootInstanceId);}diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.tsindex a439bc100e..cc77e10c5e 100644--- a/apps/builder/app/shared/nano-states/nano-states.ts+++ b/apps/builder/app/shared/nano-states/nano-states.ts@@ -11,6 +11,7 @@ import type {Instance,Instances,InstancesItem,+ Page,Prop,Props,StyleDecl,@@ -39,6 +40,13 @@ const useValue = <T>(atom: WritableAtom<T>) => {return [value, atom.set] as const;};+export const selectedPageStore = atom<undefined | Page>(undefined);+export const useSetSelectedPage = (page: Page) => {+ useSyncInitializeOnce(() => {+ selectedPageStore.set(page);+ });+};+export const instancesStore = atom<Map<InstancesItem["id"], InstancesItem>>(new Map());@@ -89,7 +97,10 @@ export const patchInstancesMutable = (}};-const denormalizeTree = (instances: Instances): undefined | Instance => {+const denormalizeTree = (+ instances: Instances,+ rootInstanceId: Instance["id"]+): undefined | Instance => {const convertTree = (instance: InstancesItem) => {const legacyInstance: Instance = {type: "instance",@@ -109,16 +120,22 @@ const denormalizeTree = (instances: Instances): undefined | Instance => {}return legacyInstance;};- const rootInstance = Array.from(instances.values())[0];+ const rootInstance = instances.get(rootInstanceId);if (rootInstance === undefined) {return;}return convertTree(rootInstance);};-export const rootInstanceContainer = computed(instancesStore, (instances) => {- return denormalizeTree(instances);-});+export const rootInstanceContainer = computed(+ [instancesStore, selectedPageStore],+ (instances, selectedPage) => {+ if (selectedPage === undefined) {+ return undefined;+ }+ return denormalizeTree(instances, selectedPage.rootInstanceId);+ }+);export const useRootInstance = () => {const value = useStore(rootInstanceContainer);return [value] as const;diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.tsindex 236badb937..c4fd1b607c 100644--- a/apps/builder/app/shared/sync/sync-stores.ts+++ b/apps/builder/app/shared/sync/sync-stores.ts@@ -11,6 +11,7 @@ import {styleSourcesStore,styleSourceSelectionsStore,assetContainersStore,+ selectedPageStore,selectedInstanceIdStore,selectedInstanceBrowserStyleStore,hoveredInstanceIdStore,@@ -55,6 +56,7 @@ export const registerContainers = () => {store.register("props", propsStore);// synchronize whole statesclientStores.set("assetContainers", assetContainersStore);+ clientStores.set("selectedPage", selectedPageStore);clientStores.set("selectedInstanceId", selectedInstanceIdStore);clientStores.set("selectedInstanceBrowserStyle",diff --git a/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/migration.ts b/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/migration.tsnew file mode 100644index 0000000000..21ad9cdf39--- /dev/null+++ b/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/migration.ts@@ -0,0 +1,117 @@+import { PrismaClient } from "./client";++type InstanceId = string;+type BuildId = string;+type TreeId = string;++type Instance = {+ id: InstanceId;+};++type Page = {+ id: string;+ treeId: TreeId;+ rootInstanceId: InstanceId;+};++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) => {+ let rootInstanceIdByBuildId = new Map<+ `${BuildId}:${TreeId}`,+ InstanceId+ >();++ const chunkSize = 1000;+ let cursor: undefined | { id: string; projectId: string } = undefined;+ let hasNext = true;+ while (hasNext) {+ const trees = await prisma.tree.findMany({+ take: chunkSize,+ orderBy: {+ id: "asc",+ },+ ...(cursor+ ? {+ skip: 1, // Skip the cursor+ cursor: { id_projectId: cursor },+ }+ : null),+ });+ const lastTree = trees.at(-1);+ if (lastTree) {+ cursor = { id: lastTree.id, projectId: lastTree?.projectId };+ }+ hasNext = trees.length === chunkSize;++ for (const tree of trees) {+ try {+ const instances: Instance[] = JSON.parse(tree.instances);+ const rootInstanceId = instances[0].id;+ rootInstanceIdByBuildId.set(+ `${tree.buildId}:${tree.id}`,+ rootInstanceId+ );+ } catch {+ console.info(`Tree ${tree.id} cannot be converted`);+ }+ }+ }++ cursor = undefined;+ hasNext = true;+ while (hasNext) {+ const builds = await prisma.build.findMany({+ take: chunkSize,+ orderBy: {+ id: "asc",+ },+ ...(cursor+ ? {+ skip: 1, // Skip the cursor+ cursor: { id_projectId: cursor },+ }+ : null),+ });+ const lastBuild = builds.at(-1);+ if (lastBuild) {+ cursor = { id: lastBuild.id, projectId: lastBuild.projectId };+ }+ hasNext = builds.length === chunkSize;++ for (const build of builds) {+ const { homePage, pages }: Pages = JSON.parse(build.pages);+ homePage.rootInstanceId = rootInstanceIdByBuildId.get(+ `${build.id}:${homePage.treeId}`+ ) as string;+ for (const page of pages) {+ page.rootInstanceId = rootInstanceIdByBuildId.get(+ `${build.id}:${page.treeId}`+ ) as string;+ }+ build.pages = JSON.stringify({ homePage, pages });+ }++ await Promise.all(+ builds.map(({ id, projectId, pages }) =>+ prisma.build.update({+ where: { id_projectId: { id, projectId } },+ data: { pages },+ })+ )+ );+ }+ },+ { timeout: 1000 * 60 * 8 }+ );+};diff --git a/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/schema.prisma b/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/schema.prismanew file mode 100644index 0000000000..4506a47076--- /dev/null+++ b/packages/prisma-client/prisma/migrations/20230228161419_page_root_instance_id/schema.prisma@@ -0,0 +1,144 @@+// 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", "clientExtensions"]+ output = "client"+}++datasource db {+ provider = "postgres"+ url = env("DATABASE_URL")+}++model Team {+ id String @id @default(uuid())+ users User[]+}++enum Location {+ FS+ REMOTE+}++enum UploadStatus {+ UPLOADING+ UPLOADED+}++model Asset {+ id String @default(uuid()) // not unique!+ projectId String+ format String+ size Int+ name String+ description String?+ location Location+ createdAt DateTime @default(now())+ meta String @default("{}")+ status UploadStatus @default(UPLOADED)++ @@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[]+}++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[]+ trees Tree[]+ isDeleted Boolean @default(false)++ @@unique([id, isDeleted])+ @@unique([domain, isDeleted])+}++model Build {+ id String @default(uuid())+ createdAt DateTime @default(now())+ pages String++ project Project @relation(fields: [projectId], references: [id])+ projectId String+ trees Tree[]++ isDev Boolean // exctly one is true per project+ isProd Boolean // at most one is true per project (none if not published)++ breakpoints String @default("[]")+ styles String @default("[]")+ styleSources String @default("[]")+ styleSourceSelections String @default("[]")+ props String @default("[]")++ @@id([id, projectId])+}++model Tree {+ id String @default(uuid())+ project Project @relation(fields: [projectId], references: [id])+ projectId String+ build Build @relation(fields: [buildId, projectId], references: [id, projectId])+ buildId String+ root String+ instances String @default("[]")+ props String @default("[]")+ styles String @default("[]")+ styleSelections String @default("[]")++ @@id([id, projectId])+}++model Breakpoints {+ buildId String @id+ values String @default("[]")+}++enum AuthorizationRelation {+ viewers+ editors+ builders+}++model AuthorizationToken {+ token String @default(uuid())+ // No relation to Project, as the Authorization system is not tied to a project+ projectId String+ name String @default("")+ relation AuthorizationRelation @default(viewers)+ createdAt DateTime @default(now())++ @@id([token, projectId])+}++// Dashboard+view DashboardProject {+ id String @id @default(uuid())+ createdAt DateTime @default(now())+ title String+ domain String+ userId String?+ isDeleted Boolean @default(false)+ isPublished Boolean+}diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.tsindex 68d53649ba..48517333b6 100644--- a/packages/project-build/src/db/build.ts+++ b/packages/project-build/src/db/build.ts@@ -7,7 +7,7 @@ import {} from "@webstudio-is/prisma-client";import type { AppContext } from "@webstudio-is/trpc-interface";import { findPageByIdOrPath } from "../shared/pages-utils";-import type { Build } from "../types";+import type { Build, Tree } from "../types";import { type Page, Pages } from "../schema/pages";import {createInitialBreakpoints,@@ -21,12 +21,7 @@ import {serializeStyleSourceSelections,} from "./style-source-selections";import { parseProps, serializeProps } from "./props";-import {- cloneTree,- createNewTreeData,- createTree,- deleteTreeById,-} from "./tree";+import { cloneTree, createTree, deleteTreeById } from "./tree";const parseBuild = async (build: DbBuild): Promise<Build> => {const pages = Pages.parse(JSON.parse(build.pages));@@ -120,6 +115,21 @@ const updatePages = async (return parseBuild(updatedBuild);};+const createNewPageInstances = (): Tree["instances"] => {+ const instanceId = nanoid();+ return [+ [+ instanceId,+ {+ type: "instance",+ id: instanceId,+ component: "Body",+ children: [],+ },+ ],+ ];+};+export const addPage = async ({projectId,buildId,@@ -131,7 +141,13 @@ export const addPage = async ({Partial<Omit<Page, "id" | "treeId" | "name" | "path">>;}) => {return updatePages({ projectId, buildId }, async (currentPages) => {- const tree = await createTree(createNewTreeData({ projectId, buildId }));+ const instances = createNewPageInstances();+ const [rootInstanceId] = instances[0];+ const tree = await createTree({+ projectId,+ buildId,+ instances,+ });return {homePage: currentPages.homePage,@@ -140,6 +156,7 @@ export const addPage = async ({{id: nanoid(),treeId: tree.id,+ rootInstanceId,name: data.name,path: data.path,title: data.title ?? data.name,@@ -170,6 +187,7 @@ export const editPage = async ({const updatedPage: Page = {id: currentPage.id,treeId: currentPage.treeId,+ rootInstanceId: currentPage.rootInstanceId,name: data.name ?? currentPage.name,path: data.path ?? currentPage.path,title: data.title ?? currentPage.title,@@ -224,8 +242,14 @@ const createPages = async (_context: AppContext,client: Prisma.TransactionClient = prisma) => {+ const instances = createNewPageInstances();+ const [rootInstanceId] = instances[0];const tree = await createTree(- createNewTreeData({ projectId, buildId }),+ {+ projectId,+ buildId,+ instances,+ },client);return Pages.parse({@@ -236,9 +260,10 @@ const createPages = async (title: "Home",meta: {},treeId: tree.id,+ rootInstanceId,},pages: [],- });+ } satisfies Pages);};const clonePage = async (@@ -276,7 +301,7 @@ const clonePages = async (client),pages: clones,- });+ } satisfies Pages);};/*diff --git a/packages/project-build/src/db/tree.ts b/packages/project-build/src/db/tree.tsindex 228de70653..9d33105e0d 100644--- a/packages/project-build/src/db/tree.ts+++ b/packages/project-build/src/db/tree.ts@@ -1,4 +1,3 @@-import { nanoid } from "nanoid";import { v4 as uuid } from "uuid";import { type Project, type Prisma, prisma } from "@webstudio-is/prisma-client";import type { AppContext } from "@webstudio-is/trpc-interface/server";@@ -7,32 +6,6 @@ import { parseInstances, serializeInstances } from "./instances";type TreeData = Omit<Tree, "id">;-export const createNewTreeData = ({- projectId,- buildId,-}: {- projectId: string;- buildId: string;-}): TreeData => {- const instanceId = nanoid();-- return {- projectId,- buildId,- instances: [- [- instanceId,- {- type: "instance",- id: instanceId,- component: "Body",- children: [],- },- ],- ],- };-};-export const createTree = async (treeData: TreeData,client: Prisma.TransactionClient = prismadiff --git a/packages/project-build/src/schema/pages.ts b/packages/project-build/src/schema/pages.tsindex dfc25e31e5..80ecf4b078 100644--- a/packages/project-build/src/schema/pages.ts+++ b/packages/project-build/src/schema/pages.ts@@ -15,6 +15,7 @@ const commonPageFields = {title: Title,meta: z.record(z.string(), z.string()),treeId: z.string(),+ rootInstanceId: z.string(),} as const;const HomePage = z.object({diff --git a/packages/project-build/src/shared/pages-utils.test.ts b/packages/project-build/src/shared/pages-utils.test.tsindex 3ad01ee540..c25d2c2d7c 100644--- a/packages/project-build/src/shared/pages-utils.test.ts+++ b/packages/project-build/src/shared/pages-utils.test.ts@@ -1,4 +1,5 @@import { describe, test, expect } from "@jest/globals";+import type { Page } from "../schema/pages";import { findPageByIdOrPath } from "./pages-utils";const pages = {@@ -8,8 +9,9 @@ const pages = {name: "Home",title: "Home",treeId: "tree-1",+ rootInstanceId: "instance-1",meta: {},- },+ } satisfies Page,pages: [{id: "page1",@@ -17,8 +19,9 @@ const pages = {name: "Page",title: "Page",treeId: "tree-1",+ rootInstanceId: "instance-1",meta: {},- },+ } satisfies Page,],};diff --git a/packages/project/src/shared/schema.ts b/packages/project/src/shared/schema.tsindex e693f74543..a027c1cf66 100644--- a/packages/project/src/shared/schema.ts+++ b/packages/project/src/shared/schema.ts@@ -1,6 +1,6 @@import { z } from "zod";import type { Data } from "@webstudio-is/react-sdk";-import type { Build, Page } from "@webstudio-is/project-build";+import type { Build } from "@webstudio-is/project-build";const MIN_TITLE_LENGTH = 2;@@ -25,7 +25,5 @@ export const Projects = z.array(Project);export type Projects = z.infer<typeof Projects>;export type CanvasData = Data & {- build: null | Build;buildId: Build["id"];- page: Page;};diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.tsindex ff91f84de5..77714439f3 100644--- a/packages/react-sdk/src/tree/root.ts+++ b/packages/react-sdk/src/tree/root.ts@@ -5,6 +5,7 @@ import type {Instance,Instances,InstancesItem,+ Page,Tree,} from "@webstudio-is/project-build";import type { Asset } from "@webstudio-is/asset-uploader";@@ -17,6 +18,7 @@ import { getPropsByInstanceId } from "../props";import type { GetComponent } from "../components/components-utils";export type Data = {+ page: Page;tree: Tree | null;build: Build | null;assets: Array<Asset>;@@ -30,7 +32,10 @@ type RootProps = {getComponent: GetComponent;};-const denormalizeTree = (instances: Instances) => {+const denormalizeTree = (+ instances: Instances,+ rootInstanceId: Instance["id"]+) => {const convertTree = (instance: InstancesItem) => {const legacyInstance: Instance = {type: "instance",@@ -50,7 +55,11 @@ const denormalizeTree = (instances: Instances) => {}return legacyInstance;};- return convertTree(Array.from(instances.values())[0]);+ const rootInstance = instances.get(rootInstanceId);+ if (rootInstance === undefined) {+ return undefined;+ }+ return convertTree(rootInstance);};export const InstanceRoot = ({@@ -66,9 +75,15 @@ export const InstanceRoot = ({setParams(data.params ?? null);registerComponents(customComponents);-+ const instance = denormalizeTree(+ new Map(data.tree.instances),+ data.page.rootInstanceId+ );+ if (instance === undefined) {+ return null;+ }return createElementsTree({- instance: denormalizeTree(new Map(data.tree.instances)),+ instance,propsByInstanceIdStore: atom(getPropsByInstanceId(new Map(data.build.props))),