@nocobase/cli 2.1.0-beta.20 → 2.1.0-beta.22

package/dist/lib/app-health.js

@@ -0,0 +1,126 @@
+/**
+ * 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 { printInfo, startTask, stopTask, updateTask } from './ui.js';
+const APP_HEALTH_CHECK_INTERVAL_MS = 2_000;
+const APP_HEALTH_CHECK_TIMEOUT_MS = 600_000;
+const APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS = 5_000;
+function trimValue(value) {
+    return String(value ?? '').trim();
+}
+function buildHealthCheckUrl(apiBaseUrl) {
+    return `${apiBaseUrl.replace(/\/+$/, '')}/__health_check`;
+}
+async function sleep(ms) {
+    await new Promise((resolve) => setTimeout(resolve, ms));
+}
+async function requestAppHealthCheck(params) {
+    const controller = new AbortController();
+    const timeout = setTimeout(() => {
+        controller.abort();
+    }, params.requestTimeoutMs ?? APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS);
+    try {
+        const response = await (params.fetchImpl ?? fetch)(params.healthCheckUrl, {
+            method: 'GET',
+            signal: controller.signal,
+        });
+        const text = await response.text().catch(() => '');
+        const body = text.replace(/\s+/g, ' ').trim() || 'No response yet';
+        return {
+            ok: response.ok && text.trim().toLowerCase() === 'ok',
+            message: `HTTP ${response.status}: ${body}`,
+        };
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'AbortError') {
+            return {
+                ok: false,
+                message: `No response within ${Math.ceil((params.requestTimeoutMs ?? APP_HEALTH_CHECK_REQUEST_TIMEOUT_MS) / 1000)}s`,
+            };
+        }
+        return {
+            ok: false,
+            message: error instanceof Error ? error.message : String(error),
+        };
+    }
+    finally {
+        clearTimeout(timeout);
+    }
+}
+export class AppHealthCheckError extends Error {
+}
+export function formatAppUrl(port) {
+    const value = trimValue(port);
+    return value ? `http://127.0.0.1:${value}` : undefined;
+}
+export function resolveManagedAppApiBaseUrl(runtime, options) {
+    const override = trimValue(options?.portOverride);
+    if (override) {
+        return `http://127.0.0.1:${override}/api`;
+    }
+    const baseUrl = trimValue(runtime.env.baseUrl);
+    if (baseUrl) {
+        return baseUrl.replace(/\/+$/, '');
+    }
+    const appPort = runtime.env.appPort === undefined || runtime.env.appPort === null
+        ? ''
+        : trimValue(runtime.env.appPort);
+    return appPort ? `http://127.0.0.1:${appPort}/api` : undefined;
+}
+export async function isAppReady(apiBaseUrl, options) {
+    const baseUrl = trimValue(apiBaseUrl);
+    if (!baseUrl) {
+        return false;
+    }
+    const result = await requestAppHealthCheck({
+        healthCheckUrl: buildHealthCheckUrl(baseUrl),
+        fetchImpl: options?.fetchImpl,
+        requestTimeoutMs: options?.requestTimeoutMs,
+    });
+    return result.ok;
+}
+export async function waitForAppReady(params) {
+    const apiBaseUrl = trimValue(params.apiBaseUrl);
+    if (!apiBaseUrl) {
+        printInfo(`Skipping health check for "${params.envName}" because no local API URL is saved for this env.`);
+        return;
+    }
+    const healthCheckUrl = buildHealthCheckUrl(apiBaseUrl);
+    const startedAt = Date.now();
+    let lastMessage = 'No response yet';
+    let spinnerActive = true;
+    startTask(`Waiting for NocoBase to become ready for "${params.envName}"...`);
+    try {
+        while (Date.now() - startedAt < APP_HEALTH_CHECK_TIMEOUT_MS) {
+            const result = await requestAppHealthCheck({
+                healthCheckUrl,
+                fetchImpl: params.fetchImpl,
+            });
+            if (result.ok) {
+                stopTask();
+                spinnerActive = false;
+                return;
+            }
+            lastMessage = result.message;
+            const elapsedSeconds = Math.max(1, Math.floor((Date.now() - startedAt) / 1000));
+            updateTask(`Waiting for NocoBase to become ready for "${params.envName}"... (${elapsedSeconds}s elapsed, last status: ${lastMessage})`);
+            await sleep(APP_HEALTH_CHECK_INTERVAL_MS);
+        }
+    }
+    finally {
+        if (spinnerActive) {
+            stopTask();
+        }
+    }
+    const hints = [
+        params.logHint,
+        params.containerName ? `docker logs ${params.containerName}` : undefined,
+    ].filter(Boolean);
+    const hintText = hints.length > 0 ? ` ${hints.join(' ')}` : '';
+    throw new AppHealthCheckError(`NocoBase did not become ready in time for "${params.envName}". Expected \`${healthCheckUrl}\` to respond with \`ok\`, but the last status was: ${lastMessage}.${hintText}`);
+}

package/dist/lib/app-managed-resources.js

@@ -0,0 +1,264 @@
+/**
+ * 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 { mkdir, readdir } from 'node:fs/promises';
+import { dockerContainerExists, startDockerContainer } from './app-runtime.js';
+import { resolveConfiguredEnvPath } from './cli-home.js';
+import { commandSucceeds, run } from './run-npm.js';
+import Install from '../commands/install.js';
+const DEFAULT_DOCKER_REGISTRY = 'nocobase/nocobase';
+const DEFAULT_DOCKER_VERSION = 'alpha';
+const DOCKER_APP_STORAGE_DESTINATION = '/app/nocobase/storage';
+function commandStdio(verbose) {
+    return verbose ? 'inherit' : 'ignore';
+}
+async function ensureDockerNetwork(networkName) {
+    if (await commandSucceeds('docker', ['network', 'inspect', networkName])) {
+        return;
+    }
+    await run('docker', ['network', 'create', networkName], {
+        errorName: 'docker network create',
+    });
+}
+function localSourceLabel(source) {
+    return source === 'git' ? 'Git checkout' : 'npm app';
+}
+function trimValue(value) {
+    return String(value ?? '').trim();
+}
+function normalizeDockerPlatform(value) {
+    const text = trimValue(value);
+    if (!text || text === 'auto') {
+        return undefined;
+    }
+    if (text === 'linux/amd64' || text === 'linux/arm64') {
+        return text;
+    }
+    return undefined;
+}
+function formatBuiltinDbFailure(envName, message) {
+    return [
+        `Couldn't restore the built-in database for "${envName}".`,
+        'Check the saved database settings, local storage path, and Docker runtime, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+function formatLocalSourceRestoreFailure(envName, source, message) {
+    const sourceLabel = source === 'git' ? 'the saved Git checkout' : 'the saved npm app';
+    return [
+        `Couldn't restore NocoBase files for "${envName}".`,
+        `The CLI was not able to download ${sourceLabel} before starting the app again.`,
+        'Check the saved source settings for this env, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+function formatSavedDockerSettingsIncomplete(envName, missing) {
+    return [
+        `Can't start NocoBase for "${envName}" yet.`,
+        `The saved Docker settings for this env are incomplete. Missing: ${missing.join(', ')}.`,
+        'Re-run `nb init` or `nb env add` to refresh this env config, then try again.',
+    ].join('\n');
+}
+function formatDockerAppRecreateFailure(envName, message) {
+    return [
+        `Couldn't start NocoBase for "${envName}".`,
+        'The CLI was not able to recreate the saved Docker app container successfully.',
+        'Check the saved Docker image, container settings, and database connection, then try again.',
+        `Details: ${message}`,
+    ].join('\n');
+}
+async function localProjectHasFiles(projectRoot) {
+    try {
+        const entries = await readdir(projectRoot);
+        return entries.length > 0;
+    }
+    catch (_error) {
+        return false;
+    }
+}
+export function buildSavedDockerRunArgs(runtime) {
+    const config = runtime.env.config ?? {};
+    const configuredStoragePath = trimValue(config.storagePath);
+    const storagePath = configuredStoragePath
+        ? trimValue(resolveConfiguredEnvPath(configuredStoragePath))
+        : '';
+    const appPort = runtime.env.appPort === undefined || runtime.env.appPort === null
+        ? ''
+        : trimValue(runtime.env.appPort);
+    const appKey = trimValue(config.appKey);
+    const timeZone = trimValue(config.timezone) || Intl.DateTimeFormat().resolvedOptions().timeZone || 'UTC';
+    const dbDialect = trimValue(config.dbDialect);
+    const dbHost = trimValue(config.dbHost);
+    const dbPort = trimValue(config.dbPort);
+    const dbDatabase = trimValue(config.dbDatabase);
+    const dbUser = trimValue(config.dbUser);
+    const dbPassword = trimValue(config.dbPassword);
+    const dockerRegistry = trimValue(config.dockerRegistry) || DEFAULT_DOCKER_REGISTRY;
+    const version = trimValue(config.downloadVersion) || DEFAULT_DOCKER_VERSION;
+    const imageRef = `${dockerRegistry}:${version}`;
+    const missing = [];
+    if (!storagePath) {
+        missing.push('storagePath');
+    }
+    if (!appKey) {
+        missing.push('appKey');
+    }
+    if (!dbDialect) {
+        missing.push('dbDialect');
+    }
+    if (!dbHost) {
+        missing.push('dbHost');
+    }
+    if (!dbPort) {
+        missing.push('dbPort');
+    }
+    if (!dbDatabase) {
+        missing.push('dbDatabase');
+    }
+    if (!dbUser) {
+        missing.push('dbUser');
+    }
+    if (!dbPassword) {
+        missing.push('dbPassword');
+    }
+    if (missing.length > 0) {
+        throw new Error(formatSavedDockerSettingsIncomplete(runtime.envName, missing));
+    }
+    const args = [
+        'run',
+        '-d',
+        '--name',
+        runtime.containerName,
+        '--restart',
+        'always',
+        '--network',
+        runtime.workspaceName,
+    ];
+    const dockerPlatform = normalizeDockerPlatform(config.dockerPlatform);
+    if (dockerPlatform) {
+        args.push('--platform', dockerPlatform);
+    }
+    if (appPort) {
+        args.push('-p', `${appPort}:80`);
+    }
+    args.push('-e', `APP_KEY=${appKey}`, '-e', `DB_DIALECT=${dbDialect}`, '-e', `DB_HOST=${dbHost}`, '-e', `DB_PORT=${dbPort}`, '-e', `DB_DATABASE=${dbDatabase}`, '-e', `DB_USER=${dbUser}`, '-e', `DB_PASSWORD=${dbPassword}`, '-e', `TZ=${timeZone}`, '-v', `${storagePath}:${DOCKER_APP_STORAGE_DESTINATION}`, imageRef);
+    return {
+        appPort: appPort || undefined,
+        storagePath,
+        imageRef,
+        args,
+    };
+}
+export async function recreateSavedDockerApp(runtime, options) {
+    const plan = buildSavedDockerRunArgs(runtime);
+    try {
+        await ensureDockerNetwork(runtime.workspaceName);
+        await mkdir(plan.storagePath, { recursive: true });
+        await run('docker', plan.args, {
+            errorName: 'docker run',
+            stdio: commandStdio(options?.verbose),
+        });
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error);
+        if (message.includes(`Can't start NocoBase for "${runtime.envName}" yet.`)
+            || message.includes(`Couldn't start NocoBase for "${runtime.envName}".`)) {
+            throw error instanceof Error ? error : new Error(message);
+        }
+        throw new Error(formatDockerAppRecreateFailure(runtime.envName, message));
+    }
+}
+export async function ensureBuiltinDbReady(runtime, options) {
+    const config = runtime.env.config ?? {};
+    if (!config.builtinDb) {
+        return;
+    }
+    const plan = Install.buildBuiltinDbPlan({
+        envName: runtime.envName,
+        workspaceName: runtime.workspaceName,
+        storagePath: config.storagePath,
+        source: runtime.source,
+        dbDialect: config.dbDialect,
+        dbHost: config.dbHost,
+        dbPort: config.dbPort,
+        dbDatabase: config.dbDatabase,
+        dbUser: config.dbUser,
+        dbPassword: config.dbPassword,
+        builtinDbImage: config.builtinDbImage,
+    });
+    options?.onStartTask?.(`Restoring the built-in ${plan.dbDialect} database for "${runtime.envName}"...`);
+    try {
+        await ensureDockerNetwork(plan.networkName);
+        if (await dockerContainerExists(plan.containerName)) {
+            const state = await startDockerContainer(plan.containerName, {
+                stdio: commandStdio(options?.verbose),
+            });
+            options?.onSucceedTask?.(state === 'already-running'
+                ? `The built-in ${plan.dbDialect} database is already running for "${runtime.envName}" at ${plan.dbHost}:${plan.dbPort}.`
+                : `The built-in ${plan.dbDialect} database is running for "${runtime.envName}" at ${plan.dbHost}:${plan.dbPort}.`);
+            return;
+        }
+        await mkdir(plan.dataDir, { recursive: true });
+        await run('docker', plan.args, {
+            errorName: 'docker run',
+            stdio: commandStdio(options?.verbose),
+        });
+        options?.onSucceedTask?.(`The built-in ${plan.dbDialect} database is running for "${runtime.envName}" at ${plan.dbHost}:${plan.dbPort}.`);
+    }
+    catch (error) {
+        options?.onFailTask?.(`Failed to restore the built-in database for "${runtime.envName}".`);
+        throw new Error(formatBuiltinDbFailure(runtime.envName, error instanceof Error ? error.message : String(error)));
+    }
+}
+export function buildSavedLocalDownloadArgv(runtime, options) {
+    const config = runtime.env.config ?? {};
+    const argv = ['-y', '--no-intro'];
+    if (options?.verbose) {
+        argv.push('--verbose');
+    }
+    argv.push('--source', runtime.source, '--replace', '--output-dir', runtime.projectRoot);
+    const version = String(config.downloadVersion ?? '').trim();
+    const gitUrl = String(config.gitUrl ?? '').trim();
+    const npmRegistry = String(config.npmRegistry ?? '').trim();
+    if (version) {
+        argv.push('--version', version);
+    }
+    if (gitUrl) {
+        argv.push('--git-url', gitUrl);
+    }
+    if (npmRegistry) {
+        argv.push('--npm-registry', npmRegistry);
+    }
+    if (config.devDependencies === true) {
+        argv.push('--dev-dependencies');
+    }
+    if (config.build === false) {
+        argv.push('--no-build');
+    }
+    if (config.buildDts === true) {
+        argv.push('--build-dts');
+    }
+    return argv;
+}
+export async function ensureSavedLocalSource(runtime, runCommand, options) {
+    if (await localProjectHasFiles(runtime.projectRoot)) {
+        return;
+    }
+    const sourceLabel = localSourceLabel(runtime.source);
+    options?.onStartTask?.(`Restoring the saved ${sourceLabel} for "${runtime.envName}"...`);
+    try {
+        await runCommand('source:download', buildSavedLocalDownloadArgv(runtime, {
+            verbose: options?.verbose,
+        }));
+        options?.onSucceedTask?.(`NocoBase files are ready for "${runtime.envName}".`);
+    }
+    catch (error) {
+        options?.onFailTask?.(`Failed to restore NocoBase files for "${runtime.envName}".`);
+        throw new Error(formatLocalSourceRestoreFailure(runtime.envName, runtime.source, error instanceof Error ? error.message : String(error)));
+    }
+}

package/dist/lib/app-runtime.js

@@ -7,6 +7,7 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 import path from 'node:path';
+import { resolveEnvKind } from './auth-store.js';
 import { getEnv, loadAuthConfig } from './auth-store.js';
 import { commandOutput, commandSucceeds, run, runNocoBaseCommand } from './run-npm.js';
 const DOCKER_APP_WORKDIR = '/app/nocobase';
@@ -36,7 +37,8 @@ function normalizeEnvSource(env) {
     if (source === 'docker' || source === 'npm' || source === 'git') {
         return source;
     }
-    if (env.config.appRootPath) {
+    const kind = resolveEnvKind(env.config);
+    if (kind === 'local') {
         return 'local';
     }
     return undefined;
@@ -50,17 +52,18 @@ export async function resolveManagedAppRuntime(envName) {
     const resolvedName = env.name || envName?.trim() || config.currentEnv || 'default';
     const source = normalizeEnvSource(env);
     const workspaceName = config.name?.trim() || defaultWorkspaceName();
-    if (source === 'docker') {
+    const kind = env.kind ?? resolveEnvKind(env.config);
+    if (kind === 'docker') {
         return {
             kind: 'docker',
             env,
             envName: resolvedName,
-            source,
+            source: 'docker',
             workspaceName,
             containerName: buildDockerAppContainerName(resolvedName, workspaceName),
         };
     }
-    if (env.config.appRootPath) {
+    if (kind === 'local') {
         return {
             kind: 'local',
             env,
@@ -70,8 +73,16 @@ export async function resolveManagedAppRuntime(envName) {
             workspaceName,
         };
     }
+    if (kind === 'ssh') {
+        return {
+            kind: 'ssh',
+            env,
+            envName: resolvedName,
+            source,
+        };
+    }
     return {
-        kind: 'remote',
+        kind: 'http',
         env,
         envName: resolvedName,
         source,