Merge pull request #186 from cuappdev/user-streaks

Added user streaks including their current and max streaks

Author: TushigBili

migrations/versions/6b01a81bb92b_added_active_streak_and_max_streak_to_.py

@@ -0,0 +1,34 @@
+"""Added active_streak and max_streak to users
+
+Revision ID: 6b01a81bb92b
+Revises: 31b1fa20772f
+Create Date: 2025-03-04 22:45:06.601964
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '6b01a81bb92b'
+down_revision = '31b1fa20772f'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint('report_user_id_fkey', 'report', type_='foreignkey')
+    op.drop_column('report', 'user_id')
+    op.add_column('users', sa.Column('active_streak', sa.Integer(), nullable=True))
+    op.add_column('users', sa.Column('max_streak', sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('report', sa.Column('user_id', sa.INTEGER(), autoincrement=False, nullable=False))
+    op.create_foreign_key('report_user_id_fkey', 'report', 'users', ['user_id'], ['id'])
+    op.drop_column('users', 'active_streak')
+    op.drop_column('users', 'max_streak')
+    # ### end Alembic commands ###

schema.graphql

@@ -71,6 +71,16 @@ type CreateReport {
 
 scalar DateTime
 
+enum DayOfWeekEnum {
+  MONDAY
+  TUESDAY
+  WEDNESDAY
+  THURSDAY
+  FRIDAY
+  SATURDAY
+  SUNDAY
+}
+
 enum DayOfWeekGraphQLEnum {
   MONDAY
   TUESDAY
@@ -146,6 +156,8 @@ type HourlyAverageCapacity {
   history: [Float]!
 }
 
+scalar JSONString
+
 enum MuscleGroup {
   ABDOMINALS
   CHEST
@@ -205,6 +217,8 @@ type Query {
   getWorkoutsById(id: Int): [Workout]
   activities: [Activity]
   getAllReports: [Report]
+  getWorkoutGoals(id: Int!): [String]
+  getUserStreak(id: Int!): JSONString
   getHourlyAverageCapacitiesByFacilityId(facilityId: Int): [HourlyAverageCapacity]
 }
 
@@ -230,7 +244,9 @@ type User {
   email: String
   netId: String!
   name: String!
-  workoutGoal: [DayOfWeekGraphQLEnum]
+  activeStreak: Int
+  maxStreak: Int
+  workoutGoal: [DayOfWeekEnum]
   giveaways: [Giveaway]
 }
 

src/models/user.py

@@ -14,6 +14,9 @@ class User(Base):
         - `net_id`                                The user's Net ID.
         - `name`                                  The user's name.
         - `workout_goal`                          The days of the week the user has set as their personal goal.
+        - `active_streak`                         The number of consecutive weeks the user has met their personal goal.
+        - `max_streak`                            The maximum number of consecutive weeks the user has met their personal goal.
+        - `workout_goal`                          The max number of weeks the user has met their personal goal.
     """
 
     __tablename__ = "users"
@@ -23,4 +26,6 @@ class User(Base):
     giveaways = relationship("Giveaway", secondary="giveaway_instance", back_populates="users")
     net_id = Column(String, nullable=False)
     name = Column(String, nullable=False)
+    active_streak = Column(Integer, nullable=True)
+    max_streak = Column(Integer, nullable=True)
     workout_goal = Column(ARRAY(Enum(DayOfWeekEnum)), nullable=True)

src/schema.py

@@ -185,7 +185,6 @@ def resolve_pricing(self, info):
 class User(SQLAlchemyObjectType):
     class Meta:
         model = UserModel
-    workout_goal = graphene.List(DayOfWeekGraphQLEnum)
 
 
 class UserInput(graphene.InputObjectType):
@@ -241,6 +240,8 @@ class Query(graphene.ObjectType):
     get_workouts_by_id = graphene.List(Workout, id=graphene.Int(), description="Get all of a user's workouts by ID.")
     activities = graphene.List(Activity)
     get_all_reports = graphene.List(Report, description="Get all reports.")
+    get_workout_goals = graphene.List(graphene.String, id=graphene.Int(required=True), description="Get the workout goals of a user by ID.")
+    get_user_streak = graphene.Field(graphene.JSONString, id=graphene.Int(required=True), description="Get the current and max workout streak of a user.")
     get_hourly_average_capacities_by_facility_id = graphene.List(
         HourlyAverageCapacity, facility_id=graphene.Int(), description="Get all facility hourly average capacities."
     )
