Refactor OnyxUpdate type to bring back type safety #696

blazejkustra · 2025-10-30T09:38:35Z

Details

This PR fixes the OnyxUpdates type. Specifically, the value property of an update was not type-safe because the key was incorrectly inferred.

It also introduces type tests, which can be expanded and refined in the future.

⚠️ Note: I had to set up a dedicated type testing environment (new script, building dist on the fly) since augmenting the type definitions was affecting the entire lib catalog:

declare module '../../dist/types' {
    interface CustomTypeOptions {
        keys: keyof OnyxValues;
        collectionKeys: keyof OnyxCollectionValues;
        values: OnyxValues;
    }
}

Related Issues

Expensify/App#73830

Automated Tests

N/A

Manual Tests

N/A

Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

tests/types/OnyxUpdate.ts

tests/types/test.ts

blazejkustra · 2025-10-31T16:43:55Z

lib/types.ts

-type Collection<TKey extends CollectionKeyBase, TValue, TMap = never> = {
-    [MapK in keyof TMap]: MapK extends `${TKey}${string}`
-        ? MapK extends `${TKey}`
-            ? never // forbids empty id
-            : TValue
-        : never;
-};


This wasn't working as expected, so needed to refactor this a bit @fabioh8010.

Which caused a lot of type errors in tests and lib catalogs

Did some testing on E/App and looks okay I think 👌

blazejkustra · 2025-10-31T16:45:07Z

lib/types.ts

@@ -1,5 +1,4 @@
 import type {Merge} from 'type-fest';
-import type {BuiltIns} from 'type-fest/source/internal';


This is not a stable api in type-fest, it was actually moved to another file in next type-fest major version which can lead to a lot of silent type errors in projects using react-native-onyx.

Ollyws · 2025-11-02T09:17:12Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified there are no new alerts related to the canBeMissing param for useOnyx
I verified proper code patterns were followed (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 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 any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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.ts or at the top of the file that uses the constant) are defined as such
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
- 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 a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
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 PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp

Android: mWeb Chrome

iOS: HybridApp

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

Ollyws

Tests all working as expected. LGTM.

lib/Onyx.ts

lib/OnyxUtils.ts

tests/utils/GenericCollection.ts

fabioh8010 · 2025-11-03T08:44:55Z

lib/types.ts

-type Collection<TKey extends CollectionKeyBase, TValue, TMap = never> = {
-    [MapK in keyof TMap]: MapK extends `${TKey}${string}`
-        ? MapK extends `${TKey}`
-            ? never // forbids empty id
-            : TValue
-        : never;
-};


Did some testing on E/App and looks okay I think 👌

…ations

…x/update-typesafety

fabioh8010

NAB, LGTM!

tests/unit/onyxTest.ts

mountiny · 2025-11-04T00:09:38Z

@chrispader can you also review please?

chrispader

LGTM, i just requested some additional comments, but not a blocker!

lib/types.ts

.eslintignore

tests/utils/GenericCollection.ts

tests/types/setup.ts

chrispader · 2025-11-04T16:01:28Z

Do i understand correctly, that the approach with the type tests is to make sure, that whenever we change the types and it creates type errors that were not explicitly ignored with @ts-expect-error before, it should fail the workflow, right?

In this case, how do we prevent from introducing other type errors for the same lines for which currently errors are ignored/expected? Currently, these might slip through, right?

…checking issues

blazejkustra · 2025-11-04T18:54:00Z

Do i understand correctly, that the approach with the type tests is to make sure, that whenever we change the types and it creates type errors that were not explicitly ignored with @ts-expect-error before, it should fail the workflow, right?

Yes!

In this case, how do we prevent from introducing other type errors for the same lines for which currently errors are ignored/expected? Currently, these might slip through, right?

Yes, but it's better than nothing 😄 And in most cases the errors would be caused in other places too, so it would be easily visible.

blazejkustra · 2025-11-04T18:54:32Z

All yours @MarioExpensify

mountiny · 2025-11-04T20:08:38Z

