Skip to content
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.

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

Search and sorting OOIs #3262

Merged
merged 25 commits into from
Aug 23, 2024
Merged

Search and sorting OOIs #3262

merged 25 commits into from
Aug 23, 2024

Conversation

noamblitz
Copy link
Contributor

@noamblitz noamblitz commented Jul 21, 2024

Changes

Adds a substring search to the OOI list.
Adds sorting in OOI list on object_type or scan_level

Issue link

Closes #345
Part of #3084

Demo

image image

QA notes

Please add some information for QA on how to test the newly created code.


Code Checklist

  • All the commits in this PR are properly PGP-signed and verified.
  • This PR only contains functionality relevant to the issue.
  • I have written unit tests for the changes or fixes I made.
  • I have checked the documentation and made changes where necessary.
  • I have performed a self-review of my code and refactored it to the best of my abilities.
  • Tickets have been created for newly discovered issues.
  • For any non-trivial functionality, I have added integration and/or end-to-end tests.
  • I have informed others of any required .env changes files if required and changed the .env-dist accordingly.
  • I have included comments in the code to elaborate on what is not self-evident from the code itself, including references to issues and discussions online, or implicit behavior of an interface.

Checklist for code reviewers:

Copy-paste the checklist from the docs/source/templates folder into your comment.


Checklist for QA:

Copy-paste the checklist from the docs/source/templates folder into your comment.

@noamblitz noamblitz changed the title Search in octopoes Search and sorting in octopoes Jul 23, 2024
@noamblitz noamblitz changed the title Search and sorting in octopoes Search and sorting OOIs Jul 23, 2024
@stephanie0x00
Copy link
Contributor

stephanie0x00 commented Aug 6, 2024

Did a small QA so I could test #3320, I love this feature, it will make the end-users life so much easier ❤️!

  1. Feature request from a user point of view:
    Could we maybe move the search bar to either:
  • the top of the filter section
  • or outside of the filter selection altogether (my preference) on the top of the page.

This will make it easier for user to quickly search through the data, instead of having to open de filter selection dropdown, scroll down and then click on the apply button. My preference would be to move the search bar out of the filter section completely and even place it above this section. This will really improve the user experience.

  1. During checking it looks like the sorting of the objects isn't properly applied? Or is this the intended sorting?
    image

@underdarknl
Copy link
Contributor

closes #345

@Rieven
Copy link
Contributor

Rieven commented Aug 14, 2024

  1. During checking it looks like the sorting of the objects isn't properly applied? Or is this the intended sorting?

Sorting is applied in #3320

@underdarknl underdarknl marked this pull request as ready for review August 14, 2024 11:52
@underdarknl underdarknl requested a review from a team as a code owner August 14, 2024 11:52
@HeleenSG
Copy link
Contributor

Did a small QA so I could test #3320, I love this feature, it will make the end-users life so much easier ❤️!

  1. Feature request from a user point of view:
    Could we maybe move the search bar to either:
  • the top of the filter section
  • or outside of the filter selection altogether (my preference) on the top of the page.

This will make it easier for user to quickly search through the data, instead of having to open de filter selection dropdown, scroll down and then click on the apply button. My preference would be to move the search bar out of the filter section completely and even place it above this section. This will really improve the user experience.

  1. During checking it looks like the sorting of the objects isn't properly applied? Or is this the intended sorting?
    image

1: Yes, fully agree with this request. We're currently working towards the new filters design. Which removes the need to always open the filters as it is now.

An example of the new design to give an idea of the direction we're going in:
Screenshot 2024-08-19 at 13 07 12

Source: https://www.figma.com/design/5lYYfE1SqJ9qofjyvwdvtw/%E2%9C%85-KAT-%7C-Approved-%7C-Reports-Flow?node-id=2606-5202&t=RtHQv8W5lBTQXheH-1

For the object page (and other tables that need to be filterable) we will have the same setup.

If we also want to include a filter option at the top of the page will depend on the content of the page. As the filter options will be used for specific content. I can see situations where it would be useful to set filters for all the content on the page (e.g dashboard). But in most situations we will place the filters within the section it belongs to. For example, above any (large) table that needs to be filterable. Which will also leaves us the possibility to add a KAT-wide search bar in the future. For example in the header.

@stephanie0x00
Copy link
Contributor

Did a small QA so I could test #3320, I love this feature, it will make the end-users life so much easier ❤️!

  1. Feature request from a user point of view:
    Could we maybe move the search bar to either:
  • the top of the filter section
  • or outside of the filter selection altogether (my preference) on the top of the page.

This will make it easier for user to quickly search through the data, instead of having to open de filter selection dropdown, scroll down and then click on the apply button. My preference would be to move the search bar out of the filter section completely and even place it above this section. This will really improve the user experience.

  1. During checking it looks like the sorting of the objects isn't properly applied? Or is this the intended sorting?
    image

1: Yes, fully agree with this request. We're currently working towards the new filters design. Which removes the need to always open the filters as it is now.

An example of the new design to give an idea of the direction we're going in: Screenshot 2024-08-19 at 13 07 12

Source: https://www.figma.com/design/5lYYfE1SqJ9qofjyvwdvtw/%E2%9C%85-KAT-%7C-Approved-%7C-Reports-Flow?node-id=2606-5202&t=RtHQv8W5lBTQXheH-1

For the object page (and other tables that need to be filterable) we will have the same setup.

If we also want to include a filter option at the top of the page will depend on the content of the page. As the filter options will be used for specific content. I can see situations where it would be useful to set filters for all the content on the page (e.g dashboard). But in most situations we will place the filters within the section it belongs to. For example, above any (large) table that needs to be filterable. Which will also leaves us the possibility to add a KAT-wide search bar in the future. For example in the header.

This will be a great improvement! Already looking forward to this. :)

Copy link
Contributor

@ammar92 ammar92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one tiny remark about a type; should be an easy fix

octopoes/octopoes/connector/octopoes.py Show resolved Hide resolved
@dekkers dekkers added the 😸 Review/QA feedback Review/QA feedback provided label Aug 22, 2024
@underdarknl underdarknl removed the 😸 Review/QA feedback Review/QA feedback provided label Aug 22, 2024
@stephanie0x00
Copy link
Contributor

Checklist for QA:

  • I have checked out this branch, and successfully ran a fresh make reset.
  • I confirmed that there are no unintended functional regressions in this branch:
    • I have managed to pass the onboarding flow
    • Objects and Findings are created properly
    • Tasks are created and completed properly
  • I confirmed that the PR's advertised feature or hotfix works as intended.
  • I checked the logs for errors and/or warnings and made issues where necessary

What works:

Looks good. Searching on 'mis' will give all mispo.es results. This will definitely make life easier.

What doesn't work:

n/a

Bug or feature?:

n/a

@underdarknl underdarknl merged commit ed1b875 into main Aug 23, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add search on key on OOI list
7 participants