@mhmdhammoud/meritt-utils 1.5.1 → 1.5.3

package/.github/workflows/npm-publish.yml

@@ -3,41 +3,82 @@ name: NPM Publish on Release
 on:
   push:
     branches: [master]
+
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run type check
+        run: npm run test:types
+
+      - name: Run linting
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
   build:
+    needs: test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
-      - run: npm ci
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project
+        run: npm run build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
 
   publish-npm:
-    needs: build
+    needs: [test, build]
     runs-on: ubuntu-latest
+    if: success()
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version: '20'
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-  notify:
-    needs: [publish-npm]
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify by Email
-        uses: dawidd6/action-send-mail@v2
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
         with:
-          server_address: ${{ secrets.EMAIL_HOST }}
-          server_port: 465
-          username: ${{ secrets.EMAIL_USERNAME }}
-          password: ${{ secrets.EMAIL_PASSWORD }}
-          subject: ${{ github.event.head_commit.message }} ${{ github.job }} job of ${{ github.repository }} has ${{ job.status }}
-          body: ${{ github.job }} job in worflow ${{ github.workflow }} of ${{ github.repository }} has ${{ job.status }}
-          to: mohammad.hammoud.lb@hotmail.com,steef12009@gmail.com
-          from: Github Action
+          name: dist
+          path: dist/
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

package/.github/workflows/push.yml

@@ -1,29 +1,83 @@
-name: Changes
+name: CI Pipeline
+
 on:
   push:
     branches: [dev]
+  pull_request:
+    branches: [dev, master]
+
 jobs:
-  type-check:
+  lint-and-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 16
-      - run: npm ci
-      - run: npm run test:types
-  notify:
-    needs: [type-check]
+          node-version: '20'
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Run type check
+        run: npm run test:types
+      
+      - name: Run linting
+        run: npm run lint
+      
+      - name: Run tests with coverage
+        run: npm run test:coverage
+      
+      - name: Upload coverage reports
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: coverage-report
+          path: coverage/
+
+  build:
+    needs: lint-and-test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build project
+        run: npm run build
+      
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  security-audit:
     runs-on: ubuntu-latest
     steps:
-      - name: Notify by Email
-        uses: dawidd6/action-send-mail@v2
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
         with:
-          server_address: ${{ secrets.EMAIL_HOST }}
-          server_port: 465
-          username: ${{ secrets.EMAIL_USERNAME }}
-          password: ${{ secrets.EMAIL_PASSWORD }}
-          subject: ${{ github.event.head_commit.message }} ${{ github.job }} job of ${{ github.repository }} has ${{ job.status }}
-          body: ${{ github.job }} job in worflow ${{ github.workflow }} of ${{ github.repository }} has ${{ job.status }}
-          to: mohammad.hammoud.lb@hotmail.com,steef12009@gmail.com
-          from: Github Action
+          node-version: '20'
+          cache: 'npm'
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Run security audit
+        run: npm audit --audit-level=moderate
+

package/.prettierrc

@@ -0,0 +1,8 @@
+{
+	"semi": false,
+	"singleQuote": true,
+	"trailingComma": "es5",
+	"tabWidth": 2,
+	"useTabs": true,
+	"printWidth": 80
+}

package/ReleaseNotes.md

@@ -1,5 +1,60 @@
 # Changes
 
