feat(ingest/salesforce): helpful error messages on failure #11266

mayurinehate · 2024-08-29T11:05:15Z

Checklist

The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
Links to related issues (if applicable)
Tests for the changes have been added/updated (if applicable)
Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

coderabbitai · 2024-08-29T11:05:24Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

skrydal · 2024-08-29T14:57:10Z

metadata-ingestion/src/datahub/ingestion/source/salesforce.py

@@ -287,7 +287,13 @@ def __init__(self, config: SalesforceConfig, ctx: PipelineContext) -> None:

        except Exception as e:
            logger.error(e)
-            raise ConfigurationError("Salesforce login failed") from e
+            if "API_CURRENTLY_DISABLED" in str(e):


This string will be present only if the Exception is actually:
simple_salesforce.exceptions.SalesforceAuthenticationFailed maybe we can catch is explicitly?

skrydal · 2024-08-29T15:07:46Z

metadata-ingestion/src/datahub/ingestion/source/salesforce.py

+                error = "Salesforce login failed. Please make sure user has API Enabled Access."
+            else:
+                error = "Salesforce login failed. Please verify your credentials."
+                "Please set `is_sandbox: True` in recipe if this is sandbox account."


The second part of this message might be missleading in case somebody really provided wrong credentials. Maybe we could only add is_sandbox info if the instance_url somehow falls into the regular expression by ending somehow like: .sandbox.my.salesforce.com?

I'm not quite sure if salesforce sandbox url follows any specific structure. Do you have any resource that confirms that instance url can be used to identify whether this is sandbox account ?

Looks like its general pattern to use "sandbox" in name, so in favour of best practice, will change this handling to check whether "sandbox" is present in url, before showing this message.

skrydal · 2024-08-29T15:08:56Z

metadata-ingestion/src/datahub/ingestion/source/salesforce.py

+        try:
+            sObjects = self.get_salesforce_objects()
+        except Exception as e:
+            if "sObject type 'EntityDefinition' is not supported." in str(e):
+                # https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_entitydefinition.htm
+                raise ConfigurationError(
+                    "Salesforce EntityDefinition query failed. "
+                    "Please verify if user has 'View Setup and Configuration' permission."
+                ) from e
+            raise e
+        else:
+            for sObject in sObjects:
+                yield from self.get_salesforce_object_workunits(sObject)


Awesome 👍

skrydal

Looks very good, left some comments about clarification of error messages trigger.

skrydal

LGTM

feat(ingest/salesforce): helpful error messages on failure

28e0ec9

github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Aug 29, 2024

Merge branch 'master' into salesforce_error_messages

56db1f8

vercel bot had a problem deploying to Preview August 29, 2024 11:37 Failure

Merge branch 'master' into salesforce_error_messages

0855b9c

vercel bot deployed to Preview August 29, 2024 12:33 View deployment

skrydal reviewed Aug 29, 2024

View reviewed changes

skrydal requested changes Aug 29, 2024

View reviewed changes

address review comment

837bcd4

mayurinehate requested a review from skrydal August 30, 2024 05:57

vercel bot deployed to Preview August 30, 2024 06:20 View deployment

skrydal approved these changes Aug 30, 2024

View reviewed changes

Merge branch 'master' into salesforce_error_messages

bc53923

vercel bot deployed to Preview September 3, 2024 05:07 View deployment

Merge branch 'master' into salesforce_error_messages

986c848

vercel bot deployed to Preview September 5, 2024 11:42 View deployment

hsheth2 approved these changes Sep 5, 2024

View reviewed changes

hsheth2 merged commit d788cd7 into datahub-project:master Sep 5, 2024
68 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ingest/salesforce): helpful error messages on failure #11266

feat(ingest/salesforce): helpful error messages on failure #11266

mayurinehate commented Aug 29, 2024

coderabbitai bot commented Aug 29, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

skrydal Aug 29, 2024

skrydal Aug 29, 2024

mayurinehate Aug 30, 2024

mayurinehate Aug 30, 2024 •

edited

Loading

skrydal Aug 29, 2024

skrydal left a comment

skrydal left a comment

feat(ingest/salesforce): helpful error messages on failure #11266

feat(ingest/salesforce): helpful error messages on failure #11266

Conversation

mayurinehate commented Aug 29, 2024

Checklist

coderabbitai bot commented Aug 29, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

skrydal Aug 29, 2024

Choose a reason for hiding this comment

skrydal Aug 29, 2024

Choose a reason for hiding this comment

mayurinehate Aug 30, 2024

Choose a reason for hiding this comment

mayurinehate Aug 30, 2024 • edited Loading

Choose a reason for hiding this comment

skrydal Aug 29, 2024

Choose a reason for hiding this comment

skrydal left a comment

Choose a reason for hiding this comment

skrydal left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Aug 29, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mayurinehate Aug 30, 2024 •

edited

Loading