@uoa/lambda-tracing 2.2.2 → 2.3.0-beta.2

package/changelog.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 2.3.0
+- Automatically decode response if Content-Encoding header is present. Supports gzip, br, and deflate encodings.
+
 ## 2.2.2
 - Change behaviour for optional audit parameters. Instead of removing empty optional parameters, they will be present with a hyphen ("-").
 

package/dist/uoaHttps.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const https = __importStar(require("https"));
 const api_1 = require("@opentelemetry/api");
 const fast_xml_parser_1 = require("fast-xml-parser");
+const zlib = __importStar(require("node:zlib"));
 function request(...args) {
     if (args[2]) {
         api_1.propagation.inject(api_1.context.active(), args[1].headers);
@@ -109,10 +110,16 @@ function doHttpsRequest(options, resolve, reject) {
                 try {
                     let body = Buffer.concat(chunks);
                     let parsedBody = body.toString();
+                    let decodedBody = body;
+                    //Get the response content-encoding header value so we can decode before parsing
+                    const responseContentEncoding = response.headers["content-encoding"]?.toLowerCase() ?? '';
+                    if (responseContentEncoding !== '') {
+                        decodedBody = decodeResponse(body, responseContentEncoding);
+                    }
                     //Get the response content-type header value so we can apply different parsing methods
                     const responseContentType = response.headers["content-type"]?.toLowerCase() ?? '';
                     if (responseContentType === '' || responseContentType.includes('json')) {
-                        parsedBody = JSON.parse(body.toString());
+                        parsedBody = JSON.parse(decodedBody.toString());
                     }
                     else if (responseContentType.includes('xml')) {
                         const parser = new fast_xml_parser_1.XMLParser({
@@ -120,10 +127,10 @@ function doHttpsRequest(options, resolve, reject) {
                             ignorePiTags: true,
                             ignoreAttributes: false
                         });
-                        parsedBody = parser.parse(body.toString());
+                        parsedBody = parser.parse(decodedBody.toString());
                     }
                     else if (responseContentType.includes('image')) {
-                        parsedBody = body.toString('base64');
+                        parsedBody = decodedBody.toString('base64');
                     }
                     if (response.statusCode !== undefined && response.statusCode >= 200 && response.statusCode < 300) {
                         resolve(parsedBody);
@@ -155,6 +162,24 @@ function setRequestBody(request, data) {
         }
     }
 }
+function decodeResponse(encodedBody, contentEncodingHeader) {
+    const contentEncodings = contentEncodingHeader.replace(/\s/g, '').split(',');
+    let decodedBody = encodedBody;
+    contentEncodings.forEach(contentEncoding => {
+        switch (contentEncoding) {
+            case 'gzip':
+                decodedBody = zlib.gunzipSync(decodedBody);
+                break;
+            case 'deflate':
+                decodedBody = zlib.inflateSync(decodedBody);
+                break;
+            case 'br':
+                decodedBody = zlib.brotliDecompressSync(decodedBody);
+                break;
+        }
+    });
+    return decodedBody;
+}
 module.exports = {
     request,
     doGetRequest,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uoa/lambda-tracing",
-  "version": "2.2.2",
+  "version": "2.3.0-beta.2",
   "description": "Library for logging & distributed tracing in UoA Lambda projects",
   "repository": {
     "type": "git",

package/uoaHttps.ts

@@ -5,6 +5,7 @@ import {context, propagation} from "@opentelemetry/api";
 import {RequestOptions} from "https";
 import {ClientRequest} from "http";
 import {XMLParser} from "fast-xml-parser";
+import * as zlib from "node:zlib";
 
 function request(options: RequestOptions | string | URL, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
 function request(url: string | URL, options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
@@ -100,20 +101,27 @@ function doHttpsRequest(options: RequestOptions, resolve: any, reject: any): Cli
                 try {
                     let body: Buffer = Buffer.concat(chunks);
                     let parsedBody: any = body.toString();
+                    let decodedBody: Buffer = body;
+
+                    //Get the response content-encoding header value so we can decode before parsing
+                    const responseContentEncoding: string = response.headers["content-encoding"]?.toLowerCase() ?? '';
+                    if (responseContentEncoding !== '') {
+                        decodedBody = decodeResponse(body, responseContentEncoding);
+                    }
 
                     //Get the response content-type header value so we can apply different parsing methods
                     const responseContentType: string = response.headers["content-type"]?.toLowerCase() ?? '';
                     if (responseContentType === '' || responseContentType.includes('json')) {
-                        parsedBody = JSON.parse(body.toString());
+                        parsedBody = JSON.parse(decodedBody.toString());
                     } else if (responseContentType.includes('xml')) {
                         const parser = new XMLParser({
                             ignoreDeclaration: true,
                             ignorePiTags: true,
                             ignoreAttributes: false
                         });
-                        parsedBody = parser.parse(body.toString());
+                        parsedBody = parser.parse(decodedBody.toString());
                     } else if (responseContentType.includes('image')) {
-                        parsedBody = body.toString('base64');
+                        parsedBody = decodedBody.toString('base64');
                     }
 
                     if (response.statusCode !== undefined && response.statusCode >= 200 && response.statusCode < 300) {
@@ -146,6 +154,25 @@ function setRequestBody(request: ClientRequest, data: any) {
     }
 }
 
+function decodeResponse(encodedBody: Buffer, contentEncodingHeader: string): Buffer {
+    const contentEncodings: string[] = contentEncodingHeader.replace(/\s/g, '').split(',');
+    let decodedBody: Buffer = encodedBody;
+    contentEncodings.forEach(contentEncoding => {
+        switch (contentEncoding) {
+            case 'gzip':
+                decodedBody = zlib.gunzipSync(decodedBody);
+                break;
+            case 'deflate':
+                decodedBody = zlib.inflateSync(decodedBody);
+                break;
+            case 'br':
+                decodedBody = zlib.brotliDecompressSync(decodedBody);
+                break;
+        }
+    });
+    return decodedBody;
+}
+
 module.exports = {
     request,
     doGetRequest,