Repository navigation
Test that no log message contains the key - #34
Merged
Merged
Conversation
The README promises the client writes the key into no message, while a failed delivery's message carries the whole body. Every message kind the client logs is now driven with a sentinel key: a rejecting server, an unreachable one, an oversize name, a full queue and a close that times out. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (head
Judgment call flagged: the test adds about 5.5 s per framework, because the This review 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.
Summary
Stage B (unit-test expansion) cycle. The README section on the
logcallback promises that "the client does not write the key into any message", while a failed delivery's message carries the report's whole JSON body. No test held the client to that promise.Log_NeverContainsTheKeyOnAnyPathThatLogs. Every message kind the client logs is driven with a sentinel key:trace server answered 401(a rejecting server),could not deliver(nothing listening, and the request cancelled whenClosetimes out),dropped(an oversize name),queue full, dropped, andclose timed out. Each kind is asserted to have been logged, so the check cannot pass vacuously, and no message may contain the key.Deferred issues
User-Agent), Repeated events are not coalesced, unlike trace-client-java 0.7.0 #28 (coalescing repeated events) and A repeated tag key is sent twice and counted twice #31 (repeated tag keys) were not picked up. Each changes the wire format or the behaviour every vendoring program depends on, so each needs a maintainer's decision first.Docs sweep
The README ("What
Reportpromises", "Turning it off", "The wire format", "Getting it", "Building"), the class and member XML docs, the csproj comment and<Version>, and thebuild.yml/ test csproj comments were checked against the source. No drift was found.Test plan
Buildworkflow green on ubuntu-latest (net8.0)Buildworkflow green on windows-latest (net8.0 + net48)dotnetis not installed in the dispatch sandbox, so CI is the only anchor)No tracking issue: the gap was found during triage.
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