Skip to content

[HOLD bump queue] feat: Split queries with many parameters into multiple queries to avoid too many SQL variables error#804

Open
chrispader wants to merge 11 commits into
Expensify:mainfrom
margelo:@chrispader/fix-too-many-sql-variables-error
Open

[HOLD bump queue] feat: Split queries with many parameters into multiple queries to avoid too many SQL variables error#804
chrispader wants to merge 11 commits into
Expensify:mainfrom
margelo:@chrispader/fix-too-many-sql-variables-error

Conversation

@chrispader

@chrispader chrispader commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

@mountiny

Details

This PR fixes an issue with our SQLite storage provider implementation, where in some cases, very large Onyx DBs with lots of keys would cause queries with IN (...) to exceed the number of allowed parameters per query (usually more than 32,766, as per https://sqlite.org/limits.html).

This PR does the following:

  1. When the storage provider is initialized, fetch the MAX_VARIABLE_NUMBER compile option once and store it globally.
  2. In multiGet and removeItems split queries into multiple separate queries, if the number of keys exceeds the max.

Related Issues

Expensify/App#94577

Linked E/App PR

Expensify/App#94947

Automated Tests

Manual Tests

To reproduce this error, we must manually add some code to the app locally:

  1. Add this useEffect in https://github.com/Expensify/App/blob/371c63dd33c770f0b2ab6d592d557156c66860ad/src/App.tsx#L73-L144:
import React, {useEffect} from 'react';
import Onyx from 'react-native-onyx';
import type {OnyxMultiSetInput} from 'react-native-onyx';
import OnyxUtils from 'react-native-onyx/dist/OnyxUtils';

function App() {
    // ...

    useEffect(() => {
        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
        const data = Array(33000)
            .fill(0)
            .reduce<Record<string, string>>((acc, _, i) => {
                const key = `TooManyVariablesDemo-${i}`;
                acc[key] = key;
                return acc;
            }, {}) as unknown as OnyxMultiSetInput;

        Onyx.multiSet(data).then(() => {
            OnyxUtils.getAllKeys().then((keys) => {
                console.log(`[TooManySQLVariablesDemo] Number of keys in Onyx: ${keys.size}`);
            });
        });
    }, []);

    // ...
}
  1. Add an explicit catch block to the clearOnyxAndResetApp function in https://github.com/Expensify/App/blob/371c63dd33c770f0b2ab6d592d557156c66860ad/src/libs/actions/App.ts#L879-L933
function clearOnyxAndResetApp(shouldNavigateToHomepage?: boolean) {
    // ...

    const resetPromise = clearWorkboxRecoveryCaches().then(() =>
    clearOnyxAndSeedFullReconnect(KEYS_TO_PRESERVE)
        .then(() => {
            // ...
        })
        .catch((error) => {
            Log.alert('[TooManySQLVariablesDemo] Error clearing Onyx', {error});
        }),
    );

    return resetPromise
}
  1. Run the app and open the developer tools.
  2. Make sure that the [TooManySQLVariablesDemo] Number of keys in Onyx: <number of keys in Onyx> log appears with at least more than 32,766 keys (as this is the configured limit for number of parameters/variables in a query)
  3. Add a breakpoint in the .catch((error) => { ... }) block from step 2
  4. Make sure the breakpoint is hit without the fix from this PR and that the error reads as the following:
[NativeNitroSQLiteException][SqlExecutionError] too many SQL variables
  1. Repeat steps 1-5 with the fix in place and make sure that the breakpoint is not hit and no error is thrown.

Author Checklist

  • I linked the correct issue in the ### Related Issues section above
  • I linked the corresponding Expensify/App PR in the ### Linked E/App PR section above, and verified this change against it (E/App CI passed and manual testing completed)
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Before fix:

Screen.Recording.2026-06-30.at.17.27.42.mov

After fix:

after.mov

@chrispader chrispader requested a review from a team as a code owner June 30, 2026 09:43
@melvin-bot melvin-bot Bot requested review from Valforte and removed request for a team June 30, 2026 09:43

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b6ea41a34f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread lib/storage/providers/SQLiteProvider.ts Outdated
@chrispader chrispader changed the title feat: Split quries with many parameters into multiple queries to avoid too many SQL variables error feat: Split queries with many parameters into multiple queries to avoid too many SQL variables error Jun 30, 2026
@mountiny mountiny self-requested a review June 30, 2026 10:55
@mountiny

Copy link
Copy Markdown
Contributor

@ChavdaSachin can you please review and test the out in the app?

@mountiny mountiny requested a review from ChavdaSachin June 30, 2026 10:56
Comment thread lib/storage/providers/SQLiteProvider.ts
Comment thread lib/storage/providers/SQLiteProvider.ts Outdated
Comment thread lib/storage/providers/SQLiteProvider.ts
Comment thread lib/utils.ts
@fabioh8010

Copy link
Copy Markdown
Contributor

@chrispader Please add manual test steps, test recordings and a linked E/App PR where QA/reviewer will use for testing.

@mountiny mountiny changed the title feat: Split queries with many parameters into multiple queries to avoid too many SQL variables error [HOLD bump queue] feat: Split queries with many parameters into multiple queries to avoid too many SQL variables error Jul 1, 2026
@mountiny

mountiny commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Please continue testing and reviewing, but I put it on hold as we merged 2 onyx prs that need to be deployed in App first

@chrispader

Copy link
Copy Markdown
Contributor Author

@mountiny alright, sounds good! Could we trigger an ad-hoc build on the App PR?

@fabioh8010 @ChavdaSachin i've added unit tests and updated the SQLite mock to reflect param handling in executeBatch based on how NitroSQLite does it. This is ready for final review. 🙌🏼

Comment thread tests/unit/mocks/sqliteMock.ts Outdated
Comment thread tests/unit/mocks/sqliteMock.ts Outdated

@fabioh8010 fabioh8010 left a comment

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.

Very nice!

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.

3 participants