Merge branch 'main' into main

Author: matt-aitken

.changeset/soft-glasses-repair.md

@@ -0,0 +1,5 @@
+---
+"@trigger.dev/cli": patch
+---
+
+Added whoami command, fixed TypeScript error

apps/webapp/app/entry.server.tsx

@@ -74,7 +74,7 @@ function serveTheBots(
       {
         // Use onAllReady to wait for the entire document to be ready
         onAllReady() {
-          responseHeaders.set("Content-Type", "text/html");
+          responseHeaders.set("Content-Type", "text/html; charset=utf-8");
           let body = new PassThrough();
           pipe(body);
           resolve(
@@ -114,7 +114,7 @@ function serveBrowsers(
         // use onShellReady to wait until a suspense boundary is triggered
         onShellReady() {
           shellReady = true;
-          responseHeaders.set("Content-Type", "text/html");
+          responseHeaders.set("Content-Type", "text/html; charset=utf-8");
           let body = new PassThrough();
           pipe(body);
           resolve(

apps/webapp/app/utils.ts

@@ -45,13 +45,10 @@ export function useMatchesData(
   const paths = Array.isArray(id) ? id : [id];
 
   // Get the first matching route
-  const route = paths.reduce(
-    (acc, path) => {
-      if (acc) return acc;
-      return matchingRoutes.find((route) => route.id === path);
-    },
-    undefined as RouteMatch | undefined
-  );
+  const route = paths.reduce((acc, path) => {
+    if (acc) return acc;
+    return matchingRoutes.find((route) => route.id === path);
+  }, undefined as RouteMatch | undefined);
 
   return route;
 }
@@ -76,7 +73,7 @@ export function hydrateDates(object: any): any {
   if (
     typeof object === "string" &&
     object.match(/\d{4}-\d{2}-\d{2}/) &&
-    !isNaN(Date.parse(object))
+    !Number.isNaN(Date.parse(object))
   ) {
     return new Date(object);
   }

examples/nextjs-12/jsconfig.json

@@ -0,0 +1,3 @@
+{
+  "compilerOptions": {}
+}

examples/nextjs-12/package.json

@@ -17,7 +17,8 @@
   },
   "devDependencies": {
     "eslint": "8.44.0",
-    "eslint-config-next": "12.3.4"
+    "eslint-config-next": "12.3.4",
+    "@trigger.dev/cli": "workspace:*"
   },
   "trigger.dev": {
     "endpointId": "nextjs-12"

packages/cli/src/cli/index.ts

@@ -3,6 +3,7 @@ import inquirer from "inquirer";
 import pathModule from "node:path";
 import { createIntegrationCommand } from "../commands/createIntegration";
 import { devCommand } from "../commands/dev";
+import { whoamiCommand } from "../commands/whoami.js";
 import { initCommand } from "../commands/init";
 import { CLOUD_TRIGGER_URL, COMMAND_NAME } from "../consts";
 import { telemetryClient } from "../telemetry/telemetry";
@@ -87,6 +88,21 @@ program
     await updateCommand(path);
   });
 
+program
+  .command("whoami")
+  .description("display the current logged in user and project details")
+  .argument("[path]", "The path to the project", ".")
+  .option("-p, --port <port>", "The local port your server is on", "3000")
+  .option("-e, --env-file <name>", "The name of the env file to load", ".env.local")
+  .version(getVersion(), "-v, --version", "Display the version number")
+  .action(async (path, options) => {
+    try {
+      await whoamiCommand(path, options);
+    } catch (e) {
+      throw e;
+    }
+  });
+
 export const promptTriggerUrl = async (): Promise<string> => {
   const { instanceType } = await inquirer.prompt<{
     instanceType: "cloud" | "self-hosted";

packages/cli/src/commands/dev.ts

@@ -206,7 +206,7 @@ export async function devCommand(path: string, anyOptions: any) {
   throttle(refresh, throttleTimeMs);
 }
 
-async function getEndpointIdFromPackageJson(path: string, options: DevCommandOptions) {
+export async function getEndpointIdFromPackageJson(path: string, options: DevCommandOptions) {
   if (options.clientId) {
     return options.clientId;
   }
@@ -221,7 +221,7 @@ async function getEndpointIdFromPackageJson(path: string, options: DevCommandOpt
   return value as string;
 }
 
-async function readEnvFilesWithBackups(
+export async function readEnvFilesWithBackups(
   path: string,
   envFile: string,
   backups: string[]
@@ -249,7 +249,7 @@ async function readEnvFilesWithBackups(
   return;
 }
 
-async function getTriggerApiDetails(path: string, envFile: string) {
+export async function getTriggerApiDetails(path: string, envFile: string) {
   const resolvedEnvFile = await readEnvFilesWithBackups(path, envFile, [
     ".env",
     ".env.local",

packages/cli/src/commands/whoami.ts

@@ -0,0 +1,62 @@
+import { z } from "zod";
+import { logger } from "../utils/logger";
+import { resolvePath } from "../utils/parseNameAndPath";
+import { TriggerApi } from "../utils/triggerApi";
+import { DevCommandOptions, getEndpointIdFromPackageJson, getTriggerApiDetails } from "./dev";
+import ora from "ora";
+
+export const WhoAmICommandOptionsSchema = z.object({
+  envFile: z.string(),
+});
+
+export type WhoAmICommandOptions = z.infer<typeof WhoAmICommandOptionsSchema>;
+
+export async function whoamiCommand(path: string, anyOptions: any) {
+  const loadingSpinner = ora(`Hold while we fetch your data`);
+  loadingSpinner.start();
+
+  const result = WhoAmICommandOptionsSchema.safeParse(anyOptions);
+  if (!result.success) {
+    logger.error(result.error.message);
+    return;
+  }
+  const options = result.data;
+
+  const resolvedPath = resolvePath(path);
+
+  // Read from package.json to get the endpointId
+  const endpointId = await getEndpointIdFromPackageJson(resolvedPath, options as DevCommandOptions);
+  if (!endpointId) {
+    logger.error(
+      "You must run the `init` command first to setup the project – you are missing \n'trigger.dev': { 'endpointId': 'your-client-id' } from your package.json file, or pass in the --client-id option to this command"
+    );
+    loadingSpinner.stop();
+    return;
+  }
+  // Read from .env.local or .env to get the TRIGGER_API_KEY and TRIGGER_API_URL
+  const apiDetails = await getTriggerApiDetails(resolvedPath, options.envFile);
+
+  if (!apiDetails) {
+    return;
+  }
+
+  const triggerAPI = new TriggerApi(apiDetails.apiKey, apiDetails.apiUrl);
+  const userData = await triggerAPI.whoami(apiDetails.apiKey);
+
+  loadingSpinner.stop();
+
+  logger.info(`
+  environment: ${userData?.type}
+  Trigger Client Id: ${endpointId} 
+  User ID: ${userData?.userId}
+  Project: 
+   id:   ${userData?.project.id}
+   slug: ${userData?.project.slug}
+   name: ${userData?.project.name}
+  Organization:
+   id:    ${userData?.organization.id}
+   slug:  ${userData?.organization.slug}
+   title: ${userData?.organization.title}
+  `);
+  process.exit(1);
+}

packages/cli/src/utils/fileSystem.ts

@@ -25,11 +25,11 @@ export async function removeFile(path: string) {
 }
 
 export async function readFile(path: string) {
-  return await fsModule.readFile(path, "utf-8");
+  return await fsModule.readFile(path, "utf8");
 }
 
 export async function readJSONFile(path: string) {
-  const fileContents = await fsModule.readFile(path, "utf-8");
+  const fileContents = await fsModule.readFile(path, "utf8");
 
   return JSON.parse(fileContents);
 }
@@ -39,7 +39,7 @@ export async function writeJSONFile(path: string, json: any) {
 }
 
 export function readJSONFileSync(path: string) {
-  const fileContents = fsSync.readFileSync(path, "utf-8");
+  const fileContents = fsSync.readFileSync(path, "utf8");
 
   return JSON.parse(fileContents);
 }

packages/cli/tsconfig.json

@@ -1,11 +1,52 @@
 {
-  "extends": "@trigger.dev/tsconfig/node18.json",
   "include": ["src/globals.d.ts", "./src/**/*.ts", "tsup.config.ts", "./test/**/*.ts"],
   "compilerOptions": {
+    /* LANGUAGE COMPILATION OPTIONS */
+    "target": "ES2020",
+    "lib": ["DOM", "DOM.Iterable", "ES2020"],
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "checkJs": true,
+
+    /* EMIT RULES */
+    "outDir": "./dist",
+    "noEmit": true, // TSUP takes care of emitting js for us, in a MUCH faster way
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "removeComments": true,
+
+    /* TYPE CHECKING RULES */
+    "strict": true,
+    // "noImplicitAny": true, // Included in "Strict"
+    // "noImplicitThis": true, // Included in "Strict"
+    // "strictBindCallApply": true, // Included in "Strict"
+    // "strictFunctionTypes": true, // Included in "Strict"
+    // "strictNullChecks": true, // Included in "Strict"
+    // "strictPropertyInitialization": true, // Included in "Strict"
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "useUnknownInCatchVariables": true,
+    "noUncheckedIndexedAccess": true, // TLDR - Checking an indexed value (array[0]) now forces type <T | undefined> as there is no confirmation that index exists
+    // THE BELOW ARE EXTRA STRICT OPTIONS THAT SHOULD ONLY BY CONSIDERED IN VERY SAFE PROJECTS
+    // "exactOptionalPropertyTypes": true, // TLDR - Setting to undefined is not the same as a property not being defined at all
+    // "noPropertyAccessFromIndexSignature": true, // TLDR - Use dot notation for objects if youre sure it exists, use ['index'] notaion if unsure
+
+    /* OTHER OPTIONS */
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    // "emitDecoratorMetadata": true,
+    // "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "useDefineForClassFields": true,
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
-    "declaration": false,
-    "declarationMap": false,
     "types": ["jest"]
   },
   "exclude": ["node_modules"]