feat: added Request.postDataBuffer (#150)

Author: mxschmitt

playwright/async_api.py

@@ -132,6 +132,17 @@ def postDataJSON(self) -> typing.Union[typing.Dict, NoneType]:
         """
         return mapping.from_maybe_impl(self._impl_obj.postDataJSON)
 
+    @property
+    def postDataBuffer(self) -> typing.Union[bytes, NoneType]:
+        """Request.postDataBuffer
+
+        Returns
+        -------
+        Optional[bytes]
+            Request's post body in a binary form, if any.
+        """
+        return mapping.from_maybe_impl(self._impl_obj.postDataBuffer)
+
     @property
     def headers(self) -> typing.Dict[str, str]:
         """Request.headers

playwright/network.py

@@ -59,10 +59,10 @@ def method(self) -> str:
 
     @property
     def postData(self) -> Optional[str]:
-        b64_content = self._initializer.get("postData")
-        if not b64_content:
+        data = self.postDataBuffer
+        if not data:
             return None
-        return base64.b64decode(b64_content).decode()
+        return data.decode()
 
     @property
     def postDataJSON(self) -> Optional[Dict]:
@@ -76,6 +76,13 @@ def postDataJSON(self) -> Optional[Dict]:
             return dict(parse.parse_qsl(post_data))
         return json.loads(post_data)
 
+    @property
+    def postDataBuffer(self) -> Optional[bytes]:
+        b64_content = self._initializer.get("postData")
+        if not b64_content:
+            return None
+        return base64.b64decode(b64_content)
+
     @property
     def headers(self) -> Dict[str, str]:
         return parse_headers(self._initializer["headers"])

playwright/sync_api.py

@@ -132,6 +132,17 @@ def postDataJSON(self) -> typing.Union[typing.Dict, NoneType]:
         """
         return mapping.from_maybe_impl(self._impl_obj.postDataJSON)
 
+    @property
+    def postDataBuffer(self) -> typing.Union[bytes, NoneType]:
+        """Request.postDataBuffer
+
+        Returns
+        -------
+        Optional[bytes]
+            Request's post body in a binary form, if any.
+        """
+        return mapping.from_maybe_impl(self._impl_obj.postDataBuffer)
+
     @property
     def headers(self) -> typing.Dict[str, str]:
         """Request.headers

tests/async/test_interception.py

@@ -727,7 +727,7 @@ async def test_request_continue_should_amend_post_data(page, server):
       """
         ),
     )
-    assert serverRequest.post_body == "doggo"
+    assert serverRequest.post_body.decode() == "doggo"
 
 
 async def test_request_fulfill_should_work_a(page, server):

tests/async/test_network.py

@@ -237,6 +237,41 @@ async def test_should_be_undefined_when_there_is_no_post_data(page, server):
     assert response.request.postDataJSON is None
 
 
+async def test_should_work_with_binary_post_data(page, server):
+    await page.goto(server.EMPTY_PAGE)
+    server.set_route("/post", lambda req: req.finish())
+    requests = []
+    page.on("request", lambda r: requests.append(r))
+    await page.evaluate(
+        """async () => {
+        await fetch('./post', { method: 'POST', body: new Uint8Array(Array.from(Array(256).keys())) })
+    }"""
+    )
+    assert len(requests) == 1
+    buffer = requests[0].postDataBuffer
+    assert len(buffer) == 256
+    for i in range(256):
+        assert buffer[i] == i
+
+
+async def test_should_work_with_binary_post_data_and_interception(page, server):
+    await page.goto(server.EMPTY_PAGE)
+    server.set_route("/post", lambda req: req.finish())
+    requests = []
+    await page.route("/post", lambda route: asyncio.ensure_future(route.continue_()))
+    page.on("request", lambda r: requests.append(r))
+    await page.evaluate(
+        """async () => {
+        await fetch('./post', { method: 'POST', body: new Uint8Array(Array.from(Array(256).keys())) })
+    }"""
+    )
+    assert len(requests) == 1
+    buffer = requests[0].postDataBuffer
+    assert len(buffer) == 256
+    for i in range(256):
+        assert buffer[i] == i
+
+
 async def test_response_text_should_work(page, server):
     response = await page.goto(server.PREFIX + "/simple.json")
     assert await response.text() == '{"foo": "bar"}\n'

tests/server.py

@@ -78,7 +78,7 @@ def start(self):
         class TestServerHTTPHandler(http.Request):
             def process(self):
                 request = self
-                self.post_body = request.content.read().decode()
+                self.post_body = request.content.read()
                 request.content.seek(0, 0)
                 uri = request.uri.decode()
                 if request_subscribers.get(uri):