refactor(vscode): remove telemetry.foo.record (#859)

## Problem
In vscode `telemetry.foo.record` is confusing to partner teams and has a
couple of misuses in our codebase

## Solution
We're modifying vscodes telemetry generation to only allow records on a
span, instead of on `telemetry.foo.record`.

This means the following will be available
```
telemetry.foo.run(span => {
    span.record( {someInformation: 5})
})
```

but `telemetry.foo.record` will not.

Author: jpinkney-aws

telemetry/vscode/src/generate.ts

@@ -284,15 +284,6 @@ function generateMetricRecorder(metadataType: TypeAliasDeclarationStructure): In
             }
         ],
         methods: [
-            {
-                docs: ['Adds data to the metric which is preserved for the remainder of the execution context'],
-                name: 'record',
-                returnType: 'void',
-                parameters: [{
-                        name: 'data',
-                        type: `${metadataType.name}<T>`,
-                }],
-            },
             {
                 docs: ['Sends the metric to the telemetry service'],
                 name: 'emit',
@@ -310,7 +301,7 @@ function generateMetricRecorder(metadataType: TypeAliasDeclarationStructure): In
                 returnType: 'U',
                 parameters: [{
                         name: 'fn',
-                        type: `(span: this) => U`,
+                        type: `(span: Span<T>) => U`,
                 }],
             }
         ],
@@ -406,10 +397,31 @@ function generateFile(telemetryJson: MetricDefinitionRoot, dest: string) {
         kind: StructureKind.TypeAlias,
     }
 
+    const span: InterfaceDeclarationStructure = {
+        kind: StructureKind.Interface,
+        name: 'Span',
+        isExported: true,
+        typeParameters: [{ name: 'T' }],
+        docs: ['Represents a telemetry span for tracking and recording metric data.'],
+        methods: [
+            {
+                name: 'record',
+                parameters: [
+                    {
+                        name: 'data',
+                        type: 'Partial<T>',
+                    },
+                ],
+                returnType: 'this',
+            }
+        ],
+    }
+
     const definitions = generateDefinitions(telemetryJson.metrics)
     const recorder = generateMetricRecorder(metadataType)
     file.addVariableStatement(definitions)
     file.addTypeAlias(metadataType)
+    file.addInterface(span)
     file.addInterface(recorder)
     file.addClass(generateTelemetryHelper(recorder, telemetryJson.metrics))
 

telemetry/vscode/test/resources/generatorOutput.ts

@@ -125,14 +125,17 @@ export const definitions: Record<string, MetricDefinition> = {
 
 export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>
 
+/** Represents a telemetry span for tracking and recording metric data. */
+export interface Span<T> {
+    record(data: Partial<T>): this
+}
+
 export interface Metric<T extends MetricBase = MetricBase> {
     readonly name: string
-    /** Adds data to the metric which is preserved for the remainder of the execution context */
-    record(data: Metadata<T>): void
     /** Sends the metric to the telemetry service */
     emit(data?: T): void
     /** Executes a callback, automatically sending the metric after completion */
-    run<U>(fn: (span: this) => U): U
+    run<U>(fn: (span: Span<T>) => U): U
 }
 
 export abstract class TelemetryBase {

telemetry/vscode/test/resources/generatorOverrideOutput.ts

@@ -96,14 +96,17 @@ export const definitions: Record<string, MetricDefinition> = {
 
 export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>
 
+/** Represents a telemetry span for tracking and recording metric data. */
+export interface Span<T> {
+    record(data: Partial<T>): this
+}
+
 export interface Metric<T extends MetricBase = MetricBase> {
     readonly name: string
-    /** Adds data to the metric which is preserved for the remainder of the execution context */
-    record(data: Metadata<T>): void
     /** Sends the metric to the telemetry service */
     emit(data?: T): void
     /** Executes a callback, automatically sending the metric after completion */
-    run<U>(fn: (span: this) => U): U
+    run<U>(fn: (span: Span<T>) => U): U
 }
 
 export abstract class TelemetryBase {