src/vs/base/common/observableInternal/changeTracker.ts
98 LOC · 61 covered · 37 uncovered · 4 ranges · 6771 concepts · 2 introducers · 3467 tests
File neighbourhood
The centred file is linked to every concept that introduces one of its ranges, every test that runs code from the file, and the gray connector concepts standing between those tests and the file's own introducer concepts. Undirected links join concepts to every file where they introduce source and concepts to the tests they introduce; arrows show specialization between the displayed concepts and bridge only concepts omitted from this view. Concept colors match the source ranges below; connector concepts have no source color and are shown in gray.
Focused file, its introducer and connector concepts, their introduced files, and tests that run code from the file
In the embedded map, ordinary wheel input scrolls the page; use the visible controls to zoom and drag to pan. Open the full-screen map for canvas navigation: wheel pans, Ctrl/Command plus wheel zooms, and arrow keys pan when this region is focused. On touch screens, open the full-screen map to pan or pinch. If JavaScript or WebGL is unavailable, use the related-file, concept, and source links on this page.
Graph controls are ready.
Interactive rendering requires JavaScript and WebGL. Use the related-file, concept, and source links on this page while the interactive map is unavailable.
/*---------------------------------------------------------------------------------------------
devToolsLogger.ts ×24
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { BugIndicatingError } from './commonFacade/deps.js';
import { IObservableWithChange, IReader } from './base.js';
export interface IChangeTracker<TChangeSummary> {
createChangeSummary(previousChangeSummary: TChangeSummary | undefined): TChangeSummary;
handleChange(ctx: IChangeContext, change: TChangeSummary): boolean;
beforeUpdate?(reader: IReader, change: TChangeSummary): void;
}
export interface IChangeContext {
readonly changedObservable: IObservableWithChange<any, any>;
readonly change: unknown;
/**
* Returns if the given observable caused the change.
*/
didChange<T, TChange>(observable: IObservableWithChange<T, TChange>): this is { change: TChange };
}
/**
* Subscribes to and records changes and the last value of the given observables.
* Don't use the key "changes", as it is reserved for the changes array!
*/
export function recordChanges<TObs extends Record<any, IObservableWithChange<any, any>>>(obs: TObs):
& { changes: readonly ({ [TKey in keyof TObs]: { key: TKey; change: TObs[TKey]['TChange'] } }[keyof TObs])[] }> {
return {
createChangeSummary: (_previousChangeSummary) => {
// eslint-disable-next-line local/code-no-any-casts
return {
changes: [],
} as any;
},
handleChange(ctx, changeSummary) {
for (const key in obs) {
if (ctx.didChange(obs[key])) {
// eslint-disable-next-line local/code-no-any-casts
(changeSummary.changes as any).push({ key, change: ctx.change });
}
}
return true;
},
beforeUpdate(reader, changeSummary) {
for (const key in obs) {
if (key === 'changes') {
throw new BugIndicatingError('property name "changes" is reserved for change tracking');
}
}
}
};
}
/**
* Subscribes to and records changes and the last value of the given observables.
* Don't use the key "changes", as it is reserved for the changes array!
*/
export function recordChangesLazy<TObs extends Record<any, IObservableWithChange<any, any>>>(getObs: () => TObs):
IChangeTracker<{ [TKey in keyof TObs]: ReturnType<TObs[TKey]['get']> }
& { changes: readonly ({ [TKey in keyof TObs]: { key: TKey; change: TObs[TKey]['TChange'] } }[keyof TObs])[] }> {
let obs: TObs | undefined = undefined;
return {
createChangeSummary: (_previousChangeSummary) => {
// eslint-disable-next-line local/code-no-any-casts
return {
changes: [],
} as any;
},
handleChange(ctx, changeSummary) {
if (!obs) {
obs = getObs();
}
for (const key in obs) {
if (ctx.didChange(obs[key])) {
// eslint-disable-next-line local/code-no-any-casts
(changeSummary.changes as any).push({ key, change: ctx.change });
}
}
return true;
},
beforeUpdate(reader, changeSummary) {
if (!obs) {
obs = getObs();
}
for (const key in obs) {
if (key === 'changes') {
throw new BugIndicatingError('property name "changes" is reserved for change tracking');
}
changeSummary[key] = obs[key].read(reader);
}
}
};
}