Skip to content

sqlite: check sqlite3_step() and sqlite3_reset() results #63319

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
semimikoh wants to merge 2 commits into
base: main
Choose a base branch
from
+138 −14
Open

sqlite: check sqlite3_step() and sqlite3_reset() results #63319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fae197
sqlite: check sqlite3_step() and sqlite3_reset() results
semimikoh May 15, 2026
52592e6
sqlite: address review feedback on reset error handling
semimikoh Aug 7, 2026
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
76 changes: 62 additions & 14 deletions src/node_sqlite.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ inline MaybeLocal<String> Utf8StringMaybeOneByte(Isolate* isolate,
} \
} while (0)

#define RESET_OR_THROW(isolate, db, stmt, ret) \
CHECK_ERROR_OR_THROW((isolate), (db), sqlite3_reset((stmt)), SQLITE_OK, (ret))

// Surface deferred SQLite errors that sqlite3_reset() returns from the prior
// sqlite3_step(). Disables the safety-net reset guard via |needs_reset|.
#define RESET_AND_CHECK(isolate, db, stmt, needs_reset, ret) \
do { \
(needs_reset) = false; \
RESET_OR_THROW((isolate), (db), (stmt), (ret)); \
} while (0)

#define THROW_AND_RETURN_ON_BAD_STATE(env, condition, msg) \
do { \
if ((condition)) { \
Expand Down Expand Up @@ -2989,9 +3000,20 @@ MaybeLocal<Object> StatementExecutionHelper::Run(Environment* env,
bool use_big_ints) {
Isolate* isolate = env->isolate();
EscapableHandleScope scope(isolate);
sqlite3_step(stmt);
int r = sqlite3_reset(stmt);
CHECK_ERROR_OR_THROW(isolate, db, r, SQLITE_OK, MaybeLocal<Object>());
bool needs_reset = true;
auto reset = OnScopeLeave([&]() {
if (needs_reset) sqlite3_reset(stmt);
});

int step_r = sqlite3_step(stmt);
// SQLITE_ROW is accepted here (and discarded) so that run() can still be
// used on RETURNING/SELECT statements, matching prior behavior of
// ignoring the step result entirely.
if (step_r != SQLITE_DONE && step_r != SQLITE_ROW) {

@TrevorBurnham TrevorBurnham Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: accepting SQLITE_ROW here is right (run() on a RETURNING/SELECT statement should step once and discard) and matches the previous behavior of ignoring the step result entirely. A short comment would keep someone from "tightening" this to != SQLITE_DONE later.

THROW_ERR_SQLITE_ERROR(isolate, db);
return MaybeLocal<Object>();
}
RESET_AND_CHECK(isolate, db, stmt, needs_reset, MaybeLocal<Object>());

sqlite3_int64 last_insert_rowid = sqlite3_last_insert_rowid(db->Connection());
sqlite3_int64 changes = sqlite3_changes64(db->Connection());
Expand Down Expand Up @@ -3065,18 +3087,25 @@ MaybeLocal<Value> StatementExecutionHelper::Get(Environment* env,
bool use_big_ints) {
Isolate* isolate = env->isolate();
EscapableHandleScope scope(isolate);
auto reset = OnScopeLeave([&]() { sqlite3_reset(stmt); });
bool needs_reset = true;
auto reset = OnScopeLeave([&]() {
if (needs_reset) sqlite3_reset(stmt);
});

int r = sqlite3_step(stmt);
if (r == SQLITE_DONE) return scope.Escape(Undefined(isolate));
if (r == SQLITE_DONE) {
RESET_AND_CHECK(isolate, db, stmt, needs_reset, MaybeLocal<Value>());
return scope.Escape(Undefined(isolate));
}
if (r != SQLITE_ROW) {
THROW_ERR_SQLITE_ERROR(isolate, db);
return MaybeLocal<Value>();
}

int num_cols = sqlite3_column_count(stmt);
if (num_cols == 0) {
return Undefined(isolate);
RESET_AND_CHECK(isolate, db, stmt, needs_reset, MaybeLocal<Value>());
return scope.Escape(Undefined(isolate));
}

LocalVector<Value> row_values(isolate);
Expand All @@ -3085,9 +3114,9 @@ MaybeLocal<Value> StatementExecutionHelper::Get(Environment* env,
return MaybeLocal<Value>();
}

Local<Value> result;
if (return_arrays) {
return scope.Escape(
Array::New(isolate, row_values.data(), row_values.size()));
result = Array::New(isolate, row_values.data(), row_values.size());
} else {
LocalVector<Name> keys(isolate);
keys.reserve(num_cols);
Expand All @@ -3100,9 +3129,12 @@ MaybeLocal<Value> StatementExecutionHelper::Get(Environment* env,
}

DCHECK_EQ(keys.size(), row_values.size());
return scope.Escape(Object::New(
isolate, Null(isolate), keys.data(), row_values.data(), num_cols));
result = Object::New(
isolate, Null(isolate), keys.data(), row_values.data(), num_cols);
}

RESET_AND_CHECK(isolate, db, stmt, needs_reset, MaybeLocal<Value>());

@TrevorBurnham TrevorBurnham Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After a SQLITE_ROW step the VDBE is still in RUN_STATE, so this reset runs sqlite3VdbeHalt() and can genuinely fail — unlike the SQLITE_DONE path above, where the halt already happened during the step, making that check effectively a no-op. So get() can now throw after the row was built: e.g. INSERT ... RETURNING id with PRAGMA foreign_keys = ON and a deferred FK violation, where the implicit commit fails at reset. Same for all(), which discards a fully-built array.

That's arguably the more correct behavior, but it's a change on a path that currently succeeds, so it deserves a test and possibly a notable-change label.

return scope.Escape(result);
}

void StatementSync::All(const FunctionCallbackInfo<Value>& args) {
Expand All @@ -3119,15 +3151,19 @@ void StatementSync::All(const FunctionCallbackInfo<Value>& args) {
return;
}

auto reset = OnScopeLeave([&]() { sqlite3_reset(stmt->statement_); });

bool needs_reset = true;
auto reset = OnScopeLeave([&]() {
if (needs_reset) sqlite3_reset(stmt->statement_);
});
Local<Value> result;
if (StatementExecutionHelper::All(env,
stmt->db_.get(),
stmt->statement_,
stmt->return_arrays_,
stmt->use_big_ints_)
.ToLocal(&result)) {
RESET_AND_CHECK(
isolate, stmt->db_.get(), stmt->statement_, needs_reset, void());
args.GetReturnValue().Set(result);
}
}
Expand Down Expand Up @@ -3566,14 +3602,19 @@ void SQLTagStore::All(const FunctionCallbackInfo<Value>& args) {
}
}

auto reset = OnScopeLeave([&]() { sqlite3_reset(stmt->statement_); });
bool needs_reset = true;
auto reset = OnScopeLeave([&]() {
if (needs_reset) sqlite3_reset(stmt->statement_);
});
Local<Value> result;
if (StatementExecutionHelper::All(env,
stmt->db_.get(),
stmt->statement_,
stmt->return_arrays_,
stmt->use_big_ints_)
.ToLocal(&result)) {
RESET_AND_CHECK(
isolate, stmt->db_.get(), stmt->statement_, needs_reset, void());
args.GetReturnValue().Set(result);
}
}
Expand Down Expand Up @@ -3800,7 +3841,10 @@ void StatementSyncIterator::Next(const FunctionCallbackInfo<Value>& args) {
if (r != SQLITE_ROW) {
CHECK_ERROR_OR_THROW(
env->isolate(), iter->stmt_->db_.get(), r, SQLITE_DONE, void());
sqlite3_reset(iter->stmt_->statement_);
RESET_OR_THROW(env->isolate(),

@TrevorBurnham TrevorBurnham Aug 6, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same shape: this early return skips the {done: true, value: null} result, and done_ is never set on this path (it's only written in the constructor and in Return()), so a caught error leaves the iterator resumable on an already-reset statement.

Setting iter->done_ = true here also fixes a pre-existing bug — after natural exhaustion the iterator already restarts today:

const it = stmt.iterate();
while (!it.next().done);
it.next();  // yields row 1 again

iter->stmt_->db_.get(),
iter->stmt_->statement_,
void());
iter->done_ = true;
MaybeLocal<Value> values[] = {Boolean::New(isolate, true), Null(isolate)};
Local<Object> result;
Expand Down Expand Up @@ -3853,6 +3897,10 @@ void StatementSyncIterator::Return(const FunctionCallbackInfo<Value>& args) {
env, iter->stmt_->IsFinalized(), "statement has been finalized");
Isolate* isolate = env->isolate();

// Unlike Next(), the reset result is intentionally ignored here: Return()
// is invoked by the language during abrupt completion (e.g. a `throw`
// inside a `for...of` body), and throwing on a deferred SQLite error
// would discard the caller's already-pending exception.
sqlite3_reset(iter->stmt_->statement_);
iter->done_ = true;

Expand Down
76 changes: 76 additions & 0 deletions test/parallel/test-sqlite-statement-sync.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,28 @@ suite('StatementSync.prototype.get()', () => {
message: /statement has been finalized/,
});
});

test('surfaces a deferred SQLite error from reset() even though a row was already built', (t) => {
using db = new DatabaseSync(':memory:');
db.exec(`
PRAGMA foreign_keys = ON;
PRAGMA defer_foreign_keys = ON;
CREATE TABLE parent(id INTEGER PRIMARY KEY);
CREATE TABLE child(id INTEGER PRIMARY KEY, parent_id INTEGER REFERENCES parent(id));
`);
// The FK check is deferred until the implicit transaction commits, which
// happens inside reset() here because RETURNING leaves the statement's
// VDBE running after the row is produced.
const stmt = db.prepare(
'INSERT INTO child (parent_id) VALUES (999) RETURNING id'
);
t.assert.throws(() => {
stmt.get();
}, {
code: 'ERR_SQLITE_ERROR',
message: /FOREIGN KEY constraint failed/,
});
});
});

