Test behavior instead of implementation. Made more of AndroidKeyProcessor guts private

gspencergoog · gspencergoog · commit b3829165b746 · 2020-06-25T19:37:09.000-07:00
diff --git a/shell/platform/android/io/flutter/embedding/android/AndroidKeyProcessor.java b/shell/platform/android/io/flutter/embedding/android/AndroidKeyProcessor.java
@@ -4,15 +4,12 @@
 
 package io.flutter.embedding.android;
 
-import android.app.Activity;
-import android.content.Context;
-import android.content.ContextWrapper;
 import android.util.Log;
 import android.view.KeyCharacterMap;
 import android.view.KeyEvent;
+import android.view.View;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
-import androidx.annotation.VisibleForTesting;
 import io.flutter.embedding.engine.systemchannels.KeyEventChannel;
 import io.flutter.plugin.editing.TextInputPlugin;
 import java.util.AbstractMap.SimpleImmutableEntry;
@@ -41,40 +38,28 @@ public class AndroidKeyProcessor {
   @NonNull private final KeyEventChannel keyEventChannel;
   @NonNull private final TextInputPlugin textInputPlugin;
   private int combiningCharacter;
-  @NonNull EventResponder eventResponder;
+  @NonNull private EventResponder eventResponder;
 
   /**
    * Constructor for AndroidKeyProcessor.
    *
-   * @param context takes the application context so that this processor can find the activity for
-   *     re-dispatching of events that were not handled by the framework.
+   * @param view takes the activity to use for re-dispatching of events that were not handled by the
+   *     framework.
    * @param keyEventChannel the event channel to listen to for new key events.
    * @param textInputPlugin a plugin, which, if set, is given key events before the framework is,
    *     and if it has a valid input connection and is accepting text, then it will handle the event
    *     and the framework will not receive it.
    */
   public AndroidKeyProcessor(
-      @NonNull Context context,
+      @NonNull View view,
       @NonNull KeyEventChannel keyEventChannel,
       @NonNull TextInputPlugin textInputPlugin) {
     this.keyEventChannel = keyEventChannel;
     this.textInputPlugin = textInputPlugin;
-    this.eventResponder = new EventResponder(context);
+    this.eventResponder = new EventResponder(view);
     this.keyEventChannel.setEventResponseHandler(eventResponder);
   }
 
-  /**
-   * Set the event responder for this key processor.
-   *
-   * <p>Typically used by the testing framework to inject mocks.
-   *
-   * @param eventResponder the event responder to use instead of the default responder.
-   */
-  @VisibleForTesting
-  public void setEventResponder(@NonNull EventResponder eventResponder) {
-    this.eventResponder = eventResponder;
-  }
-
   /**
    * Called when a key up event is received by the {@link FlutterView}.
    *
@@ -186,16 +171,16 @@ private Character applyCombiningCharacterToBaseCharacter(int newCharacterCodePoi
     return complexCharacter;
   }
 
-  public static class EventResponder implements KeyEventChannel.EventResponseHandler {
+  private static class EventResponder implements KeyEventChannel.EventResponseHandler {
     // The maximum number of pending events that are held before starting to
     // complain.
     private static final long MAX_PENDING_EVENTS = 1000;
     final Deque<Entry<Long, KeyEvent>> pendingEvents = new ArrayDeque<Entry<Long, KeyEvent>>();
-    @NonNull private final Context context;
-    @VisibleForTesting boolean dispatchingKeyEvent = false;
+    @NonNull private final View view;
+    boolean dispatchingKeyEvent = false;
 
-    public EventResponder(@NonNull Context context) {
-      this.context = context;
+    public EventResponder(@NonNull View view) {
+      this.view = view;
     }
 
     /**
@@ -264,31 +249,13 @@ public void addEvent(long id, @NonNull KeyEvent event) {
      */
     public void dispatchKeyEvent(KeyEvent event) {
       // Since the framework didn't handle it, dispatch the key again.
-      Activity activity = getActivity(context);
-      if (activity != null) {
+      if (view != null) {
         // Turn on dispatchingKeyEvent so that we don't dispatch to ourselves and
         // send it to the framework again.
         dispatchingKeyEvent = true;
-        activity.dispatchKeyEvent(event);
+        view.dispatchKeyEvent(event);
         dispatchingKeyEvent = false;
       }
     }
-
-    /**
-     * Gets the nearest ancestor Activity for the given Context.
-     *
-     * @param context the context to look in for the activity.
-     * @return null if no Activity found.
-     */
-    private Activity getActivity(Context context) {
-      if (context instanceof Activity) {
-        return (Activity) context;
-      }
-      if (context instanceof ContextWrapper) {
-        // Recurse up chain of base contexts until we find an Activity.
-        return getActivity(((ContextWrapper) context).getBaseContext());
-      }
-      return null;
-    }
   }
 }
