@skillswaveca/nova-shared-libraries 4.16.2 → 4.17.1

package/docs-base/package-info.js

@@ -1,31 +1,31 @@
 export const packageInfo = [
   {
     "name": "@skillswaveca/nova-utils",
-    "version": "4.16.1",
+    "version": "4.17.0",
     "description": "A collection of random utils used in nova repos",
     "docsPath": "./nova-utils/index.html"
   },
   {
     "name": "@skillswaveca/nova-router",
-    "version": "4.16.1",
+    "version": "4.17.0",
     "description": "An extended Koa router that enables better validation",
     "docsPath": "./nova-router/index.html"
   },
   {
     "name": "@skillswaveca/nova-model",
-    "version": "4.16.1",
+    "version": "4.17.0",
     "description": "Nova model stuff",
     "docsPath": "./nova-model/index.html"
   },
   {
     "name": "@skillswaveca/nova-middleware",
-    "version": "4.16.1",
+    "version": "4.17.0",
     "description": "A collection of middleware used by nova projects",
     "docsPath": "./nova-middleware/index.html"
   },
   {
     "name": "@skillswaveca/nova-drivers",
-    "version": "4.16.1",
+    "version": "4.17.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.16.2",
+  "version": "4.17.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.16.2",
+  "version": "4.17.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.16.2",
+  "version": "4.17.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

package/packages/nova-middleware/src/distributed-logging-middleware.js

@@ -1,36 +1,36 @@
-import { v4 as uuidv4 } from 'uuid';
-
-import logger from '../../nova-utils/src/logger.js';
-
-/**
- * Koa middleware for log synchronization across multiple services.
- * Provides a log context with `x-nova-request-id` as a default log value
- * that can be used to sync logs across services. Also provides the property
- * `context.novaRequestId` that can be used to get the current request id when
- * trigger external services.
- *
- * If a request does not contain a header `x-nova-request-id` then a new
- * uuid will be provided.
- *
- * @returns {(function(*, *): Promise<void>)|*}
- */
-export const distributedLoggingMiddleware = () => {
-  return async(context, next) => {
-    if (!context.log) {
-        context.log = logger;
-    }
-
-    const defaultLogger = context.log;
-
-    try {
-        const novaRequestId = context.request.headers['x-nova-request-id'] || uuidv4();
-        context.log = context.log.child({ 'x-nova-request-id': novaRequestId });
-        context.novaRequestId = novaRequestId;
-    } catch (error) {
-        context.log.error({ error: error.message }, 'Distributed Logging Middleware: Error');
-        context.log = defaultLogger;
-    }
-
-    await next();
-  };
-};
+import { v4 as uuidv4 } from 'uuid';
+
+import { log as logger } from '../../nova-utils/src/logger.js';
+
+/**
+ * Koa middleware for log synchronization across multiple services.
+ * Provides a log context with `x-nova-request-id` as a default log value
+ * that can be used to sync logs across services. Also provides the property
+ * `context.novaRequestId` that can be used to get the current request id when
+ * trigger external services.
+ *
+ * If a request does not contain a header `x-nova-request-id` then a new
+ * uuid will be provided.
+ *
+ * @returns {(function(*, *): Promise<void>)|*}
+ */
+export const distributedLoggingMiddleware = () => {
+  return async(context, next) => {
+    if (!context.log) {
+      context.log = logger;
+    }
+
+    const defaultLogger = context.log;
+
+    try {
+      const novaRequestId = context.request.headers['x-nova-request-id'] || uuidv4();
+      context.log = context.log.child({ 'x-nova-request-id': novaRequestId });
+      context.novaRequestId = novaRequestId;
+    } catch (error) {
+      context.log.error({ error: error.message }, 'Distributed Logging Middleware: Error');
+      context.log = defaultLogger;
+    }
+
+    await next();
+  };
+};

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.16.2",
+  "version": "4.17.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

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.16.2",
+  "version": "4.17.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.16.2",
+  "version": "4.17.1",
   "main": "index.js",
   "scripts": {
     "pre-release": "pnpm run create-index",

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

@@ -1,26 +1,47 @@
 import { AsyncLocalStorage } from 'node:async_hooks';
 import pino from 'pino';
+import { v4 as uuidv4 } from 'uuid';
 
-const base = null;
-const level = process.env.LOG_LEVEL || 'info';
-const redact = {
-  paths: [
-    'context.log',
-    'context.drivers',
-    'context.config',
-    'event.Records[*].dynamodb',
-  ],
-  remove: true,
-};
-const serializers = pino.stdSerializers;
-const logger = pino({ base, level, redact, serializers });
+export const asyncContext = new AsyncLocalStorage();
+// Create a base logger instance
+const baseLogger = pino({
+  level: process.env.NODE_ENV === 'production' ? 'info' : 'debug',
+});
 
-export const asyncLocalStorage = new AsyncLocalStorage();
+// addToContext function: adds a key/value pair to the current request's logger context.
+export const addToContext = (key, value) => {
+  const store = asyncContext.getStore();
+  if (store) {
+    // Get the current child logger or fallback to the base logger.
+    const currentLogger = store.get('logger') || baseLogger;
+    // Create a new child logger with the additional key/value pair.
+    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);
+  }
+};
 
-const getAsyncData = () => {
-  return asyncLocalStorage.getStore() || {};
+export const contextMiddleware = async(ctx, next) => {
+  const requestId = uuidv4();
+  const child = baseLogger.child({ requestId });
+  const store = new Map();
+  store.set('logger', child);
+  await asyncContext.run(store, async() => {
+    await next();
+  });
 };
 
-export default logger;
+// Wrap the base logger with a Proxy that uses the child logger from AsyncLocalStorage if available.
+export const log = new Proxy(baseLogger, {
+  get(target, property, receiver) {
+    const store = asyncContext.getStore();
+    if (store && store.get('logger')) {
+      target = store.get('logger');
+    }
+    return Reflect.get(target, property, receiver);
+  },
+});
+
+export const logger = log;
 
-export const log = logger.child(getAsyncData());
+export default log;