@empiricalrun/playwright-utils 0.14.2 → 0.14.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/playwright-utils
 
+## 0.14.3
+
+### Patch Changes
+
+- 3c9f929: feat: AuthStore API changes, better login logic, docs
+
 ## 0.14.2
 
 ### Patch Changes

package/dist/auth/index.d.ts

@@ -3,11 +3,16 @@ type WithKey<T> = T & {
     key: string;
 };
 export declare class AuthStore<T extends WithKey<{}>> {
-    private page;
-    private userContext;
-    private loginFunc;
-    private checkLoggedInFunc;
-    constructor(page: Page, userContext: T, loginFunc: (page: Page, userContext: T) => Promise<void>, checkLoggedInFunc: (page: Page, userContext: T) => Promise<boolean>);
+    page: Page;
+    userContext: T;
+    loginFunc: (page: Page, userContext: T) => Promise<void>;
+    checkLoggedInFunc: (page: Page, userContext: T) => Promise<boolean>;
+    constructor({ page, userContext, loginFunc, checkLoggedInFunc, }: {
+        page: Page;
+        userContext: T;
+        loginFunc: (page: Page, userContext: T) => Promise<void>;
+        checkLoggedInFunc: (page: Page, userContext: T) => Promise<boolean>;
+    });
     loginIfRequired(): Promise<void>;
     static location(userContext: {
         key: string;

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/auth/index.ts"],"names":[],"mappings":"AAAA,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;IAExC,OAAO,CAAC,IAAI;IACZ,OAAO,CAAC,WAAW;IACnB,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,iBAAiB;gBAHjB,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,CAAC,EACd,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,EACxD,iBAAiB,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC;IAGvE,eAAe;IAwBrB,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,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"}

package/dist/auth/index.js

@@ -1,13 +1,17 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthStore = void 0;
+const fs_1 = __importDefault(require("fs"));
 const playwright_core_1 = require("playwright-core");
 class AuthStore {
     page;
     userContext;
     loginFunc;
     checkLoggedInFunc;
-    constructor(page, userContext, loginFunc, checkLoggedInFunc) {
+    constructor({ page, userContext, loginFunc, checkLoggedInFunc, }) {
         this.page = page;
         this.userContext = userContext;
         this.loginFunc = loginFunc;
@@ -15,21 +19,31 @@ class AuthStore {
     }
     async loginIfRequired() {
         let shouldDoLogin = false;
-        try {
-            const hasLoggedIn = await this.checkLoggedInFunc(this.page, this.userContext);
-            shouldDoLogin = !hasLoggedIn;
+        const storagePath = AuthStore.location(this.userContext);
+        if (!fs_1.default.existsSync(storagePath)) {
+            shouldDoLogin = true;
         }
-        catch (err) {
-            if (err instanceof playwright_core_1.errors.TimeoutError) {
-                shouldDoLogin = true;
+        else {
+            const browser = this.page.context().browser();
+            const newContext = await browser.newContext({
+                storageState: storagePath,
+            });
+            const page = await newContext.newPage();
+            try {
+                const hasLoggedIn = await this.checkLoggedInFunc(page, this.userContext);
+                shouldDoLogin = !hasLoggedIn;
             }
-            else {
-                throw err;
+            catch (err) {
+                if (err instanceof playwright_core_1.errors.TimeoutError) {
+                    shouldDoLogin = true;
+                }
+                else {
+                    throw err;
+                }
             }
         }
         if (shouldDoLogin) {
             await this.loginFunc(this.page, this.userContext);
-            const storagePath = AuthStore.location(this.userContext);
             await this.page.context().storageState({ path: storagePath });
         }
     }

package/docs/auth.md

@@ -4,7 +4,7 @@ This builds around playwright's `storageState` primitive which is used to cache
 auth related state (in a json file on disk).
 
 This requires an object of `UserContext` type, which has a `key: string`. The
-rest of the object can be custom.
+rest of the object can be custom. See [section](#set-up-usercontext) on how to do that.
 
 ## Usage
 
@@ -46,3 +46,47 @@ projects: [
   }
 ]
 ```
+
+## Set up UserContext
+
+- Create the `UserContext` type and implementations of that type in `test-data/index.ts`
+- Create `TestOptions` in `fixtures.ts` that has all options that can be configured
+- Configure fixtures and `playwright.config.ts` to use `TestOptions` type
+- Set the `userContext` in the project.use field
+
+```ts
+// fixtures.ts
+import { baseTestFixture } from "@empiricalrun/playwright-utils/test";
+import { UserContext } from "./test-data";
+
+export type UserContext = {
+  key: string;
+  // other fields
+}
+
+export type TestOptions = {
+  userContext: UserContext;
+}
+
+export const test = baseTestFixture(base).extend<TestOptions>({
+  userContext: [primaryUser, { option: true }],
+});
+```
+
+```ts
+// playwright.config.ts
+import { defineConfig } from "@playwright/test";
+import { someTypeOfUser } from "./test-data";
+
+export default defineConfig<TestOptions>({
+  ...baseConfig,
+  projects: [
+    {
+      name: "chromium",
+      use: {
+        userContext: someTypeOfUser
+      },
+    },
+  ],
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,20 +22,20 @@
   },
   "author": "Empirical Team <hey@empirical.run>",
   "devDependencies": {
-    "@playwright/test": "^1.47.1",
-    "@types/node": "^20.14.9"
+    "@playwright/test": "1.47.1",
+    "@types/node": "^20.14.9",
+    "@types/babel__code-frame": "^7.0.6",
+    "@types/md5": "^2.3.5",
+    "@types/mime": "3.0.0"
   },
   "dependencies": {
     "@aws-sdk/client-s3": "^3.614.0",
     "@aws-sdk/s3-request-presigner": "^3.614.0",
     "@babel/code-frame": "^7.24.7",
-    "@types/babel__code-frame": "^7.0.6",
-    "@types/md5": "^2.3.5",
-    "@types/mime": "3.0.0",
     "mailosaur": "^8.6.1",
     "md5": "^2.3.0",
     "mime": "3.0.0",
-    "playwright-core": "^1.46.1",
+    "playwright-core": "1.47.1",
     "playwright-extra": "^4.3.6",
     "puppeteer-extra-plugin-recaptcha": "^3.6.8",
     "@empiricalrun/llm": "^0.9.4",