refactor(codewhisperer): unify isCWRunning state to one place #4336

Problem:
There are 2 state variables maintained in CW which serve the same purpose to
represent "CW is running/thinking to generate recommendations":

1. `InlineCompletionService.isPaginatedRunning` https://github.com/aws/aws-toolkit-vscode/blob/master/src/codewhisperer/service/inlineCompletionService.ts#L30
2. `RecommendationHandler.isGenerateRecommendationInProgress` https://github.com/aws/aws-toolkit-vscode/blob/master/src/codewhisperer/service/recommendationHandler.ts#L75

Soltuion:
Merge these 2 variables into one at `RecommendationService` instead of
maintaining 2 separately at their lower level component.

                            / RecommendationHandler.getRecommendation (C9)
    RecommendationService
                            \ InlineCompletionService.getPaginatedRecommendation (VSCode)

Author: Will-ShaoHua

src/codewhisperer/service/inlineCompletionService.ts

@@ -27,7 +27,6 @@ export class InlineCompletionService {
     private maxPage = 100
     private statusBar: CodeWhispererStatusBar
     private _showRecommendationTimer?: NodeJS.Timer
-    private _isPaginationRunning = false
 
     constructor(statusBar: CodeWhispererStatusBar = CodeWhispererStatusBar.instance) {
         this.statusBar = statusBar
@@ -86,11 +85,7 @@ export class InlineCompletionService {
         autoTriggerType?: CodewhispererAutomatedTriggerType,
         event?: vscode.TextDocumentChangeEvent
     ) {
-        if (
-            vsCodeState.isCodeWhispererEditing ||
-            this._isPaginationRunning ||
-            RecommendationHandler.instance.isSuggestionVisible()
-        ) {
+        if (vsCodeState.isCodeWhispererEditing || RecommendationHandler.instance.isSuggestionVisible()) {
             return
         }
 
@@ -164,10 +159,8 @@ export class InlineCompletionService {
     }
 
     private async setState(state: keyof typeof states) {
-        this._isPaginationRunning = false
         switch (state) {
             case 'loading': {
-                this._isPaginationRunning = true
                 await this.statusBar.setState('loading')
                 break
             }
@@ -185,10 +178,6 @@ export class InlineCompletionService {
             }
         }
     }
-
-    isPaginationRunning(): boolean {
-        return this._isPaginationRunning
-    }
 }
 
 /** The states that the completion service can be in */

src/codewhisperer/service/keyStrokeHandler.ts

@@ -13,7 +13,6 @@ import { RecommendationHandler } from './recommendationHandler'
 import { CodewhispererAutomatedTriggerType } from '../../shared/telemetry/telemetry'
 import { getTabSizeSetting } from '../../shared/utilities/editorUtilities'
 import { isInlineCompletionEnabled } from '../util/commonUtil'
-import { InlineCompletionService } from './inlineCompletionService'
 import { ClassifierTrigger } from './classifierTrigger'
 import { extractContextForCodeWhisperer } from '../util/editorContext'
 import { RecommendationService } from './recommendationService'
@@ -79,10 +78,10 @@ export class KeyStrokeHandler {
     }
 
     public shouldTriggerIdleTime(): boolean {
-        if (isCloud9() && RecommendationHandler.instance.isGenerateRecommendationInProgress) {
+        if (isCloud9() && RecommendationService.instance.isRunning) {
             return false
         }
-        if (isInlineCompletionEnabled() && InlineCompletionService.instance.isPaginationRunning()) {
+        if (isInlineCompletionEnabled() && RecommendationService.instance.isRunning) {
             return false
         }
         return true

src/codewhisperer/service/recommendationHandler.ts

@@ -72,7 +72,6 @@ export class RecommendationHandler {
     public requestId: string
     private nextToken: string
     private cancellationToken: vscode.CancellationTokenSource
-    public isGenerateRecommendationInProgress: boolean
     private _onDidReceiveRecommendation: vscode.EventEmitter<void> = new vscode.EventEmitter<void>()
     public readonly onDidReceiveRecommendation: vscode.Event<void> = this._onDidReceiveRecommendation.event
     private inlineCompletionProvider?: CWInlineCompletionItemProvider
@@ -88,7 +87,6 @@ export class RecommendationHandler {
         this.nextToken = ''
         this.lastInvocationTime = performance.now() - CodeWhispererConstants.invocationTimeIntervalThreshold * 1000
         this.cancellationToken = new vscode.CancellationTokenSource()
-        this.isGenerateRecommendationInProgress = false
         this.prev = new vscode.Disposable(() => {})
         this.next = new vscode.Disposable(() => {})
         this.reject = new vscode.Disposable(() => {})

src/codewhisperer/service/recommendationService.ts

@@ -17,6 +17,11 @@ import { DefaultCodeWhispererClient } from '../client/codewhisperer'
 export class RecommendationService {
     static #instance: RecommendationService
 
+    private _isRunning: boolean = false
+    get isRunning() {
+        return this._isRunning
+    }
+
     public static get instance() {
         return (this.#instance ??= new RecommendationService())
     }
@@ -29,20 +34,20 @@ export class RecommendationService {
         autoTriggerType?: CodewhispererAutomatedTriggerType,
         event?: vscode.TextDocumentChangeEvent
     ) {
+        if (this._isRunning) {
+            return
+        }
+
         if (isCloud9('any')) {
             // C9 manual trigger key alt/option + C is ALWAYS enabled because the VSC version C9 is on doesn't support setContextKey which is used for CODEWHISPERER_ENABLED
             // therefore we need a connection check if there is ANY connection(regardless of the connection's state) connected to CodeWhisperer on C9
             if (triggerType === 'OnDemand' && !AuthUtil.instance.isConnected()) {
                 return
             }
 
-            if (RecommendationHandler.instance.isGenerateRecommendationInProgress) {
-                return
-            }
-
             RecommendationHandler.instance.checkAndResetCancellationTokens()
             vsCodeState.isIntelliSenseActive = false
-            RecommendationHandler.instance.isGenerateRecommendationInProgress = true
+            this._isRunning = true
 
             try {
                 let response: GetRecommendationsResponse = {
@@ -78,20 +83,27 @@ export class RecommendationService {
                     })
                 }
             } finally {
-                RecommendationHandler.instance.isGenerateRecommendationInProgress = false
+                this._isRunning = false
             }
         } else if (isInlineCompletionEnabled()) {
             if (triggerType === 'OnDemand') {
                 ClassifierTrigger.instance.recordClassifierResultForManualTrigger(editor)
             }
-            await InlineCompletionService.instance.getPaginatedRecommendation(
-                client,
-                editor,
-                triggerType,
-                config,
-                autoTriggerType,
-                event
-            )
+
+            this._isRunning = true
+
+            try {
+                await InlineCompletionService.instance.getPaginatedRecommendation(
+                    client,
+                    editor,
+                    triggerType,
+                    config,
+                    autoTriggerType,
+                    event
+                )
+            } finally {
+                this._isRunning = false
+            }
         }
     }
 }

src/test/codewhisperer/service/keyStrokeHandler.test.ts

@@ -21,6 +21,7 @@ import { isInlineCompletionEnabled } from '../../../codewhisperer/util/commonUti
 import { ClassifierTrigger } from '../../../codewhisperer/service/classifierTrigger'
 import { CodeWhispererUserGroupSettings } from '../../../codewhisperer/util/userGroupUtil'
 import * as CodeWhispererConstants from '../../../codewhisperer/models/constants'
+import { RecommendationService } from '../../../codewhisperer/service/recommendationService'
 
 describe('keyStrokeHandler', function () {
     const config: ConfigurationEntry = {
@@ -192,7 +193,7 @@ describe('keyStrokeHandler', function () {
     describe('shouldTriggerIdleTime', function () {
         it('should return false when inline is enabled and inline completion is in progress ', function () {
             const keyStrokeHandler = new KeyStrokeHandler()
-            sinon.stub(InlineCompletionService.instance, 'isPaginationRunning').returns(true)
+            sinon.stub(RecommendationService.instance, 'isRunning').get(() => true)
             const result = keyStrokeHandler.shouldTriggerIdleTime()
             assert.strictEqual(result, !isInlineCompletionEnabled())
         })