@@ -296,15 +297,60 @@ def resolve_get_weekly_workout_days(self, info, id):
     def resolve_get_all_reports(self, info):
         query = ReportModel.query.all()
         return query
+    
+    def resolve_get_workout_goals(self, info, id):
+        user = User.get_query(info).filter(UserModel.id == id).first()
+        if not user:
+            raise GraphQLError("User with the given ID does not exist.")
+
+        return [day.value for day in user.workout_goal] if user.workout_goal else []
+    
+    def resolve_get_user_streak(self, info, id):
+        user = User.get_query(info).filter(UserModel.id == id).first()
+        if not user:
+            raise GraphQLError("User with the given ID does not exist.")
 
+        workouts = (
+            Workout.get_query(info)
+            .filter(WorkoutModel.user_id == user.id)
+            .order_by(WorkoutModel.workout_time.desc())
+            .all()
+        )
+
+        if not workouts:
+            return {"active_streak": 0, "max_streak": 0}
+
+        workout_dates = {workout.workout_time.date() for workout in workouts}
+        sorted_dates = sorted(workout_dates, reverse=True)
+
+        today = datetime.utcnow().date()
+        active_streak = 0
+        max_streak = 0
+        streak = 0
+        prev_date = None
+
+        for date in sorted_dates:
+            if prev_date and (prev_date - date).days > 1:
+                max_streak = max(max_streak, streak)
+                streak = 0
+
+            streak += 1
+            prev_date = date
+
+            if date == today or (date == today - timedelta(days=1) and active_streak == 0):
+                active_streak = streak
+
+        max_streak = max(max_streak, streak)
+
+        return {"active_streak": active_streak, "max_streak": max_streak}
+    
     def resolve_get_hourly_average_capacities_by_facility_id(self, info, facility_id):
         valid_facility_ids = [14492437, 8500985, 7169406, 10055021, 2323580, 16099753, 15446768, 12572681]
         if facility_id not in valid_facility_ids:
             raise GraphQLError("Invalid facility ID.")
         query = HourlyAverageCapacity.get_query(info).filter(HourlyAverageCapacityModel.facility_id == facility_id)
         return query.all()
 
-
 # MARK: - Mutation
 
 

src/utils/utils.py

@@ -7,6 +7,7 @@
 from src.models.gym import Gym
 from src.models.facility import Facility, FacilityType
 from src.models.amenity import Amenity, AmenityType
+from src.models.workout import Workout
 from src.utils.constants import ASSET_BASE_URL, EASTERN_TIMEZONE
 
 
@@ -140,3 +141,54 @@ def get_facility_id(name):
     """
     facility = Facility.query.filter_by(name=name).first()
     return facility.id
+
+def calculate_streaks(user, workouts, workout_goal):
+    """
+    Calculate the current and maximum workout streaks for a user.
+
+    Parameters:
+        - `user`          The user object.
+        - `workouts`      The user's list of completed workouts.
+        - `workout_goal`  A list of goal days (e.g., ['Monday', 'Wednesday']).
+
+    Returns:
+        - Updates `user.active_streak` and `user.max_streak`.
+    """
+    if not workouts:
+        user.active_streak = 0
+        user.max_streak = user.max_streak or 0
+        return
+
+    # Convert goal days to set of weekday numbers (Monday=0, Sunday=6)
+    goal_days = {time.strptime(day, "%A").tm_wday for day in workout_goal}
+
+    # Filter workouts to only include those on goal days
+    valid_workouts = [w for w in workouts if w.workout_time.weekday() in goal_days]
+
+    # Sort by workout date
+    valid_workouts.sort(key=lambda x: x.workout_time)
+
+    active_streak = 1
+    max_streak = user.max_streak or 0
+
+    for i in range(1, len(valid_workouts)):
+        prev_day = valid_workouts[i - 1].workout_time
+        curr_day = valid_workouts[i].workout_time
+
+        # Find the next expected goal day
+        expected_next_day = prev_day + timedelta(days=1)
+        while expected_next_day.weekday() not in goal_days:
+            expected_next_day += timedelta(days=1)
+
+        # Check if current workout is on the expected next goal day
+        if curr_day.date() == expected_next_day.date():
+            active_streak += 1
+        else:
+            max_streak = max(max_streak, active_streak)
+            active_streak = 1
+
+    # Final update
+    max_streak = max(max_streak, active_streak)
+    user.active_streak = active_streak
+    user.max_streak = max_streak
+