@uoa/lambda-tracing 2.2.0 → 2.2.2

package/ReleaseSteps.md

@@ -1,8 +1,9 @@
 # Steps to release package to npm
 1. `npm login`
 2. `npm version <new version>`
-3. Push to git to sync new tags
-4. `npm publish --access=public --otp=<2FA code>`
+3. Update changelog.md & commit the changes
+4. Push to git to sync new tags
+5. `npm publish --access=public --otp=<2FA code>`
 
 # Testing locally before release
 1. `npm pack`

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,7 +1,14 @@
 # Changelog
 
+## 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
+
 ## 2.2.0
 - Added audit level to logger
+- The logger debug, info, warn, and error functions now require a string input
 
 ## 2.1.2
 - Updated XML response parsing to include attribute tags

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/package.json

@@ -1,12 +1,27 @@
 {
   "name": "@uoa/lambda-tracing",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "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/readme.md

@@ -126,8 +126,7 @@ logger.audit({application: "applicationName", action: "read", resourceId: "12345
 ```
 Will produce the following log message:
 ```text
-2024-04-12T00:58:05.321Z [-] AUDIT src.controller.person-controller - [[[TraceId,SpanId,Info]]] application:applicationName accessedBy:upi1234 action:read owner:upi5678 
-resourceType:personalDetails resourceId:123456789 Additional useful info
+2024-04-12T00:58:05.321Z [-] AUDIT src.controller.person-controller - [[[TraceId,SpanId,Info]]] application:applicationName accessedBy:upi1234 action:read owner:upi5678 resourceType:personalDetails resourceId:123456789 Additional useful info
 ```
 
 ### Distributed Tracing