feat: aded Request.postDataJSON (microsoft#148)

Author: mxschmitt

playwright/async_api.py

@@ -119,6 +119,19 @@ def postData(self) -> typing.Union[str, NoneType]:
         """
         return mapping.from_maybe_impl(self._impl_obj.postData)
 
+    @property
+    def postDataJSON(self) -> typing.Union[typing.Dict, NoneType]:
+        """Request.postDataJSON
+
+        When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.
+
+        Returns
+        -------
+        Optional[Dict]
+            Parsed request's body for `form-urlencoded` and JSON as a fallback if any.
+        """
+        return mapping.from_maybe_impl(self._impl_obj.postDataJSON)
+
     @property
     def headers(self) -> typing.Dict[str, str]:
         """Request.headers

playwright/network.py

@@ -17,6 +17,7 @@
 import mimetypes
 from pathlib import Path
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast
+from urllib import parse
 
 from playwright.connection import ChannelOwner, from_channel, from_nullable_channel
 from playwright.helper import (
@@ -63,6 +64,18 @@ def postData(self) -> Optional[str]:
             return None
         return base64.b64decode(b64_content).decode()
 
+    @property
+    def postDataJSON(self) -> Optional[Dict]:
+        post_data = self.postData
+        if not post_data:
+            return None
+        content_type = self.headers["content-type"]
+        if not content_type:
+            return None
+        if content_type == "application/x-www-form-urlencoded":
+            return dict(parse.parse_qsl(post_data))
+        return json.loads(post_data)
+
     @property
     def headers(self) -> Dict[str, str]:
         return parse_headers(self._initializer["headers"])

playwright/sync_api.py

@@ -119,6 +119,19 @@ def postData(self) -> typing.Union[str, NoneType]:
         """
         return mapping.from_maybe_impl(self._impl_obj.postData)
 
+    @property
+    def postDataJSON(self) -> typing.Union[typing.Dict, NoneType]:
+        """Request.postDataJSON
+
+        When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.
+
+        Returns
+        -------
+        Optional[Dict]
+            Parsed request's body for `form-urlencoded` and JSON as a fallback if any.
+        """
+        return mapping.from_maybe_impl(self._impl_obj.postDataJSON)
+
     @property
     def headers(self) -> typing.Dict[str, str]:
         """Request.headers

tests/async/test_network.py

@@ -207,6 +207,36 @@ async def test_request_postdata_should_be_undefined_when_there_is_no_post_data(
     assert response.request.postData is None
 
 
+async def test_should_parse_the_json_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(
+        """() => fetch('./post', { method: 'POST', body: JSON.stringify({ foo: 'bar' }) })"""
+    )
+    assert len(requests) == 1
+    assert requests[0].postDataJSON == {"foo": "bar"}
+
+
+async def test_should_parse_the_data_if_content_type_is_form_urlencoded(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.setContent(
+        """<form method='POST' action='/post'><input type='text' name='foo' value='bar'><input type='number' name='baz' value='123'><input type='submit'></form>"""
+    )
+    await page.click("input[type=submit]")
+    assert len(requests) == 1
+    assert requests[0].postDataJSON == {"foo": "bar", "baz": "123"}
+
+
+async def test_should_be_undefined_when_there_is_no_post_data(page, server):
+    response = await page.goto(server.EMPTY_PAGE)
+    assert response.request.postDataJSON is None
+
+
 async def test_response_text_should_work(page, server):
     response = await page.goto(server.PREFIX + "/simple.json")
     assert await response.text() == '{"foo": "bar"}\n'