@mimik/sumologic-winston-logger 2.1.10 → 2.1.11

package/eslint.config.js

@@ -30,10 +30,8 @@ export default [
       ecmaVersion: ECMA_VERSION,
       globals: {
         ...globals.nodeBuiltin,
-        console: 'readonly',
         describe: 'readonly',
         it: 'readonly',
-        require: 'readonly',
       },
       sourceType: 'module',
     },
@@ -41,6 +39,7 @@ export default [
       '@stylistic/brace-style': ['warn', 'stroustrup', { allowSingleLine: true }],
       '@stylistic/line-comment-position': ['off'],
       '@stylistic/max-len': ['warn', MAX_LENGTH_LINE, { ignoreComments: true, ignoreStrings: true, ignoreRegExpLiterals: true }],
+      '@stylistic/quotes': ['warn', 'single'],
       '@stylistic/semi': ['error', 'always'],
       'capitalized-comments': ['off'],
       'complexity': ['error', MAX_COMPLEXITY],
@@ -51,6 +50,7 @@ export default [
       'init-declarations': ['off'],
       'linebreak-style': ['off'],
       'max-depth': ['error', MAX_DEPTH],
+      '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 +63,7 @@ export default [
       'no-undefined': ['off'],
       'one-var': ['error', 'never'],
       'processDoc/validate-document-env': ['error'],
-      'quotes': ['warn', 'single'],
+      'quotes': 'off',
       'sort-imports': ['error', { allowSeparatedGroups: true }],
       'sort-keys': ['error', 'asc', { caseSensitive: true, minKeys: MIN_KEYS_IN_OBJECT, natural: false, allowLineSeparatedGroups: true }],
     },

package/lib/awsKinesisTransport.js

@@ -13,6 +13,7 @@ import {
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
+  safeStringify,
 } from './common.js';
 import {
   KinesisClient,
@@ -119,12 +120,11 @@ export default class AwsKinesis extends Transport {
   }
 
   log(info, callback) {
-    const messageInfo = info[MESSAGE];
-    const infoSize = messageInfo.length;
+    const infoSize = Buffer.byteLength(info[MESSAGE]);
     let { level } = info;
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = JSON.parse(messageInfo);
+    const data = { ...info };
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;
@@ -143,7 +143,7 @@ export default class AwsKinesis extends Transport {
       levelData = events[level];
     }
     levelData.size += infoSize;
-    levelData.Records.push({ Data: Buffer.from(JSON.stringify(data)), PartitionKey: `${PARTITION_KEY}-${randomInt(RANDOM_MIN, RANDOM_LIMIT)}` });
+    levelData.Records.push({ Data: Buffer.from(safeStringify(data)), PartitionKey: `${PARTITION_KEY}-${randomInt(RANDOM_MIN, RANDOM_LIMIT)}` });
     if (levelData.Records.length >= this.maxEvents || levelData.size >= this.maxSize) {
       this.send(levelData.Records, level);
       levelData.Records = [];

package/lib/awsS3Transport.js

@@ -9,6 +9,7 @@ import {
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
+  safeStringify,
 } from './common.js';
 import {
   PutObjectCommand,
@@ -179,12 +180,11 @@ export default class AwsS3 extends Transport {
   }
 
   log(info, callback) {
-    const messageInfo = info[MESSAGE];
-    const infoSize = messageInfo.length;
+    const infoSize = Buffer.byteLength(info[MESSAGE]);
     const { level } = info;
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = JSON.parse(messageInfo);
+    const data = { ...info };
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;
@@ -210,7 +210,7 @@ export default class AwsS3 extends Transport {
       }
       typeLevelData.size += infoSize;
       typeLevelData.nbEvents += 1;
-      serverData.push(data);
+      serverData.push(safeStringify(data));
       if (typeLevelData.nbEvents >= this.maxEvents || typeLevelData.size >= this.maxSize) {
         this.sendRemote(typeLevelData.data, level, new Date());
         typeLevelData.data = {};
@@ -228,7 +228,7 @@ export default class AwsS3 extends Transport {
         levelData = events[level];
       }
       levelData.size += infoSize;
-      levelData.data.push(data);
+      levelData.data.push(safeStringify(data));
       if (levelData.data.length >= this.maxEvents || levelData.size >= this.maxSize) {
         this.send(levelData.data, level, new Date());
         levelData.data = [];

package/lib/common.js

@@ -41,6 +41,18 @@ const OK_EXIT = 0;
 const MEGA = 1048576; // 2^20 conversion to mega
 const MILLI_MIN = 60000; // 1000*60 conversion to minute
 
+const safeStringify = (obj) => {
+  const seen = new WeakSet();
+
+  return JSON.stringify(obj, (key, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) return '[Circular]';
+      seen.add(value);
+    }
+    return value;
+  });
+};
+
 export {
   ALL_MODE,
   ALL_MODES,
@@ -75,4 +87,5 @@ export {
   UNKNOWN_TYPE,
   UNKNOWN_ID,
   WARN,
+  safeStringify,
 };

package/lib/sumologicTransport.js

@@ -9,10 +9,10 @@ import {
   UNKNOWN_ID,
   UNKNOWN_TYPE,
   WARN,
+  safeStringify,
 } 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 {
@@ -28,7 +28,7 @@ export default class Sumo extends Transport {
   log(info, callback) {
     const { serverType } = globalThis;
     let { serverId } = globalThis;
-    const data = info;
+    const data = { ...info };
 
     if (serverType) {
       if (!serverId) serverId = `${UNKNOWN_ID}${CLIENTS}`;
@@ -42,7 +42,7 @@ export default class Sumo extends Transport {
     axios({
       method: 'POST',
       url: `${this.endpoint}${this.code}`,
-      data: inspect(data, { depth: null, compact: false }),
+      data: safeStringify(data),
     })
       .then(() => this.emit(LOG, { message: `logs sent to ${SUMOLOGIC}` }))
       .catch((err) => {

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@mimik/sumologic-winston-logger",
-  "version": "2.1.10",
+  "version": "2.1.11",
   "description": "Log wrapper for sumo, s3, kinesis and winston",
   "main": "./index.js",
   "type": "module",
+  "exports": "./index.js",
   "engines": {
     "node": ">=24.0.0"
   },
@@ -15,12 +16,6 @@
     "prepublishOnly": "npm run docs && npm run lint && npm run test-ci",
     "commit-ready": "npm run docs && npm run lint && npm run test-ci"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "npm run commit-ready",
-      "pre-push": "npm run test"
-    }
-  },
   "keywords": [
     "log",
     "logging",
@@ -36,9 +31,9 @@
     "url": "https://bitbucket.org/mimiktech/sumologic-winston-logger"
   },
   "dependencies": {
-    "@mimik/lib-filters": "^2.0.5",
-    "@aws-sdk/client-s3": "3.990.0",
-    "@aws-sdk/client-kinesis": "3.990.0",
+    "@mimik/lib-filters": "^2.0.6",
+    "@aws-sdk/client-s3": "3.993.0",
+    "@aws-sdk/client-kinesis": "3.993.0",
     "@smithy/node-http-handler": "4.4.10",
     "axios": "1.13.5",
     "winston": "3.19.0",
@@ -47,7 +42,7 @@
   "devDependencies": {
     "@eslint/js": "9.39.2",
     "@mimik/eslint-plugin-document-env": "^2.0.8",
-    "@mimik/request-helper": "^2.0.2",
+    "@mimik/request-helper": "^2.0.3",
     "@stylistic/eslint-plugin": "5.8.0",
     "aws-sdk-client-mock": "4.1.0",
     "c8": "10.1.3",

package/test/logger.spec.js

@@ -248,8 +248,8 @@ describe('S3 transport', function S3Tests() {
       calls.length.should.be.greaterThan(0);
       const payload = JSON.parse(calls[0].args[0].input.Body);
       payload.should.be.an('array').with.lengthOf(1);
-      payload[0].should.have.property('message');
-      payload[0].should.have.property('serverType', 'mTest');
+      JSON.parse(payload[0]).should.have.property('message');
+      JSON.parse(payload[0]).should.have.property('serverType', 'mTest');
       done();
     }, TEST_DELAY);
   });
@@ -261,7 +261,7 @@ describe('S3 transport', function S3Tests() {
       calls.length.should.be.greaterThan(0);
       const payload = JSON.parse(calls[0].args[0].input.Body);
       payload.should.be.an('array').with.lengthOf(1);
-      payload[0].should.have.property('correlationId');
+      JSON.parse(payload[0]).should.have.property('correlationId');
       done();
     }, TEST_DELAY);
   });
@@ -299,8 +299,8 @@ describe('S3 remote transport', function S3RemoteTests() {
       calls.length.should.be.greaterThan(0);
       const payload = JSON.parse(calls[0].args[0].input.Body);
       payload.should.be.an('array');
-      payload[0].should.have.property('serverType', 'mTestRemote');
-      payload[0].should.have.property('serverId', 'remoteServerId');
+      JSON.parse(payload[0]).should.have.property('serverType', 'mTestRemote');
+      JSON.parse(payload[0]).should.have.property('serverId', 'remoteServerId');
       done();
     }, TEST_DELAY);
   });
@@ -441,6 +441,28 @@ describe('S3 transport error handling', function S3ErrorTests() {
   });
 });
 
+describe('Circular reference handling', function CircularTests() {
+  this.timeout(START_TIMEOUT);
+  beforeEach(() => {
+    s3Mock.resetHistory();
+    kinesisMock.resetHistory();
+  });
+
+  it('handles logging objects with circular references', (done) => {
+    const circular = { name: 'test' };
+    circular.self = circular;
+    logger.info('test circular reference', circular);
+    setTimeout(() => {
+      const s3Calls = s3Mock.commandCalls(PutObjectCommand);
+      s3Calls.length.should.be.greaterThan(0);
+      const payload = JSON.parse(s3Calls[0].args[0].input.Body);
+      payload.should.be.an('array');
+      JSON.parse(payload[0]).should.have.property('message');
+      done();
+    }, TEST_DELAY);
+  });
+});
+
 describe('Kinesis transport', function KinesisTests() {
   this.timeout(START_TIMEOUT);
   beforeEach(() => kinesisMock.resetHistory());

package/.nycrc

@@ -1,4 +0,0 @@
-{
-  "exclude": ["gulpfile.js"],
-  "reporter": ["lcov", "text"]
-}