[wdspec] remove unsubscribe by contexts (#54868)

Co-authored-by: Maksim Sadym <sadym@chromium.org>

Author: OrKoN

tools/webdriver/webdriver/bidi/modules/session.py

@@ -44,11 +44,8 @@ def subscribe(self,
     @command
     def unsubscribe(self,
                     events: Optional[List[str]] = None,
-                    contexts: Optional[List[str]] = None,
                     subscriptions: Optional[List[str]] = None) -> Mapping[str, Any]:
         params: MutableMapping[str, Any] = {}
-        if contexts is not None:
-            params["contexts"] = contexts
         if events is not None:
             params["events"] = events
         if subscriptions is not None:

tools/wptrunner/wptrunner/executors/executorwebdriver.py

@@ -50,7 +50,7 @@
                        DisplayFeaturesProtocolPart,
                        merge_dicts)
 
-from typing import Any, List, Dict, Optional, Tuple
+from typing import Any, List, Dict, Optional
 from webdriver.client import Session
 from webdriver import error as webdriver_error
 from webdriver.bidi import error as webdriver_bidi_error
@@ -273,7 +273,7 @@ async def handle_user_prompt(self,
 
 
 class WebDriverBidiEventsProtocolPart(BidiEventsProtocolPart):
-    _subscriptions: List[Tuple[List[str], Optional[List[str]]]] = []
+    _subscriptions: List[str] = []
 
     def __init__(self, parent):
         super().__init__(parent)
@@ -312,15 +312,10 @@ async def _get_top_context(self, context: str) -> Optional[str]:
 
     async def subscribe(self, events, contexts):
         self.logger.info("Subscribing to events %s in %s" % (events, contexts))
-        # The BiDi subscriptions are done for top context even if the sub-context is provided. We need to get the
-        # top-level contexts list to handle the scenario when subscription is done for a sub-context which is closed
-        # afterwards. However, the subscription itself is done for the provided contexts in order to throw in case of
-        # the sub-context is removed.
-        top_contexts = await self._contexts_to_top_contexts(contexts)
         result = await self.webdriver.bidi_session.session.subscribe(events=events, contexts=contexts)
         # The `subscribe` method either raises an exception or adds subscription. The command is atomic, meaning in case
         # of exception no subscription is added.
-        self._subscriptions.append((events, top_contexts))
+        self._subscriptions.append(result["subscription"])
         return result
 
     async def unsubscribe(self, subscriptions):
@@ -331,10 +326,10 @@ async def unsubscribe(self, subscriptions):
     async def unsubscribe_all(self):
         self.logger.info("Unsubscribing from all the events")
         while self._subscriptions:
-            events, contexts = self._subscriptions.pop()
-            self.logger.debug("Unsubscribing from events %s in %s" % (events, contexts))
+            subscription = self._subscriptions.pop()
+            self.logger.debug("Unsubscribing from event %s" % subscription)
             try:
-                await self.webdriver.bidi_session.session.unsubscribe(events=events, contexts=contexts)
+                await self.webdriver.bidi_session.session.unsubscribe(subscriptions=[subscription])
             except webdriver_bidi_error.NoSuchFrameException:
                 # The browsing context is already removed. Nothing to do.
                 pass
@@ -345,7 +340,7 @@ async def unsubscribe_all(self):
                 else:
                     raise e
             except Exception as e:
-                self.logger.error("Failed to unsubscribe from events %s in %s: %s" % (events, contexts, e))
+                self.logger.error("Failed to unsubscribe from event %s: %s" % (subscription, e))
                 # Re-raise the exception to identify regressions.
                 # TODO: consider to continue the loop in case of the exception.
                 raise e

webdriver/tests/bidi/session/unsubscribe/contexts.py

@@ -1,6 +1,6 @@
 import pytest
 
-from webdriver.bidi.error import InvalidArgumentException, NoSuchFrameException
+from webdriver.bidi.error import InvalidArgumentException
 
 from ... import create_console_api_message
 
@@ -89,79 +89,6 @@ async def test_unsubscribe_from_one_event_and_then_from_module(
     await bidi_session.session.unsubscribe(events=["browsingContext.load"])
 
 
-@pytest.mark.asyncio
-@pytest.mark.parametrize("value", [True, "foo", 42, {}])
-async def test_params_contexts_invalid_type(bidi_session, value):
-    with pytest.raises(InvalidArgumentException):
-        await bidi_session.session.unsubscribe(events=["browsingContext.load"], contexts=value)
-
-
-@pytest.mark.asyncio
-async def test_params_contexts_empty(bidi_session):
-    with pytest.raises(InvalidArgumentException):
-        await bidi_session.session.unsubscribe(events=["browsingContext.load"], contexts=[])
-
-
-@pytest.mark.asyncio
-@pytest.mark.parametrize("value", [None, True, 42, [], {}])
-async def test_params_contexts_value_invalid_type(bidi_session, value):
-    with pytest.raises(InvalidArgumentException):
-        await bidi_session.session.unsubscribe(events=["browsingContext.load"], contexts=[value])
-
-
-@pytest.mark.asyncio
-async def test_params_contexts_value_invalid_value(bidi_session):
-    with pytest.raises(NoSuchFrameException):
-        await bidi_session.session.unsubscribe(events=["browsingContext.load"], contexts=["foo"])
-
-
-@pytest.mark.asyncio
-async def test_params_contexts_value_valid_and_invalid_value(
-    bidi_session, subscribe_events, wait_for_event, wait_for_future_safe, top_context
-):
-    # Subscribe to a valid context
-    await subscribe_events(events=["log.entryAdded"], contexts=[top_context["context"]])
-
-    # Try to unsubscribe from the valid and an invalid context
-    with pytest.raises(NoSuchFrameException):
-        await bidi_session.session.unsubscribe(events=["log.entryAdded"], contexts=[top_context["context"], "foo"])
-
-    # Make sure that we didn't unsubscribe from the valid context because of the error
-    # and events are still coming
-
-    # Track all received log.entryAdded events in the events array
-    events = []
-
-    async def on_event(method, data):
-        events.append(data)
-
-    remove_listener = bidi_session.add_event_listener(
-        "log.entryAdded", on_event)
-
-    on_entry_added = wait_for_event("log.entryAdded")
-    await create_console_api_message(bidi_session, top_context, "text1")
-    await wait_for_future_safe(on_entry_added)
-
-    assert len(events) == 1
-
-    remove_listener()
-
-
-@pytest.mark.asyncio
-async def test_unsubscribe_from_closed_tab(
-    bidi_session, subscribe_events
-):
-    new_tab = await bidi_session.browsing_context.create(type_hint="tab")
-    # Subscribe to a new context
-    await subscribe_events(events=["log.entryAdded"], contexts=[new_tab["context"]])
-
-    await bidi_session.browsing_context.close(context=new_tab["context"])
-
-    # Try to unsubscribe from the closed context
-    with pytest.raises(NoSuchFrameException):
-        await bidi_session.session.unsubscribe(events=["log.entryAdded"], contexts=[new_tab["context"]])
-
-
 @pytest.mark.asyncio
 async def test_params_unsubscribe_globally_without_subscription(bidi_session):
     with pytest.raises(InvalidArgumentException):
@@ -180,26 +107,6 @@ async def test_params_unsubscribe_globally_with_individual_subscription(
         await bidi_session.session.unsubscribe(events=["log.entryAdded"])
 
 
-@pytest.mark.asyncio
-async def test_params_unsubscribe_from_one_context_without_subscription(
-    bidi_session, top_context
-):
-    with pytest.raises(InvalidArgumentException):
-        await bidi_session.session.unsubscribe(events=["log.entryAdded"], contexts=[top_context["context"]])
-
-
-@pytest.mark.asyncio
-async def test_params_unsubscribe_from_one_context_with_global_subscription(
-    subscribe_events, bidi_session, top_context
-):
-    # Subscribe to all contexts
-    await subscribe_events(events=["log.entryAdded"])
-
-    # Try to unsubscribe from one context
-    with pytest.raises(InvalidArgumentException):
-        await bidi_session.session.unsubscribe(events=["log.entryAdded"], contexts=[top_context["context"]])
-
-
 @pytest.mark.asyncio
 @pytest.mark.parametrize("subscriptions", [None, True, 42, {}, "foo"])
 async def test_params_subscriptions_invalid_type(bidi_session, subscriptions):

webdriver/tests/bidi/session/unsubscribe/invalid.py

@@ -215,47 +215,6 @@ async def on_load_event(method, data):
     remove_listener_2()
 
 
-async def test_unsubscribe_partially_from_one_context(
-    bidi_session, top_context, new_tab, wait_for_events
-):
-    # Subscribe for log events to multiple contexts at once
-    result = await bidi_session.session.subscribe(
-        events=["log.entryAdded"], contexts=[top_context["context"], new_tab["context"]]
-    )
-    # Unsubscribe from log events in one of the contexts
-    await bidi_session.session.unsubscribe(
-        events=["log.entryAdded"], contexts=[top_context["context"]]
-    )
-
-    with wait_for_events(["log.entryAdded"]) as waiter:
-        # Trigger console event in the unsubscribed context
-        await create_console_api_message(bidi_session, top_context, "text1")
-        events = await waiter.get_events(lambda events: len(events) >= 0)
-        assert len(events) == 0
-
-        # Trigger another console event in the still observed context
-        expected_text = await create_console_api_message(bidi_session, new_tab, "text2")
-        events = await waiter.get_events(lambda events: len(events) >= 1)
-
-        assert len(events) == 1
-        recursive_compare(
-            {
-                "text": expected_text,
-            },
-            events[0][1],
-        )
-
-        # Unsubscribe from subscription.
-        await bidi_session.session.unsubscribe(subscriptions=[result["subscription"]])
-
-        # Trigger another console event
-        await create_console_api_message(bidi_session, new_tab, "text2")
-
-        # Make sure that there're no new events
-        events = await waiter.get_events(lambda events: len(events) >= 1)
-        assert len(events) == 1
-
-
 async def test_unsubscribe_with_event_and_subscriptions(bidi_session, new_tab, inline):
     result = await bidi_session.session.subscribe(events=["browsingContext"])