Make "compositionend" event fired after setting caret position

third_party/WebKit/Source/core/editing/InputMethodControllerTest.cpp

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "core/editing/InputMethodController.h"
 
 #include "core/dom/Document.h"
 #include "core/dom/Element.h"
 #include "core/dom/Range.h"
 #include "core/editing/Editor.h"
@@ skipping 793 matching lines @@
   EXPECT_EQ(3u, controller().getSelectionOffsets().end());
 }
 
 TEST_F(InputMethodControllerTest, CompositionInputEventIsComposing) {
   document().settings()->setScriptEnabled(true);
   Element* editable = insertHTMLElement(
       "<div id='sample' contentEditable='true'></div>", "sample");
   Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);
   script->setInnerHTML(
       "document.getElementById('sample').addEventListener('beforeinput', "
-      "function(event) {"
+      "event => {"
       "    document.title = `beforeinput.isComposing:${event.isComposing};`;"
       "});"
       "document.getElementById('sample').addEventListener('input', "
-      "function(event) {"
+      "event => {"
       "    document.title += `input.isComposing:${event.isComposing};`;"
       "});",
       ASSERT_NO_EXCEPTION);
   document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
   document().view()->updateAllLifecyclePhases();
 
   // Simulate composition in the |contentEditable|.
   Vector<CompositionUnderline> underlines;
   underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
   editable->focus();
 
   document().setTitle(emptyString());
   controller().setComposition("foo", underlines, 0, 3);
   EXPECT_STREQ("beforeinput.isComposing:true;input.isComposing:true;",
                document().title().utf8().data());
 
   document().setTitle(emptyString());
   controller().finishComposingText(InputMethodController::KeepSelection);
   // Last pair of InputEvent should also be inside composition scope.
   EXPECT_STREQ("beforeinput.isComposing:true;input.isComposing:true;",
                document().title().utf8().data());
 }
 
-TEST_F(InputMethodControllerTest, CompositionInputEventData) {
+TEST_F(InputMethodControllerTest, CompositionInputEventForReplace) {

[yosin_UTC9, 2016/11/17 01:39:55]

Could you make another CL for re-factoring IMCTest.cpp?

[yabinh, 2016/11/17 05:15:54]

Done.

   document().settings()->setScriptEnabled(true);
   Element* editable = insertHTMLElement(
       "<div id='sample' contentEditable='true'></div>", "sample");

[yosin_UTC9, 2016/11/17 01:39:55]

nit: s/contentEditable='true'/contenteditable/

[yabinh, 2016/11/17 05:15:55]

Done.
Also applied to other places.

   Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);
   script->setInnerHTML(
       "document.getElementById('sample').addEventListener('beforeinput', "
-      "function(event) {"
+      "event => {"

[yosin_UTC9, 2016/11/17 01:39:55]

nit: You can write this in one line:

event => document.tile += `beforeinput.data:${event.data};`);

This can make code compact.

[yabinh, 2016/11/17 05:15:55]

Done.

       "    document.title = `beforeinput.data:${event.data};`;"
       "});"
       "document.getElementById('sample').addEventListener('input', "
-      "function(event) {"
+      "event => {"
       "    document.title += `input.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      "    document.title += `compositionend.data:${event.data};`;"
       "});",
       ASSERT_NO_EXCEPTION);
   document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
   document().view()->updateAllLifecyclePhases();
 
   // Simulate composition in the |contentEditable|.
   Vector<CompositionUnderline> underlines;
   underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
   editable->focus();
 
   document().setTitle(emptyString());
