@cloudbase/cli 2.11.6 → 2.11.7

package/bin/tcb.js

@@ -0,0 +1,339 @@
+#!/usr/bin/env node
+const yargsParser = require('yargs-parser')
+const chalk = require('chalk')
+const { program } = require('commander')
+const logSymbols = require('log-symbols')
+const didYouMean = require('didyoumean')
+const updateNotifier = require('update-notifier')
+const frameworkPkg = require('@cloudbase/framework-core/package.json')
+let wedaPkg = {}
+try {
+    wedaPkg = require('@cloudbase/lowcode-cli/package.json') || {}
+} catch (e) {
+    wedaPkg = { version: '' }
+}
+const { CloudApiService } = require('@cloudbase/cloud-api')
+const { getCredentialWithoutCheck } = require('@cloudbase/toolbox')
+const { Confirm } = require('enquirer')
+const execa = require('execa')
+const semver = require('semver')
+
+const pkg = require('../package.json')
+const { ALL_COMMANDS } = require('../lib/constant')
+const { getProxy } = require('../lib/utils/net')
+const { getCloudBaseConfig, getPrivateSettings } = require('../lib/utils/config')
+const { registerCommands } = require('../lib')
+const { beaconAction } = require('../lib/utils/report')
+const { t } = require('../lib/i18n')
+
+const regionSupported = ['ap-shanghai', 'ap-beijing', 'ap-guangzhou', 'ap-singapore']
+const regionSupportedMap = {
+    'ap-shanghai': t('上海'),
+    'ap-beijing': t('北京'),
+    'ap-guangzhou': t('广州'),
+    'ap-singapore': t('新加坡'),
+    sh: t('上海'),
+    bj: t('北京'),
+    gz: t('广州'),
+    sg: t('新加坡')
+}
+
+async function main() {
+    let processArgv = process.argv
+    const isBeta = pkg.version.indexOf('-') > -1
+    process.CLI_VERSION = pkg.version
+
+    const currentMajorVersion = +semver.major(process.version)
+
+    // 定义最小版本和推荐版本
+    const NODE_MIN_VERSION = 18
+
+    // 检查当前版本是否满足最小版本要求
+    if (NODE_MIN_VERSION > currentMajorVersion) {
+        console.error(
+            chalk.bold.red(
+                t('当前 Node.js 版本为 v{{current}}。请升级到至少 v{{min}} 版本。', { 
+                    current: currentMajorVersion, 
+                    min: NODE_MIN_VERSION 
+                })
+            )
+        )
+        process.exit(1)
+    }
+    
+
+    // 输出版本信息
+    console.log(chalk.gray(`CloudBase CLI ${pkg.version}`))
+    console.log(chalk.gray(t('试试 tcb ai 命令，开启 AI 原生开发')))
+
+    const yargsParsedResult = yargsParser(process.argv.slice(2))
+    const config = await getCloudBaseConfig(yargsParsedResult.configFile)
+    const privateSettings = getPrivateSettings(config)
+    if (privateSettings) {
+        console.log(chalk.gray(t('检测到私有化配置')))
+        if (privateSettings.endpoints && privateSettings.endpoints.cliApi) {
+            // 初始化 lowcode 服务cliapi入口
+            process.env.CLOUDBASE_LOWCODE_CLOUDAPI_URL = privateSettings.endpoints.cliApi
+        }
+    }
+    // 注册命令
+    await registerCommands()
+
+    // 设置 options 选项
+    program.storeOptionsAsProperties(false)
+    program.option('--verbose', t('打印出内部运行信息'))
+    program.option('--mode <mode>', t('指定加载 env 文件的环境'))
+    program.option('--config-file <path>', t('设置配置文件，默认为 cloudbaserc.json'))
+    program.option('-r, --region <region>', t('指定环境地域'))
+
+    if (!privateSettings) {
+        // HACK: 隐藏自动生成的 help 信息
+        program.helpOption(false)
+    }
+    const isCommandEmpty = yargsParsedResult._.length === 0
+
+    // -v 时输出的版本信息，设置时避免影响其他命令使用 -v
+    if (isCommandEmpty) {
+        program.version(
+            `\nCLI: ${pkg.version}`,
+            '-v, --version',
+            t('输出当前 CloudBase CLI 版本')
+        )
+    }
+
+    // 处理无效命令
+    program.action(() => {
+        const args = program.args
+        if (!Array.isArray(args) || !args.length) {
+            return
+        }
+        const cmd = args.join(' ')
+        console.log(chalk.bold.red('Error: ') + t('{{cmd}} 不是有效的命令', { cmd }))
+        didYouMean.threshold = 0.5
+        didYouMean.caseSensitive = false
+        const suggest = didYouMean(cmd, ALL_COMMANDS)
+        if (suggest) {
+            console.log(chalk.bold(t('\n您是不是想使用命令：tcb {{suggest}}\n', { suggest })))
+        }
+        console.log(t('💡使用 {{helpCmd}} 查看所有命令', { helpCmd: chalk.bold('tcb -h') }))
+    })
+
+    // 没有使用命令
+    if (isCommandEmpty) {
+        if (privateSettings) {
+            program.outputHelp()
+        } else {
+            if (['-h', '--help'].includes(processArgv[2])) {
+                // 需要隐藏的选项
+                const hideArgs = ['-h', '--help']
+                hideArgs.forEach((arg) => {
+                    const index = processArgv.indexOf(arg)
+                    if (index > -1) {
+                        processArgv.splice(index, 1)
+                    }
+                })
+                const { outputHelpInfo } = require('../lib/help')
+                outputHelpInfo()
+            } else if (!['-v', '--version'].includes(processArgv[2])) {
+                // HACK: framework 智能命令
+                const { smartDeploy } = require('../lib')
+                smartDeploy()
+            }
+        }
+    }
+
+    try {
+        program.parse(processArgv)
+    } catch (e) {
+        const errMsg = `${logSymbols.error} ${
+            e.message || t('参数异常，请检查您是否使用了正确的命令！')
+        }`
+        console.log(errMsg)
+    }
+
+    /**
+     * 处理异常
+     */
+    async function errorHandler(err) {
+        try {
+            await beaconAction.report('tcb_cli_error', {
+                name: err.name,
+                message: err.message,
+                stack: err.stack,
+                requestId: err.requestId,
+                canIgnore: 'false'
+            })
+        } catch (error) {
+            // 静默处理上报错误，不影响主程序运行
+        }
+        process.emit('tcbError')
+        const stackIngoreErrors = ['TencentCloudSDKHttpException', 'CloudBaseError']
+        // 忽略自定义错误的错误栈
+        if (err && err.stack && !stackIngoreErrors.includes(err.name)) {
+            console.log(err.stack)
+        }
+
+        // 3 空格，兼容中文字符编码长度问题
+        if (err && err.message) {
+            let errMsg = logSymbols.error + ' ' + err.message
+            errMsg += err.requestId ? `\n${err.requestId}` : ''
+            console.log(errMsg)
+
+            // 多地域错误提示
+            if (errMsg.includes('Environment') && errMsg.includes('not found')) {
+                // 检查是否已经指定了 -r 或 --region 参数，如未指定则尝试获取地域信息
+                const regionSpecified =
+                    processArgv.indexOf('-r') !== -1 || processArgv.indexOf('--region') !== -1
+                const region = yargsParsedResult.r || yargsParsedResult.region
+                const multiRegionErrMsg = t('\n此环境可能不属于当前账号，或为非{{region}}地域环境，如需切换地域请追加参数（例：-r gz），请检查环境归属，参考多地域使用方法：{{url}}', { 
+                    region: regionSupportedMap[region] || t('上海'), 
+                    url: 'https://docs.cloudbase.net/cli-v1/region.html' 
+                })
+                if (!regionSpecified) {
+                    // 从 -e 参数、--envId 参数和配置文件中获取环境 id
+                    const envId = yargsParsedResult.e || yargsParsedResult.envId || config.envId
+
+                    // 调用 API 接口尝试查询环境信息
+                    const predictRegion = await tryTellEnvRegion(envId)
+
+                    if (regionSupported.includes(predictRegion)) {
+                        // 让用户选择是否切换地域
+                        const prompt = new Confirm({
+                            type: 'confirm',
+                            name: 'confirm',
+                            message: t('该环境可能属于 {{region}} 地域，是否切换地域并重新执行命令？', { region: regionSupportedMap[predictRegion] }),
+                            initial: 'Y'
+                        })
+                        const confirm = await prompt.run()
+                        if (confirm) {
+                            // 检查原始命令是否已经追加了 -r 参数，如果有则替换，如果没有则追加
+                            const regionArgIndex = processArgv.indexOf('-r')
+                            if (regionArgIndex !== -1) {
+                                processArgv[regionArgIndex + 1] = predictRegion
+                            } else {
+                                processArgv.push('-r', predictRegion)
+                            }
+                            // 重新执行命令
+                            const newArgvStr = processArgv.slice(2).join(' ')
+                            console.log(
+                                `\n${chalk.yellow.bold(t('正在重新执行命令：'))} tcb ${newArgvStr}\n`
+                            )
+                            await execa('tcb', processArgv.slice(2), {
+                                stdio: 'inherit'
+                            })
+                            process.emit('tcbExit')
+                            process.exit(0)
+                        } else {
+                            console.log(chalk.yellow.bold(multiRegionErrMsg))
+                        }
+                    }
+                } else {
+                    console.log(chalk.yellow.bold(multiRegionErrMsg))
+                }
+            }
+        }
+
+        // 输出详细的错误信息
+        if (processArgv.includes('--verbose')) {
+            console.log(err)
+        }
+
+        process.emit('tcbExit')
+        setTimeout(() => {
+            process.exit(1)
+        }, 1000)
+    }
+
+    const isTokenExpired = (credential, gap = 120) =>
+        credential.accessTokenExpired &&
+        Number(credential.accessTokenExpired) < Date.now() + gap * 1000
+
+    async function tryTellEnvRegion(envId) {
+        // 依次调用不同地域的 API 接口查询环境信息
+        const fetchedRegion = await Promise.all(
+            regionSupported.map(async (region) => {
+                const { EnvList = [] } = await fetchEnvInfoWithRegion(envId, region)
+                if (EnvList.length !== 0 && EnvList.find((item) => item.EnvId === envId)) {
+                    return res.EnvList[0].Region
+                }
+                return ''
+            })
+        )
+
+        let predictRegion = ''
+        fetchedRegion.forEach((region) => {
+            if (region) {
+                predictRegion = region
+            }
+        })
+        return predictRegion
+    }
+
+    // 在指定地域调用 API 接口查询环境信息
+    async function fetchEnvInfoWithRegion(envId, region) {
+        let commonCredential = {}
+        const commonOpts = {
+            service: 'tcb',
+            version: '2019-09-24',
+            proxy: getProxy(),
+            timeout: 15000,
+            getCredential: async () => {
+                if (commonCredential.secretId && !isTokenExpired(commonCredential)) {
+                    return commonCredential
+                }
+                const credential = await getCredentialWithoutCheck()
+                if (!credential) {
+                    throw new Error(t('无有效身份信息，请使用 cloudbase login 登录'))
+                }
+                commonCredential = credential
+                return {
+                    ...credential,
+                    tokenExpired: Number(credential.accessTokenExpired)
+                }
+            }
+        }
+        const apiName = 'DescribeEnvs'
+        const tcbApi = new CloudApiService({
+            ...commonOpts,
+            region
+        })
+        const res = await tcbApi.request(apiName, {
+            EnvId: envId
+        })
+        return res
+    }
+
+    process.on('uncaughtException', errorHandler)
+    process.on('unhandledRejection', errorHandler)
+
+    // 检查更新
+    const ONE_DAY = 86400000
+    // Beta 版 1 个小时检查一次，稳定版 1 天检查一次
+    const CheckInterval = isBeta ? 3600000 : ONE_DAY
+
+    const notifier = updateNotifier({
+        pkg,
+        distTag: isBeta ? 'beta' : 'latest',
+        // 检查更新间隔 1 天
+        updateCheckInterval: CheckInterval
+    })
+
+    if (notifier.update) {
+        console.log(`\n${t('发现新版本：')} ` + notifier.update.latest)
+        console.log(`${t('当前版本：')} ` + notifier.update.current)
+        console.log(`${t('请参考升级文档：')} https://docs.cloudbase.net/cli-v1/install\n`)
+    }
+}
+
+if (require.main === module) {
+    try {
+        main()
+    } catch (error) {
+        console.log(error)
+    }
+}
+process.on('unhandledRejection', (err) => {
+    console.log('unhandledRejection', err)
+})
+
+exports.main = main

