test(e2e): add Workplace App settings coverage (215 settings, 445 scenarios)

.github/workflows/e2e-advisory.yml

@@ -82,6 +82,11 @@ concurrency:
 permissions:
     contents: read
 
+# Which Playwright projects run on which trigger:
+#   push, schedule, workflow_dispatch   `local` and `mock` (job `workplace`)
+#   schedule, workflow_dispatch         also `settings` (job `workplace`, own step)
+#   push, schedule, workflow_dispatch   `settings-browser` (job `settings-browser`,
+#                                       GitHub-hosted, no stack)
 jobs:
     workplace:
         # The job name is what appears in the commit's Checks list, next to the
@@ -93,16 +98,21 @@ jobs:
         # To fall back to GitHub-hosted, set `runs-on: ubuntu-latest` and restore
         # the `Raise vm.max_map_count` step (see below).
         runs-on: [self-hosted, placeos-e2e]
-        # Includes up to 120 minutes waiting for the native e2e job (see "Wait for
-        # the native e2e job to finish").
-        timeout-minutes: 165
+        # 120 minutes waiting for the native e2e job (see "Wait for the native e2e
+        # job to finish"), 45 for setup, the stack and the `local` and `mock`
+        # tests, and 60 for the `settings` step's own timeout on scheduled and
+        # manual runs.
+        timeout-minutes: 225
         env:
             E2E_BACKEND_URL: https://localhost:9443
             # The runner is a 12-core, 16 GB Mac that also hosts the stack's
             # containers, the Angular dev server and the browsers. Seeding reads
             # this too (one staff user, desk and room set per worker), so it must
-            # be the same here as in the test step.
-            E2E_WORKERS: '4'
+            # be the same here as in the test step. Six workers became faster
+            # than four once the specs paused the animated page background
+            # (e2e/support/background.ts); before that the browsers used all
+            # the CPU.
+            E2E_WORKERS: '6'
             TZ: 'Etc/UTC'
         steps:
             # persist-credentials: false — checkout otherwise leaves the token in
@@ -151,6 +161,8 @@ jobs:
             - name: Reclaim the machine from any previous run
               run: |
                   e2e/stack/down.sh --volumes || true
+                  # The `settings` step's reports, which a push run does not rewrite.
+                  rm -rf reports/e2e/workplace-settings reports/e2e/workplace-settings-results.json
                   # Playwright refuses to start its webServer if 4214 is held.
                   lsof -nP -iTCP:4214 -sTCP:LISTEN -t 2>/dev/null | xargs -r kill -9 || true
                   # Images the previous run's pull replaced. A running stack's images
@@ -260,11 +272,37 @@ jobs:
                   } >> "$GITHUB_STEP_SUMMARY"
 
             - name: Run workplace e2e
-              run: bunx playwright test --config apps/workplace/playwright.config.ts
+              id: local
+              run: bunx playwright test --config apps/workplace/playwright.config.ts --project=local --project=mock
+
+            # The Workplace settings suite: about 400 tests, about 12 minutes on
+            # this machine with six workers. Scheduled and manual runs only. It
+            # also runs after a failed `local` step, but not when that step was
+            # skipped (the stack never came up).
+            #
+            # The PLAYWRIGHT_* variables and --output move this run's reports and
+            # test artifacts away from the `local` run's, which Playwright would
+            # otherwise overwrite.
+            - name: Run workplace settings e2e
+              id: settings
+              if: ${{ !cancelled() && steps.local.outcome != 'skipped' && (github.event_name == 'schedule' || github.event_name == 'workflow_dispatch') }}
+              timeout-minutes: 60
+              env:
+                  PLAYWRIGHT_HTML_OUTPUT_DIR: reports/e2e/workplace-settings
+                  PLAYWRIGHT_JSON_OUTPUT_FILE: reports/e2e/workplace-settings-results.json
+              run: >-
+                  bunx playwright test --config apps/workplace/playwright.config.ts
+                  --project=settings --output=dist/.playwright/workplace-settings
 
             - name: Summarise results
               if: ${{ always() }}
