@mimik/sumologic-winston-logger 2.1.8 → 2.1.10

package/lib/common.js

@@ -1,6 +1,6 @@
-/* eslint-disable no-magic-numbers */
 const ENV_DEV = ['development', 'dev'];
 const ENV_LOCAL = 'local';
+const DEBUG_LEVEL = 'debug';
 
 const ALL_MODE = 'all'; // legacy support
 const NONE_MODE = 'none';
@@ -9,25 +9,6 @@ const SUMOLOGIC = 'sumologic';
 const AWS_KINESIS = 'awsKinesis';
 const ALL_MODES = [AWS_S3, SUMOLOGIC, AWS_KINESIS, ALL_MODE, NONE_MODE];
 
-const DEFAULT = {
-  ENV: ENV_LOCAL,
-  FILTER_FILE: null,
-  LEVEL: 'debug',
-  MODE: [NONE_MODE],
-  NO_STACK: 'yes',
-
-  EXIT_DELAY: 2000, // delay for flushing the transports and exiting, in millisecond
-  KINESIS_HTTP_OPTIONS_CONNECTION_TIMEOUT: 5000, // connection timeout for the http handler, in millisecond
-  KINESIS_HTTP_OPTIONS_SOCKET_TIMEOUT: 5000, // socket timeout for the http handler, in millisecond
-  KINESIS_MAX_EVENTS: 1000, // max number of events before sending to Kinesis
-  KINESIS_MAX_RETRIES: 4, // max retries to connect to Kinesis
-  KINESIS_MAX_SIZE: 5, // max size of the data before sending to Kinesis, in mByte
-  KINESIS_TIMEOUT: 1000, // max time before sending events to Kinesis, in millisecond
-  S3_MAX_EVENTS: 1000, // max number of events before sending to S3
-  S3_MAX_SIZE: 5, // max size of the data before sending to S3, in mByte
-  S3_TIMEOUT: 5, // max time before sending events to S3, in minute
-};
-
 const SPLAT = Symbol.for('splat');
 const LEVEL = Symbol.for('level');
 const MESSAGE = Symbol.for('message');
@@ -48,13 +29,17 @@ const OTHER = 'other';
 
 const UNAUTHORIZED_ERROR = 401;
 const NOT_FOUND_ERROR = 404;
+const TEAPOT_ERROR = 418;
 const SYSTEM_ERROR = 500;
 
+const OK_RESPONSE = 200;
+
 const START_TIMEOUT = 30000; // in millisecond
 const FLUSH_TIMEOUT = 1000; // in millisecond
 const OK_EXIT = 0;
 
 const MEGA = 1048576; // 2^20 conversion to mega
