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: Fix share link options saving (#5805)

Oleg Isonen7a6ffcb22964
diff --git a/apps/builder/app/shared/share-project/share-project.test.tsx b/apps/builder/app/shared/share-project/share-project.test.tsx
index 330d122e92..42309f62fd 100644
--- a/apps/builder/app/shared/share-project/share-project.test.tsx
+++ b/apps/builder/app/shared/share-project/share-project.test.tsx
@@ -48,6 +48,25 @@ const click = (element: Element) => {
});
};
+const input = (element: HTMLInputElement, value: string) => {
+ act(() => {
+ const valueSetter = Object.getOwnPropertyDescriptor(
+ HTMLInputElement.prototype,
+ "value"
+ )?.set;
+ valueSetter?.call(element, value);
+ element.dispatchEvent(new InputEvent("input", { bubbles: true }));
+ });
+};
+
+const focusOut = (element: Element, relatedTarget: EventTarget) => {
+ act(() => {
+ element.dispatchEvent(
+ new FocusEvent("focusout", { bubbles: true, relatedTarget })
+ );
+ });
+};
+
const renderShareProject = ({
onChange,
}: {
@@ -85,11 +104,12 @@ afterEach(() => {
});
describe("ShareProject", () => {
- test("keeps share link permission changes in local state before parent rerender", () => {
+ test("saves share link permission changes when link options close", () => {
const onChange = vi.fn();
renderShareProject({ onChange });
- click(getElement('[aria-label="Menu Button for options"]'));
+ const optionsButton = getElement('[aria-label="Menu Button for options"]');
+ click(optionsButton);
click(getControlByLabel("Editor"));
const publishCheckbox = getControlByLabel<HTMLButtonElement>("Can publish");
@@ -97,14 +117,45 @@ describe("ShareProject", () => {
click(publishCheckbox);
- expect(onChange).toHaveBeenNthCalledWith(1, {
+ expect(onChange).not.toHaveBeenCalled();
+
+ click(optionsButton);
+
+ expect(onChange).toHaveBeenCalledWith({
...link,
relation: "editors",
+ canPublish: true,
});
- expect(onChange).toHaveBeenNthCalledWith(2, {
+ });
+
+ test("does not save link name while link options remain open", () => {
+ const onChange = vi.fn();
+ renderShareProject({ onChange });
+
+ click(getElement('[aria-label="Menu Button for options"]'));
+
+ const nameInput = getElement<HTMLInputElement>('input[name="Name"]');
+ const editorSwitch = getControlByLabel("Editor");
+ input(nameInput, "Renamed link");
+ focusOut(nameInput, editorSwitch);
+
+ expect(onChange).not.toHaveBeenCalled();
+ });
+
+ test("saves link name when link options close", () => {
+ const onChange = vi.fn();
+ renderShareProject({ onChange });
+
+ const optionsButton = getElement('[aria-label="Menu Button for options"]');
+ click(optionsButton);
+
+ const nameInput = getElement<HTMLInputElement>('input[name="Name"]');
+ input(nameInput, "Renamed link");
+ click(optionsButton);
+
+ expect(onChange).toHaveBeenCalledWith({
...link,
- relation: "editors",
- canPublish: true,
+ name: "Renamed link",
});
});
});
diff --git a/apps/builder/app/shared/share-project/share-project.tsx b/apps/builder/app/shared/share-project/share-project.tsx
index 990c77e296..a5378d049c 100644
--- a/apps/builder/app/shared/share-project/share-project.tsx
+++ b/apps/builder/app/shared/share-project/share-project.tsx
@@ -7,6 +7,7 @@ import {
type ComponentProps,
type ReactNode,
} from "react";
+import { shallowEqual } from "shallow-equal";
import { type Role, roleLabels } from "@webstudio-is/project";
import { roleDescriptions } from "~/shared/permissions";
import {
@@ -143,24 +144,53 @@ const Menu = ({
}: MenuProps) => {
const ids = useIds(["name", "canClone", "canCopy", "canPublish"]);
const [isOpen, setIsOpen] = useState(false);
- const [customLinkName, setCustomLinkName] = useState<string>(name);
+ const [draftLink, setDraftLink] = useState(value);
+ const draftLinkRef = useRef(value);
+
+ const updateDraftLink = (update: LinkOptionsUpdate) => {
+ const nextLink = { ...draftLinkRef.current, ...update };
+ draftLinkRef.current = nextLink;
+ setDraftLink(nextLink);
+ };
const handleCheckedChange = (role: Role) => (checked: boolean) => {
if (checked) {
- onChange({ relation: role });
+ updateDraftLink({ relation: role });
}
};
- const saveCustomLinkName = () => {
- if (customLinkName.length === 0) {
+ const saveDraftLink = () => {
+ const draft = draftLinkRef.current;
+ const nextName = draft.name.trim();
+ const nextLink = {
+ ...draft,
+ name: nextName.length === 0 ? value.name : nextName,
+ };
+ if (
+ shallowEqual(
+ getComparableLinkOptions(nextLink),
+ getComparableLinkOptions(value)
+ )
+ ) {
return;
}
- onChange({ name: customLinkName.trim() });
+ onChange(nextLink);
};
return (
- <Popover open={isOpen} onOpenChange={setIsOpen}>
+ <Popover
+ open={isOpen}
+ onOpenChange={(open) => {
+ if (open === false) {
+ saveDraftLink();
+ } else {
+ draftLinkRef.current = value;
+ setDraftLink(value);
+ }
+ setIsOpen(open);
+ }}
+ >
<PopoverTrigger asChild>
<Button
prefix={<EllipsesIcon />}
@@ -175,22 +205,20 @@ const Menu = ({
width: theme.spacing[24],
}}
sideOffset={0}
- onInteractOutside={saveCustomLinkName}
>
<Item>
<Label htmlFor={ids.name}>Name</Label>
<InputField
id={ids.name}
- color={customLinkName.length === 0 ? "error" : undefined}
- value={customLinkName}
- onChange={(event) => setCustomLinkName(event.target.value)}
+ color={draftLink.name.length === 0 ? "error" : undefined}
+ value={draftLink.name}
+ onChange={(event) => updateDraftLink({ name: event.target.value })}
onKeyDown={(event) => {
if (event.key === "Enter") {
- saveCustomLinkName();
+ saveDraftLink();
setIsOpen(false);
}
}}
- onBlur={saveCustomLinkName}
placeholder="Share Project"
name="Name"
autoFocus
@@ -200,7 +228,7 @@ const Menu = ({
<Item>
<Label>Permissions</Label>
<Permission
- checked={value.relation === "viewers"}
+ checked={draftLink.relation === "viewers"}
onCheckedChange={handleCheckedChange("viewers")}
title={roleLabels.viewers}
info={
@@ -234,18 +262,20 @@ const Menu = ({
>
<Checkbox
disabled={
- !allowAdditionalPermissions || value.relation !== "viewers"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "viewers"
}
- checked={value.canClone}
+ checked={draftLink.canClone}
onCheckedChange={(canClone) => {
- onChange({ canClone: Boolean(canClone) });
+ updateDraftLink({ canClone: Boolean(canClone) });
}}
id={ids.canClone}
/>
<Label
htmlFor={ids.canClone}
disabled={
- !allowAdditionalPermissions || value.relation !== "viewers"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "viewers"
}
>
Can clone
@@ -261,18 +291,20 @@ const Menu = ({
>
<Checkbox
disabled={
- !allowAdditionalPermissions || value.relation !== "viewers"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "viewers"
}
- checked={value.canCopy}
+ checked={draftLink.canCopy}
onCheckedChange={(canCopy) => {
- onChange({ canCopy: Boolean(canCopy) });
+ updateDraftLink({ canCopy: Boolean(canCopy) });
}}
id={ids.canCopy}
/>
<Label
htmlFor={ids.canCopy}
disabled={
- !allowAdditionalPermissions || value.relation !== "viewers"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "viewers"
}
>
Can copy
@@ -283,7 +315,7 @@ const Menu = ({
<Permission
disabled={!allowAdditionalPermissions}
onCheckedChange={handleCheckedChange("editors")}
- checked={value.relation === "editors"}
+ checked={draftLink.relation === "editors"}
title={roleLabels.editors}
info={
<Flex direction="column">
@@ -316,18 +348,20 @@ const Menu = ({
>
<Checkbox
disabled={
- !allowAdditionalPermissions || value.relation !== "editors"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "editors"
}
- checked={value.canPublish}
+ checked={draftLink.canPublish}
onCheckedChange={(canPublish) => {
- onChange({ canPublish: Boolean(canPublish) });
+ updateDraftLink({ canPublish: Boolean(canPublish) });
}}
id={ids.canPublish}
/>
<Label
htmlFor={ids.canPublish}
disabled={
- !allowAdditionalPermissions || value.relation !== "editors"
+ !allowAdditionalPermissions ||
+ draftLink.relation !== "editors"
}
>
Can publish
@@ -337,7 +371,7 @@ const Menu = ({
<Permission
onCheckedChange={handleCheckedChange("builders")}
- checked={value.relation === "builders"}
+ checked={draftLink.relation === "builders"}
title={roleLabels.builders}
info={roleDescriptions.builders}
/>
@@ -345,7 +379,7 @@ const Menu = ({
<Permission
disabled={!allowAdditionalPermissions}
onCheckedChange={handleCheckedChange("administrators")}
- checked={value.relation === "administrators"}
+ checked={draftLink.relation === "administrators"}
title={roleLabels.administrators}
info={
<Flex direction="column">
@@ -399,6 +433,12 @@ export type LinkOptions = {
type LinkOptionsUpdate = Partial<Omit<LinkOptions, "token">>;
+const getComparableLinkOptions = (link: LinkOptions): LinkOptionsUpdate => {
+ const { token, ...options } = link;
+ void token;
+ return options;
+};
+
type SharedLinkItemType = {
value: LinkOptions;
onChange: (value: LinkOptions) => void;
diff --git a/apps/builder/e2e/flows/share-dialog.ts b/apps/builder/e2e/flows/share-dialog.ts
index 6bc5ce230d..d348e1ace0 100644
--- a/apps/builder/e2e/flows/share-dialog.ts
+++ b/apps/builder/e2e/flows/share-dialog.ts
@@ -124,12 +124,13 @@ export const createShareLink = async ({
.getByRole("button", { name: "Menu Button for options" })
.click();
const renamedLinkOptions = getShareLinkOptions({ page, name });
- if (await selectRole({ options: renamedLinkOptions, role })) {
- await waitForShareLinkMutation({ page });
- }
+ const roleChanged = await selectRole({ options: renamedLinkOptions, role });
await renamedLink
.getByRole("button", { name: "Menu Button for options" })
.click();
+ if (roleChanged) {
+ await waitForShareLinkMutation({ page });
+ }
await waitForShareLinksReady({ page });
};
@@ -160,9 +161,10 @@ export const updateShareLinkRole = async ({
const group = getShareLinkGroup({ page, name });
await group.getByRole("button", { name: "Menu Button for options" }).click();
const options = getShareLinkOptions({ page, name });
- if (await selectRole({ options, role })) {
+ const roleChanged = await selectRole({ options, role });
+ await group.getByRole("button", { name: "Menu Button for options" }).click();
+ if (roleChanged) {
await waitForShareLinkMutation({ page });
}
- await group.getByRole("button", { name: "Menu Button for options" }).click();
await waitForShareLinksReady({ page });
};