getSnapshotTree is required on IChannelStorageService#25707
Merged
agarwal-navin merged 8 commits intomainfrom Oct 23, 2025
Merged
getSnapshotTree is required on IChannelStorageService#25707agarwal-navin merged 8 commits intomainfrom
agarwal-navin merged 8 commits intomainfrom
Conversation
github-actions
bot
added
area: dds
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR makes getSnapshotTree a required method on IChannelStorageService and updates implementations and type validation accordingly.
- Changes IChannelStorageService signature from optional to required and propagates usage (removes optional chaining).
- Adds createSnapshotTreeFromContents utility with accompanying tests.
- Updates type validation metadata and removes LocalChannelStorageService (and its tests) which did not implement the new required API.
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/runtime/datastore-definitions/src/channel.ts | Makes getSnapshotTree required in the interface. |
| packages/dds/tree/src/shared-tree-core/sharedTreeCore.ts | Adjusts call site to required method (drops optional chaining). |
| packages/runtime/runtime-utils/src/objectstoragepartition.ts | Implements required getSnapshotTree passthrough. |
| packages/runtime/test-runtime-utils/src/mocks.ts | Adds snapshot tree creation & implements getSnapshotTree in mock storage. |
| packages/runtime/test-runtime-utils/src/test/mocks.spec.ts | Adds tests for createSnapshotTreeFromContents. |
| packages/runtime/datastore-definitions/src/test/types/validateDatastoreDefinitionsPrevious.generated.ts | Marks expected type validation breaks. |
| packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts | Marks expected type validation breaks. |
| packages/runtime/datastore-definitions/package.json | Adds broken forward compatibility entries. |
| packages/runtime/test-runtime-utils/package.json | Adds broken forward compatibility entries. |
| packages/runtime/test-runtime-utils/api-report/test-runtime-utils.legacy.beta.api.md | API report updated with required method (undocumented). |
| packages/runtime/datastore-definitions/api-report/datastore-definitions.legacy.beta.api.md | API report reflects required method. |
| packages/runtime/datastore/src/localChannelStorageService.ts | Removes implementation that lacked required method. |
| packages/runtime/datastore/src/test/localChannelStorageService.spec.ts | Removes tests for removed implementation. |
| .changeset/heavy-mails-pay.md | Records breaking change release notes. |
jason-ha
approved these changes
Oct 20, 2025
Contributor
jason-ha
left a comment
jason-ha
left a comment
There was a problem hiding this comment.
Approved with suggestion for changeset update to point to the issue.
Contributor
There was a problem hiding this comment.
Appears to be required dead code removal (as opposed to fixing to conform to new requirements), right?
Contributor
Author
There was a problem hiding this comment.
Moved this to a separate PR. This one now only contains breaking changes.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
noencke
approved these changes
Oct 23, 2025
Contributor
|
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output |
agarwal-navin
deleted the
test/breaks/client/2.70/getSnapshotTreeRequired
branch
This was referenced Oct 23, 2025
anthony-murphy-agent
pushed a commit
to anthony-murphy-agent/FluidFramework
that referenced
this pull request
Jan 14, 2026
## Description The property `getSnapshotTree` is now required on `IChannelStorageService`. ## Breaking Changes This is a breaking change. This API was added and the upcoming break was announced in release 2.51.0 [here](https://github.com/microsoft/FluidFramework/releases/tag/client_v2.51.0#user-content-new-getsnapshottree-api-on-ichannelstorageservice-24970).
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
4 participants
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.
Description
The property
getSnapshotTreeis now required onIChannelStorageService.Breaking Changes
This is a breaking change. This API was added and the upcoming break was announced in release 2.51.0 here.