@cloudbase/cli 1.12.7-alpha.3 → 2.0.1

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/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/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/index.ts

@@ -18,4 +18,8 @@ export * from './config'
 export * from './auth'
 export * from './store'
 export * from './notice'
-export * from './parallel'
+export * from './parallel'
+
+export * from './tcbrApi'
+export * from './checkTcbrEnv'
+export * from './commonParamsCheck'

package/src/utils/net/http-request.ts

@@ -1,5 +1,5 @@
 import _fetch, { RequestInit } from 'node-fetch'
-import HttpsProxyAgent from 'https-proxy-agent'
+import {HttpsProxyAgent} from 'https-proxy-agent'
 import { REQUEST_TIMEOUT } from '../../constant'
 import { CloudBaseError } from '../../error'
 import { getProxy } from './proxy'

package/src/utils/tcbrApi/callTcbrApi.ts

@@ -0,0 +1,28 @@
+import { CloudBaseError } from '@cloudbase/toolbox'
+import { CloudApiService } from './tcbr-cloud-api-request'
+
+const tcbrService = CloudApiService.getInstance('tcbr')
+
+export async function callTcbrApi(action: string, data: Record<string, any>) {
+    try {
+        const res = await tcbrService.request(action, data)
+        // 返回统一格式的 JSON 结果
+        return {
+            code: 0,
+            errmsg: 'success',
+            data: {
+                ...res
+            }
+        }
+    } catch (e) {
+        // 不直接 throw 因为调用 DescribeCloudRunServerDetail 如果传入了当前不存在的服务名会返回报错
+        // 对特殊错误特殊处理
+        if (e.code === 'AuthFailure.UnauthorizedOperation') {
+            console.log('\n', `requestId: ${e.requestId}`)
+            throw new CloudBaseError('您没有权限执行此操作，请检查 CAM 策略\n')
+        } else if (e.code === 'LimitExceeded') {
+            throw new CloudBaseError(`${e.original.Message}\n`)
+        }
+        return e
+    }
+}

package/src/utils/tcbrApi/index.ts

@@ -0,0 +1 @@
+export * from './callTcbrApi'

package/src/utils/tcbrApi/tcbr-cloud-api/cloud-api-service.ts

