@flowriki/agent 0.1.0-beta.2 → 0.1.0-beta.4

package/dist/{chunk-EYRGRDNB.js → chunk-7JLRYAQ2.js}

@@ -1,7 +1,9 @@
 #!/usr/bin/env node
 
 // src/engine.ts
-import os4 from "os";
+import os5 from "os";
+import { createRequire as createRequire4 } from "module";
+import { spawnSync } from "child_process";
 
 // ../agent-core/dist/index.js
 import { z as z4 } from "zod";
@@ -11,13 +13,14 @@ import crypto22 from "crypto";
 import { createRequire as createRequire3 } from "module";
 import { WebSocket, WebSocketServer } from "ws";
 import fs23 from "fs";
+import os2 from "os";
 import path23 from "path";
 
 // ../orchestrator/dist/index.js
 import fs4 from "fs";
 import path3 from "path";
 
-// ../protocol/dist/chunk-CS3GWM4N.js
+// ../protocol/dist/chunk-ROEX7TWK.js
 import { z } from "zod";
 var LocatorOverrideSchema = z.object({
   strategy: z.enum(["css", "xpath", "id", "testId", "text", "label", "placeholder", "altText", "title"]),
@@ -249,6 +252,9 @@ var RecordedStepSchema = RecordedTargetSchema.extend({
    * stays unresolved and is reported, never invented. */
   secretRef: z.string().regex(SECRET_REF_PATTERN).optional()
 }).strict();
+function slugify(name) {
+  return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
+}
 var CURRENT_SCHEMA_VERSION = 5;
 var FlowDocumentSchema = z.object({
   schemaVersion: z.literal(CURRENT_SCHEMA_VERSION),
@@ -572,6 +578,7 @@ var ProjectMarkerSchema = z3.object({
   /** `v1:ed25519:<base64url>` */
   signature: z3.string()
 });
+var PRODUCTION_SERVICE = "https://flowriki-cloud.onrender.com";
 
 // ../core/dist/index.js
 function proposeAssertions(before, after) {
@@ -4200,9 +4207,6 @@ function clampRepeat(value) {
   if (!Number.isFinite(n) || n < 2) return DEFAULT_FLAKINESS_REPEAT;
   return Math.min(n, MAX_FLAKINESS_REPEAT);
 }
-function slugify(name) {
-  return name.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
-}
 function uniqueRef(flowSlug, name, taken) {
   const base = `${flowSlug}_${slugify(name) || "secret"}`;
   if (!taken.has(base)) {
@@ -5427,6 +5431,20 @@ function ensureRootCommit(root) {
   git2(root, ["commit", "--allow-empty", "-m", "Initialise repository"]);
   return git2(root, ["rev-list", "--max-parents=0", "HEAD"]).split("\n").pop();
 }
+function deliveredRun(delivered) {
+  const { flow, secrets, config } = delivered;
+  return {
+    readConfig: () => config,
+    // By id, and only the one that was sent. A machine serving no checkout has
+    // no other flow to confuse it with.
+    getFlow: (id) => id === flow.id ? flow : null,
+    readSecrets: () => secrets,
+    baseUrlFor: (f) => f.baseUrl ?? config.baseUrl ?? "",
+    environmentFor: (f) => ({ ...config.environment, ...f.environment ?? {} }),
+    // See RunSource.resolveFile: there is no project directory here.
+    resolveFile: () => void 0
+  };
+}
 
 // ../agent-core/dist/index.js
 var PROTOCOL_VERSION = 1;
@@ -5833,7 +5851,9 @@ var Agent = class {
         `this agent speaks protocol ${PROTOCOL_VERSION}; the command is version ${command.v}`
       );
     }
-    const project = this.opts.projects.find((p) => p.id === command.projectId);
+    const delivered = command.args["flow"];
+    const produces = command.name.startsWith("record.") || command.name === "run.cancel";
+    const project = this.opts.projects.find((p) => p.id === command.projectId) ?? (delivered || produces ? { id: command.projectId, name: String(delivered?.name ?? command.projectId), root: "" } : void 0);
     if (!project) {
       return this.refuse(
         command.id,
@@ -6043,16 +6063,39 @@ var AgentLink = class {
     }
   }
 };
+var HEARTBEAT_MS = 3e4;
 function adapt(socket) {
   let closed = false;
   const closeHandlers = [];
   const fire = () => {
     if (closed) return;
     closed = true;
+    clearInterval(heartbeat);
     for (const handler of closeHandlers) handler();
   };
   socket.on("close", fire);
   socket.on("error", fire);
+  let answered = true;
+  socket.on("pong", () => {
+    answered = true;
+  });
+  const heartbeat = setInterval(() => {
+    if (!answered) {
+      try {
+        socket.terminate();
+      } catch {
+      }
+      fire();
+      return;
+    }
+    answered = false;
+    try {
+      socket.ping();
+    } catch {
+      fire();
+    }
+  }, HEARTBEAT_MS);
+  heartbeat.unref?.();
   return {
     send: (data) => {
       if (socket.readyState !== WebSocket.OPEN) return;
@@ -6104,6 +6147,15 @@ function dialWebSocket(opts) {
     socket.once("error", failed);
   });
 }
+var scratchRoots = /* @__PURE__ */ new Map();
+function scratchRoot(projectId) {
+  let root = scratchRoots.get(projectId);
+  if (!root) {
+    root = fs23.mkdtempSync(path23.join(os2.tmpdir(), `flowriki-record-${projectId.replace(/[^\w-]/g, "")}-`));
+    scratchRoots.set(projectId, root);
+  }
+  return root;
+}
 function buildHandlers(deps) {
   const { storeFor, storage = null, onActivity, lease, recorder } = deps;
   const debugging = deps.debugger;
@@ -6389,14 +6441,22 @@ function buildHandlers(deps) {
       if (command.flowRevision === void 0) {
         return { ok: false, reason: "stale_revision", detail: "reload the flow and supply its revision before running" };
       }
-      const store = storeFor(project.root);
       const flowId = String(command.args["flowId"] ?? "");
-      const flow = store.getFlow(flowId);
+      const carried = command.args["flow"];
+      const source = carried ? deliveredRun({
+        flow: carried,
+        secrets: command.args["secrets"] ?? {},
+        config: command.args["config"] ?? {}
+      }) : storeFor(project.root);
+      if (!carried && !project.root) {
+        return { ok: false, reason: "failed", detail: "this machine has no checkout of that project" };
+      }
+      const flow = source.getFlow(flowId);
       if (!flow) return { ok: false, reason: "failed", detail: `no flow ${flowId} in this project` };
       if (flow.revision !== command.flowRevision) {
         return { ok: false, reason: "stale_revision", detail: "the flow changed \u2014 reload it before running" };
       }
-      const missing = store.unresolvedSecrets(flow);
+      const missing = carried ? [] : storeFor(project.root).unresolvedSecrets(flow);
       if (missing.length) {
         return {
           ok: false,
@@ -6418,7 +6478,7 @@ function buildHandlers(deps) {
           signal: aborter.signal,
           ...typeof command.args["headless"] === "boolean" ? { headless: command.args["headless"] } : {},
           ...command.args["repeat"] ? { repeat: Number(command.args["repeat"]) } : {},
-          store,
+          store: source,
           storage,
           flowId,
           expectedRevision: command.flowRevision,
@@ -6473,14 +6533,28 @@ function buildHandlers(deps) {
         const url = optional("url");
         const route = optional("path");
         const recordedBy = optional("recordedBy");
+        const headless = typeof command.args["headless"] === "boolean" ? command.args["headless"] : void 0;
+        const root = project.root || scratchRoot(project.id);
+        if (!project.root) {
+          if (!/^f_[a-z0-9]+(?:-[a-z0-9]+)*$/.test(featureId)) throw new Error("Invalid feature ID");
+          const workspace = new Store(root);
+          if (!workspace.listFeatures().some((feature) => feature.id === featureId)) workspace.createFeature(featureId.slice(2));
+        }
         const started = await recorder.start({
-          root: project.root,
+          // A SCRATCH DIRECTORY when this machine has no checkout of the
+          // project. The recorder writes as it goes — that is what makes a
+          // half-finished recording survivable — and the flow it produces is
+          // returned on stop for the service to commit to the repository. A
+          // machine that has the project checked out still records into it.
+          root,
+          projectId: project.id,
           featureId,
           name,
           ...url ? { url } : {},
           ...route ? { path: route } : {},
           ...recordedBy ? { recordedBy } : {},
-          ...command.args["environment"] ? { environment: command.args["environment"] } : {}
+          ...command.args["environment"] ? { environment: command.args["environment"] } : {},
+          ...headless === void 0 ? {} : { headless }
         });
         lease?.activate("run");
         onActivity?.({ kind: "recording", projectId: project.id, detail: name });
@@ -6495,7 +6569,7 @@ function buildHandlers(deps) {
     "record.stop": async (_command, project) => {
       if (!recorder) return { ok: false, reason: "failed", detail: "this agent cannot record \u2014 no browser is configured" };
       try {
-        const saved = await recorder.stop();
+        const saved = await recorder.stop(project.id);
         if (!saved.ok) return { ok: false, reason: "failed", detail: saved.error };
         return { ok: true, result: { flow: saved.flow, projectId: project.id } };
       } finally {
@@ -6572,12 +6646,15 @@ function createAgentRuntime(options) {
   let journal = null;
   const coordinators = /* @__PURE__ */ new Map();
   let recordingIn = null;
+  let recordingProject = null;
+  let lastRecording = null;
   const coordinatorFor = (projectRoot) => {
     let existing = coordinators.get(projectRoot);
     if (!existing) {
       existing = new RecordingCoordinator({
         store: new Store(projectRoot),
         emit: (event) => {
+          if (event.type === "recording.stopped") lastRecording = { ok: true, flow: event.flow };
           journal?.append({ name: `recording.${event.type.replace(/^recording\./, "")}`, data: event });
         }
       });
@@ -6636,13 +6713,17 @@ function createAgentRuntime(options) {
       const coordinator = coordinatorFor(opts.root);
       const { root: _root, ...rest } = opts;
       const started = await coordinator.start(rest);
+      recordingProject = opts["projectId"];
+      lastRecording = null;
       recordingIn = coordinator;
       return started;
     },
-    stop: async () => {
-      if (!recordingIn) return { ok: false, error: "no recording is in progress on this machine" };
+    stop: async (projectId) => {
+      if (projectId && recordingProject && projectId !== recordingProject) return { ok: false, error: "This recording belongs to another project" };
+      if (lastRecording?.ok) return lastRecording;
+      if (!recordingIn) return lastRecording ?? { ok: false, error: "no recording is in progress on this machine" };
       const result = await recordingIn.stop();
-      recordingIn = null;
+      lastRecording = result;
       return result;
     },
     discard: async () => {
@@ -6708,20 +6789,20 @@ import fs7 from "fs";
 
 // src/paths.ts
 import fs6 from "fs";
-import os2 from "os";
+import os3 from "os";
 import path5 from "path";
 function dataDir(env = process.env) {
   const override = env["FLOWRIKI_HOME"]?.trim();
   if (override) return path5.resolve(override);
   if (process.platform === "win32") {
     const appData = env["APPDATA"]?.trim();
-    return appData ? path5.join(appData, "Flowriki") : path5.join(os2.homedir(), "AppData", "Roaming", "Flowriki");
+    return appData ? path5.join(appData, "Flowriki") : path5.join(os3.homedir(), "AppData", "Roaming", "Flowriki");
   }
   if (process.platform === "darwin") {
-    return path5.join(os2.homedir(), "Library", "Application Support", "Flowriki");
+    return path5.join(os3.homedir(), "Library", "Application Support", "Flowriki");
   }
   const state = env["XDG_STATE_HOME"]?.trim();
-  return state ? path5.join(state, "flowriki") : path5.join(os2.homedir(), ".local", "state", "flowriki");
+  return state ? path5.join(state, "flowriki") : path5.join(os3.homedir(), ".local", "state", "flowriki");
 }
 function ensureDataDir(env = process.env) {
   const dir = dataDir(env);
@@ -6788,7 +6869,6 @@ function forgetConnection(service, env = process.env) {
 var fingerprint = (secret) => crypto3.createHash("sha256").update(secret).digest("hex").slice(0, 12);
 
 // src/service.ts
-var PRODUCTION_SERVICE = "https://flowriki-cloud.onrender.com";
 var BadServiceUrl = class extends Error {
 };
 function resolveService(explicit, env = process.env) {
@@ -6811,11 +6891,11 @@ function resolveService(explicit, env = process.env) {
 
 // src/lock.ts
 import fs8 from "fs";
-import os3 from "os";
+import os4 from "os";
 function takeLock(env = process.env) {
   ensureDataDir(env);
   const file = lockPath(env);
-  const mine = { pid: process.pid, since: (/* @__PURE__ */ new Date()).toISOString(), host: os3.hostname() };
+  const mine = { pid: process.pid, since: (/* @__PURE__ */ new Date()).toISOString(), host: os4.hostname() };
   for (let attempt = 0; attempt < 2; attempt += 1) {
     try {
       fs8.writeFileSync(file, JSON.stringify(mine), { flag: "wx", mode: 384 });
@@ -6891,7 +6971,7 @@ function openBrowser(url, env = process.env) {
 }
 
 // src/engine.ts
-var AGENT_VERSION = "0.1.0-beta.2";
+var AGENT_VERSION = "0.1.0-beta.4";
 async function connect(options = {}) {
   let service;
   try {
@@ -6908,7 +6988,7 @@ async function connect(options = {}) {
       message: "the stored connection is no longer accepted \u2014 asking for a new one"
     });
   }
-  const machineName = options.machineName?.trim() || `${os4.userInfo().username}@${os4.hostname()}`;
+  const machineName = options.machineName?.trim() || `${os5.userInfo().username}@${os5.hostname()}`;
   let asked;
   try {
     const res = await fetch(`${service}/api/pairing-requests`, {
@@ -7015,6 +7095,13 @@ async function start(options = {}) {
       message: `this installation is not connected to ${service} yet`
     };
   }
+  if (!browsersReady()) {
+    options.onStatus?.("preparing", "downloading the browser Flowriki records with \u2014 this happens once");
+    const prepared = await prepareBrowsers();
+    if (!prepared.ok) {
+      return { ok: false, reason: "refused", message: `this machine cannot record yet \u2014 ${prepared.message}` };
+    }
+  }
   const lock = takeLock();
   if (!lock.ok) {
     return {
@@ -7061,6 +7148,36 @@ async function start(options = {}) {
     }
   };
 }
+async function prepareBrowsers() {
+  if (browsersReady()) {
+    return { ok: true, already: true, message: "chromium is already installed" };
+  }
+  let cli;
+  try {
+    cli = createRequire4(import.meta.url).resolve("playwright/cli.js");
+  } catch {
+    return {
+      ok: false,
+      already: false,
+      message: "playwright is not installed beside this agent \u2014 reinstall it"
+    };
+  }
+  const run = spawnSync(process.execPath, [cli, "install", "chromium"], { stdio: "inherit" });
+  if (run.status !== 0) {
+    return {
+      ok: false,
+      already: false,
+      message: `could not install chromium (exit ${run.status ?? "unknown"}) \u2014 try \`npx playwright@${playwrightVersion() ?? "latest"} install chromium\` yourself`
+    };
+  }
+  return { ok: browsersReady(), already: false, message: "chromium installed" };
+}
+function browsersReady() {
+  return inspectPlaywright().chromiumInstalled === true;
+}
+function playwrightVersion() {
+  return inspectPlaywright().version;
+}
 function status(serviceArg) {
   const service = resolveService(serviceArg);
   const connection = connectionFor(service);
@@ -7122,7 +7239,7 @@ async function doctor(serviceArg) {
 }
 function inspectPlaywright() {
   try {
-    const browsersPath = process.env["PLAYWRIGHT_BROWSERS_PATH"] ?? (process.platform === "win32" ? path6.join(os4.homedir(), "AppData", "Local", "ms-playwright") : process.platform === "darwin" ? path6.join(os4.homedir(), "Library", "Caches", "ms-playwright") : path6.join(os4.homedir(), ".cache", "ms-playwright"));
+    const browsersPath = process.env["PLAYWRIGHT_BROWSERS_PATH"] ?? (process.platform === "win32" ? path6.join(os5.homedir(), "AppData", "Local", "ms-playwright") : process.platform === "darwin" ? path6.join(os5.homedir(), "Library", "Caches", "ms-playwright") : path6.join(os5.homedir(), ".cache", "ms-playwright"));
     const chromiumInstalled = fs9.existsSync(browsersPath) ? fs9.readdirSync(browsersPath).some((d) => d.startsWith("chromium")) : false;
     return { version: null, browsersPath, chromiumInstalled };
   } catch {
@@ -7140,6 +7257,8 @@ export {
   connect,
   resolveCheckouts,
   start,
+  prepareBrowsers,
+  browsersReady,
   status,
   doctor,
   disconnect

package/dist/cli.js

@@ -4,10 +4,11 @@ import {
   connect,
   disconnect,
   doctor,
+  prepareBrowsers,
   resolveCheckouts,
   start,
   status
-} from "./chunk-EYRGRDNB.js";
+} from "./chunk-7JLRYAQ2.js";
 
 // src/cli.ts
 import { parseArgs } from "util";
@@ -27,6 +28,7 @@ ${bold("USAGE")}
   flowriki-agent start              run the agent (stays in the foreground)
   flowriki-agent status             is it connected, and what is prepared
   flowriki-agent doctor             diagnose setup problems
+  flowriki-agent prepare            download the browser recording needs
   flowriki-agent disconnect         forget this computer's credential
 
 ${bold("OPTIONS")}
@@ -129,8 +131,7 @@ Run \`flowriki-agent --help\`.`);
       console.log(`${bold("Flowriki agent")} ${dim(AGENT_VERSION)}`);
       console.log(dim(`  connected as ${started.connection.machineName}`));
       if (started.projects.length === 0) {
-        console.log(yellow("  no projects prepared \u2014 this machine is online and idle"));
-        console.log(dim("  Add one:  flowriki-agent start --project /path/to/a/checkout"));
+        console.log(dim("  ready \u2014 this machine records and runs whatever the dashboard asks for"));
       }
       for (const project of started.projects) {
         console.log(dim(`  project  ${project.name}  (${project.root})`));
@@ -150,6 +151,11 @@ Run \`flowriki-agent --help\`.`);
       return await new Promise(() => {
       });
     }
+    case "prepare": {
+      const result = await prepareBrowsers();
+      console.log(result.ok ? green(result.message) : red(result.message));
+      return result.ok ? 0 : 1;
+    }
     case "status": {
       const state = status(service);
       if (values.json) {

package/dist/engine.js

@@ -1,18 +1,22 @@
 #!/usr/bin/env node
 import {
   AGENT_VERSION,
+  browsersReady,
   connect,
   disconnect,
   doctor,
+  prepareBrowsers,
   resolveCheckouts,
   start,
   status
-} from "./chunk-EYRGRDNB.js";
+} from "./chunk-7JLRYAQ2.js";
 export {
   AGENT_VERSION,
+  browsersReady,
   connect,
   disconnect,
   doctor,
+  prepareBrowsers,
   resolveCheckouts,
   start,
   status

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowriki/agent",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.4",
   "description": "Run Flowriki UI tests on your own computer. Connects this machine to your Flowriki account.",
   "license": "SEE LICENSE IN LICENSE",
   "type": "module",