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: Allow same page path in different folders if those have a slug (#3172)

Oleg Isonenfaeef3bd4fda
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
index 33b3081ac4..26d732302d 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-settings.tsx
@@ -96,6 +96,7 @@ import {
duplicatePage,
isRootId,
toTreeData,
+ isPathAvailable,
} from "./page-utils";
import { Form } from "./form";
import type { System } from "~/builder/features/address-bar";
@@ -205,25 +206,6 @@ const PageValues = SharedPageValues.extend({
path: isFeatureEnabled("cms") ? PagePath : LegacyPagePath,
});
-const isPathUnique = (
- pages: Pages,
- // undefined page id means new page
- pageId: undefined | Page["id"],
- path: string
-) => {
- const list = [];
- const set = new Set();
- list.push(path);
- set.add(path);
- for (const page of pages.pages) {
- if (page.id !== pageId) {
- list.push(page.path);
- set.add(page.path);
- }
- }
- return list.length === set.size;
-};
-
const validateValues = (
pages: undefined | Pages,
// undefined page id means new page
@@ -258,7 +240,14 @@ const validateValues = (
return parsedResult.error.formErrors.fieldErrors;
}
if (pages !== undefined && values.path !== undefined) {
- if (isPathUnique(pages, pageId, values.path) === false) {
+ if (
+ isPathAvailable({
+ pages,
+ path: values.path,
+ parentFolderId: values.parentFolderId,
+ pageId,
+ }) === false
+ ) {
errors.path = errors.path ?? [];
errors.path.push("All paths must be unique");
}
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
index ce2311ef3f..12253a135c 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.test.ts
@@ -8,6 +8,7 @@ import {
DataSource,
encodeDataSourceVariable,
ROOT_FOLDER_ID,
+ type Page,
} from "@webstudio-is/sdk";
import {
cleanupChildRefsMutable,
@@ -22,6 +23,7 @@ import {
duplicatePage,
$editingPagesItemId,
$pageRootScope,
+ isPathAvailable,
} from "./page-utils";
import {
$dataSourceVariables,
@@ -36,16 +38,75 @@ import { registerContainers } from "~/shared/sync";
registerContainers();
+const createPages = () => {
+ const data = createDefaultPages({
+ rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
+ homePageId: "homePageId",
+ });
+
+ const { pages, folders } = data;
+
+ function f(id: string, children?: Array<Page | Folder>): Folder;
+ function f(id: string, slug: string, children?: Array<Page | Folder>): Folder;
+ // eslint-disable-next-line func-style
+ function f(id: string, slug?: unknown, children?: unknown) {
+ if (Array.isArray(slug)) {
+ children = slug;
+ slug = id;
+ }
+ const folder = {
+ id,
+ name: id,
+ slug: slug ?? id,
+ children: register((children as Array<Page | Folder>) ?? [], false),
+ };
+
+ return folder;
+ }
+
+ const p = (id: string, path: string): Page => {
+ const page = {
+ id,
+ meta: {},
+ name: id,
+ path,
+ rootInstanceId: "rootInstanceId",
+ systemDataSourceId: "systemDataSourceId",
+ title: `"${id}"`,
+ };
+ return page;
+ };
+
+ const register = (children: Array<Page | Folder>, root: boolean = true) => {
+ const childIds = [];
+ const rootFolder = folders.find(isRoot);
+
+ for (const child of children) {
+ childIds.push(child.id);
+ if ("meta" in child) {
+ pages.push(child);
+ continue;
+ }
+ folders.push(child);
+
+ if (root) {
+ rootFolder?.children.push(child.id);
+ }
+ }
+
+ return childIds;
+ };
+
+ return { f, p, register, pages: data };
+};
+
const toMap = <T extends { id: string }>(list: T[]) =>
new Map(list.map((item) => [item.id, item]));
describe("toTreeData", () => {
test("initial pages always has home pages and a root folder", () => {
- const pages = createDefaultPages({
- rootInstanceId: "id",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const { pages } = createPages();
const tree = toTreeData(pages);
expect(tree.root).toEqual({
id: ROOT_FOLDER_ID,
@@ -59,7 +120,7 @@ describe("toTreeData", () => {
meta: {},
name: "Home",
path: "",
- rootInstanceId: "id",
+ rootInstanceId: "rootInstanceId",
systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
@@ -71,19 +132,9 @@ describe("toTreeData", () => {
});
test("add empty folder", () => {
- const pages = createDefaultPages({
- rootInstanceId: "id",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
- pages.folders.push({
- id: "folderId",
- name: "Folder",
- slug: "folder",
- children: [],
- });
- const rootFolder = pages.folders.find(isRoot);
- rootFolder?.children.push("folderId");
+ const { pages, register, f } = createPages();
+ register([f("folder", [])]);
+
const tree = toTreeData(pages);
expect(tree.root).toEqual({
id: ROOT_FOLDER_ID,
@@ -97,7 +148,7 @@ describe("toTreeData", () => {
meta: {},
name: "Home",
path: "",
- rootInstanceId: "id",
+ rootInstanceId: "rootInstanceId",
systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
@@ -106,8 +157,8 @@ describe("toTreeData", () => {
},
{
type: "folder",
- id: "folderId",
- name: "Folder",
+ id: "folder",
+ name: "folder",
slug: "folder",
children: [],
},
@@ -116,28 +167,9 @@ describe("toTreeData", () => {
});
test("add a page inside a folder", () => {
- const pages = createDefaultPages({
- rootInstanceId: "id",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
- pages.pages.push({
- id: "pageId",
- meta: {},
- name: "Page",
- path: "/page",
- rootInstanceId: "id",
- systemDataSourceId: "systemDataSourceId",
- title: `"Page"`,
- });
- pages.folders.push({
- id: "folderId",
- name: "Folder",
- slug: "folder",
- children: ["pageId"],
- });
- const rootFolder = pages.folders.find(isRoot);
- rootFolder?.children.push("folderId");
+ const { pages, register, f, p } = createPages();
+ register([f("folder", [p("page", "/page")])]);
+
const tree = toTreeData(pages);
expect(tree.root).toEqual({
@@ -152,7 +184,7 @@ describe("toTreeData", () => {
meta: {},
name: "Home",
path: "",
- rootInstanceId: "id",
+ rootInstanceId: "rootInstanceId",
systemDataSourceId: "systemDataSourceId",
title: `"Home"`,
},
@@ -161,21 +193,21 @@ describe("toTreeData", () => {
},
{
type: "folder",
- id: "folderId",
- name: "Folder",
+ id: "folder",
+ name: "folder",
slug: "folder",
children: [
{
type: "page",
- id: "pageId",
+ id: "page",
data: {
- id: "pageId",
+ id: "page",
meta: {},
- name: "Page",
+ name: "page",
path: "/page",
- rootInstanceId: "id",
+ rootInstanceId: "rootInstanceId",
systemDataSourceId: "systemDataSourceId",
- title: `"Page"`,
+ title: `"page"`,
},
},
],
@@ -185,25 +217,9 @@ describe("toTreeData", () => {
});
test("nest a folder", () => {
- const pages = createDefaultPages({
- rootInstanceId: "id",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
- const rootFolder = pages.folders.find(isRoot);
- rootFolder?.children.push("1");
- pages.folders.push({
- id: "1",
- name: "Folder 1",
- slug: "folder-1",
- children: ["1-1"],
- });
- pages.folders.push({
- id: "1-1",
- name: "Folder 1-1",
- slug: "folder-1-1",
- children: [],
- });
+ const { pages, register, f } = createPages();
+ register([f("1", [f("1-1")])]);
+
const tree = toTreeData(pages);
expect(tree.root).toEqual({
type: "folder",
@@ -220,21 +236,21 @@ describe("toTreeData", () => {
path: "",
title: `"Home"`,
meta: {},
- rootInstanceId: "id",
+ rootInstanceId: "rootInstanceId",
systemDataSourceId: "systemDataSourceId",
},
},
{
type: "folder",
id: "1",
- name: "Folder 1",
- slug: "folder-1",
+ name: "1",
+ slug: "1",
children: [
{
type: "folder",
id: "1-1",
- name: "Folder 1-1",
- slug: "folder-1-1",
+ name: "1-1",
+ slug: "1-1",
children: [],
},
],
@@ -248,11 +264,7 @@ describe("reparentOrphansMutable", () => {
// We must deal with the fact there can be an orphaned folder or page in a collaborative mode,
// because user A can add a page to a folder while user B deletes the folder without receiving the create page yet.
test("reparent orphans to the root", () => {
- const pages = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const { pages } = createPages();
pages.pages.push({
id: "pageId",
meta: {},
@@ -281,11 +293,9 @@ describe("reparentOrphansMutable", () => {
describe("cleanupChildRefsMutable", () => {
test("cleanup refs", () => {
- const { folders } = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const {
+ pages: { folders },
+ } = createPages();
folders.push({
id: "folderId",
name: "Folder",
@@ -305,58 +315,40 @@ describe("cleanupChildRefsMutable", () => {
});
describe("isSlugAvailable", () => {
- const { folders } = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
- folders.push({
- id: "folderId1",
- name: "Folder 1",
- slug: "slug1",
- children: ["folderId1-1"],
- });
- folders.push({
- id: "folderId1-1",
- name: "Folder 1-1",
- slug: "slug1-1",
- children: [],
- });
- folders.push({
- id: "folderId2-1",
- name: "Folder 2-1",
- slug: "",
- children: [],
- });
- folders.push({
- id: "folderId2-2",
- name: "Folder 2-2",
- slug: "",
- children: [],
- });
+ const {
+ pages: { folders },
+ register,
+ f,
+ } = createPages();
+
+ register([
+ f("folder1", [f("folder1-1")]),
+ f("folder2-1", ""),
+ f("folder2-2", ""),
+ ]);
+
const rootFolder = folders.find(isRoot)!;
- rootFolder.children.push("folderId1");
test("available in the root", () => {
- expect(isSlugAvailable("slug", folders, rootFolder.id)).toBe(true);
+ expect(isSlugAvailable("folder", folders, rootFolder.id)).toBe(true);
});
test("not available in the root", () => {
- expect(isSlugAvailable("slug1", folders, rootFolder.id)).toBe(false);
+ expect(isSlugAvailable("folder1", folders, rootFolder.id)).toBe(false);
});
- test("available in Folder 1", () => {
- expect(isSlugAvailable("slug", folders, "folderId1")).toBe(true);
+ test("available in folder1", () => {
+ expect(isSlugAvailable("folder", folders, "folder1")).toBe(true);
});
- test("not available in Folder 1", () => {
- expect(isSlugAvailable("slug1-1", folders, "folderId1")).toBe(false);
+ test("not available in folder1", () => {
+ expect(isSlugAvailable("folder1-1", folders, "folder1")).toBe(false);
});
test("existing folder can have a matching slug when its the same id/folder", () => {
- expect(
- isSlugAvailable("slug1-1", folders, "folderId1", "folderId1-1")
- ).toBe(true);
+ expect(isSlugAvailable("folder1-1", folders, "folder1", "folder1-1")).toBe(
+ true
+ );
});
test("empty folder slug can be defined multiple times", () => {
@@ -364,24 +356,59 @@ describe("isSlugAvailable", () => {
});
});
+describe("isPathAvailable", () => {
+ const { f, p, register, pages } = createPages();
+
+ register([
+ f("folder1", [p("page1", "/page")]),
+ f("folder2", [p("page2", "/page")]),
+ f("/", [p("page3", "/page")]),
+ ]);
+
+ test("/folder2/page existing page", () => {
+ expect(
+ isPathAvailable({
+ pages,
+ path: "/page",
+ parentFolderId: "folder2",
+ pageId: "page2",
+ })
+ ).toBe(true);
+ });
+
+ test("/folder2/page new page", () => {
+ expect(
+ isPathAvailable({ pages, path: "/page", parentFolderId: "folder2" })
+ ).toBe(false);
+ });
+
+ test("/folder2/page1 new page", () => {
+ expect(
+ isPathAvailable({ pages, path: "/page1", parentFolderId: "folder2" })
+ ).toBe(true);
+ });
+
+ test("/page new page", () => {
+ expect(isPathAvailable({ pages, path: "/page", parentFolderId: "/" })).toBe(
+ false
+ );
+ });
+});
+
describe("registerFolderChildMutable", () => {
test("register a folder child in the root via fallback", () => {
- const { folders } = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const {
+ pages: { folders },
+ } = createPages();
registerFolderChildMutable(folders, "folderId");
const rootFolder = folders.find(isRoot);
expect(rootFolder?.children).toEqual(["homePageId", "folderId"]);
});
test("register a folder child in a provided folder", () => {
- const { folders } = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const {
+ pages: { folders },
+ } = createPages();
const folder = {
id: "folderId",
name: "Folder",
@@ -394,11 +421,9 @@ describe("registerFolderChildMutable", () => {
});
test("register in a provided folder & cleanup old refs", () => {
- const { folders } = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const {
+ pages: { folders },
+ } = createPages();
const folder = {
id: "folderId",
name: "Folder",
@@ -522,11 +547,7 @@ describe("filterSelfAndChildren", () => {
});
describe("getExistingRoutePaths", () => {
- const pages = createDefaultPages({
- rootInstanceId: "rootInstanceId",
- systemDataSourceId: "systemDataSourceId",
- homePageId: "homePageId",
- });
+ const { pages } = createPages();
test("gets all the route paths that exists in the project", () => {
pages.pages.push({
diff --git a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
index 67841f1934..4cab09b100 100644
--- a/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
+++ b/apps/builder/app/builder/features/sidebar-left/panels/pages/page-utils.ts
@@ -194,6 +194,34 @@ export const isSlugAvailable = (
);
};
+export const isPathAvailable = ({
+ pages,
+ path,
+ parentFolderId,
+ pageId,
+}: {
+ pages: Pages;
+ path: Page["path"];
+ parentFolderId: Folder["id"];
+ // undefined page id means new page
+ pageId?: Page["id"];
+}) => {
+ const map = new Map<Page["path"], Page>();
+ const allPages = [pages.homePage, ...pages.pages];
+ for (const page of allPages) {
+ map.set(getPagePath(page.id, pages), page);
+ }
+ const folderPath = getPagePath(parentFolderId, pages);
+ // When slug is empty, folderPath is "/".
+ const pagePath = folderPath === "/" ? path : `${folderPath}${path}`;
+ const existingPage = map.get(pagePath);
+ // We found another page that has the same path and the current page.
+ if (pageId && existingPage?.id === pageId) {
+ return true;
+ }
+ return existingPage === undefined;
+};
+
/**
* - Register a folder or a page inside children of a given parent folder.
* - Fallback to a root folder.
diff --git a/packages/sdk/src/schema/pages.ts b/packages/sdk/src/schema/pages.ts
index 00894a62f4..36a16b9908 100644
--- a/packages/sdk/src/schema/pages.ts
+++ b/packages/sdk/src/schema/pages.ts
@@ -144,12 +144,7 @@ export const Pages = z.object({
compiler: CompilerSettings.optional(),
redirects: z.array(PageRedirect).optional(),
homePage: HomePage,
- pages: z
- .array(Page)
- .refine(
- (array) => new Set(array.map((page) => page.path)).size === array.length,
- "All paths must be unique"
- ),
+ pages: z.array(Page),
folders: z
.array(Folder)
.refine((folders) => folders.length > 0, "Folders can't be empty"),