@scenetest/scenes 0.1.2 → 0.2.0

package/dist/warmup.js

@@ -0,0 +1,186 @@
+/**
+ * Actor warmup — run login (or other setup) once per actor, on first use,
+ * capture the resulting storageState, and reuse it for subsequent scenes.
+ *
+ * Warmup is lazy: nothing runs at startup. The first time a scene creates
+ * a context for an actor with `warmup`, the cache runs the warmup and
+ * stores the result. Same actor key in a later scene gets the cached state.
+ */
+import { getMacro } from './dsl.js';
+import { resolveSelector } from './selectors.js';
+// ---------------------------------------------------------------------------
+// WarmupCache — lazy, deduplicating cache
+// ---------------------------------------------------------------------------
+/**
+ * Lazy warmup cache. Runs each actor's warmup at most once (keyed by
+ * actor `key`), on the first scene that needs it.
+ *
+ * Concurrent requests for the same key share the same in-flight promise,
+ * so parallel scenes never double-warmup.
+ */
+export class WarmupCache {
+    cache = new Map();
+    /**
+     * Get cached warmup state for an actor, running warmup on first request.
+     * Returns `undefined` if the actor has no warmup configured.
+     */
+    async ensure(browser, config, baseUrl, actionTimeout) {
+        if (!config.warmup)
+            return undefined;
+        const existing = this.cache.get(config.key);
+        if (existing)
+            return existing;
+        const start = Date.now();
+        const promise = runActorWarmup(browser, config, baseUrl, actionTimeout)
+            .then(state => {
+            console.log(`    ✓ warmup: ${config.key} (${Date.now() - start}ms)`);
+            return state;
+        })
+            .catch(err => {
+            // Remove failed entry so it can be retried
+            this.cache.delete(config.key);
+            const msg = err instanceof Error ? err.message : String(err);
+            console.error(`    ✗ warmup failed: ${config.key} — ${msg}`);
+            throw err;
+        });
+        this.cache.set(config.key, promise);
+        return promise;
+    }
+    /** Number of cached warmup states (for testing). */
+    get size() {
+        return this.cache.size;
+    }
+}
+// ---------------------------------------------------------------------------
+// executeMacroOnPage — lightweight imperative executor
+// ---------------------------------------------------------------------------
+/**
+ * Interpolate `[self.field]` references in a DSL line with actor config values.
+ */
+function interpolateSelf(line, config) {
+    return line.replace(/\[self\.([\w]+)\]/g, (_match, field) => {
+        const value = config[field];
+        if (value === undefined) {
+            throw new Error(`[self.${field}] — actor "${config.key}" has no field "${field}"`);
+        }
+        return String(value);
+    });
+}
+/**
+ * Execute a sequence of DSL action lines on a bare Playwright page.
+ *
+ * Supports the subset of actions needed for login flows:
+ * openTo, see, seeText, click, typeInto, wait.
+ *
+ * Interpolates `[self.field]` for actor credentials.
+ */
+export async function executeMacroOnPage(page, actions, config, actionTimeout) {
+    for (const raw of actions) {
+        const line = interpolateSelf(raw, config).trim();
+        if (!line || line.startsWith('#') || line.startsWith('//'))
+            continue;
+        const spaceIdx = line.indexOf(' ');
+        const action = spaceIdx === -1 ? line : line.slice(0, spaceIdx);
+        const rest = spaceIdx === -1 ? '' : line.slice(spaceIdx + 1).trim();
+        switch (action) {
+            case 'openTo':
+                await page.goto(rest, { timeout: actionTimeout });
+                break;
+            case 'see': {
+                const locator = resolveSelector(page, rest);
+                await locator.waitFor({ state: 'visible', timeout: actionTimeout });
+                break;
+            }
+            case 'seeText':
+                await page.getByText(rest).first().waitFor({ state: 'visible', timeout: actionTimeout });
+                break;
+            case 'click': {
+                const locator = resolveSelector(page, rest);
+                await locator.click({ timeout: actionTimeout });
+                break;
+            }
+            case 'typeInto': {
+                // Last token is value, everything before is selector
+                const { selector, value } = extractSelectorAndValue(rest);
+                await resolveSelector(page, selector).fill(value, { timeout: actionTimeout });
+                break;
+            }
+            case 'wait': {
+                const ms = parseInt(rest, 10);
+                if (isNaN(ms))
+                    throw new Error(`warmup: wait requires a number, got: ${rest}`);
+                await new Promise(r => setTimeout(r, ms));
+                break;
+            }
+            default:
+                throw new Error(`warmup: unsupported action "${action}" — only openTo, see, seeText, click, typeInto, wait are supported`);
+        }
+    }
+}
+/**
+ * Extract selector and value from a "selector value" string.
+ * Last token (possibly quoted) is the value; everything before is the selector.
+ */
+function extractSelectorAndValue(rest) {
+    const trimmed = rest.trim();
+    // Check for quoted last token
+    const lastChar = trimmed[trimmed.length - 1];
+    if (lastChar === "'" || lastChar === '"') {
+        let i = trimmed.length - 2;
+        while (i >= 0 && trimmed[i] !== lastChar)
+            i--;
+        if (i >= 0) {
+            return {
+                selector: trimmed.slice(0, i).trim(),
+                value: trimmed.slice(i + 1, -1),
+            };
+        }
+    }
+    // No quotes — last word is the value
+    const lastSpace = trimmed.lastIndexOf(' ');
+    if (lastSpace === -1) {
+        throw new Error(`warmup typeInto: expected "selector value", got: ${rest}`);
+    }
+    return {
+        selector: trimmed.slice(0, lastSpace).trim(),
+        value: trimmed.slice(lastSpace + 1),
+    };
+}
+// ---------------------------------------------------------------------------
+// runActorWarmup — single actor
+// ---------------------------------------------------------------------------
+/**
+ * Run warmup for a single actor: create temp context, execute warmup,
+ * capture storageState, close context.
+ */
+export async function runActorWarmup(browser, config, baseUrl, actionTimeout) {
+    const context = await browser.newContext({
+        baseURL: baseUrl,
+    });
+    try {
+        const page = await context.newPage();
+        if (typeof config.warmup === 'function') {
+            // Function warmup
+            await config.warmup(page, config);
+        }
+        else if (typeof config.warmup === 'string') {
+            // Macro warmup
+            const macro = getMacro(config.warmup);
+            if (!macro) {
+                throw new Error(`warmup: macro "${config.warmup}" not found for actor "${config.key}". ` +
+                    `Register it with defineMacro('${config.warmup}', [...]) before scenes run.`);
+            }
+            await executeMacroOnPage(page, macro, config, actionTimeout);
+        }
+        else {
+            throw new Error(`warmup: actor "${config.key}" has invalid warmup type: ${typeof config.warmup}`);
+        }
+        // Capture storage state
+        const state = await context.storageState();
+        return state;
+    }
+    finally {
+        await context.close();
+    }
+}
+//# sourceMappingURL=warmup.js.map

