Added error to sentry scope

[Omri-Levy]

User description

• fix(workflows-service): added context for errors in sentry
• fix(workflows-service): added sentry error scope to captureException

Description

Elaborate on the subject, motivation, and context.

Related issues

• Provide a link to each related issue.

Breaking changes

• Describe the breaking changes that this pull request introduces.

How these changes were tested

• Describe the tests that you ran to verify your changes, including devices, operating systems, browsers and versions.

Examples and references

• Links, screenshots, and other resources related to this change.

Checklist

• [] I have read the contribution guidelines of this project
• [] I have read the style guidelines of this project
• [] I have performed a self-review of my own code
• [] I have commented my code, particularly in hard-to-understand areas
• [] I have made corresponding changes to the documentation
• [] My changes generate no new warnings and errors
• [] New and existing tests pass locally with my changes

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error reporting to include additional data for better debugging and issue resolution.

---

PR Type

Bug fix

---

Description

• Enhanced the Sentry error handling in the captureException method by including additional error details to improve debugging and issue resolution.

---

Changes walkthrough 📝

	Relevant files
Enhancement	sentry.service.ts Enhance Sentry Error Reporting with Additional Data            services/workflows-service/src/sentry/sentry.service.ts Added extra error data to the Sentry scope in the captureException method. +2/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[changeset-bot]

⚠️ No Changeset found

Latest commit: 689fdc1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The SentryService class in the workflows-service has been updated to enhance error reporting. Specifically, the captureException method now includes functionality to set extra data for errors before invoking other internal methods. This improvement aims to provide more contextual information when capturing exceptions, aiding in better debugging and monitoring.

Changes

File	Change Summary
services/workflows-service/src/sentry/sentry.service.ts	Modified the captureException method in the SentryService class to set extra data for errors before calling other internal methods.

Poem

In the code where errors roam,
Sentry now makes data known,
With extra bits to guide the way,
Debugging woes kept well at bay.
🐇✨ The rabbit hops with cheer,
For clearer logs are finally here!

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[github-actions]

PR Description updated to latest commit (689fdc1)

[github-actions]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the PR involves a small change in a single file and the change is straightforward. The added lines are simple and the context of the change is well explained in the PR description.
🧪 Relevant tests	No
⚡ Possible issues	Type Mismatch: The scope.setExtra('error', error); might cause issues if error is not always an object that can be serialized properly by Sentry. If error can be a string, this might not provide the expected structured data in Sentry.
🔒 Security concerns	No

Code feedback:

---

relevant file	services/workflows-service/src/sentry/sentry.service.ts
suggestion	Consider checking the type of error before setting it as extra data in Sentry. This ensures that the data is always in a consistent format which is easier to debug. You might use a conditional check or a formatting function to standardize the error information. [important]
relevant line	scope.setExtra('error', error);

---

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add type checking for the error parameter to enhance error data structure in Sentry Consider checking the type of the error before setting it as an extra in the Sentry scope. If error is a string, directly setting it might not provide the structured data Sentry can utilize for better error tracking. Instead, you could check if error is an instance of Error and handle it accordingly. services/workflows-service/src/sentry/sentry.service.ts [12] -scope.setExtra('error', error); +if (error instanceof Error) { + scope.setExtra('error', { message: error.message, stack: error.stack }); +} else { + scope.setExtra('error', { message: error }); +} Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies an improvement in error handling by structuring the error data based on its type before sending it to Sentry, which can significantly enhance error tracking and debugging capabilities.	8

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1d05d51 and 689fdc1.

Files selected for processing (1)

• services/workflows-service/src/sentry/sentry.service.ts (1 hunks)

Additional comments not posted (2)

services/workflows-service/src/sentry/sentry.service.ts (2)

12-13: Add error context to Sentry scope.

The addition of scope.setExtra('error', error); provides valuable context for errors captured by Sentry. This is a good enhancement for debugging purposes.

---

Line range hint 22-22: Add error context to Sentry scope.

The inclusion of scope.setExtra('error', error); in the captureHttpException method is consistent with the changes in captureException and enhances error context.