Refactor RedisLock (PP-1481)

[jonathangreen]

Description

Small refactor to the RedisLock class.

• Add a new parameter to the lock() function called raise_when_not_acquired that raises an exception if the lock isn't acquired.
• Make the TaskLock class only optionally take a redis_client parameter.

Motivation and Context

This is a small refactor to attempt to DRY some uses of the RedisLock classes.

Almost all the uses of RedisLock have the same pattern where they try to acquire the lock, then they raise (or exit) if the lock wasn't acquired. Since we are doing this everywhere anyway, this should be the default behavior. I added raise_when_not_acquired to do this, and refactored existing code to use it.

Note: This changes the behavior of some tasks slightly. They used to silently exit if they couldn't acquire a lock, now they will exit with an error. Since we don't expect tasks to fail to get the lock, I think this is the correct thing to do, but it is a slight change.

The TaskLock class used to take a required redis_client parameter. Since it also takes a Task parameter, which has access to the redis client, we make it optional, and fall back to the redis client on the task.

How Has This Been Tested?

• Unit tests

Checklist

• I have updated the documentation accordingly.
• All new and existing tests passed.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.12%. Comparing base (e07e2cd) to head (d29308f).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2285   +/-   ##
=======================================
  Coverage   91.12%   91.12%           
=======================================
  Files         363      363           
  Lines       41330    41333    +3     
  Branches     8846     8846           
=======================================
+ Hits        37660    37663    +3     
  Misses       2408     2408           
  Partials     1262     1262           

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

[tdilauro]

Looks good. 🎸

Just one minor typo in a comment.

[tdilauro]

Minor typo here: "...[if] the lock..."