creevey 0.10.0-beta.8 → 0.10.0-rc.0

package/dist/server/master/testsManager.js

@@ -0,0 +1,282 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestsManager = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = require("fs");
+const events_1 = __importDefault(require("events"));
+const types_js_1 = require("../../types.js");
+const utils_js_1 = require("../utils.js");
+const promises_1 = require("fs/promises");
+/**
+ * TestsManager is responsible for all operations related to test data management
+ * including loading, saving, merging, and updating test data.
+ * It extends EventEmitter to emit update events that can be subscribed to.
+ */
+class TestsManager extends events_1.default {
+    tests = {};
+    screenDir;
+    reportDir;
+    /**
+     * Creates a new TestsManager instance
+     * @param screenDir Directory for storing reference images
+     * @param reportDir Directory for storing reports and screenshots
+     */
+    constructor(screenDir, reportDir) {
+        super();
+        this.screenDir = screenDir;
+        this.reportDir = reportDir;
+    }
+    /**
+     * Get a copy of all tests
+     * @returns all tests
+     */
+    getTests() {
+        return this.tests;
+    }
+    /**
+     * Get a test by ID
+     * @param id Test ID
+     * @returns Test data
+     */
+    getTest(id) {
+        return this.tests[id];
+    }
+    /**
+     * Get test data in a format suitable for status reporting
+     * @returns Test data in the format needed for status
+     */
+    getTestsData() {
+        const testsData = {};
+        Object.entries(this.tests).forEach(([id, test]) => {
+            if (!test)
+                return;
+            const { story: _, fn: __, ...testData } = test;
+            testsData[id] = testData;
+        });
+        return testsData;
+    }
+    /**
+     * Load tests from a report file
+     */
+    loadTestsFromReport() {
+        // TODO: Move to utils
+        const reportDataPath = path_1.default.join(this.reportDir, 'data.js');
+        const testsFromReport = (0, utils_js_1.tryToLoadTestsData)(reportDataPath) ?? {};
+        return testsFromReport;
+    }
+    /**
+     * Merge tests from report with tests from stories
+     */
+    mergeTests(testsWithReports, testsFromStories) {
+        Object.values(testsFromStories)
+            .filter(types_js_1.isDefined)
+            .forEach((test) => {
+            const testWithReport = testsWithReports[test.id];
+            if (!testWithReport)
+                return;
+            test.retries = testWithReport.retries;
+            if (testWithReport.status === 'success' || testWithReport.status === 'failed') {
+                test.status = testWithReport.status;
+            }
+            test.results = testWithReport.results;
+            test.approved = testWithReport.approved;
+        });
+        return testsFromStories;
+    }
+    loadAndMergeTests(testsFromStories) {
+        const testsFromReport = this.loadTestsFromReport();
+        return this.mergeTests(testsFromReport, testsFromStories);
+    }
+    /**
+     * Update tests with incremental changes
+     * @param testsDiff Tests to update or remove
+     */
+    updateTests(testsDiff) {
+        const tests = {};
+        const removedTests = [];
+        Object.entries(testsDiff).forEach(([id, newTest]) => {
+            if (newTest) {
+                if (this.tests[id]) {
+                    this.tests[id] = {
+                        ...newTest,
+                        retries: this.tests[id].retries,
+                        results: this.tests[id].results,
+                        approved: this.tests[id].approved,
+                    };
+                }
+                else {
+                    this.tests[id] = newTest;
+                }
+                const { story: _, fn: __, ...restTest } = newTest;
+                tests[id] = { ...restTest, status: 'unknown' };
+            }
+            else if (this.tests[id]) {
+                const { id: testId, browser, testName, storyPath, storyId } = this.tests[id];
+                removedTests.push({ id: testId, browser, testName, storyPath, storyId });
+                // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+                delete this.tests[id];
+            }
+        });
+        this.saveTestsToJson();
+        const update = { tests, removedTests };
+        this.emit('update', update);
+        return update;
+    }
+    /**
+     * Update test result
+     * @param id Test ID
+     * @param status New test status
+     * @param result Optional test result
+     */
+    updateTestStatus(id, status, result) {
+        // TODO Handle 'retrying' status
+        const test = this.tests[id];
+        if (!test)
+            return null;
+        const { browser, testName, storyPath, storyId } = test;
+        test.status = status === 'retrying' ? 'failed' : status;
+        if (!result) {
+            // NOTE: Running status
+            const update = { tests: { [id]: { id, browser, testName, storyPath, status, storyId } } };
+            this.emit('update', update);
+            return update;
+        }
+        test.results ??= [];
+        test.results.push(result);
+        if (status === 'failed') {
+            test.approved = null;
+        }
+        const update = {
+            tests: {
+                [id]: {
+                    id,
+                    browser,
+                    testName,
+                    storyPath,
+                    status,
+                    approved: test.approved,
+                    results: [result],
+                    storyId,
+                },
+            },
+        };
+        this.emit('update', update);
+        return update;
+    }
+    /**
+     * Save tests to JSON file
+     * @param reportDir Directory to save the JSON file
+     */
+    saveTestsToJson() {
+        (0, fs_1.mkdirSync)(this.reportDir, { recursive: true });
+        (0, fs_1.writeFileSync)(path_1.default.join(this.reportDir, 'tests.json'), 
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        JSON.stringify(this.tests, (_, value) => ((0, types_js_1.isFunction)(value) ? value.toString() : value), 2));
+    }
+    /**
+     * Save test data to a module
+     * @param data Test data to include in the module
+     */
+    async saveTestData(data = this.getTestsData()) {
+        const dataModule = `
+(function (root, factory) {
+  if (typeof module === 'object' && module.exports) {
+    module.exports = factory();
+  } else {
+    root.__CREEVEY_DATA__ = factory();
+  }
+}(this, function () { return ${JSON.stringify(data)} }));
+`;
+        await (0, promises_1.writeFile)(path_1.default.join(this.reportDir, 'data.js'), dataModule);
+    }
+    /**
+     * Copy image for approval
+     * @param test Test data
+     * @param image Image name
+     * @param actual Actual image path
+     */
+    async copyImage(test, image, actual) {
+        const { browser, testName, storyPath } = test;
+        const restPath = [...storyPath, testName].filter(types_js_1.isDefined);
+        const testPath = path_1.default.join(...restPath, image == browser ? '' : browser);
+        const srcImagePath = path_1.default.join(this.reportDir, testPath, actual);
+        const dstImagePath = path_1.default.join(this.screenDir, testPath, `${image}.png`);
+        await (0, promises_1.mkdir)(path_1.default.join(this.screenDir, testPath), { recursive: true });
+        await (0, promises_1.copyFile)(srcImagePath, dstImagePath);
+    }
+    /**
+     * Approve a specific test
+     * @param payload Approval payload with test ID, retry index, and image name
+     */
+    async approve({ id, retry, image }) {
+        const test = this.tests[id];
+        if (!test?.results)
+            return null;
+        const result = test.results[retry];
+        if (!result.images)
+            return null;
+        const images = result.images[image];
+        if (!images)
+            return null;
+        test.approved ??= {};
+        const { browser, testName, storyPath, storyId } = test;
+        await this.copyImage(test, image, images.actual);
+        test.approved[image] = retry;
+        if (Object.keys(result.images).every((name) => typeof test.approved?.[name] == 'number')) {
+            test.status = 'approved';
+        }
+        const update = {
+            tests: {
+                [id]: {
+                    id,
+                    browser,
+                    testName,
+                    storyPath,
+                    status: test.status,
+                    approved: test.approved,
+                    storyId,
+                },
+            },
+        };
+        this.emit('update', update);
+        return update;
+    }
+    /**
+     * Approve all failed tests
+     */
+    async approveAll() {
+        const updatedTests = {};
+        for (const test of Object.values(this.tests)) {
+            if (!test?.results)
+                continue;
+            const retry = test.results.length - 1;
+            const { images, status } = test.results.at(retry) ?? {};
+            if (!images || status != 'failed')
+                continue;
+            for (const [name, image] of Object.entries(images)) {
+                if (!image)
+                    continue;
+                await this.copyImage(test, name, image.actual);
+                test.approved ??= {};
+                test.approved[name] = retry;
+                test.status = 'approved';
+                updatedTests[test.id] = {
+                    id: test.id,
+                    browser: test.browser,
+                    storyPath: test.storyPath,
+                    storyId: test.storyId,
+                    status: test.status,
+                    approved: { [name]: retry },
+                };
+            }
+        }
+        const result = { tests: updatedTests };
+        this.emit('update', result);
+        return result;
+    }
+}
+exports.TestsManager = TestsManager;
+//# sourceMappingURL=testsManager.js.map

