Move context warnings from the UI to the debug log (#2891)

The context warnings in the UI are creating more confusion than they're worth, so we'll move them to the debug output and work on better ways of surfacing these issues as necessary in the transcript view. ## Test plan - Recreate each warning scenario - Verify code behaves well
sourcegraph · Jan 25, 2024 · e62ca32 · e62ca32
1 parent ad9c9a6
commit e62ca32
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 101 deletions.
diff --git a/lib/shared/src/index.ts b/lib/shared/src/index.ts
@@ -150,7 +150,6 @@ export type {
 export { DOTCOM_URL, LOCAL_APP_URL, isDotCom } from './sourcegraph-api/environments'
 export {
     AbortError,
-    ContextWindowLimitError,
     NetworkError,
     RateLimitError,
     TimeoutError,

diff --git a/lib/shared/src/sourcegraph-api/errors.ts b/lib/shared/src/sourcegraph-api/errors.ts
@@ -106,12 +106,3 @@ export function isAbortError(error: unknown): error is AbortError {
 }
 
 export class TimeoutError extends Error {}
-
-export class ContextWindowLimitError extends Error {
-    public static readonly errorName = 'ContextWindowLimitError'
-    public readonly name = ContextWindowLimitError.errorName
-
-    constructor(public readonly message: string) {
-        super(message)
-    }
-}
diff --git a/lib/ui/src/chat/ErrorItem.tsx b/lib/ui/src/chat/ErrorItem.tsx
@@ -1,6 +1,6 @@
 import React, { useCallback } from 'react'
 
-import { ContextWindowLimitError, RateLimitError, type ChatError } from '@sourcegraph/cody-shared'
+import { RateLimitError, type ChatError } from '@sourcegraph/cody-shared'
 
 import type { ApiPostMessage, ChatButtonProps, UserAccountInfo } from '../Chat'
 
@@ -26,16 +26,6 @@ export const ErrorItem: React.FunctionComponent<{
         )
     }
 
-    if (typeof error !== 'string' && error.name === ContextWindowLimitError.errorName && postMessage) {
-        return (
-            <ContextWindowLimitErrorItem
-                error={error as ContextWindowLimitError}
-                ChatButtonComponent={ChatButtonComponent}
-                postMessage={postMessage}
-            />
-        )
-    }
-
     return <RequestErrorItem error={error.message} />
 })
 
@@ -53,44 +43,6 @@ export const RequestErrorItem: React.FunctionComponent<{
     )
 })
 
-const ContextWindowLimitErrorItem: React.FunctionComponent<{
-    error: ContextWindowLimitError
-    ChatButtonComponent?: React.FunctionComponent<ChatButtonProps>
-    postMessage: ApiPostMessage
-}> = React.memo(function ContextWindowLimitErrorItemContent({
-    error,
-    ChatButtonComponent,
-    postMessage,
-}) {
-    const onClick = useCallback(() => {
-        postMessage({ command: 'reset' })
-    }, [postMessage])
-
-    return (
-        <div className={styles.errorItem}>
-            <div className={styles.icon}>
-                <span className="codicon codicon-warning" />
-            </div>
-            <div className={styles.body}>
-                <header>
-                    <h1>Context Limit Reached</h1>
-                    <p>{error.message}</p>
-                </header>
-                {ChatButtonComponent && (
-                    <div className={styles.actions}>
-                        <ChatButtonComponent
-                            label="Start New Chat"
-                            action=""
-                            appearance="primary"
-                            onClick={onClick}
-                        />
-                    </div>
-                )}
-            </div>
-        </div>
-    )
-})
-
 /**
  * An error message shown in the chat.
  */

