Remove null values from cache to improve Onyx read speed

[chrispader]

@mountiny @neil-marcellini

Details

Removes null values from OnyxCache (reads) and therefore removes unnecessary calls to removeNestedNullValues on read.

This PR adds a nullishStorageKeys Set to OnyxCache where a key can be added in order for the key to represent null/"not set" in cache. This change let's us keep existing performance and loading state improvements that @janicduplessis implemented in https://github.com/Expensify/react-native-onyx/pull/401.

This PR also adds some general code quality improvements around using the cache and handling reads and writes to Onyx.

Recently IDBKeyvalProvider hasn't been identical in it's behavior to SQLiteStorageProvider. Therefore, i added some extra logic to setItem, multiSet and multiMerge, to check for null values and handle those in the storage layer.

Related Issues

https://github.com/Expensify/react-native-onyx/issues/553 https://github.com/Expensify/App/issues/42654

Automated Tests

Manual Tests

Author Checklist

• [x] I linked the correct issue in the ### Related Issues section above
• [x] I wrote clear testing steps that cover the changes made in this PR
  • [x] I added steps for local testing in the Tests section
  • [x] 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).
• [x] I included screenshots or videos for tests on all platforms
• [x] I ran the tests on all platforms & verified they passed on:
  • [x] Android / native
  • [x] Android / Chrome
  • [x] iOS / native
  • [x] iOS / Safari
  • [x] MacOS / Chrome / Safari
  • [x] MacOS / Desktop
• [x] 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)
• [x] I followed proper code patterns (see Reviewing the code)
  • [x] 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)
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I followed the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] I verified that if a function's arguments changed that all usages have also been updated correctly
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] 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)
• [x] 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.
• [x] I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[neil-marcellini]

Requesting a review from myself so this doesn't get lost, but planning to let Janic review first.

[chrispader]

This PR seems to be the fix for a regression in https://github.com/Expensify/App/pull/42057, which was reverted in https://github.com/Expensify/App/pull/42725

@neil-marcellini @janicduplessis i'm gonna prioritize this PR right now so we can hopefully merge this today. I'll let you guys know when i'm done with the implementation so you can review

cc @mountiny

[chrispader]

@neil-marcellini @mountiny @janicduplessis this PR is now ready for review! Once we merged this, we can review, QA and merge https://github.com/Expensify/App/pull/42772

[chrispader]

@mountiny addressed all your comments and improved a few other parts of the implementation

[github-actions[bot]]

🚀Published to npm in v2.0.43

[ahmedGaber93]

Coming from this issue https://github.com/Expensify/App/issues/42529. useOnyx in useReportIDs.tsx here are sent reportActions with null values to the E/App. I see this PR remove null values from cache and I test the issue with this fix in v2.0.43 and it fixed.

@chrispader I just need to confirm if this PR fix the above issue because its title indicates it is for improve performance

[chrispader]

Coming from this issue Expensify/App#42529. useOnyx in useReportIDs.tsx here are sent reportActions with null values to the E/App. I see this PR remove null values from cache and I test the issue with this fix in v2.0.43 and it fixed.

@chrispader I just need to confirm if this PR fix the above issue because its title indicates it is for improve performance

@ahmedGaber93 this PR is also supposed to remove null values from all getter options, like withOnyx, useOnyx and Onyx.connect. If this PR fixed your issue, it should be fine!

[ahmedGaber93]

Coming from this issue https://github.com/Expensify/App/issues/42529. E/App still receive null values in Onyx.connet here. For reproduce steps see issue description. I think we can add an extra null check in E/App to urgent fix, but this is still needing to fix.

[chrispader]

Coming from this issue Expensify/App#42529. E/App still receive null values in Onyx.connet here. For reproduce steps see issue description. I think we can add an extra null check in E/App to urgent fix, but this is still needing to fix.

I couldn't reproduce this myself, but i suppose this stems from old data (with null values) still being in storage, which is then returned.

We only remove null values on write, so unless a key doesn't change in the meantime, it will still hold the null value

@ahmedGaber93 could you link me to the exact repro steps? the ones from the issue description don't give me this problem

[chrispader]

@ahmedGaber93 You mean exact null values right? because Onyx can still return an object that includes keys that are undefined. This would also lead to report actions being filtered out by Boolean(value)