+const MILLI_MIN = 60000; // 1000*60 conversion to minute
 
 export {
   ALL_MODE,
@@ -62,7 +47,7 @@ export {
   AWS_KINESIS,
   AWS_S3,
   CLIENTS,
-  DEFAULT,
+  DEBUG_LEVEL,
   ENV_DEV,
   ENV_LOCAL,
   ERROR,
@@ -73,16 +58,19 @@ export {
   LEVEL,
   LOG,
   MEGA,
+  MILLI_MIN,
   MESSAGE,
   NONE_MODE,
   NOT_FOUND_ERROR,
   OK_EXIT,
+  OK_RESPONSE,
   OTHER,
   PARTITION_KEY,
   SPLAT,
   START_TIMEOUT,
   SUMOLOGIC,
   SYSTEM_ERROR,
+  TEAPOT_ERROR,
   UNAUTHORIZED_ERROR,
   UNKNOWN_TYPE,
   UNKNOWN_ID,

package/lib/formatLib.js

@@ -5,11 +5,7 @@ import {
   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';
 
@@ -43,7 +39,7 @@ const correlationId = format((origInfo) => {
   const info = origInfo;
   const meta = info[SPLAT];
 
-  if (meta && isString(meta[meta.length - INDEX_ADJUST])) {
+  if (meta && typeof meta[meta.length - INDEX_ADJUST] === 'string') {
     const results = meta[meta.length - INDEX_ADJUST].split('/');
 
     ([info.correlationId, info.requestedAt] = results);
@@ -66,32 +62,35 @@ const filterMeta = format((origInfo, opts) => {
   let target;
   let index;
 
-  forEach(meta, (origItem, i) => {
-    if (!isObject(origItem)) return true;
-    let item = origItem;
+  if (meta) {
+    for (let i = 0; i < meta.length; i += 1) {
+      if (typeof meta[i] === 'object' && meta[i] !== null) {
+        let item = meta[i];
 
-    // In order to avoid having to do it in the rest of the code for mongoose objects
-    try {
-      item = origItem.toObject();
-    }
-    catch {
-      Object.keys(item).forEach((key) => {
+        // In order to avoid having to do it in the rest of the code for mongoose objects
         try {
-          item[key] = item[key].toObject();
+          item = meta[i].toObject();
         }
         catch {
-          // do nothing
+          Object.keys(item).forEach((key) => {
+            try {
+              item[key] = item[key].toObject();
+            }
+            catch {
+              // do nothing
+            }
+          });
         }
-      });
+        // end of mongoose
+        target = logs(item, config);
+        index = i;
+        break;
+      }
     }
-    // end of monggose
-    target = logs(item, config);
-    index = i;
-    return false;
-  });
-  if (isNil(index)) return info;
+  }
+  if (index === undefined) return info;
   meta[index] = target;
-  forEach(target, (value, key) => {
+  Object.entries(target).forEach(([key, value]) => {
     if (!isReserved(key)) {
       info[key] = value;
     }

package/lib/stackLib.js

@@ -1,14 +1,12 @@
 import { basename } from 'node:path';
 import { createHash } from 'node:crypto';
 import { fileURLToPath } from 'node:url';
-import reject from 'lodash.reject';
 
 // 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+(?<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;
@@ -29,13 +27,13 @@ const parseStack = (newError) => {
   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 = stackList.filter(line => !line.includes(filename) && !line.includes('winston') && !line.includes('logform') && !line.includes('formatLib'));
 
   if (truncatedList.length === NO_LINE) return null;
   const firstLine = truncatedList[FIRST_LINE];
   const stackParts = STACKREG.exec(firstLine) || STACKREG2.exec(firstLine);
 
-  if (stackParts && stackParts.length !== ALL_STACK) return null;
+  if (!stackParts || stackParts.length !== ALL_STACK) return null;
   const stackInfo = {
     method: stackParts[METHOD],
     path: stackParts[PATH],
@@ -44,7 +42,7 @@ const parseStack = (newError) => {
     file: basename(stackParts[PATH]),
     stack: `${SHIFT}${truncatedList.join('\n').trimStart()}`,
   };
-  stackInfo.hash = createHash('sha256', SECRET)
+  stackInfo.hash = createHash('sha256')
     .update(stackInfo.stack)
     .digest('hex');
   // this is a hash of the stacktrace for easier searching for the stacktrace

package/lib/sumologicTransport.js

@@ -12,6 +12,7 @@ import {
 } from './common.js';
 import Transport from 'winston-transport';
 import axios from 'axios';
+import { inspect } from 'node:util';
 import { setImmediate } from 'node:timers';
 
 export default class Sumo extends Transport {
@@ -41,13 +42,13 @@ export default class Sumo extends Transport {
     axios({
       method: 'POST',
       url: `${this.endpoint}${this.code}`,
-      data,
+      data: inspect(data, { depth: null, compact: false }),
     })
-      .then(() => this.emit(LOG, { message: `log sent to ${SUMOLOGIC}` }))
+      .then(() => this.emit(LOG, { message: `logs sent to ${SUMOLOGIC}` }))
       .catch((err) => {
         const { response } = err;
 
-        const resp = { endpoint: this.endpoint, info, message: `coud not send log to ${SUMOLOGIC}` };
+        const resp = { endpoint: this.endpoint, info, message: `could not log to ${SUMOLOGIC}` };
 
         if (info && info[SPLAT] && Array.isArray(info[SPLAT])) [, resp.correlationId] = info[SPLAT];
         if (!response) {

package/manual-test/eventsMock.js

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

package/manual-test/testManyLogs.js

@@ -1,6 +1,5 @@
 /* eslint-disable no-console */
 import '../test/testEnv.js';
-import Promise from 'bluebird';
 import { getCorrelationId } from '@mimik/request-helper';
 import logger from '../index.js';
 
@@ -35,7 +34,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 }, getCorrelationId('test-correlation-id'))).then(() => {
+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');
 });

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.8",
+  "version": "2.1.10",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
+  "engines": {
+    "node": ">=24.0.0"
+  },
   "scripts": {
     "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/loggerProd.spec.js test/logger.spec.js",
-    "test-ci": "c8 --reporter=lcov --reporter=text npm test --exit",
+    "test": "mocha --reporter mochawesome --bail --exit --check-leaks --global serverType,serverId test/logger.spec.js test/loggerProd.spec.js",
+    "test-ci": "c8 --reporter=lcov --reporter=text 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"
   },
@@ -33,39 +36,30 @@
     "url": "https://bitbucket.org/mimiktech/sumologic-winston-logger"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^2.0.4",
-    "@aws-sdk/client-s3": "3.890.0",
-    "@aws-sdk/client-kinesis": "3.890.0",
-    "@smithy/node-http-handler": "4.2.1",
-    "axios": "1.12.2",
-    "bluebird": "3.7.2",
-    "lodash.difference": "4.5.0",
-    "lodash.foreach": "4.5.0",
-    "lodash.isnil": "4.0.0",
-    "lodash.isobject": "3.0.2",
-    "lodash.isstring": "4.0.1",
-    "lodash.isundefined": "3.0.1",
-    "lodash.reject": "4.6.0",
-    "lodash.split": "4.4.2",
-    "winston": "3.17.0",
+    "@mimik/lib-filters": "^2.0.5",
+    "@aws-sdk/client-s3": "3.990.0",
+    "@aws-sdk/client-kinesis": "3.990.0",
+    "@smithy/node-http-handler": "4.4.10",
+    "axios": "1.13.5",
+    "winston": "3.19.0",
     "winston-transport": "4.9.0"
   },
   "devDependencies": {
-    "@eslint/js": "9.35.0",
+    "@eslint/js": "9.39.2",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
     "@mimik/request-helper": "^2.0.2",
-    "@stylistic/eslint-plugin": "5.3.1",
-    "body-parser": "2.2.0",
+    "@stylistic/eslint-plugin": "5.8.0",
+    "aws-sdk-client-mock": "4.1.0",
     "c8": "10.1.3",
-    "chai": "6.0.1",
-    "eslint": "9.35.0",
+    "chai": "6.2.2",
+    "eslint": "9.39.2",
     "eslint-plugin-import": "2.32.0",
-    "express": "5.1.0",
+    "express": "5.2.1",
+    "globals": "17.3.0",
     "husky": "9.1.7",
-    "jsdoc-to-markdown": "9.1.2",
-    "mocha": "11.7.2",
+    "jsdoc-to-markdown": "9.1.3",
+    "mocha": "11.7.5",
     "mochawesome": "7.1.4",
-    "sinon": "21.0.0",
-    "supertest": "7.1.4"
+    "sinon": "21.0.1"
   }
 }