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.

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

Deprecate enableGroupedBatching #23260

Merged
13 changes: 13 additions & 0 deletions .changeset/sad-dodos-sell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
"@fluidframework/container-runtime": minor
"@fluidframework/fluid-static": minor
---
---
"section": deprecation
---

IContainerRuntimeOptions.enableGroupedBatching is now deprecated

The `IContainerRuntimeOptions.enableGroupedBatching` property is deprecated and will be removed in version 2.20.0. This will mean that the grouped batching feature can no longer be disabled. In versions 2.20.0 and beyond, grouped batching is required for the proper functioning of the Fluid Framework.

The sole case where grouped batching will be disabled is for compatibility with older v1 clients, and this will be implemented without any need for the configurable `IContainerRuntimeOptions.enableGroupedBatching` option.
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ export interface IContainerRuntimeMetadata extends ICreateContainerMetadata, IGC
export interface IContainerRuntimeOptions {
readonly chunkSizeInBytes?: number;
readonly compressionOptions?: ICompressionRuntimeOptions;
// @deprecated
readonly enableGroupedBatching?: boolean;
markfields marked this conversation as resolved.
Show resolved Hide resolved
readonly enableRuntimeIdCompressor?: IdCompressorMode;
readonly explicitSchemaControl?: boolean;
Expand Down
3 changes: 2 additions & 1 deletion packages/runtime/container-runtime/src/containerRuntime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -515,9 +515,10 @@ export interface IContainerRuntimeOptions {
/**
* If enabled, the runtime will group messages within a batch into a single
* message to be sent to the service.
* The grouping an ungrouping of such messages is handled by the "OpGroupingManager".
* The grouping and ungrouping of such messages is handled by the "OpGroupingManager".
*
* By default, the feature is enabled.
* @deprecated The ability to disable Grouped Batching is deprecated and will be removed in v2.20.0. This feature is required for the proper functioning of the Fluid Framework.
*/
readonly enableGroupedBatching?: boolean;

Expand Down
Loading