fix(listeners): fix removing listeners (microsoft#272)

Author: pavelfeldman

playwright/async_api.py

@@ -3431,11 +3431,6 @@ def video(self) -> typing.Union["Video", NoneType]:
         """
         return mapping.from_impl_nullable(self._impl_obj.video)
 
-    def remove_listener(self, event: str, f: typing.Any) -> NoneType:
-        return mapping.from_maybe_impl(
-            self._impl_obj.remove_listener(event=event, f=mapping.to_impl(f))
-        )
-
     async def opener(self) -> typing.Union["Page", NoneType]:
         """Page.opener
 

playwright/async_base.py

@@ -71,4 +71,4 @@ def once(self, event_name: str, handler: Any) -> None:
         self._impl_obj.once(event_name, self._wrap_handler(handler))
 
     def remove_listener(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.remove_listener(event_name, handler)
+        self._impl_obj.remove_listener(event_name, self._wrap_handler(handler))

playwright/page.py

@@ -777,22 +777,6 @@ async def waitForFunction(
     def workers(self) -> List["Worker"]:
         return self._workers.copy()
 
-    # on(event: str | symbol, listener: Listener): self {
-    #   if (event === Page.Events.FileChooser) {
-    #     if (!self.listenerCount(event))
-    #       self._channel.setFileChooserInterceptedNoReply({ intercepted: True });
-    #   }
-    #   super.on(event, listener);
-    #   return self;
-    # }
-
-    # removeListener(event: str | symbol, listener: Listener): self {
-    #   super.removeListener(event, listener);
-    #   if (event === Page.Events.FileChooser && !self.listenerCount(event))
-    #     self._channel.setFileChooserInterceptedNoReply({ intercepted: False });
-    #   return self;
-    # }
-
     async def pdf(
         self,
         scale: int = None,

playwright/sync_api.py

@@ -3563,11 +3563,6 @@ def video(self) -> typing.Union["Video", NoneType]:
         """
         return mapping.from_impl_nullable(self._impl_obj.video)
 
-    def remove_listener(self, event: str, f: typing.Any) -> NoneType:
-        return mapping.from_maybe_impl(
-            self._impl_obj.remove_listener(event=event, f=mapping.to_impl(f))
-        )
-
     def opener(self) -> typing.Union["Page", NoneType]:
         """Page.opener
 

playwright/sync_base.py

@@ -118,7 +118,7 @@ def once(self, event_name: str, handler: Any) -> None:
         self._impl_obj.once(event_name, self._wrap_handler(handler))
 
     def remove_listener(self, event_name: str, handler: Any) -> None:
-        self._impl_obj.remove_listener(event_name, handler)
+        self._impl_obj.remove_listener(event_name, self._wrap_handler(handler))
 
     def _gather(self, *actions: Callable) -> List[Any]:
         g_self = greenlet.getcurrent()

scripts/generate_async_api.py

@@ -78,6 +78,7 @@ def generate(t: Any) -> None:
             not name.startswith("_")
             and isinstance(value, FunctionType)
             and "expect_" not in name
+            and "remove_listener" != name
         ):
             print("")
             if inspect.iscoroutinefunction(value):

scripts/generate_sync_api.py

@@ -78,6 +78,7 @@ def generate(t: Any) -> None:
             not name.startswith("_")
             and isinstance(value, FunctionType)
             and "expect_" not in name
+            and "remove_listener" != name
         ):
             print("")
             print(

tests/async/test_listeners.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+async def test_listeners(page, server):
+    log = []
+
+    def print_response(response):
+        log.append(response)
+
+    page.on("response", print_response)
+    await page.goto(f"{server.PREFIX}/input/textarea.html")
+    assert len(log) > 0
+    page.remove_listener("response", print_response)
+
+    log = []
+    await page.goto(f"{server.PREFIX}/input/textarea.html")
+    assert len(log) == 0

tests/sync/test_listeners.py

@@ -0,0 +1,29 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+def test_listeners(page, server):
+    log = []
+
+    def print_response(response):
+        log.append(response)
+
+    page.on("response", print_response)
+    page.goto(f"{server.PREFIX}/input/textarea.html")
+    assert len(log) > 0
+    page.remove_listener("response", print_response)
+
+    log = []
+    page.goto(f"{server.PREFIX}/input/textarea.html")
+    assert len(log) == 0