Refactor: FileParser and related implementations in preparation for migration to Spring Kafka #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implemented LogFileParserFactory to streamline parser creation based on log file prefixes. Updated relevant classes and tests to use the new factory, ensuring consistent instantiation of log file parsers. This change improves maintainability and readability of the codebase.
Replaced JUnit 4 imports and annotations with JUnit 5 equivalents. Updated test methods to follow JUnit 5 method signatures and added necessary setup using @beforeeach. This improves test consistency and ensures compatibility with modern testing practices.
Replaced JUnit 4 imports and annotations with JUnit 5 equivalents. Updated test methods to follow JUnit 5 method signatures and added necessary setup using @beforeeach. This improves test consistency and ensures compatibility with modern testing practices.
Replaced JUnit 4 imports and annotations with JUnit 5 equivalents. Updated test methods to follow JUnit 5 method signatures and added necessary setup using @beforeeach. This improves test consistency and ensures compatibility with modern testing practices.
Replaced JUnit 4 imports and annotations with JUnit 5 equivalents. Updated test methods to follow JUnit 5 method signatures and added necessary setup using @beforeeach. This improves test consistency and ensures compatibility with modern testing practices.
Replaced JUnit 4 imports and annotations with JUnit 5 equivalents. Updated test methods to follow JUnit 5 method signatures and added necessary setup using @beforeeach. This improves test consistency and ensures compatibility with modern testing practices.
Updated the publish method to explicitly accept a LogFileParser instance, allowing for improved flexibility and better separation of concerns. Adjusted related methods and tests to accommodate the new parameter.
Replaced JMockit with Mockito for mocking behavior in LogFileToAsn1CodecPublisherTest. Simplified dependency initialization and adjusted test methods for compatibility, improving test maintainability and consistency.
Moved inline JSON strings in LogFileToAsn1CodecPublisherTest to external test resource files for better readability and maintainability. Added a utility function to load JSON from files and updated test cases to use these resources.
Updated method implementations to use modern Java features like pattern matching and inline casting for improved readability. Added `@Slf4j` for better logging support and streamlined `buildReceivedMessageDetails` for concise logic and debug messaging when `locationParser` is unavailable.
Removed the unnecessary default initialization of the `ParserStatus` variable in the `parseFile` method. This change ensures cleaner code and avoids redundant assignments during method execution. Functionality remains unaffected.
…Test Replaced assertTrue with assertInstanceOf to improve clarity and type-specific assertions in parser tests. Updated the factory exception test to assert the correct custom exception type, ensuring better alignment with expected behavior.
Updated file parsers to pass filename and record type via constructor, eliminating the need to pass filenames repeatedly during parsing. Simplified method signatures and improved encapsulation for more streamlined and maintainable code.
Replaced the use of `@Tested` and `@Injectable` annotations with explicit constructors to initialize parser instances. This change improves clarity and aligns with best practices for test setup.
Replaced JUnit 4 assertions with JUnit 5 equivalents in test files. This modernizes the codebase for compatibility with JUnit 5 and aligns with updated testing standards. No functionality changes were introduced.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/importer/parser/TimeParser.java
Outdated
Show resolved
Hide resolved
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/importer/parser/TimeParser.java
Outdated
Show resolved
Hide resolved
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/importer/parser/TimeParser.java
Outdated
Show resolved
Hide resolved
Reorganize code to improve readability, addressing checkstyle violations such as indentation and formatting. Documented class details and parsing steps to enhance code clarity and maintainability.
mcook42
commented
Jan 21, 2025
Comment on lines
+185
to
+188
| if (locationParser == null) { | ||
| log.debug("No locationParser available - returning null"); | ||
| return null; | ||
| } |
There was a problem hiding this comment.
Note: Instead of nesting some core logic under an if statement, I adjusted the code to return null early to improve its readability. The previous implementation is logically identical to this. Now, the core of the method's logic is unnested, and the reader can more quickly identify that a populated ReceivedMessageDetails object is only returned if the locationParser is instantiated.
mcook42
requested review from
payneBrandon,
John-Wiens,
dmccoystephenson,
drewjj,
Michael7371,
jacob6838 and
mwodahl
drewjj
approved these changes
Jan 21, 2025
dmccoystephenson
approved these changes
Jan 29, 2025
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/coder/FileAsn1CodecPublisher.java
Show resolved
Hide resolved
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/coder/FileAsn1CodecPublisher.java
Show resolved
Hide resolved
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/importer/parser/DistressMsgFileParser.java
Outdated
Show resolved
Hide resolved
jpo-ode-svcs/src/main/java/us/dot/its/jpo/ode/importer/parser/SecurityResultCodeParser.java
Show resolved
Hide resolved
mcook42
deleted the
mcook42/spring-kafka/importer-processor-docs-and-style
branch
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Details
Description
instanceofto deduplicate casting and improve readabilityRelated Issue
N/A
Motivation and Context
This change is intended to make migrating the ImporterProcessor to Spring Kafka easier to complete, test, and review. The bulk of this PR is documentation updates. I used the JetBrains AI to generate the bulk of the documentation updates. I then reviewed each update for clarity, accuracy, and consistency. The documentation should reflect the current state of the code.
How Has This Been Tested?
Types of changes
Checklist:
ODE Contributing Guide