Skip to content

Commit

Permalink
Revert "[BREAK IN 2.20.0] Remove support for Batch Grouping configura…
Browse files Browse the repository at this point in the history
…tion" (#23563)

We have partners that still depend on this flag, so putting it back.

reverts #23336
  • Loading branch information
anthony-murphy authored Jan 15, 2025
1 parent ab65e32 commit fb47218
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
12 changes: 0 additions & 12 deletions .changeset/quiet-days-carry.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ 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;
// (undocumented)
Expand Down
11 changes: 10 additions & 1 deletion packages/runtime/container-runtime/src/containerRuntime.ts
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,16 @@ 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. This feature can only be disabled when compression is also disabled.
* @deprecated The ability to disable Grouped Batching is deprecated and will be removed in a future release. 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 Expand Up @@ -1549,7 +1559,6 @@ export class ContainerRuntime
// Backfill in defaults for the internal runtimeOptions, since they may not be present on the provided runtimeOptions object
this.runtimeOptions = {
flushMode: defaultFlushMode,
enableGroupedBatching: true,
...runtimeOptions,
};
this.logger = createChildLogger({ logger: this.baseLogger });
Expand Down

0 comments on commit fb47218

Please sign in to comment.