package/dist/server/master/testsManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testsManager.js","sourceRoot":"","sources":["../../../src/server/master/testsManager.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,2BAA8C;AAC9C,oDAAkC;AAClC,6CAUwB;AACxB,0CAAiD;AACjD,0CAAyD;AAEzD;;;;GAIG;AACH,MAAa,YAAa,SAAQ,gBAAY;IACpC,KAAK,GAAwC,EAAE,CAAC;IAChD,SAAS,CAAS;IAClB,SAAS,CAAS;IAE1B;;;;OAIG;IACH,YAAY,SAAiB,EAAE,SAAiB;QAC9C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACI,OAAO,CAAC,EAAU;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,YAAY;QACjB,MAAM,SAAS,GAA2B,EAAE,CAAC;QAE7C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE;YAChD,IAAI,CAAC,IAAI;gBAAE,OAAO;YAElB,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;YAC/C,SAAS,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,mBAAmB;QACxB,sBAAsB;QACtB,MAAM,cAAc,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC5D,MAAM,eAAe,GAAG,IAAA,6BAAkB,EAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QACjE,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;OAEG;IACK,UAAU,CAChB,gBAAwC,EACxC,gBAAqD;QAErD,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC;aAC5B,MAAM,CAAC,oBAAS,CAAC;aACjB,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAChB,MAAM,cAAc,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACjD,IAAI,CAAC,cAAc;gBAAE,OAAO;YAC5B,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;YACtC,IAAI,cAAc,CAAC,MAAM,KAAK,SAAS,IAAI,cAAc,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC9E,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;YACtC,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC;YACtC,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC,QAAQ,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEL,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAEM,iBAAiB,CAAC,gBAAqD;QAC5E,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEnD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,SAA8C;QAC/D,MAAM,KAAK,GAA2B,EAAE,CAAC;QACzC,MAAM,YAAY,GAAe,EAAE,CAAC;QAEpC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,EAAE;YAClD,IAAI,OAAO,EAAE,CAAC;gBACZ,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;oBACnB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG;wBACf,GAAG,OAAO;wBACV,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO;wBAC/B,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,OAAO;wBAC/B,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,QAAQ;qBAClC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;gBAC3B,CAAC;gBAED,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC;gBAClD,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;YACjD,CAAC;iBAAM,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC1B,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBAC7E,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;gBACzE,gEAAgE;gBAChE,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACxB,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACI,gBAAgB,CAAC,EAAU,EAAE,MAAkB,EAAE,MAAmB;QACzE,gCAAgC;QAChC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI;YAAE,OAAO,IAAI,CAAC;QAEvB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;QAExD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,uBAAuB;YACvB,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;YAC1F,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC5B,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,OAAO,KAAK,EAAE,CAAC;QACpB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE1B,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,CAAC;QAED,MAAM,MAAM,GAAG;YACb,KAAK,EAAE;gBACL,CAAC,EAAE,CAAC,EAAE;oBACJ,EAAE;oBACF,OAAO;oBACP,QAAQ;oBACR,SAAS;oBACT,MAAM;oBACN,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,OAAO,EAAE,CAAC,MAAM,CAAC;oBACjB,OAAO;iBACR;aACF;SACF,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,eAAe;QACpB,IAAA,cAAS,EAAC,IAAI,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,IAAA,kBAAa,EACX,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC;QACvC,+DAA+D;QAC/D,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAA,qBAAU,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAC5F,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,OAA+B,IAAI,CAAC,YAAY,EAAE;QAC1E,MAAM,UAAU,GAAG;;;;;;;+BAOQ,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;CAClD,CAAC;QACE,MAAM,IAAA,oBAAS,EAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,SAAS,CAAC,IAAgB,EAAE,KAAa,EAAE,MAAc;QACrE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;QAC9C,MAAM,QAAQ,GAAG,CAAC,GAAG,SAAS,EAAE,QAAQ,CAAC,CAAC,MAAM,CAAC,oBAAS,CAAC,CAAC;QAC5D,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,QAAQ,EAAE,KAAK,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;QACzE,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjE,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,KAAK,MAAM,CAAC,CAAC;QACzE,MAAM,IAAA,gBAAK,EAAC,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,MAAM,IAAA,mBAAQ,EAAC,YAAY,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAkB;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,EAAE,OAAO;YAAE,OAAO,IAAI,CAAC;QAChC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QACzB,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;QACrB,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;QAEvD,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;QAE7B,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,EAAE,CAAC;YACzF,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;QAC3B,CAAC;QAED,MAAM,MAAM,GAAG;YACb,KAAK,EAAE;gBACL,CAAC,EAAE,CAAC,EAAE;oBACJ,EAAE;oBACF,OAAO;oBACP,QAAQ;oBACR,SAAS;oBACT,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACvB,OAAO;iBACR;aACF;SACF,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;QACrB,MAAM,YAAY,GAAwC,EAAE,CAAC;QAC7D,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7C,IAAI,CAAC,IAAI,EAAE,OAAO;gBAAE,SAAS;YAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;YACtC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YACxD,IAAI,CAAC,MAAM,IAAI,MAAM,IAAI,QAAQ;gBAAE,SAAS;YAC5C,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnD,IAAI,CAAC,KAAK;oBAAE,SAAS;gBACrB,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAE/C,IAAI,CAAC,QAAQ,KAAK,EAAE,CAAC;gBACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;gBAC5B,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC;gBAEzB,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG;oBACtB,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE;iBAC5B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC5B,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AArSD,oCAqSC"}

