@mimik/sumologic-winston-logger 2.1.11 → 2.1.12

package/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(npx mocha:*)",
+      "Bash(done)"
+    ]
+  }
+}

package/.husky/pre-commit

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run commit-ready

package/.husky/pre-push

@@ -1,4 +1,2 @@
 #!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 npm run test

package/README.md

@@ -11,7 +11,8 @@ The following environment variables are used to configure the logger:
 | LOG_LEVEL | Log level for the running instance | debug |  |
 | CONSOLE_LEVEL | Console log level | debug |  |
 | FILTER_FILE | Filename containing filter rules | null |  |
-| EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
+| FLUSH_EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
+| FLUSH_EXIT_TIMEOUT | Timeout safety net in case flush never completes | 5000 | in millisecond |
 | NO_STACK | Whether to include call stacks in all log messages | yes | expected: yes/no |
 | LOG_MODE | Comma-separated list defining the log mode/backends | none | enum: awsS3, awsKinesis, sumologic, all, none |
 
@@ -52,12 +53,12 @@ If `LOG_MODE` includes `awsS3`, the following environment variables are required
 | S3_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
 
 When `LOG_MODE` is `none`, logs are written to the console only.
-When `LOG_MODE` is `all`, it is equivalent to `sumologic,awsS3`.
+When `LOG_MODE` is `all`, it is equivalent to `sumologic,awsS3` (does not include `awsKinesis`).
 
 `SERVER_TYPE` and `SERVER_ID` are used to build the S3 filename and are included in the
 log payload for S3 and Kinesis.
-If `global.serverType` is set, it overrides `SERVER_TYPE`.
-If `global.serverId` is set, it overrides `SERVER_ID`.
+If `globalThis.serverType` is set, it overrides `SERVER_TYPE`.
+If `globalThis.serverId` is set, it overrides `SERVER_ID`.
 
 **Kind**: global function  
 **Returns**: <code>object</code> - configuration - Logger configuration.  
@@ -139,7 +140,7 @@ To find the values that you will apply the environment variables, `SUMO_LOGIC_EN
 The endpoint is the part of the url that ends with a slash.  i.e.
 `https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/`
 
-The collector code is the Base64 encrypted part of the URL that follows the last slash in the url.
+The collector code is the Base64 encoded part of the URL that follows the last slash in the url.
 
 ### `FILTER_FILE` ###
 
@@ -162,7 +163,7 @@ Formatting of SumoLogic logs is handled by this module in the following ways:
 
 
 ### Logging Examples ###
-Listing 2 below show you how to declare a logger to run under ECMAScript 6 and then log using the various log levels supported by the Sumologic-Winston-Logger.
+Listing 2 below shows you how to declare a logger to run under ECMAScript 6 and then log using the various log levels supported by the Sumologic-Winston-Logger.
 
 ``` javascript
 import logger from '@mimik/sumologic-winston-logger';
@@ -185,7 +186,7 @@ The log() method is also supported, and adds a level parameter in position 1.
 
 ### Tailing ###
 
-Trailing allows you to scroll through log output in real time. You can trail log data in SumoLogic.
+Tailing allows you to scroll through log output in real time. You can trail log data in SumoLogic.
 
 To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface and enter `sourceCategory=<source category>` in the search bar, where `<source category>` is the log you want to trail. Then click, Run
 
@@ -194,7 +195,7 @@ To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface a
 |`sourceCategory=local/node/challengeAPI/logs`|
 
 ### Stack Trace ###
-All logging to `error()` are added the stack trace.
+All calls to `error()` include the stack trace.
 All other log levels will include a line number and file name.
 
 ## License ##

package/README_Supplement.md

@@ -76,7 +76,7 @@ To find the values that you will apply the environment variables, `SUMO_LOGIC_EN
 The endpoint is the part of the url that ends with a slash.  i.e.
 `https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/`
 
-The collector code is the Base64 encrypted part of the URL that follows the last slash in the url.
+The collector code is the Base64 encoded part of the URL that follows the last slash in the url.
 
 ### `FILTER_FILE` ###
 
@@ -99,7 +99,7 @@ Formatting of SumoLogic logs is handled by this module in the following ways:
 
 
 ### Logging Examples ###
-Listing 2 below show you how to declare a logger to run under ECMAScript 6 and then log using the various log levels supported by the Sumologic-Winston-Logger.
+Listing 2 below shows you how to declare a logger to run under ECMAScript 6 and then log using the various log levels supported by the Sumologic-Winston-Logger.
 
 ``` javascript
 import logger from '@mimik/sumologic-winston-logger';
