fix(faas): get namespace bug

Author: yugasun

packages/faas/__tests__/index.test.ts

@@ -1,4 +1,4 @@
-import { FaaS } from '../src';
+import { FaaS, InvokeResult } from '../src';
 
 describe('FaaS', () => {
   const region = 'ap-guangzhou';
@@ -13,6 +13,7 @@ describe('FaaS', () => {
   };
   let reqId = '';
   const faas = new FaaS({
+    debug: !!process.env.DEBUG,
     secretId: process.env.TENCENT_SECRET_ID,
     secretKey: process.env.TENCENT_SECRET_KEY,
     token: process.env.TENCENT_TOKEN,
@@ -48,9 +49,9 @@ describe('FaaS', () => {
   });
 
   test('invoke', async () => {
-    const res = await faas.invoke({
+    const res = (await faas.invoke({
       ...faasConfig,
-    });
+    })) as InvokeResult;
 
     expect(res).toEqual({
       billDuration: expect.any(Number),
@@ -62,6 +63,8 @@ describe('FaaS', () => {
       log: expect.any(String),
       retMsg: expect.any(String),
     });
+
+    reqId = res.functionRequestId;
   });
   test('invoke with wrong region', async () => {
     try {
@@ -114,30 +117,30 @@ describe('FaaS', () => {
     expect(res).toBeInstanceOf(Array);
   });
 
-  if (reqId) {
-    test('getLogDetail', async () => {
-      const res = await faas.getLogDetail({
-        ...faasConfig,
-        ...clsConfig,
-        reqId,
-      });
-      expect(res).toBeInstanceOf(Array);
+  test('getLogDetail', async () => {
+    const res = await faas.getLogDetail({
+      ...faasConfig,
+      ...clsConfig,
+      reqId,
     });
-    test('getLogByReqId', async () => {
-      const res = await faas.getLogByReqId({
-        ...faasConfig,
-        reqId,
-      });
-      expect(res).toEqual({
-        requestId: reqId,
-        retryNum: 0,
-        startTime: expect.any(String),
-        memoryUsage: expect.any(String),
-        duration: expect.any(String),
-        message: expect.any(String),
-      });
+    expect(res).toBeInstanceOf(Array);
+  });
+  test('getLogByReqId', async () => {
+    const res = await faas.getLogByReqId({
+      ...faasConfig,
+      reqId,
     });
-  }
+
+    expect(res).toEqual({
+      requestId: reqId,
+      retryNum: 0,
+      startTime: expect.any(String),
+      memoryUsage: expect.any(String),
+      duration: expect.any(String),
+      message: expect.any(String),
+      isCompleted: expect.any(Boolean),
+    });
+  });
 
   test('getMetric', async () => {
     const res = await faas.getMetric({

packages/faas/src/apis.ts

@@ -1,4 +1,4 @@
-import { ServiceType, ApiFactory } from '@tencent-sdk/capi';
+import { Capi, ServiceType, ApiFactory } from '@tencent-sdk/capi';
 
 const ACTIONS = [
   'CreateFunction',
@@ -22,11 +22,22 @@ const ACTIONS = [
 
 export type ActionType = typeof ACTIONS[number];
 
-const APIS = ApiFactory({
-  isV3: true,
-  serviceType: ServiceType.faas,
-  version: '2018-04-16',
-  actions: ACTIONS,
-});
+export type ApiMap = Record<ActionType, (capi: Capi, inputs: any) => any>;
 
-export default APIS;
+function initializeApis({
+  isV3 = true,
+  debug = false,
+}: {
+  isV3?: boolean;
+  debug?: boolean;
+}): ApiMap {
+  return ApiFactory({
+    isV3,
+    debug,
+    serviceType: ServiceType.faas,
+    version: '2018-04-16',
+    actions: ACTIONS,
+  });
+}
+
+export { initializeApis };

packages/faas/src/index.ts

@@ -3,8 +3,8 @@ import { camelCaseProps } from '@tencent-sdk/common';
 import { Capi, ServiceType, CommonError } from '@tencent-sdk/capi';
 import { Cls } from '@tencent-sdk/cls';
 import { dtz, dayjs, formatDate, Dayjs, TIME_FORMAT } from './dayjs';
-import APIS, { ActionType } from './apis';
-import { getSearchSql } from './utils';
+import { initializeApis, ApiMap, ActionType } from './apis';
+import { getSearchSql, formatFaasLog } from './utils';
 import { Monitor } from './monitor';
 import {
   Credentials,
@@ -16,7 +16,6 @@ import {
   GetLogOptions,
   GetLogDetailOptions,
   ClsConfig,
-  LogContent,
   SearchLogItem,
   SearchLogDetailItem,
   InvokeOptions,
@@ -37,9 +36,11 @@ export * from './monitor';
 export class FaaS {
   credentials: Credentials;
   region: string;
+  debug: boolean;
   capi: Capi;
   cls: Cls;
   monitor: Monitor;
+  apis: ApiMap;
   clsConfigCache: { [prop: string]: { logsetId: string; topicId: string } };
 
   constructor({
@@ -54,6 +55,7 @@ export class FaaS {
       secretKey,
       token,
     };
+    this.debug = debug;
     this.region = region;
     this.capi = new Capi({
       debug,
@@ -82,6 +84,10 @@ export class FaaS {
 
     // 函数 CLS 配置缓存
     this.clsConfigCache = {};
+
+    this.apis = initializeApis({
+      debug,
+    });
   }
 
   /**
@@ -108,7 +114,7 @@ export class FaaS {
     Action: ActionType;
     [key: string]: any;
   }) {
-    const result = await APIS[Action](this.capi, data);
+    const result = await this.apis[Action](this.capi, data);
     return result;
   }
 
@@ -154,7 +160,8 @@ export class FaaS {
       });
       Namespaces = Namespaces.concat(res);
     }
-    return Namespaces.map((item: { Name: string }) => item.Name);
+
+    return Namespaces;
   }
 
   /**
@@ -207,7 +214,10 @@ export class FaaS {
   }: GetFaasOptions): Promise<FunctionInfo | null> {
     try {
       // 判断 namespace 是否存在
-      const namespaces = await this.getNamespaces();
+      const namespacesList = await this.getNamespaces();
+      const namespaces = namespacesList.map(
+        (item: { Name: string }) => item.Name,
+      );
       if (namespaces.indexOf(namespace) === -1) {
         throw new CommonError(ERRORS.NAMESPACE_NOT_EXIST_ERROR);
       }
@@ -425,6 +435,7 @@ export class FaaS {
     const logs = [];
     for (let i = 0, len = results.length; i < len; i++) {
       const curReq = results[i];
+      curReq.isCompleted = false;
       curReq.startTime = formatDate(curReq.startTime);
 
       const detailLog = await this.getLogDetail({
@@ -434,20 +445,12 @@ export class FaaS {
         startTime: startDate.format(TIME_FORMAT),
         endTime: endDate.format(TIME_FORMAT),
       });
-      curReq.message = (detailLog || [])
-        .map(({ content }: { content: string }) => {
-          try {
-            const info = JSON.parse(content) as LogContent;
-            if (info.SCF_Type === 'Custom') {
-              curReq.memoryUsage = info.SCF_MemUsage;
-              curReq.duration = info.SCF_Duration;
-            }
-            return info.SCF_Message;
-          } catch (e) {
-            return '';
-          }
-        })
-        .join('');
+      const formatedInfo = formatFaasLog(detailLog || []);
+      curReq.message = formatedInfo.message;
+      curReq.memoryUsage = formatedInfo.memoryUsage;
+      curReq.isCompleted = formatedInfo.isCompleted;
+      curReq.duration = formatedInfo.duration;
+
       logs.push(curReq);
     }
     return logs;
@@ -513,7 +516,9 @@ export class FaaS {
     }
     const endDate = dayjs(endTime);
 
-    console.log(`[FAAS] 通过请求 ID 获取日志: ${reqId}`);
+    if (this.debug) {
+      console.log(`[FAAS] 通过请求 ID 获取日志: ${reqId}`);
+    }
 
     const detailLog = await this.getLogDetail({
       logsetId: logsetId,
@@ -529,22 +534,13 @@ export class FaaS {
       memoryUsage: '',
       duration: '',
       message: '',
+      isCompleted: false,
     };
-    curReq.message = (detailLog || [])
-      .map(({ content, timestamp }) => {
-        try {
-          const info = JSON.parse(content) as LogContent;
-          if (info.SCF_Type === 'Custom') {
-            curReq.memoryUsage = info.SCF_MemUsage;
-            curReq.duration = info.SCF_Duration;
-            curReq.startTime = timestamp;
-          }
-          return info.SCF_Message;
-        } catch (e) {
-          return '';
-        }
-      })
-      .join('');
+    const formatedInfo = formatFaasLog(detailLog || []);
+    curReq.message = formatedInfo.message;
+    curReq.memoryUsage = formatedInfo.memoryUsage;
+    curReq.isCompleted = formatedInfo.isCompleted;
+    curReq.duration = formatedInfo.duration;
 
     return curReq;
   }

packages/faas/src/typings/index.ts

@@ -178,6 +178,7 @@ export interface SearchLogItem {
   memoryUsage: string;
   duration: string;
   message: string;
+  isCompleted: boolean;
 }
 
 // 查询得到的日志详情日志

packages/faas/src/utils.ts

@@ -1,3 +1,4 @@
+import { LogContent } from './typings/index';
 import { StatusSqlMap, GetLogOptions } from './typings';
 
 const StatusMap: StatusSqlMap = {
@@ -39,3 +40,42 @@ export function getSearchSql(options: GetLogOptions) {
 
   return sql;
 }
+
+/**
+ * 判断请求日志是否是完整的
+ * @param {string} msg - log message
+ * @returns {boolean}
+ */
+export function isCompleteRequest(msg: string) {
+  return msg.indexOf('END RequestId') > -1;
+}
+
+export function formatFaasLog(detailLog: { content: string }[]) {
+  let memoryUsage = '';
+  let duration = '';
+  let isCompleted = false;
+  let message = (detailLog || [])
+    .map(({ content }: { content: string }) => {
+      try {
+        const info = JSON.parse(content) as LogContent;
+        if (info.SCF_Type === 'Custom') {
+          memoryUsage = info.SCF_MemUsage;
+          duration = info.SCF_Duration;
+        }
+        // 判断当前调用是否完成，如果完成则设置 isCompleted 为 true
+        if (!isCompleted) {
+          isCompleted = isCompleteRequest(info.SCF_Message);
+        }
+        return info.SCF_Message;
+      } catch (e) {
+        return '';
+      }
+    })
+    .join('');
+  return {
+    memoryUsage,
+    duration,
+    isCompleted,
+    message,
+  };
+}