ec2: add telemetry to connect flow. (#3611)

* add empty connect command

* create sample QuickPick on click

* hacky prompt + func to list instanceId

* very hacky way to create prompt with instanceIds

* move extractInstanceIds to own function

* utilize lastTouchedRegion in prompt

* throw cancellationError on user cancel

* add a title to quickpick

* refactor: increase testability

* move test utility func to shared utility file

* add general test cases for extractInstanceIdsFromReservations

* add basic test for prompter

* configure command to devMode

* refactor to utilize wizard + integrate regionSubmenu

* add new testing file

* refactor to utilize regionSubmenu in isolation, rather than wrapped in Wizard class

* fix awkward indent

* add test file from feature/cwl branch

* remove old prompter old + tests

* delete tests that rely on feature/cwl changes

* refactor to avoid circular dependency

* fix improper headers + imports

* introduce Ec2ConnectClient to handle connection

* remove dead parameter

* close connection on terminal close

* add a little more to error msg

* remove dead imports

* log error to console

* rename function

Co-authored-by: Justin M. Keyes <[email protected]>

* fix header

Co-authored-by: Justin M. Keyes <[email protected]>

* fix headers and imports

* remove year from header

* delete outdated test case

* delete outdated test file

* remove year from copyright header

* fix formatting of files

* remove alias in Ec2Instance

* utilize interface for object-like shape

* improve style + start of work on debugging error

* make distinction between status error and permission error

* start to add tests for error handling

* move code to general Ec2Client

* change Log Groups to selection in region submenu

* refactor to avoid circular dependency

* fix formatting

* fix formatting

* comment out the ec2Client we are not using

* style fix

* fix formatting

* add test for error handling

* fix formatting

* add extra wrapper

* generalize some code to a remoteSession file

* add space between pieces

* retrieve IAM role attached to instance when fails to connect

* remove dead import

* refactor to avoid circular dependency

* checks if relevant policies are on attached role

* use both probes to determine source of error

* update tests

* change callback to async/await

* remove onError parameter and utilize .catch instead

* add test for permissions detection

* fix test

* make error handling a try-catch

* swap ec2Client to v3

* switch over SSM client

* update tests and signatures for new error type in v3

* fix formatting

* remove dead import

* avoid unnecessary default prefix on client name

Co-authored-by: Justin M. Keyes <[email protected]>

* fix old import

* refactor defaultEc2client -> ec2Client

* rename Ec2ConnectClient

* fix outdated imports in the test

* add icons and detail to description

* update tests to use sdk3

* update tests and function names

* bubble error up

* update test case

* Remove please in text

Co-authored-by: Justin M. Keyes <[email protected]>

* Remove please in text in other error

Co-authored-by: Justin M. Keyes <[email protected]>

* remove unnecessary types and update tests to match

* add match on detail, and instance id label

* try to add telemetry

* fix telemetry to fit other examples

* fix telemetry

* remove error suffix on error code

* change language in error message

* remove error suffix

* remove manual recording + add await so that error is thrown properly

---------

Co-authored-by: Justin M. Keyes <[email protected]>

Author: Hweinstock

src/ec2/activation.ts

@@ -5,11 +5,15 @@
 import { ExtContext } from '../shared/extensions'
 import { Commands } from '../shared/vscode/commands2'
 import { tryConnect } from './commands'
+import { telemetry } from '../shared/telemetry/telemetry'
 
 export async function activate(ctx: ExtContext): Promise<void> {
     ctx.extensionContext.subscriptions.push(
         Commands.register('aws.ec2.connectToInstance', async (param?: unknown) => {
-            await tryConnect()
+            await telemetry.ec2_connectToInstance.run(async span => {
+                span.record({ ec2ConnectionType: 'ssm' })
+                await tryConnect()
+            })
         })
     )
 }

src/ec2/commands.ts

@@ -6,6 +6,7 @@
 import { createEc2ConnectPrompter, handleEc2ConnectPrompterResponse } from './prompter'
 import { isValidResponse } from '../shared/wizards/wizard'
 import { Ec2ConnectionManager } from './model'
+import { CancellationError } from '../shared/utilities/timeoutUtils'
 
 export async function tryConnect(): Promise<void> {
     const prompter = createEc2ConnectPrompter()
@@ -15,5 +16,7 @@ export async function tryConnect(): Promise<void> {
         const selection = handleEc2ConnectPrompterResponse(response)
         const ec2Client = new Ec2ConnectionManager(selection.region)
         await ec2Client.attemptEc2Connection(selection)
+    } else {
+        throw new CancellationError('user')
     }
 }

src/ec2/model.ts

@@ -82,12 +82,15 @@ export class Ec2ConnectionManager {
             )
         }
 
-        throw new ToolkitError('Is SSM running on the target instance?', {
-            code: 'EC2SSMConnect',
-            documentationUri: vscode.Uri.parse(
-                'https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html'
-            ),
-        })
+        throw new ToolkitError(
+            'Ensure SSM is running on target instance. For more information see the documentation.',
+            {
+                code: 'EC2SSMConnect',
+                documentationUri: vscode.Uri.parse(
+                    'https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html'
+                ),
+            }
+        )
     }
 
     private async openSessionInTerminal(session: Session, selection: Ec2Selection) {

src/shared/clients/ssmClient.ts

@@ -3,9 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { AWSError, SSM } from 'aws-sdk'
+import { SSM } from 'aws-sdk'
 import { getLogger } from '../logger/logger'
-import { PromiseResult } from 'aws-sdk/lib/request'
 import globals from '../extensionGlobals'
 
 export class SsmClient {
@@ -15,9 +14,7 @@ export class SsmClient {
         return await globals.sdkClientBuilder.createAwsService(SSM, undefined, this.regionCode)
     }
 
-    public async terminateSession(
-        session: SSM.Session
-    ): Promise<void | PromiseResult<SSM.TerminateSessionResponse, AWSError>> {
+    public async terminateSession(session: SSM.Session): Promise<SSM.TerminateSessionResponse> {
         const sessionId = session.SessionId!
         const client = await this.createSdkClient()
         const termination = await client
@@ -30,7 +27,7 @@ export class SsmClient {
         return termination!
     }
 
-    public async startSession(target: string): Promise<PromiseResult<SSM.StartSessionResponse, AWSError>> {
+    public async startSession(target: string): Promise<SSM.StartSessionResponse> {
         const client = await this.createSdkClient()
         const response = await client.startSession({ Target: target }).promise()
         return response

src/shared/telemetry/vscodeTelemetry.json

@@ -1,5 +1,11 @@
 {
     "types": [
+        {
+            "name": "ec2ConnectionType",
+            "type": "string",
+            "allowedValues": ["remoteDesktop", "ssh", "scp", "ssm"],
+            "description": "Ec2 Connection Methods"
+        },
         {
             "name": "codewhispererUserGroup",
             "type": "string",