Fixed App.current_window on macOS, for when a dialog is in focus

android/src/toga_android/dialogs.py

@@ -40,24 +40,27 @@ def __init__(
     ):
         super().__init__()
 
-        self.native = AlertDialog.Builder(toga.App.app.current_window._impl.app.native)
-        self.native.setCancelable(False)
-        self.native.setTitle(title)
-        self.native.setMessage(message)
+        self.native_builder = AlertDialog.Builder(
+            toga.App.app.current_window._impl.app.native
+        )
+        self.native_builder.setCancelable(False)
+        self.native_builder.setTitle(title)
+        self.native_builder.setMessage(message)
         if icon is not None:
-            self.native.setIcon(icon)
+            self.native_builder.setIcon(icon)
 
-        self.native.setPositiveButton(
+        self.native_builder.setPositiveButton(
             positive_text,
             OnClickListener(
                 self.completion_handler,
                 True if (negative_text is not None) else None,
             ),
         )
         if negative_text is not None:
-            self.native.setNegativeButton(
+            self.native_builder.setNegativeButton(
                 negative_text, OnClickListener(self.completion_handler, False)
             )
+        self.native = self.native_builder.create()
 
     def completion_handler(self, return_value: bool) -> None:
         self.future.set_result(return_value)

android/tests_backend/app.py

@@ -42,6 +42,9 @@ def logs_path(self):
     def assert_app_icon(self, icon):
         pytest.xfail("Android apps don't have app icons at runtime")
 
+    def assert_dialog_in_focus(self, dialog):
+        assert dialog._impl.native.isShowing() is True, "The dialog is not in focus"
+
     def _menu_item(self, path):
         menu = self.main_window_probe._native_menu()
         for i_path, label in enumerate(path):

android/tests_backend/dialogs.py

@@ -4,7 +4,9 @@
 
 
 class DialogsMixin:
-    def _setup_alert_dialog_result(self, dialog, buttons, selected_index):
+    def _setup_alert_dialog_result(
+        self, dialog, buttons, selected_index, pre_close_test_method=None
+    ):
         # Install an overridden show method that invokes the original,
         # but then closes the open dialog.
         orig_show = dialog._impl.show
@@ -15,21 +17,30 @@ def automated_show(host_window, future):
             async def _close_dialog():
                 # Inject a small pause without blocking the event loop
                 await asyncio.sleep(1.0 if self.app.run_slow else 0.2)
+
                 try:
-                    dialog_view = self.get_dialog_view()
-                    self.assert_dialog_buttons(dialog_view, buttons)
-                    await self.press_dialog_button(dialog_view, buttons[selected_index])
-                except Exception as e:
-                    # An error occurred closing the dialog; that means the dialog
-                    # isn't what as expected, so record that in the future.
-                    future.set_exception(e)
+                    if pre_close_test_method:
+                        pre_close_test_method()
+                finally:
+                    try:
+                        dialog_view = self.get_dialog_view()
+                        self.assert_dialog_buttons(dialog_view, buttons)
+                        await self.press_dialog_button(
+                            dialog_view, buttons[selected_index]
+                        )
+                    except Exception as e:
+                        # An error occurred closing the dialog; that means the dialog
+                        # isn't what as expected, so record that in the future.
+                        future.set_exception(e)
 
             asyncio.create_task(_close_dialog(), name="close-dialog")
 
         dialog._impl.show = automated_show
 
-    def setup_info_dialog_result(self, dialog):
-        self._setup_alert_dialog_result(dialog, ["OK"], 0)
+    def setup_info_dialog_result(self, dialog, pre_close_test_method=None):
+        self._setup_alert_dialog_result(
+            dialog, ["OK"], 0, pre_close_test_method=pre_close_test_method
+        )
 
     def setup_question_dialog_result(self, dialog, result):
         self._setup_alert_dialog_result(dialog, ["No", "Yes"], 1 if result else 0)

changes/2926.bugfix.rst

@@ -0,0 +1 @@
+On macOS, when a dialog is in focus, `App.current_window` now returns the host window, instead of raising an `AttributeError`.

cocoa/src/toga_cocoa/app.py

@@ -30,6 +30,7 @@
     NSMenu,
     NSMenuItem,
     NSNumber,
+    NSPanel,
     NSScreen,
 )
 from .screens import Screen as ScreenImpl
@@ -366,7 +367,11 @@ def show_cursor(self):
     ######################################################################
 
     def get_current_window(self):
-        return self.native.keyWindow
+        key_window = self.native.keyWindow
+        if isinstance(key_window, NSPanel):
+            return key_window.sheetParent
+        else:
+            return key_window
 
     def set_current_window(self, window):
         window._impl.native.makeKeyAndOrderFront(window._impl.native)

cocoa/src/toga_cocoa/libs/appkit.py

@@ -545,6 +545,7 @@ class NSLineBreakMode(Enum):
 
 ######################################################################
 # NSPanel.h
+NSPanel = ObjCClass("NSPanel")
 
 NSUtilityWindowMask = 1 << 4
 

cocoa/tests_backend/app.py

@@ -10,13 +10,13 @@
     NSEvent,
     NSEventModifierFlagShift,
     NSEventType,
+    NSPanel,
     NSWindow,
 )
 
 from .dialogs import DialogsMixin
 from .probe import BaseProbe, NSRunLoop
 
