fix: add new field for list of props #1734
Conversation
ItsSudip
requested review from
lvrach,
cisse21,
debanjan97,
am6010,
ssbeefeater,
AchuthaSourabhC,
ruchiramoitra,
shrouti1507,
sandeepdsvs,
krishna2020 and
1abhishekpandey
as code owners
WalkthroughThe changes involve updates to three files related to configuration and validation. A new property Changes
Poem
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 #1734 +/- ##
=========================================
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: 2
🧹 Outside diff range and nitpick comments (2)
src/configurations/destinations/af/ui-config.json (1)
85-100: LGTM! Consider adding a minor clarification.The new "List of properties" field is well-implemented and aligns with the PR objectives. It's correctly set up as a tag input with appropriate configuration keys and a prerequisite condition.
Consider updating the note to be more specific:
- "note": "Add your name of properties that need to be sent at the root of eventValue.", + "note": "Add the names of properties that should be sent at the root of eventValue when 'Add properties at root in eventValue' is enabled.",This change would provide clearer context for users about when and how this field is used.
test/data/validation/destinations/af.json (1)
Line range hint
1-1: Consider adding test cases for the newlistOfPropsfield.While the new
listOfPropsfield has been added to the first configuration object, there are no specific test cases to validate its behavior. To ensure comprehensive test coverage, consider adding test cases that:
- Validate the presence of
listOfProps- Check for empty
listOfPropsarray- Test with invalid property formats
- Verify the maximum number of properties allowed (if any)
This will help ensure the robustness of the new field implementation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
- src/configurations/destinations/af/schema.json (1 hunks)
- src/configurations/destinations/af/ui-config.json (1 hunks)
- test/data/validation/destinations/af.json (1 hunks)
🔇 Additional comments (3)
src/configurations/destinations/af/ui-config.json (1)
85-100: Changes align well with PR objectives and maintain code integrity.The addition of the "List of properties" field successfully implements the PR's main objective without introducing any breaking changes or modifying existing behaviors. The changes are minimal, focused, and consistent with the project's style and structure. No security concerns are apparent in the implementation.
To ensure no unintended changes were made, let's verify the file structure:
This command should output the main sections of the configuration file, allowing us to verify that only the intended section ("Connection Settings") was modified.
✅ Verification successful
Verification complete: Changes align with PR objectives and maintain configuration integrity.
The structure of
src/configurations/destinations/af/ui-config.jsonremains consistent with the expected layout. The addition of the "List of properties" field in lines 85-100 does not affect existing sections or configurations. No unintended changes detected.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the structure of the ui-config.json file # Test: Check if the file structure matches the expected layout jq -r '.uiConfig | map(.title)' src/configurations/destinations/af/ui-config.jsonLength of output: 202
src/configurations/destinations/af/schema.json (2)
28-38: LGTM: New property successfully integrated into the schema.The
listOfPropsproperty has been correctly added to thepropertiesobject of theconfigSchema. Its optional nature maintains backward compatibility, and the schema's allowance for additional properties ("additionalProperties": true) ensures flexibility for this and future additions.
Line range hint
1-38: Summary: New field successfully added with minor suggestions for improvement.The PR successfully adds the new
listOfPropsfield to collect a list of properties, as intended. The implementation maintains backward compatibility and integrates well with the existing schema. Consider the suggestions for adding constraints and documentation to enhance the robustness and clarity of the new field.Overall, the changes meet the PR objectives without introducing breaking changes or affecting existing functionality.
What are the changes introduced in this PR?
We are adding a new field to collect the list of properties.
What is the related Linear task?
Resolves INT-2733
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
listOfProps, in the configuration schema for enhanced flexibility.dynamicCustomFormfield labeled "List of properties" in the UI configuration, allowing users to specify properties for event values.Bug Fixes
Tests