[No QA] Replace default updateOnyx union type with specific types in type annotations in variable declarations by OlGierd03 · Pull Request #77949 · Expensify/App

OlGierd03 · 2025-12-18T00:08:28Z

Explanation of Change

The changes in this PR are only at the type level, hence [No QA] tag

These changes are the first batch of replacements of the OnyxUpdate default union type with specified types. Replacements were made using the codegen tool jscodeshift. This PR covers most OnyxUpdate[] type replacements of type annotations in variable declarations (over 60% of all usages of default union type)

Note

Small number of lines of code have been changed manually to adjust the eslint check, which will eventually be eliminated in a separate PR, the last in a series related to OnyxUpdate type migrations

Codegen code of transform created with jscodeshift responsible for type replacements

import {Transform} from 'jscodeshift';

const transform: Transform = (file, api) => {
    const j = api.jscodeshift;
    const root = j(file.source);
    let isDirty = false;

    const isFirstMemberONYXKEYS = (node) => {
        if (node.type === 'Identifier') {
            return node.name === 'ONYXKEYS';
        }

        if (node.type === 'MemberExpression') {
            return isFirstMemberONYXKEYS(node.object);
        }

        return false;
    };

    const extractKeyPropValueFromObject = (element) => {
        if (element?.type !== 'ObjectExpression') {
            return null;
        }

        const keyProp = element.properties.find((p): p is any => p.type === 'ObjectProperty' && p.key.type === 'Identifier' && p.key.name === 'key');

        if (keyProp && keyProp.value) {
            if (keyProp.value.type === 'MemberExpression' && isFirstMemberONYXKEYS(keyProp.value)) {
                return j(keyProp.value).toSource();
            } else if (
                keyProp.value.type === 'TemplateLiteral' &&
                keyProp.value.expressions.length > 0 &&
                keyProp.value.expressions[0].type === 'MemberExpression' &&
                isFirstMemberONYXKEYS(keyProp.value.expressions[0]) &&
                keyProp.value.quasis[0].value.raw.length === 0
            ) {
                return j(keyProp.value.expressions[0]).toSource();
            }
        }
        return null;
    };

    const updateKeysFromPushCalls = (scope, variableName, extractedKeyPropValues, isValid) => {
        if (!scope) return isValid;

        const pushCalls = j(scope.path).find(j.CallExpression, {
            callee: {
                type: (type: string) => ['MemberExpression', 'OptionalMemberExpression'].includes(type),
                object: {type: 'Identifier', name: variableName},
                property: {type: 'Identifier', name: 'push'},
            },
        });

        pushCalls.forEach((pushPath) => {
            pushPath.node.arguments.forEach((arg) => {
                const keyPropValue = extractKeyPropValueFromObject(arg);
                if (keyPropValue) {
                    extractedKeyPropValues.add(keyPropValue);
                } else {
                    isValid = false;
                }
            });
        });

        return isValid;
    };

    root.find(j.VariableDeclarator).forEach((path) => {
        const {id, init} = path.node;

        if (id.type === 'Identifier' && id.typeAnnotation?.type === 'TSTypeAnnotation' && id.typeAnnotation.typeAnnotation.type === 'TSArrayType') {
            const arrayType = id.typeAnnotation.typeAnnotation;

            if (arrayType.elementType.type === 'TSTypeReference' && arrayType.elementType.typeName.type === 'Identifier' && arrayType.elementType.typeName.name === 'OnyxUpdate') {
                let extractedKeyPropValues = new Set<string>();
                let isValid = true;
                const variableName = id.name;

                if (init?.type === 'ArrayExpression') {
                    for (const element of init.elements) {
                        const keyPropValue = extractKeyPropValueFromObject(element);

                        if (keyPropValue) {
                            extractedKeyPropValues.add(keyPropValue);
                        } else {
                            isValid = false;
                            break;
                        }
                    }
                } else if (init) {
                    isValid = false;
                }

                if (isValid) {
                    isValid = updateKeysFromPushCalls(path.scope, variableName, extractedKeyPropValues, isValid);
                }

                if (isValid && extractedKeyPropValues.size > 0) {
                    const typeQueries = Array.from(extractedKeyPropValues).map((value) => j.tsTypeQuery(j.identifier(value)));
                    const replacementForDefaultType = typeQueries.length > 1 ? j.tsUnionType(typeQueries) : typeQueries[0];

                    const newType = j.tsTypeReference(
                        j.identifier('Array'),
                        j.tsTypeParameterInstantiation([
                            j.tsTypeReference(
                                j.identifier('OnyxUpdate'),
                                j.tsTypeParameterInstantiation([
                                    replacementForDefaultType,
                                ]),
                            ),
                        ]),
                    );

                    id.typeAnnotation.typeAnnotation = newType;
                    isDirty = true;
                }
            }
        }
    });

    return isDirty ? root.toSource() : null;
};

