@cedarjs/cli 8.0.0-canary.3339 → 8.0.0-canary.3341

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

@@ -9,11 +9,15 @@ import { titleCase } from "title-case";
 import { colors as c } from "@cedarjs/cli-helpers/colors";
 import { formatCedarCommand } from "@cedarjs/cli-helpers/packageManager/display";
 import { getPackageManager } from "@cedarjs/project-config/packageManager";
-import { getPaths } from "../../../lib/index.js";
+import { getConfig, getPaths } from "../../../lib/index.js";
 const CONFIG_FILENAME = "deploy.toml";
+const DOCS_URL = "https://cedarjs.com/docs/deploy/baremetal";
 const SYMLINK_FLAGS = "-nsf";
 const CURRENT_RELEASE_SYMLINK_NAME = "current";
 const LIFECYCLE_HOOKS = ["before", "after"];
+const DEFAULT_HEALTH_CHECK_PATH = "/graphql/health";
+const HEALTH_CHECK_INTERVAL_MS = 2e3;
+const HEALTH_CHECK_REQUEST_TIMEOUT_SECONDS = 5;
 const WEB_DIST_DIRS = ["web/dist", "web/dist/browser"];
 const BUILD_MANIFEST_FILENAME = "client-build-manifest.json";
 const LINK_BATCH_SIZE = 100;
@@ -26,9 +30,11 @@ const DEFAULT_SERVER_CONFIG = {
   monitorCommand: "pm2",
   sides: ["api", "web"],
   keepReleases: 5,
-  freeSpaceRequired: 2048
+  freeSpaceRequired: 2048,
+  healthCheckTimeout: 30
 };
 const pathJoin = path.posix.join;
+const shellQuote = (value) => `'${value.replaceAll("'", `'\\''`)}'`;
 const throwMissingConfig = (name) => {
   throw new Error(
     `"${name}" config option not set. See https://cedarjs.com/docs/deployment/baremetal#deploytoml`
@@ -45,6 +51,17 @@ const verifyConfig = (config, yargs) => {
   }
   return true;
 };
+const isHttpUrl = (value) => {
+  if (typeof value !== "string") {
+    return false;
+  }
+  try {
+    const { protocol } = new URL(value);
+    return protocol === "http:" || protocol === "https:";
+  } catch {
+    return false;
+  }
+};
 const verifyServerConfig = (config) => {
   if (!config.host) {
     throwMissingConfig("host");
@@ -58,6 +75,12 @@ const verifyServerConfig = (config) => {
   if (!/^\d+$/.test(String(config.freeSpaceRequired))) {
     throw new Error('"freeSpaceRequired" must be an integer >= 0');
   }
+  if (config.healthCheckUrl !== void 0 && config.healthCheckUrl !== false && !isHttpUrl(config.healthCheckUrl)) {
+    throw new Error('"healthCheckUrl" must be an http(s) URL or `false`');
+  }
+  if (!/^\d+$/.test(String(config.healthCheckTimeout))) {
+    throw new Error('"healthCheckTimeout" must be an integer >= 0');
+  }
   return true;
 };
 const symlinkCurrentCommand = async (dir, ssh, deployPath) => {
@@ -73,6 +96,84 @@ const restartProcessCommand = async (processName, ssh, serverConfig, deployPath)
     processName
   ]);
 };
