@marimo-team/islands 0.25.3-dev189 → 0.25.3-dev191

package/src/core/ai/tools/run-cells-tool.ts

@@ -1,303 +0,0 @@
-/* Copyright 2026 Marimo. All rights reserved. */
-
-import type { FileUIPart } from "ai";
-import { z } from "zod";
-import { runCells } from "@/components/editor/cell/useRunCells";
-import { notebookAtom } from "@/core/cells/cells";
-import type { CellId } from "@/core/cells/ids";
-import { staleCellIds } from "@/core/cells/utils";
-import { type JotaiStore, waitFor } from "@/core/state/jotai";
-import {
-  type BaseOutput,
-  getCellContextData,
-} from "../context/providers/cell-output";
-import {
-  type AiTool,
-  type EmptyToolInput,
-  type ToolDescription,
-  type ToolNotebookContext,
-  type ToolOutputBase,
-  toolOutputBaseSchema,
-} from "./base";
-import type { CopilotMode } from "./registry";
-
-const POST_EXECUTION_DELAY = 200;
-const WAIT_FOR_CELLS_TIMEOUT = 30_000;
-
-// Output size limits to prevent exceeding LLM token limits.
-const MAX_TEXT_OUTPUT_CHARS = 2000;
-const MAX_ERROR_OUTPUT_CHARS = 3000;
-const MAX_TOOL_OUTPUT_CHARS = 40_000;
-
-interface CellOutput {
-  consoleOutput?: string;
-  cellOutput?: string;
-}
-
-// Must use Record instead of Map because Map serializes to JSON as {}
-interface RunStaleCellsOutput extends ToolOutputBase {
-  cellsToOutput?: Record<CellId, CellOutput | null>;
-}
-
-const description: ToolDescription = {
-  baseDescription:
-    "Run cells in the current notebook that are stale. Stale cells are cells that have been edited or newly added. You can run this tool after editing the notebook or when requested. The output of the ran cells will be returned alongside metadata.",
-};
-
-const filePartSchema = z.object({
-  type: z.literal("file"),
-  url: z.string(),
-  mediaType: z.string(),
-}) satisfies z.ZodType<FileUIPart>;
-
-export class RunStaleCellsTool implements AiTool<
-  EmptyToolInput,
-  RunStaleCellsOutput
-> {
-  public readonly name = "run_stale_cells_tool";
-  public readonly description = description;
-  public readonly schema = z.object({});
-  public readonly outputSchema = toolOutputBaseSchema.extend({
-    cellsToOutput: z
-      .record(
-        z.string(),
-        z
-          .object({
-            consoleOutput: z.string().optional(),
-            cellOutput: z.string().optional(),
-            consoleAttachments: z.array(filePartSchema).optional(),
-            cellAttachments: z.array(filePartSchema).optional(),
-          })
-          .nullable(),
-      )
-      .optional(),
-  }) satisfies z.ZodType<RunStaleCellsOutput>;
-  public readonly mode: CopilotMode[] = ["agent"];
-
-  private readonly postExecutionDelay: number;
-
-  public constructor(opts?: { postExecutionDelay?: number }) {
-    this.postExecutionDelay = opts?.postExecutionDelay ?? POST_EXECUTION_DELAY;
-  }
-
-  public handler = async (
-    _args: EmptyToolInput,
-    toolContext: ToolNotebookContext,
-  ): Promise<RunStaleCellsOutput> => {
-    const { prepareForRun, sendRun, store } = toolContext;
-
-    const notebook = store.get(notebookAtom);
-    const staleCells = staleCellIds(notebook);
-
-    if (staleCells.length === 0) {
-      return {
-        status: "success",
-        message: "No stale cells found.",
-      };
-    }
-
-    await runCells({
-      cellIds: staleCells,
-      sendRun,
-      prepareForRun,
-      notebook,
-    });
-
-    // Wait for all cells to finish executing
-    const allCellsFinished = await this.waitForCellsToFinish(
-      store,
-      staleCells,
-      WAIT_FOR_CELLS_TIMEOUT,
-      this.postExecutionDelay,
-    );
-    if (!allCellsFinished) {
-      return {
-        status: "success",
-        message:
-          "No output was returned because some cells have not finished executing",
-      };
-    }
-
-    // Get notebook state after cells have finished
-    const updatedNotebook = store.get(notebookAtom);
-
-    const cellsToOutput = new Map<CellId, CellOutput | null>();
-    let outputHasErrors = false;
-    let hasAnyConsoleOutput = false;
-    let totalOutputChars = 0;
-
-    for (const cellId of staleCells) {
-      const cellContextData = getCellContextData(cellId, updatedNotebook, {
-        includeConsoleOutput: true,
-      });
-
-      const cellOutput = cellContextData.cellOutput;
-      const consoleOutputs = cellContextData.consoleOutputs;
-      const hasConsoleOutput = consoleOutputs && consoleOutputs.length > 0;
-
-      // Track errors regardless of budget
-      if (
-        (cellOutput && this.outputHasErrors(cellOutput)) ||
-        (hasConsoleOutput &&
-          consoleOutputs.some((output) => this.outputHasErrors(output)))
-      ) {
-        outputHasErrors = true;
-      }
-
-      if (!cellOutput && !hasConsoleOutput) {
-        cellsToOutput.set(cellId, null);
-        continue;
-      }
-
-      // If total budget exceeded, summarize remaining cells
-      if (totalOutputChars >= MAX_TOOL_OUTPUT_CHARS) {
-        cellsToOutput.set(cellId, {
-          cellOutput: "Cell executed (output omitted due to context limits).",
-        });
-        continue;
-      }
-
-      let cellOutputString: string | undefined;
-      let consoleOutputString: string | undefined;
-
-      if (cellOutput) {
-        cellOutputString = this.formatOutputString(cellOutput);
-        totalOutputChars += cellOutputString.length;
-      }
-
-      if (hasConsoleOutput) {
-        hasAnyConsoleOutput = true;
-        consoleOutputString = consoleOutputs
-          .map((output) => this.formatOutputString(output))
-          .join("\n");
-        consoleOutputString = this.truncateString(
-          consoleOutputString,
-          MAX_TEXT_OUTPUT_CHARS,
-        );
-        totalOutputChars += consoleOutputString.length;
-      }
-
-      cellsToOutput.set(cellId, {
-        cellOutput: cellOutputString,
-        consoleOutput: consoleOutputString,
-      });
-    }
-
-    if (cellsToOutput.size === 0) {
-      return {
-        status: "success",
-        message: "Stale cells have been run. No output was returned.",
-      };
-    }
-
-    const nextSteps = [
-      "Review the output of the cells. The CellId is the key of the result object.",
-      outputHasErrors
-        ? "There are errors in the cells. Please fix them by using the edit notebook tool and the given CellIds."
-        : "You may edit the notebook further with the given CellIds.",
-    ];
-
-    return {
-      status: "success",
-      cellsToOutput: Object.fromEntries(cellsToOutput),
-      message: hasAnyConsoleOutput
-        ? "Console output represents the stdout or stderr of the cell (eg. print statements)."
-        : undefined,
-      next_steps: nextSteps,
-    };
-  };
-
-  private outputHasErrors(cellOutput: BaseOutput): boolean {
-    return (
-      cellOutput.output.mimetype === "application/vnd.marimo+error" ||
-      cellOutput.output.mimetype === "application/vnd.marimo+traceback"
-    );
-  }
-
-  private formatOutputString(cellOutput: BaseOutput): string {
-    const { outputType, processedContent, imageUrl, output } = cellOutput;
-
-    if (outputType === "media") {
-      const base = `Media Output: Contains ${output.mimetype} content`;
-      return imageUrl ? `${base}\nImage URL: ${imageUrl}` : base;
-    }
-
-    if (output.mimetype === "text/html") {
-      // text/html (e.g. plotly figures, rich dataframes) can be millions of
-      // chars and is not interpretable by LLMs — summarize instead
-      const dataLength =
-        typeof output.data === "string"
-          ? output.data.length
-          : JSON.stringify(output.data).length;
-      return `HTML Output: text/html content (${dataLength.toLocaleString()} chars). Full output visible in notebook UI.`;
-    }
-
-    const maxChars = this.outputHasErrors(cellOutput)
-      ? MAX_ERROR_OUTPUT_CHARS
-      : MAX_TEXT_OUTPUT_CHARS;
-
-    let content = processedContent;
-    if (!content) {
-      content =
-        typeof output.data === "string"
-          ? output.data
-          : JSON.stringify(output.data);
-    }
-    return `Output:\n${this.truncateString(content, maxChars)}`;
-  }
-
-  private truncateString(str: string, maxLength: number): string {
-    if (str.length <= maxLength) {
-      return str;
-    }
-    return `${str.slice(0, maxLength)}\n\n[TRUNCATED: ${str.length.toLocaleString()} → ${maxLength.toLocaleString()} chars. Full output visible in the notebook UI.]`;
-  }
-  /**
-   * Wait for cells to finish executing (status becomes "idle")
-   * Returns true if all cells finished executing, false if the timeout was reached
-   */
-  private async waitForCellsToFinish(
-    store: JotaiStore,
-    cellIds: CellId[],
-    timeout: number,
-    postExecutionDelay: number,
-  ): Promise<boolean> {
-    const checkAllFinished = (
-      notebook: ReturnType<typeof notebookAtom.read>,
-    ) => {
-      return cellIds.every((cellId) => {
-        const cellRuntime = notebook.cellRuntime[cellId];
-        return (
-          cellRuntime?.status !== "running" && cellRuntime?.status !== "queued"
-        );
-      });
-    };
-
-    // Add a small delay after cells finish to allow console outputs to arrive
-    // Console outputs are streamed and might still be in-flight
-    const delayForConsoleOutputs = async () => {
-      if (postExecutionDelay > 0) {
-        await new Promise((resolve) => setTimeout(resolve, postExecutionDelay));
-      }
-      return true;
-    };
-
-    // Return immediately if all cells are finished
-    if (checkAllFinished(store.get(notebookAtom))) {
-      return await delayForConsoleOutputs();
-    }
-
-    // Wait for notebook state changes with timeout
-    try {
-      await Promise.race([
-        waitFor(notebookAtom, checkAllFinished),
-        new Promise<never>((_, reject) =>
-          setTimeout(() => reject(new Error("timeout")), timeout),
-        ),
-      ]);
-      return await delayForConsoleOutputs();
-    } catch {
-      return false;
-    }
-  }
-}