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

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
docs: add more clarifying comments
  • Loading branch information
@Parkreiner
Parkreiner committed May 15, 2024
commit f396df404a21383a40ed5ad3040f0d02e4c42d55
8 changes: 7 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 @@ -150,6 +150,10 @@ describe.each(secureContextValues)("useClipboard - secure: %j", (isSecure) => {

beforeEach(() => {
jest.useFakeTimers();

// Can't use jest.spyOn here because there's no guarantee that the mock
// browser environment actually implements execCommand. Trying to spy on an
// undefined value will throw an error
global.document.execCommand = mockExecCommand;

jest.spyOn(window, "navigator", "get").mockImplementation(() => ({
Expand All @@ -172,9 +176,11 @@ describe.each(secureContextValues)("useClipboard - secure: %j", (isSecure) => {
jest.runAllTimers();
jest.useRealTimers();
jest.resetAllMocks();
global.document.execCommand = originalExecCommand;

// Still have to reset the mock clipboard state because the same mock values
// are reused for each test case in a given describe.each iteration
resetMockClipboardState();
global.document.execCommand = originalExecCommand;
});

const assertClipboardUpdateLifecycle = async (
Expand Down