Skip to content

Commit 13608f3

Browse files
authored
fix(overlay): traverse non-component wrapper elements in walkAngularTree (#12)
* fix(overlay): traverse non-component wrapper elements in walkAngularTree (#11) * fix(overlay): handle host attribute prefixes, deduplicate roots, and safely serialize signal inputs * fix(overlay): discover prefixed host attributes, add body fallback, and safely serialize signal inputs
1 parent 749911b commit 13608f3

2 files changed

Lines changed: 302 additions & 30 deletions

File tree

Lines changed: 226 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,226 @@
1+
// @vitest-environment jsdom
2+
import { describe, expect, it } from 'vitest';
3+
import {
4+
AngularDebugApi,
5+
ComponentTreeNode,
6+
collectComponentTree,
7+
walkAngularTree,
8+
} from '../overlay.ts';
9+
10+
describe('overlay component tree traversal', () => {
11+
it('traverses direct component children', () => {
12+
document.body.innerHTML = `
13+
<app-root ng-version="19.0.0">
14+
<app-header></app-header>
15+
<app-footer></app-footer>
16+
</app-root>
17+
`;
18+
19+
const componentsMap = new Map<Element, unknown>();
20+
const rootEl = document.querySelector('app-root')!;
21+
const headerEl = document.querySelector('app-header')!;
22+
const footerEl = document.querySelector('app-footer')!;
23+
24+
componentsMap.set(rootEl, { name: 'Root' });
25+
componentsMap.set(headerEl, { name: 'Header' });
26+
componentsMap.set(footerEl, { name: 'Footer' });
27+
28+
const mockNg: AngularDebugApi = {
29+
getComponent: (el: Element) => componentsMap.get(el) ?? null,
30+
};
31+
32+
const nodes: ComponentTreeNode[] = [];
33+
walkAngularTree(rootEl, nodes, mockNg);
34+
35+
expect(nodes.length).toBe(1);
36+
expect(nodes[0].selector).toBe('app-root');
37+
expect(nodes[0].children.map((c) => c.selector)).toEqual(['app-header', 'app-footer']);
38+
});
39+
40+
it('traverses through non-component HTML wrapper elements (fix for #11)', () => {
41+
document.body.innerHTML = `
42+
<app-root ng-version="19.0.0">
43+
<div class="layout-wrapper">
44+
<header>
45+
<app-navbar></app-navbar>
46+
</header>
47+
<main class="content-area">
48+
<section>
49+
<app-product-list></app-product-list>
50+
</section>
51+
</main>
52+
<footer id="main-footer">
53+
<app-footer></app-footer>
54+
</footer>
55+
</div>
56+
</app-root>
57+
`;
58+
59+
const componentsMap = new Map<Element, unknown>();
60+
const rootEl = document.querySelector('app-root')!;
61+
const navEl = document.querySelector('app-navbar')!;
62+
const prodEl = document.querySelector('app-product-list')!;
63+
const footEl = document.querySelector('app-footer')!;
64+
65+
componentsMap.set(rootEl, { name: 'Root' });
66+
componentsMap.set(navEl, { name: 'Navbar' });
67+
componentsMap.set(prodEl, { name: 'ProductList' });
68+
componentsMap.set(footEl, { name: 'Footer' });
69+
70+
const mockNg: AngularDebugApi = {
71+
getComponent: (el: Element) => componentsMap.get(el) ?? null,
72+
};
73+
74+
const nodes: ComponentTreeNode[] = [];
75+
walkAngularTree(rootEl, nodes, mockNg);
76+
77+
expect(nodes.length).toBe(1);
78+
expect(nodes[0].selector).toBe('app-root');
79+
expect(nodes[0].children.map((c) => c.selector)).toEqual([
80+
'app-navbar',
81+
'app-product-list',
82+
'app-footer',
83+
]);
84+
});
85+
86+
it('handles multi-level nested components separated by HTML tags', () => {
87+
document.body.innerHTML = `
88+
<app-root ng-version="19.0.0">
89+
<div class="card">
90+
<app-card>
91+
<div class="card-body">
92+
<app-card-item></app-card-item>
93+
</div>
94+
</app-card>
95+
</div>
96+
</app-root>
97+
`;
98+
99+
const componentsMap = new Map<Element, unknown>();
100+
const rootEl = document.querySelector('app-root')!;
101+
const cardEl = document.querySelector('app-card')!;
102+
const itemEl = document.querySelector('app-card-item')!;
103+
104+
componentsMap.set(rootEl, { name: 'Root' });
105+
componentsMap.set(cardEl, { name: 'Card' });
106+
componentsMap.set(itemEl, { name: 'CardItem' });
107+
108+
const mockNg: AngularDebugApi = {
109+
getComponent: (el: Element) => componentsMap.get(el) ?? null,
110+
};
111+
112+
const nodes: ComponentTreeNode[] = [];
113+
walkAngularTree(rootEl, nodes, mockNg);
114+
115+
expect(nodes.length).toBe(1);
116+
expect(nodes[0].selector).toBe('app-root');
117+
expect(nodes[0].children.length).toBe(1);
118+
expect(nodes[0].children[0].selector).toBe('app-card');
119+
expect(nodes[0].children[0].children.length).toBe(1);
120+
expect(nodes[0].children[0].children[0].selector).toBe('app-card-item');
121+
});
122+
123+
it('collects component tree using global ng when available', () => {
124+
document.body.innerHTML = `
125+
<app-root ng-version="19.0.0">
126+
<div class="wrapper">
127+
<app-sidebar></app-sidebar>
128+
</div>
129+
</app-root>
130+
`;
131+
132+
const componentsMap = new Map<Element, unknown>();
133+
const rootEl = document.querySelector('app-root')!;
134+
const sidebarEl = document.querySelector('app-sidebar')!;
135+
136+
componentsMap.set(rootEl, { name: 'Root' });
137+
componentsMap.set(sidebarEl, { name: 'Sidebar' });
138+
139+
(window as unknown as { ng?: AngularDebugApi }).ng = {
140+
getComponent: (el: Element) => componentsMap.get(el) ?? null,
141+
};
142+
143+
const nodes = collectComponentTree();
144+
expect(nodes.length).toBe(1);
145+
expect(nodes[0].selector).toBe('app-root');
146+
expect(nodes[0].children.map((c) => c.selector)).toEqual(['app-sidebar']);
147+
});
148+
149+
it('deduplicates nested roots and avoids adding nested roots twice', () => {
150+
document.body.innerHTML = `
151+
<app-root ng-version="19.0.0">
152+
<div class="container">
153+
<app-child _nghost-ng-c10></app-child>
154+
</div>
155+
</app-root>
156+
`;
157+
158+
const componentsMap = new Map<Element, unknown>();
159+
const rootEl = document.querySelector('app-root')!;
160+
const childEl = document.querySelector('app-child')!;
161+
162+
componentsMap.set(rootEl, { name: 'Root' });
163+
componentsMap.set(childEl, { name: 'Child' });
164+
165+
(window as unknown as { ng?: AngularDebugApi }).ng = {
166+
getComponent: (el: Element) => componentsMap.get(el) ?? null,
167+
};
168+
169+
const nodes = collectComponentTree();
170+
expect(nodes.length).toBe(1);
171+
expect(nodes[0].selector).toBe('app-root');
172+
expect(nodes[0].children.length).toBe(1);
173+
expect(nodes[0].children[0].selector).toBe('app-child');
174+
});
175+
176+
it('falls back to walking document.body when window.ng is unavailable and roots is empty', () => {
177+
delete (window as unknown as { ng?: AngularDebugApi }).ng;
178+
179+
document.body.innerHTML = `
180+
<custom-widget>
181+
<nested-item></nested-item>
182+
</custom-widget>
183+
`;
184+
185+
const nodes = collectComponentTree();
186+
expect(nodes.length).toBe(1);
187+
expect(nodes[0].selector).toBe('custom-widget');
188+
expect(nodes[0].children.length).toBe(1);
189+
expect(nodes[0].children[0].selector).toBe('nested-item');
190+
});
191+
192+
it('serializes signal results and non-function plain fields in tryGetInputs', () => {
193+
let arbitraryMethodCalled = false;
194+
const signalFn = function signalValueFn() {
195+
return { nested: 'value', count: 10 };
196+
};
197+
198+
const regularMethod = () => {
199+
arbitraryMethodCalled = true;
200+
return 'should-not-run';
201+
};
202+
203+
document.body.innerHTML = `<app-widget ng-version="19.0.0"></app-widget>`;
204+
const widgetEl = document.querySelector('app-widget')!;
205+
206+
const mockComp = {
207+
signalInput: signalFn,
208+
plainObject: { theme: 'dark', active: true },
209+
plainPrimitive: 'hello',
210+
actionMethod: regularMethod,
211+
};
212+
213+
(window as unknown as { ng?: AngularDebugApi }).ng = {
214+
getComponent: (el: Element) => (el === widgetEl ? mockComp : null),
215+
};
216+
217+
const nodes = collectComponentTree();
218+
expect(nodes.length).toBe(1);
219+
expect(nodes[0].inputs).toEqual({
220+
signalInput: { nested: 'value', count: 10 },
221+
plainObject: { theme: 'dark', active: true },
222+
plainPrimitive: 'hello',
223+
});
224+
expect(arbitraryMethodCalled).toBe(false);
225+
});
226+
});

‎packages/ng-devtools/src/overlay.ts‎

Lines changed: 76 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -63,54 +63,84 @@ export async function initOverlay(options: { baseURL?: string | string[] } = {})
6363
};
6464
}
6565

