Merge pull request #1050 from dl748/master

Issue #931 fix for not allowing caching

README.md

@@ -135,6 +135,7 @@ All CLI options are optional:
 --useDocker                 Run handlers in a docker container.
 --layersDir                 The directory layers should be stored in. Default: ${codeDir}/.serverless-offline/layers'
 --dockerReadOnly            Marks if the docker code layer should be read only. Default: true
+--allowCache                Allows the code of lambda functions to cache if supported.
 ```
 
 Any of the CLI options can be added to your `serverless.yml`. For example:

package.json

@@ -158,6 +158,7 @@
     "aws-sdk": "^2.624.0",
     "boxen": "^4.2.0",
     "chalk": "^3.0.0",
+    "clear-module": "^4.1.1",
     "cuid": "^2.1.8",
     "execa": "^4.0.0",
     "extend": "^3.0.2",

src/config/commandOptions.js

@@ -99,4 +99,7 @@ export default {
   functionCleanupIdleTimeSeconds: {
     usage: 'Number of seconds until an idle function is eligible for cleanup',
   },
+  allowCache: {
+    usage: 'Allows the code of lambda functions to cache if supported',
+  },
 }

src/config/defaultOptions.js

@@ -28,4 +28,5 @@ export default {
   layersDir: null,
   dockerReadOnly: true,
   functionCleanupIdleTimeSeconds: 60,
+  allowCache: false,
 }

src/lambda/handler-runner/HandlerRunner.js

@@ -21,7 +21,12 @@ export default class HandlerRunner {
   }
 
   async _loadRunner() {
-    const { useDocker, useChildProcesses, useWorkerThreads } = this.#options
+    const {
+      useDocker,
+      useChildProcesses,
+      useWorkerThreads,
+      allowCache,
+    } = this.#options
 
     const {
       functionKey,
@@ -48,7 +53,7 @@ export default class HandlerRunner {
         const { default: ChildProcessRunner } = await import(
           './child-process-runner/index.js'
         )
-        return new ChildProcessRunner(this.#funOptions, this.#env)
+        return new ChildProcessRunner(this.#funOptions, this.#env, allowCache)
       }
 
       if (useWorkerThreads) {
@@ -58,7 +63,7 @@ export default class HandlerRunner {
         const { default: WorkerThreadRunner } = await import(
           './worker-thread-runner/index.js'
         )
-        return new WorkerThreadRunner(this.#funOptions, this.#env)
+        return new WorkerThreadRunner(this.#funOptions, this.#env, allowCache)
       }
 
       const { default: InProcessRunner } = await import(
@@ -70,22 +75,23 @@ export default class HandlerRunner {
         handlerName,
         this.#env,
         timeout,
+        allowCache,
       )
     }
 
     if (supportedPython.has(runtime)) {
       const { default: PythonRunner } = await import('./python-runner/index.js')
-      return new PythonRunner(this.#funOptions, this.#env)
+      return new PythonRunner(this.#funOptions, this.#env, allowCache)
     }
 
     if (supportedRuby.has(runtime)) {
       const { default: RubyRunner } = await import('./ruby-runner/index.js')
-      return new RubyRunner(this.#funOptions, this.#env)
+      return new RubyRunner(this.#funOptions, this.#env, allowCache)
     }
 
     if (supportedJava.has(runtime)) {
       const { default: JavaRunner } = await import('./java-runner/index.js')
-      return new JavaRunner(this.#funOptions, this.#env)
+      return new JavaRunner(this.#funOptions, this.#env, allowCache)
     }
 
     // TODO FIXME

src/lambda/handler-runner/child-process-runner/ChildProcessRunner.js

@@ -9,15 +9,17 @@ export default class ChildProcessRunner {
   #handlerName = null
   #handlerPath = null
   #timeout = null
+  #allowCache = false
 
-  constructor(funOptions, env) {
+  constructor(funOptions, env, allowCache) {
     const { functionKey, handlerName, handlerPath, timeout } = funOptions
 
     this.#env = env
     this.#functionKey = functionKey
     this.#handlerName = handlerName
     this.#handlerPath = handlerPath
     this.#timeout = timeout
+    this.#allowCache = allowCache
   }
 
   // no-op
@@ -37,6 +39,7 @@ export default class ChildProcessRunner {
     childProcess.send({
       context,
       event,
+      allowCache: this.#allowCache,
       timeout: this.#timeout,
     })
 

src/lambda/handler-runner/child-process-runner/childProcessHelper.js

@@ -23,7 +23,7 @@ process.on('uncaughtException', (err) => {
 const [, , functionKey, handlerName, handlerPath] = process.argv
 
 process.on('message', async (messageData) => {
-  const { context, event, timeout } = messageData
+  const { context, event, allowCache, timeout } = messageData
 
   // TODO we could probably cache this in the module scope?
   const inProcessRunner = new InProcessRunner(
@@ -32,6 +32,7 @@ process.on('message', async (messageData) => {
     handlerName,
     process.env,
     timeout,
+    allowCache,
   )
 
   let result

src/lambda/handler-runner/in-process-runner/InProcessRunner.js

@@ -1,18 +1,21 @@
 import { performance } from 'perf_hooks'
+import clearModule from 'clear-module'
 
 export default class InProcessRunner {
   #env = null
   #functionKey = null
   #handlerName = null
   #handlerPath = null
   #timeout = null
+  #allowCache = false
 
-  constructor(functionKey, handlerPath, handlerName, env, timeout) {
+  constructor(functionKey, handlerPath, handlerName, env, timeout, allowCache) {
     this.#env = env
     this.#functionKey = functionKey
     this.#handlerName = handlerName
     this.#handlerPath = handlerPath
     this.#timeout = timeout
+    this.#allowCache = allowCache
   }
 
   // no-op
@@ -36,7 +39,9 @@ export default class InProcessRunner {
     Object.assign(process.env, this.#env)
 
     // lazy load handler with first usage
-
+    if (!this.#allowCache) {
+      clearModule(this.#handlerPath)
+    }
     const { [this.#handlerName]: handler } = await import(this.#handlerPath)
 
     if (typeof handler !== 'function') {

src/lambda/handler-runner/java-runner/JavaRunner.js

@@ -10,8 +10,9 @@ export default class JavaRunner {
   #functionName = null
   #handler = null
   #deployPackage = null
+  #allowCache = false
 
-  constructor(funOptions, env) {
+  constructor(funOptions, env, allowCache) {
     const {
       functionName,
       handler,
@@ -23,6 +24,7 @@ export default class JavaRunner {
     this.#functionName = functionName
     this.#handler = handler
     this.#deployPackage = functionPackage || servicePackage
+    this.#allowCache = allowCache
   }
 
   // no-op
@@ -71,6 +73,7 @@ export default class JavaRunner {
         function: this.#functionName,
         jsonOutput: true,
         serverlessOffline: true,
+        allowCache: this.#allowCache,
       })
 
       const httpOptions = {

src/lambda/handler-runner/python-runner/PythonRunner.js

@@ -13,14 +13,16 @@ export default class PythonRunner {
   #handlerName = null
   #handlerPath = null
   #runtime = null
+  #allowCache = false
 
-  constructor(funOptions, env) {
+  constructor(funOptions, env, allowCache) {
     const { handlerName, handlerPath, runtime } = funOptions
 
     this.#env = env
     this.#handlerName = handlerName
     this.#handlerPath = handlerPath
     this.#runtime = platform() === 'win32' ? 'python.exe' : runtime
+    this.#allowCache = allowCache
 
     if (process.env.VIRTUAL_ENV) {
       const runtimeDir = platform() === 'win32' ? 'Scripts' : 'bin'
@@ -96,6 +98,7 @@ export default class PythonRunner {
       const input = stringify({
         context,
         event,
+        allowCache: this.#allowCache,
       })
 
       const onErr = (data) => {

src/lambda/handler-runner/ruby-runner/RubyRunner.js

@@ -10,13 +10,15 @@ export default class RubyRunner {
   #env = null
   #handlerName = null
   #handlerPath = null
+  #allowCache = false
 
-  constructor(funOptions, env) {
+  constructor(funOptions, env, allowCache) {
     const { handlerName, handlerPath } = funOptions
 
     this.#env = env
     this.#handlerName = handlerName
     this.#handlerPath = handlerPath
+    this.#allowCache = allowCache
   }
 
   // no-op
@@ -64,6 +66,7 @@ export default class RubyRunner {
     const input = stringify({
       context: _context,
       event,
+      allowCache: this.#allowCache,
     })
 
     // console.log(input)

src/lambda/handler-runner/worker-thread-runner/WorkerThreadRunner.js

@@ -5,12 +5,14 @@ const workerThreadHelperPath = resolve(__dirname, './workerThreadHelper.js')
 
 export default class WorkerThreadRunner {
   #workerThread = null
+  #allowCache = false
 
-  constructor(funOptions /* options */, env) {
+  constructor(funOptions /* options */, env, allowCache) {
     // this._options = options
 
     const { functionKey, handlerName, handlerPath, timeout } = funOptions
 
+    this.#allowCache = allowCache
     this.#workerThread = new Worker(workerThreadHelperPath, {
       // don't pass process.env from the main process!
       env,
@@ -51,6 +53,7 @@ export default class WorkerThreadRunner {
         {
           context,
           event,
+          allowCache: this.#allowCache,
           // port2 is part of the payload, for the other side to answer messages
           port: port2,
         },

src/lambda/handler-runner/worker-thread-runner/workerThreadHelper.js

@@ -4,7 +4,7 @@ import InProcessRunner from '../in-process-runner/index.js'
 const { functionKey, handlerName, handlerPath } = workerData
 
 parentPort.on('message', async (messageData) => {
-  const { context, event, port, timeout } = messageData
+  const { context, event, port, timeout, allowCache } = messageData
 
   // TODO we could probably cache this in the module scope?
   const inProcessRunner = new InProcessRunner(
@@ -13,6 +13,7 @@ parentPort.on('message', async (messageData) => {
     handlerName,
     process.env,
     timeout,
+    allowCache,
   )
 
   let result

tests/integration/lambda-invoke/serverless.yml

@@ -51,3 +51,7 @@ functions:
 
   invokedAsyncHandler:
     handler: lambdaInvokeAsyncHandler.invokedAsyncHandler
+
+custom:
+  serverless-offline:
+    allowCache: true