Consistency: track setup_ended for cancelled events

Author: anisaoshafi

src/plugins/setup.ts

@@ -15,6 +15,11 @@ import {
 	activateLicenseUntilValid,
 } from "../utils/license.ts";
 import { minDelay } from "../utils/promises.ts";
+import {
+	get_setup_ended_on_authentication_cancelled,
+	get_setup_ended_on_cli_setup_cancelled,
+	get_setup_ended_on_license_setup_cancelled,
+} from "../utils/telemetry.ts";
 
 export default createPlugin(
 	"setup",
@@ -64,6 +69,7 @@ export default createPlugin(
 											status: "CANCELLED",
 										},
 									});
+									telemetry.track(get_setup_ended_on_cli_setup_cancelled());
 									return;
 								}
 							}
@@ -76,43 +82,17 @@ export default createPlugin(
 							const authenticated = await minDelay(checkIsAuthenticated());
 							if (cancellationToken.isCancellationRequested) {
 								telemetry.track({
-									name: "setup_ended",
+									name: "auth_token_configured",
 									payload: {
 										namespace: "onboarding",
-										steps: [
-											{
-												name: "emulator_installed",
-												is_first_step: true,
-												is_last_step: false,
-												step_order: 1,
-												status: "COMPLETED",
-											},
-											{
-												name: "auth_token_configured",
-												is_first_step: false,
-												is_last_step: false,
-												step_order: 2,
-												status: "CANCELLED",
-											},
-											{
-												name: "license_setup_ended",
-												is_first_step: false,
-												is_last_step: false,
-												step_order: 3,
-												status: "SKIPPED",
-											},
-											{
-												name: "aws_profile_configured",
-												is_first_step: false,
-												is_last_step: true,
-												step_order: 4,
-												status: "SKIPPED",
-											},
-										],
+										origin: origin_trigger,
+										step_order: 2,
+										started_at: authStartedAuthAt,
+										ended_at: new Date().toISOString(),
 										status: "CANCELLED",
-										auth_token: await readAuthToken(),
 									},
 								});
+								telemetry.track(get_setup_ended_on_authentication_cancelled());
 								return;
 							}
 							if (authenticated) {
@@ -130,6 +110,7 @@ export default createPlugin(
 										status: "SKIPPED",
 									},
 								});
+
 								await minDelay(Promise.resolve());
 							} else {
 								/////////////////////////////////////////////////////////////////////
@@ -153,6 +134,9 @@ export default createPlugin(
 											status: "CANCELLED",
 										},
 									});
+									telemetry.track(
+										get_setup_ended_on_authentication_cancelled(),
+									);
 									return;
 								}
 
@@ -174,7 +158,9 @@ export default createPlugin(
 											status: "CANCELLED",
 										},
 									});
-
+									telemetry.track(
+										get_setup_ended_on_authentication_cancelled(authToken),
+									);
 									return;
 								}
 							}
@@ -219,6 +205,11 @@ export default createPlugin(
 										status: "CANCELLED",
 									},
 								});
+								telemetry.track(
+									get_setup_ended_on_license_setup_cancelled(
+										await readAuthToken(),
+									),
+								);
 								return;
 							}
 

src/utils/telemetry.ts

@@ -106,7 +106,7 @@ type Events =
 					},
 				];
 				status: "COMPLETED" | "FAILED" | "CANCELLED";
-				auth_token: string;
+				auth_token?: string;
 			};
 	  }
 	| {
@@ -213,3 +213,129 @@ export function createTelemetry(
 		},
 	};
 }
+
+export function get_setup_ended_on_cli_setup_cancelled(): Events {
+	return {
+		name: "setup_ended",
+		payload: {
+			namespace: "onboarding",
+			steps: [
+				{
+					name: "emulator_installed",
+					is_first_step: true,
+					is_last_step: false,
+					step_order: 1,
+					status: "CANCELLED",
+				},
+				{
+					name: "auth_token_configured",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 2,
+					status: "SKIPPED",
+				},
+				{
+					name: "license_setup_ended",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 3,
+					status: "SKIPPED",
+				},
+				{
+					name: "aws_profile_configured",
+					is_first_step: false,
+					is_last_step: true,
+					step_order: 4,
+					status: "SKIPPED",
+				},
+			],
+			status: "CANCELLED",
+		},
+	};
+}
+
+export function get_setup_ended_on_authentication_cancelled(
+	authToken: string = "",
+): Events {
+	return {
+		name: "setup_ended",
+		payload: {
+			namespace: "onboarding",
+			steps: [
+				{
+					name: "emulator_installed",
+					is_first_step: true,
+					is_last_step: false,
+					step_order: 1,
+					status: "COMPLETED",
+				},
+				{
+					name: "auth_token_configured",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 2,
+					status: "CANCELLED",
+				},
+				{
+					name: "license_setup_ended",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 3,
+					status: "SKIPPED",
+				},
+				{
+					name: "aws_profile_configured",
+					is_first_step: false,
+					is_last_step: true,
+					step_order: 4,
+					status: "SKIPPED",
+				},
+			],
+			status: "CANCELLED",
+			auth_token: authToken,
+		},
+	};
+}
+
+export function get_setup_ended_on_license_setup_cancelled(
+	auth_token: string,
+): Events {
+	return {
+		name: "setup_ended",
+		payload: {
+			namespace: "onboarding",
+			steps: [
+				{
+					name: "emulator_installed",
+					is_first_step: true,
+					is_last_step: false,
+					step_order: 1,
+					status: "COMPLETED",
+				},
+				{
+					name: "auth_token_configured",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 2,
+					status: "COMPLETED",
+				},
+				{
+					name: "license_setup_ended",
+					is_first_step: false,
+					is_last_step: false,
+					step_order: 3,
+					status: "CANCELLED",
+				},
+				{
+					name: "aws_profile_configured",
+					is_first_step: false,
+					is_last_step: true,
+					step_order: 4,
+					status: "SKIPPED",
+				},
+			],
+			status: "CANCELLED",
+			auth_token: auth_token,
+		},
+	};
+}