feat(scf): support http type (#227)

yugasun · web-flow · commit 20e2cc6eea10 · 2021-06-08T11:11:15.000+08:00
* feat(scf): support http type
* chore: fix test config
diff --git a/.gitignore b/.gitignore
@@ -23,3 +23,5 @@ lib
 env.js
 package-lock.json
 yarn.lock
+
+__tests__/apigw.list.test.ts
diff --git a/__tests__/scf.http.test.ts b/__tests__/scf.http.test.ts
@@ -0,0 +1,89 @@
+import { sleep } from '@ygkit/request';
+import { ScfDeployInputs } from '../src/modules/scf/interface';
+import { Scf } from '../src';
+
+describe('Scf - http', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const scf = new Scf(credentials, 'ap-chongqing');
+
+  const triggers = {
+    apigw: {
+      apigw: {
+        parameters: {
+          serviceName: 'serverless_test',
+          protocols: ['http', 'https'],
+          endpoints: [
+            {
+              path: '/',
+              method: 'ANY',
+              function: {
+                type: 'web',
+              },
+            },
+          ],
+        },
+      },
+    },
+  };
+
+  const events = Object.entries(triggers).map(([, value]) => value);
+
+  const inputs: ScfDeployInputs = {
+    // name: `serverless-test-http-${Date.now()}`,
+    name: `serverless-test-http`,
+    code: {
+      bucket: 'test-chongqing',
+      object: 'express_http.zip',
+    },
+    type: 'web',
+    namespace: 'default',
+    runtime: 'Nodejs12.16',
+    region: 'ap-chongqing',
+    description: 'Created by Serverless',
+    memorySize: 256,
+    timeout: 20,
+    tags: {
+      test: 'test',
+    },
+    environment: {
+      variables: {
+        TEST: 'value',
+      },
+    },
+    events,
+  };
+
+  let outputs;
+
+  test('deploy', async () => {
+    outputs = await scf.deploy(inputs);
+    expect(outputs.FunctionName).toBe(inputs.name);
+    expect(outputs.Type).toBe('HTTP');
+    expect(outputs.Qualifier).toBe('$LATEST');
+    expect(outputs.Description).toBe('Created by Serverless');
+    expect(outputs.Timeout).toBe(inputs.timeout);
+    expect(outputs.MemorySize).toBe(inputs.memorySize);
+    expect(outputs.Runtime).toBe(inputs.runtime);
+  });
+  test('update', async () => {
+    await sleep(3000);
+    outputs = await scf.deploy(inputs);
+    expect(outputs.FunctionName).toBe(inputs.name);
+    expect(outputs.Type).toBe('HTTP');
+    expect(outputs.Qualifier).toBe('$LATEST');
+    expect(outputs.Description).toBe('Created by Serverless');
+    expect(outputs.Timeout).toBe(inputs.timeout);
+    expect(outputs.MemorySize).toBe(inputs.memorySize);
+    expect(outputs.Runtime).toBe(inputs.runtime);
+  });
+  test('remove', async () => {
+    const res = await scf.remove({
+      functionName: inputs.name,
+      ...outputs,
+    });
+    expect(res).toEqual(true);
+  });
+});
diff --git a/jest.config.js b/jest.config.js
@@ -15,6 +15,7 @@ const config = {
     '/__tests__/cdn.test.ts',
     '/__tests__/apigw.custom-domains.test.ts',
     '/__tests__/scf.sp.test.ts', // 专门用来验证测试小地域功能发布测试
+    '/__tests__/scf.http.test.ts', // 专门用来验证测试 HTTP 直通
     '/__tests__/triggers/mps.test.ts',
     '/__tests__/trigger.manager.test.ts',
   ],
diff --git a/src/modules/apigw/apis.ts b/src/modules/apigw/apis.ts
@@ -34,6 +34,8 @@ const ACTIONS = [
   'DescribeServiceSubDomainMappings',
   'BindSubDomain',
   'UnBindSubDomain',
+  'DescribeServicesStatus',
+  'DescribeServiceEnvironmentList',
 ] as const;
 
 export type ActionType = typeof ACTIONS[number];
diff --git a/src/modules/apigw/entities/api.ts b/src/modules/apigw/entities/api.ts
@@ -461,6 +461,7 @@ export default class ApiEntity {
             );
           }
           apiInputs.serviceScfFunctionName = endpoint.function.functionName;
+          apiInputs.serviceScfFunctionType = endpoint.function.functionType;
           apiInputs.serviceScfFunctionNamespace = endpoint.function.functionNamespace || 'default';
           apiInputs.serviceScfIsIntegratedResponse = endpoint.function.isIntegratedResponse
             ? true
diff --git a/src/modules/apigw/entities/service.ts b/src/modules/apigw/entities/service.ts
@@ -39,6 +39,28 @@ export default class ServiceEntity {
     return result as never;
   }
 
