fix: Command arg fix (#4048)

* fix: vscode command unexpected arg

Problem:

If a command is execute by a VS Code UI component like
an ellipsis or tree node, it is possible for the args
of that component to be incorrect since vscode will not
use the proper arguments.

Solution:

Add a new type called VsCodeCommandArgument that is a
placeholder for that unexpected argument. When the command
is used within the code we should set the value to `undefined`
and when it is executed by a VS Code UI component it will be
defined which indicates the other args will not exist.

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

* refactor: showManageConnections command on its own

This gets rid of the auth Command class that contains
showManageConnections and instead makes it its own
standalone command.

We are doing this to have more control over the
registration of the command since there are certain
options we need to set.

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

* fix: handle invalid arg for command auth

See the big comment in the function, but we are essentially
filling in a missing value because the function can be called
incorrectly and we need to handle this case without throwing
an error.

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

* tests: fix failing tests due to previous changes

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

* fix log message

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

* fix log messages

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

---------

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

Author: nkomonen-amazon

src/auth/activation.ts

@@ -8,12 +8,12 @@ import { AwsContext } from '../shared/awsContext'
 import { Auth } from './auth'
 import { LoginManager } from './deprecated/loginManager'
 import { fromString } from './providers/credentials'
-import { registerCommandsWithVSCode } from '../shared/vscode/commands2'
-import { AuthCommandBackend, AuthCommandDeclarations } from './commands'
+import { placeholder } from '../shared/vscode/commands2'
 import { getLogger } from '../shared/logger'
 import { ExtensionUse } from './utils'
 import { isCloud9 } from '../shared/extensionUtilities'
 import { isInDevEnv } from '../codecatalyst/utils'
+import { showManageConnections } from './ui/vue/show'
 
 export async function initialize(
     extensionContext: vscode.ExtensionContext,
@@ -29,11 +29,7 @@ export async function initialize(
         }
     })
 
-    registerCommandsWithVSCode(
-        extensionContext,
-        AuthCommandDeclarations.instance,
-        new AuthCommandBackend(extensionContext)
-    )
+    extensionContext.subscriptions.push(showManageConnections.register(extensionContext))
 
     showManageConnectionsOnStartup()
 }
@@ -57,5 +53,5 @@ async function showManageConnectionsOnStartup() {
     }
 
     // Show connection management to user
-    AuthCommandDeclarations.instance.declared.showManageConnections.execute('firstStartup')
+    showManageConnections.execute(placeholder, 'firstStartup')
 }

src/auth/commands.ts

@@ -32,19 +32,28 @@ import {
     isIamConnection,
     isSsoConnection,
 } from '../../connection'
-import { tryAddCredentials, signout, showRegionPrompter, promptAndUseConnection, ExtensionUse } from '../../utils'
+import {
+    tryAddCredentials,
+    signout,
+    showRegionPrompter,
+    promptAndUseConnection,
+    ExtensionUse,
+    showConnectionsPageCommand,
+    addConnection,
+} from '../../utils'
 import { Region } from '../../../shared/regions/endpoints'
 import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { validateSsoUrl, validateSsoUrlFormat } from '../../sso/validation'
 import { debounce } from '../../../shared/utilities/functionUtils'
-import { AuthError, ServiceItemId, userCancelled } from './types'
+import { AuthError, ServiceItemId, isServiceItemId, userCancelled } from './types'
 import { awsIdSignIn } from '../../../codewhisperer/util/showSsoPrompt'
 import { connectToEnterpriseSso } from '../../../codewhisperer/util/getStartUrl'
 import { trustedDomainCancellation } from '../../sso/model'
 import { FeatureId, CredentialSourceId, Result, telemetry } from '../../../shared/telemetry/telemetry'
 import { AuthFormId, isBuilderIdAuth } from './authForms/types'
 import { handleWebviewError } from '../../../webviews/server'
 import { cwQuickPickSource, cwTreeNodeSource } from '../../../codewhisperer/commands/types'
