telemetry: update SAM CLI UA env var to something more generic (#3314)

## Problem
The name `SAM_CLI_TELEMETRY_FROM_IDE` is too specific. We're also sending more than what SAM CLI expects.

## Solution
Use `AWS_TOOLING_USER_AGENT `instead and remove extraneous pairs

Author: JadenSimon

src/shared/awsClientBuilder.ts

@@ -126,7 +126,7 @@ export class DefaultAWSClientBuilder implements AWSClientBuilder {
         }
 
         if (userAgent && !opt.customUserAgent) {
-            opt.customUserAgent = await getUserAgent({ includeClientId: true })
+            opt.customUserAgent = await getUserAgent({ includePlatform: true, includeClientId: true })
         }
 
         const apiConfig = (opt as { apiConfig?: { metadata?: Record<string, string> } } | undefined)?.apiConfig

src/shared/sam/cli/samCliInvokerUtils.ts

@@ -105,7 +105,7 @@ export async function addTelemetryEnvVar(options: SpawnOptions | undefined): Pro
     return {
         ...options,
         env: {
-            SAM_CLI_TELEMETRY_FROM_IDE: await getUserAgent({ includeClientId: false }),
+            AWS_TOOLING_USER_AGENT: await getUserAgent({ includeClientId: false }),
             ...options?.env,
         },
     }

src/shared/telemetry/util.ts

@@ -61,17 +61,22 @@ export const getClientId = shared(
     }
 )
 
+export const platformPair = () => `${env.appName.replace(/\s/g, '-')}/${version}`
+
 /**
  * Returns a string that should be used as the extension's user agent.
  *
- * Omits the `ClientId` pair by default.
+ * Omits the platform and `ClientId` pairs by default.
  */
 export async function getUserAgent(
-    opt?: { includeClientId?: boolean },
+    opt?: { includePlatform?: boolean; includeClientId?: boolean },
     globalState = globals.context.globalState
 ): Promise<string> {
-    const platformName = env.appName.replace(/\s/g, '-')
-    const pairs = [`AWS-Toolkit-For-VSCode/${extensionVersion}`, `${platformName}/${version}`]
+    const pairs = [`AWS-Toolkit-For-VSCode/${extensionVersion}`]
+
+    if (opt?.includePlatform) {
+        pairs.push(platformPair())
+    }
 
     if (opt?.includeClientId) {
         const clientId = await getClientId(globalState)

src/test/shared/sam/cli/samCliInvokerUtils.test.ts

@@ -93,7 +93,7 @@ describe('addTelemetryEnvVar', async function () {
         assert.deepStrictEqual(result, {
             cwd: '/foo',
             env: {
-                SAM_CLI_TELEMETRY_FROM_IDE: result.env?.['SAM_CLI_TELEMETRY_FROM_IDE'],
+                AWS_TOOLING_USER_AGENT: result.env?.['AWS_TOOLING_USER_AGENT'],
                 AWS_REGION: 'us-east-1',
             },
         })

src/test/shared/telemetry/util.test.ts

@@ -6,7 +6,7 @@
 import * as assert from 'assert'
 import { Memento, ConfigurationTarget } from 'vscode'
 import { Settings } from '../../../shared/settings'
-import { convertLegacy, getClientId, getUserAgent, TelemetryConfig } from '../../../shared/telemetry/util'
+import { convertLegacy, getClientId, getUserAgent, platformPair, TelemetryConfig } from '../../../shared/telemetry/util'
 import { extensionVersion } from '../../../shared/vscode/env'
 import { FakeMemento } from '../../fakeExtensionContext'
 
@@ -166,6 +166,12 @@ describe('getUserAgent', function () {
         assert.ok(lastPair?.startsWith(`AWS-Toolkit-For-VSCode/${extensionVersion}`))
     })
 
+    it('includes only one pair by default', async function () {
+        const userAgent = await getUserAgent()
+        const pairs = userAgent.split(' ')
+        assert.strictEqual(pairs.length, 1)
+    })
+
     it('omits `ClientId` by default', async function () {
         const userAgent = await getUserAgent()
         assert.ok(!userAgent.includes('ClientId'))
@@ -176,4 +182,12 @@ describe('getUserAgent', function () {
         const lastPair = userAgent.split(' ').pop()
         assert.ok(lastPair?.startsWith('ClientId/'))
     })
+
+    it('includes the platform before `ClientId` if opted in', async function () {
+        const userAgent = await getUserAgent({ includePlatform: true, includeClientId: true })
+        const pairs = userAgent.split(' ')
+        const clientPairIndex = pairs.findIndex(pair => pair.startsWith('ClientId/'))
+        const beforeClient = pairs[clientPairIndex - 1]
+        assert.strictEqual(beforeClient, platformPair())
+    })
 })