Merge branch 'main' into alex-branch

Author: emilyniee

.env.sample

@@ -2,4 +2,7 @@ POSTGRES_DATABASE=
 POSTGRES_USER=
 POSTGRES_PASSWORD=
 POSTGRES_DATABASE_URL=
-
+AWS_ACCESS_KEY_ID=
+AWS_SECRET_ACCESS_KEY=
+AWS_REGION=
+SES_EMAIL_FROM=

README.md

@@ -243,6 +243,18 @@ pdm run ruff format .
 
 All code needs to pass ruff formatting and linting before it can be merged.
 
+### Logging
+
+To add a logger to a new service or file, use the `LOGGER_NAME` function in `app/utilities/constants.py`
+
+```python
+from app.utilities.constants import LOGGER_NAME
+
+log = logging.getLogger(LOGGER_NAME("my_service"))
+```
+
+If you'd like to create a new logger name in the hierarchy, you'll need to add it to `alembic.ini` under the logger section. Following the pre-existing examples for `logger_uvicorn` for example.
+
 ### Frontend
 
 #### Prettier

backend/README.md

@@ -136,3 +136,15 @@ To apply the migration, run the following command:
 ```bash
 pdm run alembic upgrade head
 ```
+
+### Logging
+
+To add a logger to a new service or file, use the `LOGGER_NAME` function in `app/utilities/constants.py`
+
+```python
+from app.utilities.constants import LOGGER_NAME
+
+log = logging.getLogger(LOGGER_NAME("my_service"))
+```
+
+If you'd like to create a new logger name in the hierarchy, you'll need to add it to `alembic.ini` under the logger section. Following the pre-existing examples for `logger_uvicorn` for example.

backend/alembic.ini

@@ -62,7 +62,7 @@ version_path_separator = os  # Use os.pathsep. Default configuration used for ne
 # output_encoding = utf-8
 
 # Updated in env.py using the POSTGRES_DATABASE_URL environment variable
-# sqlalchemy.url = 
+# sqlalchemy.url =
 
 
 [post_write_hooks]
@@ -83,8 +83,10 @@ ruff.executable = %(here)s/.venv/bin/ruff
 ruff.options = check --fix REVISION_SCRIPT_FILENAME
 
 # Logging configuration
+# Every time you want to define a new sub-logger, you need to add it to loggers or it won't show up.
+# Would recommend just using uvicorn."name of area you want to log" to identify a smaller scope
 [loggers]
-keys = root,sqlalchemy,alembic
+keys = root,sqlalchemy,alembic,uvicorn
 
 [handlers]
 keys = console
@@ -107,12 +109,17 @@ level = INFO
 handlers =
 qualname = alembic
 
+[logger_uvicorn]
+level = INFO
+handlers =
+qualname = uvicorn
+
 [handler_console]
 class = StreamHandler
 args = (sys.stderr,)
 level = NOTSET
 formatter = generic
 
 [formatter_generic]
-format = %(levelname)-5.5s [%(name)s] %(message)s
+format = %(levelname)-5.5s     [%(name)s]      %(message)s
 datefmt = %H:%M:%S

backend/app/interfaces/email_service.py

@@ -1,5 +1,7 @@
 from abc import ABC, abstractmethod
 
+from app.schemas.email_template import EmailContent, EmailTemplateType
+
 
 class IEmailService(ABC):
     """
@@ -8,65 +10,20 @@ class IEmailService(ABC):
     """
 
     @abstractmethod
