@nocobase/cli 2.1.0-alpha.40 → 2.1.0-alpha.45

package/dist/commands/app/shared.js

@@ -0,0 +1,122 @@
+/**
+ * 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 fsp from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import { buildDockerDbContainerName } from '../../lib/app-runtime.js';
+import { resolveConfiguredEnvPath } from '../../lib/cli-home.js';
+import { commandOutput, run } from '../../lib/run-npm.js';
+export function resolveConfiguredPath(value) {
+    return resolveConfiguredEnvPath(value);
+}
+function assertSafeRemovalPath(target, label) {
+    const resolved = path.resolve(target);
+    const cwd = path.resolve(process.cwd());
+    const home = path.resolve(os.homedir());
+    const root = path.parse(resolved).root;
+    if (resolved === root || resolved === cwd || resolved === home) {
+        throw new Error(`Refusing to remove ${label} at "${resolved}" because it is too broad.`);
+    }
+}
+export async function removePathIfExists(target, label) {
+    const resolved = path.resolve(target);
+    assertSafeRemovalPath(resolved, label);
+    await fsp.rm(resolved, { recursive: true, force: true });
+}
+function isMissingDockerContainerError(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return /No such (container|object)/i.test(message);
+}
+function isMissingDockerNetworkError(error) {
+    const message = error instanceof Error ? error.message : String(error);
+    return /No such network|network .* not found/i.test(message);
+}
+export async function removeDockerContainerIfExists(containerName, options) {
+    try {
+        await commandOutput('docker', ['container', 'inspect', containerName], {
+            errorName: 'docker container inspect',
+        });
+    }
+    catch (error) {
+        if (isMissingDockerContainerError(error)) {
+            return 'missing';
+        }
+        throw error;
+    }
+    await run('docker', ['rm', '-f', containerName], {
+        errorName: 'docker rm',
+        stdio: options?.stdio ?? 'ignore',
+    });
+    return 'removed';
+}
+async function dockerNetworkExists(networkName) {
+    try {
+        await commandOutput('docker', ['network', 'inspect', networkName], {
+            errorName: 'docker network inspect',
+        });
+        return true;
+    }
+    catch (error) {
+        if (isMissingDockerNetworkError(error)) {
+            return false;
+        }
+        throw error;
+    }
+}
+async function dockerNetworkHasActiveEndpoints(networkName) {
+    try {
+        const output = await commandOutput('docker', ['network', 'inspect', networkName, '--format', '{{json .Containers}}'], {
+            errorName: 'docker network inspect',
+        });
+        const containers = JSON.parse(output || '{}');
+        return Boolean(containers && typeof containers === 'object' && Object.keys(containers).length > 0);
+    }
+    catch {
+        return false;
+    }
+}
+export async function removeDockerNetworkIfUnused(networkName) {
+    if (!(await dockerNetworkExists(networkName))) {
+        return 'missing';
+    }
+    try {
+        await run('docker', ['network', 'rm', networkName], {
+            errorName: 'docker network rm',
+            stdio: 'ignore',
+        });
+        return 'removed';
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        if (/has active endpoints|is in use|active endpoints/i.test(message) ||
+            ((await dockerNetworkExists(networkName)) && (await dockerNetworkHasActiveEndpoints(networkName)))) {
+            return 'in-use';
+        }
+        if (isMissingDockerNetworkError(error)) {
+            return 'missing';
+        }
+        throw error;
+    }
+}
+export function builtinDbContainerName(runtime) {
+    if (!runtime.env.config.builtinDb) {
+        return undefined;
+    }
+    const dbDialect = String(runtime.env.config.dbDialect ?? 'postgres').trim() || 'postgres';
+    return buildDockerDbContainerName(runtime.envName, dbDialect, runtime.dockerContainerPrefix || runtime.workspaceName);
+}
+export function managedDockerNetworkName(runtime) {
+    return runtime.dockerNetworkName?.trim() || runtime.workspaceName?.trim() || undefined;
+}
+export function resolveManagedLocalAppPath(runtime) {
+    return resolveConfiguredPath(runtime.env.config.appRootPath) || runtime.projectRoot;
+}
+export function shouldRemoveManagedLocalAppFiles(runtime) {
+    return runtime.source === 'npm' || runtime.source === 'git';
+}

package/dist/commands/app/start.js

@@ -8,11 +8,14 @@
  */
 import { Command, Flags } from '@oclif/core';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
