@mhmdhammoud/meritt-utils 1.6.2 → 1.6.3

package/ReleaseNotes.md

@@ -1,5 +1,19 @@
 # Changes
 
+## Version 1.6.3
+
+### Elasticsearch Proxy Logging Fix
+
+- Disabled Elasticsearch node sniffing by default. Sniffing is unsafe when the
+  configured endpoint is an HTTPS proxy because discovered nodes may advertise
+  internal addresses or a different protocol.
+- Preserved explicit opt-in through `sniffOnConnectionFault: true` for direct
+  multi-node Elasticsearch deployments.
+- Sanitized dots and whitespace from recursive context field names.
+- Replaced empty context field names with `unnamed_field`.
+- Added regression coverage for proxy-safe transport configuration and context
+  field sanitization.
+
 ## Version 1.5.3
 
 ### Logger Improvements - Critical Bug Fixes & Production Reliability
@@ -34,7 +48,9 @@
   - 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
+- **Node discovery**: `sniffOnConnectionFault` is available for direct
+  multi-node Elasticsearch deployments. It should remain disabled behind a
+  proxy because discovered node addresses may not be externally reachable.
 - **Retry logic**: Configurable retry attempts with timeout for failed requests
 
 #### Type Safety

package/dist/__tests__/elastic-transport.test.js

@@ -15,6 +15,19 @@ describe('elastic transport resilience', () => {
         jest.useRealTimers();
         MockedClient.mockReset();
     });
+    test('disables node sniffing by default', () => {
+        MockedClient.mockImplementation(() => ({ bulk: jest.fn() }));
+        (0, elastic_transport_1.createElasticTransport)({ index: 'logs' });
+        expect(MockedClient).toHaveBeenCalledWith(expect.objectContaining({ sniffOnConnectionFault: false }));
+    });
+    test('allows node sniffing only when explicitly enabled', () => {
+        MockedClient.mockImplementation(() => ({ bulk: jest.fn() }));
+        (0, elastic_transport_1.createElasticTransport)({
+            index: 'logs',
+            sniffOnConnectionFault: true,
+        });
+        expect(MockedClient).toHaveBeenCalledWith(expect.objectContaining({ sniffOnConnectionFault: true }));
+    });
     test('reports bulk failures without emitting terminal stream errors', async () => {
         const bulk = jest
             .fn()

package/dist/__tests__/logger.test.js

@@ -132,4 +132,25 @@ describe('route and format logs', () => {
             _id: expect.anything(),
         }));
     });
+    test('sanitize empty, dotted, and whitespace context field names', () => {
+        //@ts-ignore
+        jest.spyOn(pino_1.pino, 'destination').mockReturnValue(PINO_DESTINATION);
+        //@ts-ignore
+        pino_1.pino.mockReturnValue(PINO);
+        const logger = new logger_1.default(LOGGER_NAME);
+        logger.info(LOG_EVENT, {
+            '': 'empty',
+            'field.with.dots': 'dotted',
+            ' field name ': 'spaced',
+            nested: { '   ': 'nested-empty' },
+        });
+        expect(PINO.info).toHaveBeenCalledWith(expect.objectContaining({
+            context: {
+                unnamed_field: 'empty',
+                fieldwithdots: 'dotted',
+                fieldname: 'spaced',
+                nested: { unnamed_field: 'nested-empty' },
+            },
+        }));
+    });
 });

package/dist/lib/elastic-transport.js

