@cloudbase/manager-node 4.2.0 → 4.2.2

package/src/env/index.ts

@@ -0,0 +1,614 @@
+import COS from 'cos-nodejs-sdk-v5'
+import Util from 'util'
+import { Environment } from '../environment'
+import {
+    IResponseInfo,
+    AuthDomain,
+    EnvInfo,
+    LoginConfigItem,
+    ICheckTcbServiceRes,
+    ICreatePostpayRes
+} from '../interfaces'
+import { CloudBaseError } from '../error'
+import { guid6, rsaEncrypt, CloudService, preLazy } from '../utils'
+import { CamService } from '../cam'
+import { ROLE_NAME } from '../constant'
+import { BillingService } from '../billing'
+
+interface ICreateEnvParam {
+    name: string
+    paymentMode?: PAYMENT_MODE
+    channel?: QCLOUD_CHANNEL
+}
+
+interface ICreateEnvRes {
+    // 环境当前状态：NORMAL：正常可用 NOINITIALIZE：尚未初始化 INITIALIZING：初始化过程中
+    Status: 'NORMAL' | 'NOINITIALIZE' | 'INITIALIZING'
+    // 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+    RequestId: string
+}
+
+type PAYMENT_MODE = 'prepay' | 'postpay'
+type SOURCE = 'miniapp' | 'qcloud'
+type WX_CHANNEL = 'ide' | 'api'
+type QCLOUD_CHANNEL = 'cocos' | 'qq' | 'cloudgame' | 'qc_console' | 'dcloud'
+
+interface IDeleteDomainRes {
+    RequestId: string
+    Deleted: number
+}
+
+interface IAuthDomainsRes {
+    RequestId: string
+    Domains: AuthDomain[]
+}
+
+interface IListEnvRes {
+    RequestId: string
+    EnvList: EnvInfo[]
+}
+
+interface IEnvLoginConfigRes {
+    RequestId: string
+    ConfigList: LoginConfigItem[]
+}
+
+interface IInitParam {
+    Channel?: string
+    Source?: string
+}
+
+export class EnvService {
+    private environment: Environment
+    private envId: string
+    private cloudService: CloudService
+    private camService: CamService
+    private billService: BillingService
+    private envType?: string
+
+    constructor(environment: Environment) {
+        this.environment = environment
+        this.envId = environment.getEnvId()
+        this.envType = environment.getEnvType()
+        this.cloudService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
+        this.camService = new CamService(environment.cloudBaseContext)
+        this.billService = new BillingService(environment.cloudBaseContext)
+    }
+
+    /**
+     * 列出所有环境
+     * @returns {Promise<IListEnvRes>}
+     */
+    async listEnvs(): Promise<IListEnvRes> {
+        return this.cloudService.request('DescribeEnvs')
+    }
+
+    /**
+     * 创建新环境
+     * @param {string} name 环境名称
+     * @returns {Promise<ICreateEnvRes>}
+     */
+    async createEnv(
+        param: ICreateEnvParam
+    ): Promise<{
+        envId: string
+    }> {
+        // 1. 检查是否开通过TCB服务,若未开通，跳2检查角色  开通则跳5 创建环境
+        // 2. 查询tcb 角色是否绑定该账户
+        // 3. 若未绑定，则创建角色并绑定角色
+        // 4. 开通TCB服务
+        // 5. 创建环境
+        // 6. 购买环境，选择预付费 或 后付费 套餐
+        // 7. 若购买失败，将当前环境销毁，若购买成功，返回envId
+        const { name, paymentMode, channel = 'qc_console' } = param
+
+        // 1. 检查TCB服务是否开通
+        const { Initialized } = await this.checkTcbService()
+
+        if (!Initialized) {
+            // 跳2 查询TCB角色是否绑定
+            let hasTcbRole = false
+            try {
+                const res = await this.camService.getRole(ROLE_NAME.TCB)
+                hasTcbRole = true
+            } catch (e) {
+                // 判断是否为角色不存在错误
+                if (e.code !== 'InvalidParameter.RoleNotExist') {
+                    throw e
+                }
+            }
+
+            if (!hasTcbRole) {
+                // 3. 当前账户没有tcbRole，创建角色并绑定
+
+                // 创建角色
+                const createRoleResult = await this.camService.createRole({
+                    RoleName: ROLE_NAME.TCB,
+                    Description:
+                        '云开发(TCB)操作权限含在访问管理(CAM)创建角色，新增角色载体，给角色绑定策略；含读写对象存储(COS)数据；含读写无服务器云函数(SCF)数据；含读取云监控(Monitor)数据。',
+                    PolicyDocument:
+                        '{"version":"2.0","statement":[{"action":"sts:AssumeRole","effect":"allow","principal":{"service":["scf.qcloud.com","tcb.cloud.tencent.com", "cvm.qcloud.com"]}}]}'
+                })
+
+                const { RoleId } = createRoleResult
+
+                // 绑定角色策略
+                // await this.camService.attachRolePolicy({
+                //     PolicyId: 8825032,
+                //     AttachRoleName: ROLE_NAME.TCB
+                // })
+
+                await this.camService.attachRolePolicies({
+                    RoleName: ROLE_NAME.TCB,
+                    PolicyName: [
+                        'QcloudAccessForTCBRole',
+                        'QcloudAccessForTCBRoleInAccessCloudBaseRun'
+                    ]
+                })
+            }
+
+            // 4. 未开通则初始化TCB
+            await this.initTcb({ Channel: channel, Source: 'qcloud' })
+        }
+
+        // 5. 创建环境
+
+        const params: any = {
+            Alias: name,
+            EnvId: `${name}-${guid6()}`,
+            Source: 'qcloud'
+        }
+
+        if (channel) {
+            params.Channel = channel
+        }
+
+        const { EnvId } = await this.cloudService.request('CreateEnv', params)
+
+        const realPaymentMode = paymentMode ? paymentMode : 'postpay'
+        // 6. 购买环境
+
+        let prepayCreateDeal = false
+        let prepayPayDeal = false
+        let postpayDeal = false
+        let payError = null
+
+        if (realPaymentMode === 'prepay') {
+            // 预付费
+            // 1. 创建订单
+            // 2. 支付订单
+
+            const goods = [
+                {
+                    GoodsCategoryId: 101183,
+                    // action: 'purchase',
+                    // currency: 'CNY',
+                    RegionId: 1,
+                    ZoneId: 0,
+                    GoodsNum: 1,
+                    ProjectId: 0,
+                    PayMode: 1,
+                    Platform: 1,
+                    GoodsDetail: JSON.stringify({
+                        productCode: 'p_tcb',
+                        subProductCode: 'sp_tcb_basic',
+                        resourceId: EnvId,
+                        pid: 16677,
+                        timeUnit: 'm',
+                        timeSpan: 1,
+                        tcb_cos: 1,
+                        tcb_cdn: 1,
+                        tcb_scf: 1,
+                        tcb_mongodb: 1,
+                        region: 'ap-shanghai',
+                        zone: 'ap-shanghai-1',
+                        source: 'qcloud',
+                        envId: EnvId,
+                        packageId: 'basic',
+                        isAutoRenew: 'true',
+                        tranType: 1,
+                        productInfo: [
+                            {
+                                name: '套餐版本',
+                                value: '基础版 1'
+                            },
+                            {
+                                name: '存储空间',
+                                value: '5GB'
+                            },
+                            {
+                                name: 'CDN流量',
+                                value: '5GB'
+                            },
+                            {
+                                name: '云函数资源使用量',
+                                value: '4万GBs'
+                            },
+                            {
+                                name: '数据库容量',
+                                value: '2GB'
+                            },
+                            {
+                                name: '数据库同时连接数',
+                                value: '20个'
+                            }
+                        ]
+                    })
+                }
+            ]
+
+            let OrderIdsList = []
+            try {
+                const { OrderIds } = await this.billService.GenerateDeals(goods)
+                OrderIdsList = OrderIds
+                prepayCreateDeal = true
+            } catch (e) {
+                // 预付费下单失败
+                payError = e
+            }
+
+            if (prepayCreateDeal) {
+                // 下单成功
+                try {
+                    // 购买环境套餐
+                    const { OrderIds: succOrderIds } = await this.billService.PayDeals(OrderIdsList)
+
+                    // 判断订单是否支付成功
+                    if (succOrderIds[0] === OrderIdsList[0]) {
+                        prepayPayDeal = true
+                    } else {
+                        throw new CloudBaseError('支付成功的订单号不一致')
+                    }
+                } catch (e) {
+                    // 预付费订单支付失败
+                    payError = new CloudBaseError(
+                        '预付费订单支付失败，请进入订单管理页面(https://console.cloud.tencent.com/deal)重新支付',
+                        {
+                            original: e
+                        }
+                    )
+                }
+            }
+        }
+
+        if (realPaymentMode === 'postpay') {
+            // 后付费
+            try {
+                const { TranId } = await this.CreatePostpayPackage(EnvId)
+                postpayDeal = true
+            } catch (e) {
+                payError = e
+            }
+        }
+
+        // 检查支付状态
+        // 1. 预付费下单失败 删除环境
+        // 2. 预付费下单成功过，支付订单失败，提示用户
+        // 3. 后付费开通失败 删除环境
+        if (realPaymentMode === 'prepay') {
+            if (!prepayCreateDeal) {
+                // 情形1
+                await this.destroyEnv(EnvId)
+                throw payError
+            } else {
+                if (!prepayPayDeal) {
+                    // 情形2
+                    throw payError
+                }
+            }
+        }
+
+        if (realPaymentMode === 'postpay') {
+            if (!postpayDeal) {
+                // 情形3
+                await this.destroyEnv(EnvId)
+                throw payError
+            }
+        }
+
+        // 成功返回envId
+        return {
+            envId: EnvId
+        }
+    }
+
+    /**
+     * 拉取安全域名列表
+     * @returns {Promise<IAuthDomainsRes>}
+     */
+    public async getEnvAuthDomains(): Promise<IAuthDomainsRes> {
+        return this.cloudService.request('DescribeAuthDomains', {
+            EnvId: this.envId
+        })
+    }
+
+    /**
+     * 添加环境安全域名
+     * @param {string[]} domains 域名字符串数组
+     * @returns {Promise<IResponseInfo>}
+     */
+    @preLazy()
+    public async createEnvDomain(domains: string[]): Promise<IResponseInfo> {
+        const res = await this.cloudService.request<IResponseInfo>('CreateAuthDomain', {
+            EnvId: this.envId,
+            Domains: domains
+        })
+        // 添加 COS CORS 域名
+        const promises = domains.map(async domain => {
+            this.modifyCosCorsDomain(domain)
+        })
+        await Promise.all(promises)
+        return res
+    }
+
+    /**
+     * 删除环境安全域名
+     * @param {string[]} domainIds 域名字符串数组
+     * @returns {Promise<IDeleteDomainRes>}
+     */
+    @preLazy()
+    public async deleteEnvDomain(domains: string[]): Promise<IDeleteDomainRes> {
+        // 根据域名获取域名 Id
+        const { Domains } = await this.getEnvAuthDomains()
+        const domainIds = Domains.filter(item => domains.includes(item.Domain)).map(item => item.Id)
+        const res = await this.cloudService.request<IDeleteDomainRes>('DeleteAuthDomain', {
+            EnvId: this.envId,
+            DomainIds: domainIds
+        })
+        // 删除 COS CORS 域名
+        const promises = domains.map(async domain => {
+            this.modifyCosCorsDomain(domain, true)
+        })
+        await Promise.all(promises)
+        return res
+    }
+
+    /**
+     * 检查tcb服务是否开通
+     * @returns {Promise<ICheckTcbServiceRes>}
+     * @memberof CamService
+     */
+    public async checkTcbService(): Promise<ICheckTcbServiceRes> {
+        return this.cloudService.request<ICheckTcbServiceRes>('CheckTcbService', {})
+    }
+
+    /**
+     * 初始化TCB
+     * @returns {Promise<IResponseInfo>}
+     * @memberof EnvService
+     */
+    public async initTcb(param: IInitParam): Promise<IResponseInfo> {
+        let initParam = {}
+        if (param) {
+            initParam = { ...param }
+        }
+
+        return this.cloudService.request<IResponseInfo>('InitTcb', initParam)
+    }
+
+    /**
+     * 开通后付费套餐
+     * @param {string} envId
+     * @param {SOURCE} [source]
+     * @returns {Promise<ICreatePostpayRes>}
+     * @memberof EnvService
+     */
+    public async CreatePostpayPackage(envId: string, source?: SOURCE): Promise<ICreatePostpayRes> {
+        const realSource = source ? source : 'qcloud'
+        return this.cloudService.request<ICreatePostpayRes>('CreatePostpayPackage', {
+            EnvId: envId,
+            Source: realSource
+        })
+    }
+
+    /**
+     * 销毁环境
+     * @param {string} envId
+     * @returns {Promise<IResponseInfo>}
+     * @memberof EnvService
+     */
+    public async destroyEnv(envId: string): Promise<IResponseInfo> {
+        return this.cloudService.request<IResponseInfo>('DestroyEnv', {
+            EnvId: envId
+        })
+    }
+
+    /**
+     * 获取环境信息
+     * @returns {Promise<IEnvInfoRes>}
+     */
+    public async getEnvInfo(): Promise<{
+        EnvInfo: EnvInfo
+        RequestId: string
+    }> {
+        // NOTE: DescribeEnv 接口废弃，需要使用 DescribeEnvs 接口
+        const params: any = {
+            EnvId: this.envId
+        }
+
+        if (this.envType === 'run') {
+            params.EnvType = 'run'
+        }
+
+        const { EnvList, RequestId } = await this.cloudService.request('DescribeEnvs', params)
+
+        return {
+            EnvInfo: EnvList?.length ? EnvList[0] : {},
+            RequestId
+        }
+    }
+
+    /**
+     * 修改环境名称
+     * @param {string} alias 环境名称
+     * @returns {Promise<IResponseInfo>}
+     */
+    public async updateEnvInfo(alias: string): Promise<IResponseInfo> {
+        return this.cloudService.request('ModifyEnv', {
+            EnvId: this.envId,
+            Alias: alias
+        })
+    }
+
+    /**
+     * 拉取登录配置列表
+     * @returns {Promise<IEnvLoginConfigRes>}
+     */
+    async getLoginConfigList(): Promise<IEnvLoginConfigRes> {
+        return this.cloudService.request('DescribeLoginConfigs', {
+            EnvId: this.envId
+        })
+    }
+
+    /**
+     * 创建登录方式
+     * 'WECHAT-OPEN'：微信开放平台
+     * 'WECHAT-PUBLIC'：微信公众平台
+     * @param {('WECHAT-OPEN' | 'WECHAT-PUBLIC')} platform 'WECHAT-OPEN' | 'WECHAT-PUBLIC'
+     * @param {string} appId 微信 appId
+     * @param {string} appSecret 微信 appSecret
+     * @returns {Promise<IResponseInfo>}
+     */
+    async createLoginConfig(
+        platform: 'WECHAT-OPEN' | 'WECHAT-PUBLIC' | 'QQ' | 'ANONYMOUS' | 'USERNAME',
+        appId: string,
+        appSecret?: string
+    ): Promise<IResponseInfo> {
+        let finalAppSecret = appSecret
+
+        if (platform === 'ANONYMOUS') {
+            finalAppSecret = 'anonymous'
+        }
+
+        return this.cloudService.request('CreateLoginConfig', {
+            EnvId: this.envId,
+            // 平台， “QQ" "WECHAT-OPEN" "WECHAT-PUBLIC"
+            Platform: platform,
+            PlatformId: appId,
+            PlatformSecret: finalAppSecret ? rsaEncrypt(finalAppSecret) : undefined,
+            Status: 'ENABLE'
+        })
+    }
+
+    /**
+     * 更新登录方式配置
+     * @param {string} configId 配置 Id，从配置列表中获取
+     * @param {string} [status='ENABLE'] 是否启用 'ENABLE', 'DISABLE' ，可选
+     * @param {string} [appId=''] 微信 appId，可选
+     * @param {string} [appSecret=''] 微信 appSecret，可选
+     * @returns {Promise<IResponseInfo>}
+     */
+    /* eslint-disable-next-line */
+    async updateLoginConfig(
+        configId: string,
+        status = 'ENABLE',
+        appId = '',
+        appSecret = ''
+    ): Promise<IResponseInfo> {
+        const validStatus = ['ENABLE', 'DISABLE']
+        let finalAppSecret = appSecret
+
+        if (!validStatus.includes(status)) {
+            throw new CloudBaseError(
+                `Invalid status value: ${status}. Only support 'ENABLE', 'DISABLE'`
+            )
+        }
+        const params: any = {
+            EnvId: this.envId,
+            ConfigId: configId,
+            Status: status
+        }
+
+        if (appId === 'anonymous') {
+            finalAppSecret = 'anonymous'
+        }
+
+        appId && (params.PlatformId = appId)
+        finalAppSecret && (params.PlatformSecret = rsaEncrypt(finalAppSecret))
+
+        return this.cloudService.request('UpdateLoginConfig', params)
+    }
+
+    // 创建自定义登录私钥
+    public async createCustomLoginKeys(): Promise<{
+        PrivateKey: string // 自定义签名私钥
+        KeyID: string // 私钥id
+        RequestId: string // 请求ID
+    }> {
+        return this.cloudService.request<{
+            PrivateKey: string // 自定义签名私钥
+            KeyID: string // 私钥id
+            RequestId: string // 请求ID
+        }>('CreateCustomLoginKeys', {
+            EnvId: this.envId
+        })
+    }
+
+    // 获取 COS CORS 域名
+    private async getCOSDomains() {
+        const cos = this.getCos()
+        const getBucketCors = Util.promisify(cos.getBucketCors).bind(cos)
+        const { bucket, region } = this.getStorageConfig()
+
+        const res = await getBucketCors({
+            Bucket: bucket,
+            Region: region
+        })
+        return res.CORSRules
+    }
+
+    // 添加 COS CORS 域名，和 Web 端行为保持一致
+    private async modifyCosCorsDomain(domain: string, deleted = false) {
+        const cos = this.getCos()
+        const putBucketCors = Util.promisify(cos.putBucketCors).bind(cos)
+        const { bucket, region } = this.getStorageConfig()
+
+        // 去掉原有此域名CORS配置
+        let corsRules = await this.getCOSDomains()
+        corsRules = corsRules.filter(item => {
+            return !(
+                item.AllowedOrigins &&
+                item.AllowedOrigins.length === 2 &&
+                item.AllowedOrigins[0] === `http://${domain}` &&
+                item.AllowedOrigins[1] === `https://${domain}`
+            )
+        })
+
+        if (!deleted) {
+            corsRules.push({
+                AllowedOrigin: [`http://${domain}`, `https://${domain}`],
+                AllowedMethod: ['GET', 'POST', 'PUT', 'DELETE', 'HEAD'],
+                AllowedHeader: ['*'],
+                ExposeHeader: ['Etag', 'Date'],
+                MaxAgeSeconds: '5'
+            })
+        }
+
+        await putBucketCors({
+            Bucket: bucket,
+            Region: region,
+            CORSRules: corsRules
+        })
+    }
+
+    private getCos() {
+        const { secretId, secretKey, token } = this.environment.getAuthConfig()
+
+        return new COS({
+            SecretId: secretId,
+            SecretKey: secretKey,
+            SecurityToken: token
+        })
+    }
+
+    private getStorageConfig() {
+        const envConfig = this.environment.lazyEnvironmentConfig
+        const storageConfig = envConfig?.Storages?.[0]
+        const { Region, Bucket } = storageConfig
+        return {
+            env: envConfig.EnvId,
+            region: Region,
+            bucket: Bucket
+        }
+    }
+}