Allow sending document without active focus in Chat requests (#421)

Author: makenneth

server/aws-lsp-codewhisperer/src/language-server/chat/contexts/documentContext.test.ts

@@ -99,35 +99,6 @@ describe('DocumentContext', () => {
 
             assert.deepStrictEqual(result, expected)
         })
-
-        it('returns undefined cursorState if the end position was collapsed', async () => {
-            const documentContextExtractor = new DocumentContextExtractor({ characterLimits: 0 })
-
-            const expected: DocumentContext = {
-                programmingLanguage: { languageName: 'typescript' },
-                relativeFilePath: 'file://test.ts',
-                documentSymbols: [],
-                text: '',
-                hasCodeSnippet: false,
-                totalEditorCharacters: mockTypescriptCodeBlock.length,
-                cursorState: undefined,
-            }
-
-            const result = await documentContextExtractor.extractDocumentContext(mockTSDocument, {
-                range: {
-                    start: {
-                        line: 1,
-                        character: 13,
-                    },
-                    end: {
-                        line: 1,
-                        character: 13,
-                    },
-                },
-            })
-
-            assert.deepStrictEqual(result, expected)
-        })
     })
 
     it('handles other languages correctly', async () => {

server/aws-lsp-codewhisperer/src/language-server/chat/contexts/triggerContext.ts

@@ -1,6 +1,6 @@
 import { TriggerType } from '@aws/chat-client-ui-types'
 import { ChatTriggerType, GenerateAssistantResponseCommandInput, UserIntent } from '@amzn/codewhisperer-streaming'
-import { ChatParams } from '@aws/language-server-runtimes/server-interface'
+import { ChatParams, CursorState } from '@aws/language-server-runtimes/server-interface'
 import { Features } from '../../types'
 import { DocumentContext, DocumentContextExtractor } from './documentContext'
 
@@ -10,6 +10,8 @@ export interface TriggerContext extends Partial<DocumentContext> {
 }
 
 export class QChatTriggerContext {
+    private static readonly DEFAULT_CURSOR_STATE: CursorState = { position: { line: 0, character: 0 } }
+
     #workspace: Features['workspace']
     #documentContextExtractor: DocumentContextExtractor
 
@@ -19,7 +21,7 @@ export class QChatTriggerContext {
     }
 
     async getNewTriggerContext(params: ChatParams): Promise<TriggerContext> {
-        const documentContext: DocumentContext | undefined = await this.#extractDocumentContext(params)
+        const documentContext: DocumentContext | undefined = await this.extractDocumentContext(params)
 
         return {
             ...documentContext,
@@ -66,16 +68,22 @@ export class QChatTriggerContext {
         this.#documentContextExtractor.dispose()
     }
 
-    async #extractDocumentContext(
+    // public for testing
+    async extractDocumentContext(
         input: Pick<ChatParams, 'cursorState' | 'textDocument'>
     ): Promise<DocumentContext | undefined> {
-        const { textDocument: textDocumentIdentifier, cursorState = [] } = input
+        const { textDocument: textDocumentIdentifier, cursorState } = input
 
         const textDocument =
             textDocumentIdentifier?.uri && (await this.#workspace.getTextDocument(textDocumentIdentifier.uri))
 
         return textDocument
-            ? this.#documentContextExtractor.extractDocumentContext(textDocument, cursorState[0])
+            ? this.#documentContextExtractor.extractDocumentContext(
+                  textDocument,
+                  // we want to include a default position if a text document is found so users can still ask questions about the opened file
+                  // the range will be expanded up to the max characters downstream
+                  cursorState?.[0] ?? QChatTriggerContext.DEFAULT_CURSOR_STATE
+              )
             : undefined
     }
 

server/aws-lsp-codewhisperer/src/language-server/chat/contexts/triggerContexts.test.ts

@@ -0,0 +1,95 @@
+import { TestFeatures } from '@aws/language-server-runtimes/testing'
+import { QChatTriggerContext } from './triggerContext'
+import assert = require('assert')
+import { TextDocument } from 'vscode-languageserver-textdocument'
+import { DocumentContext, DocumentContextExtractor } from './documentContext'
+import sinon = require('sinon')
+
+describe('QChatTriggerContext', () => {
+    let testFeatures: TestFeatures
+
+    const filePath = 'file://test.ts'
+    const mockTSDocument = TextDocument.create(filePath, 'typescript', 1, '')
+    const mockDocumentContext: DocumentContext = {
+        text: '',
+        programmingLanguage: { languageName: 'typescript' },
+        relativeFilePath: 'file://test.ts',
+        documentSymbols: [],
+        hasCodeSnippet: false,
+        totalEditorCharacters: 0,
+    }
+
+    beforeEach(() => {
+        testFeatures = new TestFeatures()
+        sinon.stub(DocumentContextExtractor.prototype, 'extractDocumentContext').resolves(mockDocumentContext)
+    })
+
+    afterEach(() => {
+        sinon.restore()
+    })
+
+    it('returns null if text document is not defined in params', async () => {
+        const triggerContext = new QChatTriggerContext(testFeatures.workspace, testFeatures.logging)
+
+        const documentContext = await triggerContext.extractDocumentContext({
+            cursorState: [
+                {
+                    position: {
+                        line: 5,
+                        character: 0,
+                    },
+                },
+            ],
+            textDocument: undefined,
+        })
+
+        assert.deepStrictEqual(documentContext, undefined)
+    })
+
+    it('returns null if text document is not found', async () => {
+        const triggerContext = new QChatTriggerContext(testFeatures.workspace, testFeatures.logging)
+
+        const documentContext = await triggerContext.extractDocumentContext({
+            cursorState: [
+                {
+                    position: {
+                        line: 5,
+                        character: 0,
+                    },
+                },
+            ],
+            textDocument: {
+                uri: filePath,
+            },
+        })
+
+        assert.deepStrictEqual(documentContext, undefined)
+    })
+
+    it('passes default cursor state if no cursor is found', async () => {
+        const triggerContext = new QChatTriggerContext(testFeatures.workspace, testFeatures.logging)
+
+        const documentContext = await triggerContext.extractDocumentContext({
+            cursorState: [],
+            textDocument: {
+                uri: filePath,
+            },
+        })
+
+        assert.deepStrictEqual(documentContext, undefined)
+    })
+
+    it('includes cursor state from the parameters and text document if found', async () => {
+        const triggerContext = new QChatTriggerContext(testFeatures.workspace, testFeatures.logging)
+
+        testFeatures.openDocument(mockTSDocument)
+        const documentContext = await triggerContext.extractDocumentContext({
+            cursorState: [],
+            textDocument: {
+                uri: filePath,
+            },
+        })
+
+        assert.deepStrictEqual(documentContext, mockDocumentContext)
+    })
+})

server/aws-lsp-codewhisperer/src/language-server/chat/contexts/utils.ts

@@ -61,10 +61,6 @@ export function getExtendedCodeBlockRange(
  * reflects the position in the entire document needs to be adjusted.
  */
 export function getSelectionWithinExtendedRange(selection: Range, extendedRange: Range): Range | undefined {
-    if (selection.start.line === selection.end.line && selection.start.character === selection.end.character) {
-        return undefined
-    }
-
     return {
         start: {
             line: selection.start.line - extendedRange.start.line,