package/changelog.md

@@ -0,0 +1,6 @@
+# V1.0
+
+## 不兼容变更
+
+- 废弃编程式调用
+- 

package/cloudbaserc.json

@@ -0,0 +1,13 @@
+{
+  "envId": "{{env.ENV_ID}}",
+  "functionRoot": "./functions",
+  "functions": [],
+  "ai": {
+    "defaultAgent": "{{env.AI_DEFAULT_AGENT}}",
+    "agents": {
+      "codebuddy": {
+        "type": "none"
+      }
+    }
+  }
+}

package/jest.config.js

@@ -0,0 +1,17 @@
+module.exports = {
+    roots: ['<rootDir>/test'],
+    globals: {
+        'ts-jest': {
+            tsconfig: 'tsconfig.test.json'
+        }
+    },
+    transform: {
+        '^.+\\.ts?$': 'ts-jest'
+    },
+    transformIgnorePatterns: ['node_modules'],
+    testEnvironment: 'node',
+    // https://github.com/facebook/jest/issues/5164
+    // globalSetup: './test/global-setup-hook.js',
+    // globalTeardown: './test/global-teardown-hook.js',
+    coverageReporters: ['json', 'lcov', 'clover', 'text-summary']
+}

package/lib/auth/index.js

@@ -0,0 +1,18 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./login"), exports);
+__exportStar(require("./logout"), exports);

