[User Story]: Find elements through fuzzy search

chrisdburr commented 2 weeks ago

Role

As a user

Desired Feature

I want to be able to search for specific elements that I have added based on keywords

Benefit

So that I can more easily navigate an assurance case

Acceptance Criteria

GIVEN I have an assurance case with elements already added and an option to search the case AND I enter a term that I believe is used in an element's description WHEN I search for this term, I am presented with a list of elements that fuzzy match this search term AND when I click on the relevant element, it takes me to the right place in my case

Dependencies

No response

Technical Notes

Preference is to have a fuzzy search, rather than a strict search to make it easier for users to find terms that they are slightly unfamiliar about

Definition of Done

[ ] The feature fulfills all acceptance criteria.
[ ] The code is reviewed and meets team coding standards.
[ ] All unit, integration, and end-to-end tests are passed.
[ ] The feature meets accessibility standards set for the project.
[ ] The code passes the CI/CD pipeline quality controls (style and linting).
[ ] The feature is merged into the main branch.
[ ] The feature is deployed and functional in the QA environment.
[ ] The feature was demonstrated to the team and accepted by the product owner.

RichGriff commented 3 days ago

Progress update:

Case header now contains a search button that opens up a search dialogue
User can scroll through the list to select node or start typing a word that is included in the description
Once selected the dialogue will close and the user is navigated to that node in the chart

https://github.com/alan-turing-institute/AssurancePlatform/assets/28445922/1425339d-a89a-47fd-828a-209d530d891f

RichGriff commented 3 days ago

instaging - @chrisdburr can you please review, thanks.

chrisdburr commented 2 days ago

Nice implementation on the search functionality, @RichGriff.

Minor bug I've found in testing arises when an element that is collapsed is selected from the results (see video).

https://github.com/alan-turing-institute/AssurancePlatform/assets/63010234/b1806e2b-d476-4018-a302-8e8a5f910009

alan-turing-institute / AssurancePlatform