@mimik/sumologic-winston-logger 1.6.22 → 2.0.0

package/test/logger.spec.js

@@ -1,71 +1,22 @@
-const chai = require('chai');
-const sinon = require('sinon');
-// const assert = require('assert');
-
-const { getCorrelationId } = require('@mimik/request-helper');
-
-require('./testEnv');
-const logger = require('../index');
-
-delete require.cache[require.resolve('../index')];
-delete require.cache[require.resolve('../configuration/config')];
-
-require('./testEnvProdFilter');
-const loggerProd = require('../index');
+import './testEnv.js';
+import { before, describe, it } from 'mocha';
+import { getCorrelationId } from '@mimik/request-helper';
+import logger from '../index.js';
+import process from 'process';
+import { setTimeout } from 'timers';
+import { should } from 'chai';
+import { stub } from 'sinon';
+
+const START_TIMEOUT = 30000;
+const FLUSH_TIMEOUT = 1000;
+const OK_EXIT = 0;
 
 const correlationId = getCorrelationId('--sumologic-winston-logger-test--');
 
-const user = {
-  externalIds: [
-    '2584799985283928064',
-  ],
-  appIds: [],
-  _id: '5d28b615a97b3605636a9e17',
-  id: '2584799985283928064',
-  email: 'lauraawarr+mimik5@gmail.com',
-  attributes: [{
-    name: 'nickname',
-    value: 'User 5',
-  }],
-  references: [{
-    serverType: 'mFD',
-    resourceName: 'requestFriendLists',
-    include: 'requestFriends',
-    id: '2584799985283928064',
-    self: 'https://mfd.mimik360.com/mFD/v1/requestFriendLists/2584799985283928064',
-  },
-  {
-    serverType: 'mFD',
-    resourceName: 'friendRequestLists',
-    include: 'friendRequests',
-    id: '2584799985283928064',
-    self: 'https://mfd.mimik360.com/mFD/v1/friendRequestLists/2584799985283928064',
-  },
-  {
-    serverType: 'mFD',
-    resourceName: 'friendLists',
-    include: 'friends',
-    id: '2584799985283928064',
-    self: 'https://mfd.mimik360.com/mFD/v1/friendLists/2584799985283928064',
-  },
-  {
-    serverType: 'mDS',
-    resourceName: 'nodes',
-    include: 'devices',
-    id: '2584799985283928064',
-    self: 'https://mds.mimik360.com/mDS/v1/nodes?accountId=2584799985283928064',
-  }],
-  createdAt: '2019-07-12T16:32:21.709Z',
-  self: 'https://mpo.mimik360.com/mPO/v1/users/2584799985283928064',
-  __v: 1,
-  avatar: 'https://mts.mimik360.com/mTS/v1/thumbnails/9a86220f-9d76-48e4-98a3-1a51c22fc49a',
-  updatedAt: '2019-07-12T16:35:39.195Z',
-};
-
-chai.should();
+should();
 
