Skip to content

Commit

Permalink
cherry-pick(#31437): fix(electron): tracing with @playwright/test
Browse files Browse the repository at this point in the history
  • Loading branch information
mxschmitt committed Jul 1, 2024
1 parent 4ec4ccf commit 0fe7a10
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/playwright/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ class ArtifactsRecorder {
if ((tracing as any)[this._startedCollectingArtifacts])
return;
(tracing as any)[this._startedCollectingArtifacts] = true;
if (this._testInfo._tracing.traceOptions())
if (this._testInfo._tracing.traceOptions() && (tracing as any)[kTracingStarted])
await tracing.stopChunk({ path: this._testInfo._tracing.generateNextTraceRecordingPath() });
}
}
Expand Down
44 changes: 44 additions & 0 deletions tests/installation/playwright-electron-should-work.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
*/
import { test } from './npmTest';
import fs from 'fs';
import { expect } from 'packages/playwright-test';
import path from 'path';

test('electron should work', async ({ exec, tsc, writeFiles }) => {
Expand All @@ -39,3 +40,46 @@ test('electron should work with special characters in path', async ({ exec, tmpW
cwd: path.join(folderName)
});
});

test('should work when wrapped inside @playwright/test and trace is enabled', async ({ exec, tmpWorkspace, writeFiles }) => {
await exec('npm i -D @playwright/test electron@31');
await writeFiles({
'electron-with-tracing.spec.ts': `
import { test, expect, _electron } from '@playwright/test';
test('should work', async ({ trace }) => {
const electronApp = await _electron.launch({ args: [${JSON.stringify(path.join(__dirname, '../electron/electron-window-app.js'))}] });
const window = await electronApp.firstWindow();
if (trace)
await window.context().tracing.start({ screenshots: true, snapshots: true });
await window.goto('data:text/html,<title>Playwright</title><h1>Playwright</h1>');
await expect(window).toHaveTitle(/Playwright/);
await expect(window.getByRole('heading')).toHaveText('Playwright');
const path = test.info().outputPath('electron-trace.zip');
if (trace) {
await window.context().tracing.stop({ path });
test.info().attachments.push({ name: 'trace', path, contentType: 'application/zip' });
}
await electronApp.close();
});
`,
});
const jsonOutputName = test.info().outputPath('report.json');
await exec('npx playwright test --trace=on --reporter=json electron-with-tracing.spec.ts', {
env: { PLAYWRIGHT_JSON_OUTPUT_NAME: jsonOutputName }
});
const traces = [
// our actual trace.
path.join(tmpWorkspace, 'test-results', 'electron-with-tracing-should-work', 'electron-trace.zip'),
// contains the expect() calls
path.join(tmpWorkspace, 'test-results', 'electron-with-tracing-should-work', 'trace.zip'),
];
for (const trace of traces)
expect(fs.existsSync(trace)).toBe(true);
const report = JSON.parse(fs.readFileSync(jsonOutputName, 'utf-8'));
expect(new Set(['trace'])).toEqual(new Set(report.suites[0].specs[0].tests[0].results[0].attachments.map(a => a.name)));
expect(new Set(traces.map(p => fs.realpathSync(p)))).toEqual(new Set(report.suites[0].specs[0].tests[0].results[0].attachments.map(a => a.path)));
});

0 comments on commit 0fe7a10

Please sign in to comment.