package/dist/server/playwright/docker-file.d.ts

@@ -1 +1 @@
-export declare function playwrightDockerFile(browser: string, version: string): string;
+export declare function playwrightDockerFile(browser: string, version: string): Promise<string>;

package/dist/server/playwright/docker-file.js

@@ -4,34 +4,43 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.playwrightDockerFile = playwrightDockerFile;
+const promises_1 = require("fs/promises");
+const url_1 = require("url");
 const semver_1 = __importDefault(require("semver"));
-const shelljs_1 = require("shelljs");
+const shelljs_1 = __importDefault(require("shelljs"));
+const importMetaUrl = (0, url_1.pathToFileURL)(__filename).href;
 // TODO Support custom docker images
-function playwrightDockerFile(browser, version) {
+async function playwrightDockerFile(browser, version) {
     const sv = semver_1.default.coerce(version);
     let npmRegistry;
     try {
-        npmRegistry = (0, shelljs_1.exec)('npm config get registry', { silent: true }).stdout.trim();
+        npmRegistry = shelljs_1.default.exec('npm config get registry', { silent: true }).stdout.trim();
     }
     catch {
         /* noop */
     }
-    return `
-FROM mcr.microsoft.com/playwright:v${sv?.format() ?? version}
+    const indexJs = await (0, promises_1.readFile)(new URL('./index-source.mjs', importMetaUrl), 'utf-8');
+    const dockerfile = `
+FROM node:lts
 
 WORKDIR /creevey
 
 RUN echo "{ \\"type\\": \\"module\\" }" > package.json && \\
-    echo "import { ${browser} as browser } from 'playwright-core';" >> index.js && \\
-    echo "const ws = await browser.launchServer({ port: 4444, wsPath: 'creevey' })" >> index.js && \\${npmRegistry
+${indexJs
+        .split('\n')
+        .map((line) => `    echo "${line.replace(/"/g, '\\"')}" >> index.js && \\`)
+        .join('\n')}
+    ${npmRegistry
         ? `
     echo "registry=${npmRegistry}" > .npmrc && \\`
         : ''}
-    npm i playwright-core${sv ? `@${sv.format()}` : ''}
+    npm i playwright-core${sv ? `@${sv.format()}` : ''} && \\
+    npx -y playwright${sv ? `@${sv.format()}` : ''} install --with-deps ${browser}
 
 EXPOSE 4444
 
 ENTRYPOINT [ "node", "./index.js" ]
 `;
+    return dockerfile.replace(/\\\n\s*\\?\n/g, '\\\n');
 }
 //# sourceMappingURL=docker-file.js.map

package/dist/server/playwright/docker-file.js.map

@@ -1 +1 @@
-{"version":3,"file":"docker-file.js","sourceRoot":"","sources":["../../../src/server/playwright/docker-file.ts"],"names":[],"mappings":";;;;;AAIA,oDA6BC;AAjCD,oDAA4B;AAC5B,qCAA+B;AAE/B,oCAAoC;AACpC,SAAgB,oBAAoB,CAAC,OAAe,EAAE,OAAe;IACnE,MAAM,EAAE,GAAG,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAElC,IAAI,WAAW,CAAC;IAChB,IAAI,CAAC;QACH,WAAW,GAAG,IAAA,cAAI,EAAC,yBAAyB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAChF,CAAC;IAAC,MAAM,CAAC;QACP,UAAU;IACZ,CAAC;IAED,OAAO;qCAC4B,EAAE,EAAE,MAAM,EAAE,IAAI,OAAO;;;;;qBAKvC,OAAO;uGAEtB,WAAW;QACT,CAAC,CAAC;qBACW,WAAW,kBAAkB;QAC1C,CAAC,CAAC,EACN;2BACuB,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;;;;;CAKrD,CAAC;AACF,CAAC"}
+{"version":3,"file":"docker-file.js","sourceRoot":"","sources":["../../../src/server/playwright/docker-file.ts"],"names":[],"mappings":";;;;;AAQA,oDAqCC;AA7CD,0CAAuC;AACvC,6BAAoC;AACpC,oDAA4B;AAC5B,sDAAyB;AAEzB,MAAM,aAAa,GAAG,IAAA,mBAAa,EAAC,UAAU,CAAC,CAAC,IAAI,CAAC;AAErD,oCAAoC;AAC7B,KAAK,UAAU,oBAAoB,CAAC,OAAe,EAAE,OAAe;IACzE,MAAM,EAAE,GAAG,gBAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAElC,IAAI,WAAW,CAAC;IAChB,IAAI,CAAC;QACH,WAAW,GAAG,iBAAE,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACnF,CAAC;IAAC,MAAM,CAAC;QACP,UAAU;IACZ,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,IAAA,mBAAQ,EAAC,IAAI,GAAG,CAAC,oBAAoB,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC;IAEtF,MAAM,UAAU,GAAG;;;;;;EAMnB,OAAO;SACN,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,qBAAqB,CAAC;SAC1E,IAAI,CAAC,IAAI,CAAC;MAEP,WAAW;QACT,CAAC,CAAC;qBACW,WAAW,kBAAkB;QAC1C,CAAC,CAAC,EACN;2BACuB,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE;uBAC/B,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,wBAAwB,OAAO;;;;;CAKhF,CAAC;IAEA,OAAO,UAAU,CAAC,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AACrD,CAAC"}

package/dist/server/playwright/docker.d.ts

@@ -1 +1,2 @@
-export declare function startPlaywrightContainer(imageName: string, debug: boolean): Promise<string>;
+import type { Config } from '../../types';
+export declare function startPlaywrightContainer(imageName: string, browser: string, config: Config, debug: boolean): Promise<string>;

package/dist/server/playwright/docker.js

@@ -1,11 +1,16 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startPlaywrightContainer = startPlaywrightContainer;
+const assert_1 = __importDefault(require("assert"));
 const docker_1 = require("../docker");
 const messages_1 = require("../messages");
 const utils_1 = require("../utils");
 const webdriver_1 = require("../webdriver");
-async function startPlaywrightContainer(imageName, debug) {
+async function startPlaywrightContainer(imageName, browser, config, debug) {
+    const { browserName, playwrightOptions } = config.browsers[browser];
     const port = await new Promise((resolve) => {
         (0, messages_1.subscribeOn)('worker', (message) => {
             if (message.type == 'port') {
@@ -14,10 +19,13 @@ async function startPlaywrightContainer(imageName, debug) {
         });
         (0, messages_1.emitWorkerMessage)({ type: 'port', payload: { port: -1 } });
     });
-    const host = await (0, docker_1.runImage)(imageName, [], {
+    const cacheDir = await (0, utils_1.getCreeveyCache)();
+    (0, assert_1.default)(cacheDir, "Couldn't get cache directory");
+    const host = await (0, docker_1.runImage)(imageName, [JSON.stringify({ ...playwrightOptions, browser: (0, utils_1.resolvePlaywrightBrowserType)(browserName) })], {
         ExposedPorts: { [`${port}/tcp`]: {} },
         HostConfig: {
             PortBindings: { ['4444/tcp']: [{ HostPort: `${port}` }] },
+            Binds: [`${cacheDir}/${process.pid}:/creevey/traces`],
         },
     }, debug);
     const gridUrl = `ws://localhost:${port}/creevey`;

package/dist/server/playwright/docker.js.map

@@ -1 +1 @@
-{"version":3,"file":"docker.js","sourceRoot":"","sources":["../../../src/server/playwright/docker.ts"],"names":[],"mappings":";;AAKA,4DAyBC;AA9BD,sCAAqC;AACrC,0CAA6D;AAC7D,oCAA0C;AAC1C,4CAAgD;AAEzC,KAAK,UAAU,wBAAwB,CAAC,SAAiB,EAAE,KAAc;IAC9E,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QACjD,IAAA,sBAAW,EAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE;YAChC,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,EAAE,CAAC;gBAC3B,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAA,4BAAiB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAQ,EACzB,SAAS,EACT,EAAE,EACF;QACE,YAAY,EAAE,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE;QACrC,UAAU,EAAE;YACV,YAAY,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,EAAE;SAC1D;KACF,EACD,KAAK,CACN,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,IAAI,UAAU,CAAC;IAEjD,OAAO,sBAAc,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,4BAAgB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AAC5E,CAAC"}
+{"version":3,"file":"docker.js","sourceRoot":"","sources":["../../../src/server/playwright/docker.ts"],"names":[],"mappings":";;;;;AAOA,4DAoCC;AA3CD,oDAA4B;AAC5B,sCAAqC;AACrC,0CAA6D;AAC7D,oCAAyF;AACzF,4CAAgD;AAGzC,KAAK,UAAU,wBAAwB,CAC5C,SAAiB,EACjB,OAAe,EACf,MAAc,EACd,KAAc;IAEd,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAwB,CAAC;IAC3F,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;QACjD,IAAA,sBAAW,EAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,EAAE;YAChC,IAAI,OAAO,CAAC,IAAI,IAAI,MAAM,EAAE,CAAC;gBAC3B,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAChC,CAAC;QACH,CAAC,CAAC,CAAC;QACH,IAAA,4BAAiB,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,MAAM,IAAA,uBAAe,GAAE,CAAC;IAEzC,IAAA,gBAAM,EAAC,QAAQ,EAAE,8BAA8B,CAAC,CAAC;IAEjD,MAAM,IAAI,GAAG,MAAM,IAAA,iBAAQ,EACzB,SAAS,EACT,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,iBAAiB,EAAE,OAAO,EAAE,IAAA,oCAA4B,EAAC,WAAW,CAAC,EAAE,CAAC,CAAC,EAC9F;QACE,YAAY,EAAE,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,EAAE,EAAE;QACrC,UAAU,EAAE;YACV,YAAY,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,EAAE,CAAC,EAAE;YACzD,KAAK,EAAE,CAAC,GAAG,QAAQ,IAAI,OAAO,CAAC,GAAG,kBAAkB,CAAC;SACtD;KACF,EACD,KAAK,CACN,CAAC;IAEF,MAAM,OAAO,GAAG,kBAAkB,IAAI,UAAU,CAAC;IAEjD,OAAO,sBAAc,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,4BAAgB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AAC5E,CAAC"}

package/dist/server/playwright/index-source.mjs

@@ -0,0 +1,16 @@
+import { chromium, firefox, webkit } from 'playwright-core';
+
+/** @type import("playwright-core").LaunchOptions & { browser: 'chromium' | 'firefox' | 'webkit' } */
+// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+const config = JSON.parse(process.argv.slice(2)[0]);
+
+const browsers = { chromium, firefox, webkit };
+
+const ws = await browsers[config.browser].launchServer({
+  ...config,
+  port: 4444,
+  wsPath: 'creevey',
+  tracesDir: 'traces',
+});
+
+console.log(config.browser, 'browser server launched on:', ws.wsEndpoint());

package/dist/server/playwright/internal.d.ts

@@ -1,9 +1,9 @@
-import { Browser, Page } from 'playwright-core';
-import { Config, Options, StoriesRaw, StoryInput } from '../../types';
-import { Args } from '@storybook/csf';
+import { Browser, BrowserContext, Page } from 'playwright-core';
+import type { Args } from 'storybook/internal/types';
+import { Config, StoriesRaw, StoryInput, StorybookGlobals, WorkerOptions } from '../../types';
 export declare class InternalBrowser {
     #private;
-    constructor(browser: Browser, page: Page, port: number);
+    constructor(browser: Browser, context: BrowserContext, page: Page, traceDir: string, port: number, debug?: boolean, storybookGlobals?: StorybookGlobals);
     get browser(): Page;
     get sessionId(): string;
     closeBrowser(): Promise<void>;
@@ -11,15 +11,15 @@ export declare class InternalBrowser {
     waitForComplete(callback: (isCompleted: boolean) => void): void;
     selectStory(id: string, waitForReady?: boolean): Promise<boolean>;
     updateStoryArgs(story: StoryInput, updatedArgs: Args): Promise<void>;
-    loadStoriesFromBrowser(retry?: boolean): Promise<StoriesRaw>;
-    static getBrowser(browserName: string, gridUrl: string, config: Config, options: Options): Promise<InternalBrowser | null>;
+    loadStoriesFromBrowser(): Promise<StoriesRaw>;
+    static getBrowser(browserName: string, gridUrl: string, config: Config, options: WorkerOptions): Promise<InternalBrowser | null>;
     private init;
     private openStorybookPage;
     private checkUrl;
     private waitForStorybook;
+    private triggerViteReload;
     private updateStorybookGlobals;
     private resolveCreeveyHost;
     private updateBrowserGlobalVariables;
-    private resizeViewport;
     private resetMousePosition;
 }