@@ -204,6 +204,7 @@ function createBulkSender(opts, client, splitter) {
     };
 }
 const createElasticTransport = (opts = {}) => {
+    var _a;
     const splitter = split(function (line) {
         let value;
         try {
@@ -240,7 +241,8 @@ const createElasticTransport = (opts = {}) => {
         tls: { rejectUnauthorized: opts.rejectUnauthorized, ...opts.tls },
         maxRetries: opts.maxRetries,
         requestTimeout: opts.requestTimeout,
-        sniffOnConnectionFault: opts.sniffOnConnectionFault,
+        // Keep the configured proxy endpoint unless callers explicitly opt in.
+        sniffOnConnectionFault: (_a = opts.sniffOnConnectionFault) !== null && _a !== void 0 ? _a : false,
     };
     if (opts.caFingerprint) {
         clientOpts.caFingerprint = opts.caFingerprint;

package/dist/lib/logger.js

@@ -59,7 +59,8 @@ const RESERVED_ES_FIELD_ALIASES = {
 };
 /** Convert arbitrary field names into ES-safe flattened keys */
 const toSafeElasticFieldName = (key) => {
-    const normalized = toSnakeCase(key);
+    const cleaned = key.replace(/[.\s]+/g, '');
+    const normalized = toSnakeCase(cleaned) || 'unnamed_field';
     const mapped = RESERVED_ES_FIELD_ALIASES[normalized];
     if (mapped) {
         return mapped;
@@ -290,8 +291,8 @@ function getLogger(elasticConfig) {
                 // Retry configuration for connection resilience
                 maxRetries: maxRetries,
                 requestTimeout: requestTimeout,
-                // Automatically reconnect on connection faults
-                sniffOnConnectionFault: true,
+                // Sniffing can bypass proxies and discover unreachable internal nodes.
+                sniffOnConnectionFault: false,
             };
             if (elasticConfig) {
                 Object.assign(esConfig, elasticConfig);

package/dist/types/logger.d.ts

@@ -58,7 +58,8 @@ export interface ElasticConfig {
     requestTimeout?: number;
     /**
      * Whether to sniff for additional Elasticsearch nodes on connection fault.
-     * Enables automatic reconnection when a node fails.
+     * Defaults to false because sniffing can bypass a proxy and discover
+     * internal node addresses that are unreachable or use a different protocol.
      */
     sniffOnConnectionFault?: boolean;
 }

package/package.json

@@ -1,13 +1,19 @@
 {
 	"name": "@mhmdhammoud/meritt-utils",
-	"version": "1.6.2",
+	"version": "1.6.3",
 	"description": "",
 	"main": "./dist/index.js",
 	"private": false,
 	"typings": "./dist/index.d.ts",
+	"files": [
+		"dist",
+		"imagesloaded.d.ts",
+		"README.md",
+		"ReleaseNotes.md"
+	],
 	"repository": {
 		"type": "git",
-		"url": "git@github.com:Mhmdhammoud/meritt-utils.git"
+		"url": "git+ssh://git@github.com/Mhmdhammoud/meritt-utils.git"
 	},
 	"publishConfig": {
 		"access": "public"
@@ -18,7 +24,7 @@
 		"watch": "tsc --watch",
 		"build": "tsc",
 		"test:types": "tsc --noemit",
-		"prepare": "husky install",
+		"prepare": "husky",
 		"lint": "eslint src --fix",
 		"prepublish": "npm run build",
 		"test": "jest",

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

@@ -1,84 +0,0 @@
-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:
-      - 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/
-
-  publish-npm:
-    needs: [test, build]
-    runs-on: ubuntu-latest
-    if: success()
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          registry-url: https://registry.npmjs.org/
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Download build artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: dist
-          path: dist/
-
-      - name: Publish to NPM
-        run: npm publish
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.npm_token }}

package/.github/workflows/push.yml

@@ -1,83 +0,0 @@
-name: CI Pipeline
-
-on:
-  push:
-    branches: [dev]
-  pull_request:
-    branches: [dev, master]
-
-jobs:
-  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: 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: 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 security audit
-        run: npm audit --audit-level=moderate
-

package/.husky/pre-commit

@@ -1,62 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-red='\033[0;31m'
-green='\033[0;32m'
-yellow='\033[0;33m'
-blue='\033[0;34m'
-magenta='\033[0;35m'
-cyan='\033[0;36m'
-clear='\033[0m'
-echo "
-
-  __  __ ______ _____  _____ _______ _______    _____  ________      __
- |  \/  |  ____|  __ \|_   _|__   __|__   __|  |  __ \|  ____\ \    / /
- | \  / | |__  | |__) | | |    | |     | |     | |  | | |__   \ \  / /
- | |\/| |  __| |  _  /  | |    | |     | |     | |  | |  __|   \ \/ /
- | |  | | |____| | \ \ _| |_   | |     | |     | |__| | |____   \  /
- |_|  |_|______|_|  \_\_____|  |_|     |_|     |_____/|______|   \/
-
-
-"
-echo -e "Let's hope you are not ${red}DUMB${clear}!"
-
-echo -ne '\n'
-
-echo -e "${yellow}Or Are You ??${clear}!"
-echo -ne '\n'
-echo -e "${yellow}Running pre-commit hook...${clear}"
-echo -ne '\n'
-echo -ne '\n'
-
-echo -ne '#####################                                                    (25%)\r'
-sleep 0.3
-echo -ne '##############################                                          (35%)\r'
-sleep 0.3
-echo -ne '######################################                                  (45%)\r'
-sleep 0.3
-echo -ne '############################################################            (77%)\r'
-sleep 0.3
-echo -ne '##################################################################     (100%)\r'
-
-echo -ne '\n'
-echo -ne '\n'
-echo -ne '\n'
-
-echo -e "${yellow}Running types...${clear}"
-echo -ne '\n'
-npm run test:types
-echo -ne '\n'
-
-echo -e "${green}types passed...${clear} ✅"
-echo -ne '\n'
-echo -e "${yellow}Running linting...${clear}"
-
-npm run lint
-echo -e "${green}linting passed...${clear} ✅"
-
-echo -ne '\n'
-
-echo -e "${yellow}Seems like you are a${clear} ${green}CLEVER DEVELOPER${clear} 👌"
-echo -ne '\n'
-echo -e "${green}GOOD TO GO${clear} 🚀🚀🚀"

package/.prettierrc

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

package/.prettierrc.json

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

package/eslint.config.mjs

@@ -1,64 +0,0 @@
-// @ts-check
-import eslint from '@eslint/js'
-import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
-import globals from 'globals'
-import tseslint from 'typescript-eslint'
-
-export default tseslint.config(
-	{
-		ignores: [
-			'eslint.config.mjs',
-			'dist/**',
-			'node_modules/**',
-			'coverage/**',
-			'*.d.ts',
-		],
-	},
-	eslint.configs.recommended,
-	...tseslint.configs.recommendedTypeChecked,
-	eslintPluginPrettierRecommended,
-	{
-		languageOptions: {
-			globals: {
-				...globals.node,
-			},
-			sourceType: 'module',
-			parserOptions: {
-				projectService: true,
-				tsconfigRootDir: import.meta.dirname,
-			},
-		},
-	},
-	{
-		rules: {
-			'@typescript-eslint/no-explicit-any': 'off',
-			'@typescript-eslint/no-floating-promises': 'warn',
-			'@typescript-eslint/no-unsafe-argument': 'off',
-			'@typescript-eslint/no-unsafe-assignment': 'off',
-			'@typescript-eslint/no-unsafe-return': 'off',
-			'@typescript-eslint/no-unsafe-member-access': 'off',
-			'@typescript-eslint/no-unsafe-call': 'off',
-			'@typescript-eslint/ban-ts-comment': 'off',
-			'@typescript-eslint/require-await': 'off',
-			'@typescript-eslint/await-thenable': 'off',
-			'@typescript-eslint/no-unsafe-enum-comparison': 'off',
-			'@typescript-eslint/no-base-to-string': 'off',
-			'@typescript-eslint/no-redundant-type-constituents': 'off',
-			'@typescript-eslint/no-unused-vars': [
-				'error',
-				{
-					argsIgnorePattern: '^_',
-					varsIgnorePattern: '^_',
-				},
-			],
-			'no-console': 'error',
-			'prettier/prettier': ['error', { semi: false }],
-		},
-	},
-	{
-		files: ['src/lib/logger.ts'],
-		rules: {
-			'no-console': 'off',
-		},
-	}
-)

package/example.env

@@ -1,6 +0,0 @@
-ELASTICSEARCH_USERNAME=
-ELASTICSEARCH_PASSWORD=
-ELASTICSEARCH_NODE=
-SERVER_NICKNAME=
-NODE_ENV=
-LOG_LEVEL=info

package/jest.config.js

@@ -1,13 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-	preset: 'ts-jest',
-	testEnvironment: 'node',
-	coverageDirectory: 'coverage',
-	coverageProvider: 'v8',
-	collectCoverageFrom: ['src/**/*.ts', '!test/**/*.ts'],
-	transform: {
-		'^.+\\.(ts)$': 'ts-jest',
-	},
-	transformIgnorePatterns: [],
-	testMatch: ['<rootDir>/src/**/__tests__/**/*.test.ts'],
-}

package/src/__tests__/colorful.test.ts

@@ -1,77 +0,0 @@
-import { Colorful } from '../lib'
-
-describe('Colorful Class', () => {
-	describe('rgbToHex method', () => {
-		it('should convert RGB to HEX', () => {
-			const rgbColor = 'rgb(255, 255, 255)'
-			const hexColor = Colorful.rgbToHex(rgbColor)
-			expect(hexColor).toBe('#ffffff')
-		})
-
-		it('should convert RGBA to HEX', () => {
-			const rgbaColor = 'rgba(255, 0, 0, 0.5)'
-			const hexColor = Colorful.rgbToHex(rgbaColor)
-			expect(hexColor).toBe('#ff0000')
-		})
-
-		it('should throw an error for invalid color format', () => {
-			const invalidColor = 'invalidColor'
-			expect(() => Colorful.rgbToHex(invalidColor)).toThrowError(
-				`Invalid color format '${invalidColor}'. Please provide a valid RGB or RGBA color.`
-			)
-		})
-	})
-
-	describe('hexToRgb method', () => {
-		it('should convert HEX to RGB', () => {
-			const hexColor = '#ffffff'
-			const rgbColor = Colorful.hexToRgb(hexColor)
-			expect(rgbColor).toBe('rgb(255, 255, 255)')
-		})
-	})
-
-	describe('isLightColor method', () => {
-		it('should return true for a light color (HEX format)', () => {
-			const lightHexColor = '#f0f0f0'
-			const isLight = Colorful.isLightColor(lightHexColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (HEX format)', () => {
-			const darkHexColor = '#333333'
-			const isLight = Colorful.isLightColor(darkHexColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should return true for a light color (RGBA format)', () => {
-			const lightRgbaColor = 'rgba(255, 255, 255, 0.5)'
-			const isLight = Colorful.isLightColor(lightRgbaColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (RGBA format)', () => {
-			const darkRgbaColor = 'rgba(0, 0, 0, 0.8)'
-			const isLight = Colorful.isLightColor(darkRgbaColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should return true for a light color (RGB format)', () => {
-			const lightRgbColor = 'rgb(200, 220, 255)'
-			const isLight = Colorful.isLightColor(lightRgbColor)
-			expect(isLight).toBe(true)
-		})
-
-		it('should return false for a dark color (RGB format)', () => {
-			const darkRgbColor = 'rgb(10, 20, 30)'
-			const isLight = Colorful.isLightColor(darkRgbColor)
-			expect(isLight).toBe(false)
-		})
-
-		it('should throw an error for an invalid color format', () => {
-			const invalidColor = 'invalid-color'
-			expect(() => Colorful.isLightColor(invalidColor)).toThrowError(
-				"Invalid color format 'invalid-color'. Please provide a valid HEX, RGB, or RGBA color."
-			)
-		})
-	})
-})

package/src/__tests__/elastic-transport.test.ts

@@ -1,94 +0,0 @@
-import { createElasticTransport } from '../lib/elastic-transport'
-import { Client } from '@elastic/elasticsearch'
-import { EventEmitter } from 'events'
-
-jest.mock('@elastic/elasticsearch', () => ({
-	Client: jest.fn(),
-}))
-
-const MockedClient = Client as jest.Mock
-
-const writeLog = (
-	transport: NodeJS.WritableStream,
-	doc: Record<string, unknown>
-) => transport.write(`${JSON.stringify(doc)}\n`)
-
-const waitForEvent = <T = unknown>(
-	emitter: EventEmitter,
-	eventName: string
-): Promise<T> =>
-	new Promise((resolve) => {
-		emitter.once(eventName, (value) => resolve(value as T))
-	})
-
-describe('elastic transport resilience', () => {
-	beforeEach(() => {
-		jest.useRealTimers()
-		MockedClient.mockReset()
-	})
-
-	test('reports bulk failures without emitting terminal stream errors', async () => {
-		const bulk = jest
-			.fn()
-			.mockRejectedValueOnce(new Error('ES unavailable'))
-			.mockResolvedValueOnce({ errors: false, items: [] })
-		MockedClient.mockImplementation(() => ({ bulk }))
-
-		const transport = createElasticTransport({
-			index: 'logs',
-			flushBytes: 1,
-			flushInterval: 10000,
-			requestTimeout: 10,
-		})
-		const streamError = jest.fn()
-		transport.on('error', streamError)
-
-		const failed = waitForEvent<Error>(transport, 'bulkError')
-		writeLog(transport, { message: 'first' })
-		await failed
-
-		const inserted = waitForEvent<{ successful: number; failed: number }>(
-			transport,
-			'insert'
-		)
-		writeLog(transport, { message: 'second' })
-
-		await expect(inserted).resolves.toEqual({ successful: 1, failed: 0 })
-		expect(streamError).not.toHaveBeenCalled()
-		expect(bulk).toHaveBeenCalledTimes(2)
-	})
-
-	test('watchdog releases a stuck bulk request so later logs can flush', async () => {
-		jest.useFakeTimers()
-
-		const bulk = jest
-			.fn()
-			.mockReturnValueOnce(new Promise(() => undefined))
-			.mockResolvedValueOnce({ errors: false, items: [] })
-		MockedClient.mockImplementation(() => ({ bulk }))
-
-		const transport = createElasticTransport({
-			index: 'logs',
-			flushBytes: 1,
-			flushInterval: 10000,
-			requestTimeout: 1,
-		})
-
-		const timedOut = waitForEvent<Error>(transport, 'bulkError')
-		writeLog(transport, { message: 'stuck' })
-
-		await jest.advanceTimersByTimeAsync(5001)
-		await expect(timedOut).resolves.toMatchObject({
-			message: 'Elasticsearch bulk request timed out after 5001ms',
-		})
-
-		const inserted = waitForEvent<{ successful: number; failed: number }>(
-			transport,
-			'insert'
-		)
-		writeLog(transport, { message: 'recovered' })
-
-		await expect(inserted).resolves.toEqual({ successful: 1, failed: 0 })
-		expect(bulk).toHaveBeenCalledTimes(2)
-	})
-})