Files
SRCmail/playwright.integration.config.ts
T
Bernd Rodler 0f15132ec0 test(electron): real end-to-end push -> native notification, via SMTP
Phase 1 step 7 of VNCprodbuild. integration/tests/11-electron-notification.spec.ts
launches the actual Electron shell, logs in as alice against this repo's
existing docker-compose Stalwart fixture, injects a message over real SMTP
(same helpers/smtp.ts sendMail() 02-mail-sync.spec.ts uses), and asserts a
native notification fires via electron/main.ts's __notificationCallCount
test hook - proving the full real pipeline, not just the synthetic IPC call
step 3's smoke test exercises: SMTP -> Stalwart -> JMAP push
(lib/jmap/client.ts) -> stores/email-store.ts's handleStateChange ->
handleNewEmailNotification -> the page effect -> lib/electron-bridge.ts ->
the contextBridge/IPC bridge -> electron/main.ts's Notification call.

Runs against a `next dev` server (electron/main.ts's new ELECTRON_LOAD_URL
escape hatch), not the standalone build, because this fixture's Stalwart is
deliberately plain HTTP and production's CSP correctly refuses non-TLS
connections - the identical trade-off integration/webmail.Dockerfile already
makes for the browser-based suite. New playwright.integration-electron.config.ts
+ global-setup-electron.ts (brings up only the `stalwart` compose service,
not `webmail`, which this suite never touches and which may not even be
startable on a given host - see its own header comment) keep this fully
separate from the main dockerized integration run, which has no Electron
binary compatible with that container's platform; playwright.integration.config.ts
gets a matching testIgnore so a plain `npm run test:integration` never tries
to sweep this file in. Wired as `npm run test:integration:electron`.

On "the real WebSocket path": confirmed against this fixture's actual
`stalwartlabs/stalwart:v0.16` (same as the sandbox server) that its
/jmap/ws requires the same Authorization header as every other JMAP
endpoint on the handshake itself, which the browser WebSocket API cannot
attach - so the WS attempt reaches the network correctly (see the CSP fix
in the previous commit) but always fails auth here, and the circuit
breaker falls back to SSE within about a second. That fallback is what
delivers the push this test observes - documented in detail in the spec's
header comment, including why asserting the WS handshake itself succeeds
here would be asserting something that cannot be true from a browser
against this specific server.

Known flakiness, root-caused not eliminated (see
playwright.integration-electron.config.ts's retries: 2 and its comment):
`next dev`'s on-demand route compilation + Fast Refresh occasionally races
the SSE stream during the login -> inbox transition and drops that one push
event with no error anywhere - reproduced by running the identical test
repeatedly against an already-warm stack (IT_NO_DOCKER=1): identical
request sequence logged every time, but the outcome wasn't always the same.
This is specific to the dev-server workaround this test needs for the
plaintext-Stalwart fixture, not a bug in the feature it's verifying - the
WS circuit breaker and SSE fallback fire exactly as designed in every run's
own logs, pass or fail.

Verified: passed cleanly standalone multiple times; with retries: 2 in
place, passed within the retry budget on every attempt made.
2026-08-04 14:18:40 +02:00

53 lines
2.3 KiB
TypeScript

import { defineConfig } from '@playwright/test';
/**
* Integration test config: drives the containerised webmail (+ Stalwart) stack
* managed by integration/tests/global-setup.ts. Distinct from the root
* playwright.config.ts (fast UI smoke tests against `npm run dev`).
*
* Run: npx playwright test -c playwright.integration.config.ts
*/
const WEBMAIL_URL = process.env.IT_WEBMAIL_URL ?? 'http://localhost:3000';
/**
* Video capture mode, overridable via IT_VIDEO. Default `retain-on-failure`
* keeps a .webm only for tests that fail. Set `IT_VIDEO=on` to record every
* test (e.g. for a demo or to inspect a passing flow), `off` to disable, or
* `on-first-retry` to record only when a test is retried. Videos land next to
* the other artefacts under `integration/test-results/<test>/video.webm`.
*/
type VideoMode = 'off' | 'on' | 'retain-on-failure' | 'on-first-retry';
const VIDEO_MODES: VideoMode[] = ['off', 'on', 'retain-on-failure', 'on-first-retry'];
const VIDEO: VideoMode = VIDEO_MODES.includes(process.env.IT_VIDEO as VideoMode)
? (process.env.IT_VIDEO as VideoMode)
: 'retain-on-failure';
export default defineConfig({
testDir: './integration/tests',
// Electron's own spec runs under playwright.integration-electron.config.ts
// instead (see that file's header comment for why): the dockerized run
// this config drives (integration/run-tests.sh, inside the official
// Playwright image) has no Electron binary compatible with that
// container's platform, so it must never be swept in by this config's
// default testDir glob.
testIgnore: '11-electron-notification.spec.ts',
// next dev compiles routes lazily and each test logs in fresh, so give
// individual tests and their polling assertions generous headroom.
timeout: 90_000,
expect: { timeout: 20_000 },
fullyParallel: false,
workers: 1,
retries: process.env.CI ? 1 : 0,
reporter: [['list'], ['html', { open: 'never', outputFolder: 'integration/playwright-report' }]],
outputDir: 'integration/test-results',
globalSetup: './integration/tests/global-setup.ts',
globalTeardown: './integration/tests/global-teardown.ts',
use: {
baseURL: WEBMAIL_URL,
screenshot: 'only-on-failure',
trace: 'retain-on-failure',
video: VIDEO,
},
projects: [{ name: 'chromium', use: { browserName: 'chromium' } }],
});