Skip to content

[No QA] chore/refactor user avatar utils#73868

Merged
grgia merged 23 commits intoExpensify:mainfrom
software-mansion-labs:chore/refactor-user-avatar-utils
Nov 7, 2025
Merged

[No QA] chore/refactor user avatar utils#73868
grgia merged 23 commits intoExpensify:mainfrom
software-mansion-labs:chore/refactor-user-avatar-utils

Conversation

@jmusial
Copy link
Contributor

@jmusial jmusial commented Oct 30, 2025

Explanation of Change

Cleanup refactor.

  • Splits UserAvatarUtils from UserUtils
  • Adds test
  • Adds jsdoc

Fixed Issues

$ #73221

PROPOSAL:

Depends on

#73412

Tests

  1. Open app
  2. Set new avatar
  3. Make sure it shows properly everywhere

Offline tests

n/a

QA Steps

n/a

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
    • MacOS: Desktop
  • 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
0072.android.native.mov
Android: mWeb Chrome
0072.android.chrome.mov
iOS: Native
0072.ios.native.mov
iOS: mWeb Safari
0072.ios.safari.mov
MacOS: Chrome / Safari
0072.desktop.chrome.mov
MacOS: Desktop
0072.desktop.native.mov

@codecov
Copy link

codecov bot commented Oct 30, 2025

Codecov Report

❌ Patch coverage is 76.41509% with 25 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
...lScreen/routes/report/ReportAvatarModalContent.tsx 0.00% 7 Missing ⚠️
src/pages/settings/Profile/Avatar/AvatarPage.tsx 0.00% 4 Missing ⚠️
src/libs/UserAvatarUtils.ts 95.89% 3 Missing ⚠️
...rc/pages/home/sidebar/AvatarWithDelegateAvatar.tsx 0.00% 3 Missing ⚠️
src/libs/Avatars/PresetAvatarCatalog.ts 80.00% 2 Missing ⚠️
src/hooks/useAvatarMenu.ts 0.00% 1 Missing ⚠️
src/pages/ShareCodePage.tsx 0.00% 1 Missing ⚠️
...ntModalScreen/routes/ProfileAvatarModalContent.tsx 0.00% 1 Missing ⚠️
...ModalScreen/routes/WorkspaceAvatarModalContent.tsx 0.00% 1 Missing ⚠️
...pace/companyCards/WorkspaceCompanyCardsListRow.tsx 0.00% 1 Missing ⚠️
... and 1 more
Files with missing lines Coverage Δ
src/components/AttachmentModal.tsx 0.00% <ø> (ø)
src/components/Avatar.tsx 93.54% <100.00%> (ø)
src/components/AvatarButtonWithIcon.tsx 100.00% <ø> (ø)
src/components/AvatarSelector.tsx 100.00% <100.00%> (ø)
src/components/AvatarWithIndicator.tsx 100.00% <ø> (ø)
...omponents/DisplayNames/DisplayNamesTooltipItem.tsx 0.00% <ø> (ø)
src/components/MenuItem.tsx 86.08% <ø> (ø)
...ponents/ReportActionAvatars/ReportActionAvatar.tsx 85.57% <ø> (ø)
src/components/RoomHeaderAvatars.tsx 3.22% <ø> (ø)
.../SelectionListWithSections/Search/UserInfoCell.tsx 100.00% <ø> (ø)
... and 22 more

... and 15 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jmusial jmusial changed the title Chore/refactor user avatar utils [No QA] chore/refactor user avatar utils Oct 30, 2025
@grgia grgia self-requested a review October 31, 2025 16:57
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

I know this is a draft, just a few minor thoughts

Comment on lines +200 to +202
function isLetterAvatar(originalFileName?: string): boolean {
return !!(originalFileName && LETTER_AVATAR_NAME_REGEX.test(originalFileName));
}
Copy link
Contributor

Choose a reason for hiding this comment

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

note:

For defaults/web we can also check if the path is in web static

Copy link
Contributor Author

@jmusial jmusial Nov 3, 2025

Choose a reason for hiding this comment

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