export default transform;

Important

TS performance after the changes has improved significantly, now averaging about 67% of the previous test execution time

TS performance test logs before the changes:

TEST 1

Files: 10030
Lines of Library: 53140
Lines of Definitions: 2049752
Lines of TypeScript: 764373
Lines of JavaScript: 23836
Lines of JSON: 1443
Lines of Other: 0
Identifiers: 3023191
Symbols: 4901830
Types: 1763205
Instantiations: 5596114
Memory used: 6111552K
Assignability cache size: 2764483
Identity cache size: 373433
Subtype cache size: 823420
Strict subtype cache size: 1162300
I/O Read time: 1.77s
Parse time: 3.56s
ResolveModule time: 1.12s
ResolveTypeReference time: 0.02s
ResolveLibrary time: 0.01s
Program time: 7.08s
Bind time: 2.45s
Check time: 362.25s
printTime time: 0.00s
Emit time: 0.00s
Total time: 371.79s

TEST 2

Files: 10030
Lines of Library: 53140
Lines of Definitions: 2049752
Lines of TypeScript: 764373
Lines of JavaScript: 23836
Lines of JSON: 1443
Lines of Other: 0
Identifiers: 3023191
Symbols: 4901830
Types: 1763205
Instantiations: 5596114
Memory used: 6107275K
Assignability cache size: 2764483
Identity cache size: 373433
Subtype cache size: 823420
Strict subtype cache size: 1162300
I/O Read time: 1.79s
Parse time: 3.51s
ResolveModule time: 1.14s
ResolveTypeReference time: 0.03s
ResolveLibrary time: 0.01s
Program time: 7.10s
Bind time: 2.40s
Check time: 353.45s
printTime time: 0.00s
Emit time: 0.00s
Total time: 362.96s

TS performance test logs after the changes:

TEST 1

Files: 10030
Lines of Library: 53140
Lines of Definitions: 2049752
Lines of TypeScript: 764523
Lines of JavaScript: 23836
Lines of JSON: 1443
Lines of Other: 0
Identifiers: 3026457
Symbols: 4908267
Types: 1764884
Instantiations: 5500557
Memory used: 6089074K
Assignability cache size: 2384103
Identity cache size: 373544
Subtype cache size: 824470
Strict subtype cache size: 1155736
I/O Read time: 2.04s
Parse time: 3.97s
ResolveModule time: 1.26s
ResolveTypeReference time: 0.04s
ResolveLibrary time: 0.01s
Program time: 8.07s
Bind time: 3.02s
Check time: 241.43s
printTime time: 0.00s
Emit time: 0.00s
Total time: 252.53s

TEST 2

