neonctl 2.27.1 → 2.29.0

package/dist/commands/dev.js

@@ -1,33 +1,33 @@
-import { spawn, spawnSync } from 'node:child_process';
-import { once } from 'node:events';
-import { existsSync, mkdirSync, rmSync, writeFileSync } from 'node:fs';
-import { dirname, join, resolve } from 'node:path';
-import { fileURLToPath } from 'node:url';
-import chalk from 'chalk';
-import { log } from '../log.js';
-import { bundleEntry } from '../utils/esbuild.js';
-import { resolveDevEnv } from '../dev/env.js';
-import { resolveFunctionsFromConfig, } from '../dev/functions.js';
-import { resolveWatchInputs } from '../dev/inputs.js';
-import { branchIdResolve } from '../utils/enrichers.js';
-export const command = 'dev';
-export const describe = 'Run Neon Functions locally with a dev server';
+import { spawn, spawnSync } from "node:child_process";
+import { once } from "node:events";
+import { existsSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
+import { dirname, join, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
+import chalk from "chalk";
+import { resolveDevEnv } from "../dev/env.js";
+import { resolveFunctionsFromConfig, } from "../dev/functions.js";
+import { resolveWatchInputs } from "../dev/inputs.js";
+import { log } from "../log.js";
+import { branchIdResolve } from "../utils/enrichers.js";
+import { bundleEntry } from "../utils/esbuild.js";
+export const command = "dev";
+export const describe = "Run Neon Functions locally with a dev server";
 export const builder = (argv) => argv
-    .usage('$0 dev [--source <path>] [options]')
-    .example('$0 dev --source ./functions/hello.ts', 'Serve one function on a free port with hot reload')
-    .example('$0 dev', 'Serve every function declared in neon.ts (one dev server each)')
-    .example('$0 dev --source ./functions/hello.ts --port 3000', 'Serve one function on an explicit port (fails if the port is taken)')
+    .usage("$0 dev [--source <path>] [options]")
+    .example("$0 dev --source ./functions/hello.ts", "Serve one function on a free port with hot reload")
+    .example("$0 dev", "Serve every function declared in neon.ts (one dev server each)")
+    .example("$0 dev --source ./functions/hello.ts --port 3000", "Serve one function on an explicit port (fails if the port is taken)")
     .options({
     source: {
-        describe: 'Path to a single function entry module. Omit to serve every ' +
-            'function declared in neon.ts.',
-        type: 'string',
+        describe: "Path to a single function entry module. Omit to serve every " +
+            "function declared in neon.ts.",
+        type: "string",
     },
     port: {
-        describe: 'Port to listen on (single-function mode only, with --source). ' +
-            'Fails if taken. Without it (and without a PORT env var) a free ' +
-            'port is chosen automatically.',
-        type: 'number',
+        describe: "Port to listen on (single-function mode only, with --source). " +
+            "Fails if taken. Without it (and without a PORT env var) a free " +
+            "port is chosen automatically.",
+        type: "number",
     },
 })
     .strict();
@@ -39,8 +39,8 @@ export const handler = async (props) => {
     // No --source: --port has no single target to bind, so reject it explicitly
     // rather than silently ignoring it.
     if (props.port !== undefined) {
-        throw new Error('--port can only be used with --source. To set ports for the functions ' +
-            'in neon.ts, give each one a `dev.port` in its config.');
+        throw new Error("--port can only be used with --source. To set ports for the functions " +
+            "in neon.ts, give each one a `dev.port` in its config.");
     }
     await runFromConfig(props);
 };
@@ -61,7 +61,7 @@ const runSingleSource = async (props) => {
     const unit = {
         slug: null,
         source,
-        bundleDir: join(process.cwd(), 'node_modules', '.neon-dev'),
+        bundleDir: join(process.cwd(), "node_modules", ".neon-dev"),
         childEnv: buildChildEnv(neonEnv, portFromProps(props.port)),
         label: null,
         envSummary: { neon: Object.keys(neonEnv), fn: [] },
@@ -80,14 +80,14 @@ const runFromConfig = async (props) => {
     const branchId = await resolveBranchId(props);
     const resolved = await resolveFunctionsFromConfig(process.cwd());
     if (resolved === null) {
-        throw new Error('No --source given and no neon.ts found. Pass --source <path> to run a ' +
-            'single function, or add a neon.ts that declares functions under ' +
-            '`preview.functions`.');
+        throw new Error("No --source given and no neon.ts found. Pass --source <path> to run a " +
+            "single function, or add a neon.ts that declares functions under " +
+            "`preview.functions`.");
     }
     const { configPath, functions } = resolved;
     if (functions.length === 0) {
-        throw new Error('neon.ts has no functions to serve. Add at least one under ' +
-            '`preview.functions`, or pass --source <path>.');
+        throw new Error("neon.ts has no functions to serve. Add at least one under " +
+            "`preview.functions`, or pass --source <path>.");
     }
     const { vars: neonEnv, skipped } = await resolveDevEnv({
         cwd: process.cwd(),
@@ -147,18 +147,18 @@ const resolveBranchId = async (props) => {
         });
     }
     catch (err) {
-        log.debug('dev: could not resolve branch id: %s', err instanceof Error ? err.message : String(err));
+        log.debug("dev: could not resolve branch id: %s", err instanceof Error ? err.message : String(err));
         return undefined;
     }
 };
 const DEFAULT_PORT_BASE = 8787;
 const portFromProps = (port) => {
     if (port !== undefined)
-        return { mode: 'explicit', port };
-    if (process.env.PORT !== undefined && process.env.PORT !== '') {
-        return { mode: 'explicit', port: Number(process.env.PORT) };
+        return { mode: "explicit", port };
+    if (process.env.PORT !== undefined && process.env.PORT !== "") {
+        return { mode: "explicit", port: Number(process.env.PORT) };
     }
-    return { mode: 'search', from: DEFAULT_PORT_BASE };
+    return { mode: "search", from: DEFAULT_PORT_BASE };
 };
 /**
  * Translate a {@link PlannedFunction} into a {@link ServedUnit}. Port rules:
@@ -168,13 +168,13 @@ const portFromProps = (port) => {
  */
 const plannedToUnit = (fn, branchEnv, searchBase) => {
     const port = fn.port !== undefined
-        ? { mode: 'explicit', port: fn.port }
-        : { mode: 'search', from: searchBase };
+        ? { mode: "explicit", port: fn.port }
+        : { mode: "search", from: searchBase };
     const childEnv = buildChildEnv({ ...branchEnv, ...fn.env }, port);
     return {
         slug: fn.slug,
         source: fn.source,
-        bundleDir: join(process.cwd(), 'node_modules', '.neon-dev', fn.slug),
+        bundleDir: join(process.cwd(), "node_modules", ".neon-dev", fn.slug),
         childEnv,
         label: fn.slug,
         envSummary: { neon: Object.keys(branchEnv), fn: Object.keys(fn.env) },
@@ -199,10 +199,10 @@ const buildChildEnv = (neonEnv, port) => {
     const env = { ...process.env, ...neonEnv };
     delete env.NEON_DEV_PORT;
     delete env.NEON_DEV_PORT_BASE;
-    if (port.mode === 'explicit') {
+    if (port.mode === "explicit") {
         env.NEON_DEV_PORT = String(port.port);
     }
-    else if (port.mode === 'search') {
+    else if (port.mode === "search") {
         env.NEON_DEV_PORT_BASE = String(port.from);
     }
     return env;
@@ -232,8 +232,8 @@ const runSupervisor = async (units, options = {}) => {
             bundlePath = await writeBundle(r.unit.source, r.unit.bundleDir);
         }
         catch (err) {
-            r.status = 'error';
-            logUnit(r.unit, chalk.red('bundle failed: ') +
+            r.status = "error";
+            logUnit(r.unit, chalk.red("bundle failed: ") +
                 (err instanceof Error ? err.message : String(err)));
             return;
         }
@@ -243,15 +243,15 @@ const runSupervisor = async (units, options = {}) => {
         r.child = next;
         const ready = waitForReady(next);
         pipeChildOutput(next, r.unit.label);
-        next.on('exit', (code, signal) => {
+        next.on("exit", (code, signal) => {
             if (shuttingDown || r.child !== next)
                 return;
             if (signal) {
-                log.debug('runtime for %s exited via %s', r.unit.slug ?? '(source)', signal);
+                log.debug("runtime for %s exited via %s", r.unit.slug ?? "(source)", signal);
                 return;
             }
             if (code && code !== 0 && r.everReady) {
-                r.status = 'error';
+                r.status = "error";
                 logUnit(r.unit, chalk.red(`exited with code ${code} (waiting for a change)`));
             }
         });
@@ -259,10 +259,10 @@ const runSupervisor = async (units, options = {}) => {
         if (port !== null) {
             r.boundPort = port;
             r.everReady = true;
-            r.status = 'ready';
+            r.status = "ready";
         }
         else {
-            r.status = 'error';
+            r.status = "error";
         }
     };
     const restart = (r) => {
@@ -272,14 +272,14 @@ const runSupervisor = async (units, options = {}) => {
             clearTimeout(r.restartTimer);
         r.restartTimer = setTimeout(() => {
             void (async () => {
-                logUnit(r.unit, chalk.dim('change detected, restarting…'));
+                logUnit(r.unit, chalk.dim("change detected, restarting…"));
                 if (r.child)
                     await killTree(r.child);
                 if (shuttingDown)
                     return;
                 await bundleAndStart(r);
-                if (r.status === 'ready') {
-                    logUnit(r.unit, chalk.green('ready') + ` ${urlFor(r.boundPort)}`);
+                if (r.status === "ready") {
+                    logUnit(r.unit, chalk.green("ready") + ` ${urlFor(r.boundPort)}`);
                 }
             })();
         }, 150);
@@ -304,9 +304,9 @@ const runSupervisor = async (units, options = {}) => {
     };
     // Start every unit. They are independent: keep going if one fails.
     await Promise.all(running.map((r) => startUnit(r)));
-    if (running.every((r) => r.status === 'error')) {
+    if (running.every((r) => r.status === "error")) {
         await Promise.all(running.map((r) => stopUnit(r)));
-        throw new Error('No function started. See the output above for details.');
+        throw new Error("No function started. See the output above for details.");
     }
     printBanner(running, envNote);
     // Config mode only: watch neon.ts and reconcile the live unit set when it changes.
@@ -347,12 +347,12 @@ const runSupervisor = async (units, options = {}) => {
             void (async () => {
                 await configWatcher?.close();
                 await Promise.all(running.map((r) => stopUnit(r)));
-                log.info(chalk.dim('Stopped the dev server.'));
+                log.info(chalk.dim("Stopped the dev server."));
                 resolveRun();
             })();
         };
-        process.on('SIGINT', shutdown);
-        process.on('SIGTERM', shutdown);
+        process.on("SIGINT", shutdown);
+        process.on("SIGTERM", shutdown);
     });
 };
 const makeRunningUnit = (unit) => ({
@@ -362,7 +362,7 @@ const makeRunningUnit = (unit) => ({
     everReady: false,
     restartTimer: null,
     watcher: null,
-    status: 'starting',
+    status: "starting",
 });
 /**
  * Pure slug-keyed diff of the live units against the freshly-resolved desired set:
@@ -417,16 +417,16 @@ const reconcileOnce = async (running, replan, ops) => {
         desired = await replan(nextSearchBase(running));
     }
     catch (err) {
-        log.info(chalk.red('neon.ts change ignored: ') +
+        log.info(chalk.red("neon.ts change ignored: ") +
             (err instanceof Error ? err.message : String(err)) +
-            chalk.dim(' (fix it and save again)'));
+            chalk.dim(" (fix it and save again)"));
         return;
     }
     if (ops.isShuttingDown())
         return;
     const plan = diffUnits(running, desired);
     for (const r of plan.remove) {
-        logUnit(r.unit, chalk.dim('removed from neon.ts, stopping…'));
+        logUnit(r.unit, chalk.dim("removed from neon.ts, stopping…"));
         await ops.stopUnit(r);
         const idx = running.indexOf(r);
         if (idx !== -1)
@@ -438,16 +438,16 @@ const reconcileOnce = async (running, replan, ops) => {
         const added = plan.add.map((unit) => {
             const r = makeRunningUnit(unit);
             running.push(r);
-            logUnit(unit, chalk.dim('added in neon.ts, starting…'));
+            logUnit(unit, chalk.dim("added in neon.ts, starting…"));
             return r;
         });
         await Promise.all(added.map((r) => ops.startUnit(r)));
         for (const r of added) {
-            if (r.status === 'ready') {
+            if (r.status === "ready") {
                 const env = formatEnvSummary(r.unit.envSummary);
-                logUnit(r.unit, chalk.green('ready') +
+                logUnit(r.unit, chalk.green("ready") +
                     ` ${urlFor(r.boundPort)}` +
-                    (env ? chalk.dim(`  ${env}`) : ''));
+                    (env ? chalk.dim(`  ${env}`) : ""));
             }
         }
     }
@@ -472,7 +472,7 @@ const nextSearchBase = (running) => {
  */
 const spawnChild = (unit, runtimePath, bundlePath) => {
     return spawn(process.execPath, [runtimePath, bundlePath], {
-        stdio: ['ignore', 'pipe', 'pipe'],
+        stdio: ["ignore", "pipe", "pipe"],
         env: unit.childEnv,
         detached: true,
     });
@@ -485,23 +485,23 @@ const writeBundle = async (source, bundleDir) => {
     for (const [name, contents] of Object.entries(files)) {
         writeFileSync(join(bundleDir, name), contents);
     }
-    return join(bundleDir, 'index.mjs');
+    return join(bundleDir, "index.mjs");
 };
-const urlFor = (port) => port === null ? chalk.red('not running') : `http://localhost:${port}`;
+const urlFor = (port) => port === null ? chalk.red("not running") : `http://localhost:${port}`;
 const waitForReady = (child) => new Promise((resolveReady) => {
     let settled = false;
-    let buffer = '';
+    let buffer = "";
     const onData = (chunk) => {
         buffer += chunk.toString();
         const match = READY_PATTERN.exec(buffer);
         if (match && !settled) {
             settled = true;
-            child.stdout?.off('data', onData);
+            child.stdout?.off("data", onData);
             resolveReady(Number(match[1]));
         }
     };
-    child.stdout?.on('data', onData);
-    child.once('exit', () => {
+    child.stdout?.on("data", onData);
+    child.once("exit", () => {
         if (!settled) {
             settled = true;
             resolveReady(null);
@@ -514,13 +514,13 @@ const waitForReady = (child) => new Promise((resolveReady) => {
  * prefixed with `[slug]` so concurrent servers' output stays readable.
  */
 const pipeChildOutput = (child, label) => {
-    const prefix = label ? chalk.dim(`[${label}] `) : '';
+    const prefix = label ? chalk.dim(`[${label}] `) : "";
     const forward = (stream) => {
-        let buffer = '';
-        child[stream]?.on('data', (chunk) => {
+        let buffer = "";
+        child[stream]?.on("data", (chunk) => {
             buffer += chunk.toString();
-            const lines = buffer.split('\n');
-            buffer = lines.pop() ?? '';
+            const lines = buffer.split("\n");
+            buffer = lines.pop() ?? "";
             for (const line of lines) {
                 if (READY_PATTERN.test(line))
                     continue;
@@ -528,26 +528,26 @@ const pipeChildOutput = (child, label) => {
             }
         });
     };
-    forward('stdout');
-    forward('stderr');
+    forward("stdout");
+    forward("stderr");
 };
 const printBanner = (running, envNote) => {
-    log.info('');
-    log.info(chalk.green.bold('  Neon Functions dev server'));
-    log.info('');
+    log.info("");
+    log.info(chalk.green.bold("  Neon Functions dev server"));
+    log.info("");
     for (const r of running) {
-        const name = r.unit.label ?? 'function';
+        const name = r.unit.label ?? "function";
         const url = urlFor(r.boundPort);
         log.info(`  ${chalk.dim(name.padEnd(20))} ${url}`);
         const env = formatEnvSummary(r.unit.envSummary);
         if (env)
-            log.info(`  ${' '.repeat(20)} ${chalk.dim(env)}`);
+            log.info(`  ${" ".repeat(20)} ${chalk.dim(env)}`);
     }
     if (envNote) {
-        log.info('');
-        log.info(`  ${chalk.yellow('!')} ${chalk.dim(`Neon env: ${envNote}`)}`);
+        log.info("");
+        log.info(`  ${chalk.yellow("!")} ${chalk.dim(`Neon env: ${envNote}`)}`);
     }
-    log.info('');
+    log.info("");
 };
 /**
  * Render a unit's injected env into one transparent line for the banner, e.g.
@@ -557,22 +557,22 @@ const printBanner = (running, envNote) => {
  */
 export const formatEnvSummary = (summary) => {
     if (!summary)
-        return '';
+        return "";
     const parts = [];
     if (summary.neon.length > 0) {
-        parts.push(`env: ${[...summary.neon].sort().join(', ')}`);
+        parts.push(`env: ${[...summary.neon].sort().join(", ")}`);
     }
     if (summary.fn.length > 0) {
-        parts.push(`neon.ts: ${[...summary.fn].sort().join(', ')}`);
+        parts.push(`neon.ts: ${[...summary.fn].sort().join(", ")}`);
     }
-    return parts.join(' · ');
+    return parts.join(" · ");
 };
 const logUnit = (unit, message) => {
-    const prefix = unit.label ? chalk.dim(`[${unit.label}] `) : '';
+    const prefix = unit.label ? chalk.dim(`[${unit.label}] `) : "";
     log.info(`${prefix}${message}`);
 };
 const startWatcher = async (source, restart) => {
-    const { default: chokidar } = await import('chokidar');
+    const { default: chokidar } = await import("chokidar");
     const initialInputs = await resolveWatchInputs(source);
     if (initialInputs === null) {
         return startDirectoryWatcher(chokidar, source, restart);
@@ -588,10 +588,10 @@ const startWatcher = async (source, restart) => {
  * jiti-loaded config.
  */
 const startConfigWatcher = async (configPath, onChange) => {
-    const { default: chokidar } = await import('chokidar');
+    const { default: chokidar } = await import("chokidar");
     const watcher = chokidar.watch(configPath, { ignoreInitial: true });
-    await once(watcher, 'ready');
-    watcher.on('all', () => {
+    await once(watcher, "ready");
+    watcher.on("all", () => {
         onChange();
     });
     return { sync: () => Promise.resolve(), close: () => watcher.close() };
@@ -599,8 +599,8 @@ const startConfigWatcher = async (configPath, onChange) => {
 const startInputWatcher = async (chokidar, source, initialInputs, restart) => {
     const watched = new Set([source, ...initialInputs]);
     const watcher = chokidar.watch([...watched], { ignoreInitial: true });
-    await once(watcher, 'ready');
-    watcher.on('all', () => {
+    await once(watcher, "ready");
+    watcher.on("all", () => {
         restart();
     });
     const sync = async () => {
@@ -627,16 +627,16 @@ const startDirectoryWatcher = async (chokidar, source, restart) => {
     const watchedDir = dirname(source);
     const isIgnored = (p) => {
         const segments = p.split(/[/\\]/);
-        return (segments.includes('node_modules') ||
-            segments.includes('.git') ||
-            segments.includes('dist'));
+        return (segments.includes("node_modules") ||
+            segments.includes(".git") ||
+            segments.includes("dist"));
     };
     const watcher = chokidar.watch(watchedDir, {
         ignoreInitial: true,
         ignored: (path) => isIgnored(path),
     });
-    await once(watcher, 'ready');
-    watcher.on('all', () => {
+    await once(watcher, "ready");
+    watcher.on("all", () => {
         restart();
     });
     return { sync: () => Promise.resolve(), close: () => watcher.close() };
@@ -656,41 +656,41 @@ const killTree = (child) => {
         const timeout = setTimeout(() => {
             forceKill(child, pid);
         }, 2000);
-        child.once('exit', () => {
+        child.once("exit", () => {
             clearTimeout(timeout);
             resolveKill();
         });
-        if (pid !== undefined && process.platform !== 'win32') {
+        if (pid !== undefined && process.platform !== "win32") {
             try {
-                process.kill(-pid, 'SIGTERM');
+                process.kill(-pid, "SIGTERM");
                 return;
             }
             catch {
                 // Fall through to a direct kill if the group is already gone.
             }
         }
-        child.kill('SIGTERM');
+        child.kill("SIGTERM");
     });
 };
 const forceKill = (child, pid) => {
     if (pid === undefined) {
-        child.kill('SIGKILL');
+        child.kill("SIGKILL");
         return;
     }
-    if (process.platform === 'win32') {
-        spawnSync('taskkill', ['/pid', String(pid), '/T', '/F']);
+    if (process.platform === "win32") {
+        spawnSync("taskkill", ["/pid", String(pid), "/T", "/F"]);
         return;
     }
     try {
-        process.kill(-pid, 'SIGKILL');
+        process.kill(-pid, "SIGKILL");
     }
     catch {
-        child.kill('SIGKILL');
+        child.kill("SIGKILL");
     }
 };
 const resolveRuntimePath = () => {
     const here = dirname(fileURLToPath(import.meta.url));
-    const candidate = join(here, '..', 'dev', 'runtime.js');
+    const candidate = join(here, "..", "dev", "runtime.js");
     if (!existsSync(candidate)) {
         throw new Error(`Could not locate the dev runtime at ${candidate}`);
     }