genai comments

packages/core/src/cache.ts

@@ -13,13 +13,17 @@
         super()
     }
 
-    static byName<K, V>(name: string): JSONLineCache<K, V> {
+    static byName<K, V>(
+        name: string,
+        options?: { snapshot?: boolean }
+    ): JSONLineCache<K, V> {
+        const { snapshot } = options || {}
         name = name.replace(/[^a-z0-9_]/gi, "_")
         const key = "cacheKV." + name
-        if (host.userState[key]) return host.userState[key]
+        if (!snapshot && host.userState[key]) return host.userState[key]
         const r = new JSONLineCache<K, V>(name)
-        host.userState[key] = r
+        if (!snapshot) host.userState[key] = r
         return r
     }
 
     private folder() {

packages/core/src/comments.ts

@@ -0,0 +1,22 @@
+import { JSONLineCache } from "./cache"
+import { COMMENTS_CACHE } from "./constants"
+
+export interface CommentKey {
+    uri: string
+    line: number
+    source: string
+}
+
+export function commentsCache(options?: { snapshot?: boolean }) {
+    const cache = JSONLineCache.byName<CommentKey, CommentThread>(
+        COMMENTS_CACHE,
+        options
+    )
+    return cache
+}
+
+export async function commentsForSource(source: string) {
+    const cache = commentsCache()
+    const entries = await cache.entries()
+    return entries.map(({ val }) => val).filter((c) => c.source === source)
+}

packages/core/src/constants.ts

@@ -212,6 +212,7 @@ export const AI_REQUESTS_CACHE = "airequests"
 export const CHAT_CACHE = "chat"
 export const GITHUB_PULL_REQUEST_REVIEWS_CACHE = "prr"
 export const GITHUB_PULLREQUEST_REVIEW_COMMENT_LINE_DISTANCE = 5
+export const COMMENTS_CACHE = "comments"
 
 export const PLACEHOLDER_API_BASE = "<custom api base>"
 export const PLACEHOLDER_API_KEY = "<your token>"

packages/core/src/promptrunner.ts

@@ -22,6 +22,7 @@ import { validateJSONWithSchema } from "./schema"
 import { YAMLParse } from "./yaml"
 import { expandTemplate } from "./expander"
 import { resolveLanguageModel } from "./lm"
+import { commentsCache, commentsForSource } from "./comments"
 
 async function resolveExpansionVars(
     project: Project,
@@ -57,6 +58,7 @@ async function resolveExpansionVars(
             secrets[secret] = value
         } else trace.error(`secret \`${secret}\` not found`)
     }
+    const comments = await commentsForSource(template.id)
     const res: Partial<ExpansionVariables> = {
         dir: ".",
         files,
@@ -67,6 +69,7 @@ async function resolveExpansionVars(
         },
         vars: attrs,
         secrets,
+        comments,
     }
     return res
 }

packages/core/src/types/prompt_template.d.ts

@@ -614,6 +614,67 @@ interface ChatParticipant {
     options: ChatParticipantOptions
 }
 
+/**
+ * A comment thread
+ */
+interface CommentThread {
+    filename: string
+    source: string
+    line: number
+    comments: Comment[]
+    label?: string
+    resolved?: boolean
+}
+
+/**
+ * A comment
+ */
+interface Comment {
+    /**
+     * The human-readable comment body
+     */
+    body: string
+
+    /**
+     * The author of the comment
+     */
+    author: { name: string }
+
+    /**
+     * Optional reactions of the comment
+     */
+    reactions?: CommentReaction[]
+
+    /**
+     * Optional label describing the comment
+     * Label will be rendered next to authorName if exists.
+     */
+    label?: string
+
+    /**
+     * Optional timestamp that will be displayed in comments.
+     * The date will be formatted according to the user's locale and settings.
+     */
+    timestamp?: string
+}
+
+interface CommentReaction {
+    /**
+     * The human-readable label for the reaction
+     */
+    label: string
+
+    /**
+     * The number of users who have reacted to this reaction
+     */
+    count: number
+
+    /**
+     * Whether the author of the comment has reacted to this reaction
+     */
+    authorHasReacted: boolean
+}
+
 /**
  * A set of text extracted from the context of the prompt execution
  */
@@ -647,6 +708,11 @@ interface ExpansionVariables {
      * Root prompt generation context
      */
     generator: ChatGenerationContext
+
+    /**
+     * Comment threads generated in the context of this prompt
+     */
+    comments: CommentThread[]
 }
 
 type MakeOptional<T, P extends keyof T> = Partial<Pick<T, P>> & Omit<T, P>