Files: 10030
Lines of Library: 53140
Lines of Definitions: 2049752
Lines of TypeScript: 764523
Lines of JavaScript: 23836
Lines of JSON: 1443
Lines of Other: 0
Identifiers: 3026457
Symbols: 4908267
Types: 1764884
Instantiations: 5500557
Memory used: 6089263K
Assignability cache size: 2384103
Identity cache size: 373544
Subtype cache size: 824470
Strict subtype cache size: 1155736
I/O Read time: 1.91s
Parse time: 3.72s
ResolveModule time: 1.17s
ResolveTypeReference time: 0.03s
ResolveLibrary time: 0.01s
Program time: 7.50s
Bind time: 2.78s
Check time: 233.86s
printTime time: 0.00s
Emit time: 0.00s
Total time: 244.14s

Fixed Issues

#73830

Tests

N/A

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

Screenshots/Videos

N/A

…otations in variable declarations

codecov · 2025-12-18T00:17:06Z

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines	Coverage Δ
src/libs/PersonalDetailsUtils.ts	`80.25% <100.00%> (ø)`
src/libs/ReportTitleUtils.ts	`90.24% <100.00%> (ø)`
src/libs/actions/App.ts	`42.85% <100.00%> (ø)`
src/libs/actions/RequestConflictUtils.ts	`98.36% <100.00%> (ø)`
src/libs/actions/Transaction.ts	`59.55% <100.00%> (ø)`
src/libs/actions/ExitSurvey.ts	`0.00% <0.00%> (ø)`
src/libs/actions/ReportLayout.ts	`40.00% <0.00%> (ø)`
src/libs/actions/Welcome/index.ts	`42.85% <0.00%> (ø)`
src/libs/PolicyDistanceRatesUtils.ts	`13.88% <0.00%> (ø)`
src/libs/ReportUtils.ts	`72.88% <0.00%> (ø)`
... and 33 more
... and 3 files with indirect coverage changes

src/utils/createDummySharedValue.ts

…cy.ts

…l,VacationDelegate}.ts

…ty array handling

melvin-bot · 2025-12-20T00:36:20Z

@Julesssss Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

blazejkustra · 2025-12-22T08:56:57Z

Hey @roryabraham, you might want to check this one out as it improves TS speed significantly!

Julesssss · 2025-12-22T21:45:40Z

src/libs/ReportUtils.ts

+    const optimisticData: Array<OnyxUpdate<typeof ONYXKEYS.COLLECTION.REPORT | typeof ONYXKEYS.COLLECTION.REPORT_METADATA | typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS>> = [];
+    const successData: Array<
+        OnyxUpdate<typeof ONYXKEYS.COLLECTION.REPORT | typeof ONYXKEYS.COLLECTION.REPORT_METADATA | typeof ONYXKEYS.PERSONAL_DETAILS_LIST | typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS>
+    > = [];
+    const failureData: Array<OnyxUpdate<typeof ONYXKEYS.COLLECTION.REPORT | typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS | typeof ONYXKEYS.PERSONAL_DETAILS_LIST>> = [];



Newlines for each may be more readable.

Array<OnyxUpdate<typeof ONYXKEYS.COLLECTION.REPORT | typeof ONYXKEYS.COLLECTION.REPORT_ACTIONS | typeof ONYXKEYS.PERSONAL_DETAILS_LIST>> = [];

Julesssss

