@cloudbase/manager-node 5.7.0-beta.2 → 5.7.0

package/lib/projectValidator/index.js

@@ -1,479 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectValidator = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const toolbox_1 = require("@cloudbase/toolbox");
-class ProjectValidator {
-    async validate(options = {}) {
-        var _a;
-        const cwd = path_1.default.resolve(options.cwd || process.cwd());
-        const errors = [];
-        const warnings = [];
-        const loaded = await this.loadProjectConfig(cwd, {
-            configPath: options.configPath,
-            mode: options.mode,
-            errors,
-        });
-        const version = String(((_a = loaded.rawConfig) === null || _a === void 0 ? void 0 : _a.version) || '2.1');
-        if (loaded.rawConfig) {
-            this.validateSchema(loaded.rawConfig, errors);
-        }
-        if (loaded.config) {
-            this.validateEnvId(cwd, { raw: loaded.rawConfig || {}, resolved: loaded.config }, errors);
-            this.validatePersonalRegistryConfig(loaded.config, errors);
-            const resourceIssues = this.validateResources(cwd, loaded.config);
-            errors.push(...resourceIssues.errors);
-            warnings.push(...resourceIssues.warnings);
-            this.validateConsistency(loaded.config, errors, warnings);
-        }
-        const summary = this.getSummary(loaded.config);
-        return {
-            valid: errors.length === 0,
-            version,
-            errors,
-            warnings,
-            summary,
-        };
-    }
-    async loadProjectConfig(cwd, options) {
-        const { configPath, mode, errors } = options;
-        let filepath = configPath ? path_1.default.resolve(cwd, configPath) : undefined;
-        try {
-            if (!filepath) {
-                const result = await (0, toolbox_1.searchConfig)(cwd);
-                filepath = result === null || result === void 0 ? void 0 : result.filepath;
-            }
-            if (!filepath) {
-                errors.push({
-                    level: 'error',
-                    field: 'cloudbaserc',
-                    message: '未找到 cloudbaserc 配置文件',
-                    fix: '在项目根目录新增 cloudbaserc.json / cloudbaserc.js / cloudbaserc.yaml / cloudbaserc.yml',
-                });
-                return {};
-            }
-            const rawConfig = (await (0, toolbox_1.loadConfig)({ configPath: filepath }));
-            const config = (await toolbox_1.ConfigParser.parseRawConfig(rawConfig || {}, cwd, {
-                mode,
-            }));
-            return {
-                filepath,
-                rawConfig,
-                config,
-            };
-        }
-        catch (e) {
-            errors.push({
-                level: 'error',
-                field: 'cloudbaserc',
-                message: `配置文件解析失败：${this.getErrorMessage(e)}`,
-                fix: '检查 cloudbaserc 配置文件语法是否正确',
-            });
-            return { filepath };
-        }
-    }
-    validateSchema(config, errors) {
-        const result = (0, toolbox_1.validateCloudBaseConfigBySchema)(config, { version: '2.1' });
-        result.errors.forEach((error) => {
-            errors.push({
-                level: 'error',
-                field: this.normalizeSchemaPath(error.dataPath),
-                message: `配置不符合 v2.1 Schema：${error.message}`,
-                fix: `请检查 ${this.normalizeSchemaPath(error.dataPath) || 'cloudbaserc'} 字段`,
-            });
-        });
-    }
-    validateEnvId(cwd, config, errors) {
-        if (this.hasPersonalCloudFunction(config.resolved)) {
-            if (typeof config.raw.envId !== 'string' || !config.raw.envId.trim()) {
-                errors.push({
-                    level: 'error',
-                    field: 'envId',
-                    message: '个人版 TCR 云端构建必须在 cloudbaserc 中显式声明 envId',
-                    fix: '声明 envId: "{{env.ENV_ID}}"，并在 .env* 中设置 ENV_ID',
-                });
-                return;
-            }
-            if (typeof config.resolved.envId !== 'string' || !config.resolved.envId.trim()) {
-                errors.push({
-                    level: 'error',
-                    field: 'envId',
-                    message: '个人版 TCR 云端构建的 envId 未赋值',
-                    fix: '在 .env* 中设置 cloudbaserc 通过 {{env.ENV_ID}} 引用的 ENV_ID',
-                });
-            }
-            return;
-        }
-        if (config.resolved.envId || this.getLinkedEnvId(cwd)) {
-            return;
-        }
-        errors.push({
-            level: 'error',
-            field: 'envId',
-            message: '缺少 envId，且未检测到 .tcb/project.json 关联环境',
-            fix: '在 cloudbaserc 中配置 envId，或先执行环境关联流程',
-        });
-    }
-    /**
-     * 个人版 TCR 的 username/password/namespace 必须在 cloudbaserc 中显式声明。
-     * ConfigParser 已先解析 {{env.*}}，因此这里同时承担缺失 env 值的前置校验。
-     */
-    validatePersonalRegistryConfig(config, errors) {
-        ;
-        (config.functions || []).forEach((func, index) => {
-            var _a;
-            if (!this.isPersonalCloudFunction(func)) {
-                return;
-            }
-            const build = (_a = func.imageConfig) === null || _a === void 0 ? void 0 : _a.build;
-            const namespace = build === null || build === void 0 ? void 0 : build.namespace;
-            if (typeof namespace !== 'string' || !namespace.trim()) {
-                errors.push({
-                    level: 'error',
-                    resource: `functions[${index}]`,
-                    field: 'imageConfig.build.namespace',
-                    message: '个人版 TCR 缺少 namespace，或对应环境变量未赋值',
-                    fix: '声明 namespace: "{{env.TCB_TCR_NAMESPACE}}"，并在 .env* 中设置该变量',
-                });
-            }
-            const credential = build === null || build === void 0 ? void 0 : build.registryCredential;
-            if (!credential || typeof credential !== 'object') {
-                errors.push({
-                    level: 'error',
-                    resource: `functions[${index}]`,
-                    field: 'imageConfig.build.registryCredential',
-                    message: '个人版 TCR 缺少 username/password 凭证声明',
-                    fix: '在 registryCredential 中使用 {{env.TCB_TCR_USERNAME}} 与 {{env.TCB_TCR_PASSWORD}}',
-                });
-                return;
-            }
-            const { username, password } = credential;
-            if (typeof username !== 'string' || !/^\d{5,20}$/.test(username.trim())) {
-                errors.push({
-                    level: 'error',
-                    resource: `functions[${index}]`,
-                    field: 'imageConfig.build.registryCredential.username',
-                    message: '个人版 TCR username 未赋值或不是有效腾讯云账号 ID',
-                    fix: '声明 username: "{{env.TCB_TCR_USERNAME}}"，并在 .env* 中设置该变量',
-                });
-            }
-            if (typeof password !== 'string' || !password || password.length > 16 * 1024) {
-                errors.push({
-                    level: 'error',
-                    resource: `functions[${index}]`,
-                    field: 'imageConfig.build.registryCredential.password',
-                    message: '个人版 TCR password 未赋值或长度不合法',
-                    fix: '声明 password: "{{env.TCB_TCR_PASSWORD}}"，并在 .env* 中设置该变量',
-                });
-            }
-        });
-    }
-    hasPersonalCloudFunction(config) {
-        return (config.functions || []).some((func) => this.isPersonalCloudFunction(func));
-    }
-    isPersonalCloudFunction(func) {
-        var _a;
-        return (func.type === 'HTTP' &&
-            func.buildStrategy === 'cloud' &&
-            ((_a = func.imageConfig) === null || _a === void 0 ? void 0 : _a.imageType) === 'personal');
-    }
-    validateResources(cwd, config) {
-        const errors = [];
-        const warnings = [];
-        const functionRoot = config.functionRoot || './functions';
-        (config.functions || []).forEach((func, index) => {
-            const resource = `functions[${index}]`;
-            const functionDir = path_1.default.resolve(cwd, func.dir || path_1.default.join(functionRoot, func.name));
-            if (!fs_1.default.existsSync(functionDir)) {
-                errors.push({
-                    level: 'error',
-                    resource,
-                    field: 'dir',
-                    message: `函数目录不存在：${path_1.default.relative(cwd, functionDir)}`,
-                    fix: '创建函数目录，或修正 functions[].dir / functionRoot 配置',
-                });
-                return;
-            }
-            const functionType = func.type || 'Event';
-            const buildStrategy = func.buildStrategy || 'zip';
-            if (functionType === 'HTTP' && buildStrategy === 'zip') {
-                const bootstrapPath = path_1.default.join(functionDir, 'scf_bootstrap');
-                if (!fs_1.default.existsSync(bootstrapPath)) {
-                    errors.push({
-                        level: 'error',
-                        resource,
-                        field: 'scf_bootstrap',
-                        message: '缺少 scf_bootstrap 文件（HTTP 函数 zip 部署必须）',
-                        fix: '在函数目录中新增 scf_bootstrap，并确保其具备执行权限',
-                    });
-                }
-            }
-            if (functionType === 'Event') {
-                const handlerFile = `${(func.handler || 'index.main').split('.')[0]}.js`;
-                if (!fs_1.default.existsSync(path_1.default.join(functionDir, handlerFile))) {
-                    warnings.push({
-                        level: 'warning',
-                        resource,
-                        field: 'handler',
-                        message: `未找到入口文件 ${handlerFile}`,
-                        fix: '确认 handler 配置与函数入口文件一致',
-                    });
-                }
-            }
-        });
-        (config.hosting || []).forEach((hosting, index) => {
-            const root = path_1.default.resolve(cwd, hosting.root || '.');
-            if (!fs_1.default.existsSync(root)) {
-                errors.push({
-                    level: 'error',
-                    resource: `hosting[${index}]`,
-                    field: 'root',
-                    message: `静态托管根目录不存在：${path_1.default.relative(cwd, root)}`,
-                    fix: '创建目录，或修正 hosting[].root 配置',
-                });
-            }
-        });
-        if (config.database) {
-            const migrations = config.database.migrations || './cloudbase/migrations';
-            if (path_1.default.isAbsolute(migrations) || migrations.startsWith('/')) {
-                errors.push({
-                    level: 'error',
-                    resource: 'database',
-                    field: 'migrations',
-                    message: 'database.migrations 仅支持相对路径',
-                    fix: '请使用相对路径，例如 ./cloudbase/migrations',
-                });
-            }
-            else {
-                const migrationsDir = path_1.default.resolve(cwd, migrations);
-                if (!fs_1.default.existsSync(migrationsDir)) {
-                    errors.push({
-                        level: 'error',
-                        resource: 'database',
-                        field: 'migrations',
-                        message: `数据库迁移目录不存在：${path_1.default.relative(cwd, migrationsDir)}`,
-                        fix: '创建迁移目录，或修正 database.migrations 配置',
-                    });
-                }
-            }
-        }
-        return { errors, warnings };
-    }
-    validateConsistency(config, errors, warnings = []) {
-        this.validateUniqueNames('functions', config.functions || [], errors);
-        this.validateUniqueNames('hosting', config.hosting || [], errors);
-        this.validateUniqueField('hosting', config.hosting || [], { field: 'deployPath', errors });
-        this.validateGatewayTargets(config, errors);
-        this.validateGatewayPathRewriteConflicts(config, warnings);
-        this.validateHostingSubPathBaseRisks(config, warnings);
-        this.validateSpaFallbackPrefixIsolation(config, warnings);
-    }
-    /**
-     * 检测 hosting 路由中 enablePathTransmission=true 与自动生成 pathRewrite 的冲突
-     *
-     * hosting 目标未显式配置 pathRewrite 时，部署会自动生成 PathRewrite.Prefix = hosting.deployPath。
-     * 若同时显式开启 enablePathTransmission=true，路径透传会覆盖路径重写，导致请求打到错误的托管路径（404）。
-     */
-    validateGatewayPathRewriteConflicts(config, warnings) {
-        var _a;
-        const hostingMap = new Map((config.hosting || []).map((h) => [h.name, h]));
-        (((_a = config.gateway) === null || _a === void 0 ? void 0 : _a.routes) || []).forEach((route, index) => {
-            var _a, _b, _c;
-            if (!((_a = route.target) === null || _a === void 0 ? void 0 : _a.startsWith('hosting:')))
-                return;
-            // 用户显式配置了 pathRewrite → 无自动重写，无冲突
-            if (((_b = route.pathRewrite) === null || _b === void 0 ? void 0 : _b.prefix) || ((_c = route.pathRewrite) === null || _c === void 0 ? void 0 : _c.staticStorePrefix))
-                return;
-            // 未显式开启透传 → 无冲突
-            if (route.enablePathTransmission !== true)
-                return;
-            const hostingName = route.target.slice('hosting:'.length);
-            const hosting = hostingMap.get(hostingName);
-            // hosting 无 deployPath → 不会自动生成 PathRewrite，不冲突
-            if (!(hosting === null || hosting === void 0 ? void 0 : hosting.deployPath))
-                return;
-            warnings.push({
-                level: 'warning',
-                resource: `gateway.routes[${index}]`,
-                field: 'enablePathTransmission',
-                message: `hosting 路由 ${route.target} 未显式配置 pathRewrite，部署将自动生成 ` +
-                    `PathRewrite.Prefix=${hosting.deployPath}，但 enablePathTransmission=true 会覆盖路径重写，` +
-                    `导致请求打不到托管实际部署路径`,
-                fix: '删除 enablePathTransmission，让自动生成的 pathRewrite 生效；' +
-                    '或显式配置 pathRewrite.prefix 指向托管部署路径',
-            });
-        });
-    }
-    /**
-     * 子路径部署（deployPath !== '/'）下，前端构建产物若仍使用根路径 base（如 Vite 默认 '/'），
-     * 会导致资源请求落到 /assets/* 而非 /{deployPath}/assets/*，出现 404/白屏。
-     *
-     * 这里在“可能存在构建步骤”的 hosting 配置上给出防坑告警。
-     */
-    validateHostingSubPathBaseRisks(config, warnings) {
-        ;
-        (config.hosting || []).forEach((hosting, index) => {
-            const deployPath = typeof hosting.deployPath === 'string' ? hosting.deployPath.trim() : '';
-            if (!deployPath || deployPath === '/')
-                return;
-            const framework = typeof hosting.framework === 'string' ? hosting.framework.trim().toLowerCase() : '';
-            const hasBuildStep = (typeof hosting.buildCommand === 'string' && hosting.buildCommand.trim().length > 0) ||
-                (!!framework && framework !== 'static' && framework !== 'custom');
-            if (!hasBuildStep)
-                return;
-            warnings.push({
-                level: 'warning',
-                resource: `hosting[${index}]`,
-                field: 'deployPath',
-                message: `静态托管部署在子路径 ${deployPath}，请确认前端构建 base 与子路径匹配，` +
-                    `否则资源可能请求到根路径（如 /assets/*）导致 404/白屏`,
-                fix: "建议将前端 base 配置为 './' 或与 deployPath 对齐（例如 '/serviceName/'）",
-            });
-        });
-    }
-    /**
-     * spaFallback 为站点级回退能力，不是按网关前缀独立生效。
-     * 同一 hosting 在 spaFallback=true 下被多个网关前缀复用时，容易出现不同前缀回退串扰。
-     */
-    validateSpaFallbackPrefixIsolation(config, warnings) {
-        var _a;
-        const routePathsByHosting = new Map();
-        (((_a = config.gateway) === null || _a === void 0 ? void 0 : _a.routes) || []).forEach((route) => {
-            var _a;
-            if (!((_a = route.target) === null || _a === void 0 ? void 0 : _a.startsWith('hosting:')))
-                return;
-            const hostingName = route.target.slice('hosting:'.length);
-            const pathValue = typeof route.path === 'string' ? route.path.trim() : '';
-            if (!pathValue)
-                return;
-            if (!routePathsByHosting.has(hostingName)) {
-                routePathsByHosting.set(hostingName, new Set());
-            }
-            routePathsByHosting.get(hostingName).add(pathValue);
-        });
-        (config.hosting || []).forEach((hosting, index) => {
-            if (hosting.spaFallback !== true)
-                return;
-            if (!hosting.name)
-                return;
-            const routePaths = [...(routePathsByHosting.get(hosting.name) || new Set())];
-            if (routePaths.length <= 1)
-                return;
-            warnings.push({
-                level: 'warning',
-                resource: `hosting[${index}]`,
-                field: 'spaFallback',
-                message: `hosting:${hosting.name} 在 spaFallback=true 下被多个网关前缀复用（${routePaths.join(', ')}），` +
-                    '可能出现前缀间 404 回退串扰',
-                fix: '建议将不同前缀拆分为独立 hosting 服务，或为每个前缀显式配置独立回退策略',
-            });
-        });
-    }
-    validateUniqueNames(resource, items, errors) {
-        const names = new Map();
-        items.forEach((item, index) => {
-            if (!item.name)
-                return;
-            const prev = names.get(item.name);
-            if (typeof prev === 'number') {
-                errors.push({
-                    level: 'error',
-                    resource: `${resource}[${index}]`,
-                    field: 'name',
-                    message: `${resource} 名称重复：${item.name}`,
-                    fix: `修改 ${resource}[${index}].name，避免与 ${resource}[${prev}].name 重复`,
-                });
-            }
-            else {
-                names.set(item.name, index);
-            }
-        });
-    }
-    validateUniqueField(resource, items, options) {
-        const { field, errors } = options;
-        const values = new Map();
-        items.forEach((item, index) => {
-            const value = item[field];
-            if (!value)
-                return;
-            const prev = values.get(value);
-            if (typeof prev === 'number') {
-                errors.push({
-                    level: 'error',
-                    resource: `${resource}[${index}]`,
-                    field,
-                    message: `${resource}.${field} 配置重复：${value}`,
-                    fix: `修改 ${resource}[${index}].${field}，避免与 ${resource}[${prev}].${field} 重复`,
-                });
-            }
-            else {
-                values.set(value, index);
-            }
-        });
-    }
-    validateGatewayTargets(config, errors) {
-        var _a;
-        const functionNames = new Set((config.functions || []).map((item) => item.name));
-        const hostingNames = new Set((config.hosting || []).map((item) => item.name));
-        (((_a = config.gateway) === null || _a === void 0 ? void 0 : _a.routes) || []).forEach((route, index) => {
-            const [type, name] = route.target.split(':');
-            if ((type === 'function' && !functionNames.has(name)) || (type === 'hosting' && !hostingNames.has(name))) {
-                errors.push({
-                    level: 'error',
-                    resource: `gateway.routes[${index}]`,
-                    field: 'target',
-                    message: `网关目标不存在：${route.target}`,
-                    fix: '确认 gateway.routes[].target 引用了已声明的 function 或 hosting 资源',
-                });
-            }
-        });
-    }
-    getSummary(config) {
-        var _a, _b, _c, _d;
-        return {
-            functions: ((_a = config === null || config === void 0 ? void 0 : config.functions) === null || _a === void 0 ? void 0 : _a.length) || 0,
-            hosting: ((_b = config === null || config === void 0 ? void 0 : config.hosting) === null || _b === void 0 ? void 0 : _b.length) || 0,
-            databases: (config === null || config === void 0 ? void 0 : config.database) ? 1 : 0,
-            gateways: ((_d = (_c = config === null || config === void 0 ? void 0 : config.gateway) === null || _c === void 0 ? void 0 : _c.routes) === null || _d === void 0 ? void 0 : _d.length) || 0,
-        };
-    }
-    getLinkedEnvId(cwd) {
-        const projectPath = path_1.default.join(cwd, '.tcb', 'project.json');
-        if (!fs_1.default.existsSync(projectPath)) {
-            return '';
-        }
-        try {
-            const project = JSON.parse(fs_1.default.readFileSync(projectPath, 'utf8'));
-            return project.envId || project.EnvId || '';
-        }
-        catch (e) {
-            return '';
-        }
-    }
-    normalizeSchemaPath(dataPath) {
-        return dataPath.replace(/^\//, '').replace(/\//g, '.');
-    }
-    getErrorMessage(error) {
-        return (error === null || error === void 0 ? void 0 : error.message) || String(error);
-    }
-}
-exports.ProjectValidator = ProjectValidator;
-__exportStar(require("./types"), exports);

package/lib/projectValidator/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/types/deploy/DatabaseDeployer.d.ts

@@ -1,70 +0,0 @@
-import { Environment } from '../environment';
-import { IPGUserMigrationInput } from '../database/type';
-/** 数据库迁移部署配置（对应 cloudbaserc.json 中的 database 块） */
-export interface IDatabaseDeployConfig {
-    /** 数据库类型（v2.1 schema: 目前仅支持 postgresql） */
-    type: 'postgresql';
-    /** migration SQL 文件目录（相对项目根） */
-    migrations?: string;
-}
-/** Plan 中单条 migration 的状态 */
-export interface IDatabasePlanItem {
-    /** 14位数字时间串 */
-    version: string;
-    /** migration 名称 */
-    name: string;
-    /** pending=待执行；applied=已应用；conflict=冲突 */
-    status: 'pending' | 'applied' | 'conflict';
-    /** 冲突原因（仅 conflict 时有值） */
-    reason?: string;
-}
-/** deploy 返回结果 */
-export interface IDatabaseDeployResult {
-    /** 异步任务 ID（无pending时为空字符串） */
-    taskId: string;
-}
-export declare class DatabaseDeployer {
-    private environment;
-    constructor(environment: Environment);
-    /**
-     * 从本地目录解析 migration 文件列表
-     *
-     * 文件名格式：{14位时间戳}_{小写下划线名称}.sql
-     * 例如：20260526000000_create_users.sql
-     *
-     * 按文件名升序排列（即按版本号从早到晚）
-     */
-    parseMigrationFiles(migrationsDir: string): IPGUserMigrationInput[];
-    /**
-     * 生成部署计划
-     *
-     * 调用 previewPGUserMigrations 获取云端对比结果，
-     * 返回每条migration 的状态（pending / applied / conflict）
-     */
-    plan(config: IDatabaseDeployConfig, cwd: string, envId: string): Promise<IDatabasePlanItem[]>;
-    /**
-     * 执行数据库迁移
-     *
-     * 流程：
-     * 1. 解析本地 migration 文件
-     * 2. 预览确认无冲突（有冲突直接 throw，中断整个部署）
-     * 3. 无 pending 则跳过
-     * 4. 提交 pushPGUserMigrations
-     * 5. 轮询describeTaskResult 等待完成
-     */
-    deploy(config: IDatabaseDeployConfig, cwd: string, envId: string): Promise<IDatabaseDeployResult>;
-    /**
-     * 解析 migrations 目录路径
-     * - 未配置：默认 ./cloudbase/migrations
-     * - 仅允许相对路径（禁止 / 开头）
-     */
-    private resolveMigrationsDir;
-    /**
-     * 校验 database.type（当前仅支持 postgresql）
-     */
-    private assertDatabaseType;
-    /**
-     * 轮询等待异步任务完成
-     */
-    private waitForTask;
-}