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.

experimental: Abort controller (#4195)

Oleg Isonen9fd5ce0552c8
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 910cb7387f..9888f6527b 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -32,7 +32,6 @@ import {
} from "~/shared/nano-states";
import { $settings, type Settings } from "./shared/client-settings";
import { builderUrl, getCanvasUrl } from "~/shared/router-utils";
-import { useCopyPaste } from "~/shared/copy-paste";
import { BlockingAlerts } from "./features/blocking-alerts";
import { useSyncPageUrl } from "~/shared/pages";
import { useMount, useUnmount } from "~/shared/hook-utils/use-mount";
@@ -58,6 +57,7 @@ import { updateWebstudioData } from "~/shared/instance-utils";
import { migrateWebstudioDataMutable } from "~/shared/webstudio-data-migrator";
import { Loading, LoadingBackground } from "./shared/loading";
import { mergeRefs } from "@react-aria/utils";
+import { initCopyPaste } from "~/shared/copy-paste";
registerContainers();
@@ -285,9 +285,7 @@ export const Builder = ({
const isCloneDialogOpen = useStore($isCloneDialogOpen);
const isPreviewMode = useStore($isPreviewMode);
const { onRef: onRefReadCanvas, onTransitionEnd } = useReadCanvasRect();
- // We need to initialize this in both canvas and builder,
- // because the events will fire in either one, depending on where the focus is
- useCopyPaste();
+
useSetWindowTitle();
const iframeRefCallback = mergeRefs((element: HTMLIFrameElement | null) => {
@@ -299,6 +297,13 @@ export const Builder = ({
const [loadingState, setLoadingState] = useState(() => $loadingState.get());
useEffect(() => {
+ const abortController = new AbortController();
+ // We need to initialize this in both canvas and builder,
+ // because the events will fire in either one, depending on where the focus is
+ // @todo we need to forward the events from canvas to builder and avoid importing this
+ // in both places
+ initCopyPaste(abortController);
+
const unsubscribe = $loadingState.subscribe((loadingState) => {
setLoadingState(loadingState);
// We need to stop updating it once it's ready in case in the future it changes again.
@@ -306,7 +311,10 @@ export const Builder = ({
unsubscribe();
}
});
- return unsubscribe;
+ return () => {
+ unsubscribe();
+ abortController.abort();
+ };
}, []);
const canvasUrl = getCanvasUrl();
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index d7d17c9fdc..6be21a2952 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -1,4 +1,4 @@
-import { useMemo, useEffect, useState, useLayoutEffect } from "react";
+import { useMemo, useEffect, useState, useLayoutEffect, useRef } from "react";
import { ErrorBoundary, type FallbackProps } from "react-error-boundary";
import { useStore } from "@nanostores/react";
import type { Instances } from "@webstudio-is/sdk";
@@ -28,10 +28,10 @@ import {
useCanvasStore,
} from "~/shared/sync";
import {
- useManageDesignModeStyles,
GlobalStyles,
subscribeStyles,
mountStyles,
+ manageDesignModeStyles,
} from "./shared/styles";
import {
WebstudioComponentCanvas,
@@ -48,23 +48,24 @@ import {
$isPreviewMode,
} from "~/shared/nano-states";
import { useDragAndDrop } from "./shared/use-drag-drop";
-import { useCopyPaste } from "~/shared/copy-paste";
+import { initCopyPaste } from "~/shared/copy-paste";
import { setDataCollapsed, subscribeCollapsedToPubSub } from "./collapsed";
import { useWindowResizeDebounced } from "~/shared/dom-hooks";
import { subscribeInstanceSelection } from "./instance-selection";
import { subscribeInstanceHovering } from "./instance-hovering";
import { useHashLinkSync } from "~/shared/pages";
import { useMount } from "~/shared/hook-utils/use-mount";
-import { useSelectedInstance } from "./use-selected-instance";
import { subscribeInterceptedEvents } from "./interceptor";
import type { ImageLoader } from "@webstudio-is/image";
import { subscribeCommands } from "~/canvas/shared/commands";
import { updateCollaborativeInstanceRect } from "./collaborative-instance";
import { $params } from "./stores";
-import { useScrollNewInstanceIntoView } from "./shared/use-scroll-new-instance-into-view";
import { subscribeInspectorEdits } from "./inspector-edits";
import { initCanvasApi } from "~/shared/canvas-api";
import { subscribeFontLoadingDone } from "./shared/font-weight-support";
+import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
+import { subscribeSelected } from "./instance-selected";
+import { subscribeScrollNewInstanceIntoView } from "./shared/scroll-new-instance-into-view";
registerContainers();
@@ -130,21 +131,43 @@ const useElementsTree = (
};
const DesignMode = () => {
- useManageDesignModeStyles();
+ const debounceEffect = useDebounceEffect();
+ const ref = useRef<Instances>();
+
useDragAndDrop();
- // We need to initialize this in both canvas and builder,
- // because the events will fire in either one, depending on where the focus is
- // @todo we need to forward the events from canvas to builder and avoid importing this
- // in both places
- useCopyPaste();
- useScrollNewInstanceIntoView();
- useSelectedInstance();
- useEffect(updateCollaborativeInstanceRect, []);
- useEffect(subscribeInstanceSelection, []);
- useEffect(subscribeInstanceHovering, []);
- useEffect(subscribeInspectorEdits, []);
- useEffect(subscribeFontLoadingDone, []);
+ useEffect(() => {
+ const abortController = new AbortController();
+ subscribeScrollNewInstanceIntoView(
+ debounceEffect,
+ ref,
+ abortController.signal
+ );
+ const unsubscribeSelected = subscribeSelected(debounceEffect);
+ return () => {
+ unsubscribeSelected();
+ abortController.abort();
+ };
+ }, [debounceEffect]);
+
+ useEffect(() => {
+ const abortController = new AbortController();
+ const options = { signal: abortController.signal };
+ // We need to initialize this in both canvas and builder,
+ // because the events will fire in either one, depending on where the focus is
+ // @todo we need to forward the events from canvas to builder and avoid importing this
+ // in both places
+ initCopyPaste(options);
+ manageDesignModeStyles(options);
+ updateCollaborativeInstanceRect(options);
+ subscribeInstanceSelection(options);
+ subscribeInstanceHovering(options);
+ subscribeInspectorEdits(options);
+ subscribeFontLoadingDone(options);
+ return () => {
+ abortController.abort();
+ };
+ }, []);
return null;
};
diff --git a/apps/builder/app/canvas/collaborative-instance.ts b/apps/builder/app/canvas/collaborative-instance.ts
index 9cc108585e..4b105f81fa 100644
--- a/apps/builder/app/canvas/collaborative-instance.ts
+++ b/apps/builder/app/canvas/collaborative-instance.ts
@@ -7,7 +7,11 @@ import {
$collaborativeInstanceRect,
} from "~/shared/nano-states";
-export const updateCollaborativeInstanceRect = () => {
+export const updateCollaborativeInstanceRect = ({
+ signal,
+}: {
+ signal: AbortSignal;
+}) => {
let frameHandler: number = -1;
let elements: HTMLElement[] = [];
@@ -43,8 +47,8 @@ export const updateCollaborativeInstanceRect = () => {
}
});
- return () => {
+ signal.addEventListener("abort", () => {
unsubscribe();
cancelAnimationFrame(frameHandler);
- };
+ });
};
diff --git a/apps/builder/app/canvas/inspector-edits.ts b/apps/builder/app/canvas/inspector-edits.ts
index 9277c46ba7..feecc2ea8f 100644
--- a/apps/builder/app/canvas/inspector-edits.ts
+++ b/apps/builder/app/canvas/inspector-edits.ts
@@ -1,14 +1,13 @@
import { canvasApi } from "~/shared/canvas-api";
import { $props } from "~/shared/nano-states";
-export const subscribeInspectorEdits = () => {
- /**
- * Prevents Radix from stealing focus when the content inside a dialog changes.
- * (Radix focus scope uses a MutationObserver)
- */
+export const subscribeInspectorEdits = ({
+ signal,
+}: {
+ signal: AbortSignal;
+}) => {
+ // Prevents Radix from stealing focus when the content inside a dialog changes.
+ // (Radix focus scope uses a MutationObserver)
const unsubscribeProps = $props.listen(canvasApi.setInert);
-
- return () => {
- unsubscribeProps();
- };
+ signal.addEventListener("abort", unsubscribeProps);
};
diff --git a/apps/builder/app/canvas/instance-hovering.ts b/apps/builder/app/canvas/instance-hovering.ts
index f521edc6a9..6178599e8f 100644
--- a/apps/builder/app/canvas/instance-hovering.ts
+++ b/apps/builder/app/canvas/instance-hovering.ts
@@ -11,7 +11,11 @@ import type { InstanceSelector } from "~/shared/tree-utils";
type TimeoutId = undefined | ReturnType<typeof setTimeout>;
-export const subscribeInstanceHovering = () => {
+export const subscribeInstanceHovering = ({
+ signal,
+}: {
+ signal: AbortSignal;
+}) => {
let hoveredElement: undefined | Element = undefined;
let isScrolling = false;
@@ -24,35 +28,41 @@ export const subscribeInstanceHovering = () => {
let mouseOutTimeoutId: TimeoutId = undefined;
- const handleMouseOver = (event: MouseEvent) => {
- if (event.target instanceof Element) {
- const element = event.target.closest(`[${idAttribute}]`) ?? undefined;
- if (element !== undefined) {
- clearTimeout(mouseOutTimeoutId);
- // store hovered element locally to update outline when scroll ends
- hoveredElement = element;
- updateHoveredInstance(element);
+ const eventOptions = { passive: true, signal };
+
+ window.addEventListener(
+ "mouseover",
+ (event: MouseEvent) => {
+ if (event.target instanceof Element) {
+ const element = event.target.closest(`[${idAttribute}]`) ?? undefined;
+ if (element !== undefined) {
+ clearTimeout(mouseOutTimeoutId);
+ // store hovered element locally to update outline when scroll ends
+ hoveredElement = element;
+ updateHoveredInstance(element);
+ }
}
- }
- };
-
- const handleMouseOut = () => {
- mouseOutTimeoutId = setTimeout(() => {
- hoveredElement = undefined;
- $hoveredInstanceSelector.set(undefined);
- $hoveredInstanceOutline.set(undefined);
- }, 100);
+ },
+ eventOptions
+ );
- // Fixes the bug, that new hover occures during timeout
- const unsubscribe = $hoveredInstanceSelector.listen(() => {
- clearTimeout(mouseOutTimeoutId);
- unsubscribe();
- });
- };
+ window.addEventListener(
+ "mouseout",
+ () => {
+ mouseOutTimeoutId = setTimeout(() => {
+ hoveredElement = undefined;
+ $hoveredInstanceSelector.set(undefined);
+ $hoveredInstanceOutline.set(undefined);
+ }, 100);
- const eventOptions = { passive: true };
- window.addEventListener("mouseover", handleMouseOver, eventOptions);
- window.addEventListener("mouseout", handleMouseOut, eventOptions);
+ // Fixes the bug, that new hover occures during timeout
+ const unsubscribe = $hoveredInstanceSelector.listen(() => {
+ clearTimeout(mouseOutTimeoutId);
+ unsubscribe();
+ });
+ },
+ eventOptions
+ );
const updateHoveredRect = (
elements: Element[],
@@ -114,11 +124,9 @@ export const subscribeInstanceHovering = () => {
}
);
- return () => {
- window.removeEventListener("mouseover", handleMouseOver);
- window.removeEventListener("mouseout", handleMouseOut);
+ signal.addEventListener("abort", () => {
unsubscribeScrollState();
clearTimeout(mouseOutTimeoutId);
unsubscribeHoveredInstanceId();
- };
+ });
};
diff --git a/apps/builder/app/canvas/instance-selection.ts b/apps/builder/app/canvas/instance-selection.ts
index 7a41eb0545..dbd3c5445b 100644
--- a/apps/builder/app/canvas/instance-selection.ts
+++ b/apps/builder/app/canvas/instance-selection.ts
@@ -8,7 +8,11 @@ import {
import { $textEditingInstanceSelector } from "~/shared/nano-states";
import { emitCommand } from "./shared/commands";
-export const subscribeInstanceSelection = () => {
+export const subscribeInstanceSelection = ({
+ signal,
+}: {
+ signal: AbortSignal;
+}) => {
let pointerDownElement: undefined | Element = undefined;
let lastPointerUpTime = 0;
let clickCount = 1;
@@ -78,11 +82,6 @@ export const subscribeInstanceSelection = () => {
}
};
- addEventListener("pointerdown", handlePointerDown, { passive: true });
- addEventListener("pointerup", handlePointerUp, { passive: true });
-
- return () => {
- removeEventListener("pointerdown", handlePointerDown);
- removeEventListener("pointerup", handlePointerUp);
- };
+ addEventListener("pointerdown", handlePointerDown, { passive: true, signal });
+ addEventListener("pointerup", handlePointerUp, { passive: true, signal });
};
diff --git a/apps/builder/app/canvas/shared/font-weight-support.ts b/apps/builder/app/canvas/shared/font-weight-support.ts
index b98a2d6a99..50570d19da 100644
--- a/apps/builder/app/canvas/shared/font-weight-support.ts
+++ b/apps/builder/app/canvas/shared/font-weight-support.ts
@@ -81,9 +81,11 @@ const testFontWeights = (fontFamily: string) => {
return supportedWeights.sort();
};
-export const subscribeFontLoadingDone = () => {
- // @todo move it to the call-site
- const abortController = new AbortController();
+export const subscribeFontLoadingDone = ({
+ signal,
+}: {
+ signal: AbortSignal;
+}) => {
document.fonts.addEventListener(
"loadingdone",
() => {
@@ -95,12 +97,8 @@ export const subscribeFontLoadingDone = () => {
}
$detectedFontsWeights.set(cache);
},
- { signal: abortController.signal }
+ { signal }
);
-
- return () => {
- abortController.abort();
- };
};
export const detectSupportedFontWeights = (stack: string) => {
diff --git a/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts b/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts
index 653a642eff..4087f63544 100644
--- a/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts
+++ b/apps/builder/app/canvas/shared/scroll-new-instance-into-view.ts
@@ -7,9 +7,10 @@ import { $instances } from "~/shared/nano-states";
*/
export const subscribeScrollNewInstanceIntoView = (
debounceEffect: (callback: () => void) => void,
- previousInstances: { current?: Instances }
+ previousInstances: { current?: Instances },
+ signal: AbortSignal
) => {
- return $instances.subscribe((instances) => {
+ const unsubscribe = $instances.subscribe((instances) => {
if (previousInstances.current === undefined) {
previousInstances.current = instances;
return;
@@ -36,4 +37,5 @@ export const subscribeScrollNewInstanceIntoView = (
});
});
});
+ signal.addEventListener("abort", unsubscribe);
};
diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.ts
index 397672a8bf..f91ff87c46 100644
--- a/apps/builder/app/canvas/shared/styles.ts
+++ b/apps/builder/app/canvas/shared/styles.ts
@@ -1,4 +1,4 @@
-import { useEffect, useLayoutEffect } from "react";
+import { useLayoutEffect } from "react";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
import {
@@ -307,10 +307,15 @@ export const subscribeStyles = () => {
};
};
-export const useManageDesignModeStyles = () => {
- useEffect(subscribeStateStyles, []);
- useEffect(subscribeEphemeralStyle, []);
- useEffect(subscribePreviewMode, []);
+export const manageDesignModeStyles = ({ signal }: { signal: AbortSignal }) => {
+ const unsubscribeStateStyles = subscribeStateStyles();
+ const unsubscribeEphemeralStyle = subscribeEphemeralStyle();
+ const unsubscribePreviewMode = subscribePreviewMode();
+ signal.addEventListener("abort", () => {
+ unsubscribeStateStyles();
+ unsubscribeEphemeralStyle();
+ unsubscribePreviewMode();
+ });
};
export const GlobalStyles = ({ params }: { params: Params }) => {
diff --git a/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts b/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts
deleted file mode 100644
index 6d7ebb4e90..0000000000
--- a/apps/builder/app/canvas/shared/use-scroll-new-instance-into-view.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { useEffect, useRef } from "react";
-import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
-import { subscribeScrollNewInstanceIntoView } from "./scroll-new-instance-into-view";
-import type { Instances } from "@webstudio-is/sdk";
-
-export const useScrollNewInstanceIntoView = () => {
- const debounceEffect = useDebounceEffect();
- const ref = useRef<Instances>();
- useEffect(() => {
- return subscribeScrollNewInstanceIntoView(debounceEffect, ref);
- }, [debounceEffect]);
-};
diff --git a/apps/builder/app/canvas/use-selected-instance.ts b/apps/builder/app/canvas/use-selected-instance.ts
deleted file mode 100644
index 1a53e13e7c..0000000000
--- a/apps/builder/app/canvas/use-selected-instance.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import { useEffect } from "react";
-import { subscribeSelected } from "./instance-selected";
-import { useDebounceEffect } from "~/shared/hook-utils/use-debounce-effect";
-
-export const useSelectedInstance = () => {
- const debounceEffect = useDebounceEffect();
-
- useEffect(() => {
- return subscribeSelected(debounceEffect);
- }, [debounceEffect]);
-};
diff --git a/apps/builder/app/shared/copy-paste/index.ts b/apps/builder/app/shared/copy-paste/index.ts
index d4da3c3d53..afbe4642f3 100644
--- a/apps/builder/app/shared/copy-paste/index.ts
+++ b/apps/builder/app/shared/copy-paste/index.ts
@@ -1 +1 @@
-export { useCopyPaste } from "./use-copy-paste";
+export { initCopyPaste } from "./init-copy-paste";
diff --git a/apps/builder/app/shared/copy-paste/init-copy-paste.ts b/apps/builder/app/shared/copy-paste/init-copy-paste.ts
index 9dda8c5761..33e3bd98df 100644
--- a/apps/builder/app/shared/copy-paste/init-copy-paste.ts
+++ b/apps/builder/app/shared/copy-paste/init-copy-paste.ts
@@ -3,6 +3,10 @@ import {
$authTokenPermissions,
$textEditingInstanceSelector,
} from "../nano-states";
+import * as instance from "./plugin-instance";
+import * as embedTemplate from "./plugin-embed-template";
+import * as markdown from "./plugin-markdown";
+import * as webflow from "./plugin-webflow/plugin-webflow";
const isTextEditing = (event: ClipboardEvent) => {
// Text is edited on the Canvas using the default Canvas text editor settings.
@@ -80,7 +84,13 @@ type Plugin = {
onPaste?: (data: string) => boolean | Promise<boolean>;
};
-export const initCopyPaste = (plugins: Plugin[]) => {
+const initPlugins = ({
+ plugins,
+ signal,
+}: {
+ plugins: Array<Plugin>;
+ signal: AbortSignal;
+}) => {
const handleCopy = async (event: ClipboardEvent) => {
if (validateClipboardEvent(event) === false) {
return;
@@ -127,15 +137,16 @@ export const initCopyPaste = (plugins: Plugin[]) => {
}
};
- document.addEventListener("copy", handleCopy);
- document.addEventListener("cut", handleCut);
+ document.addEventListener("copy", handleCopy, { signal });
+ document.addEventListener("cut", handleCut, { signal });
// Capture is required so we get the element before content-editable removes it
// This way we can detect when we are inside content-editable and ignore the event
- document.addEventListener("paste", handlePaste, { capture: true });
+ document.addEventListener("paste", handlePaste, { capture: true, signal });
+};
- return () => {
- document.removeEventListener("copy", handleCopy);
- document.removeEventListener("cut", handleCut);
- document.removeEventListener("paste", handlePaste, { capture: true });
- };
+export const initCopyPaste = ({ signal }: { signal: AbortSignal }) => {
+ initPlugins({
+ plugins: [instance, embedTemplate, markdown, webflow],
+ signal,
+ });
};
diff --git a/apps/builder/app/shared/copy-paste/use-copy-paste.ts b/apps/builder/app/shared/copy-paste/use-copy-paste.ts
deleted file mode 100644
index 303615fe4b..0000000000
--- a/apps/builder/app/shared/copy-paste/use-copy-paste.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { useEffect } from "react";
-import { initCopyPaste } from "./init-copy-paste";
-import * as instance from "./plugin-instance";
-import * as embedTemplate from "./plugin-embed-template";
-import * as markdown from "./plugin-markdown";
-import * as webflow from "./plugin-webflow/plugin-webflow";
-
-export const useCopyPaste = () => {
- useEffect(() => {
- return initCopyPaste([instance, embedTemplate, markdown, webflow]);
- }, []);
-};