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.

feat: Delay canvas scripts until resources render (#6380)

Oleg Isonenb7a11e4bc2aa
diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.test.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.test.tsx
index 0be688988f..b50a52bdfb 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.test.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.test.tsx
@@ -1,7 +1,38 @@
import { describe, test, expect } from "vitest";
import { __testing__ } from "./webstudio-component";
-const { computeComponentKey, getPreviewCurrentUrl } = __testing__;
+const { computeComponentKey, getPreviewCurrentUrl, getHtmlEmbedCanvasProps } =
+ __testing__;
+
+describe("getHtmlEmbedCanvasProps", () => {
+ test.each([
+ [undefined, "settled", true],
+ [false, "settled", true],
+ [true, "settled", false],
+ [false, "pending", false],
+ ] as const)(
+ "sets HtmlEmbed script execution for safeMode=%p and resources=%p",
+ (isSafeMode, resourcesState, executeScripts) => {
+ expect(
+ getHtmlEmbedCanvasProps({
+ component: "HtmlEmbed",
+ isSafeMode,
+ resourcesState,
+ })
+ ).toEqual({ $ws$executeScripts: executeScripts });
+ }
+ );
+
+ test("does not pass the private prop to other components", () => {
+ expect(
+ getHtmlEmbedCanvasProps({
+ component: "Button",
+ isSafeMode: false,
+ resourcesState: "settled",
+ })
+ ).toEqual({});
+ });
+});
describe("computeComponentKey - key generation logic", () => {
test("prioritizes assetId over other props", () => {
diff --git a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
index fadb8d1c44..b674cfa1cb 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -6,6 +6,7 @@ import {
useRef,
useLayoutEffect,
useMemo,
+ useContext,
Fragment,
type ReactNode,
type JSX,
@@ -106,6 +107,23 @@ import {
takeNewContentBlockDiagnostics,
} from "~/shared/content-block-diagnostics";
import { resolveContentBlockOccurrenceAssetId } from "~/shared/content-block-source-utils";
+import { $resourcesState } from "~/shared/resources";
+import { ReactSdkContext } from "@webstudio-is/react-sdk/runtime";
+
+const getHtmlEmbedCanvasProps = ({
+ component,
+ isSafeMode,
+ resourcesState,
+}: {
+ component: string;
+ isSafeMode: boolean | undefined;
+ resourcesState: "pending" | "settled";
+}) =>
+ component === "HtmlEmbed"
+ ? {
+ $ws$executeScripts: isSafeMode !== true && resourcesState === "settled",
+ }
+ : {};
const computeComponentKey = (props: Record<string, unknown>) => {
const assetId = props.$webstudio$canvasOnly$assetId;
@@ -140,7 +158,11 @@ const getPreviewCurrentUrl = (
return currentUrl;
};
-export const __testing__ = { computeComponentKey, getPreviewCurrentUrl };
+export const __testing__ = {
+ computeComponentKey,
+ getPreviewCurrentUrl,
+ getHtmlEmbedCanvasProps,
+};
const PreviewLinkCurrentUrlProvider = ({
children,
@@ -667,6 +689,8 @@ const WebstudioComponentCanvasInner = forwardRef<
const allProps = useStore($props);
const externalContentRoots = useStore($externalContentRoots);
const metas = useStore($registeredComponentMetas);
+ const resourcesState = useStore($resourcesState);
+ const { isSafeMode } = useContext(ReactSdkContext);
const textEditingInstanceSelector = useStore($textEditingInstanceSelector);
@@ -775,6 +799,11 @@ const WebstudioComponentCanvasInner = forwardRef<
[selectorIdAttribute]: string;
} & Record<string, unknown> = {
...mergedProps,
+ ...getHtmlEmbedCanvasProps({
+ component: instance.component,
+ isSafeMode,
+ resourcesState,
+ }),
// current props should override bypassed from parent
// important for data-ws-* props
tabIndex: 0,
@@ -965,6 +994,8 @@ const WebstudioComponentPreviewInner = forwardRef<
WebstudioComponentProps
>(({ instance, instanceSelector, components, ...restProps }, ref) => {
const instances = useStore($instances);
+ const resourcesState = useStore($resourcesState);
+ const { isSafeMode } = useContext(ReactSdkContext);
const { [showAttribute]: show = true, ...instanceProps } =
useInstanceProps(instanceSelector);
const props: {
@@ -973,6 +1004,11 @@ const WebstudioComponentPreviewInner = forwardRef<
[selectorIdAttribute]: string;
} & Record<string, unknown> = {
...mergeProps(restProps, instanceProps, "merge"),
+ ...getHtmlEmbedCanvasProps({
+ component: instance.component,
+ isSafeMode,
+ resourcesState,
+ }),
[idAttribute]: instance.id,
[componentAttribute]: instance.component,
[selectorIdAttribute]: instanceSelector.join(","),
diff --git a/apps/builder/app/shared/resources.test.ts b/apps/builder/app/shared/resources.test.ts
index ab4734def9..1472853a17 100644
--- a/apps/builder/app/shared/resources.test.ts
+++ b/apps/builder/app/shared/resources.test.ts
@@ -7,6 +7,7 @@ import {
$resourceDiagnosticsCache,
$resourceDiagnosticsErrorCache,
$resourcePerformanceCache,
+ $resourcesState,
$resourcesCache,
getResourceKey,
invalidateAssets,
@@ -68,12 +69,19 @@ test("dispatches resources synchronously", async () => {
preloadResources([request]);
expect(getLoaderState()).toEqual({ queueSize: 0, pendingSize: 1 });
+ expect($resourcesState.get()).toBe("pending");
await vi.waitFor(() => {
expect($hasPendingResources.get()).toBe(false);
});
+ expect($resourcesState.get()).toBe("settled");
error.mockRestore();
});
+test("marks an empty resource set as settled", () => {
+ queueResources([]);
+ expect($resourcesState.get()).toBe("settled");
+});
+
test("batches all resources from one computation", async () => {
vi.useFakeTimers();
const requests: ResourceRequest[] = [
diff --git a/apps/builder/app/shared/resources.ts b/apps/builder/app/shared/resources.ts
index 10d2eefc18..c47e115884 100644
--- a/apps/builder/app/shared/resources.ts
+++ b/apps/builder/app/shared/resources.ts
@@ -81,9 +81,13 @@ const cacheResourceMetadata = ({
};
export const $pendingResourceKeys = atom<ReadonlySet<string>>(new Set());
+export const $resourcesState = atom<"pending" | "settled">("pending");
const updatePending = () => {
$pendingResourceKeys.set(new Set([...queue.keys(), ...pending.keys()]));
+ $resourcesState.set(
+ queue.size === 0 && pending.size === 0 ? "settled" : "pending"
+ );
};
export const $hasPendingResources = computed(
@@ -230,6 +234,8 @@ const queueResources = (resources: readonly ResourceRequest[]) => {
for (const resource of resources) {
preloadResource(resource);
}
+ // Marks an empty or fully cached request set as settled too.
+ updatePending();
};
export const preloadResources = (resources: readonly ResourceRequest[]) => {
diff --git a/apps/builder/app/shared/sync/sync-stores.test.ts b/apps/builder/app/shared/sync/sync-stores.test.ts
index b3dd210e18..db75564b68 100644
--- a/apps/builder/app/shared/sync/sync-stores.test.ts
+++ b/apps/builder/app/shared/sync/sync-stores.test.ts
@@ -10,6 +10,7 @@ import {
} from "../nano-states";
import { __testing__, createObjectPool } from "./sync-stores";
import { $instances } from "./data-stores";
+import { $resourcesState } from "../resources";
const { SelectedPageAndInstanceSyncObject } = __testing__;
const subscriptionControllers: AbortController[] = [];
@@ -62,6 +63,7 @@ afterEach(() => {
$allSelectedInstanceSelectors.set([]);
$selectedInstanceOutlines.set([]);
$instances.set(new Map());
+ $resourcesState.set("pending");
});
describe("SelectedPageAndInstanceSyncObject", () => {
@@ -358,6 +360,18 @@ describe("SelectedPageAndInstanceSyncObject", () => {
});
describe("createObjectPool", () => {
+ test("syncs resource readiness to the canvas", () => {
+ const objectPool = createObjectPool();
+
+ objectPool.applyTransaction({
+ id: "resources-loaded",
+ object: "resourcesState",
+ payload: "settled",
+ });
+
+ expect($resourcesState.get()).toBe("settled");
+ });
+
test("syncs selected instance outlines for builder canvas overlay", () => {
const objectPool = createObjectPool();
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 2bd750b57c..6daa9b0889 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -81,7 +81,7 @@ import {
import { $selectedPageId } from "../nano-states/pages";
import { areSelectorListsEqual } from "../instance-utils/selection";
import { $systemDataByPage } from "../system";
-import { $resourcesCache } from "../resources";
+import { $resourcesCache, $resourcesState } from "../resources";
import {
areInstanceSelectorsEqual,
type InstanceSelector,
@@ -342,6 +342,7 @@ export const createObjectPool = () => {
new NanostoresSyncObject("project", $project),
new NanostoresSyncObject("dataSourceVariables", $dataSourceVariables),
new NanostoresSyncObject("resourcesCache", $resourcesCache),
+ new NanostoresSyncObject("resourcesState", $resourcesState),
new NanostoresSyncObject("selectedPageHash", $selectedPageHash),
new NanostoresSyncObject("selectedInstanceSizes", $selectedInstanceSizes),
new NanostoresSyncObject(
diff --git a/packages/sdk-components-react/src/html-embed.browser.test.tsx b/packages/sdk-components-react/src/html-embed.browser.test.tsx
index ba07308c6f..c69b5c3a49 100644
--- a/packages/sdk-components-react/src/html-embed.browser.test.tsx
+++ b/packages/sdk-components-react/src/html-embed.browser.test.tsx
@@ -16,6 +16,7 @@ const App = (props: {
clientOnly?: boolean;
renderer?: "canvas" | "preview";
executeScriptOnCanvas?: boolean;
+ $ws$executeScripts?: boolean;
}) => {
const [page, switchPage] = React.useReducer((n) => (n + 1) % 2, 0);
const [refresh, setRefresh] = React.useReducer((n) => n + 1, 0);
@@ -41,6 +42,7 @@ const App = (props: {
code={code}
clientOnly={props.clientOnly}
executeScriptOnCanvas={props.executeScriptOnCanvas}
+ $ws$executeScripts={props.$ws$executeScripts}
/>
<button type="button" onClick={switchPage}>
page:{page}
@@ -160,6 +162,27 @@ describe("Published site", () => {
* On canvas renderer, scripts are not executed on the server side.
*/
describe("Builder renderer= canvas | preview", () => {
+ test.each(["canvas", "preview"] as const)(
+ "waits for resources to settle before executing scripts in %s",
+ async (renderer) => {
+ const props = {
+ renderer,
+ executeScriptOnCanvas: true,
+ $ws$executeScripts: false,
+ };
+ const { rerender } = render(<App {...props} />);
+
+ expect(screen.queryByTestId(SCRIPT_TEST_ID)).toBeTruthy();
+ expect(screen.queryByTestId(SCRIPT_PROCESSED_TEST_ID)).not.toBeTruthy();
+
+ rerender(<App {...props} $ws$executeScripts={true} />);
+ await Promise.resolve();
+
+ expect(screen.queryByTestId(SCRIPT_TEST_ID)).not.toBeTruthy();
+ expect(screen.queryByTestId(SCRIPT_PROCESSED_TEST_ID)).toBeTruthy();
+ }
+ );
+
/**
* On canvas if renderer is canvas, and executeScriptOnCanvas=false
* scripts postprocessing are not applied independently of clientOnly value.
@@ -335,8 +358,7 @@ describe("Builder renderer= canvas | preview", () => {
});
/**
- * Test safe mode: when isSafeMode is true, scripts should never execute
- * regardless of executeScriptOnCanvas setting or renderer mode.
+ * Disabled script execution takes precedence over canvas settings and renderer mode.
*/
test.each(
cartesian(
@@ -359,7 +381,6 @@ describe("Builder renderer= canvas | preview", () => {
assetBaseUrl: "",
imageLoader: () => "",
renderer: renderer as "canvas" | "preview",
- isSafeMode: true,
resources: {},
breakpoints: [],
onError: console.error,
@@ -369,6 +390,7 @@ describe("Builder renderer= canvas | preview", () => {
code={code}
clientOnly={clientOnly}
executeScriptOnCanvas={executeScriptOnCanvas}
+ $ws$executeScripts={false}
/>
</ReactSdkContext.Provider>
);
@@ -381,7 +403,7 @@ describe("Builder renderer= canvas | preview", () => {
render(ui, { container });
await Promise.resolve();
- // In safe mode, scripts should not be processed (no SCRIPT_PROCESSED_TEST_ID)
+ // Scripts should not be processed (no SCRIPT_PROCESSED_TEST_ID)
expect(screen.queryByTestId(SCRIPT_TEST_ID)).toBeTruthy();
expect(screen.queryByTestId(SCRIPT_PROCESSED_TEST_ID)).not.toBeTruthy();
expect(screen.queryByTestId(FRAGMENT_DIV_ID)).toBeTruthy();
diff --git a/packages/sdk-components-react/src/html-embed.tsx b/packages/sdk-components-react/src/html-embed.tsx
index bb4ca89352..038f75efdd 100644
--- a/packages/sdk-components-react/src/html-embed.tsx
+++ b/packages/sdk-components-react/src/html-embed.tsx
@@ -218,15 +218,22 @@ type HtmlEmbedProps = {
executeScriptOnCanvas?: boolean;
clientOnly?: boolean;
className?: string;
+ $ws$executeScripts?: boolean;
// avoid builder passing it to dom
children?: never;
};
export const HtmlEmbed = forwardRef<HTMLDivElement, HtmlEmbedProps>(
(props, ref) => {
- const { code, executeScriptOnCanvas, clientOnly, children, ...rest } =
- props;
- const { renderer, isSafeMode } = useContext(ReactSdkContext);
+ const {
+ code,
+ executeScriptOnCanvas,
+ clientOnly,
+ children,
+ $ws$executeScripts = true,
+ ...rest
+ } = props;
+ const { renderer } = useContext(ReactSdkContext);
const isServer = useIsServer();
@@ -252,8 +259,7 @@ export const HtmlEmbed = forwardRef<HTMLDivElement, HtmlEmbedProps>(
}
// We are or on canvas | preview | published site after client routing
- // In safe mode, never execute scripts regardless of other settings
- if (isSafeMode) {
+ if ($ws$executeScripts === false) {
return (
<ClientOnly>
<ClientEmbedWithNonExecutableScripts