@alumnium/test 0.24.1 → 0.25.0-alpha.1

package/src/index.js

@@ -500,6 +500,12 @@ class ToolCallMasker {
       return [];
     }
     const json = parseJsonStructure(text);
+    if (!json && options.secretsOnly) {
+      logger4.debug(
+        `Failed tool call ${callId} output is not JSON, ignoring it`,
+      );
+      return [];
+    }
     if (!json) {
       logger4.info(
         `Tool call ${callId} output is not a JSON object or array, ignoring it for masking. ` +
@@ -720,10 +726,418 @@ class Masker {
     );
   }
 }
+// test/src/player/BashExecutor.ts
+import { spawn } from "node:child_process";
+import z2 from "zod";
+import { Telemetry as Telemetry5 } from "@alumnium/core/internal";
+var { logger: logger5 } = Telemetry5.get(
+  "packages/typescript/test/src/player/BashExecutor.ts",
+);
+var BASH_TOOL = "Bash";
+var DEFAULT_TIMEOUT_MS = 120000;
+var BashInput = z2.object({
+  command: z2.string(),
+  timeout: z2.number().positive().optional(),
+});
+
+class BashExecutor {
+  #props;
+  constructor(props) {
+    this.#props = props;
+  }
+  handles(call) {
+    return !call.server && call.tool === BASH_TOOL;
+  }
+  async execute(call) {
+    const { command, timeout } = BashInput.parse(call.input);
+    if (!this.#allows(command))
+      throw new Error(`Command is not allowed to replay: ${command}`);
+    logger5.debug(`Running command: ${command}`);
+    const { code, stdout, stderr } = await this.#run(command, {
+      cwd: this.#props.cwd,
+      env: { ...process.env, ...this.#props.env },
+      timeoutMs: timeout ?? this.#props.timeoutMs ?? DEFAULT_TIMEOUT_MS,
+    });
+    if (code === 0) return { content: stdout, isError: false };
+    return {
+      content: [stdout, stderr, `Exit code ${code}`].filter(Boolean).join(`
+`),
+      isError: true,
+    };
+  }
+  #allows(command) {
+    return this.#props.allow.some((allowed) =>
+      typeof allowed === "string"
+        ? command.startsWith(allowed)
+        : allowed.test(command),
+    );
+  }
+  #run(command, options) {
+    return new Promise((resolve, reject) => {
+      const child = spawn("bash", ["-c", command], {
+        cwd: options.cwd,
+        env: options.env,
+        timeout: options.timeoutMs,
+        stdio: ["ignore", "pipe", "pipe"],
+      });
+      let stdout = "";
+      let stderr = "";
+      child.stdout.setEncoding("utf8").on("data", (data) => (stdout += data));
+      child.stderr.setEncoding("utf8").on("data", (data) => (stderr += data));
+      child.on("error", reject);
+      child.on("close", (code) => resolve({ code, stdout, stderr }));
+    });
+  }
+}
+// test/src/player/McpExecutor.ts
+import { Client } from "@modelcontextprotocol/sdk/client/index.js";
+import { StdioClientTransport } from "@modelcontextprotocol/sdk/client/stdio.js";
+import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
+import {
+  ALUMNIUM_CORE_VERSION,
+  Telemetry as Telemetry6,
+} from "@alumnium/core/internal";
+var { logger: logger6 } = Telemetry6.get(
+  "packages/typescript/test/src/player/McpExecutor.ts",
+);
+var DEFAULT_RETRIES = 2;
+var DEFAULT_RETRY_DELAY_MS = 1000;
+
+class McpExecutor {
+  #servers;
+  #retries;
+  #retryDelayMs;
+  #clients = new Map();
+  constructor(props) {
+    this.#servers = props.servers;
+    this.#retries = props.retries ?? DEFAULT_RETRIES;
+    this.#retryDelayMs = props.retryDelayMs ?? DEFAULT_RETRY_DELAY_MS;
+  }
+  handles(call) {
+    return Boolean(call.server && call.server in this.#servers);
+  }
+  async execute(call, options = {}) {
+    const toolKey = Recording.toolKey(call);
+    const client = await this.#client(call.server);
+    for (let attempt = 0; ; attempt++) {
+      const canRetry = attempt < this.#retries;
+      const delayMs = this.#retryDelayMs * 2 ** attempt;
+      try {
+        const result = await client.callTool({
+          name: call.tool,
+          arguments: call.input,
+          ...(options.meta ? { _meta: options.meta } : {}),
+        });
+        const toolResult = {
+          content: result.content ?? [],
+          isError: Boolean(result.isError),
+        };
+        if (!toolResult.isError || !canRetry) return toolResult;
+        logger6.warn(`Tool '${toolKey}' reported an error, retrying`);
+      } catch (error) {
+        if (!canRetry) throw error;
+        logger6.warn(`Tool '${toolKey}' failed, retrying: {error}`, { error });
+      }
+      await new Promise((resolve) => setTimeout(resolve, delayMs));
+    }
+  }
+  async close() {
+    const clients = [...this.#clients];
+    this.#clients.clear();
+    await Promise.all(
+      clients.map(async ([name, client]) => {
+        if (this.#servers[name]?.type === "client") return;
+        try {
+          await (await client).close();
+        } catch (error) {
+          logger6.warn(`Failed to close MCP server '${name}': {error}`, {
+            error,
+          });
+        }
+      }),
+    );
+  }
+  #client(name) {
+    let client = this.#clients.get(name);
+    if (!client) {
+      client = this.#connect(name);
+      client.catch(() => this.#clients.delete(name));
+      this.#clients.set(name, client);
+    }
+    return client;
+  }
+  async #connect(name) {
+    const server = this.#servers[name];
+    if (!server) throw new Error(`Unknown MCP server '${name}'`);
+    if (server.type === "client") return server.client;
+    logger6.debug(`Connecting to MCP server '${name}'`);
+    const transport =
+      server.type === "http"
+        ? new StreamableHTTPClientTransport(new URL(server.url), {
+            requestInit: { headers: server.headers ?? {} },
+          })
+        : new StdioClientTransport({
+            command: server.command,
+            args: server.args ?? [],
+            env: { ...this.#definedEnv(), ...server.env },
+            ...(server.cwd ? { cwd: server.cwd } : {}),
+            stderr: "inherit",
+          });
+    const client = new Client({
+      name: "alumnium-test-player",
+      version: ALUMNIUM_CORE_VERSION,
+    });
+    await client.connect(transport);
+    return client;
+  }
+  #definedEnv() {
+    return Object.fromEntries(
+      Object.entries(process.env).filter((entry) => entry[1] !== undefined),
+    );
+  }
+}
+// test/src/player/Player.ts
+import z3 from "zod";
+import { Env as Env2, Telemetry as Telemetry7 } from "@alumnium/core/internal";
+
+// test/src/masker/alumniumMaskerProps.ts
+var DEFAULT_ALUMNIUM_SERVER = "alumnium";
+var ALUMNIUM_START_TOOL = "start";
+function alumniumMaskerProps(props, server = DEFAULT_ALUMNIUM_SERVER) {
+  return {
+    ...props,
+    registerResponsePaths: {
+      ...alumniumRegisterResponsePaths(server),
+      ...props.registerResponsePaths,
+    },
+    wholeValueOnlyTools: [`${server}/*`, ...(props.wholeValueOnlyTools ?? [])],
+  };
+}
+function alumniumRegisterResponsePaths(server) {
+  return {
+    [`${server}/*`]: [],
+    [`${server}/${ALUMNIUM_START_TOOL}`]: ["id"],
+  };
+}
+
+// test/src/player/Player.ts
+var { logger: logger7 } = Telemetry7.get(
+  "packages/typescript/test/src/player/Player.ts",
+);
+var START_TOOL = "start";
+var STOP_TOOL = "stop";
+var CHECK_TOOL = "check";
+var NO_CACHE_META = { "alumnium.ai/cache": false };
+var NO_CHANGE_ANALYSIS_META = { "alumnium.ai/change-analysis": false };
+var DEFAULT_SKIP_TOOLS = ["ToolSearch", "TodoWrite"];
+var DriverOutput = z3.object({ id: z3.string() });
+var CheckOutput = z3.object({ result: z3.enum(["success", "failure"]) });
+
+class Player {
+  #options;
+  #maskerProps;
+  constructor(props) {
+    const {
+      executor,
+      alumniumServer = DEFAULT_ALUMNIUM_SERVER,
+      skipTools = DEFAULT_SKIP_TOOLS,
+      checkConfirmations,
+      observer = {},
+      ...maskerProps
+    } = props;
+    this.#options = {
+      executor,
+      server: alumniumServer,
+      skipTools: new Set(skipTools),
+      checkConfirmations,
+      observer,
+    };
+    this.#maskerProps = alumniumMaskerProps(maskerProps, alumniumServer);
+  }
+  async play(recording) {
+    const run = new PlayerRun(this.#options, new Masker(this.#maskerProps));
+    try {
+      return await run.play(recording);
+    } finally {
+      await run.stopDrivers();
+    }
+  }
+}
+
+class Diverged extends Error {}
+
+class PlayerRun {
+  #options;
+  #masker;
+  #driverIds = new Set();
+  constructor(options, masker) {
+    this.#options = options;
+    this.#masker = masker;
+  }
+  get #observer() {
+    return this.#options.observer;
+  }
+  async play(recording) {
+    const stepsCount = Recording.executableStepsCount(recording);
+    let stepNumber = 0;
+    for (const [stepIndex, step] of recording.steps.entries()) {
+      if (step.kind === "narration") {
+        this.#observer.onNarration?.(step);
+        continue;
+      }
+      logger7.info(`Replaying step ${++stepNumber}/${stepsCount}`);
+      try {
+        await this.#playToolStep(step);
+      } catch (error) {
+        const message = error instanceof Diverged ? error.message : `${error}`;
+        logger7.error(`Replay diverged at step ${stepNumber}: ${message}`);
+        return { status: "diverged", error: message, stepIndex };
+      }
+    }
+    logger7.info(`Replayed all ${stepsCount} steps`);
+    return { status: "replayed", verdict: recording.verdict };
+  }
+  async stopDrivers() {
+    for (const id of this.#driverIds) {
+      try {
+        logger7.info(`Stopping driver ${id} the replay did not stop`);
+        await this.#options.executor.execute({
+          server: this.#options.server,
+          tool: STOP_TOOL,
+          input: { id, save_cache: false },
+        });
+      } catch (error) {
+        logger7.warn(`Failed to stop driver ${id}: {error}`, { error });
+      }
+    }
+    this.#driverIds.clear();
+  }
+  async #playToolStep(step) {
+    const { call: recordedCall, result: recordedResult } = step;
+    const { id, ...callProps } = recordedCall;
+    const toolKey = Recording.toolKey(recordedCall);
+    if (recordedResult.isError)
+      return this.#skip(recordedCall, "it failed when recorded");
+    if (!this.#options.executor.handles(callProps)) {
+      if (this.#options.skipTools.has(toolKey))
+        return this.#skip(recordedCall, "it only exists inside the agent");
+      throw new Diverged(`No executor for tool '${toolKey}'`);
+    }
+    const call = {
+      ...callProps,
+      input: this.#masker.unmaskInput(toolKey, recordedCall.input),
+    };
+    const unresolved = Masker.findUnresolvedMasks(call.input);
+    if (unresolved.length)
+      throw new Diverged(
+        `Tool '${toolKey}' input has unresolved masks: ${unresolved.join(", ")}`,
+      );
+    const result = await this.#execute(
+      call,
+      call.server === this.#options.server && call.tool === START_TOOL
+        ? { meta: NO_CHANGE_ANALYSIS_META }
+        : undefined,
+    );
+    if (result.isError)
+      throw new Diverged(
+        `Tool '${toolKey}' failed: ${contentTexts(result.content).join(`
+`)}`,
+      );
+    this.#masker.registerOutput(id, result.content, toolKey);
+    if (call.server !== this.#options.server) return;
+    switch (call.tool) {
+      case START_TOOL: {
+        const driverId = this.#parseOutput(result.content, DriverOutput)?.id;
+        if (driverId) this.#driverIds.add(driverId);
+        break;
+      }
+      case STOP_TOOL: {
+        const driverId = DriverOutput.safeParse(call.input).data?.id;
+        if (driverId) this.#driverIds.delete(driverId);
+        break;
+      }
+      case CHECK_TOOL:
+        await this.#compareCheck(call, recordedResult, result);
+        break;
+    }
+  }
+  async #execute(call, options) {
+    this.#observer.onToolCall?.(call);
+    const result = await this.#options.executor.execute(call, options);
+    this.#observer.onToolResult?.(call, result);
+    return result;
+  }
+  #skip(call, reason) {
+    logger7.info(`Skipping tool '${Recording.toolKey(call)}', ${reason}`);
+    this.#observer.onToolSkipped?.(call, reason);
+  }
+  async #compareCheck(call, recorded, replayed) {
+    const confirmations =
+      this.#options.checkConfirmations ?? Env2.ALUMNIUM_CHECK_CONFIRMATIONS;
+    const expected = this.#checkVerdict(recorded);
+    let actual = this.#checkVerdict(replayed);
+    let outcome;
+    if (!expected || !actual) {
+      throw new Diverged(
+        `Cannot read '${Recording.toolKey(call)}' verdict to compare`,
+      );
+    } else if (expected === actual) {
+      outcome = "agreed";
+    } else if (expected === "failure") {
+      outcome = "improved";
+    } else {
+      let attempt = 0;
+      while (actual !== expected && attempt++ < confirmations) {
+        logger7.info(`Re-asking check ${attempt}/${confirmations}`);
+        const result = await this.#execute(call, { meta: NO_CACHE_META });
+        actual = result.isError ? null : this.#checkVerdict(result);
+      }
+      outcome = actual === expected ? "unstable" : "disagreed";
+    }
+    this.#observer.onCheck?.(call, outcome);
+    if (outcome === "disagreed")
+      throw new Diverged(
+        `Check '${call.input["statement"]}' failed where it passed when recorded` +
+          (confirmations
+            ? `, re-asked ${confirmations} times with the cache bypassed`
+            : ""),
+      );
+  }
+  #checkVerdict(result) {
+    return this.#parseOutput(result.content, CheckOutput)?.result ?? null;
+  }
+  #parseOutput(content, schema) {
+    for (const text of contentTexts(content)) {
+      const parsed = schema.safeParse(parseJson(text));
+      if (parsed.success) return parsed.data;
+    }
+    return null;
+  }
+}
+// test/src/player/ToolExecutor.ts
+function composeExecutors(...executors) {
+  const find = (call) => executors.find((executor) => executor.handles(call));
+  return {
+    handles: (call) => Boolean(find(call)),
+    async execute(call, options) {
+      const executor = find(call);
+      if (!executor)
+        throw new Error(
+          `No executor handles tool '${Recording.toolKey(call)}'`,
+        );
+      return executor.execute(call, options);
+    },
+    async close() {
+      await Promise.all(
+        executors.map(async (executor) => await executor.close?.()),
+      );
+    },
+  };
+}
 // test/src/Recorder.ts
 import {
-  ALUMNIUM_VERSION,
-  Telemetry as Telemetry5,
+  ALUMNIUM_CORE_VERSION as ALUMNIUM_CORE_VERSION2,
+  Telemetry as Telemetry8,
 } from "@alumnium/core/internal";
 
 // test/src/RecordingLeakError.ts
