development/vscode
development/vscode
1
0
Fork 0
mirror of https://github.com/Microsoft/vscode synced 2024-08-28 13:29:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

add TRACE_LIKEY_SNAPSHOT_LEAKAGE flag to trace leakage

Browse source
This commit is contained in:
Johannes Rieken 2022-02-11 15:01:10 +01:00
parent db9a43608a
commit 854309e8f2
No known key found for this signature in database
GPG key ID: 96634B5AF12F8798
1 changed files with 19 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
src/vs/base/common/event.ts
View file

@ -10,6 +10,9 @@ import { combinedDisposable, Disposable, DisposableStore, IDisposable, toDisposa
import { LinkedList } from 'vs/base/common/linkedList';
import { StopWatch } from 'vs/base/common/stopwatch';
let TRACE_LIKEY_SNAPSHOT_LEAKAGE = false;
// TRACE_LIKEY_SNAPSHOT_LEAKAGE = Boolean("true"); // causes an ESLint warning so that this isn't pushed by accident
/**
* To an event a function with one or zero parameters
* can be subscribed. The event is the subscriber function itself.
@ -111,23 +114,29 @@ export namespace Event {
}
function snapshot<T>(event: Event<T>, disposable: DisposableStore | undefined): Event<T> {
let stack = Stacktrace.create();
let count = 0;
let listener: IDisposable;
const emitter = new Emitter<T>({
const options: EmitterOptions | undefined = {
onFirstListenerAdd() {
listener = event(emitter.fire, emitter);
},
onListenerDidAdd() {
if (++count === 2) {
console.warn('snapshotted emitter LIKELY used public and SHOULD HAVE BEEN created with DisposableStore. snapshotted here');
stack.print();
}
},
onLastListenerRemove() {
listener.dispose();
}
});
};
if (TRACE_LIKEY_SNAPSHOT_LEAKAGE) {
let stack = Stacktrace.create();
let count = 0;
options.onListenerDidAdd = () => {
if (++count === 2) {
console.warn('snapshotted emitter LIKELY used public and SHOULD HAVE BEEN created with DisposableStore. snapshotted here');
stack.print();
}
};
}
const emitter = new Emitter<T>(options);
if (disposable) {
disposable.add(emitter);