Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guard against failures to access clipboard #940

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/langs/json/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,7 @@
"note": "Note",
"copy": "Copy",
"copiedToClipboard": "Copied to clipboard",
"couldNotCopyToClipboard": "Could not copy to clipboard",
"permalink": "Permalink",
"iframe": "Embed HTML iFrame",
"preview": "Embed Preview",
Expand Down
31 changes: 13 additions & 18 deletions src/lib/components/documents/Share.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@
Organization24,
} from "svelte-octicons";

import Button from "../common/Button.svelte";
import Button from "$lib/components/common/Button.svelte";
import CustomizeEmbed, { embedSettings } from "./CustomizeEmbed.svelte";
import Field from "../common/Field.svelte";
import FieldLabel from "../common/FieldLabel.svelte";
import Number from "../inputs/Number.svelte";
import Select from "../inputs/Select.svelte";
import Tab from "../common/Tab.svelte";
import Text from "../inputs/Text.svelte";
import TextArea from "../inputs/TextArea.svelte";
import Tip from "../common/Tip.svelte";
import Field from "$lib/components/common/Field.svelte";
import FieldLabel from "$lib/components/common/FieldLabel.svelte";
import Number from "$lib/components/inputs/Number.svelte";
import Select from "$lib/components/inputs/Select.svelte";
import Tab from "$lib/components/common/Tab.svelte";
import Text from "$lib/components/inputs/Text.svelte";
import TextArea from "$lib/components/inputs/TextArea.svelte";
import Tip from "$lib/components/common/Tip.svelte";

import Portal from "../layouts/Portal.svelte";
import Modal from "../layouts/Modal.svelte";
import Edit from "../forms/Edit.svelte";
import Portal from "$lib/components/layouts/Portal.svelte";
import Modal from "$lib/components/layouts/Modal.svelte";
import Edit from "$lib/components/forms/Edit.svelte";

import { toast } from "../layouts/Toaster.svelte";
import copy from "$lib/utils/copy";
import { createEmbedSearchParams } from "$lib/utils/embed";
import {
canonicalPageUrl,
Expand Down Expand Up @@ -108,11 +108,6 @@
break;
}
}

async function copy(text: string) {
await navigator.clipboard.writeText(text);
toast($_("share.copiedToClipboard"));
}
</script>

<div class="container">
Expand Down
2 changes: 2 additions & 0 deletions src/lib/components/documents/stories/Share.stories.svelte
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<script context="module" lang="ts">
import { Template, Story } from "@storybook/addon-svelte-csf";
import Share from "../Share.svelte";
import Toaster from "../../layouts/Toaster.svelte";

import document from "@/test/fixtures/documents/document-expanded.json";

Expand All @@ -18,6 +19,7 @@

<Template let:args>
<Share {document} {...args} />
<Toaster />
</Template>

<Story name="Document" args={{ ...args, document }} />
Expand Down
25 changes: 10 additions & 15 deletions src/lib/components/projects/ProjectShare.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
import type { Project } from "$lib/api/types";
import { canonicalUrl, embedUrl } from "$lib/api/projects";

import Button from "../common/Button.svelte";
import Field from "../common/Field.svelte";
import FieldLabel from "../common/FieldLabel.svelte";
import Text from "../inputs/Text.svelte";
import TextArea from "../inputs/TextArea.svelte";
import { toast } from "../layouts/Toaster.svelte";
import Tip from "../common/Tip.svelte";
import Portal from "../layouts/Portal.svelte";
import Modal from "../layouts/Modal.svelte";
import EditProject from "../forms/EditProject.svelte";
import Button from "$lib/components/common/Button.svelte";
import Field from "$lib/components/common/Field.svelte";
import FieldLabel from "$lib/components/common/FieldLabel.svelte";
import Text from "$lib/components/inputs/Text.svelte";
import TextArea from "$lib/components/inputs/TextArea.svelte";
import Tip from "$lib/components/common/Tip.svelte";
import Portal from "$lib/components/layouts/Portal.svelte";
import Modal from "$lib/components/layouts/Modal.svelte";
import EditProject from "$lib/components/forms/EditProject.svelte";
import copy from "$lib/utils/copy";

export let project: Project;

Expand All @@ -27,11 +27,6 @@
$: permalink = canonicalUrl(project);
$: embedSrc = embedUrl(project);
$: iframe = `<iframe src="${embedUrl(project).href}" />`;

async function copy(text: string) {
await navigator.clipboard.writeText(text);
toast($_("share.copiedToClipboard"));
}
</script>

<div class="share">
Expand Down
12 changes: 12 additions & 0 deletions src/lib/utils/copy.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import { unwrapFunctionStore, _ } from "svelte-i18n";
import { toast } from "$lib/components/layouts/Toaster.svelte";

export default async function copy(text: string) {
const $_ = unwrapFunctionStore(_);
try {
await navigator.clipboard.writeText(text);
toast($_("share.copiedToClipboard"));
} catch {
toast($_("share.couldNotCopyToClipboard"), { status: "error" });
}
}
70 changes: 70 additions & 0 deletions src/lib/utils/tests/copy.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
import {
describe,
it,
vi,
beforeEach,
afterEach,
expect,
type Mock,
} from "vitest";
import { toast } from "$lib/components/layouts/Toaster.svelte";
import { unwrapFunctionStore, _ } from "svelte-i18n";
import copy from "../copy";

// Mock the imports
vi.mock("$lib/components/layouts/Toaster.svelte", () => ({
toast: vi.fn(),
}));

vi.mock("svelte-i18n", () => ({
unwrapFunctionStore: vi.fn(),
_: vi.fn(),
}));

describe("copy", () => {
const mockUnwrapFunctionStore = unwrapFunctionStore as Mock;
const mockToast = toast as Mock;

beforeEach(() => {
mockUnwrapFunctionStore.mockReturnValue((key: string) => key);

// Mock navigator.clipboard
Object.assign(navigator, {
clipboard: {
writeText: vi.fn(),
},
});
});

afterEach(() => {
vi.clearAllMocks();
});

it("should copy text to clipboard and show success toast", async () => {
const writeTextSpy = vi
.spyOn(navigator.clipboard, "writeText")
.mockResolvedValueOnce(undefined);

await copy("test text");

expect(writeTextSpy).toHaveBeenCalledWith("test text");
expect(mockToast).toHaveBeenCalledWith("share.copiedToClipboard");
});

it("should show error toast when clipboard write fails", async () => {
const writeTextSpy = vi
.spyOn(navigator.clipboard, "writeText")
.mockRejectedValueOnce(
new Error(
"NotAllowedError: Failed to execute 'writeText' on 'Clipboard'",
),
);

expect(await copy("test text")).not.toThrowError;

expect(writeTextSpy).toHaveBeenCalledWith("test text");
expect(mockToast).toHaveBeenCalledWith("share.couldNotCopyToClipboard", {
status: "error",
});
});
});
Loading