serverless-offline 14.1.1 → 14.3.0

package/README.md

@@ -1,9 +1,5 @@
 # Serverless Offline
 
-⚠️
-We are looking for maintainers! This package is entirely community-driven. Please send an email to dherault to start helping now.
-⚠️
-
 <p>
   <a href="https://www.serverless.com">
     <img src="http://public.serverless.com/badges/v3.svg">
@@ -199,6 +195,10 @@ Turns off all authorizers.
 
 Don't prepend http routes with the stage.
 
+#### noSponsor
+
+Remove sponsor message from the output.
+
 #### noTimeout
 
 -t Disables the timeout feature.
@@ -243,6 +243,11 @@ Default: 600 (10 minutes)
 WebSocket port to listen on.<br />
 Default: 3001
 
+#### preLoadModules
+
+Pre-load specified modules in the main thread to avoid crashes when importing in worker threads. Provide module names as a comma-separated list (e.g., "sharp,canvas").<br />
+Default: ''
+
 Any of the CLI options can be added to your `serverless.yml`. For example:
 
 ```yml

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "serverless-offline",
-  "version": "14.1.1",
+  "version": "14.3.0",
   "description": "Emulate AWS λ and API Gateway locally when developing your Serverless project",
   "license": "MIT",
   "exports": {
@@ -76,7 +76,7 @@
     ]
   },
   "dependencies": {
-    "@aws-sdk/client-lambda": "^3.632.0",
+    "@aws-sdk/client-lambda": "^3.636.0",
     "@hapi/boom": "^10.0.1",
     "@hapi/h2o2": "^10.0.4",
     "@hapi/hapi": "^21.3.10",
@@ -88,7 +88,7 @@
     "fs-extra": "^11.2.0",
     "is-wsl": "^3.1.0",
     "java-invoke-local": "0.0.6",
-    "jose": "^5.6.3",
+    "jose": "^5.7.0",
     "js-string-escape": "^1.0.1",
     "jsonpath-plus": "^9.0.0",
     "jsonschema": "^1.4.1",
@@ -115,7 +115,7 @@
     "mocha": "^10.7.3",
     "nyc": "^17.0.0",
     "prettier": "^3.3.3",
-    "serverless": "^4.1.22"
+    "serverless": "^4.2.1"
   },
   "peerDependencies": {
     "serverless": "^4.0.0"

package/src/ServerlessOffline.js

@@ -1,5 +1,6 @@
 import process, { exit } from "node:process"
 import { log, setLogUtils } from "./utils/log.js"
+import logSponsor from "./utils/logSponsor.js"
 import {
   commandOptions,
   CUSTOM_OPTION,
@@ -64,6 +65,14 @@ export default class ServerlessOffline {
   async start() {
     this.#mergeOptions()
 
+    this.#preLoadModules()
+
+    if (this.#cliOptions.noSponsor) {
+      log.notice()
+    } else {
+      logSponsor()
+    }
+
     const {
       albEvents,
       httpEvents,
@@ -278,13 +287,11 @@ export default class ServerlessOffline {
       origin: this.#options.corsAllowOrigin,
     }
 
-    log.notice()
     log.notice(
       `Starting Offline at stage ${
         this.#options.stage || provider.stage
       } ${gray(`(${this.#options.region || provider.region})`)}`,
     )
-    log.notice()
     log.debug("options:", this.#options)
   }
 
@@ -418,6 +425,18 @@ export default class ServerlessOffline {
     }
   }
 
+  #preLoadModules() {
+    const modules = this.#options.preLoadModules.split(",")
+
+    modules.forEach((module) => {
+      try {
+        import(module)
+      } catch (error) {
+        log.error(`Error importing module ${module}: ${error}`)
+      }
+    })
+  }
+
   // TODO FIXME
   // TEMP quick fix to expose for testing, look for better solution
   internals() {
@@ -441,6 +460,10 @@ export default class ServerlessOffline {
       mergeOptions: () => {
         this.#mergeOptions()
       },
+
+      preLoadModules: () => {
+        this.#preLoadModules()
+      },
     }
   }
 }

package/src/config/commandOptions.js

@@ -89,6 +89,10 @@ export default {
     type: "boolean",
     usage: "Don't prepend http routes with the stage.",
   },
+  noSponsor: {
+    type: "boolean",
+    usage: "Remove sponsor message from the output.",
+  },
   noTimeout: {
     shortcut: "t",
     type: "boolean",
@@ -100,6 +104,10 @@ export default {
     usage:
       "Adds a prefix to every path, to send your requests to http://localhost:3000/prefix/[your_path] instead.",
   },
+  preLoadModules: {
+    type: "string",
+    usage: "A comma separated list of modules to preload on the main thread",
+  },
   reloadHandler: {
     type: "boolean",
     usage: "Reloads handler with each request.",

package/src/config/defaultOptions.js

@@ -20,6 +20,7 @@ export default {
   noPrependStageInUrl: false,
   noTimeout: false,
   prefix: "",
+  preLoadModules: "",
   reloadHandler: false,
   resourceRoutes: false,
   terminateIdleLambdaTime: 60,

package/src/events/http/HttpServer.js

@@ -645,7 +645,7 @@ export default class HttpServer {
       /* RESPONSE SELECTION (among endpoint's possible responses) */
 
       // Failure handling
-      let errorStatusCode = "502"
+      let errorStatusCode = "500"
 
       if (err) {
         const errorMessage = (err.message || err).toString()
@@ -655,14 +655,17 @@ export default class HttpServer {
         if (found && found.length > 1) {
           ;[, errorStatusCode] = found
         } else {
-          errorStatusCode = "502"
+          errorStatusCode = "500"
         }
 
         // Mocks Lambda errors
         result = {
-          errorMessage,
-          errorType: err.constructor.name,
-          stackTrace: this.#getArrayStackTrace(err.stack),
+          body: JSON.stringify({
+            message: errorMessage,
+            stackTrace: this.#getArrayStackTrace(err.stack),
+            type: err.constructor.name,
+          }),
+          statusCode: errorStatusCode,
         }
 
         log.error(errorMessage)

package/src/lambda/HttpServer.js

@@ -62,7 +62,7 @@ export default class HttpServer {
           .listFunctionNames()
           .map(
             (functionName) =>
-              `           * ${funcNamePairs[functionName]}: ${functionName}`,
+              `   * ${funcNamePairs[functionName]}: ${functionName}`,
           ),
       ].join("\n"),
     )
@@ -73,9 +73,7 @@ export default class HttpServer {
           .listFunctionNames()
           .map(
             (functionName) =>
-              `           * ${
-                invRoute.method
-              } ${basePath}${invRoute.path.replace(
+              `   * ${invRoute.method} ${basePath}${invRoute.path.replace(
                 "{functionName}",
                 functionName,
               )}`,
@@ -90,7 +88,7 @@ export default class HttpServer {
           .listFunctionNames()
           .map(
             (functionName) =>
-              `           * ${
+              `   * ${
                 invAsyncRoute.method
               } ${basePath}${invAsyncRoute.path.replace(
                 "{functionName}",

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

@@ -104,9 +104,9 @@ export default class PythonRunner {
       })
 
       const onErr = (data) => {
-        // TODO
-
         log.notice(data.toString())
+
+        rej(new Error("Internal Server Error"))
       }
 
       const onLine = (line) => {

package/src/lambda/handler-runner/python-runner/invoke.py

@@ -104,7 +104,7 @@ if __name__ == '__main__':
             '__offline_payload__': result
         }
 
-        if isinstance(result['body'], bytes):
+        if hasattr(result, 'body') and isinstance(result['body'], bytes):
             data['__offline_payload__']['body'] = base64.b64encode(result['body']).decode('utf-8')
             data['isBase64Encoded'] = True
 

package/src/utils/logRoutes.js

@@ -10,8 +10,7 @@ import {
   yellow,
 } from "../config/colors.js"
 
-const { max } = Math
-
+const post = "POST"
 const colorMethodMapping = new Map([
   ["DELETE", red],
   ["GET", dodgerblue],
@@ -28,13 +27,13 @@ function logRoute(method, server, path, maxLength, dimPath = false) {
   const methodColor = colorMethodMapping.get(method) ?? peachpuff
   const methodFormatted = method.padEnd(maxLength, " ")
 
-  return `${methodColor(methodFormatted)} ${yellow.dim("|")} ${gray.dim(
-    server,
-  )}${dimPath ? gray.dim(path) : lime(path)}`
+  return `${methodColor(methodFormatted)} ${yellow.dim("|")} ${gray.dim(server)}${dimPath ? gray.dim(path) : lime(path)}`
 }
 
 function getMaxHttpMethodNameLength(routeInfo) {
-  return max(...routeInfo.map(({ method }) => method.length))
+  return Math.max(
+    ...routeInfo.map(({ method }) => Math.max(method.length, post.length)),
+  )
 }
 
 export default function logRoutes(routeInfo) {
@@ -55,7 +54,7 @@ export default function logRoutes(routeInfo) {
             // eslint-disable-next-line prefer-template
             logRoute(method, server, path, maxLength) +
             "\n" +
-            logRoute("POST", server, invokePath, maxLength, true),
+            logRoute(post, server, invokePath, maxLength, true),
         )
         .join("\n"),
       boxenOptions,

package/src/utils/logSponsor.js

@@ -0,0 +1,69 @@
+/* eslint-disable no-use-before-define */
+/* eslint-disable no-console */
+import process from "node:process"
+
+import boxen from "boxen"
+import { gray, dodgerblue } from "../config/colors.js"
+
+const boxenOptions = {
+  borderColor: "blue",
+  margin: 1,
+  padding: 1,
+}
+
+// Promotion starts on August 22, 2024
+const startAt = new Date("2024-08-22T00:00:00.000Z")
+// By October 22, 2024, the promotion will be displayed to 100% of users
+const endAt = new Date("2024-10-22T00:00:00.000Z")
+const nDays = diffDays(startAt, endAt)
+
+function logSponsor() {
+  if (!shouldDisplaySponsor()) {
+    console.log()
+
+    return
+  }
+
+  console.log(
+    boxen(
+      `Sponsored by ${dodgerblue("Arccode, the RPG for developers")}\nhttps://arccode.dev?ref=so\n${gray.dim(
+        "Disable with --noSponsor",
+      )}`,
+      boxenOptions,
+    ),
+  )
+}
+
+// Display the message progressively over time to 100% of users
+function shouldDisplaySponsor() {
+  const ratio = diffDays(startAt, new Date()) / nDays
+
+  if (ratio >= 1) return true
+
+  try {
+    const nonce = Number(
+      encodeStringToNumber(process.cwd()).toString().padStart(2, "0").slice(-2),
+    )
+
+    return nonce <= ratio * 100
+  } catch {
+    //
+  }
+
+  return false
+}
+
+function encodeStringToNumber(string) {
+  let sum = 0
+
+  for (let i = 0; i < string.length; i += 1) {
+    sum += Number(string.codePointAt(i).toString(10))
+  }
+
+  return sum
+}
+
+function diffDays(a, b) {
+  return Math.round((b - a) / (1000 * 60 * 60 * 24))
+}
+export default logSponsor