Change visibility of FlutterView when onStop/onStart #30897

ColdPaleLight · 2022-01-15T10:57:23Z

Some OnePlus phones can still update the view tree after locking the screen in some cases, which causes the surfaceCreated method of SurfaceView.Holder can be called when the screen is turned off, and surfaceCreated will not be called when the screen is turned on. And changing the visibility of FlutterSurfaceView in onStart and onStop can fix this problem.

detail
flutter/flutter#93276 (comment)

PS: Setting the visibility of FlutterView directly at onStart and onStop can also solve this problem. However based on my current investigations TextureView shouldn't have this problem (it doesn't call onSurfaceTextureDestroyed when the screen is off, so no need to call onSurfaceTextureAvailable when the screen is on), Please let me know if you guys think it makes more sense to change the visibility of FlutterView.

Fix flutter/flutter#93276, flutter/flutter#94921.

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.

flutter-dashboard · 2022-01-15T10:57:26Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

dnfield · 2022-01-18T19:20:22Z

shell/platform/android/io/flutter/embedding/android/FlutterView.java

+    if (flutterSurfaceView != null) {
+      flutterSurfaceView.setVisibility(View.VISIBLE);
+    }
+  }
+
+  // Invoke this from {@code FlutterActivityAndFragmentDelegate#onStop()}
+  /* package */ void onStop() {
+    if (flutterSurfaceView != null) {
+      flutterSurfaceView.setVisibility(View.GONE);
+    }
+  }
+


We've tried to resist adding API like this historically because it's likely to get missed when you don't use the FlutterActivityAndFragmentDelegate class, IIRC. @xster or @blasten wdyt?

I'm curious about where the view is getting the wrong visibility set and why this helps. I'm also curious if we're getting calls on View.invalidateDrawable at some point here that might help us - if we can take advantage of the View's own lifecycle it'd be better.

Or alternatively if we're getting calls to onDraw or onWindowVisibilityChanged/onAttachedToWindow.

I guess these methods might not work. In this scenario, the onStart and onStop of the Activity are correct, but the visibility of the window/view tree is still visible after onStop.

dnfield

Would like to better understand if we can avoid the View hooking Activity/Fragment lifecycle.

dnfield · 2022-01-18T19:21:07Z

shell/platform/android/io/flutter/embedding/android/FlutterView.java

+    if (flutterSurfaceView != null) {
+      flutterSurfaceView.setVisibility(View.VISIBLE);
+    }
+  }
+
+  // Invoke this from {@code FlutterActivityAndFragmentDelegate#onStop()}
+  /* package */ void onStop() {
+    if (flutterSurfaceView != null) {
+      flutterSurfaceView.setVisibility(View.GONE);
+    }
+  }
+


Or alternatively if we're getting calls to onDraw or onWindowVisibilityChanged/onAttachedToWindow.

ColdPaleLight · 2022-01-19T03:52:28Z

@dnfield

I changed the code to set the visibility of FlutterView in onStart and onStop of FlutterActivityAndFragmentDelegate.
Since the methods onStart and onStop of FlutterActivityAndFragmentDelegate are not public, it is only called in the onStart and onStop of FlutterActivity/FlutterFragment. So this change should be safe.

dnfield

I think this is fine to at least work around the bug for now, but it would be better if we could find some way to avoid needing this.

dnfield · 2022-01-19T23:54:31Z

shell/platform/android/io/flutter/embedding/android/FlutterActivityAndFragmentDelegate.java

    Log.v(TAG, "onStart()");
    ensureAlive();
    doInitialFlutterViewRun();
+    flutterView.setVisibility(View.VISIBLE);


nit: please add some comment(s) here and below about why we're doing this, with a link to the bug

…/engine#30897)

zhangruiyu · 2022-01-21T02:24:31Z

when will it be merged into stable

dnfield · 2022-01-21T02:28:27Z

There is a work around posted on the bug that you can patch into your own app. I don't think we should go through the process of cherry picking for this.

zxjzerg · 2022-06-01T11:53:17Z

shell/platform/android/io/flutter/embedding/android/FlutterActivityAndFragmentDelegate.java

+    // screen when unlocked. We can work around this by changing the visibility of FlutterView in
+    // onStart and onStop.
+    // See https://github.com/flutter/flutter/issues/93276
+    flutterView.setVisibility(View.VISIBLE);


I meet an issue because of this edit. My use case is I use FlutterFragment as a tab in Activity, when user switched to other tabs, I will hide the FlutterFragment. After this commit, every time Activity resumed, the flutterView will be foreced to visible, even the FlutterFragment is set to hide.

Please file a new issue with minimum reproducible code, thank you.

Please file a new issue with minimum reproducible code, thank you.

this merge doest fix the issue;

