Fix #282: defaults user-agent to empty string in request.summary (#327)

* Fix #282: defaults user-agent to empty string in request.summary

* Remove useless comment

Author: leplatrem

jbi/log.py

@@ -64,7 +64,7 @@ def format_request_summary_fields(
 
     current_time = time.time()
     return RequestSummary(
-        agent=request.headers.get("User-Agent"),
+        agent=request.headers.get("User-Agent", ""),
         path=request.url.path,
         method=request.method,
         lang=request.headers.get("Accept-Language"),

tests/unit/test_main.py

@@ -22,6 +22,17 @@ def test_request_summary_is_logged(caplog):
             assert summary.querystring == "{}"
 
 
+def test_request_summary_defaults_user_agent_to_empty_string(caplog):
+    with caplog.at_level(logging.INFO):
+        with TestClient(app) as anon_client:
+            del anon_client.headers["User-Agent"]
+            anon_client.get("/")
+
+            summary = caplog.records[-1]
+
+            assert summary.agent == ""
+
+
 def test_errors_are_reported_to_sentry(
     anon_client, webhook_create_example: BugzillaWebhookRequest
 ):