@cedarjs/cli 8.0.0-canary.3427 → 8.0.0-canary.3429

package/dist/commands/deploy/baremetal/baremetalHandler.js

@@ -8,6 +8,10 @@ import { env as envInterpolation } from "string-env-interpolation";
 import { titleCase } from "title-case";
 import { colors as c } from "@cedarjs/cli-helpers/colors";
 import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
+import {
+  API_PROCESS_META_FILE_NAME,
+  PROCESS_META_DIR_NAME
+} from "@cedarjs/project-config";
 import { getPackageManager } from "@cedarjs/project-config/packageManager";
 import { getConfig, getPaths } from "../../../lib/index.js";
 import { MONITOR_ADAPTERS, MONITORS, isMonitor } from "./monitors.js";
@@ -17,6 +21,7 @@ const SYMLINK_FLAGS = "-nsf";
 const CURRENT_RELEASE_SYMLINK_NAME = "current";
 const LIFECYCLE_HOOKS = ["before", "after"];
 const DEFAULT_HEALTH_CHECK_PATH = "/graphql/health";
+const GENERATED_DATA_DIRS = [".cedar", ".redwood"];
 const HEALTH_CHECK_INTERVAL_MS = 2e3;
 const HEALTH_CHECK_REQUEST_TIMEOUT_SECONDS = 5;
 const WEB_DIST_DIRS = ["web/dist", "web/dist/browser"];
@@ -114,21 +119,95 @@ const monitorTask = (command, ssh, serverConfig, skip) => {
     ...skip ? { skip } : {}
   };
 };
