Remove transaction async

Author: Oscar Franco

README.md

@@ -26,11 +26,12 @@ This library is sponsored by:
 
 [<img src="https://raw.githubusercontent.com/ospfranco/react-native-quick-sqlite/main/sponsors/stream.png">](https://getstream.io/try-for-free/?utm_source=ospfranco&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=ospfranco_December2022_Trial_klmh22)
 
-*Build cross-platform messaging experiences with Stream Chat API. Sign up for Stream's 30 day trial for free!*
+_Build cross-platform messaging experiences with Stream Chat API. Sign up for Stream's 30 day trial for free!_
 
-[*Try the React Native Chat Tutorial 💬*](https://getstream.io/chat/sdk/react-native/?utm_source=ospfranco&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=ospfranco_December2022_Trial_klmh22)
+[_Try the React Native Chat Tutorial 💬_](https://getstream.io/chat/sdk/react-native/?utm_source=ospfranco&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=ospfranco_December2022_Trial_klmh22)
 
 If you want to sponsor the development of this library, [get in touch](mailto:[email protected]).
+
 ## API
 
 ```typescript
@@ -45,7 +46,6 @@ db = {
   delete: () => void,
   attach: (dbNameToAttach: string, alias: string, location?: string) => void,
   detach: (alias: string) => void,
-  transactionAsync: (fn: (tx: TransactionAsync) => Promise<void>) => Promise<void>,
   transaction: (fn: (tx: Transaction) => void) => Promise<void>,
   execute: (query: string, params?: any[]) => QueryResult,
   executeAsync: (
@@ -101,6 +101,12 @@ await QuickSQLite.transaction('myDatabase', (tx) => {
     [0, 1]
   );
 
+  // offload from JS thread
+  await tx.executeAsync = tx.executeAsync(
+    'UPDATE sometable SET somecolumn = ? where somekey = ?',
+    [0, 1]
+  );
+
   // Any uncatched error ROLLBACK transaction
   throw new Error('Random Error!');
 
@@ -111,19 +117,6 @@ await QuickSQLite.transaction('myDatabase', (tx) => {
 });
 ```
 
-Async transactions are also possible:
-
-```ts
-await QuickSQLite.transactionAsync('myDatabase', async (tx) => {
-  tx.execute('UPDATE sometable SET somecolumn = ? where somekey = ?', [0, 1]);
-
-  await tx.executeAsync(
-    'UPDATE sometable SET somecolumn = ? where somekey = ?',
-    [0, 1]
-  );
-});
-```
-
 ### Batch operation
 
 Batch execution allows transactional execution of a set of commands

example/src/tests/rawQueries.spec.ts

@@ -386,7 +386,7 @@ export function registerBaseTests() {
       const age = chance.integer();
       const networth = chance.floating();
 
-      await db.transactionAsync(async tx => {
+      await db.transaction(async tx => {
         const res = await tx.executeAsync(
           'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
           [id, name, age, networth],
@@ -418,7 +418,7 @@ export function registerBaseTests() {
       const networth = chance.floating();
 
       try {
-        await db.transactionAsync(async tx => {
+        await db.transaction(async tx => {
           await tx.executeAsync(
             'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
             [id, name, age, networth],
@@ -441,7 +441,7 @@ export function registerBaseTests() {
       const age = chance.integer();
       const networth = chance.floating();
 
-      await db.transactionAsync(async tx => {
+      await db.transaction(async tx => {
         await tx.executeAsync(
           'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
           [id, name, age, networth],
@@ -466,7 +466,7 @@ export function registerBaseTests() {
       const age = chance.integer();
       const networth = chance.floating();
 
-      await db.transactionAsync(async tx => {
+      await db.transaction(async tx => {
         await tx.executeAsync(
           'INSERT INTO "User" (id, name, age, networth) VALUES(?, ?, ?, ?)',
           [id, name, age, networth],
@@ -491,7 +491,7 @@ export function registerBaseTests() {
       // ACT: Start multiple async transactions to upsert and select the same record
       const promises = [];
       for (let iteration = 1; iteration <= iterations; iteration++) {
-        const promised = db.transactionAsync(async tx => {
+        const promised = db.transaction(async tx => {
           // ACT: Upsert statement to create record / increment the value
           await tx.executeAsync(
             `
@@ -532,7 +532,7 @@ export function registerBaseTests() {
     });
 
     it('Async transaction, rejects on callback error', async () => {
-      const promised = db.transactionAsync(async tx => {
+      const promised = db.transaction(async tx => {
         throw new Error('Error from callback');
       });
 
@@ -548,7 +548,7 @@ export function registerBaseTests() {
     });
 
     it('Async transaction, rejects on invalid query', async () => {
-      const promised = db.transactionAsync(async tx => {
+      const promised = db.transaction(async tx => {
         await tx.executeAsync('SELECT * FROM [tableThatDoesNotExist];');
       });
 

package.json

@@ -53,7 +53,7 @@
     "@types/react": "18.0.26",
     "@types/react-native": "0.70.7",
     "husky": "^6.0.0",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.3",
     "react": "18.1.0",
     "react-native": "0.70.6",
     "react-native-builder-bob": "^0.18.2",

src/index.ts

@@ -110,12 +110,6 @@ export interface FileLoadResult extends BatchQueryResult {
 }
 
 export interface Transaction {
-  commit: () => QueryResult;
-  execute: (query: string, params?: any[]) => QueryResult;
-  rollback: () => QueryResult;
-}
-
-export interface TransactionAsync {
   commit: () => QueryResult;
   execute: (query: string, params?: any[]) => QueryResult;
   executeAsync: (
@@ -149,11 +143,10 @@ interface ISQLite {
     location?: string
   ) => void;
   detach: (mainDbName: string, alias: string) => void;
-  transactionAsync: (
+  transaction: (
     dbName: string,
-    fn: (tx: TransactionAsync) => Promise<any>
+    fn: (tx: Transaction) => Promise<void> | void
   ) => Promise<void>;
-  transaction: (dbName: string, fn: (tx: Transaction) => void) => Promise<void>;
   execute: (dbName: string, query: string, params?: any[]) => QueryResult;
   executeAsync: (
     dbName: string,
@@ -203,9 +196,7 @@ QuickSQLite.open = (dbName: string, location?: string) => {
 const _close = QuickSQLite.close;
 QuickSQLite.close = (dbName: string) => {
   _close(dbName);
-  // setImmediate(() => {
   delete locks[dbName];
-  // });
 };
 
 const _execute = QuickSQLite.execute;
@@ -230,91 +221,10 @@ QuickSQLite.executeAsync = async (
   return res;
 };
 
-QuickSQLite.transaction = (
-  dbName: string,
-  callback: (tx: Transaction) => void
-) => {
-  if (!locks[dbName]) {
-    throw Error(`No lock found on db: ${dbName}`);
-  }
-
-  let isFinalized = false;
-
-  // Local transaction context object implementation
-  const execute = (query: string, params?: any[]): QueryResult => {
-    if (isFinalized) {
-      throw Error(
-        `Quick SQLite Error: Cannot execute query on finalized transaction: ${dbName}`
-      );
-    }
-
-    return QuickSQLite.execute(dbName, query, params);
-  };
-
-  const commit = () => {
-    if (isFinalized) {
-      throw Error(
-        `Quick SQLite Error: Cannot execute commit on finalized transaction: ${dbName}`
-      );
-    }
-    const result = QuickSQLite.execute(dbName, 'COMMIT');
-    isFinalized = true;
-    return result;
-  };
-
-  const rollback = () => {
-    if (isFinalized) {
-      throw Error(
-        `Quick SQLite Error: Cannot execute rollback on finalized transaction: ${dbName}`
-      );
-    }
-    const result = QuickSQLite.execute(dbName, 'ROLLBACK');
-    isFinalized = true;
-    return result;
-  };
-
-  async function run() {
-    try {
-      QuickSQLite.execute(dbName, 'BEGIN TRANSACTION');
-
-      // Handle possible async callbacks
-      await callback({ commit, execute, rollback });
-
-      if (!isFinalized) {
-        commit();
-      }
-    } catch (executionError) {
-      if (!isFinalized) {
-        try {
-          rollback();
-        } catch (rollbackError) {
-          throw rollbackError;
-        }
-      }
-
-      throw executionError;
-    } finally {
-      locks[dbName].inProgress = false;
-      startNextTransaction(dbName);
-    }
-  }
-
-  return new Promise((resolve, reject) => {
-    const tx: PendingTransaction = {
-      start: () => {
-        run().then(resolve).catch(reject);
-      },
-    };
-
-    locks[dbName].queue.push(tx);
-    startNextTransaction(dbName);
-  });
-};
-
-QuickSQLite.transactionAsync = async (
+QuickSQLite.transaction = async (
   dbName: string,
-  callback: (tx: TransactionAsync) => Promise<any>
-) => {
+  fn: (tx: Transaction) => Promise<void>
+): Promise<void> => {
   if (!locks[dbName]) {
     throw Error(`Quick SQLite Error: No lock found on db: ${dbName}`);
   }
@@ -366,7 +276,7 @@ QuickSQLite.transactionAsync = async (
     try {
       await QuickSQLite.executeAsync(dbName, 'BEGIN TRANSACTION');
 
-      await callback({
+      await fn({
         commit,
         execute,
         executeAsync,
@@ -469,7 +379,7 @@ export const typeORMDriver = {
         transaction: (
           fn: (tx: Transaction) => Promise<void>
         ): Promise<void> => {
-          return QuickSQLite.transactionAsync(options.name, fn);
+          return QuickSQLite.transaction(options.name, fn);
         },
         close: (ok: any, fail: any) => {
           try {
@@ -510,8 +420,7 @@ export type QuickSQLiteConnection = {
   delete: () => void;
   attach: (dbNameToAttach: string, alias: string, location?: string) => void;
   detach: (alias: string) => void;
-  transactionAsync: (fn: (tx: TransactionAsync) => Promise<any>) => void;
-  transaction: (fn: (tx: Transaction) => void) => Promise<void>;
+  transaction: (fn: (tx: Transaction) => Promise<void> | void) => Promise<void>;
   execute: (query: string, params?: any[]) => QueryResult;
   executeAsync: (query: string, params?: any[]) => Promise<QueryResult>;
   executeBatch: (commands: SQLBatchTuple[]) => BatchQueryResult;
@@ -532,9 +441,7 @@ export const open = (options: {
     attach: (dbNameToAttach: string, alias: string, location?: string) =>
       QuickSQLite.attach(options.name, dbNameToAttach, alias, location),
     detach: (alias: string) => QuickSQLite.detach(options.name, alias),
-    transactionAsync: (fn: (tx: TransactionAsync) => Promise<any>) =>
-      QuickSQLite.transactionAsync(options.name, fn),
-    transaction: (fn: (tx: Transaction) => void) =>
+    transaction: (fn: (tx: Transaction) => Promise<void> | void) =>
       QuickSQLite.transaction(options.name, fn),
     execute: (query: string, params?: any[] | undefined): QueryResult =>
       QuickSQLite.execute(options.name, query, params),

yarn.lock

@@ -4653,10 +4653,10 @@ posix-character-classes@^0.1.0:
   resolved "https://registry.yarnpkg.com/posix-character-classes/-/posix-character-classes-0.1.1.tgz#01eac0fe3b5af71a2a6c02feabb8c1fef7e00eab"
   integrity sha1-AerA/jta9xoqbAL+q7jB/vfgDqs=
 
-prettier@^2.7.1:
-  version "2.7.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.7.1.tgz#e235806850d057f97bb08368a4f7d899f7760c64"
-  integrity sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==
+prettier@^2.8.3:
+  version "2.8.3"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.3.tgz#ab697b1d3dd46fb4626fbe2f543afe0cc98d8632"
+  integrity sha512-tJ/oJ4amDihPoufT5sM0Z1SKEuKay8LfVAMlbbhnnkvt6BUserZylqo2PN+p9KeljLr0OHa2rXHU1T8reeoTrw==
 
 pretty-format@^26.0.0, pretty-format@^26.5.2, pretty-format@^26.6.2:
   version "26.6.2"