Use orjson for serialising responses. (#86)

When creating a bug we embed the response of the bugzilla update_bugs
call into the repsonse. This contains a datetime instance which is not
serialisable by the default JSONResponse and so currently JBI throws
an internal server error back to Bugzilla which then repeats the
request a second time which is effectively ignored because by then the
bug has the see_also field set.

This switches to ORJSONResponse which can serialise datetime and a
few other types correctly.

Author: Mossop

poetry.lock

@@ -18,6 +18,7 @@ dockerflow = "2022.1.0"
 Jinja2 = "^3.0.3"
 pydantic-yaml = {extras = ["pyyaml","ruamel"], version = "^0.6.1"}
 sentry-sdk = "^1.5.7"
+orjson = "^3.7.7"
 
 
 [tool.poetry.dev-dependencies]

pyproject.toml

@@ -10,7 +10,7 @@
 import sentry_sdk
 import uvicorn  # type: ignore
 from fastapi import Body, Depends, FastAPI, Request
-from fastapi.responses import HTMLResponse, JSONResponse
+from fastapi.responses import HTMLResponse, ORJSONResponse
 from fastapi.staticfiles import StaticFiles
 from fastapi.templating import Jinja2Templates
 from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
@@ -97,9 +97,9 @@ def bugzilla_webhook(
     """API endpoint that Bugzilla Webhook Events request"""
     try:
         result = execute_action(request, actions, settings)
-        return JSONResponse(content=result, status_code=200)
+        return ORJSONResponse(content=result, status_code=200)
     except IgnoreInvalidRequestError as exception:
-        return JSONResponse(content={"error": str(exception)}, status_code=200)
+        return ORJSONResponse(content={"error": str(exception)}, status_code=200)
 
 
 @app.get("/whiteboard_tags/")

src/app/api.py

@@ -4,7 +4,7 @@
 from typing import Dict
 
 from fastapi import APIRouter, Depends, Request
-from fastapi.responses import JSONResponse
+from fastapi.responses import ORJSONResponse
 
 from src.app import environment
 from src.jbi.services import jbi_service_health_map
@@ -20,7 +20,7 @@ def heartbeat(request: Request, settings: environment.Settings):
         if not health.get("up"):
             status_code = 503
 
-    return JSONResponse(content=data, status_code=status_code)
+    return ORJSONResponse(content=data, status_code=status_code)
 
 
 @api_router.get("/__heartbeat__")

src/app/monitor.py

@@ -5,6 +5,7 @@
 from unittest import mock
 
 import pytest
+from datetime import datetime
 from fastapi.testclient import TestClient
 
 from src.app.api import app
@@ -96,8 +97,23 @@ def test_webhook_is_200_if_action_succeeds(
     mocked_jira,
     mocked_bugzilla,
 ):
-    mocked_bugzilla().update_bugs.return_value = {}
-    mocked_jira().create_or_update_issue_remote_links.return_value = {}
+    mocked_bugzilla().update_bugs.return_value = {
+        "bugs": [
+            {
+                "changes": {
+                    "see_also": {
+                        "added": "https://mozilla.atlassian.net/browse/JBI-1922",
+                        "removed": "",
+                    }
+                },
+                "last_change_time": datetime.now(),
+            }
+        ]
+    }
+    mocked_jira().create_or_update_issue_remote_links.return_value = {
+        "id": 18936,
+        "self": "https://mozilla.atlassian.net/rest/api/2/issue/JBI-1922/remotelink/18936",
+    }
 
     with TestClient(app) as anon_client:
         response = anon_client.post(