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.

Move initial data to builder (#1177)

Bogdan Chadkinf91a4e3a19fe
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 132dce21e2..baa5f8450c 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -1,6 +1,10 @@
import { useCallback, useEffect, useMemo } from "react";
import { type Publish, usePublish, useSubscribe } from "~/shared/pubsub";
-import { type Pages, findPageByIdOrPath } from "@webstudio-is/project-build";
+import {
+ type Build,
+ type Pages,
+ findPageByIdOrPath,
+} from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
import { theme, Box, type CSS, Flex, Grid } from "@webstudio-is/design-system";
import type { AuthPermit } from "@webstudio-is/trpc-interface";
@@ -30,7 +34,13 @@ import {
useIsPreviewMode,
useSetAuthPermit,
useSetAuthToken,
+ useSetBreakpoints,
+ useSetInstances,
useSetIsPreviewMode,
+ useSetProps,
+ useSetStyles,
+ useSetStyleSources,
+ useSetStyleSourceSelections,
} from "~/shared/nano-states";
import { useClientSettings } from "./shared/client-settings";
import { Navigator } from "./features/sidebar-left";
@@ -237,7 +247,7 @@ export type BuilderProps = {
project: Project;
pages: Pages;
pageId: string;
- buildId: string;
+ build: Build;
buildOrigin: string;
authReadToken: string;
authToken?: string;
@@ -248,12 +258,19 @@ export const Builder = ({
project,
pages,
pageId,
- buildId,
+ build,
buildOrigin,
authReadToken,
authToken,
authPermit,
}: BuilderProps) => {
+ useSetBreakpoints(build.breakpoints);
+ useSetProps(build.props);
+ useSetStyles(build.styles);
+ useSetStyleSources(build.styleSources);
+ useSetStyleSourceSelections(build.styleSourceSelections);
+ useSetInstances(build.instances);
+
useSetAuthToken(authToken);
useSetAuthPermit(authPermit);
useSetProject(project);
@@ -262,7 +279,7 @@ export const Builder = ({
const [publish, publishRef] = usePublish();
useBuilderStore(publish);
useSyncServer({
- buildId,
+ buildId: build.id,
projectId: project.id,
authToken,
authPermit,
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 7f0b243485..88a26f40e1 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,6 +1,7 @@
import { useMemo, Fragment, useEffect } from "react";
import { computed } from "nanostores";
import type { CanvasData } from "@webstudio-is/project";
+import type { Instance } from "@webstudio-is/project-build";
import {
createElementsTree,
registerComponents,
@@ -23,12 +24,6 @@ import {
propsIndexStore,
assetsStore,
useRootInstance,
- useSetBreakpoints,
- useSetInstances,
- useSetProps,
- useSetStyles,
- useSetStyleSources,
- useSetStyleSourceSelections,
useSubscribeScrollState,
useIsPreviewMode,
useSetAssets,
@@ -49,17 +44,22 @@ const propsByInstanceIdStore = computed(
(propsIndex) => propsIndex.propsByInstanceId
);
+const temporaryRootInstance: Instance = {
+ type: "instance",
+ id: "temporaryRootInstance",
+ component: "Body",
+ children: [],
+};
+
const useElementsTree = (getComponent: GetComponent) => {
const [rootInstance] = useRootInstance();
return useMemo(() => {
- if (rootInstance === undefined) {
- return;
- }
-
return createElementsTree({
sandbox: true,
- instance: rootInstance,
+ // fallback to temporary root instance to render scripts
+ // and receive real data from builder
+ instance: rootInstance ?? temporaryRootInstance,
propsByInstanceIdStore,
assetsStore,
Component: WebstudioComponentDev,
@@ -96,12 +96,6 @@ export const Canvas = ({
}: CanvasProps): JSX.Element | null => {
const isBuilderReady = useSubscribeBuilderReady();
useSetAssets(data.assets);
- useSetBreakpoints(data.build.breakpoints);
- useSetProps(data.build.props);
- useSetStyles(data.build.styles);
- useSetStyleSources(data.build.styleSources);
- useSetStyleSourceSelections(data.build.styleSourceSelections);
- useSetInstances(data.build.instances);
useSetSelectedPage(data.page);
setParams(data.params ?? null);
useCanvasStore(publish);
diff --git a/apps/builder/app/routes/builder/$projectId.tsx b/apps/builder/app/routes/builder/$projectId.tsx
index 7bedbd858c..e1ba13cb61 100644
--- a/apps/builder/app/routes/builder/$projectId.tsx
+++ b/apps/builder/app/routes/builder/$projectId.tsx
@@ -53,7 +53,7 @@ export const loader = async ({
project,
pages,
pageId: pageIdParam || devBuild.pages.homePage.id,
- buildId: devBuild.id,
+ build: devBuild,
buildOrigin: getBuildOrigin(request),
authReadToken,
authToken,
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index c4fd1b607c..3f727049cf 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -31,6 +31,7 @@ type SyncEventSource = "canvas" | "builder";
declare module "~/shared/pubsub" {
export interface PubsubMap {
+ canvasStoreReady: void;
sendStoreData: {
// distinct source to avoid infinite loop
source: SyncEventSource;
@@ -170,15 +171,7 @@ const syncStoresState = (name: SyncEventSource, publish: Publish) => {
export const useCanvasStore = (publish: Publish) => {
useEffect(() => {
- // immerhin data is sent only initially so not part of syncStoresState
- // expect data to be populated by the time effect is called
const data = [];
- for (const [namespace, container] of store.containers) {
- data.push({
- namespace,
- value: container.get(),
- });
- }
for (const [namespace, store] of clientStores) {
data.push({
namespace,
@@ -196,6 +189,10 @@ export const useCanvasStore = (publish: Publish) => {
const unsubscribeStoresState = syncStoresState("canvas", publish);
const unsubscribeStoresChanges = syncStoresChanges("canvas", publish);
+ publish({
+ type: "canvasStoreReady",
+ });
+
return () => {
unsubscribeStoresState();
unsubscribeStoresChanges();
@@ -205,10 +202,30 @@ export const useCanvasStore = (publish: Publish) => {
export const useBuilderStore = (publish: Publish) => {
useEffect(() => {
+ const unsubscribeCanvasStoreReady = subscribe("canvasStoreReady", () => {
+ // immerhin data is sent only initially so not part of syncStoresState
+ // expect data to be populated by the time effect is called
+ const data = [];
+ for (const [namespace, container] of store.containers) {
+ data.push({
+ namespace,
+ value: container.get(),
+ });
+ }
+ publish({
+ type: "sendStoreData",
+ payload: {
+ source: "builder",
+ data,
+ },
+ });
+ });
+
const unsubscribeStoresState = syncStoresState("builder", publish);
const unsubscribeStoresChanges = syncStoresChanges("builder", publish);
return () => {
+ unsubscribeCanvasStoreReady();
unsubscribeStoresState();
unsubscribeStoresChanges();
};