+## Version 1.5.3
+
+### Logger Improvements - Critical Bug Fixes & Production Reliability
+
+#### Critical Fixes
+
+- **Fixed broken JSON.stringify**: Corrected production log serialization from `JSON.stringify(...args)` to `JSON.stringify(args)` - previously only stringified first argument
+- **Fixed silent failures**: Logger now throws clear errors when `LOG_LEVEL` is invalid instead of silently failing with undefined logger
+- **Fixed return type mismatch**: `getLogger()` now properly returns `PinoLogger` type with explicit error handling
+- **Fixed buffer configuration**: Corrected inconsistent buffer settings to match tests (`minLength: 1024, sync: true`)
+- **Fixed race condition**: Event listener now registered before calling `.end()` to prevent missed flush events on shutdown
+
+#### Environment Variable Validation
+
+- **Added Elasticsearch validation**: Validates required env vars (`ELASTICSEARCH_NODE`, `ELASTICSEARCH_USERNAME`, `ELASTICSEARCH_PASSWORD`, `SERVER_NICKNAME`) with clear error messages
+- **Added integer parsing validation**: All numeric env vars now validated to prevent `NaN` values from breaking configuration
+- **Validates positive numbers**: Ensures flush intervals, buffer sizes, retries, and timeouts are positive integers
+
+#### Configurable Settings (New Environment Variables)
+
+- `ES_FLUSH_INTERVAL_MS` - How often to send logs (default: 2000ms = 2 seconds)
+- `ES_FLUSH_BYTES` - Buffer size before forcing flush (default: 102400 = 100KB)
+- `ES_MAX_RETRIES` - Number of retry attempts on failure (default: 3)
+- `ES_REQUEST_TIMEOUT_MS` - Request timeout before retry (default: 30000ms = 30 seconds)
+
+#### Reliability Improvements
+
+- **Error monitoring**: Elasticsearch transport errors now logged to console instead of silent failure
+  - `error` event: Connection errors with clear messaging
+  - `insertError` event: Document indexing failures
+- **Graceful shutdown**: Properly flushes buffered logs before process exit
+  - Handles `SIGTERM` and `SIGINT` signals
+  - 5-second timeout prevents hanging forever
+  - Proper async/await handling to ensure flush completes
+- **Auto-reconnection**: `sniffOnConnectionFault: true` enables automatic reconnection when Elasticsearch nodes fail
+- **Retry logic**: Configurable retry attempts with timeout for failed requests
+
+#### Type Safety
+
+- **Removed `any` types**: All configurations now use proper TypeScript interfaces
+- **Extended ElasticConfig interface**: Added proper types for `maxRetries`, `requestTimeout`, `sniffOnConnectionFault`, and buffer settings
+- **Full compile-time validation**: Type system now validates all configuration options
+
+#### Performance
+
+- **Optimized flush settings**: Default 2-second interval with 100KB buffer balances real-time logs with reliability
+- **Reduced network overhead**: Larger buffer prevents excessive network calls during high-traffic periods
+
+#### Migration Notes
+
+- All changes are backward compatible
+- Default values ensure existing deployments work without changes
+- Optional environment variables allow fine-tuning per environment
+- No breaking changes to the Logger API
+
 ## Version 1.4.1
 
 - Json stringify the log message if its being pushed to Kibana

package/dist/__tests__/logger.test.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 const logger_1 = __importStar(require("../lib/logger"));
 const pino_1 = require("pino");

package/dist/lib/cypto.d.ts

