Fixed isLocked(type) for RWLockWriter, removed functionality from RWLockReader because it is incorrect

Author: CMCDragonkai

docs/assets/search.js

@@ -2,7 +2,8 @@
 <a href="#js-async-locks" id="js-async-locks" style="color: inherit; text-decoration: none;">
   <h1>js-async-locks</h1>
 </a>
-<p><a href="https://gitlab.com/MatrixAI/open-source/js-async-locks/commits/master"><img src="https://gitlab.com/MatrixAI/open-source/js-async-locks/badges/master/pipeline.svg" alt="pipeline status"></a></p>
+<p>staging:<a href="https://gitlab.com/MatrixAI/open-source/js-async-locks/commits/staging"><img src="https://gitlab.com/MatrixAI/open-source/js-async-locks/badges/staging/pipeline.svg" alt="pipeline status"></a>
+master:<a href="https://gitlab.com/MatrixAI/open-source/js-async-locks/commits/master"><img src="https://gitlab.com/MatrixAI/open-source/js-async-locks/badges/master/pipeline.svg" alt="pipeline status"></a></p>
 <p>Asynchronous lock utilities.</p>
 
 <a href="#installation" id="installation" style="color: inherit; text-decoration: none;">

docs/classes/RWLockReader.html

@@ -16,7 +16,6 @@ class RWLockReader implements Lockable {
   protected readerCountBlocked: number = 0;
   protected _readerCount: number = 0;
   protected _writerCount: number = 0;
-  protected activeLock: 'read' | 'write' | null = null;
 
   public lock(
     type: 'read' | 'write',
@@ -70,10 +69,8 @@ class RWLockReader implements Lockable {
           throw e;
         }
         readersRelease();
-        this.activeLock = 'read';
       } else {
         readersRelease();
-        this.activeLock = 'read';
         // Yield for the first reader to finish locking
         await yieldMicro();
       }
@@ -86,7 +83,6 @@ class RWLockReader implements Lockable {
             this.writersRelease();
           }
           readersRelease();
-          this.activeLock = null;
           // Allow semaphore to settle https://github.com/DirtyHairy/async-mutex/issues/54
           await yieldMicro();
         },
@@ -113,12 +109,10 @@ class RWLockReader implements Lockable {
         --this._writerCount;
         throw e;
       }
-      this.activeLock = 'write';
       return [
         async () => {
           release();
           --this._writerCount;
-          this.activeLock = null;
           // Allow semaphore to settle https://github.com/DirtyHairy/async-mutex/issues/54
           await yieldMicro();
         },
@@ -143,15 +137,8 @@ class RWLockReader implements Lockable {
    * Check if locked
    * If passed `type`, it will also check that the active lock is of that type
    */
-  public isLocked(type?: 'read' | 'write'): boolean {
-    if (type != null) {
-      return (
-        this.activeLock === type &&
-        (this.readersLock.isLocked() || this.writersLock.isLocked())
-      );
-    } else {
-      return this.readersLock.isLocked() || this.writersLock.isLocked();
-    }
+  public isLocked(): boolean {
+    return this.readersLock.isLocked() || this.writersLock.isLocked();
   }
 
   public async waitForUnlock(timeout?: number): Promise<void> {

docs/classes/RWLockWriter.html

@@ -17,7 +17,6 @@ class RWLockWriter implements Lockable {
   protected readerCountBlocked: number = 0;
   protected _readerCount: number = 0;
   protected _writerCount: number = 0;
-  protected activeLock: 'read' | 'write' | null = null;
 
   public lock(
     type: 'read' | 'write',
@@ -71,9 +70,7 @@ class RWLockWriter implements Lockable {
           --this._readerCount;
           throw e;
         }
-        this.activeLock = 'read';
       } else {
-        this.activeLock = 'read';
         // Yield for the first reader to finish locking
         await yieldMicro();
       }
@@ -83,7 +80,6 @@ class RWLockWriter implements Lockable {
           // The last reader unlocks
           if (readerCount === 0) {
             this.readersRelease();
-            this.activeLock = null;
             // Allow semaphore to settle https://github.com/DirtyHairy/async-mutex/issues/54
             await yieldMicro();
           }
@@ -130,13 +126,11 @@ class RWLockWriter implements Lockable {
         await yieldMicro();
         throw e;
       }
-      this.activeLock = 'write';
       return [
         async () => {
           this.readersRelease();
           writersRelease();
           --this._writerCount;
-          this.activeLock = null;
           // Allow semaphore to settle https://github.com/DirtyHairy/async-mutex/issues/54
           await yieldMicro();
         },
@@ -162,11 +156,10 @@ class RWLockWriter implements Lockable {
    * If passed `type`, it will also check that the active lock is of that type
    */
   public isLocked(type?: 'read' | 'write'): boolean {
-    if (type != null) {
-      return (
-        this.activeLock === type &&
-        (this.readersLock.isLocked() || this.writersLock.isLocked())
-      );
+    if (type === 'read') {
+      return this.readersLock.isLocked();
+    } else if (type === 'write') {
+      return this.writersLock.isLocked();
     } else {
       return this.readersLock.isLocked() || this.writersLock.isLocked();
     }

docs/index.html

@@ -7,7 +7,7 @@ describe(RWLockReader.name, () => {
   test('withF', async () => {
     const lock = new RWLockReader();
     const p1 = withF([lock.read()], async ([lock]) => {
-      expect(lock.isLocked('read')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(1);
       expect(lock.writerCount).toBe(0);
     });
@@ -19,7 +19,7 @@ describe(RWLockReader.name, () => {
     expect(lock.readerCount).toBe(0);
     expect(lock.writerCount).toBe(0);
     const p2 = withF([lock.write()], async ([lock]) => {
-      expect(lock.isLocked('write')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(0);
       expect(lock.writerCount).toBe(1);
     });
@@ -38,22 +38,22 @@ describe(RWLockReader.name, () => {
       string,
       void
     > {
-      expect(lock.isLocked('read')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(1);
       expect(lock.writerCount).toBe(0);
       yield 'first';
-      expect(lock.isLocked('read')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(1);
       expect(lock.writerCount).toBe(0);
       yield 'second';
-      expect(lock.isLocked('read')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(1);
       expect(lock.writerCount).toBe(0);
       return 'last';
     });
     for await (const _ of g1) {
       // It should be locked during iteration
-      expect(lock.isLocked('read')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(1);
       expect(lock.writerCount).toBe(0);
     }
@@ -113,22 +113,22 @@ describe(RWLockReader.name, () => {
       string,
       void
     > {
-      expect(lock.isLocked('write')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(0);
       expect(lock.writerCount).toBe(1);
       yield 'first';
-      expect(lock.isLocked('write')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(0);
       expect(lock.writerCount).toBe(1);
       yield 'second';
-      expect(lock.isLocked('write')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(0);
       expect(lock.writerCount).toBe(1);
       return 'last';
     });
     for await (const _ of g1) {
       // It should be locked during iteration
-      expect(lock.isLocked('write')).toBe(true);
+      expect(lock.isLocked()).toBe(true);
       expect(lock.readerCount).toBe(0);
       expect(lock.writerCount).toBe(1);
     }