Add reason to MarQS acknowledgeMessage to track why it's called

[ericallam]

Summary by CodeRabbit

Release Notes

• Improvements

  • Enhanced error logging and message acknowledgment across multiple services
  • Added more descriptive context to message acknowledgments
  • Improved error handling in queue processing

• Changes

  • Updated acknowledgment methods to include optional reason parameter
  • Refined error tracking in task run and checkpoint services

These updates improve system observability and provide more detailed logging for troubleshooting queue-related processes.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 38fcc85

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]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/webapp/app/v3/marqs/devQueueConsumer.server.ts

Oops! Something went wrong! :(

ESLint: 8.45.0

ESLint couldn't find the config "custom" to extend from. Please check that the name of the config is correct.

The config "custom" was referenced from the config file in "/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request focuses on enhancing error handling and logging across multiple services and queue consumers in the web application. The primary modification is the addition of a reason parameter to the acknowledgeMessage method, which allows for more detailed and context-specific message acknowledgments. The changes span several files in the apps/webapp/app/v3 directory, introducing more granular error reporting and improving the traceability of message processing across different components.

Changes

File	Change Summary
marqs/devQueueConsumer.server.ts	Enhanced error handling with more specific acknowledgment messages for parsing failures, missing task runs, and worker-related issues
marqs/index.server.ts	Added optional reason parameter to acknowledgeMessage method with default value "unknown"
marqs/sharedQueueConsumer.server.ts	Updated message acknowledgment with a descriptive reason string
requeueTaskRun.server.ts	Added specific acknowledgment reasons for task runs with "DELAYED", "WAITING_FOR_DEPLOY", and completed statuses
services/createCheckpoint.server.ts	Added acknowledgment reason when no checkpoint event is found
services/finalizeTaskRun.server.ts	Added acknowledgment reason for task run finalization
services/resumeAttempt.server.ts	Enhanced error messages for acknowledgments related to attempt resumption

Possibly related PRs

• Fix: Prevent failed resumes for very large batches #1598: Improvements in error handling and logging for attempt resumption services

Poem

🐰 In the realm of queues and code so bright,
Reasons now dance with messages' might
Logging leaps forward with context clear
No more mysteries, debugging draws near!
A rabbit's tale of error's delight 🚀

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a18e1d and 38fcc85.

📒 Files selected for processing (7)

• apps/webapp/app/v3/marqs/devQueueConsumer.server.ts (6 hunks)
• apps/webapp/app/v3/marqs/index.server.ts (4 hunks)
• apps/webapp/app/v3/marqs/sharedQueueConsumer.server.ts (1 hunks)
• apps/webapp/app/v3/requeueTaskRun.server.ts (2 hunks)
• apps/webapp/app/v3/services/createCheckpoint.server.ts (1 hunks)
• apps/webapp/app/v3/services/finalizeTaskRun.server.ts (1 hunks)
• apps/webapp/app/v3/services/resumeAttempt.server.ts (2 hunks)

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

• 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>, 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.