sorting string validation

Author: MVarshini

backend/app/api/v1/commons/constants.py

@@ -0,0 +1,23 @@
+# Define the keywords for sorting.
+DIRECTIONS = ("asc", "desc")
+FIELDS = (
+    "ciSystem.keyword",
+    "benchmark.keyword",
+    "ocpVersion.keyword",
+    "releaseStream.keyword",
+    "platform.keyword",
+    "networkType.keyword",
+    "ipsec.keyword",
+    "fips.keyword",
+    "encrypted.keyword",
+    "publish.keyword",
+    "computeArch.keyword",
+    "controlPlaneArch.keyword",
+    "jobStatus.keyword",
+    "startDate",
+    "endDate",
+    "workerNodesCount",
+    "masterNodesCount",
+    "infraNodesCount",
+    "totalNodesCount",
+)

backend/app/api/v1/commons/utils.py

@@ -1,6 +1,7 @@
 from app.services.search import ElasticService
 from fastapi import HTTPException, status
 import re
+import app.api.v1.commons.constants as constants
 
 
 async def getMetadata(uuid: str, configpath: str):
@@ -80,15 +81,18 @@ def build_sort_terms(sort_string: str) -> list[dict[str, str]]:
     :return: list, transformed sort structure or raises a ValueError for invalid input
 
     """
-
-    pattern = r"^([\w]+):(asc|desc)$"
-    match = re.match(pattern, sort_string)
-
-    if not match:
-        raise HTTPException(
-            status.HTTP_400_BAD_REQUEST,
-            f"Invalid sort string format. Expected 'sort=key:direction' with direction as 'asc' or 'desc'.",
-        )
-
-    key, direction = match.groups()
-    return [{key: {"order": direction}}]
+    sort_terms = []
+    if sort_string:
+        key, dir = sort_string.split(":", maxsplit=1)
+        if dir not in constants.DIRECTIONS:
+            raise HTTPException(
+                status.HTTP_400_BAD_REQUEST,
+                f"Sort direction {dir!r} must be one of {','.join(constants.DIRECTIONS)}",
+            )
+        if key not in constants.FIELDS:
+            raise HTTPException(
+                status.HTTP_400_BAD_REQUEST,
+                f"Sort key {key!r} must be one of {','.join(constants.FIELDS)}",
+            )
+        sort_terms.append({f"{key}": {"order": dir}})
+    return sort_terms

backend/app/api/v1/endpoints/ocp/ocpJobs.py

@@ -12,7 +12,7 @@
 @router.get(
     "/api/v1/ocp/jobs",
     summary="Returns a job list",
-    description="Returns a list of jobs in the specified dates of requested size. \
+    description="Returns a list of jobs in the specified dates. \
             If not dates are provided the API will default the values. \
             `startDate`: will be set to the day of the request minus 5 days.\
             `endDate`: will be set to the day of the request.",
@@ -51,7 +51,8 @@ async def jobs(
             ),
             status_code=422,
         )
-
+    if not sort:
+        sort = None
     if offset and not size:
         raise HTTPException(400, f"offset {offset} specified without size")
     elif not offset and not size:
@@ -60,7 +61,9 @@ async def jobs(
     elif not offset:
         offset = 0
 
-    results = await getData(start_date, end_date, size, offset, "ocp.elasticsearch")
+    results = await getData(
+        start_date, end_date, size, offset, sort, "ocp.elasticsearch"
+    )
     jobs = []
     if "data" in results and len(results["data"]) >= 1:
         jobs = results["data"].to_dict("records")

backend/app/api/v1/endpoints/quay/quayJobs.py

@@ -32,7 +32,7 @@ async def jobs(
         description="End date for searching jobs, format: 'YYYY-MM-DD'",
         examples=["2020-11-15"],
     ),
-    pretty: bool = Query(False, description="Output contet in pretty format."),
+    pretty: bool = Query(False, description="Output content in pretty format."),
     size: int = Query(None, description="Number of jobs to fetch"),
     offset: int = Query(None, description="Offset Number to fetch jobs from"),
     sort: str = Query(None, description="To sort fields on specified direction"),
@@ -60,7 +60,12 @@ async def jobs(
     elif not offset:
         offset = 0
 
-    results = await getData(start_date, end_date, size, offset, "quay.elasticsearch")
+    if not sort:
+        sort = None
+
+    results = await getData(
+        start_date, end_date, size, offset, sort, "quay.elasticsearch"
+    )
 
     jobs = []
     if "data" in results and len(results["data"]) >= 1:

backend/app/services/splunk.py

@@ -45,8 +45,6 @@ async def query(
         """
         query["count"] = size
         query["offset"] = offset
-        query["sort_dir"] = "asc"
-        query["sort_key"] = "test_type"
 
         # If additional search parameters are provided, include those in searchindex
         searchindex = (

frontend/src/actions/commonActions.js

@@ -141,7 +141,6 @@ export const getSelectedFilter =
 
 export const getRequestParams = (type) => (dispatch, getState) => {
   const { start_date, end_date, size, offset, sort } = getState()[type];
-  // const sortParam = `${activeSortIndex}:${activeSortDir}`;
   const params = {
     pretty: true,
     ...(start_date && { start_date }),

frontend/src/reducers/ocpReducer.js

@@ -48,7 +48,6 @@ const initialState = {
   size: DEFAULT_PER_PAGE,
   offset: INITAL_OFFSET,
   totalJobs: 0,
-  //tableData: [],
   filterData: [],
   categoryFilterValue: "",
   filterOptions: [],