Merge pull request #155 from tursodatabase/interrupt

Add support for Database.interrupt()

Author: penberg

Cargo.lock

@@ -12,7 +12,7 @@ crate-type = ["cdylib"]
 
 [dependencies]
 tracing-subscriber = { version = "0.3", features = ["env-filter"] }
-libsql = { git = "https://github.com/tursodatabase/libsql/", rev = "f8954db1302a97d435f7fcd7bf0d155ee38d632d", features = ["encryption"] }
+libsql = { git = "https://github.com/tursodatabase/libsql/", rev = "58b016ab72eea7fc0118009fb03195449f202edc", features = ["encryption"] }
 tracing = "0.1"
 once_cell = "1.18.0"
 tokio = { version = "1.29.1", features = [ "rt-multi-thread" ] }

Cargo.toml

@@ -69,6 +69,7 @@ This function is currently not supported.
 ### loadExtension(path, [entryPoint]) ⇒ this
 
 Loads a SQLite3 extension
+
 ### exec(sql) ⇒ this
 
 Executes a SQL statement.
@@ -77,6 +78,12 @@ Executes a SQL statement.
 | ------ | ------------------- | ------------------------------------ |
 | sql    | <code>string</code> | The SQL statement string to execute. |
 
+### interrupt() ⇒ this
+
+Cancel ongoing operations and make them return at earliest opportunity.
+
+**Note:** This is an extension in libSQL and not available in `better-sqlite3`.
+
 ### close() ⇒ this
 
 Closes the database connection.

docs/api.md

@@ -26,6 +26,7 @@ const {
   databaseOpen,
   databaseOpenWithSync,
   databaseInTransaction,
+  databaseInterrupt,
   databaseClose,
   databaseSyncSync,
   databaseSyncUntilSync,
@@ -245,6 +246,13 @@ class Database {
     }
   }
 
+  /**
+   * Interrupts the database connection.
+   */
+  interrupt() {
+    databaseInterrupt.call(this.db);
+  }
+
   /**
    * Closes the database connection.
    */
