Skip to content

Conversation

@jesswrd
Copy link
Contributor

@jesswrd jesswrd commented Jan 7, 2025

Updated usages of statusBar() to systemBar() to fix XiaoMi statusBar bug.

Fixes #132831

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@github-actions github-actions bot added platform-android Android applications specifically engine flutter/engine related. See also e: labels. labels Jan 7, 2025
@jesswrd jesswrd changed the title Fixed XiaoMi statusBar() Bug Fixed XiaoMi statusBar Bug Jan 7, 2025
@jesswrd jesswrd marked this pull request as ready for review January 8, 2025 00:45
@jesswrd jesswrd requested a review from reidbaker January 8, 2025 00:45
@reidbaker
Copy link
Contributor

Looking at this documentation here again the difference is that systemBars does not include ime https://developer.android.com/reference/android/view/WindowInsets.Type#ime()

I think our code might actually be correct in that we want input types as well. Is it possible to verify that this change actually fixes the issue the XiaoMi user was seeing? My first past on the documentation makes me think this cant add any inset that would allow us to inset correctly.

if (navigationBarVisible) {
mask = mask | android.view.WindowInsets.Type.navigationBars();
}
if (statusBarVisible) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider renaming this variable

Copy link
Contributor Author

@jesswrd jesswrd Jan 14, 2025

Choose a reason for hiding this comment

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

deleted the masking code and used systemBars instead

