Fix output.image in copilot chat (#1400)

* fix output.image in copilot chat

* fix echo

* logging

* patch cached images

* docs

Author: pelikhan

genaisrc/docs.genai.mts

@@ -4,6 +4,21 @@ import { prettier } from "./src/prettier.mts"
 
 script({
     title: "Generate TypeScript function documentation using AST insertion",
+    description: `
+## Docs!
+
+This script generates and updates TypeScript function using an AST/LLM hybrid approach.
+It uses ast-grep to look for undocumented and documented functions,
+then uses a combination of LLM, and LLM-as-a-judge to generate and validate the documentation.
+It also uses prettier to format the code before and after the generation.
+
+By default, 
+
+- no edits are applied on disk. It is recommended to 
+run this script with \`--vars 'applyEdits=true'\` to apply the edits.
+- if a diff is available, it will only process the files with changes.
+    
+    `,
     accept: ".ts",
     files: "src/cowsay.ts",
     parameters: {
@@ -17,7 +32,7 @@ script({
             type: "boolean",
             default: false,
             description:
-                "If true, the script will prettify the files efore analysis.",
+                "If true, the script will prettify the files before analysis.",
         },
         applyEdits: {
             type: "boolean",

packages/cli/src/run.ts

@@ -217,6 +217,8 @@ export async function runScriptInternal(
 ): Promise<{ exitCode: number; result?: GenerationResult }> {
     const runId = options.runId || generateId()
     const runDir = options.out || getRunDir(scriptId, runId)
+    dbg(`run id: `, runId)
+    dbg(`run dir: `, runDir)
     const cancellationToken = options.cancellationToken
     const {
         trace = new MarkdownTrace({ cancellationToken, dir: runDir }),
@@ -491,6 +493,7 @@ export async function runScriptInternal(
         }
 
         result = await runTemplate(prj, script, fragment, {
+            runId,
             inner: false,
             infoCb: (args) => {
                 const { text } = args

packages/core/src/filecache.ts

@@ -78,3 +78,12 @@ export async function fileCacheImage(
     dbg(`image: ${res}`)
     return res
 }
+
+export function patchCachedImages(
+    text: string,
+    patcher: (url: string) => string
+) {
+    const IMG_RX =
+        /\!\[(?<alt>[^\]]*)\]\((?<url>\.genaiscript\/images\/[^)]+)\)/g
+    return text.replace(IMG_RX, (_, alt, url) => `![${alt}](${patcher(url)})`)
+}

packages/core/src/generation.ts

@@ -18,6 +18,7 @@ export interface GenerationOptions
         ContentSafetyOptions,
         ScriptRuntimeOptions {
     inner: boolean // Indicates if the process is an inner operation
+    runId?: string
     runDir?: string
     cancellationToken?: CancellationToken // Token to cancel the operation
     infoCb?: (partialResponse: { text: string }) => void // Callback for providing partial responses

packages/core/src/promptrunner.ts

@@ -136,8 +136,15 @@ export async function runTemplate(
     assert(options !== undefined)
     assert(options.trace !== undefined)
     assert(options.outputTrace !== undefined)
-    const { label, cliInfo, trace, outputTrace, cancellationToken, model } =
-        options
+    const {
+        label,
+        cliInfo,
+        trace,
+        outputTrace,
+        cancellationToken,
+        model,
+        runId,
+    } = options
     const version = CORE_VERSION
     assert(model !== undefined)
 
@@ -206,6 +213,7 @@ export async function runTemplate(
                 frames: [],
                 schemas: {},
                 usage: undefined,
+                runId,
             } satisfies GenerationResult
         }
 
@@ -246,6 +254,7 @@ export async function runTemplate(
                 frames: [],
                 schemas: {},
                 usage: undefined,
+                runId,
             } satisfies GenerationResult)
         }
 
@@ -363,6 +372,7 @@ export async function runTemplate(
             perplexity: chatResult.perplexity,
             uncertainty: chatResult.uncertainty,
             usage: chatResult.usage,
+            runId,
         }
 
         // If there's an error, provide status text

packages/core/src/server/messages.ts

@@ -225,6 +225,10 @@ export type GenerationStatus = "success" | "error" | "cancelled" | undefined
 
 // Interface for the result of a generation process
 export interface GenerationResult extends GenerationOutput {
+    /**
+     * Run identifier
+     */
+    runId: string
     /**
      * The environment variables passed to the prompt
      */

packages/sample/genaisrc/poem.genai.mts

@@ -1 +1 @@
-$`Write a short poem.`
+$`Write a short poem in code.`

packages/vscode/src/chatparticipant.ts

@@ -10,9 +10,10 @@ import { Fragment } from "../../core/src/generation"
 import { convertAnnotationsToItems } from "../../core/src/annotations"
 import { deleteUndefinedValues } from "../../core/src/cleaners"
 import { templatesToQuickPickItems } from "./fragmentcommands"
+import { patchCachedImages } from "../../core/src/filecache"
 
 export async function activateChatParticipant(state: ExtensionState) {
-    const { context } = state
+    const { context, host } = state
     const { subscriptions } = context
 
     const resolveReference = (
@@ -160,7 +161,14 @@ export async function activateChatParticipant(state: ExtensionState) {
 
             const { text = "", status, statusText } = res || {}
             if (status !== "success") md("$(error) " + statusText)
-            if (text) md("\n\n" + convertAnnotationsToItems(text))
+            if (text) {
+                let patched = convertAnnotationsToItems(text)
+                const dir = state.host.projectUri
+                patched = patchCachedImages(patched, (url) =>
+                    vscode.Uri.joinPath(dir, url).toString()
+                )
+                md("\n\n" + patched)
+            }
             // TODO open url
         }
     )

packages/vscode/src/servermanager.ts

@@ -91,7 +91,7 @@ export class TerminalServerManager
     }
 
     get authority() {
-        assert(!!this._port)
+        if (!this._port) return undefined
         return `${SERVER_LOCALHOST}:${this._port}`
     }
 

packages/vscode/src/statusbar.ts

@@ -30,9 +30,10 @@ export function activateStatusBar(state: ExtensionState) {
             }${tokensSoFar ? ` ${tokensSoFar} tokens` : ""}`
         )
 
+        const authority = server.authority
         const md = new vscode.MarkdownString(
             toMarkdownString(
-                status === "running"
+                authority && status === "running"
                     ? `server: [${server.authority}](${server.browserUrl})`
                     : `server: ${status}`,
                 fragment?.files?.[0],