Merge pull request #308 from MichaelSasser/bugfix/#307-fix-json-body

[Bug]: Fix empty JSON body issue
MichaelSasser · Dec 1, 2021 · e966169 · e966169
2 parents 258d0cf + 8dfccef
commit e966169
Show file tree

Hide file tree

Showing 4 changed files with 110 additions and 156 deletions.
diff --git a/matrixctl/handlers/api.py b/matrixctl/handlers/api.py
@@ -80,12 +80,12 @@ class RequestBuilder:
     subdomain: str = "matrix"
     api_path: str = "_synapse/admin"
     api_version: str = "v2"
-    data: dict[str, t.Any] = {}  # just key/value store
-    json: dict[str, t.Any] | None = None  # json
-    content: str | bytes | Iterable[bytes] = ""  # bytes
+    data: t.Optional[dict[str, t.Any]] = None  # just key/value store
+    json: t.Optional[dict[str, t.Any]] = None  # json
+    content: t.Optional[t.Union[str, bytes, Iterable[bytes]]] = None  # bytes
     method: str = "GET"
-    params: dict[str, str | int] = {}
-    headers: dict[str, str] = {}
+    params: dict[str, t.Union[str, int]] = {}
+    headers: dict[str, str] = {}  # Cannot be none with MatrixCtl
     concurrent_limit: int = 4
     timeout: float = 5.0  # seconds
     success_codes: tuple[int, ...] = (
@@ -548,12 +548,13 @@ def _request(request_config: RequestBuilder) -> httpx.Response | t.NoReturn:
 
     logger.debug("repr: %s", repr(request_config))
 
+    # There is some weird stuff going on in httpx. It is set to None by default
     with httpx.Client(http2=True, timeout=request_config.timeout) as client:
         response: httpx.Response = client.request(
             method=request_config.method,
-            data=request_config.data,
+            data=request_config.data,  # type: ignore
             json=request_config.json,
-            content=request_config.content,
+            content=request_config.content,  # type: ignore
             url=str(request_config),
             params=request_config.params,
             headers=request_config.headers_with_auth,
@@ -621,11 +622,12 @@ async def _arequest(
 
     logger.debug("repr: %s", repr(request_config))
 
+    # There is some weird stuff going on in httpx. It is set to None by default
     response: httpx.Response = await client.request(
         method=request_config.method,
-        data=request_config.data,
+        data=request_config.data,  # type: ignore
         json=request_config.json,
-        content=request_config.content,
+        content=request_config.content,  # type: ignore
         url=str(request_config),
         params=request_config.params,
         headers=request_config.headers_with_auth,

diff --git a/news/307.bugfix b/news/307.bugfix
@@ -0,0 +1,2 @@
+Fix a bug introduced in ``be411cf0c1a9413bf25ca1b72004150c032555c2``, after
+the last release because the ``httpx`` typehints are incorrect.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Fix a bug introduced in ``be411cf0c1a9413bf25ca1b72004150c032555c2``, after
		the last release because the ``httpx`` typehints are incorrect.