CHANGELOG.md

log4js-node Changelog

6.6.0

• feat: adding function(req, res) support to connectLogger nolog - thanks @eyoboue
• fix: ability to load CJS appenders (through .cjs extension) for ESM packages - thanks @lamweili
• type: consistent typing for Logger - thanks @taozi0818
• type: Make Appender Type extensible from other modules and the user - thanks @ZachHaber
• refactor: clearer logic for invalid level and LOG synonym - thanks @lamweili
• style: ran prettier and requires prettier for ci - thanks @ZachHaber
• docs: renamed peteriman to lamweili in changelog - thanks @lamweili
• ci: replaced validate-commit-msg, fixed husky config, removed codecov - thanks @ZachHaber
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump typescript from 4.6.4 to 4.7.2
  • chore(deps): bump date-format from 4.0.10 to 4.0.11
  • chore(deps): updated package-lock.json

6.5.2

• type: add LogEvent.serialise - thanks @marrowleaves

6.5.1

• fix: fs.appendFileSync should use flag instead of flags - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps): bump streamroller from 3.1.0 to 3.1.1
  • chore(deps): updated package-lock.json

6.5.0

• feat: logger.log() to be synonym of logger.info() - thanks @lamweili
• feat: tilde expansion for filename - thanks @lamweili
• fix: better file validation - thanks @lamweili
• fix: fallback for logger.log outputs nothing - thanks @lamweili
• docs: updated fileAppender maxLogSize documentation - thanks @lamweili
• ci: enforced 100% test coverage tests - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint from 8.15.0 to 8.16.0
  • chore(deps): bump streamroller from 3.0.9 to 3.1.0
  • chore(deps): updated package-lock.json

6.4.7

• fix: dateFileAppender unable to use units in maxLogSize - thanks @lamweili
• type: added fileNameSep for FileAppender and DateFileAppender - thanks @lamweili
• docs: updated usage of units for maxLogSize - thanks @lamweili
• docs: updated comments in typescript def - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint from 8.14.0 to 8.15.0
  • chore(deps-dev): bump husky from 7.0.4 to 8.0.1
  • chore(deps-dev): bump tap from 16.1.0 to 16.2.0
  • chore(deps-dev): bump typescript from 4.6.3 to 4.6.4
  • chore(deps): bump date-format from 4.0.9 to 4.0.10
  • chore(deps): bump streamroller from 3.0.8 to 3.0.9
  • chore(deps): updated package-lock.json
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump tap from 16.0.1 to 16.1.0
  • chore(deps-dev): updated package-lock.json

6.4.6

• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint from 8.13.0 to 8.14.0
  • chore(deps): bump date-format from 4.0.7 to 4.0.9
  • chore(deps): bump streamroller from 3.0.7 to 3.0.8
    • fix: #1216 where promise rejection is not handled (streamroller@3.0.8 changelog)
  • chore(deps): updated package-lock.json
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps): bump fs-extra from 10.0.1 to 10.1.0
  • chore(deps): updated package-lock.json

6.4.5

• fix: deserialise for enableCallStack features: filename, lineNumber, columnNumber, callStack - thanks @lamweili
• fix: fileDepth for ESM - thanks @lamweili
• refactor: replace deprecated String.prototype.substr() - thanks @CommanderRoot
• type: LogEvent types - thanks @lamweili
• docs: updated typescript usage - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps): bump date-format from 4.0.6 to 4.0.7
  • chore(deps): bump streamroller from 3.0.6 to 3.0.7
    • fix: #1225 where fs-extra throws error when fs.realpath.native is undefined (streamroller@3.0.7 changelog)
  • chore(deps): updated package-lock.json
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint from 8.11.0 to 8.13.0
  • chore(deps-dev): bump eslint-plugin-import from 2.25.4 to 2.26.0
  • chore(deps-dev): bump tap from 16.0.0 to 16.0.1
  • chore(deps-dev): bump typescript from 4.6.2 to 4.6.3
  • chore(deps-dev): updated package-lock.json
• chore(deps-dev): bump minimist from 1.2.5 to 1.2.6 - thanks @Dependabot

6.4.4