+import { Commands, VsCodeCommandArg, placeholder, vscodeComponent } from '../../../shared/vscode/commands2'
 
 export class AuthWebview extends VueWebview {
     public override id: string = 'authWebview'
@@ -712,20 +721,42 @@ const Panel = VueWebview.compilePanel(AuthWebview)
 let activePanel: InstanceType<typeof Panel> | undefined
 let subscriptions: vscode.Disposable[] | undefined
 
+/**
+ * Different places the Add Connection command could be executed from.
+ *
+ * Useful for telemetry.
+ */
 export const AuthSources = {
     addConnectionQuickPick: 'addConnectionQuickPick',
     firstStartup: 'firstStartup',
     codecatalystDeveloperTools: 'codecatalystDeveloperTools',
-    unknown: 'unknown',
+    vscodeComponent: vscodeComponent,
     cwQuickPick: cwQuickPickSource,
-    cwTreeNode: cwTreeNodeSource
+    cwTreeNode: cwTreeNodeSource,
+    authNode: 'authNode'
 } as const
 
-export type AuthSource = typeof AuthSources[keyof typeof AuthSources]
+export type AuthSource = (typeof AuthSources)[keyof typeof AuthSources]
+
+export const showManageConnections = Commands.declare(
+    { id: showConnectionsPageCommand, compositeKey: { 1: 'source' } },
+    (context: vscode.ExtensionContext) => (_: VsCodeCommandArg, source: AuthSource, serviceToShow?: ServiceItemId) => {
+        // The auth webview page does not make sense to use in C9,
+        // so show the auth quick pick instead.
+        if (isCloud9('any')) {
+            return addConnection.execute()
+        }
 
-export function isAuthSource(obj: any): obj is AuthSource {
-    return Object.values(AuthSources).includes(obj)
-} 
+        if (_ !== placeholder) {
+            source = 'vscodeComponent'
+        }
+
+        if (!isServiceItemId(serviceToShow)) {
+            serviceToShow = undefined
+        }
+        return showAuthWebview(context, source, serviceToShow)
+    }
+)
 
 export async function showAuthWebview(
     ctx: vscode.ExtensionContext,

src/auth/ui/vue/show.ts

@@ -42,7 +42,7 @@ import {
     isIamConnection,
     isValidCodeCatalystConnection,
 } from './connection'
-import { Commands } from '../shared/vscode/commands2'
+import { Commands, placeholder, vscodeComponent } from '../shared/vscode/commands2'
 import { Auth } from './auth'
 import { validateIsNewSsoUrl, validateSsoUrlFormat } from './sso/validation'
 import { openUrl } from '../shared/utilities/vsCodeUtils'
@@ -62,7 +62,7 @@ export async function promptForConnection(auth: Auth, type?: 'iam' | 'sso'): Pro
     if (resp === 'addNewConnection') {
         // TODO: Cannot call function directly due to circular dependency. Refactor to fix this.
         const source: AuthSource = 'addConnectionQuickPick' // enforcing type sanity check
-        vscode.commands.executeCommand(showConnectionsPageCommand, source)
+        vscode.commands.executeCommand(showConnectionsPageCommand, placeholder, source)
         return undefined
     }
 
@@ -490,7 +490,8 @@ export const login = Commands.register('aws.login', async () => {
     const auth = Auth.instance
     const connections = await auth.listConnections()
     if (connections.length === 0) {
-        return vscode.commands.executeCommand(showConnectionsPageCommand)
+        const source: AuthSource = vscodeComponent
+        return vscode.commands.executeCommand(showConnectionsPageCommand, placeholder, source)
     } else {
         return switchConnections.execute(auth)
     }
@@ -524,7 +525,12 @@ export class AuthNode implements TreeNode<Auth> {
 
         if (!this.resource.hasConnections) {
             const item = new vscode.TreeItem(`Connect to ${getIdeProperties().company} to Get Started...`)
-            item.command = { title: 'Add Connection', command: showConnectionsPageCommand }
+            const source: AuthSource = 'authNode'
+            item.command = {
+                title: 'Add Connection',
+                command: showConnectionsPageCommand,
+                arguments: [placeholder, source],
+            }
 
             return item
         }

src/auth/utils.ts

@@ -17,13 +17,13 @@ import { watchRestartingDevEnvs } from './reconnect'
 import { PromptSettings } from '../shared/settings'
 import { dontShow } from '../shared/localizedText'
 import { getIdeProperties, isCloud9 } from '../shared/extensionUtilities'
-import { Commands } from '../shared/vscode/commands2'
+import { Commands, placeholder } from '../shared/vscode/commands2'
 import { getCodeCatalystConfig } from '../shared/clients/codecatalystClient'
 import { isDevenvVscode } from './utils'
 import { getThisDevEnv } from './model'
 import { getLogger } from '../shared/logger/logger'
 import { InactivityMessage, shouldTrackUserActivity } from './devEnv'
-import { AuthCommandDeclarations } from '../auth/commands'
+import { showManageConnections } from '../auth/ui/vue/show'
 
 const localize = nls.loadMessageBundle()
 
@@ -39,10 +39,7 @@ export async function activate(ctx: ExtContext): Promise<void> {
         uriHandlers.register(ctx.uriHandler, CodeCatalystCommands.declared),
         ...Object.values(CodeCatalystCommands.declared).map(c => c.register(commands)),
         Commands.register('aws.codecatalyst.manageConnections', () => {
-            AuthCommandDeclarations.instance.declared.showManageConnections.execute(
-                'codecatalystDeveloperTools',
-                'codecatalyst'
-            )
+            showManageConnections.execute(placeholder, 'codecatalystDeveloperTools', 'codecatalyst')
         }),
         Commands.register('aws.codecatalyst.signout', () => {
             return authProvider.secondaryAuth.deleteConnection()

src/codecatalyst/activation.ts

@@ -9,15 +9,15 @@ import { DevEnvironment } from '../shared/clients/codecatalystClient'
 import { isCloud9 } from '../shared/extensionUtilities'
 import { addColor, getIcon } from '../shared/icons'
 import { TreeNode } from '../shared/treeview/resourceTreeDataProvider'
-import { Commands } from '../shared/vscode/commands2'
+import { Commands, placeholder } from '../shared/vscode/commands2'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { CodeCatalystCommands } from './commands'
 import { ConnectedDevEnv, getDevfileLocation, getThisDevEnv } from './model'
 import * as codecatalyst from './model'
 import { getLogger } from '../shared/logger'
 import { Connection, isBuilderIdConnection } from '../auth/connection'
 import { openUrl } from '../shared/utilities/vsCodeUtils'
-import { AuthCommandDeclarations } from '../auth/commands'
+import { showManageConnections } from '../auth/ui/vue/show'
 
 const learnMoreCommand = Commands.register('aws.learnMore', async (docsUrl: vscode.Uri) => {
     return openUrl(docsUrl)
@@ -35,12 +35,10 @@ async function getLocalCommands(auth: CodeCatalystAuthenticationProvider) {
     const docsUrl = isCloud9() ? codecatalyst.docs.cloud9.overview : codecatalyst.docs.vscode.overview
     if (!isBuilderIdConnection(auth.activeConnection) || !(await auth.isConnectionOnboarded(auth.activeConnection))) {
         return [
-            AuthCommandDeclarations.instance.declared.showManageConnections
-                .build('codecatalystDeveloperTools', 'codecatalyst')
-                .asTreeNode({
-                    label: 'Start',
-                    iconPath: getIcon('vscode-debug-start'),
-                }),
+            showManageConnections.build(placeholder, 'codecatalystDeveloperTools', 'codecatalyst').asTreeNode({
+                label: 'Start',
+                iconPath: getIcon('vscode-debug-start'),
+            }),
             learnMoreCommand.build(docsUrl).asTreeNode({
                 label: 'Learn More about CodeCatalyst',
                 iconPath: getIcon('vscode-question'),

src/codecatalyst/explorer.ts

@@ -36,7 +36,7 @@ import {
     notifyNewCustomizationsCmd,
     connectWithCustomization,
     signoutCodeWhisperer,
-    showManageConnections,
+    showManageCwConnections,
 } from './commands/basicCommands'
 import { sleep } from '../shared/utilities/timeoutUtils'
 import { ReferenceLogViewProvider } from './service/referenceLogViewProvider'
@@ -94,7 +94,7 @@ export async function activate(context: ExtContext): Promise<void> {
 
     context.extensionContext.subscriptions.push(
         signoutCodeWhisperer.register(auth),
-        showManageConnections.register(),
+        showManageCwConnections.register(),
         /**
          * Configuration change
          */