feat(http): updated regex and some labels #1895
Conversation
sandeepdsvs
requested review from
lvrach,
cisse21,
debanjan97,
am6010,
ssbeefeater,
ItsSudip,
krishna2020 and
1abhishekpandey
as code owners
WalkthroughThis pull request updates the HTTP destination configuration by relaxing regex validations in both the JSON schema and UI config files. The patterns for fields such as Changes
Possibly related PRs
Suggested reviewers
Poem
Tip 🌐 Web search-backed reviews and chat
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #1895 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 53 53
Branches 7 7
=========================================
Hits 53 53 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/configurations/destinations/http/ui-config.json (1)
541-592: Reintroduction of 'Request Body' Section.
A new Request Body section has been added featuring:
- An "XML Root Key" field with an accompanying note and a regex that allows up to 100 characters (including empty values).
- A "Map your request payload" mapping that provides detailed guidance and validations for keys and values.
These changes improve configurability for HTTP request payloads. Please verify that the regex constraints and notes align with the new API requirements and UI guidelines.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/configurations/destinations/http/ui-config.json(6 hunks)
🧰 Additional context used
📓 Learnings (1)
src/configurations/destinations/http/ui-config.json (1)
Learnt from: sandeepdsvs
PR: rudderlabs/rudder-integrations-config#1830
File: src/configurations/destinations/http/ui-config.json:476-477
Timestamp: 2024-12-05T16:06:11.176Z
Learning: The regex patterns in `src/configurations/destinations/http/ui-config.json` for the "Destination property" and "RudderStack property" fields correctly validate JSON paths and appropriately throw errors for invalid inputs.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (9)
src/configurations/destinations/http/ui-config.json (9)
256-256: Clarify Maximum Batch Size Note.
The new note clearly states "Maximum batch size allowed is 100", which improves clarity for users. Please verify that this note is consistent with backend validations and the regex constraint.
468-468: Enhanced Guidance for Path Parameters.
The updated note now advises users that they can dynamically add values using JSON path or constants. This additional context should help prevent configuration errors.
475-476: Updated Regex for 'Path' Field.
The revised regex now permits an empty constant (0–100 characters) alongside a valid JSON path, aligning with the relaxed validation objective. Please ensure that allowing an empty constant meets the overall design expectations for URL paths.
485-485: Updated Note for Query Parameters.
The new note for mapping query parameters clearly instructs users to use JSON path or constants. This enhancement improves usability and consistency with other sections.
494-494: Relaxed Regex for Query Parameter 'Key'.
The regex change now allows keys with 0 to 100 characters (provided they do not start with a '$'). Please verify that accepting an empty string for the key is intentional and does not result in invalid configurations.
502-502: Updated Regex for Query Parameter 'Value'.
The modified regex accommodates both proper JSON paths and constants with a length up to 100 characters. This change aligns with the objective to relax validations; please ensure it meets service requirements.
516-516: Improved Guidance for Headers Mapping.
The note for mapping header keys now provides clearer instructions for using JSON path or constants. This should enhance user understanding when configuring header mappings.
525-525: Revised Regex for Header 'Key'.
The updated regex now allows header keys with 0–100 characters, relaxing the minimum length requirement. Please confirm that this behavior is consistent with expected header specifications.
533-533: Enhanced Regex for Header 'Value'.
The regex update for the header value now includes additional allowed characters (e.g., spaces and slashes) while still validating against a JSON path or a constant of 0–100 characters. Verify that this expanded character set aligns with downstream processing requirements.
What are the changes introduced in this PR?
What is the related Linear task?
Resolves INT-3234
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
New Features
Refactor