Enable avatar preview for workspace & thread replies by spcheema · Pull Request #24425 · Expensify/App

spcheema · 2023-08-11T13:00:10Z

Details

Fixed Issues

$ #21073
PROPOSAL: #21073 (comment)

Tests

Scenario 1:

Select a workspace from LHN and it'll open the workspace report
Click on the workspace report header and the details page will up
Now click on the workspace avatar from RHN (details page)
Click on the workspace avatar to open the avatar preview
Verify the workspace avatar and name on the preview page

Scenario 2:

Select a workspace from LHN and it'll open the workspace report
Send a message in the workspace and click on reply in the thread option
Click the header of the thread and the details page will up
Click on each avatar to open up the avatar preview
Verify avatar and name on the preview page

Scenario 3:

Go to any chat
Send a message and click on reply in the thread option
Click the header of the thread and the details page will up
Click on an avatar to open the avatar preview
Verify avatar and name on the preview page

Verify that no errors appear in the JS console

Offline tests

QA Steps

Scenario 1:

Select a workspace from LHN and it'll open the workspace report
Click on the workspace report header and the details page will up
Now click on the workspace avatar from RHN (details page)
Click on the workspace avatar to open the avatar preview
Verify the workspace avatar and name on the preview page

Scenario 2:

Select a workspace from LHN and it'll open the workspace report
Send a message in the workspace and click on reply in the thread option
Click the header of the thread and and details page will up
Click on each avatar to open up the avatar preview
Verify avatar and name on the preview page

Scenario 3:

Go to any chat
Send a message and click on reply in the thread option
Click the header of the thread and details page will up
Click on an avatar to open the avatar preview
Verify avatar and name on the preview page

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.mp4

Mobile Web - Chrome

Mobile.Web.-.Chrome.mp4

Mobile Web - Safari

Mobile.-.Safari.mp4

Desktop

Desktop.mp4

iOS

Re_.iOS.-.13.August.2023.mp4

Android

Android.mp4

spcheema · 2023-08-11T13:14:57Z

@aimane-chnaif Here is a draft PR. Please have a look and leave your feedback. I'll update screenshots later.

melvin-bot · 2023-08-11T13:58:24Z

@aimane-chnaif 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]

spcheema · 2023-08-14T01:13:21Z

@aimane-chnaif I am currently having issues with Android emulator and haven't found any solution yet. I'll update android testing video later.

https://expensify.slack.com/archives/C01GTK53T8Q/p1691972994564499

spcheema · 2023-08-14T09:18:13Z

@aimane-chnaif I am currently having issues with Android emulator and haven't found any solution yet. I'll update android testing video later.

https://expensify.slack.com/archives/C01GTK53T8Q/p1691972994564499

Android testing video attached

spcheema · 2023-08-14T23:51:17Z

Bumping up for code review @aimane-chnaif

aimane-chnaif · 2023-08-15T09:06:23Z

@spcheema when user sets custom workspace avatar, I think it should show original size to be consistent with custom user avatar

Screen.Recording.2023-08-15.at.10.04.59.AM.mov

aimane-chnaif · 2023-08-15T09:14:20Z

@spcheema when user sets custom workspace avatar, I think it should show original size to be consistent with custom user avatar

Screen.Recording.2023-08-15.at.10.04.59.AM.mov

NVM, I confirmed that it's already resized when upload workspace photo. So out of scope

spcheema · 2023-08-15T09:18:38Z

@aimane-chnaif That's the max size for the workspace

Here is the image I have used

src/components/Attachments/AttachmentView/index.js

src/components/RoomHeaderAvatars.js

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

aimane-chnaif · 2023-08-15T09:36:12Z

This is minor but hover area doesn't cover full workspace avatar

Screen.Recording.2023-08-15.at.10.34.06.AM.mov

spcheema · 2023-08-15T10:40:10Z

This is minor but the hover area doesn't cover the full workspace avatar

Screen.Recording.2023-08-15.at.10.34.06.AM.mov
@aimane-chnaif I have tweaked the pressable container style and it's now covering the full avatar area.

61.New.Expensify.-.15.August.2023.mp4

You may notice 4px hover cover outside the avatar is also clickable. It's due to the 4px border of the avatar container.

We can't reduce it otherwise avatars overlap won't be visible

