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
refactor: move builder data loading to client side (#3464)
Bogdan Chadkin1b0fc0eadc98
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsxindex c91bd738f5..0c123b196c 100644--- a/apps/builder/app/builder/builder.tsx+++ b/apps/builder/app/builder/builder.tsx@@ -2,14 +2,13 @@ import { useCallback, useEffect, type ReactNode } from "react";import { useStore } from "@nanostores/react";import { TooltipProvider } from "@radix-ui/react-tooltip";import { usePublish, $publisher } from "~/shared/pubsub";-import type { Asset } from "@webstudio-is/sdk";import type { Build } 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/index.server";import { createImageLoader } from "@webstudio-is/image";import { registerContainers, useBuilderStore } from "~/shared/sync";-import { useSyncServer } from "./shared/sync/sync-server";+import { startProjectSync, useSyncServer } from "./shared/sync/sync-server";import {SidebarLeft,NavigatorContent,@@ -24,22 +23,12 @@ import {Workspace,} from "./features/workspace";import {- $assets,$authPermit,$authToken,- $breakpoints,- $dataSources,- $instances,$isPreviewMode,$pages,$project,- $props,- $styleSourceSelections,- $styleSources,- $styles,- $resources,subscribeResources,- $marketplaceProduct,$authTokenPermissions,$publisherHost,$imageLoader,@@ -60,6 +49,7 @@ import { CloneProjectDialog } from "~/shared/clone-project";import type { TokenPermissions } from "@webstudio-is/authorization-token";import { useToastErrors } from "~/shared/error/toast-error";import { canvasApi } from "~/shared/canvas-api";+import { loadBuilderData, setBuilderData } from "~/shared/builder-data";registerContainers();@@ -221,8 +211,7 @@ export type BuilderProps = {project: Project;publisherHost: string;imageBaseUrl: string;- build: Build;- assets: [Asset["id"], Asset][];+ build: Pick<Build, "id" | "version">;authToken?: string;authPermit: AuthPermit;authTokenPermissions: TokenPermissions;@@ -234,7 +223,6 @@ export const Builder = ({publisherHost,imageBaseUrl,build,- assets,authToken,authPermit,userPlanFeatures,@@ -250,19 +238,22 @@ export const Builder = ({$userPlanFeatures.set(userPlanFeatures);$authTokenPermissions.set(authTokenPermissions);- // set initial containers value- $assets.set(new Map(assets));- $instances.set(new Map(build.instances));- $dataSources.set(new Map(build.dataSources));- $resources.set(new Map(build.resources));- // props should be after data sources to compute logic- $props.set(new Map(build.props));- $pages.set(build.pages);- $styleSources.set(new Map(build.styleSources));- $styleSourceSelections.set(new Map(build.styleSourceSelections));- $breakpoints.set(new Map(build.breakpoints));- $styles.set(new Map(build.styles));- $marketplaceProduct.set(build.marketplaceProduct);+ const controller = new AbortController();+ loadBuilderData({ projectId: project.id, signal: controller.signal })+ .then((data) => {+ setBuilderData(data);+ startProjectSync({+ projectId: project.id,+ buildId: build.id,+ version: build.version,+ authPermit,+ authToken,+ });+ })+ .catch(() => {});+ return () => {+ controller.abort("unmount");+ };});useToastErrors();@@ -282,11 +273,8 @@ export const Builder = ({useBuilderStore(publish);useSyncServer({- buildId: build.id,projectId: project.id,- authToken,authPermit,- version: build.version,});const isCloneDialogOpen = useStore($isCloneDialogOpen);const isPreviewMode = useStore($isPreviewMode);diff --git a/apps/builder/app/builder/shared/sync/sync-server.ts b/apps/builder/app/builder/shared/sync/sync-server.tsindex 50ff10f79c..a2dbb2d07e 100644--- a/apps/builder/app/builder/shared/sync/sync-server.ts+++ b/apps/builder/app/builder/shared/sync/sync-server.ts@@ -241,7 +241,7 @@ const syncServer = async function () {}};-const useSyncProject = async ({+export const startProjectSync = ({projectId,buildId,version,@@ -253,6 +253,25 @@ const useSyncProject = async ({authToken: string | undefined;version: number;authPermit: AuthPermit;+}) => {+ if (authPermit === "view") {+ return;+ }+ commandQueue.enqueue({+ type: "setDetails",+ projectId,+ buildId,+ version,+ authToken,+ });+};++const useSyncProject = async ({+ projectId,+ authPermit,+}: {+ projectId: Project["id"];+ authPermit: AuthPermit;}) => {useEffect(() => {if (authPermit === "view") {@@ -260,14 +279,6 @@ const useSyncProject = async ({}syncServer();- commandQueue.enqueue({- type: "setDetails",- projectId,- buildId,- version,- authToken,- });-const updateProjectTransactions = () => {const transactions = serverSyncStore.popAll();if (transactions.length === 0) {@@ -285,29 +296,17 @@ const useSyncProject = async ({updateProjectTransactions();clearInterval(intervalHandle);};- }, [authPermit, authToken, buildId, projectId, version]);+ }, [projectId, authPermit]);};type SyncServerProps = {- buildId: Build["id"];projectId: Project["id"];- authToken: string | undefined;authPermit: AuthPermit;- version: number;};-export const useSyncServer = ({- buildId,- projectId,- authToken,- authPermit,- version,-}: SyncServerProps) => {+export const useSyncServer = ({ projectId, authPermit }: SyncServerProps) => {useSyncProject({- buildId,projectId,- authToken,- version,authPermit,});diff --git a/apps/builder/app/routes/builder.$projectId.tsx b/apps/builder/app/routes/builder.$projectId.tsxindex 42052f4454..079cd656f4 100644--- a/apps/builder/app/routes/builder.$projectId.tsx+++ b/apps/builder/app/routes/builder.$projectId.tsx@@ -19,13 +19,11 @@ import {AuthorizationError,authorizeProject,} from "@webstudio-is/trpc-interface/index.server";-import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";import { createContext } from "~/shared/context.server";import { ErrorMessage } from "~/shared/error";import { loginPath } from "~/shared/router-utils";import type { BuilderProps } from "~/builder/index.client";import env from "~/env/env.server";-import { staticEnv } from "~/env/env.static.server";import builderStyles from "~/builder/builder.css?url";import prismStyles from "prismjs/themes/prism-solarizedlight.min.css?url";@@ -43,9 +41,6 @@ export const loader = async ({params,request,}: LoaderFunctionArgs): Promise<BuilderProps> => {- // TODO: remove after release 17 apr 2024- console.info({ staticEnv });-const context = await createContext(request);try {@@ -75,8 +70,6 @@ export const loader = async ({const devBuild = await loadBuildByProjectId(project.id);- const assets = await loadAssetsByProject(project.id, context);-const end = Date.now();const diff = end - start;@@ -112,8 +105,10 @@ export const loader = async ({project,publisherHost,imageBaseUrl: env.IMAGE_BASE_URL,- build: devBuild,- assets: assets.map((asset) => [asset.id, asset]),+ build: {+ id: devBuild.id,+ version: devBuild.version,+ },authToken,authTokenPermissions,authPermit,diff --git a/apps/builder/app/routes/rest.data.$projectId.ts b/apps/builder/app/routes/rest.data.$projectId.tsnew file mode 100644index 0000000000..0d707f83ab--- /dev/null+++ b/apps/builder/app/routes/rest.data.$projectId.ts@@ -0,0 +1,25 @@+import type { LoaderFunctionArgs } from "@remix-run/server-runtime";+import { db } from "@webstudio-is/project/index.server";+import { loadBuildByProjectId } from "@webstudio-is/project-build/index.server";+import { loadAssetsByProject } from "@webstudio-is/asset-uploader/index.server";+import { createContext } from "~/shared/context.server";++export const loader = async ({ params, request }: LoaderFunctionArgs) => {+ if (params.projectId === undefined) {+ throw new Error("Project id undefined");+ }+ const context = await createContext(request);+ const project = await db.project.loadById(params.projectId, context);+ if (project === null) {+ throw new Error(`Project "${params.projectId}" not found`);+ }+ if (project.userId === null) {+ throw new Error("Project must have project userId defined");+ }+ const devBuild = await loadBuildByProjectId(project.id);+ const assets = await loadAssetsByProject(project.id, context);+ return {+ build: devBuild,+ assets,+ };+};diff --git a/apps/builder/app/shared/builder-data.ts b/apps/builder/app/shared/builder-data.tsnew file mode 100644index 0000000000..5cfacfd869--- /dev/null+++ b/apps/builder/app/shared/builder-data.ts@@ -0,0 +1,87 @@+import type { Asset, WebstudioData } from "@webstudio-is/sdk";+import type { Build, MarketplaceProduct } from "@webstudio-is/project-build";+import {+ $assets,+ $breakpoints,+ $dataSources,+ $instances,+ $marketplaceProduct,+ $pages,+ $props,+ $resources,+ $styleSourceSelections,+ $styleSources,+ $styles,+} from "./nano-states";++type BuilderData = WebstudioData & {+ marketplaceProduct: undefined | MarketplaceProduct;+};++export const getBuilderData = (): BuilderData => {+ const pages = $pages.get();+ if (pages === undefined) {+ throw Error(`Cannot get webstudio data with empty pages`);+ }+ return {+ pages,+ instances: $instances.get(),+ props: $props.get(),+ dataSources: $dataSources.get(),+ resources: $resources.get(),+ breakpoints: $breakpoints.get(),+ styleSourceSelections: $styleSourceSelections.get(),+ styleSources: $styleSources.get(),+ styles: $styles.get(),+ assets: $assets.get(),+ marketplaceProduct: $marketplaceProduct.get(),+ };+};++export const setBuilderData = (data: BuilderData) => {+ $assets.set(data.assets);+ $instances.set(data.instances);+ $dataSources.set(data.dataSources);+ $resources.set(data.resources);+ // props should be after data sources to compute logic+ $props.set(data.props);+ $pages.set(data.pages);+ $styleSources.set(data.styleSources);+ $styleSourceSelections.set(data.styleSourceSelections);+ $breakpoints.set(data.breakpoints);+ $styles.set(data.styles);+ $marketplaceProduct.set(data.marketplaceProduct);+};++export const loadBuilderData = async ({+ projectId,+ signal,+}: {+ projectId: string;+ signal: AbortSignal;+}) => {+ const response = await fetch(`/rest/data/${projectId}`, { signal });+ if (response.ok) {+ const data = (await response.json()) as {+ assets: Asset[];+ build: Build;+ marketplaceProduct: undefined | MarketplaceProduct;+ };+ const { assets, build } = data;+ return {+ version: build.version,+ assets: new Map(assets.map((asset) => [asset.id, asset])),+ instances: new Map(build.instances),+ dataSources: new Map(build.dataSources),+ resources: new Map(build.resources),+ props: new Map(build.props),+ pages: build.pages,+ styleSources: new Map(build.styleSources),+ styleSourceSelections: new Map(build.styleSourceSelections),+ breakpoints: new Map(build.breakpoints),+ styles: new Map(build.styles),+ marketplaceProduct: build.marketplaceProduct,+ } satisfies BuilderData & { version: number };+ }+ throw Error("Unable to load builder data");+};diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.tsindex c4e8e4cb43..b65bff4d95 100644--- a/apps/builder/app/shared/pages/use-switch-page.ts+++ b/apps/builder/app/shared/pages/use-switch-page.ts@@ -2,7 +2,6 @@ import { useEffect } from "react";import { useStore } from "@nanostores/react";import { useNavigate } from "@remix-run/react";import { findPageByIdOrPath, type Page } from "@webstudio-is/sdk";-import { useMount } from "~/shared/hook-utils/use-mount";import {$authToken,$pages,@@ -30,9 +29,7 @@ export const switchPage = (pageId: Page["id"], pageHash: string = "") => {$selectedPageHash.set(pageHash);$selectedPageId.set(page.id);- $selectedInstanceSelector.set([- page.rootInstanceId ?? pages.homePage.rootInstanceId,- ]);+ $selectedInstanceSelector.set([page.rootInstanceId]);};const setPageStateFromUrl = () => {@@ -65,9 +62,16 @@ export const useSyncPageUrl = () => {const isPreviewMode = useStore($isPreviewMode);// Get pageId and pageHash from URL- useMount(() => {- setPageStateFromUrl();- });+ // once pages are loaded+ useEffect(() => {+ const unsubscribe = $pages.subscribe((pages) => {+ if (pages) {+ unsubscribe();+ setPageStateFromUrl();+ }+ });+ return unsubscribe;+ }, []);useEffect(() => {window.addEventListener("popstate", setPageStateFromUrl);