fix(codewhisperer): inline tutorial telemetry (#4632)

Author: Will-ShaoHua

packages/core/src/codewhisperer/views/lineAnnotationController.ts

@@ -44,8 +44,10 @@ function fromId(id: string | undefined): AnnotationState | undefined {
 interface AnnotationState {
     id: string
     suppressWhileRunning: boolean
+
     text: () => string
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined
+    isNextState(state: AnnotationState | undefined): boolean
 }
 
 /**
@@ -67,7 +69,7 @@ class AutotriggerState implements AnnotationState {
     text = () => 'CodeWhisperer Tip 1/3: Start typing to get suggestions ([ESC] to exit)'
     static acceptedCount = 0
 
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
         if (AutotriggerState.acceptedCount < RecommendationService.instance.acceptedSuggestionCount) {
             return new ManualtriggerState()
         } else if (session.recommendations.length > 0 && RecommendationHandler.instance.isSuggestionVisible()) {
@@ -76,6 +78,10 @@ class AutotriggerState implements AnnotationState {
             return this
         }
     }
+
+    isNextState(state: AnnotationState | undefined): boolean {
+        return state instanceof ManualtriggerState
+    }
 }
 
 /**
@@ -92,10 +98,15 @@ class PressTabState implements AnnotationState {
     id = PressTabState.id
 
     suppressWhileRunning = false
+
     text = () => 'CodeWhisperer Tip 1/3: Press [TAB] to accept ([ESC] to exit)'
 
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
-        return new AutotriggerState().nextState(changeSource, force)
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
+        return new AutotriggerState().updateState(changeSource, force)
+    }
+
+    isNextState(state: AnnotationState | undefined): boolean {
+        return state instanceof ManualtriggerState
     }
 }
 
@@ -124,7 +135,7 @@ class ManualtriggerState implements AnnotationState {
     hasManualTrigger: boolean = false
     hasValidResponse: boolean = false
 
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState | undefined {
         if (this.hasManualTrigger && this.hasValidResponse) {
             if (changeSource !== 'codewhisperer') {
                 return new TryMoreExState()
@@ -135,6 +146,10 @@ class ManualtriggerState implements AnnotationState {
             return this
         }
     }
+
+    isNextState(state: AnnotationState | undefined): boolean {
+        return state instanceof TryMoreExState
+    }
 }
 
 /**
@@ -153,13 +168,17 @@ class TryMoreExState implements AnnotationState {
     suppressWhileRunning = true
 
     text = () => 'CodeWhisperer Tip 3/3: For settings, open the CodeWhisperer menu from the status bar ([ESC] to exit)'
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState {
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState {
         if (force) {
             return new EndState()
         }
         return this
     }
 
+    isNextState(state: AnnotationState | undefined): boolean {
+        return state instanceof EndState
+    }
+
     static triggerCount: number = 0
     static learnmoeCount: number = 0
 }
@@ -170,9 +189,12 @@ class EndState implements AnnotationState {
 
     suppressWhileRunning = true
     text = () => ''
-    nextState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState {
+    updateState(changeSource: AnnotationChangeSource, force: boolean): AnnotationState {
         return this
     }
+    isNextState(state: AnnotationState): boolean {
+        return false
+    }
 }
 
 /**
@@ -192,8 +214,6 @@ export class LineAnnotationController implements vscode.Disposable {
 
     private _currentState: AnnotationState
 
-    private _seen: Set<string> = new Set()
-
     private readonly cwLineHintDecoration: vscode.TextEditorDecorationType =
         vscode.window.createTextEditorDecorationType({
             after: {
@@ -262,7 +282,7 @@ export class LineAnnotationController implements vscode.Disposable {
                     try {
                         telemetry.ui_click.emit({ elementId: `dismiss_${this._currentState.id}` })
                     } catch (_) {}
-                    await this.markTutorialDone()
+                    await this.dismissTutorial()
                     getLogger().debug(`codewhisperer: user dismiss tutorial.`)
                 }
             })
@@ -284,7 +304,7 @@ export class LineAnnotationController implements vscode.Disposable {
         return this._currentState.id === new EndState().id
     }
 
-    async markTutorialDone() {
+    async dismissTutorial() {
         this._currentState = new EndState()
         await vscode.commands.executeCommand('setContext', inlinehintWipKey, false)
         await set(inlinehintKey, this._currentState.id, globals.context.globalState)
@@ -384,14 +404,13 @@ export class LineAnnotationController implements vscode.Disposable {
             // special case
             // Endstate is meaningless and doesnt need to be rendered
             this.clear()
-            await this.markTutorialDone()
+            await this.dismissTutorial()
             return
         } else if (decorationOptions.renderOptions?.after?.contentText === new TryMoreExState().text()) {
             // special case
             // case 3 exit criteria is to fade away in 30s
             setTimeout(async () => {
-                await this.markTutorialDone()
-                await this.refresh(editor, source)
+                await this.refresh(editor, source, true)
             }, case3TimeWindow)
         }
 
@@ -423,21 +442,23 @@ export class LineAnnotationController implements vscode.Disposable {
             return undefined
         }
 
-        const nextState: AnnotationState | undefined = this._currentState.nextState(source, force ?? false)
+        const updatedState: AnnotationState | undefined = this._currentState.updateState(source, force ?? false)
 
-        if (nextState === undefined) {
+        if (updatedState === undefined) {
             return undefined
         }
 
-        if (!this._seen.has(nextState.id)) {
-            try {
-                telemetry.ui_click.emit({ elementId: this._currentState.id, passive: true })
-            } catch (e) {}
+        if (this._currentState.isNextState(updatedState)) {
+            // special case because PressTabState is part of case_1 (1a) which possibly jumps directly from case_1a to case_2 and miss case_1
+            if (this._currentState instanceof PressTabState) {
+                telemetry.ui_click.emit({ elementId: AutotriggerState.id, passive: true })
+            }
+            telemetry.ui_click.emit({ elementId: this._currentState.id, passive: true })
         }
 
         // update state
-        this._currentState = nextState
-        this._seen.add(this._currentState.id)
+        this._currentState = updatedState
+
         // take snapshot of accepted session so that we can compre if there is delta -> users accept 1 suggestion after seeing this state
         AutotriggerState.acceptedCount = RecommendationService.instance.acceptedSuggestionCount
         // take snapshot of total trigger count so that we can compare if there is delta -> users accept/reject suggestions after seeing this state