@nocobase/cli 2.1.0-beta.15 → 2.1.0-beta.17

package/dist/commands/db/logs.js

@@ -0,0 +1,85 @@
+/**
+ * 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 } from '../../lib/app-runtime.js';
+import { run } from '../../lib/run-npm.js';
+import { printInfo } from '../../lib/ui.js';
+import { formatUnmanagedDbLogsMessage, resolveDbRuntime } from './shared.js';
+function formatDbLogsFailure(envName, message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            `Can't show database logs for "${envName}" yet.`,
+            'The saved built-in database container for this env could not be found on this machine.',
+            'Try reinstalling the env, or check whether the container was removed outside the CLI.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        `Couldn't show database logs for "${envName}".`,
+        'Check that the built-in database runtime for this env is still available, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class DbLogs extends Command {
+    static description = 'Show logs for the built-in database container of the selected env.';
+    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 built-in database 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(DbLogs);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveDbRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind !== 'builtin') {
+            this.error(formatUnmanagedDbLogsMessage(runtime));
+        }
+        const tail = String(flags.tail ?? 100);
+        const follow = flags.follow !== false;
+        printInfo(follow
+            ? `Showing built-in database logs for "${runtime.envName}" (press Ctrl+C to stop).`
+            : `Showing recent built-in database logs for "${runtime.envName}".`);
+        const dockerArgs = ['logs', '--tail', tail];
+        if (follow) {
+            dockerArgs.push('--follow');
+        }
+        dockerArgs.push(runtime.containerName);
+        try {
+            await run('docker', dockerArgs, {
+                errorName: 'docker logs',
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(formatDbLogsFailure(runtime.envName, message));
+        }
+    }
+}

package/dist/commands/db/ps.js

@@ -0,0 +1,60 @@
+/**
+ * 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 } from '../../lib/app-runtime.js';
+import { listEnvs } from '../../lib/auth-store.js';
+import { renderTable } from '../../lib/ui.js';
+import { builtinDbStatus, resolveDbRuntime } from './shared.js';
+export default class DbPs extends Command {
+    static description = 'Show built-in database runtime status for configured envs without starting or stopping anything.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to inspect. Omit to show all configured envs',
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbPs);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const envNames = requestedEnv
+            ? [requestedEnv]
+            : Object.keys((await listEnvs()).envs).sort();
+        if (!envNames.length) {
+            this.log('No NocoBase env is configured yet. Run `nb init` to create one first.');
+            return;
+        }
+        const rows = [];
+        for (const envName of envNames) {
+            const runtime = await resolveDbRuntime(envName);
+            if (!runtime) {
+                if (requestedEnv) {
+                    this.error(formatMissingManagedAppEnvMessage(envName));
+                }
+                rows.push([envName, '-', '-', 'missing', '']);
+                continue;
+            }
+            const type = runtime.kind === 'builtin' ? 'builtin' : runtime.status;
+            const status = runtime.kind === 'builtin'
+                ? await builtinDbStatus(runtime.containerName)
+                : runtime.status;
+            rows.push([
+                runtime.envName,
+                type,
+                runtime.dbDialect,
+                status,
+                runtime.address,
+            ]);
+        }
+        this.log(renderTable(['Env', 'Type', 'Dialect', 'Status', 'Address'], rows));
+    }
+}

package/dist/commands/db/shared.js

@@ -0,0 +1,81 @@
+/**
+ * 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 { buildDockerDbContainerName, dockerContainerExists, dockerContainerIsRunning, resolveManagedAppRuntime, } from '../../lib/app-runtime.js';
+function formatAddress(host, port, fallbackHost) {
+    const normalizedHost = String(host ?? '').trim() || String(fallbackHost ?? '').trim();
+    const normalizedPort = String(port ?? '').trim();
+    if (normalizedHost && normalizedPort) {
+        return `${normalizedHost}:${normalizedPort}`;
+    }
+    return normalizedHost || normalizedPort || '';
+}
+export async function resolveDbRuntime(envName) {
+    const runtime = await resolveManagedAppRuntime(envName);
+    if (!runtime) {
+        return undefined;
+    }
+    const source = runtime.kind === 'remote' ? 'remote' : runtime.source;
+    const dbDialect = String(runtime.env.config.dbDialect ?? 'postgres').trim() || 'postgres';
+    if (runtime.kind !== 'remote' && runtime.env.config.builtinDb) {
+        const containerName = buildDockerDbContainerName(runtime.envName, dbDialect, runtime.workspaceName);
+        return {
+            kind: 'builtin',
+            envName: runtime.envName,
+            source,
+            dbDialect,
+            containerName,
+            address: formatAddress(runtime.env.config.dbHost, runtime.env.config.dbPort, containerName),
+            appRuntime: runtime,
+        };
+    }
+    return {
+        kind: 'external',
+        envName: runtime.envName,
+        source,
+        dbDialect,
+        address: formatAddress(runtime.env.config.dbHost, runtime.env.config.dbPort),
+        status: runtime.kind === 'remote' ? 'remote' : 'external',
+        appRuntime: runtime,
+    };
+}
+export async function builtinDbStatus(containerName) {
+    if (!(await dockerContainerExists(containerName))) {
+        return 'missing';
+    }
+    return await dockerContainerIsRunning(containerName) ? 'running' : 'stopped';
+}
+export function formatUnmanagedDbMessage(action, runtime) {
+    const verb = action === 'start' ? 'start' : 'stop';
+    if (runtime.appRuntime.kind === 'remote') {
+        return [
+            `Can't ${verb} the database for "${runtime.envName}" from this machine.`,
+            'This env only has an API connection, so there is no CLI-managed database container here.',
+            'If you need CLI-managed database start and stop, create a local env with the built-in database option enabled.',
+        ].join('\n');
+    }
+    return [
+        `Can't ${verb} the database for "${runtime.envName}" from this machine.`,
+        'This env does not use a CLI-managed built-in database, so there is no saved database container to manage here.',
+        'If you need CLI-managed database start and stop, recreate the env with the built-in database option enabled.',
+    ].join('\n');
+}
+export function formatUnmanagedDbLogsMessage(runtime) {
+    if (runtime.appRuntime.kind === 'remote') {
+        return [
+            `Can't show database logs for "${runtime.envName}" from this machine.`,
+            'This env only has an API connection, so there is no CLI-managed database container here.',
+            'If you need CLI-managed database logs, create a local env with the built-in database option enabled.',
+        ].join('\n');
+    }
+    return [
+        `Can't show database logs for "${runtime.envName}" from this machine.`,
+        'This env does not use a CLI-managed built-in database, so there is no saved database container to read logs from here.',
+        'If you need CLI-managed database logs, recreate the env with the built-in database option enabled.',
+    ].join('\n');
+}

package/dist/commands/db/start.js

@@ -0,0 +1,70 @@
+/**
+ * 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, startDockerContainer, } from '../../lib/app-runtime.js';
+import { failTask, startTask, succeedTask } from '../../lib/ui.js';
+import { formatUnmanagedDbMessage, resolveDbRuntime } from './shared.js';
+function formatDbStartFailure(envName, message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            `Can't start the database for "${envName}" yet.`,
+            'The saved built-in database container for this env could not be found on this machine.',
+            'Try reinstalling the env, or check whether the container was removed outside the CLI.',
+            `Details: ${message}`,
+        ].join('\n');
+    }
+    return [
+        `Couldn't start the database for "${envName}".`,
+        'Check that the built-in database runtime for this env is still available, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class DbStart extends Command {
+    static description = 'Start the built-in database container for the selected env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --verbose',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to start the built-in database for. Defaults to the current env when omitted',
+        }),
+        verbose: Flags.boolean({
+            description: 'Show raw startup output from the underlying Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbStart);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveDbRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind !== 'builtin') {
+            this.error(formatUnmanagedDbMessage('start', runtime));
+        }
+        startTask(`Starting the built-in database for "${runtime.envName}"...`);
+        try {
+            const state = await startDockerContainer(runtime.containerName, {
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+            succeedTask(state === 'already-running'
+                ? `The built-in database is already running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`
+                : `The built-in database is running for "${runtime.envName}"${runtime.address ? ` at ${runtime.address}` : ''}.`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask(`Failed to start the built-in database for "${runtime.envName}".`);
+            this.error(formatDbStartFailure(runtime.envName, message));
+        }
+    }
+}

package/dist/commands/db/stop.js

@@ -0,0 +1,70 @@
+/**
+ * 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, stopDockerContainer, } from '../../lib/app-runtime.js';
+import { failTask, startTask, succeedTask } from '../../lib/ui.js';
+import { formatUnmanagedDbMessage, resolveDbRuntime } from './shared.js';
+function formatDbStopFailure(envName, message) {
+    if (/does not exist/i.test(message)) {
+        return [
+            `Can't stop the database for "${envName}" yet.`,
+            'The saved built-in database container 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 the database for "${envName}".`,
+        'Check that the built-in database runtime for this env is still available, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+export default class DbStop extends Command {
+    static description = 'Stop the built-in database container for the selected env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --verbose',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name to stop the built-in database for. Defaults to the current env when omitted',
+        }),
+        verbose: Flags.boolean({
+            description: 'Show raw shutdown output from the underlying Docker command',
+            default: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(DbStop);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveDbRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind !== 'builtin') {
+            this.error(formatUnmanagedDbMessage('stop', runtime));
+        }
+        startTask(`Stopping the built-in database for "${runtime.envName}"...`);
+        try {
+            const state = await stopDockerContainer(runtime.containerName, {
+                stdio: flags.verbose ? 'inherit' : 'ignore',
+            });
+            succeedTask(state === 'already-stopped'
+                ? `The built-in database is already stopped for "${runtime.envName}".`
+                : `The built-in database has stopped for "${runtime.envName}".`);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            failTask(`Failed to stop the built-in database for "${runtime.envName}".`);
+            this.error(formatDbStopFailure(runtime.envName, message));
+        }
+    }
+}

package/dist/commands/dev.js

@@ -0,0 +1,149 @@
+/**
+ * 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 { printInfo } from '../lib/ui.js';
+function formatUnsupportedRuntimeMessage(kind, envName) {
+    if (kind === 'docker') {
+        return [
+            `Can't run dev mode for "${envName}".`,
+            'This env is managed by Docker, but `nb dev` requires a local npm or Git source directory.',
+            `Use \`nb logs --env ${envName}\` to inspect the Docker app, or create a source-based env with \`nb init --env ${envName} --source git\`.`,
+        ].join('\n');
+    }
+    return [
+        `Can't run dev mode for "${envName}".`,
+        'This env only has an API connection, but `nb dev` requires a local npm or Git source directory.',
+        `Create a source-based env with \`nb init --env ${envName} --source git\` if you want local development mode.`,
+    ].join('\n');
+}
+function appUrlForPort(port) {
+    const value = String(port ?? '').trim();
+    if (!value) {
+        return undefined;
+    }
+    return `http://127.0.0.1:${value}`;
+}
+async function isAppAlreadyRunning(appUrl) {
+    if (!appUrl) {
+        return false;
+    }
+    const controller = new AbortController();
+    const timeout = setTimeout(() => controller.abort(), 1500);
+    try {
+        const response = await fetch(`${appUrl}/api/__health_check`, {
+            signal: controller.signal,
+        });
+        const text = await response.text();
+        return response.ok && text.trim().toLowerCase() === 'ok';
+    }
+    catch (_error) {
+        return false;
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+export default class Dev extends Command {
+    static description = 'Run NocoBase in local development mode for an npm or Git source env.';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+        '<%= config.bin %> <%= command.id %> --env app1',
+        '<%= config.bin %> <%= command.id %> --env app1 --db-sync',
+        '<%= config.bin %> <%= command.id %> --env app1 --port 12000',
+        '<%= config.bin %> <%= command.id %> --env app1 --client',
+        '<%= config.bin %> <%= command.id %> --env app1 --server',
+        '<%= config.bin %> <%= command.id %> --env app1 --inspect 9229',
+    ];
+    static flags = {
+        env: Flags.string({
+            char: 'e',
+            description: 'CLI env name for dev mode. Defaults to the current env when omitted',
+            required: false,
+        }),
+        'db-sync': Flags.boolean({
+            description: 'Synchronize the database before starting dev mode',
+            required: false,
+        }),
+        port: Flags.string({
+            description: 'Development server port',
+            char: 'p',
+            required: false,
+        }),
+        client: Flags.boolean({
+            description: 'Run client dev mode only',
+            char: 'c',
+            required: false,
+        }),
+        server: Flags.boolean({
+            description: 'Run server dev mode only',
+            char: 's',
+            required: false,
+        }),
+        inspect: Flags.string({
+            description: 'Node.js inspect port for server debugging',
+            char: 'i',
+            required: false,
+        }),
+    };
+    async run() {
+        const { flags } = await this.parse(Dev);
+        const requestedEnv = flags.env?.trim() || undefined;
+        const runtime = await resolveManagedAppRuntime(requestedEnv);
+        if (!runtime) {
+            this.error(formatMissingManagedAppEnvMessage(requestedEnv));
+        }
+        if (runtime.kind === 'docker' || runtime.kind === 'remote') {
+            this.error(formatUnsupportedRuntimeMessage(runtime.kind, runtime.envName));
+        }
+        const devPort = flags.port
+            || (runtime.env.appPort !== undefined && runtime.env.appPort !== null
+                ? String(runtime.env.appPort).trim()
+                : undefined);
+        const appUrl = appUrlForPort(devPort);
+        if (await isAppAlreadyRunning(appUrl)) {
+            this.error([
+                `NocoBase is already running for "${runtime.envName}"${appUrl ? ` at ${appUrl}` : ''}.`,
+                flags.port
+                    ? `Choose another dev port with --port, or stop the running app with \`nb stop --env ${runtime.envName}\` first.`
+                    : `Run \`nb stop --env ${runtime.envName}\` before starting dev mode, or choose another dev port with --port.`,
+            ].join('\n'));
+        }
+        const npmArgs = ['dev', '--rsbuild'];
+        if (flags['db-sync']) {
+            npmArgs.push('--db-sync');
+        }
+        if (devPort) {
+            npmArgs.push('--port', devPort);
+        }
+        if (flags.client) {
+            npmArgs.push('--client');
+        }
+        if (flags.server) {
+            npmArgs.push('--server');
+        }
+        if (flags.inspect) {
+            npmArgs.push('--inspect', flags.inspect);
+        }
+        printInfo(`Starting NocoBase dev mode for "${runtime.envName}" from ${runtime.projectRoot}. Press Ctrl+C to stop.`);
+        try {
+            await runLocalNocoBaseCommand(runtime, npmArgs, {
+                stdio: 'inherit',
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error([
+                `Couldn't start dev mode for "${runtime.envName}".`,
+                'Check that dependencies are installed and the saved env settings are valid, then try again.',
+                `Details: ${message}`,
+            ].join('\n'));
+        }
+    }
+}