fix(patch): consider escaped characters when applying JSON patches

[ipolding-cais]

I have raised an issue for this: https://github.com/datahub-project/datahub/issues/10716

Checklist

• [x] The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
• [x] Links to related issues (if applicable)
• [x] Tests for the changes have been added/updated (if applicable)
• [ ] Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
• [ ] For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Summary by CodeRabbit

• New Features

  • Enhanced handling of special characters in paths for better compatibility.

• Tests

  • Added tests for JSON patches with special characters to ensure reliable functionality.

[coderabbitai[bot]]

Walkthrough

The updates enhance TemplateUtil.java to better handle special characters in JSON patch paths by decoding them before splitting. This involves adding import statements and a new helper method for decoding. Additionally, two new tests in UpstreamLineageTemplateTest.java ensure the correctness of patches involving fields with special characters.

Changes

File	Change Summary
entity-registry/src/main/java/.../template/TemplateUtil.java	Updated populateTopLevelKeys for special character handling, added imports for ArrayList and Arrays, and introduced decodeValue method
entity-registry/src/test/java/.../template/UpstreamLineageTemplateTest.java	Added tests testPatchWithFieldWithForwardSlash and testPatchWithTilde, along with an import for JsonProcessingException

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant TemplateUtil
    participant UpstreamLineageTemplateTest

    Client->>TemplateUtil: Call populateTopLevelKeys with encoded JSON path
    TemplateUtil->>TemplateUtil: Decode special characters
    TemplateUtil->>Client: Return array of top-level keys

    UpstreamLineageTemplateTest->>TemplateUtil: Call populateTopLevelKeys with encoded JSON path
    TemplateUtil->>UpstreamLineageTemplateTest: Return decoded keys
    UpstreamLineageTemplateTest->>UpstreamLineageTemplateTest: Assert results with expected values

Poem

In lines of code where paths lay tight,
Characters were handled with might.
Decoding crafted, tests imbued,
Forward slash and tilde reviewed.
Bugs now quiver in retreat,
As software stands tall and neat!
🐇✨💻

---

[!TIP]

Early access features

• OpenAI gpt-4o model for reviews and chat.

Note:

• You can disable early access features from the CodeRabbit UI or by setting early_access: false in the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues.
• OSS projects are always opted into early access features.

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
• Mastodon
• Reddit
• LinkedIn

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 Configration 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.

[jjoyce0510]

Do you mind running ./gradlew entity-registry:spotlessApply to fix the linting CI issue with the test file?

Thanks!

[ipolding-cais]

There was a test failure for unrelated code public void testSslVerificationException() in RestEmitterTest

updating with master and trying again