refactor: minor driver refactor

Author: Julien-R44

packages/verrou/src/drivers/database.ts

@@ -33,7 +33,7 @@ export class DatabaseStore implements LockStore {
   }
 
   /**
-   * Create a Knex connection instance
+   * Create or reuse a Knex connection instance
    */
   #createConnection(config: DatabaseStoreOptions) {
     if (typeof config.connection === 'string') {
@@ -89,7 +89,7 @@ export class DatabaseStore implements LockStore {
   }
 
   /**
-   * Save a new lock
+   * Save the lock in the store if not already locked by another owner
    *
    * We basically rely on primary key constraint to ensure the lock is
    * unique.
@@ -117,7 +117,8 @@ export class DatabaseStore implements LockStore {
   }
 
   /**
-   * Delete a lock
+   * Delete the lock from the store if it is owned by the owner
+   * Otherwise throws a E_LOCK_NOT_OWNED error
    */
   async delete(key: string, owner: string): Promise<void> {
     const currentOwner = await this.#getCurrentOwner(key)
@@ -127,14 +128,15 @@ export class DatabaseStore implements LockStore {
   }
 
   /**
-   * Force delete a lock
+   * Force delete the lock from the store. No check is made on the owner
    */
-  async forceRelease(key: string) {
+  async forceDelete(key: string) {
     await this.#connection.table(this.#tableName).where('key', key).delete()
   }
 
   /**
-   * Extend a lock
+   * Extend the lock expiration. Throws an error if the lock is not owned by the owner
+   * Duration is in milliseconds
    */
   async extend(key: string, owner: string, duration: number) {
     const updated = await this.#connection
@@ -147,7 +149,7 @@ export class DatabaseStore implements LockStore {
   }
 
   /**
-   * Check if a lock exists
+   * Check if the lock exists
    */
   async exists(key: string) {
     await this.#initialized

packages/verrou/src/drivers/dynamodb.ts

@@ -66,7 +66,7 @@ export class DynamoDBStore implements LockStore {
   }
 
   /**
-   * Save a lock
+   * Save the lock in the store if not already locked by another owner
    */
   async save(key: string, owner: string, ttl: number | null) {
     await this.#initialized
@@ -96,7 +96,8 @@ export class DynamoDBStore implements LockStore {
   }
 
   /**
-   * Delete a lock
+   * Delete the lock from the store if it is owned by the owner
+   * Otherwise throws a E_LOCK_NOT_OWNED error
    */
   async delete(key: string, owner: string) {
     const command = new DeleteItemCommand({
@@ -115,9 +116,9 @@ export class DynamoDBStore implements LockStore {
   }
 
   /**
-   * Force delete a lock
+   * Force delete the lock from the store. No check is made on the owner
    */
-  async forceRelease(key: string) {
+  async forceDelete(key: string) {
     const command = new DeleteItemCommand({
       TableName: this.#tableName,
       Key: { key: { S: key } },
@@ -127,7 +128,7 @@ export class DynamoDBStore implements LockStore {
   }
 
   /**
-   * Check if a lock exists
+   * Check if the lock exists
    */
   async exists(key: string) {
     await this.#initialized
@@ -142,6 +143,10 @@ export class DynamoDBStore implements LockStore {
     return result.Item !== undefined && !isExpired
   }
 
+  /**
+   * Extend the lock expiration. Throws an error if the lock is not owned by the owner
+   * Duration is in milliseconds
+   */
   async extend(key: string, owner: string, duration: number) {
     const command = new PutItemCommand({
       TableName: this.#tableName,

packages/verrou/src/drivers/memory.ts

@@ -49,7 +49,8 @@ export class MemoryStore implements LockStore {
   }
 
   /**
-   * Extend a lock
+   * Extend the lock expiration. Throws an error if the lock is not owned by the owner
+   * Duration is in milliseconds
    */
   async extend(key: string, owner: string, duration: number) {
     const lock = this.#locks.get(key)
@@ -59,7 +60,7 @@ export class MemoryStore implements LockStore {
   }
 
   /**
-   * Save a lock
+   * Save the lock in the store if not already locked by another owner
    */
   async save(key: string, owner: string, ttl: number | null) {
     try {
@@ -77,7 +78,8 @@ export class MemoryStore implements LockStore {
   }
 
   /**
-   * Delete a lock
+   * Delete the lock from the store if it is owned by the owner
+   * Otherwise throws a E_LOCK_NOT_OWNED error
    */
   async delete(key: string, owner: string) {
     const mutex = this.#locks.get(key)
@@ -89,17 +91,17 @@ export class MemoryStore implements LockStore {
   }
 
   /**
-   * Force delete a lock
+   * Force delete the lock from the store. No check is made on the owner
    */
-  async forceRelease(key: string) {
+  async forceDelete(key: string) {
     const lock = this.#locks.get(key)
     if (!lock) return
 
     lock.releaser?.()
   }
 
   /**
-   * Check if a lock exists
+   * Check if the lock exists
    */
   async exists(key: string) {
     const lock = this.#locks.get(key)

packages/verrou/src/drivers/redis.ts

@@ -25,7 +25,21 @@ export class RedisStore implements LockStore {
   }
 
   /**
-   * Delete a lock
+   * Save the lock in the store if not already locked by another owner
+   */
+  async save(key: string, owner: string, ttl: number | null) {
+    if (ttl) {
+      const result = await this.#connection.set(key, owner, 'PX', ttl, 'NX')
+      return result === 'OK'
+    }
+
+    const result = await this.#connection.setnx(key, owner)
+    return result === 1
+  }
+
+  /**
+   * Delete the lock from the store if it is owned by the owner
+   * Otherwise throws a E_LOCK_NOT_OWNED error
    */
   async delete(key: string, owner: string) {
     const lua = `
@@ -41,35 +55,23 @@ export class RedisStore implements LockStore {
   }
 
   /**
-   * Force delete a lock
+   * Force delete the lock from the store. No check is made on the owner
    */
-  async forceRelease(key: string) {
+  async forceDelete(key: string) {
     await this.#connection.del(key)
   }
 
   /**
-   * Check if a lock exists
+   * Check if the lock exists
    */
   async exists(key: string): Promise<boolean> {
     const result = await this.#connection.get(key)
     return !!result
   }
 
   /**
-   * Save a lock
-   */
-  async save(key: string, owner: string, ttl: number | null) {
-    if (ttl) {
-      const result = await this.#connection.set(key, owner, 'PX', ttl, 'NX')
-      return result === 'OK'
-    }
-
-    const result = await this.#connection.setnx(key, owner)
-    return result === 1
-  }
-
-  /**
-   * Extend a lock
+   * Extend the lock expiration. Throws an error if the lock is not owned by the owner
+   * Duration is in milliseconds
    */
   async extend(key: string, owner: string, duration: number) {
     const lua = `

packages/verrou/src/lock.ts

@@ -111,7 +111,7 @@ export class Lock {
    * Force release the lock
    */
   async forceRelease() {
-    await this.#lockStore.forceRelease(this.#key)
+    await this.#lockStore.forceDelete(this.#key)
   }
 
   /**

packages/verrou/src/types/main.ts

@@ -83,7 +83,7 @@ export interface LockStore {
   /**
    * Force delete the lock from the store. No check is made on the owner
    */
-  forceRelease(key: string): Promise<void>
+  forceDelete(key: string): Promise<void>
 
   /**
    * Check if the lock exists

packages/verrou/test_helpers/null_store.ts

@@ -13,7 +13,7 @@ export class NullStore implements LockStore {
     return true
   }
 
-  async forceRelease(_key: string): Promise<void> {
+  async forceDelete(_key: string): Promise<void> {
     return
   }