feat: extract api factory and add RequestClient

Author: yugasun

.prettierignore

@@ -1,2 +1,2 @@
 CHANGELOG.md
-*.test.js
+*.test.js

package.json

@@ -70,8 +70,9 @@
     "semantic-release": "^17.0.4"
   },
   "dependencies": {
-    "@tencent-sdk/capi": "^0.2.17",
+    "@tencent-sdk/capi": "^0.3.0",
     "@ygkit/request": "^0.1.1",
+    "cos-nodejs-sdk-v5": "^2.6.2",
     "moment": "^2.25.3",
     "tencent-cloud-sdk": "^1.0.3"
   }

src/modules/apigw/apis.js

@@ -1,69 +1,6 @@
+const { ApiFactory } = require('../../utils/api');
 const { ApiError } = require('../../utils/error');
 
-function isEmpty(val) {
-  return val === undefined || val === null || (typeof val === 'number' && isNaN(val));
-}
-
-function cleanEmptyValue(obj) {
-  const newObj = {};
-  for (const key in obj) {
-    const val = obj[key];
-    if (!isEmpty(val)) {
-      newObj[key] = val;
-    }
-  }
-  return newObj;
-}
-
-function apiFactory(actions) {
-  const apis = {};
-  actions.forEach((action) => {
-    apis[action] = async (capi, inputs) => {
-      inputs = cleanEmptyValue(inputs);
-      try {
-        const { Response } = await capi.request(
-          {
-            Action: action,
-            Version: '2018-08-08',
-            // RequestClient: 'ServerlessComponent',
-            Token: capi.options.Token || null,
-            ...inputs,
-          },
-          {
-            debug: false,
-            ServiceType: 'apigateway',
-            host: 'apigateway.tencentcloudapi.com',
-          },
-          false,
-        );
-
-        if (Response && Response.Error && Response.Error.Code) {
-          if (Response.Error.Code.indexOf('ResourceNotFound') === -1) {
-            throw new ApiError({
-              type: `API_APIGW_${action}`,
-              message: `${Response.Error.Message} (reqId: ${Response.RequestId})`,
-              reqId: Response.RequestId,
-              code: Response.Error.Code,
-            });
-          }
-          return null;
-        }
-        return Response.Result || Response;
-      } catch (e) {
-        throw new ApiError({
-          type: `API_APIGW_${action}`,
-          message: e.message,
-          stack: e.stack,
-          reqId: e.reqId,
-          code: e.code,
-        });
-      }
-    };
-  });
-
-  return apis;
-}
-
 const ACTIONS = [
   'CreateService',
   'DeleteService',
@@ -95,6 +32,26 @@ const ACTIONS = [
   'BindSubDomain',
   'UnBindSubDomain',
 ];
-const APIS = apiFactory(ACTIONS);
+
+const APIS = ApiFactory({
+  debug: true,
+  serviceType: 'apigateway',
+  version: '2018-08-08',
+  actions: ACTIONS,
+  responseHandler(Response) {
+    return Response.Result || Response;
+  },
+  errorHandler(action, Response) {
+    if (Response.Error.Code.indexOf('ResourceNotFound') === -1) {
+      throw new ApiError({
+        type: `API_APIGW_${action}`,
+        message: `${Response.Error.Message} (reqId: ${Response.RequestId})`,
+        reqId: Response.RequestId,
+        code: Response.Error.Code,
+      });
+    }
+    return null;
+  },
+});
 
 module.exports = APIS;

src/modules/apigw/index.js

@@ -56,6 +56,7 @@ class Apigw {
         Action: 'DescribeService',
         ServiceId: serviceId,
       });
