integrate notification to optimizer output

controllers/v2/optimiser/api.py

@@ -1,6 +1,7 @@
 from flask_restful import Resource, marshal_with, reqparse
 from .response_models import optimiser_response_model
 from repository.shift_repository import ShiftRepository
+from repository.fcm_token_repository import FCMTokenRepository
 from services.jwk import requires_auth, is_user_or_has_role
 from domain import UserType, session_scope
 from controllers.v2.v2_blueprint import v2_api
@@ -37,6 +38,25 @@ def post(self):
                 result = optimiser.solve()
                 optimiser.save_result(result)
 
+                # Extract user id from result
+                user_id_list = optimiser.extract_user_ids_from_result(result)
+
+                # check if there is no user
+                if not user_id_list:
+                    logging.info("No users found to notify.")
+                else:
+                    # Initialize FCM token repository for retrieving token and notifying user
+                    fcm_token_repo = FCMTokenRepository()
+
+                    # Loop through user id, retrieve token and send message
+                    for user_id in user_id_list:
+                        title = "New Shift Assignment"
+                        body = "You have been assigned to a new shift."
+                        try:
+                            fcm_token_repo.notify_user(user_id=user_id, title=title, body=body)
+                        except Exception as e:
+                            logging.error(f"Error sending notification to user {user_id}: {e}")
+
                 # Return raw data, the marshaller will format it
                 return {
                     "message": "Optimisation completed successfully",

services/optimiser/optimiser.py

@@ -1,4 +1,6 @@
 import logging
+from typing import List
+
 import minizinc
 from sqlalchemy import orm
 from datetime import datetime
@@ -214,3 +216,29 @@ def save_result(self, result) -> None:
         except Exception as e:
             logging.error(f"Error processing result data: {e}")
             raise  # Rethrow the exception after logging
+
+    def extract_user_ids_from_result(self, result) -> List[int]:
+        """
+        Extract the user IDs of volunteers assigned to shift based on the result of optimiser
+
+        :param result: The result of optimiser
+        :return: A list of user ids
+        """
+        user_id_list = []
+
+        try:
+            # Loop through over shifts, volunteers and roles in result
+            for shift_index, shift_assignment in enumerate(result["possible_assignment"]):
+                for volunteer_index, volunteer_assignments in enumerate(shift_assignment):
+                    for role_index, is_assigned in enumerate(volunteer_assignments):
+                        if is_assigned:
+                            user = self.calculator.get_volunteer_by_index(volunteer_index)
+
+                            # avoid duplicate
+                            if user.id not in user_id_list:
+                                user_id_list.append(user.id)
+
+        except Exception as e:
+            logging.error(f"Error extracting user IDs from result: {e}")
+
+        return user_id_list