@@ -63,7 +63,7 @@ declare class Crypto {
      * crypto.generateKeys()
      * ```
      * */
-    generateKeys: () => Record<'publicKey' | 'privateKey', number>;
+    generateKeys: () => Record<"publicKey" | "privateKey", number>;
     /**
      *
      * @param publicKey - The public key number

package/dist/lib/elastic-transport.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Elasticsearch transport for Pino with connection lifecycle resilience.
+ *
+ * Based on pino-elasticsearch with a fix for GitHub issue #140:
+ * When maxRetries are exceeded and Elasticsearch nodes are DEAD, the bulk helper
+ * destroys the splitter stream, causing logs to stop permanently until restart.
+ *
+ * This implementation overrides splitter.destroy to BOTH resurrect the connection
+ * pool AND reinitialize the bulk handler, so logging continues after ES recovers.
+ *
+ * @see https://github.com/pinojs/pino-elasticsearch/issues/140
+ * @see https://github.com/pinojs/pino-elasticsearch/issues/72
+ */
+import type { ClientOptions } from '@elastic/elasticsearch';
+export interface ElasticTransportOptions extends Pick<ClientOptions, 'node' | 'auth' | 'cloud' | 'caFingerprint' | 'Connection' | 'ConnectionPool' | 'maxRetries' | 'requestTimeout'> {
+    sniffOnConnectionFault?: boolean;
+    index?: string | ((logTime: string) => string);
+    flushBytes?: number;
+    'flush-bytes'?: number;
+    flushInterval?: number;
+    'flush-interval'?: number;
+    esVersion?: number;
+    'es-version'?: number;
+    rejectUnauthorized?: boolean;
+    tls?: ClientOptions['tls'];
+}
+export declare const createElasticTransport: (opts?: ElasticTransportOptions) => NodeJS.ReadWriteStream;

package/dist/lib/elastic-transport.js

@@ -0,0 +1,137 @@
+"use strict";
+/**
+ * Elasticsearch transport for Pino with connection lifecycle resilience.
+ *
+ * Based on pino-elasticsearch with a fix for GitHub issue #140:
+ * When maxRetries are exceeded and Elasticsearch nodes are DEAD, the bulk helper
+ * destroys the splitter stream, causing logs to stop permanently until restart.
+ *
+ * This implementation overrides splitter.destroy to BOTH resurrect the connection
+ * pool AND reinitialize the bulk handler, so logging continues after ES recovers.
+ *
+ * @see https://github.com/pinojs/pino-elasticsearch/issues/140
+ * @see https://github.com/pinojs/pino-elasticsearch/issues/72
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createElasticTransport = void 0;
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const split = require('split2');
+const elasticsearch_1 = require("@elastic/elasticsearch");
+function setDateTimeString(value) {
+    if (value !== null && typeof value === 'object' && 'time' in value) {
+        const t = value.time;
+        if ((typeof t === 'string' && t.length > 0) ||
+            (typeof t === 'number' && t >= 0)) {
+            return new Date(t).toISOString();
+        }
+    }
+    return new Date().toISOString();
+}
+function getIndexName(index, time) {
+    if (typeof index === 'function') {
+        return index(time);
+    }
+    return index.replace('%{DATE}', time.substring(0, 10));
+}
+function initializeBulkHandler(opts, client, splitter) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    const esVersion = Number((_b = (_a = opts.esVersion) !== null && _a !== void 0 ? _a : opts['es-version']) !== null && _b !== void 0 ? _b : 7);
+    const index = (_c = opts.index) !== null && _c !== void 0 ? _c : 'pino';
+    const buildIndexName = typeof index === 'function' ? index : null;
+    const opType = esVersion >= 7 ? undefined : undefined;
+    // CRITICAL FIX (issue #140): When bulk helper destroys stream after retries exhausted,
+    // we must BOTH resurrect the pool AND reinitialize the bulk handler so logging continues.
+    // connectionPool.resurrect exists at runtime (elastic-transport) but may not be in types
+    const pool = client.connectionPool;
+    const splitterWithDestroy = splitter;
+    splitterWithDestroy.destroy = function () {
+        if (typeof pool.resurrect === 'function') {
+            pool.resurrect({ name: 'elasticsearch-js' });
+        }
+        // Reinitialize bulk handler - without this, logging stops permanently until restart
+        initializeBulkHandler(opts, client, splitter);
+    };
+    const indexName = (time = new Date().toISOString()) => buildIndexName ? buildIndexName(time) : getIndexName(index, time);
+    const bulkInsert = client.helpers.bulk({
+        datasource: splitter,
+        flushBytes: (_e = (_d = opts.flushBytes) !== null && _d !== void 0 ? _d : opts['flush-bytes']) !== null && _e !== void 0 ? _e : 1000,
+        flushInterval: (_g = (_f = opts.flushInterval) !== null && _f !== void 0 ? _f : opts['flush-interval']) !== null && _g !== void 0 ? _g : 3000,
+        refreshOnCompletion: indexName(),
+        onDocument(doc) {
+            var _a, _b;
+            const d = doc;
+            const date = (_b = (_a = d.time) !== null && _a !== void 0 ? _a : d['@timestamp']) !== null && _b !== void 0 ? _b : new Date().toISOString();
+            if (opType === 'create') {
+                d['@timestamp'] = date;
+            }
+            return {
+                index: {
+                    _index: indexName(date),
+                    op_type: opType,
+                },
+            };
+        },
+        onDrop(doc) {
+            const error = new Error('Dropped document');
+            error.document = doc;
+            splitter.emit('insertError', error);
+        },
+    });
+    bulkInsert.then((stats) => splitter.emit('insert', stats), (err) => splitter.emit('error', err));
+}
+const createElasticTransport = (opts = {}) => {
+    const splitter = split(function (line) {
+        let value;
+        try {
+            value = JSON.parse(line);
+        }
+        catch (error) {
+            this.emit('unknown', line, error);
+            return;
+        }
+        if (typeof value === 'boolean') {
+            this.emit('unknown', line, 'Boolean value ignored');
+            return;
+        }
+        if (value === null) {
+            this.emit('unknown', line, 'Null value ignored');
+            return;
+        }
+        if (typeof value !== 'object') {
+            value = { data: value, time: setDateTimeString(value) };
+        }
+        else {
+            const obj = value;
+            if (obj['@timestamp'] === undefined) {
+                ;
+                obj.time = setDateTimeString(obj);
+            }
+        }
+        return value;
+    }, { autoDestroy: true });
+    const clientOpts = {
+        node: opts.node,
+        auth: opts.auth,
+        cloud: opts.cloud,
+        tls: { rejectUnauthorized: opts.rejectUnauthorized, ...opts.tls },
+        maxRetries: opts.maxRetries,
+        requestTimeout: opts.requestTimeout,
+        sniffOnConnectionFault: opts.sniffOnConnectionFault,
+    };
+    if (opts.caFingerprint) {
+        clientOpts.caFingerprint = opts.caFingerprint;
+    }
+    if (opts.Connection) {
+        clientOpts.Connection = opts.Connection;
+    }
+    if (opts.ConnectionPool) {
+        clientOpts.ConnectionPool = opts.ConnectionPool;
+    }
+    const client = new elasticsearch_1.Client(clientOpts);
+    client.diagnostic.on('resurrect', () => {
+        initializeBulkHandler(opts, client, splitter);
+    });
+    initializeBulkHandler(opts, client, splitter);
+    return splitter;
+};
+exports.createElasticTransport = createElasticTransport;

package/dist/lib/logger.d.ts

@@ -1,5 +1,4 @@
-import { Options as ElasticConfig } from 'pino-elasticsearch';
-import { LOG_LEVEL, LogEvent } from '../types';
+import { LOG_LEVEL, LogEvent, ElasticConfig } from '../types';
 /**
  * Checks if a given log level is valid.
  * @param level - The log level to check.