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

[For 2.20] Remove IContainerRuntimeOptions.flushmode #23337

Merged

Conversation

markfields
Copy link
Member

@markfields markfields commented Dec 16, 2024

Description

Fixes AB#26496
See #23287

IContainerRuntimeOptions.flushMode is removed. See https://github.com/microsoft/FluidFramework/releases/tag/client_v2.12.0#user-content-icontainerruntimeoptionsflushmode-is-now-deprecated-23288

Breaking Changes

This is a breaking change to the IContainerRuntimeOptions interface. flushMode is deprecated as of 2.12.0, and there are no known usages in partner codebases. FlushMode.Immediate has been deprecated since 2.0.0-rc.2.0.0.

@Copilot Copilot bot review requested due to automatic review settings December 16, 2024 23:06
@markfields markfields requested review from a team as code owners December 16, 2024 23:06
@github-actions github-actions bot added area: runtime Runtime related issues changeset-present public api change Changes to a public API labels Dec 16, 2024

Choose a reason for hiding this comment

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

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

@markfields markfields marked this pull request as draft December 16, 2024 23:07
@github-actions github-actions bot added the base: main PRs targeted against main branch label Dec 16, 2024
@markfields markfields linked an issue Dec 16, 2024 that may be closed by this pull request
@markfields markfields requested review from jason-ha, kian-thompson, MarioJGMsoft, a team, pragya91, jatgarg, tyler-cai-microsoft and rajatch-ff and removed request for a team December 16, 2024 23:15
Copy link
Collaborator

@msfluid-bot msfluid-bot left a comment

Choose a reason for hiding this comment

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

Code Coverage Summary

No packages impacted by the change.


Baseline commit: 46abe82
Baseline build: 315740
Happy Coding!!

Code coverage comparison check passed!!

@msfluid-bot
Copy link
Collaborator

msfluid-bot commented Dec 17, 2024

@fluid-example/bundle-size-tests: +245 Bytes
Metric NameBaseline SizeCompare SizeSize Diff
aqueduct.js 470.55 KB 470.59 KB +35 Bytes
azureClient.js 567.29 KB 567.34 KB +49 Bytes
connectionState.js 724 Bytes 724 Bytes No change
containerRuntime.js 266.44 KB 266.46 KB +14 Bytes
fluidFramework.js 439.08 KB 439.09 KB +14 Bytes
loader.js 134.2 KB 134.21 KB +14 Bytes
map.js 42.68 KB 42.69 KB +7 Bytes
matrix.js 150.36 KB 150.36 KB +7 Bytes
odspClient.js 534.75 KB 534.8 KB +49 Bytes
odspDriver.js 99.49 KB 99.51 KB +21 Bytes
odspPrefetchSnapshot.js 43.05 KB 43.06 KB +14 Bytes
sharedString.js 166.51 KB 166.52 KB +7 Bytes
sharedTree.js 429.55 KB 429.56 KB +7 Bytes
Total Size 3.42 MB 3.42 MB +245 Bytes

Baseline commit: 46abe82

Generated by 🚫 dangerJS against d1bc392

Copy link
Contributor

@jzaffiro jzaffiro left a comment

Choose a reason for hiding this comment

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

A few minor tweaks to wording, but docs look good!

.changeset/cruel-horses-cheat.md Outdated Show resolved Hide resolved
.changeset/cruel-horses-cheat.md Outdated Show resolved Hide resolved
.changeset/cruel-horses-cheat.md Outdated Show resolved Hide resolved
@markfields markfields linked an issue Dec 17, 2024 that may be closed by this pull request
Copy link
Contributor

@jason-ha jason-ha left a comment

Choose a reason for hiding this comment

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

I think it would also be okay to point to deprecation release notes (when available)

@markfields
Copy link
Member Author

I think it would also be okay to point to deprecation release notes (when available)

@jason-ha what specifically are you suggesting?

@markfields markfields force-pushed the test/legacy-breaks/client/2.20/remove-flushmode-option branch from f068b4a to 646135f Compare January 7, 2025 23:54
@markfields markfields marked this pull request as ready for review January 7, 2025 23:54
Copy link
Contributor

github-actions bot commented Jan 8, 2025

🔗 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:
  170492 links
    1603 destination URLs
    1838 URLs ignored
       0 warnings
       0 errors


@markfields markfields merged commit fe8279c into main Jan 8, 2025
33 checks passed
@markfields markfields deleted the test/legacy-breaks/client/2.20/remove-flushmode-option branch January 8, 2025 02:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: runtime Runtime related issues base: main PRs targeted against main branch changeset-present public api change Changes to a public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove IContainerRuntimeOptions.flushMode
6 participants