[GitHub] merrimanr opened a new pull request #1321: METRON-1948: Dropped messages from REGEX_SELECT parser field transformation are not acked in Storm

[GitBox <gi...@apache.org>]

merrimanr opened a new pull request #1321: METRON-1948: Dropped messages from REGEX_SELECT parser field transformation are not acked in Storm
URL: https://github.com/apache/metron/pull/1321
 
 
   ## Contributor Comments
   This PR fixes a bug that was exposed when using the REGEX_SELECT to set a Kafka topic field value (route a message).  When a REGEX_SELECT doesn't match the Kafka topic field is not set.  The KafkaWriter drops the message in this case but does not return the corresponding Tuple as a success or failure.  As a result the Tuple is never acked.
   
   This PR fixes that bug by adding logic to the BulkWriterComponent to ack any tuples that are not returned by a writer in the BulkWriterResponse.
   
   ### Changes Included
   
   - Added logic to ack missing tuples to the BulkWriterComponent
   - Added the `handleCommit` flag to the BulkWriterComponent error handling.  I believe this is a minor bug and error handling should respect that flag.
   - Refactored the parser integration tests slightly to use a BulkMessageWriter instead of a MessageWriter.  The fact that a MessageWriter is used made it harder to track this bug down.  This is an incremental improvement and can be expanded later if we want to simulate batches in our parser integration tests.  For now the batch size is set to 1 to avoid having to update the test cases or test data.
   - Added a unit test to catch this issue in the future
   
   ### Testing
   
   I have tested this with modified integration tests but I think it would be good for someone other than me to test in full dev.  To recreate the test:
   
   1. Spin up full dev and ensure parser topologies are running
   2. Create a new parser config and define a Kafka topic field:
   ```
   "parserConfig": {
           ...
           "kafka.topicField": "kafka_topic_field"
       },
   ```
   3.  Create a field transformation to set this field using a `REGEX_SELECT` transformation:
   ```
   "fieldTransformations": [
           {
               "input": [
                   "message"
               ],
               "output": [
                   "kafka_topic_field"
               ],
               "transformation": "REGEX_SELECT",
               "config": {
                   "new_topic": "regex value"
               }
           }
       ]
   ```
   4. Send some messages that the `REGEX_SELECT` will match and send some that won't.
   5. All tuples should be acked and there should be no errors in Storm
   
   ## Pull Request Checklist
   
   Thank you for submitting a contribution to Apache Metron.  
   Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.  
   Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) 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:
   - [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
   - [x] 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.
   - [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
   
   
   ### For code changes:
   - [x] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
   - [x] Have you included steps or a guide to how the change may be verified and tested manually?
   - [x] 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 
     ```
   
   - [x] Have you written or updated unit tests and or integration tests to verify your changes?
   - [x] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
   - [ ] 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
     ```
   
   #### 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](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services