Skip to content

Migrate AvatarCropModal to @react-navigation modal screen#93926

Merged
mountiny merged 28 commits into
Expensify:mainfrom
software-mansion-labs:borys3kk-migrate-avatar-crop-modal
Jul 8, 2026
Merged

Migrate AvatarCropModal to @react-navigation modal screen#93926
mountiny merged 28 commits into
Expensify:mainfrom
software-mansion-labs:borys3kk-migrate-avatar-crop-modal

Conversation

@borys3kk

@borys3kk borys3kk commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Migrates the avatar cropper from a <Modal> (AvatarCropModal) to a navigation screen (AvatarCropPage) opened via the avatar-crop dynamic route. The picked image is handed off through Onyx (base64 on web, file URI on native) via the new useAvatarCrop hook and AvatarCrop actions. Entry is restricted to the avatar-upload surfaces so the static suffix can't hijack user-named items.

Fixed Issues

$ #90474
PROPOSAL:

Tests

  • User avatar
  1. Go to Account > Profile
  2. Click on profile picture
  3. Upload new photo
  4. Ensure that RHP with path **/avatar-crop is opened
  5. Click save
  6. Ensure the profile avatar updated successfully
  • Workspace avatar
  1. Go to workspaces tab
  2. Select a workspace
  3. Click on workspace picture and upload new photo
  4. Ensure that RHP with path **/avatar-crop is opened
  5. Click save
  6. Ensure the workspace avatar updated successfully
  • Agent avatar

Prerequisite - have added agents in Account > Agents (Go to Account > Agents, click add agents, click create agent)

  1. Go to Account > agents
  2. Click edit on agent
  3. Click on agent avatar and upload new photo
  4. Ensure that RHP with path **/avatar-crop is opened
  5. Click save
  6. Ensure the agent avatar updated successfully
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

same as tests

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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 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)
  • 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)
  • 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.
  • 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_native.mov
Android: mWeb Chrome
android_web.mov
iOS: Native
ios_native.mov
iOS: mWeb Safari
ios_web.mov
MacOS: Chrome / Safari
Screen.Recording.2026-06-24.at.09.56.55.mov

@codecov

codecov Bot commented Jun 18, 2026

Copy link
Copy Markdown

Codecov Report

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

Files with missing lines Coverage Δ
src/ONYXKEYS.ts 100.00% <ø> (ø)
src/ROUTES.ts 20.72% <ø> (ø)
src/SCREENS.ts 100.00% <ø> (ø)
src/libs/AvatarCropUtils.ts 100.00% <100.00%> (ø)
src/libs/Navigation/linkingConfig/config.ts 76.92% <ø> (ø)
src/libs/actions/AvatarCrop.ts 100.00% <100.00%> (ø)
src/components/AvatarWithImagePicker.tsx 1.51% <0.00%> (+0.12%) ⬆️
...gation/AppNavigator/ModalStackNavigators/index.tsx 6.65% <50.00%> (+0.10%) ⬆️
...on/AppNavigator/Navigators/RightModalNavigator.tsx 0.00% <0.00%> (ø)
...rc/pages/settings/Profile/Avatar/AvatarPreview.tsx 0.00% <0.00%> (ø)
... and 9 more
... and 114 files with indirect coverage changes

@borys3kk

Copy link
Copy Markdown
Contributor Author

@codex review

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

Copy link
Copy Markdown

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: edbcb6316b

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

Comment thread src/hooks/useAvatarCrop.ts
@borys3kk borys3kk marked this pull request as ready for review June 19, 2026 08:41
@borys3kk borys3kk requested review from a team as code owners June 19, 2026 08:41
@melvin-bot melvin-bot Bot requested review from parasharrajat and removed request for a team June 19, 2026 08:41
@melvin-bot

melvin-bot Bot commented Jun 19, 2026

Copy link
Copy Markdown

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

@borys3kk borys3kk marked this pull request as draft June 19, 2026 08:41
@melvin-bot melvin-bot Bot requested review from JmillsExpensify and removed request for a team June 19, 2026 08:41
@borys3kk

Copy link
Copy Markdown
Contributor Author

@codex review

Comment thread src/hooks/useAvatarCrop.ts Outdated
Comment thread src/pages/AvatarCropPage.tsx Outdated

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

Copy link
Copy Markdown

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: 010ce59c44

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

Comment thread src/ROUTES.ts Outdated
@borys3kk

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: 02fd730d5a

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

@borys3kk

borys3kk commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@parasharrajat fixed it with state persistence between refreshes and all tests pass now so it should be good to go

@parasharrajat

Copy link
Copy Markdown
Member

Looks like once I refresh the page and upload the image, it is not saved back to profile page.

01.07.2026_23.20.31_REC.mp4

@borys3kk

borys3kk commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

fixed it now! 🚀

@parasharrajat

Copy link
Copy Markdown
Member

BUG: All platforms: New Agent profile update does not work.

04.07.2026_21.05.39_REC.mp4

@borys3kk

borys3kk commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author
Screen.Recording.2026-07-06.at.11.58.28.mov

Hmm, it worked for me without any issues can you retest?

@parasharrajat

Copy link
Copy Markdown
Member

@borys3kk You have to click New Agent button on the top.

@borys3kk

borys3kk commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

fixed, ready for re-review 🚀

@parasharrajat parasharrajat left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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 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 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)
  • 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)
  • 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.
  • 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

🔲 iOS / native

07.07.2026_21.48.08_REC.mp4

🔲 iOS / Safari

07.07.2026_21.51.08_REC.mp4

🔲 MacOS / Chrome

04.07.2026_18.27.15_REC.mp4
07.07.2026_21.29.55_REC.mp4

🔲 Android / native

07.07.2026_22.14.55_REC.mp4

🎀 👀 🎀 C+ reviewed

@melvin-bot melvin-bot Bot requested a review from mountiny July 7, 2026 16:47

@mountiny mountiny left a comment

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.

Small nits, thanks!

Comment thread src/libs/actions/AvatarCrop.ts
Comment thread src/libs/actions/AvatarCrop.ts
@borys3kk

borys3kk commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Small nits, thanks!

both nits resolved

@mountiny mountiny merged commit 18aeb65 into Expensify:main Jul 8, 2026
36 checks passed
@OSBotify

OSBotify commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🚧 mountiny has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

OSBotify commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.4.32-0 🚀

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

@MelvinBot

Copy link
Copy Markdown
Contributor

Help site review — no docs changes required

I reviewed the changes in this PR against the help site articles under docs/articles.

Conclusion: No help site updates are required.

This PR is an internal architectural refactor — it migrates the avatar cropper from a <Modal> (AvatarCropModal) to a navigation screen (AvatarCropPage) opened via the avatar-crop route, handing the picked image off through Onyx. The end-user experience of uploading, cropping, and saving an avatar is functionally unchanged; only the underlying implementation differs.

The relevant help articles describe this flow only at a high level and don't reference the cropper's implementation or the modal-vs-page distinction that changed here:

  • new-expensify/settings/Account-Settings.md — "Profile Photo → Upload or change your photo" (no cropping/implementation detail)
  • expensify-classic/settings/Add-profile-photo.md — "Edit photo → Upload photo" (Expensify Classic, not affected by this NewDot change)

Since there are no new features, settings, tabs, labels, or user-facing behavior changes introduced, there's nothing in the help site content to update. I did not create a draft PR.

If you feel a specific article should be updated (e.g. to document the cropping/preview step in more detail), let me know which one and I'll draft it.

@mitarachim

Copy link
Copy Markdown

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.4.32-3 🚀

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

Bundle Size Analysis (Sentry):

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.

8 participants