@trackunit/iris-app-playwright 0.1.27 → 0.1.29

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-playwright",
-  "version": "0.1.27",
+  "version": "0.1.29",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "generators": "./generators.json",

package/src/fixtures/baseTest.d.ts

@@ -1,7 +1,5 @@
 import { expect } from "@playwright/test";
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
-    _harRecording: void;
-} & import("./login.fixture").TrackunitBaseFixtures & import("./irisApp.fixture").IrisAppFixtures & import("./featureFlags.fixture").FeatureFlagFixtures & import("./localDevMode.fixture").LocalDevModeFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("./login.fixture").LoginCacheFixtures>;
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & import("./login.fixture").TrackunitBaseFixtures & import("./irisApp.fixture").IrisAppFixtures & import("./featureFlags.fixture").FeatureFlagFixtures & import("./localDevMode.fixture").LocalDevModeFixtures, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions & import("./login.fixture").LoginCacheFixtures>;
 export { expect };
 export type { FeatureFlag, FeatureFlagFixtures } from "./featureFlags.fixture";
 export type { IrisAppFixtures, IrisAppOptions, StorybookPreviewOptions } from "./irisApp.fixture";

package/src/fixtures/finalizeHarRecording.d.ts

@@ -0,0 +1,27 @@
+/** Name of the per-test HAR file written by `recordHar` and read by `LogsReporter`. */
+export declare const HAR_FILENAME = "test.har";
+/**
+ * Minimal slice of Playwright's `TestInfo` needed to finalize HAR recording.
+ * Declared structurally so the behavior can be unit-tested without constructing
+ * a full `TestInfo`; the real `TestInfo` satisfies it.
+ */
+export interface HarTestInfo {
+    outputPath(...pathSegments: Array<string>): string;
+    attach(name: string, options: {
+        path: string;
+    }): Promise<void>;
+}
+/**
+ * Attaches the per-test HAR (so it appears in the HTML report and is discoverable
+ * by `LogsReporter`), then deletes the original `recordHar` output file.
+ *
+ * `recordHar` writes the HAR to `testInfo.outputPath("test.har")`. `testInfo.attach`
+ * copies that file into Playwright's managed attachments location and points the
+ * attachment at the copy — which is the only path `LogsReporter` ever sees and
+ * cleans up (deleted on pass, redacted and retained on failure). The original file
+ * is left untouched, so without this deletion every test (passing included) leaks a
+ * `test.har` into the persisted workspace and stored CI artifacts, growing with the
+ * suite. Removing it here closes the leak while leaving the attachment copy for the
+ * reporter to retain on failure.
+ */
+export declare const finalizeHarRecording: (testInfo: HarTestInfo) => Promise<void>;

package/src/fixtures/finalizeHarRecording.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.finalizeHarRecording = exports.HAR_FILENAME = void 0;
+const fs_1 = require("fs");
+/** Name of the per-test HAR file written by `recordHar` and read by `LogsReporter`. */
+exports.HAR_FILENAME = "test.har";
+/**
+ * Attaches the per-test HAR (so it appears in the HTML report and is discoverable
+ * by `LogsReporter`), then deletes the original `recordHar` output file.
+ *
+ * `recordHar` writes the HAR to `testInfo.outputPath("test.har")`. `testInfo.attach`
+ * copies that file into Playwright's managed attachments location and points the
+ * attachment at the copy — which is the only path `LogsReporter` ever sees and
+ * cleans up (deleted on pass, redacted and retained on failure). The original file
+ * is left untouched, so without this deletion every test (passing included) leaks a
+ * `test.har` into the persisted workspace and stored CI artifacts, growing with the
+ * suite. Removing it here closes the leak while leaving the attachment copy for the
+ * reporter to retain on failure.
+ */
+const finalizeHarRecording = async (testInfo) => {
+    const harPath = testInfo.outputPath(exports.HAR_FILENAME);
+    if (!(0, fs_1.existsSync)(harPath)) {
+        return;
+    }
+    await testInfo.attach("har", { path: harPath });
+    (0, fs_1.rmSync)(harPath, { force: true });
+};
+exports.finalizeHarRecording = finalizeHarRecording;
+//# sourceMappingURL=finalizeHarRecording.js.map

