ime: Send on blur to IME service.

Add Mojo and protobuf messages for Chrome to send on blur to the IME
service.

Bug: 1019541
Change-Id: If01c8e2dceaa13c7218ee13913f32a26ddcfe52e
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2483944Reviewed-by: Keith Lee <keithlee@chromium.org>
Reviewed-by: Martin Barbella <mbarbella@chromium.org>
Commit-Queue: Darren Shen <shend@chromium.org>
Cr-Commit-Position: refs/heads/master@{#820085}

chrome/browser/chromeos/input_method/native_input_method_engine.cc

@@ -187,6 +187,11 @@ void NativeInputMethodEngine::ImeObserver::OnBlur(int context_id) {
   if (assistive_suggester_->IsAssistiveFeatureEnabled())
     assistive_suggester_->OnBlur();
 
+  if (active_engine_id_ && ShouldUseFstMojoEngine(*active_engine_id_) &&
+      remote_to_engine_.is_bound()) {
+    remote_to_engine_->OnBlur();
+  }
+
   base_observer_->OnBlur(context_id);
 }
 

chrome/browser/chromeos/input_method/native_input_method_engine.h

@@ -93,6 +93,7 @@ class NativeInputMethodEngine : public InputMethodEngine {
     void ProcessMessage(const std::vector<uint8_t>& message,
                         ProcessMessageCallback callback) override;
     void OnFocus() override {}
+    void OnBlur() override {}
     void OnSurroundingTextChanged(
         const std::string& text,
         uint32_t offset,

chromeos/services/ime/decoder/decoder_engine.cc

@@ -145,6 +145,14 @@ void DecoderEngine::OnFocus() {
                  base::DoNothing());
 }
 
+void DecoderEngine::OnBlur() {
+  const uint64_t seq_id = current_seq_id_;
+  ++current_seq_id_;
+
+  ProcessMessage(WrapAndSerializeMessage(OnBlurToProto(seq_id)),
+                 base::DoNothing());
+}
+
 void DecoderEngine::OnKeyEvent(mojom::PhysicalKeyEventPtr event,
                                OnKeyEventCallback callback) {
   const uint64_t seq_id = current_seq_id_;

chromeos/services/ime/decoder/decoder_engine.h

@@ -33,6 +33,7 @@ class DecoderEngine : public InputEngine {
   void ProcessMessage(const std::vector<uint8_t>& message,
                       ProcessMessageCallback callback) override;
   void OnFocus() override;
+  void OnBlur() override;
   void OnKeyEvent(mojom::PhysicalKeyEventPtr event,
                   OnKeyEventCallback callback) override;
   void OnSurroundingTextChanged(

chromeos/services/ime/decoder/decoder_engine_unittest.cc

@@ -52,6 +52,7 @@ class StubInputChannel : public mojom::InputChannel {
     std::move(callback).Run({});
   }
   void OnFocus() final {}
+  void OnBlur() final {}
   void ProcessKeypressForRulebased(
       ime::mojom::PhysicalKeyEventPtr event,
       ProcessKeypressForRulebasedCallback callback) final {}
@@ -109,6 +110,22 @@ TEST_F(DecoderEngineTest, OnFocusSendsMessageToSharedLib) {
   client.FlushForTesting();
 }
 
+TEST_F(DecoderEngineTest, OnBlurSendsMessageToSharedLib) {
+  DecoderEngine engine(/*platform=*/nullptr);
+  StubInputChannel stub_channel;
+  mojo::Receiver<mojom::InputChannel> receiver(&stub_channel);
+  mojo::Remote<mojom::InputChannel> client;
+  ASSERT_TRUE(engine.BindRequest(kImeSpec, client.BindNewPipeAndPassReceiver(),
+                                 receiver.BindNewPipeAndPassRemote(), {}));
+  ime::Wrapper expected_proto;
+  *expected_proto.mutable_public_message() = OnBlurToProto(/*seq_id=*/0);
+
+  EXPECT_CALL(mock_main_entry_, Process).With(EqualsProto(expected_proto));
+
+  client->OnBlur();
+  client.FlushForTesting();
+}
+
 TEST_F(DecoderEngineTest, OnKeyEventRepliesWithCallback) {
   DecoderEngine engine(/*platform=*/nullptr);
   StubInputChannel stub_channel;

chromeos/services/ime/decoder/proto_conversion.cc

@@ -29,6 +29,14 @@ ime::PublicMessage OnFocusToProto(uint64_t seq_id) {
   return message;
 }
 
+ime::PublicMessage OnBlurToProto(uint64_t seq_id) {
+  ime::PublicMessage message;
+  message.set_seq_id(seq_id);
+
+  *message.mutable_on_blur() = ime::OnBlur();
+  return message;
+}
+
 ime::PublicMessage OnKeyEventToProto(uint64_t seq_id,
                                      mojom::PhysicalKeyEventPtr event) {
   ime::PublicMessage message;

chromeos/services/ime/decoder/proto_conversion.h

@@ -16,6 +16,9 @@ namespace ime {
 // Converts arguments of a Mojo call to InputChannel::OnFocus into a proto.
 ime::PublicMessage OnFocusToProto(uint64_t seq_id);
 
+// Converts arguments of a Mojo call to InputChannel::OnBlur into a proto.
+ime::PublicMessage OnBlurToProto(uint64_t seq_id);
+
 // Converts arguments of a Mojo call to InputChannel::OnKeyEvent into a proto.
 ime::PublicMessage OnKeyEventToProto(uint64_t seq_id,
                                      mojom::PhysicalKeyEventPtr event);

chromeos/services/ime/decoder/proto_conversion_unittest.cc

@@ -21,6 +21,17 @@ TEST(ProtoConversionTest, OnFocusToProto) {
             expected_message.SerializeAsString());
 }
 
+TEST(ProtoConversionTest, OnBlurToProto) {
+  ime::PublicMessage expected_message;
+  expected_message.set_seq_id(42);
+  *expected_message.mutable_on_blur() = ime::OnBlur();
+
+  ime::PublicMessage actual_message = OnBlurToProto(/*seq_id=*/42);
+
+  EXPECT_EQ(actual_message.SerializeAsString(),
+            expected_message.SerializeAsString());
+}
+
 TEST(ProtoConversionTest, OnKeyEventToProto) {
   auto modifier_state = mojom::ModifierState::New();
   modifier_state->shift = true;

chromeos/services/ime/ime_service_unittest.cc

@@ -56,6 +56,7 @@ class TestClientChannel : mojom::InputChannel {
                void(const std::vector<uint8_t>& message,
                     ProcessMessageCallback));
   MOCK_METHOD0(OnFocus, void());
+  MOCK_METHOD0(OnBlur, void());
   MOCK_METHOD2(ProcessKeypressForRulebased,
                void(const mojom::PhysicalKeyEventPtr event,
                     ProcessKeypressForRulebasedCallback));

chromeos/services/ime/input_engine.cc

@@ -111,6 +111,10 @@ void InputEngine::OnFocus() {
   NOTIMPLEMENTED();  // Not used in the rulebased engine.
 }
 
+void InputEngine::OnBlur() {
+  NOTIMPLEMENTED();  // Not used in the rulebased engine.
+}
+
 void InputEngine::OnSurroundingTextChanged(
     const std::string& text,
     uint32_t offset,

chromeos/services/ime/input_engine.h

@@ -47,6 +47,7 @@ class InputEngine : public mojom::InputChannel {
   void ProcessMessage(const std::vector<uint8_t>& message,
                       ProcessMessageCallback callback) override;
   void OnFocus() override;
+  void OnBlur() override;
   void OnSurroundingTextChanged(
       const std::string& text,
       uint32_t offset,

chromeos/services/ime/public/mojom/input_engine.mojom

@@ -125,6 +125,9 @@ interface InputChannel {
   // Called when there's a new focused input field.
   OnFocus();
 
+  // Called when the input field loses focus.
+  OnBlur();
+
   // Process a PhysicalKeyEvent for non-rule-based engines.
   OnKeyEvent(PhysicalKeyEvent event) => (bool consumed);
 

chromeos/services/ime/public/proto/messages.proto

@@ -33,6 +33,7 @@ message PublicMessage {
     OnKeyEvent on_key_event = 3;
     OnKeyEventReply on_key_event_reply = 4;
     OnSurroundingTextChanged on_surrounding_text_changed = 5;
+    OnBlur on_blur = 6;
   }
 }
 
@@ -42,6 +43,10 @@ message OnFocus {
   // TODO(crbug/1019541): Add information about the input field.
 }
 
+// Protobuf version of InputEngine::OnBlur in
+// chromeos/services/ime/public/mojom/input_engine.mojom
+message OnBlur {}
+
 // Protobuf version of InputEngine::OnKeyEvent in
 // chromeos/services/ime/public/mojom/input_engine.mojom
 message OnKeyEvent {