@nocobase/cli 2.1.0-alpha.25 → 2.1.0-alpha.26

package/dist/commands/app/logs.js

@@ -0,0 +1,98 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { run } from '../../lib/run-npm.js';
+import { printInfo } from '../../lib/ui.js';
+function formatLogsFailure(envName, message) {
+    return [
+        `Couldn't show logs for "${envName}".`,
+        'Check that the saved local app or Docker container still exists on this machine, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class AppLogs extends Command {
+    static hidden = false;
+    static description = 'Show NocoBase logs for the selected env. Local npm/git installs use pm2 logs, and Docker installs use docker logs.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --tail 200',
+        '<%= config.bin %> <%= command.id %> --env app1 --no-follow',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to inspect logs for. Defaults to the current env when omitted',
+        }),
+        tail: Flags.integer({
+            description: 'Number of recent log lines to show before following',
+            default: 100,
+            min: 0,
+        }),
+        follow: Flags.boolean({
+            char: 'f',
+            description: 'Keep streaming new log lines',
+            default: true,
+            allowNo: true,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppLogs);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'http') {
+            this.error([
+                `Can't show runtime logs for "${runtime.envName}" from this machine.`,
+                'This env only has an API connection, so there is no saved local app or Docker container to read logs from.',
+                'Connect it to a local checkout or reinstall it with npm, git, or Docker if you want CLI-managed logs.',
+            ].join('\n'));
+        }
+        if (runtime.kind === 'ssh') {
+            this.error([
+                `Can't show runtime logs for "${runtime.envName}" yet.`,
+                'SSH env support is reserved but not implemented yet.',
+                'Use a local or Docker env for CLI-managed logs for now.',
+            ].join('\n'));
+        }
+        const tail = String(flags.tail ?? 100);
+        const follow = flags.follow !== false;
+        printInfo(follow
+            ? `Showing logs for "${runtime.envName}" (press Ctrl+C to stop).`
+            : `Showing recent logs for "${runtime.envName}".`);
+        try {
+            if (runtime.kind === 'docker') {
+                const dockerArgs = ['logs', '--tail', tail];
+                if (follow) {
+                    dockerArgs.push('--follow');
+                }
+                dockerArgs.push(runtime.containerName);
+                await run('docker', dockerArgs, {
+                    errorName: 'docker logs',
+                    stdio: 'inherit',
+                });
+                return;
+            }
+            const localArgs = ['pm2', 'logs', '--lines', tail];
+            if (!follow) {
+                localArgs.push('--nostream');
+            }
+            await runLocalNocoBaseCommand(runtime, localArgs, {
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(formatLogsFailure(runtime.envName, message));
+        }
+    }
+}

package/dist/commands/app/restart.js

@@ -0,0 +1,75 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+function argvHasToken(argv, tokens) {
+    return tokens.some((token) => argv.includes(token));
+}
+function pushFlag(argv, flag, value) {
+    if (value !== undefined) {
+        argv.push(flag, String(value));
+    }
+}
+export default class AppRestart extends Command {
+    static hidden = false;
+    static description = 'Restart NocoBase for the selected env by stopping it first, then starting it again.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env local',
+        '<%= config.bin %> <%= command.id %> --env local --quickstart',
+        '<%= config.bin %> <%= command.id %> --env local --port 12000',
+        '<%= config.bin %> <%= command.id %> --env local --daemon',
+        '<%= config.bin %> <%= command.id %> --env local --no-daemon',
+        '<%= config.bin %> <%= command.id %> --env local --instances 2',
+        '<%= config.bin %> <%= command.id %> --env local --launch-mode pm2',
+        '<%= config.bin %> <%= command.id %> --env local --verbose',
+        '<%= config.bin %> <%= command.id %> --env local-docker',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to restart. Defaults to the current env when omitted',
+        }),
+        quickstart: Flags.boolean({ description: 'Quickstart the application after stopping it', required: false }),
+        port: Flags.string({ description: 'Port (overrides appPort from env config when set)', char: 'p', required: false }),
+        daemon: Flags.boolean({
+            description: 'Run the application as a daemon after stopping it (default: true; use --no-daemon to stay in the foreground)',
+            char: 'd',
+            required: false,
+            default: true,
+            allowNo: true,
+        }),
+        instances: Flags.integer({ description: 'Number of instances to run after stopping it', char: 'i', required: false }),
+        'launch-mode': Flags.string({ description: 'Launch Mode', required: false, options: ['pm2', 'node'] }),
+        verbose: Flags.boolean({
+            description: 'Show raw shutdown/startup output from the underlying local or Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppRestart);
+        const stopArgv = [];
+        const daemonFlagWasProvided = argvHasToken(this.argv, ['--daemon', '--no-daemon']);
+        pushFlag(stopArgv, '--env', flags.env?.trim() || undefined);
+        if (flags.verbose) {
+            stopArgv.push('--verbose');
+        }
+        await this.config.runCommand('app:stop', stopArgv);
+        const startArgv = [...stopArgv];
+        if (flags.quickstart) {
+            startArgv.push('--quickstart');
+        }
+        pushFlag(startArgv, '--port', flags.port);
+        if (daemonFlagWasProvided) {
+            startArgv.push(flags.daemon === false ? '--no-daemon' : '--daemon');
+        }
+        pushFlag(startArgv, '--instances', flags.instances);
+        pushFlag(startArgv, '--launch-mode', flags['launch-mode']);
+        await this.config.runCommand('app:start', startArgv);
+    }
+}

