fix(telemetry): do not throttle named events from commands #3032

Problem:
* Telemetry package is outdated
* Events emitted from commands are throttled by default, but this isn't desirable for 'named' events
  * Only affects certain CodeCatalyst commands

Solution:
* Update package
* Skip throttling when commands have a telemetry name
  * Test coverage was added for this

Author: JadenSimon

package-lock.json

@@ -3499,7 +3499,7 @@
         "report": "nyc report --reporter=html --reporter=json"
     },
     "devDependencies": {
-        "@aws-toolkits/telemetry": "^1.0.80",
+        "@aws-toolkits/telemetry": "^1.0.82",
         "@cspotcode/source-map-support": "^0.8.1",
         "@sinonjs/fake-timers": "^8.1.0",
         "@types/adm-zip": "^0.4.34",

package.json

@@ -10,7 +10,7 @@ const localize = nls.loadMessageBundle()
 
 import * as vscode from 'vscode'
 import { selectCodeCatalystResource } from './wizards/selectResource'
-import { openCodeCatalystUrl } from './utils'
+import { openCodeCatalystUrl, recordSource } from './utils'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { Commands } from '../shared/vscode/commands2'
 import { CodeCatalystClient, CodeCatalystResource, createClient } from '../shared/clients/codecatalystClient'
@@ -236,7 +236,7 @@ export class CodeCatalystCommands {
         // need to be careful of mapping explosion so this granular data would either need
         // to be flattened or we restrict the names to a pre-determined set
         if (id === undefined) {
-            telemetry.codecatalyst_connect.record({ source: 'CommandPalette' })
+            recordSource('CommandPalette')
         }
 
         return this.withClient(openDevEnv, devenv, targetPath)

src/codecatalyst/commands.ts

@@ -15,7 +15,7 @@ import { showViewLogsMessage } from '../shared/utilities/messages'
 import { CodeCatalystAuthenticationProvider } from './auth'
 import { getCodeCatalystDevEnvId } from '../shared/vscode/env'
 import globals from '../shared/extensionGlobals'
-import { telemetry } from '../shared/telemetry/telemetry'
+import { recordSource } from './utils'
 
 const localize = nls.loadMessageBundle()
 
@@ -223,7 +223,7 @@ async function openReconnectedDevEnv(
         project: { name: devenv.projectName },
     }
 
-    telemetry.codecatalyst_connect.record({ source: 'Reconnect' })
+    recordSource('Reconnect')
     await codeCatalystConnectCommand.execute(client, identifier, devenv.previousVscodeWorkspace)
 
     // When we only have 1 devenv to watch we might as well close the local vscode instance

src/codecatalyst/reconnect.ts

@@ -7,14 +7,14 @@ import * as vscode from 'vscode'
 import { SearchParams, UriHandler } from '../shared/vscode/uriHandler'
 import { getCodeCatalystConfig } from '../shared/clients/codecatalystClient'
 import { CodeCatalystCommands } from './commands'
-import { telemetry } from '../shared/telemetry/telemetry'
+import { recordSource } from './utils'
 
 export function register(
     handler: UriHandler,
     commands: Pick<typeof CodeCatalystCommands.declared, 'cloneRepo' | 'openDevEnv'>
 ) {
     async function cloneHandler(params: ReturnType<typeof parseCloneParams>) {
-        telemetry.codecatalyst_localClone.record({ source: 'UriHandler' })
+        recordSource('UriHandler')
 
         if (params.url.authority.endsWith(getCodeCatalystConfig().gitHostname)) {
             await commands.cloneRepo.execute(params.url)
@@ -24,7 +24,7 @@ export function register(
     }
 
     async function connectHandler(params: ReturnType<typeof parseConnectParams | typeof parseConnectParamsOld>) {
-        telemetry.codecatalyst_connect.record({ source: 'UriHandler' })
+        recordSource('UriHandler')
 
         await commands.openDevEnv.execute({
             id: params.devEnvironmentId,

src/codecatalyst/uriHandlers.ts

@@ -7,6 +7,7 @@ import { Ides } from 'aws-sdk/clients/codecatalyst'
 import * as vscode from 'vscode'
 import { CodeCatalystResource, getCodeCatalystConfig } from '../shared/clients/codecatalystClient'
 import { pushIf } from '../shared/utilities/collectionUtils'
+import { telemetry } from '../shared/telemetry/telemetry'
 
 /**
  * Builds a web URL from the given CodeCatalyst object.
@@ -54,3 +55,9 @@ export function openCodeCatalystUrl(o: CodeCatalystResource) {
 export function isCodeCatalystVSCode(ides: Ides | undefined): boolean {
     return ides !== undefined && ides.findIndex(ide => ide.name === 'VSCode') !== -1
 }
+
+export function recordSource(source: 'Webview' | 'UriHandler' | 'Reconnect' | 'CommandPalette') {
+    // TODO: add `source` (or something similar) as a base component to events
+    telemetry.codecatalyst_connect.record({ source } as any)
+    telemetry.codecatalyst_localClone.record({ source } as any)
+}

src/codecatalyst/utils.ts

@@ -31,6 +31,7 @@ import { CancellationError } from '../../../shared/utilities/timeoutUtils'
 import { isCloud9 } from '../../../shared/extensionUtilities'
 import { telemetry } from '../../../shared/telemetry/telemetry'
 import { isNonNullable } from '../../../shared/utilities/tsUtils'
+import { recordSource } from '../../utils'
 
 interface LinkedResponse {
     readonly type: 'linked'
@@ -141,7 +142,7 @@ export class CodeCatalystCreateWebview extends VueWebview {
             }
         })()
 
-        telemetry.codecatalyst_connect.record({ source: 'Webview' })
+        recordSource('Webview')
         telemetry.codecatalyst_createDevEnvironment.record({ codecatalyst_createDevEnvironmentRepoType: source.type })
 
         this.onComplete(devenv)

src/codecatalyst/vue/create/backend.ts

@@ -31,23 +31,6 @@
             "name": "cli",
             "type": "string",
             "description": "Installed CLI"
-        },
-        {
-            "name": "codecatalyst_createDevEnvironmentRepoType",
-            "type": "string",
-            "description": "Type of Git repository provided to the Code Catalyst workspace create wizard",
-            "allowedValues": ["linked", "none"]
-        },
-        {
-            "name": "codecatalyst_updateDevEnvironmentLocationType",
-            "type": "string",
-            "description": "Locality of the Code Catalyst update workspace request (i.e., from the thin client or the local IDE instance)",
-            "allowedValues": ["remote", "local"]
-        },
-        {
-            "name": "userId",
-            "type": "string",
-            "description": "Opaque AWS ID identifier"
         }
     ],
     "metrics": [
@@ -256,42 +239,6 @@
         {
             "name": "sam_openConfigUi",
             "description": "Called after opening the SAM Config UI"
-        },
-        {
-            "name": "codecatalyst_createDevEnvironment",
-            "description": "Create a Code Catalyst DevEnv",
-            "metadata": [
-                { "type": "result" },
-                { "type": "userId" },
-                {
-                    "type": "codecatalyst_createDevEnvironmentRepoType",
-                    "required": false
-                }
-            ]
-        },
-        {
-            "name": "codecatalyst_updateDevEnvironmentSettings",
-            "description": "Update properties of a Code Catalyst development environment",
-            "metadata": [
-                { "type": "result" },
-                { "type": "userId" },
-                { "type": "codecatalyst_updateDevEnvironmentLocationType" }
-            ]
-        },
-        {
-            "name": "codecatalyst_updateDevfile",
-            "description": "Trigger a devfile update on a Code Catalyst development environment",
-            "metadata": [{ "type": "result" }, { "type": "userId" }]
-        },
-        {
-            "name": "codecatalyst_localClone",
-            "description": "Clone a Code Catalyst code repository locally",
-            "metadata": [{ "type": "result" }, { "type": "userId" }, { "type": "source", "required": false }]
-        },
-        {
-            "name": "codecatalyst_connect",
-            "description": "Connect to a Code Catalyst development environment",
-            "metadata": [{ "type": "result" }, { "type": "userId" }, { "type": "source", "required": false }]
         }
     ]
 }