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.

Sign up for GitHub

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

Jump to bottom

Deprecate IContainerRuntimeOptions.flushMode #23288

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Deprecate IContainerRuntimeOptions.flushMode #23288

merged 5 commits into from
Dec 11, 2024
+15 −0

Conversation

markfields
Copy link
Member

@markfields markfields commented Dec 10, 2024 •
edited by azure-boards bot
Loading

Description

Fixes AB#26497

Only the default value FlushMode.TurnBased is supported when calling ContainerRuntime.loadRuntime directly, so there's no need for consumers to pass this option in. We'll remove the option altogether in 2.20.0.

Reviewer Guidance

Note that FlushMode.Immediate is still used in compatibilityConfiguration.ts, for 1.x compat mode. #23272 adds an internal-only set of options which includes flushMode, to support that use. But in the meantime we can finish removing it from the legacy-alpha API surface.

@Copilot Copilot bot review requested due to automatic review settings December 10, 2024 22:26
@markfields markfields requested review from a team as code owners December 10, 2024 22:26
@github-actions github-actions bot added area: runtime Runtime related issues changeset-present public api change Changes to a public API base: main PRs targeted against main branch labels Dec 10, 2024
Copilot
Copilot AI reviewed Dec 10, 2024
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

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 1 suggestion.

packages/runtime/container-runtime/api-report/container-runtime.legacy.alpha.api.md Show resolved Hide resolved
@markfields markfields requested review from agarwal-navin, a team, pragya91, jatgarg, tyler-cai-microsoft, kian-thompson, rajatch-ff and MarioJGMsoft and removed request for a team December 10, 2024 22:32
@markfields
Copy link
Member Author

@jzaffiro -- want to review this changeset? Similar to #23260

tylerbutler
tylerbutler reviewed Dec 11, 2024
View reviewed changes
.changeset/fancy-insects-sing.md Outdated Show resolved Hide resolved
.changeset/fancy-insects-sing.md Outdated Show resolved Hide resolved
@markfields @tylerbutler
docs review feedback
0cbf038 
Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
@markfields
Copy link
Member Author

@tylerbutler thanks for the feedback, I took your suggestions.

@github-actions GitHub Actions
Copy link
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 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"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

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

> fluid-framework-docs-site@0.0.0 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

@markfields markfields merged commit af1cd7b into microsoft:main Dec 11, 2024
32 checks passed
@markfields markfields deleted the deprecate-flushmode branch December 11, 2024 22:47
This was referenced Dec 11, 2024
Open
Closed
Josmithr pushed a commit to Josmithr/FluidFramework that referenced this pull request Dec 12, 2024
@markfields @tylerbutler @Josmithr
Deprecate IContainerRuntimeOptions.flushMode (microsoft#23288)
9aea98a 
Only the default value `FlushMode.TurnBased` is supported when calling
`ContainerRuntime.loadRuntime` directly, so there's no need for
consumers to pass this option in. We'll remove the option altogether in
`2.20.0`.

---------

Co-authored-by: Tyler Butler <tyler@tylerbutler.com>
@markfields markfields mentioned this pull request Dec 16, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot Copilot left review comments

@tylerbutler tylerbutler tylerbutler left review comments

@kian-thompson kian-thompson kian-thompson approved these changes

@jatgarg jatgarg jatgarg approved these changes

@alexvy86 alexvy86 alexvy86 approved these changes

@agarwal-navin agarwal-navin Awaiting requested review from agarwal-navin

@pragya91 pragya91 Awaiting requested review from pragya91 pragya91 was automatically assigned from microsoft/team-rajat

@tyler-cai-microsoft tyler-cai-microsoft Awaiting requested review from tyler-cai-microsoft tyler-cai-microsoft was automatically assigned from microsoft/team-rajat

@rajatch-ff rajatch-ff Awaiting requested review from rajatch-ff rajatch-ff was automatically assigned from microsoft/team-rajat

@MarioJGMsoft MarioJGMsoft Awaiting requested review from MarioJGMsoft MarioJGMsoft was automatically assigned from microsoft/team-rajat

Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@markfields @tylerbutler @alexvy86 @jatgarg @kian-thompson