Skip to content

Respect log4j1.compatibility for programmatic configuration #3812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 2.x
Choose a base branch
from

Conversation

jhl221123
Copy link
Contributor

This PR addresses issue #3667 by adding guard logic to methods in Category and LogManager that can modify the configuration. These changes ensure that programmatic configuration using the Log4j 1.x API is ignored unless the log4j1.compatibility flag is explicitly set to true.

I have confirmed the fix by running the reproducer provided in the issue, which now yields the following corrected output for the latest snapshot:

Testing 2.22.0
00:11:30.417 [main] INFO  org.example.App - Initializing Log4j 1.2 API...
00:11:30.423 [main] INFO  org.example.App - Log4j 1.2 API initialized.
Recorded 2 events (expected 2)

Testing 2.23.0
00:11:32.276 [main] INFO  org.example.App - Initializing Log4j 1.2 API...
Recorded 1 events (expected 2)

Testing 2.25.0
2025-07-09T15:11:36.970645Z main INFO Initializing Log4j 1.2 API...Recorded 1 events (expected 2)

Testing 2.26.0-SNAPSHOT
2025-07-09T15:11:39.258845Z main INFO Initializing Log4j 1.2 API...2025-07-09T15:11:39.262583Z main INFO Log4j 1.2 API initialized.Recorded 2 events (expected 2)

Additionally, I have updated the existing unit tests and added new tests to verify that the guard logic works as expected when the compatibility mode is disabled. I am not entirely confident that the new unit tests are perfect. Please let me know if there are any areas for improvement.

Checklist

Before we can review and merge your changes, please go through the checklist below. If you're still working on some items, feel free to submit your pull request as a draft—our CI will help guide you through the remaining steps.

✅ Required checks

  • License: I confirm that my changes are submitted under the Apache License, Version 2.0.

  • Commit signatures: All commits are signed and verifiable. (See GitHub Docs on Commit Signature Verification).

  • Code formatting: The code is formatted according to the project’s style guide.

    How to check and fix formatting
    • To check formatting: ./mvnw spotless:check
    • To fix formatting: ./mvnw spotless:apply

    See the build instructions for details.

  • Build & Test: I verified that the project builds and all unit tests pass.

    How to build the project

    Run: ./mvnw verify

    See the build instructions for details.

🧪 Tests (select one)

  • I have added or updated tests to cover my changes.
  • No additional tests are needed for this change.

📝 Changelog (select one)

  • I added a changelog entry in src/changelog/.2.x.x. (See Changelog Entry File Guide).
  • This is a trivial change and does not require a changelog entry.

Copy link

github-actions bot commented Jul 9, 2025

Job Requested goals Build Tool Version Build Outcome Build Scan®
build-macos-latest clean install 3.9.8 Build Scan PUBLISHED
build-ubuntu-latest clean install 3.9.8 Build Scan PUBLISHED
build-windows-latest clean install 3.9.8 Build Scan PUBLISHED
Generated by gradle/develocity-actions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: To triage
Development

Successfully merging this pull request may close these issues.

1 participant