Minor eslint error: getReportName is deprecated. Moved to src/libs/ReportNameUtils.ts.`

roryabraham · 2025-12-22T22:15:43Z

saving about 2 minutes per run, love that!

roryabraham

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

roryabraham · 2025-12-22T22:19:24Z

ignoring unrelated lint-changed. No product considerations for @heyjennahay. Type-only changes so no test or QA needed. merging

melvin-bot · 2025-12-22T22:19:57Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2025-12-22T22:30:17Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2025-12-23T00:52:38Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.2.86-0 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	failure ❌
🍎 iOS 🍎	success ✅

OSBotify · 2025-12-24T18:49:45Z

🚀 Deployed to production by https://github.com/marcaaron in version: 9.2.86-4 🚀

platform	result
🖥 desktop 🖥	success ✅
🕸 web 🕸	success ✅
🤖 android 🤖	success ✅
🍎 iOS 🍎	success ✅

Replace default updateOnyx union type with specific types in type ann…

75c271d

…otations in variable declarations

melvin-bot bot assigned OlGierd03 Dec 18, 2025

blazejkustra suggested changes Dec 18, 2025

View reviewed changes

src/utils/createDummySharedValue.ts Outdated Show resolved Hide resolved

OlGierd03 added 5 commits December 18, 2025 14:51

Codegen now modify only the files with acutal changes detected

6abfe41

Replace default updateOnyx union type in src/libs/actions/Report.ts

86c2370

Replace default updateOnyx union type in src/libs/actions/IOU.ts

0fab386

Replace default updateOnyx union type in src/libs/actions/Policy/Poli…

7e7b533

…cy.ts

Replace updateOnyx default union type in src/libs/actions/{Card,Trave…

37887b1

…l,VacationDelegate}.ts

OlGierd03 changed the title ~~Replace default updateOnyx union type with specific types in type annotations in variable declarations~~ [No QA] Replace default updateOnyx union type with specific types in type annotations in variable declarations Dec 18, 2025

OlGierd03 added 3 commits December 18, 2025 16:55

Run npm run prettier

d1ad4d2

Apply improved codegen with better push method usage analysis and emp…

d30fbca

…ty array handling

Merge 'main' branch

a017ef5

OlGierd03 marked this pull request as ready for review December 20, 2025 00:35

OlGierd03 requested review from a team as code owners December 20, 2025 00:35

melvin-bot bot requested review from Julesssss and heyjennahay and removed request for a team December 20, 2025 00:35

melvin-bot bot removed the request for review from a team December 20, 2025 00:36

OlGierd03 mentioned this pull request Dec 20, 2025

[$250] Restore Type Safety for Onyx.update() #73830

Open

OlGierd03 added 3 commits December 22, 2025 07:14

Merge 'main' branch

f5896df

Apply codegen to tsx files

d52bd38

Apply codegen to files from ./tests

75ab0cd

Julesssss reviewed Dec 22, 2025

View reviewed changes

Julesssss requested a review from blazejkustra December 22, 2025 21:47

roryabraham approved these changes Dec 22, 2025

View reviewed changes

roryabraham merged commit c3bd774 into Expensify:main Dec 22, 2025
31 of 35 checks passed

melvin-bot bot added the Emergency label Dec 22, 2025

roryabraham added Access Change and removed Emergency Access Change labels Dec 22, 2025

OSBotify mentioned this pull request Dec 23, 2025

Deploy Checklist: New Expensify 2025-12-23 #78313

Closed

mohammadjafarinejad mentioned this pull request Dec 23, 2025

Fix: Optimistically copy submission/approval related report actions #77960

Merged

53 tasks

This was referenced Dec 23, 2025

Internal QA Test Expensify/App-Test-Fork#134

Closed

[Test, please ignore] Internal QA Test #78399

Closed

Conversation

OlGierd03 commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

codecov bot commented Dec 18, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

melvin-bot bot commented Dec 20, 2025

Uh oh!

blazejkustra commented Dec 22, 2025

Uh oh!

Julesssss Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Julesssss Dec 22, 2025

Choose a reason for hiding this comment

Uh oh!

Julesssss left a comment

Choose a reason for hiding this comment

Uh oh!

roryabraham commented Dec 22, 2025

Uh oh!

roryabraham left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Screenshots/Videos

Uh oh!

roryabraham commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

melvin-bot bot commented Dec 22, 2025

Uh oh!

OSBotify commented Dec 22, 2025

Uh oh!

OSBotify commented Dec 23, 2025

Uh oh!

OSBotify commented Dec 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

OlGierd03 commented Dec 18, 2025 •

edited

Loading

codecov bot commented Dec 18, 2025 •

edited by github-actions bot

Loading

roryabraham commented Dec 22, 2025 •

edited

Loading