@dionlarson/playwright-orchestrator-core 1.3.0

package/LICENSE.md

@@ -0,0 +1,190 @@
+      Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2025 Rostyslav Kudrevatykh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,279 @@
+# Playwright Orchestrator
+
+A CLI tool for orchestrating and managing Playwright test execution.
+
+Helps to orchestrate Playwright test execution through smart sharding using existing database.
+
+![Timeline](https://github.com/rostmanrk/playwright-orchestrator/raw/main/assets/timeline.png)
+
+## 🎯 Overview
+
+The project provides tooling to analyze and orchestrate Playwright tests using available storage plugin options. Currently available plugin options:
+
+- file: Basic storage that uses a local file as storage.
+- dynamo-db: Amazon's DynamoDB adapter.
+- pg: PostgreSQL adapter.
+- mysql: MySQL adapter.
+- mongo: MongoDB adapter.
+
+**Tests are ordered as follows:**
+
+1. If there are no previous test runs, use the default timeout.
+2. Take the [EMA (Exponential Moving Average)](https://en.wikipedia.org/wiki/Moving_average#Exponential_moving_average) of the test duration. The window size can be changed in [`create`](#create) command, default value is 10.
+3. If there was a failed test in the chosen window, it is more likely to fail again. Therefore, the formula is adjusted as follows:
+
+    - Calculate the EMA of the test duration.
+    - Adjust the EMA by adding a factor based on the percentage of failed tests in the window.
+    - The final formula is: `EMA + EMA * (% of failed tests in window)`
+
+    **Example:**
+
+    - If the EMA of the test duration is 2 minutes and 4 of 10 tests in the window failed, the adjusted duration would be:
+      `2 + 2 * 0.4 = 2.8 minutes`
+
+**Serial tests duration is a sum of all included tests.**
+
+### Test identifiers
+
+In order to keep history of tests, they need to be identified. There are multiple possible cases:
+
+1. Default id: `[{project}] {file} > {title of the test}`.
+2. Serial test id: `[{project}] {file} > {title of the parent group}`.
+3. Serial test defined at the file level: `[{project}] {file}`.
+4. Custom Id: `[{project}] {custom id}`.
+
+In case some of these attributes changed, test history would be recreated. To preserve test history between changes, you can add a **static** attribute. Adding an id to an existing test would recreate the history as well.
+
+**✅ Examples**
+
+```
+import { id } from '@playwright-orchestrator/core/annotations';
+test('test', { annotation: id('#custom_id') }, () => {
+    // test code
+}
+```
+
+```
+import { id } from '@playwright-orchestrator/core/annotations';
+test.describe('serial tests', { annotation: id('#custom_id') }, () => {
+    // test code
+}
+```
+
+**❌ This won't work**
+
+```
+import { id } from '@playwright-orchestrator/core/annotations';
+test.describe('test', () => {
+    test.info().annotations.push(id('#custom_id'));
+    // test code
+}
+```
+
+## 📦 Installation
+
+Make sure Playwright is installed by following [Playwright's installation guide](https://playwright.dev/docs/intro#installation).
+
+```bash
+npm install @playwright-orchestrator/core --save-dev
+
+npm install @playwright-orchestrator/<storage_plugin_name> --save-dev
+```
+
+## 🚀 Usage
+
+Run the CLI tool:
+
+```bash
+npx playwright-orchestrator <command> <storage_type> [options]
+```
+
+## 📝 Example
+
+- [Mongo](/.github/workflows/mongo.yml)
+
+- [DynamoDB](/.github/workflows/dynamo-db.yml)
+
+- [PostgreSQL](/.github/workflows/pg.yml)
+
+1. Run the `init` command. Required to run once to set up storage. Make sure that executing credentials have all permissions.
+
+```bash
+npx playwright-orchestrator init pg --connection-string "postgres://username:password@localhost:5432/postgres"
+```
+
+2. Run the `create` command. Required to run once per run.
+
+```bash
+npx playwright-orchestrator create pg --connection-string "postgres://username:password@localhost:5432/postgres" --workers 2
+> 019464f7-1488-75d1-b5c0-5e7d3dde9195
+```
+
+3. Start the desired count of shards using the `run` command. Run ID is generated in the previous step. All Playwright options are already saved in the previous step.
+
+```bash
+npx playwright-orchestrator run pg --connection-string "postgres://username:password@localhost:5432/postgres" --run-id 019464f7-1488-75d1-b5c0-5e7d3dde9195
+```
+
+4. Failed tests can be started again using step 3.
+
+5. Merge report using [Playwright's Merge-reports CLI](https://playwright.dev/docs/test-sharding#merge-reports-cli)
+
+```bash
+npx playwright merge-reports ./blob-reports --reporter html
+```
+
+## ⚙️ Commands and Options
+
+### `init`
+
+Seeds data storage with necessary tables and initial configuration.
+No additional options.
+
+### `create`
+
+Creates and configures a new test run. Outputs created run ID. Supports most of [playwright's options](https://playwright.dev/docs/test-cli#reference).
+
+| Option             | Description                                                                         | Type     | Default | Required? |
+| ------------------ | ----------------------------------------------------------------------------------- | -------- | ------- | --------- |
+| `--history-window` | Count of runs history kept and window for average duration. More [here](#-overview) | `number` | 10      | no        |
+
+### `run`
+
+Starts a test shard for the provided test run. If used with a finished run, it will only start failed tests.
+
+Command generate blob reports into `--output` directory. To merge it use [Playwright's Merge-reports CLI](https://playwright.dev/docs/test-sharding#merge-reports-cli)
+
+**`webServer` property is not supported and is ignored; make sure the app run beforehand.**
+
+| Option         | Description                               | Type     | Default        | Required? |
+| -------------- | ----------------------------------------- | -------- | -------------- | --------- |
+| `--run-id`     | Run ID generated by `create` command      | `string` | -              | yes       |
+| `-o, --output` | Directory for artifacts produced by tests | `string` | `blob_reports` | no        |
+
+### `create-report`
+
+Generates report for provided test run id.
+
+| Option       | Description                          | Type              | Default | Required? |
+| ------------ | ------------------------------------ | ----------------- | ------- | --------- |
+| `--run-id`   | Run ID generated by `create` command | `string`          | -       | yes       |
+| `--reporter` | Type of reporter                     | `'json' \| 'gha'` | `json`  | no        |
+
+<details>
+<summary>GHA Report Example</summary>
+
+![Example](https://github.com/rostmanrk/playwright-orchestrator/raw/main/assets/report-example.png)
+
+</details>
+
+## ⚙️ Subcommands and Options
+
+Each command has corresponding subcommands for installed storages.
+
+**Each storage option can be parsed from env variable**. For example, `table-name-prefix` -> TABLE_NAME_PREFIX.
+
+### `file`
+
+Use as a storage locally created file
+
+| Option        | Description                      | Type     | Default   | Required? |
+| ------------- | -------------------------------- | -------- | --------- | --------- |
+| `--directory` | Directory to store test run data | `string` | test-runs | no        |
+
+### `dynamo-db`
+
+Use Amazon's DynamoDB as storage. Credentials are taken from AWS profile
+
+| Option                | Description           | Type     | Default                   | Required? |
+| --------------------- | --------------------- | -------- | ------------------------- | --------- |
+| `--table-name-prefix` | Table(s) name prefix  | `string` | 'playwright-orchestrator' | no        |
+| `--ttl`               | TTL in days           | `number` | 30                        | no        |
+| `--endpoint-url`      | DynamoDB endpoint URL | `string` | -                         | no        |
+
+### `pg`
+
+Use PostgreSQL as storage.
+
+| Option                | Description          | Type     | Default                   | Required? |
+| --------------------- | -------------------- | -------- | ------------------------- | --------- |
+| `--connection-string` | Connection string    | `string` | -                         | yes       |
+| `--table-name-prefix` | Table(s) name prefix | `string` | 'playwright-orchestrator' | no        |
+| `--ssl-ca `           | SSL CA               | `string` | -                         | no        |
+| `--ssl-cert `         | SSL certificate      | `string` | -                         | no        |
+| `--ssl-key `          | SSL key              | `string` | -                         | no        |
+
+### `mysql`
+
+Use MySQL as storage.
+
+| Option                            | Description                                  | Type     | Default                   | Required? |
+| --------------------------------- | -------------------------------------------- | -------- | ------------------------- | --------- |
+| `--connection-string`             | Connection string                            | `string` | -                         | yes       |
+| `--table-name-prefix`             | Table(s) name prefix                         | `string` | 'playwright-orchestrator' | no        |
+| `--ssl-profile `                  | The SSL profile overrides other SSL options. | `string` | -                         | no        |
+| `--ssl-ca`                        | SSL CA                                       | `string` | -                         | no        |
+| `--ssl-cert`                      | SSL certificate                              | `string` | -                         | no        |
+| `--ssl-key`                       | SSL key                                      | `string` | -                         | no        |
+| `--ssl-passphrase`                | SSL passphrase                               | `string` | -                         | no        |
+| `--ssl-reject-unauthorized`       | SSL reject unauthorized                      | -        | -                         | no        |
+| `--ssl-verify-server-certificate` | SSL verify server certificate                | -        | -                         | no        |
+
+### `mongo`
+
+Use MongoDB as storage.
+
+| Option                             | Description                           | Type     | Default                   | Required? |
+| ---------------------------------- | ------------------------------------- | -------- | ------------------------- | --------- |
+| `--connection-string`              | Connection string                     | `string` | -                         | yes       |
+| `--db`                             | Database name                         | `string` | -                         | yes       |
+| `--collection-name-prefix`         | Table(s) name prefix                  | `string` | 'playwright-orchestrator' | no        |
+| `--tls`                            | Enable TLS                            | -        | -                         | no        |
+| `--tls-ca`                         | SSL CA                                | `string` | -                         | no        |
+| `--tls-key`                        | SSL key                               | `string` | -                         | no        |
+| `--tls-key-password`               | SSL key password                      | `string` | -                         | no        |
+| `--tls-passphrase`                 | SSL passphrase                        | `string` | -                         | no        |
+| `--tls-allow-invalid-certificates` | Allow invalid certificates            | -        | -                         | no        |
+| `--tls-allow-invalid-hostnames`    | Allow invalid hostnames               | -        | -                         | no        |
+| `--tls-allow-invalid-certificates` | Allow invalid certificates            | -        | -                         | no        |
+| `--tls-insecure`                   | Allow insecure                        | -        | -                         | no        |
+| `--debug`                          | Add extra fields for some collections | `string` | -                         | no        |
+
+## 💻 Development
+
+Make sure podman and compose is installed. They used for tests and local development.
+
+Build or use `npm run watch`.
+
+Make sure you run `npm run cli-permissions` and `npm run link-packages`
+
+See packages.json .scripts section for more commands.
+
+## ⚖️ License
+
+Licensed under the Apache License 2.0. See LICENSE.md for details.
+
+## 🔮 Future plans/ideas
+
+- ✅ ~~Tests~~
+- ✅ ~~Better Error Handling~~
+- ✅ ~~MySQL adapter~~
+- ✅ ~~MongoDB adapter~~
+- ✅ ~~Tests improvements~~
+- ✅ ~~Better Logging~~
+- ✅ ~~Test History statistics (test duration trends, count of test failures for past n days, etc.)~~
+- ✅ ~~Smarter test ordering based on previous execution duration~~
+- ✅ ~~GHA reporter~~
+- ⬜ Redis adapter
+- ⬜ Even more adapters (by request)
+- ⬜ More examples
+- ⬜ Create Documentation site.
+- ? Restore unfinished tests in case shard terminated (Can be simply fixed by creating new run)
+
+## ⚠️ Disclaimer
+
+This library was created in a couple weeks of free time, so issues may occur, but I try to address them as quickly as I can. Don't hesitate to create an issue report or contribute.
+
+## 🤝 Support
+
+For now, the best way to support this project is to star it on GitHub and share it with your colleagues or the community.

package/dist/adapter.d.ts

@@ -0,0 +1,20 @@
+import { TestItem, ResultTestParams, SaveTestRunParams, ReporterTestItem, TestSortItem, SortTestsOptions, GetTestIdParams } from './types/adapters.js';
+import { TestRunReport } from './types/reporter.js';
+import { TestRunConfig, TestRun } from './types/test-info.js';
+export declare abstract class Adapter {
+    abstract getNextTest(runId: string, config: TestRunConfig): Promise<TestItem | undefined>;
+    abstract finishTest(params: ResultTestParams): Promise<void>;
+    abstract failTest(params: ResultTestParams): Promise<void>;
+    abstract saveTestRun(params: SaveTestRunParams): Promise<void>;
+    abstract initialize(): Promise<void>;
+    abstract startShard(runId: string): Promise<TestRunConfig>;
+    abstract finishShard(runId: string): Promise<void>;
+    abstract getReportData(runId: string): Promise<TestRunReport>;
+    abstract dispose(): Promise<void>;
+    protected transformTestRunToItems(run: TestRun): ReporterTestItem[];
+    protected sortTests(tests: ReporterTestItem[], testInfoMap: Map<string, TestSortItem>, { historyWindow, reverse }: SortTestsOptions): ReporterTestItem[];
+    private extractCompareValue;
+    protected validateTests(tests: ReporterTestItem[]): void;
+    protected getTestId({ project, file, title, annotations }: GetTestIdParams): string;
+    protected calculateEMA(current: number, ema: number, window: number): number;
+}

package/dist/adapter.js

@@ -0,0 +1,65 @@
+import { ID_TYPE } from './playwright-tools/annotations.cjs';
+export class Adapter {
+    transformTestRunToItems(run) {
+        const tests = Object.entries(run)
+            .flatMap(([file, tests]) => {
+            return Object.entries(tests).flatMap(([position, { timeout, projects, title, annotations }]) => {
+                return projects.flatMap((project) => {
+                    const testId = this.getTestId({ project, file, title, annotations });
+                    return { testId, file, position, project, timeout };
+                });
+            });
+        })
+            .map((test, i) => ({ ...test, order: i + 1 }));
+        this.validateTests(tests);
+        return tests;
+    }
+    sortTests(tests, testInfoMap, { historyWindow, reverse }) {
+        const extractValue = this.extractCompareValue.bind(this, testInfoMap, historyWindow);
+        return tests
+            .sort((a, b) => (extractValue(b) - extractValue(a)) * (reverse ? -1 : 1))
+            .map((test, i) => ({ ...test, order: i + 1 }));
+    }
+    extractCompareValue(testInfoMap, historyWindow, test) {
+        const testInfo = testInfoMap.get(test.testId);
+        let value = test.timeout;
+        if (testInfo && testInfo.ema) {
+            value = testInfo.ema;
+        }
+        const fails = testInfo?.fails ?? 0;
+        if (fails > 0) {
+            value *= fails / historyWindow + 1;
+        }
+        return value;
+    }
+    validateTests(tests) {
+        const existingIds = new Map();
+        for (const test of tests) {
+            if (existingIds.has(test.testId)) {
+                const existing = existingIds.get(test.testId);
+                throw new Error([
+                    `Test ${existing.file}:${existing.position} has the same ID as ${test.file}:${test.position}.`,
+                    'Please make sure that each test has a unique ID annotation.',
+                    'If no ID annotation is provided, the `{file} > {title}` will be taken as ID.',
+                    'Or file name in case test is serial at the top level.',
+                ].join('\n'));
+            }
+            existingIds.set(test.testId, test);
+        }
+    }
+    getTestId({ project, file, title, annotations }) {
+        const idAnnotation = annotations.find((a) => a.type === ID_TYPE);
+        if (idAnnotation)
+            return `[${project}] ${idAnnotation.description}`;
+        if (file === title)
+            return `[${project}] ${file}`;
+        return `[${project}] ${file} > ${title}`;
+    }
+    // Exponential Moving Average
+    calculateEMA(current, ema, window) {
+        if (ema === 0)
+            return current;
+        const k = 2 / (window + 1);
+        return current * k + ema * (1 - k);
+    }
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './commands/program.js';

package/dist/cli.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './commands/program.js';

package/dist/commands/create-report.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;

package/dist/commands/create-report.js

@@ -0,0 +1,18 @@
+import { Option } from '@commander-js/extra-typings';
+import { loadPlugins } from '../helpers/plugin.js';
+import { generateReport, REPORTERS } from '../reporters/reporter-factory.js';
+import { withErrorHandling } from './error-handler.js';
+import { program } from './program.js';
+export default async () => {
+    const command = program.command('create-report').description('Create for selected storage type.');
+    for await (const { factory, subCommand } of loadPlugins(command)) {
+        subCommand
+            .requiredOption('--run-id <string>', 'Run id generated by create command')
+            .addOption(new Option('--reporter <string>', 'Reporter type').choices(REPORTERS).default('json'))
+            .action(withErrorHandling(async (options) => {
+            const adapter = await factory(options);
+            await generateReport(await adapter.getReportData(options.runId), options.reporter);
+            await adapter.dispose();
+        }));
+    }
+};

package/dist/commands/create.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;

package/dist/commands/create.js

@@ -0,0 +1,26 @@
+import * as uuid from 'uuid';
+import { program } from './program.js';
+import { loadRunInfo } from '../helpers/reporter-tools.js';
+import { loadPlugins } from '../helpers/plugin.js';
+import { withErrorHandling } from './error-handler.js';
+import chalk from 'chalk';
+export default async () => {
+    const command = program
+        .command('create')
+        .description("Prepare new run configuration and fill storage. Supports all playwright's CLI options");
+    for await (const { factory, subCommand } of loadPlugins(command)) {
+        subCommand
+            .option('--history-window <number>', 'History window size', '10')
+            .allowUnknownOption()
+            .allowExcessArguments()
+            .action(withErrorHandling(async (options) => {
+            const runId = uuid.v7();
+            const args = subCommand.args.slice(subCommand.registeredArguments.length);
+            const runInfo = await loadRunInfo(args);
+            const adapter = await factory(options);
+            await adapter.saveTestRun({ runId, testRun: runInfo, args, historyWindow: +options.historyWindow });
+            await adapter.dispose();
+            console.log(chalk.green(runId));
+        }));
+    }
+};

package/dist/commands/error-handler.d.ts

@@ -0,0 +1 @@
+export declare function withErrorHandling<T extends (...args: any[]) => Promise<any> | any>(target: T): (...args: Parameters<T>) => Promise<Awaited<ReturnType<T>>>;

package/dist/commands/error-handler.js

@@ -0,0 +1,28 @@
+import { tmpdir } from 'os';
+import { writeFile } from 'node:fs/promises';
+import * as uuid from 'uuid';
+import { program } from './program.js';
+export function withErrorHandling(target) {
+    return async (...args) => {
+        try {
+            return await target(...args);
+        }
+        catch (error) {
+            const logFile = `${tmpdir()}/${uuid.v4()}.log`;
+            const errorDetails = {
+                message: error instanceof Error ? error.message : 'Unknown error',
+                stack: error instanceof Error ? error.stack : undefined,
+                timestamp: new Date().toISOString(),
+                details: error,
+            };
+            try {
+                await writeFile(logFile, JSON.stringify(errorDetails, null, 2));
+                program.error(`Error occurred. Log file: ${logFile}\nError: ${errorDetails.message}`);
+            }
+            catch (writeError) {
+                program.error(`Failed to write error log. Original error: ${errorDetails.message}`);
+            }
+            return undefined;
+        }
+    };
+}

package/dist/commands/init.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;