@vosjs/render-core 0.9.0 → 0.11.0

package/dist/record/index.js

@@ -689,7 +689,8 @@ function noticeAdvice(notices) {
 }
 
 // src/record/setup.ts
-var VERBS = /* @__PURE__ */ new Set(["wait", "click", "type", "press", "goto"]);
+var VERBS = /* @__PURE__ */ new Set(["wait", "click", "type", "press", "goto", "if"]);
+var IF_LOOK_MS = 3e3;
 function urlSchemeProblem(url) {
   let u;
   try {
@@ -701,11 +702,11 @@ function urlSchemeProblem(url) {
     return `${url} is not an http(s) address, and the recorder opens only http and https pages`;
   return null;
 }
-function validateSetup(value) {
+function validateSetup(value, phase = "setup") {
   const errors = [];
-  if (!Array.isArray(value)) return ["setup must be an array of steps"];
+  if (!Array.isArray(value)) return [`${phase} must be an array of steps`];
   value.forEach((raw, i) => {
-    const at = `setup[${i}]`;
+    const at = `${phase}[${i}]`;
     if (typeof raw !== "object" || raw === null) {
       errors.push(`${at}: must be an object`);
       return;
@@ -715,7 +716,7 @@ function validateSetup(value) {
       errors.push(`${at}: "do" must be one of ${[...VERBS].join(", ")}`);
       return;
     }
-    if ((s.do === "click" || s.do === "type") && typeof s.selector !== "string")
+    if ((s.do === "click" || s.do === "type" || s.do === "if") && typeof s.selector !== "string")
       errors.push(`${at}: ${s.do} needs a selector`);
     if (s.do === "wait" && typeof s.ms !== "number")
       errors.push(`${at}: wait needs ms`);
@@ -750,73 +751,158 @@ function setupEnvNames(steps) {
   }
   return [...out];
 }
-function resolveSetupText(t, env) {
+function scriptEnvNames(script) {
+  return [
+    .../* @__PURE__ */ new Set([
+      ...setupEnvNames(script.setup),
+      ...setupEnvNames(script.teardown)
+    ])
+  ];
+}
+function resolveSetupText(t, env, phase = "setup") {
   if (typeof t === "string") return { value: t, secret: false };
   const v = env[t.env];
   if (v === void 0 || v === "")
     throw new SetupEnvError(
-      `setup: the environment variable ${t.env} is not set, and a type step reads it. Export it in the shell that runs vos record; it is never written to a file`
+      `${phase}: the environment variable ${t.env} is not set, and a type step reads it. Export it in the shell that runs vos record; it is never written to a file`
     );
   return { value: v, secret: true };
 }
+function teardownEnvProblem(steps, env) {
+  for (const [i, s] of (steps ?? []).entries()) {
+    if (s.do !== "type" || typeof s.text !== "object") continue;
+    const v = env[s.text.env];
+    if (v === void 0 || v === "")
+      return `teardown[${i}] reads the environment variable ${s.text.env}, which is not set, so the take could leave behind what its teardown removes. Export it in the shell that runs vos record; it is never written to a file. Nothing was recorded.`;
+  }
+  return null;
+}
+var TEARDOWN_BOUND_MS = 6e4;
+function teardownLine(report) {
+  const f = report.failed;
+  const k = report.skipped;
+  if (!f && k)
+    return `teardown: nothing to undo, ${k.selector} is not on the page (teardown[${k.step}] if); ${report.ran} step(s) ran, ${k.rest} skipped`;
+  if (!f) return `teardown: ${report.ran} step(s) ran`;
+  const reason = f.error.replace(/[.\s]+$/, "");
+  return `TEARDOWN FAILED at teardown[${f.step}] (${f.do}${f.selector ? ` ${f.selector}` : ""}): ${reason}. What the take created may still be in the product; remove it by hand.`;
+}
 async function runSetup(page, steps, opts) {
   const env = opts.env ?? {};
+  const phase = opts.phase ?? "setup";
+  const now = opts.now ?? Date.now;
+  const deadline = opts.boundMs === void 0 ? void 0 : now() + opts.boundMs;
   const lines = [];
-  for (const [i, step] of steps.entries()) {
+  let typed = "";
+  let gone = null;
+  const runStep = async (step, i) => {
     const settle = "ms" in step && typeof step.ms === "number" ? step.ms : 150;
-    try {
-      switch (step.do) {
-        case "wait":
-          await opts.sleep(step.ms);
-          lines.push(`setup #${i} wait ${step.ms}ms`);
-          break;
-        case "goto":
-          await (opts.goto ? opts.goto(step.url) : page.goto(step.url, {
-            waitUntil: "networkidle",
-            timeout: 45e3
-          })).catch(() => null);
-          lines.push(`setup #${i} goto ${step.url}`);
-          break;
-        case "press":
-          await page.keyboard.press(step.key);
-          await opts.sleep(settle);
-          lines.push(`setup #${i} press ${step.key}`);
-          break;
-        case "click": {
-          const loc = page.locator(step.selector).first();
-          await loc.waitFor({ state: "visible", timeout: 8e3 });
-          await loc.click();
-          await opts.sleep(settle);
-          lines.push(`setup #${i} click ${step.selector}`);
-          break;
-        }
-        case "type": {
-          const loc = page.locator(step.selector).first();
-          await loc.waitFor({ state: "visible", timeout: 8e3 });
-          const { value, secret } = resolveSetupText(step.text, env);
-          await loc.fill(value);
-          await opts.sleep(settle);
-          lines.push(
-            `setup #${i} type ${secret ? `\${${step.text.env}}` : `${value.length} chars`} into ${step.selector}`
-          );
-          break;
-        }
+    switch (step.do) {
+      case "wait":
+        await opts.sleep(step.ms);
+        return `${phase} #${i} wait ${step.ms}ms`;
+      case "goto":
+        await (opts.goto ? opts.goto(step.url) : page.goto(step.url, {
+          waitUntil: "networkidle",
+          timeout: 45e3
+        })).catch(() => null);
+        return `${phase} #${i} goto ${step.url}`;
+      case "press":
+        await page.keyboard.press(step.key);
+        await opts.sleep(settle);
+        return `${phase} #${i} press ${step.key}`;
+      case "if": {
+        const present = await page.locator(step.selector).first().waitFor({ state: "visible", timeout: step.ms ?? IF_LOOK_MS }).then(() => true).catch(() => false);
+        if (present) return `${phase} #${i} if ${step.selector}: on the page`;
+        gone = { step: i, selector: step.selector };
+        return `${phase} #${i} if ${step.selector}: not on the page, the ${steps.length - i - 1} step(s) after it skipped`;
+      }
+      case "click": {
+        const loc = page.locator(step.selector).first();
+        await loc.waitFor({ state: "visible", timeout: 8e3 });
+        await loc.click();
+        await opts.sleep(settle);
+        return `${phase} #${i} click ${step.selector}`;
       }
+      case "type": {
+        const loc = page.locator(step.selector).first();
+        await loc.waitFor({ state: "visible", timeout: 8e3 });
+        const { value, secret } = resolveSetupText(step.text, env, phase);
+        typed = value;
+        await loc.fill(value);
+        await opts.sleep(settle);
+        return `${phase} #${i} type ${secret ? `\${${step.text.env}}` : `${value.length} chars`} into ${step.selector}`;
+      }
+    }
+  };
+  for (const [i, step] of steps.entries()) {
+    typed = "";
+    try {
+      lines.push(
+        await withinDeadline(
+          runStep(step, i),
+          deadline,
+          now,
+          `the ${phase} ran past its ${sayBound(opts.boundMs ?? 0)} bound`
+        )
+      );
     } catch (e) {
-      if (e instanceof SetupEnvError) throw e;
+      if (e instanceof SetupEnvError && phase === "setup") throw e;
       return {
         ran: i,
         lines,
         failed: {
           step: i,
           do: step.do,
-          ..."selector" in step ? { selector: step.selector } : {}
+          ..."selector" in step ? { selector: step.selector } : {},
+          error: reasonWords(e, typed)
         }
       };
     }
+    const ended = gone;
+    if (ended)
+      return {
+        ran: i + 1,
+        lines,
+        skipped: { ...ended, rest: steps.length - i - 1 }
+      };
   }
   return { ran: steps.length, lines };
 }
+function sayBound(ms) {
+  return ms >= 1e3 ? `${Math.round(ms / 1e3)} s` : `${ms} ms`;
+}
+function withinDeadline(p, deadline, now, message) {
+  if (deadline === void 0) return p;
+  const left = deadline - now();
+  return new Promise((resolve, reject) => {
+    const timer = setTimeout(
+      () => {
+        p.catch(() => {
+        });
+        reject(new Error(message));
+      },
+      Math.max(0, left)
+    );
+    p.then(
+      (v) => {
+        clearTimeout(timer);
+        resolve(v);
+      },
+      (e) => {
+        clearTimeout(timer);
+        reject(e);
+      }
+    );
+  });
+}
+var ANSI_COLOUR = new RegExp(`${String.fromCharCode(27)}\\[[0-9;]*m`, "g");
+function reasonWords(e, typed) {
+  const raw = e instanceof Error ? e.message : String(e);
+  const line = (raw.replace(ANSI_COLOUR, "").split("\n")[0] ?? "").trim();
+  if (typed && line.includes(typed)) return "the field could not be filled";
+  return line || "the step failed";
+}
 var SetupEnvError = class extends Error {
   constructor(message) {
     super(message);
@@ -2405,6 +2491,8 @@ function validateActions(value) {
     }
   }
   if (obj.setup !== void 0) errors.push(...validateSetup(obj.setup));
+  if (obj.teardown !== void 0)
+    errors.push(...validateSetup(obj.teardown, "teardown"));
   const ready = readyProblem(obj.ready);
   if (ready) errors.push(ready);
   if (obj.settle !== void 0 && typeof obj.settle !== "boolean")
@@ -3071,6 +3159,18 @@ function base64Bytes(data) {
   return out;
 }
 async function recordTake(browser, url, actions, sink, log, opts = {}) {
+  const late = {};
+  try {
+    return await recordTakeSteps(browser, url, actions, sink, log, opts, late);
+  } catch (e) {
+    const teardown = late.teardown;
+    late.teardown = void 0;
+    if (teardown) await teardown().catch(() => {
+    });
+    throw e;
+  }
+}
+async function recordTakeSteps(browser, url, actions, sink, log, opts, late) {
   const dry = opts.dryRun === true;
   const sleep = dry ? (ms) => realSleep(Math.min(ms, DRY_PAUSE_MS)) : realSleep;
   const maxSeconds = dry ? Infinity : opts.maxDurationSeconds ?? Infinity;
@@ -3083,6 +3183,8 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
         `steps[${download}] is a download, and this recorder has nowhere to keep a file. Nothing was recorded.`
       );
   }
+  const teardownEnv = teardownEnvProblem(actions.teardown, opts.env ?? {});
+  if (teardownEnv) throw new SetupEnvError(teardownEnv);
   const read = await loadScriptFiles(actions, opts.files);
   if ("problem" in read) throw new RecordRefusedError(read.problem);
   const files = read;
@@ -3126,8 +3228,9 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
     noticeLog.add(step, scan?.notices);
   };
   const pageErrors = new PageErrorLog(opts.verbose === true);
+  let tearingDown = false;
   page.on("console", (m) => {
-    if (m.type() !== "error") return;
+    if (m.type() !== "error" || tearingDown) return;
     const line = pageErrors.add(m.text());
     if (line) log(line);
   });
@@ -3158,6 +3261,50 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
     log(`goto ${url} (after setup)`);
     response = (await open(url)).response;
   }
+  const teardownSteps = actions.teardown ?? [];
+  let teardown = null;
+  let teardownRan = false;
+  const runTeardown = async () => {
+    if (!teardownSteps.length || teardownRan) return teardown;
+    teardownRan = true;
+    tearingDown = true;
+    log(`teardown: ${teardownSteps.length} step(s), off camera`);
+    try {
+      const result = await runSetup(page, teardownSteps, {
+        phase: "teardown",
+        sleep: realSleep,
+        env: opts.env ?? {},
+        goto: (target) => open(target),
+        boundMs: TEARDOWN_BOUND_MS
+      });
+      for (const line of result.lines) log(`   ${line}`);
+      teardown = {
+        ran: result.ran,
+        of: teardownSteps.length,
+        ...result.failed ? {
+          failed: {
+            step: result.failed.step,
+            do: result.failed.do,
+            ...result.failed.selector !== void 0 ? { selector: result.failed.selector } : {},
+            error: result.failed.error ?? "the step failed"
+          }
+        } : {},
+        ...result.skipped ? { skipped: result.skipped } : {}
+      };
+    } catch (e) {
+      teardown = {
+        ran: 0,
+        of: teardownSteps.length,
+        failed: {
+          step: 0,
+          do: teardownSteps[0].do,
+          error: e instanceof Error ? e.message : String(e)
+        }
+      };
+    }
+    if (teardown.failed) log(`   ${teardownLine(teardown)}`);
+    return teardown;
+  };
   let wall = null;
   if (opts.onArrival) {
     const seen = await page.evaluate(WALL_PROBE).catch(() => null);
@@ -3468,6 +3615,13 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
     })
   );
   signals.begin();
+  late.teardown = async () => {
+    if (!dry) await cdp.send("Page.stopScreencast").catch(() => {
+    });
+    pageBound.end();
+    const report = await runTeardown();
+    if (report && !report.failed) log(`   ${teardownLine(report)}`);
+  };
   for (const [stepIdx, step] of actions.steps.entries()) {
     if (capReached(now(), maxSeconds)) {
       capped = true;
@@ -4179,6 +4333,8 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
   const pageTitle = await page.title().catch(() => "") ?? "";
   for (const line of pageErrors.repeats()) log(line);
   pageBound.end();
+  late.teardown = void 0;
+  await runTeardown();
   pageBound.start(CLOSE_BOUND_MS);
   await pageBound.race(context.close().catch(() => {
   }));
@@ -4265,7 +4421,8 @@ async function recordTake(browser, url, actions, sink, log, opts = {}) {
     // Self-contained: a path a file held is inline, so the take re-records
     // from its own script with the file gone.
     actions: { ...inlineScript(actions, files), url },
-    peers: peerRuns
+    peers: peerRuns,
+    teardown
   };
 }
 async function keepPageSound(heard, sink, fetchSource, log) {
@@ -4535,6 +4692,7 @@ export {
   EXPOSURE_PROBE,
   ExposureLog,
   IDLE_CALL_MS,
+  IF_LOOK_MS,
   JS_SAID_MAX,
   JS_VALUE_MAX,
   KEY_ROUNDTRIP_MS,
@@ -4592,6 +4750,7 @@ export {
   SetupError,
   StepBound,
   StepSignals,
+  TEARDOWN_BOUND_MS,
   TRAILING_HOLD_MS,
   TakeClock,
   WAIT_MARGIN_MS,
@@ -4681,6 +4840,7 @@ export {
   sayJs,
   sayValue,
   schedulePath,
+  scriptEnvNames,
   scriptFiles,
   scrollByScript,
   scrollTravelMs,
@@ -4694,6 +4854,8 @@ export {
   stageClipboardScript,
   stepBoundMs,
   syntheticPasteScript,
+  teardownEnvProblem,
+  teardownLine,
   typeOfName,
   untilReady,
   urlSchemeProblem,