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.

Synchronize non-immerhin stores (#843)

Bogdan Chadkin83f03e225404
diff --git a/apps/designer/app/canvas/canvas.tsx b/apps/designer/app/canvas/canvas.tsx
index c16215702d..050b52accb 100644
--- a/apps/designer/app/canvas/canvas.tsx
+++ b/apps/designer/app/canvas/canvas.tsx
@@ -36,7 +36,6 @@ import {
useSetRootInstance,
useSetStyles,
useSubscribeScrollState,
- useSubscribeSelectedInstance,
} from "~/shared/nano-states";
import { usePublishScrollState } from "./shared/use-publish-scroll-state";
import { useDragAndDrop } from "./shared/use-drag-drop";
@@ -127,7 +126,6 @@ const useCopyPaste = () => {
const DesignMode = () => {
useManageDesignModeStyles();
usePublishSelectedInstanceData();
- useSubscribeSelectedInstance();
useInsertInstance();
useReparentInstance();
useDeleteInstance();
diff --git a/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx b/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
index d09b11d072..241c8957a8 100644
--- a/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
+++ b/apps/designer/app/canvas/features/wrapper-component/wrapper-component.tsx
@@ -18,7 +18,6 @@ import {
useTextEditingInstanceId,
} from "~/shared/nano-states";
import { useCssRules } from "~/canvas/shared/styles";
-import { publish } from "~/shared/pubsub";
import { SelectedInstanceConnector } from "./selected-instance-connector";
const TextEditor = lazy(() => import("../text-editor"));
@@ -155,10 +154,7 @@ export const WrapperComponentDev = ({
}}
onSelectInstance={(instanceId) => {
setTextEditingInstanceId(undefined);
- publish({
- type: "selectInstanceById",
- payload: instanceId,
- });
+ selectedInstanceIdStore.set(instanceId);
}}
/>
</Suspense>
diff --git a/apps/designer/app/designer/designer.tsx b/apps/designer/app/designer/designer.tsx
index c3aafc122a..3f93a5e695 100644
--- a/apps/designer/app/designer/designer.tsx
+++ b/apps/designer/app/designer/designer.tsx
@@ -37,7 +37,6 @@ import {
useDragAndDropState,
useIsPreviewMode,
useRootInstance,
- useSubscribeSelectedInstance,
} from "~/shared/nano-states";
import { useClientSettings } from "./shared/client-settings";
import { Navigator } from "./features/sidebar-left";
@@ -312,7 +311,6 @@ export const Designer = ({
const [dragAndDropState] = useDragAndDropState();
useSubscribeCanvasReady(publish);
useCopyPaste(publish);
- useSubscribeSelectedInstance();
const iframeRefCallback = useCallback(
(ref) => {
@@ -383,7 +381,7 @@ export const Designer = ({
<Inspector publish={publish} />
)}
</SidePanel>
- <Footer publish={publish} />
+ <Footer />
</ChromeWrapper>
</AssetsProvider>
);
diff --git a/apps/designer/app/designer/features/footer/breadcrumbs.tsx b/apps/designer/app/designer/features/footer/breadcrumbs.tsx
index 4b007c4cad..b26ffd0380 100644
--- a/apps/designer/app/designer/features/footer/breadcrumbs.tsx
+++ b/apps/designer/app/designer/features/footer/breadcrumbs.tsx
@@ -1,9 +1,9 @@
import { ChevronRightIcon } from "@webstudio-is/icons";
import { DeprecatedButton, Flex, Text } from "@webstudio-is/design-system";
-import { type Publish } from "~/shared/pubsub";
import { useSelectedInstancePath } from "~/designer/shared/instance/use-selected-instance-path";
import { useSelectedInstanceData } from "~/designer/shared/nano-states";
import { theme } from "@webstudio-is/design-system";
+import { selectedInstanceIdStore } from "~/shared/nano-states";
type BreadcrumbProps = {
children: JSX.Element | string;
@@ -30,10 +30,7 @@ const Breadcrumb = ({ children, onClick }: BreadcrumbProps) => {
);
};
-type BreadcrumbsProps = {
- publish: Publish;
-};
-export const Breadcrumbs = ({ publish }: BreadcrumbsProps) => {
+export const Breadcrumbs = () => {
const [selectedInstanceData] = useSelectedInstanceData();
const selectedInstancePath = useSelectedInstancePath(
selectedInstanceData?.id
@@ -49,10 +46,7 @@ export const Breadcrumbs = ({ publish }: BreadcrumbsProps) => {
<Breadcrumb
key={instance.id}
onClick={() => {
- publish({
- type: "selectInstanceById",
- payload: instance.id,
- });
+ selectedInstanceIdStore.set(instance.id);
}}
>
{instance.component}
diff --git a/apps/designer/app/designer/features/footer/footer.tsx b/apps/designer/app/designer/features/footer/footer.tsx
index c84353287b..1e55e13af9 100644
--- a/apps/designer/app/designer/features/footer/footer.tsx
+++ b/apps/designer/app/designer/features/footer/footer.tsx
@@ -1,9 +1,8 @@
import { Box, Flex, darkTheme } from "@webstudio-is/design-system";
-import { type Publish } from "~/shared/pubsub";
import { Breadcrumbs } from "./breadcrumbs";
import { theme } from "@webstudio-is/design-system";
-export const Footer = ({ publish }: { publish: Publish }) => {
+export const Footer = () => {
return (
<Flex
className={darkTheme}
@@ -17,7 +16,7 @@ export const Footer = ({ publish }: { publish: Publish }) => {
}}
>
<Box css={{ height: "100%", p: theme.spacing[3] }}>
- <Breadcrumbs publish={publish} />
+ <Breadcrumbs />
</Box>
</Flex>
);
diff --git a/apps/designer/app/designer/features/sidebar-left/lib/navigator/navigator.tsx b/apps/designer/app/designer/features/sidebar-left/lib/navigator/navigator.tsx
index 1da8deea10..e7f7e6c23e 100644
--- a/apps/designer/app/designer/features/sidebar-left/lib/navigator/navigator.tsx
+++ b/apps/designer/app/designer/features/sidebar-left/lib/navigator/navigator.tsx
@@ -3,13 +3,12 @@ import { type Instance } from "@webstudio-is/react-sdk";
import { type Publish } from "~/shared/pubsub";
import { useCallback } from "react";
import { useSelectedInstanceData } from "~/designer/shared/nano-states";
-import { useRootInstance } from "~/shared/nano-states";
+import { selectedInstanceIdStore, useRootInstance } from "~/shared/nano-states";
import { Header, CloseButton } from "../header";
import { InstanceTree } from "~/designer/shared/tree";
declare module "~/shared/pubsub" {
export interface PubsubMap {
- selectInstanceById: Instance["id"];
reparentInstance: {
instanceId: Instance["id"];
dropTarget: { instanceId: Instance["id"]; position: number | "end" };
@@ -29,15 +28,9 @@ export const Navigator = ({ publish, isClosable, onClose }: NavigatorProps) => {
const [selectedInstanceData] = useSelectedInstanceData();
const [rootInstance] = useRootInstance();
- const handleSelect = useCallback(
- (instanceId: Instance["id"]) => {
- publish({
- type: "selectInstanceById",
- payload: instanceId,
- });
- },
- [publish]
- );
+ const handleSelect = useCallback((instanceId: Instance["id"]) => {
+ selectedInstanceIdStore.set(instanceId);
+ }, []);
const handleDragEnd = useCallback(
(payload: {
diff --git a/apps/designer/app/shared/nano-states/nano-states.ts b/apps/designer/app/shared/nano-states/nano-states.ts
index 2acc448f4a..5090af8ce1 100644
--- a/apps/designer/app/shared/nano-states/nano-states.ts
+++ b/apps/designer/app/shared/nano-states/nano-states.ts
@@ -1,4 +1,3 @@
-import { useEffect } from "react";
import { atom, computed, type WritableAtom } from "nanostores";
import { useStore } from "@nanostores/react";
import { Instance, PresetStyles, Styles } from "@webstudio-is/react-sdk";
@@ -8,7 +7,6 @@ import type {
} from "~/canvas/shared/use-drag-drop";
import type { Breakpoint } from "@webstudio-is/css-data";
import type { DesignToken } from "@webstudio-is/design-tokens";
-import { subscribe } from "~/shared/pubsub";
import { useSyncInitializeOnce } from "../hook-utils";
const useValue = <T>(atom: WritableAtom<T>) => {
@@ -113,13 +111,6 @@ export const selectedInstanceStore = computed(
return instancesIndex.instancesById.get(selectedInstanceId);
}
);
-export const useSubscribeSelectedInstance = () => {
- useEffect(() => {
- return subscribe("selectInstanceById", (id) => {
- selectedInstanceIdStore.set(id);
- });
- }, []);
-};
const isPreviewModeContainer = atom<boolean>(false);
export const useIsPreviewMode = () => useValue(isPreviewModeContainer);
diff --git a/apps/designer/app/shared/sync/sync-stores.ts b/apps/designer/app/shared/sync/sync-stores.ts
index 333aa45b58..56536fde13 100644
--- a/apps/designer/app/shared/sync/sync-stores.ts
+++ b/apps/designer/app/shared/sync/sync-stores.ts
@@ -1,4 +1,5 @@
import store, { type Change } from "immerhin";
+import type { WritableAtom } from "nanostores";
import { useEffect } from "react";
import { allUserPropsContainer } from "@webstudio-is/react-sdk";
import { type Publish, subscribe } from "~/shared/pubsub";
@@ -7,6 +8,7 @@ import {
breakpointsContainer,
designTokensContainer,
stylesContainer,
+ selectedInstanceIdStore,
} from "~/shared/nano-states";
type StoreData = {
@@ -18,7 +20,11 @@ type SyncEventSource = "canvas" | "designer";
declare module "~/shared/pubsub" {
export interface PubsubMap {
- sendStoreData: StoreData[];
+ sendStoreData: {
+ // distinct source to avoid infinite loop
+ source: SyncEventSource;
+ data: StoreData[];
+ };
sendStoreChanges: {
// distinct source to avoid infinite loop
source: SyncEventSource;
@@ -27,15 +33,20 @@ declare module "~/shared/pubsub" {
}
}
+const clientStores = new Map<string, WritableAtom<unknown>>();
+
export const registerContainers = () => {
+ // synchronize patches
store.register("breakpoints", breakpointsContainer);
store.register("root", rootInstanceContainer);
store.register("styles", stylesContainer);
store.register("props", allUserPropsContainer);
store.register("designTokens", designTokensContainer);
+ // synchronize whole states
+ clientStores.set("selectedInstanceId", selectedInstanceIdStore);
};
-const syncChanges = (name: SyncEventSource, publish: Publish) => {
+const syncStoresChanges = (name: SyncEventSource, publish: Publish) => {
const unsubscribeRemoteChanges = subscribe(
"sendStoreChanges",
({ source, changes }) => {
@@ -69,8 +80,74 @@ const syncChanges = (name: SyncEventSource, publish: Publish) => {
};
};
+const syncStoresState = (name: SyncEventSource, publish: Publish) => {
+ const latestData = new Map<string, unknown>();
+
+ const unsubscribeRemoteChanges = subscribe(
+ "sendStoreData",
+ ({ source, data }) => {
+ /// prevent reapplying own changes
+ if (source === name) {
+ return;
+ }
+ for (const { namespace, value } of data) {
+ // apply immerhin stores data
+ const container = store.containers.get(namespace);
+ if (container) {
+ container.set(value);
+ }
+ // apply state stores data
+ const stateStore = clientStores.get(namespace);
+ if (stateStore) {
+ // should be called before store set
+ // to be accessible in listen callback
+ latestData.set(namespace, value);
+ stateStore.set(value);
+ }
+ }
+ }
+ );
+
+ const unsubscribes: Array<() => void> = [];
+ for (const [namespace, store] of clientStores) {
+ unsubscribes.push(
+ // use listen to not invoke initially
+ store.listen((value) => {
+ // nanostores cannot identify the source of change
+ // so we check the latest value applied to the store
+ // and do nothing if was set by synchronization logic
+ if (latestData.has(namespace) && latestData.get(namespace) === value) {
+ return;
+ }
+ latestData.set(namespace, value);
+ publish({
+ type: "sendStoreData",
+ payload: {
+ source: name,
+ data: [
+ {
+ namespace,
+ value,
+ },
+ ],
+ },
+ });
+ //
+ })
+ );
+ }
+
+ return () => {
+ unsubscribeRemoteChanges();
+ for (const unsubscribe of unsubscribes) {
+ unsubscribe();
+ }
+ };
+};
+
export const useCanvasStore = (publish: Publish) => {
useEffect(() => {
+ // 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 store.containers) {
@@ -81,31 +158,30 @@ export const useCanvasStore = (publish: Publish) => {
}
publish({
type: "sendStoreData",
- payload: data,
+ payload: {
+ source: "canvas",
+ data,
+ },
});
- const unsubscribeChanges = syncChanges("canvas", publish);
+ const unsubscribeStoresState = syncStoresState("canvas", publish);
+ const unsubscribeStoresChanges = syncStoresChanges("canvas", publish);
- return unsubscribeChanges;
+ return () => {
+ unsubscribeStoresState();
+ unsubscribeStoresChanges();
+ };
}, [publish]);
};
export const useDesignerStore = (publish: Publish) => {
useEffect(() => {
- const unsubscribeSendStoreData = subscribe("sendStoreData", (data) => {
- for (const { namespace, value } of data) {
- const container = store.containers.get(namespace);
- if (container) {
- container.set(value);
- }
- }
- });
-
- const unsubscribeChanges = syncChanges("designer", publish);
+ const unsubscribeStoresState = syncStoresState("designer", publish);
+ const unsubscribeStoresChanges = syncStoresChanges("designer", publish);
return () => {
- unsubscribeSendStoreData();
- unsubscribeChanges();
+ unsubscribeStoresState();
+ unsubscribeStoresChanges();
};
}, [publish]);
};