Scribe (Android stylus handwriting text input) #52943
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ | |
| import static io.flutter.Build.API_LEVELS; | ||
|
|
||
| import android.annotation.TargetApi; | ||
| import android.os.Build; | ||
| import android.view.View; | ||
| import android.view.inputmethod.InputMethodManager; | ||
| import androidx.annotation.NonNull; | ||
|
|
@@ -19,18 +20,20 @@ | |
| * | ||
| * <p>The plugin handles requests for scribe sent by the {@link | ||
| * io.flutter.embedding.engine.systemchannels.ScribeChannel}. | ||
| * | ||
| * <p>On API versions below 33, the plugin does nothing. | ||
| */ | ||
| public class ScribePlugin implements ScribeChannel.ScribeMethodHandler { | ||
|
|
||
| @NonNull private final ScribeChannel mScribeChannel; | ||
| @NonNull private final InputMethodManager mInputMethodManager; | ||
| @NonNull public View mView; | ||
|
||
|
|
||
| public ScribePlugin( | ||
|
Contributor
There was a problem hiding this comment. What is the view that is passed in here. Views in andoid IIRC do not have a long lifespan and this view is final. What happens when the app is backgrounded?
Contributor
Author
There was a problem hiding this comment. That's the FlutterView from when ScribePlugin is created in FlutterView.java: scribePlugin =
new ScribePlugin(
this, textInputPlugin.getInputMethodManager(), this.flutterEngine.getScribeChannel());I need it in order to call InputMethodManager.startStylusHandwriting. Is there a better way to get ahold of the View at that time that's called maybe?
Contributor
There was a problem hiding this comment. I am not so confident as to block the pr but I suspect that you can't make that variable final. That there is not a 1 to 1 relationship between flutter view and plugin instantiation. I am specifically thinking of add to app and cached engine scenarios. None of our existing tests would catch this because they would not execute this code path.
Contributor
Author
There was a problem hiding this comment. (From another thread) I've made a view setter so it can be updated if needed. |
||
| @NonNull View view, @NonNull InputMethodManager imm, @NonNull ScribeChannel scribeChannel) { | ||
| if (Build.VERSION.SDK_INT >= API_LEVELS.API_33) { | ||
| view.setAutoHandwritingEnabled(false); | ||
| } | ||
|
|
||
| mView = view; | ||
| mInputMethodManager = imm; | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,11 +4,14 @@ | |
|
|
||
| package io.flutter.embedding.engine.systemchannels; | ||
|
|
||
| import static io.flutter.Build.API_LEVELS; | ||
| import static org.mockito.Mockito.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.never; | ||
| import static org.mockito.Mockito.times; | ||
| import static org.mockito.Mockito.verify; | ||
|
|
||
| import android.annotation.TargetApi; | ||
| import androidx.test.ext.junit.runners.AndroidJUnit4; | ||
| import io.flutter.embedding.engine.dart.DartExecutor; | ||
| import io.flutter.plugin.common.BinaryMessenger; | ||
|
|
@@ -19,22 +22,22 @@ | |
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.ArgumentCaptor; | ||
| import org.robolectric.annotation.Config; | ||
|
|
||
| @RunWith(AndroidJUnit4.class) | ||
| public class ScribeChannelTest { | ||
| private static BinaryMessenger.BinaryReply sendToBinaryMessageHandler( | ||
| BinaryMessenger.BinaryMessageHandler binaryMessageHandler, String method) { | ||
| MethodCall methodCall = new MethodCall(method, null); | ||
| ByteBuffer encodedMethodCall = StandardMethodCodec.INSTANCE.encodeMethodCall(methodCall); | ||
| BinaryMessenger.BinaryReply mockReply = mock(BinaryMessenger.BinaryReply.class); | ||
| binaryMessageHandler.onMessage((ByteBuffer) encodedMethodCall.flip(), mockReply); | ||
| return mockReply; | ||
| } | ||
|
|
||
| ScribeChannel.ScribeMethodHandler mockHandler; | ||
| BinaryMessenger.BinaryMessageHandler binaryMessageHandler; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| ArgumentCaptor<BinaryMessenger.BinaryMessageHandler> binaryMessageHandlerCaptor = | ||
|
|
@@ -45,24 +48,57 @@ public void setUp() { | |
|
|
||
| scribeChannel.setScribeMethodHandler(mockHandler); | ||
|
|
||
| verify((BinaryMessenger) mockBinaryMessenger, times(1)) | ||
| .setMessageHandler(any(String.class), binaryMessageHandlerCaptor.capture()); | ||
|
|
||
| binaryMessageHandler = binaryMessageHandlerCaptor.getValue(); | ||
| } | ||
|
|
||
| @Config(minSdk = API_LEVELS.API_34) | ||
| @TargetApi(API_LEVELS.API_34) | ||
| @Test | ||
| public void respondsToStartStylusHandwriting() { | ||
| BinaryMessenger.BinaryReply mockReply = | ||
| sendToBinaryMessageHandler( | ||
| binaryMessageHandler, ScribeChannel.METHOD_START_STYLUS_HANDWRITING); | ||
|
|
||
| verify(mockReply).reply(any(ByteBuffer.class)); | ||
| verify(mockHandler).startStylusHandwriting(); | ||
| } | ||
|
|
||
| @Config(minSdk = API_LEVELS.API_34) | ||
| @TargetApi(API_LEVELS.API_34) | ||
| @Test | ||
| public void respondsToIsStylusHandwritingAvailable() { | ||
| BinaryMessenger.BinaryReply mockReply = | ||
| sendToBinaryMessageHandler( | ||
| binaryMessageHandler, ScribeChannel.METHOD_IS_STYLUS_HANDWRITING_AVAILABLE); | ||
|
|
||
| verify(mockReply).reply(any(ByteBuffer.class)); | ||
| verify(mockHandler).isStylusHandwritingAvailable(); | ||
| } | ||
|
|
||
| @Config(sdk = API_LEVELS.API_32) | ||
| @TargetApi(API_LEVELS.API_32) | ||
| @Test | ||
| public void respondsToStartStylusHandwritingWhenAPILevelUnsupported() { | ||
| BinaryMessenger.BinaryReply mockReply = | ||
| sendToBinaryMessageHandler( | ||
| binaryMessageHandler, ScribeChannel.METHOD_START_STYLUS_HANDWRITING); | ||
|
|
||
| verify(mockReply).reply(any(ByteBuffer.class)); | ||
|
||
| verify(mockHandler, never()).startStylusHandwriting(); | ||
| } | ||
|
|
||
| @Config(sdk = API_LEVELS.API_33) | ||
| @TargetApi(API_LEVELS.API_33) | ||
| @Test | ||
| public void respondsToIsStylusHandwritingAvailableWhenAPILevelUnsupported() { | ||
| BinaryMessenger.BinaryReply mockReply = | ||
| sendToBinaryMessageHandler( | ||
| binaryMessageHandler, ScribeChannel.METHOD_IS_STYLUS_HANDWRITING_AVAILABLE); | ||
|
|
||
| verify(mockReply).reply(any(ByteBuffer.class)); | ||
| verify(mockHandler, never()).isStylusHandwritingAvailable(); | ||
| } | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this mean that the dart side of the plugin needs to check if it is running on android and check the api level?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess in practice this probably means that you want to call this wrapped in a
try/catchin Dart. My thought process is that this method channel method is just a proxy for InputMethodManager.isStylusHandwritingAvailable. If I'm not even able to call that, I should error, rather than succeed withfalse, which the app developer might interpret to mean that InputMethodManager.isStylusHandwritingAvailable returned false.If that sounds reasonable then I'll at least make sure this is clearly documented in the framework.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update here: #52943 (comment)