• fix: set logger.level on runtime will no longer wrongly reset useCallStack - thanks @lamweili
• docs: updated docs for broken links and inaccessible pages - thanks @lamweili
• docs: broken link to gelf appender - thanks @mattalexx
• docs: updated docs for appenders module loading - thanks @leonimurilo
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps): bump streamroller from 3.0.5 to 3.0.6
  • chore(deps): bump debug from 4.3.3 to 4.3.4
  • chore(deps): bump date-format from 4.0.5 to 4.0.6
  • chore(deps-dev): bump prettier from 2.5.1 to 2.6.0
  • chore(deps): updated package-lock.json

6.4.3

• fix: added filename validation - thanks @lamweili
• refactor: do not initialise default appenders as it will be done again by configure() - thanks @lamweili
• refactor: defensive coding for cluster=null if require('cluster') fails in try-catch - thanks @lamweili
• refactor: removed redundant logic in tcp-serverAppender - thanks @lamweili
• refactor: removed redundant logic in multiprocessAppender - thanks @lamweili
• test: 100% test coverage - thanks @lamweili
  • test: part 1 of 3: #1200
  • test: part 2 of 3: #1204
  • test: part 3 of 3: #1205
  • test: improved test cases
• docs: updated README.md with badges - thanks @lamweili
• docs: added docs for istanbul ignore - thanks @lamweili
• docs: updated logger api docs - thanks @lamweili
• docs: updated file and fileSync appender docs - thanks @lamweili
• chore(lint): improve eslint rules - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint from 8.10.0 to 8.11.0
  • chore(deps-dev): bump eslint-config-airbnb-base from 13.2.0 to 15.0.0
  • chore(deps-dev): bump eslint-config-prettier from 8.4.0 to 8.5.0
  • chore(deps-dev): bump tap from 15.1.6 to 16.0.0
  • chore(deps): bump date-format from 4.0.4 to 4.0.5
  • chore(deps): bump streamroller from 3.0.4 to 3.0.5
  • chore(deps): updated package-lock.json

6.4.2

• fix: fileSync appender to create directory recursively - thanks @lamweili
• fix: serialise() for NaN, Infinity, -Infinity and undefined - thanks @lamweili
• fix: connectLogger not logging on close - thanks @lamweili
• refactor: defensive coding - thanks @lamweili
• type: fixed Logger constructor - thanks @lamweili
• test: improve test coverage - thanks @lamweili
• test: refactor and replaced tap deprecation in preparation for tap v15 - thanks @lamweili
• test: added e2e test for multiprocess Appender - thanks @nicojs
• docs: updated file appender docs - thanks @lamweili
• docs: updated dateFile appender docs - thanks @lamweili
• docs: corrected typo in sample code for multiFile appender - thanks @lamweili
• chore(deps): updated deps-dev - thanks @lamweili
  • chore(deps): bump date-format from 4.0.3 to 4.0.4
  • chore(deps): bump streamroller from 3.0.2 to 3.0.4
    • fix: #1189 for an compatibility issue with directory creation for NodeJS < 10.12.0 (streamroller@3.0.3 changelog)
  • chore(deps-dev): bump eslint from 8.8.0 to 8.10.0
  • chore(deps-dev): bump eslint-config-prettier from 8.3.0 to 8.4.0
  • chore(deps-dev): bump fs-extra from 10.0.0 to 10.0.1
  • chore(deps-dev): bump typescript from 4.5.5 to 4.6.2
• chore(deps): updated deps-dev - thanks @lamweili
  • chore(deps): bump flatted from 3.2.4 to 3.2.5
  • chore(deps-dev): bump eslint from 8.7.0 to 8.8.0
• chore(deps): updated package-lock.json - thanks @lamweili
• chore(deps-dev): bump tap from 14.10.7 to 15.1.6 - thanks @lamweili

6.4.1

• fix: startup multiprocess even when no direct appenders - thanks @nicojs
  • refactor: fixed eslint warnings - thanks @lamweili
• refactor: additional alias for date patterns - thanks @lamweili
• refactor: added emitWarning for deprecation - thanks @lamweili
• type: Fixed wrong types from 6.4.0 regression - thanks @glasser
• docs: changed author to contributors in package.json - thanks @lamweili
• chore(deps): bump node-fetch from 2.6.6 to 2.6.7 - thanks @Dependabot
• chore(deps-dev): bump typescript from 4.5.4 to 4.5.5 - thanks @lamweili

6.4.0 - BREAKING CHANGE 💥

New default file permissions may cause external applications unable to read logs. A manual code/configuration change is required.