@@ -740,11 +1154,9 @@ class RecordingLeakError extends Error {
 }
 
 // test/src/Recorder.ts
-var { logger: logger5 } = Telemetry5.get(
+var { logger: logger8 } = Telemetry8.get(
   "packages/typescript/test/src/Recorder.ts",
 );
-var DEFAULT_ALUMNIUM_SERVER = "alumnium";
-var ALUMNIUM_START_TOOL = "start";
 
 class Recorder {
   #text;
@@ -759,24 +1171,13 @@ class Recorder {
     this.#version = version ?? Recording.DEFAULT_VERSION;
     this.#text = text;
     this.#agent = agent;
-    const server = alumniumServer ?? DEFAULT_ALUMNIUM_SERVER;
-    this.#masker = new Masker({
-      ...maskerProps,
-      registerResponsePaths: {
-        ...this.#alumniumRegisterResponsePaths(server),
-        ...maskerProps.registerResponsePaths,
-      },
-      wholeValueOnlyTools: [
-        `${server}/*`,
-        ...(maskerProps.wholeValueOnlyTools ?? []),
-      ],
-    });
+    this.#masker = new Masker(alumniumMaskerProps(maskerProps, alumniumServer));
   }
   onToolUse(use) {
     this.#assertNotFinished();
     const { id, server, tool, input } = use;
     const toolKey = Recording.toolKey({ server, tool });
-    logger5.debug(`Recording tool use '${toolKey}' ({id})`, { id });
+    logger8.debug(`Recording tool use '${toolKey}' ({id})`, { id });
     this.#pendingCalls.set(id, {
       id,
       ...(server ? { server } : {}),
@@ -790,11 +1191,11 @@ class Recorder {
     const isError = Boolean(toolResult.isError);
     const call = this.#pendingCalls.get(id);
     if (!call) {
-      logger5.debug(`No recorded tool use for result '${id}', ignoring it`);
+      logger8.debug(`No recorded tool use for result '${id}', ignoring it`);
       return;
     }
     this.#pendingCalls.delete(id);
-    logger5.debug(`Recording '${call.tool}' tool result`);
+    logger8.debug(`Recording '${call.tool}' tool result`);
     this.#masker.registerOutput(id, content, Recording.toolKey(call), {
       secretsOnly: isError,
     });
