RedisWorker clean up orphaned items when dequeuing

[matt-aitken]

Somehow there were orphaned items in the RedisWorker queue (had a queue entry but no item). These started filling up the queue which means real work wasn't being done.

Changes

1. Clean up orphaned queue entries if the item doesn't exist.
2. Removed duplicate setting of invisibility timeout (it was already set correctly in the dequeued script).
3. Added tests for orphan removal.
4. Improved invisibility timeout test

Summary by CodeRabbit

• Tests
  • Enhanced test coverage for queue behavior, including improved verification of item acknowledgment, timing in dead letter queue handling, and a new test ensuring cleanup of orphaned queue entries.
• Style
  • Improved code formatting for better readability.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 599329a

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.

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.

Walkthrough

This update focuses on enhancing the test suite for the SimpleQueue implementation and refining its internal logic to better handle orphaned queue entries in Redis. The test file now includes more thorough verifications, a new test for orphaned entry cleanup, and timing adjustments for dead letter queue operations. In the queue logic, the method for handling dequeued items was simplified by removing the invisibility timeout mechanism and introducing explicit cleanup of orphaned entries within the Redis Lua script. No changes were made to the public interfaces.

Changes

File(s)	Change Summary
packages/redis-worker/src/queue.test.ts	Enhanced existing tests with additional assertions, added timing for DLQ tests, and introduced a new test for handling orphaned queue entries. Added import for direct Redis client use.
packages/redis-worker/src/queue.ts	Removed invisibility timeout logic in dequeue, updated Lua script to clean up orphaned entries from sorted set, and added minor formatting.

Sequence Diagram(s)

sequenceDiagram
    participant TestSuite
    participant SimpleQueue
    participant Redis
    TestSuite->>SimpleQueue: enqueue(item)
    SimpleQueue->>Redis: Add item to hash and sorted set
    TestSuite->>SimpleQueue: dequeue()
    SimpleQueue->>Redis: Lua script: check sorted set and hash
    alt Item exists in both
        Redis-->>SimpleQueue: Return item
    else Orphaned entry in sorted set
        Redis-->>SimpleQueue: Remove orphaned entry, return nothing
    end
    SimpleQueue-->>TestSuite: Return dequeued item or undefined

Loading

Suggested reviewers

• ericallam

Poem

In the warren of Redis, where queues hop and play,
We swept out the orphans, sent the stale bits away.
With tests that are sharper and scripts that are neat,
Our carrots of data are now quite complete!
🥕✨
— A rabbit who loves clean code

---

📜 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 56ec052 and 599329a.

📒 Files selected for processing (2)

• packages/redis-worker/src/queue.test.ts (4 hunks)
• packages/redis-worker/src/queue.ts (2 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.