fix: punctuation map tab/click blur due to rerender (related bd223d0) (#374)

Author: eagleoflqj

appium/conftest.py

@@ -30,10 +30,21 @@ def check_appium_server() -> bool:
         return False
 
 
-def launch_app(driver: WebDriver, session_config_dir: str, test_name: str) -> str:
+def launch_app(driver: WebDriver, session_base_dir: str, test_name: str) -> str:
     """Launch the test app."""
-    config_home = os.path.join(session_config_dir, test_name)
-    os.makedirs(config_home, exist_ok=True)
+    config_home = os.path.join(session_base_dir, test_name, "config")
+    os.makedirs(config_home)
+    data_home = os.path.join(session_base_dir, test_name, "data")
+    os.makedirs(data_home)
+
+    # Too many entries. Reduce to accelerate.
+    if test_name == "test_punctuation_map":
+        punctuation = os.path.join(data_home, "punctuation")
+        mb = os.path.join(punctuation, "punc.mb.zh_CN")
+        os.makedirs(punctuation)
+        with open(mb, "w") as f:
+            f.write(". 。\n, ，")
+
     profile_src = os.path.join(os.path.dirname(os.path.abspath(__file__)), "profile")
     shutil.copy2(profile_src, os.path.join(config_home, "profile"))
     app_path = os.path.join(
@@ -46,6 +57,7 @@ def launch_app(driver: WebDriver, session_config_dir: str, test_name: str) -> st
             "arguments": [],
             "environment": {
                 "FCITX_CONFIG_HOME": config_home,
+                "FCITX_DATA_HOME": data_home,
             },
         },
     )
@@ -95,7 +107,7 @@ def driver(appium_server: str) -> Generator[WebDriver, None, None]:
 
 
 @pytest.fixture(scope="session")
-def session_config_dir() -> Generator[str, None, None]:
+def session_base_dir() -> Generator[str, None, None]:
     """Create a unique base config directory for this test session."""
     timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
     base_dir = os.path.join(project_root, "build/appium", timestamp)
@@ -107,11 +119,11 @@ def session_config_dir() -> Generator[str, None, None]:
 def app(
     request: pytest.FixtureRequest,
     driver: WebDriver,
-    session_config_dir: str,
+    session_base_dir: str,
 ) -> Generator[str, None, None]:
     """Manage test app lifecycle for a single test case."""
     # Launch fresh app
-    config_home = launch_app(driver, session_config_dir, request.node.name)
+    config_home = launch_app(driver, session_base_dir, request.node.name)
     yield config_home
     # Clean up after test
     terminate_app(driver)

appium/test_entry.py

@@ -0,0 +1,72 @@
+import os
+
+from appium.webdriver.webdriver import WebDriver
+from util.button import get_undo_redo
+from util.key import press
+from util.message import CHANGE_NOT_SAVED, UI_NOT_UPDATED, UI_WRONGLY_UPDATED
+from util.string import get_string_value, is_focused
+from util.window import (
+    find_element_by_id,
+    find_elements_by_id,
+    open_input_method_config,
+    scroll,
+)
+
+KEY = "Key"
+MAPPING = "Mapping"
+ALT_MAPPING = "AltMapping"
+
+
+def test_punctuation_map(driver: WebDriver, app: str) -> None:
+    open_input_method_config(driver, "pinyin")
+    scroll(
+        find_element_by_id(driver, "detailScrollView"),
+        find_element_by_id(driver, "Punctuation"),
+        find_element_by_id(driver, "PageSize"),
+    )
+    punctuation = find_element_by_id(driver, "Punctuation")
+    punctuation.click()
+
+    def read_config_value() -> str:
+        punc_path = os.path.join(app, r"../data/punctuation/punc.mb.zh_CN")
+        with open(punc_path, "r") as f:
+            return f.readline().strip()
+
+    undo, _ = get_undo_redo(driver)
+    key = find_elements_by_id(driver, KEY)[0]
+    assert is_focused(key), UI_NOT_UPDATED
+
+    key.send_keys("*")
+    press(driver, ["\t"])
+    mapping = find_elements_by_id(driver, MAPPING)[0]
+    assert is_focused(mapping), UI_WRONGLY_UPDATED
+    # Shouldn't trigger rerender so reuse key.
+    assert get_string_value(key) == "*", UI_WRONGLY_UPDATED
+    assert read_config_value() == "* 。", CHANGE_NOT_SAVED
+
+    mapping.send_keys(r"\times")
+    alt_mapping = find_elements_by_id(driver, ALT_MAPPING)[0]
+    alt_mapping.click()
+    assert get_string_value(key) == "*", UI_WRONGLY_UPDATED
+    assert get_string_value(mapping) == r"\times", UI_WRONGLY_UPDATED
+    assert read_config_value() == r"* \times", CHANGE_NOT_SAVED
+    assert is_focused(alt_mapping), UI_WRONGLY_UPDATED
+
+    alt_mapping.send_keys(r"\dot")
+    press(driver, ["\n"])
+    assert get_string_value(key) == "*", UI_WRONGLY_UPDATED
+    assert get_string_value(mapping) == r"\times", UI_WRONGLY_UPDATED
+    assert get_string_value(alt_mapping) == r"\dot", UI_WRONGLY_UPDATED
+    assert read_config_value() == r"* \times \dot", CHANGE_NOT_SAVED
+
+    undo.click()
+    assert get_string_value(find_elements_by_id(driver, KEY)[0]) == "*", (
+        UI_WRONGLY_UPDATED
+    )
+    assert get_string_value(find_elements_by_id(driver, MAPPING)[0]) == r"\times", (
+        UI_WRONGLY_UPDATED
+    )
+    assert get_string_value(find_elements_by_id(driver, ALT_MAPPING)[0]) == "", (
+        UI_NOT_UPDATED
+    )
+    assert read_config_value() == r"* \times", CHANGE_NOT_SAVED