-    def send_email(self, to: str, subject: str, body: str) -> dict:
-        """
-        Sends an email with the given parameters.
-
-        :param to: Recipient's email address
-        :type to: str
-        :param subject: Subject of the email
-        :type subject: str
-        :param body: HTML body content of the email
-        :type body: str
-        :return: Provider-specific metadata (like message ID, thread ID, label IDs)
-        :rtype: dict
-        :raises Exception: if email was not sent successfully
-        """
-        pass
-
-    @abstractmethod
-    def send_welcome_email(self, recipient: str, user_name: str) -> dict:
-        """
-        Sends a welcome email to the specified user.
-
-        :param recipient: Email address of the user
-        :type recipient: str
-        :param user_name: Name of the user
-        :type user_name: str
-        :return: Provider-specific metadata for the sent email
-        :rtype: dict
-        :raises Exception: if email was not sent successfully
-        """
-        pass
-
-    @abstractmethod
-    def send_password_reset_email(self, recipient: str, reset_link: str) -> dict:
-        """
-        Sends a password reset email with the provided reset link.
-
-        :param recipient: Email address of the user requesting the reset
-        :type recipient: str
-        :param reset_link: Password reset link
-        :type reset_link: str
-        :return: Provider-specific metadata for the sent email
-        :rtype: dict
-        :raises Exception: if email was not sent successfully
-        """
-        pass
-
-    @abstractmethod
-    def send_notification_email(self, recipient: str, notification_text: str) -> dict:
-        """
-        Sends a notification email to the user with the provided notification text.
-        Examples of use case include matches completed and ready to view, new messages,
-        meeting time scheduled, etc.
-
-        :param recipient: Email address of the user
-        :type recipient: str
-        :param notification_text: The notification content
-        :type notification_text: str
-        :return: Provider-specific metadata for the sent email
-        :rtype: dict
-        :raises Exception: if email was not sent successfully
+    def send_email(
+        self, templateType: EmailTemplateType, content: EmailContent
+    ) -> dict:
+        """Send an email using the given template and content with a
+            respective service provider.
+
+        Args:
+            templateType (EmailTemplateType): Specifies the template
+                to be used for the email
+            content (EmailContent): Contains the recipient and data
+                to be used in the email
+
+        Returns:
+            dict: Provider-specific metadata if any
+                (like message ID, thread ID, label IDs)
         """
         pass

backend/app/interfaces/email_service_provider.py

@@ -1,5 +1,7 @@
 from abc import ABC, abstractmethod
 
+from app.schemas.email_template import EmailContent, EmailTemplateType
+
 
 class IEmailServiceProvider(ABC):
     """
@@ -9,22 +11,18 @@ class IEmailServiceProvider(ABC):
 
     @abstractmethod
     def send_email(
-        self, recipient: str, subject: str, body_html: str, body_text: str
+        self, templateType: EmailTemplateType, content: EmailContent
     ) -> dict:
-        """
-        Sends an email using the provider's service.
+        """_summary_
+
+        Args:
+            templateType (EmailTemplate): Helps provider determine which
+                template to use for the given email
+            content (EmailContent): Contains the recipient and data to be
+                used in the email
 
