Refactoring scheduling schema

Co-authored-by: emilyniee <[email protected]>

Author: sunbagel

backend/app/models/AvailableTime.py

@@ -0,0 +1,13 @@
+from sqlalchemy import Column, ForeignKey, Table
+
+from .Base import Base
+
+# AvailableTimes as a pure association table
+# only exists to establish a relationship between Users and Time Blocks
+# a User has an Availability which is composed of many time blocks
+available_times = Table(
+    "available_times",
+    Base.metadata,
+    Column("time_block_id", ForeignKey("time_blocks.id"), primary_key=True),
+    Column("user_id", ForeignKey("users.id"), primary_key=True),
+)

backend/app/models/Schedule.py

@@ -1,8 +1,5 @@
-import uuid
-
-from sqlalchemy import Column, DateTime, Enum, Interval, Integer, ForeignKey
+from sqlalchemy import Column, DateTime, ForeignKey, Integer, Interval
 from sqlalchemy.orm import relationship
-from app.models.ScheduleStatus import ScheduleStatus
 
 from .Base import Base
 
@@ -11,8 +8,8 @@ class Schedule(Base):
     __tablename__ = "schedules"
 
     id = Column(Integer, primary_key=True)
-    scheduled_time = Column(DateTime, nullable = True)
-    duration = Column(Interval, nullable = True)
+    scheduled_time = Column(DateTime, nullable=True)
+    duration = Column(Interval, nullable=True)
     status_id = Column(Integer, ForeignKey("schedule_status.id"), nullable=False)
 
     status = relationship("ScheduleStatus")

backend/app/models/SuggestedTime.py

@@ -0,0 +1,13 @@
+from sqlalchemy import Column, ForeignKey, Table
+
+from .Base import Base
+
+# SuggestedTimes as a pure association table
+# only exists to establish a relationship between Matches and Time Blocks (many to many)
+suggested_times = Table(
+    "suggested_times",
+    Base.metadata,
+    # composite key of match and time block
+    Column("match_id", ForeignKey("matches.id"), primary_key=True),
+    Column("time_block_id", ForeignKey("time_blocks.id"), primary_key=True),
+)

backend/app/models/TimeBlock.py

@@ -1,7 +1,4 @@
-import uuid
-
-from sqlalchemy import Column, DateTime, ForeignKey, Integer
-from sqlalchemy.dialects.postgresql import UUID
+from sqlalchemy import Column, DateTime, Integer
 from sqlalchemy.orm import relationship
 
 from .Base import Base
@@ -10,9 +7,19 @@
 class TimeBlock(Base):
     __tablename__ = "time_blocks"
     id = Column(Integer, primary_key=True)
-    schedule_id = Column(Integer, ForeignKey("schedules.id"), nullable = False)
     start_time = Column(DateTime)
-    end_time = Column(DateTime)
 
-    schedule = relationship("Schedule", back_populates="time_blocks")
+    # if a match has been confirmed on this time block, this is non null
+    confirmed_match = relationship(
+        "Match", back_populates="confirmed_time", uselist=False
+    )
+
+    # suggested matches
+    suggested_matches = relationship(
+        "Match", secondary="suggested_times", back_populates="suggested_time_blocks"
+    )
 
+    # the availability that the timeblock is a part of for a given user
+    users = relationship(
+        "User", secondary="available_times", back_populates="availability"
+    )

backend/app/models/User.py

@@ -17,3 +17,8 @@ class User(Base):
     auth_id = Column(String, nullable=False)
 
     role = relationship("Role")
+
+    # time blocks in an availability for a user
+    availability = relationship(
+        "TimeBlock", secondary="available_times", back_populates="users"
+    )

backend/app/models/__init__.py

@@ -9,13 +9,13 @@
 # when autogenerating new migration
 from .Base import Base
 from .Role import Role
-from .User import User
 from .Schedule import Schedule
 from .ScheduleStatus import ScheduleStatus
 from .TimeBlock import TimeBlock
+from .User import User
 
 # Used to avoid import errors for the models
-__all__ = ["Base", "User", "Role", "Schedule", "ScheduleStatus", "TimeBlock" ]
+__all__ = ["Base", "User", "Role", "Schedule", "ScheduleStatus", "TimeBlock"]
 
 log = logging.getLogger(LOGGER_NAME("models"))
 

