Skip to content
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.

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

Fixes generate_series to handle NULL arguments #1357

Merged
merged 5 commits into from
Jul 9, 2023
Merged

Fixes generate_series to handle NULL arguments #1357

merged 5 commits into from
Jul 9, 2023

Conversation

davidselassie
Copy link
Contributor

SQLite's generate_series behavior has it return an empty result set whenever any of the arguments are NULL.

SQLite version 3.37.2 2022-01-06 13:25:41
Enter ".help" for usage hints.
Connected to a transient in-memory database.
Use ".open FILENAME" to reopen on a persistent database.
sqlite> SELECT value FROM generate_series(0, 3);
┌───────┐
│ value │
├───────┤
│ 0     │
│ 1     │
│ 2     │
│ 3     │
└───────┘
sqlite> SELECT value FROM generate_series(0, NULL);
sqlite> SELECT value FROM generate_series(NULL);
sqlite> SELECT value FROM generate_series(0, 3, NULL);
sqlite> SELECT value FROM generate_series(0, NULL, 2);
sqlite> SELECT value FROM generate_series(NULL, 3, 2);
sqlite> 

rusqlite's re-implementation of generate_series that's behind the series Cargo feature has code suggesting it should have the same behavior of returning no rows, but instead errors out if any of the arguments are NULL.

SqliteFailure(Error { code: Unknown, extended_code: 1 }, Some("Invalid filter parameter type Null at index 0"))

This error was due to the args.get(i)? originally being inferred to be args.get::<i64>(i)? since they're being assigned to the parameters directly and thus NULL causes an error.

