Merge pull request #7272 from nkomonen-amazon/spinningStatusBar

There was a regression that appeared while doing the port to flare where the status bar would not show the spinning icon when generating a suggestion.

Now we will show the spinning symbol when generating a suggestion.

Additionally the file was more appropriately named since it now only has the status bar
related code.

Author: jpinkney-aws

packages/amazonq/src/app/inline/recommendationService.ts

@@ -12,6 +12,7 @@ import { CancellationToken, InlineCompletionContext, Position, TextDocument } fr
 import { LanguageClient } from 'vscode-languageclient'
 import { SessionManager } from './sessionManager'
 import { InlineGeneratingMessage } from './inlineGeneratingMessage'
+import { CodeWhispererStatusBarManager } from 'aws-core-vscode/codewhisperer'
 
 export class RecommendationService {
     constructor(
@@ -34,34 +35,41 @@ export class RecommendationService {
             context,
         }
         const requestStartTime = Date.now()
+        const statusBar = CodeWhispererStatusBarManager.instance
 
-        await this.inlineGeneratingMessage.showGenerating(context.triggerKind)
+        try {
+            // Show UI indicators that we are generating suggestions
+            await this.inlineGeneratingMessage.showGenerating(context.triggerKind)
+            await statusBar.setLoading()
 
-        // Handle first request
-        const firstResult: InlineCompletionListWithReferences = await languageClient.sendRequest(
-            inlineCompletionWithReferencesRequestType as any,
-            request,
-            token
-        )
+            // Handle first request
+            const firstResult: InlineCompletionListWithReferences = await languageClient.sendRequest(
+                inlineCompletionWithReferencesRequestType as any,
+                request,
+                token
+            )
 
-        const firstCompletionDisplayLatency = Date.now() - requestStartTime
-        this.sessionManager.startSession(
-            firstResult.sessionId,
-            firstResult.items,
-            requestStartTime,
-            firstCompletionDisplayLatency
-        )
+            const firstCompletionDisplayLatency = Date.now() - requestStartTime
+            this.sessionManager.startSession(
+                firstResult.sessionId,
+                firstResult.items,
+                requestStartTime,
+                firstCompletionDisplayLatency
+            )
 
-        if (firstResult.partialResultToken) {
-            // If there are more results to fetch, handle them in the background
-            this.processRemainingRequests(languageClient, request, firstResult, token).catch((error) => {
-                languageClient.warn(`Error when getting suggestions: ${error}`)
-            })
-        } else {
-            this.sessionManager.closeSession()
+            if (firstResult.partialResultToken) {
+                // If there are more results to fetch, handle them in the background
+                this.processRemainingRequests(languageClient, request, firstResult, token).catch((error) => {
+                    languageClient.warn(`Error when getting suggestions: ${error}`)
+                })
+            } else {
+                this.sessionManager.closeSession()
+            }
+        } finally {
+            // Remove all UI indicators of message generation since we are done
+            this.inlineGeneratingMessage.hideGenerating()
+            void statusBar.refreshStatusBar() // effectively "stop loading"
         }
-
-        this.inlineGeneratingMessage.hideGenerating()
     }
 
     private async processRemainingRequests(

packages/core/src/codewhisperer/activation.ts

@@ -62,7 +62,7 @@ import {
 } from './service/diagnosticsProvider'
 import { SecurityPanelViewProvider, openEditorAtRange } from './views/securityPanelViewProvider'
 import { Commands, registerCommandErrorHandler, registerDeclaredCommands } from '../shared/vscode/commands2'
-import { refreshStatusBar } from './service/inlineCompletionService'
+import { refreshStatusBar } from './service/statusBar'
 import { AuthUtil } from './util/authUtil'
 import { ImportAdderProvider } from './service/importAdderProvider'
 import { openUrl } from '../shared/utilities/vsCodeUtils'

packages/core/src/codewhisperer/index.ts

@@ -36,7 +36,7 @@ export {
     codeWhispererClient,
 } from './client/codewhisperer'
 export { listCodeWhispererCommands, listCodeWhispererCommandsId } from './ui/statusBarMenu'
-export { refreshStatusBar, CodeWhispererStatusBar } from './service/inlineCompletionService'
+export { refreshStatusBar, CodeWhispererStatusBarManager } from './service/statusBar'
 export { SecurityIssueHoverProvider } from './service/securityIssueHoverProvider'
 export { SecurityIssueCodeActionProvider } from './service/securityIssueCodeActionProvider'
 export {

packages/core/src/codewhisperer/service/inlineCompletionService.ts renamed to packages/core/src/codewhisperer/service/statusBar.ts

@@ -10,7 +10,7 @@ import { codicon, getIcon } from '../../shared/icons'
 import { Commands } from '../../shared/vscode/commands2'
 import { listCodeWhispererCommandsId } from '../ui/statusBarMenu'
 
-export class InlineCompletionService {
+export class CodeWhispererStatusBarManager {
     private statusBar: CodeWhispererStatusBar
 
     constructor(statusBar: CodeWhispererStatusBar = CodeWhispererStatusBar.instance) {
@@ -21,7 +21,7 @@ export class InlineCompletionService {
         })
     }
 
-    static #instance: InlineCompletionService
+    static #instance: CodeWhispererStatusBarManager
 
     public static get instance() {
         return (this.#instance ??= new this())
@@ -41,6 +41,17 @@ export class InlineCompletionService {
         }
     }
 
+    /**
+     * Sets the status bar in to a "loading state", effectively showing
+     * the spinning circle.
+     *
+     * When loading is done, call {@link refreshStatusBar} to update the
+     * status bar to the latest state.
+     */
+    async setLoading(): Promise<void> {
+        await this.setState('loading')
+    }
+
     private async setState(state: keyof typeof states) {
         switch (state) {
             case 'loading': {
@@ -76,7 +87,7 @@ const states = {
     needsProfile: 'needsProfile',
 } as const
 
-export class CodeWhispererStatusBar {
+class CodeWhispererStatusBar {
     protected statusBar: vscode.StatusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Left, 1)
 
     static #instance: CodeWhispererStatusBar
@@ -127,10 +138,10 @@ export class CodeWhispererStatusBar {
     }
 }
 
-/** In this module due to circulare dependency issues */
+/** In this module due to circular dependency issues */
 export const refreshStatusBar = Commands.declare(
     { id: 'aws.amazonq.refreshStatusBar', logging: false },
     () => async () => {
-        await InlineCompletionService.instance.refreshStatusBar()
+        await CodeWhispererStatusBarManager.instance.refreshStatusBar()
     }
 )

packages/core/src/test/codewhisperer/commands/basicCommands.test.ts

@@ -56,7 +56,7 @@ import { waitUntil } from '../../../shared/utilities/timeoutUtils'
 import { listCodeWhispererCommands } from '../../../codewhisperer/ui/statusBarMenu'
 import { CodeScanIssue, CodeScansState, CodeSuggestionsState, codeScanState } from '../../../codewhisperer/models/model'
 import { cwQuickPickSource } from '../../../codewhisperer/commands/types'
-import { refreshStatusBar } from '../../../codewhisperer/service/inlineCompletionService'
+import { refreshStatusBar } from '../../../codewhisperer/service/statusBar'
 import { focusAmazonQPanel } from '../../../codewhispererChat/commands/registerCommands'
 import * as diagnosticsProvider from '../../../codewhisperer/service/diagnosticsProvider'
 import { randomUUID } from '../../../shared/crypto'