Skip to content

fix: update tests for useClipboard to minimize risks of flakes #13250

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
May 15, 2024
Merged

fix: update tests for useClipboard to minimize risks of flakes #13250

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
8613133
wip: commit progress on test revamps
Parkreiner May 12, 2024
18cf563
fix: update existing tests to new format
Parkreiner May 12, 2024
7c6a8e6
chore: add test case for global snackbar
Parkreiner May 12, 2024
66a3502
refactor: consolidate files
Parkreiner May 12, 2024
8dfe422
refactor: make http dependency more explicit
Parkreiner May 12, 2024
caf1222
chore: add extra test case for exposed error value
Parkreiner May 13, 2024
65910c1
docs: fix typos
Parkreiner May 13, 2024
4399630
fix: make sure clipboard is reset between test runs
Parkreiner May 13, 2024
186f6c8
docs: add more context to comments
Parkreiner May 13, 2024
a5214fc
refactor: update mock console.error logic to use jest.spyOn
Parkreiner May 15, 2024
f396df4
docs: add more clarifying comments
Parkreiner May 15, 2024
58beffc
refactor: split off type alias for clarity
Parkreiner May 15, 2024
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
Prev Previous commit
Next Next commit
refactor: make http dependency more explicit
  • Loading branch information
@Parkreiner
Parkreiner committed May 12, 2024
commit 8dfe4229b159523f29db3c0dd3feaf48b067690e
6 changes: 5 additions & 1 deletion site/src/hooks/useClipboard.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import {
type UseClipboardResult,
COPY_FAILED_MESSAGE,
useClipboard,
HTTP_FALLBACK_DATA_ID,
} from "./useClipboard";

// execCommand is the workaround for copying text to the clipboard on HTTP-only
Expand Down Expand Up @@ -93,7 +94,10 @@ function setupMockClipboard(isSecure: boolean): SetupMockClipboardResult {
throw new Error("Failed to execute command 'copy'");
}

const dummyInput = document.querySelector("input[data-testid=dummy]");
const dummyInput = document.querySelector(
`input[data-testid=${HTTP_FALLBACK_DATA_ID}]`,
);

const inputIsFocused =
dummyInput instanceof HTMLInputElement &&
document.activeElement === dummyInput;
Expand Down
3 changes: 2 additions & 1 deletion site/src/hooks/useClipboard.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { displayError } from "components/GlobalSnackbar/utils";

const CLIPBOARD_TIMEOUT_MS = 1_000;
export const COPY_FAILED_MESSAGE = "Failed to copy text to clipboard";
export const HTTP_FALLBACK_DATA_ID = "http-fallback";

export type UseClipboardInput = Readonly<{
textToCopy: string;
Expand Down Expand Up @@ -99,7 +100,7 @@ function simulateClipboardWrite(textToCopy: string): boolean {
const dummyInput = document.createElement("input");

// Have to add test ID to dummy element for mocking purposes in tests
dummyInput.setAttribute("data-testid", "dummy");
dummyInput.setAttribute("data-testid", HTTP_FALLBACK_DATA_ID);

// Using visually-hidden styling to ensure that inserting the element doesn't
// cause any content reflows on the page (removes any risk of UI flickers).
Expand Down