you mean to check the avatarUrl if it contains LETTER_AVATAR_NAME_REGEX ?
The issue is that it does not retain the OG file name :( always comes as sth like
https://d1wpcgnaa73g0y.cloudfront.net/2445d8267399f0ae3149d9f3237cccd62444449f.png

Would be soo much easier if it did 😢

@@ -0,0 +1,275 @@
import * as defaultAvatars from '@components/Icon/DefaultAvatars';
Copy link
Contributor

Choose a reason for hiding this comment

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

given this is not fixing anything, is it better to push the passing tests in one PR, and then push this PR to prove it doesn't change the logic?

Copy link
Contributor

Choose a reason for hiding this comment

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

oh I see these were just moved

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yup, moved + added some test cases

* getCustomAvatarURL(CONST.ACCOUNT_ID.CONCIERGE)
* // => CONST.CONCIERGE_ICON_URL
*/
function getCustomAvatarURL(accountID: number = CONST.DEFAULT_NUMBER_ID, accountEmail?: string, avatarURL?: string): string {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we be changing this from getDefault? I wonder if instead we should separate the generator from the getter. The old getDefaultAvatarURL seems to mostly have been used for optimistic generation.

WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True, changed

@jmusial jmusial marked this pull request as ready for review November 3, 2025 17:08
@jmusial jmusial requested a review from a team as a code owner November 3, 2025 17:08
@melvin-bot melvin-bot bot requested review from Pujan92 and removed request for a team November 3, 2025 17:08
@melvin-bot
Copy link

melvin-bot bot commented Nov 3, 2025

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2025

LGTM 👍 Thank you for your hard work!

@jmusial jmusial requested a review from a team as a code owner November 4, 2025 08:50
@melvin-bot melvin-bot bot requested review from joekaufmanexpensify and removed request for a team November 4, 2025 08:50
@dukenv0307
Copy link
Contributor

@jmusial @grgia Thanks for your update, now it looks better but should the default avatar be a custom avatar?

const ALL_CUSTOM_AVATARS: Record<CustomAvatarID, AvatarEntry> = {
    ...DEFAULTS,
    ...SEASON_F1,
};

}

const isUsingDefaultAvatar = (!imageData.uri && isDefaultOrCustomDefaultAvatar(currentUserPersonalDetails?.avatar, currentUserPersonalDetails?.originalFileName)) || !!selected;
const isUsingDefaultAvatar = (!imageData.uri && (isCustomAvatar(currentUserPersonalDetails?.avatar) || isLetterAvatar(currentUserPersonalDetails?.originalFileName))) || !!selected;
Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should rename isUsingDefaultAvatar.

@grgia
Copy link
Contributor

grgia commented Nov 6, 2025

Thanks for your update, now it looks better but should the default avatar be a custom avatar?

Yes it should be in this grouping, but since this is still causing confusing we should rename @jmusial

ALL_CUSTOM_AVATARS

@jmusial jmusial requested a review from a team as a code owner November 6, 2025 14:21
@melvin-bot
Copy link

melvin-bot bot commented Nov 6, 2025

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@jmusial
Copy link
Contributor Author

jmusial commented Nov 6, 2025

@grgia changed CustomAvatars to PresetAvatars. Hopefully that is clearer. @dukenv0307 changed

@grgia
Copy link
Contributor

grgia commented Nov 6, 2025

that's a great name choice, happy with that

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

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

@github-actions
Copy link
Contributor

github-actions bot commented Nov 6, 2025

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪
Built from App PR #73868.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/73868/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/73868/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/73868/NewExpensify.dmg https://73868.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@dukenv0307
Copy link
Contributor

Code looks good. Start testing now

@dukenv0307
Copy link
Contributor

@jmusial can you please resolve the conflict?

Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Triggering a final build, that rename choice made everything 10x clearer. Great work here 🤞

@grgia
Copy link
Contributor

grgia commented Nov 7, 2025

@jmusial actually ill trigger it once you merge main, ping me!

@jmusial
Copy link
Contributor Author

jmusial commented Nov 7, 2025

@grgia @dukenv0307 done

@dukenv0307
Copy link
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
    • 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
Screen.Recording.2025-11-07.at.21.59.54.mov
Android: mWeb Chrome
Screen.Recording.2025-11-07.at.16.50.48.mov
iOS: HybridApp
Screen.Recording.2025-11-07.at.21.49.27.mov
iOS: mWeb Safari
Screen.Recording.2025-11-07.at.15.03.02.mov
MacOS: Chrome / Safari
Screen.Recording.2025-11-07.at.14.54.42.mov
MacOS: Desktop
Screen.Recording.2025-11-07.at.16.55.05.mov

@melvin-bot melvin-bot bot requested a review from grgia November 7, 2025 15:01
@grgia grgia merged commit 181d96e into Expensify:main Nov 7, 2025
28 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Nov 7, 2025

✋ 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
Copy link
Contributor

OSBotify commented Nov 7, 2025

🚀 Deployed to staging by https://github.com/grgia in version: 9.2.47-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.2.47-1 🚀

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

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.

5 participants