package/dist/commands/app/start.js

@@ -0,0 +1,252 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, startDockerContainer, } from '../../lib/app-runtime.js';
+import { AppHealthCheckError, formatAppUrl, isAppReady, resolveManagedAppApiBaseUrl, waitForAppReady, } from '../../lib/app-health.js';
+import { ensureBuiltinDbReady, ensureSavedLocalSource, recreateSavedDockerApp, } from '../../lib/app-managed-resources.js';
+import { failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+function argvHasToken(argv, tokens) {
+    return tokens.some((token) => argv.includes(token));
+}
+function formatDockerStartFailure(envName, message) {
+    return [
+        `Couldn't start NocoBase for "${envName}".`,
+        'Check that the Docker runtime for this env is still available, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+function formatLocalStartFailure(envName, options) {
+    const sourceLabel = options?.source === 'git'
+        ? 'the local Git checkout'
+        : options?.source === 'npm'
+            ? 'the local npm app'
+            : 'the local app';
+    const portHint = options?.port ? ` Expected app port: ${options.port}.` : '';
+    return [
+        `Couldn't start NocoBase for "${envName}".`,
+        `The CLI was not able to start ${sourceLabel} successfully.`,
+        `Check that the app dependencies, database connection, and local env settings are ready, then try again.${portHint}`,
+    ].join('\n');
+}
+function formatLocalReadyFailure(envName, message, options) {
+    const sourceLabel = options?.source === 'git'
+        ? 'the local Git checkout'
+        : options?.source === 'npm'
+            ? 'the local npm app'
+            : 'the local app';
+    const portHint = options?.port ? ` Expected app port: ${options.port}.` : '';
+    return [
+        `NocoBase did not become ready for "${envName}".`,
+        `The CLI started ${sourceLabel}, but the app did not pass its health check in time.`,
+        `Check the startup logs, database connection, and local env settings, then try again.${portHint}`,
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class AppStart extends Command {
+    static hidden = false;
+    static description = 'Start NocoBase for the selected env. Local npm/git installs run the app command, and Docker installs start the saved app container.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env local',
+        '<%= config.bin %> <%= command.id %> --env local --quickstart',
+        '<%= config.bin %> <%= command.id %> --env local --port 12000',
+        '<%= config.bin %> <%= command.id %> --env local --daemon',
+        '<%= config.bin %> <%= command.id %> --env local --no-daemon',
+        '<%= config.bin %> <%= command.id %> --env local --instances 2',
+        '<%= config.bin %> <%= command.id %> --env local --launch-mode pm2',
+        '<%= config.bin %> <%= command.id %> --env local --verbose',
+        '<%= config.bin %> <%= command.id %> --env local-docker',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to start. Defaults to the current env when omitted',
+        }),
+        quickstart: Flags.boolean({ description: 'Quickstart the application', required: false }),
+        port: Flags.string({ description: 'Port (overrides appPort from env config when set)', char: 'p', required: false }),
+        daemon: Flags.boolean({
+            description: 'Run the application as a daemon (default: true; use --no-daemon to stay in the foreground)',
+            char: 'd',
+            required: false,
+            default: true,
+            allowNo: true,
+        }),
+        instances: Flags.integer({ description: 'Number of instances to run', char: 'i', required: false }),
+        'launch-mode': Flags.string({ description: 'Launch Mode', required: false, options: ['pm2', 'node'] }),
+        verbose: Flags.boolean({
+            description: 'Show raw startup output from the underlying local or Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppStart);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const daemonFlagWasProvided = argvHasToken(this.argv, ['--daemon', '--no-daemon']);
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        const commandStdio = flags.verbose ? 'inherit' : 'ignore';
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'http') {
+            this.error([
+                `Can't start "${runtime.envName}" from this machine.`,
+                'This env only has an API connection, so there is no saved local app or Docker runtime to launch here.',
+                'Connect it to a local checkout or reinstall it with npm, git, or Docker if you want CLI-managed start and stop.',
+            ].join('\n'));
+        }
+        if (runtime.kind === 'ssh') {
+            this.error([
+                `Can't start "${runtime.envName}" yet.`,
+                'SSH env support is reserved but not implemented yet.',
+                'Use a local or Docker env if you need CLI-managed start and stop right now.',
+            ].join('\n'));
+        }
+        if (runtime.kind === 'docker') {
+            const unsupportedFlags = [
+                flags.quickstart ? '--quickstart' : undefined,
+                flags.port ? '--port' : undefined,
+                daemonFlagWasProvided ? (flags.daemon ? '--daemon' : '--no-daemon') : undefined,
+                flags.instances !== undefined ? '--instances' : undefined,
+                flags['launch-mode'] ? '--launch-mode' : undefined,
+            ].filter(Boolean);
+            if (unsupportedFlags.length > 0) {
+                this.error([
+                    `Can't apply ${unsupportedFlags.join(', ')} to "${runtime.envName}".`,
+                    'This env is managed by Docker, so those options are only available for local npm/git installs.',
+                    `Run \`nb app start --env ${runtime.envName}\` to start the saved container, or recreate the env if you need different runtime settings.`,
+                ].join('\n'));
+            }
+            await ensureBuiltinDbReady(runtime, {
+                verbose: flags.verbose,
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+            });
+            const appUrl = formatAppUrl(runtime.env.appPort === undefined || runtime.env.appPort === null
+                ? undefined
+                : String(runtime.env.appPort));
+            const apiBaseUrl = resolveManagedAppApiBaseUrl(runtime);
+            startTask(`Starting NocoBase for "${runtime.envName}"...`);
+            try {
+                const state = await startDockerContainer(runtime.containerName, {
+                    stdio: commandStdio,
+                });
+                if (state === 'already-running' && await isAppReady(apiBaseUrl)) {
+                    succeedTask(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+                    return;
+                }
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                if (/does not exist/i.test(message)) {
+                    printInfo(`The saved Docker app container for "${runtime.envName}" is missing. Recreating it from the saved Docker env settings...`);
+                    await recreateSavedDockerApp(runtime, {
+                        verbose: flags.verbose,
+                    });
+                }
+                else {
+                    failTask(`Failed to start NocoBase for "${runtime.envName}".`);
+                    this.error(formatDockerStartFailure(runtime.envName, message));
+                }
+            }
+            await waitForAppReady({
+                envName: runtime.envName,
+                apiBaseUrl,
+                containerName: runtime.containerName,
+                logHint: `You can inspect startup logs with \`nb app logs --env ${runtime.envName}\`.`,
+            });
+            succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+            return;
+        }
+        await ensureBuiltinDbReady(runtime, {
+            verbose: flags.verbose,
+            onStartTask: startTask,
+            onSucceedTask: succeedTask,
+            onFailTask: failTask,
+        });
+        if (runtime.source === 'npm' || runtime.source === 'git') {
+            const runCommand = this.config.runCommand.bind(this.config);
+            const downloadableRuntime = runtime;
+            await ensureSavedLocalSource(downloadableRuntime, runCommand, {
+                verbose: flags.verbose,
+                onStartTask: startTask,
+                onSucceedTask: succeedTask,
+                onFailTask: failTask,
+            });
+        }
+        const npmArgs = ['start'];
+        if (flags.quickstart) {
+            npmArgs.push('--quickstart');
+        }
+        if (flags.port) {
+            npmArgs.push('--port', flags.port);
+        }
+        else if (runtime.env.appPort !== undefined && runtime.env.appPort !== null && String(runtime.env.appPort).trim() !== '') {
+            npmArgs.push('--port', String(runtime.env.appPort));
+        }
+        if (flags.daemon !== false) {
+            npmArgs.push('--daemon');
+        }
+        if (flags.instances !== undefined) {
+            npmArgs.push('--instances', flags.instances.toString());
+        }
+        if (flags['launch-mode']) {
+            npmArgs.push('--launch-mode', flags['launch-mode']);
+        }
+        const effectivePort = flags.port
+            || (runtime.env.appPort !== undefined && runtime.env.appPort !== null
+                ? String(runtime.env.appPort).trim()
+                : undefined);
+        const appUrl = formatAppUrl(effectivePort);
+        const apiBaseUrl = resolveManagedAppApiBaseUrl(runtime, {
+            portOverride: effectivePort,
+        });
+        if (await isAppReady(apiBaseUrl, { requestTimeoutMs: 1_500 })) {
+            if (flags.daemon === false) {
+                printInfo(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}. Use \`nb app stop --env ${runtime.envName}\` before starting it again in the foreground.`);
+            }
+            else {
+                succeedTask(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+            }
+            return;
+        }
+        if (flags.daemon === false) {
+            printInfo(`Starting NocoBase for "${runtime.envName}" in the foreground${appUrl ? ` at ${appUrl}` : ''}. Press Ctrl+C to stop.`);
+        }
+        else {
+            startTask(`Starting NocoBase for "${runtime.envName}" in the background...`);
+        }
+        try {
+            await runLocalNocoBaseCommand(runtime, npmArgs, {
+                stdio: commandStdio,
+            });
+            if (flags.daemon !== false) {
+                await waitForAppReady({
+                    envName: runtime.envName,
+                    apiBaseUrl,
+                    logHint: `You can inspect startup logs with \`nb app logs --env ${runtime.envName}\`.`,
+                });
+                succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+            }
+        }
+        catch (error) {
+            failTask(`Failed to start NocoBase for "${runtime.envName}".`);
+            if (error instanceof AppHealthCheckError) {
+                this.error(formatLocalReadyFailure(runtime.envName, error.message, {
+                    port: effectivePort,
+                    source: runtime.source,
+                }));
+            }
+            this.error(formatLocalStartFailure(runtime.envName, {
+                port: effectivePort,
+                source: runtime.source,
+            }));
+        }
+    }
+}

package/dist/commands/app/stop.js

@@ -0,0 +1,98 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+import { Command, Flags } from '@oclif/core';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, stopDockerContainer, } from '../../lib/app-runtime.js';
+import { failTask, startTask, succeedTask } from '../../lib/ui.js';
+function formatStopFailure(envName, message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            `Can't stop NocoBase for "${envName}" yet.`,
+            'The saved Docker app for this env could not be found on this machine.',
+            'If it was removed manually, reinstall or reconnect the env before trying again.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        `Couldn't stop NocoBase for "${envName}".`,
+        'Check that the local app or Docker runtime is still available, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class AppStop extends Command {
+    static hidden = false;
+    static description = 'Stop NocoBase for the selected env. Local npm/git installs stop the app process, and Docker installs stop the saved app container.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env local',
+        '<%= config.bin %> <%= command.id %> --env local --verbose',
+        '<%= config.bin %> <%= command.id %> --env local-docker',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to stop. Defaults to the current env when omitted',
+        }),
+        verbose: Flags.boolean({
+            description: 'Show raw shutdown output from the underlying local or Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(AppStop);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        const commandStdio = flags.verbose ? 'inherit' : 'ignore';
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'http') {
+            this.error([
+                `Can't stop "${runtime.envName}" from this machine.`,
+                'This env only has an API connection, so there is no saved local app or Docker runtime to stop here.',
+                'If the app is running on a server, stop it there or reconnect this env to a local runtime first.',
+            ].join('\n'));
+        }
+        if (runtime.kind === 'ssh') {
+            this.error([
+                `Can't stop "${runtime.envName}" yet.`,
+                'SSH env support is reserved but not implemented yet.',
+                'Use a local or Docker env if you need CLI-managed stop right now.',
+            ].join('\n'));
+        }
+        if (runtime.kind === 'docker') {
+            startTask(`Stopping NocoBase for "${runtime.envName}"...`);
+            try {
+                const state = await stopDockerContainer(runtime.containerName, {
+                    stdio: commandStdio,
+                });
+                succeedTask(state === 'already-stopped'
+                    ? `NocoBase is already stopped for "${runtime.envName}".`
+                    : `NocoBase has stopped for "${runtime.envName}".`);
+            }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                failTask(`Failed to stop NocoBase for "${runtime.envName}".`);
+                this.error(formatStopFailure(runtime.envName, message));
+            }
+            return;
+        }
+        startTask(`Stopping NocoBase for "${runtime.envName}"...`);
+        try {
+            await runLocalNocoBaseCommand(runtime, ['pm2', 'kill'], {
+                stdio: commandStdio,
+            });
+            succeedTask(`NocoBase has stopped for "${runtime.envName}".`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask(`Failed to stop NocoBase for "${runtime.envName}".`);
+            this.error(formatStopFailure(runtime.envName, message));
+        }
+    }
+}