Merge pull request #201 from stuartcampbell/maintenance

Maintenance tasks before release

Author: stuartcampbell

scripts/migrate_satellite_locations.py

@@ -11,7 +11,6 @@
     ProposalsToChangeList,
     SingleProposal,
 )
-from nsls2api.api.v1.proposal_api import router
 from nsls2api.infrastructure import config
 from nsls2api.infrastructure.security import (
     generate_api_key,
@@ -25,7 +24,6 @@
 )
 from nsls2api.services import beamline_service, facility_service, proposal_service
 
-# router = fastapi.APIRouter()
 router = fastapi.APIRouter(
     dependencies=[Depends(validate_admin_role)], include_in_schema=True, tags=["admin"]
 )

src/nsls2api/api/v1/admin_api.py

@@ -29,7 +29,6 @@
 )
 from nsls2api.services.slack_service import get_conversation_details
 
-
 router = fastapi.APIRouter(dependencies=[Depends(get_current_user)])
 
 

src/nsls2api/api/v1/proposal_api.py

@@ -62,7 +62,6 @@ async def generate_api_key(username: str, usertype=ApiUserType.user):
             user=user,
             username=username,
             first_eight=secret_key[prefix_length : prefix_length + 8],
-            secret_key=secret_key,  # TODO: After development - we will not be storing this one in the database
             hashed_key=to_hash,
             expires_after=None,
         )
@@ -74,11 +73,11 @@ async def generate_api_key(username: str, usertype=ApiUserType.user):
         # Now that we have saved a new key for this user, we should invalidate any other keys
         for old_key in old_keys:
             if old_key.valid:
-                logger.info(f"Invalidating old key: {old_key.secret_key}")
+                logger.info(f"Invalidating old key: {old_key}")
                 old_key.valid = False
                 await old_key.save(link_rule=WriteRules.WRITE)
 
-        return {"key:": secret_key}
+        return {"key": secret_key}
 
     except Exception as e:
         logger.exception(e)

src/nsls2api/infrastructure/security.py

@@ -69,9 +69,6 @@ class ApiKey(beanie.Document):
     user: Link[ApiUser]
     username: str
     first_eight: pydantic.constr(min_length=8, max_length=8)
-    secret_key: (
-        str  # TODO: After development - we will not be storing this one in the database
-    )
     hashed_key: str
     note: Optional[str] = ""
     # scopes: Optional[list[str]] = pydantic.Field(..., example=["inherit"])

src/nsls2api/models/apikeys.py

@@ -42,7 +42,7 @@ async def get_username_by_id(lifenumber: str) -> Optional[str]:
         message = f"BNL People API query failed for lifenumber {lifenumber}"
         logger.exception(message)
         return None
-    logger.debug(person)
+    # logger.debug(person)
     if len(person) == 0 or len(person) > 1:
         logger.warning(
             f"BNL People could not find a person with an employee/life number of '{lifenumber}'"

src/nsls2api/services/bnlpeople_service.py

@@ -11,10 +11,10 @@
 from nsls2api.api.models.facility_model import FacilityName
 from nsls2api.api.models.proposal_model import (
     CommissioningProposalsList,
-    ProposalDiagnostics,
-    ProposalFullDetails,
     LockedProposalsList,
     ProposalChangeResultsList,
+    ProposalDiagnostics,
+    ProposalFullDetails,
     ProposalsToChangeList,
 )
 from nsls2api.infrastructure.logging import logger

src/nsls2api/services/proposal_service.py

@@ -81,6 +81,7 @@ async def worker_synchronize_dataadmins(skip_beamlines=False) -> None:
             f"Beamline Data Admin permissions synchronized in {time_taken.total_seconds():,.2f} seconds"
         )
 
+
 async def worker_synchronize_cycles_from_pass(
     facility_name: FacilityName = FacilityName.nsls2,
 ) -> None:
@@ -148,15 +149,15 @@ async def worker_synchronize_cycles_from_pass(
     today = datetime.datetime.now()
     found_cycle = await facility_service.facility_cycle_by_date(facility_name, today)
     if not found_cycle:
-        logger.warning(
-            f"No cycle found for today's date in facility {facility_name}"
-        )
+        logger.warning(f"No cycle found for today's date in facility {facility_name}")
     else:
         logger.info(
             f"Found cycle {found_cycle.name} for today's date in facility {facility_name}"
         )
         # Set the current operating cycle for the facility
-        await facility_service.set_current_operating_cycle(facility_name, found_cycle.name)
+        await facility_service.set_current_operating_cycle(
+            facility_name, found_cycle.name
+        )
         logger.info(
             f"Set current operating cycle for {facility_name} to {found_cycle.name}"
         )
@@ -221,6 +222,18 @@ async def worker_synchronize_proposal_types_from_pass(
 async def synchronize_proposal_from_pass(
     proposal_id: str, facility_name: FacilityName = FacilityName.nsls2
 ) -> None:
+    """
+    Synchronize a proposal from PASS into the local database.
+
+    This function fetches proposal details, associated SAFs, beamlines, and users from PASS,
+    and updates or inserts the corresponding Proposal document in the database.
+
+    :param proposal_id: The PASS proposal ID to synchronize.
+    :type proposal_id: str
+    :param facility_name: The facility name (FacilityName) to use for synchronization.
+    :type facility_name: FacilityName
+    :return: None
+    """
     beamline_list = []
     user_list = []
     saf_list = []
@@ -348,10 +361,13 @@ async def update_proposals_with_cycle(
     cycle_name: str, facility_name: FacilityName = FacilityName.nsls2
 ) -> None:
     """
-    Update the cycle <-> proposals mapping for the given cycle.
+    Update the mapping between cycles and proposals for the specified cycle.
 
     :param cycle_name: The name of the cycle to process proposals for.
     :type cycle_name: str
+    :param facility_name: The facility name (FacilityName) to use for synchronization.
+    :type facility_name: FacilityName
+    :return: None
     """
 
     proposal_list = await proposal_service.fetch_proposals_for_cycle(
@@ -364,7 +380,6 @@ async def update_proposals_with_cycle(
 
     for proposal_id in proposal_list:
         # Add the cycle to the Proposal object
-
         try:
             proposal = await proposal_service.proposal_by_id(proposal_id)
             if proposal is not None: