refactor(telemetry): @withTelemetryContext can emit with source

Now the @withTelemetryContext decorator can have a method emit when called
and will also add the `source` field automatically.

By default it does not emit.

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

Author: nkomonen-amazon

packages/core/src/shared/telemetry/util.ts

@@ -26,7 +26,7 @@ import { isValidationExemptMetric } from './exemptMetrics'
 import { isAmazonQ, isCloud9, isSageMaker } from '../../shared/extensionUtilities'
 import { randomUUID } from '../crypto'
 import { ClassToInterfaceType } from '../utilities/tsUtils'
-import { FunctionEntry } from './spans'
+import { asStringifiedStack, FunctionEntry } from './spans'
 import { telemetry } from './telemetry'
 import { v5 as uuidV5 } from 'uuid'
 import { ToolkitError } from '../errors'
@@ -383,9 +383,15 @@ export function withTelemetryContext(opts: TelemetryContextArgs) {
     ) {
         function decoratedMethod(this: This, ...args: Args): Return {
             return telemetry.function_call.run(
-                () => {
+                (span) => {
                     try {
-                        // DEVELOPERS: Set a breakpoint here and step in to it to debug the original function
+                        span.record({
+                            functionName: opts.name,
+                            className: opts.class,
+                            source: asStringifiedStack(telemetry.getFunctionStack()),
+                        })
+
+                        // DEVELOPERS: Set a breakpoint here and step in and debug the original function
                         const result = originalMethod.call(this, ...args)
 
                         if (result instanceof Promise) {
@@ -405,7 +411,7 @@ export function withTelemetryContext(opts: TelemetryContextArgs) {
                     }
                 },
                 {
-                    emit: false,
+                    emit: opts.emit !== undefined ? opts.emit : false,
                     functionId: opts,
                 }
             )

packages/core/src/shared/telemetry/vscodeTelemetry.json

@@ -1116,6 +1116,10 @@
                 {
                     "type": "className",
                     "required": false
+                },
+                {
+                    "type": "source",
+                    "required": false
                 }
             ],
             "passive": true

packages/core/src/test/shared/telemetry/spans.test.ts

@@ -579,6 +579,41 @@ describe('TelemetryTracer', function () {
     })
 
     describe('withTelemetryContext', async function () {
+        class TestEmit {
+            @withTelemetryContext({ name: 'doesNotEmit', class: 'TestEmit' })
+            doesNotEmit() {
+                return
+            }
+
+            @withTelemetryContext({ name: 'doesEmit', class: 'TestEmit', emit: false })
+            doesEmit() {
+                return this.doesEmitNested()
+            }
+
+            @withTelemetryContext({ name: 'doesEmitNested', class: 'TestEmit', emit: true })
+            doesEmitNested() {
+                return
+            }
+        }
+
+        it(`does NOT emit an event if not explicitly set`, function () {
+            const inst = new TestEmit()
+            inst.doesNotEmit()
+            assertTelemetry('function_call', [])
+        })
+
+        it(`does emit an event on its own when explicitly set`, function () {
+            const inst = new TestEmit()
+            inst.doesEmit()
+            assertTelemetry('function_call', [
+                {
+                    functionName: 'doesEmitNested',
+                    className: 'TestEmit',
+                    source: 'TestEmit#doesEmit,doesEmitNested',
+                },
+            ])
+        })
+
         class TestThrows {
             @withTelemetryContext({ name: 'throwsError', class: 'TestThrows', errorCtx: true })
             throwsError() {