@codspeed/playwright-plugin 5.5.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright 2023 CodSpeed
+
+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,138 @@
+<div align="center">
+<h1><code>@codspeed/playwright-plugin</code></h1>
+
+[Playwright](https://playwright.dev) integration for [CodSpeed](https://codspeed.io), to drive an app through Playwright and report measured user flows.
+
+[![CI](https://github.com/CodSpeedHQ/codspeed-node/actions/workflows/ci.yml/badge.svg)](https://github.com/CodSpeedHQ/codspeed-node/actions/workflows/ci.yml)
+[![npm (scoped)](https://img.shields.io/npm/v/@codspeed/playwright-plugin)](https://www.npmjs.com/package/@codspeed/playwright-plugin)
+[![Discord](https://img.shields.io/badge/chat%20on-discord-7289da.svg)](https://discord.com/invite/MxpaCfKSqF)
+[![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/CodSpeedHQ/codspeed-node)
+
+</div>
+
+> [!NOTE]
+> The `@codspeed/playwright-plugin` integration currently supports only the
+> [walltime instrument](https://docs.codspeed.io/instruments/walltime). CPU
+> Simulation is not available.
+
+`@codspeed/playwright-plugin` is the CodSpeed integration for
+[Playwright](https://playwright.dev). It runs a user-defined flow against a
+target application, measures the time spent inside that flow, and reports it to
+CodSpeed. The flow itself is plain Playwright code, so anything Playwright can
+drive can be benchmarked.
+
+> [!IMPORTANT]
+> Today the plugin supports [Electron](https://www.electronjs.org) apps as a
+> target. Browser-based targets (existing dev servers, static builds, hosted
+> URLs) are on the roadmap and will be added under the same `bench` API.
+
+## Documentation
+
+Check out the [documentation](https://docs.codspeed.io/benchmarks/nodejs/playwright) for complete integration instructions.
+
+## Installation
+
+Install the plugin alongside `playwright`:
+
+```sh
+npm install --save-dev @codspeed/playwright-plugin playwright
+```
+
+or with `yarn`:
+
+```sh
+yarn add --dev @codspeed/playwright-plugin playwright
+```
+
+or with `pnpm`:
+
+```sh
+pnpm add --save-dev @codspeed/playwright-plugin playwright
+```
+
+## Example usage with Electron
+
+Build your Electron app first so the main entrypoint exists (e.g.,
+`out/main/index.js`), then declare a benchmark with `target.kind` set to
+`"electron"`:
+
+```ts title="bench/inbox.bench.ts"
+import { bench } from "@codspeed/playwright-plugin";
+import path from "node:path";
+
+bench(
+  "inbox-search",
+  async ({ page }) => {
+    await page.fill("#search", "quarterly report");
+    await page.waitForSelector("#results");
+  },
+  {
+    target: {
+      kind: "electron",
+      appPath: path.resolve("out/main/index.js"),
+    },
+    beforeRound: async ({ page }) => {
+      await page.waitForSelector("#main:not(.loading)");
+    },
+    rounds: 5,
+  },
+);
+```
+
+For each round, the plugin launches Electron with the provided main entrypoint,
+waits for the first window, runs `beforeRound`, measures `fn`, runs
+`afterRound`, then closes the app.
+
+## API
+
+The plugin exposes a single `bench` function. Its shape is target-agnostic:
+
+```ts
+import { bench } from "@codspeed/playwright-plugin";
+
+bench(name, fn, options);
+```
+
+| Argument  | Type                                  | Required | Description                                                                                                                                                                                              |
+| --------- | ------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`    | `string`                              | yes      | Identifier of the benchmark, used by CodSpeed to track it across runs.                                                                                                                                   |
+| `fn`      | `({ page }) => void \| Promise<void>` | yes      | The function whose execution time is measured. Receives a Playwright [`Page`](https://playwright.dev/docs/api/class-page) bound to the target. Everything inside `fn` counts toward the reported timing. |
+| `options` | `BenchOptions`                        | yes      | Target configuration and benchmark settings, detailed below.                                                                                                                                             |
+
+### Options
+
+| Option        | Type                                  | Default      | Description                                                                                                                                                                                                   |
+| ------------- | ------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `target`      | `Target`                              | _(required)_ | Discriminated union describing what to drive. The `kind` field selects the target; the remaining fields are specific to that kind. Current variants: [`{ kind: "electron", ... }`](#electron-target-options). |
+| `rounds`      | `number`                              | `1`          | Number of measurement rounds. Can be overridden at runtime via the `CODSPEED_PLAYWRIGHT_ROUNDS` environment variable.                                                                                         |
+| `beforeRound` | `({ page }) => void \| Promise<void>` | —            | Runs before each round, after the target is ready. Use it to bring the app to a ready state. Not measured.                                                                                                    |
+| `afterRound`  | `({ page }) => void \| Promise<void>` | —            | Runs after each round, before the target is torn down. Not measured.                                                                                                                                          |
+
+### Electron target options
+
+| Option                          | Type         | Default             | Description                                                                                                                                 |
+| ------------------------------- | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| `target.kind`                   | `"electron"` | _(required)_        | Selects the Electron target.                                                                                                                |
+| `target.appPath`                | `string`     | _(required)_        | Absolute path to the Electron main entrypoint, e.g., `out/main/index.js`.                                                                   |
+| `target.electronArgs`           | `string[]`   | `[]`                | Extra CLI flags forwarded to the Electron process.                                                                                          |
+| `target.cwd`                    | `string`     | `process.cwd()`     | Working directory for the Electron process. Also the directory `electron` is resolved from when `target.electronExecutablePath` is not set. |
+| `target.electronExecutablePath` | `string`     | resolved `electron` | Absolute path to the Electron binary. Only set this to override the default resolution.                                                     |
+
+## Running the benchmarks locally
+
+With node 24+, you can run typescript files directly:
+
+```bash
+$ node bench/inbox.bench.ts
+[CodSpeed] [round 1/5] 42.13 ms
+[CodSpeed] [round 2/5] 41.78 ms
+[CodSpeed] [round 3/5] 42.05 ms
+[CodSpeed] [round 4/5] 41.92 ms
+[CodSpeed] [round 5/5] 42.21 ms
+```
+
+Locally, `bench` runs the app and prints per-round timings to the terminal.
+Results are uploaded to CodSpeed only when running in the
+[CI environment](https://docs.codspeed.io/benchmarks/nodejs/playwright#running-the-benchmarks-in-your-ci)
+or when using the
+[CodSpeed CLI](https://docs.codspeed.io/cli#running-benchmarks).

package/dist/index.cjs

@@ -0,0 +1,131 @@
+'use strict';
+
+var core = require('@codspeed/core');
+var node_module = require('node:module');
+var node_url = require('node:url');
+var playwright = require('playwright');
+
+const DEFAULT_ROUNDS = 3;
+const DEFAULT_PROFILING_JS_FLAGS = "--perf-prof --perf-prof-annotate-wasm --interpreted-frames-native-stack --no-turbo-inlining --no-sandbox";
+let integrationInitialized = false;
+function ensureIntegrationSetup() {
+  if (integrationInitialized)
+    return;
+  integrationInitialized = true;
+  core.InstrumentHooks.setIntegration("node-custom", "5.5.0");
+  core.InstrumentHooks.setEnvironment("nodejs", "version", process.versions.node);
+  core.InstrumentHooks.setEnvironment("nodejs", "v8", process.versions.v8);
+  core.InstrumentHooks.writeEnvironment(process.pid);
+}
+function resolveRounds(optionRounds) {
+  const envValue = process.env.CODSPEED_PLAYWRIGHT_ROUNDS;
+  const raw = envValue ?? optionRounds;
+  if (raw === void 0)
+    return DEFAULT_ROUNDS;
+  const n = Number(raw);
+  if (!Number.isInteger(n) || n < 1) {
+    throw new Error(`Invalid rounds value: ${raw} (expected positive integer)`);
+  }
+  return n;
+}
+function resolveElectronExecutable(cwd) {
+  const require = node_module.createRequire(node_url.pathToFileURL(`${cwd}/`));
+  return require("electron");
+}
+async function launchElectronApp(target) {
+  const cwd = target.cwd ?? process.cwd();
+  return playwright._electron.launch({
+    args: [
+      target.appPath,
+      ...target.electronArgs ?? [],
+      `--js-flags=${DEFAULT_PROFILING_JS_FLAGS}`
+    ],
+    cwd,
+    executablePath: target.electronExecutablePath ?? resolveElectronExecutable(cwd)
+  });
+}
+async function runOneSample(fn, options) {
+  const app = await launchElectronApp(options.target);
+  const page = await app.firstWindow();
+  try {
+    if (options.beforeRound) {
+      await options.beforeRound({ page });
+    }
+    const startTs = core.InstrumentHooks.currentTimestamp();
+    await fn({ page });
+    const endTs = core.InstrumentHooks.currentTimestamp();
+    core.InstrumentHooks.addMarker(
+      process.pid,
+      core.MARKER_TYPE_BENCHMARK_START,
+      startTs
+    );
+    core.InstrumentHooks.addMarker(process.pid, core.MARKER_TYPE_BENCHMARK_END, endTs);
+    if (options.afterRound) {
+      await options.afterRound({ page });
+    }
+    return endTs - startTs;
+  } finally {
+    await app.close();
+  }
+}
+function buildStats(sampleTimesNs) {
+  const sortedTimesNs = sampleTimesNs.map((n) => Number(n)).sort((a, b) => a - b);
+  const sum = sortedTimesNs.reduce((acc, t) => acc + t, 0);
+  const meanNs = sum / sortedTimesNs.length;
+  const variance = sortedTimesNs.reduce((acc, t) => acc + (t - meanNs) ** 2, 0) / sortedTimesNs.length;
+  const stdevNs = Math.sqrt(variance);
+  const { q1_ns, median_ns, q3_ns, iqr_outlier_rounds, stdev_outlier_rounds } = core.calculateQuantiles({
+    meanNs,
+    stdevNs,
+    sortedTimesNs
+  });
+  return {
+    min_ns: sortedTimesNs[0],
+    max_ns: sortedTimesNs[sortedTimesNs.length - 1],
+    mean_ns: meanNs,
+    stdev_ns: stdevNs,
+    q1_ns,
+    median_ns,
+    q3_ns,
+    rounds: sortedTimesNs.length,
+    total_time: core.msToS(sum / 1e6),
+    iqr_outlier_rounds,
+    stdev_outlier_rounds,
+    iter_per_round: 1,
+    warmup_iters: 0
+  };
+}
+async function bench(name, fn, options) {
+  const rounds = resolveRounds(options.rounds);
+  const uri = `${core.getCallingFile(1)}::${name}`;
+  ensureIntegrationSetup();
+  core.InstrumentHooks.setExecutedBenchmark(process.pid, uri);
+  core.InstrumentHooks.startBenchmark();
+  const sampleTimesNs = [];
+  try {
+    for (let i = 0; i < rounds; i++) {
+      const elapsedNs = await runOneSample(fn, options);
+      sampleTimesNs.push(elapsedNs);
+      console.log(
+        `[CodSpeed] [round ${i + 1}/${rounds}] ${(Number(elapsedNs) / 1e6).toFixed(2)} ms`
+      );
+    }
+  } finally {
+    core.InstrumentHooks.stopBenchmark();
+  }
+  const benchmark = {
+    name,
+    uri,
+    config: {
+      warmup_time_ns: null,
+      min_round_time_ns: null,
+      max_rounds: rounds,
+      max_time_ns: null
+    },
+    stats: buildStats(sampleTimesNs)
+  };
+  core.writeWalltimeResults([benchmark]);
+}
+
+exports.bench = bench;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.ts"],"sourcesContent":["import {\n  calculateQuantiles,\n  getCallingFile,\n  InstrumentHooks,\n  MARKER_TYPE_BENCHMARK_END,\n  MARKER_TYPE_BENCHMARK_START,\n  msToS,\n  writeWalltimeResults,\n  type Benchmark,\n  type BenchmarkStats,\n} from \"@codspeed/core\";\nimport { createRequire } from \"node:module\";\nimport { pathToFileURL } from \"node:url\";\nimport { _electron as electron } from \"playwright\";\nimport type { ElectronApplication, Page } from \"playwright-core\";\n\ndeclare const __VERSION__: string;\n\nconst DEFAULT_ROUNDS = 3;\nconst DEFAULT_PROFILING_JS_FLAGS =\n  \"--perf-prof --perf-prof-annotate-wasm --interpreted-frames-native-stack --no-turbo-inlining --no-sandbox\";\n\n/**\n * The fixtures passed to a benchmark function, mirroring Playwright's `test`\n * API. Currently exposes the target's main window as `page`.\n */\nexport interface BenchFixtures {\n  page: Page;\n}\n\n/**\n * The function whose execution is measured. Everything that runs inside it is\n * included in the reported timing.\n */\nexport type BenchFunction = (fixtures: BenchFixtures) => void | Promise<void>;\n\nexport type BenchHook = (fixtures: BenchFixtures) => void | Promise<void>;\n\n/**\n * Electron-specific target options.\n */\nexport interface ElectronTarget {\n  kind: \"electron\";\n  /**\n   * Absolute path to the Electron main entrypoint (e.g. `out/main/index.js`).\n   */\n  appPath: string;\n  /**\n   * CLI flags forwarded to Electron.\n   */\n  electronArgs?: string[];\n  /**\n   * Working directory for the Electron process. Defaults to `process.cwd()`.\n   */\n  cwd?: string;\n  /**\n   * Absolute path to the Electron executable. When omitted, it is resolved from\n   * the `electron` package in `cwd`. Set this only to override that default.\n   */\n  electronExecutablePath?: string;\n}\n\n/**\n * Determines what kind of host playwright is going to run the tests on\n */\nexport type Target = ElectronTarget;\n\n/**\n * Minimal options for a benchmark. Inspired by Vitest's `bench`, but kept\n * deliberately small.\n */\nexport interface BenchOptions {\n  /**\n   * Target configuration. The `kind` field selects the target; the remaining\n   * fields are specific to that kind.\n   */\n  target: Target;\n  /**\n   * Number of measurement rounds to perform. Defaults to 3, or the value of CODSPEED_PLAYWRIGHT_ROUNDS.\n   */\n  rounds?: number;\n  /**\n   * Runs before each round, after the target is ready. Use it to bring the app to\n   * a ready state. Not measured.\n   */\n  beforeRound?: BenchHook;\n  /**\n   * Runs after each round, before the target is torn down. Not measured.\n   */\n  afterRound?: BenchHook;\n}\n\nlet integrationInitialized = false;\n\n/**\n * Register the integration and environment with the instrumentation. This is\n * process-global, so it only needs to run once regardless of how many\n * benchmarks are defined.\n */\nfunction ensureIntegrationSetup(): void {\n  if (integrationInitialized) return;\n  integrationInitialized = true;\n\n  InstrumentHooks.setIntegration(\"node-custom\", __VERSION__);\n  InstrumentHooks.setEnvironment(\"nodejs\", \"version\", process.versions.node);\n  InstrumentHooks.setEnvironment(\"nodejs\", \"v8\", process.versions.v8);\n  InstrumentHooks.writeEnvironment(process.pid);\n}\n\nfunction resolveRounds(optionRounds: number | undefined): number {\n  const envValue = process.env.CODSPEED_PLAYWRIGHT_ROUNDS;\n  const raw = envValue ?? optionRounds;\n  if (raw === undefined) return DEFAULT_ROUNDS;\n  const n = Number(raw);\n  if (!Number.isInteger(n) || n < 1) {\n    throw new Error(`Invalid rounds value: ${raw} (expected positive integer)`);\n  }\n  return n;\n}\n\n/**\n * Resolve the path to the Electron binary.\n *\n * Playwright resolves Electron via `require(\"electron/index.js\")` from inside\n * its own package directory. Under isolated installs (e.g. pnpm), Playwright\n * cannot see the project's `electron` dependency and bails out with\n * \"Electron executablePath not found!\". We resolve it ourselves from the\n * benchmark's working directory, where `electron` is a real dependency.\n */\nfunction resolveElectronExecutable(cwd: string): string {\n  const require = createRequire(pathToFileURL(`${cwd}/`));\n  // `electron`'s main module exports the absolute path to its binary.\n  return require(\"electron\") as string;\n}\n\nasync function launchElectronApp(\n  target: ElectronTarget,\n): Promise<ElectronApplication> {\n  const cwd = target.cwd ?? process.cwd();\n  return electron.launch({\n    args: [\n      target.appPath,\n      ...(target.electronArgs ?? []),\n      `--js-flags=${DEFAULT_PROFILING_JS_FLAGS}`,\n    ],\n    cwd,\n    executablePath:\n      target.electronExecutablePath ?? resolveElectronExecutable(cwd),\n  });\n}\n\nasync function runOneSample(\n  fn: BenchFunction,\n  options: BenchOptions,\n): Promise<bigint> {\n  const app = await launchElectronApp(options.target);\n  const page = await app.firstWindow();\n\n  try {\n    if (options.beforeRound) {\n      await options.beforeRound({ page });\n    }\n\n    const startTs = InstrumentHooks.currentTimestamp();\n    await fn({ page });\n    const endTs = InstrumentHooks.currentTimestamp();\n\n    InstrumentHooks.addMarker(\n      process.pid,\n      MARKER_TYPE_BENCHMARK_START,\n      startTs,\n    );\n    InstrumentHooks.addMarker(process.pid, MARKER_TYPE_BENCHMARK_END, endTs);\n\n    if (options.afterRound) {\n      await options.afterRound({ page });\n    }\n\n    return endTs - startTs;\n  } finally {\n    await app.close();\n  }\n}\n\nfunction buildStats(sampleTimesNs: bigint[]): BenchmarkStats {\n  const sortedTimesNs = sampleTimesNs\n    .map((n) => Number(n))\n    .sort((a, b) => a - b);\n\n  const sum = sortedTimesNs.reduce((acc, t) => acc + t, 0);\n  const meanNs = sum / sortedTimesNs.length;\n  const variance =\n    sortedTimesNs.reduce((acc, t) => acc + (t - meanNs) ** 2, 0) /\n    sortedTimesNs.length;\n  const stdevNs = Math.sqrt(variance);\n\n  const { q1_ns, median_ns, q3_ns, iqr_outlier_rounds, stdev_outlier_rounds } =\n    calculateQuantiles({\n      meanNs,\n      stdevNs,\n      sortedTimesNs,\n    });\n\n  return {\n    min_ns: sortedTimesNs[0],\n    max_ns: sortedTimesNs[sortedTimesNs.length - 1],\n    mean_ns: meanNs,\n    stdev_ns: stdevNs,\n    q1_ns,\n    median_ns,\n    q3_ns,\n    rounds: sortedTimesNs.length,\n    total_time: msToS(sum / 1e6),\n    iqr_outlier_rounds,\n    stdev_outlier_rounds,\n    iter_per_round: 1,\n    warmup_iters: 0,\n  };\n}\n\n/**\n * Define and run a CodSpeed-instrumented benchmark, mirroring Playwright's\n * `test` API.\n *\n * Launches the target once per round, runs the user-provided function around a\n * measured region, and writes walltime results to disk so that the CodSpeed\n * runner can pick them up.\n *\n * @example\n * ```ts\n * import { bench } from \"@codspeed/playwright-plugin\";\n *\n * bench(\n *   \"renders the dashboard\",\n *   async ({ page }) => {\n *     await page.getByRole(\"link\", { name: \"Dashboard\" }).click();\n *     await page.getByRole(\"heading\", { name: \"Overview\" }).waitFor();\n *   },\n *   {\n *     target: { kind: \"electron\", appPath: \"out/main/index.js\" },\n *     rounds: 5,\n *   },\n * );\n * ```\n */\nexport async function bench(\n  name: string,\n  fn: BenchFunction,\n  options: BenchOptions,\n): Promise<void> {\n  const rounds = resolveRounds(options.rounds);\n  const uri = `${getCallingFile(1)}::${name}`;\n\n  ensureIntegrationSetup();\n\n  InstrumentHooks.setExecutedBenchmark(process.pid, uri);\n  InstrumentHooks.startBenchmark();\n\n  const sampleTimesNs: bigint[] = [];\n  try {\n    for (let i = 0; i < rounds; i++) {\n      const elapsedNs = await runOneSample(fn, options);\n      sampleTimesNs.push(elapsedNs);\n      console.log(\n        `[CodSpeed] [round ${i + 1}/${rounds}] ${(Number(elapsedNs) / 1e6).toFixed(2)} ms`,\n      );\n    }\n  } finally {\n    InstrumentHooks.stopBenchmark();\n  }\n\n  const benchmark: Benchmark = {\n    name,\n    uri,\n    config: {\n      warmup_time_ns: null,\n      min_round_time_ns: null,\n      max_rounds: rounds,\n      max_time_ns: null,\n    },\n    stats: buildStats(sampleTimesNs),\n  };\n\n  writeWalltimeResults([benchmark]);\n}\n\nexport type { Page } from \"playwright-core\";\n"],"names":["InstrumentHooks","createRequire","pathToFileURL","electron","MARKER_TYPE_BENCHMARK_START","MARKER_TYPE_BENCHMARK_END","calculateQuantiles","msToS","getCallingFile","writeWalltimeResults"],"mappings":";;;;;;;AAkBA,MAAM,cAAA,GAAiB,CAAA;AACvB,MAAM,0BAAA,GACJ,0GAAA;AAwEF,IAAI,sBAAA,GAAyB,KAAA;AAO7B,SAAS,sBAAA,GAA+B;AACtC,EAAA,IAAI,sBAAA;AAAwB,IAAA;AAC5B,EAAA,sBAAA,GAAyB,IAAA;AAEzB,EAAAA,oBAAA,CAAgB,cAAA,CAAe,eAAe,OAAW,CAAA;AACzD,EAAAA,oBAAA,CAAgB,cAAA,CAAe,QAAA,EAAU,SAAA,EAAW,OAAA,CAAQ,SAAS,IAAI,CAAA;AACzE,EAAAA,oBAAA,CAAgB,cAAA,CAAe,QAAA,EAAU,IAAA,EAAM,OAAA,CAAQ,SAAS,EAAE,CAAA;AAClE,EAAAA,oBAAA,CAAgB,gBAAA,CAAiB,QAAQ,GAAG,CAAA;AAC9C;AAEA,SAAS,cAAc,YAAA,EAA0C;AAC/D,EAAA,MAAM,QAAA,GAAW,QAAQ,GAAA,CAAI,0BAAA;AAC7B,EAAA,MAAM,MAAM,QAAA,IAAY,YAAA;AACxB,EAAA,IAAI,GAAA,KAAQ,MAAA;AAAW,IAAA,OAAO,cAAA;AAC9B,EAAA,MAAM,CAAA,GAAI,OAAO,GAAG,CAAA;AACpB,EAAA,IAAI,CAAC,MAAA,CAAO,SAAA,CAAU,CAAC,CAAA,IAAK,IAAI,CAAA,EAAG;AACjC,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,sBAAA,EAAyB,GAAA,CAAA,4BAAA,CAAiC,CAAA;AAAA,EAC5E;AACA,EAAA,OAAO,CAAA;AACT;AAWA,SAAS,0BAA0B,GAAA,EAAqB;AACtD,EAAA,MAAM,OAAA,GAAUC,yBAAA,CAAcC,sBAAA,CAAc,CAAA,EAAG,MAAM,CAAC,CAAA;AAEtD,EAAA,OAAO,QAAQ,UAAU,CAAA;AAC3B;AAEA,eAAe,kBACb,MAAA,EAC8B;AAC9B,EAAA,MAAM,GAAA,GAAM,MAAA,CAAO,GAAA,IAAO,OAAA,CAAQ,GAAA,EAAI;AACtC,EAAA,OAAOC,qBAAS,MAAA,CAAO;AAAA,IACrB,IAAA,EAAM;AAAA,MACJ,MAAA,CAAO,OAAA;AAAA,MACP,GAAI,MAAA,CAAO,YAAA,IAAgB,EAAC;AAAA,MAC5B,CAAA,WAAA,EAAc,0BAAA,CAAA;AAAA,KAChB;AAAA,IACA,GAAA;AAAA,IACA,cAAA,EACE,MAAA,CAAO,sBAAA,IAA0B,yBAAA,CAA0B,GAAG;AAAA,GACjE,CAAA;AACH;AAEA,eAAe,YAAA,CACb,IACA,OAAA,EACiB;AACjB,EAAA,MAAM,GAAA,GAAM,MAAM,iBAAA,CAAkB,OAAA,CAAQ,MAAM,CAAA;AAClD,EAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,WAAA,EAAY;AAEnC,EAAA,IAAI;AACF,IAAA,IAAI,QAAQ,WAAA,EAAa;AACvB,MAAA,MAAM,OAAA,CAAQ,WAAA,CAAY,EAAE,IAAA,EAAM,CAAA;AAAA,IACpC;AAEA,IAAA,MAAM,OAAA,GAAUH,qBAAgB,gBAAA,EAAiB;AACjD,IAAA,MAAM,EAAA,CAAG,EAAE,IAAA,EAAM,CAAA;AACjB,IAAA,MAAM,KAAA,GAAQA,qBAAgB,gBAAA,EAAiB;AAE/C,IAAAA,oBAAA,CAAgB,SAAA;AAAA,MACd,OAAA,CAAQ,GAAA;AAAA,MACRI,gCAAA;AAAA,MACA;AAAA,KACF;AACA,IAAAJ,oBAAA,CAAgB,SAAA,CAAU,OAAA,CAAQ,GAAA,EAAKK,8BAAA,EAA2B,KAAK,CAAA;AAEvE,IAAA,IAAI,QAAQ,UAAA,EAAY;AACtB,MAAA,MAAM,OAAA,CAAQ,UAAA,CAAW,EAAE,IAAA,EAAM,CAAA;AAAA,IACnC;AAEA,IAAA,OAAO,KAAA,GAAQ,OAAA;AAAA,EACjB,CAAA,SAAE;AACA,IAAA,MAAM,IAAI,KAAA,EAAM;AAAA,EAClB;AACF;AAEA,SAAS,WAAW,aAAA,EAAyC;AAC3D,EAAA,MAAM,aAAA,GAAgB,aAAA,CACnB,GAAA,CAAI,CAAC,MAAM,MAAA,CAAO,CAAC,CAAC,CAAA,CACpB,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,IAAI,CAAC,CAAA;AAEvB,EAAA,MAAM,GAAA,GAAM,cAAc,MAAA,CAAO,CAAC,KAAK,CAAA,KAAM,GAAA,GAAM,GAAG,CAAC,CAAA;AACvD,EAAA,MAAM,MAAA,GAAS,MAAM,aAAA,CAAc,MAAA;AACnC,EAAA,MAAM,QAAA,GACJ,aAAA,CAAc,MAAA,CAAO,CAAC,GAAA,EAAK,CAAA,KAAM,GAAA,GAAA,CAAO,CAAA,GAAI,MAAA,KAAW,CAAA,EAAG,CAAC,CAAA,GAC3D,aAAA,CAAc,MAAA;AAChB,EAAA,MAAM,OAAA,GAAU,IAAA,CAAK,IAAA,CAAK,QAAQ,CAAA;AAElC,EAAA,MAAM,EAAE,KAAA,EAAO,SAAA,EAAW,OAAO,kBAAA,EAAoB,oBAAA,KACnDC,uBAAA,CAAmB;AAAA,IACjB,MAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AAEH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,cAAc,CAAC,CAAA;AAAA,IACvB,MAAA,EAAQ,aAAA,CAAc,aAAA,CAAc,MAAA,GAAS,CAAC,CAAA;AAAA,IAC9C,OAAA,EAAS,MAAA;AAAA,IACT,QAAA,EAAU,OAAA;AAAA,IACV,KAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAQ,aAAA,CAAc,MAAA;AAAA,IACtB,UAAA,EAAYC,UAAA,CAAM,GAAA,GAAM,GAAG,CAAA;AAAA,IAC3B,kBAAA;AAAA,IACA,oBAAA;AAAA,IACA,cAAA,EAAgB,CAAA;AAAA,IAChB,YAAA,EAAc;AAAA,GAChB;AACF;AA2BA,eAAsB,KAAA,CACpB,IAAA,EACA,EAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,MAAA,GAAS,aAAA,CAAc,OAAA,CAAQ,MAAM,CAAA;AAC3C,EAAA,MAAM,GAAA,GAAM,CAAA,EAAGC,mBAAA,CAAe,CAAC,CAAA,CAAA,EAAA,EAAM,IAAA,CAAA,CAAA;AAErC,EAAA,sBAAA,EAAuB;AAEvB,EAAAR,oBAAA,CAAgB,oBAAA,CAAqB,OAAA,CAAQ,GAAA,EAAK,GAAG,CAAA;AACrD,EAAAA,oBAAA,CAAgB,cAAA,EAAe;AAE/B,EAAA,MAAM,gBAA0B,EAAC;AACjC,EAAA,IAAI;AACF,IAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,MAAA,EAAQ,CAAA,EAAA,EAAK;AAC/B,MAAA,MAAM,SAAA,GAAY,MAAM,YAAA,CAAa,EAAA,EAAI,OAAO,CAAA;AAChD,MAAA,aAAA,CAAc,KAAK,SAAS,CAAA;AAC5B,MAAA,OAAA,CAAQ,GAAA;AAAA,QACN,CAAA,kBAAA,EAAqB,IAAI,CAAA,CAAA,CAAA,EAAK,MAAA,CAAA,EAAA,EAAA,CAAY,OAAO,SAAS,CAAA,GAAI,GAAA,EAAK,OAAA,CAAQ,CAAC,CAAA,CAAA,GAAA;AAAA,OAC9E;AAAA,IACF;AAAA,EACF,CAAA,SAAE;AACA,IAAAA,oBAAA,CAAgB,aAAA,EAAc;AAAA,EAChC;AAEA,EAAA,MAAM,SAAA,GAAuB;AAAA,IAC3B,IAAA;AAAA,IACA,GAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,cAAA,EAAgB,IAAA;AAAA,MAChB,iBAAA,EAAmB,IAAA;AAAA,MACnB,UAAA,EAAY,MAAA;AAAA,MACZ,WAAA,EAAa;AAAA,KACf;AAAA,IACA,KAAA,EAAO,WAAW,aAAa;AAAA,GACjC;AAEA,EAAAS,yBAAA,CAAqB,CAAC,SAAS,CAAC,CAAA;AAClC;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+import { Page } from 'playwright-core';
+export { Page } from 'playwright-core';
+
+/**
+ * The fixtures passed to a benchmark function, mirroring Playwright's `test`
+ * API. Currently exposes the target's main window as `page`.
+ */
+interface BenchFixtures {
+    page: Page;
+}
+/**
+ * The function whose execution is measured. Everything that runs inside it is
+ * included in the reported timing.
+ */
+type BenchFunction = (fixtures: BenchFixtures) => void | Promise<void>;
+type BenchHook = (fixtures: BenchFixtures) => void | Promise<void>;
+/**
+ * Electron-specific target options.
+ */
+interface ElectronTarget {
+    kind: "electron";
+    /**
+     * Absolute path to the Electron main entrypoint (e.g. `out/main/index.js`).
+     */
+    appPath: string;
+    /**
+     * CLI flags forwarded to Electron.
+     */
+    electronArgs?: string[];
+    /**
+     * Working directory for the Electron process. Defaults to `process.cwd()`.
+     */
+    cwd?: string;
+    /**
+     * Absolute path to the Electron executable. When omitted, it is resolved from
+     * the `electron` package in `cwd`. Set this only to override that default.
+     */
+    electronExecutablePath?: string;
+}
+/**
+ * Determines what kind of host playwright is going to run the tests on
+ */
+type Target = ElectronTarget;
+/**
+ * Minimal options for a benchmark. Inspired by Vitest's `bench`, but kept
+ * deliberately small.
+ */
+interface BenchOptions {
+    /**
+     * Target configuration. The `kind` field selects the target; the remaining
+     * fields are specific to that kind.
+     */
+    target: Target;
+    /**
+     * Number of measurement rounds to perform. Defaults to 3, or the value of CODSPEED_PLAYWRIGHT_ROUNDS.
+     */
+    rounds?: number;
+    /**
+     * Runs before each round, after the target is ready. Use it to bring the app to
+     * a ready state. Not measured.
+     */
+    beforeRound?: BenchHook;
+    /**
+     * Runs after each round, before the target is torn down. Not measured.
+     */
+    afterRound?: BenchHook;
+}
+/**
+ * Define and run a CodSpeed-instrumented benchmark, mirroring Playwright's
+ * `test` API.
+ *
+ * Launches the target once per round, runs the user-provided function around a
+ * measured region, and writes walltime results to disk so that the CodSpeed
+ * runner can pick them up.
+ *
+ * @example
+ * ```ts
+ * import { bench } from "@codspeed/playwright-plugin";
+ *
+ * bench(
+ *   "renders the dashboard",
+ *   async ({ page }) => {
+ *     await page.getByRole("link", { name: "Dashboard" }).click();
+ *     await page.getByRole("heading", { name: "Overview" }).waitFor();
+ *   },
+ *   {
+ *     target: { kind: "electron", appPath: "out/main/index.js" },
+ *     rounds: 5,
+ *   },
+ * );
+ * ```
+ */
+declare function bench(name: string, fn: BenchFunction, options: BenchOptions): Promise<void>;
+
+export { type BenchFixtures, type BenchFunction, type BenchHook, type BenchOptions, type ElectronTarget, type Target, bench };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/index.es5.js

@@ -0,0 +1,129 @@
+import { getCallingFile, InstrumentHooks, writeWalltimeResults, MARKER_TYPE_BENCHMARK_START, MARKER_TYPE_BENCHMARK_END, calculateQuantiles, msToS } from '@codspeed/core';
+import { createRequire } from 'node:module';
+import { pathToFileURL } from 'node:url';
+import { _electron } from 'playwright';
+
+const DEFAULT_ROUNDS = 3;
+const DEFAULT_PROFILING_JS_FLAGS = "--perf-prof --perf-prof-annotate-wasm --interpreted-frames-native-stack --no-turbo-inlining --no-sandbox";
+let integrationInitialized = false;
+function ensureIntegrationSetup() {
+  if (integrationInitialized)
+    return;
+  integrationInitialized = true;
+  InstrumentHooks.setIntegration("node-custom", "5.5.0");
+  InstrumentHooks.setEnvironment("nodejs", "version", process.versions.node);
+  InstrumentHooks.setEnvironment("nodejs", "v8", process.versions.v8);
+  InstrumentHooks.writeEnvironment(process.pid);
+}
+function resolveRounds(optionRounds) {
+  const envValue = process.env.CODSPEED_PLAYWRIGHT_ROUNDS;
+  const raw = envValue ?? optionRounds;
+  if (raw === void 0)
+    return DEFAULT_ROUNDS;
+  const n = Number(raw);
+  if (!Number.isInteger(n) || n < 1) {
+    throw new Error(`Invalid rounds value: ${raw} (expected positive integer)`);
+  }
+  return n;
+}
+function resolveElectronExecutable(cwd) {
+  const require = createRequire(pathToFileURL(`${cwd}/`));
+  return require("electron");
+}
+async function launchElectronApp(target) {
+  const cwd = target.cwd ?? process.cwd();
+  return _electron.launch({
+    args: [
+      target.appPath,
+      ...target.electronArgs ?? [],
+      `--js-flags=${DEFAULT_PROFILING_JS_FLAGS}`
+    ],
+    cwd,
+    executablePath: target.electronExecutablePath ?? resolveElectronExecutable(cwd)
+  });
+}
+async function runOneSample(fn, options) {
+  const app = await launchElectronApp(options.target);
+  const page = await app.firstWindow();
+  try {
+    if (options.beforeRound) {
+      await options.beforeRound({ page });
+    }
+    const startTs = InstrumentHooks.currentTimestamp();
+    await fn({ page });
+    const endTs = InstrumentHooks.currentTimestamp();
+    InstrumentHooks.addMarker(
+      process.pid,
+      MARKER_TYPE_BENCHMARK_START,
+      startTs
+    );
+    InstrumentHooks.addMarker(process.pid, MARKER_TYPE_BENCHMARK_END, endTs);
+    if (options.afterRound) {
+      await options.afterRound({ page });
+    }
+    return endTs - startTs;
+  } finally {
+    await app.close();
+  }
+}
+function buildStats(sampleTimesNs) {
+  const sortedTimesNs = sampleTimesNs.map((n) => Number(n)).sort((a, b) => a - b);
+  const sum = sortedTimesNs.reduce((acc, t) => acc + t, 0);
+  const meanNs = sum / sortedTimesNs.length;
+  const variance = sortedTimesNs.reduce((acc, t) => acc + (t - meanNs) ** 2, 0) / sortedTimesNs.length;
+  const stdevNs = Math.sqrt(variance);
+  const { q1_ns, median_ns, q3_ns, iqr_outlier_rounds, stdev_outlier_rounds } = calculateQuantiles({
+    meanNs,
+    stdevNs,
+    sortedTimesNs
+  });
+  return {
+    min_ns: sortedTimesNs[0],
+    max_ns: sortedTimesNs[sortedTimesNs.length - 1],
+    mean_ns: meanNs,
+    stdev_ns: stdevNs,
+    q1_ns,
+    median_ns,
+    q3_ns,
+    rounds: sortedTimesNs.length,
+    total_time: msToS(sum / 1e6),
+    iqr_outlier_rounds,
+    stdev_outlier_rounds,
+    iter_per_round: 1,
+    warmup_iters: 0
+  };
+}
+async function bench(name, fn, options) {
+  const rounds = resolveRounds(options.rounds);
+  const uri = `${getCallingFile(1)}::${name}`;
+  ensureIntegrationSetup();
+  InstrumentHooks.setExecutedBenchmark(process.pid, uri);
+  InstrumentHooks.startBenchmark();
+  const sampleTimesNs = [];
+  try {
+    for (let i = 0; i < rounds; i++) {
+      const elapsedNs = await runOneSample(fn, options);
+      sampleTimesNs.push(elapsedNs);
+      console.log(
+        `[CodSpeed] [round ${i + 1}/${rounds}] ${(Number(elapsedNs) / 1e6).toFixed(2)} ms`
+      );
+    }
+  } finally {
+    InstrumentHooks.stopBenchmark();
+  }
+  const benchmark = {
+    name,
+    uri,
+    config: {
+      warmup_time_ns: null,
+      min_round_time_ns: null,
+      max_rounds: rounds,
+      max_time_ns: null
+    },
+    stats: buildStats(sampleTimesNs)
+  };
+  writeWalltimeResults([benchmark]);
+}
+
+export { bench };
+//# sourceMappingURL=index.es5.js.map

package/dist/index.es5.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es5.js","sources":["../src/index.ts"],"sourcesContent":["import {\n  calculateQuantiles,\n  getCallingFile,\n  InstrumentHooks,\n  MARKER_TYPE_BENCHMARK_END,\n  MARKER_TYPE_BENCHMARK_START,\n  msToS,\n  writeWalltimeResults,\n  type Benchmark,\n  type BenchmarkStats,\n} from \"@codspeed/core\";\nimport { createRequire } from \"node:module\";\nimport { pathToFileURL } from \"node:url\";\nimport { _electron as electron } from \"playwright\";\nimport type { ElectronApplication, Page } from \"playwright-core\";\n\ndeclare const __VERSION__: string;\n\nconst DEFAULT_ROUNDS = 3;\nconst DEFAULT_PROFILING_JS_FLAGS =\n  \"--perf-prof --perf-prof-annotate-wasm --interpreted-frames-native-stack --no-turbo-inlining --no-sandbox\";\n\n/**\n * The fixtures passed to a benchmark function, mirroring Playwright's `test`\n * API. Currently exposes the target's main window as `page`.\n */\nexport interface BenchFixtures {\n  page: Page;\n}\n\n/**\n * The function whose execution is measured. Everything that runs inside it is\n * included in the reported timing.\n */\nexport type BenchFunction = (fixtures: BenchFixtures) => void | Promise<void>;\n\nexport type BenchHook = (fixtures: BenchFixtures) => void | Promise<void>;\n\n/**\n * Electron-specific target options.\n */\nexport interface ElectronTarget {\n  kind: \"electron\";\n  /**\n   * Absolute path to the Electron main entrypoint (e.g. `out/main/index.js`).\n   */\n  appPath: string;\n  /**\n   * CLI flags forwarded to Electron.\n   */\n  electronArgs?: string[];\n  /**\n   * Working directory for the Electron process. Defaults to `process.cwd()`.\n   */\n  cwd?: string;\n  /**\n   * Absolute path to the Electron executable. When omitted, it is resolved from\n   * the `electron` package in `cwd`. Set this only to override that default.\n   */\n  electronExecutablePath?: string;\n}\n\n/**\n * Determines what kind of host playwright is going to run the tests on\n */\nexport type Target = ElectronTarget;\n\n/**\n * Minimal options for a benchmark. Inspired by Vitest's `bench`, but kept\n * deliberately small.\n */\nexport interface BenchOptions {\n  /**\n   * Target configuration. The `kind` field selects the target; the remaining\n   * fields are specific to that kind.\n   */\n  target: Target;\n  /**\n   * Number of measurement rounds to perform. Defaults to 3, or the value of CODSPEED_PLAYWRIGHT_ROUNDS.\n   */\n  rounds?: number;\n  /**\n   * Runs before each round, after the target is ready. Use it to bring the app to\n   * a ready state. Not measured.\n   */\n  beforeRound?: BenchHook;\n  /**\n   * Runs after each round, before the target is torn down. Not measured.\n   */\n  afterRound?: BenchHook;\n}\n\nlet integrationInitialized = false;\n\n/**\n * Register the integration and environment with the instrumentation. This is\n * process-global, so it only needs to run once regardless of how many\n * benchmarks are defined.\n */\nfunction ensureIntegrationSetup(): void {\n  if (integrationInitialized) return;\n  integrationInitialized = true;\n\n  InstrumentHooks.setIntegration(\"node-custom\", __VERSION__);\n  InstrumentHooks.setEnvironment(\"nodejs\", \"version\", process.versions.node);\n  InstrumentHooks.setEnvironment(\"nodejs\", \"v8\", process.versions.v8);\n  InstrumentHooks.writeEnvironment(process.pid);\n}\n\nfunction resolveRounds(optionRounds: number | undefined): number {\n  const envValue = process.env.CODSPEED_PLAYWRIGHT_ROUNDS;\n  const raw = envValue ?? optionRounds;\n  if (raw === undefined) return DEFAULT_ROUNDS;\n  const n = Number(raw);\n  if (!Number.isInteger(n) || n < 1) {\n    throw new Error(`Invalid rounds value: ${raw} (expected positive integer)`);\n  }\n  return n;\n}\n\n/**\n * Resolve the path to the Electron binary.\n *\n * Playwright resolves Electron via `require(\"electron/index.js\")` from inside\n * its own package directory. Under isolated installs (e.g. pnpm), Playwright\n * cannot see the project's `electron` dependency and bails out with\n * \"Electron executablePath not found!\". We resolve it ourselves from the\n * benchmark's working directory, where `electron` is a real dependency.\n */\nfunction resolveElectronExecutable(cwd: string): string {\n  const require = createRequire(pathToFileURL(`${cwd}/`));\n  // `electron`'s main module exports the absolute path to its binary.\n  return require(\"electron\") as string;\n}\n\nasync function launchElectronApp(\n  target: ElectronTarget,\n): Promise<ElectronApplication> {\n  const cwd = target.cwd ?? process.cwd();\n  return electron.launch({\n    args: [\n      target.appPath,\n      ...(target.electronArgs ?? []),\n      `--js-flags=${DEFAULT_PROFILING_JS_FLAGS}`,\n    ],\n    cwd,\n    executablePath:\n      target.electronExecutablePath ?? resolveElectronExecutable(cwd),\n  });\n}\n\nasync function runOneSample(\n  fn: BenchFunction,\n  options: BenchOptions,\n): Promise<bigint> {\n  const app = await launchElectronApp(options.target);\n  const page = await app.firstWindow();\n\n  try {\n    if (options.beforeRound) {\n      await options.beforeRound({ page });\n    }\n\n    const startTs = InstrumentHooks.currentTimestamp();\n    await fn({ page });\n    const endTs = InstrumentHooks.currentTimestamp();\n\n    InstrumentHooks.addMarker(\n      process.pid,\n      MARKER_TYPE_BENCHMARK_START,\n      startTs,\n    );\n    InstrumentHooks.addMarker(process.pid, MARKER_TYPE_BENCHMARK_END, endTs);\n\n    if (options.afterRound) {\n      await options.afterRound({ page });\n    }\n\n    return endTs - startTs;\n  } finally {\n    await app.close();\n  }\n}\n\nfunction buildStats(sampleTimesNs: bigint[]): BenchmarkStats {\n  const sortedTimesNs = sampleTimesNs\n    .map((n) => Number(n))\n    .sort((a, b) => a - b);\n\n  const sum = sortedTimesNs.reduce((acc, t) => acc + t, 0);\n  const meanNs = sum / sortedTimesNs.length;\n  const variance =\n    sortedTimesNs.reduce((acc, t) => acc + (t - meanNs) ** 2, 0) /\n    sortedTimesNs.length;\n  const stdevNs = Math.sqrt(variance);\n\n  const { q1_ns, median_ns, q3_ns, iqr_outlier_rounds, stdev_outlier_rounds } =\n    calculateQuantiles({\n      meanNs,\n      stdevNs,\n      sortedTimesNs,\n    });\n\n  return {\n    min_ns: sortedTimesNs[0],\n    max_ns: sortedTimesNs[sortedTimesNs.length - 1],\n    mean_ns: meanNs,\n    stdev_ns: stdevNs,\n    q1_ns,\n    median_ns,\n    q3_ns,\n    rounds: sortedTimesNs.length,\n    total_time: msToS(sum / 1e6),\n    iqr_outlier_rounds,\n    stdev_outlier_rounds,\n    iter_per_round: 1,\n    warmup_iters: 0,\n  };\n}\n\n/**\n * Define and run a CodSpeed-instrumented benchmark, mirroring Playwright's\n * `test` API.\n *\n * Launches the target once per round, runs the user-provided function around a\n * measured region, and writes walltime results to disk so that the CodSpeed\n * runner can pick them up.\n *\n * @example\n * ```ts\n * import { bench } from \"@codspeed/playwright-plugin\";\n *\n * bench(\n *   \"renders the dashboard\",\n *   async ({ page }) => {\n *     await page.getByRole(\"link\", { name: \"Dashboard\" }).click();\n *     await page.getByRole(\"heading\", { name: \"Overview\" }).waitFor();\n *   },\n *   {\n *     target: { kind: \"electron\", appPath: \"out/main/index.js\" },\n *     rounds: 5,\n *   },\n * );\n * ```\n */\nexport async function bench(\n  name: string,\n  fn: BenchFunction,\n  options: BenchOptions,\n): Promise<void> {\n  const rounds = resolveRounds(options.rounds);\n  const uri = `${getCallingFile(1)}::${name}`;\n\n  ensureIntegrationSetup();\n\n  InstrumentHooks.setExecutedBenchmark(process.pid, uri);\n  InstrumentHooks.startBenchmark();\n\n  const sampleTimesNs: bigint[] = [];\n  try {\n    for (let i = 0; i < rounds; i++) {\n      const elapsedNs = await runOneSample(fn, options);\n      sampleTimesNs.push(elapsedNs);\n      console.log(\n        `[CodSpeed] [round ${i + 1}/${rounds}] ${(Number(elapsedNs) / 1e6).toFixed(2)} ms`,\n      );\n    }\n  } finally {\n    InstrumentHooks.stopBenchmark();\n  }\n\n  const benchmark: Benchmark = {\n    name,\n    uri,\n    config: {\n      warmup_time_ns: null,\n      min_round_time_ns: null,\n      max_rounds: rounds,\n      max_time_ns: null,\n    },\n    stats: buildStats(sampleTimesNs),\n  };\n\n  writeWalltimeResults([benchmark]);\n}\n\nexport type { Page } from \"playwright-core\";\n"],"names":["electron"],"mappings":";;;;;AAkBA,MAAM,cAAA,GAAiB,CAAA;AACvB,MAAM,0BAAA,GACJ,0GAAA;AAwEF,IAAI,sBAAA,GAAyB,KAAA;AAO7B,SAAS,sBAAA,GAA+B;AACtC,EAAA,IAAI,sBAAA;AAAwB,IAAA;AAC5B,EAAA,sBAAA,GAAyB,IAAA;AAEzB,EAAA,eAAA,CAAgB,cAAA,CAAe,eAAe,OAAW,CAAA;AACzD,EAAA,eAAA,CAAgB,cAAA,CAAe,QAAA,EAAU,SAAA,EAAW,OAAA,CAAQ,SAAS,IAAI,CAAA;AACzE,EAAA,eAAA,CAAgB,cAAA,CAAe,QAAA,EAAU,IAAA,EAAM,OAAA,CAAQ,SAAS,EAAE,CAAA;AAClE,EAAA,eAAA,CAAgB,gBAAA,CAAiB,QAAQ,GAAG,CAAA;AAC9C;AAEA,SAAS,cAAc,YAAA,EAA0C;AAC/D,EAAA,MAAM,QAAA,GAAW,QAAQ,GAAA,CAAI,0BAAA;AAC7B,EAAA,MAAM,MAAM,QAAA,IAAY,YAAA;AACxB,EAAA,IAAI,GAAA,KAAQ,MAAA;AAAW,IAAA,OAAO,cAAA;AAC9B,EAAA,MAAM,CAAA,GAAI,OAAO,GAAG,CAAA;AACpB,EAAA,IAAI,CAAC,MAAA,CAAO,SAAA,CAAU,CAAC,CAAA,IAAK,IAAI,CAAA,EAAG;AACjC,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,sBAAA,EAAyB,GAAA,CAAA,4BAAA,CAAiC,CAAA;AAAA,EAC5E;AACA,EAAA,OAAO,CAAA;AACT;AAWA,SAAS,0BAA0B,GAAA,EAAqB;AACtD,EAAA,MAAM,OAAA,GAAU,aAAA,CAAc,aAAA,CAAc,CAAA,EAAG,MAAM,CAAC,CAAA;AAEtD,EAAA,OAAO,QAAQ,UAAU,CAAA;AAC3B;AAEA,eAAe,kBACb,MAAA,EAC8B;AAC9B,EAAA,MAAM,GAAA,GAAM,MAAA,CAAO,GAAA,IAAO,OAAA,CAAQ,GAAA,EAAI;AACtC,EAAA,OAAOA,UAAS,MAAA,CAAO;AAAA,IACrB,IAAA,EAAM;AAAA,MACJ,MAAA,CAAO,OAAA;AAAA,MACP,GAAI,MAAA,CAAO,YAAA,IAAgB,EAAC;AAAA,MAC5B,CAAA,WAAA,EAAc,0BAAA,CAAA;AAAA,KAChB;AAAA,IACA,GAAA;AAAA,IACA,cAAA,EACE,MAAA,CAAO,sBAAA,IAA0B,yBAAA,CAA0B,GAAG;AAAA,GACjE,CAAA;AACH;AAEA,eAAe,YAAA,CACb,IACA,OAAA,EACiB;AACjB,EAAA,MAAM,GAAA,GAAM,MAAM,iBAAA,CAAkB,OAAA,CAAQ,MAAM,CAAA;AAClD,EAAA,MAAM,IAAA,GAAO,MAAM,GAAA,CAAI,WAAA,EAAY;AAEnC,EAAA,IAAI;AACF,IAAA,IAAI,QAAQ,WAAA,EAAa;AACvB,MAAA,MAAM,OAAA,CAAQ,WAAA,CAAY,EAAE,IAAA,EAAM,CAAA;AAAA,IACpC;AAEA,IAAA,MAAM,OAAA,GAAU,gBAAgB,gBAAA,EAAiB;AACjD,IAAA,MAAM,EAAA,CAAG,EAAE,IAAA,EAAM,CAAA;AACjB,IAAA,MAAM,KAAA,GAAQ,gBAAgB,gBAAA,EAAiB;AAE/C,IAAA,eAAA,CAAgB,SAAA;AAAA,MACd,OAAA,CAAQ,GAAA;AAAA,MACR,2BAAA;AAAA,MACA;AAAA,KACF;AACA,IAAA,eAAA,CAAgB,SAAA,CAAU,OAAA,CAAQ,GAAA,EAAK,yBAAA,EAA2B,KAAK,CAAA;AAEvE,IAAA,IAAI,QAAQ,UAAA,EAAY;AACtB,MAAA,MAAM,OAAA,CAAQ,UAAA,CAAW,EAAE,IAAA,EAAM,CAAA;AAAA,IACnC;AAEA,IAAA,OAAO,KAAA,GAAQ,OAAA;AAAA,EACjB,CAAA,SAAE;AACA,IAAA,MAAM,IAAI,KAAA,EAAM;AAAA,EAClB;AACF;AAEA,SAAS,WAAW,aAAA,EAAyC;AAC3D,EAAA,MAAM,aAAA,GAAgB,aAAA,CACnB,GAAA,CAAI,CAAC,MAAM,MAAA,CAAO,CAAC,CAAC,CAAA,CACpB,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,IAAI,CAAC,CAAA;AAEvB,EAAA,MAAM,GAAA,GAAM,cAAc,MAAA,CAAO,CAAC,KAAK,CAAA,KAAM,GAAA,GAAM,GAAG,CAAC,CAAA;AACvD,EAAA,MAAM,MAAA,GAAS,MAAM,aAAA,CAAc,MAAA;AACnC,EAAA,MAAM,QAAA,GACJ,aAAA,CAAc,MAAA,CAAO,CAAC,GAAA,EAAK,CAAA,KAAM,GAAA,GAAA,CAAO,CAAA,GAAI,MAAA,KAAW,CAAA,EAAG,CAAC,CAAA,GAC3D,aAAA,CAAc,MAAA;AAChB,EAAA,MAAM,OAAA,GAAU,IAAA,CAAK,IAAA,CAAK,QAAQ,CAAA;AAElC,EAAA,MAAM,EAAE,KAAA,EAAO,SAAA,EAAW,OAAO,kBAAA,EAAoB,oBAAA,KACnD,kBAAA,CAAmB;AAAA,IACjB,MAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACD,CAAA;AAEH,EAAA,OAAO;AAAA,IACL,MAAA,EAAQ,cAAc,CAAC,CAAA;AAAA,IACvB,MAAA,EAAQ,aAAA,CAAc,aAAA,CAAc,MAAA,GAAS,CAAC,CAAA;AAAA,IAC9C,OAAA,EAAS,MAAA;AAAA,IACT,QAAA,EAAU,OAAA;AAAA,IACV,KAAA;AAAA,IACA,SAAA;AAAA,IACA,KAAA;AAAA,IACA,QAAQ,aAAA,CAAc,MAAA;AAAA,IACtB,UAAA,EAAY,KAAA,CAAM,GAAA,GAAM,GAAG,CAAA;AAAA,IAC3B,kBAAA;AAAA,IACA,oBAAA;AAAA,IACA,cAAA,EAAgB,CAAA;AAAA,IAChB,YAAA,EAAc;AAAA,GAChB;AACF;AA2BA,eAAsB,KAAA,CACpB,IAAA,EACA,EAAA,EACA,OAAA,EACe;AACf,EAAA,MAAM,MAAA,GAAS,aAAA,CAAc,OAAA,CAAQ,MAAM,CAAA;AAC3C,EAAA,MAAM,GAAA,GAAM,CAAA,EAAG,cAAA,CAAe,CAAC,CAAA,CAAA,EAAA,EAAM,IAAA,CAAA,CAAA;AAErC,EAAA,sBAAA,EAAuB;AAEvB,EAAA,eAAA,CAAgB,oBAAA,CAAqB,OAAA,CAAQ,GAAA,EAAK,GAAG,CAAA;AACrD,EAAA,eAAA,CAAgB,cAAA,EAAe;AAE/B,EAAA,MAAM,gBAA0B,EAAC;AACjC,EAAA,IAAI;AACF,IAAA,KAAA,IAAS,CAAA,GAAI,CAAA,EAAG,CAAA,GAAI,MAAA,EAAQ,CAAA,EAAA,EAAK;AAC/B,MAAA,MAAM,SAAA,GAAY,MAAM,YAAA,CAAa,EAAA,EAAI,OAAO,CAAA;AAChD,MAAA,aAAA,CAAc,KAAK,SAAS,CAAA;AAC5B,MAAA,OAAA,CAAQ,GAAA;AAAA,QACN,CAAA,kBAAA,EAAqB,IAAI,CAAA,CAAA,CAAA,EAAK,MAAA,CAAA,EAAA,EAAA,CAAY,OAAO,SAAS,CAAA,GAAI,GAAA,EAAK,OAAA,CAAQ,CAAC,CAAA,CAAA,GAAA;AAAA,OAC9E;AAAA,IACF;AAAA,EACF,CAAA,SAAE;AACA,IAAA,eAAA,CAAgB,aAAA,EAAc;AAAA,EAChC;AAEA,EAAA,MAAM,SAAA,GAAuB;AAAA,IAC3B,IAAA;AAAA,IACA,GAAA;AAAA,IACA,MAAA,EAAQ;AAAA,MACN,cAAA,EAAgB,IAAA;AAAA,MAChB,iBAAA,EAAmB,IAAA;AAAA,MACnB,UAAA,EAAY,MAAA;AAAA,MACZ,WAAA,EAAa;AAAA,KACf;AAAA,IACA,KAAA,EAAO,WAAW,aAAa;AAAA,GACjC;AAEA,EAAA,oBAAA,CAAqB,CAAC,SAAS,CAAC,CAAA;AAClC;;;;"}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@codspeed/playwright-plugin",
+  "version": "5.5.0",
+  "description": "Playwright benchmarking integration for CodSpeed",
+  "keywords": [
+    "codspeed",
+    "benchmark",
+    "playwright",
+    "electron",
+    "performance"
+  ],
+  "main": "dist/index.cjs",
+  "module": "dist/index.es5.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.es5.js",
+    "require": "./dist/index.cjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "Guillaume Lagrange <guillaume@codspeed.io>",
+  "repository": "https://github.com/CodSpeedHQ/codspeed-node",
+  "homepage": "https://codspeed.io",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "playwright": "^1.48.0",
+    "playwright-core": "^1.48.0",
+    "vitest": "^3.2.4"
+  },
+  "dependencies": {
+    "@codspeed/core": "^5.5.0"
+  },
+  "peerDependencies": {
+    "playwright": ">=1.40.0"
+  },
+  "scripts": {
+    "build": "NODE_NO_WARNINGS=1 rollup -c rollup.config.ts --configPlugin typescript",
+    "test": "echo 'no tests'",
+    "test/integ": "echo 'no integ tests'",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit --pretty",
+    "format": "prettier --config ../../.prettierrc.json --ignore-path ../../.prettierignore --check .",
+    "fix-format": "prettier --config ../../.prettierrc.json --ignore-path ../../.prettierignore --write .",
+    "clean": "rm -rf dist"
+  }
+}