test: add browser.bind/unbind tests and fix Bind return type

Author: Skn0tt

playwright/_impl/_api_structures.py

@@ -313,7 +313,7 @@ class TracingGroupLocation(TypedDict, total=False):
     column: Optional[int]
 
 
-class BindResult(TypedDict):
+class Bind(TypedDict):
     endpoint: str
 
 

playwright/_impl/_browser.py

@@ -27,7 +27,7 @@
 )
 
 from playwright._impl._api_structures import (
-    BindResult,
+    Bind,
     ClientCertificate,
     Geolocation,
     HttpCredentials,
@@ -247,9 +247,10 @@ async def bind(
         workspaceDir: str = None,
         host: str = None,
         port: int = None,
-    ) -> BindResult:
+    ) -> Bind:
         params = locals_to_params(locals())
-        return await self._channel.send("startServer", None, params)
+        result = await self._channel.send("startServer", None, params)
+        return Bind(endpoint=result)
 
     async def unbind(self) -> None:
         await self._channel.send("stopServer", None)

playwright/async_api/_generated.py

@@ -19,7 +19,7 @@
 from typing import Literal
 
 from playwright._impl._api_structures import (
-    BindResult,
+    Bind,
     ClientCertificate,
     Cookie,
     FilePayload,
@@ -14709,7 +14709,7 @@ async def bind(
         workspace_dir: typing.Optional[str] = None,
         host: typing.Optional[str] = None,
         port: typing.Optional[int] = None,
-    ) -> BindResult:
+    ) -> Bind:
         """Browser.bind
 
         Binds the browser to a named pipe or web socket, making it available for other clients to connect to.

playwright/sync_api/_generated.py

@@ -19,7 +19,7 @@
 from typing import Literal
 
 from playwright._impl._api_structures import (
-    BindResult,
+    Bind,
     ClientCertificate,
     Cookie,
     FilePayload,
@@ -14660,7 +14660,7 @@ def bind(
         workspace_dir: typing.Optional[str] = None,
         host: typing.Optional[str] = None,
         port: typing.Optional[int] = None,
-    ) -> BindResult:
+    ) -> Bind:
         """Browser.bind
 
         Binds the browser to a named pipe or web socket, making it available for other clients to connect to.

scripts/generate_api.py

@@ -227,7 +227,7 @@ def return_value(value: Any) -> List[str]:
 from typing import Literal
 
 
-from playwright._impl._api_structures import Cookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation, PausedDetails, PausedDetailsLocation, OnFrame, BindResult
+from playwright._impl._api_structures import Cookie, SetCookieParam, FloatRect, FilePayload, Geolocation, HttpCredentials, PdfMargins, Position, ProxySettings, ResourceTiming, SourceLocation, StorageState, ClientCertificate, ViewportSize, RemoteAddr, SecurityDetails, RequestSizes, NameValue, TracingGroupLocation, PausedDetails, PausedDetailsLocation, OnFrame, Bind
 from playwright._impl._browser import Browser as BrowserImpl
 from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
 from playwright._impl._browser_type import BrowserType as BrowserTypeImpl

tests/async/test_browser_bind.py

@@ -0,0 +1,31 @@
+# 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.
+
+from playwright.async_api import Browser
+
+
+async def test_should_bind_and_unbind_browser(browser: Browser) -> None:
+    server_info = await browser.bind("default")
+    try:
+        assert isinstance(server_info["endpoint"], str)
+    finally:
+        await browser.unbind()
+
+
+async def test_should_bind_with_custom_host_and_port(browser: Browser) -> None:
+    server_info = await browser.bind("my-title", host="127.0.0.1", port=0)
+    try:
+        assert isinstance(server_info["endpoint"], str)
+    finally:
+        await browser.unbind()