@mimik/sumologic-winston-logger 1.6.15 → 1.6.17

package/configuration/config.js

@@ -1,6 +1,10 @@
 /* eslint no-process-env: "off" */
-const _ = require('lodash');
 const fs = require('fs');
+const isUndefined = require('lodash.isundefined');
+const isNil = require('lodash.isnil');
+const trim = require('lodash.trim');
+const split = require('lodash.split');
+const difference = require('lodash.difference');
 
 /**
  *
@@ -91,7 +95,7 @@ const checkConfig = (config) => {
       if (typeof node[prop] === 'object' && node[prop]) {
         traverseNodeSync(node[prop], `${path}.${prop}`);
       }
-      else if (_.isUndefined(node[prop])) errs.push(`${path}.${prop}`);
+      else if (isUndefined(node[prop])) errs.push(`${path}.${prop}`);
     });
   }
 
@@ -105,9 +109,9 @@ const checkMode = (mode) => {
   let logMode = null;
 
   if (mode) {
-    logMode = _.split(_.trim(mode), /\s*,\s*/);
+    logMode = split(trim(mode), /\s*,\s*/);
     if (logMode.length === 0) throw new Error('Invalid LOG_MODE: cannot be an empty array');
-    if (_.difference(logMode, ALL_MODES).length !== 0) throw new Error(`Invalid items in LOG_MODE: ${mode}`);
+    if (difference(logMode, ALL_MODES).length !== 0) throw new Error(`Invalid items in LOG_MODE: ${mode}`);
     if (logMode.includes(NONE) && logMode.length !== 1) throw new Error(`Cannot have multiple modes when ${NONE} is selected`);
     if (logMode.includes(ALL)) logMode = [SUMOLOGIC, AWS_S3]; // legacy support
   }
@@ -149,8 +153,8 @@ if (configuration.mode.includes(AWS_KINESIS)) {
     maxEvents: parseInt(process.env.KINESIS_AWS_MAX_EVENTS, 10) || DEFAULT_KINESIS_MAX_EVENTS,
   };
 
