Skip to content

[Payment due @abzokhattab] Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler#90358

Merged
roryabraham merged 8 commits into
mainfrom
Rory-ReanimatedModalReactCompiler
May 13, 2026
Merged

[Payment due @abzokhattab] Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler#90358
roryabraham merged 8 commits into
mainfrom
Rory-ReanimatedModalReactCompiler

Conversation

@roryabraham
Copy link
Copy Markdown
Contributor

@roryabraham roryabraham commented May 12, 2026

Explanation of Change

Refactors src/components/Modal/ReanimatedModal/index.tsx to follow the Rules of React, eliminate unnecessary effects, and compile cleanly with React Compiler.

Changes made (each as a separate commit):

  1. Group effects by responsibility — Split the original monolithic useEffect (which handled external handles, lifecycle callbacks, and state updates simultaneously) into three focused effects, each doing one thing. Moved the unmount cleanup into the same effect that creates the handles, co-locating creation with cleanup.

  2. Remove setState from unmount cleanupsetIsVisibleState(false) and setIsContainerOpen(false) in the cleanup effect were anti-patterns: on true unmount the state is discarded anyway, and in Strict Mode's simulated unmount/remount cycle they caused spurious extra lifecycle callbacks.

  3. Fix stale closure with useEffectEvent — The lifecycle callback effect (onModalWillShow/onModalWillHide) was suppressing react-hooks/exhaustive-deps to hide a stale closure bug. Replaced with useEffectEvent, which always reads the latest callback values without requiring them as reactive dependencies.

  4. Derive isTransitioning and eliminate isVisibleStateisTransitioning is exactly isVisible !== isContainerOpen and can be derived during rendering instead of maintained as state. isVisibleState was redundant state that mirrored the isVisible prop with a one-render lag. Eliminating both removes a useEffect that called setState in response to prop changes (a "you might not need an effect" anti-pattern flagged by both the ESLint rule and the React docs).

  5. Remove manual memoizationuseCallback and useMemo wrappers are unnecessary since the component compiles with React Compiler, which handles memoization automatically.

  6. Sort component internals — Grouped declarations in the conventional order: hooks → refs → derived values → callbacks → effects → JSX variables.

Fixed Issues

(partial) #68765

Tests

  1. Open any modal (bottom sheet, right-hand panel, popover) in the app
  2. Verify the modal opens and closes with correct animations on all platforms
  3. Verify the back button / Escape key dismisses the modal correctly
  4. Verify backdrop tap dismisses the modal
  5. Verify no errors appear in the JS console

Offline tests

Same as tests — modal open/close behavior is not network-dependent.

QA Steps

  1. Open a bottom-docked modal (e.g. long-press a report in the LHN)
  2. Tap the backdrop — verify it animates out correctly on all platforms
  3. Open a right-docked panel (e.g. Settings)
  4. Press Escape (web) or back button (Android) — verify it dismisses correctly
  5. 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov

roryabraham and others added 5 commits May 12, 2026 00:02
isTransitioning can be derived as isVisible !== isContainerOpen,
removing the need for a separate state variable and the effect that
set it. isVisibleState was redundant - it always mirrored the isVisible
prop with a one-render lag. Both are replaced with direct references
to the prop and the derived expression.

Co-authored-by: Cursor <cursoragent@cursor.com>
useCallback and useMemo wrappers are unnecessary since the component
compiles with React Compiler, which handles memoization automatically.

Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

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

Files with missing lines Coverage Δ
src/components/Modal/ReanimatedModal/index.tsx 82.89% <85.71%> (+4.68%) ⬆️
... and 6 files with indirect coverage changes

@roryabraham roryabraham changed the title Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler [WIP] Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler May 12, 2026
@roryabraham roryabraham marked this pull request as ready for review May 12, 2026 20:54
@roryabraham roryabraham requested review from a team as code owners May 12, 2026 20:54
@melvin-bot melvin-bot Bot requested review from joekaufmanexpensify and removed request for a team May 12, 2026 20:54
@roryabraham roryabraham changed the title [WIP] Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler May 12, 2026
@roryabraham roryabraham removed the request for review from joekaufmanexpensify May 12, 2026 20:55
@melvin-bot melvin-bot Bot requested a review from carlosmiceli May 12, 2026 20:55
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 12, 2026

@carlosmiceli 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 12, 2026 20:55
@roryabraham roryabraham requested a review from abzokhattab May 12, 2026 20:57
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: 173165ee7d

ℹ️ 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".

const isBackdropMounted = isVisibleState || ((isTransitioning || isContainerOpen !== isVisibleState) && getPlatform() === CONST.PLATFORM.WEB);
const modalVisibility = isVisibleState || isTransitioning || isContainerOpen !== isVisibleState;
const isBackdropMounted = isVisible || (isTransitioning && getPlatform() === CONST.PLATFORM.WEB);
const modalVisibility = isVisible || isTransitioning;
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 Preserve the closing transition when open is cancelled

If a modal is dismissed while its enter animation is still running, onOpenCallBack has not set isContainerOpen yet, so both isVisible and the derived isTransitioning become false. That makes modalVisibility false immediately and skips the normal Container close callback path; on Android this is the path that calls onModalHide() because Modal.onDismiss is documented here as unreliable. This can leave modal cleanup/focus state out of sync when users press the backdrop/back button quickly during opening.

