Fix Side Drawer Advance Filters (CRASM-967)

backend/src/xfd_django/xfd_api/api_methods/search.py

@@ -148,6 +148,7 @@ async def search_post(search_body: DomainSearchBody, current_user):
                 for hit in response["hits"]["hits"]
             ],
         },
+        "aggregations": response.get("aggregations", {}),
     }
 
     return result

backend/src/xfd_django/xfd_api/helpers/elastic_search.py

@@ -44,8 +44,7 @@ def get_term_filter_value(field, field_value):
     """
     Determine the appropriate term filter value based on the field and its value.
 
-    Handles specific cases for boolean values, 'organization.regionId', numeric values,
-    and the 'name' field.
+    Handles specific cases for boolean values, 'organization.regionId', numeric values, the 'name' field, and 'vulnerabilities.severity'.
     """
     if field_value in ["false", "true"]:
         return {field: field_value == "true"}
@@ -55,6 +54,8 @@ def get_term_filter_value(field, field_value):
         return {field: field_value}
     if field == "name" and field_value and "*" not in field_value:
         field_value = "*{}*".format(field_value)
+    if field == "vulnerabilities.severity":
+        return {field: field_value.lower()}
     return {"{}.keyword".format(field): field_value}
 
 
@@ -75,6 +76,28 @@ def get_term_filter(term_filter):
     elif term_filter["field"] == "organization.regionId":
         search_type = "terms"
 
+    reg_values = [
+        "Low",
+        "low",
+        "Medium",
+        "medium",
+        "High",
+        "high",
+        "Critical",
+        "critical",
+    ]
+    na_values = [
+        "N/A",
+        "n/a",
+        "Null",
+        "null",
+        "None",
+        "none",
+        "",
+        "Undefined",
+        "undefined",
+    ]
+
     if term_filter["type"] == "any":
         if term_filter["field"] == "organization.regionId" and term_filter["values"]:
             search = {
@@ -89,6 +112,61 @@ def get_term_filter(term_filter):
                     "minimum_should_match": 1,
                 }
             }
+
+        # Handle grouping of N/A values for 'vulnerabilities.severity' field. #
+
+        elif (
+            term_filter["field"] == "vulnerabilities.severity"
+            and "N/A" in term_filter["values"]
+        ):
+            search = {
+                "bool": {
+                    "should": [
+                        {"terms": {"vulnerabilities.severity.keyword": na_values}},
+                        {
+                            "bool": {
+                                "must_not": [
+                                    {
+                                        "exists": {
+                                            "field": "vulnerabilities.severity.keyword"
+                                        }
+                                    }
+                                ]
+                            }
+                        },
+                    ],
+                    "minimum_should_match": 1,
+                }
+            }
+        # Handle grouping of 'Other' values for 'vulnerabilities.severity' field. #
+        elif (
+            term_filter["field"] == "vulnerabilities.severity"
+            and "Other" in term_filter["values"]
+        ):
+            search = {
+                "bool": {
+                    "must_not": [
+                        {
+                            "terms": {
+                                "vulnerabilities.severity.keyword": reg_values
+                                + na_values
+                            }
+                        },
+                        {
+                            "bool": {
+                                "must_not": [
+                                    {
+                                        "exists": {
+                                            "field": "vulnerabilities.severity.keyword"
+                                        }
+                                    }
+                                ]
+                            }
+                        },
+                    ],
+                }
+            }
+
         else:
             search = {
                 "bool": {
@@ -230,7 +308,11 @@ def build_request(state, options: Dict[str, Any]) -> Dict[str, Any]:
                 "nested": {"path": "vulnerabilities"},
                 "aggs": {
                     "severity": {
-                        "terms": {"field": "vulnerabilities.severity.keyword"}
+                        "terms": {
+                            "field": "vulnerabilities.severity.keyword",
+                            "missing": "null",
+                            "size": 50,
+                        }
                     },
                     "cve": {"terms": {"field": "vulnerabilities.cve.keyword"}},
                 },

backend/src/xfd_django/xfd_api/schema_models/search.py

@@ -35,6 +35,7 @@ class SearchResponse(BaseModel):
     timed_out: bool
     _shards: Any
     hits: Any
+    aggregations: Any
 
 
 class DomainSearchBody(BaseModel):

backend/src/xfd_django/xfd_api/tasks/searchSync.py

@@ -141,6 +141,7 @@ def handler(command_options):
                                 "title": vulnerability.title,
                                 "cvss": vulnerability.cvss,
                                 "severity": vulnerability.severity,
+                                "cve": vulnerability.cve,
                                 "state": vulnerability.state,
                                 "substate": vulnerability.substate,
                                 "description": vulnerability.description,

backend/src/xfd_django/xfd_api/tasks/syncdb_helpers.py

@@ -197,6 +197,18 @@ def create_sample_services_and_vulnerabilities(domain):
                     "other",
                 ]
             ),
