Show a good error if TRIGGER_ACCESS_TOKEN isn’t a PAT

Author: matt-aitken

packages/cli-v3/src/commands/login.ts

@@ -23,6 +23,10 @@ import { spinner } from "../utilities/windows.js";
 import { isLinuxServer } from "../utilities/linux.js";
 import { VERSION } from "../version.js";
 import { env } from "std-env";
+import {
+  isPersonalAccessToken,
+  NotPersonalAccessTokenError,
+} from "../utilities/isPersonalAccessToken.js";
 
 export const LoginCommandOptions = CommonCommandOptions.extend({
   apiUrl: z.string(),
@@ -84,6 +88,12 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
       const accessTokenFromEnv = env.TRIGGER_ACCESS_TOKEN;
 
       if (accessTokenFromEnv) {
+        if (!isPersonalAccessToken(accessTokenFromEnv)) {
+          throw new NotPersonalAccessTokenError(
+            "Your TRIGGER_ACCESS_TOKEN is not a Personal Access Token, they start with 'tr_pat_'. You can generate one here: https://cloud.trigger.dev/account/tokens"
+          );
+        }
+
         const auth = {
           accessToken: accessTokenFromEnv,
           apiUrl: env.TRIGGER_API_URL ?? opts.defaultApiUrl ?? "https://api.trigger.dev",
@@ -292,6 +302,10 @@ export async function login(options?: LoginOptions): Promise<LoginResult> {
       span.end();
 
       if (options?.embedded) {
+        if (e instanceof NotPersonalAccessTokenError) {
+          throw e;
+        }
+
         return {
           ok: false as const,
           error: e instanceof Error ? e.message : String(e),

packages/cli-v3/src/utilities/isPersonalAccessToken.ts

@@ -0,0 +1,12 @@
+const tokenPrefix = "tr_pat_";
+
+export function isPersonalAccessToken(token: string) {
+  return token.startsWith(tokenPrefix);
+}
+
+export class NotPersonalAccessTokenError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "NotPersonalAccessTokenError";
+  }
+}