Repository navigation
Say what the server-id, value and event name rules actually are - #18
Merged
Merged
Conversation
The README and parseServerWideConfig Javadoc allowed any server-id made of [A-Za-z0-9_.-], but the parser also wants a letter or digit first; the wire-format section said value is only omitted when not given, but NaN and infinities are dropped too; and report's Javadoc did not say a null or blank name sends nothing. A test now pins the server-id rule. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
resolveInstallId appends, so it does not land below the unusable line unless that line was last. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (CI anchor: run 38534789699 on head 6fecafe;
Inline notes:
Out-of-diff observation: the CI run warns that the Merge gate: none of the touched paths are on the do-not-auto-merge list. Merging is not authorised for this dispatch, so the PR is left open for the maintainer. This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener). drafted by Claude on behalf of Daniel Stephenson |
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
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.
Stage A: a documentation accuracy sweep. Every doc source of truth (README sections, class and method Javadoc,
pom.xmldescription,build.ymlcomment) was checked againstTraceClient.java, and three claims were found that did not match the code:parseServerWideConfigJavadoc: both said aserver-id:value may use any of[A-Za-z0-9_.-]. The parser checks the value againstTAG_KEY([A-Za-z0-9][A-Za-z0-9_.\-]*), so the value must also start with a letter or digit. A value like_mineis ignored, and the next start appends a freshserver-id:line (resolveInstallId). Both docs now say this.valueis omitted only "when not given".json()also drops NaN and ±Infinity. This is now stated.report(String, Double, Map)Javadoc: did not say that anullor blank name sends nothing (the early return inreport, already pinned byreport_ignoresABlankName). This is now stated.installId_anExistingServerIdIsUsedAndAnUnusableOneIsIgnoredgains assertions that pin the documented server-id rule: a leading_or-is ignored, and so is a value overMAX_TAG_LENGTH. These are characterization assertions only. No production code changed.The docs that were checked and found accurate: README example, "What
reportpromises", "Opting out" (not edited), "Server-wide tags", "Getting it" (0.6.1 agrees withpom.xml, the header andVERSION), "Keys" (not edited), "Building" (matches the 8/17/21 matrix), class Javadoc,close()/disabledReason()/Builder.*Javadoc, thepom.xmldescription, and thebuild.ymlcomment.Skipped issue: #13 (
withVersionexceedsMAX_TAGS) was not picked. It changes what is sent on the wire, so it needs a maintainer decision between the options listed in the issue.Test plan
mvn -B verifylocally (Java 21): 76 tests run, 0 failuresbuild (8),build (17),build (21)greenNo tracking issue. The drift was found during a Stage A sweep.
This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).
🤖 Generated with Claude Code
drafted by Claude on behalf of Daniel Stephenson