@cloudbase/cli 1.12.7-alpha.4 → 2.0.0

package/src/third/index.ts

@@ -1,13 +1,13 @@
-import { CloudApiService } from '../utils'
-const tcbService = CloudApiService.getInstance('tcb')
-
-// 解除第三方小程序绑定
-export async function deleteThirdPartAttach(options) {
-    const { ThirdPartAppid, TypeFlag } = options
-    const res: any = await tcbService.request('DeleteThirdPartAttach', {
-        ThirdPartAppid,
-        TypeFlag
-    })
-
-    return res
+import { CloudApiService } from '../utils'
+const tcbService = CloudApiService.getInstance('tcb')
+
+// 解除第三方小程序绑定
+export async function deleteThirdPartAttach(options) {
+    const { ThirdPartAppid, TypeFlag } = options
+    const res: any = await tcbService.request('DeleteThirdPartAttach', {
+        ThirdPartAppid,
+        TypeFlag
+    })
+
+    return res
 }

package/src/types.ts

@@ -375,8 +375,8 @@ export interface IListBranch {
 export interface IListImage {
     envId: string,
     serviceName: string,
-    limit: number,
-    offset: number
+    limit?: number,
+    offset?: number
 }
 
 export interface IDeleteImage {
@@ -530,4 +530,130 @@ export interface IGetFunctionAliasRes {
     Description: string
     AddTime: string
     ModTime: string
+}
+
+export interface ITcbrServerBaseConfig {
+    EnvId: string,
+    ServerName: string,
+    OpenAccessTypes: string[],
+    Cpu: number,
+    Mem: number,
+    MinNum: number,
+    MaxNum: number,
+    PolicyDetails: {
+        PolicyType: string,
+        PolicyThreshold: number
+    }[],
+    CustomLogs: string,
+    EnvParams: string,
+    InitialDelaySeconds: number,
+    CreateTime: string,
+    Port: number,
+    HasDockerfile: boolean,
+    Dockerfile: string,
+    BuildDir: string,
+}
+
+export interface IDescribeCloudRunServerDetail {
+    BaseInfo: {
+        ServerName: string,
+        DefaultDomainName: string,
+        CustomDomainName: string,
+        Status: 'running' | 'deploying' | 'deploy_failed',
+        UpdateTime: string,
+    },
+    ServerConfig: ITcbrServerBaseConfig,
+    RequestId: string
+}
+
+export interface ITcbrServiceOptions {
+    noConfirm: boolean,
+    override: boolean,
+    defaultOverride: boolean,
+    envId: string,
+    serviceName: string,
+    path: string,
+    cpu: number,
+    mem: number,
+    minNum: number,
+    maxNum: number,
+    policyDetails: string,
+    customLogs: string,
+    envParams: string,
+    containerPort: number,
+    remark: string,
+    targetDir: string,
+    dockerfile: string,
+    image: string,
+    library_image: string,
+    json: boolean
+}
+
+export interface ICloudRunProcessLog {
+    EnvId: string,
+    RunId: string
+}
+
+export interface ICloudRunBuildLog {
+    EnvId: string,
+    ServerName: string,
+    ServerVersion: string,
+    BuildId: number,
+    Offset: number
+}
+
+export interface IDescribeWxCloudBaseRunReleaseOrder {
+    envId: string,
+    serviceName: string
+}
+
+export interface IGetLogs {
+    envId: string,
+    taskId: number,
+    serviceName: string,
+}
+
+export interface ITcbrServiceConfigOptions {
+    serviceName: string,
+    envId: string,
+    cpu: number,
+    mem: number,
+    minNum: number,
+    maxNum: number,
+    policyDetails: string,
+    customLogs: string,
+    envParams: string,
+}
+
+export interface IServerInfo {
+    ServerName: string,
+    DefaultDomainName: string,
+    CustomDomainName: string,
+    Status: string,
+    UpdateTime: string,
+    CreatedTime: string,
+}
+
+export interface ITcbrServiceRequiredOptions {
+    envId: string,
+    serviceName: string,
+    containerPort: number,
+    isCreated: boolean,
+    path: string,
+    library_image: string,
+    image: string
+}
+
+export interface ITcbrServiceOptionalOptions {
+    cpu: number | string,
+    mem: number | string,
+    maxNum: number | string,
+    minNum: number | string
+}
+
+export interface ITcbrServiceConvertedOptionalOptions {
+    cpuConverted: number,
+    memConverted: number,
+    maxNumConverted: number,
+    minNumConverted: number
 }

package/src/utils/auth.ts

@@ -1,15 +1,15 @@
-import _ from 'lodash'
-import { AuthSupevisor } from '@cloudbase/toolbox'
-import { getProxy } from './net'
-import { REQUEST_TIMEOUT } from '../constant'
-
-export const authSupevisor = AuthSupevisor.getInstance({
-    cache: true,
-    proxy: getProxy(),
-    timeout: REQUEST_TIMEOUT,
-    throwError: true
-})
-
-export async function getLoginState() {
-    return authSupevisor.getLoginState()
-}
+import _ from 'lodash'
+import { AuthSupevisor } from '@cloudbase/toolbox'
+import { getProxy } from './net'
+import { REQUEST_TIMEOUT } from '../constant'
+
+export const authSupevisor = AuthSupevisor.getInstance({
+    cache: true,
+    proxy: getProxy(),
+    timeout: REQUEST_TIMEOUT,
+    throwError: true
+})
+
+export async function getLoginState() {
+    return authSupevisor.getLoginState()
+}

package/src/utils/checkTcbrEnv.ts

@@ -0,0 +1,67 @@
+import chalk from 'chalk'
+import { CloudBaseError } from '../error'
+import { CloudApiService } from './net'
+import { EnumEnvCheck } from '../constant'
+const tcbService = CloudApiService.getInstance('tcb')
+
+const oldCmdSet =
+    `
+服务列表：tcb run:deprecated list --envId <envId>
+创建服务：tcb run:deprecated create --envId <envId> --name <name>
+删除服务：tcb run:deprecated delete --envId <envId> --serviceName <serviceName>
+
+版本列表：tcb run:deprecated version list --envId <envId> --serviceName <serviceName>
+创建版本：tcb run:deprecated version create --envId <envId> --serviceName <serviceName>
+分配流量：tcb run:deprecated version modify --envId <envId> --serviceName <serviceName>
+滚动更新：tcb run:deprecated version update --envId <envId> --serviceName <serviceName> --versionName <versionName>
+删除版本：tcb run:deprecated version delete --envId <envId> --serviceName <serviceName> --versionName <versionName>
+
+查看镜像：tcb run:deprecated image list --envId <envId> --serviceName <serviceName>
+上传镜像：tcb run:deprecated image upload --envId <envId> --serviceName <serviceName> --imageId <imageId> --imageTag <imageTag>
+下载镜像：tcb run:deprecated image download --envId <envId> --serviceName <serviceName> --imageTag <imageTag>
+删除镜像：tcb run:deprecated image delete --envId <envId> --serviceName <serviceName> --imageTag <imageTag>
+`
+const newCmdSet =
+    `
+查看环境下服务：tcb run service:list --envId <envId>
+创建云托管服务：tcb run service:create --envId <envId> --serviceName <serviceName> --containerPort <containerPort>
+更新云托管服务：tcb run service:update --envId <envId> --serviceName <serviceName> --containerPort <containerPort>
+部署云托管服务：tcb run deploy --envId <envId> --serviceName <serviceName> --containerPort <containerPort>
+更新服务基础配置：tcb run service:config --envId <envId> --serviceName <serviceName>
+`
+/**
+ * 
+ * @param envId 环境 Id
+ * @param isTcbr 使用的命令是否是 tcbr 新操作集
+ * @returns 
+ */
+export async function checkTcbrEnv(envId: string | undefined, isTcbr: boolean): Promise<EnumEnvCheck> | never {
+    if(envId === undefined) {
+        throw new CloudBaseError('请使用 -e 或 --envId 指定环境 ID')
+    }
+    const { EnvList: [envInfo] } = await tcbService.request('DescribeEnvs', {
+        EnvId: envId
+    })
+
+    if(envInfo === undefined) {
+        throw new CloudBaseError('无法读取到有效的环境信息，请检查环境 ID 是否正确')
+    }
+
+    if ((envInfo.EnvType === 'tcbr' && isTcbr) || (envInfo.EnvType !== 'tcbr' && !isTcbr)) {
+        return EnumEnvCheck.EnvFit
+    } else if (envInfo.EnvType === 'tcbr' && !isTcbr) {
+        return EnumEnvCheck.EnvNewCmdOld
+    } else if (envInfo.EnvType !== 'tcbr' && isTcbr) {
+        return EnumEnvCheck.EnvOldCmdNew
+    }
+}
+
+export function logEnvCheck(envId: string, warningType: EnumEnvCheck) {
+    if(warningType === EnumEnvCheck.EnvNewCmdOld) {
+        // 当前环境是 tcbr 环境且使用的不是 tcbr 新操作集
+        throw new CloudBaseError(`当前能力不支持 ${envId} 环境，请使用如下操作集：${chalk.grey(newCmdSet)}`)
+    } else if (warningType === EnumEnvCheck.EnvOldCmdNew) {
+        // 当前环境不是 tcbr 环境但使用 tcbr 操作集
+        throw new CloudBaseError(`当前能力不支持 ${envId} 环境，请使用如下操作集：${chalk.grey(oldCmdSet)}`)
+    }
+}

package/src/utils/cli-table.ts

@@ -1,23 +1,23 @@
-import Table, { TableOptions, HorizontalTable } from 'cli-table3'
-
-// 打印水平方向的表格
-export function printHorizontalTable(
-    head: string[],
-    data: (string | number)[][] = [],
-    options?: TableOptions
-) {
-    if (!data?.length) {
-        console.log('列表数据为空')
-    }
-    const table: HorizontalTable = new Table({
-        head,
-        style: { head: ['yellow'] },
-        colAligns: new Array(head.length).fill('center'),
-        ...options
-    }) as HorizontalTable
-
-    data.forEach((item: Table.Cell[]) => {
-        table.push(item)
-    })
-    console.log(table.toString())
-}
+import Table, { TableOptions, HorizontalTable } from 'cli-table3'
+
+// 打印水平方向的表格
+export function printHorizontalTable(
+    head: string[],
+    data: (string | number)[][] = [],
+    options?: TableOptions
+) {
+    if (!data?.length) {
+        console.log('列表数据为空')
+    }
+    const table: HorizontalTable = new Table({
+        head,
+        style: { head: ['yellow'] },
+        colAligns: new Array(head.length).fill('center'),
+        ...options
+    }) as HorizontalTable
+
+    data.forEach((item: Table.Cell[]) => {
+        table.push(item)
+    })
+    console.log(table.toString())
+}

package/src/utils/commonParamsCheck.ts

@@ -0,0 +1,65 @@
+import { CloudBaseError } from '../error'
+import { convertNumber } from '../run'
+import { ITcbrServiceOptionalOptions, ITcbrServiceConvertedOptionalOptions } from '../types'
+import { validateCpuMem } from './validator'
+
+export function parseOptionalParams(options: ITcbrServiceOptionalOptions): ITcbrServiceConvertedOptionalOptions {
+    let cpuConverted
+    let memConverted
+    if (options.cpu || options.mem) {
+        let data = validateCpuMem(options.cpu, options.mem)
+        ;[cpuConverted, memConverted] = [data.cpuOutput, data.memOutput]
+    }
+
+    let maxNumConverted
+    if (options.maxNum) {
+        maxNumConverted = convertNumber(options.maxNum)
+        if (maxNumConverted < 0 || maxNumConverted > 50) {
+            throw new CloudBaseError('最大副本数必须大于等于0且小于等于50')
+        }
+    }
+
+    let minNumConverted
+    if (options.minNum) {
+        minNumConverted = convertNumber(options.minNum)
+        if (minNumConverted < 0 || minNumConverted > 50) {
+            throw new CloudBaseError('最小副本数必须大于等于0且小于等于50')
+        }
+    }
+
+    if (minNumConverted > maxNumConverted) {
+        throw new CloudBaseError('最小副本数不能大于最大副本数')
+    }
+
+    return {
+        cpuConverted,
+        memConverted,
+        maxNumConverted,
+        minNumConverted
+    }
+}
+
+/**
+ * 
+ * @description 通用两层三元运算符的参数处理，例如
+ *              MaxNum: maxNumConverted
+                ? convertNumber(maxNum)
+                : _override
+                    ? (previousServerConfig?.MaxNum)
+                    : 50
+ * @param originalParam 原始参数，如 maxNumConverted
+ * @param override 是否覆盖，如 _override
+ * @param handler 处理参数的函数，如 convertNumber
+ * @param overrideVal 如果覆盖，提供的默认覆盖值
+ * @param defaultVal 默认值
+ * @param args 传入 handler 中使用的额外参数
+ */
+export function parseInputParam(originalParam, override: boolean, handler: Function | null, overrideVal, defaultVal, ...args) {
+    return originalParam
+        ? (typeof handler === 'function')
+            ? handler(originalParam, ...args)
+            : originalParam
+        : override
+            ? overrideVal
+            : defaultVal
+}

package/src/utils/config.ts

@@ -1,39 +1,39 @@
-import _ from 'lodash'
-import path from 'path'
-import yargs, { Arguments } from 'yargs'
-import { ConfigParser, ICloudBaseConfig } from '@cloudbase/toolbox'
-
-export interface IArgs {
-    envId: string
-    region: string
-    verbose: boolean
-    configPath: string
-    [x: string]: unknown
-}
-
-export const getArgs = (): Arguments<IArgs> => {
-    // console.log(yargs.argv)
-    return yargs.alias('e', 'envId').alias('r', 'region').argv as any
-}
-
-// 获取 cloudbase 配置
-export const getCloudBaseConfig = async (configPath?: string): Promise<ICloudBaseConfig> => {
-    const args = getArgs()
-
-    let specificConfigPath = configPath || args.configPath
-    specificConfigPath = specificConfigPath ? path.resolve(specificConfigPath) : undefined
-
-    const parser = new ConfigParser({
-        configPath: specificConfigPath
-    })
-    const config: ICloudBaseConfig = await parser.get()
-
-    // 合并默认配置
-    if (config?.functionDefaultConfig && config?.functions?.length) {
-        config.functions = config.functions.map((rawConfig) =>
-            _.merge({}, config.functionDefaultConfig, rawConfig)
-        )
-    }
-
-    return config
-}
+import _ from 'lodash'
+import path from 'path'
+import yargs, { Arguments } from 'yargs'
+import { ConfigParser, ICloudBaseConfig } from '@cloudbase/toolbox'
+
+export interface IArgs {
+    envId: string
+    region: string
+    verbose: boolean
+    configPath: string
+    [x: string]: unknown
+}
+
+export const getArgs = (): Arguments<IArgs> => {
+    // console.log(yargs.argv)
+    return yargs.alias('e', 'envId').alias('r', 'region').argv as any
+}
+
+// 获取 cloudbase 配置
+export const getCloudBaseConfig = async (configPath?: string): Promise<ICloudBaseConfig> => {
+    const args = getArgs()
+
+    let specificConfigPath = configPath || args.configPath
+    specificConfigPath = specificConfigPath ? path.resolve(specificConfigPath) : undefined
+
+    const parser = new ConfigParser({
+        configPath: specificConfigPath
+    })
+    const config: ICloudBaseConfig = await parser.get()
+
+    // 合并默认配置
+    if (config?.functionDefaultConfig && config?.functions?.length) {
+        config.functions = config.functions.map((rawConfig) =>
+            _.merge({}, config.functionDefaultConfig, rawConfig)
+        )
+    }
+
+    return config
+}