-
Notifications
You must be signed in to change notification settings - Fork 135
Adv/code review #828
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
Draft
peter-lawrey
wants to merge
8
commits into
develop
Choose a base branch
from
adv/code-review
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Adv/code review #828
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Root cause:\n- Module lacked the shared code-review tooling and documentation layout required by the playbook.\n\nFix:\n- Add the code-review Maven profile with pinned Checkstyle/SpotBugs/PMD/Jacoco setup and supporting config files.\n- Move AsciiDoc references into src/main/docs/, updating links and trimming redundant README formatting.\n- Document follow-up work in TODO.adoc and annotate SpotBugs/PMD suppressions with tags for future removal.\n\nImpact:\n- mvn clean verify -Pcode-review succeeds with Checkstyle/SpotBugs/PMD all reporting 0 violations and Jacoco thresholds met.
Root cause:\n- Profile still referenced a minimal local Checkstyle, filtered SpotBugs to high severity only, and disabled Jacoco thresholds, leaving key rules unenforced.\n\nFix:\n- Switch Checkstyle to the shared net/openhft quality rules, add the dependency, and drop the redundant local config.\n- Restore SpotBugs medium severity coverage with scoped suppressions and document them in src/main/config/spotbugs-exclude.xml.\n- Reintroduce PMD using the shared EmptyCatchBlock rule (NullAssignment/AvoidInstantiatingObjectsInLoops tracked for follow-up) and record exclusions via tagged entries.\n- Set interim Jacoco gates (line ≥ 0.73, branch ≥ 0.62) and update TODO.adoc with the plan to reach the standard thresholds plus PMD expansions.\n\nImpact:\n- mvn clean verify -Pcode-review now passes with Checkstyle/SpotBugs/PMD/Jacoco all active under the stricter settings.
- Block Wget from reaching loopback/link-local/site-local hosts by default; callers that need them opt-in via Builder.allowLocalHosts().\n- Adjust tests to use the new opt-in.\n- Narrow ReserveMemoryHolder to catch ReflectiveOperationException/SecurityException and log via Jvm.warn(), eliminating the REC_CATCH_EXCEPTION finding.
# Conflicts: # src/main/docs/common-pitfalls-and-debugging.adoc # src/main/docs/thread-safety-guarantees.adoc # src/main/java/net/openhft/chronicle/core/Jvm.java # src/main/java/net/openhft/chronicle/core/analytics/AnalyticsFacade.java # src/main/java/net/openhft/chronicle/core/io/ClosedIORuntimeException.java # src/main/java/net/openhft/chronicle/core/io/ClosedIllegalStateException.java # src/main/java/net/openhft/chronicle/core/io/IORuntimeException.java # src/main/java/net/openhft/chronicle/core/io/ReferenceOwner.java # src/main/java/net/openhft/chronicle/core/threads/DelegatingEventLoop.java # src/main/java/net/openhft/chronicle/core/threads/OnDemandEventLoop.java # src/main/java/net/openhft/chronicle/core/util/MisAlignedAssertionError.java # src/main/java/net/openhft/chronicle/core/util/NanoSampler.java # src/main/java/net/openhft/chronicle/core/util/ThrowingConsumer.java # src/main/java/net/openhft/chronicle/core/util/ThrowingFunction.java # src/main/java/net/openhft/chronicle/core/util/ThrowingIntSupplier.java # src/main/java/net/openhft/chronicle/core/util/ThrowingLongSupplier.java # src/main/java/net/openhft/chronicle/core/util/ThrowingSupplier.java # src/main/java/net/openhft/chronicle/core/util/Time.java # src/main/java/net/openhft/chronicle/core/util/Updater.java
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.



No description provided.