@@ -122,7 +122,7 @@ The log() method is also supported, and adds a level parameter in position 1.
 
 ### Tailing ###
 
-Trailing allows you to scroll through log output in real time. You can trail log data in SumoLogic.
+Tailing allows you to scroll through log output in real time. You can trail log data in SumoLogic.
 
 To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface and enter `sourceCategory=<source category>` in the search bar, where `<source category>` is the log you want to trail. Then click, Run
 
@@ -131,7 +131,7 @@ To trail in SumoLogic go to Search > Live Tail in the SumoLogic user interface a
 |`sourceCategory=local/node/challengeAPI/logs`|
 
 ### Stack Trace ###
-All logging to `error()` are added the stack trace.
+All calls to `error()` include the stack trace.
 All other log levels will include a line number and file name.
 
 ## License ##

package/configuration/config.js

@@ -30,7 +30,8 @@ const DECIMAL = 10;
  * | LOG_LEVEL | Log level for the running instance | debug |  |
  * | CONSOLE_LEVEL | Console log level | debug |  |
  * | FILTER_FILE | Filename containing filter rules | null |  |
- * | EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
+ * | FLUSH_EXIT_DELAY | Delay for flushing the transports and exiting | 2000 | in millisecond |
+ * | FLUSH_EXIT_TIMEOUT | Timeout safety net in case flush never completes | 5000 | in millisecond |
  * | NO_STACK | Whether to include call stacks in all log messages | yes | expected: yes/no |
  * | LOG_MODE | Comma-separated list defining the log mode/backends | none | enum: awsS3, awsKinesis, sumologic, all, none |
  *
@@ -71,12 +72,12 @@ const DECIMAL = 10;
  * | S3_AWS_SECRET_ACCESS_KEY | AWS secret access key |  |  |
  *
  * When `LOG_MODE` is `none`, logs are written to the console only.
- * When `LOG_MODE` is `all`, it is equivalent to `sumologic,awsS3`.
+ * When `LOG_MODE` is `all`, it is equivalent to `sumologic,awsS3` (does not include `awsKinesis`).
  *
  * `SERVER_TYPE` and `SERVER_ID` are used to build the S3 filename and are included in the
  * log payload for S3 and Kinesis.