66-
function collectComponentTree() {
66+
export interface AngularDebugApi {
67+
getComponent(el: Element): unknown;
68+
getInjector?(el: Element): unknown;
69+
ɵgetSignalGraph?(injector: unknown): unknown;
70+
}
71+
72+
function findAngularElements(): Element[] {
73+
const versionEls = Array.from(document.querySelectorAll('[ng-version]'));
74+
const allEls = Array.from(document.querySelectorAll('*'));
75+
const hostEls = allEls.filter((el) =>
76+
Array.from(el.attributes).some((a) => a.name.startsWith('_nghost')),
77+
);
78+
return Array.from(new Set([...versionEls, ...hostEls]));
79+
}
80+
81+
export function collectComponentTree() {
6782
const nodes: ComponentTreeNode[] = [];
68-
const roots = document.querySelectorAll('[ng-version], [_nghost-ng-c]');
83+
const allRoots = findAngularElements();
84+
const roots = allRoots.filter(
85+
(root) => !allRoots.some((other) => other !== root && other.contains(root)),
86+
);
6987

7088
// Use Angular's debug utilities if available
71-
const ng = (window as any).ng;
89+
const ng = (window as unknown as { ng?: AngularDebugApi }).ng;
7290
if (ng?.getComponent) {
73-
for (const root of roots) {
74-
walkAngularTree(root, nodes, ng);
91+
if (roots.length > 0) {
92+
for (const root of roots) {
93+
walkAngularTree(root, nodes, ng);
94+
}
95+
} else if (typeof document !== 'undefined' && document.body) {
96+
walkAngularTree(document.body, nodes, ng);
7597
}
7698
} else {
7799
// Fallback: walk DOM for Angular component host elements
78-
walkDom(document.body, nodes);
100+
if (typeof document !== 'undefined' && document.body) {
101+
walkDom(document.body, nodes);
102+
}
79103
}
80104

81105
return nodes;
82106
}
83107

84-
interface ComponentTreeNode {
108+
export interface ComponentTreeNode {
85109
id: string;
86110
selector: string;
87111
tagName: string;
88112
children: ComponentTreeNode[];
89113
inputs?: Record<string, unknown>;
90114
}
91115

92-
function walkAngularTree(el: Element, out: ComponentTreeNode[], ng: any) {
116+
export function walkAngularTree(el: Element, out: ComponentTreeNode[], ng: AngularDebugApi) {
93117
const component = ng.getComponent(el);
94-
if (!component) return;
95-
96-
const node: ComponentTreeNode = {
97-
id: generateId(el),
98-
selector: el.tagName.toLowerCase(),
99-
tagName: el.tagName.toLowerCase(),
100-
children: [],
101-
inputs: tryGetInputs(component),
102-
};
103118

104-
for (const child of el.querySelectorAll(':scope > *')) {
105-
walkAngularTree(child, node.children, ng);
106-
}
119+
if (component) {
120+
const node: ComponentTreeNode = {
121+
id: generateId(el),
122+
selector: el.tagName.toLowerCase(),
123+
tagName: el.tagName.toLowerCase(),
124+
children: [],
125+
inputs: tryGetInputs(component),
126+
};
107127

108-
out.push(node);
128+
for (const child of el.children) {
129+
walkAngularTree(child, node.children, ng);
130+
}
131+
132+
out.push(node);
133+
} else {
134+
for (const child of el.children) {
135+
walkAngularTree(child, out, ng);
136+
}
137+
}
109138
}
110139

111140
function walkDom(el: Element, out: ComponentTreeNode[]) {
112141
const tagName = el.tagName.toLowerCase();
113-
const isComponent = tagName.includes('-') || el.hasAttribute('_nghost-ng-c');
142+
const isComponent =
143+
tagName.includes('-') || Array.from(el.attributes).some((a) => a.name.startsWith('_nghost'));
114144

115145
if (isComponent) {
116146
const node: ComponentTreeNode = {
@@ -130,15 +160,28 @@ function walkDom(el: Element, out: ComponentTreeNode[]) {
130160
}
131161
}
132162

133-
function tryGetInputs(component: any): Record<string, unknown> | undefined {
163+
function isSignal(val: unknown): val is () => unknown {
164+
if (typeof val !== 'function') return false;
165+
if (val.name === 'signalValueFn') return true;
166+
const symbols = Object.getOwnPropertySymbols(val);
167+
return symbols.some((s) => s.description === 'SIGNAL' || s.toString().includes('SIGNAL'));
168+
}
169+
170+
function tryGetInputs(component: unknown): Record<string, unknown> | undefined {
171+
if (!component || typeof component !== 'object') return undefined;
134172
try {
135173
const inputs: Record<string, unknown> = {};
136-
for (const key of Object.keys(component)) {
137-
const val = component[key];
138-
if (typeof val === 'function' && val.name === 'signalValueFn') {
139-
inputs[key] = val();
174+
const comp = component as Record<string, unknown>;
175+
for (const key of Object.keys(comp)) {
176+
const val = comp[key];
177+
if (isSignal(val)) {
178+
try {
179+
inputs[key] = serializeValue(val());
180+
} catch {
181+
// skip
182+
}
140183
} else if (typeof val !== 'function') {
141-
inputs[key] = val;
184+
inputs[key] = serializeValue(val);
142185
}
143186
}
144187
return Object.keys(inputs).length > 0 ? inputs : undefined;
@@ -532,8 +575,11 @@ function safeSerialize(val: unknown): unknown {
532575
}
533576
}
534577

535-
// Auto-init when loaded as a script
536-
if (typeof document !== 'undefined') {
578+
// Auto-init when loaded as a script (skip during test environment)
579+
if (
580+
typeof document !== 'undefined' &&
581+
!(typeof process !== 'undefined' && process.env?.['VITEST'])
582+
) {
537583
initOverlay().catch(console.error);
538584
import('./popup.ts').then((m) => m.createDevtoolsPopup()).catch(console.error);
539585
}

0 commit comments

Comments
 (0)