-        :param recipient: Email address of the recipient
-        :type recipient: str
-        :param subject: Subject of the email
-        :type subject: str
-        :param body_html: HTML body content of the email
-        :type body_html: str
-        :param body_text: Plain text content of the email
-        :type body_text: str
-        :return: Provider-specific metadata related to the sent email
-        (like message ID, status, etc.)
-        :rtype: dict
-        :raises Exception: if the email fails to send
+        Returns:
+            dict: Provider-specific metadata if any
+                (like message ID, thread ID, label IDs)
         """
         pass

backend/app/models/__init__.py

@@ -1,6 +1,10 @@
+import logging
+
 from alembic import command
 from alembic.config import Config
 
+from app.utilities.constants import LOGGER_NAME
+
 # Make sure all models are here to reflect all current models
 # when autogenerating new migration
 from .Base import Base
@@ -13,8 +17,12 @@
 # Used to avoid import errors for the models
 __all__ = ["Base", "User", "Role", "Schedule", "ScheduleStatus", "TimeBlock" ]
 
+log = logging.getLogger(LOGGER_NAME("models"))
+
 
 def run_migrations():
+    log.info("Running run_migrations in models/__init__ on server startup")
+
     alembic_cfg = Config("alembic.ini")
     # Emulates `alembic upgrade head` to migrate up to latest revision
     command.upgrade(alembic_cfg, "head")

backend/app/routes/email.py backend/app/routes/send_email.pybackend/app/routes/email.py renamed to backend/app/routes/send_email.py

@@ -3,8 +3,11 @@
 from fastapi import APIRouter, Depends
 
 from app.interfaces.email_service import IEmailService
+from app.schemas.email_template import EmailContent, EmailTemplateType, MockEmailData
+from app.services.email.amazon_ses_provider import (
+    get_email_service_provider,
+)
 from app.services.email.email_service import EmailService
-from app.services.email.email_service_provider import AmazonSESEmailProvider
 
 router = APIRouter(
     prefix="/email",
@@ -13,16 +16,19 @@
 
 
 def get_email_service() -> IEmailService:
-    email_provider = AmazonSESEmailProvider(aws_access_key="", aws_secret_key="")
-    return EmailService(email_provider)
+    return EmailService(provider=get_email_service_provider())
 
 
 # TODO (Mayank, Nov 30th) - Remove test emails once email service is fully implemented
-@router.post("/send-test-email/")
+@router.post("/send-test")
 async def send_welcome_email(
     recipient: str,
     user_name: str,
     email_service: Annotated[IEmailService, Depends(get_email_service)],
 ):
-    email_service.send_welcome_email(recipient, user_name)
-    return {"message": f"Welcome email sent to {user_name}!"}
+    return email_service.send_email(
+        templateType=EmailTemplateType.TEST,
+        content=EmailContent[MockEmailData](
+            recipient=recipient, data=MockEmailData(name=user_name, date="2021-12-01")
+        ),
+    )

backend/app/schemas/email_template.py

@@ -0,0 +1,34 @@
+import json
+from abc import ABC
+from dataclasses import dataclass
+from enum import Enum
+from typing import Generic, TypeVar
+
+EmailData = TypeVar("EmailData")
+
+
+class TemplateData(ABC):
+    def get_formatted_string(self) -> str:
+        class_dict = self.__dict__
+        try:
+            formatted_string = json.dumps(class_dict)  # Try to convert to a JSON string
+        except (TypeError, ValueError) as e:
+            raise Exception(f"Error converting class to JSON: {e}")
+
+        return formatted_string
+
+
+@dataclass
+class MockEmailData(TemplateData):
+    name: str
+    date: str
+
+
+class EmailTemplateType(Enum):
+    TEST = "Test"
+
+
+@dataclass
+class EmailContent(Generic[EmailData]):
+    recipient: str
+    data: EmailData

backend/app/server.py

@@ -5,21 +5,21 @@
 from dotenv import load_dotenv
 from fastapi import FastAPI
 
-from app.routes import email
+from . import models
+from .routes import send_email, user, schedule
+from .utilities.constants import LOGGER_NAME
+from .utilities.firebase_init import initialize_firebase
+from .utilities.ses.ses_init import ensure_ses_templates
 
 load_dotenv()
 
-# we need to load env variables before initialization code runs
-from . import models  # noqa: E402
-from .routes import user, schedule  # noqa: E402
-from .utilities.firebase_init import initialize_firebase  # noqa: E402
-
-log = logging.getLogger("uvicorn")
+log = logging.getLogger(LOGGER_NAME("server"))
 
 
 @asynccontextmanager
 async def lifespan(_: FastAPI):
     log.info("Starting up...")
+    ensure_ses_templates()
     models.run_migrations()
     initialize_firebase()
     yield
@@ -31,11 +31,11 @@ async def lifespan(_: FastAPI):
 app = FastAPI(lifespan=lifespan)
 app.include_router(user.router)
 app.include_router(schedule.router)
-app.include_router(email.router)
-
+app.include_router(send_email.router)
 
 @app.get("/")
 def read_root():
+    log.info("Hello World")
     return {"Hello": "World"}