Add facility to sync functions

src/nsls2api/api/v1/facility_api.py

@@ -62,17 +62,12 @@ async def get_facility_cycles(facility: FacilityName):
     include_in_schema=True,
 )
 async def get_proposals_for_cycle(facility: FacilityName, cycle: str):
-    if facility.name != "nsls2":
-        # TODO: Add other facilities
-        return fastapi.responses.JSONResponse(
-            {"message": f"Not implemented for the {facility.name} facility."},
-            status_code=501,
-        )
-
-    proposal_list = await proposal_service.fetch_proposals_for_cycle(cycle)
+    proposal_list = await proposal_service.fetch_proposals_for_cycle(cycle, facility)
     if proposal_list is None:
         return fastapi.responses.JSONResponse(
-            {"error": f"No proposals were found for cycle {cycle}"},
+            {
+                "error": f"No proposals were found for cycle {cycle} for facility {facility.name}"
+            },
             status_code=404,
         )
     model = CycleProposalList(

src/nsls2api/api/v1/jobs_api.py

@@ -13,7 +13,8 @@
 )
 from nsls2api.services import background_service
 
-SYNC_ROUTES_IN_SCHEMA = False
+# TODO: This flag should be automatically set to be True for development but False for production.
+SYNC_ROUTES_IN_SCHEMA = True
 
 router = fastapi.APIRouter(tags=["jobs"])
 
@@ -82,9 +83,29 @@ async def sync_proposal_types(facility: FacilityName = FacilityName.nsls2):
     dependencies=[Depends(get_current_user)],
     include_in_schema=SYNC_ROUTES_IN_SCHEMA,
     tags=["sync"],
+    deprecated=True,
 )
