Skip to content

feat: allow users to change user created workspace room avatar#72446

Merged
Beamanator merged 18 commits into
Expensify:mainfrom
samranahm:revert-72436-revert-66883-65210/edit-room-avatar
Oct 31, 2025
Merged

feat: allow users to change user created workspace room avatar#72446
Beamanator merged 18 commits into
Expensify:mainfrom
samranahm:revert-72436-revert-66883-65210/edit-room-avatar

Conversation

@samranahm

@samranahm samranahm commented Oct 13, 2025

Copy link
Copy Markdown
Contributor

Explanation of Change

Workspace member was not able to edit the room avatar, this PR introduce AvatarWithImagePicker in RoomHeaderAvatars to let non anonymous user to change room avatar.

Fixed Issues

$ #65210
PROPOSAL: #65210 (comment)

Tests

Precondition:

  • Create workspace and invite invite some member on workspace
  • Create workspace room

[Admin]

  1. Open workspace room
  2. Click header to open report detail page
  3. Verify you can edit room avatar
  4. Edit room avatar
  5. Verify system message appear changed the room avatar
  6. Open report detail page and remove the room avatar
  7. Verify room avatar is workspace avatar and system message is removed the room avatar
  8. Verify LHN alternate text is You: removed the room avatar

[Workspace member]

  1. Open workspace room that admin or any other user created
  2. Click header to open report detail page
  3. Verify you can't edit room avatar until you're a participant on that room
  4. Send a message to room chat
  5. Open report detail page upload and remove the avatar
  6. Verify log message appear and it's correct for all other room members

[Non Workspace member]

  1. Open a public room where you're not a member on workspace
  2. Participate with chat in room
  3. Open report detail page and verify you can't edit room avatar

[An Auditor]

  1. Admin invite a user as auditor
  2. Auditor open a workspace room
  3. Participate on room
  4. Open workspace report detail page and verify you can't edit room avatar
  • Verify that no errors appear in the JS console

Offline tests

  1. Open workspace room
  2. Upload image to edit room avatar
  3. Verify room avatar successfully updated
  4. Verify system message appear changed the room avatar
  5. Remove room avatar
  6. Verify avatar removed and system message appear removed the room avatar

QA Steps

Same as test

// 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
    • 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
Android.native.mp4
Android: mWeb Chrome
Android.mWeb.chrome.mp4
iOS: Native
iOS: mWeb Safari
IOS.mWeb.safari.mp4
MacOS: Chrome / Safari
macOS.chrome.mp4
MacOS: Desktop
Desktop.mp4

@codecov

codecov Bot commented Oct 13, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 36.50794% with 40 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/components/RoomHeaderAvatars.tsx 0.00% 12 Missing ⚠️
src/libs/ReportActionsUtils.ts 12.50% 7 Missing ⚠️
src/libs/ReportUtils.ts 53.84% 6 Missing ⚠️
src/libs/actions/Report.ts 68.75% 5 Missing ⚠️
...lScreen/routes/report/ReportAvatarModalContent.tsx 0.00% 4 Missing ⚠️
...ges/home/report/ContextMenu/ContextMenuActions.tsx 0.00% 2 Missing ⚠️
src/components/AvatarWithImagePicker.tsx 0.00% 1 Missing ⚠️
src/libs/OptionsListUtils/index.ts 50.00% 1 Missing ⚠️
src/libs/SidebarUtils.ts 50.00% 1 Missing ⚠️
src/pages/ReportDetailsPage.tsx 50.00% 1 Missing ⚠️
Files with missing lines Coverage Δ
src/CONST/index.ts 85.71% <ø> (ø)
src/components/AvatarButtonWithIcon.tsx 100.00% <100.00%> (ø)
src/libs/API/types.ts 100.00% <ø> (ø)
src/pages/workspace/WorkspaceOverviewPage.tsx 0.00% <ø> (ø)
src/components/AvatarWithImagePicker.tsx 3.84% <0.00%> (-0.08%) ⬇️
src/libs/OptionsListUtils/index.ts 71.92% <50.00%> (-0.04%) ⬇️
src/libs/SidebarUtils.ts 80.57% <50.00%> (-0.14%) ⬇️
src/pages/ReportDetailsPage.tsx 58.94% <50.00%> (-0.06%) ⬇️
...ges/home/report/ContextMenu/ContextMenuActions.tsx 0.91% <0.00%> (-0.01%) ⬇️
...lScreen/routes/report/ReportAvatarModalContent.tsx 5.00% <0.00%> (-1.25%) ⬇️
... and 4 more

... and 70 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.

@s77rt

s77rt commented Oct 22, 2025

Copy link
Copy Markdown
Member

@samranahm Can you update this to use UpdateRoomAvatar instead of UpdatePolicyRoomAvatar. cc @Beamanator this is to align with other auth commands e.g. UpdateRoomDescription

@samranahm

Copy link
Copy Markdown
Contributor Author

Fair point, I'll update it shortly along with system message.

@s77rt

s77rt commented Oct 22, 2025

Copy link
Copy Markdown
Member

For the system message, it's going to be a new report action of type UPDATEROOMAVATAR. You can use UPDATEROOMDESCRIPTION as a ref

@s77rt

s77rt commented Oct 22, 2025

Copy link
Copy Markdown
Member

Also now the command accepts another parameter reportActionID which is the report action id for the new system message (pass an optimistic id)

@samranahm

Copy link
Copy Markdown
Contributor Author

Got it

@s77rt

s77rt commented Oct 22, 2025

