Fix deprecation warnings from Jinja

Author: Iain-S

rctab/routers/frontend.py

@@ -2,18 +2,17 @@
 
 import datetime
 import logging
-from pathlib import Path
 from typing import Dict, Final, List, Optional
 from uuid import UUID
 
 import pandas as pd
 import plotly.express as px
 from fastapi import APIRouter, Depends, HTTPException, Request
-from fastapi.templating import Jinja2Templates
 from fastapimsal import RequiresLoginException, UserIdentityToken
+from jinja2 import Environment, PackageLoader, select_autoescape
 from jose import jwt
 from pydantic import BaseModel, EmailStr, ValidationError
-from starlette.templating import _TemplateResponse
+from starlette.templating import Jinja2Templates, _TemplateResponse
 
 from rctab.constants import __version__
 from rctab.crud.auth import check_user_access, user_authenticated_no_error
@@ -39,9 +38,8 @@
 
 logger = logging.getLogger(__name__)
 
-templates = Jinja2Templates(
-    directory=str((Path(__file__).parent.parent / "templates").absolute())
-)
+jinja_env = Environment(loader=PackageLoader("rctab"), autoescape=select_autoescape())
+templates = Jinja2Templates(env=jinja_env)
 router = APIRouter()
 
 BETA_ACCESS = False
@@ -115,9 +113,9 @@ async def home(
     settings = get_settings()
     if not user:
         return templates.TemplateResponse(
-            "index.html",
-            {
-                "request": request,
+            request=request,
+            name="index.html",
+            context={
                 "version": __version__,
                 "organisation": settings.organisation,
                 "current_year": datetime.date.today().year,
@@ -148,9 +146,9 @@ async def home(
     # If we're in Beta release mode, only users with 'has_access' can access
     if BETA_ACCESS and (not access_status.has_access):
         return templates.TemplateResponse(
-            "index.html",
-            {
-                "request": request,
+            request=request,
+            name="index.html",
+            context={
                 "version": __version__,
                 "current_year": datetime.date.today().year,
             },
@@ -180,9 +178,9 @@ async def home(
                         subscriptions_with_access.append(sub)
                         break
     return templates.TemplateResponse(
-        "signed_in_azure_info.html",
-        {
-            "request": request,
+        request=request,
+        name="signed_in_azure_info.html",
+        context={
             "name": user_name,
             "version": __version__,
             "has_access": access_to_span(access_status.has_access),
@@ -202,7 +200,7 @@ async def subscription_details(
 ) -> _TemplateResponse:
     """The subscription details page."""
     if not user:
-        return templates.TemplateResponse("index.html", {"request": request})
+        return templates.TemplateResponse(request=request, name="index.html")
 
     # Get the username from cached token
     user_name = jwt.get_unverified_claims(user.token["access_token"])["name"]
@@ -299,9 +297,9 @@ async def subscription_details(
     # pylint: enable=line-too-long
 
     return templates.TemplateResponse(
-        "signed_in_azure_info_details.html",
-        {
-            "request": request,
+        request=request,
+        name="signed_in_azure_info_details.html",
+        context={
             "name": user_name,
             "version": __version__,
             "has_access": access_to_span(access_status.has_access),
@@ -328,7 +326,7 @@ async def subscription_details_1(
 ) -> _TemplateResponse:
     """Get html for the usage tab of the details page."""
     if not user:
-        return templates.TemplateResponse("index.html", {"request": request})
+        return templates.TemplateResponse(request=request, name="index.html")
 
     # Get the username from cached token
     # user_name = jwt.get_unverified_claims(user.token["access_token"])["name"]
@@ -363,9 +361,9 @@ async def subscription_details_1(
         timeperiod = datetime.datetime.strptime(timeperiodstr, "%Y-%m-%d")
     except ValueError:
         return templates.TemplateResponse(
-            "azure_usage_info.html",
-            {
-                "request": request,
+            request=request,
+            name="azure_usage_info.html",
+            context={
                 "cost_breakdown": None,
             },
         )
@@ -397,9 +395,9 @@ async def subscription_details_1(
             "<div>", '<div class="usageFigure">'
         )
     return templates.TemplateResponse(
-        "azure_usage_info.html",
-        {
-            "request": request,
+        request=request,
+        name="azure_usage_info.html",
+        context={
             "cost_breakdown": cost_breakdown,
             "all_usage": all_usage,
             "time_frame_start": time_frame_start,

tests/test_routes/test_frontend.py

@@ -8,7 +8,7 @@
 from databases import Database
 from fastapi import HTTPException
 from fastapi.templating import Jinja2Templates
-from jinja2 import StrictUndefined
+from jinja2 import Environment, PackageLoader, StrictUndefined, select_autoescape
 from pytest_mock import MockerFixture
 
 import rctab
@@ -95,7 +95,10 @@ async def test_no_username_no_subscriptions(
     await home(mock_request, mock_user)
 
     # Check that no subscriptions are passed to the template
-    assert mock_templates.TemplateResponse.call_args.args[1]["azure_sub_data"] == []
+    assert (
+        mock_templates.TemplateResponse.call_args.kwargs["context"]["azure_sub_data"]
+        == []
+    )
 
 
 @pytest.mark.asyncio
@@ -129,10 +132,11 @@ async def test_render_home_page(mocker: MockerFixture, test_db: Database) -> Non
     mocker.patch(
         "rctab.routers.frontend.templates",
         Jinja2Templates(
-            (
-                Path(rctab.routers.frontend.__file__).parent.parent / "templates"
-            ).absolute(),
-            undefined=StrictUndefined,
+            env=Environment(
+                loader=PackageLoader("rctab"),
+                autoescape=select_autoescape(),
+                undefined=StrictUndefined,
+            )
         ),
     )
     subscription_id = UUID(int=random.randint(0, (2**32) - 1))