Skip to content

sqlite: do not leave database open after failed open #63854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anonrig wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −1
Open

sqlite: do not leave database open after failed open #63854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/node_sqlite.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,19 @@ bool DatabaseSync::Open() {
return false;
}

// sqlite3_open_v2() assigns a database handle even when it fails. Such a
// handle is in a "sick" state and may only be used to retrieve the error
// and must then be released with sqlite3_close(). Close and reset the
// handle on any failure below so that a failed open() does not leave the
// database in an open state.
bool opened = false;
auto reset_connection_on_failure = OnScopeLeave([&]() {
if (!opened && connection_ != nullptr) {
sqlite3_close_v2(connection_);
connection_ = nullptr;
}
});

// TODO(cjihrig): Support additional flags.
int default_flags = SQLITE_OPEN_URI;
int flags = open_config_.get_read_only()
Expand Down Expand Up @@ -1003,6 +1016,7 @@ bool DatabaseSync::Open() {
env()->isolate(), this, load_extension_ret, SQLITE_OK, false);
}

opened = true;
return true;
}

Expand Down
38 changes: 37 additions & 1 deletion test/parallel/test-sqlite-database-sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
const { skipIfSQLiteMissing } = require('../common');
skipIfSQLiteMissing();
const tmpdir = require('../common/tmpdir');
const { existsSync } = require('node:fs');
const { existsSync, mkdirSync } = require('node:fs');
const { join } = require('node:path');
const { DatabaseSync, StatementSync } = require('node:sqlite');
const { suite, test } = require('node:test');
Expand Down Expand Up @@ -308,6 +308,42 @@ suite('DatabaseSync.prototype.open()', () => {
});
t.assert.strictEqual(db.isOpen, true);
});

test('does not leave the database open after a failed open', (t) => {
// Regression test for https://github.com/nodejs/node/issues/63831
const dbDir = join(tmpdir.path, `database-dir-${cnt++}`);
const dbPath = join(dbDir, 'failed-open.db');
using db = new DatabaseSync(dbPath, { open: false });

// The directory does not exist, so opening the database fails.
t.assert.throws(() => {
db.open();
}, {
code: 'ERR_SQLITE_ERROR',
message: /unable to open database file/,
});
t.assert.strictEqual(db.isOpen, false);

// The connection must not be usable after a failed open.
t.assert.throws(() => {
db.exec('SELECT 1');
}, {
code: 'ERR_INVALID_STATE',
message: /database is not open/,
});
t.assert.throws(() => {
db.function('fn', () => {});
}, {
code: 'ERR_INVALID_STATE',
message: /database is not open/,
});

// The database can be opened once the underlying problem is resolved.
mkdirSync(dbDir);
t.assert.strictEqual(db.open(), undefined);
t.assert.strictEqual(db.isOpen, true);
db.exec('CREATE TABLE foo (id INTEGER PRIMARY KEY)');
});
});

suite('DatabaseSync.prototype.close()', () => {
Expand Down
Loading