+      console.log('detail', detail);
       if (detail) {
         detail.InnerSubDomain = detail.InternalSubDomain;
         exist = true;
@@ -537,7 +538,6 @@ class Apigw {
           if (e.code === 'FailedOperation.DomainResolveError') {
             customDomainOutput.push({
               isBinded: false,
-              created: '创建失败',
               subDomain: domainItem.domain,
               cname: subDomain,
               message: `您的自定义域名还未生效，请给域名 ${domainItem.domain} 添加 CNAME 记录 ${subDomain}，等待解析生效后，再次运行 'sls deploy' 完成自定义域名的配置`,

src/modules/apigw/index.test.js

@@ -18,7 +18,7 @@ async function runTest() {
         domain: 'test.yugasun.com',
         // TODO: change to your certId
         certificateId: 'cWOJJjax',
-        isDefaultMapping: 'true',
+        isDefaultMapping: false,
         pathMappingSet: [
           {
             path: '/',
@@ -46,10 +46,9 @@ async function runTest() {
         },
         auth: {
           serviceTimeout: 15,
-          secretName: 'secret',
+          secretName: 'authName',
           secretIds: ['xxx'],
         },
-
       },
       {
         path: '/mo',
@@ -102,7 +101,6 @@ async function runTest() {
   const outputs = await apigw.deploy(inputs);
   console.log('outputs', JSON.stringify(outputs));
 
-
   await apigw.remove(outputs);
 }
 

src/modules/cam/apis.js

@@ -0,0 +1,19 @@
+const { ApiFactory } = require('../../utils/api');
+
+const ACTIONS = [
+  'DescribeRoleList',
+  'ListAttachedRolePolicies',
+  'AttachRolePolicy',
+  'CreateRole',
+  'GetRole',
+  'DeleteRole',
+];
+
+const APIS = ApiFactory({
+  // debug: true,
+  serviceType: 'cam',
+  version: '2019-01-16',
+  actions: ACTIONS,
+});
+
+module.exports = APIS;

src/modules/cam/index.js

@@ -1,41 +1,27 @@
-const { cam } = require('tencent-cloud-sdk');
-const { ApiError } = require('../../utils/error');
+const { Capi } = require('@tencent-sdk/capi');
+const Apis = require('./apis');
 
 class Cam {
   constructor(credentials = {}, region) {
     this.region = region || 'ap-guangzhou';
     this.credentials = credentials;
-    this.camClient = new cam(this.credentials);
+    this.capi = new Capi({
+      Region: this.region,
+      AppId: this.credentials.AppId,
+      SecretId: this.credentials.SecretId,
+      SecretKey: this.credentials.SecretKey,
+      Token: this.credentials.Token,
+    });
   }
 
-  async request(data) {
-    try {
-      const res = await this.camClient.request(data);
-
-      if (res.Response && res.Response.Error) {
-        throw new ApiError({
-          type: `API_CAM_${data.action}`,
-          message: `${res.Response.Error.Message} (reqId: ${res.Response.RequestId})`,
-          reqId: res.Response.RequestId,
-          code: res.Response.Error.Code,
-        });
-      }
-      return res;
-    } catch (e) {
-      throw new ApiError({
-        type: `API_CAM_${data.action}`,
-        message: e.message,
-        stack: e.stack,
-        reqId: e.reqId,
-        code: e.code,
-      });
-    }
+  async request({ Action, ...data }) {
+    const result = await Apis[Action](this.capi, data);
+    return result;
   }
 
   async DescribeRoleList(page, limit) {
     const reqParams = {
       Action: 'DescribeRoleList',
-      Version: '2019-01-16',
       Page: page,
       Rp: limit,
     };
@@ -45,7 +31,6 @@ class Cam {
   async ListRolePoliciesByRoleId(roleId, page, limit) {
     const reqParams = {
       Action: 'ListAttachedRolePolicies',
-      Version: '2019-01-16',
       Page: page,
       Rp: limit,
       RoleId: roleId,
@@ -56,40 +41,53 @@ class Cam {
   async CreateRole(roleName, policiesDocument) {
     const reqParams = {
       Action: 'CreateRole',
-      Version: '2019-01-16',
       RoleName: roleName,
       PolicyDocument: policiesDocument,
-      Description: 'Serverless Framework',
+      Description: 'Created By Serverless Framework',
     };
     return this.request(reqParams);
   }
 
+  async GetRole(roleName) {
+    return this.request({
+      Action: 'GetRole',
+      RoleName: roleName,
+    });
+  }
+
+  async DeleteRole(roleName) {
+    return this.request({
+      Action: 'DeleteRole',
+      RoleName: roleName,
+    });
+  }
+
   // api limit qps 3/s
   async AttachRolePolicyByName(roleId, policyName) {
     const reqParams = {
       Action: 'AttachRolePolicy',
-      Version: '2019-01-16',
       AttachRoleId: roleId,
       PolicyName: policyName,
     };
     return this.request(reqParams);
   }
 
-  async CheckSCFExcuteRole() {
-    const ScfExcuteRoleName = 'QCS_SCFExcuteRole';
-
-    const roles = await this.DescribeRoleList(1, 200);
+  async isRoleExist(roleName) {
+    const { List = [] } = await this.DescribeRoleList(1, 200);
 
-    const len = roles.Response.List.length;
-    for (var i = 0; i < len; i++) {
-      const roleItem = roles.Response.List[i];
+    for (var i = 0; i < List.length; i++) {
+      const roleItem = List[i];
 
-      if (roleItem.RoleName == ScfExcuteRoleName) {
+      if (roleItem.RoleName === roleName) {
         return true;
       }
     }
     return false;
   }
+
+  async CheckSCFExcuteRole() {
+    return this.isRoleExist('QCS_SCFExcuteRole');
+  }
 }
 
 module.exports = Cam;

src/modules/cam/index.test.js

@@ -1,17 +1,50 @@
-const CamUtils = require('./index');
+const Client = require('./index');
 
 class ClientTest {
-	async camTest() {
-		const cam = new CamUtils({
-			SecretId: '',
-			SecretKey: '',
-		});
-		const ret = await cam.CheckSCFExcuteRole();
-		console.log(ret);
-	}
+  async run() {
+    const client = new Client({
+      SecretId: '',
+      SecretKey: '',
+    });
+    const roleName = 'role-test';
+    // 1. create role
+    const res1 = await client.CreateRole(
+      roleName,
+      JSON.stringify({
+        version: '2.0',
+        statement: [
+          {
+            action: 'name/sts:AssumeRole',
+            effect: 'allow',
+            principal: {
+              service: ['cloudaudit.cloud.tencent.com', 'cls.cloud.tencent.com'],
+            },
+          },
+        ],
+      }),
+    );
+    console.log('create result: ', JSON.stringify(res1));
+    console.log('++++++++');
+
+    // 2. get role
+    const res2 = await client.GetRole(roleName);
+    console.log('get result: ', res2);
+    console.log('++++++++');
+
+    const res3 = await client.isRoleExist(roleName, {});
+    console.log('isRoleExist result: ', res3);
+    console.log('++++++++');
+
+    const res4 = await client.DeleteRole(roleName, {});
+    console.log('delete result: ', res4);
+    console.log('++++++++');
+
+    const res5 = await client.CheckSCFExcuteRole();
+    console.log('check SCFExcuteRole exist: ', res5);
+  }
 }
 
-new ClientTest().camTest();
+new ClientTest().run();
 
 process.on('unhandledRejection', (e) => {
   throw e;