Deprecates branch_short_code, auto-refreshes default CSRF token and updates contributor section on README (#111)

Author: aditeyabaral

.github/PULL_REQUEST_TEMPLATE.md

@@ -77,7 +77,6 @@ Please provide a concise summary of the changes:
 
 - [ ] `app/app.py` – Modified `/authenticate` route logic
 - [ ] `app/pesu.py` – Updated scraping or authentication handling
-- [ ] `app/constants.py` – Added or updated constant values
 - [ ] `app/util.py` – General helper functions
 
 

.github/workflows/sync.yaml

@@ -133,7 +133,6 @@ If the authentication fails, this field will not be present in the response.
 | `prn`               | PRN of the user                                        |
 | `srn`               | SRN of the user                                        |
 | `program`           | Academic program that the user is enrolled into        |
-| `branch_short_code` | Abbreviation of the branch that the user is pursuing   |
 | `branch`            | Complete name of the branch that the user is pursuing  |
 | `semester`          | Current semester that the user is in                   |
 | `section`           | Section of the user                                    |
@@ -173,7 +172,6 @@ print(response.json())
     "prn": "PES1201800001",
     "srn": "PES1201800001",
     "program": "Bachelor of Technology",
-    "branch_short_code": "CSE",
     "branch": "Computer Science and Engineering",
     "semester": "NA",
     "section": "NA",
@@ -214,7 +212,7 @@ curl -X POST http://localhost:5000/authenticate \
 
 Made with ❤️ by
 
-[![Contributors](https://contrib.rocks/image?repo=pesu-dev/auth)](https://github.com/pesu-dev/auth/graphs/contributors)
+[![Contributors](https://contrib.rocks/image?repo=pesu-dev/auth&nocache=1)](https://github.com/pesu-dev/auth/graphs/contributors)
 
 *Powered by [contrib.rocks](https://contrib.rocks)*
 

README.md

@@ -1,6 +1,7 @@
 import argparse
 import datetime
 import logging
+import asyncio
 
 import pytz
 import uvicorn
@@ -18,6 +19,31 @@
 
 IST = pytz.timezone("Asia/Kolkata")
 README_HTML_CACHE: str | None = None
+REFRESH_INTERVAL_SECONDS = 45 * 60
+CSRF_TOKEN_REFRESH_LOCK = asyncio.Lock()
+
+
+async def _refresh_csrf_token_with_lock():
+    """
+    Refresh the CSRF token with a lock.
+    """
+    logging.debug("Refreshing unauthenticated CSRF token...")
+    async with CSRF_TOKEN_REFRESH_LOCK:
+        await pesu_academy.prefetch_client_with_csrf_token()
+        logging.info("Unauthenticated CSRF token refreshed successfully.")
+
+
+async def _csrf_token_refresh_loop():
+    """
+    Background task to refresh the CSRF token periodically.
+    """
+    while True:
+        try:
+            logging.debug("Refreshing unauthenticated CSRF token...")
+            await _refresh_csrf_token_with_lock()
+        except Exception:
+            logging.exception("Failed to refresh unauthenticated CSRF token in the background.")
+        await asyncio.sleep(REFRESH_INTERVAL_SECONDS)
 
 
 @asynccontextmanager
@@ -37,12 +63,26 @@ async def lifespan(app: FastAPI):
         logging.exception(
             "Failed to generate README.html on startup. Subsequent requests to /readme will attempt to regenerate it."
         )
+
     # Prefetch PESUAcademy client for first request
     await pesu_academy.prefetch_client_with_csrf_token()
     logging.info("Prefetched a new PESUAcademy client with an unauthenticated CSRF token.")
+
+    # Start the periodic CSRF token refresh background task
+    refresh_task = asyncio.create_task(_csrf_token_refresh_loop())
+    logging.info("Started the unauthenticated CSRF token refresh background task.")
+
     yield
 
     # Shutdown
+    refresh_task.cancel()
+    try:
+        await refresh_task
+    except asyncio.CancelledError:
+        logging.debug("Unauthenticated CSRF token refresh background task cancelled.")
+    except Exception:
+        logging.exception("Failed to cancel unauthenticated CSRF token refresh background task.")
+
     await pesu_academy.close_client()
     logging.info("PESUAuth API shutdown.")
 
@@ -164,7 +204,7 @@ async def authenticate(payload: RequestModel, background_tasks: BackgroundTasks)
         )
     )
     # Prefetch a new client with an unauthenticated CSRF token for the next request
-    background_tasks.add_task(pesu_academy.prefetch_client_with_csrf_token)
+    background_tasks.add_task(_refresh_csrf_token_with_lock)
 
     # Validate the response
     try:

app/app.py

@@ -29,12 +29,6 @@ class ProfileModel(BaseModel):
         description="Academic program that the user is enrolled in.",
         json_schema_extra={"example": "Bachelor of Technology"},
     )
-    branch_short_code: str | None = Field(
-        None,
-        title="Branch Short Code",
-        description="Abbreviation of the branch the user is pursuing.",
-        json_schema_extra={"example": "CSE"},
-    )
     branch: str | None = Field(
         None,
         title="Branch",

app/constants.py

@@ -1,5 +1,5 @@
 from pydantic import BaseModel, field_validator, ConfigDict, Field
-from app.constants import PESUAcademyConstants
+from app.pesu import PESUAcademy
 from typing import Literal
 
 
@@ -27,7 +27,7 @@ class RequestModel(BaseModel):
         json_schema_extra={"example": True},
     )
 
-    fields: list[Literal[*PESUAcademyConstants.DEFAULT_FIELDS]] | None = Field(
+    fields: list[Literal[*PESUAcademy.DEFAULT_FIELDS]] | None = Field(
         None,
         title="Profile Fields",
         description=(

app/models/profile.py

@@ -6,7 +6,6 @@
 
 import httpx
 from selectolax.parser import HTMLParser, Node
-from app.constants import PESUAcademyConstants
 
 from app.exceptions.authentication import (
     ProfileFetchError,
@@ -21,6 +20,20 @@ class PESUAcademy:
     Class to interact with the PESU Academy website.
     """
 
+    DEFAULT_FIELDS: list[str] = [
+        "name",
+        "prn",
+        "srn",
+        "program",
+        "branch",
+        "semester",
+        "section",
+        "email",
+        "phone",
+        "campus_code",
+        "campus",
+    ]
+
     PROFILE_PAGE_HEADER_TO_KEY_MAP = {
         "Name": "name",
         "PESU Id": "prn",
@@ -108,13 +121,6 @@ def parse_and_update():
             if mapped_key := self.PROFILE_PAGE_HEADER_TO_KEY_MAP.get(key):
                 logging.debug(f"Adding key: '{mapped_key}', value: '{value}' to profile...")
                 profile[mapped_key] = value
-                if mapped_key == "branch" and (
-                    branch_short_code := self.map_branch_to_short_code(value)
-                ):
-                    profile["branch_short_code"] = branch_short_code
-                    logging.debug(
-                        f"Adding key: 'branch_short_code', value: '{branch_short_code}' to profile..."
-                    )
             else:
                 raise ProfileParseError(
                     f"Unknown key: '{key}' in the profile page. The webpage might have changed."
@@ -132,22 +138,6 @@ async def close_client(self):
             await self._client.aclose()
             self._client = None
 
-    @staticmethod
-    def map_branch_to_short_code(branch: str) -> str | None:
-        """
-        Map the branch name to its short code.
-
-        Args:
-            branch (str): The full name of the branch.
-
-        Returns:
-            Optional[str]: The short code for the branch if it exists, otherwise None.
-        """
-        logging.warning(
-            "Branch short code mapping will be deprecated in future versions. If you require acronyms, please do it application-side."
-        )
-        return PESUAcademyConstants.BRANCH_SHORT_CODES.get(branch)
-
     async def get_profile_information(
         self, client: httpx.AsyncClient, username: str
     ) -> dict[str, Any]:
@@ -253,9 +243,9 @@ async def authenticate(
             dict[str, Any]: A dictionary containing the authentication status, message, and optionally the profile information.
         """
         # Default fields to fetch if fields is not provided
-        fields = PESUAcademyConstants.DEFAULT_FIELDS if fields is None else fields
+        fields = self.DEFAULT_FIELDS if fields is None else fields
         # Check if fields is not the default fields and enable field filtering
-        field_filtering = fields != PESUAcademyConstants.DEFAULT_FIELDS
+        field_filtering = fields != self.DEFAULT_FIELDS
 
         logging.info(
             f"Connecting to PESU Academy with user={username}, profile={profile}, fields={fields} ..."

app/models/request.py

@@ -38,6 +38,12 @@ def test_response(response: dict, no_profile: bool) -> bool:
         default=10,
         help="The base interval between requests (default: 10 minutes)",
     )
+    parser.add_argument(
+        "--start-delay",
+        type=int,
+        default=0,
+        help="The delay before starting the benchmark (default: 0 minutes)",
+    )
     parser.add_argument(
         "--output",
         type=str,
@@ -49,7 +55,16 @@ def test_response(response: dict, no_profile: bool) -> bool:
     )
     args = parser.parse_args()
 
-    request_count, success, times, waiting_times = 0, list(), list(), [0]
+    request_count, success, times, waiting_times = 0, list(), list(), [args.start_delay * 60]
+
+    for _ in tqdm(
+        range(args.start_delay * 60),
+        desc=f"Waiting {args.start_delay} minutes before starting the benchmark",
+        leave=False,
+        unit="s",
+    ):
+        time.sleep(1)
+
     while True:
         request_count += 1
         response, elapsed = make_request(