tree: Add changeset for transaction minimizer - #28160
Conversation
|
Hi! Thank you for opening this PR. Want me to review it? Based on the diff (26 lines, 3 files), I've queued these reviewers:
How this works
|
There was a problem hiding this comment.
🟡 Changes recommended
The new/updated docs (changeset + JSDoc) contain a clarity/grammar issue that can mislead readers about the behavioral guarantees.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds release-note coverage for the minimize transaction post-processor and updates its documentation now that the implementation is present (including clarifying a concurrency caveat), with the API report reflecting the deprecation removal.
Changes:
- Adds a new changeset announcing the
minimizetransaction post-processor. - Updates the
minimizedoc comment to remove the “no-op” deprecation note and describe behavior/caveats. - Updates the generated API report to drop
@deprecatedfromminimize.
File summaries
| File | Description |
|---|---|
| packages/dds/tree/src/shared-tree/transactionMinimize.ts | Updates minimize JSDoc to reflect current implementation and document concurrency caveat. |
| packages/dds/tree/api-report/tree.alpha.api.md | API report update removing @deprecated on minimize. |
| .changeset/wicked-teams-go.md | Adds a changeset describing minimize and how to use it. |
Review details
- Files reviewed: 3/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| When calling `runTransaction` or `runTransactionAsync`, with `RunTransactionParamsAlpha.postProcessor` set to `minimize`, | ||
| edits any newly created nodes which are removed by the transaction will be discarded. | ||
| Edits to removed nodes will also be discarded. | ||
| This is intended to remove information from changes (which, for example, may have been made by an AI system) | ||
| which cannot be easily inspected by a user looking at the effect of that change on the document. |
| * out to nothing. Minimizing the change reduces the size of the edit that is | ||
| * submitted to (and stored by) the service without altering the observable | ||
| * effect of the transaction. | ||
| * Minimization may discard edits to nodes which are removed by the transaction, | ||
| * which would cause an observable difference if those nodes are reattached by a concurrent edit. |
There was a problem hiding this comment.
FWIW, this does not bother me.
Co-authored-by: yann-achard-MS <97201204+yann-achard-MS@users.noreply.github.com>
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
Bundle size comparisonBase commit: Pending — |
Daniel Madrid (dannimad)
left a comment
There was a problem hiding this comment.
do not merge until 3.0 release is cut
Description
Added a changeset for the addition of the
mimizetransaction post-processor, as well as updating a related doc comment.