@MarioExpensify All yours 🙌

MarioExpensify · 2025-11-04T20:55:21Z

On it!

MarioExpensify

This is really good! Thank you! LGTM

os-botify · 2025-11-04T21:17:20Z

🚀 Published to npm in 3.0.11 🎉

Refactor OnyxUpdate type to bring back type safety

70f769d

melvin-bot bot assigned blazejkustra Oct 30, 2025

blazejkustra added 2 commits October 31, 2025 13:27

add type tests to onyx!

00d9891

Fix GH workflows

ffb0db8

blazejkustra marked this pull request as ready for review October 31, 2025 13:05

blazejkustra requested a review from a team as a code owner October 31, 2025 13:05

melvin-bot bot requested review from MarioExpensify and removed request for a team October 31, 2025 13:06

fabioh8010 reviewed Oct 31, 2025

View reviewed changes

tests/types/OnyxUpdate.ts Show resolved Hide resolved

tests/types/test.ts Outdated Show resolved Hide resolved

tests/types/test.ts Outdated Show resolved Hide resolved

blazejkustra added 4 commits October 31, 2025 17:25

Fix type safety, second try

00c9e40

Split tests

2e98c2c

Fix type errors while building onyx

cb08498

Refactor GenericCollection type to OnyxMergeCollectionInput

2979ece

blazejkustra commented Oct 31, 2025

View reviewed changes

blazejkustra requested a review from fabioh8010 October 31, 2025 16:45

Ollyws approved these changes Nov 2, 2025

View reviewed changes

fabioh8010 reviewed Nov 3, 2025

View reviewed changes

blazejkustra added 2 commits November 3, 2025 10:29

Add OnyxSetCollectionInput type and update related functions

541d23e

Update Onyx functions to use OnyxSetCollectionInput type for set oper…

0ff8075

…ations

blazejkustra requested a review from fabioh8010 November 3, 2025 09:44

Merge branch 'main' of github.com:Expensify/react-native-onyx into fi…

d234f8c

…x/update-typesafety

fabioh8010 approved these changes Nov 3, 2025

View reviewed changes

tests/unit/onyxTest.ts Show resolved Hide resolved

chrispader approved these changes Nov 4, 2025

View reviewed changes

lib/types.ts Show resolved Hide resolved

.eslintignore Show resolved Hide resolved

tests/utils/GenericCollection.ts Show resolved Hide resolved

tests/types/setup.ts Show resolved Hide resolved

blazejkustra added 2 commits November 4, 2025 19:51

Ignore tests/types directory in ESLint configuration to prevent type …

0f77bec

…checking issues

Rename to setup.ts

0443e3b

MarioExpensify approved these changes Nov 4, 2025

View reviewed changes

MarioExpensify merged commit 85df0af into Expensify:main Nov 4, 2025
8 checks passed

VickyStash mentioned this pull request Nov 6, 2025

Bump onyx to v3.0.13 Expensify/App#74489

Draft

54 tasks

		@@ -1,5 +1,4 @@
		import type {Merge} from 'type-fest';
		import type {BuiltIns} from 'type-fest/source/internal';

Refactor OnyxUpdate type to bring back type safety #696

Refactor OnyxUpdate type to bring back type safety #696

Uh oh!

Conversation

blazejkustra commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Related Issues

Automated Tests

Manual Tests

Author Checklist

Screenshots/Videos

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blazejkustra Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

fabioh8010 Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

blazejkustra Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Nov 2, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabioh8010 Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

fabioh8010 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mountiny commented Nov 4, 2025

Uh oh!

chrispader left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

chrispader commented Nov 4, 2025

Uh oh!

blazejkustra commented Nov 4, 2025

Uh oh!

blazejkustra commented Nov 4, 2025

Uh oh!

mountiny commented Nov 4, 2025

Uh oh!

MarioExpensify commented Nov 4, 2025

Uh oh!

MarioExpensify left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

os-botify bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

blazejkustra commented Oct 30, 2025 •

edited

Loading