package/src/fixtures/harRecording.fixture.d.ts

@@ -1,12 +1,14 @@
 /**
- * Adds Playwright HAR recording without replacing the built-in `context` fixture.
+ * Adds Playwright HAR recording without permanently leaking the per-test HAR.
  *
- * `contextOptions` is merged into the default `browser.newContext()` call by Playwright's
- * own `context` fixture, so trace/video/screenshot retention configured via `use` still works.
- * `_harRecording` is an auto-fixture that depends on `context` so its teardown runs after the
- * context closes — that's when Playwright flushes the HAR file to disk, which is when we
- * can attach it as `har` for `LogsReporter` to retain (on failure) or delete (on pass).
+ * `recordHar` (configured via `contextOptions`) only flushes the HAR to disk when the
+ * browser context closes. Playwright tears fixtures down in reverse dependency order, so a
+ * fixture that merely *depends on* `context` is torn down BEFORE the built-in `context`
+ * fixture closes the context — at which point `testInfo.outputPath("test.har")` does not yet
+ * exist and any cleanup there is a no-op (this was the original leak: a `test.har` survived
+ * for every test). We therefore override `context` itself: after the test body we close the
+ * context to flush the HAR, then attach + clean it up via `finalizeHarRecording`. The
+ * built-in `context` teardown still runs afterwards — `close()` on an already-closed context
+ * is a no-op — so trace/video/screenshot retain-on-failure are unaffected.
  */
-export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
-    _harRecording: void;
-}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+export declare const test: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;

package/src/fixtures/harRecording.fixture.js

@@ -2,34 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.test = void 0;
 const test_1 = require("@playwright/test");
-const fs_1 = require("fs");
-const HAR_FILENAME = "test.har";
+const finalizeHarRecording_1 = require("./finalizeHarRecording");
 /**
- * Adds Playwright HAR recording without replacing the built-in `context` fixture.
+ * Adds Playwright HAR recording without permanently leaking the per-test HAR.
  *
- * `contextOptions` is merged into the default `browser.newContext()` call by Playwright's
- * own `context` fixture, so trace/video/screenshot retention configured via `use` still works.
- * `_harRecording` is an auto-fixture that depends on `context` so its teardown runs after the
- * context closes — that's when Playwright flushes the HAR file to disk, which is when we
- * can attach it as `har` for `LogsReporter` to retain (on failure) or delete (on pass).
+ * `recordHar` (configured via `contextOptions`) only flushes the HAR to disk when the
+ * browser context closes. Playwright tears fixtures down in reverse dependency order, so a
+ * fixture that merely *depends on* `context` is torn down BEFORE the built-in `context`
+ * fixture closes the context — at which point `testInfo.outputPath("test.har")` does not yet
+ * exist and any cleanup there is a no-op (this was the original leak: a `test.har` survived
+ * for every test). We therefore override `context` itself: after the test body we close the
+ * context to flush the HAR, then attach + clean it up via `finalizeHarRecording`. The
+ * built-in `context` teardown still runs afterwards — `close()` on an already-closed context
+ * is a no-op — so trace/video/screenshot retain-on-failure are unaffected.
  */
 exports.test = test_1.test.extend({
     contextOptions: async ({ contextOptions }, provide, testInfo) => {
-        const harPath = testInfo.outputPath(HAR_FILENAME);
         await provide({
             ...contextOptions,
-            recordHar: { path: harPath, mode: "minimal" },
+            recordHar: { path: testInfo.outputPath(finalizeHarRecording_1.HAR_FILENAME), mode: "minimal" },
         });
     },
-    _harRecording: [
-        async ({ context: _context }, provide, testInfo) => {
-            await provide();
-            const harPath = testInfo.outputPath(HAR_FILENAME);
-            if ((0, fs_1.existsSync)(harPath)) {
-                await testInfo.attach("har", { path: harPath });
-            }
-        },
-        { auto: true },
-    ],
+    context: async ({ context }, provide, testInfo) => {
+        await provide(context);
+        await context.close();
+        await (0, finalizeHarRecording_1.finalizeHarRecording)(testInfo);
+    },
 });
 //# sourceMappingURL=harRecording.fixture.js.map