Remove usages of deprecated setSystemUiVisibility() #29493

camsim99 · 2021-11-03T00:59:14Z

Removes uses of setSystemUiVisibility() in the engine.

Pre-launch Checklist

I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
I read the [Tree Hygiene] wiki page, which explains my responsibilities.
I read and followed the [Flutter Style Guide] and the [C++, Objective-C, Java style guides].
I listed at least one issue that this PR fixes in the description above.
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt. See [testing the engine] for instructions on
writing and running engine tests.
I updated/added relevant documentation (doc comments with ///).
I signed the [CLA].
All existing and new tests are passing.

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

wytesk133 · 2021-11-09T04:59:52Z

shell/platform/android/io/flutter/app/FlutterActivityDelegate.java

      window.setStatusBarColor(0x40000000);
-      window.getDecorView().setSystemUiVisibility(PlatformPlugin.DEFAULT_SYSTEM_UI);
+      if (Build.VERSION.SDK_INT >= 30) {
+        window.setDecorFitsSystemWindows(false);


Should we use https://developer.android.com/reference/androidx/core/view/WindowCompat instead?

Is there an advantage of using this? The window.setDecorFitsSystemWindows(boolean) behavior seems to mirror that of the windowCompat.setDecorFitsSystemWindows(window, boolean) behavior.

Edit: I do see that the windowCompat version is not compatible with the deprecated flags so I will try to use that.

{ClassName}Compat is part of the AndroidX library. It provides a compatibility layer that handles all the inconsistencies between each version behind-the-scene.

Example 1

Example 2

Since the implementation details are abstracted from us, we can worry less about adding if statements for specific versions on our side and focus more on the feature work. In this case, we should try to migrate the deprecated code to use WindowCompat and WindowInsetsControllerCompat instead.

Piinks · 2021-12-01T17:34:45Z

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

+            View.SYSTEM_UI_FLAG_LAYOUT_STABLE
+                | View.SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
+                | View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN
+                | View.SYSTEM_UI_FLAG_HIDE_NAVIGATION
+                | View.SYSTEM_UI_FLAG_FULLSCREEN;


These flags are also deprecated aren't they? Or are these going to be migrated in a separate change?

The new API is backwards compatible, so I will take care of these in this PR as well!

blasten · 2022-01-13T00:15:45Z

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

+    setSystemChromeEnabledSystemUIMode(currentSystemUiMode);
+
+    if (currentOverlays != null) {
+      setSystemChromeEnabledSystemUIOverlays(currentOverlays);


setSystemChromeEnabledSystemUIOverlays sets currentOverlays.

Is what situation updateSystemUiOverlays needs to call setSystemChromeEnabledSystemUIOverlays again with the same value?

If someone decides to make a call to setSystemChromeEnabledSystemUIMode after updateSystemUiOverlays is called to change the systemUiMode, this could possibly hide some of the system bars, so then calling updateSystemUiOverlays would show those system bars again.

right, but wouldn't an external call to setSystemChromeEnabledSystemUIMode set a new currentSystemUiMode , thus making updateSystemUiOverlays() call setSystemChromeEnabledSystemUIMode(currentSystemUiMode) with the same value?

Oh, I see what you mean. In that case, if currentOverlays isn't null, then there's no need to make the call to setSystemChromeEnabledSystemUIMode.

blasten

LGTM! - I will defer to @Piinks for final review :)

Piinks

blasten · 2022-01-13T19:05:50Z

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

+    } else {
+      if (currentTheme != null) {


nit else/if -> else if (currentTheme != null)) {

…engine#29493)

wytesk133 · 2022-01-14T09:27:45Z

shell/platform/android/io/flutter/app/FlutterActivityDelegate.java

      window.addFlags(LayoutParams.FLAG_DRAWS_SYSTEM_BAR_BACKGROUNDS);
      window.setStatusBarColor(0x40000000);
-      window.getDecorView().setSystemUiVisibility(PlatformPlugin.DEFAULT_SYSTEM_UI);
+      WindowCompat.setDecorFitsSystemWindows(window, false);


This line means edge-to-edge mode will become the default mode (related to flutter/flutter#86248 ?). It would be great if we can eventually land this, but do note that it will be a breaking change for apps that don't handle paddings/safe area properly. My team had to manually apply non-trivial fixes (e.g. cl/397106186 and cl/397283284) before enabling this.

wytesk133 · 2022-01-14T09:40:59Z

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java

+    if (systemUiMode == PlatformChannel.SystemUiMode.LEAN_BACK) {
      // LEAN BACK
-      // Available starting at SDK 16
+      // Available starting at SDK 20, due to the backwards compatibility provided by the


It would be great if we can eventually migrate from the deprecated APIs to use AndroidX's compat libraries, but according to https://docs.flutter.dev/development/tools/sdk/release-notes/supported-platforms we are also supporting API 19. Seems like everything here and below will require API 20+. We might need to rethink a bit on the supported modes and the default mode (especially if edge-to-edge, which works best on API 29+, is going to be the new default).

This reverts commit 8db5038.

…engine#29493)

flutter/engine@fab1982...83d99a5 2022-01-14 [email protected] Roll Fuchsia Linux SDK from 35I2K_Bou... to V541xkYVr... (flutter/engine#30879) 2022-01-14 [email protected] Roll Dart SDK from dcab0d0b2f6c to d0d4dbfc6e69 (1 revision) (flutter/engine#30878) 2022-01-14 [email protected] Roll Skia from 1f0e64acd621 to f260a297c68d (1 revision) (flutter/engine#30877) 2022-01-14 [email protected] [fuchsia] stamp package with target api level (flutter/engine#30857) 2022-01-14 [email protected] Roll Skia from dd9e165ef7d0 to 1f0e64acd621 (1 revision) (flutter/engine#30876) 2022-01-14 [email protected] Roll Fuchsia Mac SDK from BQ2l2096A... to bGW3xlB1D... (flutter/engine#30875) 2022-01-14 [email protected] Roll Skia from 7aec4b164e79 to dd9e165ef7d0 (1 revision) (flutter/engine#30874) 2022-01-14 [email protected] Roll Dart SDK from 68ccd13498be to dcab0d0b2f6c (1 revision) (flutter/engine#30872) 2022-01-14 [email protected] Roll Dart SDK from aa6fbac07951 to 68ccd13498be (1 revision) (flutter/engine#30870) 2022-01-14 [email protected] Roll Skia from 76e62d32d979 to 7aec4b164e79 (1 revision) (flutter/engine#30869) 2022-01-14 [email protected] Roll Skia from a6f2ebf30fea to 76e62d32d979 (1 revision) (flutter/engine#30868) 2022-01-14 [email protected] Roll Dart SDK from ba044d5e9c03 to aa6fbac07951 (1 revision) (flutter/engine#30867) 2022-01-14 [email protected] Roll Skia from 7c80b2f08ead to a6f2ebf30fea (1 revision) (flutter/engine#30863) 2022-01-14 [email protected] [Windows, Keyboard] Lift key event redispatching to KeyboardManagerWin32 (flutter/engine#30702) 2022-01-14 [email protected] Ensure that PlatformViewIOS does not call into Shell semantics APIs during destruction (flutter/engine#30835) 2022-01-14 [email protected] Roll Skia from 119fb6bb2568 to 7c80b2f08ead (1 revision) (flutter/engine#30862) 2022-01-14 [email protected] Roll Dart SDK from b36d861d5487 to ba044d5e9c03 (1 revision) (flutter/engine#30861) 2022-01-14 [email protected] Roll Skia from 62b32180c192 to 119fb6bb2568 (1 revision) (flutter/engine#30860) 2022-01-14 [email protected] Roll Fuchsia Mac SDK from Uvw9UoGSm... to BQ2l2096A... (flutter/engine#30859) 2022-01-13 [email protected] Move SoftwareCanvasProvider into its own source file (flutter/engine#30856) 2022-01-13 [email protected] Roll Skia from c505bdca9d60 to 62b32180c192 (1 revision) (flutter/engine#30855) 2022-01-13 [email protected] Create a DisplayList benchmarks dylib on iOS (flutter/engine#30833) 2022-01-13 [email protected] Don't retain the MTLTexture or MTLDevice in TestMetalContext (flutter/engine#30832) 2022-01-13 [email protected] Roll Skia from 455e580b9c78 to c505bdca9d60 (1 revision) (flutter/engine#30852) 2022-01-13 [email protected] Roll buildroot to 7effd69. (flutter/engine#30851) 2022-01-13 [email protected] Remove unused field initializing formal parameters. (flutter/engine#30822) 2022-01-13 [email protected] Roll Dart SDK from f1c98a571d1a to b36d861d5487 (1 revision) (flutter/engine#30850) 2022-01-13 [email protected] Roll Skia from 759bc62a06d2 to 455e580b9c78 (2 revisions) (flutter/engine#30849) 2022-01-13 [email protected] Remove usages of deprecated setSystemUiVisibility() (flutter/engine#29493) 2022-01-13 [email protected] Roll Skia from b21c4af0f670 to 759bc62a06d2 (3 revisions) (flutter/engine#30848) 2022-01-13 [email protected] [fuchsia] Switch from core-jit to core snapshots. (flutter/engine#30744) Also rolling transitive DEPS: fuchsia/sdk/core/linux-amd64 from 35I2K_BouXUN to V541xkYVrdUC fuchsia/sdk/core/mac-amd64 from Uvw9UoGSmIjy to bGW3xlB1DoAm

…engine#29493)

* a193f08 [fuchsia] Switch from core-jit to core snapshots. (flutter/engine#30744) * 7e50462 Roll Skia from b21c4af0f670 to 759bc62a06d2 (3 revisions) (flutter/engine#30848) * 8db5038 Remove usages of deprecated setSystemUiVisibility() (flutter/engine#29493) * c05d0df Roll Skia from 759bc62a06d2 to 455e580b9c78 (2 revisions) (flutter/engine#30849) * 1fab2fb Roll Dart SDK from f1c98a571d1a to b36d861d5487 (1 revision) (flutter/engine#30850) * f9385e7 Remove unused field initializing formal parameters. (flutter/engine#30822) * b6e5d99 Roll buildroot to 7effd69. (flutter/engine#30851) * 742eaf8 Roll Skia from 455e580b9c78 to c505bdca9d60 (1 revision) (flutter/engine#30852) * d0f2beb Don't retain the MTLTexture or MTLDevice in TestMetalContext (flutter/engine#30832) * f121c1f Create a DisplayList benchmarks dylib on iOS (flutter/engine#30833) * 4499797 Roll Skia from c505bdca9d60 to 62b32180c192 (1 revision) (flutter/engine#30855) * fcf7458 Move SoftwareCanvasProvider into its own source file (flutter/engine#30856) * 794a833 Roll Fuchsia Mac SDK from Uvw9UoGSm... to BQ2l2096A... (flutter/engine#30859) * 4b32e1c Roll Skia from 62b32180c192 to 119fb6bb2568 (1 revision) (flutter/engine#30860) * facfa74 Roll Dart SDK from b36d861d5487 to ba044d5e9c03 (1 revision) (flutter/engine#30861) * f6613c9 Roll Skia from 119fb6bb2568 to 7c80b2f08ead (1 revision) (flutter/engine#30862) * fb3ee7f Ensure that PlatformViewIOS does not call into Shell semantics APIs during destruction (flutter/engine#30835) * 073e6c5 [Windows, Keyboard] Lift key event redispatching to KeyboardManagerWin32 (flutter/engine#30702) * 88e67a2 Roll Skia from 7c80b2f08ead to a6f2ebf30fea (1 revision) (flutter/engine#30863) * 1f4e7fa Roll Dart SDK from ba044d5e9c03 to aa6fbac07951 (1 revision) (flutter/engine#30867) * 3fbd427 Roll Skia from a6f2ebf30fea to 76e62d32d979 (1 revision) (flutter/engine#30868) * b6db081 Roll Skia from 76e62d32d979 to 7aec4b164e79 (1 revision) (flutter/engine#30869) * b92fd27 Roll Dart SDK from aa6fbac07951 to 68ccd13498be (1 revision) (flutter/engine#30870) * 8961366 Roll Dart SDK from 68ccd13498be to dcab0d0b2f6c (1 revision) (flutter/engine#30872) * 18ea2ce Roll Skia from 7aec4b164e79 to dd9e165ef7d0 (1 revision) (flutter/engine#30874) * 9d660d9 Roll Fuchsia Mac SDK from BQ2l2096A... to bGW3xlB1D... (flutter/engine#30875) * ad68b1b Roll Skia from dd9e165ef7d0 to 1f0e64acd621 (1 revision) (flutter/engine#30876) * b61a6f5 [fuchsia] stamp package with target api level (flutter/engine#30857) * 5787489 Roll Skia from 1f0e64acd621 to f260a297c68d (1 revision) (flutter/engine#30877) * 87ba2d8 Roll Dart SDK from dcab0d0b2f6c to d0d4dbfc6e69 (1 revision) (flutter/engine#30878) * 83d99a5 Roll Fuchsia Linux SDK from 35I2K_Bou... to V541xkYVr... (flutter/engine#30879) * 50adf4c Revert "Remove usages of deprecated setSystemUiVisibility()" (flutter/engine#30880)

camsim99 added 4 commits November 2, 2021 15:22

Add usage of updated window, system bar appearance APIs

d4ac98a

Format java file:

a3fc96c

Format file

ef971cf

Format file

136b0a5

flutter-dashboard bot added the platform-android label Nov 3, 2021

google-cla bot added the cla: yes label Nov 3, 2021

blasten reviewed Nov 3, 2021

View reviewed changes

shell/platform/android/io/flutter/plugin/platform/PlatformPlugin.java Outdated Show resolved Hide resolved

camsim99 added 3 commits November 3, 2021 16:11

add fix for flutter activitiy delegate

6b0acd3

format file

f34f876

Add changes for flutter activity and fragment activity

15959f6

wytesk133 reviewed Nov 9, 2021

View reviewed changes

camsim99 added 6 commits November 9, 2021 10:37

Make fixes based on manual testing

2dab838

replace setdecorfitssystemwindows methods

66e1276

Format platform plugin

5d70fd6

add one liners

6377d18

format file

6c7c963

change setdecorfitssystem methods

4521517

blasten mentioned this pull request Nov 12, 2021

SystemUiMode.edgeToEdge bottom viewInset jumps when keyboard is opening flutter/flutter#89914

Closed

CaseyHillers changed the base branch from master to main November 15, 2021 18:13

fluttergithubbot force-pushed the master branch from b1a8771 to 2962099 Compare November 15, 2021 18:30

godofredoc changed the base branch from master to main November 24, 2021 07:01

Piinks reviewed Dec 1, 2021

View reviewed changes

camsim99 added 8 commits December 1, 2021 16:08

Merge remote-tracking branch 'upstream/master' into issue_199402891_dev

21ab396

Remove old code

8de6247

Remove changes from deprecated method

42419c5

Update window inset type

968a33c

Remove old code

f3e0724

Format files

1e60656

Reformat file

c273413

WIP fixing tests

19629c8

camsim99 added 2 commits January 12, 2022 11:35

Remove check

2e2747d

Add comments, add back version check

881a2db

blasten reviewed Jan 13, 2022

View reviewed changes

blasten approved these changes Jan 13, 2022

View reviewed changes

Piinks approved these changes Jan 13, 2022

View reviewed changes

Move conditional

8db28bc

blasten reviewed Jan 13, 2022

View reviewed changes

Nit

cf6159f

camsim99 added the waiting for tree to go green This PR is approved and tested, but waiting for the tree to be green to land. label Jan 13, 2022

fluttergithubbot merged commit 8db5038 into flutter:main Jan 13, 2022

engine-flutter-autoroll mentioned this pull request Jan 13, 2022

Roll Engine from fab19829949d to b6e5d999c229 (7 revisions) flutter/flutter#96628

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 13, 2022

8db5038 Remove usages of deprecated setSystemUiVisibility() (flutter/…

200100a

…engine#29493)

engine-flutter-autoroll mentioned this pull request Jan 13, 2022

Roll Engine from fab19829949d to f121c1fe6843 (10 revisions) flutter/flutter#96631

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 13, 2022

8db5038 Remove usages of deprecated setSystemUiVisibility() (flutter/…

99acea0

…engine#29493)

JsouLiang pushed a commit to JsouLiang/engine that referenced this pull request Jan 14, 2022

Remove usages of deprecated setSystemUiVisibility() (flutter#29493)

5886cf9

wytesk133 reviewed Jan 14, 2022

View reviewed changes

blasten pushed a commit that referenced this pull request Jan 14, 2022

Revert "Remove usages of deprecated setSystemUiVisibility() (#29493)"

bb95430

This reverts commit 8db5038.

blasten mentioned this pull request Jan 14, 2022

Revert "Remove usages of deprecated setSystemUiVisibility()" #30880

Merged

engine-flutter-autoroll mentioned this pull request Jan 14, 2022

Roll Engine from fab19829949d to 83d99a58097b (31 revisions) flutter/flutter#96673

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 14, 2022

8db5038 Remove usages of deprecated setSystemUiVisibility() (flutter/…

2bc3ccb

…engine#29493)

iskakaushik mentioned this pull request Jan 15, 2022

Roll Engine from fab19829949d to 83d99a58097b (31 revisions) flutter/flutter#96687

Closed

This was referenced Jan 18, 2022

Revert "Roll Engine from fab19829949d to 83d99a58097b (31 revisions)" flutter/flutter#96777

Merged

Revert "Remove usages of deprecated setSystemUiVisibility()" #30904

Closed

engine-flutter-autoroll mentioned this pull request Jan 18, 2022

Roll Engine from fab19829949d to 50adf4c1f79e (32 revisions) flutter/flutter#96778

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Jan 18, 2022

8db5038 Remove usages of deprecated setSystemUiVisibility() (flutter/…

97db37e

…engine#29493)

camsim99 mentioned this pull request Jan 31, 2022

Partially remove setSystemUiVisibility() usages #31092

Merged

8 tasks

Remove usages of deprecated setSystemUiVisibility() #29493

Remove usages of deprecated setSystemUiVisibility() #29493

Uh oh!

Conversation

camsim99 commented Nov 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

camsim99 Nov 9, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blasten left a comment

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wytesk133 Jan 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

camsim99 commented Nov 3, 2021 •

edited

Loading

camsim99 Nov 9, 2021 •

edited

Loading

wytesk133 Jan 14, 2022 •

edited

Loading