feat: export persisted Onyx state through active provider

[chrispader]

Expensify's Troubleshoot export opens Onyx's SQLite database separately, which NitroSQLite 9.8.1 rejects as a duplicate connection. Onyx has no public API for exporting its persisted store through the active provider, so the export can fail. This PR adds Onyx.exportState() for native and web consumers.

@NicolasBonet @ikevin127

Details

exportState() waits for Onyx initialization, reads the active provider's existing getAll() operation, and returns a plain key/value object. It excludes stale persisted rows for keys now configured as RAM-only by default. Callers can pass {includeStaleRamOnlyKeys: true} to include those rows, as the linked App export does to match its previous raw-storage query. Neither setting adds current RAM-only values from memory or writes that have not reached storage.

The method does not mask data. Callers must redact sensitive values before sharing the result. The API reference and README document the option and these boundaries.

Related Issues

Expensify/App#101448

Linked E/App PR

Expensify/App#101568

Automated Tests

Tests cover persisted values, default exclusion and explicit inclusion of stale RAM-only rows, exclusion of current RAM-only values, and storage-read failures. All 666 unit tests, typecheck, and lint pass locally.

Manual Tests

1. In the linked App PR, open Settings → Troubleshoot and export Onyx state on native and web. Verify the exported file contains local data and masked sensitive fields.
2. Repeat offline; exporting local state should still work.
3. With the NitroSQLite 9.8.1 upgrade in [WIP] [HOLD on #101568] chore(deps): Update NitroSQLite to 9.8.2 App#101437, verify native export does not produce a duplicate-connection error.

These manual checks have not yet been completed on devices or browsers.

Author Checklist

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

None attached; this adds a storage API without changing the normal UI.

[chrispader]

@MelvinBot request review from @NicolasBonet and @ikevin127

[ikevin127]

Verified ✅

• OnyxKeys.isRamOnlyKey (lib/OnyxKeys.ts:212) exists and already handles collection prefixes, and Storage, OnyxKeys, OnyxUtils are all imported in lib/Onyx.ts already, so no new imports were needed.
• The README claim "It works on native and web" holds. Both platform providers implement getAll: lib/storage/providers/IDBKeyValProvider/index.ts:136 and lib/storage/providers/SQLiteProvider.ts:264, plus MemoryOnlyProvider and NoopProvider. No provider is missing it, so there is no platform where this throws.
• Exporting will not accidentally trip the storage fallback. degradePerformance only fires on 'IDBKeyVal store could not be created', an init-time message, so a failing getAll() rejects and propagates rather than silently swapping the app onto MemoryOnlyProvider. The propagates storage read failures test pins that.
• API.md ordering is consistent with source order, so a regenerate via npm run build:docs will not churn.
• exportState correctly does not need an entry in OnyxUtils.METHOD, that map is for update operations.

---

🟢 Small, focused diff, nothing here blocks on correctness. The comments I dropped above are type-consistency and test-contract issues.

[chrispader]

Addressed all of @ikevin127's review comments!

[ikevin127]

🟢 LGTM - Thanks for addressing the comments

[os-botify]

🚀 Published to npm in 3.0.113 🎉