@mhmdhammoud/meritt-utils 1.5.8 → 1.5.9

package/dist/__tests__/logger.test.js

@@ -94,7 +94,7 @@ describe('route and format logs', () => {
         key0: 'val0',
         key1: 'val1',
     };
-    test('log info with structured context (single object flattened)', () => {
+    test('log info with structured context (single object in context field)', () => {
         //@ts-ignore
         jest.spyOn(pino_1.pino, 'destination').mockReturnValue(PINO_DESTINATION);
         //@ts-ignore
@@ -105,11 +105,10 @@ describe('route and format logs', () => {
             component: LOGGER_NAME,
             code: LOG_EVENT.code,
             msg: LOG_EVENT.msg,
-            key0: 'val0',
-            key1: 'val1',
+            context: { key0: 'val0', key1: 'val1' },
         }));
     });
-    test('remap reserved elastic field names and reduce objects to scalars', () => {
+    test('remap reserved elastic field names in context', () => {
         //@ts-ignore
         jest.spyOn(pino_1.pino, 'destination').mockReturnValue(PINO_DESTINATION);
         //@ts-ignore
@@ -122,10 +121,12 @@ describe('route and format logs', () => {
                 _index: 'bad-index',
             },
         });
-        // Top-level fields use scalars only (avoids ES document_parsing_exception)
+        // Context holds sanitized structure; reserved names remapped recursively
         expect(PINO.info).toHaveBeenCalledWith(expect.objectContaining({
-            mongo_id: 'abc123',
-            nested: 'nested-1',
+            context: expect.objectContaining({
+                mongo_id: 'abc123',
+                nested: { mongo_id: 'nested-1', es_index: 'bad-index' },
+            }),
         }));
         expect(PINO.info).not.toHaveBeenCalledWith(expect.objectContaining({
             _id: expect.anything(),

package/dist/lib/logger.js

@@ -77,37 +77,6 @@ const isPlainObject = (v) => v !== null &&
     !Array.isArray(v) &&
     !(v instanceof Error) &&
     !(v instanceof Date);
-/**
- * Reduces object values to scalars for top-level ES fields.
- * ES text/keyword fields reject nested objects; use _id or truncated JSON.
- */
-const toScalarForTopLevel = (value) => {
-    if (value === null || value === undefined)
-        return null;
-    if (typeof value === 'string' ||
-        typeof value === 'number' ||
-        typeof value === 'boolean')
-        return value;
-    if (value instanceof Date)
-        return value.toISOString();
-    if (isObjectIdLike(value))
-        return value.toHexString();
-    if (value instanceof Error)
-        return value.message;
-    if (isPlainObject(value) && '_id' in value) {
-        const id = value._id;
-        if (id != null) {
-            if (typeof id === 'string')
-                return id;
-            if (isObjectIdLike(id))
-                return id.toHexString();
-            if (typeof id === 'object' && id !== null && 'toString' in id)
-                return String(id.toString());
-        }
-    }
-    const str = typeof value === 'object' ? JSON.stringify(value) : String(value);
-    return str.length > 200 ? `${str.slice(0, 200)}...` : str;
-};
 /**
  * Recursively sanitize log values for Elasticsearch safety.
  * - Remaps reserved key names (e.g. `_id` -> `mongo_id`)
@@ -412,17 +381,15 @@ class Logger {
         if (trace) {
             ecs.trace_id = trace.traceId;
         }
-        // Structured context: flatten single plain object as top-level fields
-        // Use scalars only for top-level ES fields; text/keyword mappings reject nested objects
+        // Structured context: put in single 'context' field to avoid ES mapping conflicts.
+        // Flattening to top-level caused document_parsing_exception (object vs scalar type mismatches).
+        // Nesting in context keeps structure consistent and avoids per-field mapping conflicts.
+        let context;
         let detail;
         if (args.length === 1 &&
             isPlainObject(args[0]) &&
             Object.keys(args[0]).length > 0) {
-            const obj = args[0];
-            for (const [k, v] of Object.entries(obj)) {
-                const key = toSafeElasticFieldName(k);
-                ecs[key] = toScalarForTopLevel(v);
-            }
+            context = sanitizeForElastic(args[0]);
         }
         else {
             detail = isLocal ? args : JSON.stringify(sanitizeForElastic(args));
@@ -434,6 +401,9 @@ class Logger {
             code: event.code,
             msg: event.msg,
         };
+        if (context !== undefined) {
+            base.context = context;
+        }
         if (detail !== undefined) {
             base.detail = detail;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@mhmdhammoud/meritt-utils",
-	"version": "1.5.8",
+	"version": "1.5.9",
 	"description": "",
 	"main": "./dist/index.js",
 	"private": false,

package/src/__tests__/logger.test.ts

@@ -70,7 +70,7 @@ describe('route and format logs', () => {
 		key0: 'val0',
 		key1: 'val1',
 	}
-	test('log info with structured context (single object flattened)', () => {
+	test('log info with structured context (single object in context field)', () => {
 		//@ts-ignore
 		jest.spyOn(pino, 'destination').mockReturnValue(PINO_DESTINATION)
 		//@ts-ignore
@@ -84,13 +84,12 @@ describe('route and format logs', () => {
 				component: LOGGER_NAME,
 				code: LOG_EVENT.code,
 				msg: LOG_EVENT.msg,
-				key0: 'val0',
-				key1: 'val1',
+				context: { key0: 'val0', key1: 'val1' },
 			})
 		)
 	})
 
-	test('remap reserved elastic field names and reduce objects to scalars', () => {
+	test('remap reserved elastic field names in context', () => {
 		//@ts-ignore
 		jest.spyOn(pino, 'destination').mockReturnValue(PINO_DESTINATION)
 		//@ts-ignore
@@ -105,11 +104,13 @@ describe('route and format logs', () => {
 			},
 		})
 
-		// Top-level fields use scalars only (avoids ES document_parsing_exception)
+		// Context holds sanitized structure; reserved names remapped recursively
 		expect(PINO.info).toHaveBeenCalledWith(
 			expect.objectContaining({
-				mongo_id: 'abc123',
-				nested: 'nested-1',
+				context: expect.objectContaining({
+					mongo_id: 'abc123',
+					nested: { mongo_id: 'nested-1', es_index: 'bad-index' },
+				}),
 			})
 		)
 		expect(PINO.info).not.toHaveBeenCalledWith(

package/src/lib/logger.ts

@@ -52,36 +52,6 @@ const isPlainObject = (v: unknown): v is Record<string, unknown> =>
 	!(v instanceof Error) &&
 	!(v instanceof Date)
 
-/**
- * Reduces object values to scalars for top-level ES fields.
- * ES text/keyword fields reject nested objects; use _id or truncated JSON.
- */
-const toScalarForTopLevel = (
-	value: unknown
-): string | number | boolean | null => {
-	if (value === null || value === undefined) return null
-	if (
-		typeof value === 'string' ||
-		typeof value === 'number' ||
-		typeof value === 'boolean'
-	)
-		return value
-	if (value instanceof Date) return value.toISOString()
-	if (isObjectIdLike(value)) return value.toHexString()
-	if (value instanceof Error) return value.message
-	if (isPlainObject(value) && '_id' in value) {
-		const id = (value as { _id?: unknown })._id
-		if (id != null) {
-			if (typeof id === 'string') return id
-			if (isObjectIdLike(id)) return id.toHexString()
-			if (typeof id === 'object' && id !== null && 'toString' in id)
-				return String((id as { toString: () => string }).toString())
-		}
-	}
-	const str = typeof value === 'object' ? JSON.stringify(value) : String(value)
-	return str.length > 200 ? `${str.slice(0, 200)}...` : str
-}
-
 /**
  * Recursively sanitize log values for Elasticsearch safety.
  * - Remaps reserved key names (e.g. `_id` -> `mongo_id`)
@@ -491,19 +461,17 @@ class Logger {
 			ecs.trace_id = trace.traceId
 		}
 
-		// Structured context: flatten single plain object as top-level fields
-		// Use scalars only for top-level ES fields; text/keyword mappings reject nested objects
+		// Structured context: put in single 'context' field to avoid ES mapping conflicts.
+		// Flattening to top-level caused document_parsing_exception (object vs scalar type mismatches).
+		// Nesting in context keeps structure consistent and avoids per-field mapping conflicts.
+		let context: Record<string, unknown> | undefined
 		let detail: unknown
 		if (
 			args.length === 1 &&
 			isPlainObject(args[0]) &&
 			Object.keys(args[0]).length > 0
 		) {
-			const obj = args[0]
-			for (const [k, v] of Object.entries(obj)) {
-				const key = toSafeElasticFieldName(k)
-				ecs[key] = toScalarForTopLevel(v)
-			}
+			context = sanitizeForElastic(args[0]) as Record<string, unknown>
 		} else {
 			detail = isLocal ? args : JSON.stringify(sanitizeForElastic(args))
 		}
@@ -515,6 +483,9 @@ class Logger {
 			code: event.code,
 			msg: event.msg,
 		}
+		if (context !== undefined) {
+			base.context = context
+		}
 		if (detail !== undefined) {
 			base.detail = detail
 		}