useOnyx type improvements

[fabioh8010]

Details

This PR does the following changes:

• Changes useOnyx to return undefined instead of null, thus allowing us to use default values more easily.
• Changes OnyxEntry and OnyxCollection types to allow undefined values (necessary because of the change above).
• Changes Onyx.set and Onyx.merge types to disallow passing undefined directly (like it was before).
• Changes Onyx.connect callback's value type to exclude undefined (undefined will never be passed).
• Deprecates withOnyx.
• Makes useOnyx return read-only value to avoid future situations like this one (it's not committed yet but the problem was because an Onyx value was being mutated during runtime, which causes getSnapshot() to always fail the deep-equality check and re-render infinitely).
• Fix initialValue type to avoid infer useOnyx's return value
• Bump TS to 5.4.5 in order to be able to use NoInfer type to fix initialValue.

⚠️ Follow-up PR on E/App when these changes are available there: Expensify/App#40367

⚠️ Playground branch: https://github.com/fabioh8010/expensify-app/tree/feature/playground-use-onyx

Related Issues

$ Expensify/App#34339

Automated Tests

Manual Tests

Some common tasks on E/App:

1. Start a new chat and search for someone (uses useOnyx).
2. Send a message to someone.
3. Open someone's profile and change settings (uses useOnyx).
4. Open Preferences and change settings (uses useOnyx).

Author Checklist

• I linked the correct issue in the ### Related Issues section above
• 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
  • MacOS / Desktop
• 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

I'm having issue to build Android app.

Android: mWeb Chrome

Screen.Recording.2024-04-26.at.15.37.33-compressed.mov

iOS: Native

It's failing runtime due to changes on this repo's main.

iOS: mWeb Safari

Screen.Recording.2024-04-26.at.15.47.24-compressed.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-26.at.15.52.43-compressed.mov

Screen.Recording.2024-04-26.at.15.54.12-compressed.mov

MacOS: Desktop

Screen.Recording.2024-04-26.at.15.56.19-compressed.mov

[fabioh8010]

@roryabraham @blazejkustra I've also upgraded both Onyx and E/App TS to 5.4.5 to be able to use NoInfer type, necessary to fix initialValue issues with TS.

[roryabraham]

This code seems good to me

[fabioh8010]

Putting this on HOLD because I'm going to be OOO next week, and will return on May 6th.

[fabioh8010]

@roryabraham @techievivek I'm taking this PR off the hold.

[github-actions]

🚀Published to npm in v2.0.37