Run full E2E test suite on PRs

.env

@@ -115,8 +115,8 @@ E2E_TEST_ACCOUNT_EMAIL_ZERO_BROKERS=
 E2E_TEST_ACCOUNT_EMAIL_ZERO_BREACHES_ZERO_BROKERS=
 E2E_TEST_ACCOUNT_EMAIL_EXPOSURES_STARTED=
 
-E2E_TEST_PAYPAL_LOGIN =
-E2E_TEST_PAYPAL_PASSWORD =
+E2E_TEST_PAYPAL_LOGIN=
+E2E_TEST_PAYPAL_PASSWORD=
 
 # Monitor Premium features
 # Link to start user on the subscription process. PREMIUM_ENABLED must be set to `true`.

.github/workflows/e2e_pr_full.yml

@@ -0,0 +1,99 @@
+name: Monitor E2E Test Suite (full)
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  e2e-tests:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    # Service containers to run with `container-job`
+    services:
+      # Label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: blurts
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+        - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.9.x
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Setting up postgres
+        run: npm run db:migrate
+        env:
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/blurts
+      - name: Store Playwright's Version
+        run: |
+          # Get the current Playwright version listed in package.json
+          PLAYWRIGHT_VERSION=$(npx playwright --version | sed 's/Version //')
+          echo "Playwright Version: $PLAYWRIGHT_VERSION"
+          echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
+      - name: Cache Playwright Browsers for Playwright's Version
+        id: cache-playwright-browsers
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/ms-playwright
+          key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}
+
+      - name: Setup Playwright Browser
+        if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
+        run: npx playwright install --with-deps
+
+      - name: Run Playwright tests
+        if: github.actor != 'dependabot[bot]'
+        run: npm run e2e -- --update-snapshots
+        timeout-minutes: 40
+        env:
+          E2E_TEST_ENV: local
+          E2E_TEST_BASE_URL: http://localhost:6060
+          E2E_TEST_ACCOUNT_EMAIL: ${{ secrets.E2E_TEST_ACCOUNT_EMAIL }}
+          E2E_TEST_ACCOUNT_EMAIL_ZERO_BREACHES: ${{ secrets.E2E_TEST_ACCOUNT_EMAIL_ZERO_BREACHES }}
+          E2E_TEST_ACCOUNT_EMAIL_EXPOSURES_STARTED: ${{ secrets.E2E_TEST_ACCOUNT_EMAIL_EXPOSURES_STARTED }}
+          E2E_TEST_ACCOUNT_PASSWORD: ${{ secrets.E2E_TEST_ACCOUNT_PASSWORD }}
+          E2E_TEST_PAYPAL_LOGIN: ${{ secrets.E2E_TEST_PAYPAL_LOGIN }}
+          E2E_TEST_PAYPAL_PASSWORD: ${{ secrets.E2E_TEST_PAYPAL_PASSWORD }}
+          ADMINS: ${{ secrets.ADMINS }}
+          OAUTH_CLIENT_SECRET: ${{ secrets.OAUTH_CLIENT_SECRET_LOCAL }}
+          OAUTH_ACCOUNT_URI: ${{ secrets.OAUTH_ACCOUNT_URI }}
+          ONEREP_API_KEY: ${{ secrets.ONEREP_API_KEY }}
+          NEXTAUTH_SECRET: ${{ secrets.NEXTAUTH_SECRET }}
+          NEXTAUTH_URL: ${{ secrets.NEXTAUTH_URL }}
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432/blurts
+          HIBP_KANON_API_TOKEN: ${{ secrets.HIBP_KANON_API_TOKEN }}
+          HIBP_API_TOKEN: ${{ secrets.HIBP_API_TOKEN }}
+          HIBP_KANON_API_ROOT: "http://localhost:6060/api/mock/hibp"
+          ONEREP_API_BASE: "http://localhost:6060/api/mock/onerep/"
+          PREMIUM_PRODUCT_ID: ${{ secrets.STAGE_PREMIUM_PRODUCT_ID }}
+          PREMIUM_PLAN_ID_MONTHLY_US: ${{ secrets.STAGE_PREMIUM_PLAN_ID_MONTHLY_US }}
+          PREMIUM_PLAN_ID_YEARLY_US: ${{ secrets.STAGE_PREMIUM_PLAN_ID_YEARLY_US }}
+          REDIS_URL: "redis://redis.mock"
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results
+          path: src/e2e/test-results/
+          retention-days: 30

