feat(exposeBinding): support new handle= parameter from 1.5 (#232)

Author: pavelfeldman

playwright/async_api.py

@@ -3663,7 +3663,9 @@ async def exposeFunction(self, name: str, binding: typing.Callable) -> NoneType:
             )
         )
 
-    async def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
+    async def exposeBinding(
+        self, name: str, binding: typing.Callable, handle: bool = None
+    ) -> NoneType:
         """Page.exposeBinding
 
         The method adds a function called `name` on the `window` object of every frame in this page.
@@ -3685,10 +3687,12 @@ async def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
             Name of the function on the window object.
         binding : Callable
             Callback function that will be called in the Playwright's context.
+        handle : Optional[bool]
+            Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
         """
         return mapping.from_maybe_impl(
             await self._impl_obj.exposeBinding(
-                name=name, binding=self._wrap_handler(binding)
+                name=name, binding=self._wrap_handler(binding), handle=handle
             )
         )
 
@@ -5286,7 +5290,9 @@ async def addInitScript(
             await self._impl_obj.addInitScript(source=source, path=path)
         )
 
-    async def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
+    async def exposeBinding(
+        self, name: str, binding: typing.Callable, handle: bool = None
+    ) -> NoneType:
         """BrowserContext.exposeBinding
 
         The method adds a function called `name` on the `window` object of every frame in every page in the context.
@@ -5305,10 +5311,12 @@ async def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
             Name of the function on the window object.
         binding : Callable
             Callback function that will be called in the Playwright's context.
+        handle : Optional[bool]
+            Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
         """
         return mapping.from_maybe_impl(
             await self._impl_obj.exposeBinding(
-                name=name, binding=self._wrap_handler(binding)
+                name=name, binding=self._wrap_handler(binding), handle=handle
             )
         )
 

playwright/browser_context.py

