Fix/window event race condition

openadapt/window/__init__.py

@@ -31,7 +31,7 @@ def get_active_window_data(
         dict or None: A dictionary containing information about the active window,
             or None if the state is not available.
     """
-    state = get_active_window_state(include_window_data)
+    state = get_active_window_state_pgw(include_window_data)
     if not state:
         return {}
     title = state["title"]
@@ -67,6 +67,20 @@ def get_active_window_state(read_window_data: bool) -> dict | None:
         return None
 
 
+def get_active_window_state_pgw(read_window_data: bool) -> dict | None:
+    """Get the state of the active window using pygetwindow.
+
+    Returns:
+        dict or None: A dictionary containing the state of the active window,
+          or None if the state is not available.
+    """
+    try:
+        return impl.get_active_window_state_pgw(read_window_data)
+    except Exception as exc:
+        logger.warning(f"{exc=}")
+        return None
+
+
 def get_active_element_state(x: int, y: int) -> dict | None:
     """Get the state of the active element at the specified coordinates.
 

openadapt/window/_windows.py

@@ -1,11 +1,63 @@
 from pprint import pprint
+import pygetwindow as gw
 import pickle
 import time
 
 from loguru import logger
 import pywinauto
 
 
+def get_active_window_state_pgw(read_window_data: bool) -> dict:
+    try:
+        active_window = gw.getActiveWindow()
+        if not active_window:
+            raise RuntimeError("No active window found.")
+    except RuntimeError as e:
+        logger.warning(e)
+        return {}
+
+    meta = {
+        "title": active_window.title,
+        "left": active_window.left,
+        "top": active_window.top,
+        "width": active_window.width,
+        "height": active_window.height,
+        "rectangle": {
+            "left": active_window.left,
+            "top": active_window.top,
+            "right": active_window.right,
+            "bottom": active_window.bottom,
+            "width": active_window.width,
+            "height": active_window.height,
+        },
+        "control_id": active_window._hWnd,
+    }
+
+    if read_window_data:
+        data = get_element_properties_pgw(active_window)
+    else:
+        data = {}
+
+    state = {
+        "title": meta["title"],
+        "left": meta["left"],
+        "top": meta["top"],
+        "width": meta["width"],
+        "height": meta["height"],
+        "meta": meta,
+        "data": data,
+        "window_id": meta["control_id"],
+    }
+
+    try:
+        pickle.dumps(state)
+    except Exception as exc:
+        logger.warning(f"{exc=}")
+        state.pop("data")
+
+    return state
+
+
 def get_active_window_state(read_window_data: bool) -> dict:
     """Get the state of the active window.
 
@@ -149,6 +201,34 @@ def dictify_rect(rect: pywinauto.win32structures.RECT) -> dict:
     return rect_dict
 
 
+def get_element_properties_pgw(window: gw.Window) -> dict:
+    """Simulates retrieving properties of a window element and its children.
+
+    Args:
+        window: An instance of a pygetwindow Window.
+
+    Returns:
+        dict: A nested dictionary containing the properties of the window.
+        The dictionary includes a "children" key, which will be an empty list
+        since pygetwindow does not support child elements retrieval.
+    """
+    properties = {
+        "title": window.title,
+        "left": window.left,
+        "top": window.top,
+        "width": window.width,
+        "height": window.height,
+        "rectangle": {
+            "left": window.left,
+            "top": window.top,
+            "width": window.width,
+            "height": window.height,
+        },
+        "children": [],  # pygetwindow does not support children
+    }
+    return properties
+
+
 def get_properties(element: pywinauto.application.WindowSpecification) -> dict:
     """Retrieves specific writable properties of an element.
 

tests/openadapt/test_window_state.py

@@ -0,0 +1,89 @@
+import pytest
+import time
+from openadapt import window
+
+
+def test_get_active_window_state():
+
+    state = window.get_active_window_state(True)
+
+    # Ensure state is a dictionary
+    assert isinstance(state, dict), "State should be a dictionary"
+
+    # Check for required keys
+    required_keys = {
+        "title",
+        "left",
+        "top",
+        "width",
+        "height",
+        "meta",
+        "data",
+        "window_id",
+    }
+    for key in required_keys:
+        assert key in state, f"Missing key in state: {key}"
+
+    # Check the type of each key
+    assert isinstance(state["title"], str), "Title should be a string"
+    assert isinstance(state["left"], int), "Left should be an integer"
+    assert isinstance(state["top"], int), "Top should be an integer"
+    assert isinstance(state["width"], int), "Width should be an integer"
+    assert isinstance(state["height"], int), "Height should be an integer"
+    assert isinstance(state["meta"], dict), "Meta should be a dictionary"
+    assert isinstance(state["data"], dict), "Data should be a dictionary"
+    assert isinstance(state["window_id"], int), "Window ID should be an integer"
+
+
+def test_get_active_window_state_pgw():
+    state = window.get_active_window_state_pgw(True)
+
+    # Ensure state is a dictionary
+    assert isinstance(state, dict), "State should be a dictionary"
+
+    # Check for required keys
+    required_keys = {
+        "title",
+        "left",
+        "top",
+        "width",
+        "height",
+        "meta",
+        "data",
+        "window_id",
+    }
+    for key in required_keys:
+        assert key in state, f"Missing key in state: {key}"
+
+    # Check the type of each key
+    assert isinstance(state["title"], str), "Title should be a string"
+    assert isinstance(state["left"], int), "Left should be an integer"
+    assert isinstance(state["top"], int), "Top should be an integer"
+    assert isinstance(state["width"], int), "Width should be an integer"
+    assert isinstance(state["height"], int), "Height should be an integer"
+    assert isinstance(state["meta"], dict), "Meta should be a dictionary"
+    assert isinstance(state["data"], dict), "Data should be a dictionary"
+    assert isinstance(state["window_id"], int), "Window ID should be an integer"
+
+
+def test_execution_time():
+    # Measure execution time for pywinauto-based function
+    start_time = time.perf_counter()
+    window.get_active_window_state(True)
+    pywinauto_duration = time.perf_counter() - start_time
+
+    # Measure execution time for pygetwindow-based function
+    start_time = time.perf_counter()
+    window.get_active_window_state_pgw(True)
+    pygetwindow_duration = time.perf_counter() - start_time
+
+    print(f"pygetwindow duration: {pygetwindow_duration:.10f}")
+    print(f"pywinauto duration: {pywinauto_duration:.10f}")
+
+    assert (
+        pygetwindow_duration < pywinauto_duration
+    ), "pygetwindow should be faster than pywinauto"
+
+
+if __name__ == "__main__":
+    pytest.main()