METRON-2029: Configure Table should have filter

[sardell]

Contributor Comments

Link to original ASF ticket: https://jira.apache.org/jira/browse/METRON-2029?filter=-2

Previously, when a user opened the configure table panel, they would have to scroll down to see all the available column choices. This list can be really long and require a lot of scrolling and parsing for a user to find what they are looking for.

I added a simple filter so a user can more easily find the column they are looking for by either their original name or the display name they can optionally give a column.

Testing

1. Clone this branch locally.
2. Navigate to metron-interface/metron-alerts, run npm ci and then scripts/scripts/start-dev.sh
3. Open the Alerts UI at localhost:4201.
4. Click on the gear icon to open the configure table panel.
5. Type in the filter to narrow the choices down.
6. To test the display name, add a display name to an existing column choice, click save at the bottom of the configure table panel, reopen the panel and try filtering with the term being the display name. It should be included in the results.
7. To clear the filter and reset the filtered results to include all available columns, click on the 'x' on the right hand side of the filter input.
8. You can find unit tests for this feature inside the configure-table.component.spec.ts file and run them with ng test.

Click on the gif below to see an expanded view of the filter in action.

Further Considerations

Currently, if a display name exists on a column, the filtering logic will only check against the display name. This was intentionally written on my part because I felt if a user renames a column with a display name, they are going to be searching for that column by display name.

Pull Request Checklist

Thank you for submitting a contribution to Apache Metron.
Please refer to our Development Guidelines for the complete guide to follow for contributions.
Please refer also to our Build Verification Guidelines for complete smoke testing guides.

In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:

For all changes:

• Is there a JIRA ticket associated with this PR? If not one needs to be created at Metron Jira.
• Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
• Has your PR been rebased against the latest commit within the target branch (typically master)?

For code changes:

• Have you included steps to reproduce the behavior or problem that is being changed or addressed?

• Have you included steps or a guide to how the change may be verified and tested manually?

• Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:

  mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
  

• Have you written or updated unit tests and or integration tests to verify your changes?

• n/a [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

• Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?

For documentation related changes:

• n/a [ ] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via site-book/target/site/index.html:

  cd site-book
  mvn site
  

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
It is also recommended that travis-ci is set up for your personal repository such that your branches are built there before submitting a pull request.

[ruffle1986]

🙏

[tiborm]

Changeset reviewed, tested locally. Thanks, @sardell! +1

[nickwallen]

+1 by inspection. Very useful feature!