-NSPanel = ObjCClass("NSPanel")
 NSDate = ObjCClass("NSDate")
 
 
@@ -190,6 +190,11 @@ def activate_menu_close_all_windows(self):
     def activate_menu_minimize(self):
         self._activate_menu_item(["Window", "Minimize"])
 
+    def assert_dialog_in_focus(self, dialog):
+        assert (
+            dialog._impl.native.window == self.app._impl.native.keyWindow
+        ), "The dialog is not in focus"
+
     def assert_menu_item(self, path, enabled):
         item = self._menu_item(path)
         assert item.isEnabled() == enabled
@@ -247,7 +252,7 @@ async def restore_standard_app(self):
         self.app._impl.native.activateIgnoringOtherApps(True)
         await self.redraw("Restore to standard app", delay=0.1)
 
-    def _setup_alert_dialog_result(self, dialog, result):
+    def _setup_alert_dialog_result(self, dialog, result, pre_close_test_method=None):
         # Replace the dialog polling mechanism with an implementation that polls
         # 5 times, then returns the required result.
         _poll_modal_session = dialog._impl._poll_modal_session
@@ -258,7 +263,11 @@ def auto_poll_modal_session(nsapp, session):
             if count < 5:
                 count += 1
                 return _poll_modal_session(nsapp, session)
-            return result
+            try:
+                if pre_close_test_method:
+                    pre_close_test_method(dialog)
+            finally:
+                return result
 
         dialog._impl._poll_modal_session = auto_poll_modal_session
 

cocoa/tests_backend/dialogs.py

@@ -16,8 +16,12 @@
 class DialogsMixin:
     supports_multiple_select_folder = True
 
-    def setup_info_dialog_result(self, dialog):
-        self._setup_alert_dialog_result(dialog, NSAlertFirstButtonReturn)
+    def setup_info_dialog_result(self, dialog, pre_close_test_method=None):
+        self._setup_alert_dialog_result(
+            dialog,
+            NSAlertFirstButtonReturn,
+            pre_close_test_method=pre_close_test_method,
+        )
 
     def setup_question_dialog_result(self, dialog, result):
         if result:

cocoa/tests_backend/window.py

@@ -91,18 +91,26 @@ def press_toolbar_button(self, index):
             argtypes=[objc_id],
         )
 
-    def _setup_alert_dialog_result(self, dialog, result):
+    def _setup_alert_dialog_result(self, dialog, result, pre_close_test_method=None):
         # Install an overridden show method that invokes the original,
         # but then closes the open dialog.
         orig_show = dialog._impl.show
 
         def automated_show(host_window, future):
             orig_show(host_window, future)
-
-            dialog._impl.host_window.endSheet(
-                dialog._impl.host_window.attachedSheet,
-                returnCode=result,
-            )
+            try:
+                if pre_close_test_method:
+                    pre_close_test_method(dialog)
+            finally:
+                try:
+                    dialog._impl.host_window.endSheet(
+                        dialog._impl.host_window.attachedSheet,
+                        returnCode=result,
+                    )
+                except Exception as e:
+                    # An error occurred closing the dialog; that means the dialog
+                    # isn't what as expected, so record that in the future.
+                    future.set_exception(e)
 
         dialog._impl.show = automated_show
 

gtk/tests_backend/app.py

