You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
refactor: derive mechanical Debug implementations in first batch - #973
Replace 15 field-based Debug implementations with derive_more::Debug across seven packages. Include printable fields and retain useful custom views, with the user-approved exceptions below. DispatcherClient prints worker count instead of the shared runtime tree. DriverHost omits owner_waker to avoid printing its data and vtable addresses. TaskList omits head and tail to avoid printing task-allocation addresses. The ten-package audit leaves anyspawn, bytesbuf_io, and cachet_memory unchanged because their implementations need custom presentation or generic handling.
This is an automated mechanical PR for allocation_hints.
This is an automated mechanical PR for anyspawn.
This is an automated mechanical PR for arty.
This is an automated mechanical PR for arty_executor.
This is an automated mechanical PR for arty_io_host.
This is an automated mechanical PR for bytesbuf.
This is an automated mechanical PR for bytesbuf_io.
This is an automated mechanical PR for cachet.
This is an automated mechanical PR for cachet_memory.
This is an automated mechanical PR for cachet_tier.
Evidence
Fourteen root assertions cover the migrated implementations and the bounded dispatcher view through fourteen .snap files. Ten assertions use public integration tests. Four use unit tests for private views. Root snapshots include nested views without duplicate assertions. Filters replace incidental addresses, identity values, and one toolchain-dependent internal Rc path. Snapshot tests are ignored under Miri as requested. Existing behavior tests retain their Miri coverage.
Current head a1ec684591b5dff3f4997a695fb0615af475aac8 merges main at 2dc2073b219b30c2fa368ad08e9f01b38386d72a without conflicts. Five CI failures on preceding head ac778e774 share one executor snapshot mismatch. Main changed PanicPolicy from an enum to a wrapper, so its derived output is now PanicPolicy(Shutdown). The snapshot now expects that exact representation. The mutation job failed its baseline on the same assertion, before mutation testing started. Production behavior and the assertion remain intact.
On the merged source, cargo test -p arty_executor --test lifecycle debug_snapshot passed both tests. cargo test -p arty --test io io_debug_snapshot passed. cargo check -p arty_executor -p arty passed. The diff against main passes the whitespace check. The staged merge also contains an upstream-only README blank line at EOF, left unchanged. CI is pending for this head. No workflow retry, coverage suppression, or gate change was made.
Earlier focused checks passed for the approved DriverHost and TaskList omissions. Executor snapshots use explicit names that passed under both module layouts. Earlier package checks and focused Debug tests also passed across the seven changed packages with cachet/test-util. Those earlier results do not replace current-head CI. Historical Codecov diagnostics identified five missed lines in unchanged macro entry points outside this batch. No coverage policy changes or suppressions were added.
Merge Danger
Debug output intentionally changes and includes more printable fields. ShutdownError.inner exposes source-error text and panic messages, as explicitly approved. The related tests and API documentation describe this change.
Heap's flattened fields, pool counts, buffer summaries and previews, task identity, type-name views, and callback summaries retain their custom presentation. DispatcherClient has a user-approved custom worker-count summary to keep output bounded. DriverHost omits owner_waker, and TaskList omits head and tail, with explicit user approval to avoid printing their addresses. Other skips cover fields without Debug support under the existing generic contracts. No extra generic Debug bounds or task-ID adapters are added.
The reason will be displayed to describe this comment to others. Learn more.
🔵 Needs a closer look
The tests can pass despite missing initializing or _single_threaded fields or incorrect thread and owner_waker values, leaving the expected output insufficiently verified.
No open issues 🎉
1 previously missed issue
In code that hasn't changed since last review
Assert the complete constructor output, including all fields
crates/arty_io_host/tests/hosting.rs:917
These checks still pass if initializing and _single_threaded are omitted, or if thread and owner_waker have incorrect values. Capture the constructor inputs and compare the complete expected string, as required by .github/skills/code-review/test-review.md under “Assert exact outcomes”. Format the captured inputs and an expected Cell::new(false) so incidental values and wrapper formatting match without hard-coding them.
✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.9%. Comparing base (2be413c) to head (a1ec684). ⚠️ Report is 2 commits behind head on main.
❌ Your project check has failed because the head coverage (99.9%) is below the target coverage (100.0%). You can increase the head coverage or adjust the target coverage.
Use explicit snapshot names without module prefixes so expectations work both on this branch and after main nests the lifecycle tests. Preserve both expected outputs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Apply the user-approved exception for DriverHost.owner_waker and update the public snapshot.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Apply the user-approved exception for TaskList head and tail, and update the public executor snapshot.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Update the snapshot for main's PanicPolicy wrapper. Preserve the existing Debug assertions and approved bounded views.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
The reason will be displayed to describe this comment to others. Learn more.
🤖: Approved.
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
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
Replace 15 field-based Debug implementations with
derive_more::Debugacross seven packages. Include printable fields and retain useful custom views, with the user-approved exceptions below. DispatcherClient prints worker count instead of the shared runtime tree. DriverHost omitsowner_wakerto avoid printing its data and vtable addresses. TaskList omitsheadandtailto avoid printing task-allocation addresses. The ten-package audit leavesanyspawn,bytesbuf_io, andcachet_memoryunchanged because their implementations need custom presentation or generic handling.allocation_hints.anyspawn.arty.arty_executor.arty_io_host.bytesbuf.bytesbuf_io.cachet.cachet_memory.cachet_tier.Evidence
Fourteen root assertions cover the migrated implementations and the bounded dispatcher view through fourteen
.snapfiles. Ten assertions use public integration tests. Four use unit tests for private views. Root snapshots include nested views without duplicate assertions. Filters replace incidental addresses, identity values, and one toolchain-dependent internalRcpath. Snapshot tests are ignored under Miri as requested. Existing behavior tests retain their Miri coverage.Current head
a1ec684591b5dff3f4997a695fb0615af475aac8mergesmainat2dc2073b219b30c2fa368ad08e9f01b38386d72awithout conflicts. Five CI failures on preceding headac778e774share one executor snapshot mismatch. Main changedPanicPolicyfrom an enum to a wrapper, so its derived output is nowPanicPolicy(Shutdown). The snapshot now expects that exact representation. The mutation job failed its baseline on the same assertion, before mutation testing started. Production behavior and the assertion remain intact.On the merged source,
cargo test -p arty_executor --test lifecycle debug_snapshotpassed both tests.cargo test -p arty --test io io_debug_snapshotpassed.cargo check -p arty_executor -p artypassed. The diff against main passes the whitespace check. The staged merge also contains an upstream-only README blank line at EOF, left unchanged. CI is pending for this head. No workflow retry, coverage suppression, or gate change was made.Earlier focused checks passed for the approved DriverHost and TaskList omissions. Executor snapshots use explicit names that passed under both module layouts. Earlier package checks and focused Debug tests also passed across the seven changed packages with
cachet/test-util. Those earlier results do not replace current-head CI. Historical Codecov diagnostics identified five missed lines in unchanged macro entry points outside this batch. No coverage policy changes or suppressions were added.Merge Danger
Debug output intentionally changes and includes more printable fields.
ShutdownError.innerexposes source-error text and panic messages, as explicitly approved. The related tests and API documentation describe this change.Heap's flattened fields, pool counts, buffer summaries and previews, task identity, type-name views, and callback summaries retain their custom presentation. DispatcherClient has a user-approved custom worker-count summary to keep output bounded. DriverHost omits
owner_waker, and TaskList omitsheadandtail, with explicit user approval to avoid printing their addresses. Other skips cover fields without Debug support under the existing generic contracts. No extra generic Debug bounds or task-ID adapters are added.