@nocobase/app-installer 0.0.0-stage → 0.1.0-beta.4

package/dist/commands/status.js

@@ -0,0 +1,132 @@
+import { lstat, readdir } from 'node:fs/promises';
+import path from 'node:path';
+import { Flags } from '@oclif/core';
+import { readCurrent } from "../lib/current-link.js";
+import { endpointsOf, healthUrl, mountPathOf, readAppEnv, } from "../lib/env-file.js";
+import { checkHealth } from "../lib/health.js";
+import { formatCommandLine, quoteForShell } from '@nocobase/cli-envelope';
+import { installerCommand } from "../lib/invocation.js";
+import { layoutOf, releaseDir } from "../lib/layout.js";
+import { currentNodeMajor } from "../lib/prechecks.js";
+import { nodeRebuildAdvice } from "../lib/source.js";
+import { findRelease, readState } from "../lib/state.js";
+export const STATUS_FLAGS = {
+    dir: Flags.string({
+        description: 'Installation root managed by app-installer. Defaults to the current directory.',
+    }),
+    json: Flags.boolean({
+        default: false,
+        description: 'Print one JSON result on stdout.',
+    }),
+};
+/** Bytes used by a directory tree, not following symbolic links. */
+export async function directorySize(dir) {
+    let total = 0;
+    const entries = await readdir(dir, { withFileTypes: true }).catch(() => []);
+    for (const entry of entries) {
+        const full = path.join(dir, entry.name);
+        if (entry.isDirectory()) {
+            total += await directorySize(full);
+        }
+        else if (entry.isFile()) {
+            total += (await lstat(full)).size;
+        }
+    }
+    return total;
+}
+function formatSize(bytes) {
+    return bytes >= 1024 ** 3
+        ? `${(bytes / 1024 ** 3).toFixed(1)} GB`
+        : `${Math.round(bytes / 1024 ** 2)} MB`;
+}
+export async function status(input, deps) {
+    const root = path.resolve(deps.cwd ?? process.cwd(), input.flags.dir ?? '.');
+    const layout = layoutOf(root);
+    const state = await readState(layout);
+    const env = await readAppEnv(layout);
+    const link = await readCurrent(layout);
+    const releases = [];
+    for (const record of state.releases) {
+        const dir = releaseDir(layout, record.id);
+        releases.push({
+            id: record.id,
+            version: record.version,
+            current: record.id === state.current,
+            builtAt: record.builtAt,
+            installedAt: record.installedAt,
+            nodeMajor: record.buildTarget.nodeMajor,
+            sizeBytes: await directorySize(dir),
+        });
+    }
+    const backups = (await readdir(layout.backupsDir).catch(() => [])).sort();
+    const endpoints = endpointsOf(env);
+    if (endpoints.port === null) {
+        deps.reporter.warn(`APP_SERVER_PORT in app.env is "${env.APP_SERVER_PORT ?? ''}", which is not a port number; the application cannot listen on it.`);
+    }
+    const url = healthUrl(env);
+    const healthy = await checkHealth(url, deps.fetchImpl);
+    let processInfo = null;
+    try {
+        processInfo = (await deps.pm2.describe(state.name)) ?? null;
+    }
+    catch {
+        deps.reporter.warn('pm2 could not be queried; process state is unknown.');
+    }
+    if (state.pending) {
+        deps.reporter.warn(`${state.pending.action === 'upgrade' ? 'An' : 'A'} ${state.pending.action} from ${state.pending.from} to ${state.pending.to}, started ${state.pending.startedAt}, did not finish. Recover with \`${installerCommand(`rollback --dir ${quoteForShell(root)}`, { registry: state.registry })}\`: it undoes an interrupted upgrade and finishes an interrupted rollback.`);
+    }
+    const currentRelease = findRelease(state, state.current);
+    const nodeMajor = currentNodeMajor();
+    const nodeMatches = currentRelease?.buildTarget.nodeMajor === nodeMajor;
+    if (!nodeMatches) {
+        const advice = nodeRebuildAdvice(state, root)
+            .map((step) => step.run
+            ? `${step.message} \`${formatCommandLine(step.run)}\``
+            : step.message)
+            .join(' ');
+        deps.reporter.warn(`The current release was built for Node ${currentRelease?.buildTarget.nodeMajor ?? '?'}, but this machine runs Node ${nodeMajor}; it will not load its native modules until a release built for this machine replaces it. ${advice}`);
+    }
+    return {
+        status: 'success',
+        result: {
+            directory: root,
+            name: state.name,
+            appName: state.appName,
+            // Where the application is mounted now, as app.env says; installer.json keeps the path it was installed at.
+            basePath: mountPathOf(env) || '/',
+            source: state.source,
+            current: state.current,
+            version: currentRelease?.version ?? null,
+            builtAt: currentRelease?.builtAt ?? null,
+            currentLink: link ?? null,
+            dialect: state.dialect,
+            registry: state.registry,
+            endpoints,
+            releases,
+            backups,
+            health: { url, ok: healthy },
+            process: processInfo,
+            node: {
+                machine: nodeMajor,
+                release: currentRelease?.buildTarget.nodeMajor ?? null,
+                matches: nodeMatches,
+            },
+            pending: state.pending ?? null,
+        },
+        summary: [
+            `The application ${state.appName} ${currentRelease?.version ?? '?'} at ${root}`,
+            `  Release   ${state.current}${currentRelease ? `, built ${currentRelease.builtAt}` : ''}`,
+            '  Source    deployment archives',
+            `  URL       ${endpoints.url} (listening on ${endpoints.host}:${endpoints.port ?? `invalid port "${env.APP_SERVER_PORT ?? ''}"`})`,
+            `  Health    ${healthy ? 'ok' : 'not answering'} (${url})`,
+            `  Process   ${processInfo ? `${processInfo.status}, pid ${processInfo.pid}, ${processInfo.restarts} restarts` : 'not registered with pm2'} (${state.name})`,
+            `  Node      machine ${nodeMajor}, release ${currentRelease?.buildTarget.nodeMajor ?? '?'}${nodeMatches ? '' : ' — mismatch'}`,
+            '  Releases',
+            ...releases.map((release) => `    ${release.current ? '*' : ' '} ${release.id}  ${formatSize(release.sizeBytes)}  installed ${release.installedAt}`),
+            ...(backups.length > 0
+                ? ['  Backups', ...backups.map((backup) => `    ${backup}`)]
+                : []),
+        ],
+    };
+}
+//# sourceMappingURL=status.js.map