diff --git a/shell/platform/android/io/flutter/embedding/android/FlutterView.java b/shell/platform/android/io/flutter/embedding/android/FlutterView.java
@@ -849,8 +849,7 @@ public void attachToFlutterEngine(@NonNull FlutterEngine flutterEngine) {
             this.flutterEngine.getPlatformViewsController());
     localizationPlugin = this.flutterEngine.getLocalizationPlugin();
     androidKeyProcessor =
-        new AndroidKeyProcessor(
-            getContext(), this.flutterEngine.getKeyEventChannel(), textInputPlugin);
+        new AndroidKeyProcessor(this, this.flutterEngine.getKeyEventChannel(), textInputPlugin);
     androidTouchProcessor = new AndroidTouchProcessor(this.flutterEngine.getRenderer());
     accessibilityBridge =
         new AccessibilityBridge(
diff --git a/shell/platform/android/io/flutter/view/FlutterView.java b/shell/platform/android/io/flutter/view/FlutterView.java
@@ -231,7 +231,7 @@ public void onPostResume() {
       mMouseCursorPlugin = null;
     }
     mLocalizationPlugin = new LocalizationPlugin(context, localizationChannel);
-    androidKeyProcessor = new AndroidKeyProcessor(getContext(), keyEventChannel, mTextInputPlugin);
+    androidKeyProcessor = new AndroidKeyProcessor(this, keyEventChannel, mTextInputPlugin);
     androidTouchProcessor = new AndroidTouchProcessor(flutterRenderer);
     mNativeView
         .getPluginRegistry()
diff --git a/shell/platform/android/test/io/flutter/embedding/android/AndroidKeyProcessorTest.java b/shell/platform/android/test/io/flutter/embedding/android/AndroidKeyProcessorTest.java
@@ -1,34 +1,31 @@
 package io.flutter.embedding.android;
 
-import static junit.framework.Assert.assertFalse;
-import static junit.framework.Assert.assertNotNull;
 import static junit.framework.TestCase.assertEquals;
 import static org.mockito.Mockito.any;
 import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
 import android.annotation.TargetApi;
-import android.app.Application;
-import android.content.Context;
 import android.view.KeyEvent;
+import android.view.View;
 import androidx.annotation.NonNull;
 import io.flutter.embedding.engine.FlutterEngine;
 import io.flutter.embedding.engine.FlutterJNI;
 import io.flutter.embedding.engine.systemchannels.KeyEventChannel;
 import io.flutter.embedding.engine.systemchannels.TextInputChannel;
 import io.flutter.plugin.editing.TextInputPlugin;
 import io.flutter.util.FakeKeyEvent;
-import java.util.Map;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
 import org.mockito.Mock;
 import org.mockito.MockitoAnnotations;
+import org.mockito.invocation.InvocationOnMock;
+import org.mockito.stubbing.Answer;
 import org.robolectric.RobolectricTestRunner;
-import org.robolectric.RuntimeEnvironment;
 import org.robolectric.annotation.Config;
 
 @Config(manifest = Config.NONE)
@@ -44,73 +41,97 @@ public void setUp() {
   }
 
   @Test
-  public void sendsKeyDownEventsToEventResponder() {
+  public void respondsTrueWhenHandlingNewEvents() {
     FlutterEngine flutterEngine = mockFlutterEngine();
     KeyEventChannel fakeKeyEventChannel = flutterEngine.getKeyEventChannel();
-    TextInputPlugin fakeTextInputPlugin = mock(TextInputPlugin.class);
+    View fakeView = mock(View.class);
 
     AndroidKeyProcessor processor =
-        new AndroidKeyProcessor(
-            RuntimeEnvironment.application, fakeKeyEventChannel, fakeTextInputPlugin);
+        new AndroidKeyProcessor(fakeView, fakeKeyEventChannel, mock(TextInputPlugin.class));
 
-    processor.onKeyDown(new FakeKeyEvent(KeyEvent.ACTION_DOWN, 65));
-    assertFalse(processor.eventResponder.dispatchingKeyEvent);
+    boolean result = processor.onKeyDown(new FakeKeyEvent(KeyEvent.ACTION_DOWN, 65));
+    assertEquals(true, result);
     verify(fakeKeyEventChannel, times(1)).keyDown(any(KeyEventChannel.FlutterKeyEvent.class));
     verify(fakeKeyEventChannel, times(0)).keyUp(any(KeyEventChannel.FlutterKeyEvent.class));
-    assertEquals(1, processor.eventResponder.pendingEvents.size());
-    Map.Entry<Long, KeyEvent> firstPendingEvent =
-        processor.eventResponder.pendingEvents.peekFirst();
-    assertNotNull(firstPendingEvent);
-    processor.eventResponder.onKeyEventHandled(firstPendingEvent.getKey());
-    assertEquals(0, processor.eventResponder.pendingEvents.size());
+    verify(fakeView, times(0)).dispatchKeyEvent(any(KeyEvent.class));
   }
 
-  @Test
-  public void unhandledKeyEventsAreSynthesized() {
+  public void synthesizesEventsWhenKeyDownNotHandled() {
     FlutterEngine flutterEngine = mockFlutterEngine();
     KeyEventChannel fakeKeyEventChannel = flutterEngine.getKeyEventChannel();
-    TextInputPlugin fakeTextInputPlugin = mock(TextInputPlugin.class);
-    Application spiedApplication = spy(RuntimeEnvironment.application);
-    Context spiedContext = spy(spiedApplication.getBaseContext());
-    when(spiedApplication.getBaseContext()).thenReturn(spiedContext);
-
+    View fakeView = mock(View.class);
+    ArgumentCaptor<KeyEventChannel.EventResponseHandler> handlerCaptor =
+        ArgumentCaptor.forClass(KeyEventChannel.EventResponseHandler.class);
+    verify(fakeKeyEventChannel).setEventResponseHandler(handlerCaptor.capture());
     AndroidKeyProcessor processor =
-        new AndroidKeyProcessor(spiedApplication, fakeKeyEventChannel, fakeTextInputPlugin);
-    AndroidKeyProcessor.EventResponder eventResponder =
-        spy(new AndroidKeyProcessor.EventResponder(spiedContext));
-    processor.setEventResponder(eventResponder);
-
-    KeyEvent event = new FakeKeyEvent(KeyEvent.ACTION_DOWN, 65);
-    processor.onKeyDown(event);
-    assertFalse(processor.eventResponder.dispatchingKeyEvent);
-    assertEquals(1, processor.eventResponder.pendingEvents.size());
-    Map.Entry<Long, KeyEvent> firstPendingEvent =
-        processor.eventResponder.pendingEvents.peekFirst();
-    assertNotNull(firstPendingEvent);
-    processor.eventResponder.onKeyEventNotHandled(firstPendingEvent.getKey());
-    assertEquals(0, processor.eventResponder.pendingEvents.size());
-    verify(eventResponder).dispatchKeyEvent(event);
+        new AndroidKeyProcessor(fakeView, fakeKeyEventChannel, mock(TextInputPlugin.class));
+    ArgumentCaptor<KeyEventChannel.FlutterKeyEvent> eventCaptor =
+        ArgumentCaptor.forClass(KeyEventChannel.FlutterKeyEvent.class);
+    FakeKeyEvent fakeKeyEvent = new FakeKeyEvent(KeyEvent.ACTION_DOWN, 65);
+
+    boolean result = processor.onKeyDown(fakeKeyEvent);
+    assertEquals(true, result);
+
+    // Capture the FlutterKeyEvent so we can find out its event ID to use when
+    // faking our response.
+    verify(fakeKeyEventChannel, times(1)).keyDown(eventCaptor.capture());
+    boolean[] dispatchResult = {true};
+    when(fakeView.dispatchKeyEvent(any(KeyEvent.class)))
+        .then(
+            new Answer<Boolean>() {
+              @Override
+              public Boolean answer(InvocationOnMock invocation) throws Throwable {
+                KeyEvent event = (KeyEvent) invocation.getArguments()[0];
+                assertEquals(fakeKeyEvent, event);
+                dispatchResult[0] = processor.onKeyDown(event);
+                return dispatchResult[0];
+              }
+            });
+
+    // Fake a response from the framework.
+    handlerCaptor.getValue().onKeyEventNotHandled(eventCaptor.getValue().eventId);
+    verify(fakeView, times(1)).dispatchKeyEvent(fakeKeyEvent);
+    assertEquals(false, dispatchResult[0]);
+    verify(fakeKeyEventChannel, times(0)).keyUp(any(KeyEventChannel.FlutterKeyEvent.class));
   }
 
-  @Test
-  public void sendsKeyUpEventsToEventResponder() {
+  public void synthesizesEventsWhenKeyUpNotHandled() {
     FlutterEngine flutterEngine = mockFlutterEngine();
     KeyEventChannel fakeKeyEventChannel = flutterEngine.getKeyEventChannel();
-    TextInputPlugin fakeTextInputPlugin = mock(TextInputPlugin.class);
-
+    View fakeView = mock(View.class);
+    ArgumentCaptor<KeyEventChannel.EventResponseHandler> handlerCaptor =
+        ArgumentCaptor.forClass(KeyEventChannel.EventResponseHandler.class);
+    verify(fakeKeyEventChannel).setEventResponseHandler(handlerCaptor.capture());
     AndroidKeyProcessor processor =
-        new AndroidKeyProcessor(
-            RuntimeEnvironment.application, fakeKeyEventChannel, fakeTextInputPlugin);
-
-    processor.onKeyUp(new FakeKeyEvent(KeyEvent.ACTION_UP, 65));
-    assertFalse(processor.eventResponder.dispatchingKeyEvent);
-    verify(fakeKeyEventChannel, times(0)).keyDown(any(KeyEventChannel.FlutterKeyEvent.class));
-    verify(fakeKeyEventChannel, times(1)).keyUp(any(KeyEventChannel.FlutterKeyEvent.class));
-    Map.Entry<Long, KeyEvent> firstPendingEvent =
-        processor.eventResponder.pendingEvents.peekFirst();
-    assertNotNull(firstPendingEvent);
-    processor.eventResponder.onKeyEventHandled(firstPendingEvent.getKey());
-    assertEquals(0, processor.eventResponder.pendingEvents.size());
+        new AndroidKeyProcessor(fakeView, fakeKeyEventChannel, mock(TextInputPlugin.class));
+    ArgumentCaptor<KeyEventChannel.FlutterKeyEvent> eventCaptor =
+        ArgumentCaptor.forClass(KeyEventChannel.FlutterKeyEvent.class);
+    FakeKeyEvent fakeKeyEvent = new FakeKeyEvent(KeyEvent.ACTION_UP, 65);
+
+    boolean result = processor.onKeyUp(fakeKeyEvent);
+    assertEquals(true, result);
+
+    // Capture the FlutterKeyEvent so we can find out its event ID to use when
+    // faking our response.
+    verify(fakeKeyEventChannel, times(1)).keyUp(eventCaptor.capture());
+    boolean[] dispatchResult = {true};
+    when(fakeView.dispatchKeyEvent(any(KeyEvent.class)))
+        .then(
+            new Answer<Boolean>() {
+              @Override
+              public Boolean answer(InvocationOnMock invocation) throws Throwable {
+                KeyEvent event = (KeyEvent) invocation.getArguments()[0];
+                assertEquals(fakeKeyEvent, event);
+                dispatchResult[0] = processor.onKeyUp(event);
+                return dispatchResult[0];
+              }
+            });
+
+    // Fake a response from the framework.
+    handlerCaptor.getValue().onKeyEventNotHandled(eventCaptor.getValue().eventId);
+    verify(fakeView, times(1)).dispatchKeyEvent(fakeKeyEvent);
+    assertEquals(false, dispatchResult[0]);
+    verify(fakeKeyEventChannel, times(0)).keyUp(any(KeyEventChannel.FlutterKeyEvent.class));
   }
 
   @NonNull

Original file line number	Diff line number	Diff line change
`@@ -231,7 +231,7 @@ public void onPostResume() {`
`231`	`231`	`mMouseCursorPlugin = null;`
`232`	`232`	`}`
`233`	`233`	`mLocalizationPlugin = new LocalizationPlugin(context, localizationChannel);`
`234`		`- androidKeyProcessor = new AndroidKeyProcessor(getContext(), keyEventChannel, mTextInputPlugin);`
	`234`	`+ androidKeyProcessor = new AndroidKeyProcessor(this, keyEventChannel, mTextInputPlugin);`
`235`	`235`	`androidTouchProcessor = new AndroidTouchProcessor(flutterRenderer);`
`236`	`236`	`mNativeView`
`237`	`237`	`.getPluginRegistry()`