ignore listeners that failed (error, timeout) more than n times, #239

This commit is contained in:
Johannes Rieken
2016-09-23 12:21:54 +02:00
parent 5874111ef2
commit 94d8b210e4
3 changed files with 68 additions and 20 deletions

View File

@@ -16,19 +16,26 @@ import {fromRange} from 'vs/workbench/api/node/extHostTypeConverters';
import {IResourceEdit} from 'vs/editor/common/services/bulkEdit';
import {ExtHostDocuments} from 'vs/workbench/api/node/extHostDocuments';
declare class WeakMap<K, V> {
// delete(key: K): boolean;
get(key: K): V;
// has(key: K): boolean;
set(key: K, value?: V): WeakMap<K, V>;
}
export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipantShape {
private _documents: ExtHostDocuments;
private _workspace: MainThreadWorkspaceShape;
private _listenerTimeout: number;
private _callbacks = new CallbackList();
private _badListeners = new WeakMap<Function, number>();
private _thresholds: { timeout: number; errors: number; };
constructor(documents: ExtHostDocuments, workspace: MainThreadWorkspaceShape, listenerTimeout: number = 1000) {
constructor(documents: ExtHostDocuments, workspace: MainThreadWorkspaceShape, thresholds: { timeout: number; errors: number; } = { timeout: 1000, errors: 5 }) {
super();
this._documents = documents;
this._workspace = workspace;
this._listenerTimeout = listenerTimeout;
this._thresholds = thresholds;
}
dispose(): void {
@@ -38,7 +45,11 @@ export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipa
get onWillSaveTextDocumentEvent(): Event<vscode.TextDocumentWillSaveEvent> {
return (listener, thisArg, disposables) => {
this._callbacks.add(listener, thisArg);
const result = { dispose: () => this._callbacks.remove(listener, thisArg) };
const result = {
dispose: () => {
this._callbacks.remove(listener, thisArg);
}
};
if (Array.isArray(disposables)) {
disposables.push(result);
}
@@ -46,13 +57,35 @@ export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipa
};
}
$participateInSave(resource: URI): TPromise<any[]> {
$participateInSave(resource: URI): TPromise<boolean[]> {
const entries = this._callbacks.entries();
return sequence(entries.map(([fn, thisArg]) => {
return () => {
const errors = this._badListeners.get(fn);
if (errors > this._thresholds.errors) {
// ignored
return TPromise.wrap(false);
}
const document = this._documents.getDocumentData(resource).document;
return this._deliverEventAsync(fn, thisArg, document);
return this._deliverEventAsync(fn, thisArg, document).then(() => {
// don't send result across the wire
return true;
}, err => {
if (!(err instanceof Error) || (<Error>err).message !== 'concurrent_edits') {
const errors = this._badListeners.get(fn);
this._badListeners.set(fn, !errors ? 1 : errors + 1);
// todo@joh signal to the listener?
// if (errors === this._thresholds.errors) {
// console.warn('BAD onWillSaveTextDocumentEvent-listener is from now on being ignored');
// }
}
return false;
});
};
}));
}
@@ -77,7 +110,7 @@ export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipa
// fire event
listener.apply(thisArg, [event]);
} catch (err) {
return TPromise.as(new Error(err));
return TPromise.wrapError(err);
}
// freeze promises after event call
@@ -85,7 +118,7 @@ export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipa
return new TPromise<any[]>((resolve, reject) => {
// join on all listener promises, reject after timeout
const handle = setTimeout(() => reject(new Error('timeout')), this._listenerTimeout);
const handle = setTimeout(() => reject(new Error('timeout')), this._thresholds.timeout);
return always(TPromise.join(promises), () => clearTimeout(handle)).then(resolve, reject);
}).then(values => {
@@ -114,11 +147,7 @@ export class ExtHostDocumentSaveParticipant extends ExtHostDocumentSaveParticipa
}
// TODO@joh bubble this to listener?
return new Error('ignoring change because of concurrent edits');
}, err => {
// soft ignore, turning into result
return err;
return TPromise.wrapError(new Error('concurrent_edits'));
});
}
}