backend/app/routes/schedule.py

@@ -1,13 +1,10 @@
-
 from fastapi import APIRouter, Depends, HTTPException
 from sqlalchemy.orm import Session
 
 from app.schemas.schedule import ScheduleCreateRequest, ScheduleEntity
 from app.services.implementations.schedule_service import ScheduleService
 from app.utilities.db_utils import get_db
 
-
-
 router = APIRouter(
     prefix="/schedules",
     tags=["schedules"],
@@ -17,9 +14,11 @@
 def get_schedule_service(db: Session = Depends(get_db)):
     return ScheduleService(db)
 
+
 @router.post("/", response_model=ScheduleEntity)
 async def create_schedule(
-    schedule: ScheduleCreateRequest, schedule_service: ScheduleService = Depends(get_schedule_service)
+    schedule: ScheduleCreateRequest,
+    schedule_service: ScheduleService = Depends(get_schedule_service),
 ):
     try:
         created_schedule = await schedule_service.create_schedule(schedule)
@@ -29,4 +28,3 @@ async def create_schedule(
     except Exception as e:
         print(e)
         raise HTTPException(status_code=500, detail=str(e))
-

backend/app/schemas/schedule.py

@@ -1,10 +1,11 @@
-from enum import Enum
-from uuid import UUID
 from datetime import datetime, timedelta
+from enum import Enum
 from typing import List, Optional
-from app.schemas.time_block import TimeBlockBase, TimeBlockId, TimeBlockFull
+from uuid import UUID
+
 from pydantic import BaseModel, ConfigDict
 
+from app.schemas.time_block import TimeBlockBase, TimeBlockFull, TimeBlockId
 
 
 class ScheduleStatus(str, Enum):
@@ -19,10 +20,12 @@ def to_schedule_status_id(cls, state: "ScheduleStatus") -> int:
             cls.PENDING_VOLUNTEER: 1,
             cls.PENDING_PARTICIPANT: 2,
             cls.SCHEDULED: 3,
-            cls.COMPLETED: 4}
+            cls.COMPLETED: 4,
+        }
 
         return status_map[state]
 
+
 class ScheduleBase(BaseModel):
     scheduled_time: Optional[datetime]
     duration: Optional[timedelta]
@@ -34,19 +37,22 @@ class ScheduleEntity(ScheduleBase):
 
     model_config = ConfigDict(from_attributes=True)
 
-# Provides both Schedule data and full TimeBlock data 
+
+# Provides both Schedule data and full TimeBlock data
 class ScheduleGetResponse(ScheduleEntity):
     time_blocks: List[TimeBlockFull]
 
+
 # List of Start and End times to Create a Schedule with
 class ScheduleCreateRequest(BaseModel):
     time_blocks: List[TimeBlockBase]
 
+
 class ScheduleUpdateRequest(BaseModel):
     schedule_id: UUID
     time_blocks: List[TimeBlockBase]
 
+
 class ScheduleDeleteRequest(BaseModel):
     schedule_id: UUID
     time_blocks: List[TimeBlockId]
-

backend/app/schemas/time_block.py

@@ -1,22 +1,27 @@
-
-from pydantic import BaseModel
 from datetime import datetime
 from uuid import UUID
 
+from pydantic import BaseModel
+
+
 class TimeBlockBase(BaseModel):
     start_time: datetime
     end_time: datetime
 
+
 class TimeBlockId(BaseModel):
     id: UUID
 
+
 class TimeBlockFull(TimeBlockBase, TimeBlockId):
-    '''
+    """
     Combines TimeBlockBase and TimeBlockId.
     Represents a full time block with an ID and time range.
-    '''
+    """
+
     pass
 
+
 class TimeBlockEntity(BaseModel):
     id: UUID
     schedule_id: int

backend/app/server.py

@@ -6,7 +6,7 @@
 from fastapi import FastAPI
 
 from . import models
-from .routes import send_email, user, schedule
+from .routes import schedule, send_email, user
 from .utilities.constants import LOGGER_NAME
 from .utilities.firebase_init import initialize_firebase
 from .utilities.ses.ses_init import ensure_ses_templates
@@ -33,6 +33,7 @@ async def lifespan(_: FastAPI):
 app.include_router(schedule.router)
 app.include_router(send_email.router)
 
+
 @app.get("/")
 def read_root():
     log.info("Hello World")