feat(server): add api

packages/core/server/src/__tests__/lock-manager.test.ts

@@ -7,9 +7,10 @@
  * For more information, please refer to: https://www.nocobase.com/agreement.
  */
 
-import { Mutex, withTimeout } from 'async-mutex';
+import { Mutex, tryAcquire } from 'async-mutex';
 
 import { Application } from '../application';
+import { LockAcquireError } from '../lock-manager';
 
 function sleep(ms = 1000) {
   return new Promise((resolve) => {
@@ -19,7 +20,7 @@ function sleep(ms = 1000) {
 
 describe('lock manager', () => {
   describe.skip('mutex example', () => {
-    it('mutex', async () => {
+    it('acquire and release', async () => {
       const order = [];
       const lock = new Mutex();
       const release1 = await lock.acquire();
@@ -42,21 +43,18 @@ describe('lock manager', () => {
       expect(order).toEqual([1, 4, 2, 3, 5, 6]);
     });
 
-    it.skip('with timeout', async () => {
-      const lock = withTimeout(new Mutex(), 200);
-      const r1 = await lock.acquire();
+    it('tryAcquire', async () => {
+      const order = [];
+      const lock = new Mutex();
+      const l1 = tryAcquire(lock);
+      expect(l1.isLocked()).toBe(false);
+      const release1 = await lock.acquire();
       expect(lock.isLocked()).toBe(true);
-      const l2 = lock.acquire();
-      await sleep(100);
-      expect(lock.isLocked()).toBe(true);
-      setTimeout(async () => {
-        expect(lock.isLocked()).toBe(false);
-        const r2 = await l2;
-        expect(lock.isLocked()).toBe(true);
-        await r2();
-        expect(lock.isLocked()).toBe(false);
-      }, 150);
-      await sleep(300);
+      const l2 = tryAcquire(lock);
+      await expect(async () => {
+        const r2 = await l2.acquire();
+      }).rejects.toThrow();
+      await release1();
     });
   });
 
@@ -168,5 +166,28 @@ describe('lock manager', () => {
       await sleep(200);
       expect(order).toEqual([3, 4, 5, 1, 6, 2]);
     });
+
+    it('tryAcquire', async () => {
+      const release = await app.lockManager.acquire('test');
+      await expect(app.lockManager.tryAcquire('test')).rejects.toThrowError(LockAcquireError);
+      await release();
+      const lock = await app.lockManager.tryAcquire('test');
+      expect(lock.acquire).toBeTypeOf('function');
+      expect(lock.runExclusive).toBeTypeOf('function');
+
+      const order = [];
+      const r1 = await lock.acquire(200);
+      order.push(1);
+      setTimeout(async () => {
+        order.push(2);
+        await r1();
+        order.push(3);
+      }, 100);
+      const r2 = await lock.acquire(200);
+      order.push(4);
+      await sleep(300);
+      await r2();
+      expect(order).toEqual([1, 2, 3, 4]);
+    });
   });
 });

packages/core/server/src/lock-manager.ts

@@ -8,7 +8,7 @@
  */
 
 import { Registry } from '@nocobase/utils';
-import { Mutex, tryAcquire, MutexInterface, E_CANCELED } from 'async-mutex';
+import { Mutex, MutexInterface, E_CANCELED } from 'async-mutex';
 
 export type Releaser = () => void | Promise<void>;
 
@@ -22,7 +22,7 @@ export interface ILockAdapter {
   close(): Promise<void>;
   acquire(key: string, ttl: number): Releaser | Promise<Releaser>;
   runExclusive<T>(key: string, fn: () => Promise<T>, ttl: number): Promise<T>;
-  // tryAcquire(key: string, timeout?: number): Promise<ILock>;
+  tryAcquire(key: string, timeout?: number): Promise<ILock>;
 }
 
 export class LockAbortError extends Error {
@@ -32,7 +32,7 @@ export class LockAbortError extends Error {
 }
 
 export class LockAcquireError extends Error {
-  constructor(message, options) {
+  constructor(message, options?) {
     super(message, options);
   }
 }
@@ -87,22 +87,20 @@ class LocalLockAdapter implements ILockAdapter {
     }
   }
 
-  // async tryAcquire(key: string) {
-  //   try {
-  //     const lock = this.getLock(key);
-  //     await tryAcquire(lock);
-  //     return {
-  //       async acquire(ttl) {
-  //         return this.acquire(key, ttl);
-  //       },
-  //       async runExclusive(fn: () => Promise<any>, ttl) {
-  //         return this.runExclusive(key, fn, ttl);
-  //       },
-  //     };
-  //   } catch (e) {
-  //     throw new LockAcquireError('Lock acquire error', { cause: e });
-  //   }
-  // }
+  async tryAcquire(key: string) {
+    const lock = this.getLock(key);
+    if (lock.isLocked()) {
+      throw new LockAcquireError('lock is locked');
+    }
+    return {
+      acquire: async (ttl) => {
+        return this.acquire(key, ttl);
+      },
+      runExclusive: async (fn: () => Promise<any>, ttl) => {
+        return this.runExclusive(key, fn, ttl);
+      },
+    };
+  }
 }
 
 export interface LockAdapterConfig<C extends ILockAdapter = ILockAdapter> {
@@ -162,8 +160,8 @@ export class LockManager {
     return client.runExclusive(key, fn, ttl);
   }
 
-  // public async tryAcquire(key: string, ttl = 500) {
-  //   const client = await this.getAdapter();
-  //   return client.tryAcquire(key, ttl);
-  // }
+  public async tryAcquire(key: string) {
+    const client = await this.getAdapter();
+    return client.tryAcquire(key);
+  }
 }