Copy link
Copy Markdown
Member

Regarding permission, only room participants who are also workspace members can change the avatar, so for example if you invited someone to a room but they are not a a workspace member then they shouldn't see the option to change the avatar.

This is also to align with room description changes. Let me know if you have any questions

@samranahm

Copy link
Copy Markdown
Contributor Author

That is indeed a practical solution. I'll update this PR ASAP.

@samranahm samranahm closed this Oct 23, 2025
@samranahm
samranahm deleted the revert-72436-revert-66883-65210/edit-room-avatar branch October 23, 2025 11:26
@samranahm
samranahm restored the revert-72436-revert-66883-65210/edit-room-avatar branch October 23, 2025 11:27
@samranahm samranahm reopened this Oct 23, 2025
@samranahm

Copy link
Copy Markdown
Contributor Author

@s77rt can you confirm if BE is now accepting UpdateRoomAvatar instead of UpdatePolicyRoomAvatar

@s77rt

s77rt commented Oct 23, 2025

Copy link
Copy Markdown
Member

Not yet, the relevant PRs are not merged yet

@samranahm

Copy link
Copy Markdown
Contributor Author

Alright, I have updated the name here.
System message is ready, just need to test before pushing once BE PRs merged.

@s77rt

s77rt commented Oct 27, 2025

Copy link
Copy Markdown
Member

Small update regarding permission: auditors can't change the avatar (even though they are effectively policy members and even if they are participants in the room)

@s77rt

s77rt commented Oct 27, 2025

Copy link
Copy Markdown
Member

BE PR hit production couple of hours ago so you should be able to test

Edit: Ah actually we are waiting on another PR too

@samranahm
samranahm marked this pull request as ready for review October 28, 2025 12:48
@samranahm
samranahm requested a review from a team as a code owner October 28, 2025 12:48
@melvin-bot
melvin-bot Bot requested review from eh2077 and removed request for a team October 28, 2025 12:48
@melvin-bot

melvin-bot Bot commented Oct 28, 2025

Copy link
Copy Markdown

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

@samranahm

Copy link
Copy Markdown
Contributor Author

Waiting for Web-Expensify, will push the system message right after it.

@eh2077 eh2077 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.

I think we need to build optimistic system message for changing room avatar, right?

Comment on lines +65 to +66
/** The name associated with avatar */
name?: string;

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.

Why this is needed?

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.

@eh2077 When we upload the avatar offline and refresh the page we get workspace default icon and that default icon should be workspace name's first letter but it's fallBack workspace building icon. So we are passing workspace name to get correct workspace icon.

Comment thread src/components/AvatarWithImagePicker.tsx
@melvin-bot

melvin-bot Bot commented Oct 30, 2025

Copy link
Copy Markdown

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

@samranahm

Copy link
Copy Markdown
Contributor Author

@eh2077 PR ready, please take a look.

onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${reportID}`,
value: {
[optimisticAction.reportActionID]: {pendingAction: null},

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.

Need to clear pending action from failureData too?

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.

Agree, we should clear pending action from failureData too.

Comment thread src/libs/ReportUtils.ts Outdated
Comment on lines +7730 to +7731
text: avatarUrl ? `changed room avatar` : 'removed the room avatar',
html: avatarUrl ? `<muted-text>changed room avatar</muted-text>` : '<muted-text>removed the room avatar</muted-text>',

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.

I think this should be fine as translateLocal is deprecated.

@eh2077

eh2077 commented Oct 31, 2025

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
    • 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-10-31.at.11.55.05.PM.mov
Android: mWeb Chrome
Screen.Recording.2025-10-31.at.11.53.44.PM.mov
iOS: HybridApp
Screen.Recording.2025-10-31.at.11.53.20.PM.mov
iOS: mWeb Safari
Screen.Recording.2025-10-31.at.11.48.00.PM.mov
MacOS: Chrome / Safari
Screen.Recording.2025-10-31.at.11.41.24.PM.mov
MacOS: Desktop
Screen.Recording.2025-10-31.at.11.56.55.PM.mov

@eh2077 eh2077 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.

LGTM 🚀

@melvin-bot
melvin-bot Bot requested a review from Beamanator October 31, 2025 16:00

@Beamanator Beamanator 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.

Loving it 👍

@Beamanator
Beamanator merged commit ef2def5 into Expensify:main Oct 31, 2025
29 checks passed
@samranahm

Copy link
Copy Markdown
Contributor Author

@Beamanator This turned out to be a pretty deep one. If appropriate, maybe we could consider increasing the bounty?

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.2.42-0 🚀

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

Comment on lines +27 to +33
if (isUserCreatedPolicyRoom(report)) {
return {
source: report?.avatarUrl ? getFullSizeAvatar(report.avatarUrl, 0) : undefined,
headerTitle: getReportName(report),
isWorkspaceAvatar: false,
};
}

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.

@samranahm these lines might be related to the deployment blocker. Can you take a look please? Thanks

@OSBotify

OSBotify commented Nov 3, 2025

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.2.42-11 🚀

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

errors={report.errorFields?.avatar ?? null}
errorRowStyles={styles.mt6}
onErrorClose={() => clearAvatarErrors(report.reportID)}
style={[styles.w100, styles.mb3, styles.alignItemsStart, styles.sectionMenuItemTopDescription]}

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.

Adding styles.sectionMenuItemTopDescription caused this alignment issue: #76647. That style seemed unnecessary so we have remove that in this PR: #77394

More details in this proposal: #76647 (comment)

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.

6 participants