refactor(cloud-function): simplize cloud-function types/class api;

Author: maslow

packages/app-service/src/api/function-log.ts

@@ -1,19 +1,34 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-07-30 10:30:29
- * @LastEditTime: 2021-11-03 16:45:06
+ * @LastEditTime: 2021-11-05 12:06:42
  * @Description: 
  */
+import { ObjectId } from "bson"
 import { Constants } from "../constants"
 import { DatabaseAgent } from "../lib/database"
 
 
+export interface CloudFunctionLogStruct {
+  requestId: string
+  method: string
+  func_id: ObjectId
+  func_name: string
+  logs: string[]
+  time_usage: number
+  data: any
+  error: Error
+  debug?: boolean
+  created_at?: Date
+  created_by?: any
+}
+
 /**
  * Add function execution log
  * @param data 
  * @returns 
  */
-export async function addFunctionLog(data: any): Promise<any> {
+export async function addFunctionLog(data: CloudFunctionLogStruct): Promise<any> {
   const db = DatabaseAgent.db
 
   if (!data) return null

packages/app-service/src/api/function.ts

@@ -1,7 +1,7 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-07-30 10:30:29
- * @LastEditTime: 2021-10-06 19:25:59
+ * @LastEditTime: 2021-11-05 13:38:09
  * @Description: 
  */
 

packages/app-service/src/cloud-sdk/index.ts

@@ -1,6 +1,6 @@
 import { AxiosStatic } from "axios"
 import { Db, getDb } from "database-proxy"
-import { FunctionContext, CloudFunction } from "cloud-function-engine"
+import { FunctionContext } from "cloud-function-engine"
 import { FileStorageInterface } from "../lib/storage/interface"
 import * as mongodb from "mongodb"
 import { DatabaseAgent } from "../lib/database"
@@ -9,6 +9,7 @@ import { SchedulerInstance } from "../lib/scheduler"
 import { getToken, parseToken } from "../lib/utils/token"
 import { invokeInFunction } from "./invoke"
 import { createFileStorage } from "../lib/storage"
+import { CloudFunction } from "../lib/function"
 
 
 export type InvokeFunctionType = (name: string, param: FunctionContext) => Promise<any>

packages/app-service/src/cloud-sdk/invoke.ts

@@ -1,6 +1,7 @@
 import { getFunctionByName } from "../api/function"
-import { CloudFunction, FunctionContext } from "cloud-function-engine"
+import { FunctionContext } from "cloud-function-engine"
 import { addFunctionLog } from "../api/function-log"
+import { CloudFunction } from "../lib/function"
 
 
 /**

packages/app-service/src/lib/function.ts

@@ -0,0 +1,70 @@
+
+
+import * as engine from "cloud-function-engine"
+import { ObjectId } from "mongodb"
+
+export enum FunctionStatus {
+  DISABLED = 0,
+  ENABLED = 1
+}
+
+/**
+ * Extended function struct
+ */
+export interface CloudFunctionStruct extends engine.CloudFunctionStruct {
+  _id: ObjectId
+  description: string
+  tags: string[]
+  label: string
+  triggers: any[]
+  version: number
+  hash: string
+  status: FunctionStatus
+  enableHTTP: boolean
+  appid: string
+  debugParams: string
+  created_at: number
+  updated_at: number
+  created_by: any
+}
+
+
+export class CloudFunction extends engine.CloudFunction {
+  /**
+   * Custom require function in cloud function
+   * @see CloudFunction.require_func
+   * @param module the module id. ex. `path`, `lodash`
+   * @returns 
+   */
+
+  static require_func = (module: string): any => {
+    if (module === '@/cloud-sdk') {
+      return require('../../cloud-sdk')
+    }
+
+    return require(module) as any
+  }
+
+  /**
+  * Function data
+  */
+  protected _data: CloudFunctionStruct
+
+  get id() {
+    return this._data._id
+  }
+
+  /**
+   * Http enabled status
+   */
+  get enableHTTP() {
+    return this._data.enableHTTP
+  }
+
+  /**
+   * Function status which control if the function could be invoked or not
+   */
+  get status() {
+    return this._data.status
+  }
+}

packages/app-service/src/lib/policy-agent/policy-agent.ts

@@ -1,16 +1,16 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-08-04 00:31:53
- * @LastEditTime: 2021-10-06 21:12:34
+ * @LastEditTime: 2021-11-05 13:52:52
  * @Description: 
  */
 
 import assert = require("assert")
 import { AccessorInterface, Params, Policy } from "database-proxy"
-import { CloudFunction } from "cloud-function-engine"
 import { getFunctionByName } from "../../api/function"
 import { InjectionGetter, PolicyAgentInterface, PolicyComposition, PolicyDataStruct } from "./types"
 import { logger } from "../logger"
+import { CloudFunction } from "../function"
 
 
 /**

packages/app-service/src/router/function/debug.ts

@@ -1,16 +1,17 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-07-30 10:30:29
- * @LastEditTime: 2021-11-03 19:41:03
+ * @LastEditTime: 2021-11-05 13:49:11
  * @Description: 
  */
 
 import { Request, Response } from 'express'
-import { FunctionContext, CloudFunction } from 'cloud-function-engine'
+import { FunctionContext } from 'cloud-function-engine'
 import { parseToken } from '../../lib/utils/token'
 import { logger } from '../../lib/logger'
 import { addFunctionLog } from '../../api/function-log'
 import { ObjectId } from 'bson'
+import { CloudFunction } from '../../lib/function'
 
 /**
  * Handler of debugging cloud function

packages/app-service/src/router/function/index.ts

@@ -1,31 +1,17 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-07-30 10:30:29
- * @LastEditTime: 2021-10-07 01:41:39
+ * @LastEditTime: 2021-11-05 13:53:31
  * @Description: 
  */
 
 import { Router } from 'express'
-import { CloudFunction } from 'cloud-function-engine'
 import * as multer from 'multer'
 import * as path from 'path'
 import { handleDebugFunction } from './debug'
 import { handleInvokeFunction } from './invoke'
 import { generateUUID } from '../../lib/utils/rand'
 
-/**
- * Custom require function in cloud function
- * @see CloudFunction.require_func
- * @param module the module id. ex. `path`, `lodash`
- * @returns 
- */
-CloudFunction.require_func = (module): any => {
-  if (module === '@/cloud-sdk') {
-    return require('../../cloud-sdk')
-  }
-  return require(module) as any
-}
-
 export const FunctionRouter = Router()
 
 /**

packages/app-service/src/router/function/invoke.ts

@@ -1,16 +1,17 @@
 /*
  * @Author: Maslow<[email protected]>
  * @Date: 2021-07-30 10:30:29
- * @LastEditTime: 2021-11-03 18:02:23
+ * @LastEditTime: 2021-11-05 13:45:36
  * @Description: 
  */
 
 import { Request, Response } from 'express'
-import { FunctionContext, CloudFunction } from 'cloud-function-engine'
+import { FunctionContext } from 'cloud-function-engine'
 import { getFunctionByName } from '../../api/function'
 import Config from '../../config'
 import { logger } from '../../lib/logger'
 import { addFunctionLog } from '../../api/function-log'
+import { CloudFunction } from '../../lib/function'
 
 
 /**

packages/cloud-function/copy2app.sh

@@ -0,0 +1,4 @@
+rm -rf ../app-service/node_modules/cloud-function-engine/dist
+rm -rf ../app-service/node_modules/cloud-function-engine/src
+cp -r dist ../app-service/node_modules/cloud-function-engine/dist
+cp -r src ../app-service/node_modules/cloud-function-engine/src

packages/cloud-function/copy2sys.sh

@@ -0,0 +1,4 @@
+rm -rf ../system-server/node_modules/cloud-function-engine/dist
+rm -rf ../system-server/node_modules/cloud-function-engine/src
+cp -r dist ../system-server/node_modules/cloud-function-engine/dist
+cp -r src ../system-server/node_modules/cloud-function-engine/src

packages/cloud-function/package.json

@@ -30,7 +30,10 @@
   "scripts": {
     "build": "npx tsc -p tsconfig.json",
     "watch": "npx tsc -p tsconfig.json -w",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "copy2app": "sh copy2app.sh",
+    "copy2sys": "sh copy2sys.sh",
+    "copy4dev": "sh copy2app.sh && sh copy2sys.sh"
   },
   "bugs": {
     "url": "https://github.com/Maslow/less-framework/issues"

packages/cloud-function/src/function.ts

@@ -38,13 +38,6 @@ export class CloudFunction {
    */
   result: FunctionResult
 
-  /**
-   *  函数ID
-   */
-  get id() {
-    return this._data._id
-  }
-
   /**
    * 函数显示名称
    */
@@ -66,20 +59,6 @@ export class CloudFunction {
     return this._data.compiledCode
   }
 
-  /**
-   * 是否允许 HTTP 访问
-   */
-  get enableHTTP() {
-    return this._data.enableHTTP
-  }
-
-  /**
-   * 启停状态
-   */
-  get status() {
-    return this._data.status
-  }
-
   constructor(data: CloudFunctionStruct) {
     assert.ok(data)
     this._data = data

packages/cloud-function/src/types.ts

@@ -51,26 +51,24 @@ export interface FunctionResult {
   error?: Error,
   time_usage: number
 }
-
 /**
  * 云函数的存储结构
  */
 export interface CloudFunctionStruct {
-  _id: string,
-  name: string,
+  /**
+   * 云函数名
+   */
+  name: string
+
   /**
    * 云函数源代码，通常是 ts
    */
-  code: string,
+  code: string
+
   /**
    * 云函数编译后的代码，通常是 js
    */
   compiledCode: string
-  enableHTTP: boolean,
-  status: number,
-  created_by: number,
-  created_at: number
-  updated_at: number
 }
 
 /** Object containing file metadata and access information. */