docs(client): document new memory_report() fields from #1273 - #511
Conversation
Adds inbound_commit_batch, msg_secret_buffer, pending_device_sync, and app_state_key_cache to the memory_report() field table, and notes the new Transient retention section in the Display output. Ref: oxidezap/whatsapp-rust#1273
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Warning Review limit reached
Next review available in: 22 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5f76790438
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Inbound_commit_batch's "largest allocation" claim now notes it holds only under default cache sizing (enlarged history_sync_tasks or other cache capacity can exceed it). pending_device_sync's description now makes clear a nonzero count is dedup-set membership, not necessarily a refresh still queued -- an online-path entry outlives its own refresh until the next offline drain or teardown removes it. Addresses review feedback from #511.
1 participant
Summary
MemoryReportfields added in oxidezap/whatsapp-rust#1273:inbound_commit_batch,msg_secret_buffer,pending_device_sync, andapp_state_key_cache.--- Transient retention ---section thatDisplaynow prints for the three transient-retention fields, alongside the existing--- In-flight history sync ---section.Context
PR #1273 was a per-client retention/cache-bounds audit (no bounds changed, no behavior changed) but it did extend
Client::memory_report()'s public output somemory_report()could see the largest transient allocation a client holds (the inbound commit batch, up to 4 MiB of decoded protos) plus two other previously-unreported collections. This PR updatesapi/client.mdx'smemory_reportfield table andDisplaydescription to match.Everything else in #1273 (an internal
agent_docs/observability.mdaudit narrative, new characterization tests, a measurement harness) is engineering-internal and has no separate public-doc surface, so it isn't mirrored here.Test plan
mint dev/mint broken-links) — not run in this session; please verify in CI or locally.src/client.rs,src/client/accessors.rs, andwacore/src/appstate_sync.rs.Generated by Claude Code
Summary by cubic
Updates
api/client.mdxto document four newMemoryReportfields—inbound_commit_batch,msg_secret_buffer,pending_device_sync, andapp_state_key_cache—and note the new--- Transient retention ---section inDisplayoutput.Clarifies that
inbound_commit_batchis only the largest allocation under default cache sizes (others likehistory_sync_taskscan exceed it) and thatpending_device_synccounts dedup-set entries, not queued work; aligns docs withoxidezap/whatsapp-rust#1273.Written for commit fce8a05. Summary will update on new commits.