• feat: added warnings when log() is used with invalid levels before fallbacking to INFO - thanks @abernh
• feat: exposed Recording - thanks @polo-language
• fix: default file permission to be 0o600 instead of 0o644 - thanks ranjit-git and @lamweili
  • docs: updated fileSync.md and misc comments - thanks @lamweili
• fix: file descriptor leak if repeated configure() - thanks @lamweili
• fix: MaxListenersExceededWarning from NodeJS - thanks @lamweili
  • test: added assertion for increase of SIGHUP listeners on log4js.configure() - thanks @lamweili
• fix: missing TCP appender with Webpack and Typescript - thanks @techmunk
• fix: dateFile appender exiting NodeJS on error - thanks @4eb0da
  • refactor: using writer.writable instead of alive for checking - thanks @lamweili
• fix: TCP appender exiting NodeJS on error - thanks @jhonatanTeixeira
• fix: multiprocess appender exiting NodeJS on error - thanks @harlentan
• test: update fakeFS.read as graceful-fs uses it - thanks @lamweili
• test: update fakeFS.realpath as fs-extra uses it - thanks @lamweili
• test: added tap.tearDown() to clean up test files
  • test: #1143 - thanks @lamweili
  • test: #1022 - thanks @abetomo
• type: improved @types for AppenderModule - thanks @nicobao
• type: Updated fileSync appender types - thanks @lamweili
• type: Removed erroneous type in file appender - thanks @vdmtrv
• type: Updated Logger.log type - thanks @ZLundqvist
• type: Updated Logger._log type - thanks @lamweili
• type: Updated Logger.level type - thanks @lamweili
• type: Updated Levels.getLevel type - thanks @saulzhong
• chore(deps): bump streamroller from 3.0.1 to 3.0.2 - thanks @lamweili
• chore(deps): bump date-format from 4.0.2 to 4.0.3 - thanks @lamweili
• chore(deps-dev): bump eslint from from 8.6.0 to 8.7.0 - thanks @lamweili
• chore(deps-dev): bump nyc from 14.1.1 to 15.1.0 - thanks @lamweili
• chore(deps-dev): bump eslint from 5.16.0 to 8.6.0 - thanks @lamweili
• chore(deps): bump flatted from 2.0.2 to 3.2.4 - thanks @lamweili
• chore(deps-dev): bump fs-extra from 8.1.0 to 10.0.0 - thanks @lamweili
• chore(deps): bump streamroller from 2.2.4 to 3.0.1 - thanks @lamweili
  • fix: compressed file ignores dateFile appender "mode" - thanks @rnd-debug
  • fix: #1039 where there is an additional separator in filename (streamroller@3.0.0 changelog)
  • fix: #1035, #1080 for daysToKeep naming confusion (streamroller@3.0.0 changelog)
  • refactor: migrated from daysToKeep to numBackups due to streamroller@^3.0.0 - thanks @lamweili
  • feat: allows for zero backups - thanks @lamweili
• chore(deps): bump date-format from 3.0.0 to 4.0.2 - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump eslint-config-prettier from 6.15.0 to 8.3.0
  • chore(deps-dev): bump eslint-plugin-prettier from 3.4.1 to 4.0.0
  • chore(deps-dev): bump husky from 3.1.0 to 7.0.4
  • chore(deps-dev): bump prettier from 1.19.0 to 2.5.1
  • chore(deps-dev): bump typescript from 3.9.10 to 4.5.4
• chore(deps-dev): bump eslint-config-prettier from 6.15.0 to 8.3.0 - thanks @lamweili
• chore(deps): updated dependencies - thanks @lamweili
  • chore(deps-dev): bump codecov from 3.6.1 to 3.8.3
  • chore(deps-dev): bump eslint-config-prettier from 6.5.0 to 6.15.0
  • chore(deps-dev): bump eslint-import-resolver-node from 0.3.2 to 0.3.6
  • chore(deps-dev): bump eslint-plugin-import" from 2.18.2 to 2.25.4
  • chore(deps-dev): bump eslint-plugin-prettier from 3.1.1 to 3.4.1
  • chore(deps-dev): bump husky from 3.0.9 to 3.1.0
  • chore(deps-dev): bump prettier from 1.18.2 to 1.19.1
  • chore(deps-dev): bump typescript from 3.7.2 to 3.9.10
