Deprecate enableGroupedBatching #23260

MarioJGMsoft · 2024-12-05T21:12:19Z

Description

After discussing the work in task #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

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

…p batching." This reverts commit 86a3ece.

markfields · 2024-12-06T23:45:24Z

.changeset/sad-dodos-sell.md

+
+Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated
+
+- We want to remove the ability to configure batch grouping, so `IContainerRuntimeOptions.enableGroupedBatching` is now being marked as deprecated and batch grouping will now depend on batch compression.


Suggested change

- We want to remove the ability to configure batch grouping, so `IContainerRuntimeOptions.enableGroupedBatching` is now being marked as deprecated and batch grouping will now depend on batch compression.

- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

Applied changes

…nfiguration' into removeBatchGroupingConfiguration

jzaffiro

Changeset looks good, approving for docs!

jzaffiro · 2024-12-09T17:52:54Z

.changeset/sad-dodos-sell.md

+
+Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated
+
+- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.


Suggested change

- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

Applied changes

markfields · 2024-12-10T00:33:09Z

packages/runtime/container-runtime/src/containerRuntime.ts

@@ -519,6 +519,7 @@ export interface IContainerRuntimeOptions {
 	 * The grouping an ungrouping of such messages is handled by the "OpGroupingManager".
 	 *
 	 * By default, the feature is enabled.
+	 * @deprecated The ability to configure Grouped Batching is now removed and it is now disabled if compression is disabled.


Suggested change

* @deprecated The ability to configure Grouped Batching is now removed and it is now disabled if compression is disabled.

* @deprecated Grouped Batching can no longer be disabled, it is required for the proper functioning of the Fluid Framework

This isn't technically true. We can't change existing functionality in a deprecation as that's effectively a breaking change. This deprecation is instead notifying consumers that they soon won't be able to disable the feature, and that there is no alternative as "it is required for the proper functioning of the Fluid Framework".

Suggested change

* @deprecated The ability to configure Grouped Batching is now removed and it is now disabled if compression is disabled.

* @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.

Applied changes

tylerbutler · 2024-12-11T02:09:30Z

.changeset/sad-dodos-sell.md

+"section": deprecation
+---
+
+Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated


Suggested change

Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated

IContainerRuntimeOptions.enableGroupedBatching is now deprecated

Curious if removing the inline code formatting was intentional. I personally do like to see it even in headers.

Yeah, it was intentional. Opinions vary, but last time we discussed this the general consensus was that code formatting in headings is more distracting than helpful, especially when so much of every heading is code.

Applied changes

tylerbutler · 2024-12-11T02:37:14Z

.changeset/sad-dodos-sell.md

+
+Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated
+
+- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.


Suggested change

- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

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.

tylerbutler · 2024-12-11T02:41:11Z

packages/runtime/container-runtime/src/containerRuntime.ts

@@ -519,6 +519,7 @@ export interface IContainerRuntimeOptions {
 	 * The grouping an ungrouping of such messages is handled by the "OpGroupingManager".


Suggested change

* The grouping an ungrouping of such messages is handled by the "OpGroupingManager".

* The grouping and ungrouping of such messages is handled by the "OpGroupingManager".

Applied changes

github-actions · 2024-12-11T19:05:59Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> [email protected] ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> [email protected] serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> [email protected] check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  170006 links
    1595 destination URLs
    1825 URLs ignored
       0 warnings
       0 errors

@deprecated

## Description After discussing the work in task [microsoft#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)

refactor(Grouped Batching): removed ability to configure group batching.

86a3ece

MarioJGMsoft requested a review from markfields December 5, 2024 21:12

anthony-murphy reviewed Dec 6, 2024

View reviewed changes

packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md Show resolved Hide resolved

MarioJGMsoft added 2 commits December 6, 2024 18:39

Revert "refactor(Grouped Batching): removed ability to configure grou…

8556f61

…p batching." This reverts commit 86a3ece.

docs: tag enableGroupedBatching as deprecated

ffa9632

github-actions bot removed public api change Changes to a public API area: tests Tests to add, test infrastructure improvements, etc labels Dec 6, 2024

update API to show deprecated tag for enableGroupedBatching

31c0337

github-actions bot added the public api change Changes to a public API label Dec 6, 2024

docs: added changeset

b7fd0cc

github-actions bot added changeset-present and removed area: framework Framework is a tag for issues involving the developer framework. Eg Aqueduct labels Dec 6, 2024

MarioJGMsoft changed the title ~~Remove support for Batch Grouping configuration~~ Deprecate enableGroupedBatching Dec 6, 2024

Merge branch 'main' into removeBatchGroupingConfiguration

8a89e37

MarioJGMsoft marked this pull request as ready for review December 6, 2024 23:33

MarioJGMsoft requested review from a team as code owners December 6, 2024 23:33

MarioJGMsoft requested review from a team, pragya91, jatgarg, tyler-cai-microsoft, kian-thompson and rajatch-ff and removed request for a team December 6, 2024 23:33

markfields reviewed Dec 6, 2024

View reviewed changes

MarioJGMsoft added 2 commits December 6, 2024 23:51

docs: Applied changes to changeset based on comments

06c8c6e

Merge remote-tracking branch 'refs/remotes/fork/removeBatchGroupingCo…

269041c

…nfiguration' into removeBatchGroupingConfiguration

jzaffiro approved these changes Dec 9, 2024

View reviewed changes

markfields reviewed Dec 10, 2024

View reviewed changes

markfields mentioned this pull request Dec 10, 2024

Deprecate IContainerRuntimeOptions.flushMode #23288

Merged

tylerbutler reviewed Dec 11, 2024

View reviewed changes

MarioJGMsoft added 2 commits December 11, 2024 17:24

docs: Applied changes based on comments to changeset

d39744d

Merge branch 'main' into removeBatchGroupingConfiguration

8a1bc5d

jatgarg approved these changes Dec 11, 2024

View reviewed changes

MarioJGMsoft merged commit 49d8e75 into microsoft:main Dec 11, 2024
32 checks passed

MarioJGMsoft deleted the removeBatchGroupingConfiguration branch December 11, 2024 21:46

This was referenced Dec 11, 2024

Upcoming Release: FluidFramework v2.13.0 #22101

Open

Upcoming Release: FluidFramework v2.12.0 tylerbutler/FluidFramework#26

Closed

MarioJGMsoft linked an issue Dec 12, 2024 that may be closed by this pull request

Removal of IContainerRuntimeOptions.enableGroupedBatching in v2.20 #23270

Open

MarioJGMsoft removed a link to an issue Dec 16, 2024

Removal of IContainerRuntimeOptions.enableGroupedBatching in v2.20 #23270

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate enableGroupedBatching #23260

Deprecate enableGroupedBatching #23260

MarioJGMsoft commented Dec 5, 2024 •

edited by azure-boards bot

Loading

markfields Dec 6, 2024

MarioJGMsoft Dec 6, 2024

jzaffiro left a comment

jzaffiro Dec 9, 2024

MarioJGMsoft Dec 11, 2024

markfields Dec 10, 2024

kian-thompson Dec 11, 2024

MarioJGMsoft Dec 11, 2024

tylerbutler Dec 11, 2024

alexvy86 Dec 11, 2024

tylerbutler Dec 11, 2024

MarioJGMsoft Dec 11, 2024

tylerbutler Dec 11, 2024

MarioJGMsoft Dec 11, 2024

tylerbutler Dec 11, 2024

MarioJGMsoft Dec 11, 2024

github-actions bot commented Dec 11, 2024


		Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated

		- We want to remove the ability to configure batch grouping, so `IContainerRuntimeOptions.enableGroupedBatching` is now being marked as deprecated and batch grouping will now depend on batch compression.

	- We want to remove the ability to configure batch grouping, so `IContainerRuntimeOptions.enableGroupedBatching` is now being marked as deprecated and batch grouping will now depend on batch compression.
	- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

	- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.
	We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.

	* @deprecated The ability to configure Grouped Batching is now removed and it is now disabled if compression is disabled.
	* @deprecated Grouped Batching can no longer be disabled, it is required for the proper functioning of the Fluid Framework

	* @deprecated The ability to configure Grouped Batching is now removed and it is now disabled if compression is disabled.
	* @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.

	Marked `IContainerRuntimeOptions.enableGroupedBatching` as deprecated
	IContainerRuntimeOptions.enableGroupedBatching is now deprecated

-- We will remove the ability to disable Grouped Batching in v2.20.0. The only exception (i.e. where Grouped Batching would be disabled) is for compatibility with older (v1) clients, and this will be implemented without needing to expose `IContainerRuntimeOptions.enableGroupedBatching`.
+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.

		@@ -519,6 +519,7 @@ export interface IContainerRuntimeOptions {
		* The grouping an ungrouping of such messages is handled by the "OpGroupingManager".

	* The grouping an ungrouping of such messages is handled by the "OpGroupingManager".
	* The grouping and ungrouping of such messages is handled by the "OpGroupingManager".

Deprecate enableGroupedBatching #23260

Deprecate enableGroupedBatching #23260

Conversation

MarioJGMsoft commented Dec 5, 2024 • edited by azure-boards bot Loading

Description

Reviewer Guidance

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jzaffiro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Dec 11, 2024

linkcheck output

MarioJGMsoft commented Dec 5, 2024 •

edited by azure-boards bot

Loading