@@ -0,0 +1,363 @@
+import crypto from 'crypto'
+import { URL } from 'url'
+import QueryString from 'query-string'
+
+import { fetch as _fetch, fetchStream as _fetchStream, nodeFetch as _nodeFetch } from './request'
+import { CloudBaseError } from './error'
+
+function isObject(x) {
+  return typeof x === 'object' && !Array.isArray(x) && x !== null
+}
+
+// 移除对象中的空值，防止调用云 API 失败
+function deepRemoveVoid(obj) {
+  if (Array.isArray(obj)) {
+    return obj.map(deepRemoveVoid)
+  } else if (isObject(obj)) {
+    let result = {}
+    for (const key in obj) {
+      if (Object.prototype.hasOwnProperty.call(obj, key)) {
+        const value = obj[key]
+        if (typeof value !== 'undefined' && value !== null) {
+          result[key] = deepRemoveVoid(value)
+        }
+      }
+    }
+    return result
+  } else {
+    return obj
+  }
+}
+
+type HexBase64Latin1Encoding = 'latin1' | 'hex' | 'base64';
+
+function sha256(message: string, secret: string, encoding?: HexBase64Latin1Encoding) {
+  const hmac = crypto.createHmac('sha256', secret)
+  return hmac.update(message).digest(encoding)
+}
+
+function getHash(message: string): string {
+  const hash = crypto.createHash('sha256')
+  return hash.update(message).digest('hex')
+}
+
+function getDate(timestamp: number): string {
+  const date = new Date(timestamp * 1000)
+  const year = date.getUTCFullYear()
+  const month = ('0' + (date.getUTCMonth() + 1)).slice(-2)
+  // UTC 日期，非本地时间
+  const day = ('0' + date.getUTCDate()).slice(-2)
+  return `${year}-${month}-${day}`
+}
+
+const ServiceVersionMap = {
+  tcb: '2018-06-08',
+  scf: '2018-04-16',
+  flexdb: '2018-11-27',
+  cam: '2019-01-16',
+  vpc: '2017-03-12',
+  ssl: '2019-12-05',
+  tcbr: '2022-02-17',
+}
+
+export interface ServiceOptions {
+    service: string;
+    version?: string;
+    proxy?: string;
+    timeout?: number;
+    region?: string;
+    baseParams?: Record<string, any>;
+    credential?: Credential;
+    getCredential?: () => Promise<Credential> | Credential;
+}
+
+export interface Credential {
+    secretId: string;
+    secretKey: string;
+    token?: string;
+    tokenExpired?: number;
+}
+
+export interface RequestOptions {
+    action: string;
+    data?: Record<string, any>;
+    method?: 'POST' | 'GET';
+    region?: string;
+}
+
+export const fetch = _fetch
+export const fetchStream = _fetchStream
+export const nodeFetch = _nodeFetch
+
+// token 将在 n 分钟内过期
+const isTokenExpired = (credential: Credential, gap = 120) =>
+  credential.tokenExpired && Number(credential.tokenExpired) < Date.now() + gap * 1000
+
+export class CloudApiService {
+    // 缓存请求实例
+    static serviceCacheMap: Record<string, CloudApiService> = {};
+
+    static getInstance(options: ServiceOptions) {
+      const { service } = options
+      if (CloudApiService.serviceCacheMap?.[service]) {
+        return CloudApiService.serviceCacheMap[service]
+      }
+      const apiService = new CloudApiService(options)
+      // 预防 serviceCacheMap 被置空导致的错误
+      CloudApiService.serviceCacheMap = {
+        ...CloudApiService.serviceCacheMap
+      }
+      CloudApiService.serviceCacheMap[service] = apiService
+      return apiService
+    }
+
+    service: string;
+    version: string;
+    proxy: string;
+    timeout: number;
+    region: string;
+    credential: Credential;
+    baseParams: Record<string, any>;
+    getCredential: () => Promise<Credential> | Credential;
+
+    url: string;
+    host: string;
+    action: string;
+    method: 'POST' | 'GET';
+    data: Record<string, any>;
+    payload: Record<string, any>;
+
+    constructor(options: ServiceOptions) {
+      if (!options) {
+        throw new CloudBaseError('Options cloud not be empty!')
+      }
+      const {
+        service,
+        baseParams,
+        version,
+        proxy,
+        region,
+        credential,
+        getCredential,
+        timeout = 60000
+      } = options
+
+      this.service = service
+      this.timeout = timeout
+
+      if (this.service === 'tcb' && process.env.CLOUDBASE_TCB_CLOUDAPI_PROXY) {
+        this.proxy = process.env.CLOUDBASE_TCB_CLOUDAPI_PROXY
+      } else {
+        this.proxy = proxy
+      }
+
+      if (this.service === 'tcb' && process.env.CLOUDBASE_TCB_CLOUDAPI_REGION) {
+        this.region = process.env.CLOUDBASE_TCB_CLOUDAPI_REGION
+      } else {
+        this.region = region || process.env.TENCENTCLOUD_REGION || 'ap-shanghai'
+      }
+
+      this.credential = credential
+      this.baseParams = baseParams || {}
+      this.getCredential = getCredential
+      this.version = ServiceVersionMap[service] || version
+    }
+
+    get baseUrl() {
+      const urlMap = {
+        tcb: 'https://tcb.tencentcloudapi.com',
+        flexdb: 'https://flexdb.tencentcloudapi.com',
+        lowcode: `${process.env.CLOUDBASE_LOWCODE_ENDPOINT || 'https://lcap.cloud.tencent.com' }/api/v1/cliapi`,
+        tcbr: 'https://tcbr.tencentcloudapi.com',
+      }
+
+      if (this.service === 'tcb' && process.env.CLOUDBASE_TCB_CLOUDAPI_HOST) {
+        return `http://${process.env.CLOUDBASE_TCB_CLOUDAPI_HOST}`
+      }
+
+      if (urlMap[this.service]) {
+        return urlMap[this.service]
+      } else {
+        return `https://${this.service}.tencentcloudapi.com`
+      }
+    }
+
+    // overload
+    async request(options: RequestOptions);
+    async request(action: string, data?: Record<string, any>, method?: 'POST' | 'GET');
+
+    async request(
+      actionOrOptions: string | RequestOptions,
+      assignData: Record<string, any> = {},
+      assignMethod: 'POST' | 'GET' = 'POST'
+    ) {
+      // 增加 region 参数，兼容之前的入参形式
+      let action
+      let data
+      let method
+      let region
+      if (typeof actionOrOptions === 'string') {
+        action = actionOrOptions
+        data = assignData
+        method = assignMethod
+      } else {
+        action = actionOrOptions?.action
+        data = actionOrOptions?.data || {}
+        method = actionOrOptions?.method || 'POST'
+        region = actionOrOptions?.region
+      }
+
+      this.action = action
+      this.data = deepRemoveVoid({ ...data, ...this.baseParams })
+      this.method = method
+
+      this.url = this.baseUrl
+
+      // 不存在密钥，或临时密钥过期
+      if (!this.credential?.secretId || isTokenExpired(this.credential)) {
+        if (!this.getCredential) {
+          throw new CloudBaseError('You must provide credential info!')
+        }
+
+        if (typeof this.getCredential !== 'function') {
+          throw new CloudBaseError('The getCredential option must be a function!')
+        }
+
+        const credential = await this.getCredential()
+
+        if (!credential) {
+          throw new CloudBaseError('Calling getCredential function get no credential info!')
+        }
+        this.credential = credential
+      }
+
+      try {
+        const data: Record<string, any> = await this.requestWithSign(region)
+        if (data.Response.Error) {
+          const tcError = new CloudBaseError(data.Response.Error.Message, {
+            action,
+            requestId: data.Response.RequestId,
+            code: data.Response.Error.Code,
+            original: data.Response.Error
+          })
+          throw tcError
+        } else {
+          return data.Response
+        }
+      } catch (e) {
+        // throw e
+        if (e.name === 'CloudBaseError') {
+          throw e
+        } else {
+          throw new CloudBaseError(e.message, {
+            action,
+            code: e.code,
+            type: e.type
+          })
+        }
+      }
+    }
+
+    async requestWithSign(region) {
+      // data 中可能带有 readStream，由于需要计算整个 body 的 hash，
+      // 所以这里把 readStream 转为 Buffer
+      // await convertReadStreamToBuffer(data)
+      const timestamp = Math.floor(Date.now() / 1000)
+
+      const { method, timeout, data } = this
+
+      if (method === 'GET') {
+        this.url += '?' + QueryString.stringify(data)
+      }
+
+      if (method === 'POST') {
+        this.payload = data
+      }
+
+      const { CLOUDBASE_TCB_CLOUDAPI_HOST } = process.env
+
+      if (this.service === 'tcb' && CLOUDBASE_TCB_CLOUDAPI_HOST) {
+        this.host = CLOUDBASE_TCB_CLOUDAPI_HOST
+      } else {
+        this.host = new URL(this.url).host
+      }
+
+      const config: any = {
+        method,
+        timeout,
+        headers: {
+          Host: this.host,
+          'X-TC-Action': this.action,
+          'X-TC-Region': region || this.region,
+          'X-TC-Timestamp': timestamp,
+          'X-TC-Version': this.version
+        }
+      }
+
+      if (this.credential.token) {
+        config.headers['X-TC-Token'] = this.credential.token
+      }
+
+      if (method === 'GET') {
+        config.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+      }
+      if (method === 'POST') {
+        config.body = JSON.stringify(data)
+        config.headers['Content-Type'] = 'application/json'
+      }
+
+      const sign = this.getRequestSign(timestamp)
+
+      config.headers['Authorization'] = sign
+      return fetch(this.url, config, this.proxy)
+    }
+
+    getRequestSign(timestamp: number) {
+      const { method, url, service } = this
+      const { secretId, secretKey } = this.credential
+      const urlObj = new URL(url)
+
+      // 通用头部
+      let headers = ''
+      const signedHeaders = 'content-type;host'
+      if (method === 'GET') {
+        headers = 'content-type:application/x-www-form-urlencoded\n'
+      }
+
+      if (method === 'POST') {
+        headers = 'content-type:application/json\n'
+      }
+
+      let path = urlObj.pathname
+      if (path === '/api/v1/cliapi' && service === 'lowcode') {
+        path = '//lcap.cloud.tencent.com/api/v1/cliapi'
+        headers += 'host:lcap.cloud.tencent.com\n'
+      } else {
+        headers += `host:${this.host}\n`
+      }
+
+        
+      const querystring = urlObj.search.slice(1)
+
+      const payloadHash = this.payload ? getHash(JSON.stringify(this.payload)) : getHash('')
+
+      const canonicalRequest = `${method}\n${path}\n${querystring}\n${headers}\n${signedHeaders}\n${payloadHash}`
+
+      const date = getDate(timestamp)
+
+      const StringToSign = `TC3-HMAC-SHA256\n${timestamp}\n${date}/${service}/tc3_request\n${getHash(
+        canonicalRequest
+      )}`
+
+      const kDate = sha256(date, `TC3${secretKey}`)
+      const kService = sha256(service, kDate)
+      const kSigning = sha256('tc3_request', kService)
+      const signature = sha256(StringToSign, kSigning, 'hex')
+
+      return `TC3-HMAC-SHA256 Credential=${secretId}/${date}/${service}/tc3_request, SignedHeaders=${signedHeaders}, Signature=${signature}`
+    }
+
+    clearCredentialCache() {
+      this.credential = null
+    }
+}