+  /**
+   * 获取 API 网关列表
+   * @param options 参数
+   * @returns 网关列表
+   */
+  async list(options?: { offset?: number; limit?: number }) {
+    options = {
+      ...{ limit: 10, offset: 0 },
+      ...(options || {}),
+    };
+    try {
+      const res: { TotalCount: number; ServiceSet: any[] } = await this.request({
+        Action: 'DescribeServicesStatus',
+        Offset: options.offset,
+        Limit: options.limit,
+      });
+      return res.ServiceSet || [];
+    } catch (e) {
+      return [];
+    }
+  }
+
   async getById(serviceId: string) {
     try {
       const detail: Detail = await this.request({
@@ -52,6 +74,112 @@ export default class ServiceEntity {
     }
   }
 
+  async removeApiUsagePlan(ServiceId: string) {
+    const { ApiUsagePlanList = [] } = await this.request({
+      Action: 'DescribeApiUsagePlan',
+      ServiceId,
+    });
+
+    for (let i = 0; i < ApiUsagePlanList.length; i++) {
+      const { UsagePlanId, Environment, ApiId } = ApiUsagePlanList[i];
+      console.log(`APIGW - Removing api usage plan: ${UsagePlanId}`);
+      const { AccessKeyList = [] } = await this.request({
+        Action: 'DescribeUsagePlanSecretIds',
+        UsagePlanId: UsagePlanId,
+        Limit: 100,
+      });
+
+      const AccessKeyIds = AccessKeyList.map((item: { SecretId: string }) => item.SecretId);
+
+      if (AccessKeyIds && AccessKeyIds.length > 0) {
+        await this.request({
+          Action: 'UnBindSecretIds',
+          UsagePlanId: UsagePlanId,
+          AccessKeyIds: AccessKeyIds,
+        });
+        // delelet all created api key
+        for (let sIdx = 0; sIdx < AccessKeyIds.length; sIdx++) {
+          await this.request({
+            Action: 'DisableApiKey',
+            AccessKeyId: AccessKeyIds[sIdx],
+          });
+        }
+      }
+
+      // unbind environment
+      await this.request({
+        Action: 'UnBindEnvironment',
+        ServiceId,
+        UsagePlanIds: [UsagePlanId],
+        Environment: Environment,
+        BindType: 'API',
+        ApiIds: [ApiId],
+      });
+
+      await this.request({
+        Action: 'DeleteUsagePlan',
+        UsagePlanId: UsagePlanId,
+      });
+    }
+  }
+
+  async removeById(serviceId: string) {
+    try {
+      const { ApiIdStatusSet = [] } = await this.request({
+        Action: 'DescribeApisStatus',
+        ServiceId: serviceId,
+        Limit: 100,
+      });
+
+      // remove all apis
+      for (let i = 0; i < ApiIdStatusSet.length; i++) {
+        const { ApiId } = ApiIdStatusSet[i];
+
+        await this.removeApiUsagePlan(serviceId);
+
+        console.log(`APIGW - Removing api: ${ApiId}`);
+
+        await this.request({
+          Action: 'DeleteApi',
+          ServiceId: serviceId,
+          ApiId,
+        });
+      }
+
+      // unrelease service
+      // get environment list
+      const { EnvironmentList = [] } = await this.request({
+        Action: 'DescribeServiceEnvironmentList',
+        ServiceId: serviceId,
+      });
+
+      for (let i = 0; i < EnvironmentList.length; i++) {
+        const { EnvironmentName, Status } = EnvironmentList[i];
+        if (Status === 1) {
+          try {
+            console.log(
+              `APIGW - Unreleasing service: ${serviceId}, environment: ${EnvironmentName}`,
+            );
+            await this.request({
+              Action: 'UnReleaseService',
+              ServiceId: serviceId,
+              EnvironmentName,
+            });
+          } catch (e) {}
+        }
+      }
+
+      // delete service
+      console.log(`APIGW - Removing service: ${serviceId}`);
+      await this.request({
+        Action: 'DeleteService',
+        ServiceId: serviceId,
+      });
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
   /** 创建 API 网关服务 */
   async create(serviceConf: ApigwCreateServiceInputs): Promise<ApigwCreateOrUpdateServiceOutputs> {
     const {
diff --git a/src/modules/scf/entities/scf.ts b/src/modules/scf/entities/scf.ts
@@ -184,12 +184,14 @@ export default class ScfEntity extends BaseEntity {
 
     const reqInputs: Partial<typeof reqParams> = reqParams;
 
-    // 更新函数接口不能传递一下参数
+    // 更新函数接口不能传递以下参数
+    delete reqInputs.Type;
     delete reqInputs.Handler;
     delete reqInputs.Code;
     delete reqInputs.CodeSource;
     delete reqInputs.AsyncRunEnable;
     delete reqInputs.InstallDependency;
+    delete reqInputs.DeployMode;
 
     // +++++++++++++++++++++++
     // FIXME: 以下是函数绑定层逻辑，当函数有一个层，更新的时候想删除，需要传递参数 Layers 不能为空，必须包含特殊元素：{ LayerName: '', LayerVersion: 0 }
diff --git a/src/modules/scf/interface.ts b/src/modules/scf/interface.ts
@@ -83,6 +83,8 @@ export interface ScfCreateFunctionInputs {
   Namespace?: string;
 
   name: string;
+  type?: string;
+  deployMode?: string;
   code?: {
     bucket: string;
     object: string;
diff --git a/src/modules/scf/utils.ts b/src/modules/scf/utils.ts
@@ -18,6 +18,8 @@ export const formatInputs = (region: RegionType, inputs: ScfCreateFunctionInputs
     Timeout?: number;
     InitTimeout?: number;
     MemorySize?: number;
+    Type?: 'HTTP' | 'Event';
+    DeployMode?: 'code' | 'image';
     PublicNetConfig?: {
       PublicNetStatus: 'ENABLE' | 'DISABLE';
       EipConfig: {
@@ -53,7 +55,8 @@ export const formatInputs = (region: RegionType, inputs: ScfCreateFunctionInputs
       CosBucketName: inputs.code?.bucket,
       CosObjectName: inputs.code?.object,
     },
-    Handler: inputs.handler,
+    Type: inputs.type === 'web' ? 'HTTP' : 'Event',
+    DeployMode: inputs.deployMode === 'image' ? 'image' : 'code',
     Runtime: inputs.runtime,
     Namespace: inputs.namespace || CONFIGS.defaultNamespace,
     Timeout: +(inputs.timeout || CONFIGS.defaultTimeout),
@@ -69,6 +72,19 @@ export const formatInputs = (region: RegionType, inputs: ScfCreateFunctionInputs
     InstallDependency: inputs.installDependency === true ? 'TRUE' : 'FALSE',
   };
 
+  // 只有 Event 函数才支持
+  if (inputs.type !== 'web') {
+    functionInputs.Handler = inputs.handler;
+
+    if (inputs.asyncRunEnable !== undefined) {
+      functionInputs.AsyncRunEnable = inputs.asyncRunEnable === true ? 'TRUE' : 'FALSE';
+    }
+
+    if (inputs.traceEnable !== undefined) {
+      functionInputs.TraceEnable = inputs.traceEnable === true ? 'TRUE' : 'FALSE';
+    }
+  }
+
   // 非必须参数
   if (inputs.role) {
     functionInputs.Role = inputs.role;
@@ -143,13 +159,5 @@ export const formatInputs = (region: RegionType, inputs: ScfCreateFunctionInputs
     });
   }
 
-  if (inputs.asyncRunEnable !== undefined) {
-    functionInputs.AsyncRunEnable = inputs.asyncRunEnable === true ? 'TRUE' : 'FALSE';
-  }
-
-  if (inputs.traceEnable !== undefined) {
-    functionInputs.TraceEnable = inputs.traceEnable === true ? 'TRUE' : 'FALSE';
-  }
-
   return functionInputs;
 };
diff --git a/src/modules/triggers/apigw.ts b/src/modules/triggers/apigw.ts
@@ -176,6 +176,8 @@ export default class ApigwTrigger extends BaseTrigger<ApigwTriggerInputsParams>
         ep.function.functionName = inputs.functionName;
         ep.function.functionNamespace = inputs.namespace || namespace || 'default';
         ep.function.functionQualifier = ep.function.functionQualifier ?? '$DEFAULT';
+        // HTTP - Web 类型，EVENT - 时间类型
+        ep.function.functionType = ep.function.type === 'web' ? 'HTTP' : 'EVENT';
         return ep;
       }),
       netTypes: parameters?.netTypes,
diff --git a/src/modules/triggers/base.ts b/src/modules/triggers/base.ts
@@ -35,13 +35,7 @@ export default abstract class BaseTrigger<P = TriggerInputsParams> {
 
   abstract getKey(triggerType: CreateTriggerReq): Promise<string> | string;
 
-  abstract formatInputs({
-    region,
-    inputs,
-  }: {
-    region: RegionType;
-    inputs: TriggerInputs<P>;
-  }):
+  abstract formatInputs({ region, inputs }: { region: RegionType; inputs: TriggerInputs<P> }):
     | {
         triggerKey: string;
         triggerInputs: P;

Original file line number	Diff line number	Diff line change
`@@ -461,6 +461,7 @@ export default class ApiEntity {`
`461`	`461`	`);`
`462`	`462`	`}`
`463`	`463`	`apiInputs.serviceScfFunctionName = endpoint.function.functionName;`
	`464`	`+ apiInputs.serviceScfFunctionType = endpoint.function.functionType;`
`464`	`465`	`apiInputs.serviceScfFunctionNamespace = endpoint.function.functionNamespace \|\| 'default';`
`465`	`466`	`apiInputs.serviceScfIsIntegratedResponse = endpoint.function.isIntegratedResponse`
`466`	`467`	`? true`