Merge pull request #810 from hayemaxi/auth-telem

VSC telemetry updates

Author: hayemaxi

telemetry/definitions/commonDefinitions.json

@@ -1589,6 +1589,16 @@
             ],
             "description": "The type of an SQS Queue"
         },
+        {
+            "name": "ssoRegistrationClientId",
+            "type": "string",
+            "description": "The client ID of an SSO registration."
+        },
+        {
+            "name": "ssoRegistrationExpiresAt",
+            "type": "string",
+            "description": "Date/time that an SSO client registration expires."
+        },
         {
             "name": "successCount",
             "type": "int",
@@ -2450,6 +2460,14 @@
                 },
                 {
                     "type": "source"
+                },
+                {
+                    "type": "ssoRegistrationClientId",
+                    "required": false
+                },
+                {
+                    "type": "ssoRegistrationExpiresAt",
+                    "required": false
                 }
             ]
         },
@@ -2524,9 +2542,21 @@
                     "type": "authStatus",
                     "required": true
                 },
+                {
+                    "type": "credentialStartUrl",
+                    "required": false
+                },
                 {
                     "type": "source",
                     "required": true
+                },
+                {
+                    "type": "ssoRegistrationClientId",
+                    "required": false
+                },
+                {
+                    "type": "ssoRegistrationExpiresAt",
+                    "required": false
                 }
             ],
             "passive": true
@@ -2650,6 +2680,14 @@
                 },
                 {
                     "type": "source"
+                },
+                {
+                    "type": "ssoRegistrationClientId",
+                    "required": false
+                },
+                {
+                    "type": "ssoRegistrationExpiresAt",
+                    "required": false
                 }
             ]
         },
@@ -2720,6 +2758,10 @@
                     "type": "credentialSourceId",
                     "required": false
                 },
+                {
+                    "type": "credentialStartUrl",
+                    "required": false
+                },
                 {
                     "type": "credentialType",
                     "required": false
@@ -2742,6 +2784,14 @@
                 {
                     "type": "sessionDuration",
                     "required": false
+                },
+                {
+                    "type": "ssoRegistrationClientId",
+                    "required": false
+                },
+                {
+                    "type": "ssoRegistrationExpiresAt",
+                    "required": false
                 }
             ]
         },

telemetry/vscode/src/generate.ts

@@ -122,6 +122,10 @@ function getTypeOrThrow(types: MetadataType[] = [], name: string) {
 
 const baseName = 'MetricBase'
 
+/**
+ * Fields set automatically by the telemetry client (thus application code
+ * normally shouldn't set these because the value will be overridden).
+ */
 const commonMetadata = [
   'awsAccount',
   'awsRegion',
@@ -132,7 +136,13 @@ const commonMetadata = [
   'requestId',
   'requestServiceType',
   'result',
-]
+] as const
+
+/** 
+ * These fields will also be set by the telemetry client, but the caller might
+ * know better, so they won't be overridden if specified in `.record()` calls.
+ */
+const optionalMetadata: typeof commonMetadata[number][] = ['awsRegion']
 
 const passive: PropertySignatureStructure = {
     isReadonly: true,
@@ -183,7 +193,7 @@ const header = `
 `.trimStart()
 
 function getMetricMetadata(metric: Metric) {
-    return metric.metadata?.filter(m => !commonMetadata.includes(m.type)) ?? []
+    return metric.metadata?.filter(m => !commonMetadata.includes(m.type as typeof commonMetadata[number])) ?? []
 }
 
 function generateMetadataProperty(metadata: MetricMetadataType): PropertySignatureStructure {
@@ -351,7 +361,7 @@ function generateFile(telemetryJson: MetricDefinitionRoot, dest: string) {
         isExported: true,
         name: 'Metadata',
         typeParameters: [`T extends ${baseName}`],
-        type: `Partial<Omit<T, keyof ${baseName}>>`,
+        type: `Partial<Omit<T, keyof ${baseName}> | Partial<Pick<${baseName}, ${optionalMetadata.map(v => `'${v}'`).join(' | ')}>>>`,
         kind: StructureKind.TypeAlias,
     }
 

telemetry/vscode/test/resources/generatorOutput.ts

@@ -114,7 +114,7 @@ export const definitions: Record<string, MetricDefinition> = {
     passive_passive: { unit: 'None', passive: true, requiredMetadata: [] },
 }
 
-export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase>>
+export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>
 
 export interface Metric<T extends MetricBase = MetricBase> {
     readonly name: string

telemetry/vscode/test/resources/generatorOverrideOutput.ts

@@ -85,7 +85,7 @@ export const definitions: Record<string, MetricDefinition> = {
     metadata_hasResult: { unit: 'None', passive: false, requiredMetadata: [] },
 }
 
-export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase>>
+export type Metadata<T extends MetricBase> = Partial<Omit<T, keyof MetricBase> | Partial<Pick<MetricBase, 'awsRegion'>>>
 
 export interface Metric<T extends MetricBase = MetricBase> {
     readonly name: string