+            cve="CVE-"
+            + random.choice(
+                [
+                    "2024-47421",
+                    "2021-22501",
+                    "2024-53959",
+                    "2024-47422",
+                    "2024-47423",
+                    "2020-28163",
+                    "2020-29312",
+                ]
+            ),
             needsPopulation=True,
             state="open",
             substate="unconfirmed",

frontend/src/components/DrawerInterior.tsx

@@ -44,6 +44,15 @@ interface Props {
   initialFilters: any[];
 }
 
+interface SeverityData {
+  value: string;
+  count: number;
+}
+
+interface GroupedData {
+  [key: string]: number;
+}
+
 const FiltersApplied: React.FC = () => {
   return (
     <div className={classes.applied}>
@@ -151,26 +160,79 @@ export const DrawerInterior: React.FC<Props> = (props) => {
   );
 
   const portFacet: any[] = facets['services.port']
-    ? facets['services.port'][0].data
+    ? facets['services.port'][0].data.sort(
+        (a: { value: number }, b: { value: number }) => a.value - b.value
+      )
     : [];
 
   const fromDomainFacet: any[] = facets['fromRootDomain']
-    ? facets['fromRootDomain'][0].data
+    ? facets['fromRootDomain'][0].data.sort(
+        (a: { value: string }, b: { value: string }) =>
+          a.value.localeCompare(b.value)
+      )
     : [];
 
   const cveFacet: any[] = facets['vulnerabilities.cve']
-    ? facets['vulnerabilities.cve'][0].data
+    ? facets['vulnerabilities.cve'][0].data.sort(
+        (a: { value: string }, b: { value: string }) =>
+          a.value.localeCompare(b.value)
+      )
     : [];
 
-  const severityFacet: any[] = facets['vulnerabilities.severity']
-    ? facets['vulnerabilities.severity'][0].data
+  // To-Do: Create array(s) to handle permutations of null and N/A values
+  const titleCaseSeverityFacet = facets['vulnerabilities.severity']
+    ? facets['vulnerabilities.severity'][0].data.map(
+        (d: { value: string; count: number }) => {
+          if (d.value === null || d.value === undefined) {
+            return { value: 'N/A', count: d.count };
+          } else {
+            return {
+              value:
+                d.value[0]?.toUpperCase() + d.value.slice(1)?.toLowerCase(),
+              count: d.count
+            };
+          }
+        }
+      )
     : [];
 
-  // Always show all severities
-  for (const value of ['Critical', 'High', 'Medium', 'Low']) {
-    if (!severityFacet.find((severity) => value === severity.value))
-      severityFacet.push({ value, count: 0 });
-  }
+  const groupedData: GroupedData = titleCaseSeverityFacet
+    .map((d: SeverityData) => {
+      const severityLevels = [
+        'N/A',
+        'Low',
+        'Medium',
+        'High',
+        'Critical',
+        'Other'
+      ];
+      if (severityLevels.includes(d.value)) {
+        return d;
+      }
+      if (
+        !d.value ||
+        ['None', 'Null', 'N/a', 'Undefined', 'undefined'].includes(d.value)
+      ) {
+        return { value: 'N/A', count: d.count };
+      } else {
+        return { value: 'Other', count: d.count };
+      }
+    })
+    .reduce((acc: GroupedData, curr: SeverityData) => {
+      if (acc[curr.value]) {
+        acc[curr.value] += curr.count;
+      } else {
+        acc[curr.value] = curr.count;
+      }
+      return acc;
+    }, {});
+
+  const sortedSeverityFacets = Object.entries(groupedData)
+    .map(([value, count]) => ({ value, count }))
+    .sort((a, b) => {
+      const order = ['N/A', 'Low', 'Medium', 'High', 'Critical', 'Other'];
+      return order.indexOf(a.value) - order.indexOf(b.value);
+    });
 
   return (
     <StyledWrapper style={{ overflowY: 'auto' }}>
@@ -360,7 +422,7 @@ export const DrawerInterior: React.FC<Props> = (props) => {
           </AccordionDetails>
         </Accordion>
       )}
-      {severityFacet.length > 0 && (
+      {sortedSeverityFacets.length > 0 && (
         <Accordion
           elevation={0}
           square
@@ -386,7 +448,7 @@ export const DrawerInterior: React.FC<Props> = (props) => {
           </AccordionSummary>
           <AccordionDetails classes={{ root: classes.details }}>
             <FacetFilter
-              options={severityFacet}
+              options={sortedSeverityFacets}
               selected={filtersByColumn['vulnerabilities.severity'] ?? []}
               onSelect={(value) =>
                 addFilter('vulnerabilities.severity', value, 'any')