--wip-- [skip ci]

Author: GuillaumeLagrange

packages/playwright/src/index.ts

@@ -32,6 +32,11 @@ export interface BenchFixtures {
  */
 export type BenchFunction = (fixtures: BenchFixtures) => void | Promise<void>;
 
+/**
+ * A hook run around the measured region. Not included in the reported timing.
+ */
+export type BenchHook = (fixtures: BenchFixtures) => void | Promise<void>;
+
 /**
  * Minimal options for a benchmark. Inspired by Vitest's `bench`, but kept
  * deliberately small.
@@ -61,6 +66,16 @@ export interface BenchOptions {
    * directory.
    */
   executablePath?: string;
+  /**
+   * Run before each round, after the window opens. Use it to bring the app to
+   * a steady state (initial render done, data loaded, …). Not measured.
+   */
+  setup?: BenchHook;
+  /**
+   * Run after each round, before the app is closed. Use it for teardown that
+   * should not be measured.
+   */
+  teardown?: BenchHook;
 }
 
 let integrationInitialized = false;
@@ -111,6 +126,10 @@ async function runOneSample(
   const page = await app.firstWindow();
 
   try {
+    if (options.setup) {
+      await options.setup({ page });
+    }
+
     const startTs = InstrumentHooks.currentTimestamp();
     await fn({ page });
     const endTs = InstrumentHooks.currentTimestamp();
@@ -122,6 +141,10 @@ async function runOneSample(
     );
     InstrumentHooks.addMarker(process.pid, MARKER_TYPE_BENCHMARK_END, endTs);
 
+    if (options.teardown) {
+      await options.teardown({ page });
+    }
+
     return endTs - startTs;
   } finally {
     await app.close();