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

[BREAK IN 2.20.0] Remove support for Batch Grouping configuration #23336

Merged
10 changes: 10 additions & 0 deletions .changeset/quiet-days-carry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"@fluidframework/container-runtime": minor
---
---
"section": legacy
---

Grouped batching is enabled by default and IContainerRuntimeOptinos.enableGroupedBatching has been removed
MarioJGMsoft marked this conversation as resolved.
Show resolved Hide resolved

This option allowed an application to disable grouped batching. But now we no longer want users to be able to turn it on or off, so this option can be removed and it will always be enabled by default.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This option allowed an application to disable grouped batching. But now we no longer want users to be able to turn it on or off, so this option can be removed and it will always be enabled by default.
The Grouped Batching feature in the container runtime has stabilized and is now enabled by default.
The `IContainerRuntimeOptions.enableGroupedBatching` option, which allowed an application to disable grouped batching, has been removed. Grouped Batching is now considered a core part of the container runtime, and as such can no longer be disabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Applied changes

Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,6 @@ 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;
// @deprecated
Expand Down
10 changes: 0 additions & 10 deletions packages/runtime/container-runtime/src/containerRuntime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -515,16 +515,6 @@ export interface IContainerRuntimeOptions {
*/
readonly enableRuntimeIdCompressor?: IdCompressorMode;

/**
* If enabled, the runtime will group messages within a batch into a single
* message to be sent to the service.
* 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;

/**
* When this property is set to true, it requires runtime to control is document schema properly through ops
* The benefit of this mode is that clients who do not understand schema will fail in predictable way, with predictable message,
Expand Down
Loading