fix: ignore null & undefined query params & headers, when converting axios calls to lambda invoke

Author: Daniel Bot

src/openapi-lambda-adapters.test.ts

@@ -80,6 +80,32 @@ describe('Adapt axios request/response to AWS Lambda Proxy Event/Response', () =
       expect(event.rawQueryString).toEqual('limit=20&offset=100')
     })
 
+    it('converts axios call with null query params', () => {
+      // given
+      const axiosConfig: AxiosRequestConfig = {
+        method: 'get',
+        url: '/v1/users',
+        params: {
+          limit: 20,
+          offset: null,
+          flag: undefined,
+        }
+      }
+      const operation: Operation = {
+        path: '/v1/users',
+        method: HttpMethod.Get,
+        responses: {}
+      }
+
+      // then
+      const event = convertAxiosToApiGw(axiosConfig, operation)
+      expect(event.pathParameters).toEqual({})
+      expect(event.queryStringParameters).toEqual({
+        limit: '20',
+      })
+      expect(event.rawQueryString).toEqual('limit=20')
+    })
+
     it('converts axios call with both path & query params', () => {
       // given
       const axiosConfig: AxiosRequestConfig = {
@@ -178,6 +204,7 @@ describe('Adapt axios request/response to AWS Lambda Proxy Event/Response', () =
       expect(event.headers['x-null']).toBeUndefined()
       expect(event.headers['x-undefined']).toBeUndefined()
     })
+    
   })
 
   describe('Api GW Proxy Response to Axios Response', () => {

src/openapi-lambda-adapters.ts

@@ -41,13 +41,13 @@ export const convertAxiosToApiGw = (config: AxiosRequestConfig, operation: Opera
   }
 
   // extract query params -> convert each value to ta string
-  const queryParams = Object.entries(config.params ?? {}).reduce<APIGatewayProxyEventQueryStringParameters>((queryParams, [key, val]) => {
+  const queryParams = Object.entries(config.params ?? {}).filter(entryValueExists).reduce<APIGatewayProxyEventQueryStringParameters>((queryParams, [key, val]) => {
     queryParams[key] = val?.toString()
     return queryParams
   }, {})
 
   const queryString: string[] = []
-  Object.entries(config.params ?? {}).forEach(([key, val]) => {
+  Object.entries(config.params ?? {}).filter(entryValueExists).forEach(([key, val]) => {
     if (val && Array.isArray(val)) {
       // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
       queryString.push(...val.map((entry) => `${key}=${entry.toString()}`))
@@ -56,11 +56,8 @@ export const convertAxiosToApiGw = (config: AxiosRequestConfig, operation: Opera
     }
   })
 
-  const urlSearchParams = new URLSearchParams()
-  Object.entries(config.params ?? {}).forEach(([key, val]) => urlSearchParams.append(key, val.toString()))
-
   const headers: Record<string, string> = {}
-  for (const [key, val] of Object.entries(config.headers ?? {}).filter(([_key, val]) => val !== null && val !== undefined)) {
+  for (const [key, val] of Object.entries(config.headers ?? {}).filter(entryValueExists)) {
     headers[key] = val.toString()
   }
 
@@ -124,6 +121,8 @@ export const convertApiGwToAxios = (resp: APIGatewayProxyStructuredResultV2, axi
   return axiosResp
 }
 
+const entryValueExists = (entry: [string, unknown]): boolean => entry[1] !== null && entry[1] !== undefined
+
 class AxiosError extends Error {
   public readonly code: string
   public readonly config: AxiosRequestConfig