@bigbinary/neeto-playwright-commons 2.1.0 → 2.1.1

package/index.d.ts

@@ -1041,15 +1041,41 @@ declare class Health {
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
   /**
    *
-   * Performs login, waits until the main application UI (floating
+   * Navigates to the given route (default: /admin/admin-panel), waits for the page to
    *
-   * menu, logo, and heading) is present, and then executes your custom verification
+   * load, then logs in via the authenticator app using the production email from the
    *
-   * steps.
+   * environment.
    *
-   * customSteps (optional): An async function (no arguments) that runs after login and common
+   * route (optional): Path to open. Defaults to ROUTES.adminPanel.index.
    *
-   * verification. Use it to perform additional assertions or navigation.
+   * @example 
+   *
+   * await health.loginToApp(ROUTES.dashboard);
+   * @endexample
+  */
+  loginToApp: (route?: string) => Promise<void>;
+  /**
+   *
+   * Waits for the floating menu and page load, then asserts that the Neeto logo and
+   *
+   * main heading test IDs are visible.
+   *
+   * @example 
+   *
+   * await health.verifyAppUI();
+   * @endexample
+  */
+  verifyAppUI: () => Promise<void>;
+  /**
+   *
+   * Performs login, waits until the main application UI (floating menu, logo, and
+   *
+   * heading) is present, and then executes your custom verification steps.
+   *
+   * customSteps (optional): An async function (no arguments) that runs after login
+   *
+   * and common verification. Use it to perform additional assertions or navigation.
    *
    * @example 
    *
@@ -8704,23 +8730,26 @@ declare const PROJECT_NAMES: {
   readonly webkit: "webkit";
   readonly lighthouseAudits: "lighthouse-audits";
   readonly cleanupCredentials: "cleanup credentials";
+  readonly productionHealth: "production-health";
 };
 type ProjectName = ValueOf<typeof PROJECT_NAMES>;
 interface PlaydashOverrides {
   projectKey: string;
 }
 type WebServerConfig = Exclude<NonNullable<PlaywrightTestConfig["webServer"]>, readonly unknown[]>;
+type UnknownRecord = Record<string, unknown>;
 interface ProjectLaunchOptionsConfig extends LaunchOptions {
   mergeArgs?: boolean;
 }
 interface Overrides {
-  globalOverrides?: Record<string, unknown>;
-  useOverrides?: Record<string, unknown>;
+  globalOverrides?: UnknownRecord;
+  useOverrides?: UnknownRecord;
   useCustomProjects?: boolean;
-  projectOverrides?: Record<string, unknown>[];
-  playdashStagingOverrides?: PlaydashOverrides & Record<string, unknown>;
-  playdashProductionOverrides?: PlaydashOverrides & Record<string, unknown>;
-  playdashLighthouseOverrides?: PlaydashOverrides & Record<string, unknown>;
+  projectOverrides?: UnknownRecord[];
+  playdashStagingOverrides?: PlaydashOverrides & UnknownRecord;
+  playdashProductionOverrides?: PlaydashOverrides & UnknownRecord;
+  playdashLighthouseOverrides?: PlaydashOverrides & UnknownRecord;
+  playdashProductionHealthOverrides?: PlaydashOverrides & UnknownRecord;
   webServerOverrides?: WebServerConfig[];
   projectLaunchOptionsOverrides?: Partial<Record<ProjectName, ProjectLaunchOptionsConfig>>;
 }

package/index.js

@@ -8660,8 +8660,8 @@ class OrganizationPage {
             await codeInput.fill(totpToken);
             expect(totp.validate({ token: totpToken })).not.toBeNull();
             await Promise.all([
-                expect(codeInput).toBeHidden(),
-                expect(this.page.getByTestId(LOGIN_SELECTORS.enterOtpInputError)).toBeHidden(),
+                expect(codeInput).toBeHidden({ timeout: 10_000 }),
+                expect(this.page.getByTestId(LOGIN_SELECTORS.enterOtpInputError)).toBeHidden({ timeout: 10_000 }),
             ]);
         }).toPass({ timeout: 2 * 60 * 1000 });
     };
@@ -8821,22 +8821,25 @@ class Health {
     constructor(page, neetoPlaywrightUtilities) {
         this.page = page;
         this.neetoPlaywrightUtilities = neetoPlaywrightUtilities;
-        if (!process.env.PLAYWRIGHT_PRODUCTION_EMAIL) {
-            throw new Error("PLAYWRIGHT_PRODUCTION_EMAIL is not set");
+        if (!process.env.PLAYWRIGHT_PRODUCTION_EMAIL ||
+            !process.env.PLAYWRIGHT_PRODUCTION_2FA_SECRET_KEY) {
+            throw new Error("One or more required env variables are missing: PLAYWRIGHT_PRODUCTION_EMAIL, PLAYWRIGHT_PRODUCTION_2FA_SECRET_KEY");
         }
         this.loginPage = new OrganizationPage(page, neetoPlaywrightUtilities);
     }
+    loginToApp = async (route = ROUTES.adminPanel.index) => {
+        await this.page.goto(route);
+        await this.neetoPlaywrightUtilities.waitForPageLoad();
+        await this.loginPage.loginViaAuthenticatorApp(this.email);
+    };
+    verifyAppUI = async () => {
+        await this.neetoPlaywrightUtilities.waitForFloatingMenu();
+        await this.neetoPlaywrightUtilities.waitForPageLoad();
+        await Promise.all([COMMON_SELECTORS.neetoLogo, COMMON_SELECTORS.heading].map(selector => expect(this.page.getByTestId(selector)).toBeVisible()));
+    };
     verifyAppIsLive = async (customSteps) => {
-        await test.step("1: Login to the application", async () => {
-            await this.page.goto(ROUTES.adminPanel.index);
-            await this.neetoPlaywrightUtilities.waitForPageLoad();
-            await this.loginPage.loginViaAuthenticatorApp(this.email);
-        });
-        await test.step("2: Verify application is live", async () => {
-            await this.neetoPlaywrightUtilities.waitForFloatingMenu();
-            await this.neetoPlaywrightUtilities.waitForPageLoad();
-            await Promise.all([COMMON_SELECTORS.neetoLogo, COMMON_SELECTORS.heading].map(selector => expect(this.page.getByTestId(selector)).toBeVisible()));
-        });
+        await test.step("1: Login to the application", () => this.loginToApp());
+        await test.step("2: Verify application UI", this.verifyAppUI);
         await customSteps?.();
     };
 }
@@ -125293,19 +125296,13 @@ var mainExports = requireMain();
 var dotenvExpand = /*@__PURE__*/getDefaultExportFromCjs(mainExports);
 
 // @ts-check
+const loadEnv = (path) => dotenvExpand.expand(dotenv.config({ path, quiet: true }));
+const envBasePath = "./e2e/config/.env";
+const envLocalPath = `${envBasePath}.local`;
+const reporterPackageName = "@bigbinary/neeto-playwright-reporter";
 process.env.TEST_ENV = process.env.TEST_ENV ?? ENVIRONMENT.development;
-const env = dotenv.config({
-    path: `./e2e/config/.env.${process.env.TEST_ENV}`,
-    quiet: true,
-});
-dotenvExpand.expand(env);
-if (require$$0$3.existsSync("./e2e/config/.env.local")) {
-    const localEnv = dotenv.config({
-        path: "./e2e/config/.env.local",
-        quiet: true,
-    });
-    dotenvExpand.expand(localEnv);
-}
+loadEnv(`${envBasePath}.${process.env.TEST_ENV}`);
+require$$0$3.existsSync(envLocalPath) && loadEnv(envLocalPath);
 const playdashStagingConfig = {
     apiKey: process.env.PLAYDASH_STAGING_API_KEY,
     ciBuildId: process.env.NEETO_CI_JOB_ID,
@@ -125322,6 +125319,11 @@ const playdashLighthouseConfig = {
     ciBuildId: process.env.NEETO_CI_JOB_ID,
     tags: process.env.TAG,
 };
+const playdashProductionHealthConfig = {
+    apiKey: process.env.PLAYDASH_PRODUCTION_HEALTH_API_KEY,
+    ciBuildId: process.env.NEETO_CI_JOB_ID,
+    tags: process.env.TAG,
+};
 const isCI = isPresent(process.env.NEETO_CI_JOB_ID);
 const railsPort = process.env.RAILS_SERVER_PORT;
 const vitePort = process.env.VITE_PORT;
@@ -125331,9 +125333,10 @@ const PROJECT_NAMES = {
     webkit: "webkit",
     lighthouseAudits: "lighthouse-audits",
     cleanupCredentials: "cleanup credentials",
+    productionHealth: "production-health",
 };
 const definePlaywrightConfig = (overrides) => {
-    const { globalOverrides = {}, useOverrides = {}, useCustomProjects = false, projectOverrides = [], playdashStagingOverrides = {}, playdashProductionOverrides = {}, playdashLighthouseOverrides = {}, webServerOverrides = [], projectLaunchOptionsOverrides = {}, } = overrides;
+    const { globalOverrides = {}, useOverrides = {}, useCustomProjects = false, projectOverrides = [], playdashProductionHealthOverrides = {}, playdashStagingOverrides = {}, playdashProductionOverrides = {}, playdashLighthouseOverrides = {}, webServerOverrides = [], projectLaunchOptionsOverrides = {}, } = overrides;
     const getProjectLaunchOptions = (projectName, defaultLaunchOptions) => {
         const overrides = projectLaunchOptionsOverrides[projectName];
         if (!overrides)
@@ -125352,29 +125355,31 @@ const definePlaywrightConfig = (overrides) => {
     let reporter = !isEmpty(playdashStagingOverrides)
         ? [
             [
-                "@bigbinary/neeto-playwright-reporter",
-                {
-                    ...playdashStagingConfig,
-                    ...playdashStagingOverrides,
-                },
+                reporterPackageName,
+                { ...playdashStagingConfig, ...playdashStagingOverrides },
             ],
         ]
         : [
             [
-                "@bigbinary/neeto-playwright-reporter",
-                {
-                    ...playdashProductionConfig,
-                    ...playdashProductionOverrides,
-                },
+                reporterPackageName,
+                { ...playdashProductionConfig, ...playdashProductionOverrides },
             ],
         ];
     if (process.env.IS_LIGHTHOUSE_REPORT) {
         reporter = [
             [
-                "@bigbinary/neeto-playwright-reporter",
+                reporterPackageName,
+                { ...playdashLighthouseConfig, ...playdashLighthouseOverrides },
+            ],
+        ];
+    }
+    if (process.env.TAG?.includes("production")) {
+        reporter = [
+            [
+                reporterPackageName,
                 {
-                    ...playdashLighthouseConfig,
-                    ...playdashLighthouseOverrides,
+                    ...playdashProductionHealthConfig,
+                    ...playdashProductionHealthOverrides,
                 },
             ],
         ];
@@ -125477,13 +125482,14 @@ const definePlaywrightConfig = (overrides) => {
                         }),
                     },
                     {
-                        name: "production-health",
+                        name: PROJECT_NAMES.productionHealth,
                         testDir: "./e2e/health",
                         testMatch: "production.health.ts",
                         use: {
                             ...devices["Desktop Chrome"],
                             baseURL: process.env.PLAYWRIGHT_PRODUCTION_BASE_URL,
-                            storageState: { cookies: [], origins: [] },
+                            screenshot: "on",
+                            trace: "on",
                         },
                     },
                     ...projectOverrides,