Notify framework to clear input connection when app is backgrounded (#35054). #9498

matthew-carroll · 2019-06-26T05:46:26Z

Problem:
Flutter is not setup to handle backgrounding and then foregrounding an app when an input control has focus. The issue is visible in the new embedding because the new embedding loosens platform restrictions around FlutterActivity continuity.

Repro Steps:

Run an app with a TextField
Give focus to the TextField
Press Android's home button
Switch back to the app
Tap the TextField to give it focus again
An error appears in the logs.

The issue is that Flutter is unaware that the app was backgrounded and therefore expects the same input connection to exist when re-foregrounded. But on the Android side, the input connection was lost when the app was backgrounded and therefore needs to be recreated when foregrounded again.

Solution:
When FlutterActivity goes to the background and detaches from the FlutterEngine instance, instruct the framework to clear the input client. By clearing it, when the user taps on the control after being re-foregrounded, Flutter will request a new input connection and things should continue as expected.

Corresponding Framework PR:
flutter/flutter#35100

xster · 2019-06-26T07:26:56Z

I assume this also fixes the case of a user opening a flutter activity, focuses on text, backs out of that flutter activity while keeping the same engine, then relaunches the same activity with the same engine and focuses on text again (assuming the same problem would exist there too)?

amirh · 2019-06-26T16:45:06Z

shell/platform/android/io/flutter/plugin/editing/TextInputPlugin.java

     * The TextInputPlugin instance should not be used after calling this.
     */
    public void destroy() {
+        if (inputTarget.type != InputTarget.Type.NO_TARGET) {


We should only do this when the target is a FRAMEWORK_CLIENT (if the target is a PLATFORM_VIEW _currentConnection on the framework side is probably null).

matthew-carroll · 2019-07-13T01:04:19Z

I updated the PR with a different approach that utilizes InputConnection#closeConnection() instead of FlutterView destruction. This change in approach now solves the original but, as well as a bug where giving focus to a regular Android View did not result in Flutter UI from losing focus, or clearing of Flutter's input connection.

I also renamed the Android side message from 'clearClient' to 'onConnectionClosed'.

I'm still dubious about where and how I'm invoking unfocus(). If anyone can see a more canonical place to adjust focus, I'd like to hear it.

xster

LGTM. Let's add tests

shell/platform/android/io/flutter/embedding/engine/systemchannels/TextInputChannel.java

shell/platform/android/io/flutter/plugin/editing/TextInputPlugin.java

mklim

LGTM modulo tests

mklim · 2019-07-22T19:59:12Z

shell/platform/android/io/flutter/plugin/editing/InputConnectionAdaptor.java

+
+        textInputChannel.onConnectionClosed(mClient);
+
+        if (onConnectionClosed != null) {


nit: This is final and never null, so I think it's okay to just always run this. Not a big deal and it doesn't hurt to be safe though.

related: annotations may be worthwhile in the constructor?

Good point, I'll add annotations.

The parameters are now annotated and the if-statement has been removed.

matthew-carroll · 2019-07-22T20:33:23Z

Rebasing to resolve conflicts.

cbracken · 2019-08-05T18:27:56Z

@matthew-carroll is this mergeable?

matthew-carroll · 2019-08-05T20:30:13Z

I have to figure out why the tests are failing and fix them.

matthew-carroll · 2019-08-16T23:17:02Z

@xster @mklim I added a unit test

mklim

There are a lot of files in a testing/embedding/android/focus_new_activity_back/ that look like they've been generated as part of a tool/IDE and shouldn't be committed to source, including binary files and apk build files. I think we probably want to apply flutter/flutter's gitignore here.

New unit test LG.

mklim · 2019-08-16T23:23:26Z

testing/embedding/android/focus_new_activity_back/.flutter-plugins

@@ -0,0 +1 @@
+android_intent=/Users/mattcarroll/.pub-cache/hosted/pub.dartlang.org/android_intent-0.3.1+1/


Pretty sure this should be reverted. We probably should add files with this extension to the .gitignore.

xster · 2019-08-17T06:13:44Z

+1. It's a bit hard to review since all the build intermediaries are checked in.

…lutter#35054)

xster · 2019-08-17T07:00:25Z

LGTM

…ounded (flutter#35054) (flutter/engine#9498)

[email protected]:flutter/engine.git/compare/21ae92651a38...3e10d92 git log 21ae926..3e10d92 --no-merges --oneline 2019-08-19 [email protected] Roll src/third_party/dart 0e201edeeb..9f13d07670 (27 commits) 2019-08-19 [email protected] Notify framework to clear input connection when app is backgrounded (#35054) (flutter/engine#9498) 2019-08-19 [email protected] Re-enable firebase test and don't use google login (flutter/engine#11228) 2019-08-19 [email protected] Update tflite_native and language_model revisions to match the Dart SDK (flutter/engine#11230) 2019-08-19 [email protected] Roll src/third_party/skia f8221786d088..8566dda51b42 (4 commits) (flutter/engine#11220) 2019-08-19 [email protected] Update metal layer drawable size on relayout. (flutter/engine#11224) 2019-08-19 [email protected] Make firebase testlab always pass (flutter/engine#11226) The AutoRoll server is located here: https://autoroll.skia.org/r/flutter-engine-flutter-autoroll Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+/master/autoroll/README.md If the roll is causing failures, please contact the current sheriff ([email protected]), and stop the roller if necessary.

…ounded (flutter#35054) (flutter#9498)" This reverts commit 4003fbc.

…ounded (#35054) (#9498)" (#11720) This reverts commit 4003fbc.

googlebot added the cla: yes label Jun 26, 2019

matthew-carroll requested review from amirh, goderbauer, jason-simmons, mklim and xster June 26, 2019 05:46

matthew-carroll mentioned this pull request Jun 26, 2019

Add handling of 'TextInput.clearClient' message from platform to framework (#35054). flutter/flutter#35100

Merged

amirh reviewed Jun 26, 2019

View reviewed changes

matthew-carroll force-pushed the 35054_text_input_error_when_home_and_back branch from a4fda95 to 53190bf Compare July 13, 2019 00:56

xster reviewed Jul 15, 2019

View reviewed changes

shell/platform/android/io/flutter/embedding/engine/systemchannels/TextInputChannel.java Show resolved Hide resolved

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

mklim approved these changes Jul 22, 2019

View reviewed changes

matthew-carroll force-pushed the 35054_text_input_error_when_home_and_back branch from 818f8dc to 29155ee Compare July 22, 2019 20:33

matthew-carroll force-pushed the 35054_text_input_error_when_home_and_back branch 2 times, most recently from 45b0f62 to 52041d0 Compare August 16, 2019 21:43

mklim reviewed Aug 16, 2019

View reviewed changes

Notify framework to clear input connection when app is backgrounded (f…

4e81b70

…lutter#35054)

matthew-carroll force-pushed the 35054_text_input_error_when_home_and_back branch from fb54ca2 to 4e81b70 Compare August 17, 2019 06:52

matthew-carroll merged commit 4003fbc into flutter:master Aug 19, 2019

engine-flutter-autoroll mentioned this pull request Aug 19, 2019

Roll engine 21ae92651a38..4003fbc3ed48 (6 commits) flutter/flutter#38851

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 19, 2019

4003fbc Notify framework to clear input connection when app is backgr…

474df76

…ounded (flutter#35054) (flutter/engine#9498)

engine-flutter-autoroll mentioned this pull request Aug 19, 2019

Roll engine 21ae92651a38..3e10d92b2bbb (7 commits) flutter/flutter#38855

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 19, 2019

4003fbc Notify framework to clear input connection when app is backgr…

a84173b

…ounded (flutter#35054) (flutter/engine#9498)

gspencergoog mentioned this pull request Aug 28, 2019

TextEditingController.clear() makes keyboard unresponsive until tapped on field. flutter/flutter#39182

Closed

matthew-carroll added a commit to matthew-carroll/engine that referenced this pull request Aug 29, 2019

Revert "Notify framework to clear input connection when app is backgr…

11da714

…ounded (flutter#35054) (flutter#9498)" This reverts commit 4003fbc.

matthew-carroll added a commit to matthew-carroll/engine that referenced this pull request Aug 29, 2019

Revert "Notify framework to clear input connection when app is backgr…

2ad834f

…ounded (flutter#35054) (flutter#9498)" This reverts commit 4003fbc.

matthew-carroll added a commit that referenced this pull request Aug 29, 2019

Revert "Notify framework to clear input connection when app is backgr…

dce8a34

…ounded (#35054) (#9498)" (#11720) This reverts commit 4003fbc.

This was referenced Sep 3, 2019

Calling TextEditingController.clear() causes TextField to loose focus, keyboard stays open but is useless flutter/flutter#39738

Closed

Please tell us when TextInputFormatter will be fixed? flutter/flutter#39976

Closed

HansMuller mentioned this pull request Sep 23, 2019

Input Formatter does not work on Android flutter/flutter#41005

Closed


		textInputChannel.onConnectionClosed(mClient);

		if (onConnectionClosed != null) {

		@@ -0,0 +1 @@
		android_intent=/Users/mattcarroll/.pub-cache/hosted/pub.dartlang.org/android_intent-0.3.1+1/

Notify framework to clear input connection when app is backgrounded (#35054). #9498

Notify framework to clear input connection when app is backgrounded (#35054). #9498

Uh oh!

Conversation

matthew-carroll commented Jun 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xster commented Jun 26, 2019

Uh oh!

amirh Jun 26, 2019

Choose a reason for hiding this comment

Uh oh!

matthew-carroll commented Jul 13, 2019

Uh oh!

xster left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mklim left a comment

Choose a reason for hiding this comment

Uh oh!

mklim Jul 22, 2019

Choose a reason for hiding this comment

Uh oh!

matthew-carroll Jul 22, 2019

Choose a reason for hiding this comment

Uh oh!

matthew-carroll Jul 22, 2019

Choose a reason for hiding this comment

Uh oh!

matthew-carroll commented Jul 22, 2019

Uh oh!

cbracken commented Aug 5, 2019

Uh oh!

matthew-carroll commented Aug 5, 2019

Uh oh!

matthew-carroll commented Aug 16, 2019

Uh oh!

mklim left a comment

Choose a reason for hiding this comment

Uh oh!

mklim Aug 16, 2019

Choose a reason for hiding this comment

Uh oh!

xster commented Aug 17, 2019

Uh oh!

xster commented Aug 17, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

matthew-carroll commented Jun 26, 2019 •

edited

Loading