Fix: normalize code transformation by gumby metrics (#4131)

* Fix: normalize code transformation by gumby metrics

* Ran newchange

* Merge vscode telemetry

* Fix: unit test

* Fix: unit test

* Chore - add project pre-validation errors

* Revert "Ran newchange"

This reverts commit 5f0dd7f.

* Fix: remove unnecessary transform

* Fix: comments

* Fix: re-adding throw

* Change CodeTransformConstants to enum

* Refactor models and constants file to models folder

* Refactor - refactor variables to ENUM as preferred coding style for this repository

* Refactor generated types to enums

* Refactor change uploadZipSize to codeTransformTotalByteSize and refactor with TODO statements for each byte count

* Refactor change uploadZipSize to codeTransformTotalByteSize and refactor with TODO statements for each byte count

* Fix: removing unneeded import

* Chore - remove codeTransformConfigurationFilePath

* Chore - remove local telemetry definitions

* Chore - version bump for analytics

* Chore - keep amazonQ invoke method for now

* Chore: clean up unused telemetry

* Fix: updated package-lock.json

* Removing unneeded metric definition

* Fix: Upgraded commons package introduces new jsonc type, which needs to be declared with its extension

* chore: run prettier

---------

Co-authored-by: Nick Ardecky <[email protected]>

Author: JuliaABurch

package-lock.json

@@ -4262,7 +4262,7 @@
     },
     "devDependencies": {
         "@aws-sdk/types": "^3.13.1",
-        "@aws-toolkits/telemetry": "^1.0.167",
+        "@aws-toolkits/telemetry": "^1.0.169",
         "@aws/fully-qualified-names": "^2.1.1",
         "@cspotcode/source-map-support": "^0.8.1",
         "@sinonjs/fake-timers": "^10.0.2",

package.json

@@ -7,12 +7,7 @@ import * as vscode from 'vscode'
 import * as nls from 'vscode-nls'
 import { Commands, placeholder } from '../../shared/vscode/commands2'
 import { getIcon } from '../../shared/icons'
-import {
-    focusAmazonQPanel,
-    reconnect,
-    showTransformByQ,
-    transformTreeNode,
-} from '../../codewhisperer/commands/basicCommands'
+import { focusAmazonQPanel, reconnect, showTransformByQ } from '../../codewhisperer/commands/basicCommands'
 import { transformByQState } from '../../codewhisperer/models/model'
 import * as CodeWhispererConstants from '../../codewhisperer/models/constants'
 import { amazonQHelpUrl } from '../../shared/constants'
@@ -66,7 +61,7 @@ export const createTransformByQ = () => {
     if (transformByQState.isRunning()) {
         vscode.commands.executeCommand('setContext', 'gumby.isTransformAvailable', false)
         if (status === '') {
-            // job is running but polling has not started yet, so display generic messsage
+            // job is running but polling has not started yet, so display generic message
             status = CodeWhispererConstants.transformByQStateRunningMessage
         }
     } else if (transformByQState.isCancelled()) {
@@ -80,7 +75,7 @@ export const createTransformByQ = () => {
     } else if (transformByQState.isNotStarted()) {
         status = ''
     }
-    return showTransformByQ.build(transformTreeNode).asTreeNode({
+    return showTransformByQ.build(CodeWhispererConstants.transformTreeNode).asTreeNode({
         label: status !== '' ? `${prefix} Transform [Job status: ` + status + `]` : `Transform`,
         iconPath: transformByQState.getIconForButton(),
         tooltip: `${prefix} Transform`,

src/amazonq/explorer/amazonQChildrenNodes.ts

@@ -12,6 +12,10 @@ import { startTransformByQWithProgress, confirmStopTransformByQ } from '../codew
 import { transformByQState } from '../codewhisperer/models/model'
 import * as CodeWhispererConstants from '../codewhisperer/models/constants'
 import { ProposedTransformationExplorer } from '../codewhisperer/service/transformationResultsViewProvider'
+import { codeTransformTelemetryState } from './telemetry/codeTransformTelemetryState'
+import { telemetry } from '../shared/telemetry/telemetry'
+import { CancelActionPositions, logCodeTransformInitiatedMetric } from './telemetry/codeTransformTelemetry'
+import { CodeTransformConstants } from './models/constants'
 
 export async function activate(context: ExtContext) {
     const transformationHubViewProvider = new TransformationHubViewProvider()
@@ -25,12 +29,13 @@ export async function activate(context: ExtContext) {
         vscode.window.registerWebviewViewProvider('aws.amazonq.transformationHub', transformationHubViewProvider),
 
         Commands.register('aws.amazonq.startTransformationInHub', async () => {
+            logCodeTransformInitiatedMetric(CodeTransformConstants.HubStartButton)
             await startTransformByQWithProgress()
         }),
 
-        Commands.register('aws.amazonq.stopTransformationInHub', async () => {
+        Commands.register('aws.amazonq.stopTransformationInHub', async (cancelSrc: CancelActionPositions) => {
             if (transformByQState.isRunning()) {
-                confirmStopTransformByQ(transformByQState.getJobId())
+                confirmStopTransformByQ(transformByQState.getJobId(), cancelSrc)
             } else {
                 vscode.window.showInformationMessage(CodeWhispererConstants.noOngoingJobMessage)
             }
@@ -48,4 +53,27 @@ export async function activate(context: ExtContext) {
             vscode.commands.executeCommand('markdown.showPreview', vscode.Uri.file(transformByQState.getPlanFilePath()))
         })
     )
+
+    // Register an activation event listener to determine when the IDE opens, closes or users
+    // select to open a new workspace
+    vscode.workspace.onDidChangeWorkspaceFolders(event => {
+        // Register when the IDE is closed
+        if (event.added.length === 0 && event.removed.length === 0) {
+            // Only fire closed during running/active job status
+            if (transformByQState.isRunning()) {
+                telemetry.codeTransform_jobIsClosedDuringIdeRun.emit({
+                    codeTransformJobId: transformByQState.getJobId(),
+                    codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+                    codeTransformStatus: transformByQState.getStatus(),
+                })
+            }
+        } else {
+            // Register when the workspace is changed to a new project, or IDE is opened
+            telemetry.codeTransform_jobIsResumedAfterIdeClose.emit({
+                codeTransformJobId: transformByQState.getJobId(),
+                codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+                codeTransformStatus: transformByQState.getStatus(),
+            })
+        }
+    })
 }

src/amazonqGumby/activation.ts

@@ -9,6 +9,7 @@ import { transformByQState } from '../codewhisperer/models/model'
 import { AuthUtil } from '../codewhisperer/util/authUtil'
 import vscode from 'vscode'
 import { sleep } from '../shared/utilities/timeoutUtils'
+import { telemetry } from '../shared/telemetry/telemetry'
 
 export async function processTransformByQ() {
     if (!AuthUtil.instance.isEnterpriseSsoInUse()) {
@@ -17,6 +18,7 @@ export async function processTransformByQ() {
     }
     if (transformByQState.isNotStarted()) {
         await sleep(1000) // sleep so that chat can respond first, then show input prompt
+        telemetry.codeTransform_jobIsStartedFromChatPrompt.emit()
         startTransformByQWithProgress()
     } else {
         vscode.window.showInformationMessage(jobInProgressMessage, { modal: true })

src/amazonqGumby/entrypoint.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export enum CodeTransformConstants {
+    HubStartButton = 'HubStartButton',
+}

src/amazonqGumby/models/constants.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ToolkitError } from '../../shared/errors'
+
+export class TransformByQUploadArchiveFailed extends ToolkitError {
+    constructor() {
+        // do not chain the error due to security issues (may contain the uploadUrl)
+        super('Failed to zip code and upload it to S3')
+    }
+}
+
+export class TransformByQJavaProjectNotFound extends ToolkitError {
+    constructor() {
+        super('No Java projects found', { code: 'NoJavaProjectsAvailable' })
+    }
+}

src/amazonqGumby/models/model.ts

@@ -0,0 +1,58 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * This class contains helper methods dedicated to logging metrics specific to
+ * CodeTransform
+ */
+
+import { telemetry } from '../../shared/telemetry/telemetry'
+import { JDKVersion } from '../../codewhisperer/models/model'
+import * as CodeWhispererConstants from '../../codewhisperer/models/constants'
+import { codeTransformTelemetryState } from './codeTransformTelemetryState'
+
+export enum CancelActionPositions {
+    ApiError = 'apiError',
+    LoadingPanel = 'loadingPanelStopButton',
+    DevToolsSidePanel = 'devToolsStopButton',
+    BottomHubPanel = 'bottomPanelSideNavButton',
+}
+
+export enum StartActionPositions {
+    DevToolsSidePanel = 'devToolsStartButton',
+    BottomHubPanel = 'bottomPanelSideNavButton',
+}
+
+export const logCodeTransformInitiatedMetric = (source: string): void => {
+    const commonMetrics = {
+        codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+    }
+
+    if (source === CodeWhispererConstants.transformTreeNode) {
+        telemetry.codeTransform_isDoubleClickedToTriggerUserModal.emit({
+            codeTransformStartSrcComponents: StartActionPositions.DevToolsSidePanel,
+            ...commonMetrics,
+        })
+    } else if (source === StartActionPositions.BottomHubPanel) {
+        telemetry.codeTransform_isDoubleClickedToTriggerUserModal.emit({
+            codeTransformStartSrcComponents: StartActionPositions.BottomHubPanel,
+            ...commonMetrics,
+        })
+    }
+}
+
+//TODO: it would be better to expand JDKVersion from an enum to a class
+export const toJDKMetricValue = (source: JDKVersion): string => {
+    switch (source) {
+        case JDKVersion.JDK8:
+            return 'jdk8'
+        case JDKVersion.JDK11:
+            return 'jdk11'
+        case JDKVersion.JDK17:
+            return 'jdk17'
+        default:
+            return ''
+    }
+}
+
+export const calculateTotalLatency = (startTime: number, endTime: number = Date.now()): number => endTime - startTime

src/amazonqGumby/telemetry/codeTransformTelemetry.ts

@@ -32,6 +32,10 @@ import { FileSystemCommon } from '../../srcShared/fs'
 import { Mutable } from '../../shared/utilities/tsUtils'
 import { CodeWhispererSource } from './types'
 import { showManageConnections } from '../../auth/ui/vue/show'
+import {
+    CancelActionPositions,
+    logCodeTransformInitiatedMetric,
+} from '../../amazonqGumby/telemetry/codeTransformTelemetry'
 import { FeatureConfigProvider } from '../service/featureConfigProvider'
 
 export const toggleCodeSuggestions = Commands.declare(
@@ -98,7 +102,6 @@ export const showSecurityScan = Commands.declare(
         }
 )
 
-export const transformTreeNode = 'qTreeNode'
 export const showTransformByQ = Commands.declare(
     { id: 'aws.awsq.transform', compositeKey: { 0: 'source' } },
     (context: ExtContext) => async (source: string) => {
@@ -107,14 +110,15 @@ export const showTransformByQ = Commands.declare(
         }
 
         if (transformByQState.isNotStarted()) {
+            logCodeTransformInitiatedMetric(source)
             startTransformByQWithProgress()
         } else if (transformByQState.isCancelled()) {
             vscode.window.showInformationMessage(CodeWhispererConstants.cancellationInProgressMessage)
         } else if (transformByQState.isRunning()) {
-            await confirmStopTransformByQ(transformByQState.getJobId())
+            await confirmStopTransformByQ(transformByQState.getJobId(), CancelActionPositions.DevToolsSidePanel)
         }
         // emit telemetry if clicked from tree node
-        if (source === transformTreeNode) {
+        if (source === CodeWhispererConstants.transformTreeNode) {
             telemetry.ui_click.emit({
                 elementId: 'amazonq_transform',
                 passive: false,