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.

refactor: add new way to synchronize immerhin stores (#4451)

Bogdan Chadkinbf574fbc4716
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index 09531cca14..f3c1418724 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -7,7 +7,11 @@ import type { Project } from "@webstudio-is/project";
import { theme, Box, type CSS, Flex, Grid } from "@webstudio-is/design-system";
import type { AuthPermit } from "@webstudio-is/trpc-interface/index.server";
import { createImageLoader } from "@webstudio-is/image";
-import { registerContainers, useBuilderStore } from "~/shared/sync";
+import {
+ builderClient,
+ registerContainers,
+ useBuilderStore,
+} from "~/shared/sync";
import { startProjectSync, useSyncServer } from "./shared/sync/sync-server";
import { SidebarLeft } from "./sidebar-left";
import { Inspector } from "./features/inspector";
@@ -294,6 +298,12 @@ export const Builder = ({
useSetWindowTitle();
const iframeRefCallback = mergeRefs((element: HTMLIFrameElement | null) => {
+ if (element?.contentWindow) {
+ // added to iframe window and stored in local variable right away to prevent
+ // overriding in emebedded scripts on canvas
+ element.contentWindow.__webstudioSharedSyncEmitter__ =
+ builderClient.emitter;
+ }
onRefReadCanvas(element);
}, publishRef);
diff --git a/apps/builder/app/shared/sync-client.test.ts b/apps/builder/app/shared/sync-client.test.ts
new file mode 100644
index 0000000000..b8be9ce254
--- /dev/null
+++ b/apps/builder/app/shared/sync-client.test.ts
@@ -0,0 +1,188 @@
+import { expect, test } from "vitest";
+import { createNanoEvents } from "nanoevents";
+import { atom } from "nanostores";
+import { Store } from "immerhin";
+import { enableMapSet } from "immer";
+import { SyncClient } from "./sync-client";
+
+enableMapSet();
+
+const createFollowerStore = () => {
+ const followerStore = new Store();
+ followerStore.register("users", atom(new Map()));
+ return followerStore;
+};
+
+const createLeaderStore = () => {
+ const leaderStore = new Store();
+ leaderStore.register(
+ "users",
+ atom(
+ new Map([
+ ["john", "John Johnson"],
+ ["frank", "Frank Frankson"],
+ ])
+ )
+ );
+ return leaderStore;
+};
+
+test("synchronize initial state when follower is connected", () => {
+ const emitter = createNanoEvents();
+ const leaderStore = createLeaderStore();
+ const followerStore = createFollowerStore();
+ const leader = new SyncClient({
+ role: "leader",
+ store: leaderStore,
+ emitter,
+ });
+ const follower = new SyncClient({
+ role: "follower",
+ store: followerStore,
+ emitter,
+ });
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(0);
+ expect(leaderStore.containers.get("users")?.get()).not.toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+ // first leader and follow is connected later
+ leader.connect({ signal: new AbortController().signal });
+ follower.connect({ signal: new AbortController().signal });
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(2);
+ expect(leaderStore.containers.get("users")?.get()).toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+});
+
+test("synchronize initial state when leader is connected", () => {
+ const emitter = createNanoEvents();
+ const leaderStore = createLeaderStore();
+ const followerStore = createFollowerStore();
+ const leader = new SyncClient({
+ role: "leader",
+ store: leaderStore,
+ emitter,
+ });
+ const follower = new SyncClient({
+ role: "follower",
+ store: followerStore,
+ emitter,
+ });
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(0);
+ expect(leaderStore.containers.get("users")?.get()).not.toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+ // first follower and leader is connected later
+ follower.connect({ signal: new AbortController().signal });
+ leader.connect({ signal: new AbortController().signal });
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(2);
+ expect(leaderStore.containers.get("users")?.get()).toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+});
+
+test("synchronize initial state when one of followers become leader", () => {
+ const emitter = createNanoEvents();
+ const leaderStore = createLeaderStore();
+ const followerStore = createFollowerStore();
+ const leader = new SyncClient({
+ role: "follower",
+ store: leaderStore,
+ emitter,
+ });
+ const follower = new SyncClient({
+ role: "follower",
+ store: followerStore,
+ emitter,
+ });
+ leader.connect({ signal: new AbortController().signal });
+ follower.connect({ signal: new AbortController().signal });
+ expect(leader.role).toEqual("follower");
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(0);
+ leader.lead();
+ expect(leader.role).toEqual("leader");
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(2);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(2);
+ expect(leaderStore.containers.get("users")?.get()).toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+});
+
+test("exchange transactions between leader and follower", async () => {
+ const emitter = createNanoEvents();
+ const leaderStore = createLeaderStore();
+ const followerStore = createFollowerStore();
+ const leader = new SyncClient({
+ role: "leader",
+ store: leaderStore,
+ emitter,
+ });
+ const follower = new SyncClient({
+ role: "follower",
+ store: followerStore,
+ emitter,
+ });
+ leader.connect({ signal: new AbortController().signal });
+ follower.connect({ signal: new AbortController().signal });
+ leaderStore.createTransaction(
+ [leaderStore.containers.get("users")!],
+ (users) => {
+ users.set("james", "James Jameson");
+ }
+ );
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(3);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(3);
+ followerStore.createTransaction(
+ [followerStore.containers.get("users")!],
+ (users) => {
+ users.set("mark", "Mark Grayson");
+ }
+ );
+ expect(leaderStore.containers.get("users")?.get().size).toEqual(4);
+ expect(followerStore.containers.get("users")?.get().size).toEqual(4);
+ expect(leaderStore.containers.get("users")?.get()).toEqual(
+ followerStore.containers.get("users")?.get()
+ );
+});
+
+test("exchange transactions between followers", async () => {
+ const emitter = createNanoEvents();
+ const follower1Store = createFollowerStore();
+ const follower2Store = createFollowerStore();
+ const follower1 = new SyncClient({
+ role: "follower",
+ store: follower1Store,
+ emitter,
+ });
+ const follower2 = new SyncClient({
+ role: "follower",
+ store: follower2Store,
+ emitter,
+ });
+ follower1.connect({ signal: new AbortController().signal });
+ follower2.connect({ signal: new AbortController().signal });
+ follower1Store.createTransaction(
+ [follower1Store.containers.get("users")!],
+ (users) => {
+ users.set("james", "James Jameson");
+ }
+ );
+ expect(follower1Store.containers.get("users")?.get().size).toEqual(1);
+ expect(follower2Store.containers.get("users")?.get().size).toEqual(1);
+ follower2Store.createTransaction(
+ [follower2Store.containers.get("users")!],
+ (users) => {
+ users.set("mark", "Mark Grayson");
+ }
+ );
+ expect(follower1Store.containers.get("users")?.get().size).toEqual(2);
+ expect(follower2Store.containers.get("users")?.get().size).toEqual(2);
+ expect(follower1Store.containers.get("users")?.get()).toEqual(
+ follower2Store.containers.get("users")?.get()
+ );
+});
diff --git a/apps/builder/app/shared/sync-client.ts b/apps/builder/app/shared/sync-client.ts
new file mode 100644
index 0000000000..a468d1a5c7
--- /dev/null
+++ b/apps/builder/app/shared/sync-client.ts
@@ -0,0 +1,127 @@
+import { nanoid } from "nanoid";
+import { createNanoEvents, type Emitter } from "nanoevents";
+import type { Change, Store } from "immerhin";
+
+type Transaction = {
+ id: string;
+ changes: Change[];
+};
+
+type SyncMessage =
+ | { type: "connect"; clientId: string }
+ | { type: "state"; clientId: string; state: Map<string, unknown> }
+ | { type: "commit"; clientId: string; transaction: Transaction }
+ | { type: "revert"; clientId: string; transactionId: string };
+
+export type SyncEmitter = Emitter<{
+ message: (message: SyncMessage) => void;
+}>;
+
+type SyncClientOptions = {
+ role: "leader" | "follower";
+ store: Store;
+ emitter?: SyncEmitter;
+};
+
+export class SyncClient {
+ clientId = nanoid();
+ role: SyncClientOptions["role"];
+ store: Store;
+ emitter: SyncEmitter;
+ connection: "disconnected" | "connecting" | "connected" = "disconnected";
+
+ constructor(options: SyncClientOptions) {
+ this.role = options.role;
+ this.store = options.store;
+ this.emitter = options.emitter ?? createNanoEvents();
+ }
+
+ broadcastState() {
+ const state = new Map<string, unknown>();
+ for (const [namespace, $store] of this.store.containers) {
+ state.set(namespace, $store.get());
+ }
+ this.emitter.emit("message", {
+ clientId: this.clientId,
+ type: "state",
+ state,
+ });
+ }
+
+ lead() {
+ this.role = "leader";
+ this.broadcastState();
+ }
+
+ connect({ signal }: { signal: AbortSignal }) {
+ const off = this.emitter.on("message", (message) => {
+ // ignore own messages
+ if (this.clientId === message.clientId) {
+ return;
+ }
+ if (message.type === "connect") {
+ if (this.role !== "leader") {
+ return;
+ }
+ this.broadcastState();
+ }
+ if (message.type === "state") {
+ if (this.connection === "connected") {
+ return;
+ }
+ this.connection = "connected";
+ for (const [namespace, $store] of this.store.containers) {
+ // immer is not able to work with Map instances from another realm
+ // use clone to recreate data with current realm classes
+ $store.set(structuredClone(message.state.get(namespace)));
+ }
+ }
+ if (message.type === "commit") {
+ /*
+ // 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.store.addTransaction(
+ message.transaction.id,
+ message.transaction.changes,
+ "remote"
+ );
+ }
+ if (message.type === "revert") {
+ this.store.revertTransaction(message.transactionId);
+ }
+ });
+
+ const unsubscribe = this.store.subscribe((id, changes, source) => {
+ if (source === "remote") {
+ return;
+ }
+ const transaction: Transaction = { id, changes };
+ this.emitter.emit("message", {
+ clientId: this.clientId,
+ type: "commit",
+ transaction,
+ });
+ });
+
+ signal.addEventListener("abort", () => {
+ off();
+ unsubscribe();
+ });
+
+ this.emitter.emit("message", {
+ clientId: this.clientId,
+ type: "connect",
+ });
+ if (this.connection === "disconnected") {
+ this.connection = "connecting";
+ }
+ if (this.role === "leader") {
+ this.broadcastState();
+ }
+ }
+}
diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.ts
index f769fa78d1..63ad0d4fd1 100644
--- a/apps/builder/app/shared/sync/sync-stores.ts
+++ b/apps/builder/app/shared/sync/sync-stores.ts
@@ -44,6 +44,7 @@ import {
} from "~/shared/nano-states";
import { $ephemeralStyles } from "~/canvas/stores";
import { $awareness } from "../awareness";
+import { SyncClient, type SyncEmitter } from "../sync-client";
enableMapSet();
// safari structuredClone fix
@@ -70,7 +71,7 @@ declare module "~/shared/pubsub" {
sendStoreChanges: {
// distinct source to avoid infinite loop
source: SyncEventSource;
- namespace: "client" | "server";
+ namespace: "client";
changes: Change[];
};
}
@@ -164,33 +165,12 @@ const syncStoresChanges = (name: SyncEventSource, publish: Publish) => {
if (source === name) {
return;
}
- if (namespace === "server") {
- serverSyncStore.createTransactionFromChanges(changes, "remote");
- }
if (namespace === "client") {
clientSyncStore.createTransactionFromChanges(changes, "remote");
}
}
);
- const unsubscribeStoreChanges = serverSyncStore.subscribe(
- (_transactionId, changes, source) => {
- // prevent sending remote patches back
- if (source === "remote") {
- return;
- }
-
- publish({
- type: "sendStoreChanges",
- payload: {
- source: name,
- namespace: "server",
- changes,
- },
- });
- }
- );
-
const unsubscribeClientImmerhinStoreChanges = clientSyncStore.subscribe(
(_transactionId, changes, source) => {
// prevent sending remote patches back
@@ -211,7 +191,6 @@ const syncStoresChanges = (name: SyncEventSource, publish: Publish) => {
return () => {
unsubscribeRemoteChanges();
- unsubscribeStoreChanges();
unsubscribeClientImmerhinStoreChanges();
};
};
@@ -228,10 +207,6 @@ const syncStoresState = (name: SyncEventSource, publish: Publish) => {
}
for (const { namespace, value } of data) {
// apply immerhin stores data
- const container = serverSyncStore.containers.get(namespace);
- if (container) {
- container.set(value);
- }
const clientContainer = clientSyncStore.containers.get(namespace);
if (clientContainer) {
clientContainer.set(value);
@@ -285,8 +260,31 @@ const syncStoresState = (name: SyncEventSource, publish: Publish) => {
};
};
+declare global {
+ interface Window {
+ __webstudioSharedSyncEmitter__: SyncEmitter | undefined;
+ }
+}
+
+/**
+ * prevent syncEmitter interception from embedded scripts on canvas
+ * i.e., `globalThis.syncEmitter = () => console.log('INTERCEPTED');`,
+ */
+const sharedSyncEmitter =
+ typeof window === "undefined"
+ ? undefined
+ : window.__webstudioSharedSyncEmitter__;
+
export const useCanvasStore = (publish: Publish) => {
useEffect(() => {
+ const canvasClient = new SyncClient({
+ role: "follower",
+ store: serverSyncStore,
+ emitter: sharedSyncEmitter,
+ });
+
+ const controller = new AbortController();
+ canvasClient.connect({ signal: controller.signal });
// connect to builder to get latest changes
publish({
type: "connect",
@@ -324,14 +322,23 @@ export const useCanvasStore = (publish: Publish) => {
});
unsubscribeStoresState();
unsubscribeStoresChanges();
+ controller.abort();
};
}, [publish]);
};
+export const builderClient = new SyncClient({
+ role: "leader",
+ store: serverSyncStore,
+});
+
export const useBuilderStore = (publish: Publish) => {
useEffect(() => {
+ const controller = new AbortController();
+ builderClient.connect({ signal: controller.signal });
let unsubscribeStoresState: undefined | (() => void);
let unsubscribeStoresChanges: undefined | (() => void);
+
const unsubscribeConnect = subscribe("connect", () => {
// subscribe stores after connection so canvas is ready to receive
// changes from immerhin queue
@@ -341,12 +348,6 @@ export const useBuilderStore = (publish: Publish) => {
// immerhin data is sent only initially so not part of syncStoresState
// expect data to be populated by the time effect is called
const data = [];
- for (const [namespace, container] of serverSyncStore.containers) {
- data.push({
- namespace,
- value: container.get(),
- });
- }
for (const [namespace, store] of clientStores) {
if (initializedStores.has(namespace)) {
data.push({
@@ -376,6 +377,7 @@ export const useBuilderStore = (publish: Publish) => {
unsubscribeDisconnect();
unsubscribeStoresState?.();
unsubscribeStoresChanges?.();
+ controller.abort();
};
}, [publish]);
};
diff --git a/apps/builder/package.json b/apps/builder/package.json
index 33bec95a72..cfbe4564c4 100644
--- a/apps/builder/package.json
+++ b/apps/builder/package.json
@@ -86,15 +86,15 @@
"detect-font": "^0.1.5",
"downshift": "^6.1.7",
"fast-deep-equal": "^3.1.3",
- "immer": "^10.0.3",
- "immerhin": "^0.9.0",
+ "immer": "^10.1.1",
+ "immerhin": "^0.10.0",
"isbot": "^5.1.17",
"lexical": "^0.16.0",
"match-sorter": "^8.0.0",
"mdast-util-from-markdown": "^2.0.1",
"mdast-util-gfm": "^3.0.0",
"micromark-extension-gfm": "^3.0.0",
- "nanoevents": "^8.0.0",
+ "nanoevents": "^9.1.0",
"nanoid": "^5.0.8",
"nanostores": "^0.9.3",
"picocolors": "^1.1.0",
diff --git a/apps/builder/vite.config.ts b/apps/builder/vite.config.ts
index 86de316e57..546710fb48 100644
--- a/apps/builder/vite.config.ts
+++ b/apps/builder/vite.config.ts
@@ -12,6 +12,20 @@ import {
import { readFileSync } from "node:fs";
export default defineConfig(({ mode }) => {
+ if (mode === "test") {
+ return {
+ resolve: {
+ conditions: ["webstudio"],
+ alias: [
+ {
+ find: "~",
+ replacement: resolve("app"),
+ },
+ ],
+ },
+ };
+ }
+
if (mode === "development") {
// Enable self-signed certificates for development service 2 service fetch calls.
// This is particularly important for secure communication with the oauth.ws.token endpoint.
diff --git a/packages/asset-uploader/package.json b/packages/asset-uploader/package.json
index bc8bb74e55..76edfee340 100644
--- a/packages/asset-uploader/package.json
+++ b/packages/asset-uploader/package.json
@@ -17,7 +17,7 @@
"@webstudio-is/trpc-interface": "workspace:*",
"fontkit": "^2.0.2",
"image-size": "^1.1.1",
- "immer": "^10.0.3",
+ "immer": "^10.1.1",
"nanoid": "^5.0.8",
"warn-once": "^0.1.1"
},
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 2a53788724..303ddeee88 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -326,11 +326,11 @@ importers:
specifier: ^3.1.3
version: 3.1.3
immer:
- specifier: ^10.0.3
- version: 10.0.3
+ specifier: ^10.1.1
+ version: 10.1.1
immerhin:
- specifier: ^0.9.0
- version: 0.9.0
+ specifier: ^0.10.0
+ version: 0.10.0
isbot:
specifier: ^5.1.17
version: 5.1.17
@@ -350,8 +350,8 @@ importers:
specifier: ^3.0.0
version: 3.0.0
nanoevents:
- specifier: ^8.0.0
- version: 8.0.0
+ specifier: ^9.1.0
+ version: 9.1.0
nanoid:
specifier: ^5.0.8
version: 5.0.8
@@ -971,8 +971,8 @@ importers:
specifier: ^1.1.1
version: 1.1.1
immer:
- specifier: ^10.0.3
- version: 10.0.3
+ specifier: ^10.1.1
+ version: 10.1.1
nanoid:
specifier: ^5.0.8
version: 5.0.8
@@ -6254,11 +6254,11 @@ packages:
engines: {node: '>=16.x'}
hasBin: true
- resolution: {integrity: sha512-pwupu3eWfouuaowscykeckFmVTpqbzW+rXFCX8rQLkZzM9ftBmU/++Ra+o+L27mz03zJTlyV4UUr+fdKNffo4A==}
+ resolution: {integrity: sha512-s2MPrmjovJcoMaHtx6K11Ra7oD05NT97w1IC5zpMkT6Atjr7H8LjaDd81iIxUYpMKSRRNMJE703M1Fhr/TctHw==}
- resolution: {integrity: sha512-J+SCbceSlOLTWaEmVt0ei6ZCDHmuFtt7It1/mt1Juw8Ll0lQg0N/mnswaqUlB67DeN4JICyU0JKnNQgBC2+61Q==}
+ resolution: {integrity: sha512-Dszopjt/dug4wXHayOvzSrBGbv47DCiwFBB7i2UxwZxg0POAjCjuxUW9hThTNbSOv97PR7RyGfql0RuavIk1Og==}
resolution: {integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==}
@@ -7075,9 +7075,9 @@ packages:
engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0}
hasBin: true
- resolution: {integrity: sha512-bYYwNCdNc5ea6/Lwh1uioU1/7aaKa3EPmNQ2weTm8PWSpbWrsaWHePe0Zq4SF+D3F3JX3cn+QdktOPCf1meOqw==}
- engines: {node: ^16.0.0 || ^18.0.0 || >=20.0.0}
+ resolution: {integrity: sha512-Jd0fILWG44a9luj8v5kED4WI+zfkkgwKyRQKItTtlPfEsh7Lznfi1kr8/iZ+XAIss4Qq5GqRB0qtWbaz9ceO/A==}
+ engines: {node: ^18.0.0 || >=20.0.0}
resolution: {integrity: sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==}
@@ -13313,11 +13313,11 @@ snapshots:
dependencies:
queue: 6.0.2
dependencies:
- immer: 10.0.3
+ immer: 10.1.1
nanoid: 5.0.8
@@ -14458,7 +14458,7 @@ snapshots:
dependencies:
picocolors: 1.0.0