• chore(deps): bump path-parse from 1.0.6 to 1.0.7 - thanks @Dependabot
• chore(deps): bump glob-parent from 5.1.1 to 5.1.2 - thanks @Dependabot
• chore(deps): bump hosted-git-info from 2.7.1 to 2.8.9 - thanks @Dependabot
• chore(deps): bump lodash from 4.17.14 to 4.17.21 - thanks @Dependabot
• chore(deps): bump y18n from 4.0.0 to 4.0.1 - thanks @Dependabot
• chore(deps): bump node-fetch from 2.6.0 to 2.6.1 - thanks @Dependabot
• chore(deps): bump yargs-parser from 13.1.1 to 13.1.2 - thanks @Dependabot
• chore(deps-dev): bump codecov from 3.6.5 to 3.7.1 - thanks @Dependabot

6.3.0

• Add option to file appender to remove ANSI colours - thanks @BlueCocoa
• Do not create appender if no categories use it - thanks @rnd-debug
• Docs: better categories inheritance description - thanks @rnd-debug
• Better jsdoc docs - thanks @wataash
• Typescript: access category field in Logger - thanks @rtvd
• Docs: influxdb appender - thanks @rnd-debug
• Support for fileSync appender in webpack - thanks @lauren-li
• Docs: UDP appender - thanks @iassasin
• Style: spaces and tabs - thanks @abetomo

6.2.1

• Update streamroller to 2.2.4 to fix incorrect filename matching during log rotation

6.2.0

• Add custom message end token to TCP appender - thanks @rnd-debug
• Update acorn (dev dep of a dep) - thanks Github Robots.

6.1.2

• Handle out-of-order appender loading - thanks @mvastola

6.1.1

• Add guards for undefined shutdown callback - thanks @aaron-edwards
• Ignore .bob files - thanks @cesine
• Add mark method to type definitions - thanks @techmunk

6.1.0

• Add pause event to dateFile appender - thanks @shayantabatabaee
• Add pause event to file appender - thanks @shayantabatabaee
• Add pause/resume event to docs

6.0.0

• Update streamroller to fix unhandled promise rejection
• Updated date-format library

5.3.0

• Padding and truncation changes

5.2.2

• Update streamroller to fix overwriting old files when using date rolling

5.2.1

• Update streamroller to fix numToKeep not working with dateFile pattern that is all digits

5.2.0

• Update streamroller to 2.2.0 (copy and truncate when file is busy)

5.1.0

• Update streamroller to 2.1.0 (windows fixes)

5.0.0

• Update streamroller to 2.0.0 (remove support for node v6)
• Update dependencies (mostly dev deps)
• Fix error when cluster not available
• Test coverage improvements

4.5.1

• Update streamroller 1.0.5 -> 1.0.6 (to fix overwriting old backup log files)
• Dependency update: lodash 4.17.4 (dependency of a dependency, not log4js) - thanks Github Automated Security Thing.
• Dependency update: lodash 4.4.0 -> 4.5.0 (dependency of a dependency, not log4js) - thanks Github Automated Security Thing.

4.5.0

• Override call stack parsing - thanks @rommni
• patternLayout filename depth token - thanks @rommni

4.4.0

• Add option to pass appender module in config - thanks @kaxelson
• Added docs for passing appender module
• Updated dependencies

4.3.2

• Types for enableCallStack - thanks @citrusjunoss

4.3.1

• Fix for maxLogSize in dateFile appender

4.3.0

• Feature: line number support - thanks @victor0801x
• Fix for missing core appenders in webpack

4.2.0

• Feature: add appender and level inheritance - thanks @pharapiak
• Feature: add response to context for connectLogger - thanks @leak4mk0
• Fix for broken sighup handler
• Add missing types for Level - thanks @Ivkaa
• Typescript fixes for connect logger context - thanks @leak4mk0
• Upgrade to streamroller-1.0.5 to fix log rotation bug

4.1.1

• Various test fixes for node v12
• Fix layout problem in node v12 - thanks @bjornstar
• Add missing types for addLevels - thanks @Ivkaa
• Allow any return type for layout function - thanks @xinbenlv

4.1.0

• Updated streamroller to 1.0.4, to fix a bug where the inital size of an existing file was ignored when appending
• Updated streamroller to 1.0.3, to fix a crash bug if the date pattern was all digits.
• Updated dependencies

Previous versions

Change information for older versions can be found by looking at the milestones in github.