From 86b8761dd5daf3295299faef160d6e0d5eac0873 Mon Sep 17 00:00:00 2001 From: Dmitry Gozman Date: Tue, 21 May 2024 08:41:57 -0700 Subject: [PATCH] chore: move artifacts recording to TestLifecycleInstrumentation --- .../playwright-core/src/client/tracing.ts | 13 +- packages/playwright/src/common/globals.ts | 16 ++ packages/playwright/src/index.ts | 158 ++++++++++-------- packages/playwright/src/worker/testInfo.ts | 1 - packages/playwright/src/worker/workerMain.ts | 14 +- tests/config/testModeFixtures.ts | 3 +- .../playwright.artifacts.spec.ts | 3 - .../playwright-test/playwright.trace.spec.ts | 96 ++++++++++- 8 files changed, 219 insertions(+), 85 deletions(-) diff --git a/packages/playwright-core/src/client/tracing.ts b/packages/playwright-core/src/client/tracing.ts index 7330cd9f26..187e1980b3 100644 --- a/packages/playwright-core/src/client/tracing.ts +++ b/packages/playwright-core/src/client/tracing.ts @@ -34,8 +34,8 @@ export class Tracing extends ChannelOwner implements ap } async start(options: { name?: string, title?: string, snapshots?: boolean, screenshots?: boolean, sources?: boolean, _live?: boolean } = {}) { - this._includeSources = !!options.sources; - const traceName = await this._wrapApiCall(async () => { + await this._wrapApiCall(async () => { + this._includeSources = !!options.sources; await this._channel.tracingStart({ name: options.name, snapshots: options.snapshots, @@ -43,14 +43,15 @@ export class Tracing extends ChannelOwner implements ap live: options._live, }); const response = await this._channel.tracingStartChunk({ name: options.name, title: options.title }); - return response.traceName; + await this._startCollectingStacks(response.traceName); }, true); - await this._startCollectingStacks(traceName); } async startChunk(options: { name?: string, title?: string } = {}) { - const { traceName } = await this._channel.tracingStartChunk(options); - await this._startCollectingStacks(traceName); + await this._wrapApiCall(async () => { + const { traceName } = await this._channel.tracingStartChunk(options); + await this._startCollectingStacks(traceName); + }, true); } private async _startCollectingStacks(traceName: string) { diff --git a/packages/playwright/src/common/globals.ts b/packages/playwright/src/common/globals.ts index 746e1ec847..5b7abef1a9 100644 --- a/packages/playwright/src/common/globals.ts +++ b/packages/playwright/src/common/globals.ts @@ -42,3 +42,19 @@ export function setIsWorkerProcess() { export function isWorkerProcess() { return _isWorkerProcess; } + +export interface TestLifecycleInstrumentation { + onTestBegin?(): Promise; + onTestFunctionEnd?(): Promise; + onTestEnd?(): Promise; +} + +let _testLifecycleInstrumentation: TestLifecycleInstrumentation | undefined; + +export function setTestLifecycleInstrumentation(instrumentation: TestLifecycleInstrumentation | undefined) { + _testLifecycleInstrumentation = instrumentation; +} + +export function testLifecycleInstrumentation() { + return _testLifecycleInstrumentation; +} diff --git a/packages/playwright/src/index.ts b/packages/playwright/src/index.ts index c196dc2d2f..daf878120b 100644 --- a/packages/playwright/src/index.ts +++ b/packages/playwright/src/index.ts @@ -16,15 +16,14 @@ import * as fs from 'fs'; import * as path from 'path'; -import type { APIRequestContext, BrowserContext, Browser, BrowserContextOptions, LaunchOptions, Page, Tracing, Video } from 'playwright-core'; -import * as playwrightLibrary from 'playwright-core'; +import type { APIRequestContext, BrowserContext, Browser, BrowserContextOptions, LaunchOptions, Page, Tracing, Video, PageScreenshotOptions } from 'playwright-core'; import { createGuid, debugMode, addInternalStackPrefix, isString, asLocator, jsonStringifyForceASCII } from 'playwright-core/lib/utils'; import type { Fixtures, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, ScreenshotMode, TestInfo, TestType, VideoMode } from '../types/test'; import type { TestInfoImpl } from './worker/testInfo'; import { rootTestType } from './common/testType'; import type { ContextReuseMode } from './common/config'; import type { ClientInstrumentation, ClientInstrumentationListener } from '../../playwright-core/src/client/clientInstrumentation'; -import { currentTestInfo } from './common/globals'; +import { currentTestInfo, setTestLifecycleInstrumentation, type TestLifecycleInstrumentation } from './common/globals'; export { expect } from './matchers/expect'; export const _baseTest: TestType<{}, {}> = rootTestType.test; @@ -45,23 +44,99 @@ if ((process as any)['__pw_initiator__']) { type TestFixtures = PlaywrightTestArgs & PlaywrightTestOptions & { _combinedContextOptions: BrowserContextOptions, _setupContextOptions: void; - _setupArtifacts: void; _contextFactory: (options?: BrowserContextOptions) => Promise; }; type WorkerFixtures = PlaywrightWorkerArgs & PlaywrightWorkerOptions & { + _playwrightImpl: PlaywrightWorkerArgs['playwright']; _browserOptions: LaunchOptions; _optionContextReuseMode: ContextReuseMode, _optionConnectOptions: PlaywrightWorkerOptions['connectOptions'], _reuseContext: boolean, }; +let artifactsRecorder: ArtifactsRecorder | undefined; + const playwrightFixtures: Fixtures = ({ defaultBrowserType: ['chromium', { scope: 'worker', option: true }], browserName: [({ defaultBrowserType }, use) => use(defaultBrowserType), { scope: 'worker', option: true }], - playwright: [async ({}, use) => { - await use(require('playwright-core')); + _playwrightImpl: [({}, use) => use(require('playwright-core')), { scope: 'worker' }], + + playwright: [async ({ _playwrightImpl }, use) => { + const instrumentation: TestLifecycleInstrumentation = { + onTestBegin: async () => { + artifactsRecorder = new ArtifactsRecorder(_playwrightImpl, tracing().artifactsDir()); + await artifactsRecorder.willStartTest(currentTestInfo() as TestInfoImpl); + }, + onTestFunctionEnd: async () => { + await artifactsRecorder?.didFinishTestFunction(); + }, + onTestEnd: async () => { + await artifactsRecorder?.didFinishTest(); + artifactsRecorder = undefined; + }, + }; + setTestLifecycleInstrumentation(instrumentation); + + const csiListener: ClientInstrumentationListener = { + onApiCallBegin: (apiName: string, params: Record, frames: StackFrame[], userData: any, out: { stepId?: string }) => { + const testInfo = currentTestInfo(); + if (!testInfo || apiName.includes('setTestIdAttribute')) + return { userObject: null }; + const step = testInfo._addStep({ + location: frames[0] as any, + category: 'pw:api', + title: renderApiCall(apiName, params), + apiName, + params, + }); + userData.userObject = step; + out.stepId = step.stepId; + }, + onApiCallEnd: (userData: any, error?: Error) => { + const step = userData.userObject; + step?.complete({ error }); + }, + onWillPause: () => { + currentTestInfo()?.setTimeout(0); + }, + runAfterCreateBrowserContext: async (context: BrowserContext) => { + await artifactsRecorder?.didCreateBrowserContext(context); + const testInfo = currentTestInfo(); + if (testInfo) + attachConnectedHeaderIfNeeded(testInfo, context.browser()); + }, + runAfterCreateRequestContext: async (context: APIRequestContext) => { + await artifactsRecorder?.didCreateRequestContext(context); + }, + runBeforeCloseBrowserContext: async (context: BrowserContext) => { + await artifactsRecorder?.willCloseBrowserContext(context); + }, + runBeforeCloseRequestContext: async (context: APIRequestContext) => { + await artifactsRecorder?.willCloseRequestContext(context); + }, + }; + + const clientInstrumentation = (_playwrightImpl as any)._instrumentation as ClientInstrumentation; + clientInstrumentation.addListener(csiListener); + + if (currentTestInfo()) { + // Setup of this fixture happens after the first test starts. + await instrumentation.onTestBegin?.(); + } + + await use(_playwrightImpl); + + if (currentTestInfo()) { + // Teardown of this fixture might happen right before the failing test ends + // as a part of worker cleanup. + await instrumentation.onTestEnd?.(); + } + + setTestLifecycleInstrumentation(undefined); + clientInstrumentation.removeListener(csiListener); }, { scope: 'worker', _hideStep: true } as any], + headless: [({ launchOptions }, use) => use(launchOptions.headless ?? true), { scope: 'worker', option: true }], channel: [({ launchOptions }, use) => use(launchOptions.channel), { scope: 'worker', option: true }], launchOptions: [{}, { scope: 'worker', option: true }], @@ -220,9 +295,9 @@ const playwrightFixtures: Fixtures = ({ }); }, - _setupContextOptions: [async ({ playwright, _combinedContextOptions, actionTimeout, navigationTimeout, testIdAttribute }, use, testInfo) => { + _setupContextOptions: [async ({ playwright, _combinedContextOptions, actionTimeout, navigationTimeout, testIdAttribute, screenshot }, use, testInfo) => { if (testIdAttribute) - playwrightLibrary.selectors.setTestIdAttribute(testIdAttribute); + playwright.selectors.setTestIdAttribute(testIdAttribute); testInfo.snapshotSuffix = process.platform; if (debugMode()) testInfo.setTimeout(0); @@ -234,6 +309,7 @@ const playwrightFixtures: Fixtures = ({ (playwright.request as any)._defaultContextOptions = { ..._combinedContextOptions }; (playwright.request as any)._defaultContextOptions.tracesDir = tracing().tracesDir(); (playwright.request as any)._defaultContextOptions.timeout = actionTimeout || 0; + artifactsRecorder?.setScreenshotOption(screenshot); await use(); (playwright.request as any)._defaultContextOptions = undefined; for (const browserType of [playwright.chromium, playwright.firefox, playwright.webkit]) { @@ -243,58 +319,6 @@ const playwrightFixtures: Fixtures = ({ } }, { auto: 'all-hooks-included', _title: 'context configuration' } as any], - _setupArtifacts: [async ({ playwright, screenshot }, use, testInfo) => { - const artifactsRecorder = new ArtifactsRecorder(playwright, tracing().artifactsDir(), screenshot); - await artifactsRecorder.willStartTest(testInfo as TestInfoImpl); - const csiListener: ClientInstrumentationListener = { - onApiCallBegin: (apiName: string, params: Record, frames: StackFrame[], userData: any, out: { stepId?: string }) => { - const testInfo = currentTestInfo(); - if (!testInfo || apiName.includes('setTestIdAttribute')) - return { userObject: null }; - const step = testInfo._addStep({ - location: frames[0] as any, - category: 'pw:api', - title: renderApiCall(apiName, params), - apiName, - params, - }); - userData.userObject = step; - out.stepId = step.stepId; - }, - onApiCallEnd: (userData: any, error?: Error) => { - const step = userData.userObject; - step?.complete({ error }); - }, - onWillPause: () => { - currentTestInfo()?.setTimeout(0); - }, - runAfterCreateBrowserContext: async (context: BrowserContext) => { - await artifactsRecorder?.didCreateBrowserContext(context); - const testInfo = currentTestInfo(); - if (testInfo) - attachConnectedHeaderIfNeeded(testInfo, context.browser()); - }, - runAfterCreateRequestContext: async (context: APIRequestContext) => { - await artifactsRecorder?.didCreateRequestContext(context); - }, - runBeforeCloseBrowserContext: async (context: BrowserContext) => { - await artifactsRecorder?.willCloseBrowserContext(context); - }, - runBeforeCloseRequestContext: async (context: APIRequestContext) => { - await artifactsRecorder?.willCloseRequestContext(context); - }, - }; - - const clientInstrumentation = (playwright as any)._instrumentation as ClientInstrumentation; - clientInstrumentation.addListener(csiListener); - - await use(); - - clientInstrumentation.removeListener(csiListener); - await artifactsRecorder.didFinishTest(); - - }, { auto: 'all-hooks-included', _title: 'trace recording' } as any], - _contextFactory: [async ({ browser, video, _reuseContext }, use, testInfo) => { const testInfoImpl = testInfo as TestInfoImpl; const videoMode = normalizeVideoMode(video); @@ -470,8 +494,8 @@ class ArtifactsRecorder { private _testInfo!: TestInfoImpl; private _playwright: Playwright; private _artifactsDir: string; - private _screenshotMode: ScreenshotMode; - private _screenshotOptions: { mode: ScreenshotMode } & Pick | undefined; + private _screenshotMode: ScreenshotMode = 'off'; + private _screenshotOptions: { mode: ScreenshotMode } & Pick | undefined; private _temporaryScreenshots: string[] = []; private _temporaryArtifacts: string[] = []; private _reusedContexts = new Set(); @@ -479,15 +503,18 @@ class ArtifactsRecorder { private _screenshottedSymbol: symbol; private _startedCollectingArtifacts: symbol; - constructor(playwright: Playwright, artifactsDir: string, screenshot: ScreenshotOption) { + constructor(playwright: Playwright, artifactsDir: string) { this._playwright = playwright; this._artifactsDir = artifactsDir; - this._screenshotMode = normalizeScreenshotMode(screenshot); - this._screenshotOptions = typeof screenshot === 'string' ? undefined : screenshot; this._screenshottedSymbol = Symbol('screenshotted'); this._startedCollectingArtifacts = Symbol('startedCollectingArtifacts'); } + setScreenshotOption(screenshot: ScreenshotOption) { + this._screenshotMode = normalizeScreenshotMode(screenshot); + this._screenshotOptions = typeof screenshot === 'string' ? undefined : screenshot; + } + private _createTemporaryArtifact(...name: string[]) { const file = path.join(this._artifactsDir, ...name); this._temporaryArtifacts.push(file); @@ -496,7 +523,6 @@ class ArtifactsRecorder { async willStartTest(testInfo: TestInfoImpl) { this._testInfo = testInfo; - testInfo._onDidFinishTestFunction = () => this.didFinishTestFunction(); // Since beforeAll(s), test and afterAll(s) reuse the same TestInfo, make sure we do not // overwrite previous screenshots. diff --git a/packages/playwright/src/worker/testInfo.ts b/packages/playwright/src/worker/testInfo.ts index 1e9e1f9c46..b6e57ee36e 100644 --- a/packages/playwright/src/worker/testInfo.ts +++ b/packages/playwright/src/worker/testInfo.ts @@ -68,7 +68,6 @@ export class TestInfoImpl implements TestInfo { readonly _projectInternal: FullProjectInternal; readonly _configInternal: FullConfigInternal; private readonly _steps: TestStepInternal[] = []; - _onDidFinishTestFunction: (() => Promise) | undefined; private readonly _stages: TestStage[] = []; _hasNonRetriableError = false; _hasUnhandledError = false; diff --git a/packages/playwright/src/worker/workerMain.ts b/packages/playwright/src/worker/workerMain.ts index ea2cdbaebc..3237104520 100644 --- a/packages/playwright/src/worker/workerMain.ts +++ b/packages/playwright/src/worker/workerMain.ts @@ -17,7 +17,7 @@ import { colors } from 'playwright-core/lib/utilsBundle'; import { debugTest, relativeFilePath, serializeError } from '../util'; import { type TestBeginPayload, type TestEndPayload, type RunPayload, type DonePayload, type WorkerInitParams, type TeardownErrorsPayload, stdioChunkToParams } from '../common/ipc'; -import { setCurrentTestInfo, setIsWorkerProcess } from '../common/globals'; +import { setCurrentTestInfo, setIsWorkerProcess, testLifecycleInstrumentation } from '../common/globals'; import { deserializeConfig } from '../common/configLoader'; import type { Suite, TestCase } from '../common/test'; import type { Annotation, FullConfigInternal, FullProjectInternal } from '../common/config'; @@ -304,10 +304,11 @@ export class WorkerMain extends ProcessRunner { if (this._lastRunningTests.length > 10) this._lastRunningTests.shift(); let shouldRunAfterEachHooks = false; + const tracingSlot = { timeout: this._project.project.timeout, elapsed: 0 }; testInfo._allowSkips = true; await testInfo._runAsStage({ title: 'setup and test' }, async () => { - await testInfo._runAsStage({ title: 'start tracing', runnable: { type: 'test' } }, async () => { + await testInfo._runAsStage({ title: 'start tracing', runnable: { type: 'test', slot: tracingSlot } }, async () => { // Ideally, "trace" would be an config-level option belonging to the // test runner instead of a fixture belonging to Playwright. // However, for backwards compatibility, we have to read it from a fixture today. @@ -318,6 +319,7 @@ export class WorkerMain extends ProcessRunner { if (typeof traceFixtureRegistration.fn === 'function') throw new Error(`"trace" option cannot be a function`); await testInfo._tracing.startIfNeeded(traceFixtureRegistration.fn); + await testLifecycleInstrumentation()?.onTestBegin?.(); }); if (this._isStopped || isSkipped) { @@ -372,10 +374,10 @@ export class WorkerMain extends ProcessRunner { try { // Run "immediately upon test function finish" callback. - await testInfo._runAsStage({ title: 'on-test-function-finish', runnable: { type: 'test', slot: afterHooksSlot } }, async () => testInfo._onDidFinishTestFunction?.()); + await testInfo._runAsStage({ title: 'on-test-function-finish', runnable: { type: 'test', slot: tracingSlot } }, async () => { + await testLifecycleInstrumentation()?.onTestFunctionEnd?.(); + }); } catch (error) { - if (error instanceof TimeoutManagerError) - didTimeoutInAfterHooks = true; firstAfterHooksError = firstAfterHooksError ?? error; } @@ -458,8 +460,8 @@ export class WorkerMain extends ProcessRunner { }).catch(() => {}); // Ignore the top-level error, it is already inside TestInfo.errors. } - const tracingSlot = { timeout: this._project.project.timeout, elapsed: 0 }; await testInfo._runAsStage({ title: 'stop tracing', runnable: { type: 'test', slot: tracingSlot } }, async () => { + await testLifecycleInstrumentation()?.onTestEnd?.(); await testInfo._tracing.stopIfNeeded(); }).catch(() => {}); // Ignore the top-level error, it is already inside TestInfo.errors. diff --git a/tests/config/testModeFixtures.ts b/tests/config/testModeFixtures.ts index 6b6feff7c2..40b1996719 100644 --- a/tests/config/testModeFixtures.ts +++ b/tests/config/testModeFixtures.ts @@ -30,11 +30,12 @@ export type TestModeTestFixtures = { export type TestModeWorkerFixtures = { toImplInWorkerScope: (rpcObject?: any) => any; playwright: typeof import('@playwright/test'); + _playwrightImpl: typeof import('@playwright/test'); }; export const testModeTest = test.extend({ mode: ['default', { scope: 'worker', option: true }], - playwright: [async ({ mode }, run) => { + _playwrightImpl: [async ({ mode }, run) => { const testMode = { 'default': new DefaultTestMode(), 'service': new DefaultTestMode(), diff --git a/tests/playwright-test/playwright.artifacts.spec.ts b/tests/playwright-test/playwright.artifacts.spec.ts index b666aa4b70..a7c0699c9d 100644 --- a/tests/playwright-test/playwright.artifacts.spec.ts +++ b/tests/playwright-test/playwright.artifacts.spec.ts @@ -151,10 +151,8 @@ test('should work with screenshot: on', async ({ runInlineTest }, testInfo) => { ' test-finished-1.png', 'artifacts-shared-shared-failing', ' test-failed-1.png', - ' test-failed-2.png', 'artifacts-shared-shared-passing', ' test-finished-1.png', - ' test-finished-2.png', 'artifacts-two-contexts', ' test-finished-1.png', ' test-finished-2.png', @@ -185,7 +183,6 @@ test('should work with screenshot: only-on-failure', async ({ runInlineTest }, t ' test-failed-1.png', 'artifacts-shared-shared-failing', ' test-failed-1.png', - ' test-failed-2.png', 'artifacts-two-contexts-failing', ' test-failed-1.png', ' test-failed-2.png', diff --git a/tests/playwright-test/playwright.trace.spec.ts b/tests/playwright-test/playwright.trace.spec.ts index dee65c9a52..b69e84c9d8 100644 --- a/tests/playwright-test/playwright.trace.spec.ts +++ b/tests/playwright-test/playwright.trace.spec.ts @@ -569,14 +569,19 @@ test('should opt out of attachments', async ({ runInlineTest, server }, testInfo expect([...trace.resources.keys()].filter(f => f.startsWith('resources/'))).toHaveLength(0); }); -test('should record with custom page fixture', async ({ runInlineTest }, testInfo) => { +test('should record with custom page fixture that closes the context', async ({ runInlineTest }, testInfo) => { + // Note that original issue did not close the context, but we do not support such usecase. + test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/23220' }); + const result = await runInlineTest({ 'a.spec.ts': ` import { test as base, expect } from '@playwright/test'; const test = base.extend({ myPage: async ({ browser }, use) => { - await use(await browser.newPage()); + const page = await browser.newPage(); + await use(page); + await page.close(); }, }); @@ -1112,3 +1117,90 @@ test('trace:retain-on-first-failure should create trace if request context is di expect(trace.apiNames).toContain('apiRequestContext.get'); expect(result.failed).toBe(1); }); + +test('should record trace in workerStorageState', async ({ runInlineTest }) => { + test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30287' }); + + const result = await runInlineTest({ + 'a.spec.ts': ` + import { test as base, expect } from '@playwright/test'; + const test = base.extend({ + storageState: ({ workerStorageState }, use) => use(workerStorageState), + workerStorageState: [async ({ browser }, use) => { + const page = await browser.newPage({ storageState: undefined }); + await page.setContent('
hello
'); + await page.close(); + await use(undefined); + }, { scope: 'worker' }], + }) + test('pass', async ({ page }) => { + await page.goto('data:text/html,
hi
'); + }); + `, + }, { trace: 'on' }); + expect(result.exitCode).toBe(0); + expect(result.passed).toBe(1); + + const tracePath = test.info().outputPath('test-results', 'a-pass', 'trace.zip'); + const trace = await parseTrace(tracePath); + expect(trace.actionTree).toEqual([ + 'Before Hooks', + ' fixture: browser', + ' browserType.launch', + ' fixture: workerStorageState', + ' browser.newPage', + ' page.setContent', + ' page.close', + ' fixture: context', + ' browser.newContext', + ' fixture: page', + ' browserContext.newPage', + 'page.goto', + 'After Hooks', + ' fixture: page', + ' fixture: context', + ]); +}); + +test('should record trace after fixture teardown timeout', async ({ runInlineTest }) => { + test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/30718' }); + + const result = await runInlineTest({ + 'a.spec.ts': ` + import { test as base, expect } from '@playwright/test'; + const test = base.extend({ + fixture: async ({}, use) => { + await use('foo'); + await new Promise(() => {}); + }, + }) + test('fails', async ({ fixture, page }) => { + await page.evaluate(() => console.log('from the page')); + }); + `, + }, { trace: 'on', timeout: '4000' }); + expect(result.exitCode).toBe(1); + expect(result.failed).toBe(1); + + const tracePath = test.info().outputPath('test-results', 'a-fails', 'trace.zip'); + const trace = await parseTrace(tracePath); + expect(trace.actionTree).toEqual([ + 'Before Hooks', + ' fixture: fixture', + ' fixture: browser', + ' browserType.launch', + ' fixture: context', + ' browser.newContext', + ' fixture: page', + ' browserContext.newPage', + 'page.evaluate', + 'After Hooks', + ' fixture: page', + ' fixture: context', + ' fixture: fixture', + 'Worker Cleanup', + ' fixture: browser', + ]); + // Check console events to make sure that library trace is recorded. + expect(trace.events).toContainEqual(expect.objectContaining({ type: 'console', text: 'from the page' })); +});