Skip to content

AbstractConfiguration#initialize - making two passes generates invalid configuration - no check if initialization has already been performed #3449

@JWT007

Description

@JWT007

Log4j 2.24.3

Repeated calls to the Configuration#doConfigure method discard appenders (and maybe other inforrmation).

In my example, I have a configuration with two defined appenders ("CONSOLE" and "RollingFile").

Taken from another test case, lets assume I use a BuiltConfiguration with a ConfigurationBuilder and create the and initialized configuration and then initialize it again (the first initialization happens in the build method if I don't call builder.build(false). (Admittedly, this is redundant and strictly incorrect; however, it is possible and I found an instance of this in the Configurator1Test unit-test.)

final Configuration config = builder.build();
config.initialize();

In the first pass, the rootNode tree is processed and through a call to PluginElementVisitor#visit(....) all nested nodes are removed and the top level child node is assigned an built object.

Image

If a second pass is made, the config.initialize() method performs no check to see if it has already been initialized (State.INITIALIZED or later). This results in another runthrough of doConfigure() and now the child nodes are missing because they have been visited and removed,

Here before the 2nd-pass of createConfigurationon the "Appenders" node:

Image

Now however, due to the missing child information, the object list of configured appenders is empty and the two previously defined appenders are gone.

Image

So the second configure cleared the previous run's appenders (and possibly other nested configuration).

I think the easy solution would be to test the state in the initialize method and if not INITIALIZING just log and return; however, I don't know if that would have other side-efffects.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    To triage

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions