Skip to content

Refactor Domain and IP Filters in Findings Library (CRASM-2704) #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 26 commits into
base: develop
Choose a base branch
from
Draft

Refactor Domain and IP Filters in Findings Library (CRASM-2704) #1209

wants to merge 26 commits into from

Conversation

hawkishpolicy
Copy link
Collaborator

Per Design Team request, this PR replaces the current Domain and IP filters used in the Findings Library with an Autocomplete based component that provides a list of Domain names and IP addresses based on user input.

🗣 Description

  • Added new /domains/search endpoint that accepts a search_term, search_field, region filters, and organization filters.
  • This returns the following:
    • an array of objects containing id and name if flagged with "name" search_field.
    • or an array of objects containing id and ip if flagged with "ip" search_field.
    • results are limited based on region and/or organization filters.
  • The results of this call are then broken into respective Domain Results and IP Results via filtering and mapping.
  • They are then filtered against existing filters to prevent redundant results.
  • A natural language sort is then applied.
  • From there they are rendered in the Autocomplete based component.
  • A checkbox controlled list is rendered below to allow the user to monitor applied filters and remove them if desired.

💭 Motivation and context

  • Closes CRASM-2704

🧪 Testing

  • tested locally.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All future TODOs are captured in issues, which are referenced in code comments.
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All relevant repo and/or project documentation has been updated to reflect the changes in this PR.
  • Tests have been added and/or modified to cover the changes in this PR.
  • All new and existing tests pass.
  • Bump major, minor, patch, pre-release, and/or build versions as appropriate via the bump_version script if this repository is versioned and the changes in this PR warrant a version bump.
  • Create a pre-release (necessary if and only if the pre-release version was bumped).

✅ Pre-merge checklist

  • Revert dependencies to default branches.
  • Finalize version.

✅ Post-merge checklist

  • Create a release (necessary if and only if the version was bumped).

Janson Bunce and others added 18 commits September 22, 2025 11:34
Add endpoint for domain name autocomplete
f258689
@hawkishpolicy
Initial setup & logic for new Domain Autocomplete.
8dc9b29
Merge branch 'Refactor-Domain/IP-Filters-CRASM-2704' of https://githu…
8c436dd 
…b.com/cisagov/XFD into Refactor-Domain/IP-Filters-CRASM-2704
Add region and organization filters to domain name search endpoint
741e7ff
@hawkishpolicy
Add domain and ip filter to Domain Search Autocomp
78b0290 
- Brought in filters, addFilter, and removeFilter from props.
- Updated useEffect to include regionFilterValues and orgFilterValues as dependencies.
- Updated searchDomainsAndIPs call to include regionFilterValues and orgFilterValues.
- Updated handleDomainChange to remove existing 'domain' filters before adding a new one.
@hawkishpolicy
Add region & organization filters to domain search
3c83d27 
- Needs testing but refactored endpoint appears to be working.
@hawkishpolicy
Merge remote-tracking branch 'origin/develop' into Refactor-Domain/IP…
a037c66 
…-Filters-CRASM-2704
Add ip search capability to domain search endpoint
791109b
Merge branch 'Refactor-Domain/IP-Filters-CRASM-2704' of https://githu…
c80dfaf 
…b.com/cisagov/XFD into Refactor-Domain/IP-Filters-CRASM-2704
@hawkishpolicy
Add Checkbox controlled list of selected domains:
3f4a307 
- Allows user to select/deselect domains to filter by.
- Extends current facet filter functionaility of filtering by multiple domains.
@hawkishpolicy
Merge branch 'Refactor-Domain/IP-Filters-CRASM-2704' of https://githu…
0ed1764 
…b.com/cisagov/XFD into Refactor-Domain/IP-Filters-CRASM-2704
@hawkishpolicy
Integrated IP search into DomainAndIPFilter:
743bff0 
- a search_field prop to toggle between domain and IP search
- conditional rendering of Autocomplete options based on search_field
- conditional adding of filters based on search_field
- conditional rendering of checkbox controlled lists based on search_field
- need to separate state for domain and IP search terms, results, and selected values
  - this should eliminate duplicate calls related to the useEffect.
@aloftus23
Add subdomain populate to sample data
7667fce
@hawkishpolicy
Seperated out state mgmt for domain and ip filters
8a1f83b 
- Improved code readability and maintainability.
- Removed unused state variables and handlers.
- Ensured consistent state management for domain and IP filters.
- Prevent potential bugs related to state handling and duplicate api calls.
- began trouble shooting an issue where autocomplete was not closing properly.
  - this issue affects autocompletes throughout the app.
@hawkishpolicy
Restored original Open logic:
bb22914 
- Restored original Open logic for RegionAndOrganizationFilters and VSDashRegionAndOrgFilters components.
- This change is out of scope for the current task but is necessary to maintain existing functionality.
- Need to determine if the open logic should be custom or handled internally by MUI Autocomplete component.
  - I'm leaning towards the latter, as I'm not sure why we need custom state and logic for this.
- Cleaned up code.
@hawkishpolicy
Refactor & logic improvement for Domain/IP Filters
f67ba9e 
- Cleaned up ResultsShallow type by making fields optional.
- Applied ResultsShallow type to domain search API calls.
  - This kept the codebase consistent and reduced potential errors.
  - Made applying domain name and IP data to rendered components cleaner and more reliable.
- Ensured Domain Results are based off of domain names via filter and mapping.
- Ensured IP Results are based off of IP addresses via filter and mapping.
- Added utility function to identify IP addresses in Domain results.
- Filtered out results that are already selected in filters.
- Implemented custom sorting logic for domain names and IP addresses.
  - Domain names are sorted alphabetically.
  - IP addresses are sorted numerically to ensure correct order (e.g., 192.168.1.1).
- Improved sorting logic for IP addresses to ensure numerical order.
- Increased Elasticsearch query size to 15 to ensure sufficient results.
- Removed unnecessary return statements in async functions.
- Removed console.log statements used for debugging.
@hawkishpolicy
Merge remote-tracking branch 'origin/develop' into Refactor-Domain/IP…
39ecbb5 
…-Filters-CRASM-2704
@hawkishpolicy
Removed unused code in the following files:
3f4ffff 
- frontend/src/components/FilterDrawer/DrawerInterior.tsx
- removes the old commented-out TaggedArrayInput components for domain and IP filters.
- removes unused imports.
@hawkishpolicy hawkishpolicy self-assigned this Sep 27, 2025
@hawkishpolicy hawkishpolicy marked this pull request as ready for review September 29, 2025 17:14
@hawkishpolicy hawkishpolicy marked this pull request as draft September 29, 2025 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aloftus23 aloftus23 Awaiting requested review from aloftus23 aloftus23 is a code owner

@cduhn17 cduhn17 Awaiting requested review from cduhn17 cduhn17 is a code owner

@Matthew-Grayson Matthew-Grayson Awaiting requested review from Matthew-Grayson Matthew-Grayson is a code owner

@nickviola nickviola Awaiting requested review from nickviola nickviola is a code owner

@rapidray12 rapidray12 Awaiting requested review from rapidray12 rapidray12 is a code owner

@schmelz21 schmelz21 Awaiting requested review from schmelz21 schmelz21 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@hawkishpolicy hawkishpolicy

Labels

backend frontend

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hawkishpolicy @aloftus23