Updating SharedTree's public transaction docs#26564
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation for SharedTree's transaction API, removing the old TODO and adding comprehensive documentation for the new alpha-level transaction APIs. The changes introduce examples and explanations for the TreeBranchAlpha.runTransaction and TreeViewAlpha.runTransaction methods, which provide more control over error handling compared to the legacy Tree.runTransaction API.
Changes:
- Removed the TODO comment about updating the transaction API documentation
- Added detailed documentation for the new alpha transaction APIs including synchronous and asynchronous forms
- Documented transaction nesting behavior and constraints functionality
jumyhre
commented
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
| ); | ||
| ``` | ||
|
|
||
| If transactions are nested, only the outermost transaction's label is used. |
Contributor
There was a problem hiding this comment.
Nit: this makes sense, but it took me a minute to reason out why. I wonder if it would be worth noting the why.
Contributor
Author
There was a problem hiding this comment.
i'm leaning weakly towards no, just because I'm in favor of keeping the doc succinct, but i'm open to it if we think this is important info for API consumers
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
|
|
||
| ### Nested Transactions | ||
|
|
||
| `runTransaction` and `runTransactionAsync` can be called from within the callback of another transaction, with some limitations. Nested transactions have the following behavior: |
Contributor
There was a problem hiding this comment.
These are obviously existing APIs, so this isn't feedback for this PR or anything, but I'm curious: would it be possible to make the async variation of this be an overload of runTransaction? Do we actually need 2 different function names?
Contributor
Author
There was a problem hiding this comment.
I think it's technically possible to put it all into one API, but I'm not 100% on that
Josmithr
reviewed
Feb 26, 2026
Josmithr
reviewed
Feb 26, 2026
…dFramework into jumyhre/docUpdate
Josmithr
reviewed
Mar 23, 2026
Josmithr
reviewed
Mar 23, 2026
Josmithr
reviewed
Mar 23, 2026
Josmithr
reviewed
Mar 23, 2026
Josmithr
approved these changes
Mar 23, 2026
Contributor
Josmithr
left a comment
Josmithr
left a comment
There was a problem hiding this comment.
Left a couple more nitpicks, but overall looks good to me! Thanks for adding this great documentation!
Josmithr
approved these changes
Mar 25, 2026
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
1 similar comment
Contributor
|
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output |
agarwal-navin
pushed a commit
to agarwal-navin/FluidFramework
that referenced
this pull request
Apr 13, 2026
This PR updates the docs for SharedTree's transaction API. It adds: - A brief explanation of the new TreeAlpha runTransaction API, and what benefits it provides over the old API - Snippets for new API use, including async forms and transaction nesting - A section on Constraints and their usage
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.
This PR updates the docs for SharedTree's transaction API. It adds: