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: WIP realtime collaboration to builder (#5726)

Oleg Isonenb006947a852e
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index a78943243a..e58525484a 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -27,8 +27,6 @@ import {
$authPermit,
$authToken,
$isPreviewMode,
- $pages,
- $project,
subscribeResources,
$authTokenPermissions,
$isDesignMode,
@@ -38,6 +36,7 @@ import {
$stagingUsername,
$stagingPassword,
} from "~/shared/nano-states";
+import { $project } from "~/shared/sync/data-stores";
import { $settings, type Settings } from "./shared/client-settings";
import { builderUrl, getCanvasUrl } from "~/shared/router-utils";
import { BlockingAlerts } from "./features/blocking-alerts";
@@ -52,6 +51,7 @@ import {
$isCloneDialogOpen,
$loadingState,
} from "./shared/nano-states";
+import { $pages } from "~/shared/sync/data-stores";
import { CloneProjectDialog } from "~/shared/clone-project";
import type { TokenPermissions } from "@webstudio-is/authorization-token";
import { useToastErrors } from "~/shared/error/toast-error";
diff --git a/apps/builder/app/builder/features/address-bar.stories.tsx b/apps/builder/app/builder/features/address-bar.stories.tsx
index 79dbb55dbe..c652a8173b 100644
--- a/apps/builder/app/builder/features/address-bar.stories.tsx
+++ b/apps/builder/app/builder/features/address-bar.stories.tsx
@@ -7,7 +7,8 @@ import { TopbarLayout } from "~/builder/shared/topbar-layout";
import { AddressBarPopover } from "./address-bar";
import { $dataSources, $pages } from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
-import { $awareness, $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
+import { $selectedPageId } from "~/shared/nano-states";
import { $currentSystem } from "~/shared/system";
registerContainers();
@@ -67,7 +68,7 @@ export default {
} satisfies Meta;
export const AddressBar: StoryFn = () => {
- $awareness.set({ pageId: "dynamicId" });
+ $selectedPageId.set("dynamicId");
return (
<StorySection title="Address Bar">
<TopbarLayout
diff --git a/apps/builder/app/builder/features/address-bar.tsx b/apps/builder/app/builder/features/address-bar.tsx
index ce09ce7203..0939d4c555 100644
--- a/apps/builder/app/builder/features/address-bar.tsx
+++ b/apps/builder/app/builder/features/address-bar.tsx
@@ -34,7 +34,7 @@ import {
matchPathnamePattern,
tokenizePathnamePattern,
} from "~/builder/shared/url-pattern";
-import { $selectedPage, $selectedPagePath } from "~/shared/awareness";
+import { $selectedPage, $selectedPagePath } from "~/shared/nano-states";
import { $currentSystem, updateCurrentSystem } from "~/shared/system";
const $selectedPageHistory = computed(
diff --git a/apps/builder/app/builder/features/breakpoints/breakpoints-selector.stories.tsx b/apps/builder/app/builder/features/breakpoints/breakpoints-selector.stories.tsx
index ffc154ecec..b0d6b8cc2a 100644
--- a/apps/builder/app/builder/features/breakpoints/breakpoints-selector.stories.tsx
+++ b/apps/builder/app/builder/features/breakpoints/breakpoints-selector.stories.tsx
@@ -1,6 +1,6 @@
import { StorySection } from "@webstudio-is/design-system";
import { BreakpointsSelector as BreakpointsSelectorComponent } from "./breakpoints-selector";
-import { $breakpoints } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import { $selectedBreakpointId } from "~/shared/nano-states/breakpoints";
const breakpointsMap = new Map([
diff --git a/apps/builder/app/builder/features/breakpoints/breakpoints-selector.tsx b/apps/builder/app/builder/features/breakpoints/breakpoints-selector.tsx
index 503a0651dd..88404365db 100644
--- a/apps/builder/app/builder/features/breakpoints/breakpoints-selector.tsx
+++ b/apps/builder/app/builder/features/breakpoints/breakpoints-selector.tsx
@@ -15,8 +15,8 @@ import { CascadeIndicator } from "./cascade-indicator";
import {
$selectedBreakpoint,
$selectedBreakpointId,
- $breakpoints,
} from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import { groupBreakpoints, isBaseBreakpoint } from "~/shared/breakpoints";
import { setCanvasWidth } from "../../shared/calc-canvas-width";
import { $canvasWidth } from "~/builder/shared/nano-states";
diff --git a/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx b/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
index 69298ddb73..e4659bdced 100644
--- a/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
+++ b/apps/builder/app/builder/features/command-panel/command-panel.stories.tsx
@@ -3,12 +3,10 @@ import { useEffect } from "react";
import { initialBreakpoints, coreMetas } from "@webstudio-is/sdk";
import { createDefaultPages } from "@webstudio-is/project-build";
import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
-import {
- $breakpoints,
- $pages,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
-import { $awareness } from "~/shared/awareness";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import { $pages } from "~/shared/sync/data-stores";
+import { $selectedPageId } from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync/sync-stores";
import { StorySection } from "@webstudio-is/design-system";
import { CommandPanel as CommandPanelComponent } from "./command-panel";
@@ -57,7 +55,7 @@ pages.pages.push({
meta: {},
});
$pages.set(pages);
-$awareness.set({ pageId: pages.homePage.id });
+$selectedPageId.set(pages.homePage.id);
export const CommandPanel: StoryFn = () => {
useEffect(() => {
diff --git a/apps/builder/app/builder/features/command-panel/groups/breakpoints-group.tsx b/apps/builder/app/builder/features/command-panel/groups/breakpoints-group.tsx
index b1bfa9c011..7b642c7dac 100644
--- a/apps/builder/app/builder/features/command-panel/groups/breakpoints-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/breakpoints-group.tsx
@@ -9,10 +9,10 @@ import { computed } from "nanostores";
import { compareMedia } from "@webstudio-is/css-engine";
import type { Breakpoint } from "@webstudio-is/sdk";
import {
- $breakpoints,
$selectedBreakpoint,
$selectedBreakpointId,
} from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import { closeCommandPanel, $isCommandPanelOpen } from "../command-state";
import type { BaseOption } from "../shared/types";
import { setCanvasWidth } from "~/builder/shared/calc-canvas-width";
diff --git a/apps/builder/app/builder/features/command-panel/groups/components-group.tsx b/apps/builder/app/builder/features/command-panel/groups/components-group.tsx
index bdc2fffdb6..4a4a007f7c 100644
--- a/apps/builder/app/builder/features/command-panel/groups/components-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/components-group.tsx
@@ -19,7 +19,7 @@ import {
insertWebstudioFragmentAt,
} from "~/shared/instance-utils";
import { humanizeString } from "~/shared/string-utils";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
import {
getInstanceLabel,
InstanceIcon,
diff --git a/apps/builder/app/builder/features/command-panel/groups/convert-group.tsx b/apps/builder/app/builder/features/command-panel/groups/convert-group.tsx
index fd97c5f1ce..3e7480b0c6 100644
--- a/apps/builder/app/builder/features/command-panel/groups/convert-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/convert-group.tsx
@@ -13,12 +13,10 @@ import {
import { matchSorter } from "match-sorter";
import { computed } from "nanostores";
import { elementComponent, tags } from "@webstudio-is/sdk";
-import {
- $instances,
- $props,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
-import { $selectedInstancePath } from "~/shared/awareness";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
+import { $selectedInstancePath } from "~/shared/nano-states";
import {
getInstanceLabel,
InstanceIcon,
diff --git a/apps/builder/app/builder/features/command-panel/groups/duplicate-tokens-group.tsx b/apps/builder/app/builder/features/command-panel/groups/duplicate-tokens-group.tsx
index 0c8ae332eb..21c8755a89 100644
--- a/apps/builder/app/builder/features/command-panel/groups/duplicate-tokens-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/duplicate-tokens-group.tsx
@@ -17,12 +17,9 @@ import {
useSelectedAction,
} from "@webstudio-is/design-system";
import type { Instance, StyleSource } from "@webstudio-is/sdk";
-import {
- $styleSources,
- $styles,
- $breakpoints,
-} from "~/shared/sync/data-stores";
+import { $styleSources } from "~/shared/sync/data-stores";
import { $selectedStyleSources } from "~/shared/nano-states";
+import { $styles, $breakpoints } from "~/shared/sync/data-stores";
import { findDuplicateTokens } from "~/shared/style-source-utils";
import { $styleSourceUsages } from "~/builder/shared/style-source-actions";
import { InstanceList, showInstance } from "../shared/instance-list";
diff --git a/apps/builder/app/builder/features/command-panel/groups/instances-group.tsx b/apps/builder/app/builder/features/command-panel/groups/instances-group.tsx
index f6644ea962..b84bc44fe4 100644
--- a/apps/builder/app/builder/features/command-panel/groups/instances-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/instances-group.tsx
@@ -11,7 +11,11 @@ import { parseComponentName } from "@webstudio-is/sdk";
import type { Instance } from "@webstudio-is/sdk";
import { $instances, $pages } from "~/shared/sync/data-stores";
import { getInstanceLabel } from "~/builder/shared/instance-label";
-import { $awareness, findAwarenessByInstanceId } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
+import { findPageAndSelectorByInstanceId } from "~/shared/instance-utils";
import { closeCommandPanel, $isCommandPanelOpen } from "../command-state";
import type { BaseOption } from "../shared/types";
import { setActiveSidebarPanel } from "~/builder/shared/nano-states";
@@ -79,13 +83,14 @@ export const InstancesGroup = ({ options }: { options: InstanceOption[] }) => {
const pages = $pages.get();
const instances = $instances.get();
if (pages && instances) {
- const awareness = findAwarenessByInstanceId(
+ const awareness = findPageAndSelectorByInstanceId(
pages,
instances,
instance.id
);
if (awareness) {
- $awareness.set(awareness);
+ $selectedPageId.set(awareness.pageId);
+ $selectedInstanceSelector.set(awareness.instanceSelector);
setActiveSidebarPanel("auto");
}
}
diff --git a/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx b/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
index 85a7c81a73..c6e0d0a9d5 100644
--- a/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/pages-group.tsx
@@ -9,7 +9,8 @@ import { computed } from "nanostores";
import type { Page } from "@webstudio-is/sdk";
import { $pages } from "~/shared/sync/data-stores";
import { $editingPageId } from "~/shared/nano-states";
-import { $selectedPage, selectPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
+import { selectPage } from "~/shared/nano-states";
import { setActiveSidebarPanel } from "~/builder/shared/nano-states";
import { closeCommandPanel, $isCommandPanelOpen } from "../command-state";
import type { BaseOption } from "../shared/types";
diff --git a/apps/builder/app/builder/features/command-panel/groups/tags-group.tsx b/apps/builder/app/builder/features/command-panel/groups/tags-group.tsx
index b95a71d626..f6aad5936c 100644
--- a/apps/builder/app/builder/features/command-panel/groups/tags-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/tags-group.tsx
@@ -9,13 +9,11 @@ import {
import { computed } from "nanostores";
import { elementComponent, tags } from "@webstudio-is/sdk";
import type { Instance } from "@webstudio-is/sdk";
-import {
- $instances,
- $props,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
import { insertWebstudioFragmentAt } from "~/shared/instance-utils";
-import { $selectedInstancePath } from "~/shared/awareness";
+import { $selectedInstancePath } from "~/shared/nano-states";
import { InstanceIcon } from "~/builder/shared/instance-label";
import { isTreeSatisfyingContentModel } from "~/shared/content-model";
import { closeCommandPanel, $isCommandPanelOpen } from "../command-state";
diff --git a/apps/builder/app/builder/features/command-panel/groups/wrap-group.test.tsx b/apps/builder/app/builder/features/command-panel/groups/wrap-group.test.tsx
index 9661b27768..fa8238b541 100644
--- a/apps/builder/app/builder/features/command-panel/groups/wrap-group.test.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/wrap-group.test.tsx
@@ -4,14 +4,12 @@ import * as baseMetas from "@webstudio-is/sdk-components-react/metas";
import * as animationMetas from "@webstudio-is/sdk-components-animation/metas";
import { createDefaultPages } from "@webstudio-is/project-build";
import { $, renderData } from "@webstudio-is/template";
-import {
- $instances,
- $pages,
- $props,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $pages, $props } from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
-import { $awareness, selectInstance } from "~/shared/awareness";
+import { $selectedPageId } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { __testing__ } from "./wrap-group";
const { canWrapInstance } = __testing__;
@@ -25,7 +23,7 @@ const metas = new Map(
beforeEach(() => {
$registeredComponentMetas.set(metas);
$pages.set(createDefaultPages({ rootInstanceId: "" }));
- $awareness.set({ pageId: "" });
+ $selectedPageId.set("");
});
describe("canWrapInstance for components", () => {
diff --git a/apps/builder/app/builder/features/command-panel/groups/wrap-group.tsx b/apps/builder/app/builder/features/command-panel/groups/wrap-group.tsx
index 209f982c94..ff3ff13951 100644
--- a/apps/builder/app/builder/features/command-panel/groups/wrap-group.tsx
+++ b/apps/builder/app/builder/features/command-panel/groups/wrap-group.tsx
@@ -19,12 +19,10 @@ import type {
Props,
WsComponentMeta,
} from "@webstudio-is/sdk";
-import {
- $instances,
- $props,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
-import { $selectedInstancePath } from "~/shared/awareness";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
+import { $selectedInstancePath } from "~/shared/nano-states";
import {
getInstanceLabel,
InstanceIcon,
diff --git a/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx b/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
index 36dac6710c..61b826adfa 100644
--- a/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
+++ b/apps/builder/app/builder/features/command-panel/shared/instance-list.tsx
@@ -18,9 +18,12 @@ import { $instances, $pages } from "~/shared/sync/data-stores";
import { getInstanceLabel } from "~/builder/shared/instance-label";
import { buildInstancePath } from "~/shared/instance-utils";
import { $commandContent } from "~/builder/features/command-panel/command-state";
-import { findAwarenessByInstanceId } from "~/shared/awareness";
-import { $awareness } from "~/shared/awareness";
+import { findPageAndSelectorByInstanceId } from "~/shared/instance-utils";
import { $activeInspectorPanel } from "~/builder/shared/nano-states";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { useAutoSelectFirstItem } from "./auto-select";
import { InstancePathFooter } from "./instance-path-footer";
@@ -53,7 +56,11 @@ export const InstanceList = ({
continue;
}
const path = buildInstancePath(instanceId, pages, instances);
- const awareness = findAwarenessByInstanceId(pages, instances, instanceId);
+ const awareness = findPageAndSelectorByInstanceId(
+ pages,
+ instances,
+ instanceId
+ );
const page = pages.pages.find((p) => p.id === awareness.pageId);
usedInInstances.push({
label: getInstanceLabel(instance),
@@ -154,8 +161,13 @@ export const showInstance = (
if (pagesData === undefined) {
return;
}
- const awareness = findAwarenessByInstanceId(pagesData, instances, instanceId);
- $awareness.set(awareness);
+ const { pageId, instanceSelector } = findPageAndSelectorByInstanceId(
+ pagesData,
+ instances,
+ instanceId
+ );
+ $selectedPageId.set(pageId);
+ $selectedInstanceSelector.set(instanceSelector);
if (panel !== undefined) {
$activeInspectorPanel.set(panel);
}
diff --git a/apps/builder/app/builder/features/components/components.tsx b/apps/builder/app/builder/features/components/components.tsx
index 85abecdfcd..6696c5032a 100644
--- a/apps/builder/app/builder/features/components/components.tsx
+++ b/apps/builder/app/builder/features/components/components.tsx
@@ -36,7 +36,7 @@ import {
insertWebstudioFragmentAt,
} from "~/shared/instance-utils";
import type { Publish } from "~/shared/pubsub";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
import { mapGroupBy } from "~/shared/shim";
import {
getInstanceLabel,
diff --git a/apps/builder/app/builder/features/footer/breadcrumbs.tsx b/apps/builder/app/builder/features/footer/breadcrumbs.tsx
index b8df155354..9e21c93c14 100644
--- a/apps/builder/app/builder/features/footer/breadcrumbs.tsx
+++ b/apps/builder/app/builder/features/footer/breadcrumbs.tsx
@@ -3,7 +3,8 @@ import { useStore } from "@nanostores/react";
import { ChevronRightIcon } from "@webstudio-is/icons";
import { theme, Button, Flex, Text } from "@webstudio-is/design-system";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
-import { $selectedInstancePath, selectInstance } from "~/shared/awareness";
+import { $selectedInstancePath } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { getInstanceLabel } from "~/builder/shared/instance-label";
export const Breadcrumbs = () => {
diff --git a/apps/builder/app/builder/features/marketplace/templates.tsx b/apps/builder/app/builder/features/marketplace/templates.tsx
index e6e2f3a1a4..a128f66db6 100644
--- a/apps/builder/app/builder/features/marketplace/templates.tsx
+++ b/apps/builder/app/builder/features/marketplace/templates.tsx
@@ -35,7 +35,7 @@ import { builderApi } from "~/shared/builder-api";
import { insertPageCopyMutable } from "~/shared/page-utils";
import { Card } from "./card";
import type { MarketplaceOverviewItem } from "~/shared/marketplace/types";
-import { selectPage } from "~/shared/awareness";
+import { selectPage } from "~/shared/nano-states";
const isBody = (instance: Instance) =>
instance.component === "Body" ||
diff --git a/apps/builder/app/builder/features/navigator/css-preview.tsx b/apps/builder/app/builder/features/navigator/css-preview.tsx
index 1afe573927..7736025bf4 100644
--- a/apps/builder/app/builder/features/navigator/css-preview.tsx
+++ b/apps/builder/app/builder/features/navigator/css-preview.tsx
@@ -12,7 +12,7 @@ import { CollapsibleSection } from "~/builder/shared/collapsible-section";
import { highlightCss } from "~/shared/code-highlight";
import type { ComputedStyleDecl } from "~/shared/style-object-model";
import { $computedStyleDeclarations } from "~/builder/features/style-panel/shared/model";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
const preStyle = css(textVariants.mono, {
margin: 0,
diff --git a/apps/builder/app/builder/features/navigator/navigator-tree.tsx b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
index 517dc4c177..e18232edbf 100644
--- a/apps/builder/app/builder/features/navigator/navigator-tree.tsx
+++ b/apps/builder/app/builder/features/navigator/navigator-tree.tsx
@@ -40,27 +40,26 @@ import {
$blockChildOutline,
$editingItemSelector,
$hoveredInstanceSelector,
- $instances,
$isContentMode,
- $props,
$propsIndex,
$propValuesByInstanceSelector,
$registeredComponentMetas,
- $selectedInstanceSelector,
getIndexedInstanceId,
type ItemDropTarget,
$propValuesByInstanceSelectorWithMemoryProps,
} from "~/shared/nano-states";
+import { $instances, $props } from "~/shared/sync/data-stores";
import { isDescendantOrSelf, type InstanceSelector } from "~/shared/tree-utils";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { reparentInstance, toggleInstanceShow } from "~/shared/instance-utils";
import { emitCommand } from "~/builder/shared/commands";
import { useContentEditable } from "~/shared/dom-hooks";
import {
+ $selectedInstanceSelector,
$selectedPage,
getInstanceKey,
- selectInstance,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import {
findClosestContainer,
isRichTextContent,
diff --git a/apps/builder/app/builder/features/pages/page-settings.stories.tsx b/apps/builder/app/builder/features/pages/page-settings.stories.tsx
index 6fe9538a23..9846d301a3 100644
--- a/apps/builder/app/builder/features/pages/page-settings.stories.tsx
+++ b/apps/builder/app/builder/features/pages/page-settings.stories.tsx
@@ -1,4 +1,4 @@
-import { $pages } from "~/shared/nano-states/pages";
+import { $pages } from "~/shared/sync/data-stores";
import { PageSettings as PageSettingsComponent } from "./page-settings";
import {
Grid,
diff --git a/apps/builder/app/builder/features/pages/page-settings.tsx b/apps/builder/app/builder/features/pages/page-settings.tsx
index 859a867017..fd3c8d35e0 100644
--- a/apps/builder/app/builder/features/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/pages/page-settings.tsx
@@ -68,15 +68,14 @@ import {
} from "@webstudio-is/icons";
import { useIds } from "~/shared/form-utils";
import {
- $assets,
- $instances,
- $pages,
$publishedOrigin,
- $project,
$permissions,
$isDesignMode,
} from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $project } from "~/shared/sync/data-stores";
import { $openProjectSettings } from "~/shared/nano-states/project-settings";
+import { $instances, $pages } from "~/shared/sync/data-stores";
import {
BindingControl,
BindingPopover,
@@ -92,7 +91,7 @@ import {
validatePathnamePattern,
} from "~/builder/shared/url-pattern";
import { useUnmount } from "~/shared/hook-utils/use-mount";
-import { selectInstance } from "~/shared/awareness";
+import { selectInstance } from "~/shared/nano-states";
import { computeExpression } from "~/shared/data-variables";
import { $currentSystem } from "~/shared/system";
import { Card } from "../marketplace/card";
diff --git a/apps/builder/app/builder/features/pages/page-utils.test.ts b/apps/builder/app/builder/features/pages/page-utils.test.ts
index ab86ef7b90..96628ed5fb 100644
--- a/apps/builder/app/builder/features/pages/page-utils.test.ts
+++ b/apps/builder/app/builder/features/pages/page-utils.test.ts
@@ -23,15 +23,15 @@ import {
reparentPageOrFolderMutable,
deletePageMutable,
} from "./page-utils";
+import { $dataSourceVariables } from "~/shared/nano-states";
import {
- $dataSourceVariables,
$dataSources,
$pages,
$project,
$resources,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
-import { $awareness } from "~/shared/awareness";
+import { $selectedPageId } from "~/shared/nano-states";
import { updateCurrentSystem } from "~/shared/system";
import { $resourcesCache, getResourceKey } from "~/shared/resources";
@@ -464,7 +464,7 @@ test("page root scope should rely on selected page", () => {
meta: {},
});
$pages.set(pages);
- $awareness.set({ pageId: "pageId" });
+ $selectedPageId.set("pageId");
$dataSources.set(
toMap([
{
@@ -506,7 +506,7 @@ test("page root scope should use variable and resource values", () => {
homePageId: "homePageId",
})
);
- $awareness.set({ pageId: "homePageId" });
+ $selectedPageId.set("homePageId");
$dataSources.set(
toMap([
{
@@ -574,7 +574,7 @@ test("page root scope should provide page system variable value", () => {
systemDataSourceId: "systemId",
})
);
- $awareness.set({ pageId: "homePageId" });
+ $selectedPageId.set("homePageId");
$dataSources.set(
toMap([
{
diff --git a/apps/builder/app/builder/features/pages/page-utils.ts b/apps/builder/app/builder/features/pages/page-utils.ts
index 6e9515b623..7fea31b8dc 100644
--- a/apps/builder/app/builder/features/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/pages/page-utils.ts
@@ -21,18 +21,16 @@ import {
deleteInstanceMutable,
updateWebstudioData,
} from "~/shared/instance-utils";
-import {
- $dataSources,
- $pages,
- $variableValuesByInstanceSelector,
-} from "~/shared/nano-states";
+import { $variableValuesByInstanceSelector } from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
+import { $pages } from "~/shared/sync/data-stores";
import { insertPageCopyMutable } from "~/shared/page-utils";
import {
$selectedPage,
getInstanceKey,
getInstancePath,
- selectPage,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
+import { selectPage } from "~/shared/nano-states";
/**
* When page or folder needs to be deleted or moved to a different parent,
diff --git a/apps/builder/app/builder/features/pages/pages.tsx b/apps/builder/app/builder/features/pages/pages.tsx
index fc8e606eb3..9f69f98cd5 100644
--- a/apps/builder/app/builder/features/pages/pages.tsx
+++ b/apps/builder/app/builder/features/pages/pages.tsx
@@ -36,8 +36,8 @@ import {
$editingPageId,
$isContentMode,
$isDesignMode,
- $pages,
} from "~/shared/nano-states";
+import { $pages } from "~/shared/sync/data-stores";
import {
getAllChildrenAndSelf,
reparentOrphansMutable,
@@ -66,7 +66,8 @@ import {
import { atom, computed } from "nanostores";
import { isPathnamePattern } from "~/builder/shared/url-pattern";
import { updateWebstudioData } from "~/shared/instance-utils";
-import { $selectedPage, selectPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
+import { selectPage } from "~/shared/nano-states";
const ItemSuffix = ({
isParentSelected,
diff --git a/apps/builder/app/builder/features/publish/publish.tsx b/apps/builder/app/builder/features/publish/publish.tsx
index 4c1be46287..c846cf6506 100644
--- a/apps/builder/app/builder/features/publish/publish.tsx
+++ b/apps/builder/app/builder/features/publish/publish.tsx
@@ -43,28 +43,25 @@ import {
} from "@webstudio-is/design-system";
import { validateProjectDomain, type Project } from "@webstudio-is/project";
import {
- $awareness,
$selectedPagePath,
- findAwarenessByInstanceId,
- type Awareness,
-} from "~/shared/awareness";
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
+import { findPageAndSelectorByInstanceId } from "~/shared/instance-utils";
+import { $selectedPageId } from "~/shared/nano-states";
import {
$authTokenPermissions,
- $dataSources,
$editingPageId,
- $instances,
- $pages,
- $project,
$publishedOrigin,
$permissions,
$stagingUsername,
$stagingPassword,
- $publisherHost,
} from "~/shared/nano-states";
+import { $publisherHost } from "~/shared/sync/data-stores";
import {
$publishDialog,
setActiveSidebarPanel,
} from "../../shared/nano-states";
+import { $project } from "~/shared/sync/data-stores";
import { Domains, PENDING_TIMEOUT, getPublishStatusAndText } from "./domains";
import { CollapsibleDomainSection } from "./collapsible-domain-section";
import {
@@ -83,6 +80,7 @@ import { isPathnamePattern, type Templates } from "@webstudio-is/sdk";
import { DomainCheckbox, domainToPublishName } from "./domain-checkbox";
import { CopyToClipboard } from "~/shared/copy-to-clipboard";
import { $openProjectSettings } from "~/shared/nano-states/project-settings";
+import { $dataSources, $instances, $pages } from "~/shared/sync/data-stores";
import { RelativeTime } from "~/builder/shared/relative-time";
import cmsUpgradeBanner from "~/shared/cms-upgrade-banner.svg?url";
@@ -327,7 +325,11 @@ const $restrictedFeatures = computed(
const features = new Map<
string,
| undefined
- | { awareness?: Awareness; view?: "pageSettings"; info?: ReactNode }
+ | {
+ navigate?: { pageId: string; instanceSelector: string[] };
+ view?: "pageSettings";
+ info?: ReactNode;
+ }
>();
if (pages === undefined) {
return features;
@@ -342,16 +344,16 @@ const $restrictedFeatures = computed(
if (!permissions.allowDynamicData) {
// pages with dynamic paths
for (const page of [pages.homePage, ...pages.pages]) {
- const awareness = {
+ const navigate = {
pageId: page.id,
instanceSelector: [page.rootInstanceId],
};
// allow catch all for 404 pages on free plan
if (isPathnamePattern(page.path) && page.path !== "/*") {
- features.set("Dynamic path", { awareness, view: "pageSettings" });
+ features.set("Dynamic path", { navigate, view: "pageSettings" });
}
if (page.meta.redirect && page.meta.redirect !== `""`) {
- features.set("Redirect", { awareness, view: "pageSettings" });
+ features.set("Redirect", { navigate, view: "pageSettings" });
}
}
// has resource variables
@@ -359,7 +361,11 @@ const $restrictedFeatures = computed(
if (dataSource.type === "resource") {
const instanceId = dataSource.scopeInstanceId ?? "";
features.set("Resource variable", {
- awareness: findAwarenessByInstanceId(pages, instances, instanceId),
+ navigate: findPageAndSelectorByInstanceId(
+ pages,
+ instances,
+ instanceId
+ ),
});
}
}
@@ -410,7 +416,11 @@ const Publish = ({
restrictedFeatures: Map<
string,
| undefined
- | { awareness?: Awareness; view?: "pageSettings"; info?: ReactNode }
+ | {
+ navigate?: { pageId: string; instanceSelector: string[] };
+ view?: "pageSettings";
+ info?: ReactNode;
+ }
>;
}) => {
const { maxDailyPublishesPerUser } = useStore($permissions);
@@ -850,18 +860,21 @@ const UpgradeBanner = ({ hasCustomDomains }: { hasCustomDomains: boolean }) => {
<Text variant="regularBold">Following Pro features are used:</Text>
<Text as="ul" color="destructive" css={{ paddingLeft: "1em" }}>
{Array.from(restrictedFeatures).map(
- ([message, { awareness, view, info } = {}], index) => (
+ ([message, { navigate, view, info } = {}], index) => (
<li key={index}>
<Flex align="center" gap="1">
- {awareness ? (
+ {navigate ? (
<button
className={buttonLinkClass}
type="button"
onClick={() => {
- $awareness.set(awareness);
+ $selectedPageId.set(navigate.pageId);
+ $selectedInstanceSelector.set(
+ navigate.instanceSelector
+ );
if (view === "pageSettings") {
setActiveSidebarPanel("pages");
- $editingPageId.set(awareness.pageId);
+ $editingPageId.set(navigate.pageId);
}
}}
>
diff --git a/apps/builder/app/builder/features/settings-panel/controls/resource-control.tsx b/apps/builder/app/builder/features/settings-panel/controls/resource-control.tsx
index e596be45a5..c17ee806a1 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/resource-control.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/resource-control.tsx
@@ -26,19 +26,16 @@ import {
validatePrimitiveValue,
type BindingVariant,
} from "~/builder/shared/binding-popover";
-import {
- $dataSources,
- $props,
- $resources,
- $variableValuesByInstanceSelector,
-} from "~/shared/nano-states";
+import { $variableValuesByInstanceSelector } from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
+import { $props, $resources } from "~/shared/sync/data-stores";
import { computeExpression } from "~/shared/data-variables";
import { updateWebstudioData } from "~/shared/instance-utils";
import {
$selectedInstance,
$selectedInstanceKeyWithRoot,
$selectedPage,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import {
UrlField,
MethodField,
diff --git a/apps/builder/app/builder/features/settings-panel/controls/tag-control.tsx b/apps/builder/app/builder/features/settings-panel/controls/tag-control.tsx
index 2e9acf45b7..5bcace0b6c 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/tag-control.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/tag-control.tsx
@@ -4,14 +4,12 @@ import { useStore } from "@nanostores/react";
import { Box, Combobox, Select, theme } from "@webstudio-is/design-system";
import { elementsByTag } from "@webstudio-is/html-data";
import { tags } from "@webstudio-is/sdk";
-import { $selectedInstance, $selectedInstancePath } from "~/shared/awareness";
+import { $selectedInstance, $selectedInstancePath } from "~/shared/nano-states";
import { updateWebstudioData } from "~/shared/instance-utils";
import { isTreeSatisfyingContentModel } from "~/shared/content-model";
-import {
- $instances,
- $props,
- $registeredComponentMetas,
-} from "~/shared/nano-states";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
import { type ControlProps, VerticalLayout } from "../shared";
import { FieldLabel } from "../property-label";
diff --git a/apps/builder/app/builder/features/settings-panel/property-label.tsx b/apps/builder/app/builder/features/settings-panel/property-label.tsx
index 1b28719e25..18f1fc97ba 100644
--- a/apps/builder/app/builder/features/settings-panel/property-label.tsx
+++ b/apps/builder/app/builder/features/settings-panel/property-label.tsx
@@ -16,7 +16,7 @@ import { AlertIcon } from "@webstudio-is/icons";
import type { Prop } from "@webstudio-is/sdk";
import { showAttribute } from "@webstudio-is/react-sdk";
import { updateWebstudioData } from "~/shared/instance-utils";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { $props } from "~/shared/sync/data-stores";
import {
$selectedInstanceInitialPropNames,
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/animation/set-css-property.ts b/apps/builder/app/builder/features/settings-panel/props-section/animation/set-css-property.ts
index 76e4230237..4784e8ba2d 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/animation/set-css-property.ts
+++ b/apps/builder/app/builder/features/settings-panel/props-section/animation/set-css-property.ts
@@ -10,7 +10,7 @@ import {
type StyleSourceSelections,
} from "@webstudio-is/sdk";
-import { isBaseBreakpoint } from "~/shared/nano-states";
+import { isBaseBreakpoint } from "~/shared/breakpoints-utils";
import { camelCaseProperty } from "@webstudio-is/css-data";
export const setListedCssProperty =
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/animation/subject-select.tsx b/apps/builder/app/builder/features/settings-panel/props-section/animation/subject-select.tsx
index 1eb94e1d7c..98d4af6845 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/animation/subject-select.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/animation/subject-select.tsx
@@ -3,10 +3,10 @@ import { nanoid } from "nanoid";
import { useState } from "react";
import {
$hoveredInstanceSelector,
- $instances,
$registeredComponentMetas,
- $selectedInstanceSelector,
} from "~/shared/nano-states";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { getInstanceStyleDecl } from "~/builder/features/style-panel/shared/model";
import { updateWebstudioData } from "~/shared/instance-utils";
import { toValue } from "@webstudio-is/css-engine";
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/match-media-breakpoints.test.ts b/apps/builder/app/builder/features/settings-panel/props-section/match-media-breakpoints.test.ts
index fd69d0c44b..53237a4211 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/match-media-breakpoints.test.ts
+++ b/apps/builder/app/builder/features/settings-panel/props-section/match-media-breakpoints.test.ts
@@ -1,16 +1,16 @@
-import { describe, it, expect } from "vitest";
+import { describe, test, expect } from "vitest";
import { matchMediaBreakpoints } from "./match-media-breakpoints";
import type { IsEqual } from "type-fest";
describe("matchMediaBreakpoints", () => {
- it("returns undefined when values array is undefined", () => {
+ test("returns undefined when values array is undefined", () => {
const matchingBreakpointIds = ["mobile", "tablet", "desktop"];
const matcher = matchMediaBreakpoints(matchingBreakpointIds);
expect(matcher(undefined)).toBeUndefined();
});
- it("returns undefined when no matching breakpoints are found", () => {
+ test("returns undefined when no matching breakpoints are found", () => {
const matchingBreakpointIds = ["mobile", "tablet", "desktop"];
const values: Array<[string, number]> = [
["other-breakpoint", 100],
@@ -22,7 +22,7 @@ describe("matchMediaBreakpoints", () => {
expect(matcher(values)).toBeUndefined();
});
- it("returns the value of the last matching breakpoint", () => {
+ test("returns the value of the last matching breakpoint", () => {
const matchingBreakpointIds = ["mobile", "tablet"];
const values: Array<[string, number]> = [
["mobile", 320],
@@ -35,7 +35,7 @@ describe("matchMediaBreakpoints", () => {
expect(matcher(values)).toBe(768);
});
- it("preserves the value type", () => {
+ test("preserves the value type", () => {
const matchingBreakpointIds = ["mobile", "tablet", "desktop"];
const stringValues: Array<[string, string]> = [["mobile", "small"]];
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
index 05daa18206..8f5e5b9edc 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.stories.tsx
@@ -9,15 +9,11 @@ import {
} from "@webstudio-is/design-system";
import { PropsSection as PropsSectionComponent } from "./props-section";
import { usePropsLogic } from "./use-props-logic";
-import {
- $assets,
- $instances,
- $pages,
- $props,
- registerComponentLibrary,
-} from "~/shared/nano-states";
+import { registerComponentLibrary } from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $instances, $pages, $props } from "~/shared/sync/data-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import { $selectedPageId } from "~/shared/nano-states";
let id = 0;
const unique = () => `${++id}`;
@@ -95,7 +91,7 @@ const rootInstance = addLinkableSections(
["company", "employees"],
$pages.get()?.pages[0]
);
-$awareness.set({ pageId: $pages.get()?.homePage.id ?? "" });
+$selectedPageId.set($pages.get()?.homePage.id ?? "");
const instance: Instance = {
id: instanceId,
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
index f371a31867..94a920b28e 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
@@ -26,15 +26,15 @@ import {
import {
$propValuesByInstanceSelector,
$propsIndex,
- $props,
$isDesignMode,
$isContentMode,
$memoryProps,
$selectedBreakpoint,
} from "~/shared/nano-states";
+import { $props } from "~/shared/sync/data-stores";
import { CollapsibleSectionWithAddButton } from "~/builder/shared/collapsible-section";
import { serverSyncStore } from "~/shared/sync/sync-stores";
-import { $selectedInstance, $selectedInstanceKey } from "~/shared/awareness";
+import { $selectedInstance, $selectedInstanceKey } from "~/shared/nano-states";
import { renderControl } from "../controls/combined";
import { usePropsLogic, type PropAndMeta } from "./use-props-logic";
import { AnimationSection } from "./animation/animation-section";
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
index 1eff9bb6db..494095e7db 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
+++ b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
@@ -10,13 +10,13 @@ import {
textContentAttribute,
} from "@webstudio-is/react-sdk";
import {
- $instances,
$isContentMode,
- $props,
$registeredComponentMetas,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
import { isRichText } from "~/shared/content-model";
-import { $selectedInstance, $selectedInstancePath } from "~/shared/awareness";
+import { $selectedInstance, $selectedInstancePath } from "~/shared/nano-states";
import {
$selectedInstanceInitialPropNames,
$selectedInstancePropsMetas,
diff --git a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx b/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
index 4e0c90f87e..a0d15ba600 100644
--- a/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
+++ b/apps/builder/app/builder/features/settings-panel/resource-panel.tsx
@@ -47,11 +47,9 @@ import {
} from "@webstudio-is/design-system";
import { TrashIcon, InfoCircleIcon, PlusIcon } from "@webstudio-is/icons";
import { humanizeString } from "~/shared/string-utils";
-import {
- $dataSources,
- $resources,
- $variableValuesByInstanceSelector,
-} from "~/shared/nano-states";
+import { $variableValuesByInstanceSelector } from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
+import { $resources } from "~/shared/sync/data-stores";
import {
BindingControl,
BindingPopover,
@@ -69,7 +67,7 @@ import {
$selectedPage,
getInstanceKey,
type InstancePath,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import { updateWebstudioData } from "~/shared/instance-utils";
import { rebindTreeVariablesMutable } from "~/shared/data-variables";
import { parseCurl, type CurlRequest } from "./curl";
diff --git a/apps/builder/app/builder/features/settings-panel/settings-section.tsx b/apps/builder/app/builder/features/settings-panel/settings-section.tsx
index 589b7d32f5..718d809f88 100644
--- a/apps/builder/app/builder/features/settings-panel/settings-section.tsx
+++ b/apps/builder/app/builder/features/settings-panel/settings-section.tsx
@@ -5,7 +5,7 @@ import { InputField } from "@webstudio-is/design-system";
import { $instances } from "~/shared/sync/data-stores";
import { HorizontalLayout, Label, Row, useLocalValue } from "./shared";
import { serverSyncStore } from "~/shared/sync/sync-stores";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { getInstanceLabel } from "~/builder/shared/instance-label";
const saveLabel = (label: string, selectedInstance: Instance) => {
diff --git a/apps/builder/app/builder/features/settings-panel/shared.tsx b/apps/builder/app/builder/features/settings-panel/shared.tsx
index 9e6f9b2f6c..99e0921d5f 100644
--- a/apps/builder/app/builder/features/settings-panel/shared.tsx
+++ b/apps/builder/app/builder/features/settings-panel/shared.tsx
@@ -42,16 +42,16 @@ import {
} from "@webstudio-is/design-system";
import {
$dataSourceVariables,
- $dataSources,
$registeredComponentMetas,
$variableValuesByInstanceSelector,
} from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
import type { BindingVariant } from "~/builder/shared/binding-popover";
import { humanizeString } from "~/shared/string-utils";
import {
$selectedInstance,
$selectedInstanceKeyWithRoot,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import { $instanceTags } from "../style-panel/shared/model";
export const showAttributeMeta: PropMeta = {
diff --git a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx b/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
index 64b4c02d19..6852d651e7 100644
--- a/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variable-popover.tsx
@@ -54,17 +54,15 @@ import {
formatValue,
} from "~/builder/shared/expression-editor";
import {
- $dataSources,
- $resources,
$permissions,
- $instances,
- $props,
$variableValuesByInstanceSelector,
} from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
+import { $resources, $instances, $props } from "~/shared/sync/data-stores";
import {
$selectedInstance,
$selectedInstanceKeyWithRoot,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import {
EditorContent,
EditorDialog,
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
index fdd54cd9ad..59ecab1031 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.stories.tsx
@@ -4,7 +4,7 @@ import { createDefaultPages } from "@webstudio-is/project-build";
import { $pages, $instances } from "~/shared/sync/data-stores";
import { $planFeatures } from "~/shared/nano-states";
import { registerContainers } from "~/shared/sync/sync-stores";
-import { $awareness } from "~/shared/awareness";
+import { $selectedPageId } from "~/shared/nano-states";
import { VariablesSection as VariablesSectionComponent } from "./variables-section";
$planFeatures.set({
@@ -24,7 +24,8 @@ $instances.set(
])
);
$pages.set(createDefaultPages({ rootInstanceId: "box" }));
-$awareness.set({ pageId: "home", instanceSelector: ["box"] });
+$selectedPageId.set("home");
+// awareness not needed for stories - instanceSelector set via selectInstance if required
export const VariablesSection: StoryObj = {
render: () => (
diff --git a/apps/builder/app/builder/features/settings-panel/variables-section.tsx b/apps/builder/app/builder/features/settings-panel/variables-section.tsx
index cdb8f4c145..044e09cb0d 100644
--- a/apps/builder/app/builder/features/settings-panel/variables-section.tsx
+++ b/apps/builder/app/builder/features/settings-panel/variables-section.tsx
@@ -22,14 +22,14 @@ import {
import { EllipsesIcon, PlusIcon } from "@webstudio-is/icons";
import type { DataSource } from "@webstudio-is/sdk";
import { findPageByIdOrPath } from "@webstudio-is/sdk";
+import { $variableValuesByInstanceSelector } from "~/shared/nano-states";
+import { $dataSources } from "~/shared/sync/data-stores";
import {
- $dataSources,
$instances,
$pages,
$props,
$resources,
- $variableValuesByInstanceSelector,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import {
CollapsibleSectionRoot,
useOpenState,
@@ -40,7 +40,7 @@ import {
$selectedInstance,
$selectedInstanceKeyWithRoot,
$selectedPage,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import { updateWebstudioData } from "~/shared/instance-utils";
import {
deleteVariableMutable,
diff --git a/apps/builder/app/builder/features/style-panel/property-label.tsx b/apps/builder/app/builder/features/style-panel/property-label.tsx
index 48176764ce..1e2f44d2d8 100644
--- a/apps/builder/app/builder/features/style-panel/property-label.tsx
+++ b/apps/builder/app/builder/features/style-panel/property-label.tsx
@@ -17,12 +17,9 @@ import {
IconLink,
} from "@webstudio-is/design-system";
import { humanizeString } from "~/shared/string-utils";
-import {
- $breakpoints,
- $instances,
- $registeredComponentMetas,
- $styleSources,
-} from "~/shared/nano-states";
+import { $registeredComponentMetas } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import { $instances, $styleSources } from "~/shared/sync/data-stores";
import type {
ComputedStyleDecl,
StyleValueSourceColor,
@@ -31,7 +28,7 @@ import { useComputedStyles } from "./shared/model";
import { useReadonly } from "./shared/readonly";
import { StyleSourceBadge } from "./style-source";
import { createBatchUpdate } from "./shared/use-style-data";
-import { $virtualInstances } from "~/shared/awareness";
+import { $virtualInstances } from "~/shared/nano-states";
import { getInstanceLabel } from "~/builder/shared/instance-label";
const $isAltPressed = atom(false);
diff --git a/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.tsx b/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.tsx
index b6de24ae0b..8b7e28cc90 100644
--- a/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/advanced/advanced.tsx
@@ -21,7 +21,7 @@ import { useComputedStyles } from "../../shared/model";
import { getDots } from "../../shared/style-section";
import { CssEditor } from "../../../../shared/css-editor";
import { $advancedStyleDeclarations } from "./stores";
-import { $selectedInstanceKey } from "~/shared/awareness";
+import { $selectedInstanceKey } from "~/shared/nano-states";
import { useReadonly } from "../../shared/readonly";
// Only here to keep the same section module interface
diff --git a/apps/builder/app/builder/features/style-panel/sections/advanced/stores.ts b/apps/builder/app/builder/features/style-panel/sections/advanced/stores.ts
index fecf729bdf..e28b04281d 100644
--- a/apps/builder/app/builder/features/style-panel/sections/advanced/stores.ts
+++ b/apps/builder/app/builder/features/style-panel/sections/advanced/stores.ts
@@ -2,7 +2,7 @@ import { computed } from "nanostores";
import type { CssProperty } from "@webstudio-is/css-engine";
import { ROOT_INSTANCE_ID } from "@webstudio-is/sdk";
import { $settings } from "~/builder/shared/client-settings";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import type { ComputedStyleDecl } from "~/shared/style-object-model";
import { $computedStyleDeclarations } from "../../shared/model";
import { sections } from "../sections";
diff --git a/apps/builder/app/builder/features/style-panel/sections/backdrop-filter/backdrop-filter.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/backdrop-filter/backdrop-filter.stories.tsx
index a4a371dd77..f9f52e8309 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backdrop-filter/backdrop-filter.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backdrop-filter/backdrop-filter.stories.tsx
@@ -7,18 +7,21 @@ import {
theme,
} from "@webstudio-is/design-system";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { Section } from "./backdrop-filter";
registerContainers();
@@ -39,10 +42,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const blurBackdropFilter: StyleDecl = {
breakpointId: "base",
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
index c4d258f475..73fb8cbf96 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/background-content.stories.tsx
@@ -8,17 +8,20 @@ import {
theme,
} from "@webstudio-is/design-system";
import { createDefaultPages } from "@webstudio-is/project-build";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { BackgroundContent as BackgroundContentPanel } from "./background-content";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { useComputedStyleDecl } from "../../shared/model";
import { setRepeatedStyleItem } from "../../shared/repeated-style";
import { type StyleValue } from "@webstudio-is/css-engine";
@@ -55,10 +58,8 @@ $styles.set(
new Map([[getStyleDeclKey(defaultBackgroundImage), defaultBackgroundImage]])
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const BackgroundStory = ({ styleValue }: { styleValue: StyleValue }) => {
const backgroundImage = useComputedStyleDecl("background-image");
diff --git a/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
index 18c421da5b..1283975334 100644
--- a/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/backgrounds/backgrounds.stories.tsx
@@ -8,15 +8,18 @@ import {
theme,
} from "@webstudio-is/design-system";
import { registerContainers } from "~/shared/sync/sync-stores";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
- $selectedBreakpointId,
$styles,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { Section as SectionComponent } from "./backgrounds";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
const backgroundImage: StyleDecl = {
breakpointId: "base",
@@ -53,10 +56,8 @@ $instances.set(
["box", { type: "instance", id: "box", component: "Box", children: [] }],
])
);
-$awareness.set({
- pageId: "",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("");
+$selectedInstanceSelector.set(["box"]);
const SingleLayerVariant = () => {
useEffect(() => {
diff --git a/apps/builder/app/builder/features/style-panel/sections/borders/borders.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/borders/borders.stories.tsx
index 9daafba943..23a96e2082 100644
--- a/apps/builder/app/builder/features/style-panel/sections/borders/borders.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/borders/borders.stories.tsx
@@ -7,18 +7,21 @@ import {
theme,
} from "@webstudio-is/design-system";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { Section } from "./borders";
registerContainers();
@@ -39,10 +42,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const solidBorderTop: StyleDecl = {
breakpointId: "base",
diff --git a/apps/builder/app/builder/features/style-panel/sections/box-shadows/box-shadows.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/box-shadows/box-shadows.stories.tsx
index a6e090e3f4..7f040ea826 100644
--- a/apps/builder/app/builder/features/style-panel/sections/box-shadows/box-shadows.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/box-shadows/box-shadows.stories.tsx
@@ -7,18 +7,21 @@ import {
theme,
} from "@webstudio-is/design-system";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { Section } from "./box-shadows";
registerContainers();
@@ -39,10 +42,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const outerShadow: StyleDecl = {
breakpointId: "base",
diff --git a/apps/builder/app/builder/features/style-panel/sections/filter/filter.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/filter/filter.stories.tsx
index 048245a346..f4b3b7e1f5 100644
--- a/apps/builder/app/builder/features/style-panel/sections/filter/filter.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/filter/filter.stories.tsx
@@ -7,18 +7,21 @@ import {
theme,
} from "@webstudio-is/design-system";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { Section } from "./filter";
registerContainers();
@@ -39,10 +42,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const blurFilterStyle: StyleDecl = {
breakpointId: "base",
diff --git a/apps/builder/app/builder/features/style-panel/sections/flex-child/flex-child.tsx b/apps/builder/app/builder/features/style-panel/sections/flex-child/flex-child.tsx
index b768fb6d74..adb74e3e26 100644
--- a/apps/builder/app/builder/features/style-panel/sections/flex-child/flex-child.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/flex-child/flex-child.tsx
@@ -32,7 +32,8 @@ import { createBatchUpdate } from "../../shared/use-style-data";
import { useReadonly } from "../../shared/readonly";
import { AlignSelfControl } from "../shared/align-self";
import { OrderControl } from "../shared/order";
-import { $selectedInstancePath, selectInstance } from "~/shared/awareness";
+import { $selectedInstancePath } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
export const properties = [
"flex-shrink",
diff --git a/apps/builder/app/builder/features/style-panel/sections/grid-child/grid-child.tsx b/apps/builder/app/builder/features/style-panel/sections/grid-child/grid-child.tsx
index 61ed18bb9a..7a19af5328 100644
--- a/apps/builder/app/builder/features/style-panel/sections/grid-child/grid-child.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/grid-child/grid-child.tsx
@@ -42,7 +42,8 @@ import { useLocalValue } from "../../../settings-panel/shared";
import { AlignSelfControl, JustifySelfControl } from "../shared/align-self";
import { OrderControl } from "../shared/order";
import { useStore } from "@nanostores/react";
-import { $selectedInstancePath, selectInstance } from "~/shared/awareness";
+import { $selectedInstancePath } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { $isStylePanelGridVisible } from "~/builder/shared/nano-states";
import { ExternalLinkIcon } from "@webstudio-is/icons";
diff --git a/apps/builder/app/builder/features/style-panel/sections/layout/layout.tsx b/apps/builder/app/builder/features/style-panel/sections/layout/layout.tsx
index 69d0fc1923..2ed72c9861 100644
--- a/apps/builder/app/builder/features/style-panel/sections/layout/layout.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/layout/layout.tsx
@@ -1,6 +1,6 @@
import { useEffect, useRef, useState, type JSX, type ReactNode } from "react";
import { useStore } from "@nanostores/react";
-import { $selectedInstanceKey } from "~/shared/awareness";
+import { $selectedInstanceKey } from "~/shared/nano-states";
import {
theme,
Box,
diff --git a/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-generator.tsx b/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-generator.tsx
index d6036cb3b6..1c5f515946 100644
--- a/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-generator.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-generator.tsx
@@ -26,12 +26,10 @@ import {
import { useComputedStyleDecl } from "../../../shared/model";
import { createBatchUpdate } from "../../../shared/use-style-data";
import { useReadonly } from "../../../shared/readonly";
-import {
- $breakpoints,
- $gridCellData,
- $instances,
- $selectedInstanceSelector,
-} from "~/shared/nano-states";
+import { $gridCellData } from "~/shared/nano-states";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import { $instances } from "~/shared/sync/data-stores";
import { updateWebstudioData } from "~/shared/instance-utils";
import { DEFAULT_GRID_TRACK_COUNT } from "./constants";
diff --git a/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-settings.tsx b/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-settings.tsx
index 8966674503..f83f58ee31 100644
--- a/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-settings.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/layout/shared/grid-settings.tsx
@@ -26,7 +26,7 @@ import {
} from "@webstudio-is/css-data";
import { PlusIcon, MinusIcon } from "@webstudio-is/icons";
import { useStore } from "@nanostores/react";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { useReadonly } from "../../../shared/readonly";
import { useComputedStyleDecl } from "../../../shared/model";
import { CssValueInputContainer } from "../../../shared/css-value-input";
diff --git a/apps/builder/app/builder/features/style-panel/sections/outline/outline.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/outline/outline.stories.tsx
index ab295c7f14..e17cfb0cf0 100644
--- a/apps/builder/app/builder/features/style-panel/sections/outline/outline.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/outline/outline.stories.tsx
@@ -7,18 +7,21 @@ import {
theme,
} from "@webstudio-is/design-system";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { Section } from "./outline";
registerContainers();
@@ -39,10 +42,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
const solidOutline: StyleDecl = {
breakpointId: "base",
diff --git a/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
index 2bd2218b6a..ea229ff6c3 100644
--- a/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/position/inset-control.stories.tsx
@@ -4,15 +4,18 @@ import { getStyleDeclKey, StyleDecl } from "@webstudio-is/sdk";
import { createDefaultPages } from "@webstudio-is/project-build";
import { InsetControl } from "./inset-control";
import { registerContainers } from "~/shared/sync/sync-stores";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
+} from "~/shared/sync/data-stores";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
} from "~/shared/nano-states";
-import { $awareness } from "~/shared/awareness";
const top: StyleDecl = {
breakpointId: "base",
@@ -88,10 +91,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
export const Inset = () => {
return (
diff --git a/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx b/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
index e7447cb99f..0209d6af05 100644
--- a/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
+++ b/apps/builder/app/builder/features/style-panel/sections/transitions/transitions.stories.tsx
@@ -1,16 +1,19 @@
import { Box, StorySection, theme } from "@webstudio-is/design-system";
import { getStyleDeclKey, StyleDecl } from "@webstudio-is/sdk";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$pages,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { Section } from "./transitions";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { createDefaultPages } from "@webstudio-is/project-build";
const transitionProperty: StyleDecl = {
@@ -53,10 +56,8 @@ $pages.set(
rootInstanceId: "box",
})
);
-$awareness.set({
- pageId: "homePageId",
- instanceSelector: ["box"],
-});
+$selectedPageId.set("homePageId");
+$selectedInstanceSelector.set(["box"]);
export const Transitions = () => (
<StorySection title="Transitions">
diff --git a/apps/builder/app/builder/features/style-panel/shared/instances-kv.ts b/apps/builder/app/builder/features/style-panel/shared/instances-kv.ts
index 0353631cdf..baadca2e6b 100644
--- a/apps/builder/app/builder/features/style-panel/shared/instances-kv.ts
+++ b/apps/builder/app/builder/features/style-panel/shared/instances-kv.ts
@@ -1,7 +1,7 @@
import { useStore } from "@nanostores/react";
import { map } from "nanostores";
import { useCallback } from "react";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
const instancesKv = map<Record<string, unknown>>({});
diff --git a/apps/builder/app/builder/features/style-panel/shared/model.tsx b/apps/builder/app/builder/features/style-panel/shared/model.tsx
index 8a7261223c..57ed5a0f99 100644
--- a/apps/builder/app/builder/features/style-panel/shared/model.tsx
+++ b/apps/builder/app/builder/features/style-panel/shared/model.tsx
@@ -22,15 +22,17 @@ import {
} from "@webstudio-is/sdk";
import { rootComponent } from "@webstudio-is/sdk";
import {
- $breakpoints,
- $props,
$registeredComponentMetas,
$selectedBreakpoint,
$selectedInstanceStates,
$selectedOrLastStyleSourceSelector,
+} from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import {
+ $props,
$styles,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import {
getComputedStyleDecl,
getPresetStyleDeclKey,
@@ -40,7 +42,7 @@ import {
import {
$selectedInstancePathWithRoot,
type InstancePath,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import type { InstanceSelector } from "~/shared/tree-utils";
const $presetStyles = computed($registeredComponentMetas, (metas) => {
diff --git a/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts b/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
index 95a92e335b..1a06b2c195 100644
--- a/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
+++ b/apps/builder/app/builder/features/style-panel/shared/repeated-style.test.ts
@@ -18,18 +18,21 @@ import {
} from "./repeated-style";
import { createComputedStyleDeclStore } from "./model";
import { parseCssFragment } from "./css-fragment";
+import { $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import {
- $breakpoints,
$instances,
- $selectedBreakpointId,
$styles,
$styleSources,
$styleSourceSelections,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { setProperty } from "./use-style-data";
import type { ComputedStyleDecl } from "~/shared/style-object-model";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
setEnv("*");
registerContainers();
@@ -37,10 +40,8 @@ registerContainers();
beforeEach(() => {
$breakpoints.set(new Map([["base", { id: "base", label: "" }]]));
$selectedBreakpointId.set("base");
- $awareness.set({
- pageId: "",
- instanceSelector: ["box"],
- });
+ $selectedPageId.set("");
+ $selectedInstanceSelector.set(["box"]);
$instances.set(
new Map([
["box", { type: "instance", id: "box", component: "Box", children: [] }],
diff --git a/apps/builder/app/builder/features/style-panel/shared/use-style-data.test.ts b/apps/builder/app/builder/features/style-panel/shared/use-style-data.test.ts
index b9c021fd37..c9fd416c6a 100644
--- a/apps/builder/app/builder/features/style-panel/shared/use-style-data.test.ts
+++ b/apps/builder/app/builder/features/style-panel/shared/use-style-data.test.ts
@@ -2,15 +2,20 @@ import { enableMapSet } from "immer";
import { describe, expect, test } from "vitest";
import { registerContainers } from "~/shared/sync/sync-stores";
import {
- $breakpoints,
- $instances,
$selectedBreakpointId,
$selectedStyleSources,
+} from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import {
+ $instances,
$styleSourceSelections,
$styleSources,
$styles,
+} from "~/shared/sync/data-stores";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
} from "~/shared/nano-states";
-import { $awareness } from "~/shared/awareness";
import { deleteProperty, setProperty } from "./use-style-data";
import { getStyleDeclKey, type StyleDecl } from "@webstudio-is/sdk";
@@ -31,10 +36,8 @@ const setupSelection = (styleSource: {
],
])
);
- $awareness.set({
- pageId: "",
- instanceSelector: ["body"],
- });
+ $selectedPageId.set("");
+ $selectedInstanceSelector.set(["body"]);
$breakpoints.set(new Map([["base", { id: "base", label: "Base" }]]));
$selectedBreakpointId.set("base");
$styleSources.set(new Map([[styleSource.id, styleSource]]));
diff --git a/apps/builder/app/builder/features/style-panel/shared/use-style-data.ts b/apps/builder/app/builder/features/style-panel/shared/use-style-data.ts
index de4f545410..c79f4eb058 100644
--- a/apps/builder/app/builder/features/style-panel/shared/use-style-data.ts
+++ b/apps/builder/app/builder/features/style-panel/shared/use-style-data.ts
@@ -5,13 +5,15 @@ import {
$selectedBreakpoint,
$selectedOrLastStyleSourceSelector,
$selectedStyleSource,
+} from "~/shared/nano-states";
+import {
$styleSourceSelections,
$styleSources,
$styles,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { $ephemeralStyles } from "~/canvas/stores";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { isStyleSourceLocked } from "~/shared/style-source-utils";
type StyleUpdate =
diff --git a/apps/builder/app/builder/features/style-panel/style-panel.tsx b/apps/builder/app/builder/features/style-panel/style-panel.tsx
index 0d7dbe316f..ef4d8067ba 100644
--- a/apps/builder/app/builder/features/style-panel/style-panel.tsx
+++ b/apps/builder/app/builder/features/style-panel/style-panel.tsx
@@ -29,7 +29,7 @@ import {
} from "~/shared/nano-states";
import { isStyleSourceLocked } from "~/shared/style-source-utils";
import { ReadonlyProvider } from "./shared/readonly";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { CollapsibleProvider } from "~/builder/shared/collapsible-section";
import {
$settings,
diff --git a/apps/builder/app/builder/features/style-panel/style-source-section.test.ts b/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
index f0b59452bf..eeb71b30f0 100644
--- a/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
+++ b/apps/builder/app/builder/features/style-panel/style-source-section.test.ts
@@ -1,15 +1,18 @@
import { enableMapSet } from "immer";
import { expect, test, describe } from "vitest";
import { registerContainers } from "~/shared/sync/sync-stores";
+import { $selectedStyleSources } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import {
- $instances,
- $selectedStyleSources,
$styleSourceSelections,
$styleSources,
$styles,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { addStyleSourceToInstance, __testing__ } from "./style-source-section";
-import { $awareness } from "~/shared/awareness";
+import {
+ $selectedPageId,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
const { duplicateStyleSource, getComponentStates } = __testing__;
@@ -154,10 +157,8 @@ test("add style source to instance", () => {
],
])
);
- $awareness.set({
- pageId: "",
- instanceSelector: ["body"],
- });
+ $selectedPageId.set("");
+ $selectedInstanceSelector.set(["body"]);
$styleSources.set(new Map([["local1", { id: "local1", type: "local" }]]));
$styleSourceSelections.set(new Map());
$selectedStyleSources.set(new Map());
@@ -193,10 +194,8 @@ test("duplicate locked style source creates an unlocked copy", () => {
],
])
);
- $awareness.set({
- pageId: "",
- instanceSelector: ["body"],
- });
+ $selectedPageId.set("");
+ $selectedInstanceSelector.set(["body"]);
$styleSources.set(
new Map([
[
diff --git a/apps/builder/app/builder/features/style-panel/style-source-section.tsx b/apps/builder/app/builder/features/style-panel/style-source-section.tsx
index 9a3596d21b..90d57a8bf6 100644
--- a/apps/builder/app/builder/features/style-panel/style-source-section.tsx
+++ b/apps/builder/app/builder/features/style-panel/style-source-section.tsx
@@ -14,9 +14,9 @@ import {
getStyleDeclKey,
} from "@webstudio-is/sdk";
import { type ItemSource, StyleSourceInput } from "./style-source";
+import { type RenameStyleSourceError } from "~/shared/style-source-utils";
import {
renameStyleSource,
- type RenameStyleSourceError,
deleteStyleSource,
DeleteStyleSourceDialog,
setStyleSourceLocked,
@@ -28,15 +28,17 @@ import {
$selectedOrLastStyleSourceSelector,
$selectedStyleSources,
$selectedStyleState,
+} from "~/shared/nano-states";
+import {
$styleSourceSelections,
$styleSources,
$styles,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { removeByMutable } from "~/shared/array-utils";
import { cloneStyles } from "~/shared/tree-utils";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { subscribe } from "~/shared/pubsub";
-import { $selectedInstance } from "~/shared/awareness";
+import { $selectedInstance } from "~/shared/nano-states";
import { $instanceTags } from "./shared/model";
// Declare command for this module
diff --git a/apps/builder/app/builder/features/sync-status.tsx b/apps/builder/app/builder/features/sync-status.tsx
index 83295768ba..5e49eeec03 100644
--- a/apps/builder/app/builder/features/sync-status.tsx
+++ b/apps/builder/app/builder/features/sync-status.tsx
@@ -9,7 +9,7 @@ import {
} from "@webstudio-is/design-system";
import { OfflineIcon } from "@webstudio-is/icons";
import { useEffect } from "react";
-import { $queueStatus } from "~/shared/sync/project-queue";
+import { $syncStatus } from "@webstudio-is/sync-client";
const $isOnline = atom(false);
@@ -24,13 +24,13 @@ const subscribeIsOnline = () => {
};
export const SyncStatus = () => {
- const statusObject = useStore($queueStatus);
+ const statusObject = useStore($syncStatus);
const isOnline = useStore($isOnline);
useEffect(subscribeIsOnline, []);
if (
statusObject.status === "idle" ||
- statusObject.status === "running" ||
+ statusObject.status === "syncing" ||
statusObject.status === "recovering"
) {
return null;
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/block-editor-context-menu.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/block-editor-context-menu.tsx
index f599de3eb6..1304f5eec5 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/block-editor-context-menu.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/block-editor-context-menu.tsx
@@ -2,13 +2,13 @@ import { useStore } from "@nanostores/react";
import { styled } from "@webstudio-is/design-system";
import {
- $instances,
$modifierKeys,
$textEditingInstanceSelector,
$textEditorContextMenu,
$textEditorContextMenuCommand,
findTemplates,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { applyScale } from "./outline";
import { $scale } from "~/builder/shared/nano-states";
import { TemplatesMenu } from "./outline/block-instance-outline";
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-instance-context-menu.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-instance-context-menu.tsx
index 422d5f1789..72c8c07161 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-instance-context-menu.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-instance-context-menu.tsx
@@ -1,7 +1,7 @@
import { useStore } from "@nanostores/react";
import { $instanceContextMenu } from "~/shared/nano-states";
import { useEffect, useRef } from "react";
-import { selectInstance } from "~/shared/awareness";
+import { selectInstance } from "~/shared/nano-states";
import {
ContextMenu,
ContextMenuTrigger,
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
index 3faf2046ac..da8fc8f5aa 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/canvas-tools.tsx
@@ -2,11 +2,11 @@ import { useStore } from "@nanostores/react";
import { css } from "@webstudio-is/design-system";
import { PlacementIndicator } from "@webstudio-is/design-system";
import {
- $instances,
$isPreviewMode,
$dragAndDropState,
$canvasToolsVisible,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import {
CollaborativeInstanceOutline,
HoveredInstanceOutline,
@@ -26,6 +26,7 @@ import {
import { BlockChildHoveredInstanceOutline } from "./outline/block-instance-outline";
import { TextEditorContextMenu } from "./block-editor-context-menu";
import { CanvasInstanceContextMenu } from "./canvas-instance-context-menu";
+import { CollaborativeCursors } from "./collaborative-cursors";
const containerStyle = css({
position: "absolute",
@@ -86,6 +87,7 @@ export const CanvasTools = () => {
<>
{isPreviewMode === false && (
<>
+ <CollaborativeCursors />
{isStylePanelGridVisible && <GridGuides />}
<SelectedInstanceOutline />
<HoveredInstanceOutline />
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.test.ts b/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.test.ts
new file mode 100644
index 0000000000..46779bde68
--- /dev/null
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.test.ts
@@ -0,0 +1,160 @@
+import { describe, expect, test } from "vitest";
+import { __testing__ } from "./collaborative-cursors";
+
+const {
+ shouldSkipCollaborator,
+ hasCursorPosition,
+ computeCursorCoordinates,
+ isWithinLayer,
+ toRenderableCollaboratorCursor,
+} = __testing__;
+
+describe("collaborative-cursors helpers", () => {
+ test("shouldSkipCollaborator returns true only for different known pages", () => {
+ expect(
+ shouldSkipCollaborator({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-b",
+ })
+ ).toBe(true);
+
+ expect(
+ shouldSkipCollaborator({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-a",
+ })
+ ).toBe(false);
+
+ expect(
+ shouldSkipCollaborator({
+ currentPageId: "page-a",
+ collaboratorPageId: undefined,
+ })
+ ).toBe(false);
+ });
+
+ test("hasCursorPosition returns true when pointer position is set", () => {
+ expect(hasCursorPosition(undefined)).toBe(false);
+ expect(hasCursorPosition({ x: 10, y: 20, xRatio: 0.1, yRatio: 0.2 })).toBe(
+ true
+ );
+ });
+
+ test("computeCursorCoordinates maps normalized coordinates using canvas rect", () => {
+ const layerRect = { left: 0, top: 0, width: 1200, height: 800 };
+ const canvasRect = { left: 100, top: 200, width: 800, height: 600 };
+
+ const result = computeCursorCoordinates({
+ pointerPosition: { x: 0, y: 0, xRatio: 0.5, yRatio: 0.25 },
+ layerRect,
+ canvasRect,
+ });
+
+ expect(result).toEqual({ x: 500, y: 350 });
+ });
+
+ test("computeCursorCoordinates falls back to layer rect when canvas rect is missing", () => {
+ const layerRect = { left: 0, top: 0, width: 1000, height: 800 };
+
+ const result = computeCursorCoordinates({
+ pointerPosition: { x: 0, y: 0, xRatio: 0.5, yRatio: 0.25 },
+ layerRect,
+ canvasRect: undefined,
+ });
+
+ expect(result).toEqual({ x: 500, y: 200 });
+ });
+
+ test("computeCursorCoordinates uses ratios against layer rect when canvas rect is missing", () => {
+ const layerRect = { left: 50, top: 100, width: 1000, height: 800 };
+
+ const result = computeCursorCoordinates({
+ pointerPosition: { x: 350, y: 500, xRatio: 0.3, yRatio: 0.5 },
+ layerRect,
+ canvasRect: undefined,
+ });
+
+ expect(result).toEqual({ x: 300, y: 400 });
+ });
+
+ test("isWithinLayer bounds-checks computed coordinates", () => {
+ const layerRect = { left: 0, top: 0, width: 500, height: 400 };
+
+ expect(isWithinLayer({ x: 10, y: 10, layerRect })).toBe(true);
+ expect(isWithinLayer({ x: -1, y: 10, layerRect })).toBe(false);
+ expect(isWithinLayer({ x: 10, y: 401, layerRect })).toBe(false);
+ expect(isWithinLayer({ x: 999, y: 999, layerRect: undefined })).toBe(true);
+ });
+
+ test("toRenderableCollaboratorCursor returns coordinates only for visible collaborator cursor", () => {
+ const layerRect = { left: 0, top: 0, width: 1200, height: 800 };
+ const canvasRect = { left: 100, top: 200, width: 800, height: 600 };
+
+ expect(
+ toRenderableCollaboratorCursor({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-b",
+ pointerPosition: { x: 10, y: 20, xRatio: 0, yRatio: 0 },
+ layerRect,
+ canvasRect,
+ })
+ ).toBeUndefined();
+
+ expect(
+ toRenderableCollaboratorCursor({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-a",
+ pointerPosition: undefined,
+ layerRect,
+ canvasRect,
+ })
+ ).toBeUndefined();
+
+ expect(
+ toRenderableCollaboratorCursor({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-a",
+ pointerPosition: { x: 0, y: 0, xRatio: 0.5, yRatio: 0.25 },
+ layerRect,
+ canvasRect,
+ })
+ ).toEqual({ x: 500, y: 350 });
+ });
+
+ test("toRenderableCollaboratorCursor recalculates position when receiver canvas changes", () => {
+ const layerRect = { left: 0, top: 0, width: 1400, height: 1000 };
+ const normalized = { xRatio: 0.25, yRatio: 0.75 };
+
+ const firstReceiverCanvasRect = {
+ left: 100,
+ top: 100,
+ width: 800,
+ height: 600,
+ };
+ const secondReceiverCanvasRect = {
+ left: 200,
+ top: 150,
+ width: 1200,
+ height: 900,
+ };
+
+ const firstRender = toRenderableCollaboratorCursor({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-a",
+ pointerPosition: { x: 0, y: 0, ...normalized },
+ layerRect,
+ canvasRect: firstReceiverCanvasRect,
+ });
+
+ const secondRender = toRenderableCollaboratorCursor({
+ currentPageId: "page-a",
+ collaboratorPageId: "page-a",
+ pointerPosition: { x: 0, y: 0, ...normalized },
+ layerRect,
+ canvasRect: secondReceiverCanvasRect,
+ });
+
+ expect(firstRender).toEqual({ x: 300, y: 550 });
+ expect(secondRender).toEqual({ x: 500, y: 825 });
+ });
+});
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.tsx
new file mode 100644
index 0000000000..eeccd0118e
--- /dev/null
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/collaborative-cursors.tsx
@@ -0,0 +1,245 @@
+import { useStore } from "@nanostores/react";
+import { useEffect, useMemo, useState } from "react";
+import { css, type Rect } from "@webstudio-is/design-system";
+import {
+ $collaborators,
+ assignCollaboratorColors,
+ type CollaboratorInfo,
+} from "@webstudio-is/sync-client";
+import {
+ $collaborativeInstanceSelector,
+ $selectedPageId,
+} from "~/shared/nano-states";
+import { $canvasRect } from "~/builder/shared/nano-states";
+
+const layerStyle = css({
+ position: "fixed",
+ inset: 0,
+ pointerEvents: "none",
+});
+
+const cursorStyle = css({
+ position: "absolute",
+ top: 0,
+ left: 0,
+ transformOrigin: "top left",
+ transition: "transform 300ms ease-out",
+ willChange: "transform",
+});
+
+const shouldSkipCollaborator = ({
+ currentPageId,
+ collaboratorPageId,
+}: {
+ currentPageId: string | undefined;
+ collaboratorPageId: string | undefined;
+}) => {
+ return (
+ currentPageId !== undefined &&
+ collaboratorPageId !== undefined &&
+ collaboratorPageId !== currentPageId
+ );
+};
+
+const hasCursorPosition = (
+ pointerPosition: CollaboratorInfo["pointerPosition"]
+) => {
+ return pointerPosition !== undefined;
+};
+
+const computeCursorCoordinates = ({
+ pointerPosition,
+ layerRect,
+ canvasRect,
+}: {
+ pointerPosition: CollaboratorInfo["pointerPosition"];
+ layerRect: Rect | undefined;
+ canvasRect: Rect | undefined;
+}) => {
+ if (pointerPosition === undefined || layerRect === undefined) {
+ return { x: 0, y: 0 };
+ }
+ if (canvasRect !== undefined) {
+ return {
+ x:
+ canvasRect.left -
+ layerRect.left +
+ pointerPosition.xRatio * canvasRect.width,
+ y:
+ canvasRect.top -
+ layerRect.top +
+ pointerPosition.yRatio * canvasRect.height,
+ };
+ }
+ return {
+ x: pointerPosition.xRatio * layerRect.width,
+ y: pointerPosition.yRatio * layerRect.height,
+ };
+};
+
+const isWithinLayer = ({
+ x,
+ y,
+ layerRect,
+}: {
+ x: number;
+ y: number;
+ layerRect: Rect | undefined;
+}) => {
+ if (layerRect === undefined) {
+ return true;
+ }
+ return x >= 0 && x < layerRect.width && y >= 0 && y < layerRect.height;
+};
+
+const toRenderableCollaboratorCursor = ({
+ currentPageId,
+ collaboratorPageId,
+ pointerPosition,
+ layerRect,
+ canvasRect,
+}: {
+ currentPageId: string | undefined;
+ collaboratorPageId: string | undefined;
+ pointerPosition: CollaboratorInfo["pointerPosition"];
+ layerRect: Rect | undefined;
+ canvasRect: Rect | undefined;
+}) => {
+ if (shouldSkipCollaborator({ currentPageId, collaboratorPageId })) {
+ return;
+ }
+
+ if (!hasCursorPosition(pointerPosition)) {
+ return;
+ }
+
+ const coordinates = computeCursorCoordinates({
+ pointerPosition,
+ layerRect,
+ canvasRect,
+ });
+
+ if (!isWithinLayer({ ...coordinates, layerRect })) {
+ return;
+ }
+
+ return coordinates;
+};
+
+const areInstanceSelectorsEqual = (
+ left: readonly string[] | undefined,
+ right: readonly string[] | undefined
+) => {
+ if (left === right) {
+ return true;
+ }
+ if (
+ left === undefined ||
+ right === undefined ||
+ left.length !== right.length
+ ) {
+ return false;
+ }
+ return left.every((id, index) => id === right[index]);
+};
+
+export const CollaborativeCursors = () => {
+ const collaborators = useStore($collaborators);
+ const canvasRect = useStore($canvasRect);
+ const currentPageId = useStore($selectedPageId);
+ const [layerElement, setLayerElement] = useState<
+ HTMLDivElement | null | undefined
+ >(undefined);
+ const layerRect = layerElement?.getBoundingClientRect();
+ const collaboratorColors = useMemo(
+ () => assignCollaboratorColors(collaborators.keys()),
+ [collaborators]
+ );
+
+ useEffect(() => {
+ const collaborativeSelection = [...collaborators.values()].find(
+ (collaborator) => {
+ if (
+ shouldSkipCollaborator({
+ currentPageId,
+ collaboratorPageId: collaborator.pageId,
+ })
+ ) {
+ return false;
+ }
+ return (
+ collaborator.selectedInstanceIds !== undefined &&
+ collaborator.selectedInstanceIds.length > 0
+ );
+ }
+ )?.selectedInstanceIds;
+
+ const currentCollaborativeSelection = $collaborativeInstanceSelector.get();
+ if (
+ areInstanceSelectorsEqual(
+ currentCollaborativeSelection,
+ collaborativeSelection
+ )
+ ) {
+ return;
+ }
+
+ $collaborativeInstanceSelector.set(collaborativeSelection);
+ }, [collaborators, currentPageId]);
+
+ return (
+ <div className={layerStyle()} ref={setLayerElement}>
+ {[...collaborators.entries()].map(([clientId, collaborator]) => {
+ const coordinates = toRenderableCollaboratorCursor({
+ currentPageId,
+ collaboratorPageId: collaborator.pageId,
+ pointerPosition: collaborator.pointerPosition,
+ layerRect,
+ canvasRect,
+ });
+
+ if (coordinates === undefined) {
+ return;
+ }
+
+ const { x, y } = coordinates;
+
+ const color = collaboratorColors.get(clientId);
+
+ return (
+ <div
+ key={clientId}
+ className={cursorStyle()}
+ style={{
+ color,
+ transform: `translate3d(${x}px, ${y}px, 0)`,
+ }}
+ >
+ <svg
+ width="14"
+ height="20"
+ viewBox="0 0 14 20"
+ fill="none"
+ xmlns="http://www.w3.org/2000/svg"
+ >
+ <path
+ d="M1 1.5L1 17.7L4.8 13.4L8 19L11 17.4L7.8 11.8L13 11.8L1 1.5Z"
+ fill="currentColor"
+ stroke="white"
+ strokeWidth="1"
+ />
+ </svg>
+ </div>
+ );
+ })}
+ </div>
+ );
+};
+
+export const __testing__ = {
+ shouldSkipCollaborator,
+ hasCursorPosition,
+ computeCursorCoordinates,
+ isWithinLayer,
+ toRenderableCollaboratorCursor,
+};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-instance-outline.tsx
index f0c3c25826..4e6adf718e 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-instance-outline.tsx
@@ -23,13 +23,13 @@ import {
$blockChildOutline,
$hoveredInstanceOutline,
$hoveredInstanceSelector,
- $instances,
$isContentMode,
$modifierKeys,
findBlockSelector,
findTemplates,
type BlockChildOutline,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { $clampingRect, $scale } from "~/builder/shared/nano-states";
import type { InstanceSelector } from "~/shared/tree-utils";
import {
@@ -38,7 +38,7 @@ import {
} from "~/shared/instance-utils";
import { skipInertHandlersAttribute } from "~/builder/shared/inert-handlers";
import { useEffectEvent } from "~/shared/hook-utils/effect-event";
-import { getInstancePath } from "~/shared/awareness";
+import { getInstancePath } from "~/shared/nano-states";
import { insertTemplateAt } from "./block-utils";
import { Outline } from "./outline";
import { applyScale } from "../apply-scale";
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-utils.ts b/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-utils.ts
index 03d91b2231..201323300d 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-utils.ts
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/block-utils.ts
@@ -1,7 +1,7 @@
import type { Instance, Instances } from "@webstudio-is/sdk";
import { blockTemplateComponent } from "@webstudio-is/sdk";
import { shallowEqual } from "shallow-equal";
-import { selectInstance } from "~/shared/awareness";
+import { selectInstance } from "~/shared/nano-states";
import { builderApi } from "~/shared/builder-api";
import { findAvailableVariables } from "~/shared/data-variables";
import {
@@ -14,13 +14,13 @@ import {
detectFragmentTokenConflicts,
} from "~/shared/instance-utils";
import {
- $instances,
- $project,
$registeredComponentMetas,
$textEditingInstanceSelector,
findBlockChildSelector,
findBlockSelector,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $project } from "~/shared/sync/data-stores";
import type { DroppableTarget, InstanceSelector } from "~/shared/tree-utils";
const getInsertionIndex = (
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
index f45671af96..398642662b 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/collaborative-instance-outline.tsx
@@ -1,16 +1,51 @@
import { useStore } from "@nanostores/react";
-import { $collaborativeInstanceRect } from "~/shared/nano-states";
+import { useMemo } from "react";
+import {
+ $collaborators,
+ assignCollaboratorColors,
+} from "@webstudio-is/sync-client";
+import {
+ $collaborativeInstanceRect,
+ $collaborativeInstanceSelector,
+ $selectedPageId,
+} from "~/shared/nano-states";
import { Outline } from "./outline";
import { applyScale } from "../apply-scale";
import { $scale, $clampingRect } from "~/builder/shared/nano-states";
import { $ephemeralStyles } from "~/canvas/stores";
+const areSelectorsEqual = (
+ left: readonly string[] | undefined,
+ right: readonly string[] | undefined
+) => {
+ if (left === right) {
+ return true;
+ }
+ if (
+ left === undefined ||
+ right === undefined ||
+ left.length !== right.length
+ ) {
+ return false;
+ }
+ return left.every((id, index) => id === right[index]);
+};
+
// Outline of an instance that is being edited by AI or a human collaborator.
export const CollaborativeInstanceOutline = () => {
const scale = useStore($scale);
const instanceRect = useStore($collaborativeInstanceRect);
+ const collaborativeInstanceSelector = useStore(
+ $collaborativeInstanceSelector
+ );
+ const collaborators = useStore($collaborators);
+ const currentPageId = useStore($selectedPageId);
const ephemeralStyles = useStore($ephemeralStyles);
const clampingRect = useStore($clampingRect);
+ const collaboratorColors = useMemo(
+ () => assignCollaboratorColors(collaborators.keys()),
+ [collaborators]
+ );
if (
instanceRect === undefined ||
@@ -22,11 +57,33 @@ export const CollaborativeInstanceOutline = () => {
const rect = applyScale(instanceRect, scale);
+ const selectedCollaborator = [...collaborators.entries()].find(
+ ([, collaborator]) => {
+ if (
+ currentPageId !== undefined &&
+ collaborator.pageId !== undefined &&
+ collaborator.pageId !== currentPageId
+ ) {
+ return false;
+ }
+ return areSelectorsEqual(
+ collaborator.selectedInstanceIds,
+ collaborativeInstanceSelector
+ );
+ }
+ );
+
+ const color =
+ selectedCollaborator === undefined
+ ? undefined
+ : collaboratorColors.get(selectedCollaborator[0]);
+
return (
<Outline
- variant="collaboration"
+ variant="default"
rect={rect}
clampingRect={clampingRect}
+ color={color}
></Outline>
);
};
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
index bdacd66bd2..cdf9afec20 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/hovered-instance-outline.tsx
@@ -4,10 +4,10 @@ import {
$blockChildOutline,
$hoveredInstanceOutlineAndInstance,
$hoveredInstanceSelector,
- $instances,
$isContentMode,
$textEditingInstanceSelector,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { $clampingRect, $scale } from "~/builder/shared/nano-states";
import { findClosestSlot } from "~/shared/instance-utils";
import { isDescendantOrSelf } from "~/shared/tree-utils";
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
index 94014adee5..5b86fcb775 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/outline.tsx
@@ -92,6 +92,7 @@ type OutlineProps = {
rect: Rect;
clampingRect: Rect;
variant?: "default" | "collaboration" | "slot";
+ color?: string;
};
export const Outline = ({
@@ -99,6 +100,7 @@ export const Outline = ({
rect,
clampingRect,
variant,
+ color,
}: OutlineProps) => {
const outlineRect = {
top: Math.max(rect.top, clampingRect.top),
@@ -112,6 +114,10 @@ export const Outline = ({
Math.max(rect.left, clampingRect.left),
};
const dynamicStyle = useDynamicStyle(outlineRect);
+ const style =
+ color === undefined
+ ? dynamicStyle
+ : { ...dynamicStyle, borderColor: color };
if (outlineRect.width <= 0 || outlineRect.height <= 0) {
return;
}
@@ -130,7 +136,7 @@ export const Outline = ({
{propertyStyle}
<div
className={`${baseStyle()} ${baseOutlineStyle({ variant, isLeftClamped, isRightClamped, isBottomClamped, isTopClamped })}`}
- style={dynamicStyle}
+ style={style}
>
{children}
</div>
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
index ce250b02fd..1fbd70676a 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/outline/selected-instance-outline.tsx
@@ -1,10 +1,8 @@
import { useStore } from "@nanostores/react";
-import {
- $instances,
- $selectedInstanceOutlineAndInstance,
- $selectedInstanceSelector,
-} from "~/shared/nano-states";
+import { $selectedInstanceOutlineAndInstance } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
import { isDescendantOrSelf } from "~/shared/tree-utils";
import { Outline } from "./outline";
import { applyScale } from "../apply-scale";
diff --git a/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx b/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
index 3eb9b67c12..53af889177 100644
--- a/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
+++ b/apps/builder/app/builder/features/workspace/canvas-tools/resize-handles.tsx
@@ -9,11 +9,8 @@ import {
import { useEffect, useRef } from "react";
import { $canvasWidth } from "~/builder/shared/nano-states";
import { minCanvasWidth } from "~/shared/breakpoints";
-import {
- $breakpoints,
- $isResizingCanvas,
- $selectedBreakpointId,
-} from "~/shared/nano-states";
+import { $isResizingCanvas, $selectedBreakpointId } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
const handlesContainerStyle = css({
position: "absolute",
diff --git a/apps/builder/app/builder/features/workspace/workspace.tsx b/apps/builder/app/builder/features/workspace/workspace.tsx
index 15e5e51bd7..0ad3c16529 100644
--- a/apps/builder/app/builder/features/workspace/workspace.tsx
+++ b/apps/builder/app/builder/features/workspace/workspace.tsx
@@ -8,7 +8,7 @@ import {
} from "~/builder/shared/nano-states";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
import { CanvasTools } from "./canvas-tools";
-import { selectInstance } from "~/shared/awareness";
+import { selectInstance } from "~/shared/nano-states";
import { ResizeHandles } from "./canvas-tools/resize-handles";
import { MediaBadge } from "./canvas-tools/media-badge";
import { useSetCanvasWidth } from "~/builder/shared/calc-canvas-width";
diff --git a/apps/builder/app/builder/inspector.tsx b/apps/builder/app/builder/inspector.tsx
index d271f7129c..edaa257740 100644
--- a/apps/builder/app/builder/inspector.tsx
+++ b/apps/builder/app/builder/inspector.tsx
@@ -31,7 +31,7 @@ import {
$selectedInstance,
$selectedInstanceKey,
$selectedPage,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import { InstanceIcon, getInstanceLabel } from "./shared/instance-label";
const InstanceInfo = ({ instance }: { instance: Instance }) => {
diff --git a/apps/builder/app/builder/shared/asset-manager/asset-info.tsx b/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
index 31a7da1757..5fcfba9be9 100644
--- a/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
+++ b/apps/builder/app/builder/shared/asset-manager/asset-info.tsx
@@ -51,22 +51,18 @@ import {
} from "@webstudio-is/icons";
import { hyphenateProperty } from "@webstudio-is/css-engine";
import {
- $assets,
$authPermit,
$editingPageId,
- $instances,
- $pages,
$permissions,
- $props,
- $styles,
- $styleSourceSelections,
} from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $styleSourceSelections } from "~/shared/sync/data-stores";
import { $openProjectSettings } from "~/shared/nano-states/project-settings";
-import {
- $awareness,
- findAwarenessByInstanceId,
- selectPage,
-} from "~/shared/awareness";
+import { $styles } from "~/shared/sync/data-stores";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { selectPage } from "~/shared/nano-states";
+import { findPageAndSelectorByInstanceId } from "~/shared/instance-utils";
+import { $selectedPageId } from "~/shared/nano-states";
import { updateWebstudioData } from "~/shared/instance-utils";
import { deleteAssets, replaceAsset } from "~/builder/shared/assets";
import { validateFiles } from "~/builder/shared/assets/asset-upload";
@@ -74,6 +70,7 @@ import {
$activeInspectorPanel,
setActiveSidebarPanel,
} from "~/builder/shared/nano-states";
+import { $instances, $pages, $props } from "~/shared/sync/data-stores";
import {
formatAssetName,
parseAssetName,
@@ -266,12 +263,14 @@ const AssetUsagesList = ({ usages }: { usages: AssetUsage[] }) => {
if (!prop || !pages) {
return;
}
- const awareness = findAwarenessByInstanceId(
- pages,
- instances,
- prop.instanceId
- );
- $awareness.set(awareness);
+ const { pageId, instanceSelector } =
+ findPageAndSelectorByInstanceId(
+ pages,
+ instances,
+ prop.instanceId
+ );
+ $selectedPageId.set(pageId);
+ $selectedInstanceSelector.set(instanceSelector);
setActiveSidebarPanel("auto");
$activeInspectorPanel.set("settings");
}}
@@ -311,12 +310,14 @@ const AssetUsagesList = ({ usages }: { usages: AssetUsage[] }) => {
if (!styleInstanceId || !pages) {
return;
}
- const awareness = findAwarenessByInstanceId(
- pages,
- instances,
- styleInstanceId
- );
- $awareness.set(awareness);
+ const { pageId, instanceSelector } =
+ findPageAndSelectorByInstanceId(
+ pages,
+ instances,
+ styleInstanceId
+ );
+ $selectedPageId.set(pageId);
+ $selectedInstanceSelector.set(instanceSelector);
setActiveSidebarPanel("auto");
$activeInspectorPanel.set("style");
}}
diff --git a/apps/builder/app/builder/shared/asset-manager/asset-manager.stories.tsx b/apps/builder/app/builder/shared/asset-manager/asset-manager.stories.tsx
index fe3de0e081..306eba7125 100644
--- a/apps/builder/app/builder/shared/asset-manager/asset-manager.stories.tsx
+++ b/apps/builder/app/builder/shared/asset-manager/asset-manager.stories.tsx
@@ -7,7 +7,7 @@ import {
VIDEO_EXTENSIONS,
} from "@webstudio-is/sdk";
import type { Asset, AllowedFileExtension } from "@webstudio-is/sdk";
-import { $assets } from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
import { useEffect } from "react";
// Create mock assets for every file type
diff --git a/apps/builder/app/builder/shared/asset-manager/delete-unused-assets.tsx b/apps/builder/app/builder/shared/asset-manager/delete-unused-assets.tsx
index 85cbf5a5eb..d7eeaf390b 100644
--- a/apps/builder/app/builder/shared/asset-manager/delete-unused-assets.tsx
+++ b/apps/builder/app/builder/shared/asset-manager/delete-unused-assets.tsx
@@ -15,7 +15,7 @@ import {
Box,
} from "@webstudio-is/design-system";
import type { Asset } from "@webstudio-is/sdk";
-import { $assets, $pages, $props, $styles } from "~/shared/nano-states";
+import { $assets, $pages, $props, $styles } from "~/shared/sync/data-stores";
import { deleteAssets } from "~/builder/shared/assets";
import { formatAssetName } from "~/builder/shared/assets/asset-utils";
import { calculateUsagesByAssetId } from "./asset-info";
diff --git a/apps/builder/app/builder/shared/assets/delete-assets.ts b/apps/builder/app/builder/shared/assets/delete-assets.ts
index be31edd7d1..b7773a15b1 100644
--- a/apps/builder/app/builder/shared/assets/delete-assets.ts
+++ b/apps/builder/app/builder/shared/assets/delete-assets.ts
@@ -1,5 +1,5 @@
import type { Asset } from "@webstudio-is/sdk";
-import { $assets } from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { onNextTransactionComplete } from "~/shared/sync/project-queue";
import { invalidateAssets } from "~/shared/resources";
diff --git a/apps/builder/app/builder/shared/assets/replace-asset.ts b/apps/builder/app/builder/shared/assets/replace-asset.ts
index edf0434fc3..1a371cf05e 100644
--- a/apps/builder/app/builder/shared/assets/replace-asset.ts
+++ b/apps/builder/app/builder/shared/assets/replace-asset.ts
@@ -1,6 +1,6 @@
import type { Asset } from "@webstudio-is/sdk";
import { toast } from "@webstudio-is/design-system";
-import { $assets, $pages, $props, $styles } from "~/shared/nano-states";
+import { $assets, $pages, $props, $styles } from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { onNextTransactionComplete } from "~/shared/sync/project-queue";
import { invalidateAssets } from "~/shared/resources";
diff --git a/apps/builder/app/builder/shared/assets/upload-assets.tsx b/apps/builder/app/builder/shared/assets/upload-assets.tsx
index a6ace1c756..5c0ab1f65c 100644
--- a/apps/builder/app/builder/shared/assets/upload-assets.tsx
+++ b/apps/builder/app/builder/shared/assets/upload-assets.tsx
@@ -9,12 +9,12 @@ import { restAssetsUploadPath, restAssetsPath } from "~/shared/router-utils";
import { fetch } from "~/shared/fetch.client";
import type { AssetActionResponse } from "~/builder/shared/assets";
import {
- $assets,
$authToken,
- $project,
$uploadingFilesDataStore,
type UploadingFileData,
} from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $project } from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { onNextTransactionComplete } from "~/shared/sync/project-queue";
import { invalidateAssets } from "~/shared/resources";
diff --git a/apps/builder/app/builder/shared/assets/use-assets.tsx b/apps/builder/app/builder/shared/assets/use-assets.tsx
index 08b999a533..1971b25308 100644
--- a/apps/builder/app/builder/shared/assets/use-assets.tsx
+++ b/apps/builder/app/builder/shared/assets/use-assets.tsx
@@ -2,7 +2,8 @@ import { useMemo } from "react";
import { computed } from "nanostores";
import { useStore } from "@nanostores/react";
import type { Asset } from "@webstudio-is/sdk";
-import { $assets, $uploadingFilesDataStore } from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $uploadingFilesDataStore } from "~/shared/nano-states";
import type {
AssetContainer,
UploadedAssetContainer,
diff --git a/apps/builder/app/builder/shared/calc-canvas-width.ts b/apps/builder/app/builder/shared/calc-canvas-width.ts
index e1576e0cab..8b96b5aae8 100644
--- a/apps/builder/app/builder/shared/calc-canvas-width.ts
+++ b/apps/builder/app/builder/shared/calc-canvas-width.ts
@@ -7,11 +7,8 @@ import {
minCanvasWidth,
} from "~/shared/breakpoints-utils";
import { $workspaceRect, $canvasWidth } from "~/builder/shared/nano-states";
-import {
- $breakpoints,
- $isPreviewMode,
- $selectedBreakpoint,
-} from "~/shared/nano-states";
+import { $isPreviewMode, $selectedBreakpoint } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
const defaultWidth = 320;
diff --git a/apps/builder/app/builder/shared/commands.ts b/apps/builder/app/builder/shared/commands.ts
index 7f9f455a3c..bd6a682718 100644
--- a/apps/builder/app/builder/shared/commands.ts
+++ b/apps/builder/app/builder/shared/commands.ts
@@ -10,8 +10,8 @@ import {
$isDesignMode,
$isPreviewMode,
toggleBuilderMode,
- $project,
} from "~/shared/nano-states";
+import { $project } from "~/shared/sync/data-stores";
// Declare command for type safety
declare module "~/shared/pubsub" {
@@ -40,7 +40,8 @@ import {
setActiveSidebarPanel,
toggleActiveSidebarPanel,
} from "./nano-states";
-import { $selectedInstancePath, selectInstance } from "~/shared/awareness";
+import { $selectedInstancePath } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { openCommandPanel } from "../features/command-panel";
import { showWrapComponentsList } from "../features/command-panel/groups/wrap-group";
import { showConvertComponentsList } from "../features/command-panel/groups/convert-group";
diff --git a/apps/builder/app/builder/shared/data-variable-utils.tsx b/apps/builder/app/builder/shared/data-variable-utils.tsx
index 8993905c8e..c5c3835c91 100644
--- a/apps/builder/app/builder/shared/data-variable-utils.tsx
+++ b/apps/builder/app/builder/shared/data-variable-utils.tsx
@@ -16,13 +16,13 @@ import {
} from "@webstudio-is/design-system";
import type { DataSource, Instance } from "@webstudio-is/sdk";
import { ROOT_INSTANCE_ID } from "@webstudio-is/sdk";
+import { $pages } from "~/shared/sync/data-stores";
import {
- $pages,
$instances,
$props,
$dataSources,
$resources,
-} from "~/shared/nano-states";
+} from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { findVariableUsagesByInstance } from "~/shared/data-variables";
diff --git a/apps/builder/app/builder/shared/instance-context-menu.tsx b/apps/builder/app/builder/shared/instance-context-menu.tsx
index 3c0855866e..66afdc8c99 100644
--- a/apps/builder/app/builder/shared/instance-context-menu.tsx
+++ b/apps/builder/app/builder/shared/instance-context-menu.tsx
@@ -17,11 +17,11 @@ import {
$selectedInstancePath,
$selectedPage,
getInstanceKey,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
import { canUnwrapInstance } from "~/shared/instance-utils";
import { $propValuesByInstanceSelector } from "~/shared/nano-states";
import { ROOT_INSTANCE_ID } from "@webstudio-is/sdk";
-import type { InstancePath } from "~/shared/awareness";
+import type { InstancePath } from "~/shared/nano-states";
const getMenuPermissions = (instancePath: InstancePath | undefined) => {
const instanceId = instancePath?.[0]?.instance.id;
diff --git a/apps/builder/app/builder/shared/style-source-actions.tsx b/apps/builder/app/builder/shared/style-source-actions.tsx
index 9a39a830d1..77d054b35d 100644
--- a/apps/builder/app/builder/shared/style-source-actions.tsx
+++ b/apps/builder/app/builder/shared/style-source-actions.tsx
@@ -16,12 +16,11 @@ import {
} from "@webstudio-is/design-system";
import type { Instance, StyleSource } from "@webstudio-is/sdk";
import {
- $styleSources,
- $styleSourceSelections,
- $styles,
$selectedStyleSources,
$selectedStyleState,
} from "~/shared/nano-states";
+import { $styleSources } from "~/shared/sync/data-stores";
+import { $styleSourceSelections, $styles } from "~/shared/sync/data-stores";
import {
deleteStyleSourceMutable,
findUnusedTokens,
@@ -32,10 +31,7 @@ import {
type RenameStyleSourceError,
} from "~/shared/style-source-utils";
import { serverSyncStore } from "~/shared/sync/sync-stores";
-import { $selectedInstance } from "~/shared/awareness";
-
-// Re-export the type for convenience
-export type { RenameStyleSourceError };
+import { $selectedInstance } from "~/shared/nano-states";
const $isDeleteUnusedTokensDialogOpen = atom(false);
diff --git a/apps/builder/app/builder/shared/topbar-layout.stories.tsx b/apps/builder/app/builder/shared/topbar-layout.stories.tsx
index 06f46251f7..4fd8f95d6c 100644
--- a/apps/builder/app/builder/shared/topbar-layout.stories.tsx
+++ b/apps/builder/app/builder/shared/topbar-layout.stories.tsx
@@ -15,7 +15,7 @@ import {
ShieldIcon,
WebstudioIcon,
} from "@webstudio-is/icons";
-import { $queueStatus } from "~/shared/sync/project-queue";
+import { $syncStatus } from "@webstudio-is/sync-client";
import { $authPermit } from "~/shared/nano-states";
import { SyncStatus } from "~/builder/features/sync-status";
import { ViewMode } from "~/builder/features/view-mode";
@@ -75,7 +75,7 @@ const SafeModeIndicator = () => (
);
export const TopbarLayouts = () => {
- $queueStatus.set({ status: "failed" });
+ $syncStatus.set({ status: "failed" });
$authPermit.set("view");
return (
<StorySection title="Topbar Layouts">
diff --git a/apps/builder/app/builder/shared/topbar.tsx b/apps/builder/app/builder/shared/topbar.tsx
index 04bdcd2cf9..29df9a2dae 100644
--- a/apps/builder/app/builder/shared/topbar.tsx
+++ b/apps/builder/app/builder/shared/topbar.tsx
@@ -21,7 +21,7 @@ import { AddressBarPopover } from "~/builder/features/address-bar";
import { toggleActiveSidebarPanel } from "~/builder/shared/nano-states";
import type { ReactNode } from "react";
import { CloneButton } from "~/builder/features/clone";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
import { BuilderModeDropDown } from "~/builder/features/builder-mode";
import { SafeModeButton } from "~/builder/features/safe-mode";
import { NotificationPopover } from "~/shared/notifications/notification-popover";
diff --git a/apps/builder/app/builder/shared/url-pattern.test.ts b/apps/builder/app/builder/shared/url-pattern.test.ts
index 444f6c9fa9..dbf1479590 100644
--- a/apps/builder/app/builder/shared/url-pattern.test.ts
+++ b/apps/builder/app/builder/shared/url-pattern.test.ts
@@ -6,7 +6,7 @@ import {
tokenizePathnamePattern,
validatePathnamePattern,
} from "./url-pattern";
-import { VALID_URLPATTERN_PATHS } from "@webstudio-is/sdk/router-paths.test";
+import { VALID_URLPATTERN_PATHS } from "@webstudio-is/sdk/router-path-test-data";
/**
* These tests use the shared test data from @webstudio-is/sdk to ensure
diff --git a/apps/builder/app/canvas/canvas.tsx b/apps/builder/app/canvas/canvas.tsx
index 484ffa31db..601b5ad4a4 100644
--- a/apps/builder/app/canvas/canvas.tsx
+++ b/apps/builder/app/canvas/canvas.tsx
@@ -37,9 +37,6 @@ import {
WebstudioComponentPreview,
} from "./features/webstudio-component";
import {
- $assets,
- $pages,
- $instances,
registerComponentLibrary,
$registeredComponents,
subscribeComponentHooks,
@@ -48,8 +45,9 @@ import {
$isContentMode,
subscribeModifierKeys,
assetBaseUrl,
- $breakpoints,
} from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import { $pages, $instances, $breakpoints } from "~/shared/sync/data-stores";
import { useDragAndDrop } from "./shared/use-drag-drop";
import {
initCopyPaste,
@@ -69,13 +67,14 @@ import { subscribeFontLoadingDone } from "./shared/font-weight-support";
import { subscribeSelected } from "./instance-selected";
import { subscribeGridGuidesOnSelected } from "./grid-guide-utils";
import { subscribeScrollNewInstanceIntoView } from "./shared/scroll-new-instance-into-view";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
import { createInstanceElement } from "./elements";
import { subscribeScrollbarSize } from "./scrollbar-width";
import { compareMedia } from "@webstudio-is/css-engine";
import { builderApi } from "~/shared/builder-api";
import { useDebounceEffect } from "@webstudio-is/design-system";
import { subscribeInstanceContextMenu } from "./instance-context-menu";
+import { startPointerTracking } from "~/shared/awareness";
registerContainers();
@@ -313,6 +312,8 @@ export const Canvas = () => {
useEffect(subscribeInflator, []);
+ useEffect(() => startPointerTracking(), []);
+
useHashLinkSync();
useEffect(subscribeInterceptedEvents, []);
diff --git a/apps/builder/app/canvas/features/build-mode/block-template.tsx b/apps/builder/app/canvas/features/build-mode/block-template.tsx
index ea14245aaf..d88c9825bb 100644
--- a/apps/builder/app/canvas/features/build-mode/block-template.tsx
+++ b/apps/builder/app/canvas/features/build-mode/block-template.tsx
@@ -5,7 +5,8 @@ import {
type WebstudioComponentSystemProps,
} from "@webstudio-is/react-sdk";
import * as React from "react";
-import { $isDesignMode, $selectedInstanceSelector } from "~/shared/nano-states";
+import { $isDesignMode } from "~/shared/nano-states";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
export const BlockTemplate = React.forwardRef<
HTMLDivElement,
diff --git a/apps/builder/app/canvas/features/build-mode/block.tsx b/apps/builder/app/canvas/features/build-mode/block.tsx
index 5e183dee67..af7085ce11 100644
--- a/apps/builder/app/canvas/features/build-mode/block.tsx
+++ b/apps/builder/app/canvas/features/build-mode/block.tsx
@@ -8,12 +8,9 @@ import {
} from "@webstudio-is/react-sdk";
import * as React from "react";
-import {
- $instances,
- $isDesignMode,
- $isPreviewMode,
- $selectedInstanceSelector,
-} from "~/shared/nano-states";
+import { $isDesignMode, $isPreviewMode } from "~/shared/nano-states";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
export const Block = React.forwardRef<
HTMLDivElement,
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
index f2c0f75da7..92858674a2 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.stories.tsx
@@ -8,15 +8,15 @@ import { theme } from "@webstudio-is/design-system";
import type { Instance, Instances, Props } from "@webstudio-is/sdk";
import { $, renderData } from "@webstudio-is/template";
import {
- $instances,
- $pages,
$registeredComponentMetas,
$textEditingInstanceSelector,
$textToolbar,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $pages } from "~/shared/sync/data-stores";
import { TextEditor } from "./text-editor";
import { emitCommand, subscribeCommands } from "~/canvas/shared/commands";
-import { $awareness } from "~/shared/awareness";
+import { $selectedPageId } from "~/shared/nano-states";
export default {
component: TextEditor,
@@ -242,7 +242,7 @@ export const CursorPositioningUpDown: StoryFn<typeof TextEditor> = () => {
],
});
- $awareness.set({ pageId: "pageId" });
+ $selectedPageId.set("pageId");
$registeredComponentMetas.set(
new Map([
diff --git a/apps/builder/app/canvas/features/text-editor/text-editor.tsx b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
index 82761e5952..d25098cc5a 100644
--- a/apps/builder/app/canvas/features/text-editor/text-editor.tsx
+++ b/apps/builder/app/canvas/features/text-editor/text-editor.tsx
@@ -71,15 +71,14 @@ import {
$blockChildOutline,
$hoveredInstanceOutline,
$hoveredInstanceSelector,
- $instances,
$registeredComponentMetas,
- $selectedInstanceSelector,
$textEditingInstanceSelector,
$textEditorContextMenu,
execTextEditorContextMenuCommand,
findBlockChildSelector,
findTemplates,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import {
getElementByInstanceSelector,
getVisibleElementsByInstanceSelector,
@@ -87,11 +86,12 @@ import {
import deepEqual from "fast-deep-equal";
import { inflateInstance } from "~/canvas/inflator";
import {
+ $selectedInstanceSelector,
$selectedPage,
addTemporaryInstance,
getInstancePath,
- selectInstance,
-} from "~/shared/awareness";
+} from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { shallowEqual } from "shallow-equal";
import {
insertListItemAt,
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 d00e47ea94..1e1d43fad2 100644
--- a/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
+++ b/apps/builder/app/canvas/features/webstudio-component/webstudio-component.tsx
@@ -60,13 +60,13 @@ export const __testing__ = { computeComponentKey };
import {
$propValuesByInstanceSelectorWithMemoryProps,
getIndexedInstanceId,
- $instances,
$registeredComponentMetas,
$selectedInstanceRenderState,
findBlockSelector,
- $props,
} from "~/shared/nano-states";
+import { $props } from "~/shared/sync/data-stores";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import {
type InstanceSelector,
areInstanceSelectorsEqual,
@@ -75,11 +75,8 @@ import { inflateInstance } from "~/canvas/inflator";
import { getIsVisuallyHidden } from "~/shared/visually-hidden";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { TextEditor } from "../text-editor";
-import {
- $selectedPage,
- getInstanceKey,
- selectInstance,
-} from "~/shared/awareness";
+import { $selectedPage, getInstanceKey } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import {
createInstanceChildrenElements,
type WebstudioComponentProps,
diff --git a/apps/builder/app/canvas/grid-guide-utils.ts b/apps/builder/app/canvas/grid-guide-utils.ts
index 8196618549..7f4142e8e9 100644
--- a/apps/builder/app/canvas/grid-guide-utils.ts
+++ b/apps/builder/app/canvas/grid-guide-utils.ts
@@ -1,14 +1,14 @@
import {
- $instances,
$isResizingCanvas,
$stylesIndex,
$propValuesByInstanceSelectorWithMemoryProps,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { $gridCellData, type GridCellData } from "~/shared/nano-states";
import { subscribeScrollState } from "~/canvas/shared/scroll-state";
import { subscribeWindowResize } from "~/shared/dom-hooks";
import type { InstanceSelector } from "~/shared/tree-utils";
-import { $awareness } from "~/shared/awareness";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
import { getElementByInstanceSelector } from "~/shared/dom-utils";
import { parseGridTemplateTrackList } from "@webstudio-is/css-data";
import { doNotTrackMutation } from "~/shared/dom-utils";
@@ -310,15 +310,16 @@ export const subscribeGridGuidesOnSelected = () => {
let previousSelectedInstance: readonly string[] | undefined = undefined;
let unsubscribeGridGuides = () => {};
- const unsubscribe = $awareness.subscribe((awareness) => {
- const instanceSelector = awareness?.instanceSelector;
- if (instanceSelector !== previousSelectedInstance) {
- unsubscribeGridGuides();
- unsubscribeGridGuides =
- subscribeGridGuides(instanceSelector ?? []) ?? (() => {});
- previousSelectedInstance = instanceSelector;
+ const unsubscribe = $selectedInstanceSelector.subscribe(
+ (instanceSelector) => {
+ if (instanceSelector !== previousSelectedInstance) {
+ unsubscribeGridGuides();
+ unsubscribeGridGuides =
+ subscribeGridGuides(instanceSelector ?? []) ?? (() => {});
+ previousSelectedInstance = instanceSelector;
+ }
}
- });
+ );
return () => {
unsubscribe();
diff --git a/apps/builder/app/canvas/inflator.ts b/apps/builder/app/canvas/inflator.ts
index 7674d41728..5cf22fc59a 100644
--- a/apps/builder/app/canvas/inflator.ts
+++ b/apps/builder/app/canvas/inflator.ts
@@ -3,14 +3,11 @@ import { inflatedAttribute, idAttribute } from "@webstudio-is/react-sdk";
import { compareMedia, type StyleValue } from "@webstudio-is/css-engine";
import { parseGridTemplateTrackList } from "@webstudio-is/css-data";
import type { Breakpoint, StyleDecl, WsComponentMeta } from "@webstudio-is/sdk";
-import {
- $breakpoints,
- $instances,
- $registeredComponentMetas,
- $stylesIndex,
-} from "~/shared/nano-states";
+import { $registeredComponentMetas, $stylesIndex } from "~/shared/nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import { $instances } from "~/shared/sync/data-stores";
import { $selectedBreakpoint } from "~/shared/nano-states";
-import { $selectedPage } from "~/shared/awareness";
+import { $selectedPage } from "~/shared/nano-states";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { doNotTrackMutation } from "~/shared/dom-utils";
diff --git a/apps/builder/app/canvas/instance-hovering.ts b/apps/builder/app/canvas/instance-hovering.ts
index 6a2103a129..df35a6d342 100644
--- a/apps/builder/app/canvas/instance-hovering.ts
+++ b/apps/builder/app/canvas/instance-hovering.ts
@@ -2,10 +2,10 @@ import { idAttribute } from "@webstudio-is/react-sdk";
import {
$blockChildOutline,
$hoveredInstanceSelector,
- $instances,
$textEditingInstanceSelector,
findBlockChildSelector,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { $hoveredInstanceOutline } from "~/shared/nano-states";
import {
getAllElementsBoundingBox,
@@ -14,7 +14,7 @@ import {
} from "~/shared/dom-utils";
import { subscribeScrollState } from "./shared/scroll-state";
import { isDescendantOrSelf, type InstanceSelector } from "~/shared/tree-utils";
-import { $awareness } from "~/shared/awareness";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
type TimeoutId = undefined | ReturnType<typeof setTimeout>;
@@ -196,21 +196,22 @@ export const subscribeInstanceHovering = ({
(instanceSelector) => {
if (instanceSelector) {
updateHoveredRect(instanceSelector);
- } else {
- $hoveredInstanceOutline.set(undefined);
+ return;
}
+ $hoveredInstanceOutline.set(undefined);
}
);
// selected instance selection can change hovered instance outlines (example Block/Template/Child)
- const usubscribeSelectedInstanceSelector = $awareness.subscribe(() => {
- const instanceSelector = $hoveredInstanceSelector.get();
- if (instanceSelector) {
- updateHoveredRect(instanceSelector);
- } else {
+ const usubscribeSelectedInstanceSelector =
+ $selectedInstanceSelector.subscribe(() => {
+ const instanceSelector = $hoveredInstanceSelector.get();
+ if (instanceSelector) {
+ updateHoveredRect(instanceSelector);
+ return;
+ }
$hoveredInstanceOutline.set(undefined);
- }
- });
+ });
signal.addEventListener("abort", () => {
unsubscribeScrollState();
diff --git a/apps/builder/app/canvas/instance-selected.ts b/apps/builder/app/canvas/instance-selected.ts
index 0c94293558..ac824184cd 100644
--- a/apps/builder/app/canvas/instance-selected.ts
+++ b/apps/builder/app/canvas/instance-selected.ts
@@ -10,14 +10,12 @@ import {
$selectedInstanceSizes,
$selectedInstanceRenderState,
$stylesIndex,
- $instances,
$propValuesByInstanceSelectorWithMemoryProps,
- $styles,
$selectedInstanceStates,
- $styleSourceSelections,
type UnitSizes,
type PropertySizes,
} from "~/shared/nano-states";
+import { $styleSourceSelections } from "~/shared/sync/data-stores";
import {
getAllElementsBoundingBox,
getVisibleElementsByInstanceSelector,
@@ -27,9 +25,10 @@ import {
} from "~/shared/dom-utils";
import { subscribeScrollState } from "~/canvas/shared/scroll-state";
import { $selectedInstanceOutline } from "~/shared/nano-states";
+import { $instances, $styles } from "~/shared/sync/data-stores";
import { inflateInstance } from "~/canvas/inflator";
import type { InstanceSelector } from "~/shared/tree-utils";
-import { $awareness } from "~/shared/awareness";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
const setOutline = (instanceId: Instance["id"], elements: HTMLElement[]) => {
$selectedInstanceOutline.set({
@@ -344,16 +343,17 @@ export const subscribeSelected = (
let previousSelectedInstance: readonly string[] | undefined = undefined;
let unsubscribeSelectedInstance = () => {};
- const unsubscribe = $awareness.subscribe((awareness) => {
- const instanceSelector = awareness?.instanceSelector;
- if (instanceSelector !== previousSelectedInstance) {
- unsubscribeSelectedInstance();
- unsubscribeSelectedInstance =
- subscribeSelectedInstance(instanceSelector ?? [], debounceEffect) ??
- (() => {});
- previousSelectedInstance = instanceSelector;
+ const unsubscribe = $selectedInstanceSelector.subscribe(
+ (instanceSelector) => {
+ if (instanceSelector !== previousSelectedInstance) {
+ unsubscribeSelectedInstance();
+ unsubscribeSelectedInstance =
+ subscribeSelectedInstance(instanceSelector ?? [], debounceEffect) ??
+ (() => {});
+ previousSelectedInstance = instanceSelector;
+ }
}
- });
+ );
return () => {
unsubscribe();
diff --git a/apps/builder/app/canvas/instance-selection.ts b/apps/builder/app/canvas/instance-selection.ts
index c8145f9247..ff8fcf7152 100644
--- a/apps/builder/app/canvas/instance-selection.ts
+++ b/apps/builder/app/canvas/instance-selection.ts
@@ -2,15 +2,16 @@ import { getInstanceSelectorFromElement } from "~/shared/dom-utils";
import {
$hoveredInstanceOutline,
$hoveredInstanceSelector,
- $instances,
$isContentMode,
- $props,
$registeredComponentMetas,
} from "~/shared/nano-states";
+import { $props } from "~/shared/sync/data-stores";
import { $textEditingInstanceSelector } from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import { emitCommand } from "./shared/commands";
import { shallowEqual } from "shallow-equal";
-import { $awareness, selectInstance } from "~/shared/awareness";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { findClosestRichText } from "~/shared/content-model";
const isElementBeingEdited = (element: Element) => {
@@ -44,7 +45,7 @@ const handleSelect = (event: MouseEvent) => {
}
// Prevent unnecessary updates (2 clicks are registered before a double click)
- if (!shallowEqual(instanceSelector, $awareness.get()?.instanceSelector)) {
+ if (!shallowEqual(instanceSelector, $selectedInstanceSelector.get())) {
selectInstance(instanceSelector);
}
};
@@ -100,7 +101,7 @@ const handleEdit = (event: MouseEvent) => {
}
// Select the instance when no editable parent is found
- if (!shallowEqual(instanceSelector, $awareness.get()?.instanceSelector)) {
+ if (!shallowEqual(instanceSelector, $selectedInstanceSelector.get())) {
selectInstance(instanceSelector);
}
@@ -109,7 +110,7 @@ const handleEdit = (event: MouseEvent) => {
// Avoid redundant selection if the instance is already selected
if (
- !shallowEqual($awareness.get()?.instanceSelector, editableInstanceSelector)
+ !shallowEqual($selectedInstanceSelector.get(), editableInstanceSelector)
) {
selectInstance(editableInstanceSelector);
}
diff --git a/apps/builder/app/canvas/interceptor.ts b/apps/builder/app/canvas/interceptor.ts
index 0125df5b92..4aa5982966 100644
--- a/apps/builder/app/canvas/interceptor.ts
+++ b/apps/builder/app/canvas/interceptor.ts
@@ -4,12 +4,10 @@ import {
matchPathnamePattern,
tokenizePathnamePattern,
} from "~/builder/shared/url-pattern";
-import { $selectedPage, selectPage } from "~/shared/awareness";
-import {
- $isPreviewMode,
- $pages,
- $selectedPageHash,
-} from "~/shared/nano-states";
+import { $selectedPage } from "~/shared/nano-states";
+import { selectPage } from "~/shared/nano-states";
+import { $isPreviewMode, $selectedPageHash } from "~/shared/nano-states";
+import { $pages } from "~/shared/sync/data-stores";
import { $currentSystem, updateCurrentSystem } from "~/shared/system";
import { comparePatterns } from "./shared/routing-priority";
diff --git a/apps/builder/app/canvas/shared/commands.ts b/apps/builder/app/canvas/shared/commands.ts
index ff1327ecdb..08cc7d79ae 100644
--- a/apps/builder/app/canvas/shared/commands.ts
+++ b/apps/builder/app/canvas/shared/commands.ts
@@ -4,20 +4,20 @@ import { createCommandsEmitter } from "~/shared/commands-emitter";
import { getElementByInstanceSelector } from "~/shared/dom-utils";
import { findAllEditableInstanceSelector } from "~/shared/instance-utils";
import {
- $instances,
- $props,
$registeredComponentMetas,
- $selectedInstanceSelector,
$textEditingInstanceSelector,
$textToolbar,
} from "~/shared/nano-states";
+import { $instances } from "~/shared/sync/data-stores";
+import { $props } from "~/shared/sync/data-stores";
import {
CLEAR_FORMAT_COMMAND,
TOGGLE_SPAN_COMMAND,
getActiveEditor,
hasSelectionFormat,
} from "../features/text-editor/toolbar-connector";
-import { selectInstance } from "~/shared/awareness";
+import { $selectedInstanceSelector } from "~/shared/nano-states";
+import { selectInstance } from "~/shared/nano-states";
import { isDescendantOrSelf, type InstanceSelector } from "~/shared/tree-utils";
import { deleteSelectedInstance } from "~/shared/instance-utils";
import { findClosestRichText } from "~/shared/content-model";
diff --git a/apps/builder/app/canvas/shared/styles.test.ts b/apps/builder/app/canvas/shared/styles.test.ts
index 9a260929b8..775f171fea 100644
--- a/apps/builder/app/canvas/shared/styles.test.ts
+++ b/apps/builder/app/canvas/shared/styles.test.ts
@@ -28,6 +28,7 @@ const {
hasExpressionChildren,
renderStateStyles,
simulateConditionBreakpoints,
+ shouldRenderInBackgroundTask,
} = __testing__;
const createTestSheet = () =>
@@ -232,6 +233,24 @@ describe("renderStateStyles", () => {
});
});
+describe("shouldRenderInBackgroundTask", () => {
+ test("returns true when document is hidden", () => {
+ expect(shouldRenderInBackgroundTask("hidden")).toBe(true);
+ });
+
+ test("returns true when document is prerender", () => {
+ expect(shouldRenderInBackgroundTask("prerender")).toBe(true);
+ });
+
+ test("returns false when document is visible", () => {
+ expect(shouldRenderInBackgroundTask("visible")).toBe(false);
+ });
+
+ test("returns false when visibility state is unavailable", () => {
+ expect(shouldRenderInBackgroundTask(undefined)).toBe(false);
+ });
+});
+
describe("getEphemeralProperty", () => {
test("generates property name from styleSourceId, state, and property", () => {
expect(
diff --git a/apps/builder/app/canvas/shared/styles.ts b/apps/builder/app/canvas/shared/styles.ts
index 15b36eca07..292c1ae510 100644
--- a/apps/builder/app/canvas/shared/styles.ts
+++ b/apps/builder/app/canvas/shared/styles.ts
@@ -28,22 +28,27 @@ import {
toVarFallback,
} from "@webstudio-is/css-engine";
import {
- $assets,
- $breakpoints,
- $instances,
- $props,
$registeredComponentMetas,
$selectedBreakpoint,
- $selectedInstanceSelector,
$selectedStyleState,
- $styleSourceSelections,
- $styles,
assetBaseUrl,
} from "~/shared/nano-states";
+import { $assets } from "~/shared/sync/data-stores";
+import {
+ $breakpoints,
+ $instances,
+ $props,
+ $styleSourceSelections,
+ $styles,
+} from "~/shared/sync/data-stores";
import { setDifference } from "~/shared/shim";
import { $ephemeralStyles } from "../stores";
import { canvasApi } from "~/shared/canvas-api";
-import { $selectedInstance, $selectedPage } from "~/shared/awareness";
+import {
+ $selectedInstance,
+ $selectedInstanceSelector,
+ $selectedPage,
+} from "~/shared/nano-states";
import { findAllEditableInstanceSelector } from "~/shared/instance-utils";
import type { InstanceSelector } from "~/shared/tree-utils";
import { getAllElementsByInstanceSelector } from "~/shared/dom-utils";
@@ -448,21 +453,66 @@ const simulateConditionBreakpoints = ({
return result;
};
+const shouldRenderInBackgroundTask = (
+ visibilityState: DocumentVisibilityState | "prerender" | undefined
+) => {
+ return visibilityState !== undefined && visibilityState !== "visible";
+};
+
/**
* track new or deleted styles and style source selections items
* and update style sheet accordingly
*/
export const subscribeStyles = () => {
- let animationFrameId: undefined | number;
+ let renderJob:
+ | undefined
+ | {
+ type: "raf";
+ id: number;
+ }
+ | {
+ type: "timeout";
+ id: ReturnType<typeof setTimeout>;
+ };
+
+ const cancelScheduledRender = () => {
+ if (renderJob === undefined) {
+ return;
+ }
+ if (renderJob.type === "raf") {
+ cancelAnimationFrame(renderJob.id);
+ }
+ if (renderJob.type === "timeout") {
+ clearTimeout(renderJob.id);
+ }
+ renderJob = undefined;
+ };
const renderUserSheetInTheNextFrame = () => {
- if (animationFrameId) {
- cancelAnimationFrame(animationFrameId);
+ cancelScheduledRender();
+ const visibilityState =
+ typeof document === "undefined" ? undefined : document.visibilityState;
+ if (shouldRenderInBackgroundTask(visibilityState)) {
+ // Background tabs throttle or pause requestAnimationFrame, which would
+ // delay remote style updates until the window regains focus.
+ renderJob = {
+ type: "timeout",
+ id: setTimeout(() => {
+ renderJob = undefined;
+ userSheet.setTransformer($transformValue.get());
+ userSheet.render();
+ }, 50),
+ };
+ return;
}
- animationFrameId = requestAnimationFrame(() => {
- userSheet.setTransformer($transformValue.get());
- userSheet.render();
- });
+ renderJob = {
+ type: "raf",
+ id: requestAnimationFrame(() => {
+ renderJob = undefined;
+ userSheet.setTransformer($transformValue.get());
+ userSheet.render();
+ }),
+ };
};
const unsubscribeBreakpoints = computed(
@@ -559,9 +609,7 @@ export const subscribeStyles = () => {
unsubscribeStyleSourceSelections();
unsubscribeDescendantSelectors();
unsubscribeTransformValue();
- if (animationFrameId) {
- cancelAnimationFrame(animationFrameId);
- }
+ cancelScheduledRender();
};
};
@@ -873,4 +921,5 @@ export const __testing__ = {
hasExpressionChildren,
renderStateStyles,
simulateConditionBreakpoints,
+ shouldRenderInBackgroundTask,
};
diff --git a/apps/builder/app/canvas/shared/use-drag-drop.ts b/apps/builder/app/canvas/shared/use-drag-drop.ts
index 66061dd95a..b2838b5e0f 100644
--- a/apps/builder/app/canvas/shared/use-drag-drop.ts
+++ b/apps/builder/app/canvas/shared/use-drag-drop.ts
@@ -9,11 +9,10 @@ import {
} from "@webstudio-is/design-system";
import {
$dragAndDropState,
- $instances,
- $props,
$registeredComponentMetas,
type ItemDropTarget,
} from "~/shared/nano-states";
+import { $instances, $props } from "~/shared/sync/data-stores";
import { publish, useSubscribe } from "~/shared/pubsub";
import {
getComponentTemplateData,
diff --git a/apps/builder/app/dashboard/projects/colors.ts b/apps/builder/app/dashboard/projects/colors.ts
deleted file mode 100644
index 9b05f55fd9..0000000000
--- a/apps/builder/app/dashboard/projects/colors.ts
+++ /dev/null
@@ -1,6 +0,0 @@
-export const colors = Array.from({ length: 50 }, (_, i) => {
- const l = 55 + (i % 3) * 3; // Reduced variation in lightness (55-61%) to lower contrast
- const c = 0.14 + (i % 2) * 0.02; // Reduced variation in chroma (0.14-0.16) for balance
- const h = (i * 137.5) % 360; // Golden angle for pleasing hue distribution
- return `oklch(${l}% ${c.toFixed(2)} ${h.toFixed(1)})`;
-});
diff --git a/apps/builder/app/dashboard/projects/tags.tsx b/apps/builder/app/dashboard/projects/tags.tsx
index f57982cabb..c347335b69 100644
--- a/apps/builder/app/dashboard/projects/tags.tsx
+++ b/apps/builder/app/dashboard/projects/tags.tsx
@@ -28,7 +28,13 @@ import { nativeClient } from "~/shared/trpc/trpc-client";
import type { User } from "~/shared/db/user.server";
import { nanoid } from "nanoid";
import { EllipsesIcon, SpinnerIcon } from "@webstudio-is/icons";
-import { colors } from "./colors";
+
+const tagColorPalette = Array.from({ length: 50 }, (_, index) => {
+ const lightness = 55 + (index % 3) * 3;
+ const chroma = 0.14 + (index % 2) * 0.02;
+ const hue = (index * 137.5) % 360;
+ return `oklch(${lightness}% ${chroma.toFixed(2)} ${hue.toFixed(1)})`;
+});
type DeleteConfirmationDialogProps = {
onClose: () => void;
@@ -341,7 +347,7 @@ export const Tag = ({
>) => {
const [searchParams, setSearchParams] = useSearchParams();
const selectedTagsIds = searchParams.getAll("tag");
- const color = colors[index] ?? theme.colors.backgroundNeutralDark;
+ const color = tagColorPalette[index] ?? theme.colors.backgroundNeutralDark;
return (
<Button
color="neutral"
diff --git a/apps/builder/app/env/env.static.ts b/apps/builder/app/env/env.static.ts
index 182ab980d2..3f5169a110 100644
--- a/apps/builder/app/env/env.static.ts
+++ b/apps/builder/app/env/env.static.ts
@@ -9,4 +9,5 @@
export const publicStaticEnv = {
VERSION: import.meta.env.GITHUB_SHA ?? "local",
+ COLLAB_RELAY_URL: import.meta.env.PUBLIC_COLLAB_RELAY_URL,
};
diff --git a/apps/builder/app/env/vite-env.d.ts b/apps/builder/app/env/vite-env.d.ts
index db9bd03fe2..c1af4b1081 100644
--- a/apps/builder/app/env/vite-env.d.ts
+++ b/apps/builder/app/env/vite-env.d.ts
@@ -1,4 +1,5 @@
interface ImportMetaEnv {
readonly GITHUB_REF_NAME: string | undefined;
readonly GITHUB_SHA: string | undefined;
+ readonly PUBLIC_COLLAB_RELAY_URL: string | undefined;
}
diff --git a/apps/builder/app/routes/rest.build-version.ts b/apps/builder/app/routes/rest.build-version.ts
new file mode 100644
index 0000000000..a511cffd41
--- /dev/null
+++ b/apps/builder/app/routes/rest.build-version.ts
@@ -0,0 +1,21 @@
+import type { LoaderFunctionArgs } from "@remix-run/server-runtime";
+import { json } from "@remix-run/server-runtime";
+import { loadRawBuildById } from "@webstudio-is/project-build/index.server";
+import { createContext } from "~/shared/context.server";
+import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
+
+export const loader = async ({ request }: LoaderFunctionArgs) => {
+ preventCrossOriginCookie(request);
+
+ const url = new URL(request.url);
+ const buildId = url.searchParams.get("buildId");
+
+ if (!buildId) {
+ throw new Response("Missing buildId", { status: 400 });
+ }
+
+ const context = await createContext(request);
+ const build = await loadRawBuildById(context, buildId);
+
+ return json({ version: build.version });
+};
diff --git a/apps/builder/app/routes/rest.patch.ts b/apps/builder/app/routes/rest.patch.ts
deleted file mode 100644
index 08d77cc5a7..0000000000
--- a/apps/builder/app/routes/rest.patch.ts
+++ /dev/null
@@ -1,459 +0,0 @@
-import { applyPatches, enableMapSet, enablePatches, type Patch } from "immer";
-import type { ActionFunctionArgs } from "@remix-run/server-runtime";
-import {
- Breakpoints,
- Breakpoint,
- Instances,
- Instance,
- Pages,
- Props,
- Prop,
- DataSources,
- DataSource,
- StyleSourceSelections,
- StyleSources,
- StyleSource,
- Styles,
- Resources,
- Resource,
-} from "@webstudio-is/sdk";
-import {
- type Build,
- findCycles,
- MarketplaceProduct,
-} from "@webstudio-is/project-build";
-import {
- parsePages,
- parseStyleSourceSelections,
- parseStyles,
- serializePages,
- serializeStyleSourceSelections,
- serializeStyles,
- parseData,
- serializeData,
- parseConfig,
- serializeConfig,
- loadRawBuildById,
- parseInstanceData,
-} from "@webstudio-is/project-build/index.server";
-import { patchAssets } from "@webstudio-is/asset-uploader/index.server";
-import type { Project } from "@webstudio-is/project";
-import {
- AuthorizationError,
- authorizeProject,
-} from "@webstudio-is/trpc-interface/index.server";
-import { createContext } from "~/shared/context.server";
-import * as projectApi from "@webstudio-is/project/index.server";
-import type { Database } from "@webstudio-is/postgrest/index.server";
-import { publicStaticEnv } from "~/env/env.static";
-import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
-import { checkCsrf } from "~/services/csrf-session.server";
-import type { Transaction } from "~/shared/sync-client";
-
-type Change = {
- namespace: string;
- patches: Array<Patch>;
-};
-
-type PatchData = {
- transactions: Transaction<Change[]>[];
- buildId: Build["id"];
- projectId: Project["id"];
- version: number;
-};
-
-export const action = async ({
- request,
-}: ActionFunctionArgs): Promise<
- | { status: "ok" }
- | { status: "version_mismatched"; errors: string }
- | { status: "authorization_error"; errors: string }
- | { status: "error"; errors: string }
-> => {
- try {
- preventCrossOriginCookie(request);
-
- enableMapSet();
- enablePatches();
-
- await checkCsrf(request);
-
- const {
- buildId,
- projectId,
- transactions,
- version: clientVersion,
- }: PatchData = await request.json();
-
- const version = new URL(request.url).searchParams.get("client-version");
-
- if (publicStaticEnv.VERSION !== version) {
- return {
- status: "version_mismatched",
- errors: `The client and server versions do not match. Please reload to continue.`,
- };
- }
-
- if (buildId === undefined) {
- return { status: "error", errors: "Build id required" };
- }
- if (projectId === undefined) {
- return { status: "error", errors: "Project id required" };
- }
-
- const lastTransactionId = transactions.at(-1)?.id;
-
- if (lastTransactionId === undefined) {
- return {
- status: "error",
- errors: "Transaction array must not be empty.",
- };
- }
-
- const context = await createContext(request);
-
- if (context.authorization.type === "service") {
- throw new AuthorizationError("Service calls are not allowed");
- }
-
- if (context.authorization.type === "anonymous") {
- return {
- status: "authorization_error",
- errors:
- "Due to a recent update or a possible logout, you may need to log in again. Please reload the page and sign in to continue.",
- };
- }
-
- // @todo: Commented until better Content Edit mode checks are implemented
- const [canEditContent /* canEdit */] = await Promise.all([
- authorizeProject.hasProjectPermit({ projectId, permit: "edit" }, context),
- /*
- authorizeProject.hasProjectPermit(
- { projectId, permit: "build" },
- context
- ),
- */
- ]);
-
- if (canEditContent === false) {
- return {
- status: "authorization_error",
- errors: "You don't have permission to edit this project.",
- };
- }
-
- // const isContentEditMode = canEditContent && !canEdit;
-
- const build = await loadRawBuildById(context, buildId);
-
- const serverVersion = build.version;
- if (clientVersion !== serverVersion) {
- // Check if a retry attempt is made with a previously successful transaction.
- // This can occur if the connection was lost or an error occurred post-transaction completion,
- // leaving the client in an erroneous state and prompting a retry.
- if (lastTransactionId === build.lastTransactionId) {
- return { status: "ok" };
- }
-
- return {
- status: "version_mismatched",
- errors: `You are currently in single-player mode. The project has been edited in a different tab, browser, or by another user. Please reload the page to get the latest version.`,
- };
- }
-
- const buildData: {
- pages?: Pages;
- breakpoints?: Breakpoints;
- instances?: Instances;
- props?: Props;
- dataSources?: DataSources;
- resources?: Resources;
- styleSources?: StyleSources;
- styleSourceSelections?: StyleSourceSelections;
- styles?: Styles;
- marketplaceProduct?: MarketplaceProduct;
- } = {};
-
- let previewImageAssetId: string | null | undefined = undefined;
-
- // Used to optimize by validating only changed styles, as they accounted for 99% of validation time
- const patchedStyleDeclKeysSet = new Set<string>();
-
- for await (const transaction of transactions) {
- for await (const change of transaction.payload) {
- const { namespace, patches } = change;
- if (patches.length === 0) {
- continue;
- }
-
- if (namespace === "pages") {
- // lazily parse build data before patching
- const pages = buildData.pages ?? parsePages(build.pages);
- const currentSocialImageAssetId =
- pages.homePage.meta.socialImageAssetId;
- buildData.pages = applyPatches(pages, patches);
- const newSocialImageAssetId =
- buildData.pages.homePage.meta.socialImageAssetId;
- if (currentSocialImageAssetId !== newSocialImageAssetId) {
- previewImageAssetId = newSocialImageAssetId || null;
- }
- continue;
- }
-
- if (namespace === "instances") {
- const instances =
- buildData.instances ?? parseInstanceData(build.instances);
-
- buildData.instances = applyPatches(instances, patches);
-
- // Detect cycles
- const cycles = findCycles(buildData.instances.values());
- if (cycles.length > 0) {
- console.error(
- "Cycles detected in the instance tree after patching",
- cycles
- );
-
- return {
- status: "error",
- errors: "Cycles detected in the instance tree",
- };
- }
-
- continue;
- }
-
- if (namespace === "props") {
- const props = buildData.props ?? parseData<Prop>(build.props);
- buildData.props = applyPatches(props, patches);
- continue;
- }
-
- if (namespace === "assets") {
- // assets implements own patching
- // @todo parallelize the updates
- // currently not possible because we fetch the entire tree
- // and parallelized updates will cause unpredictable side effects
- await patchAssets({ projectId }, patches, context);
- continue;
- }
-
- // This is super simple and naive implementation of permissions checks for Content Edit mode
- // @todo: Implement proper permissions checks, one of idea is to allow any changes to the new instances
- /*
- if (isContentEditMode) {
- return {
- status: "error",
- errors: `You don't have permission to patch namespace ${namespace}`,
- };
- }*/
-
- if (namespace === "styleSourceSelections") {
- const styleSourceSelections =
- buildData.styleSourceSelections ??
- parseStyleSourceSelections(build.styleSourceSelections);
- buildData.styleSourceSelections = applyPatches(
- styleSourceSelections,
- patches
- );
- continue;
- }
-
- if (namespace === "styleSources") {
- const styleSources =
- buildData.styleSources ??
- parseData<StyleSource>(build.styleSources);
- buildData.styleSources = applyPatches(styleSources, patches);
- continue;
- }
-
- if (namespace === "styles") {
- // It's somehow implementation detail leak, as we use the fact that styles patches has ids in path
- for (const patch of patches) {
- patchedStyleDeclKeysSet.add(`${patch.path[0]}`);
- }
-
- const styles = buildData.styles ?? parseStyles(build.styles);
- buildData.styles = applyPatches(styles, patches);
- continue;
- }
-
- if (namespace === "dataSources") {
- const dataSources =
- buildData.dataSources ?? parseData<DataSource>(build.dataSources);
- buildData.dataSources = applyPatches(dataSources, patches);
- continue;
- }
-
- if (namespace === "resources") {
- const resources =
- buildData.resources ?? parseData<Resource>(build.resources);
- buildData.resources = applyPatches(resources, patches);
- continue;
- }
-
- if (namespace === "breakpoints") {
- const breakpoints =
- buildData.breakpoints ?? parseData<Breakpoint>(build.breakpoints);
- buildData.breakpoints = applyPatches(breakpoints, patches);
- continue;
- }
-
- if (namespace === "marketplaceProduct") {
- const marketplaceProduct =
- buildData.marketplaceProduct ??
- parseConfig<MarketplaceProduct>(build.marketplaceProduct);
-
- buildData.marketplaceProduct = applyPatches(
- marketplaceProduct,
- patches
- );
-
- continue;
- }
-
- return { status: "error", errors: `Unknown namespace "${namespace}"` };
- }
- }
-
- // save build data when all patches applied
- const dbBuildData: Database["public"]["Tables"]["Build"]["Update"] = {
- version: clientVersion + 1,
- lastTransactionId,
- updatedAt: new Date().toISOString(),
- };
-
- if (buildData.pages) {
- // parse with zod before serialization to avoid saving invalid data
- dbBuildData.pages = serializePages(Pages.parse(buildData.pages));
- }
-
- if (buildData.breakpoints) {
- dbBuildData.breakpoints = serializeData<Breakpoint>(
- Breakpoints.parse(buildData.breakpoints)
- );
- }
-
- if (buildData.instances) {
- dbBuildData.instances = serializeData<Instance>(
- Instances.parse(buildData.instances)
- );
- }
-
- if (buildData.props) {
- dbBuildData.props = serializeData<Prop>(Props.parse(buildData.props));
- }
-
- if (buildData.dataSources) {
- dbBuildData.dataSources = serializeData<DataSource>(
- DataSources.parse(buildData.dataSources)
- );
- }
-
- if (buildData.resources) {
- dbBuildData.resources = serializeData<Resource>(
- Resources.parse(buildData.resources)
- );
- }
-
- if (buildData.styleSources) {
- dbBuildData.styleSources = serializeData<StyleSource>(
- StyleSources.parse(buildData.styleSources)
- );
- }
- if (buildData.styleSourceSelections) {
- dbBuildData.styleSourceSelections = serializeStyleSourceSelections(
- StyleSourceSelections.parse(buildData.styleSourceSelections)
- );
- }
-
- if (buildData.styles) {
- // Optimize by validating only changed styles, as they accounted for 99% of validation time
- const stylesToValidate: Styles = new Map();
- for (const styleId of patchedStyleDeclKeysSet) {
- const style = buildData.styles.get(styleId);
- // In case of deletion style could be undefined
- if (style === undefined) {
- continue;
- }
-
- stylesToValidate.set(styleId, style);
- }
-
- Styles.parse(stylesToValidate);
-
- dbBuildData.styles = serializeStyles(buildData.styles);
- }
-
- if (buildData.marketplaceProduct) {
- dbBuildData.marketplaceProduct = serializeConfig<MarketplaceProduct>(
- MarketplaceProduct.parse(buildData.marketplaceProduct)
- );
- }
-
- const update = await context.postgrest.client
- .from("Build")
- .update(dbBuildData, { count: "exact" })
- .match({
- id: buildId,
- projectId,
- version: clientVersion,
- });
-
- if (update.error) {
- console.error(update.error);
- throw update.error;
- }
- if (update.count == null) {
- console.error("Update count is null");
- throw new Error("Update count is null");
- }
-
- // ensure only build with client version is updated
- // to avoid race conditions
- if (update.count === 0) {
- // We don't validate if lastTransactionId matches the user's transaction ID here, as we've already done so earlier.
- // Given the sequential nature of messages from a single client, this situation is deemed improbable.
- return {
- status: "version_mismatched",
- errors: `You are currently in single-player mode. The project has been edited in a different tab, browser, or by another user. Please reload the page to get the latest version.`,
- };
- }
-
- if (previewImageAssetId !== undefined) {
- await projectApi.updatePreviewImage(
- { assetId: previewImageAssetId, projectId },
- context
- );
- }
-
- return { status: "ok" };
- } catch (error) {
- if (error instanceof AuthorizationError) {
- return {
- status: "authorization_error",
- errors: error.message,
- };
- }
-
- if (error instanceof Response && error.ok === false) {
- return {
- status: "authorization_error",
- errors: error.statusText,
- };
- }
-
- if (error instanceof Response) {
- return {
- status: "error",
- errors: await error.text(),
- };
- }
-
- console.error(error);
- return {
- status: "error",
- errors: error instanceof Error ? error.message : JSON.stringify(error),
- };
- }
-};
diff --git a/apps/builder/app/routes/trpc.$.ts b/apps/builder/app/routes/trpc.$.ts
index c68ce8b4a2..e9b4b5c9bf 100644
--- a/apps/builder/app/routes/trpc.$.ts
+++ b/apps/builder/app/routes/trpc.$.ts
@@ -1,13 +1,19 @@
import { fetchRequestHandler } from "@trpc/server/adapters/fetch";
import type { ActionFunctionArgs } from "@remix-run/server-runtime";
-import { createContext } from "~/shared/context.server";
+import { createContext, isServiceAuthorization } from "~/shared/context.server";
import { appRouter } from "~/services/trcp-router.server";
import { preventCrossOriginCookie } from "~/services/no-cross-origin-cookie";
import { checkCsrf } from "~/services/csrf-session.server";
+const isServiceRequest = (request: Request) => {
+ return isServiceAuthorization(request.headers.get("Authorization"));
+};
+
export const action = async ({ request }: ActionFunctionArgs) => {
- preventCrossOriginCookie(request);
- await checkCsrf(request);
+ if (isServiceRequest(request) === false) {
+ preventCrossOriginCookie(request);
+ await checkCsrf(request);
+ }
// https://trpc.io/docs/server/adapters/fetch
const response = await fetchRequestHandler({
diff --git a/apps/builder/app/services/build-router.server.ts b/apps/builder/app/services/build-router.server.ts
new file mode 100644
index 0000000000..40d855af93
--- /dev/null
+++ b/apps/builder/app/services/build-router.server.ts
@@ -0,0 +1,190 @@
+import { z } from "zod";
+import {
+ AuthorizationError,
+ authorizeProject,
+} from "@webstudio-is/trpc-interface/index.server";
+import {
+ procedure,
+ router,
+ type AppContext,
+} from "@webstudio-is/trpc-interface/index.server";
+import { publicStaticEnv } from "~/env/env.static";
+import env from "~/env/env.server";
+import { createAccessToken } from "~/services/token.server";
+import {
+ applyPatchRequest,
+ loadAuthorizedPatchState,
+ toPatchResult,
+} from "~/shared/sync/patch/patch-service.server";
+import { normalizePatchRequest } from "~/shared/sync/patch/patch-normalize.server";
+import type { BuildPatchTransaction } from "@webstudio-is/project/index.server";
+
+const patchEntryInput = z.object({
+ seq: z.number().optional(),
+ transaction: z.custom<BuildPatchTransaction>(),
+});
+
+const browserPatchInput = z.object({
+ source: z.literal("browser"),
+ appVersion: z.string(),
+ authToken: z.string().optional(),
+ buildId: z.string(),
+ projectId: z.string(),
+ version: z.number(),
+ entries: z.array(patchEntryInput),
+});
+
+const relayPatchInput = z.object({
+ source: z.literal("relay"),
+ buildId: z.string(),
+ projectId: z.string(),
+ version: z.number(),
+ entries: z.array(
+ patchEntryInput.extend({
+ authToken: z.string(),
+ })
+ ),
+});
+
+const loadBuildProjectId = async (ctx: AppContext, buildId: string) => {
+ const build = await ctx.postgrest.client
+ .from("Build")
+ .select("projectId")
+ .eq("id", buildId)
+ .single();
+
+ if (build.error) {
+ throw build.error;
+ }
+
+ return String(build.data.projectId);
+};
+
+const assertBrowserPatchContext = ({
+ appVersion,
+ authorization,
+}: {
+ appVersion: string;
+ authorization: AppContext["authorization"];
+}) => {
+ if (authorization.type === "service") {
+ throw new AuthorizationError("Service calls are not allowed");
+ }
+ if (authorization.type === "anonymous") {
+ throw new AuthorizationError(
+ "Due to a recent update or a possible logout, you may need to log in again. Please reload the page and sign in to continue."
+ );
+ }
+ if (publicStaticEnv.VERSION !== appVersion) {
+ return {
+ status: "version_mismatched" as const,
+ errors:
+ "The client and server versions do not match. Please reload to continue.",
+ };
+ }
+};
+
+const assertRelayPatchContext = (
+ authorization: AppContext["authorization"]
+) => {
+ if (authorization.type !== "service") {
+ throw new AuthorizationError("Collab relay is not authorized");
+ }
+};
+
+export const buildRouter = router({
+ createCollabToken: procedure
+ .input(
+ z.object({
+ buildId: z.string(),
+ projectId: z.string(),
+ })
+ )
+ .query(async ({ ctx, input }) => {
+ if (env.AUTH_WS_CLIENT_SECRET.length === 0) {
+ throw new Error("Collaboration token signing is not configured");
+ }
+ if (ctx.authorization.type !== "user") {
+ throw new AuthorizationError(
+ "Collaboration token requires a user session"
+ );
+ }
+
+ const buildProjectId = await loadBuildProjectId(ctx, input.buildId);
+ if (buildProjectId !== input.projectId) {
+ throw new Error("Build does not belong to project");
+ }
+
+ const canEdit = await authorizeProject.hasProjectPermit(
+ { projectId: input.projectId, permit: "edit" },
+ ctx
+ );
+ if (canEdit === false) {
+ throw new AuthorizationError(
+ "You don't have permission to edit this project."
+ );
+ }
+
+ return {
+ token: await createAccessToken(
+ { userId: ctx.authorization.userId, projectId: input.projectId },
+ env.AUTH_WS_CLIENT_SECRET,
+ { maxAge: 5 * 60 * 1000 }
+ ),
+ };
+ }),
+
+ getPatchState: procedure
+ .input(
+ z.object({
+ authToken: z.string(),
+ buildId: z.string(),
+ })
+ )
+ .mutation(async ({ ctx, input }) => {
+ assertRelayPatchContext(ctx.authorization);
+ return await loadAuthorizedPatchState({
+ authToken: input.authToken,
+ buildId: input.buildId,
+ context: ctx,
+ });
+ }),
+
+ patch: procedure
+ .input(z.discriminatedUnion("source", [browserPatchInput, relayPatchInput]))
+ .mutation(async ({ ctx, input }) => {
+ try {
+ if (input.source === "browser") {
+ const patchContext =
+ input.authToken === undefined
+ ? ctx
+ : await ctx.createTokenContext(input.authToken);
+ const versionResult = assertBrowserPatchContext({
+ appVersion: input.appVersion,
+ authorization: patchContext.authorization,
+ });
+ if (versionResult !== undefined) {
+ return versionResult;
+ }
+ return await applyPatchRequest(
+ patchContext,
+ normalizePatchRequest(input, () => ({
+ type: "context",
+ context: patchContext,
+ }))
+ );
+ }
+
+ assertRelayPatchContext(ctx.authorization);
+ return await applyPatchRequest(
+ ctx,
+ normalizePatchRequest(input, (entry) => ({
+ type: "token",
+ authToken: entry.authToken,
+ }))
+ );
+ } catch (error) {
+ return await toPatchResult(error);
+ }
+ }),
+});
diff --git a/apps/builder/app/services/trcp-router.server.ts b/apps/builder/app/services/trcp-router.server.ts
index 4044848b6d..022b24815c 100644
--- a/apps/builder/app/services/trcp-router.server.ts
+++ b/apps/builder/app/services/trcp-router.server.ts
@@ -9,8 +9,10 @@ import { userRouter } from "./user-router.server";
import { logoutRouter } from "./logout-router.server";
import { notificationRouter } from "./notification-router.server";
import { workspaceRouter } from "./workspace-router.server";
+import { buildRouter } from "./build-router.server";
export const appRouter = router({
+ build: buildRouter,
user: userRouter,
marketplace: marketplaceRouter,
domain: domainRouter,
diff --git a/apps/builder/app/shared/awareness.test.tsx b/apps/builder/app/shared/awareness.test.tsx
index 1c51b85ec6..3fb549e8df 100644
--- a/apps/builder/app/shared/awareness.test.tsx
+++ b/apps/builder/app/shared/awareness.test.tsx
@@ -1,5 +1,9 @@
-import { expect, test } from "vitest";
-import { findAwarenessByInstanceId } from "./awareness";
+import { afterEach, expect, test, vi } from "vitest";
+import { $awareness, __testing__, startPointerTracking } from "./awareness";
+
+const { $pointerPosition } = __testing__;
+import { findPageAndSelectorByInstanceId } from "./instance-utils";
+import { $selectedPageId } from "./nano-states/pages";
import { createDefaultPages } from "@webstudio-is/project-build";
import { $, renderData } from "@webstudio-is/template";
@@ -15,7 +19,7 @@ test("find awareness by instance", () => {
</$.Box>
</$.Body>
);
- expect(findAwarenessByInstanceId(pages, instances, "textId")).toEqual({
+ expect(findPageAndSelectorByInstanceId(pages, instances, "textId")).toEqual({
pageId: "homePageId",
instanceSelector: ["textId", "boxId", "bodyId"],
});
@@ -40,8 +44,166 @@ test("find awareness by instance inside of slot", () => {
</$.Slot>
</$.Body>
);
- expect(findAwarenessByInstanceId(pages, instances, "boxId")).toEqual({
+ expect(findPageAndSelectorByInstanceId(pages, instances, "boxId")).toEqual({
pageId: "homePageId",
instanceSelector: ["boxId", "fragmentId", "slotTwoId", "bodyId"],
});
});
+
+afterEach(async () => {
+ vi.useRealTimers();
+ $selectedPageId.set(undefined);
+ $pointerPosition.set(undefined);
+ await Promise.resolve();
+});
+
+test("awareness updates are coalesced into one microtask", async () => {
+ const listener = vi.fn();
+ const unsubscribe = $awareness.listen(listener);
+
+ await Promise.resolve();
+ listener.mockClear();
+
+ $pointerPosition.set({ x: 1, y: 2, xRatio: 0.1, yRatio: 0.2 });
+ $pointerPosition.set({ x: 3, y: 4, xRatio: 0.3, yRatio: 0.4 });
+
+ expect(listener).not.toHaveBeenCalled();
+ await Promise.resolve();
+
+ expect(listener).toHaveBeenCalledTimes(1);
+ expect(listener.mock.calls[0]?.[0]).toEqual({
+ pageId: undefined,
+ pointerPosition: { x: 3, y: 4, xRatio: 0.3, yRatio: 0.4 },
+ selectedInstanceIds: undefined,
+ });
+
+ unsubscribe();
+});
+
+test("pointer tracking is throttled to 8fps and keeps latest position", () => {
+ vi.useFakeTimers();
+ $selectedPageId.set("homePageId");
+
+ const stop = startPointerTracking();
+
+ window.dispatchEvent(
+ new MouseEvent("pointermove", { clientX: 10, clientY: 20 })
+ );
+ window.dispatchEvent(
+ new MouseEvent("pointermove", { clientX: 11, clientY: 21 })
+ );
+ window.dispatchEvent(
+ new MouseEvent("pointermove", { clientX: 12, clientY: 22 })
+ );
+
+ expect($pointerPosition.get()).toBeUndefined();
+
+ vi.advanceTimersByTime(125);
+
+ expect($pointerPosition.get()).toMatchObject({ x: 12, y: 22 });
+
+ stop();
+});
+
+test("pointer tracking maps iframe coordinates to parent viewport", () => {
+ vi.useFakeTimers();
+ $selectedPageId.set("homePageId");
+
+ const originalFrameElement = window.frameElement;
+ Object.defineProperty(window, "frameElement", {
+ configurable: true,
+ value: {
+ getBoundingClientRect: () => ({
+ left: 100,
+ top: 200,
+ }),
+ },
+ });
+
+ const stop = startPointerTracking();
+
+ window.dispatchEvent(
+ new MouseEvent("pointermove", { clientX: 10, clientY: 20 })
+ );
+ vi.advanceTimersByTime(125);
+
+ expect($pointerPosition.get()).toMatchObject({ x: 110, y: 220 });
+
+ stop();
+ Object.defineProperty(window, "frameElement", {
+ configurable: true,
+ value: originalFrameElement,
+ });
+});
+
+test("pointer tracking maps iframe coordinates with canvas scale", () => {
+ vi.useFakeTimers();
+ $selectedPageId.set("homePageId");
+
+ const originalFrameElement = window.frameElement;
+ const originalInnerWidth = window.innerWidth;
+ const originalInnerHeight = window.innerHeight;
+
+ Object.defineProperty(window, "innerWidth", {
+ configurable: true,
+ value: 1000,
+ });
+ Object.defineProperty(window, "innerHeight", {
+ configurable: true,
+ value: 800,
+ });
+
+ const originalParent = window.parent;
+ Object.defineProperty(window, "parent", {
+ configurable: true,
+ value: {
+ innerWidth: 1200,
+ innerHeight: 900,
+ },
+ });
+
+ Object.defineProperty(window, "frameElement", {
+ configurable: true,
+ value: {
+ getBoundingClientRect: () => ({
+ left: 100,
+ top: 200,
+ width: 500,
+ height: 400,
+ }),
+ },
+ });
+
+ const stop = startPointerTracking();
+
+ window.dispatchEvent(
+ new MouseEvent("pointermove", { clientX: 400, clientY: 200 })
+ );
+ vi.advanceTimersByTime(125);
+
+ // frame is rendered at 0.5 scale => 100 + 400*0.5, 200 + 200*0.5
+ expect($pointerPosition.get()).toEqual({
+ x: 300,
+ y: 300,
+ xRatio: 0.4,
+ yRatio: 0.25,
+ });
+
+ stop();
+ Object.defineProperty(window, "frameElement", {
+ configurable: true,
+ value: originalFrameElement,
+ });
+ Object.defineProperty(window, "innerWidth", {
+ configurable: true,
+ value: originalInnerWidth,
+ });
+ Object.defineProperty(window, "innerHeight", {
+ configurable: true,
+ value: originalInnerHeight,
+ });
+ Object.defineProperty(window, "parent", {
+ configurable: true,
+ value: originalParent,
+ });
+});
diff --git a/apps/builder/app/shared/awareness.ts b/apps/builder/app/shared/awareness.ts
index 6774b323e9..29054e3d41 100644
--- a/apps/builder/app/shared/awareness.ts
+++ b/apps/builder/app/shared/awareness.ts
@@ -1,258 +1,163 @@
-import { atom, computed, onSet } from "nanostores";
-import {
- findPageByIdOrPath,
- Instance,
- Instances,
- ROOT_INSTANCE_ID,
- type Page,
- rootComponent,
- Pages,
- findParentFolderByChildId,
- getPagePath,
- ROOT_FOLDER_ID,
-} from "@webstudio-is/sdk";
-import { $pages } from "./nano-states/pages";
-import { $instances, $selectedInstanceSelector } from "./nano-states/instances";
-import type { InstanceSelector } from "./tree-utils";
-
-export type Awareness = {
- pageId: Page["id"];
- instanceSelector?: Instance["id"][];
-};
-
-export const $awareness = atom<undefined | Awareness>();
-
-onSet($awareness, ({ newValue }) => {
- $selectedInstanceSelector.set(newValue?.instanceSelector);
-});
-
-export const $selectedPage = computed(
- [$pages, $awareness],
- (pages, awareness) => {
- if (pages === undefined || awareness === undefined) {
- return;
- }
- return findPageByIdOrPath(awareness.pageId, pages);
- }
+import { atom, computed } from "nanostores";
+import type { Rect } from "@webstudio-is/design-system";
+import type { CollaboratorInfo } from "@webstudio-is/sync-client";
+import { $selectedInstanceSelector } from "./nano-states/instances";
+import { $selectedPageId } from "./nano-states/pages";
+
+const POINTER_FPS_LIMIT = 8;
+const POINTER_FRAME_MS = Math.ceil(1000 / POINTER_FPS_LIMIT);
+
+export type Awareness = Pick<
+ CollaboratorInfo,
+ "pageId" | "selectedInstanceIds" | "pointerPosition"
+>;
+
+export const $pointerPosition = atom<CollaboratorInfo["pointerPosition"]>();
+
+const $computedAwareness = computed(
+ [$pointerPosition, $selectedPageId, $selectedInstanceSelector],
+ (pointerPosition, pageId, selectedInstanceIds): Awareness => ({
+ pageId,
+ selectedInstanceIds,
+ pointerPosition,
+ })
);
-export const $selectedPagePath = computed(
- [$selectedPage, $pages],
- (page, pages) => {
- if (pages === undefined || page === undefined) {
- return "/";
- }
- const parentFolder = findParentFolderByChildId(page.id, pages.folders);
- const parentFolderId = parentFolder?.id ?? ROOT_FOLDER_ID;
- const foldersPath = getPagePath(parentFolderId, pages);
- return [foldersPath, page?.path ?? ""]
- .filter(Boolean)
- .join("/")
- .replace(/\/+/g, "/");
- }
-);
+export const $awareness = atom<Awareness>($computedAwareness.get());
-export const $temporaryInstances = atom<Instances>(new Map());
-export const addTemporaryInstance = (instance: Instance) => {
- $temporaryInstances.get().set(instance.id, instance);
- $temporaryInstances.set($temporaryInstances.get());
-};
+let scheduledAwareness: Awareness | undefined;
+let isAwarenessFlushScheduled = false;
-export const $virtualInstances = computed($selectedPage, (selectedPage) => {
- const virtualInstances: Instances = new Map();
- if (selectedPage) {
- virtualInstances.set(ROOT_INSTANCE_ID, {
- type: "instance",
- id: ROOT_INSTANCE_ID,
- component: rootComponent,
- children: [{ type: "id", value: selectedPage.rootInstanceId }],
- });
+$computedAwareness.listen((awareness) => {
+ scheduledAwareness = awareness;
+ if (isAwarenessFlushScheduled) {
+ return;
}
- return virtualInstances;
-});
-
-export const $selectedInstance = computed(
- [$instances, $virtualInstances, $temporaryInstances, $awareness],
- (instances, virtualInstances, tempInstances, awareness) => {
- if (awareness?.instanceSelector === undefined) {
- return;
+ isAwarenessFlushScheduled = true;
+ queueMicrotask(() => {
+ isAwarenessFlushScheduled = false;
+ if (scheduledAwareness !== undefined) {
+ $awareness.set(scheduledAwareness);
}
- const [selectedInstanceId] = awareness.instanceSelector;
- return (
- instances.get(selectedInstanceId) ??
- virtualInstances.get(selectedInstanceId) ??
- tempInstances.get(selectedInstanceId)
- );
- }
-);
-
-export const getInstanceKey = <
- InstanceSelector extends undefined | Instance["id"][],
->(
- instanceSelector: InstanceSelector
-): (InstanceSelector extends undefined ? undefined : never) | string =>
- JSON.stringify(instanceSelector);
+ });
+});
-export const $selectedInstanceKeyWithRoot = computed(
- $awareness,
- (awareness) => {
- const instanceSelector = awareness?.instanceSelector;
- if (instanceSelector) {
- if (instanceSelector[0] === ROOT_INSTANCE_ID) {
- return getInstanceKey(instanceSelector);
- }
- return getInstanceKey([...instanceSelector, ROOT_INSTANCE_ID]);
+export const startPointerTracking = () => {
+ const sourceWindow = window;
+
+ const clampRatio = (value: number) => {
+ return Math.min(1, Math.max(0, value));
+ };
+
+ const getNormalizationRect = (): Rect => {
+ const frameElement = sourceWindow.frameElement;
+ if (frameElement !== null) {
+ const frameRect = frameElement.getBoundingClientRect();
+ return {
+ left: frameRect.left,
+ top: frameRect.top,
+ width: frameRect.width > 0 ? frameRect.width : sourceWindow.innerWidth,
+ height:
+ frameRect.height > 0 ? frameRect.height : sourceWindow.innerHeight,
+ };
}
- }
-);
-
-export const $selectedInstanceKey = computed($awareness, (awareness) =>
- getInstanceKey(awareness?.instanceSelector)
-);
-
-export type InstancePath = Array<{
- instance: Instance;
- instanceSelector: string[];
-}>;
-
-export const getInstancePath = (
- instanceSelector: string[],
- instances: Instances,
- virtualInstances?: Instances,
- temporaryInstances?: Instances
-): undefined | InstancePath => {
- const instancePath: InstancePath = [];
- for (let index = 0; index < instanceSelector.length; index += 1) {
- const instanceId = instanceSelector[index];
- const instance =
- instances.get(instanceId) ??
- virtualInstances?.get(instanceId) ??
- temporaryInstances?.get(instanceId);
- // collection item can be undefined
- if (instance === undefined) {
- continue;
+ return {
+ left: 0,
+ top: 0,
+ width: sourceWindow.innerWidth,
+ height: sourceWindow.innerHeight,
+ };
+ };
+
+ const toViewportPosition = (
+ x: number,
+ y: number
+ ): { x: number; y: number } => {
+ const frameElement = sourceWindow.frameElement;
+ if (frameElement === null) {
+ return { x, y };
}
- instancePath.push({
- instance,
- instanceSelector: instanceSelector.slice(index),
- });
- }
- // all consuming code expect at least one instance to be selected
- // though it is possible to get empty array when undo created page
- if (instancePath.length === 0) {
- return;
- }
- return instancePath;
-};
-export const $selectedInstancePath = computed(
- [$instances, $virtualInstances, $temporaryInstances, $awareness],
- (instances, virtualInstances, temporaryInstances, awareness) => {
- const instanceSelector = awareness?.instanceSelector;
- if (instanceSelector === undefined) {
+ // When running inside the canvas iframe, project pointer coordinates into
+ // the parent viewport so remote cursors align with builder overlays.
+ const frameRect = frameElement.getBoundingClientRect();
+ const frameWidth =
+ typeof frameRect.width === "number" && Number.isFinite(frameRect.width)
+ ? frameRect.width
+ : sourceWindow.innerWidth;
+ const frameHeight =
+ typeof frameRect.height === "number" && Number.isFinite(frameRect.height)
+ ? frameRect.height
+ : sourceWindow.innerHeight;
+ const scaleX =
+ sourceWindow.innerWidth === 0 ? 1 : frameWidth / sourceWindow.innerWidth;
+ const scaleY =
+ sourceWindow.innerHeight === 0
+ ? 1
+ : frameHeight / sourceWindow.innerHeight;
+ return {
+ x: frameRect.left + x * scaleX,
+ y: frameRect.top + y * scaleY,
+ };
+ };
+
+ let latestPointer: CollaboratorInfo["pointerPosition"];
+ let timer: ReturnType<typeof setTimeout> | undefined;
+ let lastFlushAt = 0;
+
+ const flush = () => {
+ timer = undefined;
+ if (latestPointer === undefined) {
return;
}
- return getInstancePath(
- instanceSelector,
- instances,
- virtualInstances,
- temporaryInstances
- );
- }
-);
-export const $selectedInstancePathWithRoot = computed(
- [$instances, $virtualInstances, $temporaryInstances, $awareness],
- (instances, virtualInstances, temporaryInstances, awareness) => {
- let instanceSelector = awareness?.instanceSelector;
- if (instanceSelector === undefined) {
+ const prev = $pointerPosition.get();
+ if (
+ prev?.x === latestPointer.x &&
+ prev?.y === latestPointer.y &&
+ prev?.xRatio === latestPointer.xRatio &&
+ prev?.yRatio === latestPointer.yRatio
+ ) {
return;
}
- // add root as ancestor when root is not selected
- if (instanceSelector[0] !== ROOT_INSTANCE_ID) {
- instanceSelector = [...instanceSelector, ROOT_INSTANCE_ID];
- }
- return getInstancePath(
- instanceSelector,
- instances,
- virtualInstances,
- temporaryInstances
- );
- }
-);
-
-export const selectPage = (pageId: Page["id"]) => {
- const pages = $pages.get();
- if (pages === undefined) {
- return;
- }
- const page = findPageByIdOrPath(pageId, pages);
- if (page === undefined) {
- return;
- }
- $awareness.set({ pageId: page.id, instanceSelector: [page.rootInstanceId] });
-};
-export const selectInstance = (
- instanceSelector: undefined | Instance["id"][]
-) => {
- const awareness = $awareness.get();
- if (
- awareness &&
- // prevent triggering select across the builder when selector is the same
- // useful when click and focus events have to select instance
- awareness.instanceSelector?.join() !== instanceSelector?.join()
- ) {
- $awareness.set({
- pageId: awareness.pageId,
- instanceSelector,
- });
- }
-};
+ lastFlushAt = Date.now();
+ $pointerPosition.set(latestPointer);
+ };
-const findPageId = (pages: Pages, instanceSelector: InstanceSelector) => {
- const rootInstanceId = instanceSelector.at(-1);
- for (const page of [pages.homePage, ...pages.pages]) {
- if (page.rootInstanceId === rootInstanceId) {
- return page.id;
+ const scheduleFlush = () => {
+ if (timer !== undefined) {
+ return;
}
- }
- return pages.homePage.id;
-};
-
-const parentInstanceByIdCache = new WeakMap<
- Instances,
- Map<Instance["id"], Instance["id"]>
->();
-
-/**
- * traverse the tree up until body to build awareness
- * when instance id is inside of slot last matching parent is used to further
- */
-export const findAwarenessByInstanceId = (
- pages: Pages,
- instances: Instances,
- startingInstanceId: Instance["id"]
-): Awareness => {
- // recompute parent instances only when instances are changed
- let parentInstanceById = parentInstanceByIdCache.get(instances);
- if (parentInstanceById === undefined) {
- parentInstanceById = new Map<Instance["id"], Instance["id"]>();
- for (const instance of instances.values()) {
- for (const child of instance.children) {
- if (child.type === "id") {
- parentInstanceById.set(child.value, instance.id);
- }
- }
+ const elapsed = Date.now() - lastFlushAt;
+ const delay = Math.max(0, POINTER_FRAME_MS - elapsed);
+ timer = setTimeout(flush, delay);
+ };
+
+ const onPointerMove = (event: PointerEvent) => {
+ const viewportPosition = toViewportPosition(event.clientX, event.clientY);
+ const normalizationRect = getNormalizationRect();
+ latestPointer = {
+ ...viewportPosition,
+ xRatio: clampRatio(
+ (viewportPosition.x - normalizationRect.left) / normalizationRect.width
+ ),
+ yRatio: clampRatio(
+ (viewportPosition.y - normalizationRect.top) / normalizationRect.height
+ ),
+ };
+ scheduleFlush();
+ };
+
+ window.addEventListener("pointermove", onPointerMove, { passive: true });
+
+ return () => {
+ window.removeEventListener("pointermove", onPointerMove);
+ if (timer !== undefined) {
+ clearTimeout(timer);
+ timer = undefined;
}
- parentInstanceByIdCache.set(instances, parentInstanceById);
- }
- const instanceSelector = [];
- let currentInstanceId: undefined | Instance["id"] = startingInstanceId;
- while (currentInstanceId) {
- instanceSelector.push(currentInstanceId);
- currentInstanceId = parentInstanceById.get(currentInstanceId);
- }
- const pageId = findPageId(pages, instanceSelector);
- return { pageId, instanceSelector };
+ };
};
+
+export const __testing__ = { $pointerPosition };
diff --git a/apps/builder/app/shared/breakpoints/select-breakpoint-by-order.ts b/apps/builder/app/shared/breakpoints/select-breakpoint-by-order.ts
index d4eda0a64e..42b2d021b0 100644
--- a/apps/builder/app/shared/breakpoints/select-breakpoint-by-order.ts
+++ b/apps/builder/app/shared/breakpoints/select-breakpoint-by-order.ts
@@ -1,5 +1,6 @@
import { groupBreakpoints } from "../breakpoints-utils";
-import { $selectedBreakpointId, $breakpoints } from "../nano-states";
+import { $selectedBreakpointId } from "../nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
import { setCanvasWidth } from "~/builder/shared/calc-canvas-width";
/**
diff --git a/apps/builder/app/shared/builder-data.ts b/apps/builder/app/shared/builder-data.ts
index ce20d9af44..47d7673bb9 100644
--- a/apps/builder/app/shared/builder-data.ts
+++ b/apps/builder/app/shared/builder-data.ts
@@ -2,8 +2,8 @@ import { getStyleDeclKey, type WebstudioData } from "@webstudio-is/sdk";
import type { MarketplaceProduct } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
import type { loader } from "~/routes/rest.data.$projectId";
+import { $project } from "~/shared/sync/data-stores";
import {
- $project,
$assets,
$breakpoints,
$dataSources,
@@ -15,7 +15,7 @@ import {
$styleSourceSelections,
$styleSources,
$styles,
-} from "./nano-states";
+} from "~/shared/sync/data-stores";
import { fetch } from "~/shared/fetch.client";
export type BuilderData = WebstudioData & {
diff --git a/apps/builder/app/shared/context.server.test.ts b/apps/builder/app/shared/context.server.test.ts
new file mode 100644
index 0000000000..c304643330
--- /dev/null
+++ b/apps/builder/app/shared/context.server.test.ts
@@ -0,0 +1,104 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+const env = vi.hoisted(() => ({
+ TRPC_SERVER_API_TOKEN: undefined as string | undefined,
+ POSTGREST_URL: "http://localhost:3000",
+ POSTGREST_API_KEY: "",
+ PUBLISHER_HOST: "wstd.work",
+}));
+
+const authenticator = vi.hoisted(() => ({
+ isAuthenticated: vi.fn(),
+}));
+const builderAuthenticator = vi.hoisted(() => ({
+ isAuthenticated: vi.fn(),
+}));
+const isBuilder = vi.hoisted(() => vi.fn(() => false));
+const isCanvas = vi.hoisted(() => vi.fn(() => false));
+
+vi.mock("~/env/env.server", () => ({
+ default: env,
+}));
+
+vi.mock("~/env/env.static.server", () => ({
+ staticEnv: {},
+}));
+
+vi.mock("~/services/auth.server", () => ({
+ authenticator,
+}));
+
+vi.mock("~/services/builder-auth.server", () => ({
+ builderAuthenticator,
+}));
+
+vi.mock("~/services/trpc.server", () => ({
+ trpcSharedClient: {
+ domain: {},
+ deployment: {},
+ },
+}));
+
+vi.mock("~/shared/entri/entri-api.server", () => ({
+ entryApi: {},
+}));
+
+vi.mock("@webstudio-is/plans", () => ({
+ defaultPlanFeatures: {},
+}));
+
+vi.mock("@webstudio-is/plans/index.server", () => ({
+ getAuthorizationOwnerId: vi.fn(),
+ getPlanInfo: vi.fn(),
+}));
+
+vi.mock("@webstudio-is/postgrest/index.server", () => ({
+ createClient: vi.fn(),
+}));
+
+vi.mock("~/services/session.server", () => ({
+ readLoginSessionBloomFilter: vi.fn(),
+}));
+
+vi.mock("./router-utils", () => ({
+ isBuilder,
+ isCanvas,
+}));
+
+vi.mock("@webstudio-is/http-client", () => ({
+ parseBuilderUrl: vi.fn(),
+}));
+
+import { extractAuthFromRequest } from "./context.server";
+
+describe("extractAuthFromRequest", () => {
+ beforeEach(() => {
+ env.TRPC_SERVER_API_TOKEN = undefined;
+ authenticator.isAuthenticated.mockResolvedValue(undefined);
+ builderAuthenticator.isAuthenticated.mockResolvedValue(undefined);
+ isBuilder.mockReturnValue(false);
+ isCanvas.mockReturnValue(false);
+ });
+
+ test("does not treat an empty service token as service authorization", async () => {
+ env.TRPC_SERVER_API_TOKEN = "";
+ const request = new Request("https://webstudio.is/trpc", {
+ headers: { Authorization: "" },
+ });
+
+ const auth = await extractAuthFromRequest(request);
+
+ expect(auth.isServiceCall).toBe(false);
+ });
+
+ test("accepts a matching non-empty service token", async () => {
+ env.TRPC_SERVER_API_TOKEN = "service-token";
+ const request = new Request("https://webstudio.is/trpc", {
+ headers: { Authorization: "service-token" },
+ });
+
+ const auth = await extractAuthFromRequest(request);
+
+ expect(auth.isServiceCall).toBe(true);
+ });
+});
diff --git a/apps/builder/app/shared/context.server.ts b/apps/builder/app/shared/context.server.ts
index b44dc3b3b7..84b9c778d3 100644
--- a/apps/builder/app/shared/context.server.ts
+++ b/apps/builder/app/shared/context.server.ts
@@ -32,17 +32,26 @@ export const extractAuthFromRequest = async (request: Request) => {
? await builderAuthenticator.isAuthenticated(request)
: await authenticator.isAuthenticated(request);
- const isServiceCall =
- request.headers.has("Authorization") &&
- request.headers.get("Authorization") === env.TRPC_SERVER_API_TOKEN;
+ const isServiceCall = isServiceAuthorization(
+ request.headers.get("Authorization")
+ );
return {
authToken,
- sessionData,
isServiceCall,
+ sessionData,
};
};
+export const isServiceAuthorization = (authorizationHeader: string | null) => {
+ return (
+ authorizationHeader != null &&
+ env.TRPC_SERVER_API_TOKEN !== undefined &&
+ env.TRPC_SERVER_API_TOKEN.length > 0 &&
+ authorizationHeader === env.TRPC_SERVER_API_TOKEN
+ );
+};
+
const createTokenAuthorizationContext = async (
authToken: string,
postgrest: AppContext["postgrest"]
diff --git a/apps/builder/app/shared/copy-paste.test.tsx b/apps/builder/app/shared/copy-paste.test.tsx
index d12e028744..841e9e5f34 100644
--- a/apps/builder/app/shared/copy-paste.test.tsx
+++ b/apps/builder/app/shared/copy-paste.test.tsx
@@ -26,7 +26,7 @@ import {
extractWebstudioFragment,
insertWebstudioFragmentCopy,
} from "./instance-utils";
-import { $project } from "./nano-states";
+import { $project } from "~/shared/sync/data-stores";
import { findAvailableVariables } from "./data-variables";
import { camelCaseProperty } from "@webstudio-is/css-data";
diff --git a/apps/builder/app/shared/copy-paste/plugin-html.test.tsx b/apps/builder/app/shared/copy-paste/plugin-html.test.tsx
index 88c38206cc..c7d14eaa01 100644
--- a/apps/builder/app/shared/copy-paste/plugin-html.test.tsx
+++ b/apps/builder/app/shared/copy-paste/plugin-html.test.tsx
@@ -4,8 +4,9 @@ import { renderData, ws } from "@webstudio-is/template";
import { createDefaultPages } from "@webstudio-is/project-build";
import type { Project } from "@webstudio-is/project";
import { registerContainers } from "../sync/sync-stores";
-import { $instances, $pages, $project } from "../nano-states";
-import { $awareness } from "../awareness";
+import { $instances } from "~/shared/sync/data-stores";
+import { $pages, $project } from "~/shared/sync/data-stores";
+import { $selectedPageId, $selectedInstanceSelector } from "../nano-states";
import { html } from "./plugin-html";
setEnv("*");
@@ -22,7 +23,8 @@ test("paste html fragment", async () => {
$pages.set(
createDefaultPages({ rootInstanceId: "bodyId", homePageId: "pageId" })
);
- $awareness.set({ pageId: "pageId", instanceSelector: ["divId", "bodyId"] });
+ $selectedPageId.set("pageId");
+ $selectedInstanceSelector.set(["divId", "bodyId"]);
expect(
await html.onPaste?.(`
<section>
@@ -59,7 +61,8 @@ test("ignore html without any tags", async () => {
$pages.set(
createDefaultPages({ rootInstanceId: "bodyId", homePageId: "pageId" })
);
- $awareness.set({ pageId: "pageId", instanceSelector: ["divId", "bodyId"] });
+ $selectedPageId.set("pageId");
+ $selectedInstanceSelector.set(["divId", "bodyId"]);
expect(await html.onPaste?.(`It works`)).toEqual(false);
expect($instances.get()).toEqual(data.instances);
});
@@ -75,7 +78,8 @@ test("skip whitespace-only text nodes between element siblings", async () => {
$pages.set(
createDefaultPages({ rootInstanceId: "bodyId", homePageId: "pageId" })
);
- $awareness.set({ pageId: "pageId", instanceSelector: ["divId", "bodyId"] });
+ $selectedPageId.set("pageId");
+ $selectedInstanceSelector.set(["divId", "bodyId"]);
// Regression test: whitespace between elements should not create separate text nodes
// but the space should be preserved as part of one of the adjacent span instances
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
index 76e66af3a2..2364807228 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.test.ts
@@ -17,17 +17,18 @@ import {
import type { Project } from "@webstudio-is/project";
import * as baseComponentMetas from "@webstudio-is/sdk-components-react/metas";
import { registerContainers } from "../sync/sync-stores";
+import { $registeredComponentMetas } from "../nano-states";
+import { $instances } from "~/shared/sync/data-stores";
import {
- $instances,
$dataSources,
$pages,
$project,
$props,
- $registeredComponentMetas,
-} from "../nano-states";
+} from "~/shared/sync/data-stores";
import { instanceText } from "./plugin-instance";
import { createDefaultPages } from "@webstudio-is/project-build";
-import { $awareness, selectInstance } from "../awareness";
+import { selectInstance } from "~/shared/nano-states";
+import { $selectedPageId } from "../nano-states/pages";
import * as instanceUtils from "../instance-utils";
const expectString = expect.any(String) as unknown as string;
@@ -50,7 +51,7 @@ $pages.set(
rootInstanceId: "body0",
})
);
-$awareness.set({ pageId: "home-page" });
+$selectedPageId.set("home-page");
const createInstance = (
id: Instance["id"],
diff --git a/apps/builder/app/shared/copy-paste/plugin-instance.ts b/apps/builder/app/shared/copy-paste/plugin-instance.ts
index f440dbd23e..2a0befd584 100644
--- a/apps/builder/app/shared/copy-paste/plugin-instance.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-instance.ts
@@ -9,11 +9,7 @@ import {
isComponentDetachable,
portalComponent,
} from "@webstudio-is/sdk";
-import {
- $selectedInstanceSelector,
- $instances,
- $project,
-} from "../nano-states";
+import { $instances, $project } from "~/shared/sync/data-stores";
import type { InstanceSelector } from "../tree-utils";
import {
deleteInstanceMutable,
@@ -26,7 +22,10 @@ import {
detectFragmentTokenConflicts,
type Insertable,
} from "../instance-utils";
-import { $selectedInstancePath } from "../awareness";
+import {
+ $selectedInstancePath,
+ $selectedInstanceSelector,
+} from "~/shared/nano-states";
import { findAvailableVariables } from "../data-variables";
import { builderApi } from "../builder-api";
import type { Plugin } from "./init-copy-paste";
diff --git a/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.test.tsx b/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.test.tsx
index 5d9340b685..67a0ed251e 100644
--- a/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.test.tsx
+++ b/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.test.tsx
@@ -13,13 +13,9 @@ import {
import { $, renderData } from "@webstudio-is/template";
import * as defaultMetas from "@webstudio-is/sdk-components-react/metas";
import { __testing__ } from "./plugin-webflow";
-import {
- $breakpoints,
- $project,
- $registeredComponentMetas,
- $styleSources,
- $styles,
-} from "../../nano-states";
+import { $registeredComponentMetas } from "../../nano-states";
+import { $breakpoints } from "~/shared/sync/data-stores";
+import { $project, $styleSources, $styles } from "~/shared/sync/data-stores";
import invariant from "tiny-invariant";
import { WfData } from "./schema";
diff --git a/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.ts b/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.ts
index bd4f5873b8..f6fda77577 100644
--- a/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.ts
+++ b/apps/builder/app/shared/copy-paste/plugin-webflow/plugin-webflow.ts
@@ -5,7 +5,7 @@ import {
insertWebstudioFragmentCopy,
updateWebstudioData,
} from "../../instance-utils";
-import { $project } from "../../nano-states";
+import { $project } from "~/shared/sync/data-stores";
import {
WfData,
wfNodeTypes,
diff --git a/apps/builder/app/shared/instance-utils.test.tsx b/apps/builder/app/shared/instance-utils.test.tsx
index 7c7651d70f..a2c7356123 100644
--- a/apps/builder/app/shared/instance-utils.test.tsx
+++ b/apps/builder/app/shared/instance-utils.test.tsx
@@ -53,9 +53,10 @@ import {
deleteSelectedInstance,
detectPageTokenConflicts,
} from "./instance-utils";
-import type { InstancePath } from "./awareness";
+import type { InstancePath } from "./nano-states";
+import { $registeredComponentMetas } from "./nano-states";
+import { $assets } from "~/shared/sync/data-stores";
import {
- $assets,
$breakpoints,
$dataSources,
$instances,
@@ -65,16 +66,13 @@ import {
$styleSourceSelections,
$styleSources,
$styles,
- $registeredComponentMetas,
$resources,
-} from "./nano-states";
+} from "~/shared/sync/data-stores";
import { registerContainers } from "./sync/sync-stores";
-import {
- $awareness,
- getInstancePath,
- selectInstance,
- selectPage,
-} from "./awareness";
+import { $selectedInstanceSelector, getInstancePath } from "./nano-states";
+import { selectPage } from "./nano-states";
+import { selectInstance } from "./nano-states";
+import { $selectedPageId } from "./nano-states/pages";
enableMapSet();
registerContainers();
@@ -2601,10 +2599,12 @@ describe("find closest insertable", () => {
rootInstanceId: "",
})
);
- $awareness.set({
- pageId: "homePageId",
- instanceSelector: ["collectionId[1]", "collectionId", "bodyId"],
- });
+ $selectedPageId.set("homePageId");
+ $selectedInstanceSelector.set([
+ "collectionId[1]",
+ "collectionId",
+ "bodyId",
+ ]);
$registeredComponentMetas.set(defaultMetasMap);
});
@@ -3112,7 +3112,7 @@ describe("canUnwrapInstance", () => {
$props.set(props);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
const instancePath = [
{
@@ -3144,7 +3144,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
const instancePath = [
{
@@ -3174,7 +3174,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
const instancePath = [
{
@@ -3206,7 +3206,7 @@ describe("canUnwrapInstance", () => {
$registeredComponentMetas.set(defaultMetasMap);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
const instancePath = [
{
@@ -3509,7 +3509,7 @@ describe("convertInstance", () => {
test("prevents converting body instance", () => {
const pages = createDefaultPages({ rootInstanceId: "bodyId" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
const initialInstances = renderData(
<ws.element ws:tag="html" ws:id="rootId">
@@ -3540,10 +3540,10 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["child2", "parent", "body"]);
deleteSelectedInstance();
- expect($awareness.get()?.instanceSelector).toEqual([
+ expect($selectedInstanceSelector.get()).toEqual([
"child3",
"parent",
"body",
@@ -3563,10 +3563,10 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["child3", "parent", "body"]);
deleteSelectedInstance();
- expect($awareness.get()?.instanceSelector).toEqual([
+ expect($selectedInstanceSelector.get()).toEqual([
"child2",
"parent",
"body",
@@ -3584,10 +3584,10 @@ describe("deleteSelectedInstance", () => {
$instances.set(instances);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["child1", "parent", "body"]);
deleteSelectedInstance();
- expect($awareness.get()?.instanceSelector).toEqual(["parent", "body"]);
+ expect($selectedInstanceSelector.get()).toEqual(["parent", "body"]);
});
});
@@ -3632,7 +3632,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["body"]);
// Insert without explicit conflictResolution (defaults to "theirs")
@@ -3707,7 +3707,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["body"]);
// Insert with conflictResolution="ours" to keep existing styles
@@ -3782,7 +3782,7 @@ describe("insertWebstudioFragmentAt with conflictResolution", () => {
setDataStores(data);
const pages = createDefaultPages({ rootInstanceId: "body" });
$pages.set(pages);
- $awareness.set({ pageId: pages.homePage.id });
+ $selectedPageId.set(pages.homePage.id);
selectInstance(["body"]);
// Insert with conflictResolution="merge"
diff --git a/apps/builder/app/shared/instance-utils.ts b/apps/builder/app/shared/instance-utils.ts
index 7d028d6ccf..4319176cbb 100644
--- a/apps/builder/app/shared/instance-utils.ts
+++ b/apps/builder/app/shared/instance-utils.ts
@@ -37,24 +37,26 @@ import { detectTokenConflicts } from "./style-source-utils";
import { type ConflictResolution } from "./token-conflict-dialog";
import { buildMergedBreakpointIds } from "./breakpoints-utils";
import {
- $props,
+ $registeredComponentMetas,
+ $registeredTemplates,
+ $isPreviewMode,
+ $textEditingInstanceSelector,
+ $isContentMode,
+ findBlockSelector,
+} from "./nano-states";
+import { $props } from "~/shared/sync/data-stores";
+import {
$styles,
$styleSourceSelections,
$styleSources,
$instances,
- $registeredComponentMetas,
$dataSources,
$assets,
$breakpoints,
$pages,
$resources,
- $registeredTemplates,
$project,
- $isPreviewMode,
- $textEditingInstanceSelector,
- $isContentMode,
- findBlockSelector,
-} from "./nano-states";
+} from "~/shared/sync/data-stores";
import {
type DroppableTarget,
type InstanceSelector,
@@ -75,14 +77,13 @@ import { serverSyncStore } from "./sync/sync-stores";
import { setDifference, setUnion } from "./shim";
import { breakCyclesMutable, findCycles } from "@webstudio-is/project-build";
import {
- $awareness,
$selectedInstancePath,
+ $selectedInstanceSelector,
$selectedPage,
- findAwarenessByInstanceId,
getInstancePath,
- selectInstance,
type InstancePath,
-} from "./awareness";
+} from "./nano-states";
+import { selectInstance } from "./nano-states";
import { findClosestInstanceMatchingFragment } from "./matcher";
import {
findAvailableVariables,
@@ -1703,13 +1704,12 @@ export const findClosestInsertable = (
from?: Insertable
): undefined | Insertable => {
const selectedPage = $selectedPage.get();
- const awareness = $awareness.get();
if (selectedPage === undefined) {
return;
}
// paste to the page root if nothing is selected
const instanceSelector = from?.parentSelector ??
- awareness?.instanceSelector ?? [selectedPage.rootInstanceId];
+ $selectedInstanceSelector.get() ?? [selectedPage.rootInstanceId];
if (instanceSelector[0] === ROOT_INSTANCE_ID) {
toast.error(`Cannot insert into Global root`);
return;
@@ -1782,7 +1782,11 @@ export const buildInstancePath = (
pages: Pages,
instances: Instances
): string[] => {
- const awareness = findAwarenessByInstanceId(pages, instances, instanceId);
+ const awareness = findPageAndSelectorByInstanceId(
+ pages,
+ instances,
+ instanceId
+ );
if (!awareness.instanceSelector) {
return [];
}
@@ -1811,6 +1815,48 @@ export const buildInstancePath = (
* @param fragment - The fragment to check for conflicts
* @returns Array of token conflicts (empty if no conflicts)
*/
+const parentInstanceByIdCache = new WeakMap<
+ Instances,
+ Map<Instance["id"], Instance["id"]>
+>();
+
+/**
+ * Traverse the instance tree up to the root to find the page and full instance
+ * selector for a given instance id. When an instance appears via a slot,
+ * the last matching parent is used.
+ */
+export const findPageAndSelectorByInstanceId = (
+ pages: Pages,
+ instances: Instances,
+ startingInstanceId: Instance["id"]
+): { pageId: string; instanceSelector: string[] } => {
+ let parentInstanceById = parentInstanceByIdCache.get(instances);
+ if (parentInstanceById === undefined) {
+ parentInstanceById = new Map<Instance["id"], Instance["id"]>();
+ for (const instance of instances.values()) {
+ for (const child of instance.children) {
+ if (child.type === "id") {
+ parentInstanceById.set(child.value, instance.id);
+ }
+ }
+ }
+ parentInstanceByIdCache.set(instances, parentInstanceById);
+ }
+ const instanceSelector: string[] = [];
+ let currentInstanceId: undefined | Instance["id"] = startingInstanceId;
+ while (currentInstanceId) {
+ instanceSelector.push(currentInstanceId);
+ currentInstanceId = parentInstanceById.get(currentInstanceId);
+ }
+ const rootInstanceId = instanceSelector.at(-1);
+ for (const page of [pages.homePage, ...pages.pages]) {
+ if (page.rootInstanceId === rootInstanceId) {
+ return { pageId: page.id, instanceSelector };
+ }
+ }
+ return { pageId: pages.homePage.id, instanceSelector };
+};
+
export const detectFragmentTokenConflicts = ({
fragment,
}: {
diff --git a/apps/builder/app/shared/nano-states/breakpoints.ts b/apps/builder/app/shared/nano-states/breakpoints.ts
index 043dddc181..936ace03ff 100644
--- a/apps/builder/app/shared/nano-states/breakpoints.ts
+++ b/apps/builder/app/shared/nano-states/breakpoints.ts
@@ -3,10 +3,6 @@ import type { Breakpoint } from "@webstudio-is/sdk";
import { $breakpoints } from "../sync/data-stores";
import { isBaseBreakpoint } from "../breakpoints-utils";
-// Re-export for backward compatibility
-export { $breakpoints };
-export { isBaseBreakpoint };
-
export const $selectedBreakpointId = atom<undefined | Breakpoint["id"]>(
undefined
);
diff --git a/apps/builder/app/shared/nano-states/canvas.ts b/apps/builder/app/shared/nano-states/canvas.ts
index e3d962286a..6a8f5e579f 100644
--- a/apps/builder/app/shared/nano-states/canvas.ts
+++ b/apps/builder/app/shared/nano-states/canvas.ts
@@ -2,7 +2,7 @@ import { atom, computed } from "nanostores";
import type { Instance, Instances } from "@webstudio-is/sdk";
import { blockComponent, blockTemplateComponent } from "@webstudio-is/sdk";
import type { FontWeight } from "@webstudio-is/fonts";
-import { $instances } from "./instances";
+import { $instances } from "../sync/data-stores";
import type { InstanceSelector } from "../tree-utils";
export type TextToolbarState = {
diff --git a/apps/builder/app/shared/nano-states/components.ts b/apps/builder/app/shared/nano-states/components.ts
index 63e0d2e3b1..9d5895674e 100644
--- a/apps/builder/app/shared/nano-states/components.ts
+++ b/apps/builder/app/shared/nano-states/components.ts
@@ -1,7 +1,7 @@
import { nanoid } from "nanoid";
import { shallowEqual } from "shallow-equal";
import type { ExoticComponent } from "react";
-import { atom, computed } from "nanostores";
+import { atom } from "nanostores";
import type {
AnyComponent,
Hook,
@@ -14,9 +14,10 @@ import {
type WsComponentMeta,
} from "@webstudio-is/sdk";
import type { InstanceSelector } from "../tree-utils";
-import { $memoryProps, $props } from "./misc";
-import { $instances } from "./instances";
-import { $awareness, $selectedPage, getInstanceKey } from "../awareness";
+import { $props, $instances } from "../sync/data-stores";
+import { $memoryProps } from "./misc";
+import { $selectedPage } from "./pages";
+import { $selectedInstanceSelector, getInstanceKey } from "./instances";
import {
renderTemplate,
type GeneratedTemplateMeta,
@@ -101,16 +102,11 @@ const createHookContext = (): HookContext => {
};
};
-const $instanceSelector = computed(
- $awareness,
- (awareness) => awareness?.instanceSelector
-);
-
// subscribe builder events and invoke all component hooks
export const subscribeComponentHooks = () => {
let lastInstanceSelector: undefined | InstanceSelector = undefined;
- const unsubscribeSelectedInstanceSelector = $instanceSelector.subscribe(
- (instanceSelector) => {
+ const unsubscribeSelectedInstanceSelector =
+ $selectedInstanceSelector.subscribe((instanceSelector) => {
// prevent executing hooks when selected instance is not changed
if (shallowEqual(lastInstanceSelector, instanceSelector)) {
return;
@@ -157,8 +153,7 @@ export const subscribeComponentHooks = () => {
// store converts values to readonly
lastInstanceSelector = instanceSelector as InstanceSelector;
- }
- );
+ });
return () => {
unsubscribeSelectedInstanceSelector();
diff --git a/apps/builder/app/shared/nano-states/index.ts b/apps/builder/app/shared/nano-states/index.ts
index 25870c5737..7ae895eb2b 100644
--- a/apps/builder/app/shared/nano-states/index.ts
+++ b/apps/builder/app/shared/nano-states/index.ts
@@ -1,20 +1,3 @@
-// Re-export data stores that were moved to sync/data-stores
-export {
- $project,
- $publisherHost,
- $dataSources,
- $resources,
- $props,
- $styles,
- $styleSources,
- $styleSourceSelections,
- $assets,
- $marketplaceProduct,
- $pages,
- $instances,
- $breakpoints,
-} from "../sync/data-stores";
-
export * from "./misc";
export * from "./breakpoints";
export * from "./instances";
diff --git a/apps/builder/app/shared/nano-states/instance-selection.ts b/apps/builder/app/shared/nano-states/instance-selection.ts
new file mode 100644
index 0000000000..5fc2e3ebe5
--- /dev/null
+++ b/apps/builder/app/shared/nano-states/instance-selection.ts
@@ -0,0 +1,16 @@
+import { atom } from "nanostores";
+import type { InstanceSelector } from "../tree-utils";
+
+export const $selectedInstanceSelector = atom<undefined | InstanceSelector>(
+ undefined
+);
+
+export const selectInstance = (
+ instanceSelector: undefined | InstanceSelector
+) => {
+ // prevent triggering select across the builder when selector is the same
+ // useful when click and focus events have to select instance
+ if ($selectedInstanceSelector.get()?.join() !== instanceSelector?.join()) {
+ $selectedInstanceSelector.set(instanceSelector);
+ }
+};
diff --git a/apps/builder/app/shared/nano-states/instances.ts b/apps/builder/app/shared/nano-states/instances.ts
index d47f6ae4e5..91beba6e6f 100644
--- a/apps/builder/app/shared/nano-states/instances.ts
+++ b/apps/builder/app/shared/nano-states/instances.ts
@@ -1,16 +1,21 @@
-import { atom } from "nanostores";
-import type { InstanceSelector } from "../tree-utils";
+import { atom, computed } from "nanostores";
+import {
+ type Instance,
+ type Instances,
+ ROOT_INSTANCE_ID,
+ rootComponent,
+} from "@webstudio-is/sdk";
import { $instances } from "../sync/data-stores";
-
-// Re-export for backward compatibility
-export { $instances };
+import type { InstanceSelector } from "../tree-utils";
+import { $selectedPage } from "./pages";
+import { $selectedInstanceSelector } from "./instance-selection";
+export {
+ $selectedInstanceSelector,
+ selectInstance,
+} from "./instance-selection";
export const $isResizingCanvas = atom(false);
-export const $selectedInstanceSelector = atom<undefined | InstanceSelector>(
- undefined
-);
-
export const $editingItemSelector = atom<undefined | InstanceSelector>(
undefined
);
@@ -63,3 +68,140 @@ export const execTextEditorContextMenuCommand = (
) => {
$textEditorContextMenuCommand.set(command);
};
+export const $temporaryInstances = atom<Instances>(new Map());
+export const addTemporaryInstance = (instance: Instance) => {
+ $temporaryInstances.get().set(instance.id, instance);
+ $temporaryInstances.set($temporaryInstances.get());
+};
+
+export const $virtualInstances = computed($selectedPage, (selectedPage) => {
+ const virtualInstances: Instances = new Map();
+ if (selectedPage) {
+ virtualInstances.set(ROOT_INSTANCE_ID, {
+ type: "instance",
+ id: ROOT_INSTANCE_ID,
+ component: rootComponent,
+ children: [{ type: "id", value: selectedPage.rootInstanceId }],
+ });
+ }
+ return virtualInstances;
+});
+
+export const $selectedInstance = computed(
+ [
+ $instances,
+ $virtualInstances,
+ $temporaryInstances,
+ $selectedInstanceSelector,
+ ],
+ (instances, virtualInstances, tempInstances, instanceSelector) => {
+ if (instanceSelector === undefined) {
+ return;
+ }
+ const [selectedInstanceId] = instanceSelector;
+ return (
+ instances.get(selectedInstanceId) ??
+ virtualInstances.get(selectedInstanceId) ??
+ tempInstances.get(selectedInstanceId)
+ );
+ }
+);
+
+export const getInstanceKey = <
+ InstanceSelector extends undefined | Instance["id"][],
+>(
+ instanceSelector: InstanceSelector
+): (InstanceSelector extends undefined ? undefined : never) | string =>
+ JSON.stringify(instanceSelector);
+
+export const $selectedInstanceKeyWithRoot = computed(
+ $selectedInstanceSelector,
+ (instanceSelector) => {
+ if (instanceSelector) {
+ if (instanceSelector[0] === ROOT_INSTANCE_ID) {
+ return getInstanceKey(instanceSelector);
+ }
+ return getInstanceKey([...instanceSelector, ROOT_INSTANCE_ID]);
+ }
+ }
+);
+
+export const $selectedInstanceKey = computed(
+ $selectedInstanceSelector,
+ (instanceSelector) => getInstanceKey(instanceSelector)
+);
+
+export type InstancePath = Array<{
+ instance: Instance;
+ instanceSelector: string[];
+}>;
+
+export const getInstancePath = (
+ instanceSelector: string[],
+ instances: Instances,
+ virtualInstances?: Instances,
+ temporaryInstances?: Instances
+): undefined | InstancePath => {
+ const instancePath: InstancePath = [];
+ for (let index = 0; index < instanceSelector.length; index += 1) {
+ const instanceId = instanceSelector[index];
+ const instance =
+ instances.get(instanceId) ??
+ virtualInstances?.get(instanceId) ??
+ temporaryInstances?.get(instanceId);
+ if (instance === undefined) {
+ continue;
+ }
+ instancePath.push({
+ instance,
+ instanceSelector: instanceSelector.slice(index),
+ });
+ }
+ if (instancePath.length === 0) {
+ return;
+ }
+ return instancePath;
+};
+
+export const $selectedInstancePath = computed(
+ [
+ $instances,
+ $virtualInstances,
+ $temporaryInstances,
+ $selectedInstanceSelector,
+ ],
+ (instances, virtualInstances, temporaryInstances, instanceSelector) => {
+ if (instanceSelector === undefined) {
+ return;
+ }
+ return getInstancePath(
+ instanceSelector,
+ instances,
+ virtualInstances,
+ temporaryInstances
+ );
+ }
+);
+
+export const $selectedInstancePathWithRoot = computed(
+ [
+ $instances,
+ $virtualInstances,
+ $temporaryInstances,
+ $selectedInstanceSelector,
+ ],
+ (instances, virtualInstances, temporaryInstances, instanceSelector) => {
+ if (instanceSelector === undefined) {
+ return;
+ }
+ if (instanceSelector[0] !== ROOT_INSTANCE_ID) {
+ instanceSelector = [...instanceSelector, ROOT_INSTANCE_ID];
+ }
+ return getInstancePath(
+ instanceSelector,
+ instances,
+ virtualInstances,
+ temporaryInstances
+ );
+ }
+);
diff --git a/apps/builder/app/shared/nano-states/misc.ts b/apps/builder/app/shared/nano-states/misc.ts
index a28b566a2f..30d52bb1a0 100644
--- a/apps/builder/app/shared/nano-states/misc.ts
+++ b/apps/builder/app/shared/nano-states/misc.ts
@@ -27,35 +27,17 @@ import type { AssetType } from "@webstudio-is/asset-uploader";
import type { DragStartPayload } from "~/canvas/shared/use-drag-drop";
import { type InstanceSelector } from "../tree-utils";
import type { ChildrenOrientation } from "@webstudio-is/design-system";
-import { $awareness, $selectedInstance } from "../awareness";
+import { $selectedInstance, $selectedInstanceSelector } from "./instances";
import { getPermissions } from "../permissions";
import {
$project,
$publisherHost,
- $dataSources,
- $resources,
$props,
$styles,
$styleSources,
$styleSourceSelections,
- $assets,
- $marketplaceProduct,
} from "../sync/data-stores";
-// Re-export data stores for backward compatibility
-export {
- $project,
- $publisherHost,
- $dataSources,
- $resources,
- $props,
- $styles,
- $styleSources,
- $styleSourceSelections,
- $assets,
- $marketplaceProduct,
-};
-
export const $publishedOrigin = computed(
[$project, $publisherHost],
(project, publisherHost) => `https://${project?.domain}.${publisherHost}`
@@ -89,7 +71,7 @@ export const $selectedStyleSources = atom(
);
export const $selectedStyleState = atom<StyleDecl["state"]>();
// reset style state whenever selected instance change
-onSet($awareness, () => {
+onSet($selectedInstanceSelector, () => {
$selectedStyleState.set(undefined);
});
diff --git a/apps/builder/app/shared/nano-states/pages.ts b/apps/builder/app/shared/nano-states/pages.ts
index 11c50a7f3e..6f6c23c83c 100644
--- a/apps/builder/app/shared/nano-states/pages.ts
+++ b/apps/builder/app/shared/nano-states/pages.ts
@@ -1,10 +1,55 @@
-import { atom } from "nanostores";
-import type { Page } from "@webstudio-is/sdk";
+import { atom, computed } from "nanostores";
+import {
+ type Page,
+ findPageByIdOrPath,
+ findParentFolderByChildId,
+ getPagePath,
+ ROOT_FOLDER_ID,
+} from "@webstudio-is/sdk";
import { $pages } from "../sync/data-stores";
+import { $selectedInstanceSelector } from "./instance-selection";
-// Re-export for backward compatibility
-export { $pages };
+export const $selectedPageId = atom<undefined | Page["id"]>(undefined);
export const $selectedPageHash = atom<{ hash: string }>({ hash: "" });
export const $editingPageId = atom<undefined | Page["id"]>();
+
+export const $selectedPage = computed(
+ [$pages, $selectedPageId],
+ (pages, selectedPageId) => {
+ if (pages === undefined || selectedPageId === undefined) {
+ return;
+ }
+ return findPageByIdOrPath(selectedPageId, pages);
+ }
+);
+
+export const $selectedPagePath = computed(
+ [$selectedPage, $pages],
+ (page, pages) => {
+ if (pages === undefined || page === undefined) {
+ return "/";
+ }
+ const parentFolder = findParentFolderByChildId(page.id, pages.folders);
+ const parentFolderId = parentFolder?.id ?? ROOT_FOLDER_ID;
+ const foldersPath = getPagePath(parentFolderId, pages);
+ return [foldersPath, page?.path ?? ""]
+ .filter(Boolean)
+ .join("/")
+ .replace(/\/+/g, "/");
+ }
+);
+
+export const selectPage = (pageId: Page["id"]) => {
+ const pages = $pages.get();
+ if (pages === undefined) {
+ return;
+ }
+ const page = findPageByIdOrPath(pageId, pages);
+ if (page === undefined) {
+ return;
+ }
+ $selectedPageId.set(page.id);
+ $selectedInstanceSelector.set([page.rootInstanceId]);
+};
diff --git a/apps/builder/app/shared/nano-states/props.test.tsx b/apps/builder/app/shared/nano-states/props.test.tsx
index f81079ceec..f8d68ab977 100644
--- a/apps/builder/app/shared/nano-states/props.test.tsx
+++ b/apps/builder/app/shared/nano-states/props.test.tsx
@@ -11,15 +11,21 @@ import {
collectionComponent,
} from "@webstudio-is/sdk";
import { textContentAttribute } from "@webstudio-is/react-sdk";
-import { $instances } from "./instances";
+import {
+ $instances,
+ $pages,
+ $assets,
+ $dataSources,
+ $props,
+ $resources,
+} from "../sync/data-stores";
import {
$propValuesByInstanceSelector,
$variableValuesByInstanceSelector,
} from "./props";
-import { $pages } from "./pages";
-import { $assets, $dataSources, $props, $resources } from "./misc";
import { $dataSourceVariables } from "./variables";
-import { $awareness, getInstanceKey } from "../awareness";
+import { $selectedPageId } from "./pages";
+import { getInstanceKey } from "../nano-states";
import {
$,
expression,
@@ -65,7 +71,7 @@ const selectPageRoot = (
systemDataSourceId,
});
$pages.set(defaultPages);
- $awareness.set({ pageId: defaultPages.homePage.id });
+ $selectedPageId.set(defaultPages.homePage.id);
};
beforeEach(() => {
diff --git a/apps/builder/app/shared/nano-states/props.ts b/apps/builder/app/shared/nano-states/props.ts
index a70aa9e01f..d4326fe2d3 100644
--- a/apps/builder/app/shared/nano-states/props.ts
+++ b/apps/builder/app/shared/nano-states/props.ts
@@ -22,21 +22,15 @@ import {
getCollectionEntries,
} from "@webstudio-is/react-sdk";
import { mapGroupBy } from "~/shared/shim";
-import { $instances } from "./instances";
-import {
- $dataSources,
- $props,
- $assets,
- $resources,
- $uploadingFilesDataStore,
- $memoryProps,
- $isPreviewMode,
-} from "./misc";
-import { $pages } from "./pages";
+import { $instances } from "../sync/data-stores";
+import { $dataSources, $props, $assets, $resources } from "../sync/data-stores";
+import { $uploadingFilesDataStore, $memoryProps, $isPreviewMode } from "./misc";
+import { $pages } from "../sync/data-stores";
import type { InstanceSelector } from "../tree-utils";
import { $dataSourceVariables } from "./variables";
import { uploadingFileDataToAsset } from "~/builder/shared/assets/asset-utils";
-import { $selectedPage, getInstanceKey } from "../awareness";
+import { $selectedPage } from "./pages";
+import { getInstanceKey } from "./instances";
import { computeExpression } from "../data-variables";
import { $currentSystem } from "../system";
import {
diff --git a/apps/builder/app/shared/page-utils.test.tsx b/apps/builder/app/shared/page-utils.test.tsx
index db79ff59fe..c2c4c900d7 100644
--- a/apps/builder/app/shared/page-utils.test.tsx
+++ b/apps/builder/app/shared/page-utils.test.tsx
@@ -11,7 +11,7 @@ import {
createDefaultPages,
createRootFolder,
} from "@webstudio-is/project-build";
-import { $project } from "./nano-states";
+import { $project } from "./sync/data-stores";
import { insertPageCopyMutable } from "./page-utils";
import {
$,
diff --git a/apps/builder/app/shared/page-utils.ts b/apps/builder/app/shared/page-utils.ts
index 9fc82b96d3..dd8c24904e 100644
--- a/apps/builder/app/shared/page-utils.ts
+++ b/apps/builder/app/shared/page-utils.ts
@@ -22,7 +22,7 @@ import {
restoreExpressionVariables,
unsetExpressionVariables,
} from "./data-variables";
-import { $project } from "./nano-states";
+import { $project } from "./sync/data-stores";
import type { ConflictResolution } from "./token-conflict-dialog";
const deduplicateName = (
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index e37913fdcc..276a3d65fd 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -1,17 +1,17 @@
import { useEffect } from "react";
import { useStore } from "@nanostores/react";
import { useNavigate } from "@remix-run/react";
+import { $pages, $project } from "~/shared/sync/data-stores";
import {
$authToken,
- $pages,
- $project,
$selectedPageHash,
$builderMode,
isBuilderMode,
setBuilderMode,
} from "~/shared/nano-states";
import { builderPath } from "~/shared/router-utils";
-import { $selectedPage, selectPage } from "../awareness";
+import { $selectedPage } from "../nano-states";
+import { selectPage } from "../nano-states";
import { findPageByIdOrPath } from "@webstudio-is/sdk";
const setPageStateFromUrl = () => {
diff --git a/apps/builder/app/shared/polly/backoff.test.ts b/apps/builder/app/shared/polly/backoff.test.ts
deleted file mode 100644
index 7e4d5b9805..0000000000
--- a/apps/builder/app/shared/polly/backoff.test.ts
+++ /dev/null
@@ -1,141 +0,0 @@
-/**
- * @vitest-environment jsdom
- */
-import { describe, test, expect, vi, beforeEach } from "vitest";
-import { createBackoff } from "./backoff";
-
-describe("createBackoff", () => {
- beforeEach(() => {
- vi.restoreAllMocks();
- });
-
- // ── Deterministic (jitter=false) ─────────────────────────────
-
- describe("deterministic (jitter=false)", () => {
- test("first delay equals baseDelay", () => {
- const backoff = createBackoff({
- baseDelay: 1000,
- multiplier: 2,
- jitter: false,
- });
-
- expect(backoff.next()).toBe(1000);
- });
-
- test("delays grow exponentially", () => {
- const backoff = createBackoff({
- baseDelay: 100,
- multiplier: 2,
- jitter: false,
- });
-
- expect(backoff.next()).toBe(100); // 100 * 2^0
- expect(backoff.next()).toBe(200); // 100 * 2^1
- expect(backoff.next()).toBe(400); // 100 * 2^2
- expect(backoff.next()).toBe(800); // 100 * 2^3
- });
-
- test("clamps at maxDelay", () => {
- const backoff = createBackoff({
- baseDelay: 1000,
- multiplier: 10,
- maxDelay: 5000,
- jitter: false,
- });
-
- expect(backoff.next()).toBe(1000);
- expect(backoff.next()).toBe(5000); // Would be 10000, clamped
- expect(backoff.next()).toBe(5000); // Stays clamped
- });
-
- test("reset restores initial state", () => {
- const backoff = createBackoff({
- baseDelay: 100,
- multiplier: 3,
- jitter: false,
- });
-
- backoff.next(); // 100
- backoff.next(); // 300
- backoff.next(); // 900
-
- backoff.reset();
-
- expect(backoff.attempts()).toBe(0);
- expect(backoff.next()).toBe(100); // Back to start
- });
-
- test("attempts tracks failure count", () => {
- const backoff = createBackoff({ jitter: false });
-
- expect(backoff.attempts()).toBe(0);
- backoff.next();
- expect(backoff.attempts()).toBe(1);
- backoff.next();
- expect(backoff.attempts()).toBe(2);
- });
- });
-
- // ── Jitter (default) ──────────────────────────────────────────
-
- describe("jitter (default)", () => {
- test("delays are within expected range", () => {
- // Fix Math.random to midpoint (0.5)
- vi.spyOn(Math, "random").mockReturnValue(0.5);
-
- const backoff = createBackoff({
- baseDelay: 1000,
- multiplier: 3,
- maxDelay: 120_000,
- });
-
- // First: random(1000, 1000 * 3) = random(1000, 3000) at 0.5 → 2000
- expect(backoff.next()).toBe(2000);
-
- // Second: random(1000, 2000 * 3) = random(1000, 6000) at 0.5 → 3500
- expect(backoff.next()).toBe(3500);
- });
-
- test("clamps at maxDelay with jitter", () => {
- // Force Math.random to return 1.0 (max)
- vi.spyOn(Math, "random").mockReturnValue(0.999999);
-
- const backoff = createBackoff({
- baseDelay: 1000,
- multiplier: 3,
- maxDelay: 5000,
- });
-
- // Keep calling until we exceed max
- for (let i = 0; i < 20; i++) {
- expect(backoff.next()).toBeLessThanOrEqual(5000);
- }
- });
-
- test("delays are never below baseDelay", () => {
- // Force Math.random to return 0 (min)
- vi.spyOn(Math, "random").mockReturnValue(0);
-
- const backoff = createBackoff({
- baseDelay: 500,
- multiplier: 3,
- });
-
- for (let i = 0; i < 10; i++) {
- expect(backoff.next()).toBeGreaterThanOrEqual(500);
- }
- });
-
- test("uses defaults when no options provided", () => {
- vi.spyOn(Math, "random").mockReturnValue(0.5);
-
- const backoff = createBackoff();
-
- // Default: baseDelay=5000, multiplier=3, maxDelay=120000
- // First: random(5000, 5000 * 3) at 0.5 → 10000
- const first = backoff.next();
- expect(first).toBe(10_000);
- expect(backoff.attempts()).toBe(1);
- });
- });
-});
diff --git a/apps/builder/app/shared/polly/polling-client.ts b/apps/builder/app/shared/polly/polling-client.ts
index 784b5c5dcc..053d98645d 100644
--- a/apps/builder/app/shared/polly/polling-client.ts
+++ b/apps/builder/app/shared/polly/polling-client.ts
@@ -15,7 +15,7 @@
* The client is intentionally framework-agnostic. Wrap it with
* nanostores, React state, Svelte stores, or anything else.
*/
-import { createBackoff, type BackoffOptions } from "./backoff";
+import { createBackoff, type BackoffOptions } from "@webstudio-is/sync-client";
export type PollingClientOptions<T> = {
/** Async function that fetches the data. */
diff --git a/apps/builder/app/shared/project-settings/section-general.tsx b/apps/builder/app/shared/project-settings/section-general.tsx
index 6b5b984616..90113b9c2f 100644
--- a/apps/builder/app/shared/project-settings/section-general.tsx
+++ b/apps/builder/app/shared/project-settings/section-general.tsx
@@ -21,7 +21,9 @@ import { CopyIcon, InfoCircleIcon } from "@webstudio-is/icons";
import { Image, wsImageLoader } from "@webstudio-is/image";
import type { ProjectMeta } from "@webstudio-is/sdk";
import { ImageControl } from "./image-control";
-import { $assets, $pages, $project, $permissions } from "~/shared/nano-states";
+import { $assets, $project } from "~/shared/sync/data-stores";
+import { $permissions } from "~/shared/nano-states";
+import { $pages } from "~/shared/sync/data-stores";
import { serverSyncStore } from "~/shared/sync/sync-stores";
import { sectionSpacing } from "./utils";
import { CodeEditor } from "~/shared/code-editor";
diff --git a/apps/builder/app/shared/router-utils/path-utils.ts b/apps/builder/app/shared/router-utils/path-utils.ts
index 91011dcd44..b5256b1297 100644
--- a/apps/builder/app/shared/router-utils/path-utils.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.ts
@@ -1,5 +1,4 @@
import type { AUTH_PROVIDERS } from "~/shared/session";
-import { publicStaticEnv } from "~/env/env.static";
import { getAuthorizationServerOrigin } from "./origins";
import type { BuilderMode } from "../nano-states/misc";
@@ -158,17 +157,8 @@ export const restAssetsUploadPath = ({
return `/rest/assets/${name}`;
};
-export const restPatchPath = () => {
- const urlSearchParams = new URLSearchParams();
-
- urlSearchParams.set("client-version", publicStaticEnv.VERSION);
-
- const urlSearchParamsString = urlSearchParams.toString();
-
- return `/rest/patch${
- urlSearchParamsString ? `?${urlSearchParamsString}` : ""
- }`;
-};
+export const restBuildVersionPath = (buildId: string) =>
+ `/rest/build-version?buildId=${encodeURIComponent(buildId)}`;
export const getCanvasUrl = () => {
return `/canvas`;
diff --git a/apps/builder/app/shared/sync-client.test.ts b/apps/builder/app/shared/sync-client.test.ts
index b6b54932f5..ca1bbf4877 100644
--- a/apps/builder/app/shared/sync-client.test.ts
+++ b/apps/builder/app/shared/sync-client.test.ts
@@ -1,11 +1,11 @@
import { describe, expect, test, vi } from "vitest";
-import { createNanoEvents } from "nanoevents";
import { atom } from "nanostores";
import { Store } from "immerhin";
import { enableMapSet } from "immer";
import {
ImmerhinSyncObject,
NanostoresSyncObject,
+ NanoEventsSyncEmitter,
SyncClient,
SyncObjectPool,
type SyncStorage,
@@ -34,7 +34,7 @@ const createLeaderStore = () => {
};
test("synchronize initial state when follower is connected", () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const leaderStore = createLeaderStore();
const followerStore = createFollowerStore();
const leader = new SyncClient({
@@ -63,7 +63,7 @@ test("synchronize initial state when follower is connected", () => {
});
test("synchronize initial state when leader is connected", () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const leaderStore = createLeaderStore();
const followerStore = createFollowerStore();
const leader = new SyncClient({
@@ -92,7 +92,7 @@ test("synchronize initial state when leader is connected", () => {
});
test("synchronize initial state when one of followers become leader", () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const leaderStore = createLeaderStore();
const followerStore = createFollowerStore();
const leader = new SyncClient({
@@ -120,7 +120,7 @@ test("synchronize initial state when one of followers become leader", () => {
});
test("exchange transactions between leader and follower", async () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const leaderStore = createLeaderStore();
const followerStore = createFollowerStore();
const leader = new SyncClient({
@@ -157,7 +157,7 @@ test("exchange transactions between leader and follower", async () => {
});
test("exchange transactions between followers", async () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const follower1Store = createFollowerStore();
const follower2Store = createFollowerStore();
const follower1 = new SyncClient({
@@ -232,7 +232,7 @@ test("merge state in pool object to partially restore from storage", () => {
describe("nanostores sync object", () => {
test("sync initial state and exchange transactions", () => {
- const emitter = createNanoEvents();
+ const emitter = new NanoEventsSyncEmitter();
const $leader = atom(1);
const $follower = atom(2);
new SyncClient({
diff --git a/apps/builder/app/shared/sync-client.ts b/apps/builder/app/shared/sync-client.ts
index e646ad6bac..227229128c 100644
--- a/apps/builder/app/shared/sync-client.ts
+++ b/apps/builder/app/shared/sync-client.ts
@@ -1,18 +1,13 @@
import { nanoid } from "nanoid";
-import { createNanoEvents, type Emitter } from "nanoevents";
+import { createNanoEvents } from "nanoevents";
import type { Change, Store } from "immerhin";
import type { WritableAtom } from "nanostores";
-
-export type Transaction<Payload = unknown> = {
- id: string;
- object: string;
- payload: Payload;
-};
-
-export type RevertedTransaction = {
- id: string;
- object: string;
-};
+import type {
+ Transaction,
+ RevertedTransaction,
+ SyncMessage,
+ SyncEmitter,
+} from "@webstudio-is/sync-client";
export interface SyncStorage {
name: string;
@@ -54,9 +49,20 @@ interface SyncObject {
export class ImmerhinSyncObject implements SyncObject {
name: string;
store: Store;
- constructor(name: string, store: Store) {
+ transformOnSend?: (changes: Change[]) => Change[];
+ transformOnReceive?: (changes: Change[]) => Change[];
+ constructor(
+ name: string,
+ store: Store,
+ transform?: {
+ onSend?: (changes: Change[]) => Change[];
+ onReceive?: (changes: Change[]) => Change[];
+ }
+ ) {
this.name = name;
this.store = store;
+ this.transformOnSend = transform?.onSend;
+ this.transformOnReceive = transform?.onReceive;
}
getState() {
const state = new Map<string, unknown>();
@@ -79,7 +85,10 @@ export class ImmerhinSyncObject implements SyncObject {
}
}
applyTransaction(transaction: Transaction<Change[]>) {
- this.store.addTransaction(transaction.id, transaction.payload, "remote");
+ const payload = this.transformOnReceive
+ ? this.transformOnReceive(transaction.payload)
+ : transaction.payload;
+ this.store.addTransaction(transaction.id, payload, "remote");
}
revertTransaction(transaction: RevertedTransaction) {
this.store.revertTransaction(transaction.id);
@@ -92,7 +101,10 @@ export class ImmerhinSyncObject implements SyncObject {
if (source === "remote") {
return;
}
- sendTransaction({ id, object: this.name, payload });
+ const outgoing = this.transformOnSend
+ ? this.transformOnSend(payload)
+ : payload;
+ sendTransaction({ id, object: this.name, payload: outgoing });
});
signal.addEventListener("abort", unsubscribe);
}
@@ -185,15 +197,15 @@ export class SyncObjectPool implements SyncObject {
}
}
-type SyncMessage =
- | { type: "connect"; clientId: string }
- | { type: "state"; clientId: string; state: unknown }
- | { type: "apply"; clientId: string; transaction: Transaction }
- | { type: "revert"; clientId: string; transaction: RevertedTransaction };
-
-export type SyncEmitter = Emitter<{
- message: (message: SyncMessage) => void;
-}>;
+export class NanoEventsSyncEmitter implements SyncEmitter {
+ private inner = createNanoEvents<{ message: (m: SyncMessage) => void }>();
+ emit(message: SyncMessage): void {
+ this.inner.emit("message", message);
+ }
+ on(handler: (message: SyncMessage) => void): () => void {
+ return this.inner.on("message", handler);
+ }
+}
type SyncClientOptions = {
role: "leader" | "follower";
@@ -214,12 +226,12 @@ export class SyncClient {
this.role = options.role;
this.object = options.object;
this.storages = options.storages ?? [];
- this.emitter = options.emitter ?? createNanoEvents();
+ this.emitter = options.emitter ?? new NanoEventsSyncEmitter();
}
lead() {
this.role = "leader";
- this.emitter.emit("message", {
+ this.emitter.emit({
clientId: this.clientId,
type: "state",
state: this.object.getState(),
@@ -227,7 +239,7 @@ export class SyncClient {
}
connect({ signal, onReady }: { signal: AbortSignal; onReady?: () => void }) {
- const off = this.emitter.on("message", (message) => {
+ const off = this.emitter.on((message) => {
// ignore own messages
if (this.clientId === message.clientId) {
return;
@@ -236,7 +248,7 @@ export class SyncClient {
if (this.role !== "leader") {
return;
}
- this.emitter.emit("message", {
+ this.emitter.emit({
clientId: this.clientId,
type: "state",
state: this.object.getState(),
@@ -250,14 +262,6 @@ export class SyncClient {
this.object.setState(message.state);
}
if (message.type === "apply") {
- /*
- // leader interacts with server
- // and should validate transactions from various actors
- if (this.role === "leader" && invalid(event.transaction)) {
- this.emitter.emit('revert', { clientId, transactions: [transaction.id] })
- return;
- }
- */
this.object.applyTransaction(message.transaction);
if (this.role === "leader") {
for (const storage of this.storages) {
@@ -272,7 +276,7 @@ export class SyncClient {
signal.addEventListener("abort", off);
this.object.subscribe((transaction) => {
- this.emitter.emit("message", {
+ this.emitter.emit({
clientId: this.clientId,
type: "apply",
transaction,
@@ -284,7 +288,7 @@ export class SyncClient {
}
}, signal);
- this.emitter.emit("message", {
+ this.emitter.emit({
clientId: this.clientId,
type: "connect",
});
@@ -298,7 +302,7 @@ export class SyncClient {
// fallback to default object state
state ??= this.object.getState();
this.object.setState(state);
- this.emitter.emit("message", {
+ this.emitter.emit({
clientId: this.clientId,
type: "state",
state,
diff --git a/apps/builder/app/shared/sync/collab-sync.test.ts b/apps/builder/app/shared/sync/collab-sync.test.ts
new file mode 100644
index 0000000000..b1d9c192bb
--- /dev/null
+++ b/apps/builder/app/shared/sync/collab-sync.test.ts
@@ -0,0 +1,373 @@
+/**
+ * Unit tests for the single-player and multi-client sync cycle using
+ * InProcessEmitter + in-process fake storage.
+ */
+import { describe, test, expect, beforeEach, afterEach } from "vitest";
+import { atom } from "nanostores";
+import { Store } from "immerhin";
+import { enableMapSet } from "immer";
+import {
+ ImmerhinSyncObject,
+ NanostoresSyncObject,
+ SyncClient,
+ SyncObjectPool,
+} from "~/shared/sync-client";
+import type { Change } from "immerhin";
+import type { SyncStorage } from "~/shared/sync-client";
+import type {
+ SyncEmitter,
+ SyncMessage,
+ Transaction,
+} from "@webstudio-is/sync-client";
+
+enableMapSet();
+
+// helpers
+
+const inProcessRooms = new Map<
+ string,
+ Map<symbol, (message: SyncMessage) => void>
+>();
+
+const createInProcessRoom = (buildId: string) => {
+ const handlers =
+ inProcessRooms.get(buildId) ??
+ new Map<symbol, (message: SyncMessage) => void>();
+ inProcessRooms.set(buildId, handlers);
+
+ return {
+ createEmitter(): SyncEmitter {
+ const ownKeys = new Set<symbol>();
+ return {
+ emit(message) {
+ for (const [key, handler] of handlers) {
+ if (ownKeys.has(key)) {
+ continue;
+ }
+ handler(message);
+ }
+ },
+ on(handler) {
+ const key = Symbol();
+ ownKeys.add(key);
+ handlers.set(key, handler);
+ return () => {
+ handlers.delete(key);
+ ownKeys.delete(key);
+ };
+ },
+ };
+ },
+ cleanup() {
+ inProcessRooms.delete(buildId);
+ },
+ };
+};
+
+const createFakeServer = () => {
+ const server: SyncStorage & {
+ version: number;
+ savedTransactions: Transaction<Change[]>[];
+ } = {
+ name: "fake-server",
+ version: 0,
+ savedTransactions: [],
+ sendTransaction(transaction: Transaction<Change[]>): void {
+ if (transaction.object !== "server") {
+ return;
+ }
+ this.savedTransactions.push(transaction);
+ this.version += 1;
+ },
+ subscribe(setState: (state: unknown) => void, _signal: AbortSignal): void {
+ setState(undefined);
+ },
+ };
+ return server;
+};
+
+const makeStore = (initial: Record<string, unknown> = {}) => {
+ const store = new Store();
+ const $data = atom<Record<string, unknown>>(initial);
+ store.register("data", $data);
+ return { store, $data };
+};
+
+const makeClient = ({
+ role,
+ emitter,
+ storages = [],
+}: {
+ role: "leader" | "follower";
+ emitter: ReturnType<ReturnType<typeof createInProcessRoom>["createEmitter"]>;
+ storages?: ConstructorParameters<typeof SyncClient>[0]["storages"];
+}) => {
+ const { store, $data } = makeStore();
+ const object = new SyncObjectPool([new ImmerhinSyncObject("server", store)]);
+ const client = new SyncClient({ role, object, emitter, storages });
+ return { client, store, $data };
+};
+
+// Single-player
+
+describe("single-player sync cycle", () => {
+ test("leader saves transaction to server on local edit", () => {
+ const room = createInProcessRoom("build-1");
+ const fakeServer = createFakeServer();
+ const { client, store, $data } = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+
+ client.connect({ signal: new AbortController().signal });
+
+ store.createTransaction([store.containers.get("data")!], (data) => {
+ data["key"] = "value";
+ });
+
+ expect($data.get()).toEqual({ key: "value" });
+ expect(fakeServer.savedTransactions).toHaveLength(1);
+ expect(fakeServer.savedTransactions[0].object).toBe("server");
+ expect(fakeServer.version).toBe(1);
+
+ room.cleanup();
+ });
+
+ test("follower does not save to server on local edit", () => {
+ const room = createInProcessRoom("build-2");
+ const fakeServer = createFakeServer();
+ const { client, store, $data } = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+
+ client.connect({ signal: new AbortController().signal });
+
+ store.createTransaction([store.containers.get("data")!], (data) => {
+ data["key"] = "value";
+ });
+
+ expect($data.get()).toEqual({ key: "value" });
+ expect(fakeServer.savedTransactions).toHaveLength(0);
+
+ room.cleanup();
+ });
+});
+
+// Multi-client
+
+describe("multi-client sync cycle", () => {
+ let room: ReturnType<typeof createInProcessRoom>;
+ let fakeServer: ReturnType<typeof createFakeServer>;
+
+ beforeEach(() => {
+ room = createInProcessRoom("build-multi");
+ fakeServer = createFakeServer();
+ });
+
+ afterEach(() => {
+ room.cleanup();
+ });
+
+ test("leader applies transaction and follower receives it", () => {
+ const leaderClient = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+ const followerClient = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+
+ const signal = new AbortController().signal;
+ leaderClient.client.connect({ signal });
+ followerClient.client.connect({ signal });
+
+ leaderClient.store.createTransaction(
+ [leaderClient.store.containers.get("data")!],
+ (data) => {
+ data["msg"] = "hello";
+ }
+ );
+
+ expect(leaderClient.$data.get()).toEqual({ msg: "hello" });
+ expect(followerClient.$data.get()).toEqual({ msg: "hello" });
+ expect(fakeServer.savedTransactions).toHaveLength(1);
+ });
+
+ test("follower applies transaction and leader receives it, leader saves to server", () => {
+ const leaderClient = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+ const followerClient = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+
+ const signal = new AbortController().signal;
+ leaderClient.client.connect({ signal });
+ followerClient.client.connect({ signal });
+
+ followerClient.store.createTransaction(
+ [followerClient.store.containers.get("data")!],
+ (data) => {
+ data["from"] = "follower";
+ }
+ );
+
+ expect(leaderClient.$data.get()).toEqual({ from: "follower" });
+ expect(followerClient.$data.get()).toEqual({ from: "follower" });
+ // Leader receives the follower's transaction and saves it to server
+ expect(fakeServer.savedTransactions).toHaveLength(1);
+ });
+
+ test("concurrent edits to different keys both converge", () => {
+ const c1 = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+ const c2 = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+
+ const signal = new AbortController().signal;
+ c1.client.connect({ signal });
+ c2.client.connect({ signal });
+
+ c1.store.createTransaction([c1.store.containers.get("data")!], (data) => {
+ data["a"] = 1;
+ });
+ c2.store.createTransaction([c2.store.containers.get("data")!], (data) => {
+ data["b"] = 2;
+ });
+
+ expect(c1.$data.get()).toEqual({ a: 1, b: 2 });
+ expect(c2.$data.get()).toEqual({ a: 1, b: 2 });
+ });
+
+ test("concurrent edits to same key - last-applied wins", () => {
+ const c1 = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+ const c2 = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+
+ const signal = new AbortController().signal;
+ c1.client.connect({ signal });
+ c2.client.connect({ signal });
+
+ c1.store.createTransaction([c1.store.containers.get("data")!], (data) => {
+ data["x"] = "from-leader";
+ });
+ c2.store.createTransaction([c2.store.containers.get("data")!], (data) => {
+ data["x"] = "from-follower";
+ });
+
+ // Both clients should have the same final value (last-applied wins)
+ expect(c1.$data.get()["x"]).toEqual(c2.$data.get()["x"]);
+ });
+
+ test("second follower receives initial state from leader on connect", () => {
+ const c1 = makeClient({
+ role: "leader",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+
+ const signal = new AbortController().signal;
+ c1.client.connect({ signal });
+
+ c1.store.createTransaction([c1.store.containers.get("data")!], (data) => {
+ data["existing"] = true;
+ });
+
+ // Second client joins after data already exists
+ const c2 = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+ c2.client.connect({ signal });
+
+ expect(c2.$data.get()).toEqual({ existing: true });
+ });
+
+ test("follower promoted to leader after calling lead()", () => {
+ const c1 = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ storages: [fakeServer],
+ });
+ const c2 = makeClient({
+ role: "follower",
+ emitter: room.createEmitter(),
+ });
+
+ const signal = new AbortController().signal;
+ c1.client.connect({ signal });
+ c2.client.connect({ signal });
+
+ c1.store.createTransaction([c1.store.containers.get("data")!], (data) => {
+ data["draft"] = true;
+ });
+ // Nothing saved yet - both are followers
+ expect(fakeServer.savedTransactions).toHaveLength(0);
+
+ // Promote c1 to leader
+ c1.client.lead();
+ expect(c1.client.role).toBe("leader");
+
+ // Now c2 should have received the state broadcast from c1 and c1 receives
+ // from the state message
+ expect(c2.$data.get()).toEqual({ draft: true });
+ });
+});
+
+// NanostoresSyncObject
+
+describe("nanostores multi-client sync", () => {
+ test("nanostores value propagates to remote clients", () => {
+ const room = createInProcessRoom("build-nano");
+ const $leaderColor = atom("blue");
+ const $followerColor = atom("red");
+
+ const leaderEmitter = room.createEmitter();
+ const followerEmitter = room.createEmitter();
+
+ const leader = new SyncClient({
+ role: "leader",
+ object: new NanostoresSyncObject("color", $leaderColor),
+ emitter: leaderEmitter,
+ });
+ const follower = new SyncClient({
+ role: "follower",
+ object: new NanostoresSyncObject("color", $followerColor),
+ emitter: followerEmitter,
+ });
+
+ const signal = new AbortController().signal;
+ leader.connect({ signal });
+ follower.connect({ signal });
+
+ // follower receives leader's initial state
+ expect($followerColor.get()).toBe("blue");
+
+ $leaderColor.set("green");
+ expect($followerColor.get()).toBe("green");
+
+ $followerColor.set("purple");
+ expect($leaderColor.get()).toBe("purple");
+
+ room.cleanup();
+ });
+});
diff --git a/apps/builder/app/shared/sync/command-queue.test.ts b/apps/builder/app/shared/sync/command-queue.test.ts
index 5dc6ef2201..54207df2db 100644
--- a/apps/builder/app/shared/sync/command-queue.test.ts
+++ b/apps/builder/app/shared/sync/command-queue.test.ts
@@ -142,8 +142,11 @@ describe("command-queue", () => {
const commands = dequeueAll();
// The setDetails breaks the merge chain, so we get 3 commands
- // (note: the internal reverse() may reorder them)
- expect(commands.length).toBeGreaterThanOrEqual(3);
+ expect(commands).toEqual([
+ expect.objectContaining({ type: "transactions", projectId: "p1" }),
+ expect.objectContaining({ type: "setDetails", projectId: "p1" }),
+ expect.objectContaining({ type: "transactions", projectId: "p1" }),
+ ]);
});
test("merges multiple transactions in a single batch", () => {
@@ -165,9 +168,7 @@ describe("command-queue", () => {
}
});
- test("merges with the last matching transactions command", () => {
- // Enqueue transactions for two different projects, then another for p1.
- // The second p1 batch should merge with the first p1 batch.
+ test("does not merge across another project's pending transactions", () => {
enqueue({
type: "transactions",
projectId: "p1",
@@ -185,15 +186,12 @@ describe("command-queue", () => {
});
const commands = dequeueAll();
- // After merging, p1's transactions should contain t1 and t3
- const p1Commands = commands.filter(
- (c) => c.type === "transactions" && c.projectId === "p1"
- );
- expect(p1Commands).toHaveLength(1);
- if (p1Commands[0].type === "transactions") {
- expect(p1Commands[0].transactions.map((t) => t.id)).toContain("t1");
- expect(p1Commands[0].transactions.map((t) => t.id)).toContain("t3");
- }
+ expect(commands).toHaveLength(3);
+ expect(commands).toEqual([
+ expect.objectContaining({ type: "transactions", projectId: "p1" }),
+ expect.objectContaining({ type: "transactions", projectId: "p2" }),
+ expect.objectContaining({ type: "transactions", projectId: "p1" }),
+ ]);
});
test("empty queue followed by a transactions command is not merged", () => {
@@ -230,8 +228,12 @@ describe("command-queue", () => {
const commands = dequeueAll();
expect(commands).toHaveLength(2);
- expect(commands.some((c) => c.type === "setDetails")).toBe(true);
- expect(commands.some((c) => c.type === "transactions")).toBe(true);
+ expect(commands[0]).toEqual(
+ expect.objectContaining({ type: "setDetails" })
+ );
+ expect(commands[1]).toEqual(
+ expect.objectContaining({ type: "transactions" })
+ );
});
test("multiple dequeueAll calls return disjoint results", () => {
diff --git a/apps/builder/app/shared/sync/command-queue.ts b/apps/builder/app/shared/sync/command-queue.ts
index 695c2db930..dd632a5690 100644
--- a/apps/builder/app/shared/sync/command-queue.ts
+++ b/apps/builder/app/shared/sync/command-queue.ts
@@ -1,7 +1,7 @@
import type { Project } from "@webstudio-is/project";
import type { Build } from "@webstudio-is/project-build";
import type { Change } from "immerhin";
-import type { Transaction } from "~/shared/sync-client";
+import type { Transaction } from "@webstudio-is/sync-client";
type Command =
| {
@@ -25,16 +25,15 @@ export const enqueue = (command: Command) => {
return;
}
- // merge transactions in case of no commands in queue
- for (const projectCommand of projectCommandsQueue.reverse()) {
- if (projectCommand.type !== "transactions") {
- break;
- }
-
- if (projectCommand.projectId === command.projectId) {
- projectCommand.transactions.push(...command.transactions);
- return;
- }
+ // Merge only with the immediate tail command. Looking farther back can move
+ // transactions across another project's pending command and change save order.
+ const projectCommand = projectCommandsQueue.at(-1);
+ if (
+ projectCommand?.type === "transactions" &&
+ projectCommand.projectId === command.projectId
+ ) {
+ projectCommand.transactions.push(...command.transactions);
+ return;
}
projectCommandsQueue.push(command);
diff --git a/apps/builder/app/shared/sync/multiplayer-client.ts b/apps/builder/app/shared/sync/multiplayer-client.ts
new file mode 100644
index 0000000000..455faab8bb
--- /dev/null
+++ b/apps/builder/app/shared/sync/multiplayer-client.ts
@@ -0,0 +1,106 @@
+import type { Project } from "@webstudio-is/project";
+import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
+import { toast } from "@webstudio-is/design-system";
+import { nativeClient } from "~/shared/trpc/trpc-client";
+import { loadBuilderData, type LoadedBuilderData } from "~/shared/builder-data";
+import {
+ createMultiplayerSyncEmitter,
+ startMultiplayerPresenceSync,
+} from "./multiplayer-sync";
+import type { SyncStorage } from "~/shared/sync-client";
+
+export type MultiplayerSyncClient = {
+ clientId: string;
+ emitter: ReturnType<typeof createMultiplayerSyncEmitter>;
+ storages: SyncStorage[];
+ destroy(): void;
+ onDataLoaded(data: LoadedBuilderData): void;
+};
+
+const createCollabAuthTokenLoader = ({
+ authPermit,
+ authToken,
+ buildId,
+ projectId,
+}: {
+ authPermit: AuthPermit;
+ authToken: string | undefined;
+ buildId: () => string | undefined;
+ projectId: Project["id"];
+}): (() => Promise<string | undefined>) => {
+ if (authPermit === "view") {
+ return async () => undefined;
+ }
+ if (authToken !== undefined) {
+ return async () => authToken;
+ }
+ return async () => {
+ const currentBuildId = buildId();
+ if (currentBuildId === undefined) {
+ throw new Error("Build id is not ready for collaboration token");
+ }
+ const result = await nativeClient.build.createCollabToken.query({
+ buildId: currentBuildId,
+ projectId,
+ });
+ return result.token;
+ };
+};
+
+export const createMultiplayerSyncClient = ({
+ applyBuilderData,
+ authPermit,
+ authToken,
+ projectId,
+ relayUrl,
+ signal,
+}: {
+ applyBuilderData: (data: LoadedBuilderData) => void;
+ authPermit: AuthPermit;
+ authToken: string | undefined;
+ projectId: Project["id"];
+ relayUrl: string;
+ signal: AbortSignal;
+}): MultiplayerSyncClient => {
+ let buildId: string | undefined;
+ let unsubscribePresence: (() => void) | undefined;
+ const clientId = crypto.randomUUID();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: createCollabAuthTokenLoader({
+ authPermit,
+ authToken,
+ buildId: () => buildId,
+ projectId,
+ }),
+ clientId,
+ url: relayUrl,
+ onReload: async () => {
+ try {
+ const reloaded = await loadBuilderData({ projectId, signal });
+ applyBuilderData(reloaded);
+ } catch (error) {
+ console.error("[builder-sync] multiplayer reload failed:", error);
+ }
+ },
+ onUserMessage: (message) => {
+ toast.error(message, { id: "multiplayer-sync-message" });
+ },
+ });
+
+ return {
+ clientId,
+ emitter,
+ storages: [],
+ destroy() {
+ emitter.close();
+ unsubscribePresence?.();
+ unsubscribePresence = undefined;
+ },
+ onDataLoaded(data) {
+ buildId = data.id;
+ emitter.connect(data.id);
+ unsubscribePresence?.();
+ unsubscribePresence = startMultiplayerPresenceSync(emitter);
+ },
+ };
+};
diff --git a/apps/builder/app/shared/sync/multiplayer-sync.test.ts b/apps/builder/app/shared/sync/multiplayer-sync.test.ts
new file mode 100644
index 0000000000..3c64f9bea8
--- /dev/null
+++ b/apps/builder/app/shared/sync/multiplayer-sync.test.ts
@@ -0,0 +1,301 @@
+import { afterEach, describe, expect, test, vi } from "vitest";
+import type { WebSocketEmitterOptions } from "@webstudio-is/sync-client/websocket";
+import { $collaborators, $syncStatus } from "@webstudio-is/sync-client";
+import { __testing__ as awarenessTesting } from "~/shared/awareness";
+import {
+ createMultiplayerSyncEmitter,
+ startMultiplayerPresenceSync,
+} from "./multiplayer-sync";
+
+const createTransportFactory = () => {
+ let callbacks: WebSocketEmitterOptions | undefined;
+ const sendToRelay = vi.fn();
+ const close = vi.fn();
+ return {
+ close,
+ get callbacks() {
+ if (callbacks === undefined) {
+ throw new Error("Transport was not created");
+ }
+ return callbacks;
+ },
+ createTransport(options: WebSocketEmitterOptions) {
+ callbacks = options;
+ return {
+ close,
+ emit: vi.fn(),
+ on: vi.fn(() => () => {}),
+ sendToRelay,
+ };
+ },
+ sendToRelay,
+ };
+};
+
+describe("createMultiplayerSyncEmitter", () => {
+ afterEach(() => {
+ $syncStatus.set({ status: "idle" });
+ $collaborators.set(new Map());
+ });
+
+ test("keeps unsaved state until all local applies are durable", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: async () => "token",
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+ $syncStatus.set({ status: "idle" });
+
+ emitter.connect("build-1");
+ emitter.emit({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ });
+ emitter.emit({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-2", object: "server", payload: [] },
+ });
+
+ expect($syncStatus.get()).toEqual({ status: "syncing" });
+
+ transport.callbacks.onBroadcast({
+ type: "broadcast",
+ actorId: "client-1",
+ clientSeq: 1,
+ originClientId: "client-1",
+ relayTs: 10,
+ seq: 1,
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ });
+ transport.callbacks.onAck(1, 2);
+
+ expect($syncStatus.get()).toEqual({ status: "syncing" });
+
+ transport.callbacks.onBroadcast({
+ type: "broadcast",
+ actorId: "client-1",
+ clientSeq: 2,
+ originClientId: "client-1",
+ relayTs: 11,
+ seq: 2,
+ transaction: { id: "tx-2", object: "server", payload: [] },
+ });
+ transport.callbacks.onAck(2, 3);
+
+ expect($syncStatus.get()).toEqual({ status: "idle" });
+ });
+
+ test("connects to the build room and sends local transactions as relay applies", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: async () => "token",
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+
+ emitter.connect("build-1");
+ emitter.emit({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ });
+
+ expect(transport.callbacks.buildId).toBe("build-1");
+ expect(transport.sendToRelay).toHaveBeenCalledWith({
+ type: "apply",
+ transactionId: "tx-1",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ clientId: "client-1",
+ actorId: "client-1",
+ clientSeq: 1,
+ });
+ });
+
+ test("forwards sync messages locally before relaying server transactions", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: async () => "token",
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+ const handler = vi.fn();
+ emitter.on(handler);
+
+ emitter.emit({
+ type: "state",
+ clientId: "client-1",
+ state: new Map([["server", new Map()]]),
+ });
+
+ expect(handler).toHaveBeenCalledWith({
+ type: "state",
+ clientId: "client-1",
+ state: new Map([["server", new Map()]]),
+ });
+ expect(transport.sendToRelay).not.toHaveBeenCalled();
+ });
+
+ test("does not relay client-only sync transactions to the multiplayer service", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: async () => "token",
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+ const handler = vi.fn();
+ emitter.on(handler);
+
+ emitter.connect("build-1");
+ emitter.emit({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-1", object: "canvasIframeState", payload: "idle" },
+ });
+
+ expect(handler).toHaveBeenCalledWith({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-1", object: "canvasIframeState", payload: "idle" },
+ });
+ expect(transport.sendToRelay).not.toHaveBeenCalled();
+ });
+
+ test("applies relay broadcasts to sync handlers", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+ const handler = vi.fn();
+ emitter.on(handler);
+
+ emitter.connect("build-1");
+ transport.callbacks.onBroadcast({
+ type: "broadcast",
+ actorId: "client-2",
+ clientSeq: 1,
+ originClientId: "client-2",
+ relayTs: 10,
+ seq: 1,
+ transaction: { id: "tx-2", object: "server", payload: [] },
+ });
+
+ expect(handler).toHaveBeenCalledWith({
+ type: "apply",
+ clientId: "client-2",
+ transaction: { id: "tx-2", object: "server", payload: [] },
+ });
+ });
+
+ test("surfaces relay applied errors to user messages", () => {
+ const transport = createTransportFactory();
+ const onUserMessage = vi.fn();
+ const emitter = createMultiplayerSyncEmitter({
+ getAuthToken: async () => "token",
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ onUserMessage,
+ url: "localhost:1999",
+ });
+
+ emitter.connect("build-1");
+ emitter.emit({
+ type: "apply",
+ clientId: "client-1",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ });
+ transport.callbacks.onApplied("tx-1", 1, "rejected", "No permission");
+
+ expect(onUserMessage).toHaveBeenCalledWith("No permission");
+ expect($syncStatus.get()).toEqual({ status: "idle" });
+ });
+
+ test("updates collaborators from relay presence", () => {
+ const transport = createTransportFactory();
+ const emitter = createMultiplayerSyncEmitter({
+ clientId: "client-1",
+ createTransport: transport.createTransport,
+ url: "localhost:1999",
+ });
+ $collaborators.set(new Map());
+
+ emitter.connect("build-1");
+ transport.callbacks.onPresence("client-2", {
+ pageId: "page-1",
+ pointerPosition: { x: 1, y: 2, xRatio: 0.1, yRatio: 0.2 },
+ selectedInstanceIds: ["instance-1"],
+ });
+
+ expect($collaborators.get().get("client-2")).toMatchObject({
+ pageId: "page-1",
+ pointerPosition: { x: 1, y: 2, xRatio: 0.1, yRatio: 0.2 },
+ selectedInstanceIds: ["instance-1"],
+ });
+ });
+});
+
+describe("startMultiplayerPresenceSync", () => {
+ afterEach(() => {
+ awarenessTesting.$pointerPosition.set(undefined);
+ });
+
+ test("sends only the latest awareness update in one microtask", async () => {
+ const emitter = { sendPresence: vi.fn() };
+ const unsubscribe = startMultiplayerPresenceSync(emitter);
+
+ await Promise.resolve();
+ emitter.sendPresence.mockClear();
+
+ awarenessTesting.$pointerPosition.set({
+ x: 1,
+ y: 2,
+ xRatio: 0.1,
+ yRatio: 0.2,
+ });
+ awarenessTesting.$pointerPosition.set({
+ x: 3,
+ y: 4,
+ xRatio: 0.3,
+ yRatio: 0.4,
+ });
+
+ expect(emitter.sendPresence).not.toHaveBeenCalled();
+ await Promise.resolve();
+
+ expect(emitter.sendPresence).toHaveBeenCalledTimes(1);
+ expect(emitter.sendPresence).toHaveBeenCalledWith({
+ pageId: undefined,
+ pointerPosition: { x: 3, y: 4, xRatio: 0.3, yRatio: 0.4 },
+ selectedInstanceIds: undefined,
+ });
+ unsubscribe();
+ });
+
+ test("does not send scheduled presence after unsubscribe", async () => {
+ const emitter = { sendPresence: vi.fn() };
+ const unsubscribe = startMultiplayerPresenceSync(emitter);
+
+ await Promise.resolve();
+ emitter.sendPresence.mockClear();
+
+ awarenessTesting.$pointerPosition.set({
+ x: 1,
+ y: 2,
+ xRatio: 0.1,
+ yRatio: 0.2,
+ });
+ unsubscribe();
+
+ await Promise.resolve();
+
+ expect(emitter.sendPresence).not.toHaveBeenCalled();
+ });
+});
diff --git a/apps/builder/app/shared/sync/multiplayer-sync.ts b/apps/builder/app/shared/sync/multiplayer-sync.ts
new file mode 100644
index 0000000000..d3c62b64bb
--- /dev/null
+++ b/apps/builder/app/shared/sync/multiplayer-sync.ts
@@ -0,0 +1,192 @@
+import { createNanoEvents } from "nanoevents";
+import {
+ $collaborators,
+ $syncStatus,
+ createMultiplayerRetryTracker,
+ type ApplyMessage,
+ type ErrorMessage,
+ type PresenceMessage,
+ type ReloadMessage,
+ type SyncEmitter,
+ type SyncMessage,
+} from "@webstudio-is/sync-client";
+import {
+ createWebSocketSyncEmitter,
+ type WebSocketEmitterOptions,
+ type WebSocketSyncEmitter,
+} from "@webstudio-is/sync-client/websocket";
+import { $awareness, type Awareness } from "~/shared/awareness";
+
+type MultiplayerSyncEmitterOptions = {
+ clientId: string;
+ getAuthToken?: () => Promise<string | undefined>;
+ url: string;
+ onReload?: (message: ReloadMessage) => void;
+ onUserMessage?: (message: string) => void;
+ createTransport?: (options: WebSocketEmitterOptions) => WebSocketSyncEmitter;
+};
+
+export type MultiplayerSyncEmitter = SyncEmitter & {
+ close(): void;
+ connect(buildId: string): void;
+ sendPresence(payload: Awareness): void;
+};
+
+const updateCollaborator = (clientId: string, payload: unknown) => {
+ const next = new Map($collaborators.get());
+ const previous = next.get(clientId);
+ next.set(clientId, {
+ ...previous,
+ ...(typeof payload === "object" && payload !== null ? payload : {}),
+ lastSeen: Date.now(),
+ });
+ $collaborators.set(next);
+};
+
+export const startMultiplayerPresenceSync = (
+ emitter: Pick<MultiplayerSyncEmitter, "sendPresence">
+) => {
+ return $awareness.listen((awareness) => {
+ emitter.sendPresence(awareness);
+ });
+};
+
+export const createMultiplayerSyncEmitter = ({
+ clientId,
+ getAuthToken,
+ url,
+ onReload,
+ onUserMessage,
+ createTransport = createWebSocketSyncEmitter,
+}: MultiplayerSyncEmitterOptions): MultiplayerSyncEmitter => {
+ const events = createNanoEvents<{
+ message: (message: SyncMessage) => void;
+ }>();
+ let clientSeq = 0;
+ let tracker: ReturnType<typeof createMultiplayerRetryTracker>;
+ let ws: WebSocketSyncEmitter | undefined;
+
+ const updateUnsaved = () => {
+ $syncStatus.set(
+ tracker.getPendingCount() > 0 ? { status: "syncing" } : { status: "idle" }
+ );
+ };
+
+ const sendApply = (message: ApplyMessage) => {
+ if (ws === undefined) {
+ return;
+ }
+ ws.sendToRelay(message);
+ };
+
+ const connect = (buildId: string) => {
+ if (ws !== undefined) {
+ return;
+ }
+ ws = createTransport({
+ buildId,
+ clientId,
+ getAuthToken,
+ url,
+ onAck: (seq, version) => {
+ tracker.handleAck({ type: "ack", seq, version });
+ updateUnsaved();
+ },
+ onApplied: (transactionId, seq, status, errors) => {
+ tracker.handleApplied({
+ type: "applied",
+ transactionId,
+ seq,
+ status,
+ errors,
+ });
+ updateUnsaved();
+ },
+ onBroadcast: (message) => {
+ tracker.handleBroadcast(message);
+ updateUnsaved();
+ events.emit("message", {
+ type: "apply",
+ clientId: message.originClientId,
+ transaction: message.transaction,
+ });
+ },
+ onClose: () => {},
+ onErrorMessage: (message: ErrorMessage) => {
+ tracker.handleErrorMessage(message);
+ updateUnsaved();
+ },
+ onOpen: () => {
+ tracker.handleReconnect();
+ },
+ onPresence: (presenceClientId, payload) => {
+ updateCollaborator(presenceClientId, payload);
+ },
+ onReload: (message) => {
+ tracker.handleReload(message);
+ updateUnsaved();
+ },
+ });
+ };
+
+ tracker = createMultiplayerRetryTracker({
+ onDropped: () => {
+ updateUnsaved();
+ },
+ onDurable: () => {
+ updateUnsaved();
+ },
+ onReload,
+ onUserMessage,
+ sendApply,
+ });
+
+ return {
+ close() {
+ tracker.destroy();
+ updateUnsaved();
+ ws?.close();
+ ws = undefined;
+ },
+ connect,
+ emit(message) {
+ // Preserve the regular in-browser SyncEmitter contract. The builder and
+ // canvas iframe still use this emitter for local state handshakes and
+ // client-only stores; multiplayer only adds remote relay for server patches.
+ events.emit("message", message);
+
+ if (message.type !== "apply") {
+ return;
+ }
+ if (message.transaction.object !== "server") {
+ return;
+ }
+
+ clientSeq += 1;
+ const applyMessage: ApplyMessage = {
+ type: "apply",
+ transactionId: message.transaction.id,
+ transaction: message.transaction,
+ clientId,
+ actorId: clientId,
+ clientSeq,
+ };
+ tracker.track(applyMessage);
+ updateUnsaved();
+ },
+ on(handler) {
+ return events.on("message", handler);
+ },
+ sendPresence(payload) {
+ const message: PresenceMessage = {
+ type: "presence",
+ clientId,
+ payload,
+ };
+ if (ws === undefined) {
+ return;
+ }
+ ws.sendToRelay(message);
+ },
+ };
+};
diff --git a/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts b/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts
new file mode 100644
index 0000000000..999316b8e3
--- /dev/null
+++ b/apps/builder/app/shared/sync/pages-patch-normalizer.test.ts
@@ -0,0 +1,242 @@
+import { describe, expect, test } from "vitest";
+import { enableMapSet } from "immer";
+import type { Pages } from "@webstudio-is/sdk";
+import {
+ normalizePagesPatch,
+ denormalizePagesPatch,
+} from "./pages-patch-normalizer";
+import type { Change } from "immerhin";
+
+enableMapSet();
+
+const makePages = (
+ pages: Array<{ id: string; name: string }> = [],
+ folders: Array<{ id: string; name: string }> = []
+): Pages =>
+ ({
+ homePage: {
+ id: "home",
+ name: "Home",
+ path: "",
+ title: "Home",
+ meta: {},
+ } as Pages["homePage"],
+ pages: pages.map((p) => ({
+ ...p,
+ path: `/${p.name.toLowerCase()}`,
+ title: p.name,
+ meta: {},
+ })) as Pages["pages"],
+ folders: folders.map((f) => ({
+ ...f,
+ slug: f.name.toLowerCase(),
+ children: [],
+ })) as Pages["folders"],
+ }) satisfies Pages;
+
+const makeChange = (
+ namespace: string,
+ patches: Change["patches"],
+ revisePatches: Change["revisePatches"] = []
+): Change => ({ namespace, patches, revisePatches });
+
+// normalizePagesPatch
+
+describe("normalizePagesPatch", () => {
+ test("replaces numeric index with encoded page id for replace op", () => {
+ const pages = makePages([
+ { id: "p1", name: "About" },
+ { id: "p2", name: "Contact" },
+ ]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["pages", 1, "name"], value: "Updated" },
+ ]),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", "@p2", "name"]);
+ });
+
+ test("replaces numeric index with encoded folder id for replace op", () => {
+ const pages = makePages([], [{ id: "f1", name: "Blog" }]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["folders", 0, "slug"], value: "news" },
+ ]),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["folders", "@f1", "slug"]);
+ });
+
+ test("encodes id from value for add op", () => {
+ const pages = makePages([{ id: "p1", name: "About" }]);
+ const newPage = {
+ id: "p2",
+ name: "New",
+ path: "/new",
+ title: "New",
+ meta: {},
+ };
+ const changes = [
+ makeChange("pages", [{ op: "add", path: ["pages", 1], value: newPage }]),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", "@p2"]);
+ expect(result[0].patches[0].value).toEqual(newPage);
+ });
+
+ test("encodes id from revise patch value for remove op", () => {
+ const pages = makePages([
+ { id: "p1", name: "About" },
+ { id: "p2", name: "Contact" },
+ ]);
+ const removedPage = {
+ id: "p2",
+ name: "Contact",
+ path: "/contact",
+ title: "Contact",
+ meta: {},
+ };
+ const changes = [
+ makeChange(
+ "pages",
+ [{ op: "remove", path: ["pages", 1] }],
+ [{ op: "add", path: ["pages", 1], value: removedPage }]
+ ),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", "@p2"]);
+ });
+
+ test("leaves non-pages namespace unchanged", () => {
+ const pages = makePages([{ id: "p1", name: "About" }]);
+ const changes = [
+ makeChange("instances", [
+ { op: "replace", path: [0, "type"], value: "div" },
+ ]),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual([0, "type"]);
+ });
+
+ test("leaves already-string-indexed path unchanged", () => {
+ const pages = makePages([{ id: "p1", name: "About" }]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["homePage", "name"], value: "Home" },
+ ]),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["homePage", "name"]);
+ });
+
+ test("normalizes revise patches symmetrically", () => {
+ const pages = makePages([
+ { id: "p1", name: "About" },
+ { id: "p2", name: "Contact" },
+ ]);
+ const changes = [
+ makeChange(
+ "pages",
+ [{ op: "replace", path: ["pages", 1, "name"], value: "Updated" }],
+ [{ op: "replace", path: ["pages", 1, "name"], value: "Contact" }]
+ ),
+ ];
+ const result = normalizePagesPatch(changes, pages);
+ expect(result[0].revisePatches[0].path).toEqual(["pages", "@p2", "name"]);
+ });
+});
+
+// denormalizePagesPatch
+
+describe("denormalizePagesPatch", () => {
+ test("converts encoded page id back to current index", () => {
+ const pages = makePages([
+ { id: "p1", name: "About" },
+ { id: "p2", name: "Contact" },
+ ]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["pages", "@p2", "name"], value: "Updated" },
+ ]),
+ ];
+ const result = denormalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", 1, "name"]);
+ });
+
+ test("converts to current index even when order differs from sender", () => {
+ // Receiver has reversed order vs sender
+ const pages = makePages([
+ { id: "p2", name: "Contact" },
+ { id: "p1", name: "About" },
+ ]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["pages", "@p1", "name"], value: "Updated" },
+ ]),
+ ];
+ const result = denormalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", 1, "name"]);
+ });
+
+ test("uses append-to-end index for add op", () => {
+ const pages = makePages([{ id: "p1", name: "About" }]);
+ const newPage = {
+ id: "p2",
+ name: "New",
+ path: "/new",
+ title: "New",
+ meta: {},
+ };
+ const changes = [
+ makeChange("pages", [
+ { op: "add", path: ["pages", "@p2"], value: newPage },
+ ]),
+ ];
+ const result = denormalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["pages", 1]);
+ });
+
+ test("leaves path unchanged when page id not found (stale patch)", () => {
+ const pages = makePages([{ id: "p1", name: "About" }]);
+ const changes = [
+ makeChange("pages", [
+ { op: "replace", path: ["pages", "@deleted", "name"], value: "X" },
+ ]),
+ ];
+ const result = denormalizePagesPatch(changes, pages);
+ // Unchanged - Immer applyPatches will fail gracefully and leader drops it
+ expect(result[0].patches[0].path).toEqual(["pages", "@deleted", "name"]);
+ });
+
+ test("leaves non-pages namespace unchanged", () => {
+ const pages = makePages([]);
+ const changes = [
+ makeChange("instances", [
+ { op: "replace", path: ["@some-id", "type"], value: "div" },
+ ]),
+ ];
+ const result = denormalizePagesPatch(changes, pages);
+ expect(result[0].patches[0].path).toEqual(["@some-id", "type"]);
+ });
+
+ test("roundtrip: normalize then denormalize is identity for replace", () => {
+ const pages = makePages([
+ { id: "p1", name: "About" },
+ { id: "p2", name: "Contact" },
+ ]);
+ const original: Change[] = [
+ makeChange(
+ "pages",
+ [{ op: "replace", path: ["pages", 1, "name"], value: "Updated" }],
+ [{ op: "replace", path: ["pages", 1, "name"], value: "Contact" }]
+ ),
+ ];
+ const normalized = normalizePagesPatch(original, pages);
+ const restored = denormalizePagesPatch(normalized, pages);
+ expect(restored[0].patches[0].path).toEqual(original[0].patches[0].path);
+ expect(restored[0].revisePatches[0].path).toEqual(
+ original[0].revisePatches[0].path
+ );
+ });
+});
diff --git a/apps/builder/app/shared/sync/pages-patch-normalizer.ts b/apps/builder/app/shared/sync/pages-patch-normalizer.ts
new file mode 100644
index 0000000000..ccebb547fa
--- /dev/null
+++ b/apps/builder/app/shared/sync/pages-patch-normalizer.ts
@@ -0,0 +1,161 @@
+import type { Patch } from "immer";
+import type { Change } from "immerhin";
+import type { Folder, Page, Pages } from "@webstudio-is/sdk";
+
+// Sentinel prefix used to distinguish ID-based path segments from numeric indices
+// on the wire. Kept as a plain string so patches stay JSON-serializable.
+const ID_PREFIX = "@";
+
+const encodeId = (id: string) => `${ID_PREFIX}${id}`;
+const decodeId = (seg: string): string | undefined =>
+ seg.startsWith(ID_PREFIX) ? seg.slice(ID_PREFIX.length) : undefined;
+
+const isIdSegment = (seg: string | number): seg is string =>
+ typeof seg === "string" && seg.startsWith(ID_PREFIX);
+
+const normalizeOnePatch = (
+ patch: Patch,
+ revisePatches: Patch[],
+ pages: Pages
+): Patch => {
+ const [key, indexOrId, ...rest] = patch.path;
+ if (typeof indexOrId !== "number") {
+ return patch;
+ }
+ if (key !== "pages" && key !== "folders") {
+ return patch;
+ }
+
+ const items: Array<Page | Folder> =
+ key === "pages" ? pages.pages : pages.folders;
+
+ if (patch.op === "add") {
+ const id = (patch.value as { id?: string } | undefined)?.id;
+ if (!id) {
+ return patch;
+ }
+ return { ...patch, path: [key, encodeId(id), ...rest] };
+ }
+
+ if (patch.op === "remove") {
+ const rp = revisePatches.find(
+ (r) => r.op === "add" && r.path[0] === key && r.path[1] === indexOrId
+ );
+ const id = (rp?.value as { id?: string } | undefined)?.id;
+ if (!id) {
+ return patch;
+ }
+ return { ...patch, path: [key, encodeId(id), ...rest] };
+ }
+
+ const id = (items[indexOrId] as { id?: string } | undefined)?.id;
+ if (!id) {
+ return patch;
+ }
+ return { ...patch, path: [key, encodeId(id), ...rest] };
+};
+
+const normalizeRevise = (
+ rp: Patch,
+ forwardPatches: Patch[],
+ pages: Pages
+): Patch => {
+ const [key, indexOrId, ...rest] = rp.path;
+ if (typeof indexOrId !== "number") {
+ return rp;
+ }
+ if (key !== "pages" && key !== "folders") {
+ return rp;
+ }
+
+ const items: Array<Page | Folder> =
+ key === "pages" ? pages.pages : pages.folders;
+
+ if (rp.op === "add") {
+ const id = (rp.value as { id?: string } | undefined)?.id;
+ if (!id) {
+ return rp;
+ }
+ return { ...rp, path: [key, encodeId(id), ...rest] };
+ }
+
+ if (rp.op === "remove") {
+ const fp = forwardPatches.find(
+ (f) => f.op === "add" && f.path[0] === key && f.path[1] === indexOrId
+ );
+ const id = (fp?.value as { id?: string } | undefined)?.id;
+ if (!id) {
+ return rp;
+ }
+ return { ...rp, path: [key, encodeId(id), ...rest] };
+ }
+
+ const id = (items[indexOrId] as { id?: string } | undefined)?.id;
+ if (!id) {
+ return rp;
+ }
+ return { ...rp, path: [key, encodeId(id), ...rest] };
+};
+
+export const normalizePagesPatch = (
+ changes: Change[],
+ pagesState: Pages
+): Change[] =>
+ changes.map((change) => {
+ if (change.namespace !== "pages") {
+ return change;
+ }
+ return {
+ ...change,
+ patches: change.patches.map((p) =>
+ normalizeOnePatch(p, change.revisePatches, pagesState)
+ ),
+ revisePatches: change.revisePatches.map((rp) =>
+ normalizeRevise(rp, change.patches, pagesState)
+ ),
+ };
+ });
+
+const denormalizeOnePatch = (patch: Patch, pages: Pages): Patch => {
+ const [key, indexOrId, ...rest] = patch.path;
+ if (!isIdSegment(indexOrId as string | number)) {
+ return patch;
+ }
+ if (key !== "pages" && key !== "folders") {
+ return patch;
+ }
+
+ const id = decodeId(indexOrId as string)!;
+ const items: Array<Page | Folder> =
+ key === "pages" ? pages.pages : pages.folders;
+
+ if (patch.op === "add") {
+ // Insert at end - exact position doesn't matter for concurrent adds
+ return { ...patch, path: [key, items.length, ...rest] };
+ }
+
+ const idx = items.findIndex((item) => item.id === id);
+ if (idx === -1) {
+ // Item not found; return patch unchanged - the apply will fail gracefully
+ // (leader drops stale patches, followers silently ignore missing paths)
+ return patch;
+ }
+ return { ...patch, path: [key, idx, ...rest] };
+};
+
+export const denormalizePagesPatch = (
+ changes: Change[],
+ currentState: Pages
+): Change[] =>
+ changes.map((change) => {
+ if (change.namespace !== "pages") {
+ return change;
+ }
+ return {
+ ...change,
+ patches: change.patches.map((p) => denormalizeOnePatch(p, currentState)),
+ revisePatches: change.revisePatches.map((rp) =>
+ denormalizeOnePatch(rp, currentState)
+ ),
+ };
+ });
diff --git a/apps/builder/app/shared/sync/patch/patch-auth.server.test.ts b/apps/builder/app/shared/sync/patch/patch-auth.server.test.ts
new file mode 100644
index 0000000000..eb24165a37
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-auth.server.test.ts
@@ -0,0 +1,189 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+const hasProjectPermit = vi.hoisted(() => vi.fn());
+const readAccessToken = vi.hoisted(() => vi.fn());
+
+vi.mock("@webstudio-is/trpc-interface/index.server", () => {
+ class AuthorizationError extends Error {}
+ return {
+ AuthorizationError,
+ authorizeProject: { hasProjectPermit },
+ };
+});
+
+vi.mock("@webstudio-is/project/index.server", () => ({
+ getRequiredPermitForBuildPatchTransaction: (transaction: {
+ payload: Array<{ namespace: string }>;
+ }) =>
+ transaction.payload.some((change) => change.namespace === "styles")
+ ? "build"
+ : "edit",
+}));
+
+vi.mock("~/env/env.server", () => ({
+ default: {
+ AUTH_WS_CLIENT_SECRET: "secret",
+ },
+}));
+
+vi.mock("~/services/token.server", () => ({
+ readAccessToken,
+}));
+
+import {
+ authorizePatchEntries,
+ createWriterContext,
+} from "./patch-auth.server";
+import type { NormalizedPatchRequest } from "./patch-normalize.server";
+
+const createContext = () => {
+ const context = {
+ authorization: { type: "anonymous" },
+ createTokenContext: vi.fn(async (authToken: string) => ({
+ authorization: { type: "token", authToken },
+ })),
+ };
+ return context;
+};
+
+const transaction = (namespace: string, id = `tx-${namespace}`) => ({
+ id,
+ payload: [{ namespace, patches: [{ op: "replace", path: ["x"], value: 1 }] }],
+});
+
+describe("createWriterContext", () => {
+ beforeEach(() => {
+ readAccessToken.mockReset();
+ });
+
+ test("rejects empty and legacy session tokens", async () => {
+ const context = createContext();
+
+ await expect(createWriterContext(context as never, "")).rejects.toThrow(
+ "Collab writer token is not authorized"
+ );
+ await expect(
+ createWriterContext(context as never, "session")
+ ).rejects.toThrow("Collab writer token is not authorized");
+ });
+
+ test("creates a user context from a signed collab token", async () => {
+ readAccessToken.mockResolvedValue({
+ userId: "user-1",
+ projectId: "project-1",
+ });
+
+ const writerContext = await createWriterContext(
+ createContext() as never,
+ "signed-token"
+ );
+
+ expect(writerContext.authorization).toMatchObject({
+ type: "user",
+ userId: "user-1",
+ });
+ const authorization = writerContext.authorization as {
+ isLoggedInToBuilder: (projectId: string) => Promise<boolean>;
+ };
+ expect(await authorization.isLoggedInToBuilder("project-1")).toBe(true);
+ expect(await authorization.isLoggedInToBuilder("project-2")).toBe(false);
+ });
+
+ test("falls back to the shared-link token context", async () => {
+ readAccessToken.mockResolvedValue(undefined);
+ const context = createContext();
+
+ const writerContext = await createWriterContext(
+ context as never,
+ "shared-link-token"
+ );
+
+ expect(context.createTokenContext).toHaveBeenCalledWith(
+ "shared-link-token"
+ );
+ expect(writerContext.authorization).toEqual({
+ type: "token",
+ authToken: "shared-link-token",
+ });
+ });
+});
+
+describe("authorizePatchEntries", () => {
+ beforeEach(() => {
+ hasProjectPermit.mockReset();
+ readAccessToken.mockReset();
+ });
+
+ test("checks every transaction with its own writer and required permit", async () => {
+ readAccessToken
+ .mockResolvedValueOnce({ userId: "user-1", projectId: "project-1" })
+ .mockResolvedValueOnce({ userId: "user-2", projectId: "project-1" });
+ hasProjectPermit.mockResolvedValue(true);
+ const context = createContext();
+ const patch: NormalizedPatchRequest = {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 1,
+ entries: [
+ {
+ transaction: transaction("props") as never,
+ writer: { type: "token", authToken: "token-1" },
+ },
+ {
+ transaction: transaction("styles") as never,
+ writer: { type: "token", authToken: "token-2" },
+ },
+ ],
+ };
+
+ const result = await authorizePatchEntries(context as never, patch);
+
+ expect(result.rejected).toEqual([]);
+ expect(result.authorized[0].context.authorization).toMatchObject({
+ type: "user",
+ userId: "user-1",
+ });
+ expect(hasProjectPermit).toHaveBeenCalledTimes(2);
+ expect(hasProjectPermit).toHaveBeenNthCalledWith(
+ 1,
+ { projectId: "project-1", permit: "edit" },
+ expect.objectContaining({
+ authorization: expect.objectContaining({ userId: "user-1" }),
+ })
+ );
+ expect(hasProjectPermit).toHaveBeenNthCalledWith(
+ 2,
+ { projectId: "project-1", permit: "build" },
+ expect.objectContaining({
+ authorization: expect.objectContaining({ userId: "user-2" }),
+ })
+ );
+ });
+
+ test("returns rejected entries when a writer does not have the required permit", async () => {
+ readAccessToken.mockResolvedValue({
+ userId: "user-1",
+ projectId: "project-1",
+ });
+ hasProjectPermit.mockResolvedValue(false);
+
+ const result = await authorizePatchEntries(createContext() as never, {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 1,
+ entries: [
+ {
+ transaction: transaction("styles") as never,
+ writer: { type: "token", authToken: "token-1" },
+ },
+ ],
+ });
+
+ expect(result.authorized).toEqual([]);
+ expect(result.rejected).toEqual([
+ expect.objectContaining({
+ errors: "You don't have permission to build this project.",
+ }),
+ ]);
+ });
+});
diff --git a/apps/builder/app/shared/sync/patch/patch-auth.server.ts b/apps/builder/app/shared/sync/patch/patch-auth.server.ts
new file mode 100644
index 0000000000..966c7d95f1
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-auth.server.ts
@@ -0,0 +1,115 @@
+import {
+ AuthorizationError,
+ authorizeProject,
+ type AppContext,
+ type AuthPermit,
+} from "@webstudio-is/trpc-interface/index.server";
+import { getRequiredPermitForBuildPatchTransaction } from "@webstudio-is/project/index.server";
+import env from "~/env/env.server";
+import { readAccessToken } from "~/services/token.server";
+import type {
+ NormalizedPatchRequest,
+ PatchEntry,
+} from "./patch-normalize.server";
+
+export type AuthorizedPatchEntry = {
+ entry: PatchEntry;
+ context: AppContext;
+};
+
+export type RejectedPatchEntry = {
+ entry: PatchEntry;
+ errors: string;
+};
+
+export const createWriterContext = async (
+ context: AppContext,
+ authToken: string
+) => {
+ if (authToken.length === 0 || authToken === "session") {
+ throw new AuthorizationError("Collab writer token is not authorized");
+ }
+ try {
+ const accessToken = await readAccessToken(
+ authToken,
+ env.AUTH_WS_CLIENT_SECRET
+ );
+ if (accessToken !== undefined) {
+ return {
+ ...context,
+ authorization: {
+ type: "user" as const,
+ userId: accessToken.userId,
+ sessionCreatedAt: 0,
+ isLoggedInToBuilder: async (projectId: string) =>
+ projectId === accessToken.projectId,
+ },
+ };
+ }
+ } catch {
+ // Not a signed collab token; try the existing shared-link token flow.
+ }
+ return context.createTokenContext(authToken);
+};
+
+const resolveEntryWriterContext = async (
+ context: AppContext,
+ entry: PatchEntry
+) => {
+ if (entry.writer.type === "context") {
+ return entry.writer.context;
+ }
+ return createWriterContext(context, entry.writer.authToken);
+};
+
+export const assertProjectPermit = async ({
+ context,
+ permit,
+ projectId,
+}: {
+ context: AppContext;
+ permit: AuthPermit;
+ projectId: string;
+}) => {
+ const allowed = await authorizeProject.hasProjectPermit(
+ { projectId, permit },
+ context
+ );
+ if (allowed === false) {
+ throw new AuthorizationError(
+ `You don't have permission to ${permit === "build" ? "build" : "edit"} this project.`
+ );
+ }
+};
+
+export const authorizePatchEntries = async (
+ context: AppContext,
+ patch: NormalizedPatchRequest
+) => {
+ const authorized: AuthorizedPatchEntry[] = [];
+ const rejected: RejectedPatchEntry[] = [];
+
+ for (const entry of patch.entries) {
+ try {
+ const writerContext = await resolveEntryWriterContext(context, entry);
+ await assertProjectPermit({
+ context: writerContext,
+ permit: getRequiredPermitForBuildPatchTransaction(entry.transaction),
+ projectId: patch.projectId,
+ });
+ authorized.push({ entry, context: writerContext });
+ } catch (error) {
+ if (error instanceof AuthorizationError) {
+ rejected.push({ entry, errors: error.message });
+ continue;
+ }
+ throw error;
+ }
+ }
+
+ if (authorized.length === 0 && rejected.length === 0) {
+ throw new Error("Transaction entries required");
+ }
+
+ return { authorized, rejected };
+};
diff --git a/apps/builder/app/shared/sync/patch/patch-normalize.server.test.ts b/apps/builder/app/shared/sync/patch/patch-normalize.server.test.ts
new file mode 100644
index 0000000000..025fa8717e
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-normalize.server.test.ts
@@ -0,0 +1,140 @@
+import { describe, expect, test } from "vitest";
+import {
+ normalizePatchRequest,
+ type PatchData,
+} from "./patch-normalize.server";
+
+const transaction = {
+ id: "tx-1",
+ object: "server",
+ payload: [{ namespace: "props", patches: [] }],
+};
+
+describe("normalizePatchRequest", () => {
+ test("normalizes browser transactions into per-transaction entries with the current context", () => {
+ const context = { authorization: { type: "user", userId: "user-1" } };
+ const data: PatchData = {
+ buildId: "build-1",
+ projectId: "project-1",
+ version: 3,
+ entries: [{ transaction }],
+ };
+
+ expect(
+ normalizePatchRequest(data, () => ({
+ type: "context",
+ context: context as never,
+ }))
+ ).toEqual({
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ entries: [
+ {
+ transaction,
+ writer: { type: "context", context: context as never },
+ },
+ ],
+ });
+ });
+
+ test("strips revise patches from normalized transactions", () => {
+ const data = {
+ buildId: "build-1",
+ projectId: "project-1",
+ version: 3,
+ entries: [
+ {
+ transaction: {
+ id: "tx-1",
+ payload: [
+ {
+ namespace: "props",
+ patches: [],
+ revisePatches: [{ op: "remove", path: ["x"] }],
+ },
+ ],
+ },
+ },
+ ],
+ };
+
+ expect(
+ normalizePatchRequest(data as never, () => ({
+ type: "context",
+ context: {} as never,
+ })).entries[0].transaction
+ ).toEqual({
+ id: "tx-1",
+ payload: [{ namespace: "props", patches: [] }],
+ });
+ });
+
+ test("requires entries", () => {
+ expect(() =>
+ normalizePatchRequest(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ version: 3,
+ } as PatchData,
+ () => ({ type: "context", context: {} as never })
+ )
+ ).toThrow("Transaction entries required");
+ });
+
+ test("normalizes relay entries with per-entry writer tokens", () => {
+ const data = {
+ buildId: "build-1",
+ projectId: "project-1",
+ version: 3,
+ entries: [
+ {
+ seq: 1,
+ authToken: "token-1",
+ transaction,
+ },
+ {
+ authToken: "token-2",
+ transaction: { ...transaction, id: "tx-2" },
+ },
+ ],
+ };
+
+ expect(
+ normalizePatchRequest(data, (entry) => ({
+ type: "token",
+ authToken: entry.authToken,
+ }))
+ ).toEqual({
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ entries: [
+ {
+ seq: 1,
+ transaction,
+ writer: { type: "token", authToken: "token-1" },
+ },
+ {
+ transaction: { ...transaction, id: "tx-2" },
+ writer: { type: "token", authToken: "token-2" },
+ },
+ ],
+ });
+ });
+
+ test("requires non-empty entries", () => {
+ expect(() =>
+ normalizePatchRequest(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ version: 3,
+ entries: [],
+ },
+ () => ({ type: "context", context: {} as never })
+ )
+ ).toThrow("Transaction entries required");
+ });
+});
diff --git a/apps/builder/app/shared/sync/patch/patch-normalize.server.ts b/apps/builder/app/shared/sync/patch/patch-normalize.server.ts
new file mode 100644
index 0000000000..5010c39947
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-normalize.server.ts
@@ -0,0 +1,80 @@
+import type { Project } from "@webstudio-is/project";
+import type { BuildPatchTransaction } from "@webstudio-is/project/index.server";
+import type { Build } from "@webstudio-is/project-build";
+import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
+
+export type PatchWriter =
+ | { type: "context"; context: AppContext }
+ | { type: "token"; authToken: string };
+
+export type PatchDataEntry = {
+ seq?: number;
+ transaction: BuildPatchTransaction;
+};
+
+export type PatchEntry = {
+ seq?: number;
+ transaction: BuildPatchTransaction;
+ writer: PatchWriter;
+};
+
+export type NormalizedPatchRequest = {
+ buildId: Build["id"];
+ projectId: Project["id"];
+ clientVersion: number;
+ entries: PatchEntry[];
+};
+
+export type PatchData<Entry extends PatchDataEntry = PatchDataEntry> = {
+ buildId: string;
+ projectId: string;
+ version: number;
+ entries: Entry[];
+};
+
+const stripRevisePatchesFromPatchTransaction = (
+ transaction: BuildPatchTransaction
+): BuildPatchTransaction => {
+ let changed = false;
+ const payload = transaction.payload.map((change) => {
+ if (Object.hasOwn(change, "revisePatches") === false) {
+ return change;
+ }
+ changed = true;
+ const { revisePatches: _revisePatches, ...rest } =
+ change as typeof change & {
+ revisePatches?: unknown;
+ };
+ return rest;
+ });
+
+ if (changed === false) {
+ return transaction;
+ }
+ return { ...transaction, payload };
+};
+
+export const normalizePatchRequest = <Entry extends PatchDataEntry>(
+ data: PatchData<Entry>,
+ getWriter: (entry: Entry) => PatchWriter
+): NormalizedPatchRequest => {
+ if (data.buildId === undefined) {
+ throw new Error("Build id required");
+ }
+ if (data.projectId === undefined) {
+ throw new Error("Project id required");
+ }
+ if (Array.isArray(data.entries) === false || data.entries.length === 0) {
+ throw new Error("Transaction entries required");
+ }
+ return {
+ buildId: data.buildId,
+ projectId: data.projectId,
+ clientVersion: data.version,
+ entries: data.entries.map((entry) => ({
+ seq: entry.seq,
+ transaction: stripRevisePatchesFromPatchTransaction(entry.transaction),
+ writer: getWriter(entry),
+ })),
+ };
+};
diff --git a/apps/builder/app/shared/sync/patch/patch-service.server.test.ts b/apps/builder/app/shared/sync/patch/patch-service.server.test.ts
new file mode 100644
index 0000000000..474477f1b8
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-service.server.test.ts
@@ -0,0 +1,237 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+
+const patchBuild = vi.hoisted(() => vi.fn());
+const authorizePatchEntries = vi.hoisted(() => vi.fn());
+
+vi.mock("@webstudio-is/project/index.server", () => ({
+ patchBuild,
+}));
+
+vi.mock("./patch-auth.server", () => ({
+ assertProjectPermit: vi.fn(),
+ authorizePatchEntries,
+ createWriterContext: vi.fn(),
+}));
+
+import { applyPatchRequest } from "./patch-service.server";
+import type { NormalizedPatchRequest } from "./patch-normalize.server";
+
+const createContext = () =>
+ ({
+ postgrest: {
+ client: {
+ from: () => ({
+ select: () => ({
+ eq: () => ({
+ single: async () => ({
+ data: { projectId: "project-1", version: 3 },
+ error: undefined,
+ }),
+ }),
+ }),
+ }),
+ },
+ },
+ }) as never;
+
+const transaction = (id: string) => ({
+ id,
+ payload: [{ namespace: "props", patches: [] }],
+});
+
+const patch: NormalizedPatchRequest = {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ entries: [
+ {
+ seq: 1,
+ transaction: transaction("tx-1") as never,
+ writer: { type: "token", authToken: "token-1" },
+ },
+ {
+ seq: 2,
+ transaction: transaction("tx-2") as never,
+ writer: { type: "token", authToken: "token-2" },
+ },
+ ],
+};
+
+describe("applyPatchRequest", () => {
+ beforeEach(() => {
+ patchBuild.mockReset();
+ authorizePatchEntries.mockReset();
+ });
+
+ test("returns per-entry partial results while applying authorized entries", async () => {
+ authorizePatchEntries.mockResolvedValue({
+ authorized: [{ entry: patch.entries[1], context: { writer: 2 } }],
+ rejected: [
+ {
+ entry: patch.entries[0],
+ errors: "You don't have permission to edit this project.",
+ },
+ ],
+ });
+ patchBuild.mockResolvedValue({ status: "ok", version: 4 });
+
+ const result = await applyPatchRequest(createContext(), patch);
+
+ expect(patchBuild).toHaveBeenCalledWith(
+ expect.objectContaining({
+ transactions: [patch.entries[1].transaction],
+ }),
+ { writer: 2 }
+ );
+ expect(result).toEqual({
+ status: "partial",
+ version: 4,
+ entries: [
+ {
+ seq: 1,
+ transactionId: "tx-1",
+ status: "rejected",
+ errors: "You don't have permission to edit this project.",
+ },
+ { seq: 2, transactionId: "tx-2", status: "accepted" },
+ ],
+ });
+ });
+
+ test("falls back to per-entry apply when a mixed authorized batch fails", async () => {
+ const context = { writer: 1 };
+ authorizePatchEntries.mockResolvedValue({
+ authorized: [
+ { entry: patch.entries[0], context },
+ { entry: patch.entries[1], context },
+ ],
+ rejected: [],
+ });
+ patchBuild
+ .mockResolvedValueOnce({ status: "error", errors: "batch failed" })
+ .mockResolvedValueOnce({ status: "ok", version: 4 })
+ .mockResolvedValueOnce({ status: "error", errors: "entry failed" });
+
+ const result = await applyPatchRequest(createContext(), patch);
+
+ expect(result).toEqual({
+ status: "partial",
+ version: 4,
+ entries: [
+ { seq: 1, transactionId: "tx-1", status: "accepted" },
+ {
+ seq: 2,
+ transactionId: "tx-2",
+ status: "failed",
+ errors: "entry failed",
+ },
+ ],
+ });
+ });
+
+ test("applies mixed writer entries with their own context without batching", async () => {
+ authorizePatchEntries.mockResolvedValue({
+ authorized: [
+ { entry: patch.entries[0], context: { writer: 1 } },
+ { entry: patch.entries[1], context: { writer: 2 } },
+ ],
+ rejected: [],
+ });
+ patchBuild
+ .mockResolvedValueOnce({ status: "ok", version: 4 })
+ .mockResolvedValueOnce({ status: "ok", version: 5 });
+
+ const result = await applyPatchRequest(createContext(), patch);
+
+ expect(patchBuild).toHaveBeenCalledTimes(2);
+ expect(patchBuild).toHaveBeenNthCalledWith(
+ 1,
+ expect.objectContaining({
+ clientVersion: 3,
+ transactions: [patch.entries[0].transaction],
+ }),
+ { writer: 1 }
+ );
+ expect(patchBuild).toHaveBeenNthCalledWith(
+ 2,
+ expect.objectContaining({
+ clientVersion: 4,
+ transactions: [patch.entries[1].transaction],
+ }),
+ { writer: 2 }
+ );
+ expect(result).toEqual({
+ status: "ok",
+ version: 5,
+ entries: [
+ { seq: 1, transactionId: "tx-1", status: "accepted" },
+ { seq: 2, transactionId: "tx-2", status: "accepted" },
+ ],
+ });
+ });
+
+ test("preserves entry order when transaction ids are duplicated", async () => {
+ const duplicatePatch: NormalizedPatchRequest = {
+ ...patch,
+ entries: [
+ {
+ seq: 1,
+ transaction: transaction("tx-duplicate") as never,
+ writer: { type: "token", authToken: "token-1" },
+ },
+ {
+ seq: 2,
+ transaction: transaction("tx-duplicate") as never,
+ writer: { type: "token", authToken: "token-2" },
+ },
+ ],
+ };
+ authorizePatchEntries.mockResolvedValue({
+ authorized: [
+ { entry: duplicatePatch.entries[1], context: { writer: 2 } },
+ ],
+ rejected: [
+ {
+ entry: duplicatePatch.entries[0],
+ errors: "You don't have permission to edit this project.",
+ },
+ ],
+ });
+ patchBuild.mockResolvedValue({ status: "ok", version: 4 });
+
+ const result = await applyPatchRequest(createContext(), duplicatePatch);
+
+ expect(result).toEqual({
+ status: "partial",
+ version: 4,
+ entries: [
+ {
+ seq: 1,
+ transactionId: "tx-duplicate",
+ status: "rejected",
+ errors: "You don't have permission to edit this project.",
+ },
+ { seq: 2, transactionId: "tx-duplicate", status: "accepted" },
+ ],
+ });
+ });
+
+ test("does not convert thrown per-entry persistence errors into terminal entry failures", async () => {
+ const context = { writer: 1 };
+ authorizePatchEntries.mockResolvedValue({
+ authorized: [
+ { entry: patch.entries[0], context },
+ { entry: patch.entries[1], context },
+ ],
+ rejected: [],
+ });
+ patchBuild
+ .mockResolvedValueOnce({ status: "error", errors: "batch failed" })
+ .mockResolvedValueOnce({ status: "ok", version: 4 })
+ .mockRejectedValueOnce(new Error("PostgREST unavailable"));
+
+ await expect(applyPatchRequest(createContext(), patch)).rejects.toThrow(
+ "PostgREST unavailable"
+ );
+ });
+});
diff --git a/apps/builder/app/shared/sync/patch/patch-service.server.ts b/apps/builder/app/shared/sync/patch/patch-service.server.ts
new file mode 100644
index 0000000000..b87697b60c
--- /dev/null
+++ b/apps/builder/app/shared/sync/patch/patch-service.server.ts
@@ -0,0 +1,251 @@
+import {
+ AuthorizationError,
+ type AppContext,
+} from "@webstudio-is/trpc-interface/index.server";
+import { patchBuild } from "@webstudio-is/project/index.server";
+import {
+ assertProjectPermit,
+ authorizePatchEntries,
+ createWriterContext,
+ type AuthorizedPatchEntry,
+} from "./patch-auth.server";
+import type {
+ NormalizedPatchRequest,
+ PatchEntry,
+} from "./patch-normalize.server";
+
+export type PatchEntryResult =
+ | { seq?: number; transactionId: string; status: "accepted" }
+ | {
+ seq?: number;
+ transactionId: string;
+ status: "rejected" | "failed";
+ errors: string;
+ };
+
+export type PatchResult =
+ | { status: "ok"; version?: number; entries?: PatchEntryResult[] }
+ | { status: "partial"; version: number; entries: PatchEntryResult[] }
+ | { status: "version_mismatched"; errors: string }
+ | { status: "authorization_error"; errors: string }
+ | { status: "error"; errors: string };
+
+export const toPatchResult = async (error: unknown): Promise<PatchResult> => {
+ if (error instanceof AuthorizationError) {
+ return {
+ status: "authorization_error",
+ errors: error.message,
+ };
+ }
+
+ if (error instanceof Response && error.ok === false) {
+ return {
+ status: "authorization_error",
+ errors: error.statusText,
+ };
+ }
+
+ if (error instanceof Response) {
+ return {
+ status: "error",
+ errors: await error.text(),
+ };
+ }
+
+ console.error(error);
+ return {
+ status: "error",
+ errors: error instanceof Error ? error.message : JSON.stringify(error),
+ };
+};
+
+const loadBuildState = async (context: AppContext, buildId: string) => {
+ const build = await context.postgrest.client
+ .from("Build")
+ .select("projectId, version")
+ .eq("id", buildId)
+ .single();
+
+ if (build.error) {
+ throw build.error;
+ }
+
+ return {
+ projectId: String(build.data.projectId),
+ version: Number(build.data.version),
+ };
+};
+
+const assertBuildProject = async (
+ context: AppContext,
+ patch: Pick<NormalizedPatchRequest, "buildId" | "projectId">
+) => {
+ const state = await loadBuildState(context, patch.buildId);
+ if (state.projectId !== patch.projectId) {
+ throw new Error("Build does not belong to project");
+ }
+ return state;
+};
+
+const acceptedResult = (entry: PatchEntry): PatchEntryResult => ({
+ seq: entry.seq,
+ transactionId: entry.transaction.id,
+ status: "accepted",
+});
+
+const failedResult = (entry: PatchEntry, errors: string): PatchEntryResult => ({
+ seq: entry.seq,
+ transactionId: entry.transaction.id,
+ status: "failed",
+ errors,
+});
+
+const rejectedResult = ({
+ entry,
+ errors,
+}: {
+ entry: PatchEntry;
+ errors: string;
+}): PatchEntryResult => ({
+ seq: entry.seq,
+ transactionId: entry.transaction.id,
+ status: "rejected",
+ errors,
+});
+
+const applyAuthorizedEntries = async ({
+ authorized,
+ patch,
+ version,
+}: {
+ authorized: AuthorizedPatchEntry[];
+ patch: NormalizedPatchRequest;
+ version: number;
+}) => {
+ if (authorized.length === 0) {
+ return {
+ version,
+ entries: [] satisfies PatchEntryResult[],
+ status: "ok" as const,
+ };
+ }
+
+ const applyContext = authorized[0].context;
+ const hasSharedContext = authorized.every(
+ ({ context }) => context === applyContext
+ );
+
+ if (hasSharedContext) {
+ const batchResult = await patchBuild(
+ {
+ buildId: patch.buildId,
+ projectId: patch.projectId,
+ clientVersion: version,
+ transactions: authorized.map(({ entry }) => entry.transaction),
+ },
+ applyContext
+ );
+
+ if (batchResult.status === "ok") {
+ return {
+ status: "ok" as const,
+ version: batchResult.version,
+ entries: authorized.map(({ entry }) => acceptedResult(entry)),
+ };
+ }
+
+ if (batchResult.status === "version_mismatched") {
+ return batchResult;
+ }
+ }
+
+ const entries: PatchEntryResult[] = [];
+ let currentVersion = version;
+
+ for (const { entry, context: entryContext } of authorized) {
+ const entryResult = await patchBuild(
+ {
+ buildId: patch.buildId,
+ projectId: patch.projectId,
+ clientVersion: currentVersion,
+ transactions: [entry.transaction],
+ },
+ entryContext
+ );
+
+ if (entryResult.status === "ok") {
+ currentVersion = entryResult.version;
+ entries.push(acceptedResult(entry));
+ continue;
+ }
+ if (entryResult.status === "version_mismatched") {
+ return entryResult;
+ }
+ entries.push(failedResult(entry, entryResult.errors));
+ }
+
+ return {
+ status: "partial" as const,
+ version: currentVersion,
+ entries,
+ };
+};
+
+export const applyPatchRequest = async (
+ context: AppContext,
+ patch: NormalizedPatchRequest
+): Promise<PatchResult> => {
+ await assertBuildProject(context, patch);
+ const { authorized, rejected } = await authorizePatchEntries(context, patch);
+ const applied = await applyAuthorizedEntries({
+ authorized,
+ patch,
+ version: patch.clientVersion,
+ });
+
+ if (applied.status === "version_mismatched") {
+ return applied;
+ }
+
+ const entriesByTransactionId = new Map<string, PatchEntryResult[]>();
+ for (const entryResult of [
+ ...rejected.map(rejectedResult),
+ ...applied.entries,
+ ]) {
+ const entries = entriesByTransactionId.get(entryResult.transactionId) ?? [];
+ entries.push(entryResult);
+ entriesByTransactionId.set(entryResult.transactionId, entries);
+ }
+ const entries = patch.entries.flatMap((entry) => {
+ return entriesByTransactionId.get(entry.transaction.id)?.shift() ?? [];
+ });
+ const hasPartialResult = entries.some((entry) => entry.status !== "accepted");
+ if (hasPartialResult) {
+ return {
+ status: "partial",
+ version: applied.version,
+ entries,
+ };
+ }
+
+ return { status: "ok", version: applied.version, entries };
+};
+
+export const loadAuthorizedPatchState = async ({
+ authToken,
+ buildId,
+ context,
+}: {
+ authToken: string;
+ buildId: string;
+ context: AppContext;
+}) => {
+ const state = await loadBuildState(context, buildId);
+ const writerContext = await createWriterContext(context, authToken);
+ await assertProjectPermit({
+ context: writerContext,
+ permit: "edit",
+ projectId: state.projectId,
+ });
+ return state;
+};
diff --git a/apps/builder/app/shared/sync/project-queue.test.ts b/apps/builder/app/shared/sync/project-queue.test.ts
index b460c36b6e..c69b762560 100644
--- a/apps/builder/app/shared/sync/project-queue.test.ts
+++ b/apps/builder/app/shared/sync/project-queue.test.ts
@@ -2,31 +2,39 @@
* @vitest-environment jsdom
*/
import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
-import type { Backoff } from "~/shared/polly/backoff";
-
-// ── Module mocks ─────────────────────────────────────────────────
-
-const { mockFetch, mockToastError, mockCreateBackoff, mockLoadBuilderData } =
- vi.hoisted(() => ({
- mockFetch: vi.fn(),
- mockToastError: vi.fn(),
- mockCreateBackoff: vi.fn(),
- mockLoadBuilderData: vi.fn(),
- }));
+import type { Backoff } from "@webstudio-is/sync-client";
+
+// Module mocks
+
+const {
+ mockBuildPatch,
+ mockCreateNativeClient,
+ mockToastError,
+ mockCreateBackoff,
+ mockLoadBuilderData,
+} = vi.hoisted(() => ({
+ mockBuildPatch: vi.fn(),
+ mockCreateNativeClient: vi.fn(),
+ mockToastError: vi.fn(),
+ mockCreateBackoff: vi.fn(),
+ mockLoadBuilderData: vi.fn(),
+}));
-vi.mock("~/shared/fetch.client", () => ({
- fetch: mockFetch,
+vi.mock("~/shared/trpc/trpc-client", () => ({
+ createNativeClient: mockCreateNativeClient,
+ nativeClient: { build: { patch: { mutate: mockBuildPatch } } },
}));
vi.mock("@webstudio-is/design-system", () => ({
toast: { error: mockToastError },
}));
-vi.mock("~/shared/router-utils", () => ({
- restPatchPath: () => "/rest/patch",
+vi.mock("~/env/env.static", () => ({
+ publicStaticEnv: { VERSION: "test-version" },
}));
-vi.mock("~/shared/polly/backoff", () => ({
+vi.mock("@webstudio-is/sync-client", async (importOriginal) => ({
+ ...(await importOriginal<typeof import("@webstudio-is/sync-client")>()),
createBackoff: mockCreateBackoff,
}));
@@ -34,11 +42,11 @@ vi.mock("~/shared/builder-data", () => ({
loadBuilderData: mockLoadBuilderData,
}));
-// ── Imports (after mocks) ────────────────────────────────────────
+// Imports (after mocks)
import type { Change } from "immerhin";
+import { $hasUnsavedSyncChanges, $syncStatus } from "@webstudio-is/sync-client";
import {
- $queueStatus,
$lastTransactionId,
commandQueue,
isSyncIdle,
@@ -52,14 +60,14 @@ import {
const { retry, pollCommands, transactionCallbacks } = __testing__;
-// ── Constants (duplicated to avoid exporting them just for tests) ─
+// Constants (duplicated to avoid exporting them just for tests)
const NEW_ENTRIES_INTERVAL = 1000;
const INTERVAL_RECOVERY = 2000;
const MAX_RETRY_RECOVERY = 5;
const MAX_ALLOWED_API_ERRORS = 5;
-// ── Helpers ──────────────────────────────────────────────────────
+// Helpers
const flush = () => vi.advanceTimersByTimeAsync(0);
@@ -87,12 +95,12 @@ const createMockBackoff = (overrides: Partial<Backoff> = {}): Backoff => {
};
};
-// ── Tests ────────────────────────────────────────────────────────
+// Tests
describe("project-queue", () => {
beforeEach(() => {
vi.useFakeTimers();
- $queueStatus.set({ status: "idle" });
+ $syncStatus.set({ status: "idle" });
$lastTransactionId.set(undefined);
commandQueue.dequeueAll();
transactionCallbacks.clear();
@@ -100,7 +108,10 @@ describe("project-queue", () => {
// Default mocks
mockCreateBackoff.mockReturnValue(createMockBackoff());
- mockFetch.mockResolvedValue(new Response());
+ mockCreateNativeClient.mockReturnValue({
+ build: { patch: { mutate: mockBuildPatch } },
+ });
+ mockBuildPatch.mockResolvedValue({ status: "ok" });
mockToastError.mockClear();
mockLoadBuilderData.mockResolvedValue({});
});
@@ -111,24 +122,40 @@ describe("project-queue", () => {
vi.restoreAllMocks();
});
- // ── isSyncIdle ─────────────────────────────────────────────────
+ // unload protection
+
+ describe("$hasUnsavedSyncChanges", () => {
+ test("is false when sync is idle", () => {
+ $syncStatus.set({ status: "idle" });
+
+ expect($hasUnsavedSyncChanges.get()).toBe(false);
+ });
+
+ test("is true while changes are not saved yet", () => {
+ $syncStatus.set({ status: "syncing" });
+
+ expect($hasUnsavedSyncChanges.get()).toBe(true);
+ });
+ });
+
+ // isSyncIdle
describe("isSyncIdle", () => {
test("resolves immediately when status is idle", async () => {
- $queueStatus.set({ status: "idle" });
+ $syncStatus.set({ status: "idle" });
const result = await isSyncIdle();
expect(result).toEqual({ status: "idle" });
});
test("rejects immediately when status is fatal", async () => {
- $queueStatus.set({ status: "fatal", error: "broken" });
+ $syncStatus.set({ status: "fatal", error: "broken" });
await expect(isSyncIdle()).rejects.toThrow(
"Synchronization is in fatal state"
);
});
test("waits and resolves when status transitions to idle", async () => {
- $queueStatus.set({ status: "running" });
+ $syncStatus.set({ status: "syncing" });
let resolved = false;
isSyncIdle().then(() => {
@@ -137,13 +164,13 @@ describe("project-queue", () => {
await flush();
expect(resolved).toBe(false);
- $queueStatus.set({ status: "idle" });
+ $syncStatus.set({ status: "idle" });
await flush();
expect(resolved).toBe(true);
});
test("waits and rejects when status transitions to fatal", async () => {
- $queueStatus.set({ status: "running" });
+ $syncStatus.set({ status: "syncing" });
let error: Error | undefined;
isSyncIdle().catch((err: Error) => {
@@ -152,13 +179,13 @@ describe("project-queue", () => {
await flush();
expect(error).toBeUndefined();
- $queueStatus.set({ status: "fatal", error: "crashed" });
+ $syncStatus.set({ status: "fatal", error: "crashed" });
await flush();
expect(error?.message).toMatch("Synchronization is in fatal state");
});
test("ignores intermediate non-idle/non-fatal statuses", async () => {
- $queueStatus.set({ status: "running" });
+ $syncStatus.set({ status: "syncing" });
let resolved = false;
isSyncIdle().then(() => {
@@ -166,21 +193,21 @@ describe("project-queue", () => {
});
await flush();
- $queueStatus.set({ status: "recovering" });
+ $syncStatus.set({ status: "recovering" });
await flush();
expect(resolved).toBe(false);
- $queueStatus.set({ status: "failed" });
+ $syncStatus.set({ status: "failed" });
await flush();
expect(resolved).toBe(false);
- $queueStatus.set({ status: "idle" });
+ $syncStatus.set({ status: "idle" });
await flush();
expect(resolved).toBe(true);
});
});
- // ── onTransactionComplete ──────────────────────────────────────
+ // onTransactionComplete
describe("onTransactionComplete", () => {
test("cleans up callbacks after 60s timeout", async () => {
@@ -195,7 +222,7 @@ describe("project-queue", () => {
});
});
- // ── onNextTransactionComplete ──────────────────────────────────
+ // onNextTransactionComplete
describe("onNextTransactionComplete", () => {
test("fires when $lastTransactionId changes and transaction succeeds", async () => {
@@ -224,7 +251,7 @@ describe("project-queue", () => {
});
});
- // ── retry generator ────────────────────────────────────────────
+ // retry generator
describe("retry generator (backoff integration)", () => {
test("uses 'recovering' status for the first MAX_RETRY_RECOVERY attempts", async () => {
@@ -247,7 +274,7 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(INTERVAL_RECOVERY);
await p;
- expect($queueStatus.get()).toEqual({ status: "recovering" });
+ expect($syncStatus.get()).toEqual({ status: "recovering" });
}
});
@@ -277,7 +304,7 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(15_000);
await failedPromise;
- expect($queueStatus.get()).toEqual({ status: "failed" });
+ expect($syncStatus.get()).toEqual({ status: "failed" });
});
test("uses backoff.next() delay and shows toast in failed state", async () => {
@@ -335,7 +362,7 @@ describe("project-queue", () => {
});
});
- // ── pollCommands generator ─────────────────────────────────────
+ // pollCommands generator
describe("pollCommands generator", () => {
test("yields commands from the queue", async () => {
@@ -355,7 +382,7 @@ describe("project-queue", () => {
);
});
- test("sets status to running when commands are available", async () => {
+ test("sets status to syncing when commands are available", async () => {
commandQueue.enqueue({
type: "setDetails",
projectId: "p1",
@@ -367,7 +394,7 @@ describe("project-queue", () => {
const gen = pollCommands();
await gen.next();
- expect($queueStatus.get()).toEqual({ status: "running" });
+ expect($syncStatus.get()).toEqual({ status: "syncing" });
});
test("sets status to idle and waits when queue is empty", async () => {
@@ -392,7 +419,7 @@ describe("project-queue", () => {
});
});
- // ── enqueueProjectDetails ──────────────────────────────────────
+ // enqueueProjectDetails
describe("enqueueProjectDetails", () => {
test("skips enqueue for 'view' permit", () => {
@@ -451,7 +478,7 @@ describe("project-queue", () => {
});
});
- // ── ServerSyncStorage ──────────────────────────────────────────
+ // ServerSyncStorage
describe("ServerSyncStorage", () => {
test("sendTransaction enqueues only for 'server' object", () => {
@@ -496,14 +523,11 @@ describe("project-queue", () => {
});
});
- // ── pollQueue integration ──────────────────────────────────────
+ // pollQueue integration
describe("pollQueue integration", () => {
test("successful transaction increments version and fires callbacks", async () => {
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({ status: "ok" }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({ status: "ok" });
const txCallback = vi.fn();
onTransactionComplete("tx-success", txCallback);
@@ -528,19 +552,46 @@ describe("project-queue", () => {
expect(txCallback).toHaveBeenCalledWith(true);
});
+ test("sends auth token in RPC input and header", async () => {
+ mockBuildPatch.mockResolvedValue({ status: "ok" });
+
+ enqueueProjectDetails({
+ projectId: "p1",
+ buildId: "b1",
+ version: 1,
+ authPermit: "edit",
+ authToken: "tok",
+ });
+ commandQueue.enqueue({
+ type: "transactions",
+ projectId: "p1",
+ transactions: [makeTx("tx-auth")],
+ });
+
+ await vi.advanceTimersByTimeAsync(NEW_ENTRIES_INTERVAL * 3);
+ await flush();
+
+ expect(mockBuildPatch).toHaveBeenCalledWith(
+ expect.objectContaining({
+ authToken: "tok",
+ source: "browser",
+ })
+ );
+ expect(mockCreateNativeClient).toHaveBeenCalledWith({
+ "x-auth-token": "tok",
+ });
+ });
+
test("version_mismatched response sets fatal status", async () => {
vi.stubGlobal(
"confirm",
vi.fn(() => false)
);
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({
- status: "version_mismatched",
- errors: "Version mismatch",
- }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({
+ status: "version_mismatched",
+ errors: "Version mismatch",
+ });
enqueueProjectDetails({
projectId: "p1",
@@ -558,7 +609,7 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(NEW_ENTRIES_INTERVAL * 3);
await flush();
- expect($queueStatus.get().status).toBe("fatal");
+ expect($syncStatus.get().status).toBe("fatal");
vi.unstubAllGlobals();
});
@@ -569,13 +620,10 @@ describe("project-queue", () => {
vi.fn(() => false)
);
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({
- status: "authorization_error",
- errors: "Not authorized",
- }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({
+ status: "authorization_error",
+ errors: "Not authorized",
+ });
enqueueProjectDetails({
projectId: "p1",
@@ -593,19 +641,16 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(NEW_ENTRIES_INTERVAL * 3);
await flush();
- expect($queueStatus.get().status).toBe("fatal");
+ expect($syncStatus.get().status).toBe("fatal");
vi.unstubAllGlobals();
});
test("fatal after MAX_ALLOWED_API_ERRORS unknown API errors", async () => {
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({
- status: "unknown_error",
- errors: "Something bad",
- }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({
+ status: "unknown_error",
+ errors: "Something bad",
+ });
enqueueProjectDetails({
projectId: "p1",
@@ -631,20 +676,17 @@ describe("project-queue", () => {
await flush();
}
- expect($queueStatus.get().status).toBe("fatal");
+ expect($syncStatus.get().status).toBe("fatal");
});
- test("non-ok response retries without crashing", async () => {
+ test("rpc errors retry without crashing", async () => {
let callCount = 0;
- mockFetch.mockImplementation(async () => {
+ mockBuildPatch.mockImplementation(async () => {
callCount += 1;
if (callCount <= 2) {
- return { ok: false, text: async () => "Server Error" } as Response;
+ throw new Error("Server Error");
}
- return {
- ok: true,
- json: async () => ({ status: "ok" }),
- } as Response;
+ return { status: "ok" };
});
enqueueProjectDetails({
@@ -672,15 +714,12 @@ describe("project-queue", () => {
test("network error retries without crashing", async () => {
let callCount = 0;
- mockFetch.mockImplementation(async () => {
+ mockBuildPatch.mockImplementation(async () => {
callCount += 1;
if (callCount <= 1) {
throw new Error("ERR_CONNECTION_REFUSED");
}
- return {
- ok: true,
- json: async () => ({ status: "ok" }),
- } as Response;
+ return { status: "ok" };
});
Object.defineProperty(navigator, "onLine", {
@@ -730,7 +769,7 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(NEW_ENTRIES_INTERVAL * 5);
await flush();
- expect($queueStatus.get().status).toBe("fatal");
+ expect($syncStatus.get().status).toBe("fatal");
expect(mockToastError).toHaveBeenCalledWith(
expect.stringContaining("Project details not found"),
expect.anything()
@@ -743,10 +782,7 @@ describe("project-queue", () => {
vi.fn(() => false)
);
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({ status: "ok" }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({ status: "ok" });
enqueueProjectDetails({
projectId: "p1",
@@ -778,13 +814,13 @@ describe("project-queue", () => {
await vi.advanceTimersByTimeAsync(NEW_ENTRIES_INTERVAL * 2);
await flush();
- expect($queueStatus.get().status).toBe("fatal");
+ expect($syncStatus.get().status).toBe("fatal");
vi.unstubAllGlobals();
});
});
- // ── stopPolling ────────────────────────────────────────────────
+ // stopPolling
describe("stopPolling", () => {
test("can be called safely when not polling", () => {
@@ -792,10 +828,7 @@ describe("project-queue", () => {
});
test("stops the polling loop", async () => {
- mockFetch.mockResolvedValue({
- ok: true,
- json: async () => ({ status: "ok" }),
- } as Response);
+ mockBuildPatch.mockResolvedValue({ status: "ok" });
enqueueProjectDetails({
projectId: "p1",
@@ -806,7 +839,7 @@ describe("project-queue", () => {
});
stopPolling();
- mockFetch.mockClear();
+ mockBuildPatch.mockClear();
commandQueue.enqueue({
type: "transactions",
@@ -818,7 +851,7 @@ describe("project-queue", () => {
await flush();
// No fetch calls should have happened after stopping
- expect(mockFetch).not.toHaveBeenCalled();
+ expect(mockBuildPatch).not.toHaveBeenCalled();
});
});
});
diff --git a/apps/builder/app/shared/sync/project-queue.ts b/apps/builder/app/shared/sync/project-queue.ts
index 09afd2622e..c0fe337b22 100644
--- a/apps/builder/app/shared/sync/project-queue.ts
+++ b/apps/builder/app/shared/sync/project-queue.ts
@@ -4,13 +4,20 @@ import type { Change } from "immerhin";
import type { Project } from "@webstudio-is/project";
import type { Build } from "@webstudio-is/project-build";
import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
-import { createBackoff } from "~/shared/polly/backoff";
-import { fetch } from "~/shared/fetch.client";
import { toast } from "@webstudio-is/design-system";
-import { restPatchPath } from "~/shared/router-utils";
+import {
+ $hasUnsavedSyncChanges,
+ $syncStatus,
+ createBackoff,
+ createTransactionCompletionStore,
+ type SyncStatus,
+} from "@webstudio-is/sync-client";
import { loadBuilderData } from "~/shared/builder-data";
+import { publicStaticEnv } from "~/env/env.static";
+import { createNativeClient, nativeClient } from "~/shared/trpc/trpc-client";
import * as commandQueue from "./command-queue";
-import type { SyncStorage, Transaction } from "~/shared/sync-client";
+import type { SyncStorage } from "~/shared/sync-client";
+import type { Transaction } from "@webstudio-is/sync-client";
export { commandQueue };
@@ -30,63 +37,16 @@ const pause = (timeout: number) => {
return new Promise((resolve) => setTimeout(resolve, timeout));
};
-export type QueueStatus =
- | { status: "running" }
- | { status: "idle" }
- | { status: "recovering" }
- | { status: "failed" }
- | { status: "fatal"; error: string };
+/** Last server-confirmed build version. Updated after each successful PATCH. */
+export const $committedVersion = atom<number>(0);
-export const $queueStatus = atom<QueueStatus>({ status: "idle" });
+const transactionCompletion = createTransactionCompletionStore();
-// Transaction completion tracking
-type TransactionCompleteCallback = (success: boolean) => void;
-const transactionCallbacks = new Map<string, TransactionCompleteCallback[]>();
-
-// Atom to communicate transaction IDs from sendTransaction to user code
-export const $lastTransactionId = atom<string | undefined>(undefined);
-
-/**
- * Register a callback to be called when a specific transaction is confirmed by the server.
- * The callback receives true if the transaction was successfully persisted, false otherwise.
- */
-export const onTransactionComplete = (
- transactionId: string,
- callback: TransactionCompleteCallback
-) => {
- const callbacks = transactionCallbacks.get(transactionId) ?? [];
- callbacks.push(callback);
- transactionCallbacks.set(transactionId, callbacks);
-
- // Cleanup after timeout to prevent memory leaks
- setTimeout(() => {
- transactionCallbacks.delete(transactionId);
- }, 60000); // 1 minute timeout
-};
-
-/**
- * Register a callback to be called when the next transaction is confirmed by the server.
- * Use this right after calling serverSyncStore.createTransaction().
- */
-export const onNextTransactionComplete = (callback: () => void) => {
- let unsubscribe: (() => void) | undefined;
- // eslint-disable-next-line prefer-const
- unsubscribe = $lastTransactionId.subscribe((transactionId) => {
- if (transactionId) {
- onTransactionComplete(transactionId, (success) => {
- if (success) {
- callback();
- }
- });
- unsubscribe?.();
- }
- });
-
- // Cleanup after timeout to prevent memory leak if transaction never gets an ID
- setTimeout(() => {
- unsubscribe?.();
- }, 60000);
-};
+export const $lastTransactionId = transactionCompletion.$lastTransactionId;
+export const onTransactionComplete =
+ transactionCompletion.onTransactionComplete;
+export const onNextTransactionComplete =
+ transactionCompletion.onNextTransactionComplete;
// polling is important to queue new transactions independently
// from async iterator and batch them into single job
@@ -94,13 +54,13 @@ const pollCommands = async function* () {
while (true) {
const commands = commandQueue.dequeueAll();
if (commands.length > 0) {
- $queueStatus.set({ status: "running" });
+ $syncStatus.set({ status: "syncing" });
yield* commands;
await pause(NEW_ENTRIES_INTERVAL);
// Do not switch on idle state until there is possibility that queue is not empty
continue;
}
- $queueStatus.set({ status: "idle" });
+ $syncStatus.set({ status: "idle" });
await pause(NEW_ENTRIES_INTERVAL);
}
};
@@ -112,10 +72,10 @@ const retry = async function* () {
yield;
if (backoff.attempts() < MAX_RETRY_RECOVERY) {
backoff.next();
- $queueStatus.set({ status: "recovering" });
+ $syncStatus.set({ status: "recovering" });
await pause(INTERVAL_RECOVERY);
} else {
- $queueStatus.set({ status: "failed" });
+ $syncStatus.set({ status: "failed" });
const delay = backoff.next();
@@ -195,7 +155,11 @@ const pollQueue = async (signal: AbortSignal) => {
const detailsMap = new Map<
Project["id"],
- { version: number; buildId: Build["id"]; authToken: string | undefined }
+ {
+ version: number;
+ buildId: Build["id"];
+ authToken: string | undefined;
+ }
>();
polling: for await (const command of pollCommands()) {
@@ -222,7 +186,7 @@ const pollQueue = async (signal: AbortSignal) => {
}
// stop synchronization and wait til user reload
- $queueStatus.set({ status: "fatal", error });
+ $syncStatus.set({ status: "fatal", error });
if (shouldReload === false) {
toast.error(
@@ -254,7 +218,7 @@ const pollQueue = async (signal: AbortSignal) => {
duration: Number.POSITIVE_INFINITY,
});
- $queueStatus.set({ status: "fatal", error });
+ $syncStatus.set({ status: "fatal", error });
return;
}
@@ -266,10 +230,6 @@ const pollQueue = async (signal: AbortSignal) => {
for await (const _ of retry()) {
// in case of any error continue retrying
try {
- const headers = new Headers();
- if (details.authToken) {
- headers.append("x-auth-token", details.authToken);
- }
// revise patches are not used on the server and reduce possible patch size
const optimizedTransactions = transactions.map((transaction) => ({
...transaction,
@@ -278,33 +238,30 @@ const pollQueue = async (signal: AbortSignal) => {
patches: change.patches,
})),
}));
- const response = await fetch(restPatchPath(), {
- method: "post",
- body: JSON.stringify({
- transactions: optimizedTransactions,
- buildId: details.buildId,
- projectId,
- // provide latest stored version to server
- version: details.version,
- headers,
- }),
+ const patchClient =
+ details.authToken === undefined
+ ? nativeClient
+ : createNativeClient({ "x-auth-token": details.authToken });
+ const result = await patchClient.build.patch.mutate({
+ source: "browser",
+ appVersion: publicStaticEnv.VERSION,
+ authToken: details.authToken,
+ entries: optimizedTransactions.map((transaction) => ({
+ transaction,
+ })),
+ buildId: details.buildId,
+ projectId,
+ // provide latest stored version to server
+ version: details.version,
});
- if (response.ok) {
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
- const result = (await response.json()) as any;
+ if (result) {
if (result.status === "ok") {
- details.version += 1;
+ details.version = result.version ?? details.version + 1;
+ $committedVersion.set(details.version);
- // Notify all transaction completion callbacks
for (const transaction of transactions) {
- const callbacks = transactionCallbacks.get(transaction.id);
- if (callbacks) {
- for (const callback of callbacks) {
- callback(true);
- }
- transactionCallbacks.delete(transaction.id);
- }
+ transactionCompletion.completeTransaction(transaction.id, true);
}
// stop retrying and wait next transactions
@@ -314,17 +271,25 @@ const pollQueue = async (signal: AbortSignal) => {
// user may cancel to copy own state before reloading
if (
result.status === "version_mismatched" ||
- result.status === "authorization_error"
+ result.status === "authorization_error" ||
+ result.status === "partial"
) {
const error =
- result.errors ?? "Unknown version mismatch. Please reload.";
+ ("errors" in result ? result.errors : undefined) ??
+ ("entries" in result
+ ? result.entries
+ .filter((entry) => entry.status !== "accepted")
+ .map((entry) => entry.errors)
+ .join("\n")
+ : undefined) ??
+ "Unknown version mismatch. Please reload.";
const shouldReload = confirm(error);
if (shouldReload) {
location.reload();
}
- $queueStatus.set({ status: "fatal", error });
+ $syncStatus.set({ status: "fatal", error });
if (shouldReload === false) {
toast.error(
@@ -343,7 +308,7 @@ const pollQueue = async (signal: AbortSignal) => {
} Synchronization has been paused.`;
// Api error we don't know how to handle, as retries will not help probably
// We should show error and break synchronization
- $queueStatus.set({ status: "fatal", error });
+ $syncStatus.set({ status: "fatal", error });
toast.error(error, {
id: "fatal-error",
@@ -354,13 +319,6 @@ const pollQueue = async (signal: AbortSignal) => {
}
apiErrorCount += 1;
- } else {
- // Various 500 responses, from proxies etc
- // It's usually ok to be here, probably restorable with retries
- const text = await response.text();
- // To investigate some strange errors we have seen
-
- console.info(`Non ok response: ${text}`);
}
} catch (error) {
if (navigator.onLine) {
@@ -416,8 +374,8 @@ export class ServerSyncStorage implements SyncStorage {
* Promisify idle state of the queue for a one-off notification when everything is saved.
*/
export const isSyncIdle = () => {
- return new Promise<QueueStatus>((resolve, reject) => {
- const handle = (status: QueueStatus) => {
+ return new Promise<SyncStatus>((resolve, reject) => {
+ const handle = (status: SyncStatus) => {
if (status.status === "idle") {
resolve(status);
return true;
@@ -432,10 +390,10 @@ export const isSyncIdle = () => {
}
return false;
};
- const status = $queueStatus.get();
+ const status = $syncStatus.get();
if (handle(status) === false) {
- const unsubscribe = $queueStatus.subscribe((status) => {
+ const unsubscribe = $syncStatus.subscribe((status) => {
if (handle(status)) {
unsubscribe();
}
@@ -447,8 +405,7 @@ export const isSyncIdle = () => {
export const usePreventUnload = () => {
useEffect(() => {
const handler = (event: BeforeUnloadEvent) => {
- const { status } = $queueStatus.get();
- if (status === "idle" || status === "fatal") {
+ if ($hasUnsavedSyncChanges.get() === false) {
return;
}
event.preventDefault();
@@ -461,5 +418,5 @@ export const usePreventUnload = () => {
export const __testing__ = {
pollCommands,
retry,
- transactionCallbacks,
+ transactionCallbacks: transactionCompletion.callbacks,
};
diff --git a/apps/builder/app/shared/sync/singleplayer-client.ts b/apps/builder/app/shared/sync/singleplayer-client.ts
new file mode 100644
index 0000000000..063084e176
--- /dev/null
+++ b/apps/builder/app/shared/sync/singleplayer-client.ts
@@ -0,0 +1,44 @@
+import type { Project } from "@webstudio-is/project";
+import type { Build } from "@webstudio-is/project-build";
+import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
+import type { SyncStorage } from "~/shared/sync-client";
+import {
+ ServerSyncStorage,
+ enqueueProjectDetails,
+ stopPolling,
+} from "./project-queue";
+
+export type SingleplayerSyncClient = {
+ storages: SyncStorage[];
+ destroy(): void;
+ onDataLoaded(data: { id: Build["id"]; version: number }): void;
+};
+
+export const createSingleplayerSyncClient = ({
+ authPermit,
+ authToken,
+ projectId,
+}: {
+ authPermit: AuthPermit;
+ authToken: string | undefined;
+ projectId: Project["id"];
+}): SingleplayerSyncClient => {
+ return {
+ storages: authPermit === "view" ? [] : [new ServerSyncStorage(projectId)],
+ destroy() {
+ stopPolling();
+ },
+ onDataLoaded(data) {
+ if (authPermit === "view") {
+ return;
+ }
+ enqueueProjectDetails({
+ projectId,
+ buildId: data.id,
+ version: data.version,
+ authPermit,
+ authToken,
+ });
+ },
+ };
+};
diff --git a/apps/builder/app/shared/sync/sync-client.ts b/apps/builder/app/shared/sync/sync-client.ts
index 0cd8460f29..4e76a970c7 100644
--- a/apps/builder/app/shared/sync/sync-client.ts
+++ b/apps/builder/app/shared/sync/sync-client.ts
@@ -1,13 +1,13 @@
import type { Project } from "@webstudio-is/project";
import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
-import { SyncClient } from "~/shared/sync-client";
+import type { SyncEmitter } from "@webstudio-is/sync-client";
+import { SyncClient, type SyncStorage } from "~/shared/sync-client";
import { registerContainers, createObjectPool } from "./sync-stores";
-import {
- ServerSyncStorage,
- enqueueProjectDetails,
- stopPolling,
-} from "./project-queue";
-import { loadBuilderData } from "~/shared/builder-data";
+import { loadBuilderData, type LoadedBuilderData } from "~/shared/builder-data";
+import { publicStaticEnv } from "~/env/env.static";
+import { isFeatureEnabled } from "@webstudio-is/feature-flags";
+import { createSingleplayerSyncClient } from "./singleplayer-client";
+import { createMultiplayerSyncClient } from "./multiplayer-client";
import {
$project,
$pages,
@@ -27,6 +27,48 @@ import {
let client: SyncClient | undefined;
let currentProjectId: string | undefined;
+let modeClient: SyncModeClient | undefined;
+
+type SyncModeClient = {
+ clientId?: string;
+ emitter?: SyncEmitter;
+ storages: SyncStorage[];
+ destroy(): void;
+ onDataLoaded(data: LoadedBuilderData): void;
+};
+
+const resolveMultiplayerRelayUrl = (relayUrl: string) => {
+ if (typeof window === "undefined") {
+ return relayUrl;
+ }
+ const configuredUrl = new URL(relayUrl, window.location.origin);
+ const currentUrl = new URL(window.location.href);
+ const isLocalWstdDev =
+ currentUrl.hostname === "wstd.dev" ||
+ currentUrl.hostname.endsWith(".wstd.dev");
+
+ if (isLocalWstdDev && currentUrl.port === "5173") {
+ return new URL(configuredUrl.pathname, currentUrl.origin).href;
+ }
+
+ return configuredUrl.href;
+};
+
+const applyBuilderData = (data: LoadedBuilderData) => {
+ $publisherHost.set(data.publisherHost);
+ $project.set(data.project);
+ $pages.set(data.pages);
+ $assets.set(data.assets);
+ $instances.set(data.instances);
+ $props.set(data.props);
+ $dataSources.set(data.dataSources);
+ $resources.set(data.resources);
+ $breakpoints.set(data.breakpoints);
+ $styleSources.set(data.styleSources);
+ $styleSourceSelections.set(data.styleSourceSelections);
+ $styles.set(data.styles);
+ $marketplaceProduct.set(data.marketplaceProduct);
+};
/**
* Initialize the sync infrastructure and load project data.
@@ -45,70 +87,66 @@ export const initializeClientSync = ({
signal: AbortSignal;
onReady?: () => void;
}) => {
+ const multiplayerRelayUrl = isFeatureEnabled("collabRelay")
+ ? publicStaticEnv.COLLAB_RELAY_URL?.trim() || undefined
+ : undefined;
+ const resolvedMultiplayerRelayUrl =
+ multiplayerRelayUrl === undefined
+ ? undefined
+ : resolveMultiplayerRelayUrl(multiplayerRelayUrl);
+ const useMultiplayer = resolvedMultiplayerRelayUrl !== undefined;
+
// Note: "view" permit will skip transaction synchronization
// Reset sync client if projectId changed
if (client && currentProjectId !== projectId) {
destroyClientSync();
- client = undefined;
}
// Only register containers once and create sync client
if (!client) {
registerContainers();
+ const object = createObjectPool();
+ const nextModeClient: SyncModeClient =
+ useMultiplayer && resolvedMultiplayerRelayUrl !== undefined
+ ? createMultiplayerSyncClient({
+ applyBuilderData,
+ authPermit,
+ authToken,
+ projectId,
+ relayUrl: resolvedMultiplayerRelayUrl,
+ signal,
+ })
+ : createSingleplayerSyncClient({
+ authPermit,
+ authToken,
+ projectId,
+ });
+ modeClient = nextModeClient;
client = new SyncClient({
role: "leader",
- object: createObjectPool(),
- storages: [new ServerSyncStorage(projectId)],
+ object,
+ emitter: nextModeClient.emitter,
+ storages: nextModeClient.storages,
});
+ if (nextModeClient.clientId !== undefined) {
+ client.clientId = nextModeClient.clientId;
+ }
currentProjectId = projectId;
}
client.connect({
signal,
onReady() {
- // Load builder data if we don't have it yet OR if projectId changed
- const currentProjectInStore = $project.get()?.id;
- const needsDataLoad =
- !$pages.get() || currentProjectInStore !== projectId;
-
loadBuilderData({ projectId, signal })
.then((data) => {
- if (needsDataLoad) {
- // Set publisherHost from loaded data (needed for $publishedOrigin computed store)
- $publisherHost.set(data.publisherHost);
-
- // Set all the stores with loaded data
- $project.set(data.project);
- $pages.set(data.pages);
- $assets.set(data.assets);
- $instances.set(data.instances);
- $props.set(data.props);
- $dataSources.set(data.dataSources);
- $resources.set(data.resources);
- $breakpoints.set(data.breakpoints);
- $styleSources.set(data.styleSources);
- $styleSourceSelections.set(data.styleSourceSelections);
- $styles.set(data.styles);
- $marketplaceProduct.set(data.marketplaceProduct);
- }
-
- // Start project sync with build info from loaded data
- if (authPermit !== "view") {
- enqueueProjectDetails({
- projectId,
- buildId: data.id,
- version: data.version,
- authPermit,
- authToken,
- });
- }
-
+ applyBuilderData(data);
+ modeClient?.onDataLoaded(data);
onReady?.();
})
.catch((error) => {
- if (error.name !== "AbortError") {
- console.error("Failed to load project data:", error);
+ if (!signal.aborted) {
+ console.error("[builder-sync] failed to load project data:", error);
}
});
},
@@ -120,8 +158,11 @@ export const initializeClientSync = ({
* Call this when closing the builder or switching between projects.
*/
export const destroyClientSync = () => {
+ modeClient?.destroy();
+ modeClient = undefined;
+ client = undefined;
+ currentProjectId = undefined;
resetDataStores();
- stopPolling();
};
export const getSyncClient = () => client;
diff --git a/apps/builder/app/shared/sync/sync-stores.test.ts b/apps/builder/app/shared/sync/sync-stores.test.ts
new file mode 100644
index 0000000000..690267e1ac
--- /dev/null
+++ b/apps/builder/app/shared/sync/sync-stores.test.ts
@@ -0,0 +1,123 @@
+import { afterEach, describe, expect, test, vi } from "vitest";
+import { $selectedInstanceSelector, $selectedPageId } from "../nano-states";
+import { __testing__ } from "./sync-stores";
+
+const { SelectedPageAndInstanceSyncObject } = __testing__;
+
+const waitForBatchedStore = () =>
+ new Promise<void>((resolve) => {
+ setTimeout(resolve, 0);
+ });
+
+afterEach(() => {
+ $selectedPageId.set(undefined);
+ $selectedInstanceSelector.set(undefined);
+});
+
+describe("SelectedPageAndInstanceSyncObject", () => {
+ test("sends page and instance selector as one final transaction", async () => {
+ const syncObject = new SelectedPageAndInstanceSyncObject();
+ const sendTransaction = vi.fn();
+ syncObject.subscribe(sendTransaction, new AbortController().signal);
+
+ await waitForBatchedStore();
+ sendTransaction.mockClear();
+
+ $selectedPageId.set("page-a");
+ $selectedInstanceSelector.set(["body-a"]);
+
+ await waitForBatchedStore();
+
+ expect(sendTransaction).toHaveBeenCalledTimes(1);
+ expect(sendTransaction).toHaveBeenCalledWith({
+ id: expect.any(String),
+ object: "selectedPageAndInstance",
+ payload: {
+ selectedPageId: "page-a",
+ selectedInstanceSelector: ["body-a"],
+ },
+ });
+ });
+
+ test("applies page and instance selector without echoing transaction", async () => {
+ const syncObject = new SelectedPageAndInstanceSyncObject();
+ const sendTransaction = vi.fn();
+ syncObject.subscribe(sendTransaction, new AbortController().signal);
+
+ await waitForBatchedStore();
+ sendTransaction.mockClear();
+
+ syncObject.applyTransaction({
+ id: "selection",
+ object: "selectedPageAndInstance",
+ payload: {
+ selectedPageId: "page-b",
+ selectedInstanceSelector: ["body-b"],
+ },
+ });
+
+ expect($selectedPageId.get()).toBe("page-b");
+ expect($selectedInstanceSelector.get()).toEqual(["body-b"]);
+
+ await waitForBatchedStore();
+
+ expect(sendTransaction).not.toHaveBeenCalled();
+ });
+
+ test("malformed remote payload does not suppress next local transaction", async () => {
+ const syncObject = new SelectedPageAndInstanceSyncObject();
+ const sendTransaction = vi.fn();
+ syncObject.subscribe(sendTransaction, new AbortController().signal);
+
+ await waitForBatchedStore();
+ sendTransaction.mockClear();
+
+ syncObject.applyTransaction({
+ id: "selection",
+ object: "selectedPageAndInstance",
+ payload: null,
+ });
+
+ $selectedPageId.set("page-c");
+ $selectedInstanceSelector.set(["body-c"]);
+
+ await waitForBatchedStore();
+
+ expect(sendTransaction).toHaveBeenCalledTimes(1);
+ expect(sendTransaction).toHaveBeenCalledWith({
+ id: expect.any(String),
+ object: "selectedPageAndInstance",
+ payload: {
+ selectedPageId: "page-c",
+ selectedInstanceSelector: ["body-c"],
+ },
+ });
+ });
+
+ test("malformed selection fields do not update stores", () => {
+ const syncObject = new SelectedPageAndInstanceSyncObject();
+
+ $selectedPageId.set("page-before");
+ $selectedInstanceSelector.set(["body-before"]);
+
+ syncObject.applyTransaction({
+ id: "selection",
+ object: "selectedPageAndInstance",
+ payload: {
+ selectedPageId: 10,
+ selectedInstanceSelector: ["body-after"],
+ },
+ });
+ syncObject.applyTransaction({
+ id: "selection",
+ object: "selectedPageAndInstance",
+ payload: {
+ selectedPageId: "page-after",
+ selectedInstanceSelector: [10],
+ },
+ });
+
+ expect($selectedPageId.get()).toBe("page-before");
+ expect($selectedInstanceSelector.get()).toEqual(["body-before"]);
+ });
+});
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index 21c3c7df05..ebf887b9b8 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -1,25 +1,16 @@
import { Store } from "immerhin";
import { enableMapSet, setAutoFreeze } from "immer";
import { useEffect } from "react";
+import { batched } from "nanostores";
+import { nanoid } from "nanoid";
+import { $project } from "./data-stores";
import {
- $project,
- $pages,
- $instances,
- $props,
- $dataSources,
- $breakpoints,
- $styles,
- $styleSources,
- $styleSourceSelections,
- $assets,
- $resources,
- $marketplaceProduct,
-} from "./data-stores";
+ normalizePagesPatch,
+ denormalizePagesPatch,
+} from "./pages-patch-normalizer";
import {
$selectedPageHash,
$selectedInstanceSizes,
- $selectedInstanceRenderState,
- $hoveredInstanceSelector,
$authTokenPermissions,
$toastErrors,
$selectedStyleSources,
@@ -39,8 +30,6 @@ import {
$isResizingCanvas,
$collaborativeInstanceRect,
$collaborativeInstanceSelector,
- $hoveredInstanceOutline,
- $selectedInstanceOutline,
$blockChildOutline,
$textToolbar,
$gridCellData,
@@ -48,19 +37,44 @@ import {
$registeredTemplates,
$modifierKeys,
$instanceContextMenu,
+ $selectedInstanceRenderState,
+ $hoveredInstanceSelector,
+ $selectedInstanceOutline,
+ $hoveredInstanceOutline,
} from "~/shared/nano-states";
+import { $marketplaceProduct } from "~/shared/sync/data-stores";
import { $ephemeralStyles } from "~/canvas/stores";
import {
ImmerhinSyncObject,
NanostoresSyncObject,
SyncClient,
SyncObjectPool,
- type SyncEmitter,
} from "../sync-client";
+import type {
+ RevertedTransaction,
+ SyncEmitter,
+ Transaction,
+} from "@webstudio-is/sync-client";
import { $canvasScrollbarSize } from "~/builder/shared/nano-states";
-import { $awareness, $temporaryInstances } from "../awareness";
+import {
+ $pages,
+ $instances,
+ $props,
+ $dataSources,
+ $breakpoints,
+ $styles,
+ $styleSources,
+ $styleSourceSelections,
+ $assets,
+ $resources,
+} from "~/shared/sync/data-stores";
+import { $pointerPosition } from "../awareness";
+import { $temporaryInstances } from "../nano-states";
+import { $selectedInstanceSelector } from "../nano-states/instances";
+import { $selectedPageId } from "../nano-states/pages";
import { $systemDataByPage } from "../system";
import { $resourcesCache } from "../resources";
+import type { InstanceSelector } from "../tree-utils";
enableMapSet();
// safari structuredClone fix
@@ -84,11 +98,109 @@ export const registerContainers = () => {
serverSyncStore.register("marketplaceProduct", $marketplaceProduct);
};
+type SelectedPageAndInstance = {
+ selectedPageId: string | undefined;
+ selectedInstanceSelector: InstanceSelector | undefined;
+};
+
+const $selectedPageAndInstance = batched(
+ [$selectedPageId, $selectedInstanceSelector],
+ (selectedPageId, selectedInstanceSelector): SelectedPageAndInstance => ({
+ selectedPageId,
+ selectedInstanceSelector,
+ })
+);
+
+class SelectedPageAndInstanceSyncObject {
+ name = "selectedPageAndInstance";
+ operation: "local" | "state" | "add" = "local";
+ ignoreNextBatchedChange = false;
+
+ getState() {
+ return $selectedPageAndInstance.get();
+ }
+
+ setState(state: unknown) {
+ this.operation = "state";
+ this.ignoreNextBatchedChange = this.setSelectedPageAndInstance(state);
+ this.operation = "local";
+ }
+
+ applyTransaction(transaction: Transaction) {
+ this.operation = "add";
+ try {
+ this.ignoreNextBatchedChange = this.setSelectedPageAndInstance(
+ structuredClone(transaction.payload)
+ );
+ } catch (error) {
+ console.error(error);
+ }
+ this.operation = "local";
+ }
+
+ revertTransaction(_transaction: RevertedTransaction) {
+ // @todo store the list of transactions
+ }
+
+ subscribe(
+ sendTransaction: (transaction: Transaction) => void,
+ signal: AbortSignal
+ ) {
+ const unsubscribe = $selectedPageAndInstance.listen((payload) => {
+ if (this.ignoreNextBatchedChange) {
+ this.ignoreNextBatchedChange = false;
+ return;
+ }
+ if (this.operation !== "local") {
+ return;
+ }
+ sendTransaction({ id: nanoid(), object: this.name, payload });
+ });
+ signal.addEventListener("abort", unsubscribe);
+ }
+
+ private setSelectedPageAndInstance(state: unknown) {
+ if (typeof state !== "object" || state === null) {
+ return false;
+ }
+ const { selectedPageId, selectedInstanceSelector } =
+ state as Partial<SelectedPageAndInstance>;
+ if (selectedPageId !== undefined && typeof selectedPageId !== "string") {
+ return false;
+ }
+ if (
+ selectedInstanceSelector !== undefined &&
+ (Array.isArray(selectedInstanceSelector) === false ||
+ selectedInstanceSelector.every((id) => typeof id === "string") ===
+ false)
+ ) {
+ return false;
+ }
+ $selectedPageId.set(selectedPageId);
+ $selectedInstanceSelector.set(selectedInstanceSelector);
+ return true;
+ }
+}
+
+export const __testing__ = {
+ SelectedPageAndInstanceSyncObject,
+};
+
export const createObjectPool = () => {
return new SyncObjectPool([
- new ImmerhinSyncObject("server", serverSyncStore),
+ new ImmerhinSyncObject("server", serverSyncStore, {
+ onSend: (changes) => {
+ const pages = $pages.get();
+ return pages ? normalizePagesPatch(changes, pages) : changes;
+ },
+ onReceive: (changes) => {
+ const pages = $pages.get();
+ return pages ? denormalizePagesPatch(changes, pages) : changes;
+ },
+ }),
new ImmerhinSyncObject("client", clientSyncStore),
- new NanostoresSyncObject("awareness", $awareness),
+ new SelectedPageAndInstanceSyncObject(),
+ new NanostoresSyncObject("pointerPosition", $pointerPosition),
new NanostoresSyncObject("temporaryInstances", $temporaryInstances),
new NanostoresSyncObject("project", $project),
@@ -104,6 +216,11 @@ export const createObjectPool = () => {
"hoveredInstanceSelector",
$hoveredInstanceSelector
),
+ new NanostoresSyncObject(
+ "selectedInstanceOutline",
+ $selectedInstanceOutline
+ ),
+ new NanostoresSyncObject("hoveredInstanceOutline", $hoveredInstanceOutline),
new NanostoresSyncObject("builderMode", $builderMode),
new NanostoresSyncObject("authTokenPermissions", $authTokenPermissions),
new NanostoresSyncObject("toastErrors", $toastErrors),
@@ -131,11 +248,6 @@ export const createObjectPool = () => {
),
new NanostoresSyncObject("isResizingCanvas", $isResizingCanvas),
new NanostoresSyncObject("textToolbar", $textToolbar),
- new NanostoresSyncObject(
- "selectedInstanceOutline",
- $selectedInstanceOutline
- ),
- new NanostoresSyncObject("hoveredInstanceOutline", $hoveredInstanceOutline),
new NanostoresSyncObject("blockChildOutline", $blockChildOutline),
new NanostoresSyncObject("instanceContextMenu", $instanceContextMenu),
new NanostoresSyncObject("modifierKeys", $modifierKeys),
diff --git a/apps/builder/app/shared/system.test.ts b/apps/builder/app/shared/system.test.ts
index 03a6402a9b..52da7bb8df 100644
--- a/apps/builder/app/shared/system.test.ts
+++ b/apps/builder/app/shared/system.test.ts
@@ -3,7 +3,7 @@ import type { Page, Pages } from "@webstudio-is/sdk";
import { $pages } from "~/shared/sync/data-stores";
import { registerContainers } from "~/shared/sync/sync-stores";
import { updateCurrentSystem } from "./system";
-import { selectPage } from "./awareness";
+import { selectPage } from "./nano-states";
registerContainers();
diff --git a/apps/builder/app/shared/system.ts b/apps/builder/app/shared/system.ts
index dfa0df2659..7af3fd5196 100644
--- a/apps/builder/app/shared/system.ts
+++ b/apps/builder/app/shared/system.ts
@@ -5,8 +5,9 @@ import {
matchPathnamePattern,
tokenizePathnamePattern,
} from "~/builder/shared/url-pattern";
-import { $selectedPage } from "./awareness";
-import { $pages, $publishedOrigin } from "./nano-states";
+import { $selectedPage } from "./nano-states/pages";
+import { $pages } from "./sync/data-stores";
+import { $publishedOrigin } from "./nano-states/misc";
import { serverSyncStore } from "./sync/sync-stores";
export const $systemDataByPage = atom(
diff --git a/apps/builder/app/shared/tailwind/tailwind.ts b/apps/builder/app/shared/tailwind/tailwind.ts
index 751eab5412..d65d03326b 100644
--- a/apps/builder/app/shared/tailwind/tailwind.ts
+++ b/apps/builder/app/shared/tailwind/tailwind.ts
@@ -14,7 +14,7 @@ import {
type Prop,
type WebstudioFragment,
} from "@webstudio-is/sdk";
-import { isBaseBreakpoint } from "../nano-states";
+import { isBaseBreakpoint } from "../breakpoints-utils";
import { preflight } from "./__generated__/preflight";
// breakpoints used to map tailwind classes to webstudio breakpoints
diff --git a/apps/builder/app/shared/trpc/trpc-client.ts b/apps/builder/app/shared/trpc/trpc-client.ts
index 529ebd8a4a..2cc9be28c1 100644
--- a/apps/builder/app/shared/trpc/trpc-client.ts
+++ b/apps/builder/app/shared/trpc/trpc-client.ts
@@ -11,14 +11,20 @@ import { createRecursiveProxy } from "@trpc/server/shared";
import { useMemo, useState } from "react";
import { fetch } from "~/shared/fetch.client";
-export const nativeClient = createTRPCProxyClient<AppRouter>({
- links: [
- httpBatchLink({
- fetch,
- url: "/trpc",
- }),
- ],
-});
+export const createNativeClient = (
+ headers?: Record<string, string | undefined>
+) =>
+ createTRPCProxyClient<AppRouter>({
+ links: [
+ httpBatchLink({
+ fetch,
+ headers: () => headers ?? {},
+ url: "/trpc",
+ }),
+ ],
+ });
+
+export const nativeClient = createNativeClient();
type Procedures<T> = T extends AnyRouter
? {
diff --git a/apps/builder/package.json b/apps/builder/package.json
index 7f4ea59c1c..9da70baebf 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -64,6 +64,7 @@
"@webstudio-is/dashboard": "workspace:*",
"@webstudio-is/design-system": "workspace:*",
"@webstudio-is/domain": "workspace:*",
+ "@webstudio-is/sync-client": "workspace:*",
"@webstudio-is/feature-flags": "workspace:*",
"@webstudio-is/fonts": "workspace:*",
"@webstudio-is/html-data": "workspace:*",
diff --git a/apps/builder/tsconfig.json b/apps/builder/tsconfig.json
index ccbf7285e9..1b03f4b129 100644
--- a/apps/builder/tsconfig.json
+++ b/apps/builder/tsconfig.json
@@ -1,6 +1,7 @@
{
"extends": "@webstudio-is/tsconfig/base.json",
"include": ["app", "**/*.ts", "**/*.tsx", "../../@types/**/*.d.ts"],
+ "exclude": ["node_modules", "party"],
"compilerOptions": {
"target": "ES2023",
diff --git a/apps/builder/vite.config.ts b/apps/builder/vite.config.ts
index ad2d690a59..a9bec86157 100644
--- a/apps/builder/vite.config.ts
+++ b/apps/builder/vite.config.ts
@@ -1,5 +1,5 @@
import path, { resolve } from "node:path";
-import { defineConfig, type CorsOptions } from "vite";
+import { defineConfig, loadEnv, type CorsOptions } from "vite";
import { vitePlugin as remix } from "@remix-run/dev";
import { vercelPreset } from "@vercel/remix/vite";
import type { IncomingMessage } from "node:http";
@@ -32,6 +32,12 @@ export default defineConfig(({ mode }) => {
process.env.NODE_TLS_REJECT_UNAUTHORIZED = "0";
}
+ const env = loadEnv(mode, __dirname, "");
+ const collabRelayProxyTarget =
+ process.env.COLLAB_RELAY_PROXY_TARGET ??
+ env.COLLAB_RELAY_PROXY_TARGET ??
+ "http://127.0.0.1:1999";
+
return {
plugins: [
remix({
@@ -48,6 +54,30 @@ export default defineConfig(({ mode }) => {
name: "request-timing-logger",
configureServer(server) {
server.middlewares.use((req, res, next) => {
+ // Some dev proxies can forward HTTP/2 pseudo-headers such as
+ // ":method". Remix converts Node headers to Fetch Headers, where
+ // those names are invalid and crash before the request reaches app
+ // code. Vite still needs a normal req.url, so preserve ":path"
+ // before removing the pseudo-headers.
+ if (req.url === undefined) {
+ const path = req.headers[":path"];
+ if (typeof path === "string") {
+ req.url = path;
+ }
+ }
+ for (const header of Object.keys(req.headers)) {
+ if (header.startsWith(":")) {
+ delete req.headers[header];
+ }
+ }
+ // Pre-bundled dep chunks must never be served from a stale browser
+ // cache. Vite uses ?v= to bust the cache, but some browsers (or
+ // service workers) still serve cached chunks with old hashes,
+ // causing duplicate-React errors during hydration. no-store removes
+ // the files from the browser cache entirely.
+ if (req.url?.includes("/node_modules/.vite/deps/")) {
+ res.setHeader("Cache-Control", "no-store");
+ }
const start = Date.now();
res.on("finish", () => {
const duration = Date.now() - start;
@@ -94,9 +124,12 @@ export default defineConfig(({ mode }) => {
server: {
// Service-to-service OAuth token call requires a specified host for the wstd.dev domain
host: "wstd.dev",
- // Needed for SSL
- proxy: {},
-
+ proxy: {
+ "/collab-relay": {
+ target: collabRelayProxyTarget,
+ ws: true,
+ },
+ },
https: {
key: readFileSync("../../https/privkey.pem"),
cert: readFileSync("../../https/fullchain.pem"),
@@ -135,6 +168,6 @@ export default defineConfig(({ mode }) => {
});
}) as never,
},
- envPrefix: "GITHUB_",
+ envPrefix: ["GITHUB_", "PUBLIC_"],
};
});
diff --git a/packages/asset-uploader/package.json b/packages/asset-uploader/package.json
index b502889643..93399ddd29 100644
--- a/packages/asset-uploader/package.json
+++ b/packages/asset-uploader/package.json
@@ -13,6 +13,7 @@
"@aws-crypto/sha256-js": "^5.2.0",
"@smithy/signature-v4": "^5.1.3",
"@webstudio-is/fonts": "workspace:*",
+ "@webstudio-is/postgrest": "workspace:*",
"@webstudio-is/sdk": "workspace:*",
"@webstudio-is/trpc-interface": "workspace:*",
"fontkit": "^2.0.4",
@@ -23,7 +24,6 @@
},
"devDependencies": {
"@types/fontkit": "^2.0.8",
- "@webstudio-is/postgrest": "workspace:*",
"@webstudio-is/tsconfig": "workspace:*",
"msw": "^2.13.2",
"vitest": "^3.1.2",
@@ -35,6 +35,10 @@
},
"./index.server": {
"webstudio": "./src/index.server.ts"
+ },
+ "./patch-assets-core.server": {
+ "webstudio": "./src/asset-patch-core.ts",
+ "import": "./src/asset-patch-core.ts"
}
},
"license": "AGPL-3.0-or-later",
diff --git a/packages/asset-uploader/src/asset-patch-core.ts b/packages/asset-uploader/src/asset-patch-core.ts
new file mode 100644
index 0000000000..03a979199e
--- /dev/null
+++ b/packages/asset-uploader/src/asset-patch-core.ts
@@ -0,0 +1,189 @@
+import { type Patch, applyPatches } from "immer";
+import { type Asset, Assets } from "@webstudio-is/sdk";
+import type { Client } from "@webstudio-is/postgrest/index.server";
+import { formatAsset } from "./utils/format-asset";
+
+const assertPostgrestSuccess = (result: { error: unknown }) => {
+ if (result.error) {
+ throw result.error;
+ }
+};
+
+export const loadAssetsByProjectWithClient = async (
+ projectId: string,
+ client: Client
+): Promise<Asset[]> => {
+ const assets = await client
+ .from("Asset")
+ // use inner to filter out assets without file
+ // when file is not uploaded
+ .select(
+ `
+ assetId:id,
+ projectId,
+ filename,
+ description,
+ file:File!inner (*)
+ `
+ )
+ .eq("projectId", projectId)
+ .eq("file.status", "UPLOADED")
+ // always sort by primary key to get stable list
+ // required to not break fixtures
+ .order("id");
+ assertPostgrestSuccess(assets);
+
+ const result: Asset[] = [];
+ for (const {
+ assetId,
+ projectId,
+ filename,
+ description,
+ file,
+ } of assets.data ?? []) {
+ if (file) {
+ result.push(
+ formatAsset({ assetId, projectId, filename, description, file })
+ );
+ }
+ }
+
+ return result;
+};
+
+export const deleteAssetsWithClient = async (
+ props: {
+ ids: Array<Asset["id"]>;
+ projectId: string;
+ },
+ client: Client
+): Promise<void> => {
+ const assets = await client
+ .from("Asset")
+ .select(
+ `
+ id,
+ projectId,
+ name,
+ file:File!inner (*)
+ `
+ )
+ .in("id", props.ids)
+ .eq("projectId", props.projectId);
+ assertPostgrestSuccess(assets);
+
+ if ((assets.data ?? []).length === 0) {
+ throw new Error("Assets not found");
+ }
+
+ const previewUpdate = await client
+ .from("Project")
+ .update({ previewImageAssetId: null })
+ .eq("id", props.projectId)
+ .in("previewImageAssetId", props.ids);
+ assertPostgrestSuccess(previewUpdate);
+
+ const deletedAssets = await client
+ .from("Asset")
+ .delete()
+ .in("id", props.ids)
+ .eq("projectId", props.projectId);
+ assertPostgrestSuccess(deletedAssets);
+
+ const unusedFileNames = new Set(assets.data?.map((asset) => asset.name));
+ const assetsByStillUsedFileName = await client
+ .from("Asset")
+ .select("name")
+ .in("name", Array.from(unusedFileNames));
+ assertPostgrestSuccess(assetsByStillUsedFileName);
+ for (const asset of assetsByStillUsedFileName.data ?? []) {
+ unusedFileNames.delete(asset.name);
+ }
+
+ if (unusedFileNames.size > 0) {
+ const deletedFiles = await client
+ .from("File")
+ .update({ isDeleted: true })
+ .in("name", Array.from(unusedFileNames));
+ assertPostgrestSuccess(deletedFiles);
+ }
+};
+
+/**
+ * patchAssetsWithClient can only delete, add, or update asset metadata.
+ */
+export const patchAssetsWithClient = async (
+ { projectId, client }: { projectId: string; client: Client },
+ patches: Array<Patch>
+): Promise<void> => {
+ const assetsList = await loadAssetsByProjectWithClient(projectId, client);
+ const assets = new Map<Asset["id"], Asset>();
+ for (const asset of assetsList) {
+ assets.set(asset.id, asset);
+ }
+ const patchedAssets = applyPatches(assets, patches);
+ // validate assets without recreating objects
+ // we expect referencial equality to find updated assets
+ Assets.parse(patchedAssets);
+
+ const deletedAssetIds: Asset["id"][] = [];
+ for (const assetId of assets.keys()) {
+ if (patchedAssets.has(assetId) === false) {
+ deletedAssetIds.push(assetId);
+ }
+ }
+ if (deletedAssetIds.length !== 0) {
+ await deleteAssetsWithClient({ projectId, ids: deletedAssetIds }, client);
+ }
+
+ for (const asset of assets.values()) {
+ const patchedAsset = patchedAssets.get(asset.id);
+ if (asset !== patchedAsset && patchedAsset) {
+ const { filename, description } = patchedAsset;
+ const updatedAsset = await client
+ .from("Asset")
+ .update({ filename, description })
+ .eq("id", asset.id)
+ .eq("projectId", asset.projectId);
+ assertPostgrestSuccess(updatedAsset);
+ }
+ }
+
+ const addedAssets: Asset[] = [];
+ for (const [assetId, asset] of patchedAssets) {
+ if (assets.has(assetId) === false) {
+ addedAssets.push(asset);
+ }
+ }
+ if (addedAssets.length !== 0) {
+ const files = await client
+ .from("File")
+ .select()
+ .in(
+ "name",
+ addedAssets.map((asset) => asset.name)
+ );
+ assertPostgrestSuccess(files);
+
+ const fileNames = new Set(files.data?.map((file) => file.name));
+
+ // restore file when undo is triggered
+ const restoredFiles = await client
+ .from("File")
+ .update({ isDeleted: false })
+ .in("name", Array.from(fileNames));
+ assertPostgrestSuccess(restoredFiles);
+
+ const insertedAssets = await client.from("Asset").insert(
+ addedAssets
+ // making sure corresponding file exist before creating an asset that references it
+ .filter((asset) => fileNames.has(asset.name))
+ .map((asset) => ({
+ id: asset.id,
+ projectId,
+ name: asset.name,
+ }))
+ );
+ assertPostgrestSuccess(insertedAssets);
+ }
+};
diff --git a/packages/asset-uploader/src/db/load.ts b/packages/asset-uploader/src/db/load.ts
index 3a3cad0ed6..1545ec05f8 100644
--- a/packages/asset-uploader/src/db/load.ts
+++ b/packages/asset-uploader/src/db/load.ts
@@ -4,7 +4,7 @@ import {
AuthorizationError,
} from "@webstudio-is/trpc-interface/index.server";
import type { Asset } from "@webstudio-is/sdk";
-import { formatAsset } from "../utils/format-asset";
+import { loadAssetsByProjectWithClient } from "../asset-patch-core";
export const loadAssetsByProject = async (
projectId: string,
@@ -24,39 +24,5 @@ export const loadAssetsByProject = async (
);
}
- const assets = await context.postgrest.client
- .from("Asset")
- // use inner to filter out assets without file
- // when file is not uploaded
- .select(
- `
- assetId:id,
- projectId,
- filename,
- description,
- file:File!inner (*)
- `
- )
- .eq("projectId", projectId)
- .eq("file.status", "UPLOADED")
- // always sort by primary key to get stable list
- // required to not break fixtures
- .order("id");
-
- const result: Asset[] = [];
- for (const {
- assetId,
- projectId,
- filename,
- description,
- file,
- } of assets.data ?? []) {
- if (file) {
- result.push(
- formatAsset({ assetId, projectId, filename, description, file })
- );
- }
- }
-
- return result;
+ return loadAssetsByProjectWithClient(projectId, context.postgrest.client);
};
diff --git a/packages/asset-uploader/src/delete.ts b/packages/asset-uploader/src/delete.ts
index 93412a04e1..83562287ca 100644
--- a/packages/asset-uploader/src/delete.ts
+++ b/packages/asset-uploader/src/delete.ts
@@ -4,6 +4,7 @@ import {
AuthorizationError,
} from "@webstudio-is/trpc-interface/index.server";
import type { Asset } from "@webstudio-is/sdk";
+import { deleteAssetsWithClient } from "./asset-patch-core";
export const deleteAssets = async (
props: {
@@ -23,50 +24,5 @@ export const deleteAssets = async (
);
}
- const assets = await context.postgrest.client
- .from("Asset")
- .select(
- `
- id,
- projectId,
- name,
- file:File!inner (*)
- `
- )
- .in("id", props.ids)
- .eq("projectId", props.projectId);
-
- if ((assets.data ?? []).length === 0) {
- throw new Error("Assets not found");
- }
-
- await context.postgrest.client
- .from("Project")
- .update({ previewImageAssetId: null })
- .eq("id", props.projectId)
- .in("previewImageAssetId", props.ids);
-
- await context.postgrest.client
- .from("Asset")
- .delete()
- .in("id", props.ids)
- .eq("projectId", props.projectId);
-
- // find unused files
- const unusedFileNames = new Set(assets.data?.map((asset) => asset.name));
- const assetsByStillUsedFileName = await context.postgrest.client
- .from("Asset")
- .select("name")
- .in("name", Array.from(unusedFileNames));
- for (const asset of assetsByStillUsedFileName.data ?? []) {
- unusedFileNames.delete(asset.name);
- }
-
- // delete unused files
- if (unusedFileNames.size > 0) {
- await context.postgrest.client
- .from("File")
- .update({ isDeleted: true })
- .in("name", Array.from(unusedFileNames));
- }
+ await deleteAssetsWithClient(props, context.postgrest.client);
};
diff --git a/packages/asset-uploader/src/index.server.ts b/packages/asset-uploader/src/index.server.ts
index 90a84bf654..b832609539 100644
--- a/packages/asset-uploader/src/index.server.ts
+++ b/packages/asset-uploader/src/index.server.ts
@@ -2,5 +2,6 @@ export * from "./db";
export * from "./upload";
export * from "./delete";
export * from "./patch";
+export * from "./asset-patch-core";
export * from "./clients/fs/fs";
export * from "./clients/s3/s3";
diff --git a/packages/asset-uploader/src/patch.test.ts b/packages/asset-uploader/src/patch.test.ts
index 67fdc256ac..f019efe9a0 100644
--- a/packages/asset-uploader/src/patch.test.ts
+++ b/packages/asset-uploader/src/patch.test.ts
@@ -8,6 +8,7 @@ import {
testContext,
} from "@webstudio-is/postgrest/testing";
import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
+import { patchAssetsWithClient } from "./asset-patch-core";
import { patchAssets } from "./patch";
import type { Patch } from "immer";
@@ -148,4 +149,199 @@ describe("patchAssets (msw)", () => {
await patchAssets({ projectId }, patches, createContext());
expect(insertedAssets).toBeDefined();
});
+
+ test("core helper deletes assets and marks unused files as deleted", async () => {
+ const projectId = uid();
+ const localAssetRow = { ...assetRow, projectId };
+ let resetPreviewImage = false;
+ let deletedAsset = false;
+ let deletedFile = false;
+
+ server.use(
+ db.get("Asset", ({ request }) => {
+ const url = new URL(request.url);
+ if (url.searchParams.has("id")) {
+ return json([
+ {
+ id: "asset-1",
+ projectId,
+ name: "photo.jpg",
+ file: localAssetRow.file,
+ },
+ ]);
+ }
+ if (url.searchParams.has("name")) {
+ return json([]);
+ }
+ return json([localAssetRow]);
+ }),
+ db.patch("Project", async ({ request }) => {
+ const body = (await request.json()) as {
+ previewImageAssetId?: string | null;
+ };
+ resetPreviewImage = body.previewImageAssetId === null;
+ return empty({ status: 204 });
+ }),
+ db.delete("Asset", () => {
+ deletedAsset = true;
+ return empty({ status: 204 });
+ }),
+ db.patch("File", async ({ request }) => {
+ const body = (await request.json()) as { isDeleted?: boolean };
+ deletedFile = body.isDeleted === true;
+ return empty({ status: 204 });
+ })
+ );
+
+ const patches: Patch[] = [
+ {
+ op: "remove",
+ path: ["asset-1"],
+ },
+ ];
+
+ await patchAssetsWithClient(
+ { projectId, client: testContext.postgrest.client },
+ patches
+ );
+
+ expect(resetPreviewImage).toBe(true);
+ expect(deletedAsset).toBe(true);
+ expect(deletedFile).toBe(true);
+ });
+
+ test("core helper stops asset deletion when preview reset fails", async () => {
+ const projectId = uid();
+ const localAssetRow = { ...assetRow, projectId };
+ let deletedAsset = false;
+
+ server.use(
+ db.get("Asset", ({ request }) => {
+ const url = new URL(request.url);
+ if (url.searchParams.has("id")) {
+ return json([
+ {
+ id: "asset-1",
+ projectId,
+ name: "photo.jpg",
+ file: localAssetRow.file,
+ },
+ ]);
+ }
+ return json([localAssetRow]);
+ }),
+ db.patch("Project", () => json({ message: "db error" }, { status: 500 })),
+ db.delete("Asset", () => {
+ deletedAsset = true;
+ return empty({ status: 204 });
+ })
+ );
+
+ const patches: Patch[] = [
+ {
+ op: "remove",
+ path: ["asset-1"],
+ },
+ ];
+
+ await expect(
+ patchAssetsWithClient(
+ { projectId, client: testContext.postgrest.client },
+ patches
+ )
+ ).rejects.toThrow();
+
+ expect(deletedAsset).toBe(false);
+ });
+
+ test("core helper stops file cleanup when asset delete fails", async () => {
+ const projectId = uid();
+ const localAssetRow = { ...assetRow, projectId };
+ let deletedFile = false;
+
+ server.use(
+ db.get("Asset", ({ request }) => {
+ const url = new URL(request.url);
+ if (url.searchParams.has("id")) {
+ return json([
+ {
+ id: "asset-1",
+ projectId,
+ name: "photo.jpg",
+ file: localAssetRow.file,
+ },
+ ]);
+ }
+ if (url.searchParams.has("name")) {
+ return json([]);
+ }
+ return json([localAssetRow]);
+ }),
+ db.patch("Project", () => empty({ status: 204 })),
+ db.delete("Asset", () => json({ message: "db error" }, { status: 500 })),
+ db.patch("File", () => {
+ deletedFile = true;
+ return empty({ status: 204 });
+ })
+ );
+
+ const patches: Patch[] = [
+ {
+ op: "remove",
+ path: ["asset-1"],
+ },
+ ];
+
+ await expect(
+ patchAssetsWithClient(
+ { projectId, client: testContext.postgrest.client },
+ patches
+ )
+ ).rejects.toThrow();
+
+ expect(deletedFile).toBe(false);
+ });
+
+ test("core helper stops asset insert when file restore fails", async () => {
+ const projectId = uid();
+ let insertedAssets = false;
+
+ server.use(
+ db.get("Asset", () => json([])),
+ db.get("File", () => json([{ name: "new.jpg" }])),
+ db.patch("File", () => json({ message: "db error" }, { status: 500 })),
+ db.post("Asset", () => {
+ insertedAssets = true;
+ return empty({ status: 201 });
+ })
+ );
+
+ const patches: Patch[] = [
+ {
+ op: "add",
+ path: ["asset-new"],
+ value: {
+ id: "asset-new",
+ name: "new.jpg",
+ type: "image",
+ projectId,
+ format: "jpg",
+ size: 500,
+ description: null,
+ createdAt: "2024-01-01T00:00:00.000Z",
+ path: "",
+ meta: { width: 50, height: 50 },
+ },
+ },
+ ];
+
+ await expect(
+ patchAssetsWithClient(
+ { projectId, client: testContext.postgrest.client },
+ patches
+ )
+ ).rejects.toThrow();
+
+ expect(insertedAssets).toBe(false);
+ });
});
diff --git a/packages/asset-uploader/src/patch.ts b/packages/asset-uploader/src/patch.ts
index 32669d2fb1..dda24346e7 100644
--- a/packages/asset-uploader/src/patch.ts
+++ b/packages/asset-uploader/src/patch.ts
@@ -1,15 +1,13 @@
-import { type Patch, applyPatches } from "immer";
+import type { Patch } from "immer";
import {
type AppContext,
authorizeProject,
} from "@webstudio-is/trpc-interface/index.server";
-import { type Asset, Assets } from "@webstudio-is/sdk";
-import { deleteAssets } from "./delete";
-import { loadAssetsByProject } from "./db/load";
+import { patchAssetsWithClient } from "./asset-patch-core";
/**
- * patchAssets can only delete or add assets
- * update patches are ignored
+ * patchAssets applies asset metadata updates, deletions, and undo restores after
+ * the app layer confirms project edit access.
*/
export const patchAssets = async (
{ projectId }: { projectId: string },
@@ -24,73 +22,8 @@ export const patchAssets = async (
throw new Error("You don't have edit access to this project");
}
- const assetsList = await loadAssetsByProject(projectId, context);
- const assets = new Map<Asset["id"], Asset>();
- for (const asset of assetsList) {
- assets.set(asset.id, asset);
- }
- const patchedAssets = applyPatches(assets, patches);
- // validate assets without recreating objects
- // we expect referencial equality to find updated assets
- Assets.parse(patchedAssets);
-
- // delete assets no longer existing in patched version
- const deletedAssetIds: Asset["id"][] = [];
- for (const assetId of assets.keys()) {
- if (patchedAssets.has(assetId) === false) {
- deletedAssetIds.push(assetId);
- }
- }
- if (deletedAssetIds.length !== 0) {
- deleteAssets({ projectId, ids: deletedAssetIds }, context);
- }
-
- // update assets
- for (const asset of assets.values()) {
- const patchedAsset = patchedAssets.get(asset.id);
- if (asset !== patchedAsset && patchedAsset) {
- const { filename, description } = patchedAsset;
- await context.postgrest.client
- .from("Asset")
- .update({ filename, description })
- .eq("id", asset.id)
- .eq("projectId", asset.projectId);
- }
- }
-
- // add new assets found in patched version
- const addedAssets: Asset[] = [];
- for (const [assetId, asset] of patchedAssets) {
- if (assets.has(assetId) === false) {
- addedAssets.push(asset);
- }
- }
- if (addedAssets.length !== 0) {
- const files = await context.postgrest.client
- .from("File")
- .select()
- .in(
- "name",
- addedAssets.map((asset) => asset.name)
- );
-
- const fileNames = new Set(files.data?.map((file) => file.name));
-
- // restore file when undo is triggered
- await context.postgrest.client
- .from("File")
- .update({ isDeleted: false })
- .in("name", Array.from(fileNames));
-
- await context.postgrest.client.from("Asset").insert(
- addedAssets
- // making sure corresponding file exist before creating an asset that references it
- .filter((asset) => fileNames.has(asset.name))
- .map((asset) => ({
- id: asset.id,
- projectId,
- name: asset.name,
- }))
- );
- }
+ await patchAssetsWithClient(
+ { projectId, client: context.postgrest.client },
+ patches
+ );
};
diff --git a/packages/css-engine/src/color.ts b/packages/css-engine/src/color.ts
index 4e7bfd1ad8..8206433973 100644
--- a/packages/css-engine/src/color.ts
+++ b/packages/css-engine/src/color.ts
@@ -33,7 +33,7 @@ colorjs.ColorSpace.registry["display-p3"] = colorjs.P3;
colorjs.ColorSpace.registry["a98-rgb"] = colorjs.A98RGB;
colorjs.ColorSpace.registry["prophoto-rgb"] = colorjs.ProPhoto;
-// Re-export colorjs as `color` so consumers never need to import colorjs.io/fn
+// Export colorjs as `color` so consumers never need to import colorjs.io/fn
// directly. Importing this module guarantees all color spaces are registered.
export const color = colorjs;
diff --git a/packages/design-system/package.json b/packages/design-system/package.json
index ffc7e89522..02c54a2bd1 100644
--- a/packages/design-system/package.json
+++ b/packages/design-system/package.json
@@ -77,6 +77,9 @@
".": {
"webstudio": "./src/index.ts"
},
+ "./colors": {
+ "webstudio": "./src/colors.ts"
+ },
"./test-setup": "./src/test-setup.ts"
},
"license": "AGPL-3.0-or-later",
diff --git a/packages/design-system/src/components/color-picker.test.ts b/packages/design-system/src/components/color-picker.test.ts
index 20f757617c..4be243b39d 100644
--- a/packages/design-system/src/components/color-picker.test.ts
+++ b/packages/design-system/src/components/color-picker.test.ts
@@ -2,7 +2,47 @@ import { describe, test, expect } from "vitest";
import type { ColorSpace } from "hdr-color-input";
import type { ColorValue } from "@webstudio-is/css-engine";
import { __testing__ } from "./color-picker";
-const { cssStringToStyleValue } = __testing__;
+const { cssStringToStyleValue, shouldCommitColorChange } = __testing__;
+
+describe("shouldCommitColorChange", () => {
+ test("returns false when values serialize identically", () => {
+ expect(
+ shouldCommitColorChange(
+ {
+ type: "color",
+ colorSpace: "srgb",
+ components: [1, 0, 0],
+ alpha: 1,
+ },
+ {
+ type: "color",
+ colorSpace: "srgb",
+ components: [1, 0, 0],
+ alpha: 1,
+ }
+ )
+ ).toBe(false);
+ });
+
+ test("returns true when values differ", () => {
+ expect(
+ shouldCommitColorChange(
+ {
+ type: "color",
+ colorSpace: "srgb",
+ components: [1, 0, 0],
+ alpha: 1,
+ },
+ {
+ type: "color",
+ colorSpace: "srgb",
+ components: [0, 1, 0],
+ alpha: 1,
+ }
+ )
+ ).toBe(true);
+ });
+});
// All ColorSpace values from hdr-color-input and their expected CSS input strings
// (as <color-input> would emit in its change event).
diff --git a/packages/design-system/src/components/color-picker.tsx b/packages/design-system/src/components/color-picker.tsx
index 4c9f201282..86bcf7b417 100644
--- a/packages/design-system/src/components/color-picker.tsx
+++ b/packages/design-system/src/components/color-picker.tsx
@@ -150,11 +150,21 @@ type ColorPickerProps = {
disabled?: boolean;
};
+const shouldCommitColorChange = (
+ previousValue: StyleValue,
+ nextValue: StyleValue
+) => {
+ return toValue(previousValue) !== toValue(nextValue);
+};
+
// Renders <color-input> with its built-in trigger chip, hiding the text input.
// The chip opens the panel natively via the Popover API.
// Our own ColorThumb is rendered on top (pointer-events: none) so that clicks
// pass through to the real chip underneath.
-export const __testing__ = { cssStringToStyleValue };
+export const __testing__ = {
+ cssStringToStyleValue,
+ shouldCommitColorChange,
+};
export const ColorPicker = ({
value,
@@ -244,7 +254,23 @@ export const ColorPicker = ({
const controller = new AbortController();
const { signal } = controller;
+ let isOpen = false;
let lastStyleValue: StyleValue = callbacksRef.current.value;
+ let lastCommittedStyleValue: StyleValue = callbacksRef.current.value;
+
+ const commitIfChanged = () => {
+ if (disabled) {
+ return;
+ }
+ if (
+ shouldCommitColorChange(lastCommittedStyleValue, lastStyleValue) ===
+ false
+ ) {
+ return;
+ }
+ lastCommittedStyleValue = lastStyleValue;
+ callbacksRef.current.onChangeComplete(lastStyleValue);
+ };
colorInputElement.addEventListener(
"change",
@@ -273,6 +299,7 @@ export const ColorPicker = ({
// Set contrast immediately on open so the initial color is correct
// before any change event fires (the component's own JS sets --contrast
// based on raw color only, ignoring alpha).
+ isOpen = true;
callbacksRef.current.disableCanvasPointerEvents();
document.body.style.userSelect = "none";
callbacksRef.current.onOpenChange?.(true);
@@ -281,15 +308,30 @@ export const ColorPicker = ({
{ signal }
);
+ const handleInteractionEnd = () => {
+ if (isOpen === false) {
+ return;
+ }
+ commitIfChanged();
+ };
+
+ document.addEventListener("pointerup", handleInteractionEnd, {
+ signal,
+ capture: true,
+ });
+ document.addEventListener("pointercancel", handleInteractionEnd, {
+ signal,
+ capture: true,
+ });
+
colorInputElement.addEventListener(
"close",
() => {
+ isOpen = false;
callbacksRef.current.enableCanvasPointerEvents();
document.body.style.removeProperty("user-select");
callbacksRef.current.onOpenChange?.(false);
- if (!disabled) {
- callbacksRef.current.onChangeComplete(lastStyleValue);
- }
+ commitIfChanged();
},
{ signal }
);
diff --git a/packages/feature-flags/src/flags.ts b/packages/feature-flags/src/flags.ts
index 0a952b87c8..fc900c9be5 100644
--- a/packages/feature-flags/src/flags.ts
+++ b/packages/feature-flags/src/flags.ts
@@ -3,3 +3,4 @@ export const internalComponents = false;
export const unsupportedBrowsers = false;
export const resourceProp = false;
export const tailwind = false;
+export const collabRelay = false;
diff --git a/packages/multiplayer-protocol/package.json b/packages/multiplayer-protocol/package.json
new file mode 100644
index 0000000000..ab1de78e2f
--- /dev/null
+++ b/packages/multiplayer-protocol/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "@webstudio-is/multiplayer-protocol",
+ "version": "0.0.0",
+ "description": "Wire protocol for Webstudio multiplayer synchronization",
+ "author": "Webstudio <[email protected]>",
+ "license": "AGPL-3.0-or-later",
+ "type": "module",
+ "exports": {
+ ".": {
+ "webstudio": "./src/index.ts",
+ "import": "./src/index.ts",
+ "default": "./src/index.ts"
+ }
+ },
+ "sideEffects": false,
+ "scripts": {
+ "typecheck": "tsgo --noEmit",
+ "test": "vitest run"
+ },
+ "devDependencies": {
+ "@webstudio-is/tsconfig": "workspace:*",
+ "vitest": "^3.1.2"
+ }
+}
diff --git a/packages/multiplayer-protocol/src/index.test.ts b/packages/multiplayer-protocol/src/index.test.ts
new file mode 100644
index 0000000000..cd5e54cb88
--- /dev/null
+++ b/packages/multiplayer-protocol/src/index.test.ts
@@ -0,0 +1,56 @@
+import { describe, expect, test } from "vitest";
+import { stripRevisePatchesFromTransaction } from ".";
+
+describe("stripRevisePatchesFromTransaction", () => {
+ test("removes revisePatches from server payload entries", () => {
+ const transaction = {
+ id: "tx-1",
+ object: "server",
+ payload: [
+ {
+ namespace: "instances",
+ patches: [{ op: "add", path: ["x"], value: 1 }],
+ revisePatches: [{ op: "remove", path: ["x"] }],
+ },
+ ],
+ };
+
+ const stripped = stripRevisePatchesFromTransaction(transaction);
+
+ expect(stripped.payload).toEqual([
+ {
+ namespace: "instances",
+ patches: [{ op: "add", path: ["x"], value: 1 }],
+ },
+ ]);
+ });
+
+ test("keeps non-server transactions unchanged", () => {
+ const transaction = {
+ id: "tx-2",
+ object: "client",
+ payload: { selected: ["id-1"] },
+ };
+
+ const stripped = stripRevisePatchesFromTransaction(transaction);
+
+ expect(stripped).toBe(transaction);
+ });
+
+ test("returns same object when no revisePatches exist", () => {
+ const transaction = {
+ id: "tx-3",
+ object: "server",
+ payload: [
+ {
+ namespace: "instances",
+ patches: [{ op: "add", path: ["x"], value: 1 }],
+ },
+ ],
+ };
+
+ const stripped = stripRevisePatchesFromTransaction(transaction);
+
+ expect(stripped).toBe(transaction);
+ });
+});
diff --git a/packages/multiplayer-protocol/src/index.ts b/packages/multiplayer-protocol/src/index.ts
new file mode 100644
index 0000000000..457fc25195
--- /dev/null
+++ b/packages/multiplayer-protocol/src/index.ts
@@ -0,0 +1,148 @@
+/**
+ * Relay protocol types - the messages exchanged between clients and the
+ * multiplayer relay service.
+ */
+export type Transaction<Payload = unknown> = {
+ id: string;
+ object: string;
+ payload: Payload;
+};
+
+export type RevertedTransaction = {
+ id: string;
+ object: string;
+};
+
+export type CollaboratorInfo = {
+ name?: string;
+ avatarUrl?: string;
+ pageId?: string;
+ selectedInstanceIds?: string[];
+ pointerPosition?: {
+ x: number;
+ y: number;
+ xRatio: number;
+ yRatio: number;
+ };
+ lastSeen?: number;
+};
+
+export type ApplyMessage = {
+ type: "apply";
+ transactionId: string;
+ transaction: Transaction;
+ clientId: string;
+ actorId: string;
+ clientSeq: number;
+};
+
+export type BroadcastMessage = {
+ type: "broadcast";
+ transaction: Transaction;
+ originClientId: string;
+ seq: number;
+ actorId: string;
+ clientSeq: number;
+ relayTs: number;
+};
+
+export type AckMessage = { type: "ack"; seq: number; version: number };
+
+export type ReloadMessage = {
+ type: "reload";
+ reason: "version_mismatched" | "persistence_error";
+ errors?: string;
+};
+
+export const rateLimitedErrorMessage =
+ "You're sending changes faster than they can be synced. Please pause for a moment and try again.";
+
+export const persistenceBacklogErrorMessage =
+ "Collaboration is catching up. Please pause for a moment while changes are saved.";
+
+export type ErrorMessage = {
+ type: "error";
+ code: "rate_limited" | "persistence_backlog_full";
+ message: string;
+ transactionId?: string;
+ retryAfterMs?: number;
+};
+
+export type AppliedMessage = {
+ type: "applied";
+ transactionId: string;
+ seq: number;
+ status: /** Rejected by the service without applying or saving. */
+ | "dropped"
+ /** Rejected by persistence authorization. */
+ | "rejected"
+ /** Could not be persisted after the relay accepted it. */
+ | "failed"
+ /** Already sequenced earlier; still wait for ack before treating it as durable. */
+ | "settled";
+ errors?: string;
+};
+
+export type RevertMessage = {
+ type: "revert";
+ clientId: string;
+ transaction: RevertedTransaction;
+};
+
+export type PresenceMessage = {
+ type: "presence";
+ clientId: string;
+ payload: unknown;
+};
+
+export type RelayClientMessage = ApplyMessage | PresenceMessage;
+
+export type RelayServerMessage =
+ | BroadcastMessage
+ | AckMessage
+ | AppliedMessage
+ | RevertMessage
+ | ReloadMessage
+ | ErrorMessage
+ | PresenceMessage;
+
+export const stripRevisePatchesFromTransaction = (
+ transaction: Transaction
+): Transaction => {
+ if (transaction.object !== "server" || !Array.isArray(transaction.payload)) {
+ return transaction;
+ }
+
+ let changed = false;
+ const nextPayload = transaction.payload.map((entry) => {
+ if (
+ entry === null ||
+ typeof entry !== "object" ||
+ Array.isArray(entry) ||
+ !Object.hasOwn(entry, "revisePatches")
+ ) {
+ return entry;
+ }
+ changed = true;
+ const { revisePatches: _revisePatches, ...rest } = entry as Record<
+ string,
+ unknown
+ >;
+ return rest;
+ });
+
+ if (!changed) {
+ return transaction;
+ }
+
+ return {
+ ...transaction,
+ payload: nextPayload,
+ };
+};
+
+export interface OperationOrder {
+ actorId: string;
+ clientSeq: number;
+ relayTs: number;
+}
diff --git a/packages/multiplayer-protocol/tsconfig.json b/packages/multiplayer-protocol/tsconfig.json
new file mode 100644
index 0000000000..904e30bb05
--- /dev/null
+++ b/packages/multiplayer-protocol/tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../packages/tsconfig/base.json",
+ "include": ["src"],
+ "compilerOptions": {
+ "paths": {}
+ }
+}
diff --git a/packages/project-build/package.json b/packages/project-build/package.json
index b604ea8766..3254a05ff2 100644
--- a/packages/project-build/package.json
+++ b/packages/project-build/package.json
@@ -9,7 +9,8 @@
"type": "module",
"exports": {
".": {
- "webstudio": "./src/index.ts"
+ "webstudio": "./src/index.ts",
+ "partykit": "./src/index.ts"
},
"./index.server": {
"webstudio": "./src/index.server.ts"
diff --git a/packages/project-build/src/db/build-parser.ts b/packages/project-build/src/db/build-parser.ts
new file mode 100644
index 0000000000..2b9f3a9aaa
--- /dev/null
+++ b/packages/project-build/src/db/build-parser.ts
@@ -0,0 +1,44 @@
+/* eslint no-console: ["error", { allow: ["time", "timeEnd"] }] */
+
+import type { Instance } from "@webstudio-is/sdk";
+import { breakCyclesMutable } from "../shared/graph-utils";
+
+const parseCompactInstanceData = (serialized: string) => {
+ const instances = JSON.parse(serialized) as Instance[];
+
+ // @todo: Remove after measurements on real data
+ console.time("breakCyclesMutable");
+ breakCyclesMutable(instances, (node) => node.component === "Slot");
+ console.timeEnd("breakCyclesMutable");
+
+ return instances;
+};
+
+export const parseData = <Type extends { id: string }>(
+ string: string
+): Map<Type["id"], Type> => {
+ const list = JSON.parse(string) as Type[];
+ return new Map(list.map((item) => [item.id, item]));
+};
+
+export const parseInstanceData = (
+ string: string
+): Map<Instance["id"], Instance> => {
+ const list = parseCompactInstanceData(string);
+ return new Map(list.map((item) => [item.id, item]));
+};
+
+export const serializeData = <Type extends { id: string }>(
+ data: Map<Type["id"], Type>
+) => {
+ const dataSourcesList: Type[] = Array.from(data.values());
+ return JSON.stringify(dataSourcesList);
+};
+
+export const parseConfig = <Type>(string: string): Type => {
+ return JSON.parse(string);
+};
+
+export const serializeConfig = <Type>(data: Type) => {
+ return JSON.stringify(data);
+};
diff --git a/packages/project-build/src/db/build.ts b/packages/project-build/src/db/build.ts
index d70428790f..360e5b7cde 100644
--- a/packages/project-build/src/db/build.ts
+++ b/packages/project-build/src/db/build.ts
@@ -26,6 +26,15 @@ import { breakCyclesMutable } from "../shared/graph-utils";
import { createPages } from "../template";
import { serializeStyles } from "./styles";
import { serializeStyleSourceSelections } from "./style-source-selections";
+import { parseConfig, serializeConfig, serializeData } from "./build-parser";
+
+export {
+ parseConfig,
+ parseData,
+ parseInstanceData,
+ serializeConfig,
+ serializeData,
+} from "./build-parser";
const parseCompactData = <Item>(serialized: string) =>
JSON.parse(serialized) as Item[];
@@ -41,35 +50,6 @@ const parseCompactInstanceData = (serialized: string) => {
return instances;
};
-export const parseData = <Type extends { id: string }>(
- string: string
-): Map<Type["id"], Type> => {
- const list = JSON.parse(string) as Type[];
- return new Map(list.map((item) => [item.id, item]));
-};
-
-export const parseInstanceData = (
- string: string
-): Map<Instance["id"], Instance> => {
- const list = parseCompactInstanceData(string);
- return new Map(list.map((item) => [item.id, item]));
-};
-
-export const serializeData = <Type extends { id: string }>(
- data: Map<Type["id"], Type>
-) => {
- const dataSourcesList: Type[] = Array.from(data.values());
- return JSON.stringify(dataSourcesList);
-};
-
-export const parseConfig = <Type>(string: string): Type => {
- return JSON.parse(string);
-};
-
-export const serializeConfig = <Type>(data: Type) => {
- return JSON.stringify(data);
-};
-
const parseCompactBuild = async (
build: Database["public"]["Tables"]["Build"]["Row"]
) => {
diff --git a/packages/project-build/src/index.ts b/packages/project-build/src/index.ts
index 06c0552c41..be565354c6 100644
--- a/packages/project-build/src/index.ts
+++ b/packages/project-build/src/index.ts
@@ -1,4 +1,8 @@
export * from "./types";
+export * from "./db/build-parser";
+export * from "./db/pages";
+export * from "./db/style-source-selections";
+export * from "./db/styles";
export * from "./shared/pages-utils";
export * from "./shared/marketplace";
export * from "./shared/graph-utils";
diff --git a/packages/project/package.json b/packages/project/package.json
index 9e420b79b7..36957a14b8 100644
--- a/packages/project/package.json
+++ b/packages/project/package.json
@@ -17,7 +17,9 @@
"@webstudio-is/plans": "workspace:*",
"@webstudio-is/postgrest": "workspace:*",
"@webstudio-is/project-build": "workspace:*",
+ "@webstudio-is/sdk": "workspace:*",
"@webstudio-is/trpc-interface": "workspace:*",
+ "immer": "^10.1.1",
"nanoid": "^5.1.5",
"slugify": "^1.6.6",
"type-fest": "^4.37.0",
@@ -34,6 +36,10 @@
},
"./index.server": {
"webstudio": "./src/index.server.ts"
+ },
+ "./build-patch-core.server": {
+ "webstudio": "./src/db/build-patch-core.ts",
+ "import": "./src/db/build-patch-core.ts"
}
},
"license": "AGPL-3.0-or-later",
diff --git a/packages/project/src/db/build-patch-core.ts b/packages/project/src/db/build-patch-core.ts
new file mode 100644
index 0000000000..9bcc292d14
--- /dev/null
+++ b/packages/project/src/db/build-patch-core.ts
@@ -0,0 +1,303 @@
+import { applyPatches, enableMapSet, enablePatches, type Patch } from "immer";
+import {
+ Breakpoints,
+ type Breakpoint,
+ DataSources,
+ type DataSource,
+ Instances,
+ type Instance,
+ Pages,
+ Props,
+ type Prop,
+ Resources,
+ type Resource,
+ StyleSourceSelections,
+ StyleSources,
+ type StyleSource,
+ Styles,
+} from "@webstudio-is/sdk";
+import {
+ findCycles,
+ MarketplaceProduct,
+ parsePages,
+ serializePages,
+ parseStyleSourceSelections,
+ serializeStyleSourceSelections,
+ parseStyles,
+ serializeStyles,
+ parseData,
+ parseConfig,
+ parseInstanceData,
+ serializeConfig,
+ serializeData,
+} from "@webstudio-is/project-build";
+import type { Database } from "@webstudio-is/postgrest/index.server";
+
+enableMapSet();
+enablePatches();
+
+export type BuildPatchChange = {
+ namespace: string;
+ patches: Array<Patch>;
+};
+
+export type BuildPatchTransaction = {
+ id: string;
+ payload: BuildPatchChange[];
+};
+
+export type BuildPatchUpdateResult =
+ | {
+ status: "ok";
+ update?: Database["public"]["Tables"]["Build"]["Update"];
+ nextVersion: number;
+ assetPatches: Patch[][];
+ previewImageAssetId?: string | null;
+ }
+ | { status: "version_mismatched"; errors: string }
+ | { status: "error"; errors: string };
+
+export const createBuildPatchUpdate = async ({
+ build,
+ clientVersion,
+ transactions,
+}: {
+ build: Database["public"]["Tables"]["Build"]["Row"];
+ clientVersion: number;
+ transactions: BuildPatchTransaction[];
+}): Promise<BuildPatchUpdateResult> => {
+ const lastTransactionId = transactions.at(-1)?.id;
+
+ if (lastTransactionId === undefined) {
+ return {
+ status: "error",
+ errors: "Transaction array must not be empty.",
+ };
+ }
+
+ const serverVersion = build.version;
+ if (clientVersion !== serverVersion) {
+ if (lastTransactionId === build.lastTransactionId) {
+ return { status: "ok", assetPatches: [], nextVersion: serverVersion };
+ }
+
+ return {
+ status: "version_mismatched",
+ errors: `You are currently in single-player mode. The project has been edited in a different tab, browser, or by another user. Please reload the page to get the latest version.`,
+ };
+ }
+
+ const buildData: {
+ pages?: Pages;
+ breakpoints?: Breakpoints;
+ instances?: Instances;
+ props?: Props;
+ dataSources?: DataSources;
+ resources?: Resources;
+ styleSources?: StyleSources;
+ styleSourceSelections?: StyleSourceSelections;
+ styles?: Styles;
+ marketplaceProduct?: MarketplaceProduct;
+ } = {};
+
+ let previewImageAssetId: string | null | undefined = undefined;
+ const patchedStyleDeclKeysSet = new Set<string>();
+ const assetPatches: Patch[][] = [];
+
+ for await (const transaction of transactions) {
+ for await (const change of transaction.payload) {
+ const { namespace, patches } = change;
+ if (patches.length === 0) {
+ continue;
+ }
+
+ if (namespace === "pages") {
+ const pages = buildData.pages ?? parsePages(build.pages);
+ const currentSocialImageAssetId =
+ pages.homePage.meta.socialImageAssetId;
+ buildData.pages = applyPatches(pages, patches);
+ const newSocialImageAssetId =
+ buildData.pages.homePage.meta.socialImageAssetId;
+ if (currentSocialImageAssetId !== newSocialImageAssetId) {
+ previewImageAssetId = newSocialImageAssetId || null;
+ }
+ continue;
+ }
+
+ if (namespace === "instances") {
+ const instances =
+ buildData.instances ?? parseInstanceData(build.instances);
+
+ buildData.instances = applyPatches(instances, patches);
+
+ const cycles = findCycles(buildData.instances.values());
+ if (cycles.length > 0) {
+ console.error(
+ "Cycles detected in the instance tree after patching",
+ cycles
+ );
+
+ return {
+ status: "error",
+ errors: "Cycles detected in the instance tree",
+ };
+ }
+
+ continue;
+ }
+
+ if (namespace === "props") {
+ const props = buildData.props ?? parseData<Prop>(build.props);
+ buildData.props = applyPatches(props, patches);
+ continue;
+ }
+
+ if (namespace === "assets") {
+ assetPatches.push(patches);
+ continue;
+ }
+
+ if (namespace === "styleSourceSelections") {
+ const styleSourceSelections =
+ buildData.styleSourceSelections ??
+ parseStyleSourceSelections(build.styleSourceSelections);
+ buildData.styleSourceSelections = applyPatches(
+ styleSourceSelections,
+ patches
+ );
+ continue;
+ }
+
+ if (namespace === "styleSources") {
+ const styleSources =
+ buildData.styleSources ?? parseData<StyleSource>(build.styleSources);
+ buildData.styleSources = applyPatches(styleSources, patches);
+ continue;
+ }
+
+ if (namespace === "styles") {
+ for (const patch of patches) {
+ patchedStyleDeclKeysSet.add(`${patch.path[0]}`);
+ }
+
+ const styles = buildData.styles ?? parseStyles(build.styles);
+ buildData.styles = applyPatches(styles, patches);
+ continue;
+ }
+
+ if (namespace === "dataSources") {
+ const dataSources =
+ buildData.dataSources ?? parseData<DataSource>(build.dataSources);
+ buildData.dataSources = applyPatches(dataSources, patches);
+ continue;
+ }
+
+ if (namespace === "resources") {
+ const resources =
+ buildData.resources ?? parseData<Resource>(build.resources);
+ buildData.resources = applyPatches(resources, patches);
+ continue;
+ }
+
+ if (namespace === "breakpoints") {
+ const breakpoints =
+ buildData.breakpoints ?? parseData<Breakpoint>(build.breakpoints);
+ buildData.breakpoints = applyPatches(breakpoints, patches);
+ continue;
+ }
+
+ if (namespace === "marketplaceProduct") {
+ const marketplaceProduct =
+ buildData.marketplaceProduct ??
+ parseConfig<MarketplaceProduct>(build.marketplaceProduct);
+
+ buildData.marketplaceProduct = applyPatches(
+ marketplaceProduct,
+ patches
+ );
+
+ continue;
+ }
+
+ return { status: "error", errors: `Unknown namespace "${namespace}"` };
+ }
+ }
+
+ const update: Database["public"]["Tables"]["Build"]["Update"] = {
+ version: clientVersion + 1,
+ lastTransactionId,
+ updatedAt: new Date().toISOString(),
+ };
+
+ if (buildData.pages) {
+ update.pages = serializePages(Pages.parse(buildData.pages));
+ }
+
+ if (buildData.breakpoints) {
+ update.breakpoints = serializeData<Breakpoint>(
+ Breakpoints.parse(buildData.breakpoints)
+ );
+ }
+
+ if (buildData.instances) {
+ update.instances = serializeData<Instance>(
+ Instances.parse(buildData.instances)
+ );
+ }
+
+ if (buildData.props) {
+ update.props = serializeData<Prop>(Props.parse(buildData.props));
+ }
+
+ if (buildData.dataSources) {
+ update.dataSources = serializeData<DataSource>(
+ DataSources.parse(buildData.dataSources)
+ );
+ }
+
+ if (buildData.resources) {
+ update.resources = serializeData<Resource>(
+ Resources.parse(buildData.resources)
+ );
+ }
+
+ if (buildData.styleSources) {
+ update.styleSources = serializeData<StyleSource>(
+ StyleSources.parse(buildData.styleSources)
+ );
+ }
+
+ if (buildData.styleSourceSelections) {
+ update.styleSourceSelections = serializeStyleSourceSelections(
+ StyleSourceSelections.parse(buildData.styleSourceSelections)
+ );
+ }
+
+ if (buildData.styles) {
+ const stylesToValidate: Styles = new Map();
+ for (const styleId of patchedStyleDeclKeysSet) {
+ const style = buildData.styles.get(styleId);
+ if (style === undefined) {
+ continue;
+ }
+ stylesToValidate.set(styleId, style);
+ }
+
+ Styles.parse(stylesToValidate);
+ update.styles = serializeStyles(buildData.styles);
+ }
+
+ if (buildData.marketplaceProduct) {
+ update.marketplaceProduct = serializeConfig<MarketplaceProduct>(
+ MarketplaceProduct.parse(buildData.marketplaceProduct)
+ );
+ }
+
+ return {
+ status: "ok",
+ assetPatches,
+ update,
+ nextVersion: clientVersion + 1,
+ previewImageAssetId,
+ };
+};
diff --git a/packages/project/src/db/build-patch-permissions.test.ts b/packages/project/src/db/build-patch-permissions.test.ts
new file mode 100644
index 0000000000..58eb396a25
--- /dev/null
+++ b/packages/project/src/db/build-patch-permissions.test.ts
@@ -0,0 +1,42 @@
+import { describe, expect, test } from "vitest";
+import { getRequiredPermitForBuildPatchTransaction } from "./build-patch-permissions";
+import type { BuildPatchTransaction } from "./build-patch-core";
+
+const transaction = (
+ namespace: string,
+ patches: BuildPatchTransaction["payload"][number]["patches"] = [
+ { op: "replace", path: ["prop-1", "value"], value: "Title" },
+ ]
+): BuildPatchTransaction => ({
+ id: "tx-1",
+ payload: [{ namespace, patches }],
+});
+
+describe("getRequiredPermitForBuildPatchTransaction", () => {
+ test("allows content prop edits with edit permit", () => {
+ expect(
+ getRequiredPermitForBuildPatchTransaction(transaction("props"))
+ ).toBe("edit");
+ });
+
+ test("requires build permit for style edits", () => {
+ expect(
+ getRequiredPermitForBuildPatchTransaction(transaction("styles"))
+ ).toBe("build");
+ });
+
+ test("requires build permit when any change in the transaction is design scoped", () => {
+ expect(
+ getRequiredPermitForBuildPatchTransaction({
+ id: "tx-1",
+ payload: [
+ { namespace: "props", patches: [] },
+ {
+ namespace: "breakpoints",
+ patches: [{ op: "add", path: ["bp-1"], value: {} }],
+ },
+ ],
+ })
+ ).toBe("build");
+ });
+});
diff --git a/packages/project/src/db/build-patch-permissions.ts b/packages/project/src/db/build-patch-permissions.ts
new file mode 100644
index 0000000000..008f53d39a
--- /dev/null
+++ b/packages/project/src/db/build-patch-permissions.ts
@@ -0,0 +1,18 @@
+import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
+import type { BuildPatchTransaction } from "./build-patch-core";
+
+const contentNamespaces = new Set(["props"]);
+
+export const getRequiredPermitForBuildPatchTransaction = (
+ transaction: BuildPatchTransaction
+): AuthPermit => {
+ for (const change of transaction.payload) {
+ if (change.patches.length === 0) {
+ continue;
+ }
+ if (contentNamespaces.has(change.namespace) === false) {
+ return "build";
+ }
+ }
+ return "edit";
+};
diff --git a/packages/project/src/db/build-patch.test.ts b/packages/project/src/db/build-patch.test.ts
new file mode 100644
index 0000000000..183aff27f4
--- /dev/null
+++ b/packages/project/src/db/build-patch.test.ts
@@ -0,0 +1,296 @@
+import { describe, expect, test } from "vitest";
+import {
+ createTestServer,
+ db,
+ empty,
+ json,
+ testContext,
+} from "@webstudio-is/postgrest/testing";
+import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
+import type { Patch } from "immer";
+import { patchBuild, type BuildPatchTransaction } from "./build-patch";
+import { createBuildPatchUpdate } from "./build-patch-core";
+
+const server = createTestServer();
+
+const createContext = (): AppContext =>
+ ({
+ ...testContext,
+ authorization: { type: "user", userId: "user-1" },
+ getOwnerPlanFeatures: async () => ({}),
+ }) as unknown as AppContext;
+
+const ownershipHandler = db.get("Project", ({ request }) => {
+ const url = new URL(request.url);
+ if (url.searchParams.has("userId")) {
+ return json({ id: url.searchParams.get("id")?.replace("eq.", "") });
+ }
+ return json(null);
+});
+
+const buildRow = {
+ id: "build-1",
+ projectId: "project-1",
+ version: 3,
+ lastTransactionId: "previous-tx",
+ isCleaned: null,
+ publishStatus: "PUBLISHED" as const,
+ createdAt: new Date().toISOString(),
+ updatedAt: new Date().toISOString(),
+ pages: JSON.stringify({
+ meta: {},
+ homePage: {
+ id: "page-1",
+ name: "Home",
+ path: "",
+ title: "Home",
+ meta: {},
+ rootInstanceId: "body-1",
+ },
+ pages: [],
+ folders: [{ id: "root", name: "Root", slug: "", children: [] }],
+ }),
+ breakpoints: JSON.stringify([]),
+ styles: JSON.stringify([]),
+ styleSources: JSON.stringify([]),
+ styleSourceSelections: JSON.stringify([]),
+ props: JSON.stringify([
+ {
+ id: "prop-1",
+ instanceId: "body-1",
+ name: "title",
+ type: "string",
+ value: "Old title",
+ },
+ ]),
+ dataSources: JSON.stringify([]),
+ resources: JSON.stringify([]),
+ instances: JSON.stringify([
+ { id: "body-1", type: "instance", component: "Body", children: [] },
+ ]),
+ deployment: null,
+ marketplaceProduct: JSON.stringify({}),
+};
+
+const transaction = (
+ overrides: Partial<BuildPatchTransaction> = {}
+): BuildPatchTransaction => ({
+ id: "tx-1",
+ payload: [
+ {
+ namespace: "props",
+ patches: [
+ { op: "replace", path: ["prop-1", "value"], value: "New title" },
+ ],
+ },
+ ],
+ ...overrides,
+});
+
+describe("patchBuild", () => {
+ test("applies transactions, validates data, and updates build with optimistic version guard", async () => {
+ let updatedBuild: unknown;
+ server.use(
+ db.get("Build", () => json([buildRow])),
+ db.patch("Build", async ({ request }) => {
+ updatedBuild = await request.json();
+ return empty({ headers: { "Content-Range": "*/1" } });
+ })
+ );
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [transaction()],
+ },
+ createContext()
+ );
+
+ expect(result).toEqual({ status: "ok", version: 4 });
+ expect(updatedBuild).toMatchObject({
+ version: 4,
+ lastTransactionId: "tx-1",
+ });
+ expect(JSON.parse((updatedBuild as { props: string }).props)).toEqual([
+ {
+ id: "prop-1",
+ instanceId: "body-1",
+ name: "title",
+ type: "string",
+ value: "New title",
+ },
+ ]);
+ });
+
+ test("returns ok when retrying a transaction already saved by the server", async () => {
+ let didPatch = false;
+ server.use(
+ db.get("Build", () =>
+ json([{ ...buildRow, version: 4, lastTransactionId: "tx-1" }])
+ ),
+ db.patch("Build", () => {
+ didPatch = true;
+ return empty({ headers: { "Content-Range": "*/1" } });
+ })
+ );
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [transaction()],
+ },
+ createContext()
+ );
+
+ expect(result).toEqual({ status: "ok", version: 4 });
+ expect(didPatch).toBe(false);
+ });
+
+ test("returns version_mismatched when loaded build version differs", async () => {
+ server.use(db.get("Build", () => json([{ ...buildRow, version: 4 }])));
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [transaction()],
+ },
+ createContext()
+ );
+
+ expect(result.status).toBe("version_mismatched");
+ });
+
+ test("returns version_mismatched when optimistic update affects no rows", async () => {
+ server.use(
+ db.get("Build", () => json([buildRow])),
+ db.patch("Build", () => empty({ headers: { "Content-Range": "*/0" } }))
+ );
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [transaction()],
+ },
+ createContext()
+ );
+
+ expect(result.status).toBe("version_mismatched");
+ });
+
+ test("rejects unknown namespaces", async () => {
+ let didPatch = false;
+ server.use(
+ db.get("Build", () => json([buildRow])),
+ db.patch("Build", () => {
+ didPatch = true;
+ return empty({ headers: { "Content-Range": "*/1" } });
+ })
+ );
+
+ const result = await patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [
+ transaction({
+ payload: [
+ {
+ namespace: "unknown",
+ patches: [{ op: "add", path: [], value: null }],
+ },
+ ],
+ }),
+ ],
+ },
+ createContext()
+ );
+
+ expect(result).toEqual({
+ status: "error",
+ errors: 'Unknown namespace "unknown"',
+ });
+ expect(didPatch).toBe(false);
+ });
+
+ test("core patch helper is decoupled from asset app logic", async () => {
+ const assetPatch: Patch = { op: "add", path: ["asset-1"], value: {} };
+ const result = await createBuildPatchUpdate({
+ build: buildRow,
+ clientVersion: 3,
+ transactions: [
+ transaction({
+ payload: [
+ {
+ namespace: "assets",
+ patches: [assetPatch],
+ },
+ ],
+ }),
+ ],
+ });
+
+ expect(result).toMatchObject({
+ status: "ok",
+ assetPatches: [[assetPatch]],
+ nextVersion: 4,
+ update: {
+ lastTransactionId: "tx-1",
+ version: 4,
+ },
+ });
+ });
+
+ test("does not mark build as saved when asset patching fails", async () => {
+ let didPatchBuild = false;
+ server.use(
+ ownershipHandler,
+ db.get("Build", () => json([buildRow])),
+ db.get("Asset", () => json([])),
+ db.patch("Build", () => {
+ didPatchBuild = true;
+ return empty({ headers: { "Content-Range": "*/1" } });
+ })
+ );
+
+ await expect(
+ patchBuild(
+ {
+ buildId: "build-1",
+ projectId: "project-1",
+ clientVersion: 3,
+ transactions: [
+ transaction({
+ payload: [
+ {
+ namespace: "assets",
+ patches: [
+ {
+ op: "add",
+ path: ["asset-invalid"],
+ value: {
+ id: "asset-invalid",
+ name: "invalid.jpg",
+ },
+ },
+ ],
+ },
+ ],
+ }),
+ ],
+ },
+ createContext()
+ )
+ ).rejects.toThrow();
+
+ expect(didPatchBuild).toBe(false);
+ });
+});
diff --git a/packages/project/src/db/build-patch.ts b/packages/project/src/db/build-patch.ts
new file mode 100644
index 0000000000..f43dee95de
--- /dev/null
+++ b/packages/project/src/db/build-patch.ts
@@ -0,0 +1,90 @@
+import { patchAssets } from "@webstudio-is/asset-uploader/index.server";
+import type { Build } from "@webstudio-is/project-build";
+import { loadRawBuildById } from "@webstudio-is/project-build/index.server";
+import type { AppContext } from "@webstudio-is/trpc-interface/index.server";
+import type { Project } from "./project";
+import { updatePreviewImage } from "./project";
+import {
+ createBuildPatchUpdate,
+ type BuildPatchChange,
+ type BuildPatchTransaction,
+} from "./build-patch-core";
+
+export type { BuildPatchChange, BuildPatchTransaction };
+
+export type PatchBuildResult =
+ | { status: "ok"; version: number }
+ | { status: "version_mismatched"; errors: string }
+ | { status: "error"; errors: string };
+
+export const patchBuild = async (
+ {
+ buildId,
+ projectId,
+ transactions,
+ clientVersion,
+ }: {
+ buildId: Build["id"];
+ projectId: Project["id"];
+ transactions: BuildPatchTransaction[];
+ clientVersion: number;
+ },
+ context: AppContext
+): Promise<PatchBuildResult> => {
+ const build = await loadRawBuildById(context, buildId);
+ const result = await createBuildPatchUpdate({
+ build,
+ clientVersion,
+ transactions,
+ });
+
+ if (result.status !== "ok") {
+ return result;
+ }
+
+ if (result.update === undefined) {
+ return { status: "ok", version: result.nextVersion };
+ }
+
+ // build.patch does not have the worker's atomic Build+asset commit path.
+ // Apply app-side asset mutations before marking the Build with
+ // lastTransactionId so a failed asset mutation is not later treated as an
+ // already-saved retry.
+ for (const patches of result.assetPatches) {
+ await patchAssets({ projectId }, patches, context);
+ }
+
+ const update = await context.postgrest.client
+ .from("Build")
+ .update(result.update, { count: "exact" })
+ .match({
+ id: buildId,
+ projectId,
+ version: clientVersion,
+ });
+
+ if (update.error) {
+ console.error(update.error);
+ throw update.error;
+ }
+ if (update.count == null) {
+ console.error("Update count is null");
+ throw new Error("Update count is null");
+ }
+
+ if (update.count === 0) {
+ return {
+ status: "version_mismatched",
+ errors: `You are currently in single-player mode. The project has been edited in a different tab, browser, or by another user. Please reload the page to get the latest version.`,
+ };
+ }
+
+ if (result.previewImageAssetId !== undefined) {
+ await updatePreviewImage(
+ { assetId: result.previewImageAssetId, projectId },
+ context
+ );
+ }
+
+ return { status: "ok", version: result.nextVersion };
+};
diff --git a/packages/project/src/index.server.ts b/packages/project/src/index.server.ts
index 5cf0557764..2401591e49 100644
--- a/packages/project/src/index.server.ts
+++ b/packages/project/src/index.server.ts
@@ -1,4 +1,7 @@
export * from "./db/project";
+export * from "./db/build-patch";
+export * from "./db/build-patch-core";
+export * from "./db/build-patch-permissions";
export * as workspace from "./db/workspace";
export * as notification from "./db/notification";
export * from "./trpc/project-router";
diff --git a/packages/react-sdk/src/remix.test.ts b/packages/react-sdk/src/remix.test.ts
index a331405e64..869c85140b 100644
--- a/packages/react-sdk/src/remix.test.ts
+++ b/packages/react-sdk/src/remix.test.ts
@@ -1,6 +1,6 @@
import { expect, test, describe } from "vitest";
import { generateRemixParams, generateRemixRoute } from "./remix";
-import { STATIC_PATHS } from "@webstudio-is/sdk/router-paths.test";
+import { STATIC_PATHS } from "@webstudio-is/sdk/router-path-test-data";
/**
* These tests use the shared test data from @webstudio-is/sdk to ensure
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
index 34dc59aee0..50933f7a03 100644
--- a/packages/sdk/package.json
+++ b/packages/sdk/package.json
@@ -9,6 +9,7 @@
"exports": {
".": {
"webstudio": "./src/index.ts",
+ "partykit": "./src/index.ts",
"types": "./lib/types/index.d.ts",
"import": "./lib/index.js"
},
@@ -27,8 +28,8 @@
"types": "./lib/types/core-templates.d.ts",
"import": "./lib/core-templates.js"
},
- "./router-paths.test": {
- "webstudio": "./src/router-paths.test.ts"
+ "./router-path-test-data": {
+ "webstudio": "./src/router-path-test-data.ts"
}
},
"files": [
diff --git a/packages/sdk/src/router-paths.test.ts b/packages/sdk/src/router-paths.test.ts
index 9218fc6de3..b67510779b 100644
--- a/packages/sdk/src/router-paths.test.ts
+++ b/packages/sdk/src/router-paths.test.ts
@@ -13,16 +13,6 @@ import { describe, test, expect } from "vitest";
import { OldPagePath, ProjectNewRedirectPath } from "./schema/pages";
import { ALL_VALID_PATHS, ALL_INVALID_PATHS } from "./router-path-test-data";
-// Re-export for use in other packages
-export {
- VALID_ROUTER_PATHS,
- INVALID_ROUTER_PATHS,
- ALL_VALID_PATHS,
- ALL_INVALID_PATHS,
- VALID_URLPATTERN_PATHS,
- STATIC_PATHS,
-} from "./router-path-test-data";
-
describe("Router path validation consistency", () => {
describe("OldPagePath schema - valid paths", () => {
test.each(ALL_VALID_PATHS)("accepts: %s", (path) => {
diff --git a/packages/sync-client/package.json b/packages/sync-client/package.json
new file mode 100644
index 0000000000..6e30e5518e
--- /dev/null
+++ b/packages/sync-client/package.json
@@ -0,0 +1,36 @@
+{
+ "name": "@webstudio-is/sync-client",
+ "version": "0.0.0",
+ "description": "Client runtime for Webstudio synchronization",
+ "author": "Webstudio <[email protected]>",
+ "license": "AGPL-3.0-or-later",
+ "type": "module",
+ "exports": {
+ ".": {
+ "webstudio": "./src/index.ts",
+ "import": "./src/index.ts",
+ "default": "./src/index.ts"
+ },
+ "./websocket": {
+ "webstudio": "./src/multiplayer/websocket-emitter.ts",
+ "import": "./src/multiplayer/websocket-emitter.ts",
+ "default": "./src/multiplayer/websocket-emitter.ts"
+ }
+ },
+ "sideEffects": false,
+ "scripts": {
+ "typecheck": "tsgo --noEmit",
+ "test": "vitest run"
+ },
+ "dependencies": {
+ "@webstudio-is/multiplayer-protocol": "workspace:*",
+ "nanostores": "^0.11.3",
+ "nanoid": "^5.1.5",
+ "immerhin": "*",
+ "partysocket": "^1.1.18"
+ },
+ "devDependencies": {
+ "@webstudio-is/tsconfig": "workspace:*",
+ "vitest": "^3.1.2"
+ }
+}
diff --git a/packages/sync-client/src/backoff.test.ts b/packages/sync-client/src/backoff.test.ts
new file mode 100644
index 0000000000..674c23aae4
--- /dev/null
+++ b/packages/sync-client/src/backoff.test.ts
@@ -0,0 +1,123 @@
+import { beforeEach, describe, expect, test, vi } from "vitest";
+import { createBackoff } from "./backoff";
+
+describe("createBackoff", () => {
+ beforeEach(() => {
+ vi.restoreAllMocks();
+ });
+
+ describe("deterministic mode", () => {
+ test("starts with base delay", () => {
+ const backoff = createBackoff({
+ baseDelay: 1000,
+ jitter: false,
+ multiplier: 2,
+ });
+
+ expect(backoff.next()).toBe(1000);
+ });
+
+ test("grows exponentially", () => {
+ const backoff = createBackoff({
+ baseDelay: 100,
+ jitter: false,
+ multiplier: 2,
+ });
+
+ expect(backoff.next()).toBe(100);
+ expect(backoff.next()).toBe(200);
+ expect(backoff.next()).toBe(400);
+ expect(backoff.next()).toBe(800);
+ });
+
+ test("clamps at max delay", () => {
+ const backoff = createBackoff({
+ baseDelay: 1000,
+ jitter: false,
+ maxDelay: 5000,
+ multiplier: 10,
+ });
+
+ expect(backoff.next()).toBe(1000);
+ expect(backoff.next()).toBe(5000);
+ expect(backoff.next()).toBe(5000);
+ });
+
+ test("resets delay and attempts", () => {
+ const backoff = createBackoff({
+ baseDelay: 100,
+ jitter: false,
+ multiplier: 3,
+ });
+
+ backoff.next();
+ backoff.next();
+ backoff.next();
+ backoff.reset();
+
+ expect(backoff.attempts()).toBe(0);
+ expect(backoff.next()).toBe(100);
+ });
+
+ test("tracks attempts", () => {
+ const backoff = createBackoff({ jitter: false });
+
+ expect(backoff.attempts()).toBe(0);
+ backoff.next();
+ expect(backoff.attempts()).toBe(1);
+ backoff.next();
+ expect(backoff.attempts()).toBe(2);
+ });
+ });
+
+ describe("jitter mode", () => {
+ test("uses decorrelated jitter", () => {
+ vi.spyOn(Math, "random").mockReturnValue(0.5);
+
+ const backoff = createBackoff({
+ baseDelay: 1000,
+ maxDelay: 120_000,
+ multiplier: 3,
+ });
+
+ expect(backoff.next()).toBe(2000);
+ expect(backoff.next()).toBe(3500);
+ });
+
+ test("never exceeds max delay", () => {
+ vi.spyOn(Math, "random").mockReturnValue(0.999999);
+
+ const backoff = createBackoff({
+ baseDelay: 1000,
+ maxDelay: 5000,
+ multiplier: 3,
+ });
+
+ for (let index = 0; index < 20; index += 1) {
+ expect(backoff.next()).toBeLessThanOrEqual(5000);
+ }
+ });
+
+ test("never goes below base delay", () => {
+ vi.spyOn(Math, "random").mockReturnValue(0);
+
+ const backoff = createBackoff({
+ baseDelay: 500,
+ multiplier: 3,
+ });
+
+ for (let index = 0; index < 10; index += 1) {
+ expect(backoff.next()).toBeGreaterThanOrEqual(500);
+ }
+ });
+
+ test("uses builder-compatible defaults", () => {
+ vi.spyOn(Math, "random").mockReturnValue(0.5);
+
+ const backoff = createBackoff();
+
+ expect(backoff.next()).toBe(10_000);
+ expect(backoff.attempts()).toBe(1);
+ });
+ });
+});
diff --git a/apps/builder/app/shared/polly/backoff.ts b/packages/sync-client/src/backoff.ts
similarity index 58%
rename from apps/builder/app/shared/polly/backoff.ts
rename to packages/sync-client/src/backoff.ts
index 47d72b4557..951fbe8fcf 100644
--- a/apps/builder/app/shared/polly/backoff.ts
+++ b/packages/sync-client/src/backoff.ts
@@ -3,22 +3,22 @@
*
* Produces progressively longer delays after consecutive failures,
* capped at a configurable maximum. Uses decorrelated jitter
- * (delay = random(base, prev × multiplier)) to prevent thundering-herd
+ * (delay = random(base, prev * multiplier)) to prevent thundering-herd
* when many clients retry simultaneously after a shared outage.
*
- * The backoff is a pure, stateful object with no timers or side-effects.
+ * The backoff is a pure, stateful object with no timers or side effects.
* Call `next()` to get the next delay, and `reset()` after a success.
*/
export type BackoffOptions = {
/**
- * Base delay in milliseconds (also the minimum delay).
+ * Base delay in milliseconds.
* @default 5_000
*/
baseDelay?: number;
/**
- * Maximum delay in milliseconds. Delays are clamped to this value.
+ * Maximum delay in milliseconds.
* @default 120_000
*/
maxDelay?: number;
@@ -30,21 +30,15 @@ export type BackoffOptions = {
multiplier?: number;
/**
- * When `true` (default), use decorrelated jitter so that delays are
- * randomised between `baseDelay` and `lastDelay × multiplier`.
- *
- * Set to `false` for deterministic exponential growth (useful in tests).
+ * When true, randomize delays between baseDelay and previousDelay * multiplier.
* @default true
*/
jitter?: boolean;
};
export type Backoff = {
- /** Compute and return the next delay in ms. Increments the failure counter. */
next: () => number;
- /** Reset to initial state (e.g. after a successful request). */
reset: () => void;
- /** Number of consecutive failures since the last reset. */
attempts: () => number;
};
@@ -52,15 +46,16 @@ const DEFAULT_BASE_DELAY = 5_000;
const DEFAULT_MAX_DELAY = 120_000;
const DEFAULT_MULTIPLIER = 3;
-const randomBetween = (min: number, max: number) =>
- Math.random() * (max - min) + min;
+const randomBetween = (min: number, max: number) => {
+ return Math.random() * (max - min) + min;
+};
export const createBackoff = (options?: BackoffOptions): Backoff => {
const {
baseDelay = DEFAULT_BASE_DELAY,
+ jitter = true,
maxDelay = DEFAULT_MAX_DELAY,
multiplier = DEFAULT_MULTIPLIER,
- jitter = true,
} = options ?? {};
let failures = 0;
@@ -70,16 +65,14 @@ export const createBackoff = (options?: BackoffOptions): Backoff => {
failures += 1;
if (jitter) {
- // Decorrelated jitter: next delay is random between baseDelay and last × multiplier
lastDelay = Math.min(
maxDelay,
randomBetween(baseDelay, lastDelay * multiplier)
);
- } else {
- // Deterministic exponential (useful for testing)
- lastDelay = Math.min(maxDelay, baseDelay * multiplier ** (failures - 1));
+ return lastDelay;
}
+ lastDelay = Math.min(maxDelay, baseDelay * multiplier ** (failures - 1));
return lastDelay;
};
@@ -88,7 +81,9 @@ export const createBackoff = (options?: BackoffOptions): Backoff => {
lastDelay = baseDelay;
};
- const attempts = () => failures;
-
- return { next, reset, attempts };
+ return {
+ attempts: () => failures,
+ next,
+ reset,
+ };
};
diff --git a/packages/sync-client/src/index.ts b/packages/sync-client/src/index.ts
new file mode 100644
index 0000000000..6b57eba248
--- /dev/null
+++ b/packages/sync-client/src/index.ts
@@ -0,0 +1,57 @@
+/**
+ * @webstudio-is/sync-client - shared single-player and multiplayer sync client
+ *
+ * Public exports (framework-agnostic, browser + Node.js compatible):
+ * - Protocol types: relay message shapes
+ * - Sync state primitives
+ * - Atom exports: $collaborators, $syncStatus
+ */
+
+export type {
+ SyncMessage,
+ Transaction,
+ RevertedTransaction,
+ SyncEmitter,
+ SyncObject,
+} from "./types";
+export type {
+ ApplyMessage,
+ BroadcastMessage,
+ AckMessage,
+ ReloadMessage,
+ ErrorMessage,
+ AppliedMessage,
+ RevertMessage,
+ PresenceMessage,
+ RelayClientMessage,
+ RelayServerMessage,
+ CollaboratorInfo,
+} from "@webstudio-is/multiplayer-protocol";
+export {
+ persistenceBacklogErrorMessage,
+ rateLimitedErrorMessage,
+ stripRevisePatchesFromTransaction,
+} from "@webstudio-is/multiplayer-protocol";
+export { $collaborators } from "./multiplayer/collab-state";
+export {
+ $hasUnsavedSyncChanges,
+ $syncStatus,
+ type SyncStatus,
+} from "./sync-status";
+export { createTransactionCompletionStore } from "./transaction-completion";
+export {
+ assignCollaboratorColors,
+ collaboratorColor,
+ collaboratorColorPalette,
+} from "./multiplayer/collaborator-colors";
+export type { OperationOrder } from "@webstudio-is/multiplayer-protocol";
+export {
+ ACK_TIMEOUT_MS,
+ FAST_RETRY_MS,
+ MAX_FAST_RETRIES,
+ createMultiplayerRetryTracker,
+ syncDelayedMessage,
+ type MultiplayerRetryTrackerOptions,
+ type RetryReason,
+} from "./multiplayer/multiplayer-retry-tracker";
+export { createBackoff, type Backoff, type BackoffOptions } from "./backoff";
diff --git a/packages/sync-client/src/multiplayer/collab-state.test.ts b/packages/sync-client/src/multiplayer/collab-state.test.ts
new file mode 100644
index 0000000000..84a8f1d9c5
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/collab-state.test.ts
@@ -0,0 +1,8 @@
+import { describe, test, expect } from "vitest";
+import { $collaborators } from "./collab-state";
+
+describe("$collaborators", () => {
+ test("initializes as empty map", () => {
+ expect($collaborators.get()).toEqual(new Map());
+ });
+});
diff --git a/packages/sync-client/src/multiplayer/collab-state.ts b/packages/sync-client/src/multiplayer/collab-state.ts
new file mode 100644
index 0000000000..cb9dbab9b7
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/collab-state.ts
@@ -0,0 +1,4 @@
+import { atom } from "nanostores";
+import type { CollaboratorInfo } from "@webstudio-is/multiplayer-protocol";
+
+export const $collaborators = atom(new Map<string, CollaboratorInfo>());
diff --git a/packages/sync-client/src/multiplayer/collaborator-colors.test.ts b/packages/sync-client/src/multiplayer/collaborator-colors.test.ts
new file mode 100644
index 0000000000..31b6fb7ce9
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/collaborator-colors.test.ts
@@ -0,0 +1,73 @@
+import { describe, expect, test } from "vitest";
+import {
+ assignCollaboratorColors,
+ collaboratorColor,
+ collaboratorColorPalette,
+} from "./collaborator-colors";
+
+describe("collaboratorColorPalette", () => {
+ test("has exactly 50 entries", () => {
+ expect(collaboratorColorPalette).toHaveLength(50);
+ });
+
+ test("each entry is a valid oklch() string", () => {
+ for (const paletteColor of collaboratorColorPalette) {
+ expect(paletteColor).toMatch(
+ /^oklch\(\d+(?:\.\d+)?% \d+\.\d+ \d+(?:\.\d+)?\)$/
+ );
+ }
+ });
+
+ test("all entries are distinct", () => {
+ expect(new Set(collaboratorColorPalette).size).toBe(50);
+ });
+});
+
+describe("collaboratorColor", () => {
+ test("same id always returns the same color", () => {
+ expect(collaboratorColor("abc")).toBe(collaboratorColor("abc"));
+ expect(collaboratorColor("user-123")).toBe(collaboratorColor("user-123"));
+ });
+
+ test("different ids return different colors", () => {
+ const sample = ["a", "b", "c", "d", "e", "f", "g", "h"].map(
+ collaboratorColor
+ );
+ expect(new Set(sample).size).toBeGreaterThan(1);
+ });
+
+ test("return value is one of the palette colors", () => {
+ const palette = new Set(collaboratorColorPalette);
+ expect(palette.has(collaboratorColor("anything"))).toBe(true);
+ expect(palette.has(collaboratorColor("client-1"))).toBe(true);
+ expect(palette.has(collaboratorColor(""))).toBe(true);
+ });
+
+ test("empty string returns a color without throwing", () => {
+ expect(() => collaboratorColor("")).not.toThrow();
+ expect(collaboratorColorPalette).toContain(collaboratorColor(""));
+ });
+});
+
+describe("assignCollaboratorColors", () => {
+ test("assigns the same color for the same active collaborator set", () => {
+ const ids = ["client-2", "client-1", "client-3"];
+
+ expect(assignCollaboratorColors(ids)).toEqual(
+ assignCollaboratorColors([...ids].reverse())
+ );
+ });
+
+ test("does not reuse colors for active collaborators with hash collisions", () => {
+ const colors = assignCollaboratorColors(["i", "ab"]);
+
+ expect(colors.get("i")).not.toBe(colors.get("ab"));
+ });
+
+ test("does not reuse colors after palette slots are exhausted", () => {
+ const ids = Array.from({ length: 75 }, (_, index) => `client-${index}`);
+ const colors = [...assignCollaboratorColors(ids).values()];
+
+ expect(new Set(colors).size).toBe(colors.length);
+ });
+});
diff --git a/packages/sync-client/src/multiplayer/collaborator-colors.ts b/packages/sync-client/src/multiplayer/collaborator-colors.ts
new file mode 100644
index 0000000000..0f7ee17f4d
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/collaborator-colors.ts
@@ -0,0 +1,57 @@
+/**
+ * A palette of 50 perceptually-uniform oklch colors, one per collaborator slot.
+ * Generated with the golden-angle hue distribution (137.5deg) so adjacent slots
+ * are maximally distinguishable.
+ */
+const collaboratorColorForSlot = (slot: number): string => {
+ const lightness = 55 + (slot % 3) * 3;
+ const chroma = 0.14 + (slot % 2) * 0.02;
+ const hue = (slot * 137.5) % 360;
+ return `oklch(${lightness}% ${chroma.toFixed(2)} ${hue.toFixed(1)})`;
+};
+
+export const collaboratorColorPalette = Array.from({ length: 50 }, (_, slot) =>
+ collaboratorColorForSlot(slot)
+);
+
+/**
+ * Returns a deterministic oklch color string for the given collaborator id.
+ * The same id always maps to the same color across all clients.
+ */
+export const collaboratorColor = (id: string): string => {
+ return collaboratorColorPalette[
+ getInitialColorSlot(id) % collaboratorColorPalette.length
+ ]!;
+};
+
+/**
+ * Assigns identity colors across the active collaborator set without reusing
+ * colors.
+ */
+export const assignCollaboratorColors = (
+ ids: Iterable<string>
+): Map<string, string> => {
+ const assignedColors = new Map<string, string>();
+ const usedSlots = new Set<number>();
+
+ for (const id of [...new Set(ids)].sort()) {
+ let slot = getInitialColorSlot(id) % collaboratorColorPalette.length;
+
+ while (usedSlots.has(slot)) {
+ slot += 1;
+ }
+
+ usedSlots.add(slot);
+ assignedColors.set(id, collaboratorColorForSlot(slot));
+ }
+
+ return assignedColors;
+};
+
+const getInitialColorSlot = (id: string): number => {
+ let hash = 0;
+ for (let charIndex = 0; charIndex < id.length; charIndex++) {
+ hash = (hash * 31 + id.charCodeAt(charIndex)) >>> 0;
+ }
+ return hash;
+};
diff --git a/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.test.ts b/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.test.ts
new file mode 100644
index 0000000000..5fa58f572a
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.test.ts
@@ -0,0 +1,337 @@
+import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
+import type { ApplyMessage } from "@webstudio-is/multiplayer-protocol";
+import {
+ ACK_TIMEOUT_MS,
+ FAST_RETRY_MS,
+ createMultiplayerRetryTracker,
+} from "./multiplayer-retry-tracker";
+
+const makeApply = (overrides: Partial<ApplyMessage> = {}): ApplyMessage => ({
+ type: "apply",
+ transactionId: "tx-1",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ clientId: "client-1",
+ actorId: "actor-1",
+ clientSeq: 1,
+ ...overrides,
+});
+
+describe("createMultiplayerRetryTracker", () => {
+ beforeEach(() => {
+ vi.useFakeTimers();
+ });
+
+ afterEach(() => {
+ vi.restoreAllMocks();
+ vi.useRealTimers();
+ });
+
+ test("retries the exact same apply when durable ack does not arrive", async () => {
+ const sendApply = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleBroadcast({
+ type: "broadcast",
+ transaction: apply.transaction,
+ originClientId: "client-1",
+ seq: 7,
+ actorId: "actor-1",
+ clientSeq: 1,
+ relayTs: 10,
+ });
+
+ expect(sendApply).toHaveBeenCalledTimes(1);
+
+ await vi.advanceTimersByTimeAsync(ACK_TIMEOUT_MS);
+ expect(sendApply).toHaveBeenCalledTimes(2);
+ expect(sendApply).toHaveBeenLastCalledWith(apply);
+
+ await vi.advanceTimersByTimeAsync(FAST_RETRY_MS);
+ expect(sendApply).toHaveBeenCalledTimes(3);
+ expect(sendApply).toHaveBeenLastCalledWith(apply);
+ });
+
+ test("clears pending state when ack reaches the pending sequence", async () => {
+ const sendApply = vi.fn();
+ const onDurable = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ onDurable,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleBroadcast({
+ type: "broadcast",
+ transaction: apply.transaction,
+ originClientId: "client-1",
+ seq: 7,
+ actorId: "actor-1",
+ clientSeq: 1,
+ relayTs: 10,
+ });
+ tracker.handleAck({ type: "ack", seq: 7, version: 4 });
+
+ expect(onDurable).toHaveBeenCalledWith({
+ message: apply,
+ seq: 7,
+ version: 4,
+ });
+ expect(tracker.getPendingCount()).toBe(0);
+
+ await vi.advanceTimersByTimeAsync(ACK_TIMEOUT_MS);
+ expect(sendApply).toHaveBeenCalledTimes(1);
+ });
+
+ test("ignores older ack versions after a newer ack was seen", () => {
+ const sendApply = vi.fn();
+ const onDurable = vi.fn();
+ const apply = makeApply({ transactionId: "tx-2", clientSeq: 2 });
+ const tracker = createMultiplayerRetryTracker({
+ onDurable,
+ sendApply,
+ });
+
+ tracker.handleAck({ type: "ack", seq: 10, version: 12 });
+ tracker.handleAck({ type: "ack", seq: 9, version: 11 });
+ tracker.track(apply);
+ tracker.handleBroadcast({
+ type: "broadcast",
+ transaction: apply.transaction,
+ originClientId: "client-1",
+ seq: 10,
+ actorId: "actor-1",
+ clientSeq: 2,
+ relayTs: 10,
+ });
+
+ expect(onDurable).toHaveBeenCalledWith({
+ message: apply,
+ seq: 10,
+ version: 12,
+ });
+ });
+
+ test("does not clear pending state on settled without a durable ack", async () => {
+ const sendApply = vi.fn();
+ const onDurable = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ ackTimeoutMs: 100,
+ onDurable,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleApplied({
+ type: "applied",
+ transactionId: "tx-1",
+ seq: 7,
+ status: "settled",
+ });
+
+ expect(tracker.getPendingCount()).toBe(1);
+ expect(onDurable).not.toHaveBeenCalled();
+
+ await vi.advanceTimersByTimeAsync(100);
+ expect(sendApply).toHaveBeenCalledTimes(2);
+
+ tracker.handleAck({ type: "ack", seq: 7, version: 4 });
+ expect(onDurable).toHaveBeenCalledWith({
+ message: apply,
+ seq: 7,
+ version: 4,
+ });
+ expect(tracker.getPendingCount()).toBe(0);
+ });
+
+ test("drops pending state when worker drops an apply", () => {
+ const sendApply = vi.fn();
+ const onDropped = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ onDropped,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleApplied({
+ type: "applied",
+ transactionId: "tx-1",
+ seq: 0,
+ status: "dropped",
+ });
+
+ expect(onDropped).toHaveBeenCalledWith({
+ message: apply,
+ seq: 0,
+ status: "dropped",
+ });
+ expect(tracker.getPendingCount()).toBe(0);
+ });
+
+ test("drops pending state when persistence rejects or fails an apply", () => {
+ const sendApply = vi.fn();
+ const onDropped = vi.fn();
+ const onUserMessage = vi.fn();
+ const tracker = createMultiplayerRetryTracker({
+ onDropped,
+ onUserMessage,
+ sendApply,
+ });
+ const rejected = makeApply();
+ const failed = makeApply({ transactionId: "tx-2", clientSeq: 2 });
+
+ tracker.track(rejected);
+ tracker.track(failed);
+ tracker.handleApplied({
+ type: "applied",
+ transactionId: "tx-1",
+ seq: 1,
+ status: "rejected",
+ errors: "No permission",
+ });
+ tracker.handleApplied({
+ type: "applied",
+ transactionId: "tx-2",
+ seq: 2,
+ status: "failed",
+ errors: "Patch failed",
+ });
+
+ expect(onDropped).toHaveBeenCalledWith({
+ message: rejected,
+ seq: 1,
+ status: "rejected",
+ errors: "No permission",
+ });
+ expect(onDropped).toHaveBeenCalledWith({
+ message: failed,
+ seq: 2,
+ status: "failed",
+ errors: "Patch failed",
+ });
+ expect(onUserMessage).toHaveBeenCalledWith("No permission");
+ expect(onUserMessage).toHaveBeenCalledWith("Patch failed");
+ expect(tracker.getPendingCount()).toBe(0);
+ });
+
+ test("uses backoff after fast retries are exhausted", async () => {
+ const sendApply = vi.fn();
+ const onUserMessage = vi.fn();
+ const apply = makeApply();
+ vi.spyOn(Math, "random").mockReturnValue(0.4);
+ const tracker = createMultiplayerRetryTracker({
+ ackTimeoutMs: 100,
+ fastRetryMs: 200,
+ maxFastRetries: 1,
+ onUserMessage,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleBroadcast({
+ type: "broadcast",
+ transaction: apply.transaction,
+ originClientId: "client-1",
+ seq: 7,
+ actorId: "actor-1",
+ clientSeq: 1,
+ relayTs: 10,
+ });
+
+ await vi.advanceTimersByTimeAsync(100);
+ await vi.advanceTimersByTimeAsync(200);
+
+ expect(sendApply).toHaveBeenCalledTimes(3);
+ expect(onUserMessage).toHaveBeenCalledWith(
+ "Changes are taking longer than expected to save. Retrying in 9 seconds."
+ );
+ });
+
+ test("respects rate-limit retryAfterMs before resending", async () => {
+ const sendApply = vi.fn();
+ const onUserMessage = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ fastRetryMs: 2_000,
+ onUserMessage,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleErrorMessage({
+ type: "error",
+ code: "rate_limited",
+ message: "Slow down",
+ transactionId: "tx-1",
+ retryAfterMs: 3_000,
+ });
+
+ expect(onUserMessage).toHaveBeenCalledWith("Slow down");
+
+ await vi.advanceTimersByTimeAsync(2_999);
+ expect(sendApply).toHaveBeenCalledTimes(1);
+
+ await vi.advanceTimersByTimeAsync(1);
+ expect(sendApply).toHaveBeenCalledTimes(2);
+ expect(sendApply).toHaveBeenLastCalledWith(apply);
+ });
+
+ test("resends pending operations on reconnect without owning socket backoff", () => {
+ const sendApply = vi.fn();
+ const onRetry = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ onRetry,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleReconnect();
+
+ expect(sendApply).toHaveBeenCalledTimes(2);
+ expect(sendApply).toHaveBeenLastCalledWith(apply);
+ expect(onRetry).toHaveBeenCalledWith({
+ message: apply,
+ reason: "reconnect",
+ retryInMs: 0,
+ });
+ });
+
+ test("stops retrying after reload", async () => {
+ const sendApply = vi.fn();
+ const onReload = vi.fn();
+ const apply = makeApply();
+ const tracker = createMultiplayerRetryTracker({
+ ackTimeoutMs: 100,
+ onReload,
+ sendApply,
+ });
+
+ tracker.track(apply);
+ tracker.handleBroadcast({
+ type: "broadcast",
+ transaction: apply.transaction,
+ originClientId: "client-1",
+ seq: 7,
+ actorId: "actor-1",
+ clientSeq: 1,
+ relayTs: 10,
+ });
+ tracker.handleReload({ type: "reload", reason: "persistence_error" });
+
+ expect(onReload).toHaveBeenCalledWith({
+ type: "reload",
+ reason: "persistence_error",
+ });
+ expect(tracker.getPendingCount()).toBe(0);
+
+ await vi.advanceTimersByTimeAsync(100);
+ expect(sendApply).toHaveBeenCalledTimes(1);
+ });
+});
diff --git a/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.ts b/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.ts
new file mode 100644
index 0000000000..44791123fa
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/multiplayer-retry-tracker.ts
@@ -0,0 +1,298 @@
+import type {
+ AckMessage,
+ AppliedMessage,
+ ApplyMessage,
+ BroadcastMessage,
+ ErrorMessage,
+ ReloadMessage,
+} from "@webstudio-is/multiplayer-protocol";
+import { createBackoff, type Backoff } from "../backoff";
+
+export const ACK_TIMEOUT_MS = 15_000;
+export const FAST_RETRY_MS = 2_000;
+export const MAX_FAST_RETRIES = 3;
+export const syncDelayedMessage =
+ "Changes are taking longer than expected to save. Retrying in X seconds.";
+
+type PendingApply = {
+ backoff: Backoff;
+ message: ApplyMessage;
+ retryTimer: ReturnType<typeof setTimeout> | undefined;
+ seq: number | undefined;
+ timeoutRetries: number;
+};
+
+export type RetryReason =
+ | "missing_ack"
+ | "rate_limited"
+ | "persistence_backlog_full"
+ | "reconnect";
+
+export type MultiplayerRetryTrackerOptions = {
+ sendApply: (message: ApplyMessage) => void;
+ onDurable?: (event: {
+ message: ApplyMessage;
+ seq: number;
+ version: number;
+ }) => void;
+ onDropped?: (event: {
+ message: ApplyMessage;
+ seq: number;
+ status: AppliedMessage["status"];
+ errors?: string;
+ }) => void;
+ onRetry?: (event: {
+ message: ApplyMessage;
+ reason: RetryReason;
+ retryInMs: number;
+ }) => void;
+ onUserMessage?: (message: string) => void;
+ onReload?: (message: ReloadMessage) => void;
+ ackTimeoutMs?: number;
+ fastRetryMs?: number;
+ maxFastRetries?: number;
+ setTimeout?: typeof setTimeout;
+ clearTimeout?: typeof clearTimeout;
+};
+
+export const createMultiplayerRetryTracker = ({
+ ackTimeoutMs = ACK_TIMEOUT_MS,
+ clearTimeout: clearTimer = globalThis.clearTimeout,
+ fastRetryMs = FAST_RETRY_MS,
+ maxFastRetries = MAX_FAST_RETRIES,
+ onDropped,
+ onDurable,
+ onReload,
+ onRetry,
+ onUserMessage,
+ sendApply,
+ setTimeout: setTimer = globalThis.setTimeout,
+}: MultiplayerRetryTrackerOptions) => {
+ const pendingByTransactionId = new Map<string, PendingApply>();
+ const pendingByOperationKey = new Map<string, PendingApply>();
+ let lastAckSeq = 0;
+ let lastAckVersion = 0;
+ let stopped = false;
+
+ const operationKey = (message: Pick<ApplyMessage, "actorId" | "clientSeq">) =>
+ `${message.actorId}:${message.clientSeq}`;
+
+ const clearRetryTimer = (entry: PendingApply) => {
+ if (entry.retryTimer !== undefined) {
+ clearTimer(entry.retryTimer);
+ entry.retryTimer = undefined;
+ }
+ };
+
+ const deletePending = (entry: PendingApply) => {
+ clearRetryTimer(entry);
+ pendingByTransactionId.delete(entry.message.transactionId);
+ pendingByOperationKey.delete(operationKey(entry.message));
+ };
+
+ const markDurable = (entry: PendingApply, version: number) => {
+ if (entry.seq === undefined) {
+ return;
+ }
+ deletePending(entry);
+ onDurable?.({ message: entry.message, seq: entry.seq, version });
+ };
+
+ const maybeMarkDurable = (entry: PendingApply) => {
+ if (entry.seq !== undefined && lastAckSeq >= entry.seq) {
+ markDurable(entry, lastAckVersion);
+ return true;
+ }
+ return false;
+ };
+
+ const getNextRetryDelay = (entry: PendingApply) => {
+ entry.timeoutRetries += 1;
+ if (entry.timeoutRetries <= maxFastRetries) {
+ return fastRetryMs;
+ }
+ const delay = entry.backoff.next();
+ onUserMessage?.(
+ syncDelayedMessage.replace("X", String(Math.round(delay / 1000)))
+ );
+ return delay;
+ };
+
+ const scheduleRetry = (
+ entry: PendingApply,
+ delay: number,
+ reason: RetryReason
+ ) => {
+ if (stopped) {
+ return;
+ }
+ clearRetryTimer(entry);
+ onRetry?.({ message: entry.message, reason, retryInMs: delay });
+ entry.retryTimer = setTimer(() => {
+ entry.retryTimer = undefined;
+ if (
+ stopped ||
+ pendingByTransactionId.has(entry.message.transactionId) === false
+ ) {
+ return;
+ }
+ sendApply(entry.message);
+ if (entry.seq !== undefined) {
+ scheduleRetry(entry, getNextRetryDelay(entry), "missing_ack");
+ }
+ }, delay);
+ };
+
+ const scheduleAckTimeout = (entry: PendingApply, delay = ackTimeoutMs) => {
+ scheduleRetry(entry, delay, "missing_ack");
+ };
+
+ const track = (message: ApplyMessage) => {
+ if (stopped) {
+ return;
+ }
+
+ const existing = pendingByTransactionId.get(message.transactionId);
+ if (existing !== undefined) {
+ sendApply(existing.message);
+ return;
+ }
+
+ const entry: PendingApply = {
+ backoff: createBackoff(),
+ message,
+ retryTimer: undefined,
+ seq: undefined,
+ timeoutRetries: 0,
+ };
+ pendingByTransactionId.set(message.transactionId, entry);
+ pendingByOperationKey.set(operationKey(message), entry);
+ sendApply(message);
+ };
+
+ const handleBroadcast = (message: BroadcastMessage) => {
+ const entry = pendingByOperationKey.get(operationKey(message));
+ if (entry === undefined) {
+ return false;
+ }
+
+ entry.seq = message.seq;
+ entry.timeoutRetries = 0;
+ entry.backoff.reset();
+
+ if (maybeMarkDurable(entry)) {
+ return true;
+ }
+
+ scheduleAckTimeout(entry);
+ return true;
+ };
+
+ const handleAck = (message: AckMessage) => {
+ if (message.seq >= lastAckSeq) {
+ lastAckSeq = message.seq;
+ lastAckVersion = message.version;
+ }
+
+ for (const entry of Array.from(pendingByTransactionId.values())) {
+ maybeMarkDurable(entry);
+ }
+ };
+
+ const handleApplied = (message: AppliedMessage) => {
+ const entry = pendingByTransactionId.get(message.transactionId);
+ if (entry === undefined) {
+ return;
+ }
+
+ if (message.status === "dropped") {
+ deletePending(entry);
+ onDropped?.({
+ message: entry.message,
+ seq: message.seq,
+ status: message.status,
+ });
+ return;
+ }
+
+ if (message.status === "rejected" || message.status === "failed") {
+ deletePending(entry);
+ onUserMessage?.(
+ message.errors ??
+ (message.status === "rejected"
+ ? "You don't have permission to save this change."
+ : "This change could not be saved.")
+ );
+ onDropped?.({
+ message: entry.message,
+ seq: message.seq,
+ status: message.status,
+ errors: message.errors,
+ });
+ return;
+ }
+
+ entry.seq = message.seq;
+ if (maybeMarkDurable(entry)) {
+ return;
+ }
+ scheduleAckTimeout(entry);
+ };
+
+ const handleErrorMessage = (message: ErrorMessage) => {
+ onUserMessage?.(message.message);
+ const transactionId = message.transactionId;
+ if (transactionId === undefined) {
+ return;
+ }
+
+ const entry = pendingByTransactionId.get(transactionId);
+ if (entry === undefined) {
+ return;
+ }
+
+ const delay = Math.max(message.retryAfterMs ?? 0, getNextRetryDelay(entry));
+ scheduleRetry(entry, delay, message.code);
+ };
+
+ const handleReload = (message: ReloadMessage) => {
+ stopped = true;
+ for (const entry of pendingByTransactionId.values()) {
+ clearRetryTimer(entry);
+ }
+ pendingByTransactionId.clear();
+ pendingByOperationKey.clear();
+ onReload?.(message);
+ };
+
+ const handleReconnect = () => {
+ if (stopped) {
+ return;
+ }
+ for (const entry of pendingByTransactionId.values()) {
+ sendApply(entry.message);
+ onRetry?.({ message: entry.message, reason: "reconnect", retryInMs: 0 });
+ }
+ };
+
+ const destroy = () => {
+ stopped = true;
+ for (const entry of pendingByTransactionId.values()) {
+ clearRetryTimer(entry);
+ }
+ pendingByTransactionId.clear();
+ pendingByOperationKey.clear();
+ };
+
+ return {
+ destroy,
+ getPendingCount: () => pendingByTransactionId.size,
+ handleAck,
+ handleApplied,
+ handleBroadcast,
+ handleErrorMessage,
+ handleReconnect,
+ handleReload,
+ track,
+ };
+};
diff --git a/packages/sync-client/src/multiplayer/websocket-emitter.test.ts b/packages/sync-client/src/multiplayer/websocket-emitter.test.ts
new file mode 100644
index 0000000000..0c05a1b4f6
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/websocket-emitter.test.ts
@@ -0,0 +1,300 @@
+import { describe, expect, test, vi } from "vitest";
+
+const { partySocketOptions } = vi.hoisted(() => ({
+ partySocketOptions: [] as Array<{
+ host: string;
+ prefix?: string;
+ protocol: "ws" | "wss" | undefined;
+ query: () => Promise<Record<string, string>>;
+ }>,
+}));
+
+vi.mock("partysocket", () => ({
+ default: vi.fn((options) => {
+ partySocketOptions.push(options);
+ return {
+ addEventListener: vi.fn(),
+ close: vi.fn(),
+ readyState: 1,
+ send: vi.fn(),
+ };
+ }),
+}));
+
+import {
+ createWebSocketSyncEmitter,
+ dispatchWebSocketMessage,
+ parseCollabRelayUrl,
+} from "./websocket-emitter";
+
+const createCallbacks = () => ({
+ onAck: vi.fn(),
+ onApplied: vi.fn(),
+ onPresence: vi.fn(),
+ onBroadcast: vi.fn(),
+ onReload: vi.fn(),
+ onErrorMessage: vi.fn(),
+});
+
+describe("dispatchWebSocketMessage", () => {
+ test("forwards applied status from websocket messages", () => {
+ const callbacks = createCallbacks();
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify({
+ type: "applied",
+ transactionId: "tx-1",
+ seq: 7,
+ status: "settled",
+ }),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onApplied).toHaveBeenCalledWith(
+ "tx-1",
+ 7,
+ "settled",
+ undefined
+ );
+ });
+
+ test("forwards applied errors from websocket messages", () => {
+ const callbacks = createCallbacks();
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify({
+ type: "applied",
+ transactionId: "tx-1",
+ seq: 7,
+ status: "rejected",
+ errors: "No permission",
+ }),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onApplied).toHaveBeenCalledWith(
+ "tx-1",
+ 7,
+ "rejected",
+ "No permission"
+ );
+ });
+
+ test("forwards broadcast messages", () => {
+ const callbacks = createCallbacks();
+ const message = {
+ type: "broadcast",
+ transaction: { id: "tx-1", object: "server", payload: [] },
+ originClientId: "client-1",
+ seq: 1,
+ actorId: "actor-1",
+ clientSeq: 1,
+ relayTs: 10,
+ };
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify(message),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onBroadcast).toHaveBeenCalledWith(message);
+ });
+
+ test("forwards ack messages", () => {
+ const callbacks = createCallbacks();
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify({ type: "ack", seq: 3, version: 9 }),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onAck).toHaveBeenCalledWith(3, 9);
+ });
+
+ test("forwards presence messages", () => {
+ const callbacks = createCallbacks();
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify({
+ type: "presence",
+ clientId: "client-1",
+ payload: { pointerPosition: { x: 1, y: 2, xRatio: 0.1, yRatio: 0.2 } },
+ }),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onPresence).toHaveBeenCalledWith("client-1", {
+ pointerPosition: { x: 1, y: 2, xRatio: 0.1, yRatio: 0.2 },
+ });
+ });
+
+ test("forwards reload messages", () => {
+ const callbacks = createCallbacks();
+ const message = {
+ type: "reload",
+ reason: "version_mismatched",
+ errors: "Reload required",
+ };
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify(message),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onReload).toHaveBeenCalledWith(message);
+ });
+
+ test("forwards error messages", () => {
+ const callbacks = createCallbacks();
+ const message = {
+ type: "error",
+ code: "persistence_backlog_full",
+ message:
+ "Collaboration is catching up. Please pause for a moment while changes are saved.",
+ retryAfterMs: 100,
+ };
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify(message),
+ handlers: new Set(),
+ callbacks,
+ });
+
+ expect(callbacks.onErrorMessage).toHaveBeenCalledWith(message);
+ });
+
+ test("does not forward old role messages to sync handlers", () => {
+ const callbacks = createCallbacks();
+ const handler = vi.fn();
+
+ dispatchWebSocketMessage({
+ data: JSON.stringify({ type: "role", role: "leader" }),
+ handlers: new Set([handler]),
+ callbacks,
+ });
+
+ expect(handler).not.toHaveBeenCalled();
+ });
+});
+
+describe("parseCollabRelayUrl", () => {
+ test("uses ws for loopback hosts", () => {
+ expect(parseCollabRelayUrl("localhost:1999")).toEqual({
+ host: "localhost:1999",
+ protocol: "ws",
+ });
+ });
+
+ test("lets PartySocket choose protocol for bare remote hosts", () => {
+ expect(parseCollabRelayUrl("collab.example.com")).toEqual({
+ host: "collab.example.com",
+ protocol: undefined,
+ });
+ });
+
+ test("preserves relay URL path as PartySocket prefix", () => {
+ expect(parseCollabRelayUrl("apps.webstudio.is/collab-relay")).toEqual({
+ host: "apps.webstudio.is",
+ prefix: "collab-relay/parties",
+ protocol: undefined,
+ });
+ });
+
+ test("normalizes explicit http and https URLs to websocket protocols", () => {
+ expect(parseCollabRelayUrl("http://collab.example.com")).toEqual({
+ host: "collab.example.com",
+ protocol: "ws",
+ });
+ expect(parseCollabRelayUrl("https://collab.example.com")).toEqual({
+ host: "collab.example.com",
+ protocol: "wss",
+ });
+ });
+
+ test("keeps explicit websocket protocols", () => {
+ expect(parseCollabRelayUrl("ws://collab.example.com")).toEqual({
+ host: "collab.example.com",
+ protocol: "ws",
+ });
+ expect(parseCollabRelayUrl("wss://collab.example.com")).toEqual({
+ host: "collab.example.com",
+ protocol: "wss",
+ });
+ });
+
+ test("trims leading and trailing path slashes for prefix", () => {
+ expect(
+ parseCollabRelayUrl("https://apps.webstudio.is/collab-relay/")
+ ).toEqual({
+ host: "apps.webstudio.is",
+ prefix: "collab-relay/parties",
+ protocol: "wss",
+ });
+ });
+});
+
+describe("createWebSocketSyncEmitter", () => {
+ test("omits auth token query for view-only connections", async () => {
+ partySocketOptions.length = 0;
+
+ createWebSocketSyncEmitter({
+ url: "localhost:1999",
+ buildId: "build-1",
+ clientId: "client-1",
+ onAck: vi.fn(),
+ onApplied: vi.fn(),
+ onBroadcast: vi.fn(),
+ onErrorMessage: vi.fn(),
+ onPresence: vi.fn(),
+ });
+
+ await expect(partySocketOptions[0].query()).resolves.toEqual({});
+ });
+
+ test("sends auth token query when provided", async () => {
+ partySocketOptions.length = 0;
+
+ createWebSocketSyncEmitter({
+ url: "localhost:1999",
+ buildId: "build-1",
+ clientId: "client-1",
+ getAuthToken: async () => "token-1",
+ onAck: vi.fn(),
+ onApplied: vi.fn(),
+ onBroadcast: vi.fn(),
+ onErrorMessage: vi.fn(),
+ onPresence: vi.fn(),
+ });
+
+ await expect(partySocketOptions[0].query()).resolves.toEqual({
+ token: "token-1",
+ });
+ });
+
+ test("passes parsed relay URL options to PartySocket", () => {
+ partySocketOptions.length = 0;
+
+ createWebSocketSyncEmitter({
+ url: "https://apps.webstudio.is/collab-relay",
+ buildId: "build-1",
+ clientId: "client-1",
+ onAck: vi.fn(),
+ onApplied: vi.fn(),
+ onBroadcast: vi.fn(),
+ onErrorMessage: vi.fn(),
+ onPresence: vi.fn(),
+ });
+
+ expect(partySocketOptions[0]).toMatchObject({
+ host: "apps.webstudio.is",
+ prefix: "collab-relay/parties",
+ protocol: "wss",
+ });
+ });
+});
diff --git a/packages/sync-client/src/multiplayer/websocket-emitter.ts b/packages/sync-client/src/multiplayer/websocket-emitter.ts
new file mode 100644
index 0000000000..b43b867b20
--- /dev/null
+++ b/packages/sync-client/src/multiplayer/websocket-emitter.ts
@@ -0,0 +1,264 @@
+/**
+ * createWebSocketSyncEmitter - SyncEmitter over PartySocket (auto-reconnect WebSocket).
+ *
+ * Relay-specific message types (ack, applied, broadcast, reload, error,
+ * presence) are
+ * dispatched to dedicated callbacks; standard SyncClient messages (connect,
+ * state, apply, revert) are forwarded to local handlers.
+ *
+ * Auth token is injected by the host so this module stays auth-agnostic.
+ */
+
+import PartySocket from "partysocket";
+import type { SyncEmitter, SyncMessage } from "../types";
+import type {
+ AckMessage,
+ AppliedMessage,
+ BroadcastMessage,
+ ErrorMessage,
+ PresenceMessage,
+ ReloadMessage,
+ RelayClientMessage,
+ RelayServerMessage,
+} from "@webstudio-is/multiplayer-protocol";
+import { stripRevisePatchesFromTransaction } from "@webstudio-is/multiplayer-protocol";
+
+interface MessageCallbacks
+ extends Pick<
+ WebSocketEmitterOptions,
+ | "onAck"
+ | "onApplied"
+ | "onPresence"
+ | "onBroadcast"
+ | "onReload"
+ | "onErrorMessage"
+ > {}
+
+export type WebSocketEmitterOptions = {
+ url: string;
+ buildId: string;
+ clientId: string;
+ getAuthToken?: () => Promise<string | undefined>;
+ onAck: (seq: number, version: number) => void;
+ onApplied: (
+ transactionId: string,
+ seq: number,
+ status: AppliedMessage["status"],
+ errors?: string
+ ) => void;
+ onPresence: (clientId: string, payload: unknown) => void;
+ onBroadcast: (message: BroadcastMessage) => void;
+ onErrorMessage: (message: ErrorMessage) => void;
+ onReload?: (message: ReloadMessage) => void;
+ onOpen?: () => void;
+ onClose?: () => void;
+};
+
+/** The multiplayer transport interface used by browser and CLI clients. */
+export type WebSocketSyncEmitter = SyncEmitter & {
+ sendToRelay(message: RelayClientMessage): void;
+ close(): void;
+};
+
+export type CollabRelayUrl = {
+ host: string;
+ prefix?: string;
+ protocol: "ws" | "wss" | undefined;
+};
+
+export const parseCollabRelayUrl = (relayUrl: string): CollabRelayUrl => {
+ const hasExplicitProtocol =
+ relayUrl.match(/^https?:\/\//) !== null ||
+ relayUrl.match(/^wss?:\/\//) !== null;
+ const url = new URL(hasExplicitProtocol ? relayUrl : `ws://${relayUrl}`);
+ const isLoopbackHost =
+ url.hostname === "localhost" ||
+ url.hostname === "127.0.0.1" ||
+ url.hostname === "0.0.0.0" ||
+ url.hostname === "[::1]";
+ const protocol =
+ hasExplicitProtocol && url.protocol === "ws:"
+ ? "ws"
+ : hasExplicitProtocol && url.protocol === "wss:"
+ ? "wss"
+ : hasExplicitProtocol && url.protocol === "http:"
+ ? "ws"
+ : hasExplicitProtocol && url.protocol === "https:"
+ ? "wss"
+ : isLoopbackHost
+ ? "ws"
+ : undefined;
+ const relayPathPrefix = url.pathname.replace(/^\/+|\/+$/g, "");
+ const prefix =
+ relayPathPrefix.length === 0 ? undefined : `${relayPathPrefix}/parties`;
+ return {
+ host: url.host,
+ prefix,
+ protocol,
+ };
+};
+
+export const dispatchWebSocketMessage = ({
+ data,
+ handlers,
+ callbacks,
+ onMessage,
+ onParseError,
+}: {
+ data: string;
+ handlers: Set<(message: SyncMessage) => void>;
+ callbacks: MessageCallbacks;
+ onMessage?: (message: RelayServerMessage | SyncMessage) => void;
+ onParseError?: (raw: string) => void;
+}) => {
+ let parsed: RelayServerMessage | SyncMessage;
+ try {
+ parsed = JSON.parse(data) as RelayServerMessage | SyncMessage;
+ } catch {
+ onParseError?.(data);
+ return;
+ }
+
+ const type = (parsed as { type: string }).type;
+ onMessage?.(parsed);
+
+ if (type === "ack") {
+ const ack = parsed as AckMessage;
+ callbacks.onAck(ack.seq, ack.version);
+ return;
+ }
+ if (type === "applied") {
+ const applied = parsed as AppliedMessage;
+ callbacks.onApplied(
+ applied.transactionId,
+ applied.seq,
+ applied.status,
+ applied.errors
+ );
+ return;
+ }
+ if (type === "presence") {
+ const presence = parsed as PresenceMessage;
+ callbacks.onPresence(presence.clientId, presence.payload);
+ return;
+ }
+ if (type === "broadcast") {
+ callbacks.onBroadcast(parsed as BroadcastMessage);
+ return;
+ }
+ if (type === "reload") {
+ callbacks.onReload?.(parsed as ReloadMessage);
+ return;
+ }
+ if (type === "error") {
+ callbacks.onErrorMessage(parsed as ErrorMessage);
+ return;
+ }
+
+ if (
+ type === "connect" ||
+ type === "state" ||
+ type === "apply" ||
+ type === "revert"
+ ) {
+ // Standard SyncClient messages for same-host sync primitives.
+ const syncMsg = parsed as SyncMessage;
+ for (const handler of handlers) {
+ handler(syncMsg);
+ }
+ }
+};
+
+export const createWebSocketSyncEmitter = (
+ opts: WebSocketEmitterOptions
+): WebSocketSyncEmitter => {
+ const warnPrefix = `[collab-ws:${opts.clientId.slice(0, 6)}]`;
+ const warn = (message: string, ...args: unknown[]) =>
+ console.warn(`${warnPrefix} ${message}`, ...args);
+
+ const relayUrl = parseCollabRelayUrl(opts.url);
+
+ const ws = new PartySocket({
+ host: relayUrl.host,
+ prefix: relayUrl.prefix,
+ protocol: relayUrl.protocol,
+ room: opts.buildId,
+ id: opts.clientId,
+ query: async () => {
+ const authToken = await opts.getAuthToken?.();
+ return authToken === undefined || authToken.length === 0
+ ? {}
+ : { token: authToken };
+ },
+ });
+ const socketRoomUrl =
+ "roomUrl" in ws && typeof ws.roomUrl === "string" ? ws.roomUrl : undefined;
+
+ const handlers = new Set<(message: SyncMessage) => void>();
+
+ const sanitizeRelayMessage = (
+ message: RelayClientMessage
+ ): RelayClientMessage => {
+ if (message.type === "apply") {
+ return {
+ ...message,
+ transaction: stripRevisePatchesFromTransaction(message.transaction),
+ };
+ }
+ return message;
+ };
+
+ ws.addEventListener("open", () => {
+ opts.onOpen?.();
+ });
+ ws.addEventListener("close", (event) => {
+ if (event.code !== 1000) {
+ warn(
+ "socket closed url=%s code=%d reason=%s wasClean=%s",
+ socketRoomUrl,
+ event.code,
+ event.reason,
+ event.wasClean
+ );
+ }
+ opts.onClose?.();
+ });
+ ws.addEventListener("error", (event) => {
+ warn("socket error url=%s event=%o", socketRoomUrl, event);
+ });
+
+ ws.addEventListener("message", (ev) => {
+ dispatchWebSocketMessage({
+ data: ev.data as string,
+ handlers,
+ callbacks: opts,
+ onParseError: (raw) => {
+ warn("message parse failed raw=%s", raw.slice(0, 200));
+ },
+ });
+ });
+
+ return {
+ emit(message: SyncMessage): void {
+ ws.send(JSON.stringify(message));
+ // Deliver locally too, so any same-tab listener receives it.
+ for (const handler of handlers) {
+ handler(message);
+ }
+ },
+
+ on(handler: (message: SyncMessage) => void): () => void {
+ handlers.add(handler);
+ return () => handlers.delete(handler);
+ },
+
+ sendToRelay(message: RelayClientMessage): void {
+ const sanitized = sanitizeRelayMessage(message);
+ ws.send(JSON.stringify(sanitized));
+ },
+
+ close(): void {
+ ws.close();
+ },
+ };
+};
diff --git a/packages/sync-client/src/sync-status.test.ts b/packages/sync-client/src/sync-status.test.ts
new file mode 100644
index 0000000000..a25b61f9a8
--- /dev/null
+++ b/packages/sync-client/src/sync-status.test.ts
@@ -0,0 +1,37 @@
+import { afterEach, describe, expect, test } from "vitest";
+import { $hasUnsavedSyncChanges, $syncStatus } from "./sync-status";
+
+afterEach(() => {
+ $syncStatus.set({ status: "idle" });
+});
+
+describe("$syncStatus", () => {
+ test("reports idle when sync is idle", () => {
+ $syncStatus.set({ status: "idle" });
+
+ expect($syncStatus.get()).toEqual({ status: "idle" });
+ expect($hasUnsavedSyncChanges.get()).toBe(false);
+ });
+
+ test("reports unsaved changes while syncing", () => {
+ $syncStatus.set({ status: "syncing" });
+
+ expect($syncStatus.get()).toEqual({ status: "syncing" });
+ expect($hasUnsavedSyncChanges.get()).toBe(true);
+ });
+
+ test("reports unsaved changes while recovering or failed", () => {
+ $syncStatus.set({ status: "recovering" });
+ expect($hasUnsavedSyncChanges.get()).toBe(true);
+
+ $syncStatus.set({ status: "failed" });
+ expect($hasUnsavedSyncChanges.get()).toBe(true);
+ });
+
+ test("does not report fatal as unsaved because sync is paused", () => {
+ $syncStatus.set({ status: "fatal", error: "broken" });
+
+ expect($syncStatus.get()).toEqual({ status: "fatal", error: "broken" });
+ expect($hasUnsavedSyncChanges.get()).toBe(false);
+ });
+});
diff --git a/packages/sync-client/src/sync-status.ts b/packages/sync-client/src/sync-status.ts
new file mode 100644
index 0000000000..542366705d
--- /dev/null
+++ b/packages/sync-client/src/sync-status.ts
@@ -0,0 +1,17 @@
+import { atom, computed } from "nanostores";
+
+export type SyncStatus =
+ | { status: "idle" }
+ | { status: "syncing" }
+ | { status: "recovering" }
+ | { status: "failed" }
+ | { status: "fatal"; error: string };
+
+export const $syncStatus = atom<SyncStatus>({
+ status: "idle",
+});
+
+export const $hasUnsavedSyncChanges = computed(
+ $syncStatus,
+ (status) => status.status !== "idle" && status.status !== "fatal"
+);
diff --git a/packages/sync-client/src/transaction-completion.test.ts b/packages/sync-client/src/transaction-completion.test.ts
new file mode 100644
index 0000000000..124d4f2f5a
--- /dev/null
+++ b/packages/sync-client/src/transaction-completion.test.ts
@@ -0,0 +1,47 @@
+import { describe, expect, test, vi } from "vitest";
+import { createTransactionCompletionStore } from "./transaction-completion";
+
+describe("createTransactionCompletionStore", () => {
+ test("calls completion callbacks and clears them", () => {
+ const store = createTransactionCompletionStore();
+ const callback = vi.fn();
+
+ store.onTransactionComplete("tx-1", callback);
+ store.completeTransaction("tx-1", true);
+ store.completeTransaction("tx-1", true);
+
+ expect(callback).toHaveBeenCalledOnce();
+ expect(callback).toHaveBeenCalledWith(true);
+ expect(store.callbacks.has("tx-1")).toBe(false);
+ });
+
+ test("calls next-transaction callback only on success", () => {
+ const store = createTransactionCompletionStore();
+ const callback = vi.fn();
+
+ store.onNextTransactionComplete(callback);
+ store.$lastTransactionId.set("tx-1");
+ store.completeTransaction("tx-1", false);
+
+ expect(callback).not.toHaveBeenCalled();
+
+ store.onNextTransactionComplete(callback);
+ store.$lastTransactionId.set("tx-2");
+ store.completeTransaction("tx-2", true);
+
+ expect(callback).toHaveBeenCalledOnce();
+ });
+
+ test("removes stale callbacks after timeout", () => {
+ vi.useFakeTimers();
+ const store = createTransactionCompletionStore();
+
+ store.onTransactionComplete("tx-1", vi.fn());
+ expect(store.callbacks.has("tx-1")).toBe(true);
+
+ vi.advanceTimersByTime(60_000);
+ expect(store.callbacks.has("tx-1")).toBe(false);
+
+ vi.useRealTimers();
+ });
+});
diff --git a/packages/sync-client/src/transaction-completion.ts b/packages/sync-client/src/transaction-completion.ts
new file mode 100644
index 0000000000..b6d9f876c1
--- /dev/null
+++ b/packages/sync-client/src/transaction-completion.ts
@@ -0,0 +1,74 @@
+import { atom } from "nanostores";
+
+type TransactionCompleteCallback = (success: boolean) => void;
+
+export const createTransactionCompletionStore = ({
+ timeoutMs = 60_000,
+ setTimeout: setTimer,
+}: {
+ timeoutMs?: number;
+ setTimeout?: typeof globalThis.setTimeout;
+} = {}) => {
+ const $lastTransactionId = atom<string | undefined>();
+ const callbacks = new Map<string, TransactionCompleteCallback[]>();
+ const scheduleTimeout = (callback: () => void) => {
+ return (setTimer ?? globalThis.setTimeout)(callback, timeoutMs);
+ };
+
+ const onTransactionComplete = (
+ transactionId: string,
+ callback: TransactionCompleteCallback
+ ) => {
+ const transactionCallbacks = callbacks.get(transactionId) ?? [];
+ transactionCallbacks.push(callback);
+ callbacks.set(transactionId, transactionCallbacks);
+
+ scheduleTimeout(() => {
+ callbacks.delete(transactionId);
+ });
+ };
+
+ const onNextTransactionComplete = (callback: () => void) => {
+ let unsubscribe: (() => void) | undefined;
+ unsubscribe = $lastTransactionId.subscribe((transactionId) => {
+ if (transactionId === undefined) {
+ return;
+ }
+ onTransactionComplete(transactionId, (success) => {
+ if (success) {
+ callback();
+ }
+ });
+ unsubscribe?.();
+ });
+
+ scheduleTimeout(() => {
+ unsubscribe?.();
+ });
+ };
+
+ const completeTransaction = (transactionId: string, success: boolean) => {
+ const transactionCallbacks = callbacks.get(transactionId);
+ if (transactionCallbacks === undefined) {
+ return;
+ }
+ for (const callback of transactionCallbacks) {
+ callback(success);
+ }
+ callbacks.delete(transactionId);
+ };
+
+ const clear = () => {
+ callbacks.clear();
+ $lastTransactionId.set(undefined);
+ };
+
+ return {
+ $lastTransactionId,
+ callbacks,
+ clear,
+ completeTransaction,
+ onNextTransactionComplete,
+ onTransactionComplete,
+ };
+};
diff --git a/packages/sync-client/src/types.ts b/packages/sync-client/src/types.ts
new file mode 100644
index 0000000000..bc8b04ea94
--- /dev/null
+++ b/packages/sync-client/src/types.ts
@@ -0,0 +1,30 @@
+import type {
+ RevertedTransaction,
+ Transaction,
+} from "@webstudio-is/multiplayer-protocol";
+
+export type { RevertedTransaction, Transaction };
+
+export type SyncMessage =
+ | { type: "connect"; clientId: string }
+ | { type: "state"; clientId: string; state: unknown }
+ | {
+ type: "apply";
+ clientId: string;
+ transaction: Transaction<unknown>;
+ }
+ | { type: "revert"; clientId: string; transaction: RevertedTransaction };
+
+export interface SyncEmitter {
+ emit(message: SyncMessage): void;
+ on(handler: (message: SyncMessage) => void): () => void;
+}
+
+/** Minimal interface for applying transactions to a sync object pool. */
+export interface SyncObject {
+ applyTransaction(transaction: Transaction): void;
+ subscribe(
+ sendTransaction: (transaction: Transaction) => void,
+ signal: AbortSignal
+ ): void;
+}
diff --git a/packages/sync-client/tsconfig.json b/packages/sync-client/tsconfig.json
new file mode 100644
index 0000000000..904e30bb05
--- /dev/null
+++ b/packages/sync-client/tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../packages/tsconfig/base.json",
+ "include": ["src"],
+ "compilerOptions": {
+ "paths": {}
+ }
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 79cf655de7..6c9dfb550c 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -216,7 +216,7 @@ importers:
version: 66.6.8
'@vercel/remix':
specifier: 2.15.3
'@webstudio-is/asset-uploader':
specifier: workspace:*
version: link:../../packages/asset-uploader
@@ -283,6 +283,9 @@ importers:
'@webstudio-is/sdk-components-react-radix':
specifier: workspace:*
version: link:../../packages/sdk-components-react-radix
+ '@webstudio-is/sync-client':
+ specifier: workspace:*
+ version: link:../../packages/sync-client
'@webstudio-is/template':
specifier: workspace:*
version: link:../../packages/template
@@ -384,7 +387,7 @@ importers:
remix-auth-oauth2:
specifier: ^2.3.0
shallow-equal:
specifier: ^3.1.0
version: 3.1.0
@@ -421,7 +424,7 @@ importers:
devDependencies:
'@remix-run/dev':
specifier: ^2.16.5
'@types/debug':
specifier: ^4.1.12
version: 4.1.12
@@ -1009,6 +1012,9 @@ importers:
'@webstudio-is/fonts':
specifier: workspace:*
version: link:../fonts
+ '@webstudio-is/postgrest':
+ specifier: workspace:*
+ version: link:../postgrest
'@webstudio-is/sdk':
specifier: workspace:*
version: link:../sdk
@@ -1034,9 +1040,6 @@ importers:
'@types/fontkit':
specifier: ^2.0.8
version: 2.0.8
- '@webstudio-is/postgrest':
- specifier: workspace:*
- version: link:../postgrest
'@webstudio-is/tsconfig':
specifier: workspace:*
version: link:../tsconfig
@@ -1128,25 +1131,25 @@ importers:
devDependencies:
'@cloudflare/vite-plugin':
specifier: ^1.1.0
'@netlify/vite-plugin-react-router':
specifier: ^1.0.1
'@react-router/dev':
specifier: ^7.5.3
'@react-router/fs-routes':
specifier: ^7.5.3
'@remix-run/cloudflare':
specifier: ^2.16.5
- version: 2.16.5(@cloudflare/[email protected])([email protected])
+ version: 2.16.5(@cloudflare/[email protected])([email protected])
'@remix-run/cloudflare-pages':
specifier: ^2.16.5
- version: 2.16.5(@cloudflare/[email protected])([email protected])
+ version: 2.16.5(@cloudflare/[email protected])([email protected])
'@remix-run/dev':
specifier: ^2.16.5
'@remix-run/node':
specifier: ^2.16.5
version: 2.16.5([email protected])
@@ -1167,7 +1170,7 @@ importers:
version: 17.0.33
'@vercel/react-router':
specifier: ^1.1.0
'@vitejs/plugin-react':
specifier: ^4.4.1
@@ -1239,7 +1242,7 @@ importers:
wrangler:
specifier: ^3.63.2
- version: 3.63.2(@cloudflare/[email protected])
+ version: 3.63.2(@cloudflare/[email protected])
packages/css-data:
dependencies:
@@ -1696,6 +1699,15 @@ importers:
specifier: ^3.1.2
+ packages/multiplayer-protocol:
+ devDependencies:
+ '@webstudio-is/tsconfig':
+ specifier: workspace:*
+ version: link:../tsconfig
+ vitest:
+ specifier: ^3.1.2
+
packages/plans:
dependencies:
zod:
@@ -1776,9 +1788,15 @@ importers:
'@webstudio-is/project-build':
specifier: workspace:*
version: link:../project-build
+ '@webstudio-is/sdk':
+ specifier: workspace:*
+ version: link:../sdk
'@webstudio-is/trpc-interface':
specifier: workspace:*
version: link:../trpc-interface
+ immer:
+ specifier: ^10.1.1
+ version: 10.1.1
nanoid:
specifier: ^5.1.5
version: 5.1.5
@@ -2258,6 +2276,31 @@ importers:
specifier: 18.3.0-canary-14898b6a9-20240318
version: 18.3.0-canary-14898b6a9-20240318([email protected])
+ packages/sync-client:
+ dependencies:
+ '@webstudio-is/multiplayer-protocol':
+ specifier: workspace:*
+ version: link:../multiplayer-protocol
+ immerhin:
+ specifier: '*'
+ version: 0.10.0
+ nanoid:
+ specifier: ^5.1.5
+ version: 5.1.5
+ nanostores:
+ specifier: ^0.11.3
+ version: 0.11.3
+ partysocket:
+ specifier: ^1.1.18
+ version: 1.1.18([email protected])
+ devDependencies:
+ '@webstudio-is/tsconfig':
+ specifier: workspace:*
+ version: link:../tsconfig
+ vitest:
+ specifier: ^3.1.2
+
packages/template:
dependencies:
'@webstudio-is/css-data':
@@ -2682,6 +2725,9 @@ packages:
'@cloudflare/[email protected]':
resolution: {integrity: sha512-6Cu6NIAicmb8H6CkzFdQG5Ib+TDs9HU8AKQEGlxnbvEBDmhUNpmL30ETXpLS0asdeyc+rTb2xag0hSv0Z1BflQ==}
+ '@cloudflare/[email protected]':
+ resolution: {integrity: sha512-7RqxXIM9HyhjfZ9ztXjITuc7mL0w4s+zXgypqKmMuvuObC3DgXutJ3bOYbQ+Ss5QbywrzWSNMlmGdL/ldg/yZg==}
+
'@codemirror/[email protected]':
resolution: {integrity: sha512-PHHBXFomUs5DF+9tCOM/UoW6XQ4R44lLNNhRaW9PKPTU0D7lIjRg3ElxaJnTwsl/oHiR93WSXDBrekhoUGCPtg==}
@@ -6630,6 +6676,9 @@ packages:
resolution: {integrity: sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==}
engines: {node: '>= 0.8'}
+ resolution: {integrity: sha512-Gs6RLjzlLRdT8X9ZipJdIZI/Y6/HhRLyq9RdDlCsnpxr/+Nn6bU2EFGuC94GjxqhM+Nmij2Vcq98yoHrU8uNFQ==}
+
resolution: {integrity: sha512-i/2XbnSz/uxRCU6+NdVJgKWDTM427+MqYbkQzD321DuCQJUqOuJKIA0IM2+W2xtYHdKOmZ4dR6fExsd4SXL+WQ==}
engines: {node: '>=6'}
@@ -7977,6 +8026,14 @@ packages:
resolution: {integrity: sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==}
engines: {node: '>= 0.8'}
+ resolution: {integrity: sha512-SyuvH9VavWOSa14v6dYdp3yfSUDII4BQB1+TkGOFBkjfZKjnDBiba4fhdhwBlqGBkqw4ea3gTA1DYhSffX24Wg==}
+ peerDependencies:
+ react: 18.3.0-canary-14898b6a9-20240318
+ peerDependenciesMeta:
+ react:
+ optional: true
+
resolution: {integrity: sha512-b7uo2UCUOYZcnF/3ID0lulOJi/bafxa1xPe7ZPsammBSpjSWQkjNxlt635YGS2MiR9GjvuXCtz2emr3jbsz98g==}
@@ -8934,9 +8991,6 @@ packages:
resolution: {integrity: sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==}
- resolution: {integrity: sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==}
-
resolution: {integrity: sha512-oJFu94HQb+KVduSUQL7wnpmqnfmLsOA/nAh6b6EH0wCEoK0/mPeXU6c3wKDV83MkOuHPRHtSXKKU99IBazS/2w==}
@@ -10004,7 +10058,7 @@ snapshots:
optionalDependencies:
workerd: 1.20250428.0
dependencies:
'@cloudflare/unenv-preset': 2.3.1([email protected])([email protected])
'@hattip/adapter-node': 0.0.49
@@ -10015,7 +10069,7 @@ snapshots:
tinyglobby: 0.2.13
unenv: 2.0.0-rc.15
- wrangler: 3.63.2(@cloudflare/[email protected])
+ wrangler: 3.63.2(@cloudflare/[email protected])
ws: 8.18.0
transitivePeerDependencies:
- bufferutil
@@ -10074,6 +10128,8 @@ snapshots:
'@cloudflare/[email protected]': {}
+ '@cloudflare/[email protected]': {}
+
'@codemirror/[email protected]':
dependencies:
'@codemirror/language': 6.11.0
@@ -10637,7 +10693,7 @@ snapshots:
dependencies:
'@hattip/core': 0.0.49
'@whatwg-node/fetch': 0.9.23
- node-fetch-native: 1.6.6
+ node-fetch-native: 1.6.7
'@hattip/[email protected]':
dependencies:
@@ -12057,7 +12113,7 @@ snapshots:
react: 18.3.0-canary-14898b6a9-20240318
react-dom: 18.3.0-canary-14898b6a9-20240318([email protected])
dependencies:
'@babel/core': 7.26.10
'@babel/generator': 7.27.0
@@ -12091,7 +12147,7 @@ snapshots:
optionalDependencies:
typescript: 5.8.2
- wrangler: 3.63.2(@cloudflare/[email protected])
+ wrangler: 3.63.2(@cloudflare/[email protected])
transitivePeerDependencies:
- '@types/node'
- babel-plugin-macros
@@ -12167,9 +12223,9 @@ snapshots:
optionalDependencies:
typescript: 5.8.2
dependencies:
minimatch: 9.0.4
optionalDependencies:
typescript: 5.8.2
@@ -12221,6 +12277,13 @@ snapshots:
optionalDependencies:
typescript: 5.8.2
+ dependencies:
+ '@cloudflare/workers-types': 4.20240718.0
+ '@remix-run/cloudflare': 2.16.5(@cloudflare/[email protected])([email protected])
+ optionalDependencies:
+ typescript: 5.8.2
+
dependencies:
'@cloudflare/kv-asset-handler': 0.1.3
@@ -12229,6 +12292,14 @@ snapshots:
optionalDependencies:
typescript: 5.8.2
+ dependencies:
+ '@cloudflare/kv-asset-handler': 0.1.3
+ '@cloudflare/workers-types': 4.20240718.0
+ '@remix-run/server-runtime': 2.16.5([email protected])
+ optionalDependencies:
+ typescript: 5.8.2
+
dependencies:
'@babel/core': 7.26.10
@@ -12312,6 +12383,89 @@ snapshots:
- utf-8-validate
- yaml
+ dependencies:
+ '@babel/core': 7.26.10
+ '@babel/generator': 7.27.0
+ '@babel/parser': 7.27.0
+ '@babel/plugin-syntax-decorators': 7.24.1(@babel/[email protected])
+ '@babel/plugin-syntax-jsx': 7.24.1(@babel/[email protected])
+ '@babel/preset-typescript': 7.24.1(@babel/[email protected])
+ '@babel/traverse': 7.27.0
+ '@babel/types': 7.27.0
+ '@mdx-js/mdx': 2.3.0
+ '@npmcli/package-json': 4.0.1
+ '@remix-run/node': 2.16.5([email protected])
+ '@remix-run/router': 1.23.0
+ '@remix-run/server-runtime': 2.16.5([email protected])
+ '@types/mdx': 2.0.13
+ '@vanilla-extract/integration': 6.5.0(@types/[email protected])
+ arg: 5.0.2
+ cacache: 17.1.4
+ chalk: 4.1.2
+ chokidar: 3.6.0
+ cross-spawn: 7.0.6
+ dotenv: 16.3.1
+ es-module-lexer: 1.6.0
+ esbuild: 0.17.6
+ esbuild-plugins-node-modules-polyfill: 1.6.3([email protected])
+ execa: 5.1.1
+ exit-hook: 2.2.1
+ express: 4.21.1
+ fs-extra: 10.1.0
+ get-port: 5.1.1
+ gunzip-maybe: 1.4.2
+ jsesc: 3.0.2
+ json5: 2.2.3
+ lodash: 4.17.21
+ lodash.debounce: 4.0.8
+ minimatch: 9.0.4
+ ora: 5.4.1
+ pathe: 1.1.2
+ picocolors: 1.1.1
+ picomatch: 2.3.1
+ pidtree: 0.6.0
+ postcss: 8.5.3
+ postcss-discard-duplicates: 5.1.0([email protected])
+ postcss-load-config: 4.0.1([email protected])
+ postcss-modules: 6.0.0([email protected])
+ prettier: 2.8.7
+ pretty-ms: 7.0.1
+ react-refresh: 0.14.2
+ remark-frontmatter: 4.0.1
+ remark-mdx-frontmatter: 1.1.1
+ semver: 7.7.1
+ set-cookie-parser: 2.6.0
+ tar-fs: 2.1.1
+ tsconfig-paths: 4.2.0
+ valibot: 0.41.0([email protected])
+ vite-node: 3.0.0-beta.2(@types/[email protected])([email protected])([email protected])
+ ws: 7.5.10
+ optionalDependencies:
+ '@remix-run/serve': 2.16.5([email protected])
+ typescript: 5.8.2
+ wrangler: 3.63.2(@cloudflare/[email protected])
+ transitivePeerDependencies:
+ - '@types/node'
+ - babel-plugin-macros
+ - bluebird
+ - bufferutil
+ - jiti
+ - less
+ - lightningcss
+ - sass
+ - sass-embedded
+ - stylus
+ - sugarss
+ - supports-color
+ - terser
+ - ts-node
+ - tsx
+ - utf-8-validate
+ - yaml
+
dependencies:
'@remix-run/node': 2.16.5([email protected])
@@ -12932,9 +13086,9 @@ snapshots:
'@vanilla-extract/[email protected]': {}
dependencies:
'@vercel/static-config': 3.0.0
isbot: 5.1.25
@@ -12952,9 +13106,9 @@ snapshots:
react-dom: 18.3.0-canary-14898b6a9-20240318([email protected])
ts-morph: 12.0.0
dependencies:
'@remix-run/node': 2.16.5([email protected])
'@remix-run/server-runtime': 2.16.5([email protected])
'@vercel/static-config': 3.0.0
@@ -13095,9 +13249,9 @@ snapshots:
acorn-walk: 8.3.5
optional: true
dependencies:
- acorn: 8.14.1
+ acorn: 8.16.0
@@ -13114,8 +13268,7 @@ snapshots:
- optional: true
dependencies:
@@ -13363,8 +13516,8 @@ snapshots:
dependencies:
- debug: 4.4.0
- tslib: 2.6.2
+ debug: 4.4.3
+ tslib: 2.8.1
transitivePeerDependencies:
- supports-color
@@ -13631,7 +13784,6 @@ snapshots:
dependencies:
ms: 2.1.3
- optional: true
optional: true
@@ -14040,6 +14192,8 @@ snapshots:
'@types/node': 22.13.10
require-like: 0.1.2
+
@@ -15184,8 +15338,8 @@ snapshots:
dependencies:
- acorn: 8.14.1
- acorn-jsx: 5.3.2([email protected])
+ acorn: 8.16.0
+ acorn-jsx: 5.3.2([email protected])
micromark-extension-mdx-expression: 1.0.8
micromark-extension-mdx-jsx: 1.0.5
micromark-extension-mdx-md: 1.0.1
@@ -15395,7 +15549,7 @@ snapshots:
dependencies:
'@types/debug': 4.1.12
- debug: 4.4.0
+ debug: 4.4.3
decode-named-character-reference: 1.0.2
micromark-core-commonmark: 1.1.0
micromark-factory-space: 1.1.0
@@ -15544,10 +15698,10 @@ snapshots:
dependencies:
- acorn: 8.14.1
+ acorn: 8.16.0
pathe: 2.0.3
pkg-types: 1.3.1
- ufo: 1.5.4
+ ufo: 1.6.3
@@ -15815,6 +15969,12 @@ snapshots:
+ dependencies:
+ event-target-polyfill: 0.0.4
+ optionalDependencies:
+ react: 18.3.0-canary-14898b6a9-20240318
+
@@ -16274,7 +16434,7 @@ snapshots:
transitivePeerDependencies:
- supports-color
dependencies:
'@oslojs/crypto': 0.6.2
'@oslojs/encoding': 0.4.1
@@ -16282,7 +16442,7 @@ snapshots:
debug: 4.3.7
optionalDependencies:
- '@remix-run/cloudflare': 2.16.5(@cloudflare/[email protected])([email protected])
+ '@remix-run/cloudflare': 2.16.5(@cloudflare/[email protected])([email protected])
'@remix-run/node': 2.16.5([email protected])
transitivePeerDependencies:
- supports-color
@@ -16786,8 +16946,6 @@ snapshots:
-
@@ -16931,7 +17089,7 @@ snapshots:
dependencies:
- acorn: 8.14.1
+ acorn: 8.16.0
webpack-virtual-modules: 0.6.2
@@ -17323,6 +17481,32 @@ snapshots:
- supports-color
- utf-8-validate
+ dependencies:
+ '@cloudflare/kv-asset-handler': 0.3.4
+ '@esbuild-plugins/node-globals-polyfill': 0.2.3([email protected])
+ '@esbuild-plugins/node-modules-polyfill': 0.2.2([email protected])
+ blake3-wasm: 2.1.5
+ chokidar: 3.6.0
+ date-fns: 3.6.0
+ esbuild: 0.17.19
+ miniflare: 3.20240701.0
+ nanoid: 3.3.7
+ path-to-regexp: 6.2.1
+ resolve: 1.22.8
+ resolve.exports: 2.0.2
+ selfsigned: 2.1.1
+ source-map: 0.6.1
+ xxhash-wasm: 1.0.2
+ optionalDependencies:
+ '@cloudflare/workers-types': 4.20240718.0
+ fsevents: 2.3.3
+ transitivePeerDependencies:
+ - bufferutil
+ - supports-color
+ - utf-8-validate
+
dependencies:
'@cloudflare/kv-asset-handler': 0.4.0