feat: oauth support in databricks source #1911
Conversation
shekhar-rudder
requested review from
lvrach,
cisse21,
debanjan97,
am6010,
ssbeefeater,
ItsSudip,
sandeepdsvs,
krishna2020 and
1abhishekpandey
as code owners
WalkthroughThis update modifies the Databricks UI configuration. The changes update the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant UI
participant ConfigHandler
User->>UI: Open Databricks configuration
UI->>ConfigHandler: Load ui-config.json
ConfigHandler-->>UI: Return configuration with authentication type options
User->>UI: Select "Personal Access Token"
UI->>ConfigHandler: Validate Token field requirement
ConfigHandler-->>UI: Display Token field only
User->>UI: Switch to "M2M OAuth"
UI->>ConfigHandler: Enforce OAuth validations
ConfigHandler-->>UI: Display Client ID & Client secret fields
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 #1911 +/- ##
=========================================
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/sources/databricks/ui-config.json (1)
92-105: Addition of Client Secret Field for OAuth
This segment introduces the"Client secret"field with the necessary validations and marks it as sensitive ("secret": true). The prerequisite condition ensures it is only required when OAuth is selected. Although the regex pattern and error message are functionally correct, you might consider refining the error message to provide more specific guidance to end users in case of invalid input.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/configurations/sources/databricks/ui-config.json(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (4)
src/configurations/sources/databricks/ui-config.json (4)
5-5: Sensitive Field Update for OAuth Client Secret
Adding"oauthClientSecret"to the"secretFields"array ensures that the new OAuth client secret is properly treated as sensitive data. This change is consistent with the new OAuth support and helps prevent accidental exposure of credentials.
44-62: Addition of Authentication Type Dropdown
The new"Authentication Type"field (of type"singleSelect") correctly offers the options to choose between Personal Access Token (PAT) and M2M OAuth. Setting the default to"oauth"aligns with the PR’s objective of introducing OAuth support. The configuration ensures that subsequent credential fields can be conditionally rendered based on the selected authentication method.
63-77: Conditional Rendering for the Token Field
Modifying the"Token"field to include"inputFieldType": "password"and adding the"preRequisiteField"condition ("authenticationType": "pat") ensures that this field is only displayed when the PAT method is selected. This improves the UI clarity by hiding unnecessary fields when OAuth is being used.
78-91: Addition of Client ID Field for OAuth
The newly added"Client ID"field, complete with its regex validation and prerequisite condition ("authenticationType": "oauth"), is a solid addition for supporting OAuth. The regex pattern ensures a minimum input length of 1 character and limits the input to 100 characters, which is appropriate for most client IDs.
What are the changes introduced in this PR?
authenticationType, to allow selection between PAT and OAuth authentication.oauthClientIdandoauthClientSecret, which are displayed only when OAuth authentication is selected.tokenfield to be shown only when PAT authentication is chosen.What is the related Linear task?
Resolves INT-XXX
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