-
Notifications
You must be signed in to change notification settings - Fork 124
feat(react): add element template alog diagnostics #2633
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
145 changes: 145 additions & 0 deletions
145
packages/react/runtime/__test__/element-template/debug/elementPAPICall.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| // Copyright 2026 The Lynx Authors. All rights reserved. | ||
| // Licensed under the Apache License Version 2.0 that can be found in the | ||
| // LICENSE file in the root directory of this source tree. | ||
|
|
||
| import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'; | ||
|
|
||
| import { initElementTemplatePAPICallAlog } from '../../../src/element-template/debug/elementPAPICall.js'; | ||
|
|
||
| describe('ElementTemplate PAPI alog wrapper', () => { | ||
| const originalProfile = globalThis.__PROFILE__; | ||
|
|
||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| globalThis.__PROFILE__ = true; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| globalThis.__PROFILE__ = originalProfile; | ||
| }); | ||
|
|
||
| it('wraps ET PAPI calls and formats native refs', () => { | ||
| const templateRef = { id: 1 }; | ||
| const childRef = { id: 2 }; | ||
| const circular: Record<string, unknown> = {}; | ||
| circular['self'] = circular; | ||
| const jsonUndefined = { toJSON: () => undefined }; | ||
| function namedHandler() {} | ||
| const anonymousHandler = () => {}; | ||
| Object.defineProperty(anonymousHandler, 'name', { value: '' }); | ||
|
|
||
| const target = { | ||
| __CreateElementTemplate: vi.fn(() => templateRef), | ||
| __SetAttributeOfElementTemplate: vi.fn(), | ||
| __InsertNodeToElementTemplate: vi.fn(() => childRef), | ||
| __RemoveNodeFromElementTemplate: vi.fn(() => null), | ||
| __SerializeElementTemplate: vi.fn(() => Symbol.for('serialized')), | ||
| } satisfies Record<string, unknown>; | ||
|
|
||
| initElementTemplatePAPICallAlog(target); | ||
|
|
||
| expect((target.__CreateElementTemplate as (...args: unknown[]) => unknown)( | ||
| '_et_card', | ||
| null, | ||
| ['title'], | ||
| [], | ||
| 17, | ||
| )).toBe(templateRef); | ||
| (target.__SetAttributeOfElementTemplate as (...args: unknown[]) => unknown)( | ||
| templateRef, | ||
| 0, | ||
| [ | ||
| templateRef, | ||
| undefined, | ||
| null, | ||
| namedHandler, | ||
| anonymousHandler, | ||
| Symbol.for('slot'), | ||
| circular, | ||
| jsonUndefined, | ||
| ], | ||
| null, | ||
| ); | ||
| expect((target.__InsertNodeToElementTemplate as (...args: unknown[]) => unknown)( | ||
| templateRef, | ||
| 1, | ||
| childRef, | ||
| undefined, | ||
| )).toBe(childRef); | ||
| expect((target.__RemoveNodeFromElementTemplate as (...args: unknown[]) => unknown)( | ||
| templateRef, | ||
| 1, | ||
| childRef, | ||
| )).toBeNull(); | ||
| expect((target.__SerializeElementTemplate as (...args: unknown[]) => unknown)(templateRef)).toBe( | ||
| Symbol.for('serialized'), | ||
| ); | ||
|
|
||
| const logs = (console.alog as unknown as { mock: { calls: unknown[][] } }).mock.calls | ||
| .map(args => String(args[0])) | ||
| .join('\n'); | ||
| expect(logs).toContain( | ||
| '__CreateElementTemplate("_et_card", null, ["title"], [], 17) => _et_card#17', | ||
| ); | ||
| expect(logs).toContain( | ||
| '__SetAttributeOfElementTemplate(_et_card#17, 0, [_et_card#17, undefined, null, [Function namedHandler], [Function], Symbol(slot), [object Object], [object Object]], null)', | ||
| ); | ||
| expect(logs).toContain( | ||
| '__InsertNodeToElementTemplate(_et_card#17, 1, {"id":2}, undefined) => {"id":2}', | ||
| ); | ||
| expect(logs).toContain('__RemoveNodeFromElementTemplate(_et_card#17, 1, {"id":2})'); | ||
| expect(logs).toContain('__SerializeElementTemplate(_et_card#17) => Symbol(serialized)'); | ||
| expect(globalThis.lynx.performance.profileStart).toHaveBeenCalledTimes(5); | ||
| expect(globalThis.lynx.performance.profileEnd).toHaveBeenCalledTimes(5); | ||
| }); | ||
|
|
||
| it('skips missing APIs and keeps logging optional', () => { | ||
| const originalAlog = console.alog; | ||
| const createElementTemplate = vi.fn(() => null); | ||
| const target = { | ||
| __CreateElementTemplate: createElementTemplate, | ||
| } satisfies Record<string, unknown>; | ||
|
|
||
| globalThis.__PROFILE__ = false; | ||
| console.alog = undefined; | ||
| try { | ||
| initElementTemplatePAPICallAlog(target); | ||
|
|
||
| expect((target.__CreateElementTemplate as (...args: unknown[]) => unknown)( | ||
| '_et_empty', | ||
| null, | ||
| [], | ||
| [], | ||
| 3, | ||
| )).toBeNull(); | ||
| expect(createElementTemplate).toHaveBeenCalledTimes(1); | ||
| expect(globalThis.lynx.performance.profileStart).not.toHaveBeenCalled(); | ||
| expect(globalThis.lynx.performance.profileEnd).not.toHaveBeenCalled(); | ||
| } finally { | ||
| console.alog = originalAlog; | ||
| } | ||
| }); | ||
|
|
||
| it('ends the profile when a wrapped ET PAPI throws', () => { | ||
| const error = new Error('native failed'); | ||
| const target = { | ||
| __CreateElementTemplate: vi.fn(() => { | ||
| throw error; | ||
| }), | ||
| } satisfies Record<string, unknown>; | ||
|
|
||
| initElementTemplatePAPICallAlog(target); | ||
|
|
||
| expect(() => | ||
| (target.__CreateElementTemplate as (...args: unknown[]) => unknown)( | ||
| '_et_error', | ||
| null, | ||
| [], | ||
| [], | ||
| 5, | ||
| ) | ||
| ).toThrow(error); | ||
| expect(globalThis.lynx.performance.profileStart).toHaveBeenCalledTimes(1); | ||
| expect(globalThis.lynx.performance.profileEnd).toHaveBeenCalledTimes(1); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
85 changes: 85 additions & 0 deletions
85
packages/react/runtime/src/element-template/debug/elementPAPICall.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| // Copyright 2025 The Lynx Authors. All rights reserved. | ||
| // Licensed under the Apache License Version 2.0 that can be found in the | ||
| // LICENSE file in the root directory of this source tree. | ||
|
|
||
| import { profileEnd, profileStart } from '../../shared/profile.js'; | ||
|
|
||
| const elementTemplatePAPINameList = [ | ||
| '__CreateElementTemplate', | ||
| '__SetAttributeOfElementTemplate', | ||
| '__InsertNodeToElementTemplate', | ||
| '__RemoveNodeFromElementTemplate', | ||
| '__SerializeElementTemplate', | ||
| ] as const; | ||
|
|
||
| export function initElementTemplatePAPICallAlog(globalWithIndex: Record<string, unknown> = globalThis): void { | ||
| let count = 0; | ||
| const elementTemplateMap = new Map<unknown, string>(); | ||
|
|
||
| for (const elementTemplatePAPIName of elementTemplatePAPINameList) { | ||
| const oldElementTemplatePAPI = globalWithIndex[elementTemplatePAPIName]; | ||
| if (typeof oldElementTemplatePAPI !== 'function') { | ||
| continue; | ||
| } | ||
| const callElementTemplatePAPI = oldElementTemplatePAPI as (...args: unknown[]) => unknown; | ||
|
|
||
| globalWithIndex[elementTemplatePAPIName] = (...args: unknown[]): unknown => { | ||
| const shouldProfile = typeof __PROFILE__ !== 'undefined' && __PROFILE__; | ||
| if (shouldProfile) { | ||
| profileStart(`ElementTemplatePAPI: ${elementTemplatePAPIName}`, { | ||
| args: { | ||
| args: formatValue(args, elementTemplateMap), | ||
| }, | ||
| }); | ||
| } | ||
|
|
||
| let result: unknown; | ||
| try { | ||
| result = callElementTemplatePAPI(...args); | ||
| } finally { | ||
| if (shouldProfile) { | ||
| profileEnd(); | ||
| } | ||
| } | ||
|
|
||
| if (elementTemplatePAPIName === '__CreateElementTemplate' && result != null) { | ||
| elementTemplateMap.set(result, `${String(args[0])}#${String(args[4])}`); | ||
| } | ||
|
|
||
| const formattedResult = result == null ? undefined : formatValue(result, elementTemplateMap); | ||
| console.alog?.( | ||
| `[ReactLynxDebug] ElementTemplate API call #${++count}: ${elementTemplatePAPIName}(${ | ||
| args.map(arg => formatValue(arg, elementTemplateMap)).join(', ') | ||
| })${formattedResult == null ? '' : ` => ${formattedResult}`}`, | ||
| ); | ||
| return result; | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| function formatValue(value: unknown, elementTemplateMap: Map<unknown, string>): string { | ||
| if (elementTemplateMap.has(value)) { | ||
| return elementTemplateMap.get(value)!; | ||
| } | ||
| if (value === undefined) { | ||
| return 'undefined'; | ||
| } | ||
| if (value === null) { | ||
| return 'null'; | ||
| } | ||
| if (Array.isArray(value)) { | ||
| return '[' + value.map(item => formatValue(item, elementTemplateMap)).join(', ') + ']'; | ||
| } | ||
| if (typeof value === 'function') { | ||
| return `[Function${value.name ? ` ${value.name}` : ''}]`; | ||
| } | ||
| if (typeof value === 'symbol') { | ||
| return value.toString(); | ||
| } | ||
| try { | ||
| const formatted = JSON.stringify(value); | ||
| return formatted ?? Object.prototype.toString.call(value); | ||
| } catch { | ||
| return Object.prototype.toString.call(value); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.