@empiricalrun/playwright-utils 0.16.0 → 0.16.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.16.1
+
+### Patch Changes
+
+- f1ab4f3: feat: added custom context page provider
+
 ## 0.16.0
 
 ### Minor Changes

package/dist/test/index.d.ts

@@ -1,8 +1,14 @@
-import type { PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
+import type { BrowserContext, BrowserContextOptions, Page, PlaywrightTestArgs, PlaywrightTestOptions, PlaywrightWorkerArgs, PlaywrightWorkerOptions, TestType } from "@playwright/test";
 import { injectLocatorHighlightScripts } from "./scripts";
 import { HighlighterOpts } from "./types";
-export declare const baseTestFixture: (testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>, options?: HighlighterOpts) => TestType<PlaywrightTestArgs & PlaywrightTestOptions & {
-    [key: string]: any;
-}, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
+type TestOptions = {
+    page: Page;
+    customContextPageProvider: (options?: BrowserContextOptions) => Promise<{
+        context: BrowserContext;
+        page: Page;
+    }>;
+    saveVideos: void;
+};
+export declare const baseTestFixture: (testFn: TestType<PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>, options?: HighlighterOpts) => TestType<PlaywrightTestArgs & PlaywrightTestOptions & TestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 export { injectLocatorHighlightScripts };
 //# sourceMappingURL=index.d.ts.map

package/dist/test/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,eAAe;;kDAYzB,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/test/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,qBAAqB,EACrB,IAAI,EACJ,kBAAkB,EAClB,qBAAqB,EACrB,oBAAoB,EACpB,uBAAuB,EACvB,QAAQ,EACT,MAAM,kBAAkB,CAAC;AAK1B,OAAO,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,yBAAyB,EAAE,CACzB,OAAO,CAAC,EAAE,qBAAqB,KAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAC;QAAC,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IACtD,UAAU,EAAE,IAAI,CAAC;CAClB,CAAC;AAIF,eAAO,MAAM,eAAe,WAClB,SACN,kBAAkB,GAAG,qBAAqB,EAC1C,oBAAoB,GAAG,uBAAuB,CAC/C,YACQ,eAAe,uHA2DzB,CAAC;AAEF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/test/index.js

@@ -1,8 +1,15 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.injectLocatorHighlightScripts = exports.baseTestFixture = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const rimraf_1 = require("rimraf");
 const scripts_1 = require("./scripts");
 Object.defineProperty(exports, "injectLocatorHighlightScripts", { enumerable: true, get: function () { return scripts_1.injectLocatorHighlightScripts; } });
+const videoStore = "videos-store";
 const baseTestFixture = function (testFn, options = {
     mousePointerHighlighter: true,
     locatorHighlighter: true,
@@ -13,6 +20,45 @@ const baseTestFixture = function (testFn, options = {
             (0, scripts_1.injectLocatorHighlightScripts)(page, options);
             await use(page);
         },
+        customContextPageProvider: async ({ page }, use, testInfo) => {
+            const contexts = [];
+            async function createContext(options = {}) {
+                const pageContext = await page
+                    .context()
+                    .browser()
+                    .newContext({
+                    ...options,
+                    recordVideo: {
+                        dir: path_1.default.join(testInfo.project.outputDir, videoStore, testInfo.testId),
+                    },
+                });
+                contexts.push(pageContext);
+                const customPage = await pageContext.newPage();
+                (0, scripts_1.injectLocatorHighlightScripts)(customPage);
+                return { context: pageContext, page: customPage };
+            }
+            await use(createContext);
+            for (const context of contexts) {
+                await context.close();
+            }
+        },
+        saveVideos: [
+            // eslint-disable-next-line no-empty-pattern
+            async ({}, use, testInfo) => {
+                await use();
+                const pathToTestVideos = path_1.default.join(testInfo.project.outputDir, "videos-store", testInfo.testId);
+                if (fs_1.default.existsSync(pathToTestVideos)) {
+                    for (let name of fs_1.default.readdirSync(pathToTestVideos)) {
+                        await testInfo.attach("video", {
+                            path: path_1.default.join(pathToTestVideos, name),
+                            contentType: "video/webm",
+                        });
+                    }
+                    (0, rimraf_1.rimrafSync)(pathToTestVideos);
+                }
+            },
+            { auto: true },
+        ],
     });
 };
 exports.baseTestFixture = baseTestFixture;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.16.0",
+  "version": "0.16.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -40,6 +40,7 @@
     "playwright-core": "1.47.1",
     "playwright-extra": "^4.3.6",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
+    "rimraf": "^6.0.1",
     "@empiricalrun/llm": "^0.9.27",
     "@empiricalrun/r2-uploader": "^0.3.7"
   },