prowl-tools 0.1.8 → 0.1.10

package/dist/lib.cjs

@@ -394,6 +394,9 @@ function createMacDriver(client, options = {}) {
     waitForNetworkIdle() {
       return rejectUnsupported("waitForNetworkIdle");
     },
+    waitForResponse() {
+      return rejectUnsupported("waitForResponse");
+    },
     // scripting & artifacts ------------------------------------------------
     evaluate() {
       return rejectUnsupported("evalScript");
@@ -524,10 +527,15 @@ ${macdriverBuildInstructions()}`
 ${macdriverBuildInstructions()}`);
 }
 var DEFAULT_REQUEST_TIMEOUT_MS = 3e4;
+function errorMessage(error) {
+  return error instanceof Error ? error.message : String(error);
+}
 var SpawnMacHelperClient = class {
   child;
   pending = /* @__PURE__ */ new Map();
   requestTimeoutMs;
+  onEvent;
+  onEventError;
   stdoutBuffer = "";
   stderrBuffer = "";
   nextId = 1;
@@ -535,6 +543,9 @@ var SpawnMacHelperClient = class {
   terminalError;
   constructor(binaryPath, options = {}) {
     this.requestTimeoutMs = options.requestTimeoutMs ?? DEFAULT_REQUEST_TIMEOUT_MS;
+    this.onEvent = options.onEvent;
+    this.onEventError = options.onEventError ?? ((message) => process.stderr.write(`${message}
+`));
     this.child = (0, import_node_child_process.spawn)(binaryPath, ["serve"], { stdio: ["pipe", "pipe", "pipe"] });
     this.child.stdout?.setEncoding("utf-8");
     this.child.stderr?.setEncoding("utf-8");
@@ -571,6 +582,10 @@ var SpawnMacHelperClient = class {
     } catch {
       return;
     }
+    if (typeof message.event === "string" && typeof message.id !== "number") {
+      this.handleEvent(message);
+      return;
+    }
     const id = typeof message.id === "number" ? message.id : void 0;
     if (id === void 0) {
       return;
@@ -587,6 +602,18 @@ var SpawnMacHelperClient = class {
       pending.reject(new Error(typeof message.error === "string" ? message.error : "prowl-macdriver error"));
     }
   }
+  handleEvent(event) {
+    try {
+      this.onEvent?.(event);
+    } catch (error) {
+      try {
+        this.onEventError(
+          `prowl-macdriver event sink failed for event "${event.event}": ${errorMessage(error)}`
+        );
+      } catch {
+      }
+    }
+  }
   failAll(error) {
     for (const pending of this.pending.values()) {
       clearTimeout(pending.timer);
@@ -1587,6 +1614,9 @@ function createAndroidDriver(client, options = {}) {
     waitForNetworkIdle() {
       return rejectUnsupported("waitForNetworkIdle");
     },
+    waitForResponse() {
+      return rejectUnsupported("waitForResponse");
+    },
     // scripting & artifacts ------------------------------------------------
     evaluate() {
       return rejectUnsupported("evalScript");
@@ -2050,6 +2080,7 @@ var WEB_ONLY_STEP_TYPES = /* @__PURE__ */ new Set([
   "navigate",
   "waitForUrl",
   "waitForNetworkIdle",
+  "waitForResponse",
   "mockRoute",
   "unmockRoute",
   "evalScript",
@@ -2668,6 +2699,9 @@ function createIosDriver(client, options) {
     waitForNetworkIdle() {
       return rejectUnsupported("waitForNetworkIdle");
     },
+    waitForResponse() {
+      return rejectUnsupported("waitForResponse");
+    },
     // scripting & artifacts ------------------------------------------------
     evaluate() {
       return rejectUnsupported("evalScript");
@@ -3673,6 +3707,21 @@ var waitForUrlStepSchema = import_zod.z.object({
 var waitForNetworkIdleStepSchema = import_zod.z.object({
   waitForNetworkIdle: import_zod.z.object({ timeout: import_zod.z.number().optional() }).strict()
 }).strict();
+var waitForResponseStatusSchema = import_zod.z.number().int().min(100).max(599);
+var waitForResponseTimeoutSchema = import_zod.z.number().int().min(0).finite();
+var waitForResponseStepSchema = import_zod.z.object({
+  waitForResponse: import_zod.z.object({
+    // Matched against each response URL as a glob (`*`/`**` match any run of
+    // characters including `/`, `?` matches one character); matching is
+    // unanchored, so a pattern with no wildcards behaves as a substring match.
+    url: import_zod.z.string().min(1).describe(
+      "URL glob to wait for; unanchored, so a wildcard-free pattern is a substring match"
+    ),
+    // Optional status filter: only resolve on a response with this exact HTTP status.
+    status: waitForResponseStatusSchema.optional(),
+    timeout: waitForResponseTimeoutSchema.optional()
+  }).strict()
+}).strict();
 var selectOptionStepSchema = import_zod.z.object({
   selectOption: import_zod.z.object({ selector: import_zod.z.string().min(1), value: import_zod.z.string() }).strict()
 }).strict();
@@ -3834,6 +3883,7 @@ var stepSchema = import_zod.z.union([
   waitForSelectorStepSchema,
   waitForUrlStepSchema,
   waitForNetworkIdleStepSchema,
+  waitForResponseStepSchema,
   hoverStepSchema,
   scrollStepSchema,
   scrollToStepSchema,
@@ -4068,6 +4118,16 @@ function interpolateStep(step, vars, stepPath2, redacted) {
   if ("waitForNetworkIdle" in step) {
     return { waitForNetworkIdle: { timeout: step.waitForNetworkIdle.timeout } };
   }
+  if ("waitForResponse" in step) {
+    const urlResult = interpolateString(step.waitForResponse.url, vars);
+    return {
+      waitForResponse: {
+        url: urlResult.value,
+        ...step.waitForResponse.status !== void 0 ? { status: step.waitForResponse.status } : {},
+        timeout: step.waitForResponse.timeout
+      }
+    };
+  }
   if ("hover" in step) {
     const selectorResult = interpolateString(step.hover.selector, vars);
     return { hover: { selector: selectorResult.value } };
@@ -4687,6 +4747,9 @@ function createPlaywrightDriver(page) {
     async waitForNetworkIdle(options) {
       await page.waitForLoadState("networkidle", { timeout: options?.timeout });
     },
+    async waitForResponse(predicate, options) {
+      await page.waitForResponse((response) => predicate(response), { timeout: options?.timeout });
+    },
     evaluate(pageFunction, arg) {
       const raw = page.evaluate;
       const result = arg === void 0 ? raw.call(page, pageFunction) : raw.call(page, pageFunction, arg);
@@ -5148,6 +5211,7 @@ function getStepType(step) {
   if ("waitForSelector" in step) return "waitForSelector";
   if ("waitForUrl" in step) return "waitForUrl";
   if ("waitForNetworkIdle" in step) return "waitForNetworkIdle";
+  if ("waitForResponse" in step) return "waitForResponse";
   if ("hover" in step) return "hover";
   if ("scroll" in step) return "scroll";
   if ("scrollTo" in step) return "scrollTo";
@@ -5164,6 +5228,11 @@ function getStepType(step) {
   if ("waitForDownload" in step) return "waitForDownload";
   return "step";
 }
+function compileResponseUrlMatcher(pattern) {
+  const regexBody = pattern.replace(/[.*+?^${}()|[\]\\]/g, "\\$&").replace(/\\\*/g, ".*").replace(/\\\?/g, ".");
+  const regex = new RegExp(regexBody);
+  return (url) => regex.test(url);
+}
 var RUNTIME_VAR_PATTERN = /\{\{([A-Z0-9_]+)\}\}/g;
 function substituteRuntimeVars(input, vars) {
   return input.replace(RUNTIME_VAR_PATTERN, (match, name) => {
@@ -5202,6 +5271,15 @@ function applyRuntimeVars(step, vars) {
   if ("waitForSelector" in step) {
     return { waitForSelector: { selector: sub(step.waitForSelector.selector), timeout: step.waitForSelector.timeout } };
   }
+  if ("waitForResponse" in step) {
+    return {
+      waitForResponse: {
+        url: sub(step.waitForResponse.url),
+        ...step.waitForResponse.status !== void 0 ? { status: step.waitForResponse.status } : {},
+        ...step.waitForResponse.timeout !== void 0 ? { timeout: step.waitForResponse.timeout } : {}
+      }
+    };
+  }
   if ("evalScript" in step) {
     if (typeof step.evalScript === "string") return { evalScript: sub(step.evalScript) };
     return {
@@ -5811,6 +5889,32 @@ var STEP_HANDLERS = {
       };
     }
   },
+  waitForResponse: {
+    capabilities: ["response", "wait"],
+    run: async (h) => {
+      if (!("waitForResponse" in h.step)) unknownStep();
+      const { url: pattern, status, timeout } = h.step.waitForResponse;
+      const matchesResponseUrl = compileResponseUrlMatcher(pattern);
+      try {
+        await h.driver.waitForResponse(
+          (response) => matchesResponseUrl(response.url()) && (status === void 0 || response.status() === status),
+          { timeout }
+        );
+      } catch (err) {
+        const isTimeout = err instanceof Error && (err.name === "TimeoutError" || /timeout/i.test(err.message));
+        if (!isTimeout) throw err;
+        const statusPart = status !== void 0 ? ` with status ${status}` : "";
+        const timeoutPart = timeout !== void 0 ? ` within ${timeout}ms` : "";
+        throw new Error(
+          `waitForResponse: no response matching "${pattern}"${statusPart} was received${timeoutPart}.`
+        );
+      }
+      return {
+        kind: "result",
+        result: { type: "waitForResponse", status: "pass", durationMs: Date.now() - h.stepStart, value: pattern }
+      };
+    }
+  },
   waitForNetworkIdle: {
     capabilities: ["wait"],
     run: async (h) => {
@@ -6601,6 +6705,15 @@ function formatStep(step) {
   const error = step.error ? ` error=${escapeMd(step.error)}` : "";
   return `${base}${selector}${healed}${value}${error}`;
 }
+function formatRetryAttempt(attempt) {
+  const base = `- attempt ${attempt.attempt}: ${attempt.status.toUpperCase()} (${attempt.durationMs}ms)`;
+  if (attempt.status === "pass") {
+    return base;
+  }
+  const step = attempt.failedStep ? ` failed-step=[${attempt.failedStep.index}] ${escapeMd(attempt.failedStep.type)}` : "";
+  const error = attempt.error ? ` error=${escapeMd(attempt.error)}` : "";
+  return `${base}${step}${error}`;
+}
 function formatAssertion(assertion) {
   const value = assertion.value !== void 0 ? ` value=${typeof assertion.value === "string" ? escapeMd(assertion.value) : assertion.value}` : "";
   const error = assertion.error ? ` error=${escapeMd(assertion.error)}` : "";
@@ -6615,6 +6728,16 @@ function writeSummary(runDir, result) {
   lines.push(`Target: ${result.targetUrl}`);
   lines.push(`Started: ${result.startedAt}`);
   lines.push(`Duration: ${result.durationMs}ms`);
+  if (result.retryHistory && result.retryHistory.length > 1) {
+    lines.push("");
+    lines.push("## Retries");
+    if (result.retrySummary) {
+      lines.push(escapeMd(result.retrySummary));
+    }
+    for (const attempt of result.retryHistory) {
+      lines.push(formatRetryAttempt(attempt));
+    }
+  }
   lines.push("");
   lines.push("## Steps");
   for (const step of result.steps) {
@@ -6775,7 +6898,8 @@ function isHistoryEntry(value) {
     return false;
   }
   const entry = value;
-  return typeof entry.hunt === "string" && (entry.status === "pass" || entry.status === "fail") && typeof entry.durationMs === "number" && Number.isFinite(entry.durationMs) && typeof entry.startedAt === "string" && (entry.runDir === void 0 || typeof entry.runDir === "string");
+  return typeof entry.hunt === "string" && (entry.status === "pass" || entry.status === "fail") && typeof entry.durationMs === "number" && Number.isFinite(entry.durationMs) && typeof entry.startedAt === "string" && (entry.runDir === void 0 || typeof entry.runDir === "string") && // Optional (PROWL-033): older history.json files predate `retries`.
+  (entry.retries === void 0 || typeof entry.retries === "number" && Number.isInteger(entry.retries) && entry.retries >= 0);
 }
 function readHistory(configDir) {
   const filePath = historyPath(configDir);
@@ -7027,6 +7151,60 @@ async function executeHuntAttempt(options, config, configDir, interpolatedHunt,
 function delay3(ms) {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
+function toRetryAttempt(attempt, result) {
+  const record = {
+    attempt,
+    status: result.status,
+    durationMs: result.durationMs
+  };
+  if (result.status === "fail") {
+    const failedIndex = result.steps.findIndex((step) => step.status === "fail");
+    if (failedIndex >= 0) {
+      const failed = result.steps[failedIndex];
+      record.failedStep = { index: failedIndex, type: failed.type };
+      if (failed.error) {
+        record.error = failed.error;
+      }
+    }
+    if (!record.error) {
+      const failedAssertion = result.assertions.find((assertion) => assertion.status === "fail");
+      if (failedAssertion?.error) {
+        record.error = failedAssertion.error;
+      }
+    }
+  }
+  return record;
+}
+function describeAttemptFailure(attempt) {
+  if (attempt.status !== "fail") {
+    return void 0;
+  }
+  const step = attempt.failedStep?.type;
+  if (step && attempt.error) {
+    return `${step} (${attempt.error})`;
+  }
+  return step ?? attempt.error;
+}
+function buildRetrySummary(attempts, maxRetries) {
+  const final = attempts[attempts.length - 1];
+  const firstFailure = describeAttemptFailure(attempts[0]);
+  const suffix = firstFailure ? ` \u2014 first failure: ${firstFailure}` : "";
+  if (final.status === "pass") {
+    return `Passed on attempt ${final.attempt} of ${maxRetries + 1}${suffix}`;
+  }
+  return `Failed after ${attempts.length} attempts${suffix}`;
+}
+function finalizeRetryOutcome(outcome, attempts, maxRetries, junit) {
+  outcome.result = writeReports(
+    outcome.runDir,
+    {
+      ...outcome.result,
+      retryHistory: attempts,
+      retrySummary: buildRetrySummary(attempts, maxRetries)
+    },
+    { junit }
+  );
+}
 async function runHunt(options) {
   const { config, configDir } = loadConfig(options.configPath);
   if (config.target.type === "macos") {
@@ -7056,7 +7234,9 @@ async function runHunt(options) {
   }
   const maxRetries = hunt.retry?.maxRetries ?? 0;
   const retryDelay = hunt.retry?.delay ?? 0;
+  const junit = options.junit ?? config.artifacts.junit;
   let lastResult;
+  const attempts = [];
   for (let attempt = 0; attempt <= maxRetries; attempt++) {
     if (attempt > 0 && retryDelay > 0) {
       await delay3(retryDelay);
@@ -7072,19 +7252,20 @@ async function runHunt(options) {
       targetUrl,
       allowedDomains
     );
+    attempts.push(toRetryAttempt(attempt + 1, lastResult.result));
     if (lastResult.result.status === "pass") {
-      if (attempt > 0) {
-        lastResult.result.artifacts.summary = `Passed on attempt ${attempt + 1} of ${maxRetries + 1}`;
+      if (attempts.length > 1) {
+        finalizeRetryOutcome(lastResult, attempts, maxRetries, junit);
       }
-      recordHistory(configDir, lastResult, config.history.maxRuns);
+      recordHistory(configDir, lastResult, config.history.maxRuns, attempts.length - 1);
       return lastResult;
     }
   }
-  if (maxRetries > 0 && lastResult) {
-    lastResult.result.artifacts.summary = `Failed after ${maxRetries + 1} attempts`;
-  }
   if (lastResult) {
-    recordHistory(configDir, lastResult, config.history.maxRuns);
+    if (attempts.length > 1) {
+      finalizeRetryOutcome(lastResult, attempts, maxRetries, junit);
+    }
+    recordHistory(configDir, lastResult, config.history.maxRuns, attempts.length - 1);
   }
   return lastResult;
 }
@@ -7288,7 +7469,9 @@ async function runNativeHunt(options, config, configDir, target, native) {
   }
   const maxRetries = hunt.retry?.maxRetries ?? 0;
   const retryDelay = hunt.retry?.delay ?? 0;
+  const junit = options.junit ?? config.artifacts.junit;
   let lastResult;
+  const attempts = [];
   for (let attempt = 0; attempt <= maxRetries; attempt++) {
     if (attempt > 0 && retryDelay > 0) {
       await delay3(retryDelay);
@@ -7303,23 +7486,24 @@ async function runNativeHunt(options, config, configDir, target, native) {
       randomVars,
       config.guardrails.allowedApps
     );
+    attempts.push(toRetryAttempt(attempt + 1, lastResult.result));
     if (lastResult.result.status === "pass") {
-      if (attempt > 0) {
-        lastResult.result.artifacts.summary = `Passed on attempt ${attempt + 1} of ${maxRetries + 1}`;
+      if (attempts.length > 1) {
+        finalizeRetryOutcome(lastResult, attempts, maxRetries, junit);
       }
-      recordHistory(configDir, lastResult, config.history.maxRuns);
+      recordHistory(configDir, lastResult, config.history.maxRuns, attempts.length - 1);
       return lastResult;
     }
   }
-  if (maxRetries > 0 && lastResult) {
-    lastResult.result.artifacts.summary = `Failed after ${maxRetries + 1} attempts`;
-  }
   if (lastResult) {
-    recordHistory(configDir, lastResult, config.history.maxRuns);
+    if (attempts.length > 1) {
+      finalizeRetryOutcome(lastResult, attempts, maxRetries, junit);
+    }
+    recordHistory(configDir, lastResult, config.history.maxRuns, attempts.length - 1);
   }
   return lastResult;
 }
-function recordHistory(configDir, outcome, maxRuns) {
+function recordHistory(configDir, outcome, maxRuns, retries = 0) {
   try {
     const relativeRunDir = import_node_path16.default.relative(configDir, outcome.runDir);
     appendEntry(
@@ -7329,7 +7513,9 @@ function recordHistory(configDir, outcome, maxRuns) {
         status: outcome.result.status,
         durationMs: outcome.result.durationMs,
         startedAt: outcome.result.startedAt,
-        runDir: relativeRunDir || void 0
+        runDir: relativeRunDir || void 0,
+        // Omit when no retry ran so entries stay additive/backward-compatible.
+        retries: retries > 0 ? retries : void 0
       },
       maxRuns
     );
@@ -8397,6 +8583,7 @@ var STEP_REFERENCE = `
 - waitForSelector: { selector: "#el", timeout: 5000 }
 - waitForUrl: { value: "/path", timeout: 5000 }
 - waitForNetworkIdle: { timeout: 5000 }
+- waitForResponse: { url: "**/api/orders", status: 200, timeout: 10000 } \u2014 wait for a matching network response (url is a glob/substring; status is optional)
 
 ### Interaction
 - click: "Button Text" \u2014 click by text (tries role=button first)