Repository navigation
Say that reports still queued at close()'s timeout are sent afterwards, not dropped - #41
Merged
Merged
Conversation
…s, not dropped close(timeout) returns once the timeout runs out, but the daemon sender keeps draining what was queued and only stops when it reaches the sentinel. The docstring and README read as if the thread stopped at the timeout. Say what actually happens, mention close(timeout=...) in the README, pin the behaviour with a test, and say the 32-tag cap counts version. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Member
Author
|
Self-review rubric (anchored on CI run 43548303032 and the diff):
Judgment notes:
Summary: a docs-only correction with a characterization test. CI is green and no do-not-auto-merge path is touched. This 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.
Summary
Stage A documentation accuracy sweep. One drift was found and fixed:
close()timeout behaviour. Theclose()docstring opens with "Stop the sending thread" and the README's "close()drains" row says reports get the timeout "before the thread stops". Both read as if anything still unsent is dropped when the timeout runs out. Intrace_client/trace_client.py,close()only doesthread.join(timeout). The daemon sender keeps draining the queue afterclose()returns and stops when it reaches the sentinel. Anything it has not sent by process exit is lost. (The existingtest_close_on_a_full_queue_drops_the_oldest_report_and_still_stops_the_senderalready depends on this: 256 reports are delivered after a 0.5 sclose().) The docstring and README now say this, and the README now mentionsclose(timeout=...).installoff an event countsversiontoo. This matches_with_install, which checkslen(tags) >= MAX_TAGSafterversionhas been merged in.test_reports_still_queued_at_the_timeout_are_sent_after_close_returnscovers the newly documented behaviour. No production logic changed.The rest of the sweep found no drift in: the constructor signature, the promises table, opt-out values, precedence and
disabled_reasonstrings, the wire-format section, the Building section againstbuild.yml(3.8/3.10/3.12), the module headers,pyproject.toml, and__all__.Deferred
MAX_TAGS/versionpromise, and the change has to be made in step with trace-client-java.Java parity
No Java-visible behaviour changed: this is documentation plus a test. The Java README could not be read during this session, so whether its
close()docs have the same wording is unverified.Test plan
python3 -m unittest: 78 tests ran, OK (local Python 3.8.10)test (3.8),test (3.10),test (3.12)greenNo tracking issue — gap found during the documentation 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