Fixed tests

Author: gspencergoog

shell/platform/android/BUILD.gn

@@ -429,6 +429,7 @@ action("robolectric_tests") {
   sources = [
     "test/io/flutter/FlutterTestSuite.java",
     "test/io/flutter/SmokeTest.java",
+    "test/io/flutter/embedding/android/AndroidKeyProcessorTest.java",
     "test/io/flutter/embedding/android/FlutterActivityAndFragmentDelegateTest.java",
     "test/io/flutter/embedding/android/FlutterActivityTest.java",
     "test/io/flutter/embedding/android/FlutterAndroidComponentTest.java",
@@ -446,6 +447,7 @@ action("robolectric_tests") {
     "test/io/flutter/embedding/engine/dart/DartExecutorTest.java",
     "test/io/flutter/embedding/engine/plugins/shim/ShimPluginRegistryTest.java",
     "test/io/flutter/embedding/engine/renderer/FlutterRendererTest.java",
+    "test/io/flutter/embedding/engine/systemchannels/KeyEventChannelTest.java",
     "test/io/flutter/embedding/engine/systemchannels/RestorationChannelTest.java",
     "test/io/flutter/external/FlutterLaunchTests.java",
     "test/io/flutter/plugin/common/StandardMessageCodecTest.java",

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

@@ -25,11 +25,12 @@
  */
 public class AndroidKeyProcessor {
   private static final String TAG = "AndroidKeyProcessor";
+  private static long eventIdSerial = 0;
 
   @NonNull private final KeyEventChannel keyEventChannel;
   @NonNull private final TextInputPlugin textInputPlugin;
-  @NonNull private int combiningCharacter;
-  @NonNull public final EventResponder eventResponder;
+  private int combiningCharacter;
+  @NonNull EventResponder eventResponder;
 
   public AndroidKeyProcessor(
       @NonNull Context context,
@@ -41,6 +42,17 @@ public AndroidKeyProcessor(
     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.
+   */
+  public void setEventResponder(@NonNull EventResponder eventResponder) {
+    this.eventResponder = eventResponder;
+  }
+
   /**
    * Called when a key up event is received by the {@link FlutterView}.
    *
@@ -55,7 +67,7 @@ public boolean onKeyUp(@NonNull KeyEvent keyEvent) {
 
     Character complexCharacter = applyCombiningCharacterToBaseCharacter(keyEvent.getUnicodeChar());
     KeyEventChannel.FlutterKeyEvent flutterEvent =
-        new KeyEventChannel.FlutterKeyEvent(keyEvent, complexCharacter);
+        new KeyEventChannel.FlutterKeyEvent(keyEvent, complexCharacter, eventIdSerial++);
     keyEventChannel.keyUp(flutterEvent);
     eventResponder.addEvent(flutterEvent.eventId, keyEvent);
     return true;
@@ -85,7 +97,7 @@ public boolean onKeyDown(@NonNull KeyEvent keyEvent) {
 
     Character complexCharacter = applyCombiningCharacterToBaseCharacter(keyEvent.getUnicodeChar());
     KeyEventChannel.FlutterKeyEvent flutterEvent =
-        new KeyEventChannel.FlutterKeyEvent(keyEvent, complexCharacter);
+        new KeyEventChannel.FlutterKeyEvent(keyEvent, complexCharacter, eventIdSerial++);
     keyEventChannel.keyDown(flutterEvent);
     eventResponder.addEvent(flutterEvent.eventId, keyEvent);
     return true;
@@ -124,7 +136,7 @@ private Character applyCombiningCharacterToBaseCharacter(int newCharacterCodePoi
       return null;
     }
 
-    Character complexCharacter = (char) newCharacterCodePoint;
+    char complexCharacter = (char) newCharacterCodePoint;
     boolean isNewCodePointACombiningCharacter =
         (newCharacterCodePoint & KeyCharacterMap.COMBINING_ACCENT) != 0;
     if (isNewCodePointACombiningCharacter) {
@@ -154,10 +166,9 @@ public static class EventResponder implements KeyEventChannel.EventResponseHandl
     // The maximum number of pending events that are held before starting to
     // complain.
     private static final long MAX_PENDING_EVENTS = 1000;
-    private final Deque<Entry<Long, KeyEvent>> pendingEvents =
-        new ArrayDeque<Entry<Long, KeyEvent>>();
+    final Deque<Entry<Long, KeyEvent>> pendingEvents = new ArrayDeque<Entry<Long, KeyEvent>>();
     @NonNull private final Context context;
-    public boolean dispatchingKeyEvent = false;
+    boolean dispatchingKeyEvent = false;
 
     public EventResponder(@NonNull Context context) {
       this.context = context;
@@ -168,9 +179,13 @@ public EventResponder(@NonNull Context context) {
      *
      * @param id the id of the event to be removed.
      */
-    private KeyEvent removePendingEvent(@NonNull long id) {
+    private KeyEvent removePendingEvent(long id) {
       if (pendingEvents.getFirst().getKey() != id) {
-        throw new AssertionError("Event response received out of order");
+        throw new AssertionError(
+            "Event response received out of order. Should have seen event "
+                + pendingEvents.getFirst().getKey()
+                + " first. Instead, received "
+                + id);
       }
       return pendingEvents.removeFirst().getValue();
     }
@@ -182,7 +197,7 @@ private KeyEvent removePendingEvent(@NonNull long id) {
      *     be null.
      */
     @Override
-    public void onKeyEventHandled(@NonNull long id) {
+    public void onKeyEventHandled(long id) {
       removePendingEvent(id);
     }
 
@@ -194,18 +209,8 @@ public void onKeyEventHandled(@NonNull long id) {
      *     not be null.
      */
     @Override
-    public void onKeyEventNotHandled(@NonNull long id) {
-      KeyEvent pendingEvent = removePendingEvent(id);
-
-      // Since the framework didn't handle it, dispatch the key again.
-      Activity activity = getActivity(context);
-      if (activity != null) {
-        // Turn on dispatchingKeyEvent so that we don't dispatch to ourselves and
-        // send it to the framework again.
-        dispatchingKeyEvent = true;
-        activity.dispatchKeyEvent(pendingEvent);
-        dispatchingKeyEvent = false;
-      }
+    public void onKeyEventNotHandled(long id) {
+      dispatchKeyEvent(removePendingEvent(id));
     }
 
     /** Adds an Android key event with an id to the event responder to wait for a response. */
@@ -221,6 +226,23 @@ public void addEvent(long id, @NonNull KeyEvent event) {
       }
     }
 
+    /**
+     * Dispatches the event to the activity associated with the context.
+     *
+     * @param event the event to be dispatched to the activity.
+     */
+    public void dispatchKeyEvent(KeyEvent event) {
+      // Since the framework didn't handle it, dispatch the key again.
+      Activity activity = getActivity(context);
+      if (activity != null) {
+        // Turn on dispatchingKeyEvent so that we don't dispatch to ourselves and
+        // send it to the framework again.
+        dispatchingKeyEvent = true;
+        activity.dispatchKeyEvent(event);
+        dispatchingKeyEvent = false;
+      }
+    }
+
     /**
      * Gets the nearest ancestor Activity for the given Context.
      *

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

@@ -5,13 +5,13 @@
 package io.flutter.embedding.engine.systemchannels;
 
 import android.os.Build;
-import android.util.Log;
 import android.view.InputDevice;
 import android.view.KeyEvent;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
-import io.flutter.embedding.engine.dart.DartExecutor;
+import io.flutter.Log;
 import io.flutter.plugin.common.BasicMessageChannel;
+import io.flutter.plugin.common.BinaryMessenger;
 import io.flutter.plugin.common.JSONMessageCodec;
 import java.util.HashMap;
 import java.util.Map;
@@ -26,7 +26,6 @@
  */
 public class KeyEventChannel {
   private static final String TAG = "KeyEventChannel";
-  private static long eventIdSerial = 0;
 
   /**
    * Sets the event response handler to be used to receive key event response messages from the
@@ -47,7 +46,7 @@ public interface EventResponseHandler {
      * @param id the event id of the event to be marked as being handled by the framework. Must not
      *     be null.
      */
-    public void onKeyEventHandled(@NonNull long id);
+    public void onKeyEventHandled(long id);
 
     /**
      * Called whenever the framework responds that a given key event wasn't handled by the
@@ -56,56 +55,58 @@ public interface EventResponseHandler {
      * @param id the event id of the event to be marked as not being handled by the framework. Must
      *     not be null.
      */
-    public void onKeyEventNotHandled(@NonNull long id);
+    public void onKeyEventNotHandled(long id);
   }
 
-  private final BasicMessageChannel.MessageHandler<Object> messageHandler =
-      new BasicMessageChannel.MessageHandler<Object>() {
-        @Override
-        public void onMessage(
-            @Nullable Object message, @NonNull BasicMessageChannel.Reply<Object> reply) {
-          // If there is no handler to respond to this message then we don't
-          // need to parse it.
-          if (eventResponseHandler == null) {
-            return;
-          }
-
-          try {
-            final JSONObject annotatedEvent = (JSONObject) message;
-            final String type = annotatedEvent.getString("type");
-            final JSONObject data = annotatedEvent.getJSONObject("data");
-
-            switch (type) {
-              case "keyHandled":
-                eventResponseHandler.onKeyEventHandled(data.getLong("eventId"));
-                break;
-              case "keyNotHandled":
-                eventResponseHandler.onKeyEventNotHandled(data.getLong("eventId"));
-                break;
-            }
-          } catch (JSONException e) {
-            Log.e(TAG, "Unable to unpack JSON message: " + e);
-          } finally {
-            reply.reply(null);
-          }
-        }
-      };
+  /**
+   * A constructor that creates a KeyEventChannel with the default message handler.
+   *
+   * @param binaryMessenger the binary messenger used to send messages on this channel.
+   */
+  public KeyEventChannel(@NonNull BinaryMessenger binaryMessenger) {
+    this.channel =
+        new BasicMessageChannel<>(binaryMessenger, "flutter/keyevent", JSONMessageCodec.INSTANCE);
+  }
 
-  @NonNull public final BasicMessageChannel<Object> channel;
+  /**
+   * Creates a reply handler for this an event with the given eventId.
+   *
+   * @param eventId the event ID to create a reply for.
+   */
+  BasicMessageChannel.Reply<Object> createReplyHandler(long eventId) {
+    return message -> {
+      if (eventResponseHandler == null) {
+        return;
+      }
 
-  public KeyEventChannel(@NonNull DartExecutor dartExecutor) {
-    this.channel =
-        new BasicMessageChannel<>(dartExecutor, "flutter/keyevent", JSONMessageCodec.INSTANCE);
-    this.channel.setMessageHandler(messageHandler);
+      try {
+        if (message == null) {
+          eventResponseHandler.onKeyEventNotHandled(eventId);
+          return;
+        }
+        final JSONObject annotatedEvent = (JSONObject) message;
+        final boolean handled = annotatedEvent.getBoolean("handled");
+        if (handled) {
+          eventResponseHandler.onKeyEventHandled(eventId);
+        } else {
+          eventResponseHandler.onKeyEventNotHandled(eventId);
+        }
+      } catch (JSONException e) {
+        Log.e(TAG, "Unable to unpack JSON message: " + e);
+        eventResponseHandler.onKeyEventNotHandled(eventId);
+      }
+    };
   }
 
+  @NonNull public final BasicMessageChannel<Object> channel;
+
   public void keyUp(@NonNull FlutterKeyEvent keyEvent) {
     Map<String, Object> message = new HashMap<>();
     message.put("type", "keyup");
     message.put("keymap", "android");
     encodeKeyEvent(keyEvent, message);
 
-    channel.send(message);
+    channel.send(message, createReplyHandler(keyEvent.eventId));
   }
 
   public void keyDown(@NonNull FlutterKeyEvent keyEvent) {
@@ -114,7 +115,7 @@ public void keyDown(@NonNull FlutterKeyEvent keyEvent) {
     message.put("keymap", "android");
     encodeKeyEvent(keyEvent, message);
 
-    channel.send(message);
+    channel.send(message, createReplyHandler(keyEvent.eventId));
   }
 
   private void encodeKeyEvent(
@@ -136,7 +137,10 @@ private void encodeKeyEvent(
     message.put("eventId", event.eventId);
   }
 
-  /** Key event as defined by Flutter. */
+  /**
+   * A key event as defined by Flutter that includes an id for the specific event to be used when
+   * responding to the event.
+   */
   public static class FlutterKeyEvent {
     public final int deviceId;
     public final int flags;
@@ -152,12 +156,12 @@ public static class FlutterKeyEvent {
     public final int repeatCount;
     public final long eventId;
 
-    public FlutterKeyEvent(@NonNull KeyEvent androidKeyEvent) {
-      this(androidKeyEvent, null);
+    public FlutterKeyEvent(@NonNull KeyEvent androidKeyEvent, long eventId) {
+      this(androidKeyEvent, null, eventId);
     }
 
     public FlutterKeyEvent(
-        @NonNull KeyEvent androidKeyEvent, @Nullable Character complexCharacter) {
+        @NonNull KeyEvent androidKeyEvent, @Nullable Character complexCharacter, long eventId) {
       this(
           androidKeyEvent.getDeviceId(),
           androidKeyEvent.getFlags(),
@@ -168,7 +172,8 @@ public FlutterKeyEvent(
           androidKeyEvent.getScanCode(),
           androidKeyEvent.getMetaState(),
           androidKeyEvent.getSource(),
-          androidKeyEvent.getRepeatCount());
+          androidKeyEvent.getRepeatCount(),
+          eventId);
     }
 
     public FlutterKeyEvent(
@@ -181,7 +186,8 @@ public FlutterKeyEvent(
         int scanCode,
         int metaState,
         int source,
-        int repeatCount) {
+        int repeatCount,
+        long eventId) {
       this.deviceId = deviceId;
       this.flags = flags;
       this.plainCodePoint = plainCodePoint;
@@ -192,7 +198,7 @@ public FlutterKeyEvent(
       this.metaState = metaState;
       this.source = source;
       this.repeatCount = repeatCount;
-      this.eventId = eventIdSerial++;
+      this.eventId = eventId;
       InputDevice device = InputDevice.getDevice(deviceId);
       if (device != null) {
         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT) {