Skip to content

Conversation

evan-onyx
Copy link
Contributor

@evan-onyx evan-onyx commented Aug 8, 2025

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.

  • This PR should be backported (make sure to check that the backport attempt succeeds)
  • [Optional] Override Linear Check

Summary by cubic

Updated Salesforce connector docs to fix example formatting and add a direct link to the documentation.

  • Docs Improvements
  • Examples now show correct field and association structure.
  • Added clickable doc links using improved link parsing in descriptions.

@evan-onyx evan-onyx requested a review from a team as a code owner August 8, 2025 00:33
Copy link

vercel bot commented Aug 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Project Deployment Preview Comments Updated (UTC)
internal-search Ready Preview Comment Aug 13, 2025 4:37pm

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a 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

Copy link
Contributor

@greptile-apps greptile-apps bot left a 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:

  1. 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 to https://docs.onyx.app/connectors/salesforce.

  2. Field Component Enhancement (Field.tsx): The SubLabel component was modified to conditionally use a new RichTextSubtext 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.

  3. 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" and rel="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

Edit Code Review Bot Settings | Greptile

@wenxi-onyx wenxi-onyx enabled auto-merge August 13, 2025 16:33
@wenxi-onyx wenxi-onyx added this pull request to the merge queue Aug 13, 2025
Merged via the queue into main with commit 0eb1824 Aug 13, 2025
15 checks passed
@wenxi-onyx wenxi-onyx deleted the docs/salesforce-explainer-text branch August 13, 2025 19:08
AnkitTukatek pushed a commit to TukaTek/onyx that referenced this pull request Sep 23, 2025
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants