Skip to content

Commit

Permalink
Deprecate enableGroupedBatching (#23260)
Browse files Browse the repository at this point in the history
## Description

After discussing the work in task
[#8124](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/8124),
we concluded that it was best to make Batch Grouping dependent on Batch
Compression.

This is the first step where we are tagging enableGroupedBatching as
deprecated in containerRuntime.ts

Acceptance Criteria:
containerRuntime.enableGroupedBatching is now tagged as deprecated

Execution Plan: 
Create the changeset file explaining the change and add the @deprecated
tag

## Reviewer Guidance

Please let me know if there's anything I should change or make better.

Fixes
[AB#26356](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/26356)
  • Loading branch information
MarioJGMsoft authored Dec 11, 2024
1 parent 0512e74 commit 49d8e75
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 1 deletion.
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;
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

0 comments on commit 49d8e75

Please sign in to comment.