Add additional logging to request before calling action; modify logging when IgnoreInvalidRequestError happens.

Author: Bryan Sieber

src/app/log.py

@@ -31,6 +31,7 @@ def configure_logging():
         "loggers": {
             "request.summary": {"handlers": ["console"], "level": "INFO"},
             "src.jbi": {"handlers": ["console"], "level": "INFO"},
+            "ignored-requests": {"handlers": ["console"], "level": "DEBUG"},
         },
     }
 

src/jbi/router.py

@@ -21,6 +21,7 @@
 api_router = APIRouter(tags=["JBI"])
 
 jbi_logger = logging.getLogger("src.jbi.router")
+invalid_logger = logging.getLogger("ignored-requests")
 
 
 def extract_current_action(  # pylint: disable=inconsistent-return-statements
@@ -58,11 +59,12 @@ def execute_action(request: BugzillaWebhookRequest, action_map, settings):
         callable_action = action_module.init(  # type: ignore
             **current_action["parameters"]
         )
+        jbi_logger.info("request: %s", request.json())
         content = callable_action(payload=request)
         jbi_logger.info("request: %s, content: %s", request.json(), content)
         return JSONResponse(content=content, status_code=200)
     except IgnoreInvalidRequestError as exception:
-        jbi_logger.info("ignore-invalid-request: %s", exception, exc_info=True)
+        invalid_logger.debug("ignore-invalid-request: %s", exception)
         return JSONResponse(content={"error": str(exception)}, status_code=202)
 
 

tests/unit/jbi/test_router.py

@@ -28,7 +28,7 @@ def test_request_is_ignored_because_private(
         assert response.json()["error"] == "private bugs are not valid"
 
         invalid_request_logs = caplog.records[0]
-        assert invalid_request_logs.name == "src.jbi.router"
+        assert invalid_request_logs.name == "ignored-requests"
 
         assert invalid_request_logs.msg == "ignore-invalid-request: %s"
         assert invalid_request_logs.args
@@ -53,7 +53,7 @@ def test_request_is_ignored_because_no_bug(
         assert response.json()["error"] == "no bug data received"
 
         invalid_request_logs = caplog.records[0]
-        assert invalid_request_logs.name == "src.jbi.router"
+        assert invalid_request_logs.name == "ignored-requests"
 
         assert invalid_request_logs.msg == "ignore-invalid-request: %s"
         assert invalid_request_logs.args
@@ -85,7 +85,7 @@ def test_request_is_ignored_because_no_action(
                 )
 
                 invalid_request_logs = caplog.records[0]
-                assert invalid_request_logs.name == "src.jbi.router"
+                assert invalid_request_logs.name == "ignored-requests"
 
                 assert invalid_request_logs.msg == "ignore-invalid-request: %s"
                 assert invalid_request_logs.args