fix(globals): use 'local' globals if not running web mode (aws#4754)

Problem: To get web tests working we used globalThis for globals. This is shared across extensions in VS Code, resulting in problems if another extension declares the same global twice. This is occurs when we run standalone and toolkit at the same time.

Solution: Use local globals if we are not in web mode. Otherwise, use full globals. This allows the web tests to pass. We will have to revisit this if we have 2 extensions running in web mode.

- Also add slightly more informative globals error handling.
- Refactor CW class so that globals doesn't get called during imports.

Author: hayemaxi

docs/web.md

@@ -151,3 +151,4 @@ The assumption for the behavior is due to how Web Workers work. We (VS Code) use
     -   VS Code uses Dedicated Workers since `globalThis` is indicated as a [`DedicatedWorkerGlobalScope`](https://developer.mozilla.org/en-US/docs/Web/API/DedicatedWorkerGlobalScope) when debugging
     -   `globalThis` is one object (that I could find so far) which **is shared** between our extension and test scripts. A guess to why is that the main script spawns another web worker (for unit tests) and passes on the `DedicatedWorkerGlobalScope`. See [`"Workers can also spawn other workers"`](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers).
     -   `globalThis` returns `global` in Node.js, or a `WorkerGlobalScope` in the browser
+    -   NOTE: `globalThis` is shared across all of VS Code, including all extensions.

packages/amazonq/src/extension.ts

@@ -7,7 +7,7 @@ import * as vscode from 'vscode'
 import { activateShared, deactivateShared } from './extensionShared'
 
 export async function activate(context: vscode.ExtensionContext) {
-    await activateShared(context)
+    await activateShared(context, false)
 }
 
 export async function deactivate() {

packages/amazonq/src/extensionShared.ts

@@ -36,7 +36,10 @@ import { isExtensionActive, VSCODE_EXTENSION_ID } from 'aws-core-vscode/utils'
 import { registerSubmitFeedback } from 'aws-core-vscode/feedback'
 import { telemetry, ExtStartUpSources } from 'aws-core-vscode/telemetry'
 
-export async function activateShared(context: vscode.ExtensionContext) {
+export async function activateShared(context: vscode.ExtensionContext, isWeb: boolean) {
+    initialize(context, isWeb)
+    await initializeComputeRegion()
+
     const contextPrefix = 'amazonq'
     globals.contextPrefix = 'amazonq.' //todo: disconnect from above line
 
@@ -72,8 +75,6 @@ export async function activateShared(context: vscode.ExtensionContext) {
         }
     }
 
-    await initializeComputeRegion()
-    initialize(context)
     const extContext = {
         extensionContext: context,
     }

packages/core/src/amazonqGumby/activation.ts

@@ -10,7 +10,7 @@ import { ExtContext } from '../shared/extensions'
 import { stopTransformByQ } from '../codewhisperer/commands/startTransformByQ'
 import { transformByQState } from '../codewhisperer/models/model'
 import { ProposedTransformationExplorer } from '../codewhisperer/service/transformByQ/transformationResultsViewProvider'
-import { codeTransformTelemetryState } from './telemetry/codeTransformTelemetryState'
+import { CodeTransformTelemetryState } from './telemetry/codeTransformTelemetryState'
 import { telemetry } from '../shared/telemetry/telemetry'
 import { CancelActionPositions } from './telemetry/codeTransformTelemetry'
 import { AuthUtil } from '../codewhisperer/util/authUtil'
@@ -32,14 +32,14 @@ export async function activate(context: ExtContext) {
                 if (transformByQState.isRunning()) {
                     telemetry.codeTransform_jobIsClosedDuringIdeRun.emit({
                         codeTransformJobId: transformByQState.getJobId(),
-                        codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+                        codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
                         codeTransformStatus: transformByQState.getStatus(),
                     })
                 }
             } else {
                 telemetry.codeTransform_jobIsResumedAfterIdeClose.emit({
                     codeTransformJobId: transformByQState.getJobId(),
-                    codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+                    codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
                     codeTransformStatus: transformByQState.getStatus(),
                 })
             }

packages/core/src/amazonqGumby/chat/controller/controller.ts

@@ -31,7 +31,7 @@ import { CancelActionPositions } from '../../telemetry/codeTransformTelemetry'
 import { openUrl } from '../../../shared/utilities/vsCodeUtils'
 import { telemetry } from '../../../shared/telemetry/telemetry'
 import { MetadataResult } from '../../../shared/telemetry/telemetryClient'
-import { codeTransformTelemetryState } from '../../telemetry/codeTransformTelemetryState'
+import { CodeTransformTelemetryState } from '../../telemetry/codeTransformTelemetryState'
 import { getAuthType } from '../../../codewhisperer/service/transformByQ/transformApiHandler'
 
 // These events can be interactions within the chat,
@@ -234,7 +234,7 @@ export class GumbyController {
     private async initiateTransformationOnProject(message: any) {
         const authType = await getAuthType()
         telemetry.codeTransform_jobIsStartedFromChatPrompt.emit({
-            codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
             credentialSourceId: authType,
             result: MetadataResult.Pass,
         })

packages/core/src/amazonqGumby/telemetry/codeTransformTelemetryState.ts

@@ -5,15 +5,14 @@
 
 import { randomUUID } from '../../common/crypto'
 
-interface ICodeTransformerTelemetryState {
+interface ICodeTransformTelemetryState {
     sessionId: string
     sessionStartTime: number
     resultStatus: string
 }
 
-class CodeTransformerTelemetryState {
-    private static instance: CodeTransformerTelemetryState
-    mainState: ICodeTransformerTelemetryState
+export class CodeTransformTelemetryState {
+    mainState: ICodeTransformTelemetryState
 
     private constructor() {
         this.mainState = {
@@ -23,14 +22,6 @@ class CodeTransformerTelemetryState {
         }
     }
 
-    public static getInstance(): CodeTransformerTelemetryState {
-        if (!CodeTransformerTelemetryState.instance) {
-            CodeTransformerTelemetryState.instance = new CodeTransformerTelemetryState()
-        }
-
-        return CodeTransformerTelemetryState.instance
-    }
-
     public getSessionId = () => this.mainState.sessionId
     public getStartTime = () => this.mainState.sessionStartTime
     public getResultStatus = () => this.mainState.resultStatus
@@ -44,6 +35,10 @@ class CodeTransformerTelemetryState {
     public setResultStatus = (newValue: string) => {
         this.mainState.resultStatus = newValue
     }
-}
 
-export const codeTransformTelemetryState = CodeTransformerTelemetryState.getInstance()
+    static #instance: CodeTransformTelemetryState
+
+    public static get instance() {
+        return (this.#instance ??= new this())
+    }
+}

packages/core/src/auth/activation.ts

@@ -12,9 +12,9 @@ import { ExtensionUse, initAuthCommands } from './utils'
 import { isCloud9 } from '../shared/extensionUtilities'
 import { isInDevEnv } from '../shared/vscode/env'
 import { registerCommands, getShowManageConnections } from './ui/vue/show'
-import { isWeb } from '../common/webUtils'
 import { UriHandler } from '../shared/vscode/uriHandler'
 import { authenticationPath } from './sso/ssoAccessTokenProvider'
+import { isWeb } from '../shared/extensionGlobals'
 
 export async function initialize(
     extensionContext: vscode.ExtensionContext,

packages/core/src/auth/ui/vue/show.ts

@@ -5,7 +5,7 @@
  * This module sets up the necessary components
  * for the webview to be shown.
  */
-import globals from '../../../shared/extensionGlobals'
+import globals, { isWeb } from '../../../shared/extensionGlobals'
 import { getIdeProperties, isCloud9 } from '../../../shared/extensionUtilities'
 import { VueWebview } from '../../../webviews/main'
 import * as vscode from 'vscode'
@@ -53,7 +53,6 @@ import { ClassToInterfaceType } from '../../../shared/utilities/tsUtils'
 import { debounce } from 'lodash'
 import { submitFeedback } from '../../../feedback/vue/submitFeedback'
 import { InvalidGrantException } from '@aws-sdk/client-sso-oidc'
-import { isWeb } from '../../../common/webUtils'
 import { ExtStartUpSources } from '../../../shared/telemetry'
 
 export class AuthWebview extends VueWebview {

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

@@ -37,7 +37,7 @@ import {
     CodeTransformJavaTargetVersionsAllowed,
     telemetry,
 } from '../../shared/telemetry/telemetry'
-import { codeTransformTelemetryState } from '../../amazonqGumby/telemetry/codeTransformTelemetryState'
+import { CodeTransformTelemetryState } from '../../amazonqGumby/telemetry/codeTransformTelemetryState'
 import {
     CancelActionPositions,
     JDKToTelemetryValue,
@@ -98,7 +98,7 @@ async function validateJavaHome(): Promise<boolean> {
     }
     if (javaVersionUsedByMaven !== transformByQState.getSourceJDKVersion()) {
         telemetry.codeTransform_isDoubleClickedToTriggerInvalidProject.emit({
-            codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
             codeTransformPreValidationError: 'ProjectJDKDiffersFromMavenJDK',
             result: MetadataResult.Fail,
             reason: `${transformByQState.getSourceJDKVersion()} (project) - ${javaVersionUsedByMaven} (maven)`,
@@ -143,7 +143,7 @@ export async function startTransformByQ() {
         intervalId = setInterval(() => {
             void vscode.commands.executeCommand(
                 'aws.amazonq.showPlanProgressInHub',
-                codeTransformTelemetryState.getStartTime()
+                CodeTransformTelemetryState.instance.getStartTime()
             )
         }, CodeWhispererConstants.transformationJobPollingIntervalSeconds * 1000)
 
@@ -276,9 +276,9 @@ export async function finalizeTransformationJob(status: string) {
     transformByQState.setToSucceeded()
     if (status === 'PARTIALLY_COMPLETED') {
         transformByQState.setToPartiallySucceeded()
-        codeTransformTelemetryState.setResultStatus('JobPartiallySucceeded')
+        CodeTransformTelemetryState.instance.setResultStatus('JobPartiallySucceeded')
     } else {
-        codeTransformTelemetryState.setResultStatus('JobCompletedSuccessfully')
+        CodeTransformTelemetryState.instance.setResultStatus('JobCompletedSuccessfully')
     }
 
     await vscode.commands.executeCommand('aws.amazonq.transformationHub.reviewChanges.reveal')
@@ -300,7 +300,7 @@ export async function setTransformationToRunningState() {
     sessionPlanProgress['generatePlan'] = StepProgress.Pending
     sessionPlanProgress['transformCode'] = StepProgress.Pending
 
-    codeTransformTelemetryState.setStartTime()
+    CodeTransformTelemetryState.instance.setStartTime()
 
     const projectPath = transformByQState.getProjectPath()
     let projectId = telemetryUndefined
@@ -309,7 +309,7 @@ export async function setTransformationToRunningState() {
     }
 
     telemetry.codeTransform_jobStartedCompleteFromPopupDialog.emit({
-        codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+        codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
         codeTransformJavaSourceVersionsAllowed: JDKToTelemetryValue(
             transformByQState.getSourceJDKVersion()!
         ) as CodeTransformJavaSourceVersionsAllowed,
@@ -323,7 +323,7 @@ export async function setTransformationToRunningState() {
     await vscode.commands.executeCommand('workbench.view.extension.aws-codewhisperer-transformation-hub')
     await vscode.commands.executeCommand(
         'aws.amazonq.showPlanProgressInHub',
-        codeTransformTelemetryState.getStartTime()
+        CodeTransformTelemetryState.instance.getStartTime()
     )
 }
 
@@ -351,16 +351,16 @@ export async function postTransformationJob() {
     transformByQState
         .getChatControllers()
         ?.transformationFinished.fire({ message: chatMessage, tabID: ChatSessionManager.Instance.getSession().tabID })
-    const durationInMs = calculateTotalLatency(codeTransformTelemetryState.getStartTime())
-    const resultStatusMessage = codeTransformTelemetryState.getResultStatus()
+    const durationInMs = calculateTotalLatency(CodeTransformTelemetryState.instance.getStartTime())
+    const resultStatusMessage = CodeTransformTelemetryState.instance.getResultStatus()
 
     const versionInfo = await getVersionData()
     const mavenVersionInfoMessage = `${versionInfo[0]} (${transformByQState.getMavenName()})`
     const javaVersionInfoMessage = `${versionInfo[1]} (${transformByQState.getMavenName()})`
 
     // Note: IntelliJ implementation of ResultStatusMessage includes additional metadata such as jobId.
     telemetry.codeTransform_totalRunTime.emit({
-        codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+        codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
         codeTransformResultStatusMessage: resultStatusMessage,
         codeTransformRunTimeLatency: durationInMs,
         codeTransformLocalMavenVersion: mavenVersionInfoMessage,
@@ -371,7 +371,7 @@ export async function postTransformationJob() {
 
     sessionJobHistory = processHistory(
         sessionJobHistory,
-        convertDateToTimestamp(new Date(codeTransformTelemetryState.getStartTime())),
+        convertDateToTimestamp(new Date(CodeTransformTelemetryState.instance.getStartTime())),
         transformByQState.getProjectName(),
         transformByQState.getStatus(),
         convertToTimeString(durationInMs),
@@ -402,7 +402,7 @@ export async function transformationJobErrorHandler(error: any) {
     if (!transformByQState.isCancelled()) {
         // means some other error occurred; cancellation already handled by now with stopTransformByQ
         transformByQState.setToFailed()
-        codeTransformTelemetryState.setResultStatus('JobFailed')
+        CodeTransformTelemetryState.instance.setResultStatus('JobFailed')
         // jobFailureErrorNotification should always be defined here
         let displayedErrorMessage = transformByQState.getJobFailureErrorNotification() ?? 'Job failed'
         if (transformByQState.getJobFailureMetadata() !== '') {
@@ -430,7 +430,7 @@ export async function cleanupTransformationJob(intervalId: NodeJS.Timeout | unde
     await vscode.commands.executeCommand('setContext', 'gumby.isStopButtonAvailable', false)
     await vscode.commands.executeCommand(
         'aws.amazonq.showPlanProgressInHub',
-        codeTransformTelemetryState.getStartTime()
+        CodeTransformTelemetryState.instance.getStartTime()
     )
 }
 
@@ -463,7 +463,7 @@ export async function stopTransformByQ(
     if (transformByQState.isRunning()) {
         getLogger().info('CodeTransformation: User requested to stop transformation. Stopping transformation.')
         transformByQState.setToCancelled()
-        codeTransformTelemetryState.setResultStatus('JobCancelled')
+        CodeTransformTelemetryState.instance.setResultStatus('JobCancelled')
         await vscode.commands.executeCommand('setContext', 'gumby.isStopButtonAvailable', false)
         try {
             await stopJob(jobId)
@@ -491,7 +491,7 @@ export async function stopTransformByQ(
         }
         telemetry.codeTransform_jobIsCancelledByUser.emit({
             codeTransformCancelSrcComponents: cancelSrc as CodeTransformCancelSrcComponents,
-            codeTransformSessionId: codeTransformTelemetryState.getSessionId(),
+            codeTransformSessionId: CodeTransformTelemetryState.instance.getSessionId(),
             result: MetadataResult.Pass,
         })
     }