Fix: issues in Onyx bump due to removal of null values in cache

[chrispader]

@mountiny

Details

This PR fixes minor issues in Onyx arising from this Onyx bump PR.

• Never set undefined values in cache and storage, when undefined is passed to Onyx.set/Onyx.merge/...
• Remove duplicate "key removal" logic in Onyx.multiSet
• OnyxUtils.getCachedCollection should only return undefined keys that are actually set in cache. (We need strict objects with not set keys rather then keys that are undefined when not existing)
• Fix issues with deepEqual comparisons in keyChanged and keysChanged (and prefer easier-to-read early-returns) (improve naming of some variables and make them more consistent)
• Due to the TS changes, i noticed that in mergeObject we're trying to access a key on target, even though target might not even be an object
• Fix an issue in withOnyx where we check if all state entries in tempState are non-undefined, rather than checking if the keys exist. This caused components to never exit the loading state in withOnyx and therefore never render

The PR also adds some TS type changes and improvements related to Onyx input values, that also stem from this Onyx bump PR.

Related Issues

margelo/expensify-app-fork#20

Automated Tests

Manual Tests

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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[mountiny]

@chrispader Can you please provide more details for the PR and also ideally cover some of these changes in new tests wherever it would make sense? It been lots of changes without specific tests

@blazejkustra @fabioh8010 can you please review this PR too?

[chrispader]

@mountiny updated the PR description. This PR should fix all remaining issues in the Onyx bump PR (so far).

@blazejkustra @fabioh8010 the TS changes are mostly related to similar changes i made in a previous PR, related to Onyx input types (Onyx.merge, Onyx.set)

[chrispader]

ready for review! 🚀

[chrispader]

@mountiny working on adding new tests for these changes today!

[fabioh8010]

@chrispader Nice work, left few comments!

Could you apply these changes too? We don't need them anymore since we get rid of null.

diff --git a/lib/useOnyx.ts b/lib/useOnyx.ts
index 958170b..230cbaf 100644
--- a/lib/useOnyx.ts
+++ b/lib/useOnyx.ts
@@ -2,21 +2,11 @@ import {deepEqual} from 'fast-equals';
 import {useCallback, useEffect, useRef, useSyncExternalStore} from 'react';
 import type {IsEqual} from 'type-fest';
 import OnyxUtils from './OnyxUtils';
-import type {CollectionKeyBase, KeyValueMapping, NonNull, OnyxCollection, OnyxEntry, OnyxKey, Selector} from './types';
+import type {CollectionKeyBase, OnyxCollection, OnyxKey, OnyxValue, Selector} from './types';
 import useLiveRef from './useLiveRef';
 import usePrevious from './usePrevious';
 import Onyx from './Onyx';
 
