serverless-offline 9.2.6 → 9.3.0

package/README.md

@@ -215,10 +215,10 @@ the Lambda handler process is running in a child process.
 To use `Lambda.invoke` you need to set the lambda endpoint to the `serverless-offline` endpoint:
 
 ```js
-const { env } = require('node:process')
-const { Lambda } = require('aws-sdk')
+import { env } from 'node:process'
+import aws from 'aws-sdk'
 
-const lambda = new Lambda({
+const lambda = new aws.Lambda({
   apiVersion: '2015-03-31',
   // endpoint needs to be set only if it deviates from the default
   endpoint: env.IS_OFFLINE
@@ -230,17 +230,17 @@ const lambda = new Lambda({
 All your lambdas can then be invoked in a handler using
 
 ```js
-const { Buffer } = require('node:buffer')
-const { Lambda } = require('aws-sdk')
+import { Buffer } from 'node:buffer'
+import aws from 'aws-sdk'
 
 const { stringify } = JSON
 
-const lambda = new Lambda({
+const lambda = new aws.Lambda({
   apiVersion: '2015-03-31',
   endpoint: 'http://localhost:3002',
 })
 
-exports.handler = async function () {
+export async function handler() {
   const clientContextData = stringify({ foo: 'foo' })
 
   const params = {
@@ -623,9 +623,9 @@ Usage in order to send messages back to clients:
 Or,
 
 ```js
-const { ApiGatewayManagementApi } = require('aws-sdk')
+import aws from 'aws-sdk'
 
-const apiGatewayManagementApi = new ApiGatewayManagementApi({
+const apiGatewayManagementApi = new aws.ApiGatewayManagementApi({
   apiVersion: '2018-11-29',
   endpoint: 'http://localhost:3001',
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "dedicatedTo": "Blue, a great migrating bird.",
   "name": "serverless-offline",
-  "version": "9.2.6",
+  "version": "9.3.0",
   "description": "Emulate AWS λ and API Gateway locally when developing your Serverless project",
   "license": "MIT",
   "main": "./src/index.js",
@@ -189,18 +189,18 @@
     "@hapi/h2o2": "^9.1.0",
     "@hapi/hapi": "^20.2.2",
     "@serverless/utils": "^6.7.0",
-    "aws-sdk": "^2.1195.0",
+    "aws-sdk": "^2.1204.0",
     "boxen": "^7.0.0",
     "chalk": "^5.0.1",
     "execa": "^6.1.0",
     "fs-extra": "^10.1.0",
     "java-invoke-local": "0.0.6",
     "js-string-escape": "^1.0.1",
-    "jsonpath-plus": "^7.0.0",
+    "jsonpath-plus": "^7.1.0",
     "jsonschema": "^1.4.1",
     "jsonwebtoken": "^8.5.1",
     "jszip": "^3.10.1",
-    "luxon": "^3.0.1",
+    "luxon": "3.0.1",
     "node-fetch": "^3.2.10",
     "node-schedule": "^2.1.0",
     "object.hasown": "^1.1.1",
@@ -211,7 +211,7 @@
   },
   "devDependencies": {
     "archiver": "^5.3.1",
-    "eslint": "^8.22.0",
+    "eslint": "^8.23.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.25.4",

package/src/lambda/LambdaFunction.js

@@ -2,6 +2,7 @@ import { readFile, writeFile } from 'node:fs/promises'
 import { dirname, join, resolve } from 'node:path'
 import process from 'node:process'
 import { performance } from 'node:perf_hooks'
+import { promisify } from 'node:util'
 import { log } from '@serverless/utils/log.js'
 import { emptyDir, ensureDir, remove } from 'fs-extra'
 import jszip from 'jszip'
@@ -18,6 +19,8 @@ import { createUniqueId } from '../utils/index.js'
 const { ceil } = Math
 const { entries, fromEntries } = Object
 
+const setTimeoutPromise = promisify(setTimeout)
+
 export default class LambdaFunction {
   #artifact = null
 
@@ -37,6 +40,8 @@ export default class LambdaFunction {
 
   #handler = null
 
+  #handlerRunDone = false
+
   #handlerRunner = null
 
   #idleTimeStarted = null
@@ -49,13 +54,15 @@ export default class LambdaFunction {
 
   #memorySize = null
 
+  #noTimeout = null
+
   #region = null
 
   #runtime = null
 
-  #timeout = null
+  #status = 'IDLE' // can be 'BUSY' or 'IDLE'
 
-  status = 'IDLE' // can be 'BUSY' or 'IDLE'
+  #timeout = null
 
   constructor(functionKey, functionDefinition, serverless, options) {
     const {
@@ -71,28 +78,28 @@ export default class LambdaFunction {
 
     const { handler, name, package: functionPackage = {} } = functionDefinition
 
-    const memorySize =
+    // this._executionTimeout = null
+    this.#functionKey = functionKey
+    this.#functionName = name
+    this.#handler = handler
+
+    this.#memorySize =
       functionDefinition.memorySize ||
       provider.memorySize ||
       DEFAULT_LAMBDA_MEMORY_SIZE
 
-    const runtime =
+    this.#noTimeout = options.noTimeout
+
+    this.#region = provider.region
+
+    this.#runtime =
       functionDefinition.runtime || provider.runtime || DEFAULT_LAMBDA_RUNTIME
 
-    const timeout =
+    this.#timeout =
       (functionDefinition.timeout ||
         provider.timeout ||
         DEFAULT_LAMBDA_TIMEOUT) * 1000
 
-    // this._executionTimeout = null
-    this.#functionKey = functionKey
-    this.#functionName = name
-    this.#handler = handler
-    this.#memorySize = memorySize
-    this.#region = provider.region
-    this.#runtime = runtime
-    this.#timeout = timeout
-
     this.#verifySupportedRuntime()
 
     const env = {
@@ -141,17 +148,17 @@ export default class LambdaFunction {
       handler,
       layers: functionDefinition.layers || [],
       provider,
-      runtime,
+      runtime: this.#runtime,
       serverlessPath,
       servicePackage: servicePackage.artifact
         ? resolve(servicepath, servicePackage.artifact)
         : undefined,
       servicePath: servicepath,
-      timeout,
+      timeout: this.#timeout,
     }
 
     this.#handlerRunner = new HandlerRunner(funOptions, options, env)
-    this.#lambdaContext = new LambdaContext(name, memorySize)
+    this.#lambdaContext = new LambdaContext(name, this.#memorySize)
   }
 
   #startExecutionTimer() {
@@ -267,8 +274,25 @@ export default class LambdaFunction {
     return this.#functionName
   }
 
+  get status() {
+    return this.#status
+  }
+
+  async #timeoutAndTerminate() {
+    await setTimeoutPromise(this.#timeout)
+
+    // if the handler has finished before the timeout don't terminate
+    if (this.#handlerRunDone) {
+      return
+    }
+
+    await this.#handlerRunner.cleanup()
+
+    throw new Error('Lambda timeout.')
+  }
+
   async runHandler() {
-    this.status = 'BUSY'
+    this.#status = 'BUSY'
 
     if (!this.#initialized) {
       await this.#initialize()
@@ -283,7 +307,14 @@ export default class LambdaFunction {
 
     this.#startExecutionTimer()
 
-    const result = await this.#handlerRunner.run(this.#event, context)
+    this.#handlerRunDone = false
+
+    const result = await Promise.race([
+      this.#handlerRunner.run(this.#event, context),
+      ...(this.#noTimeout ? [] : [this.#timeoutAndTerminate()]),
+    ])
+
+    this.#handlerRunDone = true
 
     this.#stopExecutionTimer()
 
@@ -298,7 +329,7 @@ export default class LambdaFunction {
       )
     }
 
-    this.status = 'IDLE'
+    this.#status = 'IDLE'
     this.#startIdleTimer()
 
     return result

package/src/utils/index.js

@@ -1,7 +1,10 @@
+export { default as checkDockerDaemon } from './checkDockerDaemon.js'
+export { default as checkGoVersion } from './checkGoVersion.js'
 export { default as createApiKey } from './createApiKey.js'
 export { default as createUniqueId } from './createUniqueId.js'
 export { default as detectExecutable } from './detectExecutable.js'
 export { default as formatToClfTime } from './formatToClfTime.js'
+export { default as generateHapiPath } from './generateHapiPath.js'
 export { default as getHttpApiCorsConfig } from './getHttpApiCorsConfig.js'
 export { default as jsonPath } from './jsonPath.js'
 export { default as lowerCaseKeys } from './lowerCaseKeys.js'
@@ -10,9 +13,7 @@ export { default as parseMultiValueHeaders } from './parseMultiValueHeaders.js'
 export { default as parseMultiValueQueryStringParameters } from './parseMultiValueQueryStringParameters.js'
 export { default as parseQueryStringParameters } from './parseQueryStringParameters.js'
 export { default as splitHandlerPathAndName } from './splitHandlerPathAndName.js'
-export { default as checkDockerDaemon } from './checkDockerDaemon.js'
-export { default as checkGoVersion } from './checkGoVersion.js'
-export { default as generateHapiPath } from './generateHapiPath.js'
+
 // export { default as baseImage } from './baseImage.js'
 
 const { isArray } = Array