Refactor Timeline class to pydantic model

.deepsource.toml

@@ -0,0 +1,10 @@
+version = 1
+
+test_patterns = ["tests/**"]
+
+[[analyzers]]
+name = "python"
+enabled = true
+
+  [analyzers.meta]
+  runtime_version = "3.x.x"

.gitignore

@@ -51,6 +51,7 @@ htmlcov/
 nosetests.xml
 coverage.xml
 *,cover
+locustfile.py
 
 # Translations
 *.mo

Pipfile

@@ -33,6 +33,7 @@ pydantic = {extras = ["dotenv"],version = "*"}
 python-dateutil = "*"
 requests = "*"
 scout-apm = "*"
+sentry-sdk = "*"
 uvicorn = "*"
 
 [requires]

Procfile

@@ -1 +1 @@
-web: gunicorn app.main:APP -w 4 -k uvicorn.workers.UvicornWorker
+web: gunicorn app.main:APP -w 2 --max-requests 1000 --max-requests-jitter 400 -k uvicorn.workers.UvicornWorker

app/config.py

@@ -13,6 +13,8 @@ class _Settings(BaseSettings):
     local_redis_url: AnyUrl = None
     # Scout APM
     scout_name: str = None
+    # Sentry
+    sentry_dsn: str = None
 
 
 @functools.lru_cache()

app/data/__init__.py

@@ -4,7 +4,11 @@
 from ..services.location.nyt import NYTLocationService
 
 # Mapping of services to data-sources.
-DATA_SOURCES = {"jhu": JhuLocationService(), "csbs": CSBSLocationService(), "nyt": NYTLocationService()}
+DATA_SOURCES = {
+    "jhu": JhuLocationService(),
+    "csbs": CSBSLocationService(),
+    "nyt": NYTLocationService(),
+}
 
 
 def data_source(source):

app/io.py

@@ -10,7 +10,11 @@
 
 
 def save(
-    name: str, content: Union[str, Dict, List], write_mode: str = "w", indent: int = 2, **json_dumps_kwargs
+    name: str,
+    content: Union[str, Dict, List],
+    write_mode: str = "w",
+    indent: int = 2,
+    **json_dumps_kwargs,
 ) -> pathlib.Path:
     """Save content to a file. If content is a dictionary, use json.dumps()."""
     path = DATA / name
@@ -35,7 +39,12 @@ class AIO:
 
     @classmethod
     async def save(
-        cls, name: str, content: Union[str, Dict, List], write_mode: str = "w", indent: int = 2, **json_dumps_kwargs
+        cls,
+        name: str,
+        content: Union[str, Dict, List],
+        write_mode: str = "w",
+        indent: int = 2,
+        **json_dumps_kwargs,
     ):
         """Save content to a file. If content is a dictionary, use json.dumps()."""
         path = DATA / name

app/location/__init__.py

@@ -11,7 +11,7 @@ class Location:  # pylint: disable=too-many-instance-attributes
     """
 
     def __init__(
-        self, id, country, province, coordinates, last_updated, confirmed, deaths, recovered
+        self, id, country, province, coordinates, last_updated, confirmed, deaths, recovered,
     ):  # pylint: disable=too-many-arguments
         # General info.
         self.id = id
@@ -66,7 +66,11 @@ def serialize(self):
             # Last updated.
             "last_updated": self.last_updated,
             # Latest data (statistics).
-            "latest": {"confirmed": self.confirmed, "deaths": self.deaths, "recovered": self.recovered},
+            "latest": {
+                "confirmed": self.confirmed,
+                "deaths": self.deaths,
+                "recovered": self.recovered,
+            },
         }
 
 

app/main.py

@@ -4,12 +4,14 @@
 import logging
 
 import pydantic
+import sentry_sdk
 import uvicorn
 from fastapi import FastAPI, Request, Response
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.middleware.gzip import GZipMiddleware
 from fastapi.responses import JSONResponse
 from scout_apm.async_.starlette import ScoutMiddleware
+from sentry_sdk.integrations.asgi import SentryAsgiMiddleware
 
 from .config import get_settings
 from .data import data_source
@@ -23,6 +25,9 @@
 
 SETTINGS = get_settings()
 
+if SETTINGS.sentry_dsn:  # pragma: no cover
+    sentry_sdk.init(dsn=SETTINGS.sentry_dsn)
+
 APP = FastAPI(
     title="Coronavirus Tracker",
     description=(
@@ -47,9 +52,18 @@
 else:
     LOGGER.debug("No SCOUT_NAME config")
 
+# Sentry Error Tracking
+if SETTINGS.sentry_dsn:  # pragma: no cover
+    LOGGER.info("Adding Sentry middleware")
+    APP.add_middleware(SentryAsgiMiddleware)
+
 # Enable CORS.
 APP.add_middleware(
-    CORSMiddleware, allow_credentials=True, allow_origins=["*"], allow_methods=["*"], allow_headers=["*"],
+    CORSMiddleware,
+    allow_credentials=True,
+    allow_origins=["*"],
+    allow_methods=["*"],
+    allow_headers=["*"],
 )
 APP.add_middleware(GZipMiddleware, minimum_size=1000)
 

app/models.py

@@ -1,7 +1,7 @@
 """app.models.py"""
 from typing import Dict, List
 
-from pydantic import BaseModel
+from pydantic import BaseModel, validator
 
 
 class Latest(BaseModel):
@@ -27,8 +27,25 @@ class Timeline(BaseModel):
     Timeline model.
     """
 
-    latest: int
-    timeline: Dict[str, int] = {}
+    timeline: Dict[str, int] = dict()
+
+    @validator("timeline")
+    @classmethod
+    def sort_timeline(cls, value):
+        """Sort the timeline history before inserting into the model"""
+        return dict(sorted(value.items()))
+
+    @property
+    def latest(self):
+        """Get latest available history value."""
+        return list(self.timeline.values())[-1] if self.timeline else 0
+
+    def serialize(self):
+        """
+        Serialize the model into dict
+        TODO: override dict() instead of using serialize
+        """
+        return {**self.dict(), "latest": self.latest}
 
 
 class Timelines(BaseModel):

app/routers/v1.py

@@ -19,7 +19,11 @@ async def all_categories():
         "deaths": deaths,
         "recovered": recovered,
         # Latest.
-        "latest": {"confirmed": confirmed["latest"], "deaths": deaths["latest"], "recovered": recovered["latest"],},
+        "latest": {
+            "confirmed": confirmed["latest"],
+            "deaths": deaths["latest"],
+            "recovered": recovered["latest"],
+        },
     }
 
 

app/routers/v2.py

@@ -65,11 +65,17 @@ async def get_locations(
 
         # Do filtering.
         try:
-            locations = [location for location in locations if str(getattr(location, key)).lower() == str(value)]
+            locations = [
+                location
+                for location in locations
+                if str(getattr(location, key)).lower() == str(value)
+            ]
         except AttributeError:
             pass
         if not locations:
-            raise HTTPException(404, detail=f"Source `{source}` does not have the desired location data.")
+            raise HTTPException(
+                404, detail=f"Source `{source}` does not have the desired location data.",
+            )
 
     # Return final serialized data.
     return {
@@ -84,7 +90,9 @@ async def get_locations(
 
 # pylint: disable=invalid-name
 @V2.get("/locations/{id}", response_model=LocationResponse)
-async def get_location_by_id(request: Request, id: int, source: Sources = "jhu", timelines: bool = True):
+async def get_location_by_id(
+    request: Request, id: int, source: Sources = "jhu", timelines: bool = True
+):
     """
     Getting specific location by id.
     """