serverless-offline 9.2.2 → 9.2.5

package/README.md

@@ -137,7 +137,7 @@ All CLI options are optional:
 --printOutput               Turns on logging of your lambda outputs in the terminal.
 --reloadHandler             Reloads handler with each request.
 --resourceRoutes            Turns on loading of your HTTP proxy settings from serverless.yml
---useChildProcesses         Run handlers in a child process
+--useChildProcesses         [This option is deprecated] Run handlers in a child process.
 --useDocker                 Run handlers in a docker container.
 --useInProcess              Run handlers in the same process as 'serverless-offline'.
 --webSocketHardTimeout      Set WebSocket hard timeout in seconds to reproduce AWS limits (https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html#apigateway-execution-service-websocket-limits-table). Default: 7200 (2 hours)
@@ -188,7 +188,7 @@ Lambda handlers for the `node.js` runtime can run in different execution modes w
 - global state is being shared across lambda handlers as well as with `serverless` and `serverless-offline`
 - easy debugging
 
-#### child-processes
+#### child-processes (this option is deprecated, please use the default worker-threads instead)
 
 - handlers run in a separate node.js instance
 - memory is not being shared between handlers, memory consumption is therefore higher

package/package.json

@@ -1,7 +1,7 @@
 {
   "dedicatedTo": "Blue, a great migrating bird.",
   "name": "serverless-offline",
-  "version": "9.2.2",
+  "version": "9.2.5",
   "description": "Emulate AWS λ and API Gateway locally when developing your Serverless project",
   "license": "MIT",
   "main": "./src/index.js",

package/src/ServerlessOffline.js

@@ -1,12 +1,12 @@
 import process, { exit } from 'node:process'
 import { log } from '@serverless/utils/log.js'
-import chalk from 'chalk'
 import {
   commandOptions,
   CUSTOM_OPTION,
   defaultOptions,
   SERVER_SHUTDOWN_TIMEOUT,
 } from './config/index.js'
+import { gray, orange } from './config/colors.js'
 
 export default class ServerlessOffline {
   #cliOptions = null
@@ -225,6 +225,14 @@ export default class ServerlessOffline {
       ...this.#cliOptions,
     }
 
+    if (this.#options.useChildProcesses) {
+      log.notice()
+      log.warning(
+        orange(`'--useChildProcesses' is deprecated and will be removed in the next major version. Worker threads, the current default, should provide the same if not an even better developer experience.
+If you are experiencing any issues please let us know: https://github.com/dherault/serverless-offline/issues`),
+      )
+    }
+
     // Parse CORS options
     this.#options.corsAllowHeaders = this.#options.corsAllowHeaders
       .replace(/\s/g, '')
@@ -247,7 +255,7 @@ export default class ServerlessOffline {
     log.notice(
       `Starting Offline at stage ${
         this.#options.stage || provider.stage
-      } ${chalk.gray(`(${this.#options.region || provider.region})`)}`,
+      } ${gray(`(${this.#options.region || provider.region})`)}`,
     )
     log.notice()
     log.debug('options:', this.#options)

package/src/config/colors.js

@@ -0,0 +1,10 @@
+import chalk from 'chalk'
+
+export const dodgerblue = chalk.hex('#1e90ff')
+export const gray = chalk.hex('#808080')
+export const lime = chalk.hex('#00ff00')
+export const orange = chalk.hex('#ffa500')
+export const peachpuff = chalk.hex('#ffdab9')
+export const plum = chalk.hex('#dda0dd')
+export const red = chalk.hex('#ff0000')
+export const yellow = chalk.hex('#ffff00')

package/src/config/commandOptions.js

@@ -132,7 +132,8 @@ export default {
   },
   useChildProcesses: {
     type: 'boolean',
-    usage: 'Use separate node process to run handlers',
+    usage:
+      '[This option is deprecated] Use separate node process to run handlers.',
   },
   useDocker: {
     type: 'boolean',

package/src/events/http/Endpoint.js

@@ -10,11 +10,11 @@ const __dirname = dirname(fileURLToPath(import.meta.url))
 
 // velocity template defaults
 const defaultRequestTemplate = readFileSync(
-  resolve(__dirname, './templates/offline-default.req.vm'),
+  resolve(__dirname, 'templates/offline-default.req.vm'),
   'utf8',
 )
 const defaultResponseTemplate = readFileSync(
-  resolve(__dirname, './templates/offline-default.res.vm'),
+  resolve(__dirname, 'templates/offline-default.res.vm'),
   'utf8',
 )
 

package/src/events/http/HttpServer.js

@@ -788,12 +788,6 @@ export default class HttpServer {
           response.variety = 'buffer'
         } else if (typeof result === 'string') {
           response.source = stringify(result)
-        } else if (result && result.body && typeof result.body !== 'string') {
-          return this.#reply502(
-            response,
-            'According to the API Gateway specs, the body content must be stringified. Check your Lambda response and make sure you are invoking JSON.stringify(YOUR_CONTENT) on your body object',
-            {},
-          )
         } else {
           response.source = result
         }
@@ -888,6 +882,7 @@ export default class HttpServer {
             response.variety = 'buffer'
           } else {
             if (result && result.body && typeof result.body !== 'string') {
+              // FIXME TODO we should probably just write to console instead of returning a payload
               return this.#reply502(
                 response,
                 'According to the API Gateway specs, the body content must be stringified. Check your Lambda response and make sure you are invoking JSON.stringify(YOUR_CONTENT) on your body object',

package/src/events/http/authJWTSettingsExtractor.js

@@ -1,20 +1,24 @@
 import { log } from '@serverless/utils/log.js'
 
+function buildFailureResult(warningMessage) {
+  log.warning(warningMessage)
+
+  return {
+    unsupportedAuth: true,
+  }
+}
+
+function buildSuccessResult(authorizerName) {
+  return {
+    authorizerName,
+  }
+}
+
 export default function authJWTSettingsExtractor(
   endpoint,
   provider,
   ignoreJWTSignature,
 ) {
-  const buildFailureResult = (warningMessage) => {
-    log.warning(warningMessage)
-
-    return {
-      unsupportedAuth: true,
-    }
-  }
-
-  const buildSuccessResult = (authorizerName) => ({ authorizerName })
-
   const { authorizer } = endpoint
 
   if (!authorizer) {

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

@@ -59,7 +59,7 @@ export default class ChildProcessRunner {
             rej(data.error)
             return
           }
-          res(data)
+          res(data.result)
         })
       })
     } catch (err) {

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

@@ -41,5 +41,5 @@ process.on('message', async (messageData) => {
   const result = await inProcessRunner.run(event, context)
 
   // TODO check serializeability (contains function, symbol etc)
-  process.send(result)
+  process.send({ result })
 })

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

@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url'
 import { MessageChannel, Worker } from 'node:worker_threads'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
-const workerThreadHelperPath = resolve(__dirname, './workerThreadHelper.js')
+const workerThreadHelperPath = resolve(__dirname, 'workerThreadHelper.js')
 
 export default class WorkerThreadRunner {
   #workerThread = null

package/src/utils/logRoutes.js

@@ -1,17 +1,17 @@
 import boxen from 'boxen'
-import chalk from 'chalk'
+import {
+  dodgerblue,
+  gray,
+  lime,
+  orange,
+  peachpuff,
+  plum,
+  red,
+  yellow,
+} from '../config/colors.js'
 
 const { max } = Math
 
-const dodgerblue = chalk.hex('#1e90ff')
-const grey = chalk.hex('#808080')
-const lime = chalk.hex('#00ff00')
-const orange = chalk.hex('#ffa500')
-const peachpuff = chalk.hex('#ffdab9')
-const plum = chalk.hex('#dda0dd')
-const red = chalk.hex('#ff0000')
-const yellow = chalk.hex('#ffff00')
-
 const colorMethodMapping = new Map([
   ['DELETE', red],
   ['GET', dodgerblue],
@@ -28,9 +28,9 @@ function logRoute(method, server, path, maxLength, dimPath = false) {
   const methodColor = colorMethodMapping.get(method) ?? peachpuff
   const methodFormatted = method.padEnd(maxLength, ' ')
 
-  return `${methodColor(methodFormatted)} ${yellow.dim('|')} ${grey.dim(
+  return `${methodColor(methodFormatted)} ${yellow.dim('|')} ${gray.dim(
     server,
-  )}${dimPath ? grey.dim(path) : lime(path)}`
+  )}${dimPath ? gray.dim(path) : lime(path)}`
 }
 
 function getMaxHttpMethodNameLength(routeInfo) {
@@ -51,7 +51,7 @@ export default function logRoutes(routeInfo) {
     boxen(
       routeInfo
         .map(
-          ({ method, path, server, invokePath }) =>
+          ({ invokePath, method, path, server }) =>
             // eslint-disable-next-line prefer-template
             logRoute(method, server, path, maxLength) +
             '\n' +