sqlite: add DatabaseSync.prototype[Symbol.dispose]()

cjihrig · aduh95 · commit 5c976f16cd08 · 2025-03-23T11:07:42.000+01:00
This commit adds support for the explicit resource management proposal to the sqlite module. Refs: #53752 (comment) PR-URL: #57506 Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: Edy Silva <edigleyssonsilva@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
diff --git a/doc/api/sqlite.md b/doc/api/sqlite.md
@@ -281,6 +281,17 @@ targetDb.applyChangeset(changeset);
 // Now that the changeset has been applied, targetDb contains the same data as sourceDb.
 ```
 
+### `database[Symbol.dispose]()`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+Closes the database connection. If the database connection is already closed
+then this is a no-op.
+
 ## Class: `Session`
 
 <!-- YAML
diff --git a/lib/sqlite.js b/lib/sqlite.js
@@ -1,5 +1,19 @@
 'use strict';
+const {
+  SymbolDispose,
+} = primordials;
 const { emitExperimentalWarning } = require('internal/util');
+const binding = internalBinding('sqlite');
 
 emitExperimentalWarning('SQLite');
-module.exports = internalBinding('sqlite');
+
+// TODO(cjihrig): Move this to C++ once Symbol.dispose reaches Stage 4.
+binding.DatabaseSync.prototype[SymbolDispose] = function() {
+  try {
+    this.close();
+  } catch {
+    // Ignore errors.
+  }
+};
+
+module.exports = binding;
diff --git a/test/parallel/test-sqlite-database-sync-dispose.js b/test/parallel/test-sqlite-database-sync-dispose.js
@@ -0,0 +1,32 @@
+'use strict';
+require('../common');
+const tmpdir = require('../common/tmpdir');
+const assert = require('node:assert');
+const { join } = require('node:path');
+const { DatabaseSync } = require('node:sqlite');
+const { suite, test } = require('node:test');
+let cnt = 0;
+
+tmpdir.refresh();
+
+function nextDb() {
+  return join(tmpdir.path, `database-${cnt++}.db`);
+}
+
+suite('DatabaseSync.prototype[Symbol.dispose]()', () => {
+  test('closes an open database', () => {
+    const db = new DatabaseSync(nextDb());
+    db[Symbol.dispose]();
+    assert.throws(() => {
+      db.close();
+    }, /database is not open/);
+  });
+
+  test('supports databases that are not open', () => {
+    const db = new DatabaseSync(nextDb(), { open: false });
+    db[Symbol.dispose]();
+    assert.throws(() => {
+      db.close();
+    }, /database is not open/);
+  });
+});
