fix(scf): delete apigw trigger logical

Author: yugasun

__tests__/scf.test.js

@@ -120,12 +120,13 @@ describe('Scf', () => {
     ];
   });
 
-  afterAll(async () => {
+  afterAll(async (done) => {
     await cfs.remove({
       fsName: cfsInputs.fsName,
       fileSystemId: inputs.cfs[0].cfsId,
     });
     await layer.remove(inputs.layers[0]);
+    done();
   });
 
   test('should deploy SCF success', async () => {

package.json

@@ -68,15 +68,15 @@
     "eslint-plugin-import": "^2.20.1",
     "eslint-plugin-prettier": "^3.1.2",
     "husky": "^4.2.3",
-    "jest": "^26.4.2",
+    "jest": "^26.6.3",
     "lint-staged": "^10.0.8",
     "prettier": "^1.19.1",
     "semantic-release": "^17.0.4"
   },
   "dependencies": {
     "@tencent-sdk/capi": "^1.1.5",
     "@tencent-sdk/cls": "^0.1.7",
-    "@ygkit/request": "^0.1.1",
+    "@ygkit/request": "^0.1.3",
     "cos-nodejs-sdk-v5": "^2.6.2",
     "moment": "^2.25.3",
     "tencent-cloud-sdk": "^1.0.5"

src/modules/apigw/index.js

@@ -1,5 +1,6 @@
 const { Capi } = require('@tencent-sdk/capi');
 const Apis = require('./apis');
+const { ApigwTrigger } = require('../triggers');
 const { uniqueArray, camelCaseProperty, isArray } = require('../../utils/index');
 
 class Apigw {
@@ -13,6 +14,7 @@ class Apigw {
       SecretKey: this.credentials.SecretKey,
       Token: this.credentials.Token,
     });
+    this.trigger = new ApigwTrigger(credentials, this.region);
   }
 
   getProtocolString(protocols) {
@@ -38,6 +40,7 @@ class Apigw {
     } catch (e) {
       // no op
     }
+    return true;
   }
 
   marshalServiceConfig(endpoint, apiInputs) {
@@ -871,6 +874,10 @@ class Apigw {
     // 2. delete only apis created by serverless framework
     if (apiConfig.apiId && apiConfig.created === true) {
       console.log(`Removing api ${apiConfig.apiId}`);
+      await this.trigger.remove({
+        serviceId,
+        apiId: apiConfig.apiId,
+      });
       await this.removeOrUnbindRequest({
         Action: 'DeleteApi',
         apiId: apiConfig.apiId,

src/modules/scf/index.js

@@ -1,4 +1,4 @@
-const { sleep } = require('@ygkit/request');
+const { sleep, waitResponse } = require('@ygkit/request');
 const { Capi } = require('@tencent-sdk/capi');
 const { TypeError, ApiError } = require('../../utils/error');
 const { deepClone, strip } = require('../../utils');
@@ -293,13 +293,28 @@ class Scf {
     });
   }
 
-  // 删除函数
+  // delete function
   async deleteFunction(namespace, functionName) {
-    await this.request({
+    namespace = namespace || CONFIGS.defaultNamespace;
+    const res = await this.request({
       Action: 'DeleteFunction',
       FunctionName: functionName,
-      Namespace: namespace || CONFIGS.defaultNamespace,
+      Namespace: namespace,
     });
+
+    try {
+      await waitResponse({
+        callback: async () => this.getFunction(namespace, functionName),
+        targetResponse: null,
+        timeout: 120 * 1000,
+      });
+    } catch (e) {
+      throw new ApiError({
+        type: 'API_SCF_DeleteFunction',
+        message: `Cannot delete function in 2 minutes, (reqId: ${res.RequestId})`,
+      });
+    }
+    return true;
   }
 
   /**
@@ -616,8 +631,6 @@ class Scf {
       return false;
     }
 
-    await this.deleteFunction(namespace, functionName);
-
     try {
       await this.isOperationalStatus(namespace, functionName);
     } catch (e) {}
@@ -636,6 +649,8 @@ class Scf {
       }
     }
 
+    await this.deleteFunction(namespace, functionName);
+
     console.log(`Remove function ${functionName} and it's triggers success`);
 
     return true;

src/modules/triggers/apigw.js

@@ -0,0 +1,89 @@
+const BaseTrigger = require('./base');
+const Apis = require('./apis');
+
+class ApigwTrigger extends BaseTrigger {
+  async removeScfTrigger({ serviceId, apiId, functionName, namespace, qualifier }) {
+    // 1. get all trigger list
+    const allList = await this.getTriggerList({
+      functionName,
+      namespace,
+      qualifier,
+    });
+
+    // 2. get apigw trigger list
+    const apigwList = allList.filter((item) => item.Type === 'apigw');
+
+    const [curApiTrigger] = apigwList.filter(({ ResourceId }) => {
+      return ResourceId.indexOf(`service/${serviceId}/API/${apiId}`) !== -1;
+    });
+
+    // 3. remove current apigw trigger
+    if (curApiTrigger) {
+      try {
+        await Apis.SCF.DeleteTrigger(this.capi, {
+          Type: 'apigw',
+          FunctionName: functionName,
+          Namespace: namespace,
+          Qualifier: qualifier,
+          TriggerDesc: curApiTrigger.TriggerDesc,
+          TriggerName: curApiTrigger.TriggerName,
+        });
+      } catch (e) {
+        console.log(e);
+      }
+    }
+  }
+  async remove({ serviceId, apiId }) {
+    // get api detail
+    const apiDetail = await Apis.APIGW.DescribeApi(this.capi, {
+      ServiceId: serviceId,
+      ApiId: apiId,
+    });
+    if (!apiDetail) {
+      return true;
+    }
+
+    // 1. scf type
+    if (apiDetail.ServiceScfFunctionName) {
+      await this.removeScfTrigger({
+        serviceId,
+        apiId,
+        functionName: apiDetail.ServiceScfFunctionName,
+        namespace: apiDetail.ServiceScfFunctionNamespace,
+        qualifier: apiDetail.ServiceScfFunctionQualifier,
+      });
+    }
+
+    // 2. ws type
+    if (apiDetail.ServiceWebsocketRegisterFunctionName) {
+      await this.removeScfTrigger({
+        serviceId,
+        apiId,
+        functionName: apiDetail.ServiceWebsocketRegisterFunctionName,
+        namespace: apiDetail.ServiceWebsocketRegisterFunctionNamespace,
+        qualifier: apiDetail.ServiceWebsocketRegisterFunctionQualifier,
+      });
+    }
+    if (apiDetail.ServiceWebsocketCleanupFunctionName) {
+      await this.removeScfTrigger({
+        serviceId,
+        apiId,
+        functionName: apiDetail.ServiceWebsocketCleanupFunctionName,
+        namespace: apiDetail.ServiceWebsocketCleanupFunctionNamespace,
+        qualifier: apiDetail.ServiceWebsocketCleanupFunctionQualifier,
+      });
+    }
+    if (apiDetail.ServiceWebsocketTransportFunctionName) {
+      await this.removeScfTrigger({
+        serviceId,
+        apiId,
+        functionName: apiDetail.ServiceWebsocketTransportFunctionName,
+        namespace: apiDetail.ServiceWebsocketTransportFunctionNamespace,
+        qualifier: apiDetail.ServiceWebsocketTransportFunctionQualifier,
+      });
+    }
+    return true;
+  }
+}
+
+module.exports = ApigwTrigger;

src/modules/triggers/apis.js

@@ -0,0 +1,38 @@
+const { ApiFactory } = require('../../utils/api');
+const { ApiError } = require('../../utils/error');
+
+const SCF_ACTIONS = ['CreateTrigger', 'DeleteTrigger', 'ListTriggers'];
+const APIGW_ACTIONS = ['DescribeApi'];
+
+const SCF = ApiFactory({
+  // debug: true,
+  serviceType: 'scf',
+  version: '2018-04-16',
+  actions: SCF_ACTIONS,
+});
+
+const APIGW = ApiFactory({
+  // debug: true,
+  serviceType: 'apigateway',
+  version: '2018-08-08',
+  actions: APIGW_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 = {
+  SCF,
+  APIGW,
+};

src/modules/triggers/base.js

@@ -0,0 +1,44 @@
+const { Capi } = require('@tencent-sdk/capi');
+
+const Apis = require('./apis');
+
+class BaseTrigger {
+  constructor(credentials = {}, region) {
+    this.region = region || 'ap-guangzhou';
+    this.credentials = credentials;
+
+    this.credentials = 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 getTriggerList({ functionName, namespace = 'default', qualifier }) {
+    const listOptions = {
+      FunctionName: functionName,
+      Namespace: namespace,
+      Limit: 100,
+    };
+    if (qualifier) {
+      listOptions.Filters = [
+        {
+          Name: 'Qualifier',
+          Values: [qualifier],
+        },
+      ];
+    }
+    const { Triggers = [], TotalCount } = await Apis.SCF.ListTriggers(this.capi, listOptions);
+    if (TotalCount > 100) {
+      const res = await this.getTriggerList(functionName, namespace, qualifier);
+      return Triggers.concat(res);
+    }
+
+    return Triggers;
+  }
+}
+
+module.exports = BaseTrigger;

src/modules/triggers/index.js

@@ -0,0 +1,5 @@
+const ApigwTrigger = require('./apigw');
+
+module.exports = {
+  ApigwTrigger,
+};