test(auth): cover every taskless auth status outcome

Author: theCodeDrift

packages/cli/src/auth/status.ts

@@ -0,0 +1,38 @@
+import type { V2Outcome, WhoamiResult } from "../api/v2";
+import { isEnvironmentToken, rejectedTokenRemedy } from "./token";
+
+/**
+ * The lines `taskless auth` prints for a token, given the service's answer
+ * about it.
+ *
+ * A rejected token and an unreachable service read differently on purpose: the
+ * first names its fix, the second says nothing about the token, which may be
+ * fine.
+ */
+export function describeAuthStatus(
+  outcome: V2Outcome<WhoamiResult, never>
+): string[] {
+  const source = isEnvironmentToken() ? " via TASKLESS_TOKEN" : "";
+  switch (outcome.status) {
+    case "ok": {
+      const orgs = outcome.data.orgs.map((o) => o.name);
+      const orgSuffix = orgs.length > 0 ? ` (${orgs.join(", ")})` : "";
+      return [`Logged in as ${outcome.data.user}${orgSuffix}${source}.`];
+    }
+    case "unauthorized": {
+      return [
+        `Logged in${source}, but the token was rejected.`,
+        `It is invalid or expired. ${rejectedTokenRemedy()}`,
+      ];
+    }
+    case "unavailable": {
+      return [
+        `Logged in${source}, but unable to verify identity.`,
+        `The Taskless service was unreachable (${outcome.reason}).`,
+      ];
+    }
+    default: {
+      return [`Logged in${source}, but unable to verify identity.`];
+    }
+  }
+}

packages/cli/src/commands/auth.ts

@@ -4,12 +4,8 @@ import { defineCommand } from "citty";
 
 import { whoami } from "../api/v2";
 import { loginInteractive } from "../auth/login-interactive";
-import {
-  getToken,
-  isEnvironmentToken,
-  rejectedTokenRemedy,
-  removeToken,
-} from "../auth/token";
+import { describeAuthStatus } from "../auth/status";
+import { getToken, isEnvironmentToken, removeToken } from "../auth/token";
 import { getTelemetry } from "../telemetry";
 import { type CLIErrorCode, writeJsonError } from "../types/errors";
 import { splitRawArguments } from "../util/argv";
@@ -210,28 +206,8 @@ export const authCommand = defineCommand({
       return;
     }
 
-    const source = isEnvironmentToken() ? " via TASKLESS_TOKEN" : "";
-    const outcome = await whoami(token);
-    switch (outcome.status) {
-      case "ok": {
-        const orgs = outcome.data.orgs.map((o) => o.name);
-        const orgSuffix = orgs.length > 0 ? ` (${orgs.join(", ")})` : "";
-        console.log(`Logged in as ${outcome.data.user}${orgSuffix}${source}.`);
-        return;
-      }
-      case "unauthorized": {
-        console.log(`Logged in${source}, but the token was rejected.`);
-        console.log(`It is invalid or expired. ${rejectedTokenRemedy()}`);
-        return;
-      }
-      default: {
-        console.log(`Logged in${source}, but unable to verify identity.`);
-        if (outcome.status === "unavailable") {
-          console.log(
-            `The Taskless service was unreachable (${outcome.reason}).`
-          );
-        }
-      }
+    for (const line of describeAuthStatus(await whoami(token))) {
+      console.log(line);
     }
   },
 });

packages/cli/test/auth-status.test.ts

@@ -0,0 +1,80 @@
+import { afterEach, beforeEach, describe, expect, it } from "vitest";
+
+import type { WhoamiResult } from "../src/api/v2";
+import { describeAuthStatus } from "../src/auth/status";
+
+const identity: WhoamiResult = {
+  user: "someone",
+  orgs: [
+    {
+      orgId: 1,
+      id: "00000000-0000-0000-0000-000000000001",
+      name: "acme",
+      source: "github",
+      url: "https://github.com/acme",
+    },
+  ],
+};
+
+let previousToken: string | undefined;
+
+beforeEach(() => {
+  previousToken = process.env.TASKLESS_TOKEN;
+  delete process.env.TASKLESS_TOKEN;
+});
+
+afterEach(() => {
+  if (previousToken === undefined) {
+    delete process.env.TASKLESS_TOKEN;
+  } else {
+    process.env.TASKLESS_TOKEN = previousToken;
+  }
+});
+
+describe("describeAuthStatus", () => {
+  it("names the user and orgs for an accepted saved token", () => {
+    expect(describeAuthStatus({ status: "ok", data: identity })).toEqual([
+      "Logged in as someone (acme).",
+    ]);
+  });
+
+  it("says when the token comes from TASKLESS_TOKEN", () => {
+    process.env.TASKLESS_TOKEN = "env-token";
+
+    expect(describeAuthStatus({ status: "ok", data: identity })).toEqual([
+      "Logged in as someone (acme) via TASKLESS_TOKEN.",
+    ]);
+  });
+
+  it("reports a rejected saved token with auth login as the fix", () => {
+    const lines = describeAuthStatus({ status: "unauthorized" });
+
+    expect(lines[0]).toBe("Logged in, but the token was rejected.");
+    expect(lines[1]).toMatch(/auth login` to replace the saved token\.$/);
+  });
+
+  it("reports a rejected TASKLESS_TOKEN with the variable as the fix", () => {
+    process.env.TASKLESS_TOKEN = "env-token";
+
+    const lines = describeAuthStatus({ status: "unauthorized" });
+
+    expect(lines[0]).toBe(
+      "Logged in via TASKLESS_TOKEN, but the token was rejected."
+    );
+    expect(lines[1]).toMatch(/replace or unset it/);
+  });
+
+  it("does not call a token invalid when the service is unreachable", () => {
+    const lines = describeAuthStatus({
+      status: "unavailable",
+      reason: "network error: offline",
+      retryable: true,
+    });
+
+    expect(lines).toEqual([
+      "Logged in, but unable to verify identity.",
+      "The Taskless service was unreachable (network error: offline).",
+    ]);
+    expect(lines.join("\n")).not.toMatch(/rejected|invalid|expired/);
+  });
+});