.github/workflows/e2e_pr.yml → .github/workflows/e2e_pr_smoke.yml

@@ -1,4 +1,4 @@
-name: Monitor e2e Smoke Tests
+name: Monitor E2E Test Suite (smoke)
 on:
   push:
     branches: [ main ]
@@ -46,7 +46,6 @@ jobs:
           PLAYWRIGHT_VERSION=$(npx playwright --version | sed 's/Version //')
           echo "Playwright Version: $PLAYWRIGHT_VERSION"
           echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
-
       - name: Cache Playwright Browsers for Playwright's Version
         id: cache-playwright-browsers
         uses: actions/cache@v4
@@ -69,7 +68,7 @@ jobs:
           E2E_TEST_ACCOUNT_EMAIL_ZERO_BREACHES: ${{ secrets.E2E_TEST_ACCOUNT_EMAIL_ZERO_BREACHES }}
           E2E_TEST_ACCOUNT_EMAIL_EXPOSURES_STARTED: ${{ secrets.E2E_TEST_ACCOUNT_EMAIL_EXPOSURES_STARTED }}
           E2E_TEST_ACCOUNT_PASSWORD: ${{ secrets.E2E_TEST_ACCOUNT_PASSWORD }}
-          E2E_TEST_PAYPAL_LOGIN:  ${{ secrets.E2E_TEST_PAYPAL_LOGIN }}
+          E2E_TEST_PAYPAL_LOGIN: ${{ secrets.E2E_TEST_PAYPAL_LOGIN }}
           E2E_TEST_PAYPAL_PASSWORD: ${{ secrets.E2E_TEST_PAYPAL_PASSWORD }}
           ADMINS: ${{ secrets.ADMINS }}
           OAUTH_CLIENT_SECRET: ${{ secrets.OAUTH_CLIENT_SECRET_LOCAL }}
@@ -82,9 +81,6 @@ jobs:
           HIBP_API_TOKEN: ${{ secrets.HIBP_API_TOKEN }}
           HIBP_KANON_API_ROOT: "http://localhost:6060/api/mock/hibp"
           ONEREP_API_BASE: "http://localhost:6060/api/mock/onerep/"
-          # MNTOR-3516: Our tests are currently set up to expect accounts to act like
-          # old user accounts, so let's pretend they all are:
-          BROKER_SCAN_RELEASE_DATE: "3000-12-31"
           REDIS_URL: "redis://redis.mock"
       - uses: actions/upload-artifact@v4
         if: always()

playwright.config.js