-describe('sumologic-winston-logger Unit Tests', function loggerTests() {
-  this.timeout(30000);
+describe('sumologic-winston-logger Unit Tests', function LoggerTests() {
+  this.timeout(START_TIMEOUT);
   it('Can log an debug message without a correlationId and info', (done) => {
     logger.debug('this is an debug statement');
     done();
@@ -94,25 +45,17 @@ describe('sumologic-winston-logger Unit Tests', function loggerTests() {
     logger.debug('this is a debug statement');
     done();
   });
-  it('Changing the environment to prod to cover filters', (done) => {
-    loggerProd.info('this is an info statement on prod', { meta: 'data' });
-    done();
-  });
-  it('Changing the environment to prod to cover filters and see filtered result', (done) => {
-    loggerProd.info('this is an info statement on prod', { user }, correlationId);
-    done();
-  });
-  it('Can log a debug statement without correlationId and info on production', (done) => {
-    loggerProd.debug('this is a debug statement');
+  it('can flush logs', (done) => {
+    logger.flush();
     done();
   });
   it('Can flush and exit', (done) => {
     logger.debug('this is a debug statement');
-    sinon.stub(process, 'exit');
-    logger.flushAndExit(0);
+    stub(process, 'exit');
+    logger.flushAndExit(OK_EXIT);
     done();
   });
-  before((done) => setTimeout(done, 1000)); // adding a delay to make usre that the fush is done
+  before(done => setTimeout(done, FLUSH_TIMEOUT)); // adding a delay to make sure that the fush is done
   it('Cleanup', (done) => {
     process.exit.restore();
     done();

package/test/loggerProd.spec.js

@@ -0,0 +1,90 @@
+import './testEnvProdFilter.js';
+import { before, describe, it } from 'mocha';
+import { getCorrelationId } from '@mimik/request-helper';
+import logger from '../index.js';
+import process from 'process';
+import { setTimeout } from 'timers';
+import { should } from 'chai';
+import { stub } from 'sinon';
+
+const START_TIMEOUT = 30000;
+const FLUSH_TIMEOUT = 1000;
+const OK_EXIT = 0;
+
+const correlationId = getCorrelationId('--sumologic-winston-logger-prod-test--');
+
+const user = {
+  __v: 1,
+  _id: '5d28b615a97b3605636a9e17',
+  appIds: [],
+  attributes: [{
+    name: 'nickname',
+    value: 'User 5',
+  }],
+  avatar: 'https://mts.mimik360.com/mTS/v1/thumbnails/9a86220f-9d76-48e4-98a3-1a51c22fc49a',
+  createdAt: '2019-07-12T16:32:21.709Z',
+  email: 'lauraawarr+mimik5@gmail.com',
+  externalIds: [
+    '2584799985283928064',
+  ],
+  id: '2584799985283928064',
+  references: [{
+    serverType: 'mFD',
+    resourceName: 'requestFriendLists',
+    include: 'requestFriends',
+    id: '2584799985283928064',
+    self: 'https://mfd.mimik360.com/mFD/v1/requestFriendLists/2584799985283928064',
+  },
+  {
+    serverType: 'mFD',
+    resourceName: 'friendRequestLists',
+    include: 'friendRequests',
+    id: '2584799985283928064',
+    self: 'https://mfd.mimik360.com/mFD/v1/friendRequestLists/2584799985283928064',
+  },
+  {
+    serverType: 'mFD',
+    resourceName: 'friendLists',
+    include: 'friends',
+    id: '2584799985283928064',
+    self: 'https://mfd.mimik360.com/mFD/v1/friendLists/2584799985283928064',
+  },
+  {
+    serverType: 'mDS',
+    resourceName: 'nodes',
+    include: 'devices',
+    id: '2584799985283928064',
+    self: 'https://mds.mimik360.com/mDS/v1/nodes?accountId=2584799985283928064',
+  }],
+  self: 'https://mpo.mimik360.com/mPO/v1/users/2584799985283928064',
+  updatedAt: '2019-07-12T16:35:39.195Z',
+};
+
+should();
+
+describe('sumologic-winston-logger prod Unit Tests', function LoggerTests() {
+  this.timeout(START_TIMEOUT);
+  it('Changing the environment to prod to cover filters', (done) => {
+    logger.info('this is an info statement on prod', { meta: 'data' });
+    done();
+  });
+  it('Changing the environment to prod to cover filters and see filtered result', (done) => {
+    logger.info('this is an info statement on prod', { user }, correlationId);
+    done();
+  });
+  it('Can log a debug statement without correlationId and info on production', (done) => {
+    logger.debug('this is a debug statement');
+    done();
+  });
+  it('Can flush and exit', (done) => {
+    logger.debug('this is a debug statement');
+    stub(process, 'exit');
+    logger.flushAndExit(OK_EXIT);
+    done();
+  });
+  before(done => setTimeout(done, FLUSH_TIMEOUT)); // adding a delay to make sure that the fush is done
+  it('Cleanup', (done) => {
+    process.exit.restore();
+    done();
+  });
+});

package/test/testEnv.js

@@ -1,5 +1,6 @@
 /* eslint no-process-env: "off" */
 
+import process from 'process';
 /**
  *
  * Test logger Configuration.
@@ -55,7 +56,7 @@ process.env.KINESIS_AWS_STREAM_NAME_OTHER = 'a kinesis stream name for other';
 // process.env.KINESIS_AWS_TIMEOUT = 10;
 // process.env.KINESIS_AWS_MAX_SIZE = 1;
 process.env.EXIT_DELAY = 1;
-process.env.LOG_MODE = 'sumologic';
+process.env.LOG_MODE = 'all';
 // process.env.LOG_MODE = 'awsS3';
 // process.env.LOG_MODE = 'awsS3, sumologic, awsKinesis';
 // process.env.LOG_MODE = 'all';

package/test/testEnvProdFilter.js

@@ -1,5 +1,6 @@
 /* eslint no-process-env: "off" */
 
+import process from 'process';
 /**
  *
  * Test logger prod with filter Configuration.
@@ -14,10 +15,16 @@
  * | FILTER_FILE | filename containing filter rules
  * | NO_STACK | indicatior to log th stack on all log message
  * | LOG_MODE | loge mode for the running instance
+ * | SUMO_LOGIC_ENDPOINT | url of the sumologic collector
+ * | SUMO_LOGIC_COLLECTOR_CODE | code of the sumologic collector
  */
+// process.env.SUMO_LOGIC_ENDPOINT = 'http://localhost:9080/logs/';
+// process.env.SUMO_LOGIC_COLLECTOR_CODE = '1234';
+process.env.SUMO_LOGIC_ENDPOINT = 'https://a sumologic endpoint url';
+process.env.SUMO_LOGIC_COLLECTOR_CODE = 'a sumologic collector code';
 process.env.NODE_ENV = 'prod';
 process.env.FILTER_FILE = './test/filterConfig.json';
 process.env.NO_STACK = 'yes';
-process.env.LOG_MODE = 'sumologic';
+process.env.LOG_MODE = 'none';
 process.env.CONSOLE_LEVEL = 'debug';
 process.env.LOG_LEVEL = 'debug';

package/.eslintrc

@@ -1,43 +0,0 @@
-{
-  "plugins": [
-    "@mimik/document-env",
-    "@mimik/dependencies"
-  ],
-  "env": {
-    "node": true
-  },
-  "parserOptions": {
-    "ecmaVersion": 2020
-  },
-  "extends": "airbnb",
-  "rules": {
-    "import/no-extraneous-dependencies": ["error", {"devDependencies": true}],
-    "import/no-unresolved": ["error", { "amd": true, "commonjs": true, "caseSensitiveStrict": true }],
-    "brace-style": [1, "stroustrup", {"allowSingleLine": true}],
-    "no-confusing-arrow": [0], // arrow isnt confusing
-    "max-len": [1, 180, { "ignoreComments": true }],
-    "linebreak-style": 0,
-    "quotes": [1, "single"],
-    "semi": [1, "always"],
-    "no-process-env": ["error"],
-    "@mimik/document-env/validate-document-env": 2,
-    "@mimik/dependencies/case-sensitive": 2,
-    "@mimik/dependencies/no-cycles": 2,
-    "@mimik/dependencies/require-json-ext": 2
-  },
-  "settings":{
-    "react": {
-      "version": "detect"
-    }
-  },
-  "globals": {
-    "module": true,
-    "require": true,
-    "const": false,
-    "it": false,
-    "describe": false,
-    "before": true,
-    "after": true,
-    "JSON": true
-  }
-}