Skip to content

Commit

Permalink
Improve changesets for tree errors (#21940)
Browse files Browse the repository at this point in the history
## Description

Improve/add error related changesets for tree.
  • Loading branch information
CraigMacomber authored Jul 18, 2024
1 parent 7ed3bac commit 3b8a366
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions .changeset/stale-rooms-bow.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
"fluid-framework": minor
"@fluidframework/tree": minor
---

Expand Down
14 changes: 14 additions & 0 deletions .changeset/weak-swans-take.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
"fluid-framework": minor
"@fluidframework/tree": minor
---

Improved error reporting

Several cases of invalid usage patterns for tree APIs have gained improved error reporting, as well as improved documentation on the APIs detailing what usage is supported.
These improvements include:

- Unsupported usages of schema classes: using more than one schema class derived from a single SchemaFactory generated base class. This used to hit internal asserts, but now has a descriptive user-facing UsageError. Most of this work was done in [9fb3dcf](https://github.com/microsoft/FluidFramework/commit/9fb3dcf491a7f0d66f4abbdc64ab97ccabef4707).

- Improved detection of when prior exception may have left SharedTree in an invalid state.
These cases now report a UsageError including a reference to the prior exception. This was mainly done in [9fb3dcf](https://github.com/microsoft/FluidFramework/commit/9fb3dcf491a7f0d66f4abbdc64ab97ccabef4707) and [b77d530](https://github.com/microsoft/FluidFramework/commit/b77d530b9252201c40a90d1a2a6315f76f1a4a4b).

0 comments on commit 3b8a366

Please sign in to comment.