-const healthCheckUrl = (serverConfig) => {
+const healthCheckTarget = (serverConfig) => {
   if (serverConfig.healthCheckUrl === false) {
     return void 0;
   }
   if (serverConfig.healthCheckUrl) {
-    return serverConfig.healthCheckUrl;
+    return { url: serverConfig.healthCheckUrl };
   }
   if (!serverConfig.sides.includes("api")) {
     return void 0;
   }
-  return `http://localhost:${getConfig().api.port}${DEFAULT_HEALTH_CHECK_PATH}`;
+  return { apiPath: DEFAULT_HEALTH_CHECK_PATH };
+};
+const describeHealthCheckTarget = (target) => {
+  return "url" in target ? target.url : `${target.apiPath} on the api server`;
+};
+const API_PROCESS_META_FILES = GENERATED_DATA_DIRS.map(
+  (dir) => [
+    CURRENT_RELEASE_SYMLINK_NAME,
+    dir,
+    PROCESS_META_DIR_NAME,
+    API_PROCESS_META_FILE_NAME
+  ].join("/")
+);
+const API_SERVER_DIST_DIRS = [
+  "node_modules/@cedarjs/api-server/dist",
+  "api/node_modules/@cedarjs/api-server/dist"
+].map((dir) => `${CURRENT_RELEASE_SYMLINK_NAME}/${dir}`);
+const releaseWritesApiProcessMeta = async (ssh, serverConfig) => {
+  try {
+    await ssh.exec(serverConfig.path, "grep", [
+      "-rqs",
+      "writeApiProcessMeta",
+      ...API_SERVER_DIST_DIRS
+    ]);
+    return true;
+  } catch (e) {
+    if (typeof e === "object" && e !== null && "exitCode" in e && (e.exitCode === 1 || e.exitCode === 2)) {
+      return false;
+    }
+    throw e;
+  }
+};
+const readApiProcessMeta = async (ssh, serverConfig) => {
+  const [preferredFile, fallbackFile] = API_PROCESS_META_FILES;
+  let contents = "";
+  try {
+    const result = await ssh.exec(serverConfig.path, "cat", [
+      preferredFile,
+      "2>/dev/null",
+      "||",
+      "cat",
+      fallbackFile
+    ]);
+    contents = result.stdout;
+  } catch {
+    throw new Error(
+      `The api server hasn't written ${preferredFile} yet. It does that once it's listening.`
+    );
+  }
+  const jsonStart = contents.indexOf("{");
+  let meta;
+  try {
+    meta = JSON.parse(jsonStart === -1 ? contents : contents.slice(jsonStart));
+  } catch (e) {
+    const message = e instanceof Error ? e.message : String(e);
+    throw new Error(`${preferredFile} isn't valid JSON: ${message}`);
+  }
+  if (typeof meta !== "object" || meta === null || !("port" in meta) || !Number.isInteger(meta.port) || !("host" in meta) || typeof meta.host !== "string" || "rootPath" in meta && typeof meta.rootPath !== "string") {
+    throw new Error(
+      `${preferredFile} doesn't hold the api server's port and host: ` + contents.trim()
+    );
+  }
+  return {
+    port: Number(meta.port),
+    host: meta.host,
+    ..."rootPath" in meta && typeof meta.rootPath === "string" ? { rootPath: meta.rootPath } : {}
+  };
+};
+const apiServerUrl = ({
+  port,
+  host,
+  rootPath = "/"
+}, apiPath) => {
+  const hostname = ["", "::", "0.0.0.0"].includes(host) ? "localhost" : host.includes(":") ? `[${host}]` : host;
+  return `http://${hostname}:${port}${rootPath.replace(/\/+$/, "")}${apiPath}`;
 };
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
 const waitForHealthCheck = async ({
-  url,
+  target,
   timeoutSeconds,
   ssh,
   serverConfig,
@@ -138,8 +217,24 @@ const waitForHealthCheck = async ({
   const deadline = Date.now() + timeoutSeconds * 1e3;
   let lastFailure = "";
   let keepTrying = true;
+  let writesApiProcessMeta;
+  const apiProcessMeta = async () => {
+    try {
+      return await readApiProcessMeta(ssh, serverConfig);
+    } catch (e) {
+      writesApiProcessMeta ??= await releaseWritesApiProcessMeta(
+        ssh,
+        serverConfig
+      );
+      if (writesApiProcessMeta) {
+        throw e;
+      }
+      return { port: getConfig().api.port, host: "" };
+    }
+  };
   while (keepTrying) {
     try {
+      const url = "url" in target ? target.url : apiServerUrl(await apiProcessMeta(), target.apiPath);
       await ssh.exec(serverConfig.path, "curl", [
         "--fail",
         "--location",
@@ -163,7 +258,7 @@ const waitForHealthCheck = async ({
   }
   throw new Error(
     [
-      `Health check failed: ${url} did not respond successfully within ${timeoutSeconds} seconds of restarting the ${serverConfig.processNames?.join(", ")} process(es).`,
+      `Health check failed: ${describeHealthCheckTarget(target)} did not respond successfully within ${timeoutSeconds} seconds of restarting the ${serverConfig.processNames?.join(", ")} process(es).`,
       `Last attempt: ${lastFailure}`,
       "",
       ...nextSteps,
@@ -171,15 +266,15 @@ const waitForHealthCheck = async ({
     ].join("\n")
   );
 };
-const healthCheckTask = (url, ssh, serverConfig, nextSteps) => {
+const healthCheckTask = (target, ssh, serverConfig, nextSteps) => {
   return {
-    title: url ? `Checking ${url}...` : "Checking health...",
+    title: target ? `Checking ${describeHealthCheckTarget(target)}...` : "Checking health...",
     task: async (_ctx, task) => {
-      if (!url) {
+      if (!target) {
         return;
       }
       await waitForHealthCheck({
-        url,
+        target,
         timeoutSeconds: parseInt(String(serverConfig.healthCheckTimeout), 10),
         ssh,
         serverConfig,
@@ -189,7 +284,7 @@ const healthCheckTask = (url, ssh, serverConfig, nextSteps) => {
         }
       });
     },
-    skip: () => !url
+    skip: () => !target
   };
 };
 const serverConfigWithDefaults = (serverConfig, yargs) => {
@@ -282,6 +377,10 @@ const rollbackTasks = (count, ssh, serverConfig) => {
             ssh,
             serverConfig.path
           );
+          await ssh.exec(serverConfig.path, "rm", [
+            "-f",
+            ...API_PROCESS_META_FILES
+          ]);
         } else {
           throw new Error(
             `Cannot rollback ${rollbackCount} release(s): ${dirs.length - deployedIndex - 1} previous release(s) available`
@@ -296,7 +395,7 @@ const rollbackTasks = (count, ssh, serverConfig) => {
       tasks.push(monitorTask(adapter.restart(processName), ssh, serverConfig));
     }
     tasks.push(
-      healthCheckTask(healthCheckUrl(serverConfig), ssh, serverConfig, [
+      healthCheckTask(healthCheckTarget(serverConfig), ssh, serverConfig, [
         "The release you rolled back to is live as `current`. Check the process logs on the server, or run the rollback again with `--rollback` to move one more release back."
       ])
     );
@@ -700,13 +799,13 @@ const deployTasks = (yargs, ssh, serverConfig, serverLifecycle) => {
         );
       }
     }
-    const url = healthCheckUrl(serverConfig);
+    const target = healthCheckTarget(serverConfig);
     tasks.push(
       ...commandWithLifecycleEvents({
         name: "healthCheck",
         config: { ...config, cmdPath: serverConfig.path },
-        skip: !yargs.restart || !url,
-        command: healthCheckTask(url, ssh, serverConfig, [
+        skip: !yargs.restart || !target,
+        command: healthCheckTask(target, ssh, serverConfig, [
           `The new release is live as \`current\`. Check the process logs on the server, or roll back to the previous release with \`${formatCedarCommand(["deploy", "baremetal", yargs.environment, "--rollback"])}\`.`
         ])
       })
@@ -882,16 +981,20 @@ const handler = async (yargs) => {
 export {
   DEFAULT_SERVER_CONFIG,
   RELEASE_DIR_PATTERN,
+  apiServerUrl,
   commandWithLifecycleEvents,
   commands,
   deployTasks,
+  describeHealthCheckTarget,
   handler,
-  healthCheckUrl,
+  healthCheckTarget,
   keepPreviousAssets,
   lifecycleTask,
   maintenanceTasks,
   manifestAssetFiles,
   parseConfig,
+  readApiProcessMeta,
+  releaseWritesApiProcessMeta,
   rollbackTasks,
   serverConfigWithDefaults,
   throwMissingConfig,

package/dist/commands/serve.js

@@ -7,6 +7,7 @@ import * as apiServerCLIConfig from "@cedarjs/api-server/apiCliConfig";
 import * as bothServerCLIConfig from "@cedarjs/api-server/bothCliConfig";
 import { colors as c } from "@cedarjs/cli-helpers/colors";
 import { recordTelemetryAttributes } from "@cedarjs/cli-helpers/telemetry";
+import { writeApiProcessMeta } from "@cedarjs/project-config";
 import * as webServerCLIConfig from "@cedarjs/web-server";
 import { getPaths, getConfig } from "../lib/index.js";
 import { serverFileExists } from "../lib/project.js";
@@ -46,6 +47,17 @@ async function startUDServer(entryPath, host, port) {
   });
   server.serve();
   await server.ready();
+  const address = server.node?.server?.address();
+  try {
+    writeApiProcessMeta(
+      address && typeof address !== "string" ? { port: address.port, host: address.address } : { port, host }
+    );
+  } catch (e) {
+    const message = e instanceof Error ? e.message : String(e);
+    console.warn(
+      c.warning(`Could not write the api process meta file: ${message}`)
+    );
+  }
   return server;
 }
 const command = "serve [side]";

package/dist/commands/setup/deploy/templates/baremetal.js

@@ -128,8 +128,9 @@ const deployToml = ({
 # After restarting the processes, the deploy requests the api side's health
 # check endpoint on the server and fails if it doesn't respond in time:
 #
-# * healthCheckUrl - defaults to http://localhost:<[api].port>/graphql/health
-#   on servers that host the api side. Set to \`false\` to skip the check
+# * healthCheckUrl - defaults to http://localhost:<port>/graphql/health on
+#   servers that host the api side, at the port their api server listens on.
+#   Set to \`false\` to skip the check
 # * healthCheckTimeout - seconds to keep retrying, defaults to 30
 #
 # See https://cedarjs.com/docs/deploy/baremetal for more info

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cedarjs/cli",
-  "version": "8.0.0-canary.3427",
+  "version": "8.0.0-canary.3429",
   "description": "The CedarJS Command Line",
   "repository": {
     "type": "git",
@@ -36,17 +36,17 @@
     "@babel/preset-typescript": "7.29.7",
     "@babel/traverse": "7.29.10",
     "@babel/types": "7.29.8",
-    "@cedarjs/api-server": "8.0.0-canary.3427",
-    "@cedarjs/babel-config": "8.0.0-canary.3427",
-    "@cedarjs/cli-helpers": "8.0.0-canary.3427",
-    "@cedarjs/internal": "8.0.0-canary.3427",
-    "@cedarjs/prerender": "8.0.0-canary.3427",
-    "@cedarjs/project-config": "8.0.0-canary.3427",
-    "@cedarjs/structure": "8.0.0-canary.3427",
-    "@cedarjs/telemetry": "8.0.0-canary.3427",
-    "@cedarjs/utils": "8.0.0-canary.3427",
-    "@cedarjs/vite": "8.0.0-canary.3427",
-    "@cedarjs/web-server": "8.0.0-canary.3427",
+    "@cedarjs/api-server": "8.0.0-canary.3429",
+    "@cedarjs/babel-config": "8.0.0-canary.3429",
+    "@cedarjs/cli-helpers": "8.0.0-canary.3429",
+    "@cedarjs/internal": "8.0.0-canary.3429",
+    "@cedarjs/prerender": "8.0.0-canary.3429",
+    "@cedarjs/project-config": "8.0.0-canary.3429",
+    "@cedarjs/structure": "8.0.0-canary.3429",
+    "@cedarjs/telemetry": "8.0.0-canary.3429",
+    "@cedarjs/utils": "8.0.0-canary.3429",
+    "@cedarjs/vite": "8.0.0-canary.3429",
+    "@cedarjs/web-server": "8.0.0-canary.3429",
     "@listr2/prompt-adapter-enquirer": "4.3.3",
     "@opentelemetry/api": "1.9.1",
     "@opentelemetry/core": "2.12.0",
@@ -94,7 +94,7 @@
     "yargs": "17.7.3"
   },
   "devDependencies": {
-    "@cedarjs/framework-tools": "8.0.0-canary.3427",
+    "@cedarjs/framework-tools": "8.0.0-canary.3429",
     "@prisma/dmmf": "7.10.0",
     "@types/archiver": "^7.0.0",
     "memfs": "4.80.0",