-
Notifications
You must be signed in to change notification settings - Fork 2.1k
fix: sf connector docs #5171
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
fix: sf connector docs #5171
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cubic analysis
No issues found across 3 files. Review in cubic
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR enhances the Salesforce connector configuration by fixing documentation examples and adding clickable links to external documentation. The changes span three files:
-
Salesforce Connector Configuration (
connectors.tsx
): The JSON example in the 'Custom Query Config' description was corrected to show proper structure for associations - changing from a nested object with both 'fields' and 'associations' properties to a simplified array format for Contact associations. Additionally, a plain text documentation reference was converted to a proper markdown link pointing tohttps://docs.onyx.app/connectors/salesforce
. -
Field Component Enhancement (
Field.tsx
): TheSubLabel
component was modified to conditionally use a newRichTextSubtext
component when the children prop is a string. This enables automatic parsing and rendering of links in form field subtexts while maintaining backward compatibility with existing JSX.Element children. -
New RichTextSubtext Component (
RichTextSubtext.tsx
): A new component was introduced that parses text to detect URLs and markdown-style links[text](url)
, converting them to clickable<a>
elements with appropriate styling and security attributes (target="_blank"
andrel="noopener noreferrer"
).
These changes work together to improve the user experience when configuring Salesforce connectors by providing clearer examples and making documentation links easily accessible directly from the configuration interface.
Confidence score: 2/5
- This PR introduces significant security and functionality risks that make it unsafe to merge without substantial revisions
- Score reflects critical vulnerabilities in the RichTextSubtext component including XSS exposure, inadequate URL validation, and potential performance issues with regex operations
- Pay close attention to RichTextSubtext.tsx which requires a complete security review and likely redesign before production use
3 files reviewed, no comments
87c7e92
to
4d768e0
Compare
* fix: sf connector docs * more sf logs * better logs and new attempt * add fields to error temporarily * fix sf --------- Co-authored-by: Wenxi <wenxi@onyx.app>
Description
fixed the examples and added doc links to the sf connector
How Has This Been Tested?
tested in UI
Backporting (check the box to trigger backport action)
Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.
Summary by cubic
Updated Salesforce connector docs to fix example formatting and add a direct link to the documentation.