-
Notifications
You must be signed in to change notification settings - Fork 562
improvement(client-datastore): BREAKING CHANGE: remove FluidDataStoreRuntime.submitMessage #25755
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
improvement(client-datastore): BREAKING CHANGE: remove FluidDataStoreRuntime.submitMessage #25755
Conversation
…Runtime.submitMessage and MockFluidDataStoreRuntime.submitMessage
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR removes the deprecated submitMessage method from both FluidDataStoreRuntime and MockFluidDataStoreRuntime classes, marking a breaking change. Users should migrate to using IFluidDataStoreContext.submitMessage instead.
Key Changes:
- Removal of deprecated
submitMessagemethods from production and test runtime classes - Updates to type validation configuration to mark backward compatibility as broken
- Addition of changeset documenting the breaking change
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/runtime/datastore/src/dataStoreRuntime.ts | Removes the deprecated submitMessage method from FluidDataStoreRuntime |
| packages/runtime/test-runtime-utils/src/mocks.ts | Removes the deprecated submitMessage method from MockFluidDataStoreRuntime |
| packages/runtime/datastore/api-report/datastore.legacy.beta.api.md | Updates API report to reflect removal of submitMessage from public API |
| packages/runtime/test-runtime-utils/api-report/test-runtime-utils.legacy.beta.api.md | Updates API report to reflect removal of submitMessage from mock runtime |
| packages/runtime/datastore/package.json | Marks FluidDataStoreRuntime class backward compatibility as broken |
| packages/runtime/test-runtime-utils/package.json | Marks MockFluidDataStoreRuntime class backward compatibility as broken |
| packages/runtime/datastore/src/test/types/validateDatastorePrevious.generated.ts | Adds TypeScript error suppression for expected breaking compatibility |
| packages/runtime/test-runtime-utils/src/test/types/validateTestRuntimeUtilsPrevious.generated.ts | Adds TypeScript error suppression for expected breaking compatibility |
| packages/framework/aqueduct/src/test/types/validateAqueductPrevious.generated.ts | Adds TypeScript error suppression for transitive breaking compatibility |
| packages/framework/aqueduct/package.json | Marks DataObjectFactoryProps interface backward compatibility as broken |
| .changeset/odd-loops-flash.md | Documents the breaking change with migration guidance |
| "@fluidframework/test-runtime-utils": minor | ||
| "__section": breaking | ||
| --- | ||
| Remove submitMessage from FluidDataStoreRuntime and MockFluidDataStoreRuntime |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'submitMessage'?
|
🔗 Found some broken links! 💔 Run a link check locally to find them. See linkcheck output |
noencke
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Stamped for API
…Runtime.submitMessage (microsoft#25755) remove FluidDataStoreRuntime.submitMessage and MockFluidDataStoreRuntime.submitMessage
remove FluidDataStoreRuntime.submitMessage and MockFluidDataStoreRuntime.submitMessage