fix: improved alb request query string parsing

updated docs
Inqnuam · Nov 5, 2023 · ff0cec7 · ff0cec7
1 parent 856492b
commit ff0cec7
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 72 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "serverless-aws-lambda",
-  "version": "4.6.5",
+  "version": "4.6.6",
   "description": "AWS Application Load Balancer and API Gateway - Lambda dev tool for Serverless. Allows Express synthax in handlers. Supports packaging, local invoking and offline ALB, APG, S3, SNS, SQS, DynamoDB Stream server mocking.",
   "author": "Inqnuam",
   "license": "MIT",

diff --git a/resources/defineConfig.md b/resources/defineConfig.md
@@ -35,13 +35,13 @@ export default defineConfig({
 });
 ```
 
-### Create a custom plugin which may be used inside defineConfig's `plugins`
+#### Create a custom plugin which may be used inside defineConfig's `plugins`
 
 ```js
-/**
- * @type {import("serverless-aws-lambda/defineConfig").SlsAwsLambdaPlugin}
- */
- const myCustomPlugin = {
+import { defineConfig } from "serverless-aws-lambda/defineConfig";
+import type { SlsAwsLambdaPlugin } from "serverless-aws-lambda/defineConfig";
+
+ const myCustomPlugin:SlsAwsLambdaPlugin = {
       name: "my-custom-plugin",
       onInit: async function () {
         // do something
@@ -81,7 +81,7 @@ export default defineConfig({
 
 
 
-module.exports = defineConfig({
+export default defineConfig({
   esbuild: {
     target: "es2020",
   },
@@ -92,18 +92,3 @@ module.exports = defineConfig({
   plugins: [myCustomPlugin],
 });
 ```
-
-`defineConfig` can be imported as ESM as well.
-
-```js
-import { defineConfig } from "serverless-aws-lambda/defineConfig";
-import { sqsPlugin } from "serverless-aws-lambda/sqs";
-
-export default defineConfig({
-  offline: {
-    staticPath: "./.aws_lambda",
-    port: 9999,
-  },
-  plugins: [sqsPlugin()],
-});
-```
diff --git a/resources/offline.md b/resources/offline.md
@@ -2,33 +2,30 @@ Set offline static path, custom port and add request listeners:
 
 ```js
 // config.js
-module.exports = ({ lambdas, isDeploying, isPackaging, setEnv, stage, port }) => {
-  /**
-   * @type {import("serverless-aws-lambda").Config}
-   */
-  return {
-    esbuild: {
-      //...
+import { defineConfig } from "serverless-aws-lambda/defineConfig";
+
+export default defineConfig({
+  esbuild: {
+    //...
+  },
+  offline: {
+    staticPath: "./public",
+    port: 9999,
+    onReady: (port) => {
+      console.log("We are ready to listen on", port);
     },
-    offline: {
-      staticPath: "./public",
-      port: 9999,
-      onReady: (port) => {
-        console.log("We are ready to listen on", port);
-      },
-      request: [
-        {
-          filter: /^\/__routes(\/)?$/, // filters request when request URL match /__routes
-          callback: (req, res) => {
-            // node http request Incoming Message and Response object
-            res.statusCode = 404;
-            res.end(`${req.url} not found`);
-          },
+    request: [
+      {
+        filter: /^\/__routes(\/)?$/, // filters request when request URL match /__routes
+        callback: (req, res) => {
+          // node http request Incoming Message and Response object
+          res.statusCode = 404;
+          res.end(`${req.url} not found`);
         },
-      ],
-    },
-  };
-};
+      },
+    ],
+  },
+});
 ```
 
 ### virtualEnvs
@@ -70,24 +67,23 @@ functions:
 ```
 
 ```js
-// config.js
-module.exports = ({ lambdas, isDeploying, isPackaging, setEnv, stage, port }) => {
-  return {
-    esbuild: {
-      // ...
-    },
-    offline: {
-      // ...
-    },
-    buildCallback: async (result) => {
-      const foundLambda = lambdas.find((x) => x.name == "players");
+import { defineConfig } from "serverless-aws-lambda/defineConfig";
 
-      if (foundLambda) {
-        console.log(foundLambda.virtualEnvs);
-      }
-    },
-  };
-};
+export default defineConfig({
+  esbuild: {
+    // ...
+  },
+  offline: {
+    // ...
+  },
+  buildCallback: async (result) => {
+    const foundLambda = lambdas.find((x) => x.name == "players");
+
+    if (foundLambda) {
+      console.log(foundLambda.virtualEnvs);
+    }
+  },
+});
 ```
 
 ## Run serverless-aws-lambda programmatically

diff --git a/resources/sns.md b/resources/sns.md
@@ -9,10 +9,10 @@ Import the plugin inside your defineConfig.
 
 ```js
 // config.js
-const { defineConfig } = require("serverless-aws-lambda/defineConfig");
-const { snsPlugin } = require("serverless-aws-lambda/sns");
+import { defineConfig } from "serverless-aws-lambda/defineConfig";
+import { snsPlugin } = from "serverless-aws-lambda/sns";
 
-module.exports = defineConfig({
+export default defineConfig({
   plugins: [snsPlugin()],
 });
 ```

diff --git a/resources/sqs.md b/resources/sqs.md
@@ -13,10 +13,10 @@ Import the plugin inside your defineConfig.
 
 ```js
 // config.js
-const { defineConfig } = require("serverless-aws-lambda/defineConfig");
-const { sqsPlugin } = require("serverless-aws-lambda/sqs");
+import { defineConfig } from "serverless-aws-lambda/defineConfig";
+import { sqsPlugin } = from "serverless-aws-lambda/sqs";
 
-module.exports = defineConfig({
+export default defineConfig({
   plugins: [sqsPlugin(config)],
 });
 ```

diff --git a/src/plugins/lambda/events/alb.ts b/src/plugins/lambda/events/alb.ts
@@ -235,8 +235,8 @@ export class AlbRequestHandler extends CommonEventGenerator {
     const queryComponents = queryString.split("&");
 
     queryComponents.forEach((c) => {
-      const [key, value] = c.split("=");
-      queryStringComponents[key] = value;
+      const [key, ...value] = c.split("=");
+      queryStringComponents[key] = value.join("=");
     });
 
     delete queryStringComponents.x_mock_type;