ime: Send input method changes to IME service.

Add Mojo and protobuf messages for Chrome to send input method changes
to the IME service.

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

chrome/browser/chromeos/input_method/native_input_method_engine.cc

@@ -395,6 +395,9 @@ void NativeInputMethodEngine::ImeObserver::OnConnected(base::Time start,
                  : ImeServiceEvent::kActivateImeSuccess);
 
   active_engine_id_ = engine_id;
+  if (ShouldUseFstMojoEngine(engine_id)) {
+    remote_to_engine_->OnInputMethodChanged(engine_id);
+  }
 }
 
 void NativeInputMethodEngine::ImeObserver::OnError(base::Time start) {

chrome/browser/chromeos/input_method/native_input_method_engine.h

@@ -92,6 +92,7 @@ class NativeInputMethodEngine : public InputMethodEngine {
     // mojom::InputChannel:
     void ProcessMessage(const std::vector<uint8_t>& message,
                         ProcessMessageCallback callback) override;
+    void OnInputMethodChanged(const std::string& engine_id) override {}
     void OnFocus(ime::mojom::InputFieldInfoPtr input_field_info) override {}
     void OnBlur() override {}
     void OnSurroundingTextChanged(

chromeos/services/ime/decoder/decoder_engine.cc

@@ -138,6 +138,15 @@ bool DecoderEngine::IsImeSupportedByDecoder(const std::string& ime_spec) {
          engine_main_entry_->IsImeSupported(ime_spec.c_str());
 }
 
+void DecoderEngine::OnInputMethodChanged(const std::string& engine_id) {
+  const uint64_t seq_id = current_seq_id_;
+  ++current_seq_id_;
+
+  ProcessMessage(
+      WrapAndSerializeMessage(OnInputMethodChangedToProto(seq_id, engine_id)),
+      base::DoNothing());
+}
+
 void DecoderEngine::OnFocus(mojom::InputFieldInfoPtr input_field_info) {
   const uint64_t seq_id = current_seq_id_;
   ++current_seq_id_;

chromeos/services/ime/decoder/decoder_engine.h

@@ -32,6 +32,7 @@ class DecoderEngine : public InputEngine {
 
   void ProcessMessage(const std::vector<uint8_t>& message,
                       ProcessMessageCallback callback) override;
+  void OnInputMethodChanged(const std::string& engine_id) override;
   void OnFocus(mojom::InputFieldInfoPtr input_field_info) override;
   void OnBlur() override;
   void OnKeyEvent(mojom::PhysicalKeyEventPtr event,

chromeos/services/ime/decoder/decoder_engine_unittest.cc

@@ -53,6 +53,7 @@ class StubInputChannel : public mojom::InputChannel {
                       ProcessMessageCallback callback) final {
     std::move(callback).Run({});
   }
+  void OnInputMethodChanged(const std::string& engine_id) final {}
   void OnFocus(mojom::InputFieldInfoPtr input_field_info) final {}
   void OnBlur() final {}
   void ProcessKeypressForRulebased(
@@ -103,6 +104,23 @@ TEST_F(DecoderEngineTest, BindRequestBindsInterfaces) {
   EXPECT_TRUE(receiver.is_bound());
 }
 
+TEST_F(DecoderEngineTest, OnInputMethodChangedSendsMessageToSharedLib) {
+  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() =
+      OnInputMethodChangedToProto(/*seq_id=*/0, "xkb:us::eng");
+
+  EXPECT_CALL(mock_main_entry_, Process).With(EqualsProto(expected_proto));
+
+  client->OnInputMethodChanged("xkb:us::eng");
+  client.FlushForTesting();
+}
+
 TEST_F(DecoderEngineTest, OnFocusSendsMessageToSharedLib) {
   DecoderEngine engine(/*platform=*/nullptr);
   StubInputChannel stub_channel;

chromeos/services/ime/decoder/proto_conversion.cc

@@ -63,6 +63,15 @@ InputFieldInfo::PersonalizationMode PersonalizationModeToProto(
 
 }  // namespace
 
+ime::PublicMessage OnInputMethodChangedToProto(uint64_t seq_id,
+                                               const std::string& engine_id) {
+  ime::PublicMessage message;
+  message.set_seq_id(seq_id);
+
+  message.mutable_on_input_method_changed()->set_engine_id(engine_id);
+  return message;
+}
+
 ime::PublicMessage OnFocusToProto(uint64_t seq_id,
                                   mojom::InputFieldInfoPtr input_field_info) {
   ime::PublicMessage message;

chromeos/services/ime/decoder/proto_conversion.h

@@ -13,6 +13,11 @@
 namespace chromeos {
 namespace ime {
 
+// Converts arguments of a Mojo call to InputChannel::OnInputMethodChanged into
+// a proto.
+ime::PublicMessage OnInputMethodChangedToProto(uint64_t seq_id,
+                                               const std::string& engine_id);
+
 // Converts arguments of a Mojo call to InputChannel::OnFocus into a proto.
 ime::PublicMessage OnFocusToProto(uint64_t seq_id,
                                   mojom::InputFieldInfoPtr input_field_info);

chromeos/services/ime/decoder/proto_conversion_unittest.cc

@@ -10,6 +10,20 @@
 namespace chromeos {
 namespace ime {
 
+TEST(ProtoConversionTest, OnInputMethodChangedToProto) {
+  ime::PublicMessage expected_message;
+  expected_message.set_seq_id(42);
+  ime::OnInputMethodChanged& args =
+      *expected_message.mutable_on_input_method_changed();
+  args.set_engine_id("xkb:us::eng");
+
+  ime::PublicMessage actual_message =
+      OnInputMethodChangedToProto(/*seq_id=*/42, "xkb:us::eng");
+
+  EXPECT_EQ(actual_message.SerializeAsString(),
+            expected_message.SerializeAsString());
+}
+
 TEST(ProtoConversionTest, OnFocusToProto) {
   auto info = mojom::InputFieldInfo::New(mojom::InputFieldType::kNumber,
                                          mojom::AutocorrectMode::kEnabled,

chromeos/services/ime/ime_service_unittest.cc

@@ -55,6 +55,7 @@ class TestClientChannel : mojom::InputChannel {
   MOCK_METHOD2(ProcessMessage,
                void(const std::vector<uint8_t>& message,
                     ProcessMessageCallback));
+  MOCK_METHOD1(OnInputMethodChanged, void(const std::string& engine_id));
   MOCK_METHOD1(OnFocus, void(mojom::InputFieldInfoPtr input_field_info));
   MOCK_METHOD0(OnBlur, void());
   MOCK_METHOD2(ProcessKeypressForRulebased,

chromeos/services/ime/input_engine.cc

@@ -107,6 +107,10 @@ void InputEngine::ProcessMessage(const std::vector<uint8_t>& message,
   NOTIMPLEMENTED();  // Protobuf message is not used in the rulebased engine.
 }
 
+void InputEngine::OnInputMethodChanged(const std::string& engine_id) {
+  NOTIMPLEMENTED();  // Not used in the rulebased engine.
+}
+
 void InputEngine::OnFocus(mojom::InputFieldInfoPtr input_field_info) {
   NOTIMPLEMENTED();  // Not used in the rulebased engine.
 }

chromeos/services/ime/input_engine.h

@@ -46,6 +46,7 @@ class InputEngine : public mojom::InputChannel {
   // mojom::InputChannel overrides:
   void ProcessMessage(const std::vector<uint8_t>& message,
                       ProcessMessageCallback callback) override;
+  void OnInputMethodChanged(const std::string& engine_id) override;
   void OnFocus(mojom::InputFieldInfoPtr input_field_info) override;
   void OnBlur() override;
   void OnSurroundingTextChanged(

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

@@ -164,6 +164,11 @@ interface InputChannel {
   // protobuf message.
   ProcessMessage(array<uint8> message) => (array<uint8> result);
 
+  // Called when the input method changes.
+  // |engine_id| is the unique identifier for the input method, as specified in:
+  // chrome/browser/resources/chromeos/input_method/google_xkb_manifest.json
+  OnInputMethodChanged(string engine_id);
+
   // Called when there's a new focused input field.
   OnFocus(InputFieldInfo input_field_info);
 

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

@@ -35,6 +35,7 @@ message PublicMessage {
     OnSurroundingTextChanged on_surrounding_text_changed = 5;
     OnBlur on_blur = 6;
     OnCompositionCanceled on_composition_canceled = 7;
+    OnInputMethodChanged on_input_method_changed = 8;
   }
 }
 
@@ -70,6 +71,12 @@ message InputFieldInfo {
   optional PersonalizationMode personalization = 3;
 }
 
+// Protobuf version of InputEngine::OnInputMethodChanged in
+// chromeos/services/ime/public/mojom/input_engine.mojom
+message OnInputMethodChanged {
+  optional string engine_id = 1;
+}
+
 // Protobuf version of InputEngine::OnFocus in
 // chromeos/services/ime/public/mojom/input_engine.mojom
 message OnFocus {