Skip to content

Migrate TypeSelectorModal to react-navigation#91102

Open
sharabai wants to merge 6 commits into
Expensify:mainfrom
software-mansion-labs:modal-migrate/type-selector
Open

Migrate TypeSelectorModal to react-navigation#91102
sharabai wants to merge 6 commits into
Expensify:mainfrom
software-mansion-labs:modal-migrate/type-selector

Conversation

@sharabai
Copy link
Copy Markdown
Contributor

Explanation of Change

Migrates TypeSelectorModal (react-native-modal) to a @react-navigation RHP screen (TypeSelectorPage) for consistent right-to-left animations. TypeSelector is now a MenuItemWithTopDescription that navigates to the new screen; selection writes type + computed initialValue to the form draft. A new FormValueWatcher primitive preserves the original resetForm semantics (clears errors / touched flags) without leaking effects into FormProvider.

Fixed Issues

$ #90473
PROPOSAL:

Tests

  1. Go to Settings → Workspaces → [any Control workspace] → Reports → Report fields → Add field.
  2. Tap the Type row and verify the picker opens, shows all options (Text / Date / List / Formula), and highlights the current selection.
  3. Pick a different type and verify you are returned to the Add field screen with:
    • The new type reflected on the Type row.
    • The Initial value row updated per type — visible and empty for Text, hidden for Date, visible and pre-filled with {report:id} for Formula, hidden (and replaced by the List values row) for List.
  4. On the Add field screen, leave Name empty and tap Save so the form-level error banner appears. Then change the Type and verify both the banner and any inline errors are cleared (this exercises resetForm via FormValueWatcher).
  5. Open the Type picker again, select the same type that's already active, return, and verify nothing changes (no flicker, no spurious reset, prior un-related state preserved) — exercises the reference-equality short-circuit in the watcher.
  6. Set Type = Text. Open the Initial value row, enter {report:total} on the sub-screen and tap Save to return. The form auto-switches Type to Formula (existing behavior of handleOnValueCommitted). Re-open the Type picker and verify it highlights Formula (the live type), not the previous Text.
  7. Complete the form with Name = "Project", Type = List, add a list value, tap Save, and verify the field is created.

Offline tests

Same as tests.

QA Steps

Same as tests.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed 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 added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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 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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 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.ts 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 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
ios.mp4
iOS: mWeb Safari
MacOS: Chrome / Safari

@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 19, 2026

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

@codecov
Copy link
Copy Markdown

codecov Bot commented May 19, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/SCREENS.ts 100.00% <ø> (ø)
src/components/Form/FormValueWatcher.tsx 100.00% <100.00%> (ø)
...gation/linkingConfig/RELATIONS/WORKSPACE_TO_RHP.ts 100.00% <ø> (ø)
src/libs/Navigation/linkingConfig/config.ts 76.92% <ø> (ø)
src/ROUTES.ts 18.85% <0.00%> (+1.25%) ⬆️
...gation/AppNavigator/ModalStackNavigators/index.tsx 6.68% <0.00%> (-0.06%) ⬇️
...pages/workspace/reports/CreateReportFieldsPage.tsx 0.00% <0.00%> (ø)
src/pages/workspace/reports/TypeSelector/index.tsx 0.00% <0.00%> (ø)
...orkspace/reports/TypeSelector/TypeSelectorPage.tsx 0.00% <0.00%> (ø)
... and 485 files with indirect coverage changes

@sharabai
Copy link
Copy Markdown
Contributor Author

@codex review

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6c1b37c0e8

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

[INPUT_IDS.TYPE]: item.value,
[INPUT_IDS.INITIAL_VALUE]: getDefaultInitialValueForReportFieldType(item.value),
});
Navigation.goBack();
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Use a fallback route when exiting type selector

Navigating away with plain Navigation.goBack() can fail when this screen is opened directly (deeplink/web reload) because there may be no back stack entry; Navigation.goBack logs and returns when canGoBack() is false. In that case, selecting a type leaves users stuck on this page even after writing draft values. Please pass an explicit fallback route (for this flow, the report-field create route) when going back from selection.

Useful? React with 👍 / 👎.

@sharabai
Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

@sharabai sharabai marked this pull request as ready for review May 20, 2026 11:42
@sharabai sharabai requested review from a team as code owners May 20, 2026 11:42
@melvin-bot melvin-bot Bot requested review from ZhenjaHorbach and trjExpensify and removed request for a team May 20, 2026 11:42
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 20, 2026

@ZhenjaHorbach 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]

@melvin-bot melvin-bot Bot removed the request for review from a team May 20, 2026 11:42
@trjExpensify trjExpensify removed their request for review May 21, 2026 01:15
@trjExpensify
Copy link
Copy Markdown
Contributor

PR doesn’t need product input as a refactor PR. Unassigning and unsubscribing myself.

);
}

TypeSelectorPage.displayName = 'TypeSelectorPage';
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As remember, we don't use displayName anymore

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZhenjaHorbach gonna change it then.

* Designed to live inside `FormProvider`'s render prop so consumers can react to draft-driven updates
* (e.g. from an RHP picker page) without having to wire up their own previous-value ref + effect.
*/
function FormValueWatcher<TFormID extends OnyxFormKey>({values, onValuesChange}: FormValueWatcherProps<TFormID>) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add this logic inside FormProvider?

Copy link
Copy Markdown
Contributor Author

@sharabai sharabai May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ZhenjaHorbach I don't think so. I separated it out into a component because FormProvider has more than 500 references across the codebase. And I was the only consumer. I wanted to be more modular and have something I could use, but also something that could be used by others if there's a need for it.

Copy link
Copy Markdown
Contributor Author

@sharabai sharabai May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the useEffect would run on every change of values for those 100+ consumers that don't use it.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay then
I'm just a little confused by render-null component and how it is used
But on the other hand, there seems to be no better solution in the current situation
So let's leave it as is 😁

@sharabai sharabai requested a review from ZhenjaHorbach May 21, 2026 17:01
@sharabai
Copy link
Copy Markdown
Contributor Author

@ZhenjaHorbach fixed the issue you mentioned

@ZhenjaHorbach
Copy link
Copy Markdown
Contributor

Looks like we don't reset a type after closing Add field modal

2026-05-22.10.21.10.mov

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants