fix: support async retry config (#238)

* fix(triggers): bulk create trigger delete old bug

* fix(scf): support async retry config

* chore: update jest config

Author: yugasun

__tests__/scf/async.test.ts

@@ -0,0 +1,77 @@
+import { sleep } from '@ygkit/request';
+import { Scf } from '../../src';
+import { ScfDeployInputs } from '../../src/modules/scf/interface';
+
+describe('Scf', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const scf = new Scf(credentials);
+
+  const inputs: ScfDeployInputs = {
+    name: `serverless-test-${Date.now()}`,
+    code: {
+      bucket: process.env.BUCKET,
+      object: 'express_code.zip',
+    },
+    namespace: 'test',
+    role: 'SCF_QcsRole',
+    handler: 'sl_handler.handler',
+    runtime: 'Nodejs12.16',
+    region: 'ap-guangzhou',
+    description: 'Created by Serverless',
+    memorySize: 256,
+    timeout: 20,
+    tags: {
+      test: 'test',
+    },
+    environment: {
+      variables: {
+        TEST: 'value',
+      },
+    },
+  };
+  let outputs;
+
+  test('[asyncRunEnable and traceEnable] create', async () => {
+    await sleep(3000);
+    delete inputs.cls;
+    inputs.asyncRunEnable = true;
+    inputs.traceEnable = true;
+    inputs.msgTTL = 3600;
+    inputs.retryNum = 0;
+    outputs = await scf.deploy(inputs);
+
+    const asyncConfig = await scf.scf.getAsyncRetryConfig(inputs, {} as any);
+
+    expect(outputs.AsyncRunEnable).toBe('TRUE');
+    expect(outputs.TraceEnable).toBe('TRUE');
+    expect(asyncConfig).toEqual({
+      AsyncTriggerConfig: {
+        MsgTTL: 3600,
+        RetryConfig: [
+          { ErrorCode: ['default'], RetryNum: 0, RetryInterval: 60 },
+          { ErrorCode: ['432'], RetryNum: -1, RetryInterval: 60 },
+        ],
+      },
+      RequestId: expect.any(String),
+    });
+  });
+  test('[asyncRunEnable and traceEnable] update', async () => {
+    await sleep(3000);
+    inputs.asyncRunEnable = true;
+    inputs.traceEnable = false;
+    outputs = await scf.deploy(inputs);
+
+    expect(outputs.AsyncRunEnable).toBe('TRUE');
+    expect(outputs.TraceEnable).toBe('FALSE');
+  });
+  test('[asyncRunEnable and traceEnable] remove', async () => {
+    const res = await scf.remove({
+      functionName: inputs.name,
+      ...outputs,
+    });
+    expect(res).toEqual(true);
+  });
+});

__tests__/scf/base.test.ts

@@ -526,30 +526,4 @@ describe('Scf', () => {
     });
     expect(res).toEqual(true);
   });
-  test('[asyncRunEnable and traceEnable] create', async () => {
-    await sleep(3000);
-    delete inputs.cls;
-    inputs.asyncRunEnable = true;
-    inputs.traceEnable = true;
-    outputs = await scf.deploy(inputs);
-
-    expect(outputs.AsyncRunEnable).toBe('TRUE');
-    expect(outputs.TraceEnable).toBe('TRUE');
-  });
-  test('[asyncRunEnable and traceEnable] update', async () => {
-    await sleep(3000);
-    inputs.asyncRunEnable = true;
-    inputs.traceEnable = false;
-    outputs = await scf.deploy(inputs);
-
-    expect(outputs.AsyncRunEnable).toBe('TRUE');
-    expect(outputs.TraceEnable).toBe('FALSE');
-  });
-  test('[asyncRunEnable and traceEnable] remove', async () => {
-    const res = await scf.remove({
-      functionName: inputs.name,
-      ...outputs,
-    });
-    expect(res).toEqual(true);
-  });
 });

jest.config.js

@@ -8,14 +8,15 @@ const config = {
   silent: process.env.CI && !mod,
   testTimeout: 600000,
   testEnvironment: 'node',
-  testRegex: '/__tests__/.*\\.(test|spec)\\.(js|ts)$',
+  testRegex: '/__tests__/[a-z]+/.*\\.(test|spec)\\.(js|ts)$',
   // 由于测试账号没有备案域名，所以线上 CI 忽略 CDN 测试
   testPathIgnorePatterns: [
     '/node_modules/',
     '/__tests__/cdn/',
-    '/__tests__/apigw/apigw.custom-domains.test.ts',
-    '/__tests__/scf/scf.sp.test.ts', // 专门用来验证测试小地域功能发布测试
-    '/__tests__/scf/scf.http.test.ts', // 专门用来验证测试 HTTP 直通
+    '/__tests__/apigw/custom-domains.test.ts',
+    '/__tests__/scf/special.test.ts', // 专门用来验证测试小地域功能发布测试
+    '/__tests__/scf/image.test.ts', // 专门用来验证测试镜像函数
+    '/__tests__/scf/http.test.ts', // 专门用来验证测试 HTTP 直通
     '/__tests__/triggers/mps.test.ts',
     '/__tests__/triggers/manager.test.ts',
   ],
@@ -34,6 +35,22 @@ if (mod) {
       config.testRegex = `/__tests__/${process.env.MODULE}/.*.test.(js|ts)`;
       config.testPathIgnorePatterns = ['/node_modules/'];
     }
+
+    if (mod === 'scf') {
+      config.testPathIgnorePatterns = [
+        '/node_modules/',
+        '/__tests__/scf/special.test.ts', // 专门用来验证测试小地域功能发布测试
+        '/__tests__/scf/image.test.ts', // 专门用来验证测试镜像函数
+        '/__tests__/scf/http.test.ts', // 专门用来验证测试 HTTP 直通];
+      ];
+    }
+    if (mod === 'triggers') {
+      config.testPathIgnorePatterns = [
+        '/node_modules/',
+        '/__tests__/triggers/mps.test.ts',
+        '/__tests__/triggers/manager.test.ts',
+      ];
+    }
   }
 }
 