@@ -816,7 +1217,7 @@ class Recorder {
   finish(verdict) {
     this.#assertNotFinished();
     if (this.#pendingCalls.size)
-      logger5.warn(
+      logger8.warn(
         `Dropping ${this.#pendingCalls.size} tool calls with no result: ${[
           ...this.#pendingCalls.values(),
         ]
@@ -829,7 +1230,7 @@ class Recorder {
       version: this.#version,
       text: this.#text,
       agent: this.#agent,
-      alumnium: { version: ALUMNIUM_VERSION },
+      alumnium: { version: ALUMNIUM_CORE_VERSION2 },
       hostVars: [],
       steps: this.#steps.map((step) => this.#maskStep(step)),
       verdict: {
@@ -864,17 +1265,21 @@ class Recorder {
       };
     }
   }
-  #alumniumRegisterResponsePaths(server = DEFAULT_ALUMNIUM_SERVER) {
-    return {
-      [`${server}/*`]: [],
-      [`${server}/${ALUMNIUM_START_TOOL}`]: ["id"],
-    };
-  }
   #assertNotFinished() {
     if (this.#recording) throw new Error("Recording is already finished");
   }
 }
-export { FileTestCache, Masker, Recorder, Recording, RecordingLeakError };
+export {
+  BashExecutor,
+  FileTestCache,
+  Masker,
+  McpExecutor,
+  Player,
+  Recorder,
+  Recording,
+  RecordingLeakError,
+  composeExecutors,
+};
 
-//# debugId=E1FEB499A312812964756E2164756E21
+//# debugId=88B58893F83F47D164756E2164756E21
 //# sourceMappingURL=index.js.map