Skip to content

fix(lock): release the Redis lock atomically #1478

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
rajanpanth wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(lock): release the Redis lock atomically #1478

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/lib/with-redis-lock.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ interface RedisLockOptions {
readonly ttlSeconds?: number;
}

// Compare-and-delete, so a holder can only ever release its own lock.
const RELEASE_LOCK_SCRIPT = `
if redis.call("get", KEYS[1]) == ARGV[1] then
return redis.call("del", KEYS[1])
end
return 0
`;

export class LockNotAcquiredError extends Error {
public constructor(key: string) {
super(`Failed to acquire Redis lock for key="${key}"`);
Expand All @@ -30,10 +38,7 @@ export async function withRedisLock<TResult>(
return await callback();
} finally {
try {
const currentToken = await redis.get<string>(key);
if (currentToken === token) {
await redis.del(key);
}
await redis.eval(RELEASE_LOCK_SCRIPT, [key], [token]);
} catch (releaseError) {
console.error(
`Failed to release Redis lock for key="${key}":`,
Expand Down