-  controller().setComposition("n", underlines, 0, 1);
+  controller().setComposition("hell", underlines, 4, 4);
+  EXPECT_STREQ("beforeinput.data:hell;input.data:hell;",
+               document().title().utf8().data());
+
+  // Replace the existing composition.
+  // TODO(yabinh): should be "beforeinput.data:hello;input.data:hello;".
+  document().setTitle(emptyString());
+  controller().setComposition("hello", underlines, 0, 0);
+  EXPECT_STREQ("beforeinput.data:o;input.data:o;",
+               document().title().utf8().data());
+}
+
+TEST_F(InputMethodControllerTest, CompositionInputEventForConfirm) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('beforeinput', "
+      "event => {"
+      "    document.title = `beforeinput.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('input', "
+      "event => {"
+      "    document.title += `input.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      "    document.title += `compositionend.data:${event.data};`;"
+      "});",
+      ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

Note: I'm going to make |ASSERT_NO_EXCPETION| in |setInnerHTML()| to be default.
See http://crrev.com/2505883002

[yabinh, 2016/11/17 05:15:54]

Done.

+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  document().setTitle(emptyString());
+  controller().setComposition("hello", underlines, 5, 5);
+  EXPECT_STREQ("beforeinput.data:hello;input.data:hello;",
+               document().title().utf8().data());
+
+  // Confirm the ongoing composition.
+  document().setTitle(emptyString());
+  controller().finishComposingText(InputMethodController::KeepSelection);
+  EXPECT_STREQ(
+      "beforeinput.data:hello;input.data:hello;compositionend.data:hello;",
+      document().title().utf8().data());
+}
+
+TEST_F(InputMethodControllerTest, CompositionInputEventForDelete) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('beforeinput', "
+      "event => {"
+      "    document.title = `beforeinput.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('input', "
+      "event => {"
+      "    document.title += `input.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      "    document.title += `compositionend.data:${event.data};`;"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  document().setTitle(emptyString());
+  controller().setComposition("hello", underlines, 5, 5);
+  EXPECT_STREQ("beforeinput.data:hello;input.data:hello;",
+               document().title().utf8().data());
+
+  // Delete the existing composition.
+  document().setTitle(emptyString());
+  controller().setComposition("", underlines, 0, 0);
+  EXPECT_STREQ("beforeinput.data:;compositionend.data:;",
+               document().title().utf8().data());
+}
+
+TEST_F(InputMethodControllerTest, CompositionInputEventForInsert) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('beforeinput', "
+      "event => {"
+      "    document.title = `beforeinput.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('input', "
+      "event => {"
+      "    document.title += `input.data:${event.data};`;"
+      "});"
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      "    document.title += `compositionend.data:${event.data};`;"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  // Insert new text without previous composition.
+  document().setTitle(emptyString());
+  document().updateStyleAndLayout();
+  controller().commitText("hello", 0);
+  EXPECT_STREQ("beforeinput.data:hello;input.data:hello;",
+               document().title().utf8().data());
+
+  document().setTitle(emptyString());
+  controller().setComposition("n", underlines, 1, 1);
   EXPECT_STREQ("beforeinput.data:n;input.data:n;",
                document().title().utf8().data());
 
-  document().setTitle(emptyString());
-  controller().setComposition("ni", underlines, 0, 1);
-  EXPECT_STREQ("beforeinput.data:i;input.data:i;",
-               document().title().utf8().data());
-
-  document().setTitle(emptyString());
-  controller().finishComposingText(InputMethodController::KeepSelection);
-  EXPECT_STREQ("beforeinput.data:ni;input.data:ni;",
-               document().title().utf8().data());
+  // Insert new text with previous composition.
+  document().setTitle(emptyString());
+  document().updateStyleAndLayout();
+  controller().commitText("hello", 1);
+  EXPECT_STREQ(
+      "beforeinput.data:hello;input.data:hello;compositionend.data:hello;",
+      document().title().utf8().data());
+}
+
+TEST_F(InputMethodControllerTest, CompositionEndEventForConfirm) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);
+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      // If the caret position is set before firing 'compositonend' event (and
+      // it should), the final caret position will be reset to [3,3].
+      "    const node = document.getElementById('sample').firstChild;"
+      "    getSelection().collapse(node, 3);"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  controller().setComposition("hello", underlines, 1, 1);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(1u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(1u, controller().getSelectionOffsets().end());
+
+  // Confirm the ongoing composition. Note that it moves the caret to the end of
+  // text [5,5] before firing 'compositonend' event.
+  controller().finishComposingText(InputMethodController::DoNotKeepSelection);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(3u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(3u, controller().getSelectionOffsets().end());
+}
+
+TEST_F(InputMethodControllerTest, CompositionEndEventForInsert) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      // If the caret position is set before firing 'compositonend' event (and
+      // it should), the final caret position will be reset to [3,3].
+      "    const node = document.getElementById('sample').firstChild;"
+      "    getSelection().collapse(node, 3);"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  controller().setComposition("n", underlines, 1, 1);
+
+  // Insert new text with previous composition. Note that it moves the caret to
+  // [4,4] before firing 'compositonend' event.
+  document().updateStyleAndLayout();
+  controller().commitText("hello", -1);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(3u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(3u, controller().getSelectionOffsets().end());
+}
+
+TEST_F(InputMethodControllerTest, CompositionEndEventWithRangeSelection) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:55]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      // If the caret position is set before firing 'compositonend' event (and
+      // it should), the final caret position will be reset to [2,4].
+      "    const node = document.getElementById('sample').firstChild;"
+      "    var range = document.createRange();"
+      "    range.setStart(node, 2);"
+      "    range.setEnd(node, 4);"
+      "    const selection = getSelection();"
+      "    selection.removeAllRanges();"
+      "    selection.addRange(range);"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  controller().setComposition("hello", underlines, 1, 1);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(1u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(1u, controller().getSelectionOffsets().end());
+
+  // Confirm the ongoing composition. Note that it moves the caret to the end of
+  // text [5,5] before firing 'compositonend' event.
+  controller().finishComposingText(InputMethodController::DoNotKeepSelection);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(2u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(4u, controller().getSelectionOffsets().end());
+}
+
+TEST_F(InputMethodControllerTest, CompositionEndEventWithNoneSelection) {
+  document().settings()->setScriptEnabled(true);
+  Element* editable = insertHTMLElement(
+      "<div id='sample' contentEditable='true'></div>", "sample");
+  Element* script = document().createElement("script", ASSERT_NO_EXCEPTION);

[yosin_UTC9, 2016/11/17 01:39:55]

nit: No need to have |ASSERT_NO_EXCEPTION|

[yabinh, 2016/11/17 05:15:54]

Done.

+  script->setInnerHTML(
+      "document.getElementById('sample').addEventListener('compositionend', "
+      "event => {"
+      // If the caret position is set before firing 'compositonend' event (and
+      // it should), the final caret position will be reset to null.
+      "    getSelection().removeAllRanges();"
+      "});",
+      ASSERT_NO_EXCEPTION);
+  document().body()->appendChild(script, ASSERT_NO_EXCEPTION);
+  document().view()->updateAllLifecyclePhases();
+
+  // Simulate composition in the |contentEditable|.
+  Vector<CompositionUnderline> underlines;
+  underlines.append(CompositionUnderline(0, 5, Color(255, 0, 0), false, 0));
+  editable->focus();
+
+  controller().setComposition("hello", underlines, 1, 1);
+  document().updateStyleAndLayout();
+  EXPECT_EQ(1u, controller().getSelectionOffsets().start());
+  EXPECT_EQ(1u, controller().getSelectionOffsets().end());
+
+  // Confirm the ongoing composition. Note that it moves the caret to the end of
+  // text [5,5] before firing 'compositonend' event.
+  controller().finishComposingText(InputMethodController::DoNotKeepSelection);
+  document().updateStyleAndLayout();
+  EXPECT_TRUE(controller().getSelectionOffsets().isNull());
 }
 
 }  // namespace blink