@cloudbase/manager-node 4.2.0 → 4.2.1

package/CHANGELOG.md

@@ -1,7 +1,3 @@
-# 4.0.0
-- 升级 https-proxy-agent 3->5 修复 https://github.com/TencentCloud/tencentcloud-sdk-nodejs/issues/47
-
-
 # v3.9.2-beta
 -   扩展禁用用户接口为变更用户状态接口
 -   增加修改用户信息接口

package/lib/constant.js

@@ -4,7 +4,7 @@
 //     static credentail = 'credential'
 // }
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.COS_SDK_KEEPALIVE = exports.COS_SDK_PROTOCOL = exports.USE_INTERNAL_ENDPOINT = exports.SCF_STATUS = exports.ROLE_NAME = exports.PUBLIC_RSA_KEY = exports.ERROR = exports.SERVICE_TYPE = exports.ENDPOINT = exports.RUN_ENV = exports.SDK_VERSION = exports.ENV_NAME = void 0;
+exports.SCF_STATUS = exports.ROLE_NAME = exports.PUBLIC_RSA_KEY = exports.ERROR = exports.SERVICE_TYPE = exports.ENDPOINT = exports.RUN_ENV = exports.SDK_VERSION = exports.ENV_NAME = void 0;
 exports.ENV_NAME = {
     ENV_SECRETID: 'TENCENTCLOUD_SECRETID',
     ENV_SECRETKEY: 'TENCENTCLOUD_SECRETKEY',
@@ -49,7 +49,3 @@ exports.SCF_STATUS = {
     UPDATING: 'Updating',
     CREATE_FAILED: 'CreateFailed'
 };
-// 是否使用内网域名
-exports.USE_INTERNAL_ENDPOINT = "USE_INTERNAL_ENDPOINT" in process.env;
-exports.COS_SDK_PROTOCOL = process.env.COS_SDK_PROTOCOL;
-exports.COS_SDK_KEEPALIVE = process.env.COS_SDK_KEEPALIVE;

package/lib/env/index.js

@@ -14,13 +14,17 @@ const cos_nodejs_sdk_v5_1 = __importDefault(require("cos-nodejs-sdk-v5"));
 const util_1 = __importDefault(require("util"));
 const error_1 = require("../error");
 const utils_1 = require("../utils");
+const cam_1 = require("../cam");
 const constant_1 = require("../constant");
+const billing_1 = require("../billing");
 class EnvService {
     constructor(environment) {
         this.environment = environment;
         this.envId = environment.getEnvId();
         this.envType = environment.getEnvType();
         this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+        this.camService = new cam_1.CamService(environment.cloudBaseContext);
+        this.billService = new billing_1.BillingService(environment.cloudBaseContext);
     }
     /**
      * 列出所有环境
@@ -29,6 +33,208 @@ class EnvService {
     async listEnvs() {
         return this.cloudService.request('DescribeEnvs');
     }
+    /**
+     * 创建新环境
+     * @param {string} name 环境名称
+     * @returns {Promise<ICreateEnvRes>}
+     */
+    async createEnv(param) {
+        // 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(constant_1.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: constant_1.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: constant_1.ROLE_NAME.TCB,
+                    PolicyName: [
+                        'QcloudAccessForTCBRole',
+                        'QcloudAccessForTCBRoleInAccessCloudBaseRun'
+                    ]
+                });
+            }
+            // 4. 未开通则初始化TCB
+            await this.initTcb({ Channel: channel, Source: 'qcloud' });
+        }
+        // 5. 创建环境
+        const params = {
+            Alias: name,
+            EnvId: `${name}-${utils_1.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 error_1.CloudBaseError('支付成功的订单号不一致');
+                    }
+                }
+                catch (e) {
+                    // 预付费订单支付失败
+                    payError = new error_1.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>}
@@ -255,18 +461,11 @@ class EnvService {
     }
     getCos() {
         const { secretId, secretKey, token } = this.environment.getAuthConfig();
-        const cosConfig = {
+        return new cos_nodejs_sdk_v5_1.default({
             SecretId: secretId,
             SecretKey: secretKey,
-            SecurityToken: token,
-            Domain: constant_1.USE_INTERNAL_ENDPOINT ? "{Bucket}.cos-internal.{Region}.tencentcos.cn" /* INTERNAL */ : "{Bucket}.cos.{Region}.tencentcos.cn" /* PUBLIC */
-        };
-        if (constant_1.COS_SDK_PROTOCOL) {
-            cosConfig.Protocol = constant_1.COS_SDK_PROTOCOL.endsWith(':')
-                ? constant_1.COS_SDK_PROTOCOL.toLowerCase()
-                : constant_1.COS_SDK_PROTOCOL.toLowerCase() + ':';
-        }
-        return new cos_nodejs_sdk_v5_1.default(cosConfig);
+            SecurityToken: token
+        });
     }
     getStorageConfig() {
         var _a;

package/lib/function/index.js

@@ -129,7 +129,7 @@ class FunctionService {
      */
     async createFunction(funcParam) {
         const { namespace } = this.getFunctionConfig();
-        const { func, functionRootPath, force = false, base64Code, codeSecret, functionPath, } = funcParam;
+        const { func, functionRootPath, force = false, base64Code, codeSecret, functionPath } = funcParam;
         const funcName = func.name;
         const params = configToParams({
             func,
@@ -257,13 +257,15 @@ class FunctionService {
     /**
      * 删除云函数
      * @param {string} name 云函数名称
+     * @param {string} qualifier 需要删除的版本号，不填默认删除函数下全部版本。
      * @returns {Promise<IResponseInfo>}
      */
-    async deleteFunction(name) {
+    async deleteFunction(name, qualifier) {
         const { namespace } = this.getFunctionConfig();
         return this.scfService.request('DeleteFunction', {
             FunctionName: name,
-            Namespace: namespace
+            Namespace: namespace,
+            Qualifier: qualifier
         });
     }
     /**

package/lib/storage/index.js

@@ -20,8 +20,6 @@ const cos_nodejs_sdk_v5_1 = __importDefault(require("cos-nodejs-sdk-v5"));
 const utils_1 = require("../utils");
 const error_1 = require("../error");
 const parallel_1 = require("../utils/parallel");
-const runenv_1 = require("../utils/runenv");
-const constant_1 = require("../constant");
 const BIG_FILE_SIZE = 5242880; // 5MB 1024*1024*5
 class StorageService {
     constructor(environment) {
@@ -841,27 +839,13 @@ class StorageService {
     getCos(parallel = 20) {
         const { secretId, secretKey, token, proxy } = this.environment.getAuthConfig();
         const cosProxy = process.env.TCB_COS_PROXY;
-        const cosConfig = {
+        return new cos_nodejs_sdk_v5_1.default({
             FileParallelLimit: parallel,
             SecretId: secretId,
             SecretKey: secretKey,
             Proxy: cosProxy || proxy,
-            SecurityToken: token,
-            Domain: constant_1.USE_INTERNAL_ENDPOINT ? "{Bucket}.cos-internal.{Region}.tencentcos.cn" /* INTERNAL */ : "{Bucket}.cos.{Region}.tencentcos.cn" /* PUBLIC */
-        };
-        if (constant_1.COS_SDK_PROTOCOL) {
-            cosConfig.Protocol = constant_1.COS_SDK_PROTOCOL.endsWith(':')
-                ? constant_1.COS_SDK_PROTOCOL.toLowerCase()
-                : constant_1.COS_SDK_PROTOCOL.toLowerCase() + ':';
-        }
-        // COSSDK 默认开启 KeepAlive，这里提供关闭的方式
-        if (constant_1.COS_SDK_KEEPALIVE) {
-            cosConfig.KeepAlive = { true: true, false: false }[constant_1.COS_SDK_KEEPALIVE];
-        }
-        else if (runenv_1.checkIsInScf()) {
-            cosConfig.KeepAlive = false;
-        }
-        return new cos_nodejs_sdk_v5_1.default(cosConfig);
+            SecurityToken: token
+        });
     }
     /**
      * 将 cloudPath 转换成 cloudPath/ 形式

package/lib/utils/cloud-api-request.js

@@ -70,13 +70,6 @@ class CloudService {
             cam: 'https://cam.tencentcloudapi.com',
             cdn: 'https://cdn.tencentcloudapi.com'
         };
-        // 云梯账号走内网域名
-        const intranetUrlMap = Object.keys(urlMap).map((service) => ({
-            [service]: `https://${service}.internal.tencentcloudapi.com`,
-        })).reduce((acc, cur) => (Object.assign(Object.assign({}, acc), cur)), {});
-        if (constant_1.USE_INTERNAL_ENDPOINT) {
-            return intranetUrlMap[this.service];
-        }
         if (urlMap[this.service]) {
             return urlMap[this.service];
         }

