Skip to content

Commit 1ab07c5

Browse files
jriekenjrieken
committed
rename isPromiseCanceledError to isCancellationError, nudge folks towards CancellationError instead of canceled-function
1 parent b1b2bd6 commit 1ab07c5

File tree

49 files changed

+244
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+244
-244
lines changed

‎src/vs/base/browser/ui/tree/asyncDataTree.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { CompressibleObjectTree, ICompressibleKeyboardNavigationLabelProvider, I
1414
import { IAsyncDataSource, ICollapseStateChangeEvent, ITreeContextMenuEvent, ITreeDragAndDrop, ITreeElement, ITreeEvent, ITreeFilter, ITreeMouseEvent, ITreeNode, ITreeRenderer, ITreeSorter, TreeError, TreeFilterResult, TreeVisibility, WeakMapper } from 'vs/base/browser/ui/tree/tree';
1515
import { CancelablePromise, createCancelablePromise, Promises, timeout } from 'vs/base/common/async';
1616
import { Codicon } from 'vs/base/common/codicons';
17-
import { isPromiseCanceledError, onUnexpectedError } from 'vs/base/common/errors';
17+
import { isCancellationError, onUnexpectedError } from 'vs/base/common/errors';
1818
import { Emitter, Event } from 'vs/base/common/event';
1919
import { Iterable } from 'vs/base/common/iterator';
2020
import { DisposableStore, dispose, IDisposable } from 'vs/base/common/lifecycle';
@@ -783,7 +783,7 @@ export class AsyncDataTree<TInput, T, TFilterData = void> implements IDisposable
783783
this.tree.collapse(node);
784784
}
785785

786-
if (isPromiseCanceledError(err)) {
786+
if (isCancellationError(err)) {
787787
return [];
788788
}
789789

@@ -837,7 +837,7 @@ export class AsyncDataTree<TInput, T, TFilterData = void> implements IDisposable
837837
}
838838

839839
const nodesToForget = new Map<T, IAsyncDataTreeNode<TInput, T>>();
840-
const childrenTreeNodesById = new Map<string, { node: IAsyncDataTreeNode<TInput, T>, collapsed: boolean }>();
840+
const childrenTreeNodesById = new Map<string, { node: IAsyncDataTreeNode<TInput, T>, collapsed: boolean; }>();
841841

