chore: onboard account definitions #1921
Conversation
utsabc
requested review from
lvrach,
cisse21,
debanjan97,
am6010,
ssbeefeater,
ItsSudip,
sandeepdsvs,
krishna2020 and
1abhishekpandey
as code owners
WalkthroughThis update modifies a configuration key in the Customer.io UI file and adds several new JSON configuration files for HubSpot destinations. The new configurations cover various HubSpot account types including API Key, OAuth, and Private App, with dedicated DB and UI configuration files. An existing HubSpot configuration file is also updated with a new property defining supported account definitions. Each file update strictly alters configuration parameters without modifying validation rules or control flow. Changes
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/configurations/destinations/hs/accounts/apiKey/ui-config.json (1)
1-26: Consistent Naming for Configuration Keys
The file correctly defines the UI configuration for the HS API Key account. One minor suggestion is to review the naming convention of the key"configkey". In other configuration files (e.g. incustomerio/ui-config.json), the key uses camelCase as"configKey". For consistency and to minimize potential mapping issues, consider using the same casing across files.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
src/configurations/destinations/customerio/ui-config.json(1 hunks)src/configurations/destinations/hs/accounts/apiKey/db-config.json(1 hunks)src/configurations/destinations/hs/accounts/apiKey/ui-config.json(1 hunks)src/configurations/destinations/hs/accounts/oauth/ui-config.json(1 hunks)src/configurations/destinations/hs/accounts/privateApp/db-config.json(1 hunks)src/configurations/destinations/hs/accounts/privateApp/ui-config.json(1 hunks)src/configurations/destinations/hs/db-config.json(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- src/configurations/destinations/hs/accounts/oauth/ui-config.json
- src/configurations/destinations/hs/accounts/privateApp/db-config.json
- src/configurations/destinations/hs/accounts/privateApp/ui-config.json
- src/configurations/destinations/hs/accounts/apiKey/db-config.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (1)
src/configurations/destinations/hs/db-config.json (1)
4-7: New Account Definitions Added Successfully
The addition of the"supportedAccountDefinitions"object is clear and well structured. It defines both"rudderAccountId"and"rudderDeleteAccountId"with their respective allowed values. Ensure that all downstream components consuming these definitions are updated to reference these keys correctly, especially now that the customer.io UI config is linking to them.
| "type": "textInput", | ||
| "label": "API Key", | ||
| "configKey": "apiKey", | ||
| "configKey": "rudderAccountId, rudderDeleteAccountID", | ||
| "regex": "(^\\{\\{.*\\|\\|(.*)\\}\\}$)|(^env[.].+)|^(.{1,100})$", |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Inconsistent Account Definition Identifier Naming
The change updates the "configKey" value for the "API Key" field to "rudderAccountId, rudderDeleteAccountID". Notice that the second identifier uses "ID" in all caps, whereas elsewhere (for example in the HubSpot DB configuration) the identifier is defined as "rudderDeleteAccountId". To ensure consistency across configurations and avoid potential integration issues, please change "rudderDeleteAccountID" to "rudderDeleteAccountId".
What are the changes introduced in this PR?
Introduce sample account definitions
Summary by CodeRabbit