feat(sqlite): add StatementSync.prototype.iterate method

[tpoisseau]

Hello,

I wanted an iterate method for StatementSync. An SQL query can return lot of rows, for memory efficiency it seems important we can fetch rows on demand, instead collect all in an array.

I'm not a C/C++ developer, so this was really challenging to create an object with a next callback with v8. I tried to obtain Iterator.prototype so the results extends Iterator. I did not found how to do it with v8.

I'm sure my code is not ready to be merged:

• memory leak.
  • follow similar algorithm than All
  • variables for next and return callback are wrapped by v8::External
    added to iterable_iterator JS Object, accessed from context (.This())
• no unit tests
  • I did not found unit tests for sqlite module, I can do some in JS, but in C++...
  • Maybe they are not mandatory for experimental modules ?
• solution to have an iterable iterator from iterate() is a bit hacky. in js sqlite module I decorate the method to return Iterator.from(<result from cpp iterate>).
  • If someone can help me to extend Iterator from v8 it could be great, else I'll keep the decorator.
• documentation

I'm hoping to get some help here to finalize this PR, so that we all get a quality iterate method.

Manual test:

// % ./node --experimental-sqlite
sqlite = require('node:sqlite');
db = new sqlite.DatabaseSync(':memory:');
stmt = db.prepare(`WITH cte(a) AS (VALUES (1), (2), (3)) SELECT * FROM cte`);
iterator = stmt.iterate();
// > Object [Iterator] {}
iterator.map(({a}) => a).map(x => x*x).toArray();
// > [ 1, 4, 9 ]

So it's properly integrated with JS iterator protocol, it's an iterable iterator, it's integrated with IteratoHelpers.

[himself65]

add test in tests/parallel

[tpoisseau]

Tests are added, I did not found better approach than Iterator.from, (SafeArrayIterator is not working for this case).
So I consider the PR is ready for a complete review.

Best regards,

[codecov]

Codecov Report

Attention: Patch coverage is 65.32258% with 43 lines in your changes missing coverage. Please review.

Project coverage is 87.99%. Comparing base (f270462) to head (3f3b946).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/node_sqlite.cc	65.32%	30 Missing and 13 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #54213      +/-   ##
==========================================
- Coverage   88.49%   87.99%   -0.51%     
==========================================
  Files         653      653              
  Lines      187728   187852     +124     
  Branches    36182    35885     -297     
==========================================
- Hits       166136   165292     -844     
- Misses      14814    15729     +915     
- Partials     6778     6831      +53     

Files with missing lines	Coverage Δ
src/node_sqlite.h	70.00% <ø> (ø)
src/node_sqlite.cc	81.17% <65.32%> (-2.65%)	⬇️

... and 92 files with indirect coverage changes

---- 🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests
• JS Bundle Analysis - Avoid shipping oversized bundles

[cjihrig]

@tpoisseau are you still interested in pursuing this? If so, could you rebase to resolve conflicts, and remove any merge commits, as our automation does not handle those very well.

[tpoisseau]

Yes, I would like to continue this PR so it can be merged.

I tried to rebase my branch, seems it's not great ^^'. I'll restore to previous state and retry.

[tpoisseau]

Ok, I found a simple way to "squash" all my commits:

git reset --soft upstream/main
git add .
git commit
git push --force-with-lease

Interactive rebase was way to hard in this context (merge commits, lot of commits)

[cjihrig]

LGTM with a small comment.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/63648/

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/63649/ 🟢

[cjihrig]

This should be able to land if the coverage-windows job ever passes.

[targos]

coverage-windows is broken because of a Visual Studio update. See https://github.com/nodejs/build/issues/55929

[targos]

Landed in bc701e9

[cjihrig]

https://github.com/nodejs/build/issues/55929

Thanks. By the way, that link seems to 404.

[targos]

Correct link: #55929