package/dist/commands/status.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.js","sourceRoot":"","sources":["../../src/commands/status.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EACL,WAAW,EACX,SAAS,EACT,WAAW,EACX,UAAU,GACX,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGzD,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC;QAChB,WAAW,EACT,gFAAgF;KACnF,CAAC;IACF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC;QAClB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,kCAAkC;KAChD,CAAC;CACH,CAAC;AAMF,oEAAoE;AACpE,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW;IAC7C,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAC5E,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,KAAK,IAAI,MAAM,aAAa,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC;YAC1B,KAAK,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK,IAAI,IAAI,IAAI,CAAC;QACvB,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK;QACxC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC;AAC5C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,KAAkB,EAClB,IAAiB;IAEjB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC;IAC7E,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;IAEvC,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAC1C,QAAQ,CAAC,IAAI,CAAC;YACZ,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,EAAE,KAAK,KAAK,CAAC,OAAO;YACpC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,WAAW,EAAE,MAAM,CAAC,WAAW;YAC/B,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,SAAS;YACvC,SAAS,EAAE,MAAM,aAAa,CAAC,GAAG,CAAC;SACpC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,OAAO,GAAG,CACd,MAAM,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAc,CAAC,CAC7D,CAAC,IAAI,EAAE,CAAC;IAET,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IACnC,IAAI,SAAS,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,kCAAkC,GAAG,CAAC,eAAe,IAAI,EAAE,qEAAqE,CACjI,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;IAEvD,IAAI,WAAW,GAAyD,IAAI,CAAC;IAC7E,IAAI,CAAC;QACH,WAAW,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC;IAC9D,CAAC;IAAC,MAAM,CAAC;QACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,qDAAqD,CAAC,CAAC;IAC5E,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;QAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,SAAS,KAAK,CAAC,OAAO,CAAC,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,EAAE,aAAa,KAAK,CAAC,OAAO,CAAC,SAAS,oCAAoC,gBAAgB,CAAC,kBAAkB,aAAa,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,4EAA4E,CACxW,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,SAAS,GAAG,gBAAgB,EAAE,CAAC;IACrC,MAAM,WAAW,GAAG,cAAc,EAAE,WAAW,CAAC,SAAS,KAAK,SAAS,CAAC;IACxE,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,MAAM,GAAG,iBAAiB,CAAC,KAAK,EAAE,IAAI,CAAC;aAC1C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CACZ,IAAI,CAAC,GAAG;YACN,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,MAAM,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI;YACtD,CAAC,CAAC,IAAI,CAAC,OAAO,CACjB;aACA,IAAI,CAAC,GAAG,CAAC,CAAC;QACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,0CAA0C,cAAc,EAAE,WAAW,CAAC,SAAS,IAAI,GAAG,gCAAgC,SAAS,6FAA6F,MAAM,EAAE,CACrO,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,MAAM,EAAE;YACN,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,4GAA4G;YAC5G,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC,IAAI,GAAG;YACjC,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,OAAO,EAAE,cAAc,EAAE,OAAO,IAAI,IAAI;YACxC,OAAO,EAAE,cAAc,EAAE,OAAO,IAAI,IAAI;YACxC,WAAW,EAAE,IAAI,IAAI,IAAI;YACzB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,SAAS;YACT,QAAQ;YACR,OAAO;YACP,MAAM,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE;YAC5B,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE;gBACJ,OAAO,EAAE,SAAS;gBAClB,OAAO,EAAE,cAAc,EAAE,WAAW,CAAC,SAAS,IAAI,IAAI;gBACtD,OAAO,EAAE,WAAW;aACrB;YACD,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,IAAI;SAC/B;QACD,OAAO,EAAE;YACP,mBAAmB,KAAK,CAAC,OAAO,IAAI,cAAc,EAAE,OAAO,IAAI,GAAG,OAAO,IAAI,EAAE;YAC/E,eAAe,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC,CAAC,CAAC,WAAW,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE;YAC1F,iCAAiC;YACjC,eAAe,SAAS,CAAC,GAAG,kBAAkB,SAAS,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,IAAI,iBAAiB,GAAG,CAAC,eAAe,IAAI,EAAE,GAAG,GAAG;YAClI,eAAe,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,eAAe,KAAK,GAAG,GAAG;YAC1D,eAAe,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,MAAM,SAAS,WAAW,CAAC,GAAG,KAAK,WAAW,CAAC,QAAQ,WAAW,CAAC,CAAC,CAAC,yBAAyB,KAAK,KAAK,CAAC,IAAI,GAAG;YAC5J,uBAAuB,SAAS,aAAa,cAAc,EAAE,WAAW,CAAC,SAAS,IAAI,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE;YAC9H,YAAY;YACZ,GAAG,QAAQ,CAAC,GAAG,CACb,CAAC,OAAO,EAAE,EAAE,CACV,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE,KAAK,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,eAAe,OAAO,CAAC,WAAW,EAAE,CACzH;YACD,GAAG,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;gBACpB,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,EAAE,CAAC,CAAC;gBAC5D,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;AACJ,CAAC"}