feat(runtime): support relative path import of fn (labring#1712)

* chore(runtime): optmize nameing & comments, remove redundant code * feat(runtime): support relative path import of fn * fix(server): add fn name validation rule
HUAHUAI23 · Nov 28, 2023 · 9daa9f8 · 9daa9f8
1 parent c1748d6
commit 9daa9f8
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 15 deletions.
diff --git a/runtimes/nodejs/src/support/engine/module.ts b/runtimes/nodejs/src/support/engine/module.ts
@@ -4,6 +4,7 @@ import Config from '../../config'
 import { Console } from '.'
 import * as vm from 'vm'
 import { createRequire } from 'node:module'
+import * as path from 'node:path'
 
 const CUSTOM_DEPENDENCY_NODE_MODULES_PATH = `${Config.CUSTOM_DEPENDENCY_BASE_PATH}/node_modules/`
 
@@ -19,40 +20,52 @@ export class FunctionModule {
     return this.require(moduleName, [])
   }
 
-  static require(name: string, fromModule: string[]): any {
-    if (name === '@/cloud-sdk') {
+  static require(moduleName: string, fromModule: string[], filename = ''): any {
+    if (moduleName === '@/cloud-sdk') {
       return require('@lafjs/cloud')
-    } else if (name.startsWith('@/')) {
-      name = name.replace('@/', '')
+    } else if (
+      moduleName.startsWith('@/') ||
+      moduleName.startsWith('./') ||
+      moduleName.startsWith('../')
+    ) {
+      // get function name
+      let fn = ''
+      if (moduleName.startsWith('@/')) {
+        fn = moduleName.replace('@/', '')
+      } else {
+        const dirname = '/'
+        const filePath = path.join(path.dirname(dirname + filename), moduleName)
+        fn = filePath.slice(dirname.length)
+      }
 
       // check cache
-      if (FunctionModule.cache.has(name)) {
-        return FunctionModule.cache.get(name)
+      if (FunctionModule.cache.has(fn)) {
+        return FunctionModule.cache.get(fn)
       }
 
       // check circular dependency
-      if (fromModule?.indexOf(name) !== -1) {
+      if (fromModule?.indexOf(fn) !== -1) {
         throw new Error(
-          `circular dependency detected: ${fromModule.join(' -> ')} -> ${name}`,
+          `circular dependency detected: ${fromModule.join(' -> ')} -> ${fn}`,
         )
       }
 
       // build function module
-      const data = FunctionCache.get(name)
-      const mod = this.compile(name, data.source.compiled, fromModule)
+      const data = FunctionCache.get(fn)
+      const mod = this.compile(fn, data.source.compiled, fromModule)
 
       // cache module
       if (!Config.DISABLE_MODULE_CACHE) {
-        FunctionModule.cache.set(name, mod)
+        FunctionModule.cache.set(fn, mod)
       }
       return mod
     }
 
     // load custom dependency from custom dependency path first
     try {
-      return FunctionModule.customRequire(name)
+      return FunctionModule.customRequire(moduleName)
     } catch (e) {
-      return require(name)
+      return require(moduleName)
     }
   }
 
@@ -92,7 +105,7 @@ export class FunctionModule {
     return `
     const require = (name) => {
       __from_modules.push(__filename)
-      return __require(name, __from_modules)
+      return __require(name, __from_modules, __filename)
     }
 
     ${code}

diff --git a/runtimes/nodejs/src/support/engine/types.ts b/runtimes/nodejs/src/support/engine/types.ts
@@ -6,7 +6,7 @@ import WebSocket = require('ws')
 export type RequireFuncType = (
   module: string,
   fromModules: string[],
-  ctx: FunctionContext,
+  filename?: string,
 ) => any
 
 /**

diff --git a/server/src/function/dto/create-function.dto.ts b/server/src/function/dto/create-function.dto.ts
@@ -43,6 +43,11 @@ export class CreateFunctionDto {
     if (this.tags?.length >= 8) {
       return 'tags length must less than 8'
     }
+
+    if (this.name.includes('./') || this.name.includes('../')) {
+      return 'the relative path is not allowed in function name'
+    }
+
     return null
   }
 }