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.

fix: Preserve instance deep links on Builder reload (#5977)

Oleg Isonenaefe532a7381
diff --git a/apps/builder/app/builder/builder.tsx b/apps/builder/app/builder/builder.tsx
index e9d808f580..6ba4b93011 100644
--- a/apps/builder/app/builder/builder.tsx
+++ b/apps/builder/app/builder/builder.tsx
@@ -326,7 +326,8 @@ export const Builder = (props: BuilderProps) => {
$pages.set(undefined);
});
- useSyncPageUrl();
+ const dataLoadingState = useStore($dataLoadingState);
+ useSyncPageUrl({ isDataLoaded: dataLoadingState === "loaded" });
const [publish, publishRef] = usePublish();
useEffect(() => {
@@ -361,7 +362,6 @@ export const Builder = (props: BuilderProps) => {
);
const { navigatorLayout } = useStore($settings);
- const dataLoadingState = useStore($dataLoadingState);
const [loadingState, setLoadingState] = useState(() => $loadingState.get());
useEffect(() => {
diff --git a/apps/builder/app/builder/features/publish/publish.tsx b/apps/builder/app/builder/features/publish/publish.tsx
index 120ad86e77..97508b4685 100644
--- a/apps/builder/app/builder/features/publish/publish.tsx
+++ b/apps/builder/app/builder/features/publish/publish.tsx
@@ -133,7 +133,7 @@ const PrePublishAuditMessage = ({
const href = builderUrl({
projectId: project.id,
pageId: pageId === pages.homePageId ? undefined : pageId,
- instanceId,
+ instanceSelector,
origin: window.location.origin,
authToken: $authToken.get(),
mode: $builderMode.get(),
diff --git a/apps/builder/app/routes/_ui.(builder).tsx b/apps/builder/app/routes/_ui.(builder).tsx
index ba87a9be12..0543cdd298 100644
--- a/apps/builder/app/routes/_ui.(builder).tsx
+++ b/apps/builder/app/routes/_ui.(builder).tsx
@@ -88,7 +88,7 @@ export const loader = async (loaderArgs: LoaderFunctionArgs) => {
}
if (context.authorization.type === "anonymous") {
- throw await authWsLoader(loaderArgs); // redirect("/auth/ws");
+ throw await authWsLoader(loaderArgs);
}
if (
@@ -106,7 +106,7 @@ export const loader = async (loaderArgs: LoaderFunctionArgs) => {
Date.now() - context.authorization.sessionCreatedAt >
RELOAD_ON_NAVIGATE_TIMEOUT
) {
- throw await authWsLoader(loaderArgs); // start immediately instead of redirect("/auth/ws");
+ throw await authWsLoader(loaderArgs);
}
}
@@ -276,7 +276,7 @@ export const loader = async (loaderArgs: LoaderFunctionArgs) => {
} catch (error) {
if (error instanceof AuthorizationError) {
// try to re-login user if he has no access to the project
- throw redirect(`/auth/ws`);
+ throw await authWsLoader(loaderArgs);
}
throw error;
diff --git a/apps/builder/app/routes/auth.ws.ts b/apps/builder/app/routes/auth.ws.ts
index c7e240c032..bdce767b9c 100644
--- a/apps/builder/app/routes/auth.ws.ts
+++ b/apps/builder/app/routes/auth.ws.ts
@@ -35,10 +35,13 @@ export const loader: LoaderFunction = async ({ request }) => {
const response = new Response(noStoreResponse.body, noStoreResponse);
const url = new URL(request.url);
- let returnTo = url.searchParams.get("returnTo");
+ const isAuthRoute = url.pathname === "/auth/ws";
+ let returnTo = isAuthRoute
+ ? url.searchParams.get("returnTo")
+ : `${url.pathname}${url.search}`;
if (returnTo !== null) {
- if (comparePathnames(returnTo, request.url)) {
+ if (isAuthRoute && comparePathnames(returnTo, request.url)) {
// avoid loops
returnTo = "/";
}
diff --git a/apps/builder/app/shared/pages/use-switch-page.test.tsx b/apps/builder/app/shared/pages/use-switch-page.test.tsx
index 251dacc1e1..17559625b9 100644
--- a/apps/builder/app/shared/pages/use-switch-page.test.tsx
+++ b/apps/builder/app/shared/pages/use-switch-page.test.tsx
@@ -3,7 +3,39 @@ import { createDefaultPages } from "@webstudio-is/project-build";
import { $, renderData } from "@webstudio-is/template";
import { __testing__ } from "./use-switch-page";
-const { getDeepLinkedInstanceSelection } = __testing__;
+const { getDeepLinkedInstanceSelection, shouldNavigateToPageState } =
+ __testing__;
+
+test("preserves an instance deep link until URL state is initialized", () => {
+ expect(
+ shouldNavigateToPageState({
+ isUrlStateInitialized: false,
+ isSamePageState: true,
+ searchParamsInstanceSelector: ["heading", "box", "body"],
+ instanceSelector: undefined,
+ })
+ ).toBe(false);
+
+ expect(
+ shouldNavigateToPageState({
+ isUrlStateInitialized: true,
+ isSamePageState: true,
+ searchParamsInstanceSelector: ["heading", "box", "body"],
+ instanceSelector: undefined,
+ })
+ ).toBe(true);
+});
+
+test("updates the URL when a shared instance moves to another slot path", () => {
+ expect(
+ shouldNavigateToPageState({
+ isUrlStateInitialized: true,
+ isSamePageState: true,
+ searchParamsInstanceSelector: ["box", "fragment", "slot-two", "body"],
+ instanceSelector: ["box", "fragment", "slot-one", "body"],
+ })
+ ).toBe(true);
+});
test("resolves a deep-linked instance to its page and full selector", () => {
const pages = createDefaultPages({
@@ -19,7 +51,7 @@ test("resolves a deep-linked instance to its page and full selector", () => {
);
expect(
getDeepLinkedInstanceSelection({
- instanceId: "heading",
+ instanceSelector: ["heading", "box", "body"],
canOpenPageTemplates: true,
pages,
instances,
@@ -30,6 +62,39 @@ test("resolves a deep-linked instance to its page and full selector", () => {
});
});
+test("restores the selected shared slot occurrence from its full selector", () => {
+ const pages = createDefaultPages({
+ homePageId: "home-page",
+ rootInstanceId: "body",
+ });
+ const { instances } = renderData(
+ <$.Body ws:id="body">
+ <$.Slot ws:id="slot-one">
+ <$.Fragment ws:id="fragment">
+ <$.Box ws:id="box"></$.Box>
+ </$.Fragment>
+ </$.Slot>
+ <$.Slot ws:id="slot-two">
+ <$.Fragment ws:id="fragment">
+ <$.Box ws:id="box"></$.Box>
+ </$.Fragment>
+ </$.Slot>
+ </$.Body>
+ );
+
+ expect(
+ getDeepLinkedInstanceSelection({
+ instanceSelector: ["box", "fragment", "slot-one", "body"],
+ canOpenPageTemplates: true,
+ pages,
+ instances,
+ })
+ ).toEqual({
+ pageId: "home-page",
+ instanceSelector: ["box", "fragment", "slot-one", "body"],
+ });
+});
+
test("ignores missing deep-linked instances", () => {
const pages = createDefaultPages({
homePageId: "home-page",
@@ -39,7 +104,7 @@ test("ignores missing deep-linked instances", () => {
expect(
getDeepLinkedInstanceSelection({
- instanceId: "missing",
+ instanceSelector: ["missing", "body"],
canOpenPageTemplates: true,
pages,
instances,
diff --git a/apps/builder/app/shared/pages/use-switch-page.ts b/apps/builder/app/shared/pages/use-switch-page.ts
index ab16f89bee..034826122f 100644
--- a/apps/builder/app/shared/pages/use-switch-page.ts
+++ b/apps/builder/app/shared/pages/use-switch-page.ts
@@ -1,4 +1,4 @@
-import { useEffect } from "react";
+import { useEffect, useState } from "react";
import { useStore } from "@nanostores/react";
import { useNavigate } from "@remix-run/react";
import { $instances, $pages, $project } from "~/shared/sync/data-stores";
@@ -18,48 +18,87 @@ import { $selectedPage } from "../nano-states";
import { selectPage } from "../nano-states";
import {
findPageByIdOrPath,
+ getAllPages,
isPageTemplate,
type Instances,
type Pages,
} from "@webstudio-is/sdk";
-import { findPageAndSelectorByInstanceId } from "@webstudio-is/project-build/runtime";
+import {
+ areInstanceSelectorsEqual,
+ type InstanceSelector,
+} from "@webstudio-is/project-build/runtime";
+import { canResolveInstanceSelector } from "../instance-utils/selection";
const getDeepLinkedInstanceSelection = ({
- instanceId,
+ instanceSelector,
canOpenPageTemplates,
pages,
instances,
}: {
- instanceId: string | null;
+ instanceSelector: InstanceSelector | undefined;
canOpenPageTemplates: boolean;
pages: Pages;
instances: Instances;
}) => {
- if (instanceId === null || instances.has(instanceId) === false) {
+ if (instanceSelector === undefined) {
return;
}
- const selection = findPageAndSelectorByInstanceId(
- pages,
- instances,
- instanceId
+ const instanceId = instanceSelector[0];
+ if (
+ instanceId === undefined ||
+ instances.has(instanceId) === false ||
+ canResolveInstanceSelector(instanceSelector, instances) === false
+ ) {
+ return;
+ }
+
+ const rootInstanceId = instanceSelector.at(-1);
+ const page = getAllPages(pages).find(
+ (page) => page.rootInstanceId === rootInstanceId
);
- const page = canOpenPageTemplates
- ? findPageByIdOrPath(selection.pageId, pages, { includeTemplates: true })
- : findPageByIdOrPath(selection.pageId, pages);
- if (page?.rootInstanceId !== selection.instanceSelector.at(-1)) {
+ if (
+ page === undefined ||
+ (isPageTemplate(page) && canOpenPageTemplates === false)
+ ) {
return;
}
- return selection;
+ return { pageId: page.id, instanceSelector };
};
-export const __testing__ = { getDeepLinkedInstanceSelection };
+const shouldNavigateToPageState = ({
+ isUrlStateInitialized,
+ isSamePageState,
+ searchParamsInstanceSelector,
+ instanceSelector,
+}: {
+ isUrlStateInitialized: boolean;
+ isSamePageState: boolean;
+ searchParamsInstanceSelector: InstanceSelector | undefined;
+ instanceSelector: InstanceSelector | undefined;
+}) =>
+ isUrlStateInitialized &&
+ (isSamePageState === false ||
+ (searchParamsInstanceSelector === undefined
+ ? instanceSelector !== undefined
+ : areInstanceSelectorsEqual(
+ searchParamsInstanceSelector,
+ instanceSelector
+ ) === false));
+
+export const __testing__ = {
+ getDeepLinkedInstanceSelection,
+ shouldNavigateToPageState,
+};
+
+const getInstanceSelectorFromUrl = (searchParams: URLSearchParams) =>
+ searchParams.get("instance")?.split(",");
const setPageStateFromUrl = () => {
const searchParams = new URLSearchParams(window.location.search);
const pages = $pages.get();
if (pages === undefined) {
- return;
+ return false;
}
let mode = searchParams.get("mode");
@@ -81,8 +120,9 @@ const setPageStateFromUrl = () => {
)?.id ?? pages.homePageId;
$selectedPageHash.set({ hash: searchParams.get("pageHash") ?? "" });
+ const requestedInstanceSelector = getInstanceSelectorFromUrl(searchParams);
const instanceSelection = getDeepLinkedInstanceSelection({
- instanceId: searchParams.get("instanceId"),
+ instanceSelector: requestedInstanceSelector,
canOpenPageTemplates: $canOpenPageTemplates.get(),
pages,
instances: $instances.get(),
@@ -90,9 +130,10 @@ const setPageStateFromUrl = () => {
if (instanceSelection !== undefined) {
$selectedPageId.set(instanceSelection.pageId);
selectInstance(instanceSelection.instanceSelector);
- return;
+ return true;
}
selectPage(pageId);
+ return true;
};
/**
@@ -104,25 +145,26 @@ const setPageStateFromUrl = () => {
* - atoms to searchParams
* - on atom change
*/
-export const useSyncPageUrl = () => {
+export const useSyncPageUrl = ({ isDataLoaded }: { isDataLoaded: boolean }) => {
const navigate = useNavigate();
+ const [isUrlStateInitialized, setIsUrlStateInitialized] = useState(false);
const page = useStore($selectedPage);
const pageHash = useStore($selectedPageHash);
const builderMode = useStore($builderMode);
const selectedInstanceSelector = useStore($selectedInstanceSelector);
const canOpenPageTemplate = useStore($canOpenPageTemplates);
- // Get pageId and pageHash from URL
- // once pages are loaded
+ // Apply initial URL state only after the sync client has finished loading.
+ // Individual stores can contain intermediate data before then.
useEffect(() => {
- const unsubscribe = $pages.subscribe((pages) => {
- if (pages) {
- unsubscribe();
- setPageStateFromUrl();
- }
- });
- return unsubscribe;
- }, []);
+ if (
+ isDataLoaded &&
+ isUrlStateInitialized === false &&
+ setPageStateFromUrl()
+ ) {
+ setIsUrlStateInitialized(true);
+ }
+ }, [isDataLoaded, isUrlStateInitialized]);
useEffect(() => {
window.addEventListener("popstate", setPageStateFromUrl);
@@ -143,34 +185,44 @@ export const useSyncPageUrl = () => {
const searchParamsPageId = searchParams.get("pageId") ?? pages.homePageId;
const searchParamsPageHash = searchParams.get("pageHash") ?? "";
- const searchParamsInstanceId = searchParams.get("instanceId") ?? undefined;
+ const searchParamsInstanceSelector =
+ getInstanceSelectorFromUrl(searchParams);
const searchParamsModeRaw = searchParams.get("mode");
const searchParamsMode = isBuilderMode(searchParamsModeRaw)
? searchParamsModeRaw
: undefined;
const builderModeParam = builderMode === "design" ? undefined : builderMode;
const searchParamsSafemode = searchParams.get("safemode");
- const selectedInstanceId = selectedInstanceSelector?.[0];
- const instanceId =
- selectedInstanceId === page.rootInstanceId ||
- $instances.get().has(selectedInstanceId ?? "") === false
+ const instanceSelector =
+ selectedInstanceSelector === undefined ||
+ selectedInstanceSelector[0] === page.rootInstanceId ||
+ canResolveInstanceSelector(selectedInstanceSelector, $instances.get()) ===
+ false
? undefined
- : selectedInstanceId;
+ : selectedInstanceSelector;
const isSamePageState =
searchParamsPageId === page.id &&
searchParamsPageHash === pageHash.hash &&
searchParamsMode === builderModeParam;
- // Do not navigate on popstate change or if params match
- if (isSamePageState && searchParamsInstanceId === instanceId) {
+ // Do not navigate before initial URL state is applied, on popstate change,
+ // or if params match.
+ if (
+ shouldNavigateToPageState({
+ isUrlStateInitialized,
+ isSamePageState,
+ searchParamsInstanceSelector,
+ instanceSelector,
+ }) === false
+ ) {
return;
}
navigate(
builderPath({
pageId: page.id === pages.homePageId ? undefined : page.id,
- instanceId,
+ instanceSelector,
authToken: $authToken.get(),
pageHash: pageHash.hash === "" ? undefined : pageHash.hash,
mode: builderModeParam,
@@ -178,7 +230,14 @@ export const useSyncPageUrl = () => {
}),
{ replace: isSamePageState }
);
- }, [builderMode, navigate, page, pageHash, selectedInstanceSelector]);
+ }, [
+ builderMode,
+ isUrlStateInitialized,
+ navigate,
+ page,
+ pageHash,
+ selectedInstanceSelector,
+ ]);
useEffect(() => {
const pages = $pages.get();
diff --git a/apps/builder/app/shared/router-utils/path-utils.test.ts b/apps/builder/app/shared/router-utils/path-utils.test.ts
index 9bee1ab2ee..01e41ef0f9 100644
--- a/apps/builder/app/shared/router-utils/path-utils.test.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.test.ts
@@ -5,10 +5,12 @@ test("includes an instance deep link in builder paths", () => {
expect(
builderPath({
pageId: "page-id",
- instanceId: "instance-id",
+ instanceSelector: ["instance-id", "slot-id", "body-id"],
mode: "content",
})
- ).toBe("/?pageId=page-id&instanceId=instance-id&mode=content");
+ ).toBe(
+ "/?pageId=page-id&instance=instance-id%2Cslot-id%2Cbody-id&mode=content"
+ );
});
test("includes an instance deep link in builder urls", () => {
@@ -16,11 +18,11 @@ test("includes an instance deep link in builder urls", () => {
builderUrl({
projectId: "project-id",
pageId: "page-id",
- instanceId: "instance-id",
+ instanceSelector: ["instance-id", "body-id"],
origin: "https://wstd.dev",
})
).toBe(
- "https://p-project-id.wstd.dev/?pageId=page-id&instanceId=instance-id"
+ "https://p-project-id.wstd.dev/?pageId=page-id&instance=instance-id%2Cbody-id"
);
});
diff --git a/apps/builder/app/shared/router-utils/path-utils.ts b/apps/builder/app/shared/router-utils/path-utils.ts
index 5efb678526..1fa5c3c08f 100644
--- a/apps/builder/app/shared/router-utils/path-utils.ts
+++ b/apps/builder/app/shared/router-utils/path-utils.ts
@@ -16,7 +16,7 @@ const searchParams = (params: Record<string, string | undefined | null>) => {
export type BuilderLinkParams = {
pageId?: string;
- instanceId?: string;
+ instanceSelector?: readonly string[];
authToken?: string;
pageHash?: string;
mode?: BuilderMode;
@@ -25,7 +25,7 @@ export type BuilderLinkParams = {
export const builderPath = ({
pageId,
- instanceId,
+ instanceSelector,
authToken,
pageHash,
mode,
@@ -33,7 +33,7 @@ export const builderPath = ({
}: BuilderLinkParams = {}) => {
return `/${searchParams({
pageId,
- instanceId,
+ instance: instanceSelector?.join(","),
authToken,
pageHash,
mode,