@@ -157,7 +157,9 @@ async def addInitScript(
             raise Error("Either path or source parameter must be specified")
         await self._channel.send("addInitScript", dict(source=source))
 
-    async def exposeBinding(self, name: str, binding: Callable) -> None:
+    async def exposeBinding(
+        self, name: str, binding: Callable, handle: bool = None
+    ) -> None:
         for page in self._pages:
             if name in page._bindings:
                 raise Error(
@@ -166,7 +168,9 @@ async def exposeBinding(self, name: str, binding: Callable) -> None:
         if name in self._bindings:
             raise Error(f'Function "{name}" has been already registered')
         self._bindings[name] = binding
-        await self._channel.send("exposeBinding", dict(name=name))
+        await self._channel.send(
+            "exposeBinding", dict(name=name, needsHandle=handle or False)
+        )
 
     async def exposeFunction(self, name: str, binding: Callable) -> None:
         await self.exposeBinding(name, lambda source, *args: binding(*args))

playwright/page.py

@@ -373,15 +373,19 @@ async def addStyleTag(
     async def exposeFunction(self, name: str, binding: Callable) -> None:
         await self.exposeBinding(name, lambda source, *args: binding(*args))
 
-    async def exposeBinding(self, name: str, binding: Callable) -> None:
+    async def exposeBinding(
+        self, name: str, binding: Callable, handle: bool = None
+    ) -> None:
         if name in self._bindings:
             raise Error(f'Function "{name}" has been already registered')
         if name in self._browser_context._bindings:
             raise Error(
                 f'Function "{name}" has been already registered in the browser context'
             )
         self._bindings[name] = binding
-        await self._channel.send("exposeBinding", dict(name=name))
+        await self._channel.send(
+            "exposeBinding", dict(name=name, needsHandle=handle or False)
+        )
 
     async def setExtraHTTPHeaders(self, headers: Dict[str, str]) -> None:
         await self._channel.send(
@@ -920,8 +924,11 @@ async def call(self, func: Callable) -> None:
         try:
             frame = from_channel(self._initializer["frame"])
             source = dict(context=frame._page.context, page=frame._page, frame=frame)
-            func_args = list(map(parse_result, self._initializer["args"]))
-            result = func(source, *func_args)
+            if self._initializer.get("handle"):
+                result = func(source, from_channel(self._initializer["handle"]))
+            else:
+                func_args = list(map(parse_result, self._initializer["args"]))
+                result = func(source, *func_args)
             if asyncio.isfuture(result):
                 result = await result
             await self._channel.send("resolve", dict(result=serialize_argument(result)))

playwright/sync_api.py

@@ -3809,7 +3809,9 @@ def exposeFunction(self, name: str, binding: typing.Callable) -> NoneType:
             )
         )
 
-    def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
+    def exposeBinding(
+        self, name: str, binding: typing.Callable, handle: bool = None
+    ) -> NoneType:
         """Page.exposeBinding
 
         The method adds a function called `name` on the `window` object of every frame in this page.
@@ -3831,11 +3833,13 @@ def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
             Name of the function on the window object.
         binding : Callable
             Callback function that will be called in the Playwright's context.
+        handle : Optional[bool]
+            Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
         """
         return mapping.from_maybe_impl(
             self._sync(
                 self._impl_obj.exposeBinding(
-                    name=name, binding=self._wrap_handler(binding)
+                    name=name, binding=self._wrap_handler(binding), handle=handle
                 )
             )
         )
@@ -5502,7 +5506,9 @@ def addInitScript(
             self._sync(self._impl_obj.addInitScript(source=source, path=path))
         )
 
-    def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
+    def exposeBinding(
+        self, name: str, binding: typing.Callable, handle: bool = None
+    ) -> NoneType:
         """BrowserContext.exposeBinding
 
         The method adds a function called `name` on the `window` object of every frame in every page in the context.
@@ -5521,11 +5527,13 @@ def exposeBinding(self, name: str, binding: typing.Callable) -> NoneType:
             Name of the function on the window object.
         binding : Callable
             Callback function that will be called in the Playwright's context.
+        handle : Optional[bool]
+            Whether to pass the argument as a handle, instead of passing by value. When passing a handle, only one argument is supported. When passing by value, multiple arguments are supported.
         """
         return mapping.from_maybe_impl(
             self._sync(
                 self._impl_obj.exposeBinding(
-                    name=name, binding=self._wrap_handler(binding)
+                    name=name, binding=self._wrap_handler(binding), handle=handle
                 )
             )
         )

scripts/expected_api_mismatch.txt

@@ -116,7 +116,3 @@ Parameter not implemented: BrowserContext.addInitScript(arg=)
 # OptionsOr
 Parameter not implemented: Page.waitForEvent(optionsOrPredicate=)
 Parameter not implemented: BrowserContext.waitForEvent(optionsOrPredicate=)
-
-# FIXME, 1.5 blockers
-Parameter not implemented: Page.exposeBinding(handle=)
-Parameter not implemented: BrowserContext.exposeBinding(handle=)

tests/async/test_browsercontext.py

@@ -426,6 +426,20 @@ async def test_expose_function_should_be_callable_from_inside_addInitScript(
     assert args == ["context", "page"]
 
 
+async def test_exposebindinghandle_should_work(context):
+    targets = []
+
+    def logme(t):
+        targets.append(t)
+        return 17
+
+    page = await context.newPage()
+    await page.exposeBinding("logme", lambda source, t: logme(t), handle=True)
+    result = await page.evaluate("logme({ foo: 42 })")
+    assert (await targets[0].evaluate("x => x.foo")) == 42
+    assert result == 17
+
+
 async def test_route_should_intercept(context, server):
     intercepted = []
 

tests/async/test_page.py

@@ -385,6 +385,19 @@ async def test_expose_function_should_work_with_complex_objects(page, server):
     assert result["x"] == 7
 
 
+async def test_exposebindinghandle_should_work(page, server):
+    targets = []
+
+    def logme(t):
+        targets.append(t)
+        return 17
+
+    await page.exposeBinding("logme", lambda source, t: logme(t), handle=True)
+    result = await page.evaluate("logme({ foo: 42 })")
+    assert (await targets[0].evaluate("x => x.foo")) == 42
+    assert result == 17
+
+
 async def test_page_error_should_fire(page, server, is_webkit):
     [error, _] = await asyncio.gather(
         page.waitForEvent("pageerror"),