suite('StatementSync.prototype.all()', () => {
Expand Down Expand Up @@ -144,6 +166,25 @@ suite('StatementSync.prototype.all()', () => {
message: /statement has been finalized/,
});
});

test('surfaces a deferred SQLite error from reset() even though the array was already built', (t) => {
using db = new DatabaseSync(':memory:');
db.exec(`
PRAGMA foreign_keys = ON;
PRAGMA defer_foreign_keys = ON;
CREATE TABLE parent(id INTEGER PRIMARY KEY);
CREATE TABLE child(id INTEGER PRIMARY KEY, parent_id INTEGER REFERENCES parent(id));
`);
const stmt = db.prepare(
'INSERT INTO child (parent_id) VALUES (999) RETURNING id'
);
t.assert.throws(() => {
stmt.all();
}, {
code: 'ERR_SQLITE_ERROR',
message: /FOREIGN KEY constraint failed/,
});
});
});

suite('StatementSync.prototype.iterate()', () => {
Expand Down Expand Up @@ -322,6 +363,41 @@ suite('StatementSync.prototype.iterate()', () => {
message: /statement has been finalized/,
});
});

test('does not replay results after the iterator is naturally exhausted', (t) => {
using db = new DatabaseSync(':memory:');
db.exec(`
CREATE TABLE test(key TEXT);
INSERT INTO test (key) VALUES ('key1');
`);
const it = db.prepare('SELECT * FROM test').iterate();
t.assert.deepStrictEqual(it.next(), {
__proto__: null, done: false, value: { __proto__: null, key: 'key1' },
});
t.assert.deepStrictEqual(
it.next(), { __proto__: null, done: true, value: null });
// Calling next() again on an exhausted iterator must keep reporting
// done, not silently reset the statement and replay from row 1.
t.assert.deepStrictEqual(
it.next(), { __proto__: null, done: true, value: null });
});

test('propagates a pending exception when the loop body throws mid-iteration', (t) => {
using db = new DatabaseSync(':memory:');
db.exec(`
CREATE TABLE test(key TEXT);
INSERT INTO test (key) VALUES ('key1');
INSERT INTO test (key) VALUES ('key2');
`);
const stmt = db.prepare('SELECT * FROM test');
const userError = new Error('boom');
t.assert.throws(() => {
// eslint-disable-next-line no-unused-vars
for (const row of stmt.iterate()) {
throw userError;
}
}, (err) => err === userError);
});
});

suite('StatementSync.prototype.run()', () => {
Expand Down
Loading