@uoa/lambda-tracing 2.2.1 → 2.3.0-beta.1

package/UoaLogger.ts

@@ -64,26 +64,28 @@ export class UoaLogger {
     public audit(auditInformation: AuditInformation, message?: string): void {
         // Initialize logMessage with mandatory fields
         let logMessage: string =
-            `accessedBy:${auditInformation.accessedBy.replace(/\s/g, '')} ` +
-            `action:${auditInformation.action.toString().replace(/\s/g, '')} ` +
-            `owner:${auditInformation.ownerId.replace(/\s/g, '')} ` +
-            `resourceType:${auditInformation.resourceType.replace(/\s/g, '')}`;
-
-        // Add optional fields if they exist
-        if (auditInformation.application) {
-            logMessage = `application:${auditInformation.application.replace(/\s/g, '')} ` + logMessage;
-        }
-        if (auditInformation.resourceId) {
-            logMessage += ` resourceId:${auditInformation.resourceId.replace(/\s/g, '')}`;
-        }
-
+          `application:${
+            auditInformation.application
+              ? auditInformation.application.replace(/\s/g, "")
+              : "-"
+          } ` +
+          `accessedBy:${auditInformation.accessedBy.replace(/\s/g, "")} ` +
+          `action:${auditInformation.action.toString().replace(/\s/g, "")} ` +
+          `owner:${auditInformation.ownerId.replace(/\s/g, "")} ` +
+          `resourceType:${auditInformation.resourceType.replace(/\s/g, "")} ` +
+          `resourceId:${
+            auditInformation.resourceId
+              ? auditInformation.resourceId.replace(/\s/g, "")
+              : "-"
+          }`;
+    
         // Append additional message if provided
         if (message) {
-            logMessage += ` ${message}`;
+          logMessage += ` ${message}`;
         }
-
+    
         this.logger.log("audit", logMessage);
-    }
+      }
 
     /**
      * Function to log warn level messages.

package/changelog.md

@@ -1,5 +1,11 @@
 # 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 ("-").
+
 ## 2.2.1
 - Fix formatting in readme
 

package/dist/UoaLogger.js

@@ -30,17 +30,16 @@ class UoaLogger {
      */
     audit(auditInformation, message) {
         // Initialize logMessage with mandatory fields
-        let logMessage = `accessedBy:${auditInformation.accessedBy.replace(/\s/g, '')} ` +
-            `action:${auditInformation.action.toString().replace(/\s/g, '')} ` +
-            `owner:${auditInformation.ownerId.replace(/\s/g, '')} ` +
-            `resourceType:${auditInformation.resourceType.replace(/\s/g, '')}`;
-        // Add optional fields if they exist
-        if (auditInformation.application) {
-            logMessage = `application:${auditInformation.application.replace(/\s/g, '')} ` + logMessage;
-        }
-        if (auditInformation.resourceId) {
-            logMessage += ` resourceId:${auditInformation.resourceId.replace(/\s/g, '')}`;
-        }
+        let logMessage = `application:${auditInformation.application
+            ? auditInformation.application.replace(/\s/g, "")
+            : "-"} ` +
+            `accessedBy:${auditInformation.accessedBy.replace(/\s/g, "")} ` +
+            `action:${auditInformation.action.toString().replace(/\s/g, "")} ` +
+            `owner:${auditInformation.ownerId.replace(/\s/g, "")} ` +
+            `resourceType:${auditInformation.resourceType.replace(/\s/g, "")} ` +
+            `resourceId:${auditInformation.resourceId
+                ? auditInformation.resourceId.replace(/\s/g, "")
+                : "-"}`;
         // Append additional message if provided
         if (message) {
             logMessage += ` ${message}`;

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,6 +110,11 @@ function doHttpsRequest(options, resolve, reject) {
                 try {
                     let body = Buffer.concat(chunks);
                     let parsedBody = body.toString();
+                    //Get the response content-encoding header value so we can decode before parsing
+                    const responseContentEncoding = response.headers["content-encoding"]?.toLowerCase() ?? '';
+                    if (responseContentEncoding !== '') {
+                        parsedBody = decodeResponse(parsedBody, 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')) {
@@ -155,6 +161,23 @@ function setRequestBody(request, data) {
         }
     }
 }
+function decodeResponse(responseBody, contentEncodingHeader) {
+    const contentEncodings = contentEncodingHeader.replace(/\s/g, '').split(',');
+    contentEncodings.forEach(contentEncoding => {
+        switch (contentEncoding) {
+            case 'gzip':
+                responseBody = zlib.gunzipSync(Buffer.from(responseBody)).toString();
+                break;
+            case 'deflate':
+                responseBody = zlib.inflateSync(Buffer.from(responseBody)).toString();
+                break;
+            case 'br':
+                responseBody = zlib.brotliDecompressSync(Buffer.from(responseBody)).toString();
+                break;
+        }
+    });
+    return responseBody;
+}
 module.exports = {
     request,
     doGetRequest,

package/package.json

@@ -1,12 +1,27 @@
 {
   "name": "@uoa/lambda-tracing",
-  "version": "2.2.1",
+  "version": "2.3.0-beta.1",
   "description": "Library for logging & distributed tracing in UoA Lambda projects",
   "repository": {
     "type": "git",
     "url": "git+ssh://git@bitbucket.org/uoa/lambda-tracing.git"
   },
   "author": "Mitchell Faulconbridge <mitchell.faulconbridge@auckland.ac.nz>",
+  "contributors": [
+    {
+      "name": "Mitchell Faulconbridge",
+      "email": "mitchell.faulconbridge@auckland.ac.nz"
+    },
+    {
+      "name": "Wenlai Wang",
+      "email": "w.wang@auckland.ac.nz"
+    },
+    {
+      "name": "Osama Kashif",
+      "email": "osama.kashif@auckland.ac.nz",
+      "url": "https://www.linkedin.com/in/osamakashif"
+    }
+  ],
   "license": "MIT",
   "homepage": "https://bitbucket.org/uoa/lambda-tracing#readme",
   "keywords": [

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;
@@ -101,6 +102,12 @@ function doHttpsRequest(options: RequestOptions, resolve: any, reject: any): Cli
                     let body: Buffer = Buffer.concat(chunks);
                     let parsedBody: any = body.toString();
 
+                    //Get the response content-encoding header value so we can decode before parsing
+                    const responseContentEncoding: string = response.headers["content-encoding"]?.toLowerCase() ?? '';
+                    if (responseContentEncoding !== '') {
+                        parsedBody = decodeResponse(parsedBody, 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')) {
@@ -146,6 +153,24 @@ function setRequestBody(request: ClientRequest, data: any) {
     }
 }
 
+function decodeResponse(responseBody: string, contentEncodingHeader: string): string {
+    const contentEncodings: string[] = contentEncodingHeader.replace(/\s/g, '').split(',');
+    contentEncodings.forEach(contentEncoding => {
+        switch (contentEncoding) {
+            case 'gzip':
+                responseBody = zlib.gunzipSync(Buffer.from(responseBody)).toString();
+                break;
+            case 'deflate':
+                responseBody = zlib.inflateSync(Buffer.from(responseBody)).toString();
+                break;
+            case 'br':
+                responseBody = zlib.brotliDecompressSync(Buffer.from(responseBody)).toString();
+                break;
+        }
+    });
+    return responseBody;
+}
+
 module.exports = {
     request,
     doGetRequest,