- * If `global.serverType` is set, it overrides `SERVER_TYPE`.
- * If `global.serverId` is set, it overrides `SERVER_ID`.
+ * If `globalThis.serverType` is set, it overrides `SERVER_TYPE`.
+ * If `globalThis.serverId` is set, it overrides `SERVER_ID`.
  */
 
 const checkConfig = (config) => {
@@ -123,7 +124,8 @@ const configuration = {
   filter: {
     file: process.env.FILTER_FILE || null,
   },
-  exitDelay: parseInt(process.env.EXIT_DELAY, DECIMAL) || 2000, // in millisecond
+  flushExitDelay: parseInt(process.env.FLUSH_EXIT_DELAY, DECIMAL) || 2000, // in millisecond
+  flushExitTimeout: parseInt(process.env.FLUSH_EXIT_TIMEOUT, DECIMAL) || 5000, // in millisecond
   noStack: process.env.NO_STACK || 'yes',
 };
 configuration.mode = checkMode(process.env.LOG_MODE) || [NONE_MODE];
@@ -180,3 +182,4 @@ filter.config = filterConfig;
 checkConfig(configuration);
 
 export default configuration;
+export { checkConfig, checkMode };

package/eslint.config.js

@@ -17,7 +17,7 @@ const ALLOWED_CONSTANTS = [0, 1, -1];
 
 export default [
   {
-    ignores: ['mochawesome-report/**', 'node_modules/**', 'dist/**'],
+    ignores: ['coverage/**', 'mochawesome-report/**', 'node_modules/**', 'dist/**'],
   },
   importPlugin.flatConfigs.recommended,
   stylistic.configs.recommended,
@@ -29,9 +29,8 @@ export default [
     languageOptions: {
       ecmaVersion: ECMA_VERSION,
       globals: {
+        ...globals.mocha,
         ...globals.nodeBuiltin,
-        describe: 'readonly',
-        it: 'readonly',
       },
       sourceType: 'module',
     },
@@ -50,7 +49,7 @@ export default [
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
       'max-depth': ['error', MAX_DEPTH],
-      'max-len': 'off',
+      'max-len': ['off'],
       'max-lines': ['warn', { max: MAX_LINES_IN_FILES, skipComments: true, skipBlankLines: true }],
       'max-lines-per-function': ['warn', { max: MAX_LINES_IN_FUNCTION, skipComments: true, skipBlankLines: true }],
       'max-params': ['error', MAX_FUNCTION_PARAMETERS],
@@ -63,7 +62,7 @@ export default [
       'no-undefined': ['off'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
-      'quotes': 'off',
+      'quotes': ['off'],
       'sort-imports': ['error', { allowSeparatedGroups: true }],
       'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
     },

package/index.js

@@ -115,11 +115,17 @@ logger.flushAndExit = (code) => {
     let awsS3Done = false;
     let awsKinesisDone = false;
 
-    if (config.mode.includes(NONE_MODE)) return process.exit(code);
+    const doExit = () => {
+      clearTimeout(logger.safetyTimer);
+      process.exit(code);
+    };
+
+    if (config.mode.includes(NONE_MODE)) return doExit();
+    logger.safetyTimer = setTimeout(doExit, config.flushExitTimeout); // safety net in case flush never completes
     if (awsS3) {
       awsS3.flush(FLUSH_EXIT);
       awsS3.once(FLUSH_EXIT, () => {
-        if ((!sumo || sumoDone) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
+        if ((!sumo || sumoDone) && (!awsKinesis || awsKinesisDone)) return doExit();
         awsS3Done = true;
         return null;
       });
@@ -127,7 +133,7 @@ logger.flushAndExit = (code) => {
     if (sumo) {
       sumo.flush(FLUSH_EXIT);
       sumo.once(FLUSH_EXIT, () => {
-        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
+        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return doExit();
         sumoDone = true;
         return null;
       });
@@ -135,7 +141,7 @@ logger.flushAndExit = (code) => {
     if (awsKinesis) {
       awsKinesis.flush(FLUSH_EXIT);
       awsKinesis.once(FLUSH_EXIT, () => {
-        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return process.exit(code);
+        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return doExit();
         awsKinesisDone = true;
         return null;
       });
@@ -143,7 +149,7 @@ logger.flushAndExit = (code) => {
     return null;
   };
 
-  setTimeout(flushing, config.exitDelay);
+  setTimeout(flushing, config.flushExitDelay);
 };
 
 logger.flush = () => {
@@ -180,7 +186,7 @@ logger.flush = () => {
     return null;
   };
 
-  setTimeout(flushing, config.exitDelay);
+  setTimeout(flushing, config.flushExitDelay);
 };
 
 logger.LEVELS = ['error', 'warn', 'info', 'verbose', 'debug', 'silly'];

package/lib/awsKinesisTransport.js

@@ -158,4 +158,8 @@ export default class AwsKinesis extends Transport {
     return this.flushEvent()
       .then(() => this.emit(type, { message: `logs ${type} to ${AWS_KINESIS}` }));
   }
+
+  close() {
+    clearInterval(this.time);
+  }
 };

package/lib/awsS3Transport.js

@@ -245,4 +245,8 @@ export default class AwsS3 extends Transport {
       .then(() => this.flushTypeEvent())
       .then(() => this.emit(type, { message: `logs ${type} to ${AWS_S3}` }));
   }
+
+  close() {
+    clearInterval(this.time);
+  }
 };

package/lib/common.js

@@ -34,8 +34,8 @@ const SYSTEM_ERROR = 500;
 
 const OK_RESPONSE = 200;
 
-const START_TIMEOUT = 30000; // in millisecond
-const FLUSH_TIMEOUT = 1000; // in millisecond
+const TEST_START_TIMEOUT = 30000; // in millisecond
+const TEST_FLUSH_TIMEOUT = 1000; // in millisecond
 const OK_EXIT = 0;
 
 const MEGA = 1048576; // 2^20 conversion to mega
@@ -65,7 +65,7 @@ export {
   ERROR,
   FLUSH,
   FLUSH_EXIT,
-  FLUSH_TIMEOUT,
+  TEST_FLUSH_TIMEOUT,
   INFO,
   LEVEL,
   LOG,
@@ -79,7 +79,7 @@ export {
   OTHER,
   PARTITION_KEY,
   SPLAT,
-  START_TIMEOUT,
+  TEST_START_TIMEOUT,
   SUMOLOGIC,
   SYSTEM_ERROR,
   TEAPOT_ERROR,

package/lib/formatLib.js

@@ -36,7 +36,7 @@ const stackInfo = format((origInfo, opts) => {
 });
 
 const correlationId = format((origInfo) => {
-  const info = origInfo;
+  const info = { ...origInfo };
   const meta = info[SPLAT];
 
   if (meta && typeof meta[meta.length - INDEX_ADJUST] === 'string') {
@@ -58,7 +58,7 @@ const filterMeta = format((origInfo, opts) => {
   const { config } = opts;
   const info = { ...origInfo };
 
-  const meta = info[SPLAT];
+  const meta = info[SPLAT] ? [...info[SPLAT]] : undefined;
   let target;
   let index;
 

package/lib/sumologicTransport.js

@@ -48,9 +48,14 @@ export default class Sumo extends Transport {
       .catch((err) => {
         const { response } = err;
 
-        const resp = { endpoint: this.endpoint, info, message: `could not log to ${SUMOLOGIC}` };
+        const resp = { endpoint: this.endpoint, data, message: `could not log to ${SUMOLOGIC}` };
 
-        if (info && info[SPLAT] && Array.isArray(info[SPLAT])) [, resp.correlationId] = info[SPLAT];
+        if (data.correlationId) resp.correlationId = data.correlationId;
+        else if (data[SPLAT] && Array.isArray(data[SPLAT])) {
+          const last = data[SPLAT][data[SPLAT].length - 1];
+
+          if (typeof last === 'string') resp.correlationId = last;
+        }
         if (!response) {
           resp.error = { statusCode: SYSTEM_ERROR, code: err.code, message: err.message };
           return this.emit(WARN, resp);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.11",
+  "version": "2.1.12",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
@@ -31,9 +31,9 @@
     "url": "https://bitbucket.org/mimiktech/sumologic-winston-logger"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^2.0.6",
-    "@aws-sdk/client-s3": "3.993.0",
-    "@aws-sdk/client-kinesis": "3.993.0",
+    "@mimik/lib-filters": "^2.0.7",
+    "@aws-sdk/client-s3": "3.995.0",
+    "@aws-sdk/client-kinesis": "3.995.0",
     "@smithy/node-http-handler": "4.4.10",
     "axios": "1.13.5",
     "winston": "3.19.0",
@@ -42,8 +42,8 @@
   "devDependencies": {
     "@eslint/js": "9.39.2",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@mimik/request-helper": "^2.0.3",
-    "@stylistic/eslint-plugin": "5.8.0",
+    "@mimik/request-helper": "^2.0.5",
+    "@stylistic/eslint-plugin": "5.9.0",
     "aws-sdk-client-mock": "4.1.0",
     "c8": "10.1.3",
     "chai": "6.2.2",

package/test/logger.spec.js

@@ -1,16 +1,16 @@
 import './testEnv.js';
+import { KinesisClient, PutRecordsCommand } from '@aws-sdk/client-kinesis';
 import {
-  FLUSH_TIMEOUT,
   NOT_FOUND_ERROR,
   OK_EXIT,
   OK_RESPONSE,
   SPLAT,
-  START_TIMEOUT,
   SYSTEM_ERROR,
   TEAPOT_ERROR,
+  TEST_FLUSH_TIMEOUT,
+  TEST_START_TIMEOUT,
   UNAUTHORIZED_ERROR,
 } from '../lib/common.js';
-import { KinesisClient, PutRecordsCommand } from '@aws-sdk/client-kinesis';
 import { PutObjectCommand, S3Client } from '@aws-sdk/client-s3';
 import { after, afterEach, before, beforeEach, describe, it } from 'mocha';
 import Sumo from '../lib/sumologicTransport.js';
@@ -23,6 +23,9 @@ import { setTimeout } from 'node:timers';
 import { should } from 'chai';
 import { stub } from 'sinon';
 
+import { checkConfig, checkMode } from '../configuration/config.js';
+import { parseStack } from '../lib/stackLib.js';
+
 const s3Mock = mockClient(S3Client);
 const kinesisMock = mockClient(KinesisClient);
 
@@ -36,38 +39,30 @@ const TEST_DELAY = 200;
 should();
 
 describe('sumologic-winston-logger Unit Tests', function LoggerTests() {
-  this.timeout(START_TIMEOUT);
-  it('Can log an debug message without a correlationId and info', (done) => {
-    logger.debug('this is an debug statement');
-    done();
+  this.timeout(TEST_START_TIMEOUT);
+  it('Can log a debug message without a correlationId and info', () => {
+    logger.debug('this is a debug statement');
   });
-  it('Can log an error message without a correlationId and info', (done) => {
+  it('Can log an error message without a correlationId and info', () => {
     logger.error('this is an error statement');
-    done();
   });
-  it('Can log an error message without a correlationId', (done) => {
+  it('Can log an error message without a correlationId', () => {
     logger.error('this is an error statement', { error: new Error('this is an error') });
-    done();
   });
-  it('Can log a warning message with a correlationId', (done) => {
+  it('Can log a warning message with a correlationId', () => {
     logger.warn('this is a warning statement', { meta: 'data' }, correlationId);
-    done();
   });
-  it('Can log an info message', (done) => {
+  it('Can log an info message', () => {
     logger.info('this is an info statement', { meta: 'data' });
-    done();
   });
-  it('Can log a verbose message', (done) => {
+  it('Can log a verbose message', () => {
     logger.verbose('this is a verbose statement', 'an extra string', { meta: 'data' });
-    done();
   });
-  it('Can log a debug message with no object and no correlationId', (done) => {
+  it('Can log a debug message with no object and no correlationId', () => {
     logger.debug('this is a debug statement');
-    done();
   });
-  it('can flush logs', (done) => {
+  it('can flush logs', () => {
     logger.flush();
-    done();
   });
   it('Can flush and exit', (done) => {
     logger.debug('this is a debug statement');
@@ -76,13 +71,14 @@ describe('sumologic-winston-logger Unit Tests', function LoggerTests() {
     done();
   });
   after(done => setTimeout(() => { // adding a delay to make sure that the flush is done
+    clearTimeout(logger.safetyTimer);
     process.exit.restore();
     done();
-  }, FLUSH_TIMEOUT));
+  }, TEST_FLUSH_TIMEOUT));
 });
 
 describe('Sumologic transport', function SumoTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   let server;
   let port;
   let sumo;
@@ -110,6 +106,7 @@ describe('Sumologic transport', function SumoTests() {
   after(done => server.close(done));
 
   beforeEach(() => {
+    sumo.removeAllListeners();
     sumo.code = 'ok';
     sumo.endpoint = `http://localhost:${port}/logs/`;
   });
@@ -189,7 +186,7 @@ describe('Sumologic transport', function SumoTests() {
 });
 
 describe('S3 transport', function S3Tests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   beforeEach(() => s3Mock.resetHistory());
 
   it('sends info logs to S3', (done) => {
@@ -268,7 +265,7 @@ describe('S3 transport', function S3Tests() {
 });
 
 describe('S3 remote transport', function S3RemoteTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   beforeEach(() => s3Mock.resetHistory());
   before(() => {
     globalThis.serverType = 'mTestRemote';
@@ -319,7 +316,7 @@ describe('S3 remote transport', function S3RemoteTests() {
 });
 
 describe('S3 transport flush', function S3FlushTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   const HIGH_MAX = 999;
   let s3Transport;
   let originalMaxEvents;
@@ -411,7 +408,7 @@ describe('S3 transport flush', function S3FlushTests() {
 });
 
 describe('S3 transport error handling', function S3ErrorTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
 
   afterEach(() => {
     s3Mock.reset();
@@ -442,7 +439,7 @@ describe('S3 transport error handling', function S3ErrorTests() {
 });
 
 describe('Circular reference handling', function CircularTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   beforeEach(() => {
     s3Mock.resetHistory();
     kinesisMock.resetHistory();
@@ -464,7 +461,7 @@ describe('Circular reference handling', function CircularTests() {
 });
 
 describe('Kinesis transport', function KinesisTests() {
-  this.timeout(START_TIMEOUT);
+  this.timeout(TEST_START_TIMEOUT);
   beforeEach(() => kinesisMock.resetHistory());
 
   it('sends info logs to the info stream', (done) => {
@@ -499,3 +496,93 @@ describe('Kinesis transport', function KinesisTests() {
     }, TEST_DELAY);
   });
 });
+
+describe('Transport close', function CloseTests() {
+  this.timeout(TEST_START_TIMEOUT);
+
+  it('clears the S3 interval timer on close', () => {
+    const s3Transport = logger.transports.find(tr => tr.name === 'awsS3');
+    (() => s3Transport.close()).should.not.throw();
+  });
+
+  it('clears the Kinesis interval timer on close', () => {
+    const kinesisTransport = logger.transports.find(tr => tr.name === 'awsKinesis');
+    (() => kinesisTransport.close()).should.not.throw();
+  });
+});
+
+describe('checkMode validation', function CheckModeTests() {
+  this.timeout(TEST_START_TIMEOUT);
+
+  it('returns null for undefined mode', () => {
+    should().equal(checkMode(undefined), null);
+  });
+
+  it('returns null for falsy mode', () => {
+    should().equal(checkMode(''), null);
+  });
+
+  it('returns array for a valid single mode', () => {
+    checkMode('awsS3').should.deep.equal(['awsS3']);
+  });
+
+  it('parses comma-separated modes', () => {
+    checkMode('awsS3, sumologic').should.deep.equal(['awsS3', 'sumologic']);
+  });
+
+  it('expands all mode to sumologic and awsS3', () => {
+    checkMode('all').should.deep.equal(['sumologic', 'awsS3']);
+  });
+
+  it('throws when none is combined with other modes', () => {
+    (() => checkMode('none, awsS3')).should.throw('Cannot have multiple modes');
+  });
+
+  it('throws for an invalid mode value', () => {
+    (() => checkMode('invalid')).should.throw('Invalid items in LOG_MODE');
+  });
+});
+
+describe('checkConfig validation', function CheckConfigTests() {
+  this.timeout(TEST_START_TIMEOUT);
+
+  it('does not throw for a fully defined config', () => {
+    (() => checkConfig({ key: 'value', nested: { count: 1 } })).should.not.throw();
+  });
+
+  it('throws for a config with undefined values', () => {
+    (() => checkConfig({ key: undefined })).should.throw('Missing values');
+  });
+
+  it('throws for a nested config with undefined values', () => {
+    (() => checkConfig({ nested: { key: undefined } })).should.throw('Missing values');
+  });
+});
+
+describe('parseStack', function ParseStackTests() {
+  this.timeout(TEST_START_TIMEOUT);
+
+  it('returns a stackInfo object for a valid error', () => {
+    const result = parseStack(new Error('test'));
+    should().exist(result);
+    result.should.have.property('method');
+    result.should.have.property('path');
+    result.should.have.property('line');
+    result.should.have.property('pos');
+    result.should.have.property('file');
+    result.should.have.property('stack');
+    result.should.have.property('hash');
+  });
+
+  it('produces a 64-character hex hash', () => {
+    const result = parseStack(new Error('test'));
+    should().exist(result);
+    result.hash.should.match(/^[a-f0-9]{64}$/u);
+  });
+
+  it('returns null when all stack frames are filtered out', () => {
+    const fakeError = { stack: 'Error\n    at Object.<anonymous> (node_modules/winston/foo.js:1:1)' };
+    const result = parseStack(fakeError);
+    should().equal(result, null);
+  });
+});

package/test/loggerProd.spec.js

@@ -1,5 +1,5 @@
 import './testEnvProdFilter.js';
-import { FLUSH_TIMEOUT, OK_EXIT, START_TIMEOUT } from '../lib/common.js';
+import { OK_EXIT, TEST_FLUSH_TIMEOUT, TEST_START_TIMEOUT } from '../lib/common.js';
 import { after, describe, it } from 'mocha';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
@@ -59,19 +59,16 @@ const user = {
 
 should();
 
-describe('sumologic-winston-logger prod Unit Tests', function LoggerTests() {
-  this.timeout(START_TIMEOUT);
-  it('Changing the environment to prod to cover filters', (done) => {
+describe('sumologic-winston-logger prod filter tests', function LoggerTests() {
+  this.timeout(TEST_START_TIMEOUT);
+  it('Changing the environment to prod to cover filters', () => {
     logger.info('this is an info statement on prod', { meta: 'data' });
-    done();
   });
-  it('Changing the environment to prod to cover filters and see filtered result', (done) => {
+  it('Changing the environment to prod to cover filters and see filtered result', () => {
     logger.info('this is an info statement on prod', { user }, correlationId);
-    done();
   });
-  it('Can log a debug statement without correlationId and info on production', (done) => {
+  it('Can log a debug statement without correlationId and info on production', () => {
     logger.debug('this is a debug statement');
-    done();
   });
   it('Can flush and exit', (done) => {
     logger.debug('this is a debug statement');
@@ -80,7 +77,8 @@ describe('sumologic-winston-logger prod Unit Tests', function LoggerTests() {
     done();
   });
   after(done => setTimeout(() => { // adding a delay to make sure that the flush is done
+    clearTimeout(logger.safetyTimer);
     process.exit.restore();
     done();
-  }, FLUSH_TIMEOUT));
+  }, TEST_FLUSH_TIMEOUT));
 });

package/test/testEnv.js

@@ -10,12 +10,12 @@ import process from 'node:process';
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
  * | SERVER_TYPE | type of the server that is logged
- * | SERVER_ID |id of the servier that is logged
+ * | SERVER_ID | id of the server that is logged
  * | LOG_LEVEL | log level of the running instance
  * | CONSOLE_LEVEL | log level for the console of the running instance
- * | EXIT_DELAY | delay when existing gracefully
- * | NO_STACK | indicatior to log th stack on all log message
- * | LOG_MODE | loge mode for the running instance
+ * | FLUSH_EXIT_DELAY | delay when exiting gracefully
+ * | NO_STACK | indicator to log the stack on all log messages
+ * | LOG_MODE | log mode for the running instance
  * | SUMO_LOGIC_ENDPOINT | url of the sumologic collector
  * | SUMO_LOGIC_COLLECTOR_CODE | code of the sumologic collector
  * | KINESIS_AWS_STREAM_NAME_INFO | name of the stream for info level logs
@@ -51,7 +51,7 @@ process.env.KINESIS_AWS_STREAM_NAME_ERROR = 'a kinesis stream name for error';
 process.env.KINESIS_AWS_STREAM_NAME_OTHER = 'a kinesis stream name for other';
 process.env.S3_AWS_MAX_EVENTS = 1;
 process.env.KINESIS_AWS_MAX_EVENTS = 1;
-process.env.EXIT_DELAY = 1;
+process.env.FLUSH_EXIT_DELAY = 1;
 process.env.LOG_MODE = 'awsS3, sumologic, awsKinesis';
 process.env.NO_STACK = 'yes';
 process.env.LOG_LEVEL = 'info';

package/test/testEnvProdFilter.js

@@ -9,12 +9,12 @@ import process from 'node:process';
  *
  * | Env variable name | Description | Default | Comments |
  * | ----------------- | ----------- | ------- | -------- |
- * | NODE_ENV | environement of the instance
+ * | NODE_ENV | environment of the instance
  * | LOG_LEVEL | log level of the running instance
  * | CONSOLE_LEVEL | log level for the console of the running instance
  * | FILTER_FILE | filename containing filter rules
- * | NO_STACK | indicatior to log th stack on all log message
- * | LOG_MODE | loge mode for the running instance
+ * | NO_STACK | indicator to log the stack on all log messages
+ * | LOG_MODE | log mode for the running instance
  * | SUMO_LOGIC_ENDPOINT | url of the sumologic collector
  * | SUMO_LOGIC_COLLECTOR_CODE | code of the sumologic collector
  */