b2b-platform-utils 1.1.2 → 1.1.4

package/localCache.js

@@ -19,7 +19,7 @@
 let cacheData = {};
 
 /** @type {string} */
-let serviceKey = 'notification';
+let serviceKey = 'not_set_service';
 
 /** @type {number} */
 let bufferChunkSize = 512000;

package/logger.js

@@ -1,33 +1,141 @@
 'use strict';
 
-// Purpose: Colorized console logging helpers for quick CLI visibility.
+/**
+ * @module logger
+ * @description
+ * Non-blocking logger that reads environment and service name from localCache.
+ * - Production (environment === "production"): newline-delimited JSON to stdout/stderr.
+ * - Non-production: colorized console output with icons.
+ * - Uses async writes to avoid blocking hot paths.
+ *
+ * Dependencies:
+ * - localCache module must export: getValue(key), getService().
+ */
 
-module.exports = {
-    /**
-     * Print a debug payload as magenta JSON.
-     */
-    debug: (data) => {
-        console.log(`\x1b[35m❗ ${JSON.stringify(data)} [DEBUG] \x1b[0m`);
-    },
-
-    /**
-     * Print a green success note.
-     */
-    successNote: (message) => {
-        console.info(`\x1b[32m✅ ${message?.toString()} \x1b[0m`);
-    },
-
-    /**
-     * Print a red critical note.
-     */
-    criticalNote: (message) => {
-        console.info(`\x1b[31m⛔ ${message?.toString()} ⛔\x1b[0m`);
-    },
-
-    /**
-     * Print a yellow warning note.
-     */
-    warningNote: (message) => {
-        console.warn(`\x1b[33m❗ ${message?.toString()} ❗\x1b[0m`);
+let cache;
+try {
+    // NOTE: Adjust the path if your cache module lives elsewhere.
+    cache = require('./localCache');
+} catch (_) {
+    // NOTE: Safe fallback stub to keep logger functional if cache is not available.
+    cache = {
+        getValue: () => null,
+        getService: () => 'not_set_service'
+    };
+}
+
+/**
+ * Resolve current environment and service on each call.
+ * This allows dynamic changes at runtime (if your cache updates).
+ */
+function resolveContext() {
+    const env = cache.getValue('environment') || 'development';
+    const service = cache.getService ? cache.getService() : 'not_set_service';
+    const isProd = env === 'production';
+    return { env, service, isProd };
+}
+
+/**
+ * Internal async writer using setImmediate to offload writes from the hot path.
+ * @param {'stdout'|'stderr'} stream
+ * @param {string} message
+ */
+function asyncWrite(stream, message) {
+    setImmediate(() => {
+        process[stream].write(message + '\n');
+    });
+}
+
+/**
+ * Serialize a structured JSON log line for production.
+ * @param {string} level
+ * @param {string} message
+ * @param {Record<string, any>=} extra
+ */
+function serializeJSON(level, message, extra = {}) {
+    const { env, service } = resolveContext();
+    return JSON.stringify({
+        ts: new Date().toISOString(),
+        level,
+        service,
+        env,
+        msg: message,
+        ...extra
+    });
+}
+
+/**
+ * Build a colorized single-line message for non-production.
+ * @param {string} colorCode
+ * @param {string} icon
+ * @param {string} message
+ * @param {string} label
+ */
+function colorize(colorCode, icon, message, label) {
+    return `${colorCode}${icon} ${message} [${label}] \x1b[0m`;
+}
+
+/**
+ * Print a debug payload (object) as magenta JSON or structured JSON in prod.
+ * @param {any} data
+ */
+function debug(data) {
+    const { isProd } = resolveContext();
+    if (isProd) {
+        asyncWrite('stdout', serializeJSON('debug', 'debug payload', { data }));
+    } else {
+        const payload = (() => {
+            try { return JSON.stringify(data); } catch { return String(data); }
+        })();
+        asyncWrite('stdout', colorize('\x1b[35m', '🐛', payload, 'DEBUG'));
+    }
+}
+
+/**
+ * Print a green success note.
+ * @param {string|number|boolean} message
+ */
+function successNote(message) {
+    const { isProd } = resolveContext();
+    const msg = message != null ? message.toString() : '';
+    if (isProd) {
+        asyncWrite('stdout', serializeJSON('info', msg));
+    } else {
+        asyncWrite('stdout', colorize('\x1b[32m', '✅', msg, 'SUCCESS'));
+    }
+}
+
+/**
+ * Print a red critical note.
+ * @param {string|number|boolean} message
+ */
+function criticalNote(message) {
+    const { isProd } = resolveContext();
+    const msg = message != null ? message.toString() : '';
+    if (isProd) {
+        asyncWrite('stderr', serializeJSON('error', msg));
+    } else {
+        asyncWrite('stderr', colorize('\x1b[31m', '⛔', msg, 'CRITICAL'));
     }
+}
+
+/**
+ * Print a yellow warning note.
+ * @param {string|number|boolean} message
+ */
+function warningNote(message) {
+    const { isProd } = resolveContext();
+    const msg = message != null ? message.toString() : '';
+    if (isProd) {
+        asyncWrite('stderr', serializeJSON('warn', msg));
+    } else {
+        asyncWrite('stderr', colorize('\x1b[33m', '⚠️', msg, 'WARNING'));
+    }
+}
+
+module.exports = {
+    debug,
+    successNote,
+    criticalNote,
+    warningNote
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "b2b-platform-utils",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Shared utilities for Node.js microservices: errors map, local cache, logger, numbers, dates, filesystem, media optimization, paginator, slugger, crypto wrapper, sanitize HTML, sorting.",
   "type": "commonjs",
   "license": "KingSizer",