-import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, startDockerContainer, } from '../../lib/app-runtime.js';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
 import { AppHealthCheckError, formatAppUrl, isAppReady, resolveManagedAppApiBaseUrl, waitForAppReady, } from '../../lib/app-health.js';
 import { ensureBuiltinDbReady, ensureLocalPostinstall, ensureSavedLocalSource, recreateSavedDockerApp, } from '../../lib/app-managed-resources.js';
 import { run } from '../../lib/run-npm.js';
 import { announceTargetEnv, failTask, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+function shouldPrintStartSuccess() {
+    return process.env.NB_SKIP_APP_START_SUCCESS_LOG !== '1';
+}
 function argvHasToken(argv, tokens) {
     return tokens.some((token) => argv.includes(token));
 }
@@ -52,7 +55,7 @@ function formatLocalReadyFailure(envName, message, options) {
 }
 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 description = 'Start NocoBase for the selected env. Local npm/git installs run the app command, and Docker installs recreate the saved app container.';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
         '<%= config.bin %> <%= command.id %> --env local',
@@ -76,7 +79,11 @@ export default class AppStart extends Command {
             default: false,
         }),
         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 }),
+        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',
@@ -90,10 +97,6 @@ export default class AppStart extends Command {
             description: 'Show raw startup output from the underlying local or Docker command',
             default: false,
         }),
