@mimik/sumologic-winston-logger 1.6.22 → 2.0.0

package/lib/common.js

@@ -5,13 +5,13 @@ const DEFAULT_LEVEL = 'debug';
 const DEFAULT_ENV = ENV_LOCAL;
 const DEFAULT_FILTER_FILE = null;
 
-const ALL = 'all'; // legacy support
-const NONE = 'none';
+const ALL_MODE = 'all'; // legacy support
+const NONE_MODE = 'none';
 const AWS_S3 = 'awsS3';
 const SUMOLOGIC = 'sumologic';
 const AWS_KINESIS = 'awsKinesis';
-const DEFAULT_MODE = [NONE];
-const ALL_MODES = [AWS_S3, SUMOLOGIC, AWS_KINESIS, ALL, NONE];
+const DEFAULT_MODE = [NONE_MODE];
+const ALL_MODES = [AWS_S3, SUMOLOGIC, AWS_KINESIS, ALL_MODE, NONE_MODE];
 
 const DEFAULT_S3_MAX_SIZE = 5; // max size of the data before sending to S3, in mB
 const DEFAULT_S3_MAX_EVENTS = 1000; // max number of events before sending to S3
@@ -41,39 +41,39 @@ const INFO = 'info';
 const ERROR = 'error';
 const OTHER = 'other';
 