+const healthCheckUrl = (serverConfig) => {
+  if (serverConfig.healthCheckUrl === false) {
+    return void 0;
+  }
+  if (serverConfig.healthCheckUrl) {
+    return serverConfig.healthCheckUrl;
+  }
+  if (!serverConfig.sides.includes("api")) {
+    return void 0;
+  }
+  return `http://localhost:${getConfig().api.port}${DEFAULT_HEALTH_CHECK_PATH}`;
+};
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+const waitForHealthCheck = async ({
+  url,
+  timeoutSeconds,
+  ssh,
+  serverConfig,
+  nextSteps,
+  onFailedAttempt
+}) => {
+  const deadline = Date.now() + timeoutSeconds * 1e3;
+  let lastFailure = "";
+  let keepTrying = true;
+  while (keepTrying) {
+    try {
+      await ssh.exec(serverConfig.path, "curl", [
+        "--fail",
+        "--location",
+        "--silent",
+        "--show-error",
+        "--output",
+        "/dev/null",
+        "--max-time",
+        String(HEALTH_CHECK_REQUEST_TIMEOUT_SECONDS),
+        shellQuote(url)
+      ]);
+      return;
+    } catch (e) {
+      lastFailure = e instanceof Error ? e.message : String(e);
+      onFailedAttempt?.(lastFailure);
+    }
+    keepTrying = Date.now() + HEALTH_CHECK_INTERVAL_MS <= deadline;
+    if (keepTrying) {
+      await sleep(HEALTH_CHECK_INTERVAL_MS);
+    }
+  }
+  throw new Error(
+    [
+      `Health check failed: ${url} did not respond successfully within ${timeoutSeconds} seconds of restarting the ${serverConfig.processNames?.join(", ")} process(es).`,
+      `Last attempt: ${lastFailure}`,
+      "",
+      ...nextSteps,
+      `If your app serves its health check somewhere else, set \`healthCheckUrl\` in deploy.toml. Set it to \`false\` to skip the check. See ${DOCS_URL}#health-check`
+    ].join("\n")
+  );
+};
+const healthCheckTask = (url, ssh, serverConfig, nextSteps) => {
+  return {
+    title: url ? `Checking ${url}...` : "Checking health...",
+    task: async (_ctx, task) => {
+      if (!url) {
+        return;
+      }
+      await waitForHealthCheck({
+        url,
+        timeoutSeconds: parseInt(String(serverConfig.healthCheckTimeout), 10),
+        ssh,
+        serverConfig,
+        nextSteps,
+        onFailedAttempt: (reason) => {
+          task.output = reason;
+        }
+      });
+    },
+    skip: () => !url
+  };
+};
 const serverConfigWithDefaults = (serverConfig, yargs) => {
   return {
     ...DEFAULT_SERVER_CONFIG,
@@ -183,6 +284,11 @@ const rollbackTasks = (count, ssh, serverConfig) => {
         }
       });
     }
+    tasks.push(
+      healthCheckTask(healthCheckUrl(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."
+      ])
+    );
   }
   return tasks;
 };
@@ -239,7 +345,6 @@ const manifestAssetFiles = (manifestJson) => {
   }
   return [...files];
 };
-const shellQuote = (value) => `'${value.replaceAll("'", `'\\''`)}'`;
 const readBuildManifest = async (ssh, releasePath) => {
   for (const distDir of WEB_DIST_DIRS) {
     let stdout;
@@ -579,6 +684,17 @@ const deployTasks = (yargs, ssh, serverConfig, serverLifecycle) => {
         );
       }
     }
+    const url = healthCheckUrl(serverConfig);
+    tasks.push(
+      ...commandWithLifecycleEvents({
+        name: "healthCheck",
+        config: { ...config, cmdPath: serverConfig.path },
+        skip: !yargs.restart || !url,
+        command: healthCheckTask(url, 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"])}\`.`
+        ])
+      })
+    );
   }
   tasks.push(
     ...commandWithLifecycleEvents({
@@ -755,6 +871,7 @@ export {
   commands,
   deployTasks,
   handler,
+  healthCheckUrl,
   keepPreviousAssets,
   lifecycleTask,
   maintenanceTasks,
@@ -765,5 +882,6 @@ export {
   throwMissingConfig,
   verifyConfig,
   verifyServerConfig,
+  waitForHealthCheck,
   warnIfUnpushedCommits
 };

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

@@ -26,6 +26,13 @@ const DEPLOY = `# This file contains config for a baremetal deployment
 # * passphrase - used if your private key has a passphrase
 # * agentForward - set to \`true\` to forward the client machine's ssh credentials
 #
+# 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
+# * healthCheckTimeout - seconds to keep retrying, defaults to 30
+#
 # See https://cedarjs.com/docs/deploy/baremetal for more info
 
 [[production.servers]]
@@ -41,6 +48,7 @@ repo = "git@github.com:myorg/myapp.git"
 branch = "main"
 keepReleases = 5
 freeSpaceRequired = 2048
+healthCheckTimeout = 30
 
 # If you have separate api and web servers:
 #

package/package.json

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