Useful? React with 👍 / 👎.

@abzokhattab
Copy link
Copy Markdown
Contributor

@MelvinBot review the PR

@MelvinBot
Copy link
Copy Markdown
Contributor

PR Review

Clean, well-motivated refactor. The React patterns are correct and the commit-by-commit breakdown makes the reasoning easy to follow. A few observations:

Looks good

  • useEffectEvent for lifecycle callbacks — correct fix for the stale closure that was hidden behind eslint-disable. This is the canonical pattern.
  • Deriving isTransitioning — eliminates a classic "you might not need an effect" anti-pattern. The derived value isVisible !== isContainerOpen is always consistent within a render, unlike the old state which could lag.
  • Removing isVisibleState — the one-render lag mirror of the prop was the root of complexity. Driving everything off isVisible directly simplifies the state machine significantly.
  • Removing manual memoization — appropriate given React Compiler is active in this repo and the React Compiler Compliance CI check passes.

Worth verifying

Container rendering now gates on isVisible instead of isVisibleState (index.tsx:235, index.tsx:244): In the old code, the Container stayed mounted for one extra render after isVisible flipped to false (because isVisibleState was updated in an effect). Now the Container unmounts in the same render that isVisible goes false. This is fine because Container uses Reanimated Exiting Keyframe animations which intercept the unmount, but it's a subtle timing change worth confirming on Android — especially for fast show/hide toggling where the exit animation might not have completed before a new enter is triggered.

Minor nit

onBackButtonPressHandler inlines isVisible !== isContainerOpen instead of using the derived isTransitioning constant from line 72. They're semantically identical, but using isTransitioning would be more readable and consistent.


⚡ Reviewed by MelvinBot

@abzokhattab
Copy link
Copy Markdown
Contributor

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
  • 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
Screen.Recording.2026-05-13.at.00.21.50.mov
Android: mWeb Chrome
Screen.Recording.2026-05-13.at.00.23.29.mov
iOS: HybridApp
Screen.Recording.2026-05-13.at.00.07.25.mov
iOS: mWeb Safari
Screen.Recording.2026-05-13.at.00.08.19.mov
MacOS: Chrome / Safari
Screen.Recording.2026-05-13.at.00.25.47.mov

Copy link
Copy Markdown
Contributor

@abzokhattab abzokhattab left a comment

Choose a reason for hiding this comment

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

The changes look good to me ... all QA tests pass

@melvin-bot melvin-bot Bot changed the title Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler [Payment due @abzokhattab] Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler May 12, 2026
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 12, 2026

🎯 @abzokhattab, thanks for reviewing and testing this PR! 🎉

A payment issue will be created for your review once this PR is deployed to production.
E/E issue linked to the PR - no internal issue.

If payment is not needed (e.g., regression PR review fix etc), react with 👎 to this comment to prevent the payment issue from being created.

Comment thread src/components/Modal/ReanimatedModal/index.tsx
Comment thread src/components/Modal/ReanimatedModal/index.tsx Outdated
@OSBotify
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR. The changes are purely internal code refactoring (React Compiler compliance, effect cleanup, removing redundant state) with no user-facing behavior or UI changes.

@OSBotify
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@jponikarchuk
Copy link
Copy Markdown

Deploy Blocker #90438 was identified to be related to this PR.

@jponikarchuk
Copy link
Copy Markdown

Deploy Blocker #90442 was identified to be related to this PR.

@jponikarchuk
Copy link
Copy Markdown

Deploy Blocker #90465 was identified to be related to this PR.

@mitarachim
Copy link
Copy Markdown

Deploy Blocker #90463 was identified to be related to this PR.

@jponikarchuk
Copy link
Copy Markdown

Deploy Blocker #90510 was identified to be related to this PR.

abzokhattab added a commit to abzokhattab/App that referenced this pull request May 13, 2026
…tent flash

When isVisible becomes false, isTransitioning is true until the exit animation
completes. Rendering containerView with modalVisibility (isVisible || isTransitioning)
instead of isVisible alone ensures the content stays mounted through the full
fade-out, matching the previous isVisibleState behavior that was removed in Expensify#90358.

Fixes Expensify#90510
@mkhutornyi mkhutornyi mentioned this pull request May 13, 2026
@jponikarchuk
Copy link
Copy Markdown

Deploy Blocker #90527 was identified to be related to this PR.

Beamanator pushed a commit that referenced this pull request May 13, 2026
…ReactCompiler"

This reverts commit 0348dd5, reversing
changes made to da489d1.
Beamanator added a commit that referenced this pull request May 13, 2026
…dal-react-compiler

Revert "Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler" (#90358)
OSBotify pushed a commit that referenced this pull request May 13, 2026
…dal-react-compiler

Revert "Refactor ReanimatedModal/index.tsx to follow Rules of React and compile with React Compiler" (#90358)

(cherry picked from commit b228940)

(cherry-picked to staging by Beamanator)
@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 9.3.73-4 🚀

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

@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 13, 2026

🤖 Payment issue created: #90566

@OSBotify
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor

No help site changes are required for this PR. The changes are purely internal refactoring of the ReanimatedModal component (restructuring effects, removing redundant state, eliminating manual memoization for React Compiler compatibility). No user-facing features, UI labels, or settings were added, removed, or modified.

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.

7 participants