Merge pull request #23 from stuartcampbell/current-cycle

Add endpoint to return the current operating cycle for a facility

src/nsls2api/api/models/facility_model.py

@@ -1,7 +1,15 @@
 from enum import Enum
-
+import pydantic
 
 class FacilityName(Enum):
     nsls2 = "nsls2"
     lbms = "lbms"
     cfn = "cfn"
+
+class FacilityCyclesResponseModel(pydantic.BaseModel):
+    facility: str
+    cycles: list[str]
+
+class FacilityCurrentOperatingCycleResponseModel(pydantic.BaseModel):
+    facility: str
+    cycle: str

src/nsls2api/api/v1/facility_api.py

@@ -1,28 +1,59 @@
 import fastapi
 
-from nsls2api.api.models.facility_model import FacilityName
+from nsls2api.api.models.facility_model import (
+    FacilityName,
+    FacilityCyclesResponseModel,
+    FacilityCurrentOperatingCycleResponseModel,
+)
 from nsls2api.services import proposal_service, facility_service
 
 router = fastapi.APIRouter()
 
 
 # TODO: Add back into schema when implemented.
 @router.get(
-    "/facility/{facility}/cycles/current", response_model=str, include_in_schema=False
+    "/facility/{facility}/cycles/current",
+    response_model=FacilityCurrentOperatingCycleResponseModel,
+    include_in_schema=True,
 )
-async def get_current_facilty_cycle(facility: FacilityName):
-    return "2024-1"
+async def get_current_operating_cycle(facility: FacilityName):
+    current_cycle = await facility_service.current_operating_cycle(facility.name)
+    if current_cycle is None:
+        return fastapi.responses.JSONResponse(
+            {
+                "error": f"No current operating cycle was found for facility {facility.name}"
+            },
+            status_code=404,
+        )
+
+    # TODO: Maybe add a health check here
+    # print("Are we healthy ? ")
+    # print(await facility_service.is_healthy(facility.name))
+
+    response_model = FacilityCurrentOperatingCycleResponseModel(
+        facility=facility.name, cycle=current_cycle
+    )
 
-@router.get("/facility/{facility}/cycles", include_in_schema=True)
+    return response_model
+
+
+@router.get(
+    "/facility/{facility}/cycles",
+    response_model=FacilityCyclesResponseModel,
+    include_in_schema=True,
+)
 async def get_facility_cycles(facility: FacilityName):
     cycle_list = await facility_service.facility_cycles(facility.name)
     if cycle_list is None:
         return fastapi.responses.JSONResponse(
             {"error": f"No cycles were found for facility {facility.name}"},
             status_code=404,
         )
-    data = {"facility": facility.name, "cycles": cycle_list}
-    return data
+    response_model = FacilityCyclesResponseModel(
+        facility=facility.name, cycles=cycle_list
+    )
+    return response_model
+
 
 @router.get("/facility/{facility}/cycle/{cycle}/proposals", include_in_schema=True)
 async def get_proposals_for_cycle(facility: FacilityName, cycle: str):

src/nsls2api/models/cycles.py

@@ -8,6 +8,7 @@
 class Cycle(beanie.Document):
     name: str
     accepting_proposals: Optional[bool]
+    is_current_operating_cycle: bool = False
     active: bool = False
     end_date: Optional[datetime.datetime]
     facility: str

src/nsls2api/services/facility_service.py

@@ -33,3 +33,23 @@ async def data_roles_by_user(username: str) -> Optional[list[str]]:
     facilities = await Facility.find(In(Facility.data_admins, [username])).to_list()
     facility_names = [f.facility_id for f in facilities if f.facility_id is not None]
     return facility_names
+
+
+async def current_operating_cycle(facility: str) -> Optional[str]:
+    """
+    Current Operating Cycle
+
+    This method retrieves the current operating cycle for a given facility.
+
+    :param facility: The facility name (str).
+    :return: The current operating cycle (str) or None if no current operating cycle is found.
+    """
+    cycle = await Cycle.find_one(
+        Cycle.facility == facility,
+        Cycle.is_current_operating_cycle == True,  # noqa: E712
+    )
+
+    if cycle is None:
+        return None
+
+    return cycle.name