Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(trace viewer): create injected/recorder in snapshots lazily (#35835)

Dmitry Gozman9c4ea2152956
diff --git a/packages/trace-viewer/src/ui/snapshotTab.tsx b/packages/trace-viewer/src/ui/snapshotTab.tsx
index 5ee699868c..77c25164b9 100644
--- a/packages/trace-viewer/src/ui/snapshotTab.tsx
+++ b/packages/trace-viewer/src/ui/snapshotTab.tsx
@@ -235,16 +235,20 @@ export const InspectModeController: React.FunctionComponent<{
iteration: number,
}> = ({ iframe, isInspecting, sdkLanguage, testIdAttributeName, highlightedElement, setHighlightedElement, iteration }) => {
React.useEffect(() => {
+ const highlightedAriaSnapshot = highlightedElement.lastEdited === 'ariaSnapshot' ? highlightedElement.ariaSnapshot : undefined;
+ const highlightedLocator = highlightedElement.lastEdited === 'locator' ? highlightedElement.locator : undefined;
+ const forceRecorders = !!highlightedAriaSnapshot || !!highlightedLocator || isInspecting;
+
const recorders: { recorder: Recorder, frameSelector: string }[] = [];
const isUnderTest = new URLSearchParams(window.location.search).get('isUnderTest') === 'true';
try {
- createRecorders(recorders, sdkLanguage, testIdAttributeName, isUnderTest, '', iframe?.contentWindow);
+ createRecorders(recorders, forceRecorders, sdkLanguage, testIdAttributeName, isUnderTest, '', iframe?.contentWindow);
} catch {
// Potential cross-origin exceptions.
}
- const parsedSnapshot = highlightedElement.lastEdited === 'ariaSnapshot' && highlightedElement.ariaSnapshot ? parseAriaSnapshot(yaml, highlightedElement.ariaSnapshot) : undefined;
- const fullSelector = highlightedElement.lastEdited === 'locator' && highlightedElement.locator ? locatorOrSelectorAsSelector(sdkLanguage, highlightedElement.locator, testIdAttributeName) : undefined;
+ const parsedSnapshot = highlightedAriaSnapshot ? parseAriaSnapshot(yaml, highlightedAriaSnapshot) : undefined;
+ const fullSelector = highlightedLocator ? locatorOrSelectorAsSelector(sdkLanguage, highlightedLocator, testIdAttributeName) : undefined;
for (const { recorder, frameSelector } of recorders) {
const actionSelector = fullSelector?.startsWith(frameSelector) ? fullSelector.substring(frameSelector.length).trim() : undefined;
const ariaTemplate = parsedSnapshot?.errors.length === 0 ? parsedSnapshot.fragment : undefined;
@@ -275,11 +279,11 @@ export const InspectModeController: React.FunctionComponent<{
return <></>;
};
-function createRecorders(recorders: { recorder: Recorder, frameSelector: string }[], sdkLanguage: Language, testIdAttributeName: string, isUnderTest: boolean, parentFrameSelector: string, frameWindow: Window | null | undefined) {
+function createRecorders(recorders: { recorder: Recorder, frameSelector: string }[], force: boolean, sdkLanguage: Language, testIdAttributeName: string, isUnderTest: boolean, parentFrameSelector: string, frameWindow: Window | null | undefined) {
if (!frameWindow)
return;
const win = frameWindow as any;
- if (!win._recorder) {
+ if (!win._recorder && force) {
const injectedScript = new InjectedScript(frameWindow as any, { isUnderTest, sdkLanguage, testIdAttributeName, stableRafCount: 1, browserName: 'chromium', inputFileRoleTextbox: false, customEngines: [] });
const recorder = new Recorder(injectedScript);
win._injectedScript = injectedScript;
@@ -289,12 +293,13 @@ function createRecorders(recorders: { recorder: Recorder, frameSelector: string
(window as any)._weakRecordersForTest.add(new WeakRef(recorder));
}
}
- recorders.push(win._recorder);
+ if (win._recorder)
+ recorders.push(win._recorder);
for (let i = 0; i < frameWindow.frames.length; ++i) {
const childFrame = frameWindow.frames[i];
const frameSelector = childFrame.frameElement ? win._injectedScript.generateSelectorSimple(childFrame.frameElement, { omitInternalEngines: true, testIdAttributeName }) + ' >> internal:control=enter-frame >> ' : '';
- createRecorders(recorders, sdkLanguage, testIdAttributeName, isUnderTest, parentFrameSelector + frameSelector, childFrame);
+ createRecorders(recorders, force, sdkLanguage, testIdAttributeName, isUnderTest, parentFrameSelector + frameSelector, childFrame);
}
}
diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.ts
index 039d9cbc05..18ed101e64 100644
--- a/tests/library/trace-viewer.spec.ts
+++ b/tests/library/trace-viewer.spec.ts
@@ -1561,7 +1561,7 @@ test('should show baseURL in metadata pane', {
test('should not leak recorders', {
annotation: { type: 'issue', description: 'https://github.com/microsoft/playwright/issues/33086' },
-}, async ({ showTraceViewer }) => {
+}, async ({ showTraceViewer, platform }) => {
const traceViewer = await showTraceViewer([traceFile]);
const aliveCount = async () => {
@@ -1573,24 +1573,45 @@ test('should not leak recorders', {
});
};
+ await traceViewer.page.getByRole('tab', { name: 'Locator' }).click();
+
+ const forceRecorder = async (action: string) => {
+ const frame = await traceViewer.snapshotFrame(action);
+
+ await test.step(`highlighting "body" in "${action}"`, async () => {
+ await traceViewer.page.locator('.CodeMirror').first().click();
+ if (platform === 'darwin')
+ await traceViewer.page.keyboard.press('Meta+a');
+ else
+ await traceViewer.page.keyboard.press('Control+a');
+ await traceViewer.page.keyboard.press('Backspace');
+
+ await expect(frame.locator('x-pw-highlight')).not.toBeVisible();
+ await traceViewer.page.keyboard.type('body');
+ await expect(frame.locator('x-pw-highlight')).toBeVisible();
+ });
+
+ return frame;
+ };
+
await expect(traceViewer.snapshotContainer.contentFrame().locator('body')).toContainText(`Hi, I'm frame`);
- const frame1 = await traceViewer.snapshotFrame('page.goto');
+ const frame1 = await forceRecorder('page.goto');
await expect(frame1.locator('body')).toContainText('Hello world');
- const frame2 = await traceViewer.snapshotFrame('page.evaluate');
+ const frame2 = await forceRecorder('page.evaluate');
await expect(frame2.locator('button')).toBeVisible();
await traceViewer.page.requestGC();
await expect.poll(() => aliveCount()).toBeLessThanOrEqual(2); // two snapshot iframes
- const frame3 = await traceViewer.snapshotFrame('page.setViewportSize');
+ const frame3 = await forceRecorder('page.setViewportSize');
await expect(frame3.locator('body')).toContainText(`Hi, I'm frame`);
- const frame4 = await traceViewer.snapshotFrame('page.goto');
+ const frame4 = await forceRecorder('page.goto');
await expect(frame4.locator('body')).toContainText('Hello world');
- const frame5 = await traceViewer.snapshotFrame('page.evaluate');
+ const frame5 = await forceRecorder('page.evaluate');
await expect(frame5.locator('button')).toBeVisible();
await traceViewer.page.requestGC();