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: render canvas only client side (#3199)
Bogdan Chadkind0a00a3ebc6b
diff --git a/apps/builder/.gitignore b/apps/builder/.gitignoreindex efaef2e083..f56a416128 100644--- a/apps/builder/.gitignore+++ b/apps/builder/.gitignore@@ -10,4 +10,4 @@/api/index.js.map/api/_assets/public/s/uploads-/public/metas.json+diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsxindex f9f1a52aa3..b0ae6cf013 100644--- a/apps/builder/app/canvas/canvas.tsx+++ b/apps/builder/app/canvas/canvas.tsx@@ -1,19 +1,23 @@import { useMemo, useEffect, useState } from "react";import { ErrorBoundary, type FallbackProps } from "react-error-boundary";import { useStore } from "@nanostores/react";-import type { Instance, Instances } from "@webstudio-is/sdk";+import type { Instances } from "@webstudio-is/sdk";import {type Params,type Components,createElementsTree,coreMetas,corePropsMetas,- WsComponentMeta,- type WsComponentPropsMeta,} from "@webstudio-is/react-sdk";import * as baseComponents from "@webstudio-is/sdk-components-react";+import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";+import * as baseComponentPropsMetas from "@webstudio-is/sdk-components-react/props";import * as remixComponents from "@webstudio-is/sdk-components-react-remix";+import * as remixComponentMetas from "@webstudio-is/sdk-components-react-remix/metas";+import * as remixComponentPropsMetas from "@webstudio-is/sdk-components-react-remix/props";import * as radixComponents from "@webstudio-is/sdk-components-react-radix";+import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";+import * as radixComponentPropsMetas from "@webstudio-is/sdk-components-react-radix/props";import { hooks as radixComponentHooks } from "@webstudio-is/sdk-components-react-radix/hooks";import { ErrorMessage } from "~/shared/error";import { $publisher, publish } from "~/shared/pubsub";@@ -130,42 +134,6 @@ const DesignMode = ({ params }: { params: Params }) => {return null;};-const fetchAndRegisterLibraries = async () => {- const response = await fetch("/metas.json");- type Library = {- metas: Record<Instance["component"], WsComponentMeta>;- propsMetas: Record<Instance["component"], WsComponentPropsMeta>;- };- const data: {- base: Library;- remix: Library;- radix: Library;- } = await response.json();-- registerComponentLibrary({- components: {},- metas: coreMetas,- propsMetas: corePropsMetas,- });- registerComponentLibrary({- components: baseComponents,- metas: data.base.metas,- propsMetas: data.base.propsMetas,- });- registerComponentLibrary({- components: remixComponents,- metas: data.remix.metas,- propsMetas: data.remix.propsMetas,- });- registerComponentLibrary({- namespace: "@webstudio-is/sdk-components-react-radix",- components: radixComponents,- metas: data.radix.metas,- propsMetas: data.radix.propsMetas,- hooks: radixComponentHooks,- });-};-type CanvasProps = {params: Params;imageLoader: ImageLoader;@@ -176,7 +144,28 @@ export const Canvas = ({ params, imageLoader }: CanvasProps) => {const isPreviewMode = useStore($isPreviewMode);useMount(() => {- fetchAndRegisterLibraries();+ registerComponentLibrary({+ components: {},+ metas: coreMetas,+ propsMetas: corePropsMetas,+ });+ registerComponentLibrary({+ components: baseComponents,+ metas: baseComponentMetas,+ propsMetas: baseComponentPropsMetas,+ });+ registerComponentLibrary({+ components: remixComponents,+ metas: remixComponentMetas,+ propsMetas: remixComponentPropsMetas,+ });+ registerComponentLibrary({+ namespace: "@webstudio-is/sdk-components-react-radix",+ components: radixComponents,+ metas: radixComponentMetas,+ propsMetas: radixComponentPropsMetas,+ hooks: radixComponentHooks,+ });});useMount(() => {diff --git a/apps/builder/app/canvas/index.ts b/apps/builder/app/canvas/index.client.tssimilarity index 100%rename from apps/builder/app/canvas/index.tsrename to apps/builder/app/canvas/index.client.tsdiff --git a/apps/builder/app/routes/$.tsx b/apps/builder/app/routes/$.tsxindex 8248c629bf..eaf9d50f59 100644--- a/apps/builder/app/routes/$.tsx+++ b/apps/builder/app/routes/$.tsx@@ -1,3 +1,4 @@+import { lazy } from "react";import { type LoaderFunctionArgs, redirect } from "@remix-run/server-runtime";import {Links,@@ -7,11 +8,12 @@ import {useRouteError,} from "@remix-run/react";import type { Params } from "@webstudio-is/react-sdk";+import { Body } from "@webstudio-is/sdk-components-react-remix";import { createImageLoader } from "@webstudio-is/image";import env from "~/env/env.server";-import { Canvas } from "~/canvas";import { ErrorMessage } from "~/shared/error";import { dashboardPath, isCanvas } from "~/shared/router-utils";+import { ClientOnly } from "~/shared/client-only";export const loader = async ({ request }: LoaderFunctionArgs) => {const url = new URL(request.url);@@ -50,12 +52,21 @@ export const ErrorBoundary = () => {return <ErrorMessage message={message} />;};+const Canvas = lazy(async () => {+ const { Canvas } = await import("~/canvas/index.client");+ return { default: Canvas };+});+const Outlet = () => {const { params } = useLoaderData<typeof loader>();const imageLoader = createImageLoader({imageBaseUrl: params.imageBaseUrl,});- return <Canvas params={params} imageLoader={imageLoader} />;+ return (+ <ClientOnly fallback={<Body />}>+ <Canvas params={params} imageLoader={imageLoader} />+ </ClientOnly>+ );};/**diff --git a/apps/builder/app/shared/client-only.ts b/apps/builder/app/shared/client-only.tsindex 4af28c9b3e..337651d44b 100644--- a/apps/builder/app/shared/client-only.ts+++ b/apps/builder/app/shared/client-only.ts@@ -1,9 +1,20 @@-import { type ReactNode, useState, useEffect } from "react";+import { type ReactNode, useSyncExternalStore } from "react";-export const ClientOnly = ({ children }: { children: ReactNode }) => {- const [rendered, setRendered] = useState(false);- useEffect(() => setRendered(true), []);- if (rendered) {- return children;+export const ClientOnly = ({+ fallback,+ children,+}: {+ fallback?: ReactNode;+ children: ReactNode;+}) => {+ // https://tkdodo.eu/blog/avoiding-hydration-mismatches-with-use-sync-external-store+ const isServer = useSyncExternalStore(+ () => () => {},+ () => false,+ () => true+ );+ if (isServer) {+ return fallback;}+ return children;};diff --git a/apps/builder/package.json b/apps/builder/package.jsonindex 49a4f8ea84..8066feb463 100644--- a/apps/builder/package.json+++ b/apps/builder/package.json@@ -5,12 +5,11 @@"description": "Webstudio Builder UI as a service","type": "module","scripts": {- "generate-metas": "pnpm tsx --conditions=webstudio scripts/generate-metas.mts","prebuild": "which remix",- "build": "pnpm generate-metas && remix vite:build",+ "build": "remix vite:build","start": "remix-serve build/server/index.js","start-local": "NODE_OPTIONS='-r dotenv/config' remix-serve build/server/index.js",- "dev": "pnpm generate-metas && remix vite:dev",+ "dev": "remix vite:dev","typecheck": "tsc --noEmit --emitDeclarationOnly false","test": "NODE_OPTIONS=--experimental-vm-modules jest","checks": "pnpm typecheck && pnpm test",diff --git a/apps/builder/scripts/generate-metas.mts b/apps/builder/scripts/generate-metas.mtsdeleted file mode 100644index 52c87f019a..0000000000--- a/apps/builder/scripts/generate-metas.mts+++ /dev/null@@ -1,26 +0,0 @@-import { join } from "node:path";-import { writeFile } from "node:fs/promises";-import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";-import * as baseComponentPropsMetas from "@webstudio-is/sdk-components-react/props";-import * as remixComponentMetas from "@webstudio-is/sdk-components-react-remix/metas";-import * as remixComponentPropsMetas from "@webstudio-is/sdk-components-react-remix/props";-import * as radixComponentMetas from "@webstudio-is/sdk-components-react-radix/metas";-import * as radixComponentPropsMetas from "@webstudio-is/sdk-components-react-radix/props";--const data = {- base: {- metas: baseComponentMetas,- propsMetas: baseComponentPropsMetas,- },- remix: {- metas: remixComponentMetas,- propsMetas: remixComponentPropsMetas,- },- radix: {- metas: radixComponentMetas,- propsMetas: radixComponentPropsMetas,- },-};--await writeFile(join(process.cwd(), "public/metas.json"), JSON.stringify(data));-console.info("public/metas.json is generated");