Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix(temporal): fix infinite retry of workflow after uninstallation #285

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

paul-nicolas
Copy link
Contributor

No description provided.

Copy link
Contributor

coderabbitai bot commented Jan 24, 2025

Walkthrough

The pull request introduces a new error handling case in the temporalPluginErrorCheck function within the Activities struct. The change specifically adds a condition to handle enginePlugins.ErrNotFound, transforming it into a non-retryable application error of type ErrTypeInvalidArgument. This modification enhances the error handling mechanism for scenarios where an engine plugin resource is not found, ensuring appropriate error classification without altering the existing error handling structure.

Changes

File Change Summary
internal/connectors/engine/activities/errors.go Added specific error handling for enginePlugins.ErrNotFound, converting it to a non-retryable ErrTypeInvalidArgument application error

Poem

🐰 In the realm of plugins, where errors dance and play,
A rabbit hops through code, finding a clearer way
When resources hide and cannot be found
A non-retryable error is swiftly bound!
Hop, hop, debugging with glee! 🔍✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@paul-nicolas paul-nicolas marked this pull request as ready for review January 24, 2025 13:25
@paul-nicolas paul-nicolas requested a review from a team as a code owner January 24, 2025 13:25
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.04%. Comparing base (4dc8e66) to head (2d6b929).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #285      +/-   ##
==========================================
- Coverage   73.07%   73.04%   -0.03%     
==========================================
  Files         537      537              
  Lines       27046    27048       +2     
==========================================
- Hits        19764    19758       -6     
- Misses       6224     6230       +6     
- Partials     1058     1060       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
internal/connectors/engine/activities/errors.go (1)

40-41: Great fix for preventing infinite retries!
By returning a non-retryable application error for enginePlugins.ErrNotFound, you ensure that Temporal won't keep retrying the workflow when a resource is missing. This effectively resolves the infinite retry loop.

If it suits your domain more specifically, consider adding a dedicated ErrTypeNotFound constant instead of reusing INVALID_ARGUMENT. For instance:

 const (
   ErrTypeStorage         = "STORAGE"
   ErrTypeDefault         = "DEFAULT"
   ErrTypeInvalidArgument = "INVALID_ARGUMENT"
   ErrTypeRateLimited     = "RATE_LIMITED"
   ErrTypeUnimplemented   = "UNIMPLEMENTED"
+  ErrTypeNotFound        = "NOT_FOUND"
 )
 
 case errors.Is(err, enginePlugins.ErrNotFound):
-  return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeInvalidArgument, err)
+  return temporal.NewNonRetryableApplicationError(err.Error(), ErrTypeNotFound, err)

This approach more distinctly conveys that the resource was missing rather than invalid.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4dc8e66 and 2d6b929.

📒 Files selected for processing (1)
  • internal/connectors/engine/activities/errors.go (2 hunks)
🔇 Additional comments (1)
internal/connectors/engine/activities/errors.go (1)

7-7: New import is appropriate.
The import for enginePlugins aligns with the introduced case for ErrNotFound. No issues here.

@paul-nicolas paul-nicolas merged commit 4b942f6 into main Jan 24, 2025
8 of 9 checks passed
@paul-nicolas paul-nicolas deleted the fix/infinite-retry-workflow branch January 24, 2025 13:57
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants