Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

chore: simplify the trace collection fixtures (#21203)

Browse source
This commit is contained in:
Pavel Feldman 2023-02-25 21:21:09 -08:00 committed by GitHub
parent 4b8f36dbed
commit 4d91248c1e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
packages/playwright-test/src/index.ts
View file

@ -307,7 +307,9 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
}; };
const startedCollectingArtifacts = Symbol('startedCollectingArtifacts'); const startedCollectingArtifacts = Symbol('startedCollectingArtifacts');
const stopTraceChunkOnContextClosure = async (tracing: Tracing) => { const stopTracing = async (tracing: Tracing) => {
if ((tracing as any)[startedCollectingArtifacts])
return;
(tracing as any)[startedCollectingArtifacts] = true; (tracing as any)[startedCollectingArtifacts] = true;
if (captureTrace) { if (captureTrace) {
// Export trace for now. We'll know whether we have to preserve it // Export trace for now. We'll know whether we have to preserve it
@ -342,7 +344,7 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
// Do not record empty traces and useless screenshots for them. // Do not record empty traces and useless screenshots for them.
if (reusedContexts.has(context)) if (reusedContexts.has(context))
return; return;
await stopTraceChunkOnContextClosure(context.tracing); await stopTracing(context.tracing);
if (screenshotMode === 'on' || screenshotMode === 'only-on-failure') { if (screenshotMode === 'on' || screenshotMode === 'only-on-failure') {
// Capture screenshot for now. We'll know whether we have to preserve them // Capture screenshot for now. We'll know whether we have to preserve them
// after the test finishes. // after the test finishes.
@ -352,7 +354,7 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
const onWillCloseRequestContext = async (context: APIRequestContext) => { const onWillCloseRequestContext = async (context: APIRequestContext) => {
const tracing = (context as any)._tracing as Tracing; const tracing = (context as any)._tracing as Tracing;
await stopTraceChunkOnContextClosure(tracing); await stopTracing(tracing);
}; };
// 1. Setup instrumentation and process existing contexts. // 1. Setup instrumentation and process existing contexts.
@ -383,14 +385,6 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
const preserveTrace = captureTrace && (traceMode === 'on' || (testFailed && traceMode === 'retain-on-failure') || (traceMode === 'on-first-retry' && testInfo.retry === 1)); const preserveTrace = captureTrace && (traceMode === 'on' || (testFailed && traceMode === 'retain-on-failure') || (traceMode === 'on-first-retry' && testInfo.retry === 1));
const captureScreenshots = screenshotMode === 'on' || (screenshotMode === 'only-on-failure' && testFailed); const captureScreenshots = screenshotMode === 'on' || (screenshotMode === 'only-on-failure' && testFailed);
const traceAttachments: string[] = [];
const addTraceAttachment = () => {
const tracePath = testInfo.outputPath(`trace${traceAttachments.length ? '-' + traceAttachments.length : ''}.zip`);
traceAttachments.push(tracePath);
testInfo.attachments.push({ name: 'trace', path: tracePath, contentType: 'application/zip' });
return tracePath;
};
const screenshotAttachments: string[] = []; const screenshotAttachments: string[] = [];
const addScreenshotAttachment = () => { const addScreenshotAttachment = () => {
const screenshotPath = testInfo.outputPath(`test-${testFailed ? 'failed' : 'finished'}-${screenshotAttachments.length + 1}.png`); const screenshotPath = testInfo.outputPath(`test-${testFailed ? 'failed' : 'finished'}-${screenshotAttachments.length + 1}.png`);
@ -415,21 +409,9 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
(playwright.request as any)._onWillCloseContext = undefined; (playwright.request as any)._onWillCloseContext = undefined;
testInfoImpl._onTestFailureImmediateCallbacks.delete(screenshotOnTestFailure); testInfoImpl._onTestFailureImmediateCallbacks.delete(screenshotOnTestFailure);
const stopTraceChunkOnTestFinish = async (tracing: Tracing) => {
// When we timeout during context.close(), we might end up with context still alive
// but artifacts being already collected. In this case, do not collect artifacts
// for the second time.
if ((tracing as any)[startedCollectingArtifacts])
return;
if (preserveTrace)
await tracing.stopChunk({ path: addTraceAttachment() });
else if (captureTrace)
await tracing.stopChunk();
};
// 5. Collect artifacts from any non-closed contexts. // 5. Collect artifacts from any non-closed contexts.
await Promise.all(leftoverContexts.map(async context => { await Promise.all(leftoverContexts.map(async context => {
await stopTraceChunkOnTestFinish(context.tracing); await stopTracing(context.tracing);
if (captureScreenshots) { if (captureScreenshots) {
await Promise.all(context.pages().map(async page => { await Promise.all(context.pages().map(async page => {
if ((page as any)[screenshottedSymbol]) if ((page as any)[screenshottedSymbol])
@ -441,16 +423,19 @@ const playwrightFixtures: Fixtures<TestFixtures, WorkerFixtures> = ({
} }
}).concat(leftoverApiRequests.map(async context => { }).concat(leftoverApiRequests.map(async context => {
const tracing = (context as any)._tracing as Tracing; const tracing = (context as any)._tracing as Tracing;
await stopTraceChunkOnTestFinish(tracing); await stopTracing(tracing);
}))); })));
// 6. Either remove or attach temporary traces and screenshots for contexts closed // 6. Either remove or attach temporary traces and screenshots for contexts closed
// before the test has finished. // before the test has finished.
await Promise.all(temporaryTraceFiles.map(async file => { await Promise.all(temporaryTraceFiles.map(async (file, i) => {
if (preserveTrace) if (preserveTrace) {
await fs.promises.rename(file, addTraceAttachment()).catch(() => {}); const tracePath = testInfo.outputPath(`trace${i ? '-' + i : ''}.zip`);
else await fs.promises.rename(file, tracePath).catch(() => {});
testInfo.attachments.push({ name: 'trace', path: tracePath, contentType: 'application/zip' });
} else {
await fs.promises.unlink(file).catch(() => {}); await fs.promises.unlink(file).catch(() => {});
}
})); }));
await Promise.all(temporaryScreenshots.map(async file => { await Promise.all(temporaryScreenshots.map(async file => {
if (captureScreenshots) if (captureScreenshots)