-              run: node e2e/stack/ci-summary.mjs >> "$GITHUB_STEP_SUMMARY"
+              env:
+                  SETTINGS_OUTCOME: ${{ steps.settings.outcome }}
+              run: |
+                  node e2e/stack/ci-summary.mjs >> "$GITHUB_STEP_SUMMARY"
+                  if [ "$SETTINGS_OUTCOME" != skipped ]; then
+                      node e2e/stack/ci-summary.mjs reports/e2e/workplace-settings-results.json 'workplace settings e2e' >> "$GITHUB_STEP_SUMMARY"
+                  fi
 
             # Collect EVERY service, not a hand-picked list. The first run failed
             # in Elasticsearch — which was not on the list — so the log that
@@ -289,6 +327,8 @@ jobs:
                   path: |
                       reports/e2e/workplace
                       reports/e2e/workplace-results.json
+                      reports/e2e/workplace-settings
+                      reports/e2e/workplace-settings-results.json
                   retention-days: 14
                   if-no-files-found: warn
 
@@ -359,3 +399,95 @@ jobs:
                            --header 'Content-Type: application/json' \
                            --data @- \
                            "$STATUS_URL"
+
+    # The settings specs that answer every request in the browser. They need the
+    # Workplace dev server but no PlaceOS stack, so this job runs on a
+    # GitHub-hosted runner beside the self-hosted one.
+    settings-browser:
+        name: 'workplace settings e2e, browser only (advisory, does not block builds)'
+        # The pinned Playwright has no Chromium build for ubuntu-latest (26.04).
+        runs-on: ubuntu-24.04
+        timeout-minutes: 30
+        env:
+            TZ: 'Etc/UTC'
+            # The config's webServer timeout, in ms: how long Playwright waits
+            # for `nx serve workplace` to answer.
+            E2E_WEBSERVER_TIMEOUT_MS: '900000'
+        steps:
+            - uses: actions/checkout@v6
+              with:
+                  persist-credentials: false
+
+            # Same bun version as the `workplace` job, build.yml and pull-request.yml.
+            - name: Setup Bun
+              uses: oven-sh/setup-bun@v2
+              with:
+                  bun-version: '1.4.3'
+
+            - name: Install dependencies
+              run: bun install --frozen-lockfile
+
+            - name: Setup version
+              run: bun run postinstall
+
+            - name: Install Playwright browser
+              run: bunx playwright install --with-deps chromium
+
+            # Playwright starts the Workplace dev server itself (the config's
+            # webServer). Its API proxy points at a backend that does not exist
+            # here; the specs answer those requests in the browser.
+            - name: Run workplace settings e2e (browser only)
+              run: bunx playwright test --config apps/workplace/playwright.config.ts --project=settings-browser
+
+            - name: Summarise results
+              if: ${{ always() }}
+              run: node e2e/stack/ci-summary.mjs reports/e2e/workplace-results.json 'workplace settings e2e, browser only' >> "$GITHUB_STEP_SUMMARY"
+
+            - name: Upload Playwright report
+              if: ${{ always() }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: playwright-report-workplace-settings-browser
+                  path: |
+                      reports/e2e/workplace
+                      reports/e2e/workplace-results.json
+                  retention-days: 14
+                  if-no-files-found: warn
+
+            - name: Upload failure artifacts
+              if: ${{ failure() }}
+              uses: actions/upload-artifact@v4
+              with:
+                  name: playwright-failures-workplace-settings-browser
+                  path: dist/.playwright
+                  retention-days: 14
+                  if-no-files-found: warn
+
+            # The same notification as the `workplace` job's "Notify on failure".
+            - name: Notify on failure
+              if: ${{ failure() }}
+              continue-on-error: true
+              env:
+                  STATUS_URL: ${{ secrets.STATUS_URL }}
+                  CHAT_URL: ${{ secrets.CHAT_URL }}
+                  REPO: ${{ github.repository }}
+                  COMMIT: ${{ github.sha }}
+                  BRANCH: ${{ github.ref_name }}
+                  RUN_ID: ${{ github.run_id }}
+              run: |
+                  node -e '
+                      process.stdout.write(JSON.stringify({
+                          chat_url: process.env.CHAT_URL,
+                          name: process.env.REPO,
+                          commit: process.env.COMMIT,
+                          branch: process.env.BRANCH,
+                          url: `https://github.com/${process.env.REPO}/actions/runs/${process.env.RUN_ID}`,
+                          pipeline_name: "e2e settings-browser (advisory): FAILED",
+                          status: "failure",
+                      }));
+                  ' \
+                    | curl --silent --show-error --fail \
+                           --max-time 30 \
+                           --header 'Content-Type: application/json' \
+                           --data @- \
+                           "$STATUS_URL"

E2E_USER_STORIES.md

@@ -163,7 +163,7 @@ was built in. Extending there is a separate piece of work, not an oversight.
 | VIS-17 | P1 | Declining that confirmation leaves the invite alone. | **done** — `local/visitor-cancel.spec.ts`. A dialog whose decline button also deletes is worse than one that fails to delete, and only this catches it. |
 | VIS-18 | P1 | An address that is not an email is refused **before anything is sent**. | **done** — `local/visitor-validation.spec.ts`. Asserts on the network, not on a message: the backend stores whatever it is given, so the form is the only guard. Includes a control that a valid address does send. |
 | VIS-19 | P2 | A visitor taken off the list before sending is not invited, and the rest still are. | **done** — `local/visitor-validation.spec.ts` |
-| VIS-20 | P2 | A pass number and the international-visitor flag are stored with the invite. | **partial** — `local/visitor-details.spec.ts`. The pass number is stored. The international flag is `test.fixme`: with `visitors.allow_international` on, the new invite flow has no control for it and sends `international: false`. |
+| VIS-20 | P2 | A pass number and the international-visitor flag are stored with the invite. | **done**: `local/visitor-details.spec.ts`. With `visitors.allow_international` on, the invite flow shows an international checkbox for a named visitor, and the tick is stored as `extension_data.international`. |
 | VIS-21 | P2 | The company is stored, and the separate guest record carries the visitor's name. | **done** — `local/visitor-details.spec.ts`. The guest record is what reception reads and it outlives the booking. |
 | VIS-22 | P1 | The start time and length chosen on the form are the ones stored. | **done** — `local/visitor-times.spec.ts`. Everything else here takes the default hour, so a form that ignored the picker would have passed the whole suite. |
 | VIS-23 | P2 | A maximum visit length and bookable hours limit what the form offers. | **done** — `local/visitor-times.spec.ts`. Asserts on the options offered, because an out-of-range choice is absent rather than refused. Red-checked: without the settings the form offers 240 minutes against a 60 minute cap. |
@@ -287,8 +287,8 @@ PR #561 changed the components that these routes open:
   assertions. `desk-flow.page.ts`, `meeting-flow.page.ts`, `invite-form.page.ts`,
   `landing-new.page.ts` and `your-bookings.page.ts` are the page objects of the new views. The
   page objects of the replaced views are deleted.
-- **Four stories are blocked by the new views** and are `test.fixme`. They are in the table
-  "Blocked by the new views" below.
+- **Four stories were blocked by the new views** and were `test.fixme`. The ones still blocked
+  are in the table "Blocked by the new views" below.
 - **Six rows that were blocked on the replaced flows now pass**: ROOM-11, ROOM-13, ROOM-14,
   ROOM-21, ROOM-22 and VIS-15.
 - **After the move, a full local run of 161 tests has 154 passes, 7 `fixme` and no failure**
@@ -358,12 +358,11 @@ of WP-E2E-05, and its two checks of the success view are now in that test.
 
 ### Blocked by the new views
 
-Each of these is `test.fixme` with the measurement in its comment. The first two passed on the
-views before PR #561.
+Each of these is `test.fixme` with the measurement in its comment. The first passed on the views
+before PR #561.
 
 | ID | Story | What blocks it |
 |----|-------|----------------|
-| VIS-20 (half) | The international-visitor flag is stored with the invite. | With `visitors.allow_international` on, the new invite flow has no control for the flag and sends `international: false`. |
 | ROOM-28 | A meeting booked for a colleague is stored with that colleague as the host. | The new meeting flow cannot name a colleague on this stack. `events.can_book_for_anyone` renders no host field. `events.can_book_for_others` renders a select that is filled from `GET /calendars`, which answers `500` without a calendar tenant, so the select holds only the signed-in user. |
 | NEW-DESK-03 | A desk can be selected when another desk of the building has no `features` list. | `desk-flow-select.component.ts` calls `.trim()` on the features of every desk with no guard. One desk without the list throws `TypeError: Cannot read properties of undefined (reading 'trim')`, and after that no row of the list shows as selected. The earlier flow read the list through `BookingFormService.features`, which has the guard. |
 
@@ -518,8 +517,8 @@ nothing, so the broker keeps its last value. source would need redis keyspace no
   or through `use_bookings`?** Nobody has answered it. If the answer is "the calendar", the
   green rows in §1b guard a path those customers never take. This needs a product answer, not more
   specs.
-- **Five rows are blocked on product fixes, not on test effort** (REG-08, REG-09, the
-  international half of VIS-20, ROOM-28 and NEW-DESK-03). The last three are gaps or faults of
+- **Four rows are blocked on product fixes, not on test effort** (REG-08, REG-09, ROOM-28 and
+  NEW-DESK-03). The last two are gaps or faults of
   the views that PR #561 made the default; §1c has them. All were found by this suite. Leaving
   them visible here is the point — a blocked row is coverage information, a deleted row is not.
 - **One row is blocked by the environment rather than by a bug** (AUTH-E2E-08), and it says

apps/workplace/e2e/fixtures.ts

@@ -1,4 +1,5 @@
 import { test as base, expect } from '@playwright/test';
+import { pauseBackground } from '../../../e2e/support/background';
 
 /**
  * Shared Playwright fixtures for the Workplace e2e suite.
@@ -16,8 +17,14 @@ import { test as base, expect } from '@playwright/test';
  * Setting localStorage via `addInitScript` (before any app script runs) is
  * therefore required for the app to be functional offline in tests. This
  * fixture applies it to every test/page automatically.
+ *
+ * The context also pauses the animated page background (see background.ts).
  */
 export const test = base.extend({
+    context: async ({ context }, use) => {
+        await pauseBackground(context);
+        await use(context);
+    },
     page: async ({ page }, use) => {
         await page.addInitScript(() =>
             window.localStorage.setItem('mock', 'true'),

apps/workplace/e2e/local/bookings-empty.spec.ts

@@ -20,6 +20,7 @@ import { type BrowserContext } from '@playwright/test';
 import { apiFor, currentUser, ENGINE_API } from '../../../../e2e/support/api';
 import { calendarBacked } from '../../../../e2e/support/calendar/calendar.api';
 import { buildStorageState, mintToken } from '../../../../e2e/support/auth';
+import { pauseBackground } from '../../../../e2e/support/background';
 import { APP_URL, BACKEND_URL } from '../../../../e2e/support/env';
 import { test as base, expect } from '../../../../e2e/support/fixtures';
 import { SCHEDULE_DAYS, slotOn } from '../../../../e2e/support/bookings/bookings.env';
@@ -60,6 +61,7 @@ const test = base.extend({
             context = await browser.newContext({
                 storageState: buildStorageState(token, APP_URL),
             });
+            await pauseBackground(context);
             await use(await context.newPage());
         } finally {
             testInfo.setTimeout(testInfo.timeout + 30_000);

apps/workplace/e2e/local/bookings-limit.spec.ts

@@ -16,6 +16,7 @@ import {
     uniqueTitle,
 } from '../../../../e2e/support/api';
 import { buildStorageState, mintToken } from '../../../../e2e/support/auth';
+import { pauseBackground } from '../../../../e2e/support/background';
 import {
     createBookingViaApi,
     releaseFor,
@@ -84,6 +85,7 @@ test.describe('your bookings — high cancelled history', () => {
             context = await browser.newContext({
                 storageState: buildStorageState(token, APP_URL),
             });
+            await pauseBackground(context);
             const page = await context.newPage();
             page.on('response', async (response) => {
                 if (!response.url().includes(`${STAFF_API}/bookings`)) return;

apps/workplace/e2e/local/visitor-delegate.spec.ts

@@ -38,6 +38,7 @@ import {
     listBookings,
     uniqueTitle,
 } from '../../../../e2e/support/api';
+import { pauseBackground } from '../../../../e2e/support/background';
 import { WORKERS, roleFor, staffEmail } from '../../../../e2e/support/env';
 import { VISITOR_SLOTS, visitorFor } from '../../../../e2e/support/visitor/visitor.env';
 import { deleteGuest, releaseVisitor } from '../../../../e2e/support/visitor/visitor.api';
@@ -176,6 +177,7 @@ test.describe('visitor invite on behalf of another host', () => {
                 storageState: host.role.storagePath,
                 ignoreHTTPSErrors: true,
             });
+            await pauseBackground(host_ctx);
             const host_page = await host_ctx.newPage();
             try {
                 const theirs = new YourBookingsPage(host_page);

apps/workplace/e2e/local/visitor-details.spec.ts

@@ -17,12 +17,11 @@
  * The pass number is behind `visitors.allow_pass_number`, off by default — the
  * classic "only breaks for the customers who switched it on" shape.
  *
- * ## Three tests, and one of them is `fixme`
+ * ## Three tests
  *
  * The pass number and the international tick were one test (VIS-20) while the
- * old form had both controls. The `visitor-flow-new` page has no control for
- * the tick, so the two are split: the pass number stays covered, and the tick
- * waits as `fixme`. See the note on that test.
+ * old form had both controls. They were split when the `visitor-flow-new` page
+ * lacked the tick; the page has it again, so each is now its own test.
  */
 import { test, expect } from '../../../../e2e/support/fixtures';
 import { deleteBooking, getBooking, uniqueTitle } from '../../../../e2e/support/api';
@@ -85,19 +84,12 @@ test.describe('visitor invite details', () => {
     });
 
     /**
-     * The other half of VIS-20. `fixme`, because the `visitor-flow-new` page
-     * has no control for the international tick.
-     *
-     * Measured with `visitors.allow_international` on: the page renders no
-     * `input[name$=".international"]` (count 0), and the invite it sends has
-     * `extension_data.international: false`. No file under `visitor-flow-new`
-     * reads the setting. The old form (`invite-visitor-form`) rendered the
-     * checkbox, but `/book/visitor` no longer opens that form.
-     *
-     * Written as it should pass once the page has the control. It fails today
-     * at `setCheckbox`, with "the checkbox is not on the page".
+     * The other half of VIS-20. With `visitors.allow_international` on,
+     * `visitor-flow-invites` shows a per-visitor international checkbox once a
+     * visitor is named; in single mode it is bound to the form's
+     * `international` field, so it renders as `input[name$=".international"]`.
      */
-    test.fixme('the international flag is stored with the invite', async ({
+    test('the international flag is stored with the invite', async ({
         staffPage,
         staffApi,
     }, testInfo) => {