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
Patch normalized instances (#1112)
Bogdan Chadkin83a44d9077dc
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsxindex de532334a1..56d35d1f87 100644--- a/apps/builder/app/canvas/canvas.tsx+++ b/apps/builder/app/canvas/canvas.tsx@@ -24,8 +24,8 @@ import {assetsStore,useRootInstance,useSetBreakpoints,+ useSetInstances,useSetProps,- useSetRootInstance,useSetStyles,useSetStyleSources,useSetStyleSourceSelections,@@ -108,7 +108,7 @@ export const Canvas = ({useSetStyles(data.build.styles);useSetStyleSources(data.build.styleSources);useSetStyleSourceSelections(data.tree.styleSourceSelections);- useSetRootInstance(data.tree.root);+ useSetInstances(data.tree.instances);setParams(data.params ?? null);useCanvasStore(publish);const [isPreviewMode] = useIsPreviewMode();diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsxindex 5146e517d1..88b336d4a7 100644--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx@@ -1,5 +1,6 @@import type { MouseEvent, FormEvent } from "react";import { Suspense, lazy, useCallback, useMemo, useRef } from "react";+import { useIsomorphicLayoutEffect } from "react-use";import { useStore } from "@nanostores/react";import { useLexicalComposerContext } from "@lexical/react/LexicalComposerContext";import store from "immerhin";@@ -10,6 +11,8 @@ import {} from "@webstudio-is/react-sdk";import type { GetComponent } from "@webstudio-is/react-sdk";import {+ instancesStore,+ patchInstancesMutable,rootInstanceContainer,selectedInstanceIdStore,useInstanceProps,@@ -145,12 +148,14 @@ export const WebstudioComponentDev = ({/>}onChange={(updates) => {- store.createTransaction([rootInstanceContainer], (rootInstance) => {+ const rootInstance = rootInstanceContainer.get();+ store.createTransaction([instancesStore], (instances) => {const { instancesById } = createInstancesIndex(rootInstance);const instance = instancesById.get(instanceId);if (instance) {instance.children = updates;}+ patchInstancesMutable(rootInstance, instances);});}}onSelectInstance={(instanceId) => {diff --git a/apps/builder/app/routes/rest/patch.ts b/apps/builder/app/routes/rest/patch.tsindex 7ab543b232..1025f3cf01 100644--- a/apps/builder/app/routes/rest/patch.ts+++ b/apps/builder/app/routes/rest/patch.ts@@ -7,7 +7,7 @@ import {patchStyles,patchStyleSources,patchStyleSourceSelections,- patchTree,+ patchInstances,} from "@webstudio-is/project-build/server";import type { Project } from "@webstudio-is/project";import { createContext } from "~/shared/context.server";@@ -41,8 +41,8 @@ export const action = async ({ request }: ActionArgs) => {for await (const change of transaction.changes) {const { namespace, patches } = change;- if (namespace === "root") {- await patchTree({ treeId, projectId }, patches, context);+ if (namespace === "instances") {+ await patchInstances({ treeId, projectId }, patches, context);} else if (namespace === "styleSourceSelections") {await patchStyleSourceSelections({ treeId, projectId },diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.ts b/apps/builder/app/shared/copy-paste/plugin-instance.tsindex 69d2324af7..bcfe5a82f2 100644--- a/apps/builder/app/shared/copy-paste/plugin-instance.ts+++ b/apps/builder/app/shared/copy-paste/plugin-instance.ts@@ -16,6 +16,8 @@ import {styleSourceSelectionsStore,styleSourcesStore,instancesIndexStore,+ instancesStore,+ patchInstancesMutable,} from "../nano-states";import {cloneInstance,@@ -117,15 +119,16 @@ export const onPaste = (clipboardData: string) => {instancesIndexStore.get(),selectedInstanceIdStore.get());+ const rootInstance = rootInstanceContainer.get();store.createTransaction([- rootInstanceContainer,+ instancesStore,propsStore,styleSourceSelectionsStore,styleSourcesStore,stylesStore,],- (rootInstance, props, styleSourceSelections, styleSources, styles) => {+ (instances, props, styleSourceSelections, styleSources, styles) => {const instancesIndex = createInstancesIndex(rootInstance);insertInstanceMutable(instancesIndex, data.instance, dropTarget);for (const prop of data.props) {@@ -143,6 +146,7 @@ export const onPaste = (clipboardData: string) => {for (const styleDecl of data.styles) {styles.set(getStyleDeclKey(styleDecl), styleDecl);}+ patchInstancesMutable(rootInstance, instances);});selectedInstanceIdStore.set(data.instance.id);diff --git a/apps/builder/app/shared/copy-paste/plugin-markdown.ts b/apps/builder/app/shared/copy-paste/plugin-markdown.tsindex d243a0adf3..b1c9454304 100644--- a/apps/builder/app/shared/copy-paste/plugin-markdown.ts+++ b/apps/builder/app/shared/copy-paste/plugin-markdown.ts@@ -12,6 +12,8 @@ import {} from "../tree-utils";import {instancesIndexStore,+ instancesStore,+ patchInstancesMutable,propsStore,rootInstanceContainer,selectedInstanceIdStore,@@ -218,20 +220,19 @@ export const onPaste = (clipboardData: string) => {instancesIndexStore.get(),selectedInstanceIdStore.get());- store.createTransaction(- [rootInstanceContainer, propsStore],- (rootInstance, props) => {- const instancesIndex = createInstancesIndex(rootInstance);- // We are inserting backwards, so we need to reverse the order- data.children.reverse();- for (const child of data.children) {- if (child.type === "instance") {- insertInstanceMutable(instancesIndex, child, dropTarget);- }- }- for (const prop of data.props) {- props.set(prop.id, prop);+ const rootInstance = rootInstanceContainer.get();+ store.createTransaction([instancesStore, propsStore], (instances, props) => {+ const instancesIndex = createInstancesIndex(rootInstance);+ // We are inserting backwards, so we need to reverse the order+ data.children.reverse();+ for (const child of data.children) {+ if (child.type === "instance") {+ insertInstanceMutable(instancesIndex, child, dropTarget);}}- );+ for (const prop of data.props) {+ props.set(prop.id, prop);+ }+ patchInstancesMutable(rootInstance, instances);+ });};diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.tsindex b4093a302e..efcb947f46 100644--- a/apps/builder/app/shared/instance-utils.ts+++ b/apps/builder/app/shared/instance-utils.ts@@ -7,6 +7,8 @@ import {selectedInstanceIdStore,styleSourceSelectionsStore,styleSourcesStore,+ instancesStore,+ patchInstancesMutable,} from "./nano-states";import {createInstancesIndex,@@ -22,9 +24,11 @@ export const insertInstance = (instance: Instance,dropTarget?: DroppableTarget) => {- store.createTransaction([rootInstanceContainer], (rootInstance) => {+ const rootInstance = rootInstanceContainer.get();+ store.createTransaction([instancesStore], (instances) => {const instancesIndex = createInstancesIndex(rootInstance);insertInstanceMutable(instancesIndex, instance, dropTarget);+ patchInstancesMutable(rootInstance, instances);});selectedInstanceIdStore.set(instance.id);};@@ -33,23 +37,26 @@ export const reparentInstance = (targetInstanceId: Instance["id"],dropTarget: DroppableTarget) => {- store.createTransaction([rootInstanceContainer], (rootInstance) => {+ const rootInstance = rootInstanceContainer.get();+ store.createTransaction([instancesStore], (instances) => {const instancesIndex = createInstancesIndex(rootInstance);reparentInstanceMutable(instancesIndex, targetInstanceId, dropTarget);+ patchInstancesMutable(rootInstance, instances);});selectedInstanceIdStore.set(targetInstanceId);};export const deleteInstance = (targetInstanceId: Instance["id"]) => {+ const rootInstance = rootInstanceContainer.get();store.createTransaction([- rootInstanceContainer,+ instancesStore,propsStore,styleSourceSelectionsStore,styleSourcesStore,stylesStore,],- (rootInstance, props, styleSourceSelections, styleSources, styles) => {+ (instances, props, styleSourceSelections, styleSources, styles) => {if (rootInstance === undefined) {return;}@@ -93,6 +100,7 @@ export const deleteInstance = (targetInstanceId: Instance["id"]) => {}selectedInstanceIdStore.set(parentInstance.id);+ patchInstancesMutable(rootInstance, instances);});};diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.tsindex 88eda5bcf6..89e06ac2cf 100644--- a/apps/builder/app/shared/nano-states/nano-states.ts+++ b/apps/builder/app/shared/nano-states/nano-states.ts@@ -1,4 +1,5 @@import { useMemo } from "react";+import deepEqual from "fast-deep-equal";import { atom, computed, type WritableAtom } from "nanostores";import { useStore } from "@nanostores/react";import { nanoid } from "nanoid";@@ -8,6 +9,8 @@ import type {Breakpoint,Breakpoints,Instance,+ Instances,+ InstancesItem,Prop,Props,StyleDecl,@@ -44,13 +47,90 @@ export const useSetTreeId = (treeId: Tree["id"]) => {});};-export const rootInstanceContainer = atom<Instance | undefined>();-export const useRootInstance = () => useValue(rootInstanceContainer);-export const useSetRootInstance = (root: Instance) => {+export const instancesStore = atom<Map<InstancesItem["id"], InstancesItem>>(+ new Map()+);+export const useSetInstances = (+ instances: [InstancesItem["id"], InstancesItem][]+) => {useSyncInitializeOnce(() => {- rootInstanceContainer.set(root);+ instancesStore.set(new Map(instances));});};++/**+ * this is temporary utility to map rootInstance changes+ * to normalized instances+ *+ * later its usages should be rewritten with direct instances mutations+ */+export const patchInstancesMutable = (+ rootInstance: undefined | Instance,+ instances: Instances+) => {+ const oldInstancesIndex = createInstancesIndex(rootInstance);+ const deletedInstanceIds = new Set<Instance["id"]>(instances.keys());+ for (const oldInstance of oldInstancesIndex.instancesById.values()) {+ deletedInstanceIds.delete(oldInstance.id);+ const instance = instances.get(oldInstance.id);+ const convertedOldInstance: InstancesItem = {+ type: "instance",+ id: oldInstance.id,+ component: oldInstance.component,+ children: oldInstance.children.map((child) => {+ if (child.type === "text") {+ return child;+ }+ return {+ type: "id",+ value: child.id,+ };+ }),+ };+ if (deepEqual(convertedOldInstance, instance)) {+ continue;+ }+ instances.set(oldInstance.id, convertedOldInstance);+ }+ for (const deletedId of deletedInstanceIds) {+ instances.delete(deletedId);+ }+};++const denormalizeTree = (instances: Instances): undefined | Instance => {+ const convertTree = (instance: InstancesItem) => {+ const legacyInstance: Instance = {+ type: "instance",+ id: instance.id,+ component: instance.component,+ children: [],+ };+ for (const child of instance.children) {+ if (child.type === "id") {+ const childInstance = instances.get(child.value);+ if (childInstance) {+ legacyInstance.children.push(convertTree(childInstance));+ }+ } else {+ legacyInstance.children.push(child);+ }+ }+ return legacyInstance;+ };+ const rootInstance = Array.from(instances.values())[0];+ if (rootInstance === undefined) {+ return;+ }+ return convertTree(rootInstance);+};++export const rootInstanceContainer = computed(instancesStore, (instances) => {+ return denormalizeTree(instances);+});+export const useRootInstance = () => {+ const value = useStore(rootInstanceContainer);+ return [value] as const;+};export const instancesIndexStore = computed(rootInstanceContainer,createInstancesIndexdiff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.tsindex 20efb15e7c..236badb937 100644--- a/apps/builder/app/shared/sync/sync-stores.ts+++ b/apps/builder/app/shared/sync/sync-stores.ts@@ -4,7 +4,7 @@ import type { WritableAtom } from "nanostores";import { useEffect } from "react";import { type Publish, subscribe } from "~/shared/pubsub";import {- rootInstanceContainer,+ instancesStore,propsStore,breakpointsContainer,stylesStore,@@ -48,7 +48,7 @@ const clientStores = new Map<string, WritableAtom<unknown>>();export const registerContainers = () => {// synchronize patchesstore.register("breakpoints", breakpointsContainer);- store.register("root", rootInstanceContainer);+ store.register("instances", instancesStore);store.register("styles", stylesStore);store.register("styleSources", styleSourcesStore);store.register("styleSourceSelections", styleSourceSelectionsStore);diff --git a/packages/project-build/src/db/instances.ts b/packages/project-build/src/db/instances.tsnew file mode 100644index 0000000000..81b5d8a4d0--- /dev/null+++ b/packages/project-build/src/db/instances.ts@@ -0,0 +1,53 @@+import { applyPatches, type Patch } from "immer";+import { type Project, prisma } from "@webstudio-is/prisma-client";+import {+ authorizeProject,+ type AppContext,+} from "@webstudio-is/trpc-interface/server";+import type { Tree } from "../types";+import { Instances, InstancesList } from "../schema/instances";++export const parseInstances = (instancesString: string): Instances => {+ const instancesList = InstancesList.parse(JSON.parse(instancesString));+ return new Map(instancesList.map((prop) => [prop.id, prop]));+};++export const serializeInstances = (instances: Instances) => {+ const instancesList: InstancesList = Array.from(instances.values());+ return JSON.stringify(instancesList);+};++export const patchInstances = async (+ { treeId, projectId }: { treeId: Tree["id"]; projectId: Project["id"] },+ patches: Array<Patch>,+ context: AppContext+) => {+ const canEdit = await authorizeProject.hasProjectPermit(+ { projectId, permit: "edit" },+ context+ );++ if (canEdit === false) {+ throw new Error("You don't have edit access to this project");+ }++ const tree = await prisma.tree.findUnique({+ where: {+ id_projectId: { projectId, id: treeId },+ },+ });+ if (tree === null) {+ return;+ }+ const instances = parseInstances(tree.instances);+ const patchedInstances = Instances.parse(applyPatches(instances, patches));++ await prisma.tree.update({+ data: {+ instances: serializeInstances(patchedInstances),+ },+ where: {+ id_projectId: { projectId, id: treeId },+ },+ });+};diff --git a/packages/project-build/src/db/tree.ts b/packages/project-build/src/db/tree.tsindex 36cac0d4f1..6e4e07180f 100644--- a/packages/project-build/src/db/tree.ts+++ b/packages/project-build/src/db/tree.ts@@ -1,14 +1,9 @@-import { applyPatches, type Patch } from "immer";import { nanoid } from "nanoid";import { v4 as uuid } from "uuid";-import type { z } from "zod";import { type Project, type Prisma, prisma } from "@webstudio-is/prisma-client";-import {- authorizeProject,- type AppContext,-} from "@webstudio-is/trpc-interface/server";+import type { AppContext } from "@webstudio-is/trpc-interface/server";import type { Tree } from "../types";-import { type InstancesItem, Instance, Instances } from "../schema/instances";+import { parseInstances, serializeInstances } from "./instances";import { parseProps, serializeProps } from "./props";import {parseStyleSourceSelections,@@ -17,24 +12,6 @@ import {type TreeData = Omit<Tree, "id">;-const normalizeTree = (instance: Instance, instances: InstancesItem[]) => {- const instancesItem: InstancesItem = {- type: "instance",- id: instance.id,- component: instance.component,- children: [],- };- instances.push(instancesItem);- for (const child of instance.children) {- if (child.type === "instance") {- normalizeTree(child, instances);- instancesItem.children.push({ type: "id", value: child.id });- } else {- instancesItem.children.push(child);- }- }-};-export const createNewTreeData = ({projectId,buildId,@@ -42,19 +19,22 @@ export const createNewTreeData = ({projectId: string;buildId: string;}): TreeData => {- const root: Instance = {- type: "instance",- id: nanoid(),- component: "Body",- children: [],- };- const instances: Instances = [];- normalizeTree(root, instances);+ const instanceId = nanoid();return {projectId,buildId,- root,+ instances: [+ [+ instanceId,+ {+ type: "instance",+ id: instanceId,+ component: "Body",+ children: [],+ },+ ],+ ],props: [],styleSourceSelections: [],};@@ -64,10 +44,6 @@ export const createTree = async (treeData: TreeData,client: Prisma.TransactionClient = prisma) => {- const root = Instance.parse(treeData.root);- const instances: Instances = [];- normalizeTree(root, instances);-const newTreeId = uuid();return await client.tree.create({@@ -77,7 +53,7 @@ export const createTree = async (buildId: treeData.buildId,root: "",styles: "",- instances: JSON.stringify(instances),+ instances: serializeInstances(new Map(treeData.instances)),props: serializeProps(new Map(treeData.props)),styleSelections: serializeStyleSourceSelections(new Map(treeData.styleSourceSelections)@@ -100,30 +76,6 @@ export const deleteTreeById = async ({});};-const denormalizeTree = (instances: z.infer<typeof Instances>) => {- const instancesMap: Record<string, z.infer<typeof InstancesItem>> = {};- for (const instance of instances) {- instancesMap[instance.id] = instance;- }- const convertTree = (instance: z.infer<typeof InstancesItem>) => {- const legacyInstance: Instance = {- type: "instance",- id: instance.id,- component: instance.component,- children: [],- };- for (const child of instance.children) {- if (child.type === "id") {- legacyInstance.children.push(convertTree(instancesMap[child.value]));- } else {- legacyInstance.children.push(child);- }- }- return legacyInstance;- };- return convertTree(instances[0]);-};-export const loadTreeById = async ({ projectId, treeId }: { projectId: Project["id"]; treeId: Tree["id"] },_context: AppContext,@@ -138,18 +90,17 @@ export const loadTreeById = async (return null;}- const instances = Instances.parse(JSON.parse(tree.instances));- const root = Instance.parse(denormalizeTree(instances));-+ const instances = parseInstances(tree.instances);const props = parseProps(tree.props);-const styleSourceSelections = parseStyleSourceSelections(tree.styleSelections);return {- ...tree,- root,+ id: tree.id,+ projectId: tree.projectId,+ buildId: tree.buildId,+ instances: Array.from(instances),props: Array.from(props),styleSourceSelections: Array.from(styleSourceSelections),};@@ -168,38 +119,3 @@ export const cloneTree = async (return await createTree({ ...tree, ...to }, client);};--export const patchTree = async (- { treeId, projectId }: { treeId: Tree["id"]; projectId: Project["id"] },- patches: Array<Patch>,- context: AppContext-) => {- const canEdit = await authorizeProject.hasProjectPermit(- { projectId, permit: "edit" },- context- );-- if (canEdit === false) {- throw new Error("You don't have edit access to this project");- }-- const tree = await loadTreeById({ projectId, treeId }, context);- if (tree === null) {- throw new Error(`Tree ${treeId} not found`);- }- const clientRoot = applyPatches(tree.root, patches);-- const root = Instance.parse(clientRoot);- const instances: Instances = [];- normalizeTree(root, instances);-- await prisma.tree.update({- data: {- root: "",- instances: JSON.stringify(instances),- },- where: {- id_projectId: { projectId, id: treeId },- },- });-};diff --git a/packages/project-build/src/index.server.ts b/packages/project-build/src/index.server.tsindex dfb19b9db6..3deb2786fa 100644--- a/packages/project-build/src/index.server.ts+++ b/packages/project-build/src/index.server.ts@@ -3,5 +3,6 @@ export * from "./db/breakpoints";export * from "./db/styles";export * from "./db/style-sources";export * from "./db/tree";+export * from "./db/instances";export * from "./db/props";export * from "./db/style-source-selections";diff --git a/packages/project-build/src/schema/instances.ts b/packages/project-build/src/schema/instances.tsindex 7430f3c26f..8288cc33a4 100644--- a/packages/project-build/src/schema/instances.ts+++ b/packages/project-build/src/schema/instances.ts@@ -26,22 +26,28 @@ export const Text = z.object({export type Text = z.infer<typeof Text>;+const InstanceId = z.string();+export const Id = z.object({type: z.literal("id"),- value: z.string(),+ value: InstanceId,});export type Id = z.infer<typeof Id>;export const InstancesItem = z.object({type: z.literal("instance"),- id: z.string(),+ id: InstanceId,component: z.string(),children: z.array(z.union([Id, Text])),});export type InstancesItem = z.infer<typeof InstancesItem>;-export const Instances = z.array(InstancesItem);+export const InstancesList = z.array(InstancesItem);++export type InstancesList = z.infer<typeof InstancesList>;++export const Instances = z.map(InstanceId, InstancesItem);export type Instances = z.infer<typeof Instances>;diff --git a/packages/project-build/src/types.ts b/packages/project-build/src/types.tsindex 6e752494c2..032168bf45 100644--- a/packages/project-build/src/types.ts+++ b/packages/project-build/src/types.ts@@ -2,7 +2,7 @@ import type { Pages } from "./schema/pages";import type { Breakpoint } from "./schema/breakpoints";import type { StyleDecl, StyleDeclKey } from "./schema/styles";import type { StyleSource } from "./schema/style-sources";-import type { Instance } from "./schema/instances";+import type { Instance, InstancesItem } from "./schema/instances";import type { Prop } from "./schema/props";import type { StyleSourceSelection } from "./schema/style-source-selections";@@ -22,7 +22,7 @@ export type Tree = {id: string;projectId: string;buildId: string;- root: Instance;+ instances: [InstancesItem["id"], InstancesItem][];props: [Prop["id"], Prop][];styleSourceSelections: [Instance["id"], StyleSourceSelection][];};diff --git a/packages/react-sdk/src/tree/root.ts b/packages/react-sdk/src/tree/root.tsindex efb70290ae..5b698be4f1 100644--- a/packages/react-sdk/src/tree/root.ts+++ b/packages/react-sdk/src/tree/root.ts@@ -1,6 +1,11 @@import type { ComponentProps } from "react";import { atom } from "nanostores";-import type { Tree } from "@webstudio-is/project-build";+import type {+ Instance,+ Instances,+ InstancesItem,+ Tree,+} from "@webstudio-is/project-build";import type { Asset } from "@webstudio-is/asset-uploader";import { createElementsTree } from "./create-elements-tree";import { WebstudioComponent } from "./webstudio-component";@@ -23,6 +28,29 @@ type RootProps = {getComponent: GetComponent;};+const denormalizeTree = (instances: Instances) => {+ const convertTree = (instance: InstancesItem) => {+ const legacyInstance: Instance = {+ type: "instance",+ id: instance.id,+ component: instance.component,+ children: [],+ };+ for (const child of instance.children) {+ if (child.type === "id") {+ const childInstance = instances.get(child.value);+ if (childInstance) {+ legacyInstance.children.push(convertTree(childInstance));+ }+ } else {+ legacyInstance.children.push(child);+ }+ }+ return legacyInstance;+ };+ return convertTree(Array.from(instances.values())[0]);+};+export const InstanceRoot = ({data,Component,@@ -38,7 +66,7 @@ export const InstanceRoot = ({registerComponents(customComponents);return createElementsTree({- instance: data.tree.root,+ instance: denormalizeTree(new Map(data.tree.instances)),propsByInstanceIdStore: atom(getPropsByInstanceId(new Map(data.tree.props))),