this is my code to reproduce,

amanmalhotra-cred · 2023-10-04T23:41:02Z

we have started facing an issue because of this change in our add to app approach when we recently migrated from flutter 2.10.3 -> 3.13.4.

we have a tab holder fragment in native where centre tab is native and adjacent two tabs are flutter.
while switching tabs we have fragmant transaction animation that happens
before this change, we were able to see the flutter view during that transition of fragment from one to another basically one goes down second comes up, post this change, when first fragment starts to go down, flutter view becomes invisible and the native fragment appears giving a flicker.

codewithmashi · 2025-01-01T02:07:07Z

Still Showing Black Screen on Samsung s21fe android 14. After Updating the app. Fixed the issue by clearing the data of app.

[√] Flutter (Channel stable, 3.24.4, on Microsoft Windows [Version 10.0.26100.2605], locale en-US)
[√] Windows Version (Installed version of Windows is version 10 or higher)
[√] Android toolchain - develop for Android devices (Android SDK version 35.0.0)

Got this Black Screen Error After Updating the app. Unless you do clear data.
So Anyone know how to fix it.

Remove/Add FlutterSurfaceView at onStop/onStart

515e735

flutter-dashboard bot added the platform-android label Jan 15, 2022

flutter-dashboard bot added the needs tests label Jan 15, 2022

Fix unittests

e144a6b

ColdPaleLight mentioned this pull request Jan 16, 2022

[Android] App shows black screen after being in the background. flutter/flutter#93276

Closed

Tweak the code add add some unit tests

b44cfce

ColdPaleLight requested review from blasten and dnfield January 16, 2022 15:53

ColdPaleLight changed the title ~~Remove/Add FlutterSurfaceView at onStop/onStart~~ change visibility of FlutterSurfaceView when onStop/onStart Jan 16, 2022

ColdPaleLight changed the title ~~change visibility of FlutterSurfaceView when onStop/onStart~~ Change visibility of FlutterSurfaceView when onStop/onStart Jan 16, 2022

AlexV525 mentioned this pull request Jan 17, 2022

[Android] Running an app with debug scene when the device is locked cause a black screen on Android flutter/flutter#94921

Closed

ColdPaleLight removed the needs tests label Jan 17, 2022

dnfield reviewed Jan 18, 2022

View reviewed changes

dnfield suggested changes Jan 18, 2022

View reviewed changes

Change visibility of FlutterView when onStop/onStart

644f990

ColdPaleLight force-pushed the fix_one_plus_black_screen branch from 802ef43 to 644f990 Compare January 19, 2022 03:39

ColdPaleLight requested a review from dnfield January 19, 2022 03:52

ColdPaleLight changed the title ~~Change visibility of FlutterSurfaceView when onStop/onStart~~ Change visibility of FlutterView when onStop/onStart Jan 19, 2022

dnfield approved these changes Jan 19, 2022

View reviewed changes

dnfield reviewed Jan 19, 2022

View reviewed changes

Add comments

930bba2

chinmaygarde 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 20, 2022

fluttergithubbot merged commit ed3704c into flutter:main Jan 20, 2022

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

Roll Engine from 84e48990dc8f to cd65368f9dec (9 revisions) flutter/flutter#96963

Merged

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

ed3704c Change visibility of FlutterView when onStop/onStart (flutter…

7d1d377

…/engine#30897)

zxjzerg reviewed Jun 1, 2022

View reviewed changes

zxjzerg mentioned this pull request Jun 2, 2022

FlutterFragment forced to visiable when Activity resumed flutter/flutter#105203

Closed

yk3372 mentioned this pull request Aug 23, 2022

Huawei HarmonyOS Black Screen after being in background flutter/flutter#109908

Closed

ILoveOpenSourceApplications mentioned this pull request Feb 28, 2024

bug: Occasional black screen when returning to Manager ReVanced/revanced-manager#1635

Closed

4 tasks

Change visibility of FlutterView when onStop/onStart #30897

Change visibility of FlutterView when onStop/onStart #30897

Uh oh!

Conversation

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

Uh oh!

Pre-launch Checklist

Uh oh!

flutter-dashboard bot commented Jan 15, 2022

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!

dnfield left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ColdPaleLight commented Jan 19, 2022

Uh oh!

dnfield left a comment

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!

zhangruiyu commented Jan 21, 2022

Uh oh!

dnfield commented Jan 21, 2022

Uh oh!

zxjzerg Jun 1, 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!

Choose a reason for hiding this comment

Uh oh!

amanmalhotra-cred commented Oct 4, 2023

Uh oh!

codewithmashi commented Jan 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

ColdPaleLight commented Jan 15, 2022 •

edited

Loading

zxjzerg Jun 1, 2022 •

edited

Loading