@@ -309,10 +317,14 @@ class Statement {
    * @param bindParameters - The bind parameters for executing the statement.
    */
   get(...bindParameters) {
-    if (bindParameters.length == 1 && typeof bindParameters[0] === "object") {
-      return statementGet.call(this.stmt, bindParameters[0]);
-    } else {
-      return statementGet.call(this.stmt, bindParameters.flat());
+    try {
+      if (bindParameters.length == 1 && typeof bindParameters[0] === "object") {
+        return statementGet.call(this.stmt, bindParameters[0]);
+      } else {
+        return statementGet.call(this.stmt, bindParameters.flat());
+      }
+    } catch (err) {
+      throw convertError(err);
     }
   }
 
@@ -332,17 +344,21 @@ class Statement {
       nextRows: Array(100),
       nextRowIndex: 100,
       next() {
-        if (this.nextRowIndex === 100) {
-          rowsNext.call(rows, this.nextRows);
-          this.nextRowIndex = 0;
-        }
-        const row = this.nextRows[this.nextRowIndex];
-        this.nextRows[this.nextRowIndex] = undefined;
-        if (!row) {
-          return { done: true };
-        }
+        try {
+          if (this.nextRowIndex === 100) {
+            rowsNext.call(rows, this.nextRows);
+            this.nextRowIndex = 0;
+          }
+          const row = this.nextRows[this.nextRowIndex];
+          this.nextRows[this.nextRowIndex] = undefined;
+          if (!row) {
+            return { done: true };
+          }
         this.nextRowIndex++;
-        return { value: row, done: false };
+          return { value: row, done: false };
+        } catch (err) {
+          throw convertError(err);
+        }
       },
       [Symbol.iterator]() {
         return this;
@@ -357,11 +373,15 @@ class Statement {
    * @param bindParameters - The bind parameters for executing the statement.
    */
   all(...bindParameters) {
-    const result = [];
-    for (const row of this.iterate(...bindParameters)) {
-      result.push(row);
+    try {
+      const result = [];
+      for (const row of this.iterate(...bindParameters)) {
+        result.push(row);
+      }
+      return result;
+    } catch (err) {
+      throw convertError(err);
     }
-    return result;
   }
 
   /**

index.js

@@ -314,6 +314,20 @@ test.serial("Database.exec() after close()", async (t) => {
   });
 });
 
+test.serial("Database.interrupt()", async (t) => {
+  const db = t.context.db;
+  const stmt = await db.prepare("WITH RECURSIVE infinite_loop(n) AS (SELECT 1 UNION ALL SELECT n + 1 FROM infinite_loop) SELECT * FROM infinite_loop;");
+  const fut = stmt.all();
+  db.interrupt();
+  await t.throwsAsync(async () => {
+    await fut;
+  }, {
+    instanceOf: t.context.errorType,
+    message: 'interrupted',
+    code: 'SQLITE_INTERRUPT'
+  });
+});
+
 const connect = async (path_opt) => {
   const path = path_opt ?? "hello.db";
   const provider = process.env.PROVIDER;

integration-tests/package-lock.json

@@ -40,6 +40,7 @@ const {
   databaseOpen,
   databaseOpenWithSync,
   databaseInTransaction,
+  databaseInterrupt,
   databaseClose,
   databaseSyncAsync,
   databaseSyncUntilAsync,
@@ -246,6 +247,13 @@ class Database {
     });
   }
 
+  /**
+   * Interrupts the database connection.
+   */
+  interrupt() {
+    databaseInterrupt.call(this.db);
+  }
+
   /**
    * Closes the database connection.
    */
@@ -309,10 +317,14 @@ class Statement {
    * @param bindParameters - The bind parameters for executing the statement.
    */
   get(...bindParameters) {
-    if (bindParameters.length == 1 && typeof bindParameters[0] === "object") {
-      return statementGet.call(this.stmt, bindParameters[0]);
-    } else {
-      return statementGet.call(this.stmt, bindParameters.flat());
+    try {
+      if (bindParameters.length == 1 && typeof bindParameters[0] === "object") {
+        return statementGet.call(this.stmt, bindParameters[0]);
+      } else {
+        return statementGet.call(this.stmt, bindParameters.flat());
+      }
+    } catch (e) {
+      throw convertError(e);
     }
   }
 
@@ -332,18 +344,22 @@ class Statement {
       nextRows: Array(100),
       nextRowIndex: 100,
       next() {
-        if (this.nextRowIndex === 100) {
-          this.nextRows.fill(null);
-          rowsNext.call(rows, this.nextRows);
-          this.nextRowIndex = 0;
-        }
-        const row = this.nextRows[this.nextRowIndex];
-        this.nextRows[this.nextRowIndex] = null;
-        if (!row) {
-          return { done: true };
+        try {
+          if (this.nextRowIndex === 100) {
+            this.nextRows.fill(null);
+            rowsNext.call(rows, this.nextRows);
+            this.nextRowIndex = 0;
+          }
+          const row = this.nextRows[this.nextRowIndex];
+          this.nextRows[this.nextRowIndex] = null;
+          if (!row) {
+            return { done: true };
+          }
+          this.nextRowIndex++;
+          return { value: row, done: false };
+        } catch (e) {
+          throw convertError(e);
         }
-        this.nextRowIndex++;
-        return { value: row, done: false };
       },
       [Symbol.iterator]() {
         return this;
@@ -358,12 +374,16 @@ class Statement {
    * @param bindParameters - The bind parameters for executing the statement.
    */
   async all(...bindParameters) {
-    const result = [];
-    const it = await this.iterate(...bindParameters);
-    for (const row of it) {
-      result.push(row);
+    try {
+      const result = [];
+      const it = await this.iterate(...bindParameters);
+      for (const row of it) {
+        result.push(row);
+      }
+      return result;
+    } catch (e) {
+      throw convertError(e);
     }
-    return result;
   }
 
   /**

integration-tests/tests/async.test.js

@@ -126,6 +126,17 @@ impl Database {
         Ok(cx.boolean(result).upcast())
     }
 
+    pub fn js_interrupt(mut cx: FunctionContext) -> JsResult<JsUndefined> {
+        let db: Handle<'_, JsBox<Database>> = cx.this()?;
+        let conn = db.conn.borrow();
+        let conn = conn.as_ref().unwrap().clone();
+        conn.blocking_lock().interrupt().or_else(|err| {
+            throw_libsql_error(&mut cx, err)?;
+            Ok(())
+        })?;
+        Ok(cx.undefined())
+    }
+
     pub fn js_close(mut cx: FunctionContext) -> JsResult<JsUndefined> {
         // the conn will be closed when the last statement in discarded. In most situation that
         // means immediately because you don't want to hold on a statement for longer that its

promise.js

@@ -19,6 +19,7 @@ pub fn throw_libsql_error<'a, C: Context<'a>, T>(cx: &mut C, err: libsql::Error)
             cx.throw(err)?
         }
         _ => {
+            todo!("err = {:?}", err);
             let err = format!("{:?}", err);
             let err = JsError::error(cx, err).unwrap();
             let code = cx.string("");

src/database.rs

@@ -30,6 +30,7 @@ fn main(mut cx: ModuleContext) -> NeonResult<()> {
     cx.export_function("databaseOpen", Database::js_open)?;
     cx.export_function("databaseOpenWithSync", Database::js_open_with_sync)?;
     cx.export_function("databaseInTransaction", Database::js_in_transaction)?;
+    cx.export_function("databaseInterrupt", Database::js_interrupt)?;
     cx.export_function("databaseClose", Database::js_close)?;
     cx.export_function("databaseSyncSync", Database::js_sync_sync)?;
     cx.export_function("databaseSyncAsync", Database::js_sync_async)?;

src/errors.rs

@@ -43,6 +43,10 @@ declare class Database {
      * @param {string} sql - The SQL statement string to execute.
      */
     exec(sql: string): any;
+    /**
+     * Interrupts the database connection.
+     */
+    interrupt(): void;
     /**
      * Closes the database connection.
      */