@web/test-runner-commands 0.0.0-canary-20230403143511

package/dist/setViewportPlugin.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setViewportPlugin = void 0;
+function isObject(payload) {
+    return payload != null && typeof payload === 'object';
+}
+function isViewportObject(payload) {
+    if (!isObject(payload))
+        throw new Error('You must provide a viewport object');
+    if (payload.height == null)
+        throw new Error('You must provide a viewport width');
+    if (payload.width == null)
+        throw new Error('You must provide a viewport width');
+    if (typeof payload.height !== 'number')
+        throw new Error('Viewport height must be a number');
+    if (typeof payload.height !== 'number')
+        throw new Error('Viewport width must be a number');
+    if (payload.isMobile != null)
+        throw new Error('isMobile cannot be used because it triggers a page reload');
+    if (payload.hasTouch != null)
+        throw new Error('hasTouch cannot be used because it triggers a page reload');
+    return true;
+}
+function setViewportPlugin() {
+    return {
+        name: 'set-viewport-command',
+        async executeCommand({ command, payload, session }) {
+            if (command === 'set-viewport') {
+                if (!isViewportObject(payload)) {
+                    throw new Error('You must provide a viewport object');
+                }
+                if (session.browser.type === 'puppeteer') {
+                    const page = session.browser.getPage(session.id);
+                    await page.setViewport(payload);
+                    return true;
+                }
+                if (session.browser.type === 'playwright') {
+                    const page = session.browser.getPage(session.id);
+                    await page.setViewportSize(payload);
+                    return true;
+                }
+                throw new Error(`Setting viewport is not supported for browser type ${session.browser.type}.`);
+            }
+        },
+    };
+}
+exports.setViewportPlugin = setViewportPlugin;
+//# sourceMappingURL=setViewportPlugin.js.map

package/dist/setViewportPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setViewportPlugin.js","sourceRoot":"","sources":["../src/setViewportPlugin.ts"],"names":[],"mappings":";;;AAaA,SAAS,QAAQ,CAAC,OAAgB;IAChC,OAAO,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;AACxD,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAgB;IACxC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IAC9E,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACjF,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAChF,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAC5F,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IAC3F,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI;QAC1B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI;QAC1B,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAC;IAC/E,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAgB,iBAAiB;IAC/B,OAAO;QACL,IAAI,EAAE,sBAAsB;QAE5B,KAAK,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;YAChD,IAAI,OAAO,KAAK,cAAc,EAAE;gBAC9B,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE;oBAC9B,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;iBACvD;gBAED,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE;oBACxC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA0B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACrE,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;oBAChC,OAAO,IAAI,CAAC;iBACb;gBAED,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE;oBACzC,MAAM,IAAI,GAAI,OAAO,CAAC,OAA8B,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACzE,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;oBACpC,OAAO,IAAI,CAAC;iBACb;gBAED,MAAM,IAAI,KAAK,CACb,sDAAsD,OAAO,CAAC,OAAO,CAAC,IAAI,GAAG,CAC9E,CAAC;aACH;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AA5BD,8CA4BC"}

package/dist/snapshotPlugin.d.ts

@@ -0,0 +1,10 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+export interface SaveSnapshotPayload {
+    name: string;
+    content: string;
+}
+export interface SnapshotPluginConfig {
+    updateSnapshots?: boolean;
+}
+export declare function snapshotPlugin(config?: SnapshotPluginConfig): TestRunnerPlugin;
+//# sourceMappingURL=snapshotPlugin.d.ts.map

package/dist/snapshotPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotPlugin.d.ts","sourceRoot":"","sources":["../src/snapshotPlugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAyBzD,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB;AAuHD,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED,wBAAgB,cAAc,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,gBAAgB,CAoD9E"}

package/dist/snapshotPlugin.js