@@ -50,11 +50,14 @@ export default defineConfig({
   /* Fail the build on CI if you accidentally left test.only in the source code. */
   forbidOnly: !!process.env.CI,
 
+  /* Limit the number of failures */
+  maxFailures: 1,
+
   /* Retry on CI only */
   retries: process.env.CI ? 1 : 0,
 
-  /* Opt out of parallel tests on CI. */
-  workers: process.env.CI ? 1 : undefined,
+  /* Use a custom percentage of available wokers in CI and use default locally. */
+  workers: process.env.CI ? "75%" : undefined,
 
   /* Reporter to use. See https://playwright.dev/docs/test-reporters */
   reporter: process.env.CI ? [['github'], ['html']] : 'html',
@@ -65,8 +68,7 @@ export default defineConfig({
     actionTimeout: 0,
 
     /* Base URL to use in actions like `await page.goto('/')`. */
-    baseURL: process.env.E2E_TEST_BASE_URL ?? 'https://stage.firefoxmonitor.nonprod.cloudops.mozgcp.net',
-    // baseURL: 'http://localhost:6060',
+    baseURL: process.env.E2E_TEST_BASE_URL,
 
     /* automatically take screenshot only on failures */
     screenshot: 'only-on-failure',

src/app/functions/server/isPrePlusUser.ts

@@ -4,7 +4,7 @@
 
 import "server-only";
 import { Session } from "next-auth";
-import { parseIso8601Datetime } from "../../../utils/parse";
+import { isPrePlusDate } from "../universal/isPrePlusDate";
 
 /**
  * Determine whether the user's account predates Monitor Plus
@@ -20,22 +20,8 @@ export function isPrePlusUser(user: Session["user"]): boolean {
     return false;
   }
 
-  const brokerScanReleaseDateParts = (
-    process.env.BROKER_SCAN_RELEASE_DATE ?? ""
-  ).split("-");
-  if (brokerScanReleaseDateParts[0] === "") {
-    brokerScanReleaseDateParts[0] = "2023";
-  }
-  const brokerScanReleaseDate = new Date(
-    Date.UTC(
-      Number.parseInt(brokerScanReleaseDateParts[0], 10),
-      Number.parseInt(brokerScanReleaseDateParts[1] ?? "12", 10) - 1,
-      Number.parseInt(brokerScanReleaseDateParts[2] ?? "05", 10),
-    ),
-  );
-
-  return (
-    (parseIso8601Datetime(user.subscriber.created_at)?.getTime() ?? 0) <
-    brokerScanReleaseDate.getTime()
+  return isPrePlusDate(
+    process.env.BROKER_SCAN_RELEASE_DATE ?? "",
+    user.subscriber.created_at,
   );
 }

src/app/functions/universal/isPrePlusDate.ts

@@ -0,0 +1,27 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+import { parseIso8601Datetime } from "../../../utils/parse";
+
+export function isPrePlusDate(
+  plusReleaseDateString: string,
+  dateStringToCompare: string,
+) {
+  const brokerScanReleaseDateParts = plusReleaseDateString.split("-");
+  if (brokerScanReleaseDateParts[0] === "") {
+    brokerScanReleaseDateParts[0] = "2023";
+  }
+  const brokerScanReleaseDate = new Date(
+    Date.UTC(
+      Number.parseInt(brokerScanReleaseDateParts[0], 10),
+      Number.parseInt(brokerScanReleaseDateParts[1] ?? "12", 10) - 1,
+      Number.parseInt(brokerScanReleaseDateParts[2] ?? "05", 10),
+    ),
+  );
+
+  return (
+    (parseIso8601Datetime(dateStringToCompare)?.getTime() ?? 0) <
+    brokerScanReleaseDate.getTime()
+  );
+}

src/e2e/pages/purchasePage.ts

@@ -124,7 +124,7 @@ export class PurchasePage {
       (await this.planDetails.textContent()) as string,
     );
     expect(planDetails).toContain(
-      `${process.env.E2E_TEST_ENV === "prod" ? "yearly" : "every 2 months"}`,
+      `${process.env.E2E_TEST_ENV !== "production" ? "every 2 months" : "yearly"}`,
     );
   }
 

src/e2e/pages/welcomeScanPage.ts

@@ -28,6 +28,8 @@ export class WelcomePage {
   readonly modalConfirmButton: Locator;
   readonly modalEditButton: Locator;
 
+  readonly findExposuresTitle: Locator;
+
   constructor(page: Page) {
     this.page = page;
 
@@ -67,9 +69,11 @@ export class WelcomePage {
     this.isThisCorrectModal = page.getByLabel("Is this correct?");
     this.modalConfirmButton = page.getByRole("button", { name: "Confirm" });
     this.modalEditButton = page.getByRole("button", { name: "Edit" });
+
+    this.findExposuresTitle = page.getByText("Scanning for exposures…");
   }
 
-  async goThroughFirstScan() {
+  async goThroughFirstScan(options: { skipLoader: boolean }) {
     // confirm get started step elements
     expect(await this.getStartedStep.count()).toEqual(3);
     await expect(this.page.getByText("Get started")).toBeVisible();
@@ -88,6 +92,15 @@ export class WelcomePage {
     await this.findExposuresButton.click();
 
     await this.modalConfirmButton.click();
+    await this.findExposuresTitle.waitFor();
+
+    // reloading page skips the loader and routes directly to the dashboard
+    if (options.skipLoader) {
+      // wait for scan to be finished before reloading the page
+      await this.page.waitForTimeout(10000);
+      await this.page.reload();
+    }
+
     // Waiting for scan to complete
     const dashboardPage = new DashboardPage(this.page);
     await dashboardPage.actionNeededTab.waitFor();

src/e2e/specs/auth.spec.ts

@@ -2,6 +2,7 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
+import { isPrePlusDate } from "../../app/functions/universal/isPrePlusDate.js";
 import { test, expect } from "../fixtures/basePage.js";
 
 test.describe(`${process.env.E2E_TEST_ENV} - Authentication flow verification @smoke`, () => {
@@ -14,7 +15,7 @@ test.describe(`${process.env.E2E_TEST_ENV} - Authentication flow verification @s
     authPage,
     landingPage,
   }, testInfo) => {
-    // speed up test by ignore non necessary requests
+    // speed up test by ignoring non-necessary requests
     await page.route(/(analytics)/, async (route) => {
       await route.abort();
     });
@@ -23,15 +24,20 @@ test.describe(`${process.env.E2E_TEST_ENV} - Authentication flow verification @s
     await landingPage.goToSignIn();
 
     // Fill out sign up form
-    const randomEmail = `${Date.now()}[email protected]`;
+    const currentTimestamp = Date.now();
+    const randomEmail = `${currentTimestamp}[email protected]`;
     await authPage.signUp(randomEmail, page);
 
     // assert successful login
-    const successUrl =
-      process.env.E2E_TEST_ENV === "local"
-        ? "/user/dashboard"
-        : "/user/welcome";
-    expect(page.url()).toBe(`${process.env.E2E_TEST_BASE_URL}${successUrl}`);
+    const successUrlSlugs = isPrePlusDate(
+      process.env.BROKER_SCAN_RELEASE_DATE ?? "",
+      new Date(currentTimestamp).toUTCString(),
+    )
+      ? "/user/dashboard"
+      : "/user/welcome";
+    expect(page.url()).toBe(
+      `${process.env.E2E_TEST_BASE_URL}${successUrlSlugs}`,
+    );
 
     await testInfo.attach(
       `${process.env.E2E_TEST_ENV}-signup-monitor-dashboard.png`,

src/e2e/specs/breachResolution.spec.ts

@@ -3,10 +3,30 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
 import { test, expect } from "../fixtures/basePage.js";
+import { checkAuthState } from "../utils/helpers.js";
 
 // bypass login
 test.use({ storageState: "./e2e/storageState.json" });
 test.describe(`${process.env.E2E_TEST_ENV} - Breaches Dashboard - Headers`, () => {
+  test.beforeEach(async ({ dashboardPage, welcomePage, page }) => {
+    await dashboardPage.open();
+
+    try {
+      await checkAuthState(page);
+    } catch {
+      console.log("[E2E_LOG] - No fxa auth required, proceeding...");
+    }
+
+    // if we landed on the welcome flow a new user who is eligible for premium
+    // and needs to go through their first scan
+    const isWelcomeFlow =
+      page.url() === `${process.env.E2E_TEST_BASE_URL}/user/welcome`;
+    if (isWelcomeFlow) {
+      expect(page.url()).toContain("/user/welcome");
+      await welcomePage.goThroughFirstScan({ skipLoader: true });
+    }
+  });
+
   test("Verify that the site header is displayed correctly for signed in users", async ({
     dataBreachPage,
   }) => {
@@ -89,9 +109,6 @@ test.describe(`${process.env.E2E_TEST_ENV} - Breaches Dashboard - Headers`, () =
         "https://testrail.stage.mozaws.net/index.php?/cases/view/2095103",
     });
 
-    // open dashboard page
-    await dashboardPage.open();
-
     // get expected links
     const links = dashboardPage.dashboardLinks();