src/modules/scf/apis.ts

@@ -7,6 +7,8 @@ const ACTIONS = [
   'GetFunction',
   'UpdateFunctionCode',
   'UpdateFunctionConfiguration',
+  'GetFunctionEventInvokeConfig',
+  'UpdateFunctionEventInvokeConfig',
   'CreateTrigger',
   'DeleteTrigger',
   'PublishVersion',

src/modules/scf/entities/scf.ts

@@ -216,6 +216,36 @@ export default class ScfEntity extends BaseEntity {
     return true;
   }
 
+  // 获取异步函数配置
+  async getAsyncRetryConfig(inputs: ScfCreateFunctionInputs, funcInfo: FunctionInfo) {
+    const reqParams = {
+      Namespace: inputs.namespace || funcInfo.Namespace,
+      FunctionName: inputs.name || funcInfo.FunctionName,
+      Qualifier: inputs.qualifier || funcInfo.Qualifier || '$LATEST',
+    };
+
+    const reqInputs: Partial<typeof reqParams> = reqParams;
+
+    const res = await this.request({ Action: 'GetFunctionEventInvokeConfig', ...reqInputs });
+    return res;
+  }
+  async updateAsyncRetry(inputs: ScfCreateFunctionInputs, funcInfo: FunctionInfo) {
+    console.log(`Updating function ${inputs.name} async retry configure, region ${this.region}`);
+    const reqParams = {
+      Namespace: inputs.namespace || funcInfo.Namespace,
+      FunctionName: inputs.name || funcInfo.FunctionName,
+      AsyncTriggerConfig: {
+        MsgTTL: inputs.msgTTL || 21600,
+        RetryConfig: [{ RetryNum: inputs.retryNum ?? 2 }],
+      },
+    };
+
+    const reqInputs: Partial<typeof reqParams> = reqParams;
+
+    await this.request({ Action: 'UpdateFunctionEventInvokeConfig', ...reqInputs });
+    return true;
+  }
+
   // delete function
   async delete({ namespace, functionName }: { namespace: string; functionName: string }) {
     namespace = namespace || CONFIGS.defaultNamespace;

src/modules/scf/index.ts

@@ -288,6 +288,13 @@ export default class Scf {
       await this.scf.updateConfigure(inputs, funcInfo);
     }
 
+    await this.scf.isOperational({ namespace, functionName });
+
+    // 如果是异步函数，判断是否需要更新异步调用重试配置
+    if (inputs.asyncRunEnable) {
+      await this.scf.updateAsyncRetry(inputs, funcInfo!);
+    }
+
     funcInfo = await this.scf.isOperational({ namespace, functionName });
 
     const outputs = (funcInfo as any) || ({} as ScfDeployOutputs);

src/modules/scf/interface.ts

@@ -87,6 +87,7 @@ export interface FunctionInfo {
   Tags: Tag[];
   ClsLogsetId: string;
   ClsTopicId: string;
+  Qualifier: string;
 }
 
 export interface ScfPublishVersionInputs {
@@ -192,6 +193,8 @@ export interface ScfCreateFunctionInputs {
     userId?: string;
   }[];
 
+  qualifier?: string;
+
   asyncRunEnable?: undefined | boolean;
   traceEnable?: undefined | boolean;
   installDependency?: undefined | boolean;
@@ -209,6 +212,10 @@ export interface ScfCreateFunctionInputs {
     // 启动命令参数
     args?: string;
   };
+
+  // 异步调用重试配置
+  msgTTL?: number; // 消息保留时间，单位秒
+  retryNum?: number; // 重试次数
 }
 
 export interface ScfUpdateAliasTrafficInputs {

src/modules/triggers/manager.ts

@@ -202,7 +202,14 @@ export class TriggerManager {
       }
     }
     return {
-      deleteList: deleteList.filter((item) => item) as TriggerDetail[],
+      deleteList: deleteList
+        .filter((item) => item)
+        .map((item) => {
+          return {
+            ...item,
+            triggerType: item?.Type,
+          };
+        }) as TriggerDetail[],
       deployList: deployList.map((item) => {
         delete item?.compared;
         return item as TriggerDetail;