@@ -0,0 +1,177 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.snapshotPlugin = void 0;
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const util_1 = require("util");
+const mkdirp_1 = __importDefault(require("mkdirp"));
+const readFile = util_1.promisify(fs_1.default.readFile);
+const writeFile = util_1.promisify(fs_1.default.writeFile);
+const unlink = util_1.promisify(fs_1.default.unlink);
+const access = util_1.promisify(fs_1.default.access);
+async function fileExists(filePath) {
+    try {
+        await access(filePath);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+function isObject(payload) {
+    return payload != null && typeof payload === 'object';
+}
+function isSaveSnapshotPayload(payload) {
+    if (!isObject(payload))
+        throw new Error('You must provide a payload object');
+    if (typeof payload.name !== 'string')
+        throw new Error('You must provide a path option');
+    if (payload.content !== undefined && typeof payload.content !== 'string')
+        throw new Error('You must provide a content option');
+    return true;
+}
+function getSnapshotPath(testFile) {
+    const testDir = path_1.default.dirname(testFile);
+    const testFileName = path_1.default.basename(testFile);
+    const ext = path_1.default.extname(testFileName);
+    const fileWithoutExt = testFileName.substring(0, testFileName.length - ext.length);
+    return path_1.default.join(testDir, '__snapshots__', `${fileWithoutExt}.snap.js`);
+}
+class SnapshotStore {
+    constructor() {
+        this.snapshots = new Map();
+        this.sessionToSnapshotPath = new Map();
+        this.readOperations = new Map();
+    }
+    async get(testFilePath) {
+        var _a, _b;
+        const snapshotPath = getSnapshotPath(testFilePath);
+        if (this.readOperations.has(snapshotPath)) {
+            // something else is already reading, wait for it
+            await ((_a = this.readOperations.get(snapshotPath)) === null || _a === void 0 ? void 0 : _a.promise);
+        }
+        const cachedContent = this.snapshots.get(snapshotPath);
+        if (cachedContent) {
+            // return from cache
+            return cachedContent;
+        }
+        const promiseObj = { resolve: () => { }, promise: Promise.resolve() };
+        promiseObj.promise = new Promise(resolve => {
+            promiseObj.resolve = resolve;
+        });
+        this.readOperations.set(testFilePath, promiseObj);
+        // store in cache
+        const content = (await fileExists(snapshotPath))
+            ? await readFile(snapshotPath, 'utf-8')
+            : '/* @web/test-runner snapshot v1 */\nexport const snapshots = {};\n\n';
+        this.snapshots.set(snapshotPath, content);
+        // resolve read promise to let others who are waiting continue
+        (_b = this.readOperations.get(snapshotPath)) === null || _b === void 0 ? void 0 : _b.resolve();
+        this.readOperations.delete(snapshotPath);
+        return content;
+    }
+    async saveSnapshot(sessionId, testFilePath, name, updatedSnapshot) {
+        const snapshotPath = getSnapshotPath(testFilePath);
+        const nameStr = JSON.stringify(name);
+        const startMarker = `snapshots[${nameStr}]`;
+        const endMarker = `/* end snapshot ${name} */\n\n`;
+        const replacement = updatedSnapshot
+            ? `${startMarker} = \n\`${updatedSnapshot}\`;\n${endMarker}`
+            : '';
+        const content = await this.get(testFilePath);
+        let updatedContent;
+        const startIndex = content.indexOf(startMarker);
+        if (startIndex !== -1) {
+            // replace existing snapshot
+            const endIndex = content.indexOf(endMarker);
+            if (endIndex === -1) {
+                throw new Error('Missing snapshot end marker');
+            }
+            const beforeReplace = content.substring(0, startIndex);
+            const afterReplace = content.substring(endIndex + endMarker.length);
+            updatedContent = `${beforeReplace}${replacement}${afterReplace}`;
+        }
+        else {
+            // add new snapshot
+            updatedContent = `${content}${replacement}`;
+        }
+        if (updatedContent === content) {
+            // snapshot did not actually change, avoid marking snapshot as dirty
+            return;
+        }
+        this.sessionToSnapshotPath.set(sessionId, snapshotPath);
+        this.snapshots.set(snapshotPath, updatedContent);
+    }
+    getSnapshotPathForSession(sessionId) {
+        return this.sessionToSnapshotPath.get(sessionId);
+    }
+    async writeSnapshot(snapshotPath) {
+        const updatedContent = this.snapshots.get(snapshotPath);
+        if (!updatedContent) {
+            throw new Error('Unexpected error while writing snapshots, could not find snapshot content.');
+        }
+        if (updatedContent.includes('/* end snapshot')) {
+            // update or create snapshot
+            const fileDir = path_1.default.dirname(snapshotPath);
+            await mkdirp_1.default(fileDir);
+            await writeFile(snapshotPath, updatedContent);
+        }
+        else {
+            // snapshot file is empty, remove it
+            if (await fileExists(snapshotPath)) {
+                await unlink(snapshotPath);
+            }
+        }
+    }
+}
+function snapshotPlugin(config) {
+    const updateSnapshots = config && config.updateSnapshots;
+    const snapshots = new SnapshotStore();
+    const writePromises = new Set();
+    return {
+        name: 'file-commands',
+        serverStart({ webSockets }) {
+            webSockets.on('message', async ({ data }) => {
+                const { type, sessionId } = data;
+                if (type === 'wtr-session-finished') {
+                    if (typeof sessionId !== 'string') {
+                        throw new Error('Missing session id in wtr-session-finished event');
+                    }
+                    const snapshotPath = snapshots.getSnapshotPathForSession(sessionId);
+                    if (!snapshotPath) {
+                        return;
+                    }
+                    const writePromise = snapshots.writeSnapshot(snapshotPath);
+                    writePromises.add(writePromise);
+                    await writePromise;
+                    writePromises.delete(writePromise);
+                }
+            });
+        },
+        async serverStop() {
+            // ensure all write operations are finished
+            await Promise.all([...writePromises]);
+        },
+        async executeCommand({ command, payload, session }) {
+            if (command === 'get-snapshot-config') {
+                return { updateSnapshots };
+            }
+            if (command === 'get-snapshots') {
+                const content = await snapshots.get(session.testFile);
+                return { content };
+            }
+            if (command === 'save-snapshot') {
+                if (!isSaveSnapshotPayload(payload)) {
+                    throw new Error('Invalid save snapshot payload');
+                }
+                await snapshots.saveSnapshot(session.id, session.testFile, payload.name, payload.content);
+                return true;
+            }
+        },
+    };
+}
+exports.snapshotPlugin = snapshotPlugin;
+//# sourceMappingURL=snapshotPlugin.js.map

package/dist/snapshotPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshotPlugin.js","sourceRoot":"","sources":["../src/snapshotPlugin.ts"],"names":[],"mappings":";;;;;;AAGA,gDAAwB;AACxB,4CAAoB;AACpB,+BAAiC;AACjC,oDAA4B;AAE5B,MAAM,QAAQ,GAAG,gBAAS,CAAC,YAAE,CAAC,QAAQ,CAAC,CAAC;AACxC,MAAM,SAAS,GAAG,gBAAS,CAAC,YAAE,CAAC,SAAS,CAAC,CAAC;AAC1C,MAAM,MAAM,GAAG,gBAAS,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;AACpC,MAAM,MAAM,GAAG,gBAAS,CAAC,YAAE,CAAC,MAAM,CAAC,CAAC;AAEpC,KAAK,UAAU,UAAU,CAAC,QAAgB;IACxC,IAAI;QACF,MAAM,MAAM,CAAC,QAAQ,CAAC,CAAC;QACvB,OAAO,IAAI,CAAC;KACb;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAED,SAAS,QAAQ,CAAC,OAAgB;IAChC,OAAO,OAAO,IAAI,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,CAAC;AACxD,CAAC;AAOD,SAAS,qBAAqB,CAAC,OAAgB;IAC7C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAC7E,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACxF,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;QACtE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,eAAe,CAAC,QAAgB;IACvC,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACvC,MAAM,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7C,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACvC,MAAM,cAAc,GAAG,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC;IACnF,OAAO,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,cAAc,UAAU,CAAC,CAAC;AAC1E,CAAC;AAED,MAAM,aAAa;IAAnB;QACU,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QACtC,0BAAqB,GAAG,IAAI,GAAG,EAAkB,CAAC;QAClD,mBAAc,GAAG,IAAI,GAAG,EAA2D,CAAC;IAgG9F,CAAC;IA9FC,KAAK,CAAC,GAAG,CAAC,YAAoB;;QAC5B,MAAM,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QAEnD,IAAI,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE;YACzC,iDAAiD;YACjD,aAAM,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,0CAAE,OAAO,CAAA,CAAC;SACtD;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACvD,IAAI,aAAa,EAAE;YACjB,oBAAoB;YACpB,OAAO,aAAa,CAAC;SACtB;QAED,MAAM,UAAU,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QACrE,UAAU,CAAC,OAAO,GAAG,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE;YAC/C,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;QAC/B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QAClD,iBAAiB;QACjB,MAAM,OAAO,GAAG,CAAC,MAAM,UAAU,CAAC,YAAY,CAAC,CAAC;YAC9C,CAAC,CAAC,MAAM,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;YACvC,CAAC,CAAC,sEAAsE,CAAC;QAC3E,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;QAE1C,8DAA8D;QAC9D,MAAA,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,0CAAE,OAAO,GAAG;QACjD,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QACzC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,SAAiB,EACjB,YAAoB,EACpB,IAAY,EACZ,eAAuB;QAEvB,MAAM,YAAY,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,WAAW,GAAG,aAAa,OAAO,GAAG,CAAC;QAC5C,MAAM,SAAS,GAAG,mBAAmB,IAAI,SAAS,CAAC;QACnD,MAAM,WAAW,GAAG,eAAe;YACjC,CAAC,CAAC,GAAG,WAAW,UAAU,eAAe,QAAQ,SAAS,EAAE;YAC5D,CAAC,CAAC,EAAE,CAAC;QAEP,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAC7C,IAAI,cAAsB,CAAC;QAE3B,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAChD,IAAI,UAAU,KAAK,CAAC,CAAC,EAAE;YACrB,4BAA4B;YAC5B,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC5C,IAAI,QAAQ,KAAK,CAAC,CAAC,EAAE;gBACnB,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAChD;YAED,MAAM,aAAa,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;YACvD,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YAEpE,cAAc,GAAG,GAAG,aAAa,GAAG,WAAW,GAAG,YAAY,EAAE,CAAC;SAClE;aAAM;YACL,mBAAmB;YACnB,cAAc,GAAG,GAAG,OAAO,GAAG,WAAW,EAAE,CAAC;SAC7C;QACD,IAAI,cAAc,KAAK,OAAO,EAAE;YAC9B,oEAAoE;YACpE,OAAO;SACR;QAED,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,yBAAyB,CAAC,SAAiB;QACzC,OAAO,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,YAAoB;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;SAC/F;QACD,IAAI,cAAc,CAAC,QAAQ,CAAC,iBAAiB,CAAC,EAAE;YAC9C,4BAA4B;YAC5B,MAAM,OAAO,GAAG,cAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC3C,MAAM,gBAAM,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM,SAAS,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;SAC/C;aAAM;YACL,oCAAoC;YACpC,IAAI,MAAM,UAAU,CAAC,YAAY,CAAC,EAAE;gBAClC,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;aAC5B;SACF;IACH,CAAC;CACF;AAMD,SAAgB,cAAc,CAAC,MAA6B;IAC1D,MAAM,eAAe,GAAG,MAAM,IAAI,MAAM,CAAC,eAAe,CAAC;IACzD,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAC;IACtC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAiB,CAAC;IAE/C,OAAO;QACL,IAAI,EAAE,eAAe;QAErB,WAAW,CAAC,EAAE,UAAU,EAAqB;YAC3C,UAAW,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;gBAC3C,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;gBACjC,IAAI,IAAI,KAAK,sBAAsB,EAAE;oBACnC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE;wBACjC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;qBACrE;oBACD,MAAM,YAAY,GAAG,SAAS,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;oBACpE,IAAI,CAAC,YAAY,EAAE;wBACjB,OAAO;qBACR;oBACD,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;oBAC3D,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;oBAChC,MAAM,YAAY,CAAC;oBACnB,aAAa,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;iBACpC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,KAAK,CAAC,UAAU;YACd,2CAA2C;YAC3C,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;QACxC,CAAC;QAED,KAAK,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE;YAChD,IAAI,OAAO,KAAK,qBAAqB,EAAE;gBACrC,OAAO,EAAE,eAAe,EAAE,CAAC;aAC5B;YAED,IAAI,OAAO,KAAK,eAAe,EAAE;gBAC/B,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBACtD,OAAO,EAAE,OAAO,EAAE,CAAC;aACpB;YAED,IAAI,OAAO,KAAK,eAAe,EAAE;gBAC/B,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE;oBACnC,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;iBAClD;gBAED,MAAM,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;gBAC1F,OAAO,IAAI,CAAC;aACb;QACH,CAAC;KACF,CAAC;AACJ,CAAC;AApDD,wCAoDC"}

package/index.d.ts

@@ -0,0 +1,2 @@
+// this file is autogenerated with the generate-mjs-dts-entrypoints script
+export * from './browser/commands';

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@web/test-runner-commands",
+  "version": "0.0.0-canary-20230403143511",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Web test runner commands",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/modernweb-dev/web.git",
+    "directory": "packages/test-runner-commands"
+  },
+  "author": "modern-web",
+  "homepage": "https://github.com/modernweb-dev/web/tree/master/packages/test-runner-commands",
+  "main": "browser/commands.mjs",
+  "exports": {
+    ".": {
+      "types": "./browser/commands.d.ts",
+      "default": "./browser/commands.mjs"
+    },
+    "./plugins": {
+      "import": "./plugins.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "mocha test/**/*.test.ts --require ts-node/register",
+    "test:watch": "mocha test/**/*.test.ts --require ts-node/register --watch --watch-files src,test --watch-ignore **/*.snap.js"
+  },
+  "files": [
+    "*.d.ts",
+    "*.js",
+    "*.mjs",
+    "browser",
+    "dist",
+    "src"
+  ],
+  "keywords": [
+    "web",
+    "test",
+    "runner",
+    "testrunner",
+    "commands"
+  ],
+  "dependencies": {
+    "@web/test-runner-core": "0.0.0-canary-20230403143511",
+    "mkdirp": "^1.0.4"
+  },
+  "devDependencies": {
+    "@web/test-runner-chrome": "0.0.0-canary-20230403143511",
+    "@web/test-runner-playwright": "0.0.0-canary-20230403143511",
+    "@web/test-runner-webdriver": "^0.5.1",
+    "mocha": "^8.2.1"
+  }
+}

package/plugins.d.ts

@@ -0,0 +1,2 @@
+// this file is autogenerated with the generate-mjs-dts-entrypoints script
+export * from './dist/index';

package/plugins.js

@@ -0,0 +1,2 @@
+// this file exists to make the import for /plugins work on node v10
+module.exports = require('./dist/index');

package/plugins.mjs

@@ -0,0 +1,24 @@
+// this file is autogenerated with the generate-mjs-dts-entrypoints script
+import cjsEntrypoint from './dist/index.js';
+
+const {
+  setViewportPlugin,
+  emulateMediaPlugin,
+  setUserAgentPlugin,
+  sendKeysPlugin,
+  sendMousePlugin,
+  a11ySnapshotPlugin,
+  filePlugin,
+  snapshotPlugin,
+} = cjsEntrypoint;
+
+export {
+  setViewportPlugin,
+  emulateMediaPlugin,
+  setUserAgentPlugin,
+  sendKeysPlugin,
+  sendMousePlugin,
+  a11ySnapshotPlugin,
+  filePlugin,
+  snapshotPlugin,
+};

package/src/a11ySnapshotPlugin.ts

@@ -0,0 +1,53 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+import type { ChromeLauncher, puppeteerCore } from '@web/test-runner-chrome';
+import type { PlaywrightLauncher, playwright } from '@web/test-runner-playwright';
+
+export type A11ySnapshotPayload = { selector?: string };
+
+export function a11ySnapshotPlugin(): TestRunnerPlugin<A11ySnapshotPayload> {
+  return {
+    name: 'a11y-snapshot-command',
+    async executeCommand({ command, payload, session }): Promise<any> {
+      if (command === 'a11y-snapshot') {
+        // handle specific behavior for playwright
+        if (session.browser.type === 'playwright') {
+          const page = (session.browser as PlaywrightLauncher).getPage(session.id);
+          const options: {
+            root?: playwright.ElementHandle;
+          } = {};
+          if (payload && payload.selector) {
+            const root = await page.$(payload.selector);
+            if (root) {
+              options.root = root;
+            }
+          }
+          const snapshot = await page.accessibility.snapshot(options);
+          return snapshot;
+        }
+
+        // handle specific behavior for puppeteer
+        if (session.browser.type === 'puppeteer') {
+          const page = (session.browser as ChromeLauncher).getPage(session.id);
+          const options: {
+            root?: puppeteerCore.ElementHandle;
+          } = {};
+          if (payload && payload.selector) {
+            // @ts-ignore
+            const root = await page.$(payload.selector);
+            if (root) {
+              options.root = root;
+            }
+          }
+          // @ts-ignore
+          const snapshot = await page.accessibility.snapshot(options);
+          return snapshot;
+        }
+
+        // you might not be able to support all browser launchers
+        throw new Error(
+          `Acessibility snapshot is not supported for browser type ${session.browser.type}.`,
+        );
+      }
+    },
+  };
+}

package/src/emulateMediaPlugin.ts

@@ -0,0 +1,75 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+import type { ChromeLauncher } from '@web/test-runner-chrome';
+import type { PlaywrightLauncher } from '@web/test-runner-playwright';
+
+export interface Media {
+  media?: 'screen' | 'print';
+  colorScheme?: 'dark' | 'light' | 'no-preference';
+  reducedMotion?: 'reduce' | 'no-preference';
+  forcedColors?: 'active' | 'none';
+}
+
+function isObject(payload: unknown): payload is Record<string, unknown> {
+  return payload != null && typeof payload === 'object';
+}
+
+function isMediaObject(payload: unknown): payload is Media {
+  if (!isObject(payload)) throw new Error('You must provide a viewport object');
+
+  if (payload.media != null && !(typeof payload.media === 'string')) {
+    throw new Error('media should be a string.');
+  }
+
+  if (payload.colorScheme != null && !(typeof payload.colorScheme === 'string')) {
+    throw new Error('colorScheme should be a string.');
+  }
+
+  if (payload.reducedMotion != null && !(typeof payload.reducedMotion === 'string')) {
+    throw new Error('reducedMotion should be a string.');
+  }
+  return true;
+}
+
+export function emulateMediaPlugin(): TestRunnerPlugin {
+  return {
+    name: 'emulate-media-command',
+
+    async executeCommand({ command, payload, session }) {
+      if (command === 'emulate-media') {
+        if (!isMediaObject(payload)) {
+          throw new Error('You must provide a viewport object');
+        }
+
+        if (session.browser.type === 'puppeteer') {
+          const page = (session.browser as ChromeLauncher).getPage(session.id);
+          const features = [];
+
+          if (payload.colorScheme != null) {
+            features.push({ name: 'prefers-color-scheme', value: payload.colorScheme });
+          }
+          if (payload.reducedMotion != null) {
+            features.push({ name: 'prefers-reduced-motion', value: payload.reducedMotion });
+          }
+
+          await page.emulateMediaFeatures(features);
+
+          if (payload.media) {
+            await page.emulateMediaType(payload.media);
+          }
+
+          return true;
+        }
+
+        if (session.browser.type === 'playwright') {
+          const page = (session.browser as PlaywrightLauncher).getPage(session.id);
+          await page.emulateMedia(payload as any);
+          return true;
+        }
+
+        throw new Error(
+          `Setting viewport is not supported for browser type ${session.browser.type}.`,
+        );
+      }
+    },
+  };
+}

package/src/filePlugin.ts

@@ -0,0 +1,108 @@
+import { TestRunnerPlugin } from '@web/test-runner-core';
+import path from 'path';
+import fs from 'fs';
+import { promisify } from 'util';
+import mkdirp from 'mkdirp';
+
+const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
+const unlink = promisify(fs.unlink);
+const access = promisify(fs.access);
+
+async function fileExists(filePath: string) {
+  try {
+    await access(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function isObject(payload: unknown): payload is Record<string, unknown> {
+  return payload != null && typeof payload === 'object';
+}
+
+export interface WriteFilePayload {
+  path: string;
+  content: string;
+  encoding?: BufferEncoding;
+}
+
+export interface ReadFilePayload {
+  path: string;
+  encoding?: BufferEncoding;
+}
+
+export interface RemoveFilePayload {
+  path: string;
+}
+
+function isWriteFilePayload(payload: unknown): payload is WriteFilePayload {
+  if (!isObject(payload)) throw new Error('You must provide a payload object');
+  if (typeof payload.path !== 'string') throw new Error('You must provide a path option');
+  if (typeof payload.content !== 'string') throw new Error('You must provide a content option');
+  return true;
+}
+
+function isReadFilePayload(payload: unknown): payload is ReadFilePayload {
+  if (!isObject(payload)) throw new Error('You must provide a payload object');
+  if (typeof payload.path !== 'string') throw new Error('You must provide a path option');
+  return true;
+}
+
+function isRemoveFilePayload(payload: unknown): payload is RemoveFilePayload {
+  if (!isObject(payload)) throw new Error('You must provide a payload object');
+  if (typeof payload.path !== 'string') throw new Error('You must provide a path option');
+  return true;
+}
+
+function joinFilePath(testFile: string, relativePath: string) {
+  if (path.isAbsolute(relativePath)) {
+    throw new Error('file path must not be an absolute path.');
+  }
+  const dir = path.dirname(testFile);
+  return path.join(dir, relativePath.split('/').join(path.sep));
+}
+
+export function filePlugin(): TestRunnerPlugin {
+  return {
+    name: 'file-commands',
+
+    async executeCommand({ command, payload, session }) {
+      if (command === 'write-file') {
+        if (!isWriteFilePayload(payload)) {
+          throw new Error('You must provide a payload object');
+        }
+
+        const filePath = joinFilePath(session.testFile, payload.path);
+        const fileDir = path.dirname(filePath);
+        await mkdirp(fileDir);
+        await writeFile(filePath, payload.content, payload.encoding || 'utf-8');
+        return true;
+      }
+
+      if (command === 'read-file') {
+        if (!isReadFilePayload(payload)) {
+          throw new Error('You must provide a payload object');
+        }
+
+        const filePath = joinFilePath(session.testFile, payload.path);
+        if (await fileExists(filePath)) {
+          return readFile(filePath, payload.encoding || 'utf-8');
+        } else {
+          return undefined;
+        }
+      }
+
+      if (command === 'remove-file') {
+        if (!isRemoveFilePayload(payload)) {
+          throw new Error('You must provide a payload object');
+        }
+
+        const filePath = joinFilePath(session.testFile, payload.path);
+        await unlink(filePath);
+        return true;
+      }
+    },
+  };
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+export { Viewport, setViewportPlugin } from './setViewportPlugin';
+export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
+export { setUserAgentPlugin } from './setUserAgentPlugin';
+export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';
+export { sendMousePlugin, SendMousePayload } from './sendMousePlugin';
+export { a11ySnapshotPlugin, A11ySnapshotPayload } from './a11ySnapshotPlugin';
+export { WriteFilePayload, ReadFilePayload, RemoveFilePayload, filePlugin } from './filePlugin';
+export { SaveSnapshotPayload, SnapshotPluginConfig, snapshotPlugin } from './snapshotPlugin';