package/dist/warmup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"warmup.js","sourceRoot":"","sources":["../src/warmup.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAIH,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAuBhD,8EAA8E;AAC9E,0CAA0C;AAC1C,8EAA8E;AAE9E;;;;;;GAMG;AACH,MAAM,OAAO,WAAW;IACd,KAAK,GAAG,IAAI,GAAG,EAAiC,CAAA;IAExD;;;OAGG;IACH,KAAK,CAAC,MAAM,CACV,OAAgB,EAChB,MAAmB,EACnB,OAAe,EACf,aAAqB;QAErB,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,OAAO,SAAS,CAAA;QAEpC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QAC3C,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAA;QAE7B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACxB,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,CAAC;aACpE,IAAI,CAAC,KAAK,CAAC,EAAE;YACZ,OAAO,CAAC,GAAG,CAAC,iBAAiB,MAAM,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,KAAK,CAAC,CAAA;YACpE,OAAO,KAAK,CAAA;QACd,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,2CAA2C;YAC3C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC7B,MAAM,GAAG,GAAG,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YAC5D,OAAO,CAAC,KAAK,CAAC,wBAAwB,MAAM,CAAC,GAAG,MAAM,GAAG,EAAE,CAAC,CAAA;YAC5D,MAAM,GAAG,CAAA;QACX,CAAC,CAAC,CAAA;QAEJ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QACnC,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,oDAAoD;IACpD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAA;IACxB,CAAC;CACF;AAED,8EAA8E;AAC9E,uDAAuD;AACvD,8EAA8E;AAE9E;;GAEG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,MAAmB;IACxD,OAAO,IAAI,CAAC,OAAO,CACjB,oBAAoB,EACpB,CAAC,MAAM,EAAE,KAAa,EAAE,EAAE;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;QAC3B,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,cAAc,MAAM,CAAC,GAAG,mBAAmB,KAAK,GAAG,CAAC,CAAA;QACpF,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IACtB,CAAC,CACF,CAAA;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,IAAU,EACV,OAAiB,EACjB,MAAmB,EACnB,aAAqB;IAErB,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,CAAA;QAChD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,SAAQ;QAEpE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAClC,MAAM,MAAM,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAA;QAC/D,MAAM,IAAI,GAAG,QAAQ,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QAEnE,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,QAAQ;gBACX,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;gBACjD,MAAK;YAEP,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBAC3C,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;gBACnE,MAAK;YACP,CAAC;YAED,KAAK,SAAS;gBACZ,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;gBACxF,MAAK;YAEP,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;gBAC3C,MAAM,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;gBAC/C,MAAK;YACP,CAAC;YAED,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,qDAAqD;gBACrD,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAA;gBACzD,MAAM,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAA;gBAC7E,MAAK;YACP,CAAC;YAED,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,EAAE,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;gBAC7B,IAAI,KAAK,CAAC,EAAE,CAAC;oBAAE,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAA;gBAC9E,MAAM,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;gBACzC,MAAK;YACP,CAAC;YAED;gBACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,oEAAoE,CAAC,CAAA;QAC9H,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,uBAAuB,CAAC,IAAY;IAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;IAE3B,8BAA8B;IAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;IAC5C,IAAI,QAAQ,KAAK,GAAG,IAAI,QAAQ,KAAK,GAAG,EAAE,CAAC;QACzC,IAAI,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;QAC1B,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,QAAQ;YAAE,CAAC,EAAE,CAAA;QAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACX,OAAO;gBACL,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE;gBACpC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;aAChC,CAAA;QACH,CAAC;IACH,CAAC;IAED,qCAAqC;IACrC,MAAM,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IAC1C,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,oDAAoD,IAAI,EAAE,CAAC,CAAA;IAC7E,CAAC;IACD,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE;QAC5C,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;KACpC,CAAA;AACH,CAAC;AAED,8EAA8E;AAC9E,gCAAgC;AAChC,8EAA8E;AAE9E;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAgB,EAChB,MAAmB,EACnB,OAAe,EACf,aAAqB;IAErB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC;QACvC,OAAO,EAAE,OAAO;KACjB,CAAC,CAAA;IAEF,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QAEpC,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACxC,kBAAkB;YAClB,MAAM,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACnC,CAAC;aAAM,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC7C,eAAe;YACf,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YACrC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,MAAM,IAAI,KAAK,CACb,kBAAkB,MAAM,CAAC,MAAM,0BAA0B,MAAM,CAAC,GAAG,KAAK;oBACxE,iCAAiC,MAAM,CAAC,MAAM,8BAA8B,CAC7E,CAAA;YACH,CAAC;YACD,MAAM,kBAAkB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,CAAA;QAC9D,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,kBAAkB,MAAM,CAAC,GAAG,8BAA8B,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;QACnG,CAAC;QAED,wBAAwB;QACxB,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,YAAY,EAAkB,CAAA;QAC1D,OAAO,KAAK,CAAA;IACd,CAAC;YAAS,CAAC;QACT,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IACvB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scenetest/scenes",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "CLI tool for running scenetest scene specs",
   "type": "module",
   "license": "MIT",
@@ -36,7 +36,7 @@
     "commander": "^12.0.0",
     "glob": "^10.3.10",
     "jiti": "^2.4.0",
-    "@scenetest/checks": "0.1.2"
+    "@scenetest/checks": "0.2.0"
   },
   "devDependencies": {
     "typescript": "^5.3.0",