chore: remove x- from header

Author: jpinho

packages/large-response-middleware/docs/architecture-1.plantuml

@@ -9,11 +9,17 @@ Client -> "API Gateway": Request data with/without header
 "API Gateway" -> Lambda: Invoke Lambda
 
 alt If "Accept: application:large-response.vnd+json" is present
+    Lambda -> Lambda: Logs info event
     Lambda -> "S3 Bucket": Save large response
     "S3 Bucket" -> Lambda: Return S3 ref
     Lambda -> "API Gateway": Return S3 ref `{ $payload_ref: "s3://..." }`
     "API Gateway" -> Client: Return $payload_ref
+else If "Handle-Large-Request: true" is present
+    Lambda -> Lambda: Logs info event
+    Lambda -> Lambda: Skips S3 content dump
+    Lambda -> Client: Response 413 (Payload Too Large)
 else If request header is not present
+    Lambda -> Lambda: Logs error event
     Lambda -> "API Gateway": Response 500 (Internal Server Error)
     "API Gateway" -> Client: Response 413 (Payload Too Large)
 end

packages/large-response-middleware/src/index.test.ts

@@ -5,7 +5,12 @@ import * as Lambda from 'aws-lambda';
 import { getOrgIdFromContext } from './__tests__/util';
 
 import * as middleware from './';
-import { LARGE_RESPONSE_MIME_TYPE, LARGE_RESPONSE_USER_INFO, withLargeResponseHandler } from './';
+import {
+  LARGE_RESPONSE_HANDLED_INFO,
+  LARGE_RESPONSE_MIME_TYPE,
+  LARGE_RESPONSE_USER_INFO,
+  withLargeResponseHandler,
+} from './';
 
 const uploadFileSpy = jest.spyOn(middleware, 'uploadFile').mockResolvedValue({
   filename: 'red-redington/2023-12-13/la-caballa',
@@ -282,7 +287,7 @@ describe('withLargeResponseHandler', () => {
             },
           } as any,
           headers: {
-            'X-Handle-Large-Response': 'true',
+            'Handle-Large-Response': 'true',
           },
         } as Partial<Lambda.APIGatewayProxyEventV2>,
         response: {
@@ -312,7 +317,7 @@ describe('withLargeResponseHandler', () => {
         meta: {
           content_length_mb: '1.85',
         },
-        message: LARGE_RESPONSE_USER_INFO,
+        message: LARGE_RESPONSE_HANDLED_INFO,
       });
     });
   });

packages/large-response-middleware/src/index.ts

@@ -17,8 +17,9 @@ const TO_MB_FACTOR = 1_048_576.0;
  */
 export const LIMIT_REQUEST_SIZE_MB = 6.0;
 export const LARGE_RESPONSE_MIME_TYPE = 'application/large-response.vnd+json';
-export const HANDLE_LARGE_RESPONSE_HEADER = 'x-handle-large-response';
+export const HANDLE_LARGE_RESPONSE_HEADER = 'handle-large-response';
 export const LARGE_RESPONSE_USER_INFO = `Call the API with the HTTP header 'Accept: ${LARGE_RESPONSE_MIME_TYPE}' to receive the payload through an S3 ref and avoid 500 errors or '${HANDLE_LARGE_RESPONSE_HEADER}: true' to receive a 413 Bad Request error and the metadata in the response body.`;
+export const LARGE_RESPONSE_HANDLED_INFO = `'${HANDLE_LARGE_RESPONSE_HEADER}: true' received means client can handle this event. The response is too large and can't be returned to the client.`;
 
 export type FileUploadContext = {
   bucket: string;
@@ -110,12 +111,12 @@ export const withLargeResponseHandler = ({
               meta: {
                 content_length_mb: contentLengthMB.toFixed(2),
               },
-              message: getCustomErrorMessage(customErrorMessage, event),
+              message: getCustomErrorMessage(customErrorMessage || LARGE_RESPONSE_HANDLED_INFO, event),
             });
 
             response.headers = { ...response.headers, ['content-type']: LARGE_RESPONSE_MIME_TYPE };
             Log.info(
-              `Large response detected (limit exceeded). Client can handle large response bad request. Rewriting response with { metadata, message } `,
+              `Large response detected (limit exceeded). Client signaled that it can handle large responses via 413. Rewriting response with { metadata, message } `,
               {
                 contentLength: aproxContentLengthBytes,
                 event,