fix(apigw): add remove by trigger for only remove api (#198)

* fix(apigw): get relative id

* fix(apigw): add remove by trigger for only remove api

* test(metrics): update test function name

Author: yugasun

__tests__/metrics.test.ts

@@ -25,7 +25,7 @@ describe('Metrics', () => {
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
   const metrics = new Metrics(credentials, {
-    funcName: 'serverless-test',
+    funcName: 'serverless-unit-test',
   });
 
   const rangeStart = '2020-09-09 10:00:00';

src/modules/apigw/entities/api.ts

@@ -361,10 +361,6 @@ export default class ApiEntity {
     if (exist) {
       apiConfig.apiId = exist.apiId;
       apiConfig.created = exist.created;
-
-      if (isOauthApi) {
-        apiConfig.authRelationApiId = exist.authRelationApiId;
-      }
     }
     if (isOauthApi && !apiConfig.authRelationApiId) {
       // find reletive oauth api

src/modules/apigw/index.ts

@@ -129,15 +129,9 @@ export default class Apigw {
       apiList,
       customDomains,
       usagePlan,
-      isInputServiceId = false,
+      isRemoveTrigger = false,
     } = inputs;
 
-    // 如果用户 yaml 的 inputs 配置了 serviceId，走特殊流程
-    if (isInputServiceId) {
-      await this.removeWithInputServiceId(inputs);
-      return;
-    }
-
     // check service exist
     const detail = await this.request({
       Action: 'DescribeService',
@@ -148,6 +142,20 @@ export default class Apigw {
       return;
     }
 
+    // 1. remove all apis
+    await this.api.bulkRemove({
+      apiList,
+      serviceId,
+      environment,
+    });
+
+    // 定制化需求：如果用户在yaml中配置了 serviceId，则只执行删除 api 逻辑
+    // 删除后需要重新发布
+    if (isRemoveTrigger) {
+      await this.service.release({ serviceId, environment });
+      return;
+    }
+
     // remove usage plan
     if (usagePlan) {
       await this.usagePlan.remove({
@@ -157,13 +165,6 @@ export default class Apigw {
       });
     }
 
-    // 1. remove all apis
-    await this.api.bulkRemove({
-      apiList,
-      serviceId,
-      environment,
-    });
-
     // 2. unbind all custom domains
     if (customDomains) {
       for (let i = 0; i < customDomains.length; i++) {
@@ -231,29 +232,6 @@ export default class Apigw {
 
     return outputs;
   }
-
-  // 定制化需求：如果用户在yaml中配置了 serviceId，则只执行删除 api 逻辑
-  async removeWithInputServiceId(inputs: ApigwRemoveInputs) {
-    const { environment, serviceId, apiList } = inputs;
-
-    // check service exist
-    const detail = await this.request({
-      Action: 'DescribeService',
-      ServiceId: serviceId,
-    });
-
-    if (!detail) {
-      console.log(`Service ${serviceId} not exist`);
-      return;
-    }
-
-    // 1. remove all apis
-    await this.api.bulkRemove({
-      apiList,
-      serviceId,
-      environment,
-    });
-  }
 }
 
 module.exports = Apigw;

src/modules/apigw/interface.ts

@@ -158,6 +158,7 @@ export interface ApigwDeployInputs extends ApigwCreateServiceInputs, ApigwBindCu
 
   endpoints?: ApiEndpoint[];
   isInputServiceId?: boolean;
+  isRemoveTrigger?: boolean;
 }
 
 export type ApigwDeployWithServiceIdInputs = ApigwDeployInputs & { serviceId: string };
@@ -233,4 +234,5 @@ export interface ApigwRemoveInputs {
   customDomains?: ApigwBindCustomDomainOutputs[];
   usagePlan?: ApigwSetupUsagePlanInputs;
   isInputServiceId?: boolean;
+  isRemoveTrigger?: boolean;
 }

src/modules/scf/index.ts

@@ -762,6 +762,7 @@ export default class Scf {
           try {
             // delete apigw trigger
             const curTrigger = inputs.Triggers[i];
+            curTrigger.isRemoveTrigger = true;
             await this.apigwClient.remove(curTrigger);
           } catch (e) {
             console.log(e);

src/modules/triggers/apigw.ts

@@ -145,7 +145,15 @@ export default class ApigwTrigger extends BaseTrigger<ApigwTriggerInputsParams>
     inputs: TriggerInputs<ApigwTriggerInputsParams>;
   }) {
     const { parameters } = inputs;
-    const { oldState, protocols, environment, serviceId, serviceName, serviceDesc } = parameters!;
+    const {
+      oldState,
+      protocols,
+      environment,
+      serviceId,
+      serviceName,
+      serviceDesc,
+      isInputServiceId = false,
+    } = parameters!;
     const endpoints = parameters?.endpoints ?? [{ path: '/', method: 'ANY' }];
     const triggerInputs: ApigwTriggerInputsParams = {
       oldState: oldState ?? {},
@@ -155,7 +163,12 @@ export default class ApigwTrigger extends BaseTrigger<ApigwTriggerInputsParams>
       serviceId,
       serviceName,
       serviceDesc,
-      isInputServiceId: !!serviceId,
+
+      // 定制化需求：是否在 yaml 文件中配置了 apigw 触发器的 serviceId
+      isInputServiceId,
+
+      // 定制化需求：是否是删除云函数的api网关触发器，跟api网关组件区分开
+      isRemoveTrigger: true,
       endpoints: endpoints.map((ep: any) => {
         ep.function = ep.function || {};
         ep.function.functionName = inputs.functionName;