angular/devtools/projects/shell-browser/src/app/chrome-window-extensions.ts
Milo 6f16d92988 feat(devtools): inspect signals (#61540)
add a new global api for the devtools connector to jump to the source of
a computed or effect

PR Close #61540
2025-06-02 09:35:30 -04:00

127 lines
4.1 KiB
TypeScript

/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.dev/license
*/
import {RoutePropertyType, viewSourceFromRouter} from '../../../ng-devtools-backend';
import {
buildDirectiveForest,
getInjectorFromElementNode,
findNodeFromSerializedPosition,
queryDirectiveForest,
} from '../../../ng-devtools-backend/src/lib/component-tree/component-tree';
import {ElementPosition, SignalNodePosition} from '../../../protocol';
import {ngDebugClient} from '../../../ng-devtools-backend/src/lib/ng-debug-api/ng-debug-api';
export const initializeExtendedWindowOperations = () => {
extendWindowOperations(globalThis, {inspectedApplication: chromeWindowExtensions});
};
const extendWindowOperations = <T extends {}>(target: any, classImpl: T) => {
for (const key of Object.keys(classImpl)) {
if (target[key] != null) {
console.warn(`A window function or object named ${key} would be overwritten`);
}
}
Object.assign(target, classImpl);
};
const chromeWindowExtensions = {
findConstructorByPosition: (
serializedId: string,
directiveIndex: number,
): Element | undefined => {
const node = findNodeFromSerializedPosition(serializedId);
if (node === null) {
console.error(`Cannot find element associated with node ${serializedId}`);
return;
}
if (directiveIndex !== undefined) {
if (node.directives[directiveIndex]) {
return node.directives[directiveIndex].instance.constructor;
} else {
console.error(
`Could not find the directive in the current node at index ${directiveIndex}`,
);
return;
}
}
if (node.component) {
return node.component.instance.constructor;
} else {
console.error('This component has no instance and therefore no constructor');
return;
}
},
findDomElementByPosition: (serializedId: string): Node | undefined => {
const node = findNodeFromSerializedPosition(serializedId);
if (node === null) {
console.error(`Cannot find element associated with node ${serializedId}`);
return undefined;
}
return node.nativeElement;
},
findSignalNodeByPosition: (args: any): any => {
const ng = ngDebugClient();
const {element, signalId} = JSON.parse(args) as SignalNodePosition;
const node = queryDirectiveForest(element, buildDirectiveForest());
if (node === null) {
console.error(`Cannot find element associated with node ${element}`);
return undefined;
}
const injector = getInjectorFromElementNode(node.nativeElement!);
if (!injector) {
return;
}
const graph = ng.ɵgetSignalGraph?.(injector);
if (!graph) {
return;
}
const signal = graph.nodes.find((node) => node.id === signalId);
if (!signal) {
return;
}
return signal.debuggableFn;
},
findPropertyByPosition: (args: any): any => {
const {directivePosition, objectPath} = JSON.parse(args) as {
directivePosition: {element: ElementPosition; directive: number};
objectPath: string[];
};
const node = queryDirectiveForest(directivePosition.element, buildDirectiveForest());
if (node === null) {
console.error(`Cannot find element associated with node ${directivePosition}`);
return undefined;
}
const isDirective =
directivePosition.directive !== undefined &&
node.directives[directivePosition.directive] &&
typeof node.directives[directivePosition.directive] === 'object';
if (isDirective) {
return traverseDirective(node.directives[directivePosition.directive].instance, objectPath);
}
if (node.component) {
return traverseDirective(node.component.instance, objectPath);
}
},
findConstructorByNameForRouter: (name: string, type: RoutePropertyType): any => {
return viewSourceFromRouter(name, type);
},
};
const traverseDirective = (dir: any, objectPath: string[]): any => {
for (const key of objectPath) {
if (!dir[key]) {
return;
}
dir = dir[key];
}
return dir;
};