package/lib/auth/login.js

@@ -0,0 +1,111 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkLogin = exports.login = exports.loginWithKey = exports.loginByWebAuth = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const utils_1 = require("../utils");
+const decorators_1 = require("../decorators");
+const env_1 = require("../env");
+const i18n_1 = require("../i18n");
+const log = new decorators_1.Logger();
+const LoginRes = {
+    SUCCESS: {
+        code: 'SUCCESS',
+        msg: (0, i18n_1.t)('登录成功！')
+    },
+    INVALID_TOKEN: {
+        code: 'INVALID_TOKEN',
+        msg: (0, i18n_1.t)('无效的身份信息！')
+    },
+    CHECK_LOGIN_FAILED: {
+        code: 'CHECK_LOGIN_FAILED',
+        msg: (0, i18n_1.t)('检查登录态失败')
+    },
+    INVALID_PARAM(msg) {
+        return {
+            code: 'INVALID_PARAM',
+            msg: (0, i18n_1.t)('参数无效：{{msg}}', { msg })
+        };
+    }
+};
+function loginByWebAuth() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const credential = yield utils_1.authSupevisor.loginByWebAuth({
+                getAuthUrl: (rawUrl) => {
+                    if ((0, i18n_1.isIntl)()) {
+                        return rawUrl.replace('https://tcb.cloud.tencent.com/dev', utils_1.EUrl.DevPlatform);
+                    }
+                    return rawUrl;
+                }
+            });
+            if (lodash_1.default.isEmpty(credential)) {
+                return LoginRes.INVALID_TOKEN;
+            }
+            return Object.assign({ credential }, LoginRes.SUCCESS);
+        }
+        catch (error) {
+            console.error((0, i18n_1.t)('Web 授权登录失败，可能是环境兼容性问题'));
+            console.error((0, i18n_1.t)('建议使用密钥登录：tcb login --key'));
+            console.error((0, i18n_1.t)('详细说明请参考：{{url}}', { url: 'https://docs.cloudbase.net/cli-v1/login#%E8%85%BE%E8%AE%AF%E4%BA%91-%E4%BA%91%E5%BC%80%E5%8F%91%E6%8E%A7%E5%88%B6%E5%8F%B0%E6%8E%88%E6%9D%83' }));
+            return {
+                code: 'WEB_AUTH_FAILED',
+                msg: (0, i18n_1.t)('Web 授权登录失败，请使用密钥登录：tcb login --key'),
+                error: error.message
+            };
+        }
+    });
+}
+exports.loginByWebAuth = loginByWebAuth;
+function loginWithKey(secretId, secretKey, token) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!secretId || !secretKey) {
+            return LoginRes.INVALID_PARAM((0, i18n_1.t)('SecretID 或 SecretKey 不能为空'));
+        }
+        const credential = yield utils_1.authSupevisor.loginByApiSecret(secretId, secretKey, token);
+        if (lodash_1.default.isEmpty(credential)) {
+            return LoginRes.INVALID_TOKEN;
+        }
+        return LoginRes.SUCCESS;
+    });
+}
+exports.loginWithKey = loginWithKey;
+function login(options = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { secretId, secretKey, key, token } = options;
+        return key ? loginWithKey(secretId, secretKey, token) : loginByWebAuth();
+    });
+}
+exports.login = login;
+function checkLogin() {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const credential = yield (0, utils_1.checkAndGetCredential)();
+        if (lodash_1.default.isEmpty(credential)) {
+            log.info((0, i18n_1.t)('你还没有登录，请在控制台中授权登录'));
+            const res = yield (0, utils_1.execWithLoading)(() => login(), {
+                startTip: (0, i18n_1.t)('请在浏览器中打开的授权页面进行授权...'),
+                successTip: (0, i18n_1.t)('授权登录成功！')
+            });
+            const envId = (_a = res === null || res === void 0 ? void 0 : res.credential) === null || _a === void 0 ? void 0 : _a.envId;
+            if (envId) {
+                const env = yield (0, env_1.getEnvInfo)(envId);
+                if (env.Status === "UNAVAILABLE") {
+                    yield (0, utils_1.checkEnvAvaliable)(envId);
+                }
+            }
+        }
+    });
+}
+exports.checkLogin = checkLogin;

package/lib/auth/logout.js

@@ -0,0 +1,20 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logout = void 0;
+const utils_1 = require("../utils");
+function logout() {
+    return __awaiter(this, void 0, void 0, function* () {
+        process.emit('logout');
+        yield utils_1.authSupevisor.logout();
+    });
+}
+exports.logout = logout;

package/lib/commands/account/index.js

@@ -0,0 +1,18 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./login"), exports);
+__exportStar(require("./logout"), exports);