@faable/faable 1.15.0 → 1.15.2

package/dist/api/FaableApi.js

@@ -92,6 +92,12 @@ class FaableApi {
             image,
         }));
     }
+    // Fetch a deployment with its runtime status, so the deploy command can
+    // watch for a terminal failure (ERROR/BUILD_ERROR + reason) while polling
+    // for promotion — and fail the run fast instead of timing out green.
+    async getDeployment(deployment_id) {
+        return data(this.client.get(`/deployment/${deployment_id}`));
+    }
     // Attach the captured build/deploy output to a deployment. The base client
     // timeout (10s) is too short for a multi-MB body on a slow uplink.
     async uploadDeploymentLogs(deployment_id, body) {

package/dist/commands/deploy/buildpacks/docker/index.js

@@ -1,8 +1,8 @@
-import fs from 'fs-extra';
 import path__default from 'path';
 import { cmd } from '../../../../lib/cmd.js';
 import { log } from '../../../../log.js';
 import { has_any_of_files } from '../shared/has_any_of_files.js';
+import { read_json_file } from '../shared/read_text_file.js';
 
 // A package.json with a next dependency beside the Dockerfile means this is a
 // Next.js app shipped with a custom image: emit type "next" so the backend
@@ -10,7 +10,7 @@ import { has_any_of_files } from '../shared/has_any_of_files.js';
 // --buildpack override, since the node buildpack claims package.json first.
 const detect_next = (workdir) => {
     try {
-        const pkg = fs.readJSONSync(path__default.join(workdir, "package.json"));
+        const pkg = read_json_file(path__default.join(workdir, "package.json"));
         return Boolean(pkg?.dependencies?.next || pkg?.devDependencies?.next);
     }
     catch {

package/dist/commands/deploy/buildpacks/node/analyze_package.js

@@ -1,13 +1,13 @@
-import fs from 'fs-extra';
 import path__default from 'path';
 import { log } from '../../../../log.js';
+import { read_json_file } from '../shared/read_text_file.js';
 import { detect_framework } from './frameworks.js';
 
 const analyze_package = async (params) => {
     const workdir = params.workdir;
     const package_file = path__default.join(path__default.resolve(workdir), "package.json");
     log.info(`Loading config from package.json`);
-    const pkg = await fs.readJSON(package_file);
+    const pkg = read_json_file(package_file);
     // Check if build is required to run
     const build_script = process.env.FAABLE_NPM_BUILD_SCRIPT
         ? process.env.FAABLE_NPM_BUILD_SCRIPT

package/dist/commands/deploy/buildpacks/node/frameworks.js

@@ -1,7 +1,7 @@
-import fs from 'fs-extra';
 import path__default from 'path';
 import * as R from 'ramda';
 import { log } from '../../../../log.js';
+import { read_json_file } from '../shared/read_text_file.js';
 
 const has_dep = (pkg, name) => Boolean(R.view(R.lensPath(["dependencies", name]), pkg) ||
     R.view(R.lensPath(["devDependencies", name]), pkg));
@@ -13,7 +13,7 @@ const has_dep = (pkg, name) => Boolean(R.view(R.lensPath(["dependencies", name])
 const resolve_angular_output = (workdir) => {
     const fallback = "dist";
     try {
-        const angular_json = fs.readJSONSync(path__default.join(workdir, "angular.json"));
+        const angular_json = read_json_file(path__default.join(workdir, "angular.json"));
         const projects = angular_json?.projects ?? {};
         const project_name = angular_json?.defaultProject ?? Object.keys(projects)[0];
         const build = projects?.[project_name]?.architect?.build;

package/dist/commands/deploy/buildpacks/node/node_version.js

@@ -1,7 +1,7 @@
-import fs from 'fs-extra';
 import path__default from 'path';
 import { cmd } from '../../../../lib/cmd.js';
 import { log } from '../../../../log.js';
+import { read_json_file } from '../shared/read_text_file.js';
 
 const getCurrentNodeVersion = async () => {
     const out = await cmd(`node --version`);
@@ -16,7 +16,7 @@ const getCurrentNodeVersion = async () => {
  */
 const resolve_node_version = async (workdir) => {
     const packageJSONFile = path__default.join(workdir, "package.json");
-    const { name, engines } = fs.readJSONSync(packageJSONFile);
+    const { name, engines } = read_json_file(packageJSONFile);
     if (!name) {
         throw new Error("Missing name in package.json");
     }

package/dist/commands/deploy/buildpacks/python/index.js

@@ -3,6 +3,7 @@ import path__default from 'path';
 import { log } from '../../../../log.js';
 import { render_dockerfile, build_image } from '../shared/docker_image.js';
 import { has_any_of_files } from '../shared/has_any_of_files.js';
+import { read_text_file } from '../shared/read_text_file.js';
 import { cerebrium_provider } from './providers/cerebrium.js';
 import { pipfile_provider } from './providers/pipfile.js';
 import { pyproject_provider } from './providers/pyproject.js';
@@ -89,7 +90,7 @@ const python_buildpack = {
         // Framework detection blob = the entry files themselves: an
         // `from fastapi import FastAPI` line carries the token detection needs.
         const deps = entries
-            .map((f) => fs.readFileSync(path__default.join(ctx.workdir, f)).toString())
+            .map((f) => read_text_file(path__default.join(ctx.workdir, f)))
             .join("\n")
             .toLowerCase();
         const { start_command, server } = resolve_start(ctx.workdir, deps, ctx.config);

package/dist/commands/deploy/buildpacks/python/parse_procfile.js

@@ -1,5 +1,6 @@
 import fs from 'fs-extra';
 import path__default from 'path';
+import { read_text_file } from '../shared/read_text_file.js';
 
 /**
  * Read the `web:` process command from a Procfile, if present. Returns null when
@@ -10,7 +11,7 @@ const parse_procfile = (workdir) => {
     const procfile = path__default.join(workdir, "Procfile");
     if (!fs.existsSync(procfile))
         return null;
-    const content = fs.readFileSync(procfile).toString();
+    const content = read_text_file(procfile);
     for (const line of content.split("\n")) {
         const match = line.match(/^\s*web\s*:\s*(.+?)\s*$/);
         if (match?.[1])

package/dist/commands/deploy/buildpacks/python/providers/cerebrium.js

@@ -1,5 +1,5 @@
-import fs from 'fs-extra';
 import path__default from 'path';
+import { read_text_file } from '../../shared/read_text_file.js';
 import { parse_cerebrium_toml } from './parse_cerebrium_toml.js';
 
 /**
@@ -12,7 +12,7 @@ const cerebrium_provider = {
     name: "cerebrium",
     files: ["cerebrium.toml"],
     resolve(workdir) {
-        const manifest = parse_cerebrium_toml(fs.readFileSync(path__default.join(workdir, "cerebrium.toml")).toString());
+        const manifest = parse_cerebrium_toml(read_text_file(path__default.join(workdir, "cerebrium.toml")));
         let install_command;
         let install_files;
         if (manifest.pip_requirements_file) {

package/dist/commands/deploy/buildpacks/python/python_version.js

@@ -1,5 +1,6 @@
 import fs from 'fs-extra';
 import path__default from 'path';
+import { read_text_file } from '../shared/read_text_file.js';
 
 const DEFAULT_VERSION = "3.11.3";
 /**
@@ -13,7 +14,7 @@ const DEFAULT_VERSION = "3.11.3";
 const resolve_python_version = (workdir, provider_hint) => {
     const runtime_config = path__default.join(workdir, "runtime.txt");
     if (fs.existsSync(runtime_config)) {
-        const runtime_data = fs.readFileSync(runtime_config).toString().trim();
+        const runtime_data = read_text_file(runtime_config).trim();
         if (!runtime_data.startsWith("python-")) {
             throw new Error("runtime.txt must have runtime format with python-<version>");
         }
@@ -21,7 +22,7 @@ const resolve_python_version = (workdir, provider_hint) => {
     }
     const python_version_file = path__default.join(workdir, ".python-version");
     if (fs.existsSync(python_version_file)) {
-        const version = fs.readFileSync(python_version_file).toString().trim();
+        const version = read_text_file(python_version_file).trim();
         if (version)
             return version;
     }
@@ -29,7 +30,7 @@ const resolve_python_version = (workdir, provider_hint) => {
         return provider_hint;
     const pyproject = path__default.join(workdir, "pyproject.toml");
     if (fs.existsSync(pyproject)) {
-        const toml = fs.readFileSync(pyproject).toString();
+        const toml = read_text_file(pyproject);
         const match = toml.match(/requires-python\s*=\s*["'][^0-9]*([0-9]+\.[0-9]+(?:\.[0-9]+)?)/);
         if (match?.[1])
             return match[1];

package/dist/commands/deploy/buildpacks/python/resolve_start.js

@@ -1,6 +1,7 @@
 import fs from 'fs-extra';
 import path__default from 'path';
 import { log } from '../../../../log.js';
+import { read_text_file } from '../shared/read_text_file.js';
 import { parse_procfile } from './parse_procfile.js';
 
 /** Combine all classic dependency manifests into one lowercased blob. */
@@ -9,7 +10,7 @@ const read_dependencies_text = (workdir) => {
     return files
         .map((f) => path__default.join(workdir, f))
         .filter((p) => fs.existsSync(p))
-        .map((p) => fs.readFileSync(p).toString())
+        .map((p) => read_text_file(p))
         .join("\n")
         .toLowerCase();
 };
@@ -59,7 +60,7 @@ const find_app_module = (workdir, pattern) => {
         const module = rel.replace(/\.py$/, "").split(path__default.sep).join(".");
         if (!first_existing)
             first_existing = module;
-        if (pattern.test(fs.readFileSync(abs).toString()))
+        if (pattern.test(read_text_file(abs)))
             return module;
     }
     return first_existing;

package/dist/commands/deploy/buildpacks/shared/read_text_file.js

@@ -0,0 +1,31 @@
+import fs from 'fs-extra';
+
+/**
+ * Decode a manifest/source buffer to a string, honoring a leading BOM.
+ *
+ * Editors and shells on Windows (PowerShell `>` redirection, Notepad "Save As")
+ * frequently write files as UTF‑16 with a BOM. Reading those as UTF‑8 yields
+ * mojibake with interleaved NUL bytes (`f\x00a\x00s\x00t…`), which silently
+ * breaks token detection — e.g. `\bfastapi\b` never matches a UTF‑16
+ * `requirements.txt`, so the Python buildpack skips framework detection and
+ * fails with "Could not detect how to start this Python app". Detect the BOM and
+ * decode accordingly, stripping the BOM from the result.
+ */
+const decode_buffer = (buf) => {
+    if (buf.length >= 2 && buf[0] === 0xff && buf[1] === 0xfe) {
+        return new TextDecoder("utf-16le").decode(buf.subarray(2));
+    }
+    if (buf.length >= 2 && buf[0] === 0xfe && buf[1] === 0xff) {
+        return new TextDecoder("utf-16be").decode(buf.subarray(2));
+    }
+    if (buf.length >= 3 && buf[0] === 0xef && buf[1] === 0xbb && buf[2] === 0xbf) {
+        return buf.subarray(3).toString("utf8");
+    }
+    return buf.toString("utf8");
+};
+/** Read a file to a string, decoding UTF‑16/UTF‑8 BOMs (see {@link decode_buffer}). */
+const read_text_file = (file) => decode_buffer(fs.readFileSync(file));
+/** Read and parse a JSON file, tolerating a UTF‑16/UTF‑8 BOM. */
+const read_json_file = (file) => JSON.parse(read_text_file(file));
+
+export { decode_buffer, read_json_file, read_text_file };

package/dist/commands/deploy/index.js

@@ -112,6 +112,7 @@ const deploy = {
         const start = Date.now();
         log.info(`⏳ Waiting for deployment to be promoted...`);
         let promoted = false;
+        let failure = null;
         while (Date.now() - start < timeoutMs) {
             await wait(intervalMs);
             try {
@@ -120,6 +121,16 @@ const deploy = {
                     promoted = true;
                     break;
                 }
+                // Watch for a terminal runtime failure so we fail fast (and red)
+                // instead of timing out green. The controller marks a crash-looping
+                // deployment ERROR — with a reason (e.g. a missing module) — within
+                // ~1min, long before this 5min promotion timeout.
+                const dep = await api.getDeployment(deployment.id);
+                const phase = dep.status?.phase;
+                if (phase === "ERROR" || phase === "BUILD_ERROR") {
+                    failure = { phase, reason: dep.status?.reason };
+                    break;
+                }
             }
             catch (_error) {
                 // Ignore transient errors while polling and keep waiting
@@ -129,6 +140,15 @@ const deploy = {
         if (promoted) {
             log.info(`🌍 Deployment promoted and live, visit: https://${app.url}`);
         }
+        else if (failure) {
+            // Fail the command (non-zero exit → red GitHub Action) and surface the
+            // reason the controller captured so the user sees WHY without digging.
+            log.error(`❌ Deployment failed (${failure.phase}).`);
+            if (failure.reason)
+                log.error(failure.reason);
+            log.error(`Check the logs in the dashboard -> ${dashboard_url}`);
+            throw new Error(`Deployment ${deployment.id} failed with phase ${failure.phase}`);
+        }
         else {
             log.warn(`⌛ Timed out after 5min waiting for promotion. The deployment is still rolling out, check the dashboard -> ${dashboard_url}`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faable/faable",
-  "version": "1.15.0",
+  "version": "1.15.2",
   "main": "dist/index.js",
   "license": "MIT",
   "author": "Marc Pomar <marc@faable.com>",