diff --git a/vscode/CHANGELOG.md b/vscode/CHANGELOG.md
@@ -36,6 +36,7 @@ This is a log of all notable changes to Cody for VS Code. [Unreleased] changes a
 - Autocomplete: Better cancellation of requests that are no longer relevant. [pull/2855](https://github.com/sourcegraph/cody/pull/2855)
 - Updated Enhanced Context popover copy and added a link to the docs. [pull/2864](https://github.com/sourcegraph/cody/pull/2864)
 - Include meta information about unit test files in Autocomplete analytics. [pull/2868](https://github.com/sourcegraph/cody/pull/2868)
+- Moved the Context Limit errors in chat into the deboug log output. [pull/2891](https://github.com/sourcegraph/cody/pull/2891)
 
 ## [1.1.3]
 

diff --git a/vscode/src/chat/chat-view/SimpleChatPanelProvider.ts b/vscode/src/chat/chat-view/SimpleChatPanelProvider.ts
@@ -4,7 +4,6 @@ import * as vscode from 'vscode'
 import {
     ChatModelProvider,
     ConfigFeaturesSingleton,
-    ContextWindowLimitError,
     hydrateAfterPostMessage,
     isDefined,
     isDotCom,
@@ -766,25 +765,13 @@ export class SimpleChatPanelProvider implements vscode.Disposable, ChatSession {
         prompter: IPrompter,
         sendTelemetry?: (contextSummary: any) => void
     ): Promise<Message[]> {
-        const { prompt, contextLimitWarnings, newContextUsed } = await prompter.makePrompt(
+        const { prompt, newContextUsed } = await prompter.makePrompt(
             this.chatModel,
             getContextWindowForModel(this.authProvider.getAuthStatus(), this.chatModel.modelID)
         )
 
         // Update UI based on prompt construction
         this.chatModel.setNewContextUsed(newContextUsed)
-        if (contextLimitWarnings.length > 0) {
-            const warningMsg = contextLimitWarnings
-                .map(w => {
-                    w = w.trim()
-                    if (!w.endsWith('.')) {
-                        w += '.'
-                    }
-                    return w
-                })
-                .join(' ')
-            this.postError(new ContextWindowLimitError(warningMsg), 'transcript')
-        }
 
         if (sendTelemetry) {
             // Create a summary of how many code snippets of each context source are being

diff --git a/vscode/src/chat/chat-view/prompt.test.ts b/vscode/src/chat/chat-view/prompt.test.ts
@@ -12,11 +12,9 @@ describe('DefaultPrompter', () => {
         const chat = new SimpleChatModel('a-model-id')
         chat.addHumanMessage({ text: 'Hello' })
 
-        const {
-            prompt,
-            contextLimitWarnings: warnings,
-            newContextUsed,
-        } = await new DefaultPrompter([], () => Promise.resolve([])).makePrompt(chat, 100000)
+        const { prompt, newContextUsed } = await new DefaultPrompter([], () =>
+            Promise.resolve([])
+        ).makePrompt(chat, 100000)
 
         expect(prompt).toMatchInlineSnapshot(`
           [
@@ -34,7 +32,6 @@ describe('DefaultPrompter', () => {
             },
           ]
         `)
-        expect(warnings).toMatchInlineSnapshot('[]')
         expect(newContextUsed).toMatchInlineSnapshot('[]')
     })
 
@@ -50,11 +47,9 @@ describe('DefaultPrompter', () => {
         const chat = new SimpleChatModel('a-model-id')
         chat.addHumanMessage({ text: 'Hello' })
 
-        const {
-            prompt,
-            contextLimitWarnings: warnings,
-            newContextUsed,
-        } = await new DefaultPrompter([], () => Promise.resolve([])).makePrompt(chat, 100000)
+        const { prompt, newContextUsed } = await new DefaultPrompter([], () =>
+            Promise.resolve([])
+        ).makePrompt(chat, 100000)
 
         expect(prompt).toMatchInlineSnapshot(`
           [
@@ -72,7 +67,6 @@ describe('DefaultPrompter', () => {
             },
           ]
         `)
-        expect(warnings).toMatchInlineSnapshot('[]')
         expect(newContextUsed).toMatchInlineSnapshot('[]')
     })
 })
diff --git a/vscode/src/chat/chat-view/prompt.ts b/vscode/src/chat/chat-view/prompt.ts
@@ -28,7 +28,6 @@ export interface IContextProvider {
 
 interface PromptInfo {
     prompt: Message[]
-    contextLimitWarnings: string[]
     newContextUsed: ContextItem[]
 }
 
@@ -41,7 +40,6 @@ export class CommandPrompter implements IPrompter {
     public async makePrompt(chat: SimpleChatModel, byteLimit: number): Promise<PromptInfo> {
         const promptBuilder = new PromptBuilder(byteLimit)
         const newContextUsed: ContextItem[] = []
-        const warnings: string[] = []
         const preInstruction: string | undefined = vscode.workspace
             .getConfiguration('cody.chat')
             .get('preInstruction')
@@ -58,12 +56,12 @@ export class CommandPrompter implements IPrompter {
             const messageWithContext = reverseTranscript[i]
             const contextLimitReached = promptBuilder.tryAdd(messageWithContext.message)
             if (!contextLimitReached) {
-                warnings.push(
+                logDebug(
+                    'CommandPrompter.makePrompt',
                     `Ignored ${reverseTranscript.length - i} transcript messages due to context limit`
                 )
                 return {
                     prompt: promptBuilder.build(),
-                    contextLimitWarnings: warnings,
                     newContextUsed,
                 }
             }
@@ -87,7 +85,6 @@ export class CommandPrompter implements IPrompter {
 
         return {
             prompt: promptBuilder.build(),
-            contextLimitWarnings: warnings,
             newContextUsed,
         }
     }
@@ -101,19 +98,17 @@ export class DefaultPrompter implements IPrompter {
     // Constructs the raw prompt to send to the LLM, with message order reversed, so we can construct
     // an array with the most important messages (which appear most important first in the reverse-prompt.
     //
-    // Returns the reverse prompt, a list of warnings that indicate that the prompt was truncated, and
-    // the new context that was used in the prompt for the current message.
+    // Returns the reverse prompt and the new context that was used in the
+    // prompt for the current message.
     public async makePrompt(
         chat: SimpleChatModel,
         byteLimit: number
     ): Promise<{
         prompt: Message[]
-        contextLimitWarnings: string[]
         newContextUsed: ContextItem[]
     }> {
         const promptBuilder = new PromptBuilder(byteLimit)
         const newContextUsed: ContextItem[] = []
-        const warnings: string[] = []
         const preInstruction: string | undefined = vscode.workspace
             .getConfiguration('cody.chat')
             .get('preInstruction')
@@ -130,12 +125,12 @@ export class DefaultPrompter implements IPrompter {
             const messageWithContext = reverseTranscript[i]
             const contextLimitReached = promptBuilder.tryAdd(messageWithContext.message)
             if (!contextLimitReached) {
-                warnings.push(
+                logDebug(
+                    'DefaultPrompter.makePrompt',
                     `Ignored ${reverseTranscript.length - i} transcript messages due to context limit`
                 )
                 return {
                     prompt: promptBuilder.build(),
-                    contextLimitWarnings: warnings,
                     newContextUsed,
                 }
             }
@@ -146,8 +141,11 @@ export class DefaultPrompter implements IPrompter {
             const { limitReached, used } = promptBuilder.tryAddContext(this.explicitContext)
             newContextUsed.push(...used)
             if (limitReached) {
-                warnings.push('Ignored current user-specified context items due to context limit')
-                return { prompt: promptBuilder.build(), contextLimitWarnings: warnings, newContextUsed }
+                logDebug(
+                    'DefaultPrompter.makePrompt',
+                    'Ignored current user-specified context items due to context limit'
+                )
+                return { prompt: promptBuilder.build(), newContextUsed }
             }
         }
 
@@ -159,8 +157,11 @@ export class DefaultPrompter implements IPrompter {
                 reverseTranscript.flatMap((message: MessageWithContext) => message.newContextUsed || [])
             )
             if (limitReached) {
-                warnings.push('Ignored prior context items due to context limit')
-                return { prompt: promptBuilder.build(), contextLimitWarnings: warnings, newContextUsed }
+                logDebug(
+                    'DefaultPrompter.makePrompt',
+                    'Ignored prior context items due to context limit'
+                )
+                return { prompt: promptBuilder.build(), newContextUsed }
             }
         }
 
@@ -189,7 +190,6 @@ export class DefaultPrompter implements IPrompter {
 
         return {
             prompt: promptBuilder.build(),
-            contextLimitWarnings: warnings,
             newContextUsed,
         }
     }