feat: add appender and level inheritance #863

pharapiak · 2019-04-25T18:15:56Z

These changes:

use a category's name to infer inheritance from another category
merges in unique appenders from parent categories, recursively
if no 'level' is defined for a category, it is copied from the nearest parent
fills in intermediate parent categories that are not explicitly declared in the config (E.g. given catA and catA.catB.catC, catA.catB will be created if it doesn't exist.
added support for boolean category.inherit to disable this, for backwards compatibility.
added addPreProcessingListener to config so that this inheritance is applied globally.
updated terms.md.

See configuration-inheritance-test.js for examples.

feat: add appenders and level inheritance feat: inherit appenders and level from base feat: inherit appenders, handle empty categories

…harapiak/log4js-node into inherit-parent-category-config

codecov · 2019-04-30T12:22:56Z

Codecov Report

Merging #863 into master will increase coverage by 0.05%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #863      +/-   ##
==========================================
+ Coverage   97.43%   97.49%   +0.05%     
==========================================
  Files          25       25              
  Lines         937      959      +22     
==========================================
+ Hits          913      935      +22     
  Misses         24       24

Impacted Files	Coverage Δ
lib/log4js.js	`98.07% <100%> (+0.03%)`	⬆️
lib/categories.js	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d03bcae...045a1fe. Read the comment docs.

codecov · 2019-04-30T12:22:56Z

Codecov Report

Merging #863 into master will increase coverage by 0.06%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #863      +/-   ##
==========================================
+ Coverage   97.86%   97.92%   +0.06%     
==========================================
  Files          25       25              
  Lines         937      966      +29     
==========================================
+ Hits          917      946      +29     
  Misses         20       20

Impacted Files	Coverage Δ
lib/categories.js	`100% <100%> (ø)`	⬆️
lib/configuration.js	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa6c85c...301dcde. Read the comment docs.

nomiddlename

We need to work out how to support your "pre-processing" of the config object before it gets passed to the other modules in a nice way. Right now it will break when read-only config is used, and it goes against the way I've tried to keep the main module from having to know about all the config-related stuff. I'd suggest adding an extra hook into the configuration module for adding pre-processing functions. What do you think?

nomiddlename · 2019-04-30T22:25:32Z

lib/log4js.js

@@ -59,6 +59,8 @@ function configure(configurationFileOrObject) {
  }
  debug(`Configuration is ${configObject}`);

+  categories.addInheritedConfig(configObject); // copy config from parent to child categories


I think this is going to give you problems when users supply read-only config objects (i.e. they've used Object.freeze or something similar). I think the node-config package does this by default. Your addInheritedConfig function modifies the original configObject. That's why the other modules add themselves as config listeners (there's code in the categories module that does this too) - they'll get called after the config object has been cloned, like below.

Ah, I wasn't aware of read only config objects.

I found that I had to put some inheritance 'fixes' into the configuration validation, otherwise it rejects categories that have no directly configured appenders. I was originally just adding inheritance to the cloned config that gets passed to validation, before I realized that left the original config without any inheritance.

Would it make sense to clone the incoming readonly config, and use that clone thereafter? ie: apply inheritance, validate it, and use it for subsequent getLogger calls.

Another approach I considered was augmenting the categories object, with a getter method for appenders and level that considered inheritance, but I though it would be more efficient to just collapse inherited 'stuff' to sub-categories at startup.

Yep, the steps should be the same as on the master branch for log4js.js:

// log4js.js: line 62 configuration.configure(deepClone(configObject));

Then in configuration.js we add an extra set of listeners (addPreProcessingListeners?), and call those functions with the cloned configObject. They can modify the config before it gets validated. So categories.js would add three config listeners - one for pre-processing (apply inheritance), one for the validation rules, and one for the setup.

nomiddlename · 2019-04-30T22:30:39Z

The travis CI failure is unrelated to your changes - I'll see if I can work out what's wrong with that test.

pharapiak · 2019-05-02T14:03:19Z

Working on those requested changes. The suggested preProcessingListeners approach seems to work cleanly. Now reworking unit tests to verify the results.

for preparing config before validation and interpretation

…nto inherit-parent-category-config

pharapiak · 2019-05-04T16:17:34Z

I added requested changes: applying inheritance through preProcessingListener.
I think this PR is ready to go.

nomiddlename · 2019-05-14T05:09:07Z

Published to NPM in version 4.2.0

pharapiak · 2019-05-14T16:24:44Z

Great!

BTW, this was a milestone for me: my first-ever open source contribution.

nomiddlename · 2019-05-14T23:28:22Z

Congratulations, and thanks again for your help.

Paul Harapiak added 6 commits April 25, 2019 13:12

feat: add appender and level inheritance

805634f

feat: add appenders and level inheritance

a81bf78

feat: inherit appenders and level from base

fa7c5ca

feat: add appender and level inheritance

3b81a6b

feat: add appenders and level inheritance feat: inherit appenders and level from base feat: inherit appenders, handle empty categories

Merge branch 'inherit-parent-category-config' of https://github.com/p…

04f6504

…harapiak/log4js-node into inherit-parent-category-config

feat: improved doc'n for category hierarchy

045a1fe

nomiddlename requested changes Apr 30, 2019

View reviewed changes

Paul Harapiak added 2 commits May 4, 2019 12:10

feat(categoryInheritance): using preProcessingListener

6bff3bb

for preparing config before validation and interpretation

Merge branch 'master' of https://github.com/log4js-node/log4js-node i…

301dcde

…nto inherit-parent-category-config

nomiddlename approved these changes May 5, 2019

View reviewed changes

nomiddlename added this to the 4.2.0 milestone May 6, 2019

nomiddlename merged commit 8c29e78 into log4js-node:master May 6, 2019

pharapiak deleted the inherit-parent-category-config branch May 6, 2019 13:07

pharapiak mentioned this pull request May 6, 2019

config file does not allow subcategory to inherit appenders #824

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add appender and level inheritance #863

feat: add appender and level inheritance #863

pharapiak commented Apr 25, 2019 •

edited

codecov bot commented Apr 30, 2019

codecov bot commented Apr 30, 2019 •

edited

nomiddlename left a comment

nomiddlename Apr 30, 2019

pharapiak May 1, 2019

nomiddlename May 1, 2019

nomiddlename commented Apr 30, 2019

pharapiak commented May 2, 2019

pharapiak commented May 4, 2019

nomiddlename commented May 14, 2019

pharapiak commented May 14, 2019

nomiddlename commented May 14, 2019

feat: add appender and level inheritance #863

feat: add appender and level inheritance #863

Conversation

pharapiak commented Apr 25, 2019 • edited

codecov bot commented Apr 30, 2019

Codecov Report

codecov bot commented Apr 30, 2019 • edited

Codecov Report

nomiddlename left a comment

Choose a reason for hiding this comment

nomiddlename Apr 30, 2019

Choose a reason for hiding this comment

pharapiak May 1, 2019

Choose a reason for hiding this comment

nomiddlename May 1, 2019

Choose a reason for hiding this comment

nomiddlename commented Apr 30, 2019

pharapiak commented May 2, 2019

pharapiak commented May 4, 2019

nomiddlename commented May 14, 2019

pharapiak commented May 14, 2019

nomiddlename commented May 14, 2019

pharapiak commented Apr 25, 2019 •

edited

codecov bot commented Apr 30, 2019 •

edited