refactor: extract codewhisperer tree view setup (#4428)

Problem:
We want to use the CodeWhisperer tree view in the explorer
but when enabling it the current code will try and enable
the other tree views such as the Resource Explorer

Solution:
Extract the logic for the tree view that we want to work
in both node and browser environments in to its own shared
activate function.

Now we can use that shared activation for both environments.

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

Author: nkomonen-amazon

packages/toolkit/src/awsexplorer/activation.ts

@@ -21,24 +21,21 @@ import { AwsExplorer } from './awsExplorer'
 import { copyTextCommand } from './commands/copyText'
 import { loadMoreChildrenCommand } from './commands/loadMoreChildren'
 import { checkExplorerForDefaultRegion } from './defaultRegion'
-import { createToolView, ToolView } from './toolView'
+import { ToolView } from './toolView'
 import { telemetry } from '../shared/telemetry/telemetry'
-import { cdkNode, CdkRootNode, refreshCdkExplorer } from '../cdk/explorer/rootNode'
-import {
-    CodeWhispererNode,
-    getCodewhispererNode,
-    refreshCodeWhisperer,
-    refreshCodeWhispererRootNode,
-} from '../codewhisperer/explorer/codewhispererNode'
-import { once } from '../shared/utilities/functionUtils'
+import { cdkNode, refreshCdkExplorer } from '../cdk/explorer/rootNode'
 import { CodeCatalystRootNode } from '../codecatalyst/explorer'
 import { CodeCatalystAuthenticationProvider } from '../codecatalyst/auth'
 import { S3FolderNode } from '../s3/explorer/s3FolderNode'
 import { amazonQNode, refreshAmazonQ, refreshAmazonQRootNode } from '../amazonq/explorer/amazonQNode'
 import { GlobalState } from '../shared/globalState'
+import { activateViewsShared, registerToolView } from './activationShared'
 
 /**
  * Activates the AWS Explorer UI and related functionality.
+ *
+ * IMPORTANT: Views that should work in all vscode environments (node or browser)
+ * should be setup in {@link activateViewsShared}.
  */
 export async function activate(args: {
     context: ExtContext
@@ -119,30 +116,9 @@ export async function activate(args: {
         ...amazonQViewNode,
         ...codecatalystViewNode,
         { nodes: [cdkNode], view: 'aws.cdk', refreshCommands: [refreshCdkExplorer] },
-        {
-            nodes: [getCodewhispererNode()],
-            view: 'aws.codewhisperer',
-            refreshCommands: [refreshCodeWhisperer, refreshCodeWhispererRootNode],
-        },
     ]
     for (const viewNode of viewNodes) {
-        const toolView = createToolView(viewNode)
-        args.context.extensionContext.subscriptions.push(toolView)
-        if (viewNode.view === 'aws.cdk') {
-            // Legacy CDK behavior. Mostly useful for C9 as they do not have inline buttons.
-            toolView.onDidChangeVisibility(({ visible }) => visible && cdkNode.refresh())
-        }
-
-        toolView.onDidExpandElement(e => {
-            if (e.element.resource instanceof CdkRootNode) {
-                // Legacy CDK metric, remove this when we add something generic
-                const recordExpandCdkOnce = once(() => telemetry.cdk_appExpanded.emit())
-                recordExpandCdkOnce()
-            } else if (e.element.resource instanceof CodeWhispererNode) {
-                const onDidExpandCodeWhisperer = once(() => telemetry.ui_click.emit({ elementId: 'cw_parentNode' }))
-                onDidExpandCodeWhisperer()
-            }
-        })
+        registerToolView(viewNode, args.context.extensionContext)
     }
 }
 

packages/toolkit/src/awsexplorer/activationShared.ts

@@ -0,0 +1,51 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import * as vscode from 'vscode'
+import { createToolView, ToolView } from './toolView'
+import { telemetry } from '../shared/telemetry/telemetry'
+import { cdkNode, CdkRootNode } from '../cdk/explorer/rootNode'
+import {
+    CodeWhispererNode,
+    getCodewhispererNode,
+    refreshCodeWhisperer,
+    refreshCodeWhispererRootNode,
+} from '../codewhisperer/explorer/codewhispererNode'
+import { once } from '../shared/utilities/functionUtils'
+
+/**
+ * Activates vscode Views (eg tree view) that work in any vscode environment (nodejs or browser).
+ */
+export async function activateViewsShared(context: vscode.ExtensionContext): Promise<void> {
+    registerToolView(getCodeWhispererToolView(), context)
+}
+
+export function getCodeWhispererToolView(): ToolView {
+    return {
+        nodes: [getCodewhispererNode()],
+        view: 'aws.codewhisperer',
+        refreshCommands: [refreshCodeWhisperer, refreshCodeWhispererRootNode],
+    }
+}
+
+export function registerToolView(viewNode: ToolView, context: vscode.ExtensionContext) {
+    const toolView = createToolView(viewNode)
+    context.subscriptions.push(toolView)
+    if (viewNode.view === 'aws.cdk') {
+        // Legacy CDK behavior. Mostly useful for C9 as they do not have inline buttons.
+        toolView.onDidChangeVisibility(({ visible }) => visible && cdkNode.refresh())
+    }
+
+    toolView.onDidExpandElement(e => {
+        if (e.element.resource instanceof CdkRootNode) {
+            // Legacy CDK metric, remove this when we add something generic
+            const recordExpandCdkOnce = once(() => telemetry.cdk_appExpanded.emit())
+            recordExpandCdkOnce()
+        } else if (e.element.resource instanceof CodeWhispererNode) {
+            const onDidExpandCodeWhisperer = once(() => telemetry.ui_click.emit({ elementId: 'cw_parentNode' }))
+            onDidExpandCodeWhisperer()
+        }
+    })
+}

packages/toolkit/src/extensionShared.ts

@@ -19,6 +19,7 @@ import { getIdeProperties, aboutToolkit, isCloud9 } from './shared/extensionUtil
 import { telemetry } from './shared/telemetry/telemetry'
 import { openUrl } from './shared/utilities/vsCodeUtils'
 import { activate as activateCodeWhisperer, shutdown as codewhispererShutdown } from './codewhisperer/activation'
+import { activateViewsShared } from './awsexplorer/activationShared'
 
 import { activate as activateLogger } from './shared/logger/activation'
 import { initializeComputeRegion } from './shared/extensionUtilities'
@@ -135,6 +136,8 @@ export async function activateShared(
         credentialsStore: globals.loginManager.store,
     }
 
+    await activateViewsShared(extContext.extensionContext)
+
     await activateCodeWhisperer(extContext)
 
     return extContext