appium/test_group.py

@@ -7,7 +7,12 @@
     UI_NOT_UPDATED,
     UI_WRONGLY_UPDATED,
 )
-from util.window import find_element_by_id, open_input_method_config, reset_option
+from util.window import (
+    find_element_by_id,
+    open_input_method_config,
+    reset_option,
+    scroll,
+)
 
 SWITCH_IDS = ["VAsQuickphrase", "VE_UE", "NG_GN"]
 
@@ -23,16 +28,10 @@ def read_config_values() -> list[str]:
             cfg["Fuzzy"][SWITCH_IDS[2]],
         ]
 
-    page_size = find_element_by_id(driver, "PageSize")
-    scroll = find_element_by_id(driver, "detailScrollView")
-    delta_y = page_size.rect["y"] - find_element_by_id(driver, SWITCH_IDS[0]).rect["y"]
-    driver.execute_script(
-        "macos: scroll",
-        {
-            "elementId": scroll.id,
-            "deltaX": 0,
-            "deltaY": delta_y,
-        },
+    scroll(
+        find_element_by_id(driver, "detailScrollView"),
+        find_element_by_id(driver, SWITCH_IDS[0]),
+        find_element_by_id(driver, "PageSize"),
     )
 
     for switch_id in SWITCH_IDS:

appium/util/button.py

@@ -1,15 +1,15 @@
 from appium.webdriver.webdriver import WebDriver
 from selenium.webdriver.remote.webelement import WebElement
 from util.message import BUTTON_SHOULD_BE_DISABLED
-from util.window import find_element_by_id
+from util.window import find_elements_by_id
 
 
 def get_undo_redo(driver: WebDriver) -> tuple[WebElement, WebElement]:
     """Get undo and redo buttons, asserting they are initially disabled."""
-    undo = find_element_by_id(driver, "arrow.uturn.left")
+    undo = find_elements_by_id(driver, "arrow.uturn.left")[0]
     assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
-    redo = find_element_by_id(driver, "arrow.uturn.right")
+    redo = find_elements_by_id(driver, "arrow.uturn.right")[0]
     assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
     return undo, redo

appium/util/string.py

@@ -4,3 +4,8 @@
 def get_string_value(element: WebElement) -> str:
     """Get the current string value from a text field."""
     return element.get_attribute("value")
+
+
+def is_focused(element: WebElement) -> bool:
+    """Check if the element is focused."""
+    return element.get_attribute("focused") == "true"

appium/util/window.py

@@ -38,6 +38,19 @@ def open_input_method_config(driver: WebDriver, im: str):
     find_element_by_id(driver, im).click()
 
 
+def scroll(container: WebElement, target: WebElement, first: WebElement):
+    """Scroll the container to show the target element relative to the first element."""
+    delta_y = first.rect["y"] - target.rect["y"]
+    container.parent.execute_script(
+        "macos: scroll",
+        {
+            "elementId": container.id,
+            "deltaX": 0,
+            "deltaY": delta_y,
+        },
+    )
+
+
 def reset_option(driver: WebDriver, option_id: str):
     label = find_element_by_id(driver, f"{option_id}_label")
     driver.execute_script(

src/config/ExternalView.swift

@@ -95,6 +95,7 @@ struct ExternalView: OptionViewProtocol {
         } label: {
           Image(systemName: "gear")
         }
+        .accessibilityIdentifier(option ?? "")
         .sheet(isPresented: $showDialog) {
           VStack {
             ScrollView([.vertical]) {  // ScrollView is useful for punctuation map.

src/config/ListView.swift

@@ -114,8 +114,12 @@ struct ListView: OptionViewProtocol {
       .accessibilityIdentifier("\(optionId)_plus")
     }
     .onChange(of: value as? NSDictionary) { newValue in
-      Task {
-        list = deserialize(newValue ?? [:])
+      let newList = deserialize(newValue ?? [:])
+      // Avoid reset focus on press tab for punctuation map.
+      if "\(serialize(list))" != "\(serialize(newList))" {
+        Task {
+          list = newList
+        }
       }
     }
   }