Skip to content

There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

fix(server): handle expired lock re-release & external locker injection (#6145)

DarkSkyda32682afbf9
diff --git a/packages/backend/server/src/fundamentals/mutex/index.ts b/packages/backend/server/src/fundamentals/mutex/index.ts
index f8d136f5ce..2f234b8a5a 100644
--- a/packages/backend/server/src/fundamentals/mutex/index.ts
+++ b/packages/backend/server/src/fundamentals/mutex/index.ts
@@ -6,7 +6,7 @@ import { MutexService } from './mutex';
@Global()
@Module({
providers: [MutexService, Locker],
- exports: [MutexService, Locker],
+ exports: [MutexService],
})
export class MutexModule {}
diff --git a/packages/backend/server/src/fundamentals/mutex/mutex.ts b/packages/backend/server/src/fundamentals/mutex/mutex.ts
index 8d58c88eb0..68d744ed17 100644
--- a/packages/backend/server/src/fundamentals/mutex/mutex.ts
+++ b/packages/backend/server/src/fundamentals/mutex/mutex.ts
@@ -14,11 +14,21 @@ export const MUTEX_WAIT = 100;
@Injectable({ scope: Scope.REQUEST })
export class MutexService {
protected logger = new Logger(MutexService.name);
+ private readonly locker: Locker;
constructor(
@Inject(CONTEXT) private readonly context: GraphqlContext,
private readonly ref: ModuleRef
- ) {}
+ ) {
+ // nestjs will always find and injecting the locker from local module
+ // so the RedisLocker implemented by the plugin mechanism will not be able to overwrite the internal locker
+ // we need to use find and get the locker from the `ModuleRef` manually
+ //
+ // NOTE: when a `constructor` execute in normal service, the Locker module we expect may not have been initialized
+ // but in the Service with `Scope.REQUEST`, we will create a separate Service instance for each request
+ // at this time, all modules have been initialized, so we able to get the correct Locker instance in `constructor`
+ this.locker = this.ref.get(Locker, { strict: false });
+ }
protected getId() {
let id = this.context.req.headers['x-transaction-id'] as string;
@@ -55,10 +65,7 @@ export class MutexService {
async lock(key: string) {
try {
return await retryable(
- () => {
- const locker = this.ref.get(Locker, { strict: false });
- return locker.lock(this.getId(), key);
- },
+ () => this.locker.lock(this.getId(), key),
MUTEX_RETRY,
MUTEX_WAIT
);
diff --git a/packages/backend/server/src/plugins/redis/mutex.ts b/packages/backend/server/src/plugins/redis/mutex.ts
index 8f63019f65..496fdecf0b 100644
--- a/packages/backend/server/src/plugins/redis/mutex.ts
+++ b/packages/backend/server/src/plugins/redis/mutex.ts
@@ -4,19 +4,33 @@ import { Command } from 'ioredis';
import { ILocker, Lock } from '../../fundamentals';
import { SessionRedis } from './instances';
+// === atomic mutex lock ===
+// acquire lock
+// return 1 if lock is acquired
+// return 0 if lock is not acquired
const lockScript = `local key = KEYS[1]
-local clientId = ARGV[1]
+local owner = ARGV[1]
-if redis.call("get", key) == clientId or redis.call("set", key, clientId, "NX", "EX", 60) then
+-- if lock is not exists or lock is owned by the owner
+-- then set lock to the owner and return 1, otherwise return 0
+-- if the lock is not released correctly due to unexpected reasons
+-- lock will be released after 60 seconds
+if redis.call("get", key) == owner or redis.call("set", key, owner, "NX", "EX", 60) then
return 1
else
return 0
end`;
+// release lock
+// return 1 if lock is released or lock is not exists
+// return 0 if lock is not owned by the owner
const unlockScript = `local key = KEYS[1]
-local clientId = ARGV[1]
+local owner = ARGV[1]
-if redis.call("get", key) == clientId then
+local value = redis.call("get", key)
+if value == owner then
return redis.call("del", key)
+elseif value == nil then
+ return 1
else
return 0
end`;
@@ -40,7 +54,6 @@ export class RedisMutexLocker implements ILocker {
new Command('EVAL', [unlockScript, '1', lockKey, owner])
);
- // TODO(@darksky): lock expired condition is not handled
if (result === 0) {
throw new Error(`Failed to release lock ${key}`);
}