Mark status code as optional to match latest Apilytics OpenAPI schema

Author: ruohola

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+
+- Change `status_code` into an optional parameter in `ApilyticsSender.set_response_info`.
+
 ## [1.1.0] - 2022-01-16
 
 ### Added

apilytics/core.py

@@ -97,14 +97,15 @@ def __exit__(
             )
         self._executor.submit(self._send_metrics)
 
-    def set_response_info(self, *, status_code: int) -> None:
+    def set_response_info(self, *, status_code: Optional[int] = None) -> None:
         """
         Update the context manager with info from the HTTP response object.
 
         Should be called before the context manager's block ends.
 
         Args:
-            status_code: Status code for the HTTP response.
+            status_code: Status code for the HTTP response. Can be omitted (or None)
+                if the middleware could not get the status code.
         """
         self._status_code = status_code
 
@@ -120,10 +121,14 @@ def _send_metrics(self) -> None:
         )
         data = {
             "path": self._path,
-            **({"query": self._query} if self._query else {}),
             "method": self._method,
-            "statusCode": self._status_code,
             "timeMillis": (self._end_time_ns - self._start_time_ns) // 1_000_000,
+            **({"query": self._query} if self._query else {}),  # Don't send empty str.
+            **(
+                {"statusCode": self._status_code}
+                if self._status_code is not None
+                else {}
+            ),
         }
         try:
             urllib.request.urlopen(url=request, data=json.dumps(data).encode())

tests/fastapi/test_fastapi.py

@@ -88,7 +88,7 @@ def test_middleware_should_send_data_even_on_errors(
 
     __, call_kwargs = mocked_urlopen.call_args
     data = tests.conftest.decode_request_data(call_kwargs["data"])
+    assert data.keys() == {"method", "path", "timeMillis"}
     assert data["method"] == "GET"
     assert data["path"] == "/error"
-    assert data["statusCode"] is None  # Was not able to call `set_response_info`.
     assert isinstance(data["timeMillis"], int)