Skip to content

Commit b82048a

Browse files
(op bunching) Deprecate process on FluidDataStoreRuntime (microsoft#23866)
Deprecating `process` on `FluidDataStoreRuntime`. It was deprecated on `IFluidDataStoreChannel` (and other places) as part of microsoft#22840 but missed deprecating it on `FluidDataStoreRuntime`.
1 parent cf0def9 commit b82048a

File tree

3 files changed

+14
-2
lines changed

3 files changed

+14
-2
lines changed

.changeset/tender-rabbits-speak.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
"@fluidframework/datastore": minor
3+
---
4+
---
5+
"section": deprecation
6+
---
7+
8+
The FluidDataStoreRuntime.process function is now deprecated
9+
10+
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.
11+
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.

packages/runtime/datastore/api-report/datastore.legacy.alpha.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ export class FluidDataStoreRuntime extends TypedEventEmitter<IFluidDataStoreRunt
7070
get objectsRoutingContext(): this;
7171
// (undocumented)
7272
readonly options: Record<string | number, any>;
73+
// @deprecated
7374
process(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
7475
processMessages(messageCollection: IRuntimeMessageCollection): void;
7576
// (undocumented)

packages/runtime/datastore/src/dataStoreRuntime.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -790,8 +790,8 @@ export class FluidDataStoreRuntime
790790

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

0 commit comments

Comments
 (0)