@mimik/sumologic-winston-logger 2.2.1 → 2.2.3

package/README.md

@@ -160,7 +160,7 @@ To learn more about setting this environment variable, see the section, _Finding
 
 #### Finding SumoLogic endpoint and collector code ####
 
-To find the values that you will apply the environment variables, `SUMO_LOGIC_ENDPOINT` and `SUMO_LOGIC_COLLECTOR_CODE`, in the SumoLogic Control Panel, goto: Manage > Collection, and get the source category
+To find the values that you will apply the environment variables, `SUMO_LOGIC_ENDPOINT` and `SUMO_LOGIC_COLLECTOR_CODE`, in the SumoLogic Control Panel, go to: Manage > Collection, and get the source category.
 
 ![Screen Shot 2016-10-10 at 2.03.31 PM.png](https://bitbucket.org/repo/xbXGRo/images/3258406172-Screen%20Shot%202016-10-10%20at%202.03.31%20PM.png)
 
@@ -194,11 +194,11 @@ Formatting console logs is left to winston, except that some stackTrace info is
 
 Formatting of SumoLogic logs is handled by this module in the following ways:
 
-* only the first argument is used as the message
-* one metadata object can be passed as a parameter; its properties are included in the log entry
-* structured stackTrace info is added to every log except when NO_STACK is set to 'yes'
-* if the last parameter is a string it will be considered as a `correlationId`
-* if the last parameter is a plain object **and** there is already an earlier metadata object, its properties are merged into the log entry at the top level (alongside `serverType`/`serverId`) — this is the _extra fields_ feature
+* only the first argument is used as the message,
+* one metadata object can be passed as a parameter; its properties are included in the log entry,
+* structured stackTrace info is added to every log except when NO_STACK is set to 'yes',
+* if the last parameter is a string it will be considered as a `correlationId`,
+* if the last parameter is a plain object **and** there is already an earlier metadata object, its properties are merged into the log entry at the top level (alongside `serverType`/`serverId`) — this is the _extra fields_ feature.
 
 
 ### Logging Examples ###
@@ -232,7 +232,7 @@ The log() method is also supported, and adds a level parameter in position 1.
 
 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
+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.
 
 |Example|
 |---|

package/configuration/config.js

@@ -140,6 +140,7 @@ const configuration = {
   noStack: process.env.NO_STACK || 'yes',
 };
 configuration.mode = checkMode(process.env.LOG_MODE) || [NONE_MODE];
+/* c8 ignore stop */
 
 if (configuration.mode.includes(SUMOLOGIC)) {
   configuration[SUMOLOGIC] = {
@@ -163,6 +164,7 @@ if (configuration.mode.includes(AWS_KINESIS)) {
     },
   };
 
+  /* c8 ignore next 2 -- optional env vars not set in test */
   if (process.env.KINESIS_AWS_ACCESS_KEY_ID !== undefined) configuration[AWS_KINESIS].accessKeyId = process.env.KINESIS_AWS_ACCESS_KEY_ID;
   if (process.env.KINESIS_AWS_SECRET_ACCESS_KEY !== undefined) configuration[AWS_KINESIS].secretAccessKey = process.env.KINESIS_AWS_SECRET_ACCESS_KEY;
 }
@@ -175,12 +177,14 @@ if (configuration.mode.includes(AWS_S3)) {
     maxEvents: toInt(process.env.S3_AWS_MAX_EVENTS, 1000),
   };
 
+  /* c8 ignore next 2 -- optional env vars not set in test */
   if (process.env.S3_AWS_ACCESS_KEY_ID !== undefined) configuration[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
   if (process.env.S3_AWS_SECRET_ACCESS_KEY !== undefined) configuration[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
 }
 const { filter } = configuration;
 let filterConfig = [];
 
+/* c8 ignore start -- FILTER_FILE only set in prod env, module singleton prevents re-evaluation */
 if (filter.file) {
   try {
     filterConfig = JSON.parse(readFileSync(filter.file).toString());
@@ -189,6 +193,7 @@ if (filter.file) {
     throw new Error(`Invalid file for logger config: ${filter.file}`, { cause: err });
   }
 }
+/* c8 ignore stop */
 filter.config = filterConfig;
 checkConfig(configuration);
 

package/index.js

@@ -111,6 +111,7 @@ if (config.mode.includes(AWS_KINESIS)) {
   logger.add(awsKinesis);
 }
 
+/* c8 ignore start -- flush race-condition branches depend on async transport completion order */
 logger.flushAndExit = (code) => {
   const flushing = () => {
     let sumoDone = false;
@@ -190,6 +191,7 @@ logger.flush = () => {
 
   setTimeout(flushing, config.flushExitDelay);
 };
+/* c8 ignore stop */
 
 logger.LEVELS = ['error', 'warn', 'info', 'verbose', 'debug', 'silly'];
 

package/lib/awsKinesisTransport.js

@@ -65,6 +65,7 @@ export default class AwsKinesis extends Transport {
     );
     this.kinesis = new KinesisClient(this.kinesisClientConfig);
 
+    /* c8 ignore start -- timer-based flush; exercised in production, not in unit tests */
     this.time = setInterval(() => {
       Object.keys(events).forEach((level) => {
         if (events[level].Records.length) {
@@ -74,6 +75,7 @@ export default class AwsKinesis extends Transport {
         }
       });
     }, this.timeInterval).unref();
+    /* c8 ignore stop */
   }
 
   put(Records, lvl) {

package/lib/awsS3Transport.js

@@ -46,6 +46,7 @@ export default class AwsS3 extends Transport {
     }
     this.s3 = new S3Client(this.s3ClientConfig);
 
+    /* c8 ignore start -- timer-based flush; exercised in production, not in unit tests */
     this.time = setInterval(() => {
       Object.keys(events).forEach((level) => {
         if (events[level].data.length) {
@@ -63,6 +64,7 @@ export default class AwsS3 extends Transport {
         }
       });
     }, this.timeInterval).unref();
+    /* c8 ignore stop */
   }
 
   put(data, lvl, date) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
@@ -11,8 +11,8 @@
   "scripts": {
     "docs": "jsdoc2md --template docs/README.hbs configuration/config.js > README.md",
     "lint": "eslint . --no-error-on-unmatched-pattern",
-    "test": "mocha --reporter mochawesome --bail --exit --check-leaks --global serverType,serverId test/",
-    "test-ci": "c8 --reporter=lcov --reporter=text npm test",
+    "test": "mocha",
+    "test-ci": "c8 npm test",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
@@ -32,15 +32,15 @@
   },
   "dependencies": {
     "@mimik/lib-filters": "^2.0.8",
-    "@aws-sdk/client-s3": "3.1007.0",
-    "@aws-sdk/client-kinesis": "3.1007.0",
-    "@smithy/node-http-handler": "4.4.14",
+    "@aws-sdk/client-s3": "3.1008.0",
+    "@aws-sdk/client-kinesis": "3.1008.0",
+    "@smithy/node-http-handler": "4.4.16",
     "axios": "1.13.6",
     "winston": "3.19.0",
     "winston-transport": "4.9.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.39.4",
+    "@eslint/js": "10.0.1",
     "@mimik/eslint-plugin-document-env": "^2.0.9",
     "@mimik/eslint-plugin-logger": "^1.0.3",
     "@mimik/request-helper": "^2.0.6",
@@ -48,14 +48,14 @@
     "aws-sdk-client-mock": "4.1.0",
     "c8": "11.0.0",
     "chai": "6.2.2",
-    "eslint": "9.39.4",
-    "eslint-plugin-import": "2.32.0",
+    "eslint": "10.1.0",
+    "eslint-plugin-import-x": "4.16.2",
     "express": "5.2.1",
     "globals": "17.4.0",
     "husky": "9.1.7",
     "jsdoc-to-markdown": "9.1.3",
     "mocha": "11.7.5",
     "mochawesome": "7.1.4",
-    "sinon": "21.0.2"
+    "sinon": "21.0.3"
   }
 }

package/manual-test/eventsMock.js

@@ -1,26 +0,0 @@
-/* eslint-disable no-console */
-import express from 'express';
-
-let i = 0;
-const MOCK_PORT = 9000;
-const CREATED_RESPONSE = 201;
-
-const app = express();
-const config = {
-  port: MOCK_PORT,
-  base: '/checkthat',
-};
-
-app.post(`${config.base}`, (req, res) => {
-  i += 1;
-  console.log('Recieved a POST:', i);
-  // console.log('headers:', req.headers)
-  console.log(req.body);
-
-  res.statusCode = CREATED_RESPONSE;
-  res.send(req.body);
-});
-
-app.listen(config.port, () => {
-  console.log(`event mock at ${config.port}`);
-});

package/manual-test/testLog.js

@@ -1,35 +0,0 @@
-/* eslint-disable no-console */
-import '../test/testEnv.js';
-import { getCorrelationId } from '@mimik/request-helper';
-import logger from '../index.js';
-import process from 'node:process';
-
-const user = {
-  name: 'a name',
-  password: 'a password',
-  address: {
-    street: ' a street',
-    test2: 'this is a test2',
-    city: 'a city',
-  },
-  test1: 'this is a test1',
-  test2: 'this is a test2',
-};
-const correlationId = getCorrelationId('test-12345');
-const stdin = process.openStdin();
-
-logger.info('This is a test, info', {
-  user, test: 'this is a test', test2: 'this is a test2', test1: 'this is a test1',
-}, correlationId);
-
-logger.debug('This is a test with error', { user }, correlationId);
-
-logger.error('This is a test, error', { user }, correlationId);
-
-stdin.addListener('data', () => {
-  const clonedObject = { ...user };
-
-  clonedObject.index = 'manual';
-  console.log('manual logging');
-  logger.info('this is a test', { data: clonedObject }, correlationId);
-});

package/manual-test/testLogAndQuit.js

@@ -1,42 +0,0 @@
-import '../test/testEnv';
-import { SYSTEM_ERROR } from '../lib/common.js';
-import logger from '../index.js';
-
-const ISSUE_EXIT = 1;
-
-const complexObject = {
-  key: 'property a',
-  propB: {
-    propC: 'property c',
-    propD: 'property d',
-    propE: {
-      propF: 'property f',
-    },
-  },
-};
-complexObject.propG = complexObject;
-const error = new Error('an error');
-error.name = 'this is a complex error';
-error.statusCode = SYSTEM_ERROR;
-error.title = 'System error';
-
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.info('this is a test', { user: complexObject }, '12345678');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.error('this is an error message', { user: complexObject, error, correlationId: '123344' }, '34567');
-logger.flushAndExit(ISSUE_EXIT);
-// setTimeout(() => console.log('done'), 4000);
-// logger.error(error, { user: complexObject }, '6795949');

package/manual-test/testLogError.js

@@ -1,12 +0,0 @@
-import '../test/testEnv.js';
-import { getCorrelationId } from '@mimik/request-helper';
-import logger from '../index.js';
-
-const error = new Error('this is a simple error');
-const errorCause = new Error('this is an error with cause', { cause: error });
-const errorCauseInfo = new Error('this is an error with cause and info', { cause: errorCause });
-errorCauseInfo.info = 'this is an info';
-const correlationId = getCorrelationId('test-12345');
-
-// logger.error('This is an error in object', { errorCauseInfo }, correlationId);
-logger.error('This is an error object ', errorCauseInfo, correlationId);

package/manual-test/testManyLogs.js

@@ -1,40 +0,0 @@
-/* eslint-disable no-console */
-import '../test/testEnv.js';
-import { getCorrelationId } from '@mimik/request-helper';
-import logger from '../index.js';
-
-const MAX_ITEMS = 100000;
-
-const complexObject = {
-  key: 'property a',
-  propB: {
-    propC: 'property c',
-    propD: 'property d',
-    propE: {
-      propF: 'property f',
-    },
-  },
-};
-complexObject.propG = complexObject;
-const object = {
-  user: {
-    userId: 'a long userid simulating a uuid',
-    info: 'this is a test',
-    correlationId: getCorrelationId('a long uuid to simulate a correlationId'),
-  },
-};
-const objects = [];
-
-for (let i = 0; i < MAX_ITEMS; i += 1) {
-  const clonedObject = { ...object };
-
-  clonedObject.index = i;
-  objects.push(clonedObject);
-}
-const startDate = new Date();
-
-console.log('Test start at:', startDate.toISOString(), 'with:', MAX_ITEMS, 'items');
-Promise.all(objects.map(obj => logger.info('This is a test', { data: obj }, getCorrelationId('test-correlation-id')))).then(() => {
-  const endDate = new Date();
-  console.log('Test end at:', endDate.toISOString(), 'duration:', endDate - startDate, 'with:', MAX_ITEMS, 'items');
-});