-/**
- * Represents a Onyx value that can be either a single entry or a collection of entries, depending on the `TKey` provided.
- * It's a variation of `OnyxValue` type that is read-only and excludes the `null` type.
- */
-type UseOnyxValue<TKey extends OnyxKey> = string extends TKey
-    ? unknown
-    : TKey extends CollectionKeyBase
-    ? NonNull<OnyxCollection<KeyValueMapping[TKey]>>
-    : NonNull<OnyxEntry<KeyValueMapping[TKey]>>;
-
 type BaseUseOnyxOptions = {
     /**
      * Determines if this key in this subscription is safe to be evicted.
@@ -55,7 +45,7 @@ type UseOnyxOptions<TKey extends OnyxKey, TReturnValue> = BaseUseOnyxOptions & U
 
 type FetchStatus = 'loading' | 'loaded';
 
-type CachedValue<TKey extends OnyxKey, TValue> = IsEqual<TValue, UseOnyxValue<TKey>> extends true ? TValue : TKey extends CollectionKeyBase ? NonNullable<OnyxCollection<TValue>> : TValue;
+type CachedValue<TKey extends OnyxKey, TValue> = IsEqual<TValue, OnyxValue<TKey>> extends true ? TValue : TKey extends CollectionKeyBase ? NonNullable<OnyxCollection<TValue>> : TValue;
 
 type ResultMetadata = {
     status: FetchStatus;
@@ -67,15 +57,15 @@ function getCachedValue<TKey extends OnyxKey, TValue>(key: TKey, selector?: Sele
     return OnyxUtils.tryGetCachedValue(key, {selector}) as CachedValue<TKey, TValue> | undefined;
 }
 
-function useOnyx<TKey extends OnyxKey, TReturnValue = UseOnyxValue<TKey>>(
+function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(
     key: TKey,
     options?: BaseUseOnyxOptions & UseOnyxInitialValueOption<TReturnValue> & Required<UseOnyxSelectorOption<TKey, TReturnValue>>,
 ): UseOnyxResult<TKey, TReturnValue>;
-function useOnyx<TKey extends OnyxKey, TReturnValue = UseOnyxValue<TKey>>(
+function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(
     key: TKey,
     options?: BaseUseOnyxOptions & UseOnyxInitialValueOption<NoInfer<TReturnValue>>,
 ): UseOnyxResult<TKey, TReturnValue>;
-function useOnyx<TKey extends OnyxKey, TReturnValue = UseOnyxValue<TKey>>(key: TKey, options?: UseOnyxOptions<TKey, TReturnValue>): UseOnyxResult<TKey, TReturnValue> {
+function useOnyx<TKey extends OnyxKey, TReturnValue = OnyxValue<TKey>>(key: TKey, options?: UseOnyxOptions<TKey, TReturnValue>): UseOnyxResult<TKey, TReturnValue> {
     const connectionIDRef = useRef<number | null>(null);
     const previousKey = usePrevious(key);
 

[chrispader]

@fabioh8010 thanks for mentioning these issues. I added your changes and updated the comments :)

[blazejkustra]

Type changes look good to me! I really like the idea to replace null with undefined 👍

Do I understand correctly that null will still be used but only when we want to remove a property from an onyx value/remove whole onyx value?

[chrispader]

Do I understand correctly that null will still be used but only when we want to remove a property from an onyx value/remove whole onyx value?

@blazejkustra yes exactly. passing null to Onyx functions now means "delete that key" (or sub-property of some key)

Onyx will never persist and return null values though, but always return undefined from Onyx.connect callback, withOnyx and useOnyx, if a key doesn't exist in cache/storage

[chrispader]

@fabioh8010 @blazejkustra just added one more type that we're gonna use in E/App, so you can probably ignore reviewing the last two commit, because it's just a TS type export

[fabioh8010]

@chrispader I was checking the last changes and I found an TS issue with mergeCollection. Now it's being possible to pass a different collection member key related to the one specified in the function:

    Onyx.mergeCollection(ONYXKEYS.COLLECTION.DOWNLOAD, {
        [`${ONYXKEYS.COLLECTION.DOWNLOAD}${'attachment1'}` as const]: {isDownloading: true},
        [`${ONYXKEYS.COLLECTION.DOWNLOAD}${'attachment3'}` as const]: {isDownloading: true},
        [`${ONYXKEYS.COLLECTION.REPORT}${'report1'}` as const]: {isDownloading: true}, // TS is allowing to pass a report item with a download object, previously it would raise an error
    });

EDIT: It seems that the issue is fixed if I revert these changes, why do we need them @chrispader ?

[chrispader]

@chrispader I was checking the last changes and I found an TS issue with mergeCollection. Now it's being possible to pass a different collection member key related to the one specified in the function:

    Onyx.mergeCollection(ONYXKEYS.COLLECTION.DOWNLOAD, {
        [`${ONYXKEYS.COLLECTION.DOWNLOAD}${'attachment1'}` as const]: {isDownloading: true},
        [`${ONYXKEYS.COLLECTION.DOWNLOAD}${'attachment3'}` as const]: {isDownloading: true},
        [`${ONYXKEYS.COLLECTION.REPORT}${'report1'}` as const]: {isDownloading: true}, // TS is allowing to pass a report item with a download object, previously it would raise an error
    });

EDIT: It seems that the issue is fixed if I revert these changes, why do we need them @chrispader ?

@fabioh8010 yes you're right. I thought we could pass the type of the collection to mergeCollection as a generic parameter, though the collection types are actually defined in E/App in a module declaration.d.ts and not in Onyx itself.

Reverted the changes and added back the @ts-expect-error flags in useOnyxTest

[fabioh8010]

🚀

[mountiny]

Thank you for the changes, all bugs found in the App PR has been addressed it seems so lets get this out so we can make a new build for Applause

[github-actions]

🚀Published to npm in v2.0.47