add login telemetry (#773)

Author: mythmon

src/observableApiAuth.ts

@@ -14,6 +14,7 @@ import {
 } from "./observableApiConfig.js";
 import type {TtyEffects} from "./tty.js";
 import {bold, defaultEffects as defaultTtyEffects, inverse, link, yellow} from "./tty.js";
+import {Telemetry} from "./telemetry.js";
 
 const OBSERVABLE_UI_ORIGIN = getObservableUiOrigin();
 
@@ -36,6 +37,7 @@ export const defaultEffects: AuthEffects = {
 
 export async function login(effects: AuthEffects = defaultEffects) {
   const {clack} = effects;
+  Telemetry.record({event: "login", step: "start"});
   clack.intro(inverse(" observable login "));
 
   const {currentUser} = await loginInner(effects);
@@ -52,8 +54,7 @@ export async function login(effects: AuthEffects = defaultEffects) {
     );
   }
   clack.outro("Logged in");
-
-  clack.outro();
+  Telemetry.record({event: "login", step: "finish"});
 }
 
 export async function loginInner(effects: AuthEffects): Promise<{currentUser: GetCurrentUserResponse; apiKey: ApiKey}> {
@@ -75,6 +76,7 @@ export async function loginInner(effects: AuthEffects): Promise<{currentUser: Ge
 
   let apiKey: PostAuthRequestPollResponse["apiKey"] | null = null;
   while (apiKey === null) {
+    await new Promise((resolve) => setTimeout(resolve, 1000));
     const requestPoll = await apiClient.postAuthRequestPoll(requestInfo.id);
     switch (requestPoll.status) {
       case "pending":
@@ -84,18 +86,23 @@ export async function loginInner(effects: AuthEffects): Promise<{currentUser: Ge
         break;
       case "expired":
         spinner.stop("Failed to confirm code.", 2);
+        Telemetry.record({event: "login", step: "error", code: "expired"});
         throw new CliError("That confirmation code expired.");
       case "consumed":
         spinner.stop("Failed to confirm code.", 2);
+        Telemetry.record({event: "login", step: "error", code: "consumed"});
         throw new CliError("That confirmation code has already been used.");
       default:
         spinner.stop("Failed to confirm code.", 2);
+        Telemetry.record({event: "login", step: "error", code: `unknown-${requestPoll.status}`});
         throw new CliError(`Received an unknown polling status ${requestPoll.status}.`);
     }
-    await new Promise((resolve) => setTimeout(resolve, 1000));
   }
 
-  if (!apiKey) throw new CliError("No API key returned from server.");
+  if (!apiKey) {
+    Telemetry.record({event: "login", step: "error", code: "no-key"});
+    throw new CliError("No API key returned from server.");
+  }
   await effects.setObservableApiKey(apiKey);
 
   apiClient.setApiKey({source: "login", key: apiKey.key});

src/telemetry.ts

@@ -38,8 +38,8 @@ type TelemetryTime = {
 };
 
 type TelemetryData = {
-  event: "build" | "deploy" | "preview" | "signal";
-  step?: "start" | "finish";
+  event: "build" | "deploy" | "preview" | "signal" | "login";
+  step?: "start" | "finish" | "error";
   [key: string]: unknown;
 };