-async def sync_proposals_for_cycle(request: Request, cycle: str) -> BackgroundJob:
-    sync_params = JobSyncParameters(cycle=cycle)
+async def sync_proposals_for_cycle(
+    request: Request, cycle: str, facility: FacilityName = FacilityName.nsls2
+) -> BackgroundJob:
+    sync_params = JobSyncParameters(cycle=cycle, facility=facility)
+    job = await background_service.create_background_job(
+        JobActions.synchronize_proposals_for_cycle,
+        sync_parameters=sync_params,
+    )
+    return job
+
+
+@router.get(
+    "/sync/facility/{facility}/cycle/{cycle}/proposals",
+    dependencies=[Depends(get_current_user)],
+    include_in_schema=SYNC_ROUTES_IN_SCHEMA,
+    tags=["sync"],
+)
+async def sync_proposals_for_facility_cycle(
+    request: Request, facility: FacilityName, cycle: str
+) -> BackgroundJob:
+    sync_params = JobSyncParameters(cycle=cycle, facility=facility)
     job = await background_service.create_background_job(
         JobActions.synchronize_proposals_for_cycle,
         sync_parameters=sync_params,
@@ -108,6 +129,7 @@ async def sync_cycles(facility: FacilityName = FacilityName.nsls2):
     "/sync/update-cycles/{facility}",
     include_in_schema=SYNC_ROUTES_IN_SCHEMA,
     tags=["sync"],
+    summary="Updates the local (nsls2core DB) cycle <-> proposal mapping",
 )
 async def sync_update_cycles(
     request: fastapi.Request,

src/nsls2api/api/v1/proposal_api.py

@@ -1,4 +1,3 @@
-from http.client import HTTPException
 from typing import Annotated
 
 import fastapi

src/nsls2api/services/background_service.py

@@ -130,10 +130,10 @@ async def worker_function():
                     )
                 case JobActions.synchronize_proposals_for_cycle:
                     logger.info(
-                        f"Processing job {job.id} to synchronize proposals for cycle {job.sync_parameters.cycle} (from {job.sync_parameters.sync_source})."
+                        f"Processing job {job.id} to synchronize proposals for the {job.sync_parameters.facility} facility's cycle {job.sync_parameters.cycle} (from {job.sync_parameters.sync_source})."
                     )
                     await sync_service.worker_synchronize_proposals_for_cycle_from_pass(
-                        job.sync_parameters.cycle
+                        job.sync_parameters.cycle, job.sync_paramters.facility
                     )
                 case JobActions.synchronize_proposal_types:
                     logger.info(

src/nsls2api/services/pass_service.py

@@ -122,11 +122,11 @@ async def get_saf_from_proposal(
 
 
 async def get_commissioning_proposals_by_year(
-    year: str, facility: FacilityName = FacilityName.nsls2
+    year: str, facility_name: FacilityName = FacilityName.nsls2
 ) -> Optional[list[PassProposal]]:
-    pass_facility = await facility_service.pass_id_for_facility(facility)
+    pass_facility = await facility_service.pass_id_for_facility(facility_name)
     if not pass_facility:
-        error_message: str = f"Facility {facility} does not have a PASS ID."
+        error_message: str = f"Facility {facility_name} does not have a PASS ID."
         logger.error(error_message)
         raise PassException(error_message)
 
@@ -142,11 +142,11 @@ async def get_commissioning_proposals_by_year(
                     PassProposal(**commissioning_proposal)
                 )
     except ValidationError as error:
-        error_message = f"Error validating commissioning proposal data received from PASS for year {str(year)} at {facility} facility."
+        error_message = f"Error validating commissioning proposal data received from PASS for year {str(year)} at {facility_name} facility."
         logger.error(error_message)
         raise PassException(error_message) from error
     except Exception as error:
-        error_message = f"Error retrieving commissioning proposal information from PASS for year {str(year)} at {facility} facility."
+        error_message = f"Error retrieving commissioning proposal information from PASS for year {str(year)} at {facility_name} facility."
         logger.exception(error_message)
         raise PassException(error_message) from error
 

src/nsls2api/services/proposal_service.py

@@ -74,8 +74,12 @@ async def recently_updated(count=5, beamline: str | None = None):
 #     return result
 
 
-async def fetch_proposals_for_cycle(cycle_name: str) -> list[str]:
-    cycle = await Cycle.find_one(Cycle.name == cycle_name)
+async def fetch_proposals_for_cycle(
+    cycle_name: str, facility_name: FacilityName = FacilityName.nsls2
+) -> list[str]:
+    cycle = await Cycle.find_one(
+        Cycle.name == cycle_name, Cycle.facility == facility_name
+    )
     if cycle is None:
         raise LookupError(f"Cycle {cycle} not found in local database.")
     return cycle.proposals

src/nsls2api/services/sync_service.py

@@ -317,17 +317,23 @@ async def synchronize_proposal_from_pass(proposal_id: str) -> None:
     logger.debug(f"Response: {response}")
 
 
-async def update_proposals_with_cycle(cycle_name: str) -> None:
+async def update_proposals_with_cycle(
+    cycle_name: str, facility_name: FacilityName = FacilityName.nsls2
+) -> None:
     """
     Update the cycle <-> proposals mapping for the given cycle.
 
     :param cycle_name: The name of the cycle to process proposals for.
     :type cycle_name: str
     """
 
-    proposal_list = await proposal_service.fetch_proposals_for_cycle(cycle_name)
+    proposal_list = await proposal_service.fetch_proposals_for_cycle(
+        cycle_name, facility_name=facility_name
+    )
 
-    logger.info(f"Found {len(proposal_list)} proposals for cycle {cycle_name}.")
+    logger.info(
+        f"Found {len(proposal_list)} proposals for {facility_name} cycle {cycle_name}."
+    )
 
     for proposal_id in proposal_list:
         # Add the cycle to the Proposal object
@@ -352,21 +358,29 @@ async def worker_synchronize_proposal_from_pass(proposal_id: str) -> None:
     )
 
 
-async def worker_synchronize_proposals_for_cycle_from_pass(cycle: str) -> None:
+async def worker_synchronize_proposals_for_cycle_from_pass(
+    cycle: str, facility_name: FacilityName = FacilityName.nsls2
+) -> None:
     start_time = datetime.datetime.now()
 
-    cycle_year = await facility_service.cycle_year(cycle)
+    cycle_year = await facility_service.cycle_year(cycle, facility_name=facility_name)
 
-    proposals = await proposal_service.fetch_proposals_for_cycle(cycle)
-    logger.info(f"Synchronizing {len(proposals)} proposals for {cycle} cycle.")
+    proposals = await proposal_service.fetch_proposals_for_cycle(
+        cycle, facility_name=facility_name
+    )
+    logger.info(
+        f"Synchronizing {len(proposals)} proposals for facility {facility_name} in {cycle} cycle."
+    )
 
     for proposal_id in proposals:
         logger.info(f"Synchronizing proposal {proposal_id}.")
         await synchronize_proposal_from_pass(proposal_id)
 
     commissioning_proposals: list[
         PassProposal
-    ] = await pass_service.get_commissioning_proposals_by_year(cycle_year)
+    ] = await pass_service.get_commissioning_proposals_by_year(
+        cycle_year, facility_name=facility_name
+    )
     logger.info(
         f"Synchronizing {len(proposals)} commissioning proposals for the year {cycle_year}."
     )
@@ -375,7 +389,7 @@ async def worker_synchronize_proposals_for_cycle_from_pass(cycle: str) -> None:
         await synchronize_proposal_from_pass(str(proposal.Proposal_ID))
 
     # Now update the cycle information for each proposal
-    await update_proposals_with_cycle(cycle)
+    await update_proposals_with_cycle(cycle, facility_name=facility_name)
 
     time_taken = datetime.datetime.now() - start_time
     logger.info(