@nocobase/cli 2.1.0-beta.44.test.1 → 2.1.0-beta.44.test.3

package/dist/lib/db-connection-check.js

@@ -0,0 +1,219 @@
+/**
+ * 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 { translateCli } from "./cli-locale.js";
+import { validateTcpPort } from "./prompt-validators.js";
+const DB_CONNECTION_TIMEOUT_MS = 5_000;
+const externalDbValidationCache = new Map();
+const mysqlLowerCaseTableNamesCache = new Map();
+function trimPromptValue(value) {
+    return String(value ?? '').trim();
+}
+export function readExternalDbConnectionConfig(values) {
+    const builtinDb = values.builtinDb === undefined ? true : Boolean(values.builtinDb);
+    if (builtinDb) {
+        return undefined;
+    }
+    const dialect = trimPromptValue(values.dbDialect || 'postgres');
+    if (dialect !== 'postgres' && dialect !== 'kingbase' && dialect !== 'mysql' && dialect !== 'mariadb') {
+        return undefined;
+    }
+    const host = trimPromptValue(values.dbHost);
+    const portText = trimPromptValue(values.dbPort);
+    const database = trimPromptValue(values.dbDatabase);
+    const user = trimPromptValue(values.dbUser);
+    const password = String(values.dbPassword ?? '');
+    if (!host || !portText || !database || !user || !password) {
+        return undefined;
+    }
+    if (validateTcpPort(portText)) {
+        return undefined;
+    }
+    return {
+        dialect,
+        host,
+        port: Number.parseInt(portText, 10),
+        database,
+        user,
+        password,
+    };
+}
+export function formatDbCheckAddress(config) {
+    return `${config.host}:${config.port}/${config.database}`;
+}
+function buildValidationCacheKey(config) {
+    return JSON.stringify(config);
+}
+function formatDbConnectionError(config, error) {
+    const maybeError = error;
+    const code = String(maybeError?.code ?? '').trim().toUpperCase();
+    const errno = typeof maybeError?.errno === 'number' ? maybeError.errno : undefined;
+    const rawMessage = String(maybeError?.message || maybeError?.sqlMessage || error || '').trim();
+    if (code === 'ECONNREFUSED' || code === 'ENOTFOUND' || code === 'EHOSTUNREACH' || code === 'ECONNRESET') {
+        return translateCli('validators.dbConnection.unreachable', {
+            host: config.host,
+            port: config.port,
+            details: rawMessage,
+        });
+    }
+    if (code === 'ETIMEDOUT') {
+        return translateCli('validators.dbConnection.timeout', {
+            host: config.host,
+            port: config.port,
+            seconds: Math.ceil(DB_CONNECTION_TIMEOUT_MS / 1000),
+        });
+    }
+    if (code === '28P01' || code === '28000' || code === 'ER_ACCESS_DENIED_ERROR' || errno === 1045) {
+        return translateCli('validators.dbConnection.authenticationFailed', {
+            user: config.user,
+            database: config.database,
+        });
+    }
+    if (code === '3D000' || code === 'ER_BAD_DB_ERROR' || errno === 1049) {
+        return translateCli('validators.dbConnection.databaseNotFound', {
+            database: config.database,
+        });
+    }
+    return translateCli('validators.dbConnection.connectionFailed', {
+        details: rawMessage || code || String(error),
+    });
+}
+async function checkPostgresFamilyConnection(config) {
+    const { default: pg } = await import('pg');
+    const client = new pg.Client({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectionTimeoutMillis: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await client.connect();
+        await client.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(client.end()).catch(() => undefined);
+    }
+}
+async function checkMysqlFamilyConnection(config) {
+    const { default: mysql } = await import('mysql2/promise');
+    const connection = await mysql.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        await connection.query('SELECT 1');
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function readMysqlFamilyLowerCaseTableNames(config) {
+    const { default: mysql } = await import('mysql2/promise');
+    const connection = await mysql.createConnection({
+        host: config.host,
+        port: config.port,
+        user: config.user,
+        password: config.password,
+        database: config.database,
+        connectTimeout: DB_CONNECTION_TIMEOUT_MS,
+    });
+    try {
+        const [rows] = await connection.query(`SHOW VARIABLES LIKE 'lower_case_table_names'`);
+        if (!Array.isArray(rows)) {
+            return undefined;
+        }
+        for (const row of rows) {
+            if (!row || typeof row !== 'object') {
+                continue;
+            }
+            const value = String(row.Value ?? '').trim();
+            if (value === '0' || value === '1' || value === '2') {
+                return value;
+            }
+        }
+        return undefined;
+    }
+    finally {
+        await Promise.resolve(connection.end()).catch(() => undefined);
+    }
+}
+async function performExternalDbConnectionCheck(config) {
+    try {
+        switch (config.dialect) {
+            case 'postgres':
+            case 'kingbase': {
+                await checkPostgresFamilyConnection(config);
+                return undefined;
+            }
+            case 'mysql':
+            case 'mariadb': {
+                await checkMysqlFamilyConnection(config);
+                return undefined;
+            }
+        }
+    }
+    catch (error) {
+        return formatDbConnectionError(config, error);
+    }
+}
+export async function checkExternalDbConnection(config) {
+    const cacheKey = buildValidationCacheKey(config);
+    const cached = externalDbValidationCache.get(cacheKey);
+    if (cached) {
+        return await cached;
+    }
+    const pending = performExternalDbConnectionCheck(config);
+    externalDbValidationCache.set(cacheKey, pending);
+    return await pending;
+}
+async function readMysqlLowerCaseTableNamesMode(config) {
+    if (config.dialect !== 'mysql' && config.dialect !== 'mariadb') {
+        return undefined;
+    }
+    const cacheKey = buildValidationCacheKey(config);
+    const cached = mysqlLowerCaseTableNamesCache.get(cacheKey);
+    if (cached) {
+        return await cached;
+    }
+    const pending = readMysqlFamilyLowerCaseTableNames(config);
+    mysqlLowerCaseTableNamesCache.set(cacheKey, pending);
+    return await pending;
+}
+export async function validateExternalDbConfig(values) {
+    const config = readExternalDbConnectionConfig(values);
+    if (!config) {
+        return undefined;
+    }
+    return await checkExternalDbConnection(config);
+}
+export async function validateMysqlLowerCaseTableNamesCompatibility(values) {
+    const config = readExternalDbConnectionConfig(values);
+    if (!config || (config.dialect !== 'mysql' && config.dialect !== 'mariadb')) {
+        return undefined;
+    }
+    try {
+        const mode = await readMysqlLowerCaseTableNamesMode(config);
+        if (mode === '1' && values.dbUnderscored !== true) {
+            return translateCli('validators.dbConnection.lowerCaseTableNamesRequiresUnderscored');
+        }
+        return undefined;
+    }
+    catch (error) {
+        return formatDbConnectionError(config, error);
+    }
+}
+export function clearExternalDbValidationCache() {
+    externalDbValidationCache.clear();
+    mysqlLowerCaseTableNamesCache.clear();
+}

package/dist/lib/docker-env-file.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 { access } from 'node:fs/promises';
+import { resolveConfiguredEnvPath } from './cli-home.js';
+import { inferConfiguredAppPathFromLegacyConfig } from './env-paths.js';
+function trimValue(value) {
+    const text = String(value ?? '').trim();
+    return text || undefined;
+}
+function appendDotEnvPath(basePath) {
+    return `${basePath.replace(/[\\/]+$/, '')}/.env`;
+}
+export function defaultDockerEnvFilePath(envName, config) {
+    const appPath = inferConfiguredAppPathFromLegacyConfig(config ?? {});
+    if (appPath) {
+        return appendDotEnvPath(appPath);
+    }
+    return `${envName}/.env`;
+}
+export function resolveConfiguredDockerEnvFilePath(envName, config) {
+    return trimValue(config?.envFile) || defaultDockerEnvFilePath(envName, config);
+}
+export function hasExplicitDockerEnvFile(config) {
+    return Boolean(trimValue(config?.envFile));
+}
+export function resolveDockerEnvFilePath(envName, config) {
+    return resolveConfiguredEnvPath(resolveConfiguredDockerEnvFilePath(envName, config));
+}
+export async function dockerEnvFileExists(envName, config) {
+    const filePath = resolveDockerEnvFilePath(envName, config);
+    if (!filePath) {
+        return false;
+    }
+    try {
+        await access(filePath);
+        return true;
+    }
+    catch (_error) {
+        return false;
+    }
+}
+export async function resolveDockerEnvFileArg(envName, config) {
+    const filePath = resolveDockerEnvFilePath(envName, config);
+    if (!filePath) {
+        return undefined;
+    }
+    if (await dockerEnvFileExists(envName, config)) {
+        return filePath;
+    }
+    if (hasExplicitDockerEnvFile(config)) {
+        throw new Error(`The configured envFile for "${envName}" does not exist: ${resolveConfiguredDockerEnvFilePath(envName, config)}`);
+    }
+    return undefined;
+}

package/dist/lib/docker-image.js

@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+export const DEFAULT_DOCKER_REGISTRY = 'nocobase/nocobase';
+export const DEFAULT_DOCKER_REGISTRY_ZH_CN = 'registry.cn-shanghai.aliyuncs.com/nocobase/nocobase';
+export const DEFAULT_DOCKER_VERSION = 'alpha';
+export const DOCKER_IMAGE_FULL_SUFFIX = '-full';
+const OFFICIAL_FULL_IMAGE_REGISTRIES = new Set([
+    DEFAULT_DOCKER_REGISTRY,
+    DEFAULT_DOCKER_REGISTRY_ZH_CN,
+]);
+function trimValue(value) {
+    return String(value ?? '').trim();
+}
+export function shouldUseFullDockerImageTag(registry) {
+    return OFFICIAL_FULL_IMAGE_REGISTRIES.has(trimValue(registry));
+}
+export function normalizeDockerImageTag(registry, version) {
+    const tag = trimValue(version) || DEFAULT_DOCKER_VERSION;
+    if (!shouldUseFullDockerImageTag(registry)) {
+        return tag;
+    }
+    return tag.endsWith(DOCKER_IMAGE_FULL_SUFFIX)
+        ? tag
+        : `${tag}${DOCKER_IMAGE_FULL_SUFFIX}`;
+}
+export function resolveDockerImageRef(registry, version, options) {
+    const resolvedRegistry = trimValue(registry) || options?.defaultRegistry || DEFAULT_DOCKER_REGISTRY;
+    const rawVersion = trimValue(version) || options?.defaultVersion || DEFAULT_DOCKER_VERSION;
+    const normalizedTag = normalizeDockerImageTag(resolvedRegistry, rawVersion);
+    return `${resolvedRegistry}:${normalizedTag}`;
+}

package/dist/lib/docker-log-stream.js

@@ -0,0 +1,45 @@
+/**
+ * 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 { spawn } from 'node:child_process';
+const DEFAULT_DOCKER_LOG_TAIL = 50;
+export function startDockerLogFollower(containerName, options) {
+    const tail = Math.max(0, options?.tail ?? DEFAULT_DOCKER_LOG_TAIL);
+    const child = spawn('docker', ['logs', '--tail', String(tail), '--follow', containerName], {
+        stdio: 'inherit',
+    });
+    let settled = false;
+    let resolveClosed;
+    const closed = new Promise((resolve) => {
+        resolveClosed = resolve;
+    });
+    const settle = () => {
+        if (!settled) {
+            settled = true;
+            resolveClosed();
+        }
+    };
+    child.once('error', settle);
+    child.once('close', settle);
+    return {
+        stop: async () => {
+            if (settled) {
+                return;
+            }
+            try {
+                if (!child.kill()) {
+                    settle();
+                }
+            }
+            catch {
+                settle();
+            }
+            await closed;
+        },
+    };
+}