@@ -73,6 +73,11 @@ def assert_app_icon(self, icon):
                 mid_color = img.getpixel((img.size[0] // 2, img.size[1] // 2))
                 assert mid_color == (149, 119, 73, 255)
 
+    def assert_dialog_in_focus(self, dialog):
+        # Gtk.Dialog's methods - is_active(), has_focus() both return False, even
+        # when the dialog is in focus. Hence, they cannot be used to determine focus.
+        assert dialog._impl.native.is_visible(), "The dialog is not in focus"
+
     def _menu_item(self, path):
         main_menu = self.app._impl.native.get_menubar()
         menu = main_menu

gtk/tests_backend/dialogs.py

@@ -1,3 +1,4 @@
+import asyncio
 from datetime import datetime, timedelta
 from pathlib import Path
 from unittest.mock import Mock
@@ -21,23 +22,41 @@ def _default_close_handler(self, dialog, gtk_result):
         dialog._impl.native.response(gtk_result)
         self._wait_for_dialog("Wait for dialog to disappear")
 
-    def _setup_dialog_result(self, dialog, gtk_result, close_handler=None):
+    def _setup_dialog_result(
+        self, dialog, gtk_result, close_handler=None, pre_close_test_method=None
+    ):
         # Install an overridden show method that invokes the original,
         # but then closes the open dialog.
         orig_show = dialog._impl.show
 
         def automated_show(host_window, future):
             orig_show(host_window, future)
 
-            if close_handler:
-                close_handler(dialog, gtk_result)
-            else:
-                self._default_close_handler(dialog, gtk_result)
+            async def _close_dialog():
+                # Add a slight delay for the dialog to show up
+                await asyncio.sleep(0.05)
+                try:
+                    if pre_close_test_method:
+                        pre_close_test_method(dialog)
+                finally:
+                    try:
+                        if close_handler:
+                            close_handler(dialog, gtk_result)
+                        else:
+                            self._default_close_handler(dialog, gtk_result)
+                    except Exception as e:
+                        # An error occurred closing the dialog; that means the dialog
+                        # isn't what as expected, so record that in the future.
+                        future.set_exception(e)
+
+            asyncio.create_task(_close_dialog(), name="close-dialog")
 
         dialog._impl.show = automated_show
 
-    def setup_info_dialog_result(self, dialog):
-        self._setup_dialog_result(dialog, Gtk.ResponseType.OK)
+    def setup_info_dialog_result(self, dialog, pre_close_test_method=None):
+        self._setup_dialog_result(
+            dialog, Gtk.ResponseType.OK, pre_close_test_method=pre_close_test_method
+        )
 
     def setup_question_dialog_result(self, dialog, result):
         self._setup_dialog_result(

iOS/tests_backend/app.py

@@ -48,6 +48,12 @@ def logs_path(self):
     def assert_app_icon(self, icon):
         pytest.xfail("iOS apps don't have app icons at runtime")
 
+    def assert_dialog_in_focus(self, dialog):
+        root_view_controller = self.native.keyWindow.rootViewController
+        assert (
+            root_view_controller.presentedViewController == dialog._impl.native
+        ), "The dialog is not in focus"
+
     def assert_system_menus(self):
         pytest.skip("Menus not implemented on iOS")
 

iOS/tests_backend/dialogs.py

@@ -8,7 +8,7 @@ class DialogsMixin:
     def dialog_view_controller(self):
         return self.app.current_window._impl.native.rootViewController
 
-    def _setup_alert_dialog(self, dialog, action_index):
+    def _setup_alert_dialog(self, dialog, action_index, pre_close_test_method=None):
         # Install an overridden show method that invokes the original,
         # but then closes the open dialog.
         orig_show = dialog._impl.show
@@ -20,16 +20,27 @@ def automated_show(host_window, future):
             NSRunLoop.currentRunLoop.runUntilDate(
                 NSDate.dateWithTimeIntervalSinceNow(1.0 if self.app.run_slow else 0.2)
             )
-            # Close the dialog and trigger the completion handler
-            self.dialog_view_controller.dismissViewControllerAnimated(
-                False, completion=None
-            )
-            dialog._impl.native.actions[action_index].handler(dialog._impl.native)
+            try:
+                if pre_close_test_method:
+                    pre_close_test_method(dialog)
+            finally:
+                try:
+                    # Close the dialog and trigger the completion handler
+                    self.dialog_view_controller.dismissViewControllerAnimated(
+                        False, completion=None
+                    )
+                    dialog._impl.native.actions[action_index].handler(
+                        dialog._impl.native
+                    )
+                except Exception as e:
+                    # An error occurred closing the dialog; that means the dialog
+                    # isn't what as expected, so record that in the future.
+                    future.set_exception(e)
 
         dialog._impl.show = automated_show
 
-    def setup_info_dialog_result(self, dialog):
-        self._setup_alert_dialog(dialog, 0)
+    def setup_info_dialog_result(self, dialog, pre_close_test_method=None):
+        self._setup_alert_dialog(dialog, 0, pre_close_test_method=pre_close_test_method)
 
     def setup_question_dialog_result(self, dialog, result):
         self._setup_alert_dialog(dialog, 0 if result else 1)