Skip to content

docs(orphans): fix incorrect comments on LuaReaper and RubyReaper#933

Merged
mhenrixon merged 1 commit intomainfrom
issue-870-lua-reaper-comment-fix
Mar 27, 2026
Merged

docs(orphans): fix incorrect comments on LuaReaper and RubyReaper#933
mhenrixon merged 1 commit intomainfrom
issue-870-lua-reaper-comment-fix

Conversation

@mhenrixon
Copy link
Copy Markdown
Owner

@mhenrixon mhenrixon commented Mar 27, 2026

Summary

  • LuaReaper incorrectly had the same comment as RubyReaper: "this is a much slower version of the lua script but does not crash redis"
  • Fixed LuaReaper comment to: "this is faster than the ruby reaper but may block redis while executing"
  • Fixed RubyReaper comment to: "this is slower than the lua reaper but does not block redis"

Closes #870

Test plan

  • Orphan specs: 105 examples, 0 failures

Summary by CodeRabbit

  • Documentation
    • Updated performance and Redis-behavior documentation to clarify trade-offs between available orphan-cleanup approaches.

LuaReaper had the same comment as RubyReaper ("slower version of the
lua script") which was clearly wrong — the Lua reaper IS the Lua script.
Fixed both comments to accurately describe each reaper's tradeoffs.

Closes #870
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 27, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4147cb4c-3a09-4c4b-923d-77bbba8b522a

📥 Commits

Reviewing files that changed from the base of the PR and between 51aaadc and 020cb58.

📒 Files selected for processing (2)
  • lib/sidekiq_unique_jobs/orphans/lua_reaper.rb
  • lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb

📝 Walkthrough

Walkthrough

Documentation updates to the LuaReaper and RubyReaper classes correcting performance characteristic descriptions. The Lua reaper comment was previously copy-pasted from the Ruby version, incorrectly claiming slower performance than itself.

Changes

Cohort / File(s) Summary
Reaper Documentation Updates
lib/sidekiq_unique_jobs/orphans/lua_reaper.rb, lib/sidekiq_unique_jobs/orphans/ruby_reaper.rb
Corrected class-level documentation to accurately describe relative performance: Lua reaper is faster but may block Redis; Ruby reaper is slower but doesn't block Redis.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A comment copy-paste, oh what a mistake!
The Lua reaper thought it was slow as a rake,
But truth has prevailed with a fix clean and bright,
Now Redis knows fast and slow done just right! 🚀


Comment @coderabbitai help to get the list of available commands and usage tips.

@mhenrixon mhenrixon self-assigned this Mar 27, 2026
@mhenrixon mhenrixon merged commit dc10315 into main Mar 27, 2026
31 of 32 checks passed
@mhenrixon mhenrixon deleted the issue-870-lua-reaper-comment-fix branch March 27, 2026 22:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lua Reaper comment is saying it is slower than itself

1 participant