Skip to content

Prevent using disposed of timers #213271

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
Matt Bierner (mjbvz) merged 2 commits into from
May 23, 2024
Merged

Prevent using disposed of timers #213271

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64555a1
Prevent using disposed of timers
May 22, 2024
fa922eb
Throw errors instead
May 23, 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
16 changes: 16 additions & 0 deletions src/vs/base/common/async.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,7 @@ export class ResourceQueue implements IDisposable {

export class TimeoutTimer implements IDisposable {
private _token: any;
private _isDisposed = false;

constructor();
constructor(runner: () => void, timeout: number);
Expand All @@ -893,6 +894,7 @@ export class TimeoutTimer implements IDisposable {

dispose(): void {
this.cancel();
this._isDisposed = true;
}

cancel(): void {
Expand All @@ -903,6 +905,10 @@ export class TimeoutTimer implements IDisposable {
}

cancelAndSet(runner: () => void, timeout: number): void {
if (this._isDisposed) {
throw new BugIndicatingError(`Calling 'cancelAndSet' on a disposed TimeoutTimer`);
}

this.cancel();
this._token = setTimeout(() => {
this._token = -1;
Expand All @@ -911,6 +917,10 @@ export class TimeoutTimer implements IDisposable {
}

setIfNotSet(runner: () => void, timeout: number): void {
if (this._isDisposed) {
throw new BugIndicatingError(`Calling 'setIfNotSet' on a disposed TimeoutTimer`);
}

if (this._token !== -1) {
// timer is already set
return;
Expand All @@ -925,13 +935,18 @@ export class TimeoutTimer implements IDisposable {
export class IntervalTimer implements IDisposable {

private disposable: IDisposable | undefined = undefined;
private isDisposed = false;

cancel(): void {
this.disposable?.dispose();
this.disposable = undefined;
}

cancelAndSet(runner: () => void, interval: number, context = globalThis): void {
if (this.isDisposed) {
throw new BugIndicatingError(`Calling 'cancelAndSet' on a disposed IntervalTimer`);
}

this.cancel();
const handle = context.setInterval(() => {
runner();
Expand All @@ -945,6 +960,7 @@ export class IntervalTimer implements IDisposable {

dispose(): void {
this.cancel();
this.isDisposed = true;
}
}

Expand Down