Merge #4303 refactor: simplify validateMetricEvent()

Author: justinmk3

src/shared/telemetry/telemetryService.ts

@@ -101,7 +101,7 @@ export class DefaultTelemetryService {
         if (this.telemetryEnabled && !isAutomation()) {
             const currTime = new globals.clock.Date()
             // This is noisy when running tests in vscode.
-            telemetry.session_end.emit({ value: currTime.getTime() - this.startTime.getTime() })
+            telemetry.session_end.emit({ value: currTime.getTime() - this.startTime.getTime(), result: 'Succeeded' })
 
             try {
                 await fsCommon.writeFile(this.persistFilePath, JSON.stringify(this._eventQueue))

src/shared/telemetry/util.ts

@@ -98,31 +98,25 @@ export async function getUserAgent(
 export function validateMetricEvent(event: MetricDatum, fatal: boolean) {
     const failedStr: Result = 'Failed'
     const telemetryRunDocsStr =
-        'Consider using `.run()` instead of `.emit()`, which will set these properties automatically. ' +
+        ' Consider using `.run()` instead of `.emit()`, which will set these properties automatically. ' +
         'See https://github.com/aws/aws-toolkit-vscode/blob/master/docs/telemetry.md#guidelines'
 
     if (!isValidationExemptMetric(event.MetricName) && event.Metadata) {
         const metadata = mapMetadata([])(event.Metadata)
+        let msg = 'telemetry: invalid Metric: '
+
+        if (metadata.result === undefined) {
+            msg += `"${event.MetricName}" emitted without the \`result\` property, which is always required.`
+        } else if (metadata.result === failedStr && metadata.reason === undefined) {
+            msg += `"${event.MetricName}" emitted with result=Failed but without the \`reason\` property.`
+        } else {
+            return // Validation passed.
+        }
 
-        try {
-            if (metadata.result === undefined) {
-                throw new Error(
-                    `Metric \`${event.MetricName}\` was emitted without the \`result\` property. ` +
-                        `This property is always required. ${telemetryRunDocsStr}`
-                )
-            }
-
-            if (metadata.result === failedStr && metadata.reason === undefined) {
-                throw new Error(
-                    `Metric \`${event.MetricName}\` was emitted without the \`reason\` property. ` +
-                        `This property is always required when \`result\` = 'Failed'. ${telemetryRunDocsStr}`
-                )
-            }
-        } catch (err: any) {
-            if (fatal) {
-                throw err
-            }
-            getLogger().warn(`Metric Event did not pass validation: ${(err as Error).message}`)
+        msg += telemetryRunDocsStr
+        if (fatal) {
+            throw new Error(msg)
         }
+        getLogger().warn(msg)
     }
 }