-        recreate: Flags.boolean({
-            description: 'Recreate the saved Docker app container before starting it',
-            default: false,
-        }),
     };
     async run() {
         const { flags } = await this.parse(AppStart);
@@ -131,7 +134,6 @@ export default class AppStart extends Command {
         announceTargetEnv(runtime.envName);
         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,
@@ -141,7 +143,7 @@ export default class AppStart extends Command {
                 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.`,
+                    `Run \`nb app start --env ${runtime.envName}\` to recreate the saved container, or recreate the env if you need different runtime settings.`,
                 ].join('\n'));
             }
             await ensureBuiltinDbReady(runtime, {
@@ -150,52 +152,23 @@ export default class AppStart extends Command {
                 onSucceedTask: succeedTask,
                 onFailTask: failTask,
             });
-            const appUrl = formatAppUrl(runtime.env.appPort === undefined || runtime.env.appPort === null
-                ? undefined
-                : String(runtime.env.appPort));
+            const appUrl = formatAppUrl(runtime.env.appPort === undefined || runtime.env.appPort === null ? undefined : String(runtime.env.appPort));
             const apiBaseUrl = resolveManagedAppApiBaseUrl(runtime);
-            if (flags.recreate) {
-                startTask(`Recreating the Docker app container for "${runtime.envName}"...`);
-                try {
-                    await run('docker', ['rm', '-f', runtime.containerName], {
-                        errorName: 'docker rm',
-                        stdio: commandStdio,
-                    }).catch(() => undefined);
-                    await recreateSavedDockerApp(runtime, {
-                        verbose: flags.verbose,
-                    });
-                    succeedTask(`Docker app container is ready for "${runtime.envName}".`);
-                }
-                catch (error) {
-                    const message = error instanceof Error ? error.message : String(error);
-                    failTask(`Failed to recreate NocoBase for "${runtime.envName}".`);
-                    this.error(formatDockerStartFailure(runtime.envName, message));
-                }
+            startTask(`Recreating the Docker app container for "${runtime.envName}"...`);
+            try {
+                await run('docker', ['rm', '-f', runtime.containerName], {
+                    errorName: 'docker rm',
+                    stdio: commandStdio,
+                }).catch(() => undefined);
+                await recreateSavedDockerApp(runtime, {
+                    verbose: flags.verbose,
+                });
+                succeedTask(`Docker app container is ready for "${runtime.envName}".`);
             }
-            else {
-                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));
-                    }
-                }
+            catch (error) {
+                const message = error instanceof Error ? error.message : String(error);
+                failTask(`Failed to recreate NocoBase for "${runtime.envName}".`);
+                this.error(formatDockerStartFailure(runtime.envName, message));
             }
             await waitForAppReady({
                 envName: runtime.envName,
@@ -203,7 +176,9 @@ export default class AppStart extends Command {
                 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}` : ''}.`);
+            if (shouldPrintStartSuccess()) {
+                succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+            }
             return;
         }
         await ensureBuiltinDbReady(runtime, {
@@ -229,7 +204,9 @@ export default class AppStart extends Command {
         if (flags.port) {
             npmArgs.push('--port', flags.port);
         }
-        else if (runtime.env.appPort !== undefined && runtime.env.appPort !== null && String(runtime.env.appPort).trim() !== '') {
+        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) {
@@ -241,8 +218,8 @@ export default class AppStart extends Command {
         if (flags['launch-mode']) {
             npmArgs.push('--launch-mode', flags['launch-mode']);
         }
-        const effectivePort = flags.port
-            || (runtime.env.appPort !== undefined && runtime.env.appPort !== null
+        const effectivePort = flags.port ||
+            (runtime.env.appPort !== undefined && runtime.env.appPort !== null
                 ? String(runtime.env.appPort).trim()
                 : undefined);
         const appUrl = formatAppUrl(effectivePort);
@@ -254,7 +231,9 @@ export default class AppStart extends Command {
                 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}` : ''}.`);
+                if (shouldPrintStartSuccess()) {
+                    succeedTask(`NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+                }
             }
             return;
         }
@@ -285,7 +264,9 @@ export default class AppStart extends Command {
                     apiBaseUrl,
                     logHint: `You can inspect startup logs with \`nb app logs --env ${runtime.envName}\`.`,
                 });
-                succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+                if (shouldPrintStartSuccess()) {
+                    succeedTask(`NocoBase is running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`);
+                }
             }
         }
         catch (error) {

package/dist/commands/app/stop.js

@@ -7,27 +7,28 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import { Command, Flags } from '@oclif/core';
+import { getCurrentEnvName } from '../../lib/auth-store.js';
 import { ensureCrossEnvConfirmed, hasExplicitEnvSelection } from '../../lib/env-guard.js';
-import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, stopDockerContainer, } from '../../lib/app-runtime.js';
-import { announceTargetEnv, failTask, startTask, succeedTask } from '../../lib/ui.js';
+import { formatMissingManagedAppEnvMessage, resolveManagedAppRuntime, runLocalNocoBaseCommand, } from '../../lib/app-runtime.js';
+import { announceTargetEnv, failTask, isInteractiveTerminal, printInfo, startTask, succeedTask } from '../../lib/ui.js';
+import { builtinDbContainerName, removeDockerContainerIfExists } from './shared.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');
 }
+function formatStopCrossEnvConfirmationRequiredMessage(currentEnv, requestedEnv) {
+    return [
+        `Refusing to stop env "${requestedEnv}" because the current env is "${currentEnv}" and interactive confirmation is unavailable in the current session.`,
+        '',
+        'Re-run the command with `--yes` to confirm this one-off cross-env stop, or switch the current env first.',
+    ].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 description = 'Stop NocoBase for the selected env. Local npm/git installs stop the app process, and Docker installs remove the saved app container.';
     static examples = [
         '<%= config.bin %> <%= command.id %>',
         '<%= config.bin %> <%= command.id %> --env local',
@@ -44,6 +45,15 @@ export default class AppStop extends Command {
             description: 'Confirm using --env when it targets a different env than the current env',
             default: false,
         }),
+        force: Flags.boolean({
+            char: 'f',
+            hidden: true,
+            default: false,
+        }),
+        'with-db': Flags.boolean({
+            description: 'Also remove the CLI-managed built-in database container when present',
+            default: false,
+        }),
         verbose: Flags.boolean({
             description: 'Show raw shutdown output from the underlying local or Docker command',
             default: false,
@@ -53,13 +63,23 @@ export default class AppStop extends Command {
         const { flags } = await this.parse(AppStop);
         const requestedEnv = flags.env?.trim() || undefined;
         if (requestedEnv && hasExplicitEnvSelection(this.argv)) {
-            const confirmed = await ensureCrossEnvConfirmed({
-                command: this,
-                requestedEnv,
-                yes: flags.yes,
-            });
-            if (!confirmed) {
-                return;
+            const skipCrossEnvConfirmation = flags.yes || flags.force;
+            if (!isInteractiveTerminal()) {
+                const currentEnv = await getCurrentEnvName();
+                const normalizedCurrentEnv = String(currentEnv ?? '').trim() || undefined;
+                if (normalizedCurrentEnv && normalizedCurrentEnv !== requestedEnv && !skipCrossEnvConfirmation) {
+                    this.error(formatStopCrossEnvConfirmationRequiredMessage(normalizedCurrentEnv, requestedEnv));
+                }
+            }
+            else {
+                const confirmed = await ensureCrossEnvConfirmed({
+                    command: this,
+                    requestedEnv,
+                    yes: skipCrossEnvConfirmation,
+                });
+                if (!confirmed) {
+                    return;
+                }
             }
         }
         const runtime = await resolveManagedAppRuntime(requestedEnv);
@@ -83,32 +103,58 @@ export default class AppStop extends Command {
         }
         announceTargetEnv(runtime.envName);
         if (runtime.kind === 'docker') {
+            startTask(`Removing the saved Docker app container for "${runtime.envName}"...`);
+            try {
+                const state = await removeDockerContainerIfExists(runtime.containerName, {
+                    stdio: commandStdio,
+                });
+                succeedTask(state === 'removed'
+                    ? `Docker app container removed for "${runtime.envName}".`
+                    : `No Docker app container found 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));
+            }
+        }
+        else {
             startTask(`Stopping NocoBase for "${runtime.envName}"...`);
             try {
-                const state = await stopDockerContainer(runtime.containerName, {
+                await runLocalNocoBaseCommand(runtime, ['pm2', 'kill'], {
                     stdio: commandStdio,
                 });
-                succeedTask(state === 'already-stopped'
-                    ? `NocoBase is already stopped for "${runtime.envName}".`
-                    : `NocoBase has stopped for "${runtime.envName}".`);
+                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));
             }
+        }
+        if (!flags['with-db']) {
+            return;
+        }
+        if (runtime.kind !== 'local' && runtime.kind !== 'docker') {
+            return;
+        }
+        const dbContainerName = builtinDbContainerName(runtime);
+        if (!dbContainerName) {
+            printInfo(`Env "${runtime.envName}" does not use a CLI-managed built-in database. Only the app runtime was stopped.`);
             return;
         }
-        startTask(`Stopping NocoBase for "${runtime.envName}"...`);
+        startTask(`Removing the built-in database container for "${runtime.envName}"...`);
         try {
-            await runLocalNocoBaseCommand(runtime, ['pm2', 'kill'], {
+            const state = await removeDockerContainerIfExists(dbContainerName, {
                 stdio: commandStdio,
             });
-            succeedTask(`NocoBase has stopped for "${runtime.envName}".`);
+            succeedTask(state === 'removed'
+                ? `Built-in database container removed for "${runtime.envName}".`
+                : `No built-in database container found for "${runtime.envName}".`);
         }
         catch (error) {
             const message = error instanceof Error ? error.message : String(error);
-            failTask(`Failed to stop NocoBase for "${runtime.envName}".`);
+            failTask(`Failed to stop the built-in database for "${runtime.envName}".`);
             this.error(formatStopFailure(runtime.envName, message));
         }
     }