-  if (!_.isNil(process.env.KINESIS_AWS_ACCESS_KEY_ID)) configuration[AWS_KINESIS].accessKeyId = process.env.KINESIS_AWS_ACCESS_KEY_ID;
-  if (!_.isNil(process.env.KINESIS_AWS_SECRET_ACCESS_KEY)) configuration[AWS_KINESIS].secretAccessKey = process.env.KINESIS_AWS_SECRET_ACCESS_KEY;
+  if (!isNil(process.env.KINESIS_AWS_ACCESS_KEY_ID)) configuration[AWS_KINESIS].accessKeyId = process.env.KINESIS_AWS_ACCESS_KEY_ID;
+  if (!isNil(process.env.KINESIS_AWS_SECRET_ACCESS_KEY)) configuration[AWS_KINESIS].secretAccessKey = process.env.KINESIS_AWS_SECRET_ACCESS_KEY;
 }
 if (configuration.mode.includes(AWS_S3)) {
   configuration[AWS_S3] = {
@@ -161,8 +165,8 @@ if (configuration.mode.includes(AWS_S3)) {
     maxEvents: parseInt(process.env.S3_AWS_MAX_EVENTS, 10) || DEFAULT_S3_MAX_EVENTS,
   };
 
-  if (!_.isNil(process.env.S3_AWS_ACCESS_KEY_ID)) configuration[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
-  if (!_.isNil(process.env.S3_AWS_SECRET_ACCESS_KEY)) configuration[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
+  if (!isNil(process.env.S3_AWS_ACCESS_KEY_ID)) configuration[AWS_S3].accessKeyId = process.env.S3_AWS_ACCESS_KEY_ID;
+  if (!isNil(process.env.S3_AWS_SECRET_ACCESS_KEY)) configuration[AWS_S3].secretAccessKey = process.env.S3_AWS_SECRET_ACCESS_KEY;
 }
 const { filter } = configuration;
 let filterConfig = [];

package/index.js

@@ -18,6 +18,7 @@ const {
   WARN,
   // LOG,
   FLUSH,
+  FLUSH_EXIT,
 } = require('./lib/common');
 
 let sumo;
@@ -108,17 +109,54 @@ logger.flushAndExit = (code) => {
 
     if (config.mode.includes(NONE)) return process.exit(code);
     if (awsS3) {
-      awsS3.flush();
-      awsS3.on(FLUSH, () => {
+      awsS3.flush(FLUSH_EXIT);
+      awsS3.on(FLUSH_EXIT, () => {
         if ((!sumo || sumoDone) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
         awsS3Done = true;
         return null;
       });
     }
+    if (sumo) {
+      sumo.flush(FLUSH_EXIT);
+      sumo.on(FLUSH_EXIT, () => {
+        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
+        sumoDone = true;
+        return null;
+      });
+    }
+    if (awsKinesis) {
+      awsKinesis.flush(FLUSH_EXIT);
+      awsKinesis.on(FLUSH_EXIT, () => {
+        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return process.exit(code);
+        awsKinesisDone = true;
+        return null;
+      });
+    }
+    return null;
+  };
+
+  setTimeout(flushing, config.exitDelay);
+};
+
+logger.flush = () => {
+  const flushing = () => {
+    let sumoDone = false;
+    let awsS3Done = false;
+    let awsKinesisDone = false;
+
+    if (config.mode.includes(NONE)) return null;
+    if (awsS3) {
+      awsS3.flush(FLUSH);
+      awsS3.on(FLUSH, () => {
+        if ((!sumo || sumoDone) && (!awsKinesis || awsKinesisDone)) return null;
+        awsS3Done = true;
+        return null;
+      });
+    }
     if (sumo) {
       sumo.flush();
       sumo.on(FLUSH, () => {
-        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return process.exit(code);
+        if ((!awsS3 || awsS3Done) && (!awsKinesis || awsKinesisDone)) return null;
         sumoDone = true;
         return null;
       });
@@ -126,7 +164,7 @@ logger.flushAndExit = (code) => {
     if (awsKinesis) {
       awsKinesis.flush();
       awsKinesis.on(FLUSH, () => {
-        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return process.exit(code);
+        if ((!awsS3 || awsS3Done) && (!sumo || sumoDone)) return null;
         awsKinesisDone = true;
         return null;
       });

package/lib/awsKinesisTransport.js

@@ -1,15 +1,11 @@
 const Transport = require('winston-transport');
 const Promise = require('bluebird');
-const AWS = require('aws-sdk');
-
-AWS.config.setPromisesDependency(Promise);
+const { KinesisClient, PutRecordsCommand } = require('@aws-sdk/client-kinesis');
 
 const {
-  KINESIS_AWS_API_VERSION,
   AWS_KINESIS,
   LOG,
   WARN,
-  FLUSH,
   MESSAGE,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
@@ -40,11 +36,12 @@ module.exports = class AwsKinesis extends Transport {
     this.streamNameInfo = options.streamNameInfo;
     this.streamNameError = options.streamNameError;
     this.streamNameOther = options.streamNameOther;
-    this.kinesis = new AWS.Kinesis({
-      apiVersion: KINESIS_AWS_API_VERSION,
+    this.kinesis = new KinesisClient({
       region: options.region,
-      accessKeyId: options.accessKeyId,
-      secretAccessKey: options.secretAccessKey,
+      credentials: {
+        accessKeyId: options.accessKeyId,
+        secretAccessKey: options.secretAccessKey,
+      },
     });
     this.time = setInterval(() => {
       Object.keys(events).forEach((level) => {
@@ -63,10 +60,12 @@ module.exports = class AwsKinesis extends Transport {
     if (lvl === INFO) StreamName = this.streamNameInfo;
     else if (lvl === ERROR) StreamName = this.streamNameError;
     else StreamName = this.streamNameOther;
-    return this.kinesis.putRecords({
+    const command = new PutRecordsCommand({
       StreamName,
       Records,
-    }).promise();
+    });
+
+    return this.kinesis.send(command);
   }
 
   send(Records, lvl) {
@@ -94,7 +93,8 @@ module.exports = class AwsKinesis extends Transport {
           }));
       }
       return Promise.resolve();
-    });
+    })
+      .then(() => this.emit(LOG, { message: `logs sent to ${AWS_KINESIS}` }));
   }
 
   log(info, callback) {
@@ -133,8 +133,8 @@ module.exports = class AwsKinesis extends Transport {
     }
   }
 
-  flush() {
+  flush(type) {
     return this.flushEvent()
-      .then(() => this.emit(FLUSH, { message: `logs flushed to ${AWS_KINESIS}` }));
+      .then(() => this.emit(type, { message: `logs ${type} to ${AWS_KINESIS}` }));
   }
 };

package/lib/awsS3Transport.js

@@ -1,15 +1,11 @@
 const Transport = require('winston-transport');
 const Promise = require('bluebird');
-const AWS = require('aws-sdk');
-
-AWS.config.setPromisesDependency(Promise);
+const { S3Client, PutObjectCommand } = require('@aws-sdk/client-s3');
 
 const {
-  S3_AWS_API_VERSION,
   AWS_S3,
   LOG,
   WARN,
-  FLUSH,
   MESSAGE,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
@@ -30,11 +26,12 @@ module.exports = class AwsS3 extends Transport {
     this.maxEvents = options.maxEvents;
     this.timeInterval = 1000 * 60 * options.timeout; // in minutes
     this.bucketname = options.bucketname;
-    this.s3 = new AWS.S3({
-      apiVersion: S3_AWS_API_VERSION,
+    this.s3 = new S3Client({
       region: options.region,
-      accessKeyId: options.accessKeyId,
-      secretAccessKey: options.secretAccessKey,
+      credentials: {
+        accessKeyId: options.accessKeyId,
+        secretAccessKey: options.secretAccessKey,
+      },
     });
     this.time = setInterval(() => {
       Object.keys(events).forEach((level) => {
@@ -56,11 +53,13 @@ module.exports = class AwsS3 extends Transport {
   }
 
   put(data, lvl, date) {
-    return this.s3.putObject({
+    const command = new PutObjectCommand({
       Bucket: this.bucketname,
       Key: `${lvl}/${this.server}/${date.getFullYear()}/${date.getMonth() + 1}/${date.getDate()}/${date.toISOString()}.json`,
       Body: JSON.stringify(data),
-    }).promise();
+    });
+
+    return this.s3.send(command);
   }
 
   send(data, lvl, date) {
@@ -77,18 +76,22 @@ module.exports = class AwsS3 extends Transport {
     const errors = [];
     let count = 0;
 
-    return Promise.map(Object.keys(data), (sType) => Promise.each(Object.keys(data[sType]), (sId) => this.s3.putObject({
-      Bucket: this.bucketname,
-      Key: `${lvl}/${sType}/${sId}/${date.getFullYear()}/${date.getMonth() + 1}/${date.getDate()}/${date.toISOString()}.json`,
-      Body: JSON.stringify(data[sType][sId]),
-    }).promise()
-      .then(() => {
-        count += 1;
-      })
-      .catch((err) => errors.push({
-        data: data[sType][sId],
-        error: { message: err.message, statusCode: err.statusCode || 500, details: err },
-      }))))
+    return Promise.map(Object.keys(data), (sType) => Promise.each(Object.keys(data[sType]), (sId) => {
+      const command = new PutObjectCommand({
+        Bucket: this.bucketname,
+        Key: `${lvl}/${sType}/${sId}/${date.getFullYear()}/${date.getMonth() + 1}/${date.getDate()}/${date.toISOString()}.json`,
+        Body: JSON.stringify(data[sType][sId]),
+      });
+
+      return this.s3.send(command)
+        .then(() => {
+          count += 1;
+        })
+        .catch((err) => errors.push({
+          data: data[sType][sId],
+          error: { message: err.message, statusCode: err.statusCode || 500, details: err },
+        }));
+    }))
       .then(() => ({ count, errors }));
   }
 
@@ -127,7 +130,8 @@ module.exports = class AwsS3 extends Transport {
           .catch((err) => this.emit(WARN, { error: err.message, message: `could not log to ${AWS_S3}` }));
       }
       return Promise.resolve();
-    });
+    })
+      .then(() => this.emit(LOG, { message: `logs sent to ${AWS_S3}` }));
   }
 
   flushTypeEvent() {
@@ -224,9 +228,9 @@ module.exports = class AwsS3 extends Transport {
     }
   }
 
-  flush() {
+  flush(type) {
     return this.flushEvent()
       .then(() => this.flushTypeEvent())
-      .then(() => this.emit(FLUSH, { message: `logs flushed to ${AWS_S3}` }));
+      .then(() => this.emit(type, { message: `logs ${type} to ${AWS_S3}` }));
   }
 };

package/lib/common.js

@@ -13,8 +13,6 @@ const AWS_KINESIS = 'awsKinesis';
 const DEFAULT_MODE = [NONE];
 const ALL_MODES = [AWS_S3, SUMOLOGIC, AWS_KINESIS, ALL, NONE];
 
-const S3_AWS_API_VERSION = '2006-03-01';
-const KINESIS_AWS_API_VERSION = '2013-12-02';
 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
 const DEFAULT_S3_TIMEOUT = 5; // max time before sending events to S3, in minutes
@@ -32,6 +30,7 @@ const MESSAGE = Symbol.for('message');
 const WARN = 'warn';
 const LOG = 'logged';
 const FLUSH = 'flushed';
+const FLUSH_EXIT = 'flushed and exit';
 
 const UNKNOWN_TYPE = 'unknownServerType';
 const UNKNOWN_ID = 'unknownServerId';
@@ -55,8 +54,6 @@ module.exports = {
   ALL_MODES,
   ENV_DEV,
   ENV_LOCAL,
-  S3_AWS_API_VERSION,
-  KINESIS_AWS_API_VERSION,
   DEFAULT_S3_MAX_SIZE,
   DEFAULT_S3_MAX_EVENTS,
   DEFAULT_S3_TIMEOUT,
@@ -71,6 +68,7 @@ module.exports = {
   WARN,
   LOG,
   FLUSH,
+  FLUSH_EXIT,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
   CLIENTS,

package/lib/formatLib.js

@@ -1,5 +1,8 @@
 const { format } = require('winston');
-const _ = require('lodash');
+const forEach = require('lodash.foreach');
+const isObject = require('lodash.isobject');
+const isString = require('lodash.isstring');
+const isNil = require('lodash.isnil');
 
 const { logs, isProd } = require('@mimik/lib-filters');
 
@@ -41,7 +44,7 @@ const correlationId = format((origInfo) => {
   const info = origInfo;
   const meta = info[SPLAT];
 
-  if (meta && _.isString(meta[meta.length - 1])) {
+  if (meta && isString(meta[meta.length - 1])) {
     const results = meta[meta.length - 1].split('/');
 
     ([info.correlationId, info.requestedAt] = results);
@@ -63,14 +66,14 @@ const errorStack = format((origInfo) => {
   let newValue;
   let prop;
 
-  _.forEach(meta, (item) => {
-    if (_.isObject(item)) {
+  forEach(meta, (item) => {
+    if (isObject(item)) {
       target = item;
       return false;
     }
     return true;
   });
-  _.forEach(target, (origValue, key) => {
+  forEach(target, (origValue, key) => {
     let value = origValue;
 
     if (value instanceof Error) {
@@ -96,8 +99,8 @@ const filterMeta = format((origInfo, opts) => {
   let target;
   let index;
 
-  _.forEach(meta, (origItem, i) => {
-    if (!_.isObject(origItem)) return true;
+  forEach(meta, (origItem, i) => {
+    if (!isObject(origItem)) return true;
     let item = origItem;
 
     // in order to vaoid having the do it for in the rest of the code for mongoose objects
@@ -115,9 +118,9 @@ const filterMeta = format((origInfo, opts) => {
     index = i;
     return false;
   });
-  if (_.isNil(index)) return info;
+  if (isNil(index)) return info;
   meta[index] = target;
-  _.forEach(target, (value, key) => {
+  forEach(target, (value, key) => {
     if (info[key] && !isReserved(key)) {
       info[key] = value;
     }

package/lib/stackLib.js

@@ -1,6 +1,7 @@
-const _ = require('lodash');
 const crypto = require('crypto');
 const path = require('path');
+const reject = require('lodash.reject');
+const trimStart = require('lodash.trimstart');
 
 // Stack trace format :
 // https://github.com/v8/v8/wiki/Stack%20Trace%20API
@@ -16,7 +17,7 @@ const parseStack = (newError) => {
   const stackList = newError.stack.split('\n').slice(1);
   // 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];
@@ -29,7 +30,7 @@ const parseStack = (newError) => {
     line: stackParts[3],
     pos: stackParts[4],
     file: path.basename(stackParts[2]),
-    stack: `   ${_.trimStart(truncatedList.join('\n'))}`,
+    stack: `   ${trimStart(truncatedList.join('\n'))}`,
   };
   stackInfo.hash = crypto.createHash('sha256', SECRET)
     .update(stackInfo.stack)

package/lib/sumologicTransport.js

@@ -5,7 +5,6 @@ const {
   SUMOLOGIC,
   LOG,
   WARN,
-  FLUSH,
   UNKNOWN_TYPE,
   UNKNOWN_ID,
   CLIENTS,
@@ -67,7 +66,7 @@ module.exports = class Sumo extends Transport {
     if (callback) setImmediate(callback);
   }
 
-  flush() {
-    return Promise.resolve().then(() => this.emit(FLUSH, { message: `logs flushed to ${SUMOLOGIC}` }));
+  flush(type) {
+    return Promise.resolve().then(() => this.emit(type, { message: `logs ${type} to ${SUMOLOGIC}` }));
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "1.6.15",
+  "version": "1.6.17",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "index.js",
   "scripts": {
@@ -33,12 +33,22 @@
     "url": "https://bitbucket.org/mimiktech/sumologic-winston-logger"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^1.4.6",
-    "aws-sdk": "2.1343.0",
-    "axios": "1.3.4",
+    "@mimik/lib-filters": "^1.4.8",
+    "@aws-sdk/client-s3": "3.388.0",
+    "@aws-sdk/client-kinesis": "3.388.0",
+    "axios": "1.4.0",
     "bluebird": "3.7.2",
-    "lodash": "4.17.21",
-    "winston": "3.8.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": "",
+    "lodash.reject": "4.6.0",
+    "lodash.split": "4.4.2",
+    "lodash.trim": "4.5.1",
+    "lodash.trimstart": "4.5.1",
+    "winston": "3.10.0",
     "winston-transport": "4.5.0"
   },
   "devDependencies": {
@@ -47,19 +57,20 @@
     "@mimik/request-helper": "^1.7.8",
     "body-parser": "1.20.2",
     "chai": "4.3.7",
-    "eslint": "8.36.0",
+    "eslint": "8.47.0",
     "eslint-config-airbnb": "19.0.4",
-    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-import": "2.28.0",
     "eslint-plugin-jsx-a11y": "6.7.1",
-    "eslint-plugin-react": "7.32.2",
+    "eslint-plugin-react": "7.33.1",
     "eslint-plugin-react-hooks": "4.6.0",
     "express": "4.18.2",
     "husky": "8.0.3",
     "jsdoc-to-markdown": "8.0.0",
+    "lodash": "4.17.21",
     "mocha": "10.2.0",
     "mochawesome": "7.1.3",
     "nyc": "15.1.0",
-    "sinon": "15.0.3",
+    "sinon": "15.2.0",
     "supertest": "6.3.3"
   }
 }