@harperfast/rocksdb-js 0.1.12 → 0.1.13

package/dist/index.d.cts

@@ -369,6 +369,18 @@ type TransactionOptions = {
   * @default false
   */
   disableSnapshot?: boolean;
+  /**
+  * The maximum number of times to retry the transaction.
+  *
+  * @default 3
+  */
+  maxRetries?: number;
+  /**
+  * Whether to retry the transaction if it fails with `IsBusy`.
+  *
+  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
+  */
+  retryOnBusy?: boolean;
 };
 type NativeTransaction = {
   id: number;
@@ -889,6 +901,7 @@ declare class DBI<T extends DBITransactional | unknown = unknown> {
 }
 //#endregion
 //#region src/database.d.ts
+type TransactionCallback<T> = (txn: Transaction, attempt: number) => T | PromiseLike<T>;
 interface RocksDatabaseOptions extends StoreOptions {
   /**
   * The column family name.
@@ -1133,7 +1146,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * });
   * ```
   */
-  transaction<T>(callback: (txn: Transaction) => T | PromiseLike<T>, options?: TransactionOptions): Promise<T | PromiseLike<T>>;
+  transaction<T>(callback: TransactionCallback<T>, options?: TransactionOptions): Promise<T | void>;
   /**
   * Executes all operations in the callback as a single transaction.
   *
@@ -1151,7 +1164,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * });
   * ```
   */
-  transactionSync<T>(callback: (txn: Transaction) => T | PromiseLike<T>, options?: TransactionOptions): T | PromiseLike<T> | undefined;
+  transactionSync<T>(callback: TransactionCallback<T>, options?: TransactionOptions): T | PromiseLike<T> | void;
   /**
   * Attempts to acquire a lock for a given key. If the lock is available,
   * the function returns `true` and the optional callback is never called.

package/dist/index.d.mts

@@ -369,6 +369,18 @@ type TransactionOptions = {
   * @default false
   */
   disableSnapshot?: boolean;
+  /**
+  * The maximum number of times to retry the transaction.
+  *
+  * @default 3
+  */
+  maxRetries?: number;
+  /**
+  * Whether to retry the transaction if it fails with `IsBusy`.
+  *
+  * @default `true` when the transaction is bound to a transaction log, otherwise `false`
+  */
+  retryOnBusy?: boolean;
 };
 type NativeTransaction = {
   id: number;
@@ -889,6 +901,7 @@ declare class DBI<T extends DBITransactional | unknown = unknown> {
 }
 //#endregion
 //#region src/database.d.ts
+type TransactionCallback<T> = (txn: Transaction, attempt: number) => T | PromiseLike<T>;
 interface RocksDatabaseOptions extends StoreOptions {
   /**
   * The column family name.
@@ -1133,7 +1146,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * });
   * ```
   */
-  transaction<T>(callback: (txn: Transaction) => T | PromiseLike<T>, options?: TransactionOptions): Promise<T | PromiseLike<T>>;
+  transaction<T>(callback: TransactionCallback<T>, options?: TransactionOptions): Promise<T | void>;
   /**
   * Executes all operations in the callback as a single transaction.
   *
@@ -1151,7 +1164,7 @@ declare class RocksDatabase extends DBI<DBITransactional> {
   * });
   * ```
   */
-  transactionSync<T>(callback: (txn: Transaction) => T | PromiseLike<T>, options?: TransactionOptions): T | PromiseLike<T> | undefined;
+  transactionSync<T>(callback: TransactionCallback<T>, options?: TransactionOptions): T | PromiseLike<T> | void;
   /**
   * Attempts to acquire a lock for a given key. If the lock is available,
   * the function returns `true` and the optional callback is never called.

package/dist/index.mjs

@@ -986,6 +986,29 @@ function getKeyParam(keyBuffer) {
 
 //#endregion
 //#region src/transaction.ts
+var TransactionAlreadyAbortedError = class extends Error {
+	code = "ERR_ALREADY_ABORTED";
+};
+var TransactionIsBusyError = class extends Error {
+	code = "ERR_BUSY";
+	hasLog;
+	txn;
+	constructor(error, txn) {
+		super(error.message);
+		this.hasLog = error.hasLog ?? false;
+		this.txn = txn;
+	}
+};
+var TransactionAbandonedError = class extends Error {
+	code = "ERR_TRANSACTION_ABANDONED";
+	hasLog;
+	txn;
+	constructor(error, txn) {
+		super(error.message);
+		this.hasLog = error.hasLog ?? false;
+		this.txn = txn;
+	}
+};
 /**
 * Provides transaction level operations to a transaction callback.
 */
@@ -1006,7 +1029,12 @@ var Transaction = class extends DBI {
 	* Abort the transaction.
 	*/
 	abort() {
-		this.#txn.abort();
+		try {
+			this.#txn.abort();
+		} catch (err) {
+			if (err instanceof Error && "code" in err && err.code === "ERR_TRANSACTION_ABANDONED") throw new TransactionAbandonedError(err, this);
+			throw err;
+		}
 	}
 	/**
 	* Commit the transaction.
@@ -1017,6 +1045,8 @@ var Transaction = class extends DBI {
 				this.notify("beforecommit");
 				this.#txn.commit(resolve, reject);
 			});
+		} catch (err) {
+			throw this.#handleCommitError(err);
 		} finally {
 			this.notify("aftercommit", {
 				next: null,
@@ -1032,6 +1062,8 @@ var Transaction = class extends DBI {
 		try {
 			this.notify("beforecommit");
 			this.#txn.commitSync();
+		} catch (err) {
+			throw this.#handleCommitError(err);
 		} finally {
 			this.notify("aftercommit", {
 				next: null,
@@ -1041,6 +1073,19 @@ var Transaction = class extends DBI {
 		}
 	}
 	/**
+	* Detect if error is an already aborted or busy error and return the appropriate error class.
+	*
+	* @param err - The error to check.
+	* @returns The specialized error.
+	*/
+	#handleCommitError(err) {
+		if (err instanceof Error && "code" in err) {
+			if (err.code === "ERR_ALREADY_ABORTED") return new TransactionAlreadyAbortedError(err.message);
+			if (err.code === "ERR_BUSY") return new TransactionIsBusyError(err, this);
+		}
+		return err;
+	}
+	/**
 	* Returns the transaction start timestamp in seconds. Defaults to the time at which
 	* the transaction was created.
 	*
@@ -1447,30 +1492,24 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	*/
 	async transaction(callback, options) {
 		if (typeof callback !== "function") throw new TypeError("Callback must be a function");
+		const maxRetries = options?.maxRetries ?? 3;
 		const txn = new Transaction(this.store, options);
 		let result;
-		try {
-			this.notify("begin-transaction");
-			result = await callback(txn);
-		} catch (err) {
+		this.notify("begin-transaction");
+		for (let attempt = 1; attempt <= maxRetries; attempt++) {
 			try {
-				txn.abort();
-			} catch (abortErr) {
-				if (abortErr instanceof Error && "code" in abortErr && abortErr.code === "ERR_ALREADY_ABORTED") return;
+				result = await callback(txn, attempt);
+			} catch (callbackErr) {
+				return this.#abortTransaction(txn, callbackErr);
 			}
-			throw err;
-		}
-		try {
-			await txn.commit();
-			return result;
-		} catch (err) {
-			if (err instanceof Error && "code" in err && err.code === "ERR_ALREADY_ABORTED") return;
 			try {
-				txn.abort();
-			} catch (abortErr) {
-				if (abortErr instanceof Error && "code" in abortErr && abortErr.code === "ERR_TRANSACTION_ABANDONED") throw abortErr;
+				await txn.commit();
+				return result;
+			} catch (commitErr) {
+				if (commitErr instanceof TransactionAlreadyAbortedError) return;
+				if (commitErr instanceof TransactionIsBusyError && (options?.retryOnBusy ?? commitErr.hasLog) && attempt <= maxRetries) continue;
+				this.#abandonTransaction(txn, commitErr);
 			}
-			throw err;
 		}
 	}
 	/**
@@ -1492,38 +1531,55 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	*/
 	transactionSync(callback, options) {
 		if (typeof callback !== "function") throw new TypeError("Callback must be a function");
-		const txn = new Transaction(this.store, options);
-		let result;
-		try {
-			this.notify("begin-transaction");
-			result = callback(txn);
-		} catch (err) {
+		const maxRetries = options?.maxRetries ?? 3;
+		const isRetryable = (err, attempt) => {
+			return err instanceof TransactionIsBusyError && (options?.retryOnBusy ?? err.hasLog) && attempt <= maxRetries;
+		};
+		const runAttempt = (attempt) => {
+			const txn = new Transaction(this.store, options);
+			let result;
 			try {
-				txn.abort();
-			} catch (err) {
-				if (err instanceof Error && "code" in err && err.code === "ERR_ALREADY_ABORTED") return;
+				result = callback(txn, attempt);
+			} catch (callbackErr) {
+				return this.#abortTransaction(txn, callbackErr);
 			}
-			throw err;
-		}
-		if (result && typeof result === "object" && "then" in result && typeof result.then === "function") return result.then((value) => {
+			if (typeof result?.then === "function") return result.then((value) => {
+				try {
+					txn.commitSync();
+					return value;
+				} catch (commitErr) {
+					if (commitErr instanceof TransactionAlreadyAbortedError) return;
+					if (isRetryable(commitErr, attempt)) return runAttempt(attempt + 1);
+					this.#abandonTransaction(txn, commitErr);
+				}
+			});
 			try {
 				txn.commitSync();
-				return value;
-			} catch (err) {
-				if (err instanceof Error && "code" in err && err.code === "ERR_ALREADY_ABORTED") return;
-				throw err;
+				return result;
+			} catch (commitErr) {
+				if (commitErr instanceof TransactionAlreadyAbortedError) return;
+				if (isRetryable(commitErr, attempt)) return runAttempt(attempt + 1);
+				this.#abandonTransaction(txn, commitErr);
 			}
-		});
+		};
+		this.notify("begin-transaction");
+		return runAttempt(1);
+	}
+	#abortTransaction(txn, callbackErr) {
 		try {
-			txn.commitSync();
-			return result;
-		} catch (err) {
-			if (err instanceof Error && "code" in err && err.code === "ERR_ALREADY_ABORTED") return;
-			try {
-				txn.abort();
-			} catch {}
-			throw err;
+			txn.abort();
+		} catch (abortErr) {
+			if (abortErr instanceof TransactionAlreadyAbortedError) return;
+		}
+		throw callbackErr;
+	}
+	#abandonTransaction(txn, commitErr) {
+		try {
+			txn.abort();
+		} catch (abortErr) {
+			if (abortErr instanceof TransactionAbandonedError) throw abortErr;
 		}
+		throw commitErr;
 	}
 	/**
 	* Attempts to acquire a lock for a given key. If the lock is available,
@@ -1827,7 +1883,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "0.1.12"
+	"rocksdb-js": "0.1.13"
 };
 
 //#endregion