Playwright + Chrome Test Runner

1import { execSync } from 'node:child_process';
2import fs from 'node:fs';
3import path from 'node:path';
4
5import { Actor } from 'apify';
6import type { Dictionary } from 'apify-client';
7
8import log from '@apify/log';
9
10import { collectAttachmentPaths, transformToTabular } from './transform.js';
11
12function ensureFolder(pathname: string) {
13    if (!fs.existsSync(pathname)) {
14        fs.mkdirSync(pathname, { recursive: true });
15    }
16}
17
18function getConfigPath() {
19    return `${import.meta.dirname}/../playwright.config.ts`;
20}
21
22function getResultDir() {
23    return `${import.meta.dirname}/../playwright-report`;
24}
25
26const getConfig = (options: {
27    screen: { width: number; height: number };
28    headful: boolean;
29    timeout: number;
30    locale: string;
31    darkMode: boolean;
32    ignoreHTTPSErrors: boolean;
33    video: string;
34}) => {
35    const { screen, headful, timeout, ignoreHTTPSErrors, darkMode, locale, video } = options;
36
37    return `
38// Watch out! This file gets regenerated on every run of the actor.
39// Any changes you make will be lost.
40
41// Tweak your configuration through the Actor's input through the Apify console or directly in the \`input.json\` file.
42import { defineConfig } from '@playwright/test';
43export default defineConfig({
44    timeout: ${timeout},
45    use: {
46        headless: ${!headful},
47        viewport: { width: ${screen.width}, height: ${screen.height} },
48        ignoreHTTPSErrors: ${ignoreHTTPSErrors},
49        colorScheme: '${darkMode ? 'dark' : 'light'}',
50        locale: '${locale}',
51        video: '${video}',
52        launchOptions: {
53            args: [
54                '--disable-gpu', // Mitigates the "crashing GPU process" issue in Docker containers
55            ]
56        },
57    },
58    reporter: [
59        ['html', { outputFolder: '${getResultDir()}', open: 'never' }],
60        ['json', { outputFile: '${getResultDir()}/test-results.json' }]
61    ],
62});`;
63};
64function runTests() {
65    try {
66        execSync(`npx playwright test --config=${getConfigPath()}`, {
67            cwd: import.meta.dirname,
68            encoding: 'utf8',
69            stdio: 'inherit',
70        });
71    } catch {
72        // suppress error, the report will be generated anyway
73    }
74}
75
76function updateConfig(args: {
77    screenWidth?: number;
78    screenHeight?: number;
79    headful?: boolean;
80    timeout?: number;
81    darkMode?: boolean;
82    locale?: string;
83    ignoreHTTPSErrors?: boolean;
84    video?: string;
85}) {
86    const {
87        screenWidth = 1280,
88        screenHeight = 720,
89        headful = false,
90        timeout = 60,
91        darkMode = false,
92        locale = 'en-US',
93        ignoreHTTPSErrors = true,
94        video = 'off',
95    } = args;
96
97    const config = getConfig({
98        screen: { width: screenWidth, height: screenHeight },
99        headful,
100        timeout: timeout * 1000,
101        locale,
102        darkMode,
103        ignoreHTTPSErrors,
104        video,
105    });
106    fs.writeFileSync(getConfigPath(), config, { encoding: 'utf-8' });
107}
108
109await Actor.init();
110const input = ((await Actor.getInput()) ?? {}) as Dictionary;
111
112ensureFolder(getResultDir());
113updateConfig(input);
114
115runTests();
116
117const kvs = await Actor.openKeyValueStore();
118await kvs.setValue('report', fs.readFileSync(path.join(getResultDir(), 'index.html'), { encoding: 'utf-8' }), {
119    contentType: 'text/html',
120});
121const jsonReport = JSON.parse(fs.readFileSync(path.join(getResultDir(), 'test-results.json'), { encoding: 'utf-8' }));
122const attachmentPaths = collectAttachmentPaths(jsonReport);
123
124const attachmentLinks = await Promise.all(
125    attachmentPaths.map(async (x) => {
126        const attachment = fs.readFileSync(x.path);
127        await kvs.setValue(x.key, attachment, { contentType: x.type ?? 'application/octet' });
128        return { ...x, url: kvs.getPublicUrl(x.key) };
129    }),
130);
131
132await Actor.pushData(transformToTabular(jsonReport, attachmentLinks));
133
134const reportURL = kvs.getPublicUrl('report');
135log.info('The test run has finished! The report is available in the Output tab or at the link below:');
136console.log(reportURL);
137
138await Actor.exit();