Skip to content

test(debounce): improved the test code for the debounce function #1263

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
+83 −33
Open

test(debounce): improved the test code for the debounce function #1263

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
bd8c78f
test(debounce): add test case for flush function
ssi02014 Jul 8, 2025
6f4ead9
test(debounce): change to debouncedMs constant
ssi02014 Jul 8, 2025
043f891
test(debounce): add test cases for edge options
ssi02014 Jul 8, 2025
b101677
Merge branch 'main' into test/debounce
ssi02014 Jul 13, 2025
2c2561e
Merge branch 'main' into test/debounce
ssi02014 Jul 14, 2025
79e6765
Merge branch 'main' into test/debounce
ssi02014 Jul 21, 2025
b394472
Merge branch 'main' into test/debounce
ssi02014 Jul 25, 2025
01ffc92
Merge branch 'main' into test/debounce
ssi02014 Jul 27, 2025
6ead746
Merge branch 'main' into test/debounce
ssi02014 Aug 6, 2025
b77a16e
Merge branch 'main' into test/debounce
ssi02014 Aug 20, 2025
4bd3e87
Merge branch 'main' into test/debounce
manudeli Sep 9, 2025
f1a6789
Merge branch 'main' into test/debounce
ssi02014 Oct 24, 2025
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
70 changes: 37 additions & 33 deletions src/function/debounce.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,110 +3,116 @@ import { debounce } from './debounce';
// adjust the import path as necessary
import { delay } from '../promise';

const DEBOUNCE_MS = 50;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To reduce code duplication, change debounceMs to a constant.


describe('debounce', () => {
it('should debounce function calls', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
debouncedFunc();
debouncedFunc();

await delay(debounceMs * 2);
expect(func).not.toHaveBeenCalled();
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This code was added to more clearly test the basic debounce behavior.


await delay(DEBOUNCE_MS * 2);

expect(func).toHaveBeenCalledTimes(1);
});

it('should delay the function call by the specified wait time', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
await delay(debounceMs / 2);
await delay(DEBOUNCE_MS / 2);
expect(func).not.toHaveBeenCalled();

await delay(debounceMs / 2 + 1);
await delay(DEBOUNCE_MS / 2 + 1);
expect(func).toHaveBeenCalledTimes(1);
});

it('should reset the wait time if called again before wait time ends', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
await delay(debounceMs / 2);
await delay(DEBOUNCE_MS / 2);
debouncedFunc();
await delay(debounceMs / 2);
await delay(DEBOUNCE_MS / 2);
debouncedFunc();
await delay(debounceMs / 2);
await delay(DEBOUNCE_MS / 2);
debouncedFunc();

expect(func).not.toHaveBeenCalled();

await delay(debounceMs + 1);
await delay(DEBOUNCE_MS + 1);
expect(func).toHaveBeenCalledTimes(1);
});

it('should cancel the debounced function call', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
debouncedFunc.cancel();
await delay(debounceMs);
await delay(DEBOUNCE_MS);

expect(func).not.toHaveBeenCalled();
});

it('should immediately invoke the delayed function when flush is called', async () => {
const func = vi.fn();
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
debouncedFunc.flush();

expect(func).toHaveBeenCalledTimes(1);
});
Comment on lines +65 to +73
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add test code for the debounced.flush function.


it('should work correctly if the debounced function is called after the wait time', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc();
await delay(debounceMs + 1);
await delay(DEBOUNCE_MS + 1);
debouncedFunc();
await delay(debounceMs + 1);
await delay(DEBOUNCE_MS + 1);

expect(func).toHaveBeenCalledTimes(2);
});

it('should have no effect if we call cancel when the function is not executed', () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

expect(() => debouncedFunc.cancel()).not.toThrow();
});

it('should call the function with correct arguments', async () => {
const func = vi.fn();
const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs);
const debouncedFunc = debounce(func, DEBOUNCE_MS);

debouncedFunc('test', 123);

await delay(debounceMs * 2);
await delay(DEBOUNCE_MS * 2);

expect(func).toHaveBeenCalledTimes(1);
expect(func).toHaveBeenCalledWith('test', 123);
});

it('should cancel the debounced function call if aborted via AbortSignal', async () => {
const func = vi.fn();
const debounceMs = 50;
const controller = new AbortController();
const signal = controller.signal;
const debouncedFunc = debounce(func, debounceMs, { signal });
const debouncedFunc = debounce(func, DEBOUNCE_MS, { signal });

debouncedFunc();
controller.abort();

await delay(debounceMs);
await delay(DEBOUNCE_MS);

expect(func).not.toHaveBeenCalled();
});
Expand All @@ -119,24 +125,22 @@ describe('debounce', () => {

const func = vi.fn();

const debounceMs = 50;
const debouncedFunc = debounce(func, debounceMs, { signal });
const debouncedFunc = debounce(func, DEBOUNCE_MS, { signal });

debouncedFunc();

await delay(debounceMs);
await delay(DEBOUNCE_MS);

expect(func).not.toHaveBeenCalled();
});

it('should not add multiple abort event listeners', async () => {
const func = vi.fn();
const debounceMs = 100;
const controller = new AbortController();
const signal = controller.signal;
const addEventListenerSpy = vi.spyOn(signal, 'addEventListener');

const debouncedFunc = debounce(func, debounceMs, { signal });
const debouncedFunc = debounce(func, DEBOUNCE_MS, { signal });

debouncedFunc();
debouncedFunc();
Expand Down