This PR fixes the behavior of rusqlite's generate_series to match that of SQLite's extension. It does this by interpreting those arguments as Option<i64> and if they are None`, then marks that the range should be set to result in no rows.

Adds some tests to the existing series module tests that show that NULL arguments result in no rows.

@davidselassie
Copy link
Contributor Author

davidselassie commented Jul 7, 2023

I saw that that b60ffe1#diff-1592000f020c13e61a6b81bdd6bec4f8c2a54bcadb4949cb660bdb81c5b1c346R215-R222 already existed, but it will never be reached because b60ffe1#diff-1592000f020c13e61a6b81bdd6bec4f8c2a54bcadb4949cb660bdb81c5b1c346R196 (and the equivalent lines for the other arguments) does not handle a NULL argument without erroring and returning early.

To confirm the behavior I was seeing, if you run tests on the first commit in this branch 84362c0 which only adds tests asserting no rows returned for NULL args, you'll see that they do not pass.

Is the goal to have the rusqlite version match the original logic as closely as possible? In that case I could change the lines to match the behavior of sqlite3_value_int64 in the original (which seems to handle NULL) be something like

self.min_value = args.get::<Option<i64>>(i)?.unwrap_or_default();

or

self.min_value = args.get(i).or_else(|e| match e {
   Error::InvalidFilterParameterType(_, Type::Null) => Ok(0),
   e => Err(e),
})?;

and keep the null checking loop below.

Or are you bringing this up for another reason?

@gwenn
Copy link
Collaborator

gwenn commented Jul 8, 2023

self.min_value = args.get::<Option>(i)?.unwrap_or_default();

Yes, could you please use this ?
Thanks.

@codecov
Copy link

codecov bot commented Jul 8, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.09 🎉

Comparison is base (3fe9a7f) 80.82% compared to head (256cfdd) 80.92%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1357      +/-   ##
==========================================
+ Coverage   80.82%   80.92%   +0.09%     
==========================================
  Files          49       49              
  Lines       10057    10059       +2     
==========================================
+ Hits         8129     8140      +11     
+ Misses       1928     1919       -9     
Impacted Files Coverage Δ
src/vtab/series.rs 83.18% <100.00%> (+3.84%) ⬆️

... and 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@gwenn gwenn merged commit 7b03932 into rusqlite:master Jul 9, 2023
16 checks passed
@gwenn
Copy link
Collaborator

gwenn commented Jul 9, 2023

Thanks.

@davidselassie davidselassie deleted the fix-null-series branch July 13, 2023 16:38
bors added a commit to rust-lang/cargo that referenced this pull request Dec 1, 2023
chore(deps): update rust crate rusqlite to 0.30.0

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [rusqlite](https://togithub.com/rusqlite/rusqlite) | workspace.dependencies | minor | `0.29.0` -> `0.30.0` |

---

### Release Notes

<details>
<summary>rusqlite/rusqlite (rusqlite)</summary>

### [`v0.30.0`](https://togithub.com/rusqlite/rusqlite/releases/tag/v0.30.0): 0.30.0

[Compare Source](https://togithub.com/rusqlite/rusqlite/compare/v0.29.0...v0.30.0)

#### What's Changed

-   Fix sqlite3\_auto_extension xEntryPoint signature [#&#8203;1310](https://togithub.com/rusqlite/rusqlite/issues/1310)
-   Use track_caller for panicking methods [#&#8203;1314](https://togithub.com/rusqlite/rusqlite/issues/1314)
-   Force linking against system sqlite libs [#&#8203;1317](https://togithub.com/rusqlite/rusqlite/issues/1317)
-   fix compilation for target wasm32-wasi [#&#8203;1321](https://togithub.com/rusqlite/rusqlite/issues/1321)
-   Add SQLITE_MAX_COLUMN compile-time option [#&#8203;1324](https://togithub.com/rusqlite/rusqlite/issues/1324)
-   Upgrade http links to https in Cargo.toml [#&#8203;1330](https://togithub.com/rusqlite/rusqlite/issues/1330)
-   Update fallible-iterator requirement from 0.2 to 0.3 [#&#8203;1334](https://togithub.com/rusqlite/rusqlite/issues/1334)
-   Implement FromSql & ToSql for std::num::NonZero types [#&#8203;1313](https://togithub.com/rusqlite/rusqlite/issues/1313)
-   Add new constants introduced by SQLite 3.42.0 [#&#8203;1336](https://togithub.com/rusqlite/rusqlite/issues/1336)
-   Use SQLITE_PREPARE_PERSISTENT for CachedStatement [#&#8203;1339](https://togithub.com/rusqlite/rusqlite/issues/1339)
-   Fix type of SQLITE_DESERIALIZE\_*, SQLITE_PREPARE\_*, SQLITE_SERIALIZE_\* [#&#8203;1340](https://togithub.com/rusqlite/rusqlite/issues/1340)
-   Introduce to_sqlite_error [#&#8203;1345](https://togithub.com/rusqlite/rusqlite/issues/1345)
-   remove depth from Savepoint [#&#8203;1327](https://togithub.com/rusqlite/rusqlite/issues/1327)
-   Savepoint Drop bug [#&#8203;1347](https://togithub.com/rusqlite/rusqlite/issues/1347)
-   \[breaking change] Update edition from 2018 to 2021 [#&#8203;1267](https://togithub.com/rusqlite/rusqlite/issues/1267)
-   Remove msrv for clippy by [#&#8203;1351](https://togithub.com/rusqlite/rusqlite/issues/1351)
-   Tweak bindgen [#&#8203;1352](https://togithub.com/rusqlite/rusqlite/issues/1352), [#&#8203;1353](https://togithub.com/rusqlite/rusqlite/issues/1353)
-   Inline constraint_error_code [#&#8203;1359](https://togithub.com/rusqlite/rusqlite/issues/1359)
-   Simplify bindgen generation [#&#8203;1360](https://togithub.com/rusqlite/rusqlite/issues/1360)
-   Fixes generate_series to handle NULL arguments [#&#8203;1357](https://togithub.com/rusqlite/rusqlite/issues/1357)
-   Factorize code in build.rs [#&#8203;1361](https://togithub.com/rusqlite/rusqlite/issues/1361)
-   Serialize and deserialize database [#&#8203;1341](https://togithub.com/rusqlite/rusqlite/issues/1341)
-   Spelling and a few more nits [#&#8203;1373](https://togithub.com/rusqlite/rusqlite/issues/1373)
-   Implement support for more `time` types [#&#8203;1374](https://togithub.com/rusqlite/rusqlite/issues/1374)
-   Fix visibility of TransactionState [#&#8203;1384](https://togithub.com/rusqlite/rusqlite/issues/1384)
-   Column is used only with column_decltype feature [#&#8203;1385](https://togithub.com/rusqlite/rusqlite/issues/1385)
-   Use proper var names in trait definition [#&#8203;1398](https://togithub.com/rusqlite/rusqlite/issues/1398)
-   Fix clippy warning: arc_with_non_send_sync - interrupt_lock [#&#8203;1400](https://togithub.com/rusqlite/rusqlite/issues/1400)
-   Captured identifiers in SQL strings [#&#8203;1346](https://togithub.com/rusqlite/rusqlite/issues/1346)
-   Add new constants introduced by SQLite 3.43.0 [#&#8203;1405](https://togithub.com/rusqlite/rusqlite/issues/1405)
-   Make WindowAggregate::value pass mutable value ref [#&#8203;1395](https://togithub.com/rusqlite/rusqlite/issues/1395)
-   Bump bundled SQLite version to 3.44.0 [#&#8203;1409](https://togithub.com/rusqlite/rusqlite/issues/1409)
-   Bump bindgen version to 0.69 [#&#8203;1410](https://togithub.com/rusqlite/rusqlite/issues/1410)
-   Loadable extension [#&#8203;1362](https://togithub.com/rusqlite/rusqlite/issues/1362)

#### New Contributors

-   [`@&#8203;icp1994](https://togithub.com/icp1994)` made their first contribution in [rusqlite/rusqlite#1317
-   [`@&#8203;wasm-forge](https://togithub.com/wasm-forge)` made their first contribution in [rusqlite/rusqlite#1321
-   [`@&#8203;nopjia](https://togithub.com/nopjia)` made their first contribution in [rusqlite/rusqlite#1324
-   [`@&#8203;Benjins-automation](https://togithub.com/Benjins-automation)` made their first contribution in [rusqlite/rusqlite#1330
-   [`@&#8203;itsxaos](https://togithub.com/itsxaos)` made their first contribution in [rusqlite/rusqlite#1313
-   [`@&#8203;Taywee](https://togithub.com/Taywee)` made their first contribution in [rusqlite/rusqlite#1327
-   [`@&#8203;davidselassie](https://togithub.com/davidselassie)` made their first contribution in [rusqlite/rusqlite#1357
-   [`@&#8203;nyurik](https://togithub.com/nyurik)` made their first contribution in [rusqlite/rusqlite#1373
-   [`@&#8203;nydrani](https://togithub.com/nydrani)` made their first contribution in [rusqlite/rusqlite#1374

**Full Changelog**: rusqlite/rusqlite@v0.29.0...v0.30.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 5am on the first day of the month" (UTC), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/rust-lang/cargo).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy41OS44IiwidXBkYXRlZEluVmVyIjoiMzcuNTkuOCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants