feat(runtime): check circular dependency (#1448)

* feat(runtime): check import

* feat: add check circular dependency

Author: skyoct

runtimes/nodejs/src/support/function-engine/cache.ts

@@ -33,14 +33,14 @@ export class FunctionCache {
    * @param module
    * @returns
    */
-  static requireCloudFunction(moduleName: string): any {
+  static requireCloudFunction(moduleName: string, fromModules?: string[]): any {
     const func = FunctionCache.cache.get(moduleName)
     assert(
       func,
       `require cloud function failed: function ${moduleName} not found`,
     )
-    const funcRequire = new FunctionRequire(this.requireFunc)
-    const module = funcRequire.load(func.name, func.source.compiled)
+    const funcRequire = new FunctionRequire(this.requireFunc, fromModules)
+    const module = funcRequire.load(func.name, func.source.compiled, fromModules)
     return module
   }
 
@@ -87,12 +87,20 @@ export class FunctionCache {
    * @param module the module id. ex. `path`, `lodash`
    * @returns
    */
-  static requireFunc: RequireFuncType = (module: string): any => {
+  static requireFunc: RequireFuncType = (module: string, fromModules?: string[]): any => {
     if (module === '@/cloud-sdk') {
       return require('@lafjs/cloud')
     }
     if (module.startsWith('@/')) {
-      return FunctionCache.requireCloudFunction(module.replace('@/', ''))
+      const cloudModule = module.replace('@/', '')
+
+      // check circular dependency
+      const index = fromModules?.indexOf(cloudModule)
+      if (index !== -1) {
+        throw new Error(`Circular dependency detected: ${fromModules.slice(index).join(' -> ')} -> ${cloudModule}`)
+      }
+
+      return FunctionCache.requireCloudFunction(cloudModule, fromModules)
     }
     return require(module) as any
   }

runtimes/nodejs/src/support/function-engine/engine.ts

@@ -66,6 +66,10 @@ export class FunctionEngine {
    */
   wrap(code: string): string {
     const wrapped = `
+      const require = (module) => {
+        fromModules.push(__filename)
+        return requireFunc(module, fromModules)
+      }
       ${code}; 
       const __main__ = exports.main || exports.default
       if(!__main__) { throw new Error('FunctionExecError: main function not found') }

runtimes/nodejs/src/support/function-engine/require.ts

@@ -7,9 +7,11 @@ const defaultRequireFunction: RequireFuncType = (module): any => {
 
 export class FunctionRequire {
   requireFunc: RequireFuncType
+  fromModules: string[]
 
-  constructor(requireFunc?: RequireFuncType) {
+  constructor(requireFunc?: RequireFuncType, fromModules?: string[]) {
     this.requireFunc = requireFunc ?? defaultRequireFunction
+    this.fromModules = fromModules ?? []
   }
 
   /**
@@ -18,13 +20,13 @@ export class FunctionRequire {
    * @param code
    * @returns
    */
-  load(name: string, code: string): any {
+  load(name: string, code: string, fromModules: string[]): any {
     const context = {
       __function_name: name,
       requestId: '',
     }
 
-    const sandbox = FunctionVm.buildSandbox(context, this.requireFunc)
+    const sandbox = FunctionVm.buildSandbox(context, this.requireFunc, fromModules)
     const wrapped = this.warp(code)
     const script = FunctionVm.createVM(wrapped, {})
     return script.runInNewContext(sandbox, {})
@@ -37,6 +39,10 @@ export class FunctionRequire {
    */
   warp(code: string): string {
     return `
+    const require = (module) => {
+      fromModules.push(__filename)
+      return requireFunc(module, fromModules)
+    }
     const exports = {};
     ${code}
     exports;

runtimes/nodejs/src/support/function-engine/types.ts

@@ -4,7 +4,7 @@ import { Request, Response } from 'express'
 import { ObjectId } from 'mongodb'
 import WebSocket = require('ws')
 
-export type RequireFuncType = (module: string) => any
+export type RequireFuncType = (module: string, fromModules?: string[]) => any
 
 /**
  * vm run context (global)
@@ -14,7 +14,7 @@ export interface RuntimeContext {
   module: { exports: Object }
   exports: Object
   console: FunctionConsole
-  require: RequireFuncType
+  requireFunc: RequireFuncType
   Buffer: typeof Buffer
   setTimeout: typeof setTimeout
   clearTimeout: typeof clearTimeout
@@ -26,7 +26,8 @@ export interface RuntimeContext {
   process: {
     env: { [key: string]: string }
   }
-  global: RuntimeContext
+  global: RuntimeContext,
+  fromModules: string[]
 }
 
 /**

runtimes/nodejs/src/support/function-engine/vm.ts

@@ -34,19 +34,25 @@ export class FunctionVm {
   static buildSandbox(
     functionContext: FunctionContext,
     requireFunc: any,
+    fromModules?: string[],
   ): RuntimeContext {
     const fconsole = new FunctionConsole(functionContext)
 
     const _module = {
       exports: {},
     }
+
+    if (!fromModules) {
+      fromModules = []
+    }
+
     const sandbox = {
       __context__: functionContext,
       __filename: functionContext.__function_name,
       module: _module,
       exports: _module.exports,
       console: fconsole,
-      require: requireFunc,
+      requireFunc: requireFunc,
       Buffer: Buffer,
       setImmediate: setImmediate,
       clearImmediate: clearImmediate,
@@ -60,6 +66,7 @@ export class FunctionVm {
       URL: URL,
       fetch: globalThis.fetch,
       global: null,
+      fromModules: [...fromModules],
     }
 
     sandbox.global = sandbox