842842
for (const child of node.children) {
843843
nodesToForget.set(child.element as T, child);

‎src/vs/base/common/errors.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,15 +78,15 @@ export function setUnexpectedErrorHandler(newUnexpectedErrorHandler: (e: any) =>
7878

7979
export function onUnexpectedError(e: any): undefined {
8080
// ignore errors from cancelled promises
81-
if (!isPromiseCanceledError(e)) {
81+
if (!isCancellationError(e)) {
8282
errorHandler.onUnexpectedError(e);
8383
}
8484
return undefined;
8585
}
8686

8787
export function onUnexpectedExternalError(e: any): undefined {
8888
// ignore errors from cancelled promises
89-
if (!isPromiseCanceledError(e)) {
89+
if (!isCancellationError(e)) {
9090
errorHandler.onUnexpectedExternalError(e);
9191
}
9292
return undefined;
@@ -140,7 +140,10 @@ const canceledName = 'Canceled';
140140
/**
141141
* Checks if the given error is a promise in canceled state
142142
*/
143-
export function isPromiseCanceledError(error: any): boolean {
143+
export function isCancellationError(error: any): boolean {
144+
if (error instanceof CancellationError) {
145+
return true;
146+
}
144147
return error instanceof Error && error.name === canceledName && error.message === canceledName;
145148
}
146149

@@ -154,7 +157,7 @@ export class CancellationError extends Error {
154157
}
155158

156159
/**
157-
* Returns an error that signals cancellation.
160+
* @deprecated uses {@link CancellationError}
158161
*/
159162
export function canceled(): Error {
160163
const error = new Error(canceledName);

‎src/vs/base/test/common/async.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import * as assert from 'assert';
77
import * as async from 'vs/base/common/async';
88
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
9-
import { isPromiseCanceledError } from 'vs/base/common/errors';
9+
import { isCancellationError } from 'vs/base/common/errors';
1010
import { Event } from 'vs/base/common/event';
1111
import { URI } from 'vs/base/common/uri';
1212

@@ -21,7 +21,7 @@ suite('Async', () => {
2121
});
2222
let result = promise.then(_ => assert.ok(false), err => {
2323
assert.strictEqual(canceled, 1);
24-
assert.ok(isPromiseCanceledError(err));
24+
assert.ok(isCancellationError(err));
2525
});
2626
promise.cancel();
2727
promise.cancel(); // cancel only once
@@ -36,7 +36,7 @@ suite('Async', () => {
3636
});
3737
let result = promise.then(_ => assert.ok(false), err => {
3838
assert.strictEqual(canceled, 1);
39-
assert.ok(isPromiseCanceledError(err));
39+
assert.ok(isCancellationError(err));
4040
});
4141
promise.cancel();
4242
return result;

‎src/vs/base/test/common/paging.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import * as assert from 'assert';
77
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
8-
import { canceled, isPromiseCanceledError } from 'vs/base/common/errors';
8+
import { canceled, isCancellationError } from 'vs/base/common/errors';
99
import { IPager, PagedModel } from 'vs/base/common/paging';
1010

1111
function getPage(pageIndex: number, cancellationToken: CancellationToken): Promise<number[]> {
@@ -110,7 +110,7 @@ suite('PagedModel', () => {
110110
return assert(false);
111111
}
112112
catch (err) {
113-
return assert(isPromiseCanceledError(err));
113+
return assert(isCancellationError(err));
114114
}
115115
});
116116

@@ -124,7 +124,7 @@ suite('PagedModel', () => {
124124

125125
const promise = model.resolve(5, tokenSource.token).then(
126126
() => assert(false),
127-
err => assert(isPromiseCanceledError(err))
127+
err => assert(isCancellationError(err))
128128
);
129129

130130
setTimeout(() => tokenSource.cancel(), 10);
@@ -153,15 +153,15 @@ suite('PagedModel', () => {
153153
const tokenSource1 = new CancellationTokenSource();
154154
const promise1 = model.resolve(5, tokenSource1.token).then(
155155
() => assert(false),
156-
err => assert(isPromiseCanceledError(err))
156+
err => assert(isCancellationError(err))
157157
);
158158

159159
assert.strictEqual(state, 'resolving');
160160

161161
const tokenSource2 = new CancellationTokenSource();
162162
const promise2 = model.resolve(6, tokenSource2.token).then(
163163
() => assert(false),
164-
err => assert(isPromiseCanceledError(err))
164+
err => assert(isCancellationError(err))
165165
);
166166

167167
assert.strictEqual(state, 'resolving');

‎src/vs/editor/common/services/modelService.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -852,7 +852,7 @@ export class ModelSemanticColoring extends Disposable {
852852
this._setDocumentSemanticTokens(provider, tokens || null, styling, pendingChanges);
853853
}
854854
}, (err) => {
855-
const isExpectedError = err && (errors.isPromiseCanceledError(err) || (typeof err.message === 'string' && err.message.indexOf('busy') !== -1));
855+
const isExpectedError = err && (errors.isCancellationError(err) || (typeof err.message === 'string' && err.message.indexOf('busy') !== -1));
856856
if (!isExpectedError) {
857857
errors.onUnexpectedError(err);
858858
}

‎src/vs/editor/contrib/codeAction/codeAction.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import { coalesce, equals, flatten, isNonEmptyArray } from 'vs/base/common/arrays';
77
import { CancellationToken } from 'vs/base/common/cancellation';
8-
import { illegalArgument, isPromiseCanceledError, onUnexpectedExternalError } from 'vs/base/common/errors';
8+
import { illegalArgument, isCancellationError, onUnexpectedExternalError } from 'vs/base/common/errors';
99
import { Disposable, DisposableStore, IDisposable } from 'vs/base/common/lifecycle';
1010
import { URI } from 'vs/base/common/uri';
1111
import { TextModelCancellationTokenSource } from 'vs/editor/browser/core/editorState';
@@ -136,7 +136,7 @@ export function getCodeActions(
136136
documentation
137137
};
138138
} catch (err) {
139-
if (isPromiseCanceledError(err)) {
139+
if (isCancellationError(err)) {
140140
throw err;
141141
}
142142
onUnexpectedExternalError(err);
@@ -189,7 +189,7 @@ function getDocumentation(
189189
const documentation = provider.documentation.map(entry => ({ kind: new CodeActionKind(entry.kind), command: entry.command }));
190190

191191
if (only) {
192-
let currentBest: { readonly kind: CodeActionKind, readonly command: modes.Command } | undefined;
192+
let currentBest: { readonly kind: CodeActionKind, readonly command: modes.Command; } | undefined;
193193
for (const entry of documentation) {
194194
if (entry.kind.contains(only)) {
195195
if (!currentBest) {

‎src/vs/editor/contrib/codeAction/codeActionModel.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*--------------------------------------------------------------------------------------------*/
55

66
import { CancelablePromise, createCancelablePromise, TimeoutTimer } from 'vs/base/common/async';
7-
import { isPromiseCanceledError } from 'vs/base/common/errors';
7+
import { isCancellationError } from 'vs/base/common/errors';
88
import { Emitter } from 'vs/base/common/event';
99
import { Disposable, MutableDisposable } from 'vs/base/common/lifecycle';
1010
import { isEqual } from 'vs/base/common/resources';
@@ -157,7 +157,7 @@ export namespace CodeActionsState {
157157
private readonly _cancellablePromise: CancelablePromise<CodeActionSet>,
158158
) {
159159
this.actions = _cancellablePromise.catch((e): CodeActionSet => {
160-
if (isPromiseCanceledError(e)) {
160+
if (isCancellationError(e)) {
161161
return emptyCodeActionSet;
162162
}
163163
throw e;

‎src/vs/editor/contrib/linkedEditing/linkedEditing.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import * as arrays from 'vs/base/common/arrays';
77
import { CancelablePromise, createCancelablePromise, Delayer, first } from 'vs/base/common/async';
88
import { CancellationToken } from 'vs/base/common/cancellation';
99
import { Color } from 'vs/base/common/color';
10-
import { isPromiseCanceledError, onUnexpectedError, onUnexpectedExternalError } from 'vs/base/common/errors';
10+
import { isCancellationError, onUnexpectedError, onUnexpectedExternalError } from 'vs/base/common/errors';
1111
import { Event } from 'vs/base/common/event';
1212
import { KeyCode, KeyMod } from 'vs/base/common/keyCodes';
1313
import { Disposable, DisposableStore } from 'vs/base/common/lifecycle';
@@ -330,7 +330,7 @@ export class LinkedEditingContribution extends Disposable implements IEditorCont
330330
this._visibleContextKey.set(true);
331331
this._currentDecorations = this._editor.deltaDecorations(this._currentDecorations, decorations);
332332
} catch (err) {
333-
if (!isPromiseCanceledError(err)) {
333+
if (!isCancellationError(err)) {
334334
onUnexpectedError(err);
335335
}
336336
if (this._currentRequest === request || !this._currentRequest) {

‎src/vs/editor/contrib/suggest/suggest.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*--------------------------------------------------------------------------------------------*/
55

66
import { CancellationToken } from 'vs/base/common/cancellation';
7-
import { canceled, isPromiseCanceledError, onUnexpectedExternalError } from 'vs/base/common/errors';
7+
import { canceled, isCancellationError, onUnexpectedExternalError } from 'vs/base/common/errors';
88
import { FuzzyScore } from 'vs/base/common/filters';
99
import { DisposableStore, IDisposable, isDisposable } from 'vs/base/common/lifecycle';
1010
import { StopWatch } from 'vs/base/common/stopwatch';
@@ -131,7 +131,7 @@ export class CompletionItem {
131131
this._isResolved = true;
132132
sub.dispose();
133133
}, err => {
134-
if (isPromiseCanceledError(err)) {
134+
if (isCancellationError(err)) {
135135
// the IPC queue will reject the request with the
136136
// cancellation error -> reset cached
137137
this._resolveCache = undefined;

‎src/vs/platform/contextview/browser/contextMenuHandler.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { $, addDisposableListener, EventType, isHTMLElement } from 'vs/base/brow
88
import { StandardMouseEvent } from 'vs/base/browser/mouseEvent';
99
import { Menu } from 'vs/base/browser/ui/menu/menu';
1010
import { ActionRunner, IRunEvent, WorkbenchActionExecutedClassification, WorkbenchActionExecutedEvent } from 'vs/base/common/actions';
11-
import { isPromiseCanceledError } from 'vs/base/common/errors';
11+
import { isCancellationError } from 'vs/base/common/errors';
1212
import { combinedDisposable, DisposableStore } from 'vs/base/common/lifecycle';
1313
import 'vs/css!./contextMenuHandler';
1414
import { IContextViewService } from 'vs/platform/contextview/browser/contextView';
@@ -158,7 +158,7 @@ export class ContextMenuHandler {
158158
}
159159

160160
private onDidActionRun(e: IRunEvent): void {
161-
if (e.error && !isPromiseCanceledError(e.error)) {
161+
if (e.error && !isCancellationError(e.error)) {
162162
this.notificationService.error(e.error);
163163
}
164164
}

‎src/vs/platform/environment/node/shellEnv.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { basename } from 'vs/base/common/path';
88
import { localize } from 'vs/nls';
99
import { CancellationToken, CancellationTokenSource } from 'vs/base/common/cancellation';
1010
import { toErrorMessage } from 'vs/base/common/errorMessage';
11-
import { canceled, isPromiseCanceledError } from 'vs/base/common/errors';
11+
import { canceled, isCancellationError } from 'vs/base/common/errors';
1212
import { IProcessEnvironment, isWindows, OS } from 'vs/base/common/platform';
1313
import { generateUuid } from 'vs/base/common/uuid';
1414
import { getSystemShell } from 'vs/base/node/shell';
@@ -82,7 +82,7 @@ export async function getResolvedShellEnv(logService: ILogService, args: NativeP
8282
try {
8383
resolve(await doResolveUnixShellEnv(logService, cts.token));
8484
} catch (error) {
85-
if (!isPromiseCanceledError(error) && !cts.token.isCancellationRequested) {
85+
if (!isCancellationError(error) && !cts.token.isCancellationRequested) {
8686
reject(new Error(localize('resolveShellEnvError', "Unable to resolve your shell environment: {0}", toErrorMessage(error))));
8787
} else {
8888
resolve({});

0 commit comments

Comments
 (0)