-module.exports = {
-  DEFAULT_LEVEL,
+export {
+  ALL_MODE,
+  ALL_MODES,
+  AWS_KINESIS,
+  AWS_S3,
+  CLIENTS,
   DEFAULT_ENV,
+  DEFAULT_EXIT_DELAY,
   DEFAULT_FILTER_FILE,
-  AWS_S3,
-  AWS_KINESIS,
-  SUMOLOGIC,
-  DEFAULT_MODE,
-  ALL,
-  NONE,
-  ALL_MODES,
-  ENV_DEV,
-  ENV_LOCAL,
-  DEFAULT_S3_MAX_SIZE,
-  DEFAULT_S3_MAX_EVENTS,
-  DEFAULT_S3_TIMEOUT,
-  DEFAULT_KINESIS_MAX_SIZE,
   DEFAULT_KINESIS_MAX_EVENTS,
+  DEFAULT_KINESIS_MAX_SIZE,
   DEFAULT_KINESIS_TIMEOUT,
-  DEFAULT_EXIT_DELAY,
+  DEFAULT_LEVEL,
+  DEFAULT_MODE,
   DEFAULT_NO_STACK,
-  SPLAT,
-  LEVEL,
-  MESSAGE,
-  WARN,
-  LOG,
+  DEFAULT_S3_MAX_EVENTS,
+  DEFAULT_S3_MAX_SIZE,
+  DEFAULT_S3_TIMEOUT,
+  ENV_DEV,
+  ENV_LOCAL,
+  ERROR,
   FLUSH,
   FLUSH_EXIT,
-  UNKNOWN_TYPE,
-  UNKNOWN_ID,
-  CLIENTS,
-  PARTITION_KEY,
   INFO,
-  ERROR,
+  LEVEL,
+  LOG,
+  MESSAGE,
+  NONE_MODE,
   OTHER,
+  PARTITION_KEY,
+  SPLAT,
+  SUMOLOGIC,
+  UNKNOWN_TYPE,
+  UNKNOWN_ID,
+  WARN,
 };

package/lib/formatLib.js

@@ -1,20 +1,19 @@
-const { format } = require('winston');
-const forEach = require('lodash.foreach');
-const isObject = require('lodash.isobject');
-const isString = require('lodash.isstring');
-const isNil = require('lodash.isnil');
-
-const { logs } = require('@mimik/lib-filters');
-
-const { parseStack } = require('./stackLib');
-
-const {
-  SPLAT,
-  LEVEL,
-  MESSAGE,
+import {
   ENV_DEV,
   ENV_LOCAL,
-} = require('./common');
+  LEVEL,
+  MESSAGE,
+  SPLAT,
+} from './common.js';
+import forEach from 'lodash.foreach';
+import { format } from 'winston';
+import isNil from 'lodash.isnil';
+import isObject from 'lodash.isobject';
+import isString from 'lodash.isstring';
+import { logs } from '@mimik/lib-filters';
+import { parseStack } from './stackLib.js';
+
+const INDEX_ADJUST = 1;
 
 const isReserved = (value) => {
   if (value === LEVEL || value === 'level') return true;
@@ -44,17 +43,17 @@ const correlationId = format((origInfo) => {
   const info = origInfo;
   const meta = info[SPLAT];
 
-  if (meta && isString(meta[meta.length - 1])) {
-    const results = meta[meta.length - 1].split('/');
+  if (meta && isString(meta[meta.length - INDEX_ADJUST])) {
+    const results = meta[meta.length - INDEX_ADJUST].split('/');
 
     ([info.correlationId, info.requestedAt] = results);
   }
-  if (!info.correlationId) info.step = undefined;
-  else {
+  if (info.correlationId) {
     const resultsSteps = info.correlationId.split('@');
 
     ([info.correlationId, info.step] = resultsSteps);
   }
+  else info.step = undefined;
   if (info.step) info.step = parseInt(info.step, 10);
   return info;
 });
@@ -72,11 +71,15 @@ const filterMeta = format((origInfo, opts) => {
     let item = origItem;
 
     // in order to vaoid having the do it for in the rest of the code for mongoose objects
-    try { item = origItem.toObject(); }
-    catch (err) {
+    try {
+      item = origItem.toObject();
+    }
+    catch {
       Object.keys(item).forEach((key) => {
-        try { item[key] = item[key].toObject(); }
-        catch (keyErr) {
+        try {
+          item[key] = item[key].toObject();
+        }
+        catch {
           // do nothing
         }
       });
@@ -97,7 +100,7 @@ const filterMeta = format((origInfo, opts) => {
   return info;
 });
 
-module.exports = {
+export {
   stackInfo,
   correlationId,
   filterMeta,

package/lib/stackLib.js

@@ -1,36 +1,51 @@
-const crypto = require('crypto');
-const path = require('path');
-const reject = require('lodash.reject');
-const trimStart = require('lodash.trimstart');
+import crypto from 'crypto';
+import {
+  fileURLToPath,
+} from 'url';
+import path from 'path';
+import reject from 'lodash.reject';
+import trimStart from 'lodash.trimstart';
 
 // Stack trace format :
 // https://github.com/v8/v8/wiki/Stack%20Trace%20API
 // these regexes are used to pull out the parts of the stack trace like method name, line number, etc.
-const STACKREG = /at\s+(.*)\s+\((.*):(\d*):(\d*)\)/i;
-const STACKREG2 = /at\s+()(.*):(\d*):(\d*)/i;
+const STACKREG = /at\s+(?<method>.*)\s+\((?<path>.*):(?<line>\d*):(?<position>\d*)\)/iu;
+const STACKREG2 = /at\s+(?<method>)(?<path>.*):(?<line>\d*):(?<position>\d*)/iu;
 const SECRET = 'a secret for creating the hash';
 
+const POSITION = 4;
+const LINE = 3;
+const PATH = 2;
+const METHOD = 1;
+const SHIFT = '    ';
+const ALL_STACK = 5;
+const FIRST_LINE = 0;
+const NO_LINE = 0;
+const STACK_SLICE = 1;
+
+const filename = fileURLToPath(import.meta.url);
+
 const parseStack = (newError) => {
   // get call stack, and analyze it
   // get the file, method and line number
   // slice to drop the line that just says "Error"
-  const stackList = newError.stack.split('\n').slice(1);
+  const stackList = newError.stack.split('\n').slice(STACK_SLICE);
   // remove all lines that refer to this file.
   // start the stack trace from the code that called this module.
-  const truncatedList = reject(stackList, (line) => line.includes(__filename) || line.includes('winston') || line.includes('logform') || line.includes('formatLib'));
+  const truncatedList = reject(stackList, line => line.includes(filename) || line.includes('winston') || line.includes('logform') || line.includes('formatLib'));
 
-  if (truncatedList.length === 0) return null;
-  const firstLine = truncatedList[0];
+  if (truncatedList.length === NO_LINE) return null;
+  const firstLine = truncatedList[FIRST_LINE];
   const stackParts = STACKREG.exec(firstLine) || STACKREG2.exec(firstLine);
 
-  if (stackParts && stackParts.length !== 5) return null;
+  if (stackParts && stackParts.length !== ALL_STACK) return null;
   const stackInfo = {
-    method: stackParts[1],
-    path: stackParts[2],
-    line: stackParts[3],
-    pos: stackParts[4],
-    file: path.basename(stackParts[2]),
-    stack: `    ${trimStart(truncatedList.join('\n'))}`,
+    method: stackParts[METHOD],
+    path: stackParts[PATH],
+    line: stackParts[LINE],
+    pos: stackParts[POSITION],
+    file: path.basename(stackParts[PATH]),
+    stack: `${SHIFT}${trimStart(truncatedList.join('\n'))}`,
   };
   stackInfo.hash = crypto.createHash('sha256', SECRET)
     .update(stackInfo.stack)
@@ -40,6 +55,6 @@ const parseStack = (newError) => {
   return stackInfo;
 };
 
-module.exports = {
+export {
   parseStack,
 };

package/lib/sumologicTransport.js

@@ -1,17 +1,23 @@
-const axios = require('axios');
-const Transport = require('winston-transport');
-
-const {
-  SUMOLOGIC,
-  LOG,
-  WARN,
-  UNKNOWN_TYPE,
-  UNKNOWN_ID,
+import {
   CLIENTS,
+  LOG,
   SPLAT,
-} = require('./common');
+  SUMOLOGIC,
+  UNKNOWN_ID,
+  UNKNOWN_TYPE,
+  WARN,
+} from './common.js';
+import Transport from 'winston-transport';
+import axios from 'axios';
+import {
+  setImmediate,
+} from 'timers';
+
+const UNAUTHORIZED_ERROR = 401;
+const NOTFOUND_ERROR = 404;
+const SYSTEM_ERROR = 500;
 
-module.exports = class Sumo extends Transport {
+export default class Sumo extends Transport {
   constructor(options = {}) {
     super(options);
     this.serverType = options.serverType || UNKNOWN_TYPE;
@@ -22,8 +28,8 @@ module.exports = class Sumo extends Transport {
   }
 
   log(info, callback) {
-    const { serverType } = global;
-    let { serverId } = global;
+    const { serverType } = globalThis;
+    let { serverId } = globalThis;
     const data = info;
 
     if (serverType) {
@@ -48,18 +54,18 @@ module.exports = class Sumo extends Transport {
 
         if (info && info[SPLAT] && Array.isArray(info[SPLAT])) [, resp.correlationId] = info[SPLAT];
         if (!response) {
-          resp.error = { statusCode: 500, code: err.code, message: err.message };
+          resp.error = { statusCode: SYSTEM_ERROR, code: err.code, message: err.message };
           return this.emit(WARN, resp);
         }
         const { status } = response;
 
-        resp.error = { statusCode: status || 500 };
-        if (status >= 500) resp.error.message = `${SUMOLOGIC} is not reachable`;
-        else if (status === 401) {
+        resp.error = { statusCode: status || SYSTEM_ERROR };
+        if (status >= SYSTEM_ERROR) resp.error.message = `${SUMOLOGIC} is not reachable`;
+        else if (status === UNAUTHORIZED_ERROR) {
           resp.error.message = `invalid ${SUMOLOGIC} code`;
           resp.code = this.code;
         }
-        else if (status === 404) resp.error.message = `invalid ${SUMOLOGIC} endpoint`;
+        else if (status === NOTFOUND_ERROR) resp.error.message = `invalid ${SUMOLOGIC} endpoint`;
         else resp.error.message = `could not log to ${SUMOLOGIC}`;
         return this.emit(WARN, resp);
       });

package/manual-test/eventsMock.js

@@ -1,6 +1,8 @@
 /* eslint-disable no-console */
-const express = require('express');
-const bodyParser = require('body-parser');
+import bodyParser from 'body-parser';
+import express from 'express';
+
+const INCR = 1;
 
 let i = 0;
 
@@ -12,7 +14,7 @@ const config = {
 
 app.use(bodyParser.json());
 app.post(`${config.base}`, (req, res) => {
-  i += 1;
+  i += INCR;
   console.log('Recieved a POST:', i);
   // console.log('headers:', req.headers)
   console.log(req.body);

package/manual-test/testLog.js

@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
-const _ = require('lodash');
-
-require('../test/testEnv');
-const logger = require('../index');
+import '../test/testEnv.js';
+import clone from 'lodash.clone';
+import { getCorrelationId } from '@mimik/request-helper';
+import logger from '../index.js';
+import process from 'process';
 
 const user = {
   name: 'a name',
@@ -15,7 +16,7 @@ const user = {
   test1: 'this is a test1',
   test2: 'this is a test2',
 };
-const correlationId = 'test-12345';
+const correlationId = getCorrelationId('test-12345');
 const stdin = process.openStdin();
 
 logger.info('This is a test, info', {
@@ -27,7 +28,7 @@ logger.debug('This is a test with error', { user }, correlationId);
 logger.error('This is a test, error', { user }, correlationId);
 
 stdin.addListener('data', () => {
-  const clonedObject = _.clone(user);
+  const clonedObject = clone(user);
 
   clonedObject.index = 'manual';
   console.log('manual logging');

package/manual-test/testLogAndQuit.js

@@ -1,17 +1,19 @@
-require('../test/testEnv');
-const logger = require('../index');
+import '../test/testEnv';
+import logger from '../index.js';
+
+const ISSUE_EXIT = 1;
 
 const complexObject = {
   key: 'property a',
-  b: {
-    c: 'property c',
-    d: 'property d',
-    e: {
-      f: 'property f',
+  propB: {
+    propC: 'property c',
+    propD: 'property d',
+    propE: {
+      propF: 'property f',
     },
   },
 };
-complexObject.g = complexObject;
+complexObject.propG = complexObject;
 const error = new Error('an error');
 error.name = 'this is a complex error';
 error.statusCode = 500;
@@ -35,7 +37,7 @@ 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(1);
+logger.flushAndExit(ISSUE_EXIT);
 // setTimeout(() => console.log('done'), 4000);
 // console.log('----------')
 // logger.error(error, { user: complexObject }, '6795949');

package/manual-test/testLogError.js

@@ -1,12 +1,12 @@
-/* eslint-disable no-console */
-require('../test/testEnv');
-const logger = require('../index');
+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 = 'test-12345';
+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,34 +1,35 @@
 /* eslint-disable no-console */
-const _ = require('lodash');
-const Promise = require('bluebird');
-
-require('../test/testEnv');
-const logger = require('../index');
+import '../test/testEnv.js';
+import Promise from 'bluebird';
+import clone from 'lodash.clone';
+import { getCorrelationId } from '@mimik/request-helper';
+import logger from '../index.js';
 
 const MAX_ITEMS = 100000;
+const INCR = 1;
 
 const complexObject = {
   key: 'property a',
-  b: {
-    c: 'property c',
-    d: 'property d',
-    e: {
-      f: 'property f',
+  propB: {
+    propC: 'property c',
+    propD: 'property d',
+    propE: {
+      propF: 'property f',
     },
   },
 };
-complexObject.g = complexObject;
+complexObject.propG = complexObject;
 const object = {
   user: {
     userId: 'a long userid simulating a uuid',
     info: 'this is a test',
-    correlationId: 'a long uuid to simulate a correaltionId',
+    correlationId: getCorrelationId('a long uuid to simulate a correlationId'),
   },
 };
 const objects = [];
 
-for (let i = 0; i < MAX_ITEMS; i += 1) {
-  const clonedObject = _.clone(object);
+for (let i = 0; i < MAX_ITEMS; i += INCR) {
+  const clonedObject = clone(object);
 
   clonedObject.index = i;
   objects.push(clonedObject);
@@ -36,7 +37,7 @@ for (let i = 0; i < MAX_ITEMS; i += 1) {
 const startDate = new Date();
 
 console.log('Test start at:', startDate.toISOString(), 'with:', MAX_ITEMS, 'items');
-Promise.map(objects, (obj) => logger.info('This is a test', { data: obj }, 'test-correlation-id')).then(() => {
+Promise.map(objects, 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');
 });

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "1.6.22",
+  "version": "2.0.0",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
-  "main": "index.js",
+  "main": "./index.js",
+  "type": "module",
   "scripts": {
-    "lint": "eslint --ignore-path .gitignore .",
+    "lint": "eslint . --no-error-on-unmatched-pattern",
     "docs": "jsdoc2md configuration/config.js > README.md && cat README_Supplement.md >> README.md",
-    "test": "mocha --reporter mochawesome --bail --check-leaks test/",
-    "test-ci": "nyc --reporter=lcov --reporter=text npm test",
+    "test": "mocha --reporter mochawesome --bail --check-leaks test/loggerProd.spec.js test/logger.spec.js",
+    "test-ci": "c8 --reporter=lcov --reporter=text npm test --exit",
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
@@ -32,10 +33,10 @@
     "url": "https://bitbucket.org/mimiktech/sumologic-winston-logger"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^1.5.4",
-    "@aws-sdk/client-s3": "3.665.0",
-    "@aws-sdk/client-kinesis": "3.665.0",
-    "axios": "1.7.7",
+    "@mimik/lib-filters": "^2.0.1",
+    "@aws-sdk/client-s3": "3.758.0",
+    "@aws-sdk/client-kinesis": "3.758.0",
+    "axios": "1.8.1",
     "bluebird": "3.7.2",
     "lodash.difference": "4.5.0",
     "lodash.foreach": "4.5.0",
@@ -47,28 +48,25 @@
     "lodash.split": "4.4.2",
     "lodash.trim": "4.5.1",
     "lodash.trimstart": "4.5.1",
-    "winston": "3.14.2",
-    "winston-transport": "4.8.0"
+    "winston": "3.17.0",
+    "winston-transport": "4.9.0"
   },
   "devDependencies": {
-    "@mimik/eslint-plugin-dependencies": "^2.4.6",
-    "@mimik/eslint-plugin-document-env": "^1.0.6",
-    "@mimik/request-helper": "^1.7.11",
+    "@eslint/js": "9.21.0",
+    "@mimik/eslint-plugin-document-env": "^2.0.2",
+    "@mimik/request-helper": "^2.0.0",
+    "@stylistic/eslint-plugin": "4.2.0",
     "body-parser": "1.20.3",
-    "chai": "4.5.0",
-    "eslint": "8.57.1",
-    "eslint-config-airbnb": "19.0.4",
+    "c8": "10.1.3",
+    "chai": "5.2.0",
+    "eslint": "9.21.0",
     "eslint-plugin-import": "2.31.0",
-    "eslint-plugin-jsx-a11y": "6.10.0",
-    "eslint-plugin-react": "7.37.1",
-    "eslint-plugin-react-hooks": "4.6.2",
-    "express": "4.21.0",
-    "husky": "9.1.6",
-    "jsdoc-to-markdown": "9.0.2",
-    "lodash": "4.17.21",
-    "mocha": "10.7.3",
+    "express": "4.21.2",
+    "husky": "9.1.7",
+    "jsdoc-to-markdown": "9.1.1",
+    "lodash.clone": "4.5.0",
+    "mocha": "11.1.0",
     "mochawesome": "7.1.3",
-    "nyc": "17.1.0",
     "sinon": "19.0.2",
     "supertest": "7.0.0"
   }

package/test/filterConfig.json

@@ -1,20 +1,5 @@
 [
-  "*.firsName", 
-  "*.lastName", 
-  "*.password",
-  "*.email", 
-  "*.access_token", 
-  "*.refresh_token", 
-  "*.secret", 
-  "*.accessKey", 
-  "*.refreshKey", 
-  "*.Token", 
-  "*.NewPassword",
-  "*.ConfirmPassword",
-  "*.sumologicCode", 
-  "*.accessKey", 
-  "*.admin.id", 
-  "*.server.id", 
-  "*.key", 
-  "*.user"
+  "$..references[0]", 
+  "$..references[1].serverType",
+  "$..email"
 ]