@greendrake/e2e 0.5.0 → 0.7.0

package/README.md

@@ -19,14 +19,14 @@ import { spaPlaywright } from '@greendrake/e2e'
 export default spaPlaywright({ defaultPort: '5173' })
 ```
 
-The frontend port is `VITE_PORT`, falling back to `defaultPort` — the variable the app's own Vite config is expected to pin its dev server to, so the config targets the server the app actually started. Omit `defaultPort` in an app whose harness always supplies `VITE_PORT`: a missing port then throws rather than silently testing whatever happens to be listening on a default.
+The frontend port is `VITE_PORT`, falling back to `defaultPort` — the variable the app's own Vite config is expected to pin its dev server to, so the config targets the server the app actually started. Omit `defaultPort` in an app whose harness always supplies `VITE_PORT`: a missing port then throws rather than silently testing whatever happens to be listening on a default. An app its own backend serves passes that origin as `baseURL` instead, and `VITE_PORT` is not read.
 
 What it returns (a `PlaywrightTestConfig` via `defineConfig`):
 
 - `testDir: './tests'`, `fullyParallel: true`, `workers: 5`, `retries: 0`, `forbidOnly` when `CI` is set.
 - `timeout: 120_000` — crawl-style specs visit every page and click through every link; Playwright's 30s default is sized for single-interaction tests.
 - Reporter: `html`, `open: 'never'`.
-- `use`: `baseURL` `http://localhost:<port>`, `trace: 'on-first-retry'`, `video: 'retain-on-failure'`.
+- `use`: `baseURL` `http://localhost:<port>` (or the `baseURL` given), `trace: 'on-first-retry'`, `video: 'retain-on-failure'`.
 - One project, `chromium`, on `devices['Desktop Chrome']`.
 - No `webServer`: the app, and whatever backs it, are started by the caller.
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@greendrake/e2e",
-    "version": "0.5.0",
+    "version": "0.7.0",
     "description": "Playwright kit for single-page apps: config factories, a same-origin crawler, a clipped-content detector, a polling helper and a layout checker",
     "license": "MIT",
     "author": "Eugene Greendrake <eugene@greendrake.nz>",
@@ -45,7 +45,7 @@
         "@playwright/test": ">=1.49.0"
     },
     "devDependencies": {
-        "@greendrake/dev-config": "0.5.0",
+        "@greendrake/dev-config": "0.7.0",
         "@playwright/test": "1.60.0",
         "typescript": "6.0.3"
     }

package/src/playwrightConfig.ts

@@ -6,17 +6,24 @@ export interface SpaPlaywrightOptions {
     // then fails the run rather than silently testing whatever happens to be
     // listening on a default.
     defaultPort?: string
+    // The app's origin, for an app its own backend serves rather than a dev
+    // server: VITE_PORT is then not read at all.
+    baseURL?: string
     overrides?: PlaywrightTestConfig
 }
 
-// The config an SPA would otherwise hand-copy: chromium-only, ./tests dir, an
-// html reporter that never auto-opens, and a baseURL built from VITE_PORT.
-export const spaPlaywright = (options: SpaPlaywrightOptions = {}): PlaywrightTestConfig => {
-    const port = process.env.VITE_PORT || options.defaultPort
+const devServerURL = (defaultPort?: string): string => {
+    const port = process.env.VITE_PORT || defaultPort
     if (!port) {
         throw new Error('spaPlaywright: VITE_PORT must be set (this app configures no defaultPort)')
     }
-    return defineConfig({
+    return `http://localhost:${port}`
+}
+
+// The config an SPA would otherwise hand-copy: chromium-only, ./tests dir, an
+// html reporter that never auto-opens, and a baseURL built from VITE_PORT.
+export const spaPlaywright = (options: SpaPlaywrightOptions = {}): PlaywrightTestConfig =>
+    defineConfig({
         testDir: './tests',
         fullyParallel: true,
         forbidOnly: !!process.env.CI,
@@ -27,7 +34,7 @@ export const spaPlaywright = (options: SpaPlaywrightOptions = {}): PlaywrightTes
         timeout: 120_000,
         reporter: [['html', { open: 'never' }]],
         use: {
-            baseURL: `http://localhost:${port}`,
+            baseURL: options.baseURL ?? devServerURL(options.defaultPort),
             trace: 'on-first-retry',
             video: 'retain-on-failure'
         },
@@ -39,4 +46,3 @@ export const spaPlaywright = (options: SpaPlaywrightOptions = {}): PlaywrightTes
         ],
         ...options.overrides
     })
-}