ac-logger 2.3.1 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,40 @@
+<a name="3.0.0"></a>
+ 
+# [3.0.0](https://github.com/admiralcloud/ac-logger/compare/v2.3.2..v3.0.0) (2024-08-09 15:08:00)
+
+
+### Bug Fix
+
+* **App:** Add colorization based on statusCode | MP | [e7d87144520ae667dce9e25b0a8c672dadacddc8](https://github.com/admiralcloud/ac-logger/commit/e7d87144520ae667dce9e25b0a8c672dadacddc8)    
+Add colorization based on statusCode  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Style
+
+* **App:** Lint fix | MP | [4c4c1edaecd3f94acf688fabdd78687212a12b31](https://github.com/admiralcloud/ac-logger/commit/4c4c1edaecd3f94acf688fabdd78687212a12b31)    
+Lint fix  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [a2b6d3244a9db6cdd2af978fc15a0d5cfec4408d](https://github.com/admiralcloud/ac-logger/commit/a2b6d3244a9db6cdd2af978fc15a0d5cfec4408d)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+## BREAKING CHANGES
+* **App:** Minimum Node version 18
+<a name="2.3.2"></a>
+
+## [2.3.2](https://github.com/admiralcloud/ac-logger/compare/v2.3.1..v2.3.2) (2024-05-08 15:32:14)
+
+
+### Bug Fix
+
+* **App:** Added option to change logLevel during runtime | MP | [1e59bed4b7d56dff95584fdf528f4dd931e3e6a2](https://github.com/admiralcloud/ac-logger/commit/1e59bed4b7d56dff95584fdf528f4dd931e3e6a2)    
+It is now possible to change loglevel after init  
+Related issues: [undefined/undefined#master](undefined/browse/master)
+### Chores
+
+* **App:** Updated packages | MP | [af832d3e7cb148e625b0bcd0756d69044bcb812d](https://github.com/admiralcloud/ac-logger/commit/af832d3e7cb148e625b0bcd0756d69044bcb812d)    
+Updated packages  
+Related issues: [undefined/undefined#master](undefined/browse/master)
 <a name="2.3.1"></a>
 
 ## [2.3.1](https://github.com/admiralcloud/ac-logger/compare/v2.3.0..v2.3.1) (2024-03-10 12:31:44)

package/eslint.config.js

@@ -0,0 +1,32 @@
+const globals = require('globals')
+
+module.exports = {
+  ignores: [
+    'config/env/**'
+  ],
+  languageOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+    globals: {
+      ...globals.commonjs,
+      ...globals.es2015,
+      ...globals.node,
+      expect: 'readonly',
+      describe: 'readonly',
+      it: 'readonly'
+    }
+  },
+  rules: {
+    'no-const-assign': 'error', // Ensure this rule is enabled
+    'space-before-function-paren': 'off',
+    'no-extra-semi': 'off',
+    'object-curly-spacing': ['error', 'always'],
+    'brace-style': ['error', 'stroustrup', { allowSingleLine: true }],
+    'no-useless-escape': 'off',
+    'standard/no-callback-literal': 'off',
+    'new-cap': 'off',
+    'no-console': ['warn', { allow: ['warn', 'error'] }],
+    "no-unused-vars": "error", // we shouldn't clutter code with unused variables
+    "prefer-const": ["warn", { "ignoreReadBeforeAssign": true }],
+  }
+}

package/index.js

@@ -26,10 +26,26 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
     // http log format
     if (level === 'http' && data?.controller) {
       // display accessKey, link (if applicable)
-      let message = data?.message ? ` ${data.message}` : ''
+      const message = data?.message ? ` ${data.message}` : ''
       let cuid = data?.customerId ? data?.customerId : ''
       if (data?.userId) cuid += `/${data.userId} `
-      return `${data?.timestamp} ${data?.level} ${data?.ip} ${data?.iso2 || ''} ${data?.accessKey || ''} ${cuid}${data?.controller} ${data?.action}${message} | ${data?.statusCode} | ${data?.performance?.executionTime}ms`
+      // colorize status codes
+
+      const statusCode = data?.statusCode
+      let displayStatusCode = (statusCode || ' ')
+      if (statusCode >= 500) {
+        displayStatusCode = `\x1B[35m${statusCode}\x1B[0m`
+      } 
+      else if (statusCode >= 400) {
+        displayStatusCode = `\x1B[31m${statusCode}\x1B[0m`
+      } 
+      else if (statusCode >= 300) {
+        displayStatusCode = `\x1B[33m${statusCode}\x1B[0m`
+      } 
+      else if (statusCode >= 200) {
+        displayStatusCode = `\x1B[32m${statusCode}\x1B[0m`
+      } 
+      return `${data?.timestamp} ${data?.level} ${data?.ip} ${data?.iso2 || ''} ${data?.accessKey || ''} ${cuid}${data?.controller} ${data?.action}${message} | ${displayStatusCode} | ${data?.performance?.executionTime}ms`
     }
     else {
       const meta = data?.meta
@@ -39,7 +55,7 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
       let subName = _.get(meta, 'sub') ? _.get(meta, 'sub') + ' | ' : _.get(data, 'sub') ? _.get(data, 'sub') + ' | ' : ''
       
       // modern approach (fileName, functionName, sub) // TBD with team
-      let functionIdentifier =  _.get(data, 'functionIdentifier') ? _.get(data, 'functionIdentifier') + ' | ' : ''
+      const functionIdentifier =  _.get(data, 'functionIdentifier') ? _.get(data, 'functionIdentifier') + ' | ' : ''
       if (!fileName && _.get(data, 'fileName')) fileName =  _.get(data, 'fileName')
       if (!functionName && _.get(data, 'functionName')) functionName =  _.get(data, 'functionName')
       if (!subName && _.get(data, 'sub')) subName =  _.get(data, 'sub')
@@ -48,8 +64,8 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
       let message = data?.message
 
   
-      let prefix = []
-      let dataFromPrefix = []
+      const prefix = []
+      const dataFromPrefix = []
       _.forEach(prefixFields, item => {
         if (_.get(meta, _.get(item, 'field'))) {
           prefix.push(_.get(item, 'short'))
@@ -91,6 +107,7 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
     // structured logging for analysis and querying within the CloudWatch service.
     if (applicationLogs?.enabled) {
       let filename = applicationLogs?.filename || 'application.log'
+      const symlinkName = filename
       if (filename.endsWith('.log')) {
         // If the filename ends with .log, insert -%DATE% before the extension
         filename = filename.replace(/\.log$/, '-%DATE%.log');
@@ -111,7 +128,9 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
           format.timestamp(),
           splatFormatter(),
           format.json()
-        )
+        ),
+        createSymlink: true, // Enable symlink creation
+        symlinkName: symlinkName // Fixed name for the current log file symlink
       })
 
       transport.on('error', error => {
@@ -144,7 +163,15 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
   const acLogger = createLogger(logConfig)
   if (_.get(customLevels, 'colors')) addColors(_.get(customLevels, 'colors'))
   
-
+    const changeLogLevel = (newLevel) => {
+      acLogger.transports.forEach((transport) => {
+        const currentLevel = transport.level || acLogger.level;  // Fallback to the logger's default level
+        if (currentLevel !== newLevel) {
+          console.warn(`Changing level of ${transport.name} from ${currentLevel} to ${newLevel}`);
+          transport.level = newLevel; // Confirm this line is executing
+        }
+      });
+    };
 
   const headline = (params) => {
     acLogger.info('')
@@ -228,6 +255,7 @@ module.exports = ({ prefixFields = [], timestampFormat = 'YYYY-MM-DD HH:mm:ss',
 
   return {
     acLogger,
+    changeLogLevel,
     headline,
     functionStartLine,
     listing,

package/package.json

@@ -3,19 +3,19 @@
   "author": "Mark Poepping (https://www.admiralcloud.com)",
   "license": "MIT",
   "repository": "admiralcloud/ac-logger",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "dependencies": {
     "lodash": "^4.17.21",
     "moment": "^2.30.1",
-    "winston": "^3.12.0",
+    "winston": "^3.14.1",
     "winston-daily-rotate-file": "^5.0.0"
   },
   "devDependencies": {
     "ac-semantic-release": "^0.4.2",
-    "chai": "^4.4.1",
-    "eslint": "^8.57.0",
+    "chai": "^4.5.0",
+    "eslint": "^9.8.0",
     "intercept-stdout": "^0.1.2",
-    "mocha": "^10.3.0",
+    "mocha": "^10.7.3",
     "mocha-jenkins-reporter": "^0.4.8"
   },
   "scripts": {
@@ -23,6 +23,9 @@
     "test-jenkins": "JUNIT_REPORT_PATH=./report.xml mocha --colors --reporter mocha-jenkins-reporter --reporter-options junit_report_name='ACLogger'"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
+  },
+  "resolutions": {
+    "mocha/chokidar/braces": "^3.0.3"
   }
 }

package/test/test.js

@@ -23,6 +23,30 @@ describe('Tests', () => {
     expect(lines[9]).to.contain('AppName')
     expect(lines[9]).to.contain('myApp')
   })
+  
+
+  it('Log info', () => {
+    captured_text = ''
+    const log = aclog().acLogger
+    log.info('Hello Info')
+    log.debug('Hello Debug')
+    const lines = captured_text.split('\n')
+    expect(lines[0]).to.contain('INFO')
+    expect(lines[1]).not.to.contain('DEBUG')
+  })
+
+  it('Log debug', () => {
+    const loggerSetup = aclog();
+    const log = loggerSetup.acLogger
+    loggerSetup.changeLogLevel('debug')
+    captured_text = ''
+    log.info('Hello Info')
+    log.debug('Hello Debug')
+    const lines = captured_text.split('\n')
+    expect(lines[0]).to.contain('INFO')
+    expect(lines[1]).to.contain('DEBUG')
+  })
+
 
   it('Unhook', () => {
     unhook_intercept()

package/.eslintrc.js

@@ -1,27 +0,0 @@
-const config = {
-  root: true,
-  'env': {
-    'commonjs': true,
-    'es2020': true,
-    'node': true
-  },
-  'extends': 'eslint:recommended',
-  "rules": {
-    "space-before-function-paren": 0,
-    "no-extra-semi": 0,
-    "object-curly-spacing": ["error", "always"],
-    "brace-style": ["error", "stroustrup", { "allowSingleLine": true }],
-    "no-useless-escape": 0,
-    "standard/no-callback-literal": 0,
-    "new-cap": 0
-  },
-  globals: {
-    describe: true,
-    it: true
-  },
-  'parserOptions': {
-    'ecmaVersion': 2022
-},
-}
-
-module.exports = config