browser: share activate() setup between different entrypoints (#4341)

## Problem
We currently have `extension.ts#activate()` and
`extensionWeb.ts#activate()` where the web version is basically a subset
of the main `activate()`. This creates code duplication.

## Solution
In `extensionShared.ts` have a shared activate function which both
entrypoints will call.
This function will consist of the same setup code regardless of
entrypoint, this will de-duplicate the code.

Note in activation order matters, so we may have to do some hacks if we
run in to any new issues as
we migrate shared code from `extension.ts` in to `extensionShared.ts`.
<!---
    REMINDER:
    - Read CONTRIBUTING.md first.
    - Add test coverage for your changes.
    - Update the changelog using `npm run newChange`.
    - Link to related issues/commits.
    - Testing: how did you test your changes?
    - Screenshots
-->

## License

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license.

---------

Signed-off-by: nkomonen <[email protected]>

Author: nkomonen-amazon

src/extension.ts

@@ -9,35 +9,27 @@ import * as nls from 'vscode-nls'
 import * as codecatalyst from './codecatalyst/activation'
 import { activate as activateAwsExplorer } from './awsexplorer/activation'
 import { activate as activateCloudWatchLogs } from './cloudWatchLogs/activation'
-import { initialize as initializeCredentials } from './auth/activation'
-import { initializeAwsCredentialsStatusBarItem } from './auth/ui/statusBarItem'
-import { LoginManager } from './auth/deprecated/loginManager'
 import { CredentialsProviderManager } from './auth/providers/credentialsProviderManager'
 import { SharedCredentialsProviderFactory } from './auth/providers/sharedCredentialsProviderFactory'
 import { activate as activateSchemas } from './eventSchemas/activation'
 import { activate as activateLambda } from './lambda/activation'
-import { DefaultAWSClientBuilder } from './shared/awsClientBuilder'
 import { activate as activateCloudFormationTemplateRegistry } from './shared/cloudformation/activation'
 import { endpointsFileUrl } from './shared/constants'
-import { DefaultAwsContext } from './shared/awsContext'
 import { AwsContextCommands } from './shared/awsContextCommands'
 import {
     getIdeProperties,
     getToolkitEnvironmentDetails,
-    initializeComputeRegion,
     isCloud9,
     isSageMaker,
     showWelcomeMessage,
 } from './shared/extensionUtilities'
 import { getLogger, Logger } from './shared/logger/logger'
-import { activate as activateLogger } from './shared/logger/activation'
 import { getEndpointsFromFetcher, RegionProvider } from './shared/regions/regionProvider'
 import { FileResourceFetcher } from './shared/resourcefetcher/fileResourceFetcher'
 import { HttpResourceFetcher } from './shared/resourcefetcher/httpResourceFetcher'
 import { activate as activateEcr } from './ecr/activation'
 import { activate as activateEc2 } from './ec2/activation'
 import { activate as activateSam } from './shared/sam/activation'
-import { activate as activateTelemetry } from './shared/telemetry/activation'
 import { activate as activateS3 } from './s3/activation'
 import * as awsFiletypes from './shared/awsFiletypes'
 import { activate as activateCodeWhisperer, shutdown as codewhispererShutdown } from './codewhisperer/activation'
@@ -52,7 +44,6 @@ import { activate as activateIot } from './iot/activation'
 import { activate as activateDev } from './dev/activation'
 import { activate as activateApplicationComposer } from './applicationcomposer/activation'
 import { activate as activateRedshift } from './redshift/activation'
-import { CredentialsStore } from './auth/credentials/store'
 import { activate as activateCWChat } from './amazonq/activation'
 import { activate as activateQGumby } from './amazonqGumby/activation'
 import { getSamCliContext } from './shared/sam/cli/samCliContext'
@@ -61,7 +52,7 @@ import { EnvVarsCredentialsProvider } from './auth/providers/envVarsCredentialsP
 import { EcsCredentialsProvider } from './auth/providers/ecsCredentialsProvider'
 import { SchemaService } from './shared/schemas'
 import { AwsResourceManager } from './dynamicResources/awsResourceManager'
-import globals, { initialize } from './shared/extensionGlobals'
+import globals from './shared/extensionGlobals'
 import { Experiments, Settings } from './shared/settings'
 import { isReleaseVersion } from './shared/vscode/env'
 import { Commands, registerErrorHandler as registerCommandErrorHandler } from './shared/vscode/commands2'
@@ -72,34 +63,24 @@ import { isUserCancelledError, resolveErrorMessageToDisplay, ToolkitError } from
 import { Logging } from './shared/logger/commands'
 import { showMessageWithUrl, showViewLogsMessage } from './shared/utilities/messages'
 import { registerWebviewErrorHandler } from './webviews/server'
-import { registerCommands, initializeManifestPaths } from './extensionShared'
 import { ChildProcess } from './shared/utilities/childProcess'
 import { initializeNetworkAgent } from './codewhisperer/client/agent'
 import { Timeout } from './shared/utilities/timeoutUtils'
 import { submitFeedback } from './feedback/vue/submitFeedback'
 import { showQuickStartWebview } from './shared/extensionStartup'
+import { activateShared } from './extensionShared'
 
 let localize: nls.LocalizeFunc
 
 export async function activate(context: vscode.ExtensionContext) {
-    initializeNetworkAgent()
-    await initializeComputeRegion()
     const activationStartedOn = Date.now()
     localize = nls.loadMessageBundle()
 
-    initialize(context)
     globals.machineId = await getMachineId()
-    initializeManifestPaths(context)
 
-    const toolkitOutputChannel = vscode.window.createOutputChannel(
-        localize('AWS.channel.aws.toolkit', '{0} Toolkit', getIdeProperties().company),
-        { log: true }
-    )
-    await activateLogger(context, toolkitOutputChannel)
     const remoteInvokeOutputChannel = vscode.window.createOutputChannel(
         localize('AWS.channel.aws.remoteInvoke', '{0} Remote Invocations', getIdeProperties().company)
     )
-    globals.outputChannel = toolkitOutputChannel
 
     registerCommandErrorHandler((info, error) => {
         const defaultMessage = localize('AWS.generic.message.error', 'Failed to run command: {0}', info.id)
@@ -124,15 +105,11 @@ export async function activate(context: vscode.ExtensionContext) {
     }
 
     try {
-        initializeCredentialsProviderManager()
-
-        const endpointsProvider = makeEndpointsProvider()
+        // IMPORTANT: If you are doing setup that should also work in browser, it should be done in the function below
+        await activateShared(context, () => RegionProvider.fromEndpointsProvider(makeEndpointsProvider()))
 
-        const awsContext = new DefaultAwsContext()
-        globals.awsContext = awsContext
-        const regionProvider = RegionProvider.fromEndpointsProvider(endpointsProvider)
-        const credentialsStore = new CredentialsStore()
-        const loginManager = new LoginManager(globals.awsContext, credentialsStore)
+        initializeNetworkAgent()
+        initializeCredentialsProviderManager()
 
         const toolkitEnvDetails = getToolkitEnvironmentDetails()
         // Splits environment details by new line, filter removes the empty string
@@ -141,11 +118,7 @@ export async function activate(context: vscode.ExtensionContext) {
             .filter(Boolean)
             .forEach(line => getLogger().info(line))
 
-        await initializeAwsCredentialsStatusBarItem(awsContext, context)
-        globals.regionProvider = regionProvider
-        globals.loginManager = loginManager
-        globals.awsContextCommands = new AwsContextCommands(regionProvider, Auth.instance)
-        globals.sdkClientBuilder = new DefaultAWSClientBuilder(awsContext)
+        globals.awsContextCommands = new AwsContextCommands(globals.regionProvider, Auth.instance)
         globals.schemaService = new SchemaService()
         globals.resourceManager = new AwsResourceManager(context)
         // Create this now, but don't call vscode.window.registerUriHandler() until after all
@@ -155,9 +128,6 @@ export async function activate(context: vscode.ExtensionContext) {
         const settings = Settings.instance
         const experiments = Experiments.instance
 
-        await activateTelemetry(context, awsContext, settings)
-        await initializeCredentials(context, awsContext, loginManager)
-
         experiments.onDidChange(({ key }) => {
             telemetry.aws_experimentActivation.run(span => {
                 // Record the key prior to reading the setting as `get` may throw
@@ -173,12 +143,12 @@ export async function activate(context: vscode.ExtensionContext) {
             extensionContext: context,
             awsContext: globals.awsContext,
             samCliContext: getSamCliContext,
-            regionProvider: regionProvider,
-            outputChannel: toolkitOutputChannel,
+            regionProvider: globals.regionProvider,
+            outputChannel: globals.outputChannel,
             invokeOutputChannel: remoteInvokeOutputChannel,
             telemetryService: globals.telemetry,
             uriHandler: globals.uriHandler,
-            credentialsStore,
+            credentialsStore: globals.loginManager.store,
         }
 
         try {
@@ -187,7 +157,6 @@ export async function activate(context: vscode.ExtensionContext) {
             getLogger().debug(`Developer Tools (internal): failed to activate: ${(error as Error).message}`)
         }
 
-        registerCommands(context)
         context.subscriptions.push(submitFeedback.register(context))
 
         // do not enable codecatalyst for sagemaker
@@ -203,8 +172,8 @@ export async function activate(context: vscode.ExtensionContext) {
 
         await activateAwsExplorer({
             context: extContext,
-            regionProvider,
-            toolkitOutputChannel,
+            regionProvider: globals.regionProvider,
+            toolkitOutputChannel: globals.outputChannel,
             remoteInvokeOutputChannel,
         })
 
@@ -219,7 +188,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
         await activateLambda(extContext)
 
-        await activateSsmDocument(context, globals.awsContext, regionProvider, toolkitOutputChannel)
+        await activateSsmDocument(context, globals.awsContext, globals.regionProvider, globals.outputChannel)
 
         await activateSam(extContext)
 
@@ -247,7 +216,7 @@ export async function activate(context: vscode.ExtensionContext) {
             await activateApplicationComposer(context)
         }
 
-        await activateStepFunctions(context, awsContext, toolkitOutputChannel)
+        await activateStepFunctions(context, globals.awsContext, globals.outputChannel)
 
         await activateRedshift(extContext)
 

src/extensionShared.ts

@@ -9,19 +9,63 @@
  */
 
 import vscode from 'vscode'
-import globals from './shared/extensionGlobals'
+import globals, { initialize } from './shared/extensionGlobals'
 import { join } from 'path'
 import { Commands } from './shared/vscode/commands2'
 import { documentationUrl, githubCreateIssueUrl, githubUrl } from './shared/constants'
 import { getIdeProperties, aboutToolkit } from './shared/extensionUtilities'
 import { telemetry } from './shared/telemetry/telemetry'
 import { openUrl } from './shared/utilities/vsCodeUtils'
 
-export function initializeManifestPaths(extensionContext: vscode.ExtensionContext) {
-    globals.manifestPaths.endpoints = extensionContext.asAbsolutePath(join('resources', 'endpoints.json'))
-    globals.manifestPaths.lambdaSampleRequests = extensionContext.asAbsolutePath(
+import { activate as activateLogger } from './shared/logger/activation'
+import { initializeComputeRegion } from './shared/extensionUtilities'
+import { activate as activateTelemetry } from './shared/telemetry/activation'
+import { DefaultAwsContext } from './shared/awsContext'
+import { Settings } from './shared/settings'
+import { DefaultAWSClientBuilder } from './shared/awsClientBuilder'
+import { initialize as initializeAuth } from './auth/activation'
+import { LoginManager } from './auth/deprecated/loginManager'
+import { CredentialsStore } from './auth/credentials/store'
+import { initializeAwsCredentialsStatusBarItem } from './auth/ui/statusBarItem'
+import { RegionProvider } from './shared/regions/regionProvider'
+
+/**
+ * Activation/setup code that is shared by the regular (nodejs) extension AND browser-compatible extension.
+ * Most setup code should live here, unless there is a reason not to.
+ *
+ * @param getRegionProvider - HACK telemetry requires the region provider but we cannot create it yet in this
+ * "shared" function since it breaks in browser. So for now the caller must provide it.
+ */
+export async function activateShared(context: vscode.ExtensionContext, getRegionProvider: () => RegionProvider) {
+    // Setup the logger
+    const toolkitOutputChannel = vscode.window.createOutputChannel('AWS Toolkit', { log: true })
+    await activateLogger(context, toolkitOutputChannel)
+    globals.outputChannel = toolkitOutputChannel
+
+    //setup globals
+    globals.awsContext = new DefaultAwsContext()
+    globals.sdkClientBuilder = new DefaultAWSClientBuilder(globals.awsContext)
+    globals.loginManager = new LoginManager(globals.awsContext, new CredentialsStore())
+
+    // some "initialize" functions
+    await initializeComputeRegion()
+    initialize(context)
+
+    // order matters here
+    globals.manifestPaths.endpoints = context.asAbsolutePath(join('resources', 'endpoints.json'))
+    globals.manifestPaths.lambdaSampleRequests = context.asAbsolutePath(
         join('resources', 'vs-lambda-sample-request-manifest.xml')
     )
+    globals.regionProvider = getRegionProvider()
+
+    // telemetry
+    await activateTelemetry(context, globals.awsContext, Settings.instance)
+
+    // auth
+    await initializeAuth(context, globals.awsContext, globals.loginManager)
+    await initializeAwsCredentialsStatusBarItem(globals.awsContext, context)
+
+    registerCommands(context)
 }
 
 /**

src/extensionWeb.ts

@@ -5,20 +5,9 @@
 
 import * as vscode from 'vscode'
 import { setInBrowser } from './common/browserUtils'
-import { activate as activateLogger } from './shared/logger/activation'
-import { initializeComputeRegion } from './shared/extensionUtilities'
-import { activate as activateTelemetry } from './shared/telemetry/activation'
 import { getLogger } from './shared/logger'
-import { DefaultAwsContext } from './shared/awsContext'
-import { Settings } from './shared/settings'
-import globals, { initialize } from './shared/extensionGlobals'
-import { registerCommands, initializeManifestPaths } from './extensionShared'
+import { activateShared } from './extensionShared'
 import { RegionProvider, defaultRegion } from './shared/regions/regionProvider'
-import { DefaultAWSClientBuilder } from './shared/awsClientBuilder'
-import { initialize as initializeCredentials } from './auth/activation'
-import { LoginManager } from './auth/deprecated/loginManager'
-import { CredentialsStore } from './auth/credentials/store'
-import { initializeAwsCredentialsStatusBarItem } from './auth/ui/statusBarItem'
 
 export async function activate(context: vscode.ExtensionContext) {
     setInBrowser(true) // THIS MUST ALWAYS BE FIRST
@@ -28,63 +17,21 @@ export async function activate(context: vscode.ExtensionContext) {
     )
 
     try {
-        // Setup the logger
-        const toolkitOutputChannel = vscode.window.createOutputChannel('AWS Toolkit', { log: true })
-        await activateLogger(context, toolkitOutputChannel)
-
-        setupGlobals()
-
-        await initializeComputeRegion()
-        initialize(context)
-        initializeManifestPaths(context)
-
-        await activateTelemetry(context, globals.awsContext, Settings.instance)
-
-        await initializeCredentials(context, globals.awsContext, globals.loginManager)
-        await initializeAwsCredentialsStatusBarItem(globals.awsContext, context)
-
-        registerCommands(context)
+        // IMPORTANT: Any new activation code should be done in the function below unless
+        // it is browser specific activation code.
+        await activateShared(context, () => {
+            return {
+                guessDefaultRegion: () => defaultRegion,
+            } as RegionProvider
+        })
     } catch (error) {
         const stacktrace = (error as Error).stack?.split('\n')
         // truncate if the stacktrace is unusually long
         if (stacktrace !== undefined && stacktrace.length > 40) {
             stacktrace.length = 40
         }
-        getLogger().error('Failed to activate extension in Browser', error)
-        throw error
+        getLogger().error(`Failed to activate extension`, error)
     }
 }
 
-/** Set up values for the `globals` object */
-function setupGlobals() {
-    globals.awsContext = new DefaultAwsContext()
-    globals.sdkClientBuilder = new DefaultAWSClientBuilder(globals.awsContext)
-
-    globals.loginManager = new LoginManager(globals.awsContext, new CredentialsStore())
-
-    setupGlobalsTempStubs()
-}
-
-/**
- * Since we are still incrementally enabling certain functionality
- * in the browser, certain global variables will not have been set
- * and functionality we enabled will not work.
- *
- * This function sets up the minimum-required stubs for the necessary
- * variables to get things working.
- *
- * If needed we can eventually create the real implementations instead
- * of stubbing.
- */
-function setupGlobalsTempStubs() {
-    // This is required for telemetry to run.
-    // The default region is arbitrary for now.
-    // We didn't create an actual instance since it
-    // will require non-trivial work to get the creation
-    // of the instance in the browser working.
-    globals.regionProvider = {
-        guessDefaultRegion: () => defaultRegion,
-    } as RegionProvider
-}
-
 export async function deactivate() {}