Add CodeRemediationEvent for SecurityScan (#4618)

Author: leigaol

packages/core/src/codewhisperer/client/user-service-2.json

@@ -456,6 +456,46 @@
             "max": 128,
             "min": 1
         },
+        "CodeScanRemediationsEvent": {
+            "type": "structure",
+            "members": {
+                "programmingLanguage": {
+                    "shape": "ProgrammingLanguage"
+                },
+                "CodeScanRemediationsEventType": {
+                    "shape": "CodeScanRemediationsEventType"
+                },
+                "timestamp": {
+                    "shape": "Timestamp"
+                },
+                "detectorId": {
+                    "shape": "String"
+                },
+                "findingId": {
+                    "shape": "String"
+                },
+                "ruleId": {
+                    "shape": "String"
+                },
+                "component": {
+                    "shape": "String"
+                },
+                "reason": {
+                    "shape": "String"
+                },
+                "result": {
+                    "shape": "String"
+                },
+                "includesFix": {
+                    "shape": "Boolean"
+                }
+            }
+        },
+        "CodeScanRemediationsEventType": {
+            "type": "string",
+            "documentation": "<p>Code Scan Remediations Interaction Type</p>",
+            "enum": ["CODESCAN_ISSUE_HOVER", "CODESCAN_ISSUE_APPLY_FIX", "CODESCAN_ISSUE_VIEW_DETAILS"]
+        },
         "Completion": {
             "type": "structure",
             "required": ["content"],
@@ -1327,6 +1367,7 @@
                 "codeCoverageEvent": { "shape": "CodeCoverageEvent" },
                 "userModificationEvent": { "shape": "UserModificationEvent" },
                 "codeScanEvent": { "shape": "CodeScanEvent" },
+                "codeScanRemediationsEvent": { "shape": "CodeScanRemediationsEvent" },
                 "metricData": { "shape": "MetricData" },
                 "chatAddMessageEvent": { "shape": "ChatAddMessageEvent" },
                 "chatInteractWithMessageEvent": { "shape": "ChatInteractWithMessageEvent" },

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

@@ -32,6 +32,7 @@ import { Mutable } from '../../shared/utilities/tsUtils'
 import { CodeWhispererSource } from './types'
 import { showManageConnections } from '../../auth/ui/vue/show'
 import { FeatureConfigProvider } from '../service/featureConfigProvider'
+import { TelemetryHelper } from '../util/telemetryHelper'
 
 export const toggleCodeSuggestions = Commands.declare(
     { id: 'aws.codeWhisperer.toggleCodeSuggestion', compositeKey: { 1: 'source' } },
@@ -224,6 +225,17 @@ export const openSecurityIssuePanel = Commands.declare(
             ruleId: issue.ruleId,
             credentialStartUrl: AuthUtil.instance.startUrl,
         })
+        TelemetryHelper.instance.sendCodeScanRemediationsEvent(
+            undefined,
+            'CODESCAN_ISSUE_VIEW_DETAILS',
+            issue.detectorId,
+            issue.findingId,
+            issue.ruleId,
+            undefined,
+            undefined,
+            undefined,
+            !!issue.suggestedFixes.length
+        )
     }
 )
 
@@ -259,12 +271,12 @@ export const applySecurityFix = Commands.declare(
             result: 'Succeeded',
             credentialStartUrl: AuthUtil.instance.startUrl,
         }
-
+        let languageId = undefined
         try {
             const patch = suggestedFix.code
             const document = await vscode.workspace.openTextDocument(filePath)
             const fileContent = document.getText()
-
+            languageId = document.languageId
             const updatedContent = applyPatch(fileContent, patch)
             if (!updatedContent) {
                 void vscode.window.showErrorMessage(CodeWhispererConstants.codeFixAppliedFailedMessage)
@@ -295,6 +307,17 @@ export const applySecurityFix = Commands.declare(
             applyFixTelemetryEntry.reason = err as string
         } finally {
             telemetry.codewhisperer_codeScanIssueApplyFix.emit(applyFixTelemetryEntry)
+            TelemetryHelper.instance.sendCodeScanRemediationsEvent(
+                languageId,
+                'CODESCAN_ISSUE_APPLY_FIX',
+                issue.detectorId,
+                issue.findingId,
+                issue.ruleId,
+                source,
+                applyFixTelemetryEntry.reason,
+                applyFixTelemetryEntry.result,
+                !!issue.suggestedFixes.length
+            )
         }
     }
 )

packages/core/src/codewhisperer/service/securityIssueHoverProvider.ts

@@ -9,6 +9,7 @@ import { SecurityIssueProvider } from './securityIssueProvider'
 import { Component, telemetry } from '../../shared/telemetry/telemetry'
 import path from 'path'
 import { AuthUtil } from '../util/authUtil'
+import { TelemetryHelper } from '../util/telemetryHelper'
 
 export class SecurityIssueHoverProvider extends SecurityIssueProvider implements vscode.HoverProvider {
     static #instance: SecurityIssueHoverProvider
@@ -40,6 +41,17 @@ export class SecurityIssueHoverProvider extends SecurityIssueProvider implements
                         includesFix: !!issue.suggestedFixes.length,
                         credentialStartUrl: AuthUtil.instance.startUrl,
                     })
+                    TelemetryHelper.instance.sendCodeScanRemediationsEvent(
+                        document.languageId,
+                        'CODESCAN_ISSUE_HOVER',
+                        issue.detectorId,
+                        issue.findingId,
+                        issue.ruleId,
+                        undefined,
+                        undefined,
+                        undefined,
+                        !!issue.suggestedFixes.length
+                    )
                 }
             }
         }

packages/core/src/codewhisperer/util/telemetryHelper.ts

@@ -26,6 +26,7 @@ import { getLogger } from '../../shared/logger'
 import { session } from './codeWhispererSession'
 import { CodeWhispererSupplementalContext } from '../models/model'
 import { FeatureConfigProvider } from '../service/featureConfigProvider'
+import { CodeScanRemediationsEventType } from '../client/codewhispereruserclient'
 
 const performance = globalThis.performance ?? require('perf_hooks').performance
 
@@ -568,4 +569,52 @@ export class TelemetryHelper {
                 )
             })
     }
+
+    public sendCodeScanRemediationsEvent(
+        languageId?: string,
+        codeScanRemediationEventType?: CodeScanRemediationsEventType,
+        detectorId?: string,
+        findingId?: string,
+        ruleId?: string,
+        component?: string,
+        reason?: string,
+        result?: string,
+        includesFix?: boolean
+    ) {
+        client
+            .sendTelemetryEvent({
+                telemetryEvent: {
+                    codeScanRemediationsEvent: {
+                        programmingLanguage: languageId
+                            ? {
+                                  languageName: runtimeLanguageContext.toRuntimeLanguage(
+                                      languageId as CodewhispererLanguage
+                                  ),
+                              }
+                            : undefined,
+                        CodeScanRemediationsEventType: codeScanRemediationEventType,
+                        detectorId: detectorId,
+                        findingId: findingId,
+                        ruleId: ruleId,
+                        component: component,
+                        reason: reason,
+                        result: result,
+                        includesFix: includesFix,
+                        timestamp: new Date(Date.now()),
+                    },
+                },
+            })
+            .then()
+            .catch(error => {
+                let requestId: string | undefined
+                if (isAwsError(error)) {
+                    requestId = error.requestId
+                }
+                getLogger().debug(
+                    `Failed to sendCodeScanRemediationsEvent to CodeWhisperer, requestId: ${
+                        requestId ?? ''
+                    }, message: ${error.message}`
+                )
+            })
+    }
 }