feat: implement user email verification workflow (#177)

backend/Pipfile

@@ -24,6 +24,7 @@ alembic = "*"
 requests = "*"
 types-requests = "*"
 greenlet = "*"
+emails = "*"
 
 [dev-packages]
 aiosqlite = "*"

backend/app/api/api_v1/api.py

@@ -4,14 +4,15 @@
 from httpx_oauth.clients.openid import OpenID
 from httpx_oauth.errors import GetIdEmailError
 
-from app.api.api_v1.endpoints import adminmsgs, auth, bookmarks, caseinfo
+from app.api.api_v1.endpoints import adminmsgs, auth, bookmarks, utils, caseinfo
 from app.core.auth import auth_backend_bearer, auth_backend_cookie, fastapi_users
 from app.core.config import settings
 from app.schemas.user import UserRead, UserUpdate
 
 api_router = APIRouter()
 api_router.include_router(adminmsgs.router, prefix="/adminmsgs", tags=["adminmsgs"])
 api_router.include_router(bookmarks.router, prefix="/bookmarks", tags=["bookmarks"])
+api_router.include_router(utils.router, prefix="/utils", tags=["utils"])
 api_router.include_router(caseinfo.router, prefix="/caseinfo", tags=["caseinfo"])
 
 api_router.include_router(
@@ -31,11 +32,11 @@
 #     prefix="/auth",
 #     tags=["auth"],
 # )
-# api_router.include_router(
-#     fastapi_users.get_verify_router(UserRead),
-#     prefix="/auth",
-#     tags=["auth"],
-# )
+api_router.include_router(
+    fastapi_users.get_verify_router(UserRead),
+    prefix="/auth",
+    tags=["auth"],
+)
 api_router.include_router(
     fastapi_users.get_users_router(UserRead, UserUpdate),
     prefix="/users",

backend/app/api/api_v1/endpoints/utils.py

@@ -0,0 +1,20 @@
+from typing import Any
+
+from fastapi import APIRouter, Depends
+from pydantic.networks import EmailStr
+
+from app import models, schemas
+from app.api import deps
+from app.app.utils import send_test_email
+
+router = APIRouter()
+
+
+@router.post("/test-email/", response_model=schemas.Msg, status_code=201)
+def test_email(
+    email_to: EmailStr,
+    current_user: models.User = Depends(deps.get_current_active_superuser),
+) -> Any:
+    """Send out a test email."""
+    send_test_email(email_to=email_to)
+    return {"msg": "Test email sent"}

backend/app/app/email-templates/src/test_email.mjml

@@ -0,0 +1,11 @@
+<mjml>
+  <mj-body background-color="#fff">
+    <mj-section>
+      <mj-column>
+        <mj-divider border-color="#555"></mj-divider>
+        <mj-text font-size="20px" color="#555" font-family="helvetica">{{ project_name }}</mj-text>
+        <mj-text font-size="16px" color="#555">Test email for: {{ email }}</mj-text>
+      </mj-column>
+    </mj-section>
+  </mj-body>
+</mjml>

backend/app/app/utils.py

@@ -0,0 +1,45 @@
+import logging
+from datetime import datetime, timedelta
+from pathlib import Path
+from typing import Any, Dict, Optional
+
+import emails
+from emails.template import JinjaTemplate
+
+from app.core.config import settings
+
+
+def send_email(
+    email_to: str,
+    subject_template: str = "",
+    html_template: str = "",
+    environment: Dict[str, Any] = {},
+) -> None:
+    assert settings.EMAILS_ENABLED, "no provided configuration for email variables"
+    message = emails.Message(
+        subject=JinjaTemplate(subject_template),
+        html=JinjaTemplate(html_template),
+        mail_from=(settings.EMAILS_FROM_NAME, settings.EMAILS_FROM_EMAIL),
+    )
+    smtp_options = {"host": settings.SMTP_HOST, "port": settings.SMTP_PORT}
+    if settings.SMTP_TLS:
+        smtp_options["tls"] = True
+    if settings.SMTP_USER:
+        smtp_options["user"] = settings.SMTP_USER
+    if settings.SMTP_PASSWORD:
+        smtp_options["password"] = settings.SMTP_PASSWORD
+    response = message.send(to=email_to, render=environment, smtp=smtp_options)
+    logging.info(f"send email result: {response}")
+
+
+def send_test_email(email_to: str) -> None:
+    project_name = settings.PROJECT_NAME
+    subject = f"{project_name} - Test email"
+    with open(Path(settings.EMAIL_TEMPLATES_DIR) / "test_email.html") as f:
+        template_str = f.read()
+    send_email(
+        email_to=email_to,
+        subject_template=subject,
+        html_template=template_str,
+        environment={"project_name": settings.PROJECT_NAME, "email": email_to},
+    )

backend/app/core/auth.py

@@ -1,5 +1,5 @@
 import uuid
-from typing import Any
+from typing import Any, Optional
 
 import redis.asyncio
 from fastapi import Depends, Request, Response
@@ -11,6 +11,9 @@
     RedisStrategy,
 )
 from fastapi_users_db_sqlalchemy import SQLAlchemyUserDatabase
+from fastapi_users import models
+from fastapi_users.db import BaseUserDatabase
+from fastapi_users.password import PasswordHelperProtocol
 from sqlalchemy.ext.asyncio import AsyncSession
 
 from app.api.deps import get_async_session
@@ -26,6 +29,11 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
     reset_password_token_secret = settings.SECRET_KEY
     verification_token_secret = settings.SECRET_KEY
 
+    def __init__(self,         user_db: BaseUserDatabase[models.UP, models.ID],
+        password_helper: Optional[PasswordHelperProtocol] = None,
+    ):
+        super().__init__(self, user_db, password_helper)
+
     async def on_after_register(self, user: User, request: Request | None = None):
         print(f"User {user.id} has registered.")
 
@@ -35,7 +43,8 @@ async def on_after_forgot_password(
         print(f"User {user.id} has forgot their password. Reset token: {token}")
 
     async def on_after_request_verify(self, user: User, token: str, request: Request | None = None):
-        print(f"Verification requested for user {user.id}. Verification token: {token}")
+        """Callback after requesting verification."""
+        self.email.send_user_validation(user.email, token, request and request.headers)
 
 
 async def get_user_manager(user_db: SQLAlchemyUserDatabase = Depends(get_user_db)):

backend/app/core/config.py

@@ -2,6 +2,7 @@
 import os
 import secrets
 from typing import Any
+import typing
 
 from pydantic import AnyHttpUrl, EmailStr, HttpUrl, PostgresDsn, field_validator
 from pydantic_core.core_schema import ValidationInfo
@@ -156,31 +157,17 @@ def assemble_db_connection(cls, v: str | None, info: ValidationInfo) -> Any:
 
     # -- Email Sending Configuration -----------------------------------------
 
-    # SMTP_TLS: bool = True
-    # SMTP_PORT: int | None = None
-    # SMTP_HOST: str | None = None
-    # SMTP_USER: str | None = None
-    # SMTP_PASSWORD: str | None = None
-    # EMAILS_FROM_EMAIL: EmailStr | None = None
-    # EMAILS_FROM_NAME: str | None = None
-
-    # @validator("EMAILS_FROM_NAME")
-    # def get_project_name(cls, v: str | None, values: Dict[str, Any]) -> str:
-    #     if not v:
-    #         return values["PROJECT_NAME"]
-    #     return v
-
-    # EMAIL_RESET_TOKEN_EXPIRE_HOURS: int = 48
-    # EMAIL_TEMPLATES_DIR: str = "/app/app/email-templates/build"
-    # EMAILS_ENABLED: bool = False
-
-    # @validator("EMAILS_ENABLED", pre=True)
-    # def get_emails_enabled(cls, v: bool, values: Dict[str, Any]) -> bool:
-    #     return bool(
-    #         values.get("SMTP_HOST")
-    #         and values.get("SMTP_PORT")
-    #         and values.get("EMAILS_FROM_EMAIL")
-    #     )
+    SMTP_TLS: bool = False
+    SMTP_PORT: int | None = None
+    SMTP_HOST: str | None = None
+    SMTP_USER: str | None = None
+    SMTP_PASSWORD: str | None = None
+    EMAILS_FROM_EMAIL: EmailStr | None = None
+    EMAILS_FROM_NAME: str | None = None
+
+    EMAIL_RESET_TOKEN_EXPIRE_HOURS: int = 48
+    EMAIL_TEMPLATES_DIR: str = "/app/app/email-templates/build"
+    EMAILS_ENABLED: bool = False
 
     # -- Sentry Configuration ------------------------------------------------
 

backend/app/schemas/__init__.py

@@ -2,4 +2,5 @@
 from app.schemas.auth import OAuth2ProviderConfig, OAuth2ProviderPublic  # noqa
 from app.schemas.bookmark import BookmarkCreate, BookmarkRead, BookmarkUpdate  # noqa
 from app.schemas.caseinfo import CaseInfoCreate, CaseInfoRead, CaseInfoUpdate  # noqa
+from app.schemas.msg import Msg  # noqa
 from app.schemas.user import UserCreate, UserRead, UserUpdate  # noqa

backend/app/schemas/msg.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class Msg(BaseModel):
+    msg: str