vsc: add source to common fields

Problem:

The `source` value has become a common pattern in our telemetry which answers
"who" caused the metric event. For example if we had a function() to open
a menu, there could be many different entrypoints that could call it.

Solution:

`source` will answer "who" it was for that event. And now it will
be a part of all metrics as an optional field.

Note:

The other IDEs should consider following this pattern if not already.

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

Author: nkomonen-amazon

telemetry/definitions/commonDefinitions.json

@@ -1782,7 +1782,7 @@
         {
             "name": "source",
             "type": "string",
-            "description": "The source of the operation"
+            "description": "The source of the operation. This answers 'who' caused/triggered the operation. Example: did an Auth signout happen because of some expiration or since the user explicitly clicked the signout button."
         },
         {
             "name": "sourceFacetType",

telemetry/vscode/src/generate.ts

@@ -136,6 +136,7 @@ const commonMetadata = [
     'requestId',
     'requestServiceType',
     'result',
+    'source',
 ] as const
 
 /**

telemetry/vscode/test/resources/generatorOutput.ts

@@ -30,6 +30,8 @@ export interface MetricBase {
     readonly requestServiceType?: string
     /** The result of the operation */
     readonly result?: Result
+    /** The source of the operation. This answers 'who' caused the operation. Example: did an Auth signout happen because of some expiration or since the user explicitly chose to. */
+    readonly source?: string
     /** A flag indicating that the metric was not caused by the user. */
     readonly passive?: boolean
     /** @deprecated Arbitrary "value" of the metric. */

telemetry/vscode/test/resources/generatorOverrideOutput.ts

@@ -30,6 +30,8 @@ export interface MetricBase {
     readonly requestServiceType?: string
     /** The result of the operation */
     readonly result?: Result
+    /** The source of the operation. This answers 'who' caused the operation. Example: did an Auth signout happen because of some expiration or since the user explicitly chose to. */
+    readonly source?: string
     /** A flag indicating that the metric was not caused by the user. */
     readonly passive?: boolean
     /** @deprecated Arbitrary "value" of the metric. */