.setInsets(
android.view.WindowInsets.Type.navigationBars()
| android.view.WindowInsets.Type.statusBars(),
| android.view.WindowInsets.Type.systemBars(),
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we add a test that sets the statusbars insets to something other than 100. To make sure we are using systemBars instead of status bars?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@reidbaker
Copy link
Contributor

Looking at this documentation here again the difference is that systemBars does not include ime https://developer.android.com/reference/android/view/WindowInsets.Type#ime()

I think our code might actually be correct in that we want input types as well. Is it possible to verify that this change actually fixes the issue the XiaoMi user was seeing? My first past on the documentation makes me think this cant add any inset that would allow us to inset correctly.

@jesswrd and I looked at this yesterday. An internal doc states that to support edge to edge we need to move usage of statusBars to systemBars so that is what we will do. There is code that handles status bars only if they are visible and a straight replacement would invalidate some of that code so @jesswrd is going to add tests for that behavior and we are going to make sure we dont regress a non full screen inset logic when we fix the support for xiaomi (which is a broader bug impacting more devices but this gave us an easy to reproduce case).

I believe the actual code level issue is not including systemOverlays.

// getSystemUiVisibility
// This test uses the API 30+ Algorithm for window insets. This test requires API 34 or
// higher to use the systemOverlays inset. The legacy algorithm is
// set to -1 values, so it is clear if the wrong algorithm is used.
Copy link
Contributor

Choose a reason for hiding this comment

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

Great comment helping explain the test!

// set to -1 values, so it is clear if the wrong algorithm is used.
@Test
@TargetApi(34)
@Config(sdk = 34)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you want this to be minSdk instead of sdk so that it run against api 35 and beyond.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

FlutterRenderer flutterRenderer = spy(new FlutterRenderer(mockFlutterJni));
when(flutterEngine.getRenderer()).thenReturn(flutterRenderer);

// When we attach a new FlutterView to the engine without any system insets, the viewport
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this comment should probably move to line 357 where we verify top is zero.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done


// Verify.
verify(flutterRenderer, times(3)).setViewportMetrics(viewportMetricsCaptor.capture());
// Confirm that the statusBar inset is used because it is greater.
Copy link
Contributor

Choose a reason for hiding this comment

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

greater -> largest of the insets faked.
or
larger than captionBar

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

WindowInsets navigationBarwindowInsets =
new WindowInsets.Builder()
.setInsets(android.view.WindowInsets.Type.navigationBars(), Insets.of(0, 0, 0, 10))
.setInsets(android.view.WindowInsets.Type.navigationBars(), Insets.of(0, 0, 0, 50))
Copy link
Contributor

Choose a reason for hiding this comment

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

Why use navigationBars twice?

Copy link
Contributor Author

@jesswrd jesswrd Jan 14, 2025

Choose a reason for hiding this comment

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

an accident meant to use systemOverlays() thanks for catching it! done

validateViewportMetricPadding(viewportMetricsCaptor, 0, 100, 0, 0);
clearInvocations(flutterRenderer);

// Then we simulate the system applying a window inset.
Copy link
Contributor

Choose a reason for hiding this comment

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

I am not sure this comment has value my guess is this is a copy paste.

Remove it or make it valuable like "Then simulate the system applying a navigationbar inset."

Here and below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@jesswrd jesswrd added the autosubmit Merge PR when tree becomes green via auto submit App label Jan 14, 2025
@auto-submit auto-submit bot added this pull request to the merge queue Jan 15, 2025
Merged via the queue into flutter:master with commit d832220 Jan 15, 2025
181 checks passed
@flutter-dashboard flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Jan 15, 2025
maheshj01 pushed a commit to maheshj01/flutter that referenced this pull request Jan 15, 2025
Updated usages of statusBar() to systemBar() to fix XiaoMi statusBar
bug.

Fixes flutter#132831 

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [x] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 15, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 15, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 15, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jan 16, 2025
auto-submit bot pushed a commit to flutter/packages that referenced this pull request Jan 16, 2025
flutter/flutter@40c2b86...5517cc9

2025-01-15 [email protected] feat: Change default value of keyboardDismissBehavior (flutter/flutter#158580)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161680)
2025-01-15 [email protected] Revert "Autocomplete Options Width" (flutter/flutter#161666)
2025-01-15 [email protected] Update two_dimensional_scrollables triage routing (flutter/flutter#161667)
2025-01-15 [email protected] [DisplayList] Migrate from SkRSXform to Impeller RSTransform (flutter/flutter#161652)
2025-01-15 [email protected] Roll Packages from d1fd623 to f73cb00 (2 revisions) (flutter/flutter#161672)
2025-01-15 [email protected] Fix DropdownMenu isCollapsed decoration does not Reduce height (flutter/flutter#161427)
2025-01-15 [email protected] Manual roll of Skia to e7b8d078851f (flutter/flutter#161609)
2025-01-15 [email protected] Fix `TabBar` glitchy elastic `Tab`  animation (flutter/flutter#161514)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161643)
2025-01-15 [email protected] Exclude the top-level `engine` directory from `generate_gradle_lockfiles`. (flutter/flutter#161635)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161632)
2025-01-15 [email protected] Refactor `android_engine_test`, make it easier to debug/deflake locally. (flutter/flutter#161534)
2025-01-15 [email protected] [Impeller] null check device buffer in image encoding. (flutter/flutter#161194)
2025-01-15 [email protected] Feature/twitter keyboard (flutter/flutter#161025)
2025-01-15 [email protected] Fixed XiaoMi statusBar Bug (flutter/flutter#161271)
2025-01-15 [email protected] Clean up engine's analysis_options.yaml (flutter/flutter#161554)
2025-01-14 [email protected] Remove `gradle_deprecated_settings` test app, and remove reference from lockfile exclusion yaml (flutter/flutter#161622)
2025-01-14 [email protected] [deps] remove no-longer-used repo deps (flutter/flutter#161605)
2025-01-14 [email protected] [DisplayList] remove obsolete use of Skia goemetry objects in DL utils (flutter/flutter#161553)
2025-01-14 [email protected] [Engine] Support asymmetrical rounded superellipses (flutter/flutter#161409)
2025-01-14 [email protected] [SwiftPM] Make 'flutter build ios-framework' generate an empty Package.swift (flutter/flutter#161464)
2025-01-14 [email protected] [canvaskit] Fix GIF decode failure (flutter/flutter#161536)
2025-01-14 [email protected] [Impeller] fixes for AHB swapchains. (flutter/flutter#161562)
2025-01-14 [email protected] Last Engine<>Framework lint sync (flutter/flutter#161560)
2025-01-14 [email protected] Check that localization files of stocks app are up-to-date (flutter/flutter#161608)
2025-01-14 [email protected] [Android] Actually remove dev dependencies from release builds (flutter/flutter#161343)
2025-01-14 [email protected] Update package revisions to latest (flutter/flutter#161525)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 12, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 13, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 6, 2025
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Mar 7, 2025
androidseb pushed a commit to androidseb/packages that referenced this pull request Jun 8, 2025
flutter/flutter@40c2b86...5517cc9

2025-01-15 [email protected] feat: Change default value of keyboardDismissBehavior (flutter/flutter#158580)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161680)
2025-01-15 [email protected] Revert "Autocomplete Options Width" (flutter/flutter#161666)
2025-01-15 [email protected] Update two_dimensional_scrollables triage routing (flutter/flutter#161667)
2025-01-15 [email protected] [DisplayList] Migrate from SkRSXform to Impeller RSTransform (flutter/flutter#161652)
2025-01-15 [email protected] Roll Packages from d1fd623 to f73cb00 (2 revisions) (flutter/flutter#161672)
2025-01-15 [email protected] Fix DropdownMenu isCollapsed decoration does not Reduce height (flutter/flutter#161427)
2025-01-15 [email protected] Manual roll of Skia to e7b8d078851f (flutter/flutter#161609)
2025-01-15 [email protected] Fix `TabBar` glitchy elastic `Tab`  animation (flutter/flutter#161514)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161643)
2025-01-15 [email protected] Exclude the top-level `engine` directory from `generate_gradle_lockfiles`. (flutter/flutter#161635)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161632)
2025-01-15 [email protected] Refactor `android_engine_test`, make it easier to debug/deflake locally. (flutter/flutter#161534)
2025-01-15 [email protected] [Impeller] null check device buffer in image encoding. (flutter/flutter#161194)
2025-01-15 [email protected] Feature/twitter keyboard (flutter/flutter#161025)
2025-01-15 [email protected] Fixed XiaoMi statusBar Bug (flutter/flutter#161271)
2025-01-15 [email protected] Clean up engine's analysis_options.yaml (flutter/flutter#161554)
2025-01-14 [email protected] Remove `gradle_deprecated_settings` test app, and remove reference from lockfile exclusion yaml (flutter/flutter#161622)
2025-01-14 [email protected] [deps] remove no-longer-used repo deps (flutter/flutter#161605)
2025-01-14 [email protected] [DisplayList] remove obsolete use of Skia goemetry objects in DL utils (flutter/flutter#161553)
2025-01-14 [email protected] [Engine] Support asymmetrical rounded superellipses (flutter/flutter#161409)
2025-01-14 [email protected] [SwiftPM] Make 'flutter build ios-framework' generate an empty Package.swift (flutter/flutter#161464)
2025-01-14 [email protected] [canvaskit] Fix GIF decode failure (flutter/flutter#161536)
2025-01-14 [email protected] [Impeller] fixes for AHB swapchains. (flutter/flutter#161562)
2025-01-14 [email protected] Last Engine<>Framework lint sync (flutter/flutter#161560)
2025-01-14 [email protected] Check that localization files of stocks app are up-to-date (flutter/flutter#161608)
2025-01-14 [email protected] [Android] Actually remove dev dependencies from release builds (flutter/flutter#161343)
2025-01-14 [email protected] Update package revisions to latest (flutter/flutter#161525)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
FMorschel pushed a commit to FMorschel/packages that referenced this pull request Jun 9, 2025
flutter/flutter@40c2b86...5517cc9

2025-01-15 [email protected] feat: Change default value of keyboardDismissBehavior (flutter/flutter#158580)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161680)
2025-01-15 [email protected] Revert "Autocomplete Options Width" (flutter/flutter#161666)
2025-01-15 [email protected] Update two_dimensional_scrollables triage routing (flutter/flutter#161667)
2025-01-15 [email protected] [DisplayList] Migrate from SkRSXform to Impeller RSTransform (flutter/flutter#161652)
2025-01-15 [email protected] Roll Packages from d1fd623 to f73cb00 (2 revisions) (flutter/flutter#161672)
2025-01-15 [email protected] Fix DropdownMenu isCollapsed decoration does not Reduce height (flutter/flutter#161427)
2025-01-15 [email protected] Manual roll of Skia to e7b8d078851f (flutter/flutter#161609)
2025-01-15 [email protected] Fix `TabBar` glitchy elastic `Tab`  animation (flutter/flutter#161514)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161643)
2025-01-15 [email protected] Exclude the top-level `engine` directory from `generate_gradle_lockfiles`. (flutter/flutter#161635)
2025-01-15 [email protected] Roll pub packages (flutter/flutter#161632)
2025-01-15 [email protected] Refactor `android_engine_test`, make it easier to debug/deflake locally. (flutter/flutter#161534)
2025-01-15 [email protected] [Impeller] null check device buffer in image encoding. (flutter/flutter#161194)
2025-01-15 [email protected] Feature/twitter keyboard (flutter/flutter#161025)
2025-01-15 [email protected] Fixed XiaoMi statusBar Bug (flutter/flutter#161271)
2025-01-15 [email protected] Clean up engine's analysis_options.yaml (flutter/flutter#161554)
2025-01-14 [email protected] Remove `gradle_deprecated_settings` test app, and remove reference from lockfile exclusion yaml (flutter/flutter#161622)
2025-01-14 [email protected] [deps] remove no-longer-used repo deps (flutter/flutter#161605)
2025-01-14 [email protected] [DisplayList] remove obsolete use of Skia goemetry objects in DL utils (flutter/flutter#161553)
2025-01-14 [email protected] [Engine] Support asymmetrical rounded superellipses (flutter/flutter#161409)
2025-01-14 [email protected] [SwiftPM] Make 'flutter build ios-framework' generate an empty Package.swift (flutter/flutter#161464)
2025-01-14 [email protected] [canvaskit] Fix GIF decode failure (flutter/flutter#161536)
2025-01-14 [email protected] [Impeller] fixes for AHB swapchains. (flutter/flutter#161562)
2025-01-14 [email protected] Last Engine<>Framework lint sync (flutter/flutter#161560)
2025-01-14 [email protected] Check that localization files of stocks app are up-to-date (flutter/flutter#161608)
2025-01-14 [email protected] [Android] Actually remove dev dependencies from release builds (flutter/flutter#161343)
2025-01-14 [email protected] Update package revisions to latest (flutter/flutter#161525)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages
Please CC [email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

engine flutter/engine related. See also e: labels. platform-android Android applications specifically

Projects

None yet

Development

Successfully merging this pull request may close these issues.

A bug about statusbar‘s height in the multi window on Xiaomi phone

2 participants