@skillswaveca/nova-shared-libraries 4.17.1 → 4.18.1

package/docs-base/package-info.js

@@ -1,31 +1,31 @@
 export const packageInfo = [
   {
     "name": "@skillswaveca/nova-utils",
-    "version": "4.17.0",
+    "version": "4.18.0",
     "description": "A collection of random utils used in nova repos",
     "docsPath": "./nova-utils/index.html"
   },
   {
     "name": "@skillswaveca/nova-router",
-    "version": "4.17.0",
+    "version": "4.18.0",
     "description": "An extended Koa router that enables better validation",
     "docsPath": "./nova-router/index.html"
   },
   {
     "name": "@skillswaveca/nova-model",
-    "version": "4.17.0",
+    "version": "4.18.0",
     "description": "Nova model stuff",
     "docsPath": "./nova-model/index.html"
   },
   {
     "name": "@skillswaveca/nova-middleware",
-    "version": "4.17.0",
+    "version": "4.18.0",
     "description": "A collection of middleware used by nova projects",
     "docsPath": "./nova-middleware/index.html"
   },
   {
     "name": "@skillswaveca/nova-drivers",
-    "version": "4.17.0",
+    "version": "4.18.0",
     "description": "Some helper drivers for AWS services",
     "docsPath": "./drivers/index.html"
   }

package/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-shared-libraries",
   "description": "A monorepo of shared libraries for Nova projects.",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "license": "MIT",
   "keywords": [],

package/packages/drivers/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-drivers",
   "description": "Some helper drivers for AWS services",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-middleware/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-middleware",
   "description": "A collection of middleware used by nova projects",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-model/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-model",
   "description": "Nova model stuff",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-model/src/stream/nova-stream-task-router.js

@@ -26,12 +26,12 @@ export class NovaStreamTaskRouter {
   handle(newRecord, oldRecord) {
     const { recordType, operation } = this.getRecordStatus(oldRecord, newRecord);
     if (!recordType) {
-      log.warn({ recordType, operation }, 'No record type found');
+      log.trace({ recordType, operation }, 'No record type found');
       return null;
     }
     const handler = this._recordHandlers[recordType]?.[operation];
     if (!handler) {
-      log.warn({ recordType, operation }, 'No handler found for record');
+      log.trace({ recordType, operation }, 'No handler found for record');
       return null;
     }
     return handler(newRecord, oldRecord);

package/packages/nova-router/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-router",
   "description": "An extended Koa router that enables better validation",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-utils/package.json

@@ -3,7 +3,7 @@
   "name": "@skillswaveca/nova-utils",
   "description": "A collection of random utils used in nova repos",
   "repository": "https://github.com/SkillsWave/nova-shared-libraries",
-  "version": "4.17.1",
+  "version": "4.18.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-utils/src/logger.js

@@ -2,13 +2,28 @@ import { AsyncLocalStorage } from 'node:async_hooks';
 import pino from 'pino';
 import { v4 as uuidv4 } from 'uuid';
 
+/**
+ * AsyncLocalStorage instance for maintaining request-specific context.
+ * @type {AsyncLocalStorage<Map<string, any>>}
+ */
 export const asyncContext = new AsyncLocalStorage();
-// Create a base logger instance
+
+/**
+ * Base logger instance created using pino.
+ * The log level is 'info' in production and 'debug' otherwise.
+ * @type {pino.Logger}
+ */
 const baseLogger = pino({
-  level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
+  level: 'info',
 });
 
-// addToContext function: adds a key/value pair to the current request's logger context.
+/**
+ * Adds a key/value pair to the current request's logger context.
+ * This function creates a child logger with the new field and updates the async context.
+ *
+ * @param {string} key - The key to add to the context.
+ * @param {*} value - The value to associate with the key.
+ */
 export const addToContext = (key, value) => {
   const store = asyncContext.getStore();
   if (store) {
@@ -18,9 +33,32 @@ export const addToContext = (key, value) => {
     const updatedLogger = currentLogger.child({ [key]: value });
     // Update the store so that all further logging in this async context will include the new field.
     store.set('logger', updatedLogger);
+    store.set(key, value);
+  }
+};
+
+/**
+ * Retrieves a value from the current async context by key.
+ *
+ * @param {string} key - The key whose value should be retrieved.
+ * @returns {*} The value associated with the key, or undefined if not found.
+ */
+export const getFromContext = key => {
+  const store = asyncContext.getStore();
+  if (store) {
+    return store.get(key);
   }
 };
 
+/**
+ * Middleware to set up a new async context for each request.
+ * It generates a unique request ID, creates a child logger for that request,
+ * and stores both in the async context.
+ *
+ * @param {Object} ctx - The context object (e.g., from a web framework).
+ * @param {Function} next - The next middleware function.
+ * @returns {Promise<void>}
+ */
 export const contextMiddleware = async(ctx, next) => {
   const requestId = uuidv4();
   const child = baseLogger.child({ requestId });
@@ -31,7 +69,12 @@ export const contextMiddleware = async(ctx, next) => {
   });
 };
 
-// Wrap the base logger with a Proxy that uses the child logger from AsyncLocalStorage if available.
+/**
+ * A Proxy-wrapped logger that uses the child logger from the current async context if available.
+ * This allows you to log with context-specific information without manually passing the child logger.
+ *
+ * @type {pino.Logger}
+ */
 export const log = new Proxy(baseLogger, {
   get(target, property, receiver) {
     const store = asyncContext.getStore();
@@ -42,6 +85,11 @@ export const log = new Proxy(baseLogger, {
   },
 });
 
+/**
+ * Alias for the proxied logger.
+ *
+ * @type {pino.Logger}
+ */
 export const logger = log;
 
 export default log;