accessing runtime specific functions through JsRuntime"

Author: Guy Kedem

packages/cli/src/commands/dev.ts

@@ -3,7 +3,7 @@ import childProcess from "child_process";
 import chokidar from "chokidar";
 import fs from "fs/promises";
 import ngrok from "ngrok";
-import { run as ncuRun } from "npm-check-updates";
+import run, { run as ncuRun } from "npm-check-updates";
 import ora, { Ora } from "ora";
 import pathModule from "path";
 import util from "util";
@@ -19,6 +19,7 @@ import { resolvePath } from "../utils/parseNameAndPath";
 import { RequireKeys } from "../utils/requiredKeys";
 import { TriggerApi } from "../utils/triggerApi";
 import { standardWatchIgnoreRegex, standardWatchFilePaths } from "../frameworks/watchConfig";
+import { JsRuntime, getJsRuntime } from "../utils/jsRuntime";
 
 const asyncExecFile = util.promisify(childProcess.execFile);
 
@@ -41,6 +42,7 @@ const formattedDate = new Intl.DateTimeFormat("en", {
   second: "numeric",
 });
 
+let runtime: JsRuntime;
 export async function devCommand(path: string, anyOptions: any) {
   telemetryClient.dev.started(path, anyOptions);
 
@@ -53,12 +55,12 @@ export async function devCommand(path: string, anyOptions: any) {
   const options = result.data;
 
   const resolvedPath = resolvePath(path);
-
+  runtime = await getJsRuntime(resolvedPath, logger);
   //check for outdated packages, don't await this
-  checkForOutdatedPackages(resolvedPath);
+  runtime.checkForOutdatedPackages();
 
   // Read from package.json to get the endpointId
-  const endpointId = await getEndpointIdFromPackageJson(resolvedPath, options);
+  const endpointId = await getEndpointId(runtime, options);
   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"
@@ -69,8 +71,8 @@ export async function devCommand(path: string, anyOptions: any) {
   logger.success(`✔️ [trigger.dev] Detected TriggerClient id: ${endpointId}`);
 
   //resolve the options using the detected framework (use default if there isn't a matching framework)
-  const packageManager = await getUserPackageManager(resolvedPath);
-  const framework = await getFramework(resolvedPath, packageManager);
+  const packageManager = await runtime.getUserPackageManager();
+  const framework = await runtime.getFramework();
   const resolvedOptions = await resolveOptions(framework, resolvedPath, options);
 
   // Read from .env.local or .env to get the TRIGGER_API_KEY and TRIGGER_API_URL
@@ -115,7 +117,7 @@ export async function devCommand(path: string, anyOptions: any) {
   const refresh = async () => {
     connectingSpinner.start();
 
-    const refreshedEndpointId = await getEndpointIdFromPackageJson(resolvedPath, resolvedOptions);
+    const refreshedEndpointId = await getEndpointId(runtime, resolvedOptions);
 
     // Read from env file to get the TRIGGER_API_KEY and TRIGGER_API_URL
     const apiDetails = await getTriggerApiDetails(resolvedPath, envFile);
@@ -304,43 +306,10 @@ async function verifyEndpoint(
   return;
 }
 
-export async function checkForOutdatedPackages(path: string) {
-  const updates = (await ncuRun({
-    packageFile: `${path}/package.json`,
-    filter: "/trigger.dev/.+$/",
-    upgrade: false,
-  })) as {
-    [key: string]: string;
-  };
-
-  if (typeof updates === "undefined" || Object.keys(updates).length === 0) {
-    return;
-  }
-
-  const packageFile = await fs.readFile(`${path}/package.json`);
-  const data = JSON.parse(Buffer.from(packageFile).toString("utf8"));
-  const dependencies = data.dependencies;
-  console.log(chalk.bgYellow("Updates available for trigger.dev packages"));
-  console.log(chalk.bgBlue("Run npx @trigger.dev/cli@latest update"));
-
-  for (let dep in updates) {
-    console.log(`${dep}  ${dependencies[dep]}  →  ${updates[dep]}`);
-  }
-}
-
-export async function getEndpointIdFromPackageJson(path: string, options: DevCommandOptions) {
+export function getEndpointId(runtime: JsRuntime, options: DevCommandOptions) {
   if (options.clientId) {
     return options.clientId;
-  }
-
-  const pkgJsonPath = pathModule.join(path, "package.json");
-  const pkgBuffer = await fs.readFile(pkgJsonPath);
-  const pkgJson = JSON.parse(pkgBuffer.toString());
-
-  const value = pkgJson["trigger.dev"]?.endpointId;
-  if (!value || typeof value !== "string") return;
-
-  return value as string;
+  } else return runtime.getEndpointId();
 }
 
 async function resolveEndpointUrl(apiUrl: string, port: number, hostname: string) {

packages/cli/src/commands/whoami.ts

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { logger } from "../utils/logger";
 import { resolvePath } from "../utils/parseNameAndPath";
 import { TriggerApi } from "../utils/triggerApi";
-import { DevCommandOptions, getEndpointIdFromPackageJson } from "./dev";
+import { DevCommandOptions, getEndpointId } from "./dev";
 import ora from "ora";
 import { getTriggerApiDetails } from "../utils/getTriggerApiDetails";
 
@@ -26,7 +26,7 @@ export async function whoamiCommand(path: string, anyOptions: any) {
   const resolvedPath = resolvePath(path);
 
   // Read from package.json to get the endpointId
-  const endpointId = await getEndpointIdFromPackageJson(resolvedPath, options as DevCommandOptions);
+  const endpointId = await getEndpointId(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"

packages/cli/src/utils/jsRuntime.ts

@@ -8,7 +8,7 @@ import pathModule from "path";
 
 type SupportedRuntimeId = "node" | "deno";
 
-abstract class JsRuntime {
+export abstract class JsRuntime {
   logger: Logger;
   projectRootPath: string;
   constructor(projectRootPath: string, logger: Logger) {
@@ -19,14 +19,15 @@ abstract class JsRuntime {
   abstract getUserPackageManager(): Promise<PackageManager | undefined>;
   abstract getFramework(): Promise<Framework | undefined>;
   abstract getEndpointId(): Promise<string | undefined>;
-  static async getJsRuntime(projectRootPath: string, logger: Logger) {
-    if (await NodeJsRuntime.isNodeJsRuntime(projectRootPath)) {
-      return new NodeJsRuntime(projectRootPath, logger);
-    } else if (await DenoRuntime.isDenoJsRuntime(projectRootPath)) {
-      return new DenoRuntime(projectRootPath, logger);
-    }
-    throw new Error("Unsupported runtime");
+}
+
+export async function getJsRuntime(projectRootPath: string, logger: Logger): Promise<JsRuntime> {
+  if (await NodeJsRuntime.isNodeJsRuntime(projectRootPath)) {
+    return new NodeJsRuntime(projectRootPath, logger);
+  } else if (await DenoRuntime.isDenoJsRuntime(projectRootPath)) {
+    return new DenoRuntime(projectRootPath, logger);
   }
+  throw new Error("Unsupported runtime");
 }
 
 class NodeJsRuntime extends JsRuntime {
@@ -79,7 +80,8 @@ class NodeJsRuntime extends JsRuntime {
     const pkgJsonPath = pathModule.join(this.projectRootPath, "package.json");
     const pkgBuffer = await fs.readFile(pkgJsonPath);
     const pkgJson = JSON.parse(pkgBuffer.toString());
-    return pkgJson["trigger.dev"]?.endpointId;
+    const value = pkgJson["trigger.dev"]?.endpointId;
+    if (!value || typeof value !== "string") return undefined;
   }
 }