Skip to content
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.

Sign up for GitHub

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

(op bunching) Deprecate process on FluidDataStoreRuntime #23866

Merged
merged 3 commits into from
Feb 21, 2025
Merged

(op bunching) Deprecate process on FluidDataStoreRuntime #23866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a5bb00
(op bunching) Depreate process on FluidDataStoreRuntime
agarwal-navin Feb 18, 2025
b4bf047
API md
agarwal-navin Feb 18, 2025
3609a02
PR doc comments
agarwal-navin Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .changeset/tender-rabbits-speak.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
"@fluidframework/datastore": minor
---
---
"section": deprecation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not saying this is necessarily correct but I wonder if we should put it in the section for changes to the legacy API since that's where FluidDataStoreRuntime lives. cc @tylerbutler and @jason-ha for thoughts. I know we used deprecation in the previous change so maybe that's reason enough to have it match here, but at least wanted to bring it up for discussion which might affect future deprecations of legacy APIs.

Suggested change
"section": deprecation
"section": legacy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a strong feeling either way. For now, I am keeping it deprecation to be in line with the previous change like you said.

---

The FluidDataStoreRuntime.process function is now deprecated

A new function `processMessages` has been added in its place which will be called to process multiple messages instead of a single one on the data store runtime. This is part of a feature called "Op bunching" where contiguous ops of a given type and to a given data store / DDS are bunched and sent together for processing.
Note that `process` may still be called in scenarios where this data store runtime (Datastore layer) is running with an older version of data store context (Runtime layer) in the same client. This is to support Fluid layer compatibility.
1 change: 1 addition & 0 deletions packages/runtime/datastore/api-report/datastore.legacy.alpha.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
get objectsRoutingContext(): this;
// (undocumented)
readonly options: Record<string | number, any>;
// @deprecated
process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
processMessages(messageCollection: IRuntimeMessageCollection): void;
// (undocumented)
Expand Down
4 changes: 2 additions & 2 deletions packages/runtime/datastore/src/dataStoreRuntime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,8 +790,8 @@ export class FluidDataStoreRuntime

/**
* back-compat ADO 21575.
* This is still here for back-compat purposes because it exists on IFluidDataStoreChannel. Once it is removed from
* the interface, this method can be removed.
* @deprecated {@link FluidDataStoreRuntime.processMessages} should be used instead to process messages. This is still here for back-compat
* because it exists on IFluidDataStoreChannel. Once it is removed from the interface, this method can be removed.
*/
public process(
message: ISequencedDocumentMessage,
Expand Down
Loading