Use ui.notification for ui.notify to simplify user simulation tests (#…

…3369)

* use ui.notification for ui.notify to simplify user simulation tests

* code review

---------

Co-authored-by: Falko Schindler <falko@zauberzeug.com>

nicegui/element_filter.py

@@ -63,6 +63,7 @@ def _iterate(self, parent: Element, *, visited: Optional[List[Element]] = None)
                 (element.source if isinstance(element, SourceElement) else ''),
                 element._props.get('placeholder', ''),
                 (element._props.get('value', '') or ''),  # NOTE the value could be None
+                element._props.get('options', {}).get('message', ''),
             ]
             content = ' '.join(str(c) for c in element_contents)
 

nicegui/elements/notification.py

@@ -1,5 +1,5 @@
 import asyncio
-from typing import Any, Callable, Literal, Optional, Union
+from typing import Any, Callable, Dict, Literal, Optional, Union
 
 from typing_extensions import Self
 
@@ -41,6 +41,7 @@ def __init__(self,
                  spinner: bool = False,
                  timeout: Optional[float] = 5.0,
                  on_dismiss: Optional[Callable] = None,
+                 options: Optional[Dict] = None,
                  **kwargs: Any,
                  ) -> None:
         """Notification element
@@ -59,28 +60,32 @@ def __init__(self,
         :param spinner: display a spinner in the notification (default: False)
         :param timeout: optional timeout in seconds after which the notification is dismissed (default: 5.0)
         :param on_dismiss: optional callback to be invoked when the notification is dismissed
+        :param options: optional dictionary with all options (overrides all other arguments)
 
         Note: You can pass additional keyword arguments according to `Quasar's Notify API <https://quasar.dev/quasar-plugins/notify#notify-api>`_.
         """
         with context.client.layout:
             super().__init__()
-        self._props['options'] = {
-            'message': str(message),
-            'position': position,
-            'multiLine': multi_line,
-            'spinner': spinner,
-            'closeBtn': close_button,
-            'timeout': (timeout or 0) * 1000,
-            'group': False,
-            'attrs': {'data-id': f'nicegui-dialog-{self.id}'},
-        }
-        if type is not None:
-            self._props['options']['type'] = type
-        if color is not None:
-            self._props['options']['color'] = color
-        if icon is not None:
-            self._props['options']['icon'] = icon
-        self._props['options'].update(kwargs)
+        if options:
+            self._props['options'] = options
+        else:
+            self._props['options'] = {
+                'message': str(message),
+                'position': position,
+                'multiLine': multi_line,
+                'spinner': spinner,
+                'closeBtn': close_button,
+                'timeout': (timeout or 0) * 1000,
+                'group': False,
+                'attrs': {'data-id': f'nicegui-dialog-{self.id}'},
+            }
+            if type is not None:
+                self._props['options']['type'] = type
+            if color is not None:
+                self._props['options']['color'] = color
+            if icon is not None:
+                self._props['options']['icon'] = icon
+            self._props['options'].update(kwargs)
 
         if on_dismiss:
             self.on_dismiss(on_dismiss)

nicegui/functions/notify.py

@@ -1,6 +1,6 @@
 from typing import Any, Literal, Optional, Union
 
-from ..context import context
+from ..elements.notification import Notification
 
 ARG_MAP = {
     'close_button': 'closeBtn',
@@ -49,5 +49,4 @@ def notify(message: Any, *,
     options = {ARG_MAP.get(key, key): value for key, value in locals().items() if key != 'kwargs' and value is not None}
     options['message'] = str(message)
     options.update(kwargs)
-    client = context.client
-    client.outbox.enqueue_message('notify', options, client.id)
+    Notification(options=options)

nicegui/static/nicegui.js

@@ -345,7 +345,6 @@ function createApp(elements, options) {
           window.open(url, target);
         },
         download: (msg) => download(msg.src, msg.filename, msg.media_type, options.prefix),
-        notify: (msg) => Quasar.Notify.create(msg),
       };
       const socketMessageQueue = [];
       let isProcessingSocketMessage = false;

nicegui/testing/user.py

@@ -9,7 +9,7 @@
 import socketio
 from typing_extensions import Self
 
-from nicegui import Client, ElementFilter, background_tasks, context, ui
+from nicegui import Client, ElementFilter, background_tasks, ui
 from nicegui.element import Element
 from nicegui.logging import log
 from nicegui.nicegui import Slot, _on_handshake
@@ -95,11 +95,6 @@ async def should_see(self,
             with self.client:
                 if self._gather_elements(target, kind, marker, content):
                     return
-                if isinstance(target, str):
-                    content = target
-                for _, message_type, message_data in context.client.outbox.messages:
-                    if content is not None and message_type == 'notify' and content in message_data['message']:
-                        return
                 await asyncio.sleep(0.1)
         raise AssertionError('expected to see at least one ' + self._build_error_message(target, kind, marker, content))
 

tests/test_user_simulation.py

@@ -142,6 +142,21 @@ def page():
     await user.should_see('Hello')
 
 
+async def test_should_not_see_notification(user: User) -> None:
+    @ui.page('/')
+    def page():
+        ui.button('Notify', on_click=lambda: ui.notification('Hello'))
+
+    await user.open('/')
+    await user.should_not_see('Hello')
+    user.find('Notify').click()
+    await user.should_see('Hello')
+    with pytest.raises(AssertionError):
+        await user.should_not_see('Hello')
+    user.find('Hello').trigger('dismiss')
+    await user.should_not_see('Hello')
+
+
 async def test_trigger_event(user: User) -> None:
     @ui.page('/')
     def page():