Repository: nodejs/node
Pull request: sqlite: add DatabaseSync.prototype[Symbol.dispose]()

This commit adds support for the explicit resource management proposal to the sqlite module.

Refs: https://github.com/nodejs/node/pull/53752#discussion_r1667750387

<!--
Before submitting a pull request, please read:

- the CONTRIBUTING guide at https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md
- the commit message formatting guidelines at
  https://github.com/nodejs/node/blob/HEAD/doc/contributing/pull-requests.md#commit-message-guidelines

For code changes:
1. Include tests for any bug fixes or new features.
2. Update documentation if relevant.
3. Ensure that `make -j4 test` (UNIX), or `vcbuild test` (Windows) passes.

If you believe this PR should be highlighted in the Node.js CHANGELOG
please add the `notable-change` label.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
-->


Changed files:
filename: doc/api/sqlite.md
patch: @@ -291,6 +291,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

filename: lib/sqlite.js
patch: @@ -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;

filename: test/parallel/test-sqlite-database-sync-dispose.js
patch: @@ -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/);
+  });
+});