Skip to content
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/TaskTimer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,7 @@ class TaskTimer extends EventEmitter<(event: ITaskTimerEvent) => void> {
this.#emit(Event.TICK);

for (const task of tasks.values()) {
if (generation !== this.#generation) return;
if (task.canRunOnTick) this.#dispatch(task);
}

Expand Down
98 changes: 98 additions & 0 deletions test/tasktimer.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -901,6 +901,104 @@ describe('Task callbacks', () => {
});

describe('TaskTimer re-entrancy', () => {
it.each(['pause', 'stop', 'reset'] as const)(
'skips pending tasks when a tick listener calls %s()',
(action) => {
vi.useFakeTimers();
try {
const timer = new TaskTimer({ interval: 20, precision: false });
const callback = vi.fn();
timer.add(callback);
timer.once(Event.TICK, () => timer[action]());

timer.start();
vi.advanceTimersByTime(60);

expect(callback).not.toHaveBeenCalled();
expect(timer.taskRunCount).toBe(0);
expect(vi.getTimerCount()).toBe(0);
} finally {
vi.useRealTimers();
}
}
);

it.each(['pause', 'stop', 'reset'] as const)(
'skips later tasks when a task callback calls %s()',
(action) => {
vi.useFakeTimers();
try {
const timer = new TaskTimer({ interval: 20, precision: false });
const first = vi.fn(() => {
timer[action]();
});
const second = vi.fn();
timer.add([first, second]);

timer.start();
vi.advanceTimersByTime(60);

expect(first).toHaveBeenCalledOnce();
expect(second).not.toHaveBeenCalled();
expect(vi.getTimerCount()).toBe(0);
} finally {
vi.useRealTimers();
}
}
);

it('runs pending tasks on the next tick after a listener pauses and resumes', () => {
vi.useFakeTimers();
try {
const timer = new TaskTimer({ interval: 20, precision: false });
const callback = vi.fn();
timer.add(callback);
timer.once(Event.TICK, () => timer.pause().resume());

timer.start();
vi.advanceTimersByTime(20);
expect(callback).not.toHaveBeenCalled();
expect(timer.state).toBe(State.RUNNING);

vi.advanceTimersByTime(20);
expect(callback).toHaveBeenCalledOnce();
expect(timer.tickCount).toBe(2);
timer.stop();
} finally {
vi.useRealTimers();
}
});

it('runs later tasks only on the next tick when a task restarts the timer', () => {
vi.useFakeTimers();
try {
const timer = new TaskTimer({ interval: 20, precision: false });
const second = vi.fn();
let restarted = false;
timer.add([
() => {
if (!restarted) {
restarted = true;
timer.start();
}
},
second
]);

timer.start();
vi.advanceTimersByTime(20);
expect(second).not.toHaveBeenCalled();
expect(timer.tickCount).toBe(0);

vi.advanceTimersByTime(20);
expect(second).toHaveBeenCalledOnce();
expect(timer.tickCount).toBe(1);
timer.stop();
} finally {
vi.useRealTimers();
}
});

it('does not double-schedule when start() is called inside a tick', () => {
vi.useFakeTimers();
try {
Expand Down