Skip to content
This repository has been archived by the owner on May 12, 2021. It is now read-only.

METRON-2139: Refactoring sensor-parser-config.component and wire NgRx #1430

Conversation

ruffle1986
Copy link
Contributor

@ruffle1986 ruffle1986 commented May 23, 2019

Contributor Comments

Link to the original JIRA: https://issues.apache.org/jira/browse/METRON-2139
Link to Parent Feature ticket: https://issues.apache.org/jira/browse/METRON-1856

"sensor-parser-config" and "sensor-parser-config-readonly" components are responsible for displaying, creating and editing sensor data. Previously they had nothing to do with NgRx but since we're managing the state in an NgRx store, it made sense to refactor them and wire NgRx to manage the aforementioned operations.

Related commits

This PR is part of a larger sequence of PRs we are opening to make the reviewing process of the relatively large Parser Aggregation UI feature easier.

To see only the changes that apply to this PR, please review the last commit in the list of commits (the commit to review contains the title of the PR)

If you want to learn more about why we picked this method, please refer to the discussion thread here

Please find the full list of relating PRs below.

PR#1 METRON-2114: [UI] Moving components to sensor parser module
PR#2 METRON-2116: [UI] Removing redundant AppConfigService
PR#3 METRON-2117: [UI] Aligning models to grouping feature
PR#4 METRON-2115: [UI] Aligning UI to the parser aggregation AP
PR#5 METRON-2122: [UI] Fixing early app config access issue
PR#6 METRON-2124: [UI] Move status information and start/stop to the Aggregate level
PR#7 METRON-2125: [UI] Making changes visible in the parser list by marking changed items
PR#8 METRON-2131: Add NgRx and related dependencies
PR#9 METRON-2133: Add NgRx effects to communicate with the server
PR#10 METRON-2134: Add NgRx reducers to perform parser and group changes in the store
PR#11 METRON-2135: Add NgRx actions to trigger state changes
PR#12 METRON-2136: Add parser aggregation sidebar
PR#13 METRON-2137: Implement drag and drop mechanism and wire NgRx
PR#14 METRON-2138: Code clean up
CURRENT PR#15 METRON-2139: Refactoring sensor-parser-config.component and wire NgRx

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?

  • 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:

  • 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
    
  • Have you ensured that any documentation diagrams have been updated, along with their source files, using draw.io? See Metron Development Guidelines for instructions.

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.

@@ -0,0 +1,638 @@
/**
Copy link
Contributor

Choose a reason for hiding this comment

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

@ruffle1986 I feel like we should break down this large reducer file into multiple files, as well as extract out the interfaces. I don't think it is necessarily an item that needs to be fixed for this PR to be accepted, but I do think it would make it easier to digest this code. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point. We can refactor it later once the feature is validated and accepted by users.

@@ -534,7 +534,11 @@ describe('sensors: selectors', () => {
expect(merged[1].status).toEqual(state.sensors.statuses.items[1]);
expect(merged[2].status).toEqual(state.sensors.statuses.items[2]);

<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

@ruffle1986 It looks like there is a merge conflict still needing to be resolved here.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
3 participants