aimane-chnaif · 2023-08-15T11:52:03Z

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 tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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(themeColors.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 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.
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

Web

web.mov

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

aimane-chnaif · 2023-08-15T11:54:27Z

Now workspace avatar preview and user avatar preview look exactly same, no further design confirmation is needed.

aimane-chnaif

LGTM 🎉
@PauloGasparSv all yours!

PauloGasparSv

LGTM to me too and tests great on Web.

Nice catch on separating that margin style too.

OSBotify · 2023-08-15T17:46:57Z

✋ 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 · 2023-08-17T02:21:16Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.55-0 🚀

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

OSBotify · 2023-08-21T22:27:58Z

🚀 Deployed to staging by https://github.com/PauloGasparSv in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:10:59Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

kidroca · 2023-11-24T13:25:30Z

src/components/RoomHeaderAvatars.js

+            <AttachmentModal
+                headerTitle={props.icons[0].name}
+                source={UserUtils.getFullSizeAvatar(props.icons[0].source, props.icons[0].id)}
+                isAuthTokenRequired


@spcheema @aimane-chnaif

I have a query regarding the isAuthTokenRequired flag set to true for the AttachmentModal component. This flag's setting becomes particularly interesting when compared with the Avatar component's behavior. Both AttachmentModal and Avatar utilize the same image source (props.icons[0].source), yet Avatar manages to load its image without requiring authentication.

This leads me to wonder if there are specific scenarios where authentication is indeed necessary for loading an avatar image. Understanding this is crucial because if authentication is not required in these cases, we might be exposing our authentication tokens to external addresses unnecessarily.

Furthermore, it’s important to consider future updates, particularly regarding the Image component's adaptation to use header-based authentication. Such changes can introduce complexities due to browser security features like CORS (Cross-Origin Resource Sharing). Since avatar sources are not hosted on the same origin, this could potentially lead to CORS errors, disrupting the user experience.

Could you provide insights on the necessity of the isAuthTokenRequired flag in this context? Understanding the rationale behind this decision will help us ensure both secure and efficient handling of image sources across different components.

I'm also interested - AFAIK the auth tokens were only needed for chat attachments, since these obviously need to be private (only accessible by the participants of a report where the chat attachment was sent). I don't know of / remember a reason we would need any avatars to be private & require auth tokens to fetch

Enable avatar preview for workspace & thread replies

2c45580

spcheema marked this pull request as ready for review August 11, 2023 13:58

spcheema requested a review from a team as a code owner August 11, 2023 13:58

melvin-bot bot requested review from aimane-chnaif and removed request for a team August 11, 2023 13:58

Update props docs

9d4d792

PauloGasparSv self-requested a review August 14, 2023 14:41

aimane-chnaif reviewed Aug 15, 2023

View reviewed changes

src/components/Attachments/AttachmentView/index.js Outdated Show resolved Hide resolved

Avoid duplicate func call

ffcf575

aimane-chnaif reviewed Aug 15, 2023

View reviewed changes

src/components/RoomHeaderAvatars.js Outdated Show resolved Hide resolved

aimane-chnaif reviewed Aug 15, 2023

View reviewed changes

src/components/RoomHeaderAvatars.js Outdated Show resolved Hide resolved

spcheema and others added 3 commits August 15, 2023 19:32

Refactor & cleanup

0a98249

Update src/components/RoomHeaderAvatars.js

0282519

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

Replace static string with const

301ad35

Fix avatar hover issue in the case of multiple avatars

8ff1d2f

spcheema requested a review from aimane-chnaif August 15, 2023 10:41

aimane-chnaif approved these changes Aug 15, 2023

View reviewed changes

PauloGasparSv approved these changes Aug 15, 2023

View reviewed changes

PauloGasparSv merged commit 82f06ed into Expensify:main Aug 15, 2023

spcheema deleted the fix/21073-show-avatar-preview branch August 16, 2023 11:03

OSBotify mentioned this pull request Aug 17, 2023

Deploy Checklist: New Expensify 2023-08-17 #25160

Closed

75 tasks

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

melvin-bot bot mentioned this pull request Aug 21, 2023

[HOLD for payment 2023-08-28] [$1000] not able to show preview of avatr in thread #21073

Closed

6 tasks

kidroca reviewed Nov 24, 2023

View reviewed changes

Conversation

spcheema commented Aug 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

spcheema commented Aug 11, 2023

Uh oh!

melvin-bot bot commented Aug 11, 2023

Uh oh!

spcheema commented Aug 14, 2023

Uh oh!

spcheema commented Aug 14, 2023

Uh oh!

spcheema commented Aug 14, 2023

Uh oh!

aimane-chnaif commented Aug 15, 2023

Uh oh!

aimane-chnaif commented Aug 15, 2023

Uh oh!

spcheema commented Aug 15, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aimane-chnaif commented Aug 15, 2023

Uh oh!

spcheema commented Aug 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aimane-chnaif commented Aug 15, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

aimane-chnaif commented Aug 15, 2023

Uh oh!

aimane-chnaif left a comment

Choose a reason for hiding this comment

Uh oh!

PauloGasparSv left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 15, 2023

Uh oh!

OSBotify commented Aug 17, 2023

Uh oh!

OSBotify commented Aug 21, 2023

Uh oh!

OSBotify commented Aug 24, 2023

Uh oh!

kidroca Nov 24, 2023

Choose a reason for hiding this comment

Uh oh!

Beamanator Nov 28, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

spcheema commented Aug 11, 2023 •

edited

Loading

spcheema commented Aug 15, 2023 •

edited

Loading