package/lib/utils/http-request.js

@@ -6,12 +6,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchStream = exports.fetch = void 0;
 const url_1 = require("url");
 const node_fetch_1 = __importDefault(require("node-fetch"));
-const https_proxy_agent_1 = require("https-proxy-agent");
+const https_proxy_agent_1 = __importDefault(require("https-proxy-agent"));
 const error_1 = require("../error");
 // 使用 fetch + 代理
 async function fetch(url, config = {}, proxy) {
     if (proxy || process.env.http_proxy) {
-        config.agent = new https_proxy_agent_1.HttpsProxyAgent(proxy || process.env.http_proxy);
+        config.agent = new https_proxy_agent_1.default(proxy || process.env.http_proxy);
     }
     // 解决中文编码问题
     const escapeUrl = new url_1.URL(url).toString();
@@ -35,7 +35,7 @@ async function fetch(url, config = {}, proxy) {
 exports.fetch = fetch;
 async function fetchStream(url, config = {}, proxy) {
     if (proxy || process.env.http_proxy) {
-        config.agent = new https_proxy_agent_1.HttpsProxyAgent(proxy || process.env.http_proxy);
+        config.agent = new https_proxy_agent_1.default(proxy || process.env.http_proxy);
     }
     // 解决中文编码问题
     const escapeUrl = new url_1.URL(url).toString();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "4.2.0",
+    "version": "4.2.1",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {
@@ -8,8 +8,7 @@
         "test": "jest --runInBand --detectOpenHandles --coverage --testTimeout=50000",
         "lint": "eslint \"./**/*.ts\"",
         "lint:fix": "eslint --fix \"./**/*.ts\"",
-        "prepublishOnly": "npm run build",
-        "watch": "rimraf lib types && tsc -w"
+        "prepublishOnly": "npm run build"
     },
     "repository": {
         "type": "git",
@@ -38,7 +37,7 @@
         "archiver": "^3.1.1",
         "cos-nodejs-sdk-v5": "2.9.0",
         "del": "^5.1.0",
-        "https-proxy-agent": "^5.0.1",
+        "https-proxy-agent": "^2.2.4",
         "make-dir": "^3.0.0",
         "micromatch": "^4.0.2",
         "node-fetch": "^2.6.0",

package/src/access/index.ts

@@ -0,0 +1,168 @@
+import { Environment } from '../environment'
+import { CloudService, preLazy } from '../utils'
+import {
+    ICreateAccessOptions,
+    IApi,
+    IUpdateOptions,
+    IService,
+    IDeleteOptions,
+    IGetOptions,
+    IDomainOptions
+} from './types'
+import { IResponseInfo } from '../interfaces'
+
+export class AccessService {
+    private tcbService: CloudService
+    private environment: Environment
+
+    constructor(environment: Environment) {
+        this.environment = environment
+        this.tcbService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
+    }
+
+    // 创建云接入路径
+    @preLazy()
+    public async createAccess(options: ICreateAccessOptions) {
+        const { path, name, type = 1, auth } = options
+        const { envId } = this.getEnvInfo()
+
+        return this.tcbService.request<{
+            APIId: string
+            RequestId: string
+        }>('CreateCloudBaseGWAPI', {
+            ServiceId: envId,
+            Path: path,
+            Type: type,
+            Name: name,
+            AuthSwitch: auth ? 1 : 2
+        })
+    }
+
+    // 获取云接入自定义域名列表
+    @preLazy()
+    public async getDomainList() {
+        const { envId } = this.getEnvInfo()
+        return this.tcbService.request<{
+            RequestId: string
+            // 云接入默认域名
+            DefaultDomain: string
+            // 是否开启了云接入服务
+            EnableService: boolean
+            // 云接入服务列表
+            ServiceSet: IService[]
+        }>('DescribeCloudBaseGWService', {
+            ServiceId: envId
+        })
+    }
+
+    // 获取云接入服务列表
+    @preLazy()
+    public async getAccessList(options: IGetOptions = {}) {
+        const { path, name, offset, limit } = options
+        const { envId } = this.getEnvInfo()
+
+        return this.tcbService.request<{
+            RequestId: string
+            APISet: IApi[]
+            Total: number
+            Limit: number
+            Offset: number
+            EnableService: boolean
+        }>('DescribeCloudBaseGWAPI', {
+            ServiceId: envId,
+            Path: path,
+            Name: name,
+            Offset: offset,
+            limit: limit
+        })
+    }
+
+    // 切换云接入服务开关：开启/关闭
+    @preLazy()
+    public async switchAuth(auth: boolean) {
+        const { envId } = this.getEnvInfo()
+        return this.tcbService.request<{
+            Count: number
+            RequestId: string
+        }>('ModifyCloudBaseGWPrivilege', {
+            ServiceId: envId,
+            EnableService: auth,
+            Options: [
+                {
+                    Key: 'serviceswitch',
+                    Value: auth ? 'true' : 'false'
+                }
+            ]
+        })
+    }
+
+    // 更新云接入路径鉴权
+    @preLazy()
+    public async switchPathAuth(options: IUpdateOptions) {
+        const { apiIds, auth } = options
+        const { envId } = this.getEnvInfo()
+        return this.tcbService.request<{
+            Count: number
+            RequestId: string
+        }>('ModifyCloudBaseGWAPIPrivilegeBatch', {
+            ServiceId: envId,
+            APIIdSet: apiIds,
+            Options: [
+                {
+                    Key: 'authswitch',
+                    Value: auth ? 'true' : 'false'
+                }
+            ]
+        })
+    }
+
+    // 删除云接入服务
+    @preLazy()
+    public async deleteAccess(options: IDeleteOptions) {
+        const { name, type = 1, apiId } = options
+        const { envId } = this.getEnvInfo()
+
+        return this.tcbService.request<IResponseInfo>('DeleteCloudBaseGWAPI', {
+            ServiceId: envId,
+            Name: name,
+            Type: type,
+            APIId: apiId
+        })
+    }
+
+    // 添加自定义域名
+    @preLazy()
+    public async addCustomDomain(options: IDomainOptions) {
+        const { domain, certId } = options
+        const { envId } = this.getEnvInfo()
+
+        return this.tcbService.request<IResponseInfo>('BindCloudBaseGWDomain', {
+            Domain: domain,
+            ServiceId: envId,
+            CertId: certId
+        })
+    }
+
+    // 删除自定义域名
+    @preLazy()
+    public async deleteCustomDomain(domain: string) {
+        const { envId } = this.getEnvInfo()
+
+        return this.tcbService.request<IResponseInfo>('DeleteCloudBaseGWDomain', {
+            Domain: domain,
+            ServiceId: envId
+        })
+    }
+
+    private getEnvInfo() {
+        const envConfig = this.environment.lazyEnvironmentConfig
+        const appId = envConfig.Storages[0]?.AppId
+        const { proxy } = this.environment.cloudBaseContext
+
+        return {
+            appId,
+            proxy,
+            envId: envConfig.EnvId
+        }
+    }
+}

package/src/access/types.ts

@@ -0,0 +1,55 @@
+export interface ICreateAccessOptions {
+    path: string
+    // 云函数名或云应用名称
+    name: string
+    // 1 表示云函数，2 表示云应用
+    type?: 1 | 2
+    // 鉴权开关
+    auth?: boolean
+}
+
+export interface IApi {
+    ServiceId: string
+    APIId: string
+    Path: string
+    Type: number
+    Name: string
+    CreateTime: number
+    EnvId: string
+    EnableAuth: boolean
+}
+
+export interface IUpdateOptions {
+    // APIId
+    apiIds: string[]
+    // true 为开启，false 为关闭
+    auth: boolean
+}
+
+export interface IService {
+    ServiceId: string
+    Domain: string
+    OpenTime: number
+    Status?: number
+}
+
+export interface IDeleteOptions {
+    name?: string
+    type?: number
+    apiId?: string
+    path?: string
+}
+
+export interface IGetOptions {
+    path?: string
+    name?: string
+    limit?: number
+    offset?: number
+}
+
+export interface IDomainOptions {
+    // 域名
+    domain: string
+    // 腾讯云 SSL 证书 Id
+    certId?: string
+}

package/src/billing/index.ts

@@ -0,0 +1,43 @@
+import { CloudService } from '../utils'
+import { CloudBaseContext } from '../context'
+import { IServiceVersion, IGoodItem, IGenerateDealsRes, IPayDealsRes } from '../interfaces'
+
+export class BillingService {
+    static billServiceVersion: IServiceVersion = {
+        service: 'billing',
+        version: '2018-07-09'
+    }
+    private billService: CloudService
+
+    constructor(context: CloudBaseContext) {
+        this.billService = new CloudService(
+            context,
+            BillingService.billServiceVersion.service,
+            BillingService.billServiceVersion.version
+        )
+    }
+
+    /**
+     * 创建订单
+     * @param {Array<IGoodItem>} goods
+     * @returns {Promise<IGenerateDealsRes>}
+     * @memberof BillingService
+     */
+    public async GenerateDeals(goods: Array<IGoodItem>): Promise<IGenerateDealsRes> {
+        return this.billService.request<IGenerateDealsRes>('GenerateDeals', {
+            Goods: goods
+        })
+    }
+
+    /**
+     * 支付订单
+     * @param {Array<string>} orderIds
+     * @returns {Promise<IPayDealsRes>}
+     * @memberof BillingService
+     */
+    public async PayDeals(orderIds: Array<string>): Promise<IPayDealsRes> {
+        return this.billService.request<IPayDealsRes>('PayDeals', {
+            OrderIds: orderIds
+        })
+    }
+}