@empiricalrun/playwright-utils 0.14.25 → 0.14.27

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @empiricalrun/playwright-utils
 
+## 0.14.27
+
+### Patch Changes
+
+- 714eb31: feat: support chrome extensions in AuthStore
+
+## 0.14.26
+
+### Patch Changes
+
+- Updated dependencies [2dafa69]
+  - @empiricalrun/llm@0.9.19
+
 ## 0.14.25
 
 ### Patch Changes

package/dist/auth/index.d.ts

@@ -1,22 +1,28 @@
-import { Page } from "playwright-core";
+import { BrowserContext, Page } from "playwright-core";
 type WithKey<T> = T & {
     key: string;
 };
+type AppType = "web-app" | "chrome-extension";
 export declare class AuthStore<T extends WithKey<{}>> {
+    appType: AppType;
     page: Page;
     userContext: T;
     loginFunc: (page: Page, userContext: T) => Promise<void>;
     checkLoggedInFunc: (page: Page, userContext: T) => Promise<boolean>;
-    constructor({ page, userContext, loginFunc, checkLoggedInFunc, }: {
+    constructor({ page, userContext, loginFunc, checkLoggedInFunc, appType, }: {
         page: Page;
         userContext: T;
         loginFunc: (page: Page, userContext: T) => Promise<void>;
         checkLoggedInFunc: (page: Page, userContext: T) => Promise<boolean>;
+        appType?: AppType;
     });
     loginIfRequired(): Promise<void>;
+    private pageWithAuthState;
+    private saveAuthState;
     static location(userContext: {
         key: string;
     }): string;
+    static loadStateForCrx(context: BrowserContext, userContext: WithKey<any>): Promise<void>;
 }
 export {};
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE/C,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,GAClB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;KACrE;IAOK,eAAe;IAgCrB,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;CAGtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAU,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE/D,KAAK,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,KAAK,OAAO,GAAG,SAAS,GAAG,kBAAkB,CAAC;AAE9C,qBAAa,SAAS,CAAC,CAAC,SAAS,OAAO,CAAC,EAAE,CAAC;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,CAAC,CAAC;IACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;gBACxD,EACV,IAAI,EACJ,WAAW,EACX,SAAS,EACT,iBAAiB,EACjB,OAAmB,GACpB,EAAE;QACD,IAAI,EAAE,IAAI,CAAC;QACX,WAAW,EAAE,CAAC,CAAC;QACf,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;QACzD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;QACpE,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB;IAQK,eAAe;YA4BP,iBAAiB;YAsBjB,aAAa;IAyB3B,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM;WAIxC,eAAe,CAC1B,OAAO,EAAE,cAAc,EACvB,WAAW,EAAE,OAAO,CAAC,GAAG,CAAC;CAoB5B"}

package/dist/auth/index.js

@@ -7,11 +7,13 @@ exports.AuthStore = void 0;
 const fs_1 = __importDefault(require("fs"));
 const playwright_core_1 = require("playwright-core");
 class AuthStore {
+    appType;
     page;
     userContext;
     loginFunc;
     checkLoggedInFunc;
-    constructor({ page, userContext, loginFunc, checkLoggedInFunc, }) {
+    constructor({ page, userContext, loginFunc, checkLoggedInFunc, appType = "web-app", }) {
+        this.appType = appType;
         this.page = page;
         this.userContext = userContext;
         this.loginFunc = loginFunc;
@@ -24,11 +26,7 @@ class AuthStore {
             shouldDoLogin = true;
         }
         else {
-            const browser = this.page.context().browser();
-            const newContext = await browser.newContext({
-                storageState: storagePath,
-            });
-            const page = await newContext.newPage();
+            const page = await this.pageWithAuthState(this.page, storagePath);
             try {
                 const hasLoggedIn = await this.checkLoggedInFunc(page, this.userContext);
                 shouldDoLogin = !hasLoggedIn;
@@ -44,12 +42,72 @@ class AuthStore {
         }
         if (shouldDoLogin) {
             await this.loginFunc(this.page, this.userContext);
+            await this.saveAuthState(storagePath);
+        }
+    }
+    async pageWithAuthState(page, storagePath) {
+        if (this.appType === "web-app") {
+            // Load state from the file in a new context
+            // We create a new context because of Playwright APIs
+            const browser = page.context().browser();
+            const newContext = await browser.newContext({
+                storageState: storagePath,
+            });
+            return await newContext.newPage();
+        }
+        else if (this.appType === "chrome-extension") {
+            // Load state from chrome.storage.local into the
+            // existing browser context
+            const context = page.context();
+            await AuthStore.loadStateForCrx(context, this.userContext);
+            return await context.newPage();
+        }
+        throw new Error(`unable to load auth state for app type: ${this.appType}`);
+    }
+    async saveAuthState(storagePath) {
+        if (this.appType === "web-app") {
+            // Use playwright API to export state to a file
             await this.page.context().storageState({ path: storagePath });
         }
+        else if (this.appType === "chrome-extension") {
+            // Fetch and store state from chrome.storage.local
+            const context = this.page.context();
+            let [background] = context.serviceWorkers();
+            if (!background) {
+                background = await context.waitForEvent("serviceworker");
+            }
+            const storageData = await background.evaluate(() => {
+                return new Promise((resolve) => {
+                    // @ts-ignore
+                    // eslint-disable-next-line no-undef
+                    chrome.storage.local.get((items) => {
+                        resolve(JSON.stringify(items));
+                    });
+                });
+            });
+            fs_1.default.writeFileSync(storagePath, storageData);
+        }
     }
     // TODO: make this async
     static location(userContext) {
         return `auth/${userContext.key}.json`;
     }
+    static async loadStateForCrx(context, userContext) {
+        const storagePath = AuthStore.location(userContext);
+        let [background] = context.serviceWorkers();
+        if (!background) {
+            background = await context.waitForEvent("serviceworker");
+        }
+        const contents = JSON.parse(fs_1.default.readFileSync(storagePath, { encoding: "utf-8" }));
+        await background.evaluate((contents) => {
+            return new Promise((resolve) => {
+                // @ts-ignore
+                // eslint-disable-next-line no-undef
+                chrome.storage.local.set(contents, () => {
+                    resolve("done");
+                });
+            });
+        }, contents);
+    }
 }
 exports.AuthStore = AuthStore;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.14.25",
+  "version": "0.14.27",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -40,7 +40,7 @@
     "playwright-core": "1.47.1",
     "playwright-extra": "^4.3.6",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
-    "@empiricalrun/llm": "^0.9.18",
+    "@empiricalrun/llm": "^0.9.19",
     "@empiricalrun/r2-uploader": "^0.3.6"
   },
   "scripts": {