Added error to sentry scope

[Omri-Levy]

User description

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

---

PR Type

enhancement, bug_fix

---

Description

• Enhanced error tracking in Sentry by adding extra context to the Sentry scopes within the captureHttpException method.
• Updated the submodule reference for data migrations to point to a new commit.

---

Changes walkthrough 📝

	Relevant files
Enhancement	sentry.service.ts Enhance Sentry Error Reporting with Additional Context      services/workflows-service/src/sentry/sentry.service.ts Added extra error context to Sentry scopes for better error tracking. +2/-0
Configuration changes	data-migrations Update Data Migrations Submodule Pointer                                  services/workflows-service/prisma/data-migrations Updated the submodule pointer for data migrations. +1/-1

---

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

Summary by CodeRabbit

• Bug Fixes
  • Enhanced error reporting by including additional error details in the Sentry logs for better debugging and issue resolution.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 67a2490

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 recent updates include a change in the subproject commit hash for the data migrations within the workflows service and a modification to the captureHttpException method in the SentryService class. The latter now sets an extra 'error' field in the Sentry scope before adding additional data and error level, enhancing error tracking capabilities.

Changes

File/Path	Change Summary
.../workflows-service/prisma/data-migrations	Updated subproject commit hash from d234189e598cae9e57f34d565a35a2ec1cb3f8b5 to 1e1ff2066e1c33f3d290a870175c84569290f3b5.
.../workflows-service/src/sentry/sentry.service.ts	Modified captureHttpException method to include setting an extra 'error' field in the Sentry scope.

In code we trust, our changes bright,
With hashes new and errors in sight.
From Sentry's scope to data's flow,
Our service grows with every throw.
🐰✨

---

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 (67a2490)

[github-actions]

PR Review 🔍

⏱️ Estimated effort to review [1-5]	2, because the changes are localized to specific functionality in the Sentry service and involve a straightforward update to the submodule reference. The changes are not extensive and are focused on enhancing error logging, which is typically less complex.
🧪 Relevant tests	No
⚡ Possible issues	Possible Bug: The error object added to Sentry's scope might not be fully serializable, which could lead to incomplete error reports or errors in the error reporting itself.
🔒 Security concerns	No

Code feedback:

---

relevant file	services/workflows-service/src/sentry/sentry.service.ts
suggestion	Consider checking the type and serializability of the error object before setting it as extra data in Sentry's scope. This ensures that all properties of the error can be serialized without issues, which is crucial for accurate error tracking. [important]
relevant line	scope.setExtra('error', error);

---

[github-actions]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add type checking and conversion for the error parameter to enhance error reporting structure Consider checking the type of the error parameter before setting it as extra data in the Sentry scope. If error is a string, it might be beneficial to convert it to an object that provides more structured information for debugging. services/workflows-service/src/sentry/sentry.service.ts [24] -scope.setExtra('error', error); +if (typeof error === 'string') { + scope.setExtra('error', { message: error }); +} else { + scope.setExtra('error', error); +} Suggestion importance[1-10]: 7 Why: The suggestion to check the type of error and convert it if it's a string is valid and improves the structure of error reporting in Sentry, making debugging more efficient. However, it's not a critical bug fix but rather an enhancement for better data handling.	7

[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 f7cbe02 and 67a2490.

Files selected for processing (2)

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

Files skipped from review due to trivial changes (1)

• services/workflows-service/prisma/data-migrations

Additional comments not posted (2)

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

24-24: Adding the error to the Sentry scope as extra data is a good practice for better error context in Sentry.

---

25-25: The blank line improves readability by separating logical sections of the code.