@knapsack-pro/playwright 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2025 Knapsack Sp. z o.o. https://knapsackpro.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,58 @@
+# @knapsack-pro/playwright
+
+<p align="center">
+  <a href="https://knapsackpro.com?utm_source=github&utm_medium=readme&utm_campaign=knapsack-pro-playwright&utm_content=hero_logo">
+    <img alt="Knapsack Pro" src="./.github/assets/knapsack.png" width="300" height="300" style="max-width: 100%;" />
+  </a>
+</p>
+
+<h3 align="center">Speed up your tests</h3>
+<p align="center">Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure</p>
+
+---
+
+<div align="center">
+  <a href="https://circleci.com/gh/KnapsackPro/knapsack-pro-js">
+    <img alt="Circle CI" src="https://circleci.com/gh/KnapsackPro/knapsack-pro-js.svg?style=svg" />
+  </a>
+</div>
+
+<br />
+<br />
+
+Knapsack Pro wraps [Playwright](https://playwright.dev/) and works with your existing CI infrastructure to parallelize tests optimally:
+
+- Dynamically splits your tests based on up-to-date test execution data
+- Is designed from the ground up for CI and supports all of them
+- Tracks your CI builds to detect bottlenecks
+- Does not have access to your source code and collects minimal test data
+- Enables you to export historical metrics about your CI builds
+- Replaces local dependencies like Redis with an API and runs your tests regardless of network problems
+
+## Installation
+
+See the [docs](https://docs.knapsackpro.com/playwright/guide/) to get started:
+
+<div align="center">
+  <a href="https://docs.knapsackpro.com/playwright/guide/">
+    <img alt="Install button" src="./.github/assets/install-button.png" width="116" height="50" />
+  </a>
+</div>
+
+## Dependencies
+
+- [@knapsack-pro/core](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/core)
+
+## Contributing
+
+Follow the steps in the [root README.md](https://github.com/KnapsackPro/knapsack-pro-js#contributing) to set up the project.
+
+### Testing
+
+To test `@knapsack-pro/playwright` against a real test suite we use:
+
+- [playwright-example-test-suite](https://github.com/KnapsackPro/knapsack-pro-js/tree/main/packages/playwright-example-test-suite)
+
+### Publishing
+
+See [Publishing](../../#publishing) in the root README.md.

package/lib/knapsack-playwright.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+import { readFileSync, mkdirSync, rmSync } from 'fs';
+import { execSync, spawnSync } from 'child_process';
+import pkg from '@knapsack-pro/playwright/package.json' with { type: 'json' };
+import { KnapsackProCore, KnapsackProLogger, } from '@knapsack-pro/core';
+if (process.env.KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT) {
+    process.env.KNAPSACK_PRO_TEST_SUITE_TOKEN =
+        process.env.KNAPSACK_PRO_TEST_SUITE_TOKEN_PLAYWRIGHT;
+}
+async function main() {
+    const knapsackProLogger = new KnapsackProLogger();
+    knapsackProLogger.debug(`Running ${pkg.name}@${pkg.version}`);
+    mkdirSync('.knapsack-pro', { recursive: true });
+    const cliArguments = process.argv.slice(2).join(' ');
+    knapsackProLogger.debug(`cliArguments: ${cliArguments}`);
+    const command = `npx playwright test --list ${cliArguments} --reporter=@knapsack-pro/playwright/reporters/list`;
+    knapsackProLogger.debug(`Executing: ${command}`);
+    execSync(command, { stdio: 'ignore' });
+    const tests = JSON.parse(readFileSync('.knapsack-pro/list.json', 'utf8'));
+    knapsackProLogger.debug(`Tests to run: ${tests}`);
+    const knapsackPro = new KnapsackProCore(pkg.name, pkg.version, () => tests.map((testFilePath) => ({ path: testFilePath })));
+    const onSuccess = async (testFiles) => {
+        const paths = testFiles.map((testFile) => testFile.path).join(' ');
+        const command = `PWTEST_BLOB_DO_NOT_REMOVE=1 npx playwright test ${cliArguments} ${paths}`;
+        knapsackProLogger.debug(`Executing: ${command}`);
+        spawnSync(command, { shell: true, stdio: 'inherit' });
+        const batch = readFileSync('.knapsack-pro/batch.json', 'utf8');
+        rmSync('.knapsack-pro/batch.json');
+        return JSON.parse(batch);
+    };
+    const onError = () => { };
+    knapsackPro.runQueueMode(onSuccess, onError);
+}
+main();

package/lib/reporters/batch.js

@@ -0,0 +1,44 @@
+import { writeFileSync, mkdirSync } from 'fs';
+import { pathWithRootDir } from './utils.js';
+class BatchReporter {
+    config;
+    tally;
+    constructor() {
+        this.tally = new Map();
+    }
+    version() {
+        return 'v2';
+    }
+    printsToStdio() {
+        return false;
+    }
+    onConfigure(config) {
+        this.config = config;
+    }
+    onTestEnd(test, result) {
+        if (result.status !== 'passed')
+            return;
+        const duration = result.duration / 1000;
+        const path = pathWithRootDir(test, this.config);
+        const current = this.tally.get(path);
+        if (current) {
+            this.tally.set(path, current + duration);
+        }
+        else {
+            this.tally.set(path, duration);
+        }
+    }
+    onEnd(result) {
+        const recordedTestFiles = Array.from(this.tally).map(([path, duration]) => ({
+            path,
+            time_execution: duration,
+        }));
+        const res = {
+            recordedTestFiles,
+            isTestSuiteGreen: result.status === 'passed',
+        };
+        mkdirSync('.knapsack-pro', { recursive: true });
+        writeFileSync('.knapsack-pro/batch.json', JSON.stringify(res));
+    }
+}
+export default BatchReporter;

package/lib/reporters/list.js

@@ -0,0 +1,22 @@
+import { writeFileSync } from 'fs';
+import { pathWithRootDir } from './utils.js';
+class ListReporter {
+    config;
+    version() {
+        return 'v2';
+    }
+    printsToStdio() {
+        return true;
+    }
+    onConfigure(config) {
+        this.config = config;
+    }
+    onBegin(suite) {
+        const paths = new Set();
+        suite
+            .allTests()
+            .forEach((test) => paths.add(pathWithRootDir(test, this.config)));
+        writeFileSync('.knapsack-pro/list.json', JSON.stringify(Array.from(paths)));
+    }
+}
+export default ListReporter;

package/lib/reporters/reporterV2.js

@@ -0,0 +1 @@
+export {};

package/lib/reporters/utils.js

@@ -0,0 +1,5 @@
+import { relative, basename, join } from 'path';
+export const pathWithRootDir = (test, config) => {
+    const relativeFile = relative(config.rootDir, test.location.file);
+    return join(basename(config.rootDir), relativeFile);
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@knapsack-pro/playwright",
+  "type": "module",
+  "version": "0.1.0",
+  "description": "Knapsack Pro Playwright splits Playwright tests across CI nodes and makes sure that tests will run in optimal time on each CI node.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/KnapsackPro/knapsack-pro-js.git",
+    "directory": "packages/playwright"
+  },
+  "keywords": [
+    "knapsack",
+    "knapsack pro",
+    "playwright",
+    "test suite parallelisation",
+    "parallelisation",
+    "testing",
+    "test",
+    "automation",
+    "integration",
+    "runner",
+    "CI"
+  ],
+  "author": "Knapsack Pro <support@knapsackpro.com> (https://knapsackpro.com)",
+  "license": "MIT",
+  "scripts": {
+    "build": "rm -rf lib && tsc && chmod u+x lib/knapsack-playwright.js"
+  },
+  "files": [
+    "lib"
+  ],
+  "bin": {
+    "knapsack-pro-playwright": "lib/knapsack-playwright.js"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    "./reporters/batch": "./lib/reporters/batch.js",
+    "./reporters/list": "./lib/reporters/list.js"
+  },
+  "dependencies": {
+    "@knapsack-pro/core": "^9.0.0"
+  },
+  "peerDependencies": {
+    "playwright": ">=1.50.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.9.2",
+    "playwright": "^1.56.1",
+    "typescript": "^5.9.3"
+  }
+}