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

feat(http): add new field xmlRootKey and updated regex for some fields #1884

Merged
merged 5 commits into from
Jan 31, 2025

Conversation

sandeepdsvs
Copy link
Contributor

@sandeepdsvs sandeepdsvs commented Jan 29, 2025

What are the changes introduced in this PR?

Add new field xmlRootKey and updated regex for some fields

What is the related Linear task?

Resolves INT-3173

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new checks got introduced or modified in test suites. Please explain the changes.

N/A


Developer checklist

  • My code follows the style guidelines of this project

  • No breaking changes are being introduced.

  • All related docs linked with the PR?

  • All changes manually tested?

  • Any documentation changes needed with this change?

  • I have executed schemaGenerator tests and updated schema if needed

  • Are sensitive fields marked as secret in definition config?

  • My test cases and placeholders use only masked/sample values for sensitive fields

  • Is the PR limited to 10 file changes & one task?

Reviewer checklist

  • Is the type of change in the PR title appropriate as per the changes?

  • Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a mandatory XML Root Key for XML-based HTTP configurations.
  • Improvements

    • Enhanced input validation for mapping and configuration fields.
    • Updated regex patterns to allow a broader range of valid characters.
  • Changes

    • Modified character allowances in key and value fields for HTTP configurations.
    • Implemented stricter validation for XML format settings.
    • Added new prerequisites for XML-specific configurations.

Copy link

coderabbitai bot commented Jan 29, 2025

Walkthrough

The pull request introduces modifications to the HTTP configuration's JSON schema and UI configuration. The changes primarily focus on enhancing validation rules for string properties across various sections like propertiesMapping, pathParams, queryParams, and headers. A significant addition is the new conditional requirement for an xmlRootKey when the format is set to XML. The modifications include expanding allowed characters in some regex patterns and introducing more flexible input validation for mapping properties and parameters.

Changes

File Change Summary
src/configurations/destinations/http/schema.json - Added conditional requirement for xmlRootKey when format is XML
- Updated validation patterns for from, pathParams, queryParams, and headers to restrict allowed characters
src/configurations/destinations/http/ui-config.json - Added new "XML Root Key" text input field with regex validation
- Updated regex patterns for various fields to allow more characters, including single quotes and spaces

Possibly related PRs

Suggested reviewers

  • lvrach
  • am6010
  • ssbeefeater
  • debanjan97
  • cisse21
  • 1abhishekpandey
  • ItsSudip
  • krishna2020
  • koladilip

Poem

🐰 Regex dance, a rabbit's delight,
XML keys now shine so bright,
Patterns shift with gentle grace,
Validation finds its perfect space,
Code evolves, both wild and tight! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 09e6dde and 638c43b.

📒 Files selected for processing (1)
  • src/configurations/destinations/http/ui-config.json (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/configurations/destinations/http/ui-config.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

🧹 Nitpick comments (2)
src/configurations/destinations/http/ui-config.json (1)

499-499: LGTM! Consider documenting the allowed characters.

The regex has been simplified to allow only safe characters (alphanumeric, quotes, and hyphens) in constant values, which is good for preventing parsing issues.

Consider adding a note in the placeholder text to indicate the allowed characters, e.g., "e.g: $.properties.key1 or alphanumeric with quotes and hyphens".

src/configurations/destinations/http/schema.json (1)

1068-1086: LGTM! Consider adding a default value for XML root key.

The conditional requirement for XML root key is well-defined. However, providing a default value could improve user experience.

Consider adding a default value in both schema and UI config:

 "xmlRootKey": {
   "type": "string",
-  "pattern": "^(.{0,100})$"
+  "pattern": "^(.{0,100})$",
+  "default": "root"
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f4247aa and 908c4c9.

📒 Files selected for processing (2)
  • src/configurations/destinations/http/schema.json (5 hunks)
  • src/configurations/destinations/http/ui-config.json (5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (4)
src/configurations/destinations/http/ui-config.json (3)

460-475: LGTM! The XML root key field is well-defined.

The field is correctly configured with appropriate validation, error handling, and conditional visibility based on the format.


523-523: Same regex update as the Value field.


579-579: Same pattern update as other fields with additional allowed characters.

src/configurations/destinations/http/schema.json (1)

41-41: Pattern changes are consistent with UI config.

Also applies to: 53-53, 65-65, 69-69, 81-81, 85-85

src/configurations/destinations/http/ui-config.json Outdated Show resolved Hide resolved
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f4247aa) to head (638c43b).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff            @@
##           develop     #1884   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           53        53           
  Branches         7         7           
=========================================
  Hits            53        53           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

krishna2020
krishna2020 previously approved these changes Jan 30, 2025
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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 313ce66 and ff2dc79.

📒 Files selected for processing (2)
  • src/configurations/destinations/http/schema.json (1 hunks)
  • src/configurations/destinations/http/ui-config.json (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/configurations/destinations/http/ui-config.json

krishna2020
krishna2020 previously approved these changes Jan 31, 2025
@sandeepdsvs sandeepdsvs merged commit a9c3a6d into develop Jan 31, 2025
14 checks passed
@sandeepdsvs sandeepdsvs deleted the feat.add-xml-root-key branch January 31, 2025 15: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.

4 participants