sqlite: expose prepared statement statistics

[geeksilva97]

Closes #64540

[nodejs-github-bot]

Review requested:

• @nodejs/sqlite

[bakkot]

I'm a little uncomfortable with getters that create an object every time they're read.

[codecov]

Codecov Report

❌ Patch coverage is 89.18919% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.33%. Comparing base (cb9bb66) to head (11ac9a0).
⚠️ Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
src/node_sqlite.cc	89.18%	0 Missing and 4 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #64541      +/-   ##
==========================================
+ Coverage   90.31%   90.33%   +0.01%     
==========================================
  Files         760      760              
  Lines      248532   248564      +32     
  Branches    46908    46909       +1     
==========================================
+ Hits       224467   224534      +67     
+ Misses      15505    15456      -49     
- Partials     8560     8574      +14     

Files with missing lines	Coverage Δ
src/node_sqlite.h	82.60% <ø> (ø)
src/node_sqlite.cc	81.63% <89.18%> (+0.14%)	⬆️

... and 23 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[geeksilva97]

Please @nodejs/sqlite , share your thoughts

[araujogui]

Another method to reset stats would be nice to have

[araujogui]

SQLITE_STMTSTATUS_FILTER_MISS and SQLITE_STMTSTATUS_FILTER_HIT was introduced in SQLite 3.38.0.

3.37.2: https://github.com/sqlite/sqlite/blob/version-3.37.2/src/sqlite.h.in
3.38.0: https://github.com/sqlite/sqlite/blob/version-3.38.0/src/sqlite.h.in

[araujogui]

So maybe we need to enforce a minimum SQLite version on --shared-sqlite

[geeksilva97]

What do u suggest? A CHECK or something?

[geeksilva97]

I added some ifdefs. Let's see what the team says

[geeksilva97]

Please @araujogui . Let me know if you have any other concerns

[trivikr]

Verified against a rebuilt PR head. One issue is a reproducible native crash; the other comments correct the documented SQLite semantics.

[trivikr]

Resetting SQLITE_STMTSTATUS_REPREPARE desynchronizes the iterator column-name cache. After caching names, altering the schema, calling resetStats(), and altering it again, the counter returns to the cached value and iterate() reads past the stale key array; I reproduced exit code 139. Please invalidate the cache and its generation when resetting stats. For example:

 void StatementSync::InvalidateColumnNameCache() {
   cached_column_names_.clear();
+  cached_column_names_reprepare_count_ = -1;
 }
@@
   for (const auto& info : kStatusMapping) {
     sqlite3_stmt_status(stmt->statement_, info.sqlite_status_id, true);
   }
+  stmt->InvalidateColumnNameCache();

[trivikr]

SQLITE_STMTSTATUS_MEMUSED is not a counter, and SQLite ignores resetFlg for it. I verified that it remains 3856 before and after resetStats(), so this contract cannot hold.

Suggested change

	Resets every counter reported by [`statement.stat()`][] back to zero. This
	method is a wrapper around [`sqlite3_stmt_status()`][] and is useful for
	Resets every counter reported by [`statement.stat()`][] back to zero, except
	`memused`, which reports current memory usage and cannot be reset. This

[trivikr]

SQLITE_STMTSTATUS_RUN increments on the first sqlite3_step(), not when execution completes; a partially consumed iterator increments it too.

Suggested change

	* `'run'` The number of times the statement has run to completion.
	* `'run'` The number of execution cycles started by the prepared statement.

[trivikr]

Regression rest for the suggestion from #64541 (comment)

Suggested change

	suite('StatementSync.prototype.resetStats()', () => {
	test('returns undefined', (t) => {
	suite('StatementSync.prototype.resetStats()', () => {
	test('invalidates cached iterator column names', (t) => {
	using db = new DatabaseSync(':memory:');
	db.exec('CREATE TABLE data(a); INSERT INTO data VALUES (1)');
	const stmt = db.prepare('SELECT * FROM data');
	db.exec('ALTER TABLE data RENAME COLUMN a TO b');
	stmt.iterate().toArray();
	stmt.resetStats();
	db.exec('ALTER TABLE data RENAME COLUMN b TO c');
	t.assert.deepStrictEqual(stmt.iterate().toArray(), [
	{ __proto__: null, c: 1 },
	]);
	});
	test('returns undefined', (t) => {