search

prowide / prowide-iso20022

Comprehensive business model and parser for all ISO 20022 messages
https://www.prowidesoftware.com
Apache License 2.0
142 stars 66 forks source link

Issue 118: Fix backward compatibility issue on DateTime fields #119

Closed elominp closed 1 month ago

elominp commented 1 month ago

Issue 118: Fix backward compatibility issue on DateTime fields seriaized from XMLGregorianCalendar objects

To be able to continue to parse JSON files generated from 9.x libraries using AbstractMX.toJson() when migrating to 10.x by doing an AbstractMX.fromJson(), which is a blocker for applications that were created before the existence of the 10.x branch and wouldn't be able anymore to read their previous files.

Another possibility could be to expose a public version of the fromJson method accepting custom adapters if you don't want to maintain the compatibility.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The recent changes enhance the `OffsetDateTimeJsonAdapter` class in the `iso20022-core` module, improving its JSON deserialization capabilities for `OffsetDateTime` objects. The implementation is modularized with distinct private methods for handling different DTO formats, enhancing readability and maintainability. Additionally, new backward compatibility tests are introduced to ensure that JSON parsing remains consistent across message format versions, safeguarding data integrity in financial systems. ## Changes | Files | Change Summary | |-----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------| | `iso20022-core/src/main/java/com/prowidesoftware/swift/model/mx/adapters/OffsetDateTimeJsonAdapter.java` | Refactored `OffsetDateTimeJsonAdapter` for improved deserialization. Introduced error handling and modular methods. | | `iso20022-core/src/test/java/com/prowidesoftware/swift/model/mx/adapters/DateTimeJsonAdapterBackwardCompatibilityTest.java` | Added tests to ensure backward compatibility of JSON parsing for the `MxSese02500109` message type across versions. |
Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
Commits Files that changed from the base of the PR and between 81e93b7e9d611064c0b1d005045ac9d925faa92f and 39dde93aad0854e3395c9b236bdf06e9fb13abd4.
Files selected for processing (2) * iso20022-core/src/main/java/com/prowidesoftware/swift/model/mx/adapters/OffsetDateTimeJsonAdapter.java (3 hunks) * iso20022-core/src/test/java/com/prowidesoftware/swift/model/mx/adapters/DateTimeJsonAdapterBackwardCompatibilityTest.java (1 hunks)
Additional comments not posted (8)
iso20022-core/src/main/java/com/prowidesoftware/swift/model/mx/adapters/OffsetDateTimeJsonAdapter.java (6)
`19-19`: **LGTM!** The new imports for `BigDecimal` and `Logger` are necessary and correctly added. --- `21-21`: **LGTM!** The new imports for `BigDecimal` and `Logger` are necessary and correctly added. --- `63-76`: **LGTM! Ensure comprehensive test coverage.** The enhancements to the `deserialize` method improve flexibility and robustness by handling both current and legacy DTO formats. The improved error handling and logging are beneficial for debugging. Ensure that comprehensive test coverage is in place to validate the deserialization logic. --- `78-112`: **LGTM!** The `deserializeFromOffsetDateTimeDTO` method is well-structured and correctly handles the deserialization logic for both cases where an offset is present and where it is not. --- `114-152`: **LGTM!** The `deserializeFromXMLGregorianCalendarDTO` method ensures robustness by handling uninitialized values and correctly deserializes the legacy DTO format into an `OffsetDateTime` object. --- `182-191`: **LGTM!** The `XMLGregorianCalendarDTO` class is necessary for handling the legacy DTO format and is correctly implemented with appropriate fields.
iso20022-core/src/test/java/com/prowidesoftware/swift/model/mx/adapters/DateTimeJsonAdapterBackwardCompatibilityTest.java (2)
`529-534`: **LGTM!** The `v10_should_be_able_to_parse_json_with_date_time_created_from_v9` test is essential for validating the backward compatibility of the `OffsetDateTimeJsonAdapter`. --- `536-548`: **LGTM!** The `v10_should_be_able_to_parse_json_from_v9_and_read_same_content_than_json_from_v10_and_xml` test ensures consistency and correctness of the deserialization logic across different formats and versions.
> [!WARNING] > ## Review ran into problems > >
> Problems (1) > > * Git: Failed to clone repository. Please contact CodeRabbit support. > >

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.