Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PW-1933 Fix backward compatibility issue on DateTime fields (With fix and Javadoc) #122

Merged
merged 4 commits into from
Aug 1, 2024

Conversation

fernando-prowide
Copy link
Contributor

@fernando-prowide fernando-prowide commented Aug 1, 2024

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

  • New Features

    • Enhanced JSON deserialization for OffsetDateTime to support multiple DTO formats, improving flexibility and compatibility.
    • Added backward compatibility tests for ISO 20022 JSON representations to ensure seamless transitions between versions.
  • Bug Fixes

    • Improved reliability in offset calculations for time-related tests to prevent inconsistencies across different time zones and daylight saving changes.

Copy link

coderabbitai bot commented Aug 1, 2024

Warning

Rate limit exceeded

@fernando-prowide has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 21 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 0440cbe and 569bfbc.

Walkthrough

Walkthrough

The recent changes enhance the JSON deserialization capabilities of the OffsetDateTimeJsonAdapter class in the ISO 20022 library. Key improvements include the introduction of support for multiple DTO formats, robust error handling, and backward compatibility tests to ensure seamless integration of newer JSON structures. Additionally, the handling of time offsets in tests has been refined for greater accuracy, improving overall reliability in financial messaging systems.

Changes

File Change Summary
iso20022-core/src/main/java/com/prowidesoftware/swift/model/mx/adapters/OffsetDateTimeJsonAdapter.java Refactored to enhance JSON deserialization for OffsetDateTime, introducing XMLGregorianCalendarDTO for legacy support. Improved separation of concerns and logging.
iso20022-core/src/test/java/com/prowidesoftware/swift/model/mx/adapters/DateTimeJsonAdapterBackwardCompatibilityTest.java New unit tests added to ensure backward compatibility with JSON formats from previous versions, validating JSON and XML parsing.
iso20022-core/src/test/java/com/prowidesoftware/swift/model/mx/adapters/OffsetTimeJsonAdapterTest.java Updated offset retrieval logic for tests to use TimeZone for more reliable and accurate offset calculations.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant OffsetDateTimeJsonAdapter
    participant JSONParser
    participant XMLGregorianCalendarDTO

    Client->>OffsetDateTimeJsonAdapter: Request deserialization
    OffsetDateTimeJsonAdapter->>JSONParser: Attempt to parse DateTimeOffsetDTO
    JSONParser-->>OffsetDateTimeJsonAdapter: Return parsed object or error
    alt Parsing successful
        OffsetDateTimeJsonAdapter-->>Client: Return deserialized OffsetDateTime
    else Parsing failed
        OffsetDateTimeJsonAdapter->>XMLGregorianCalendarDTO: Attempt to parse XMLGregorianCalendarDTO
        XMLGregorianCalendarDTO-->>OffsetDateTimeJsonAdapter: Return parsed object
        OffsetDateTimeJsonAdapter-->>Client: Return deserialized OffsetDateTime
    end
Loading

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • 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 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 for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

@fernando-prowide fernando-prowide removed the request for review from zubri August 1, 2024 16:29
@fernando-prowide fernando-prowide merged commit cab51fc into SRU2024_v10 Aug 1, 2024
@zubri zubri changed the title Issue 118: Fix backward compatibility issue on DateTime fields (With fix and Javadoc) PW-1933 Fix backward compatibility issue on DateTime fields (With fix and Javadoc) Aug 1, 2024
@zubri zubri deleted the gh/issue-118 branch August 2, 2024 23:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant