Modify Avatar to add imageStyles when image error by markarmanus · Pull Request #12908 · Expensify/App

markarmanus · 2022-11-21T23:10:18Z

Details

Simply the avatar component was applying the style to the Image component. But not the Icon component. The icon component is used when This.state.imageError is true. which could happen when there is a problem loading the avatar image. To solive it i wrap the Icon in a View and apply the styles to it.

Fixed Issues

$ #12645
$ #12645 (comment)

Tests

Force the component to be in the error state by setting this.state.imageError to always true
Run through the entire app on all platforms confirming all locations and uses of the Avatar component still work.

Verify that no errors appear in the JS console

Offline tests

The changes are only applied when the app is offline. So for offline tests simply run through the QA steps below to confirm the component styling is still proper while offline.

QA Steps

The test here could be done by having Airplane mode on. That seems to trigger the altenrative version of the component where the issue existed. So to test the app we need to check the component is still working properly (only style changes applied) in the entire app on all platforms on Airplane mode.

Turn on Airplane mode
Confirm the Avatar still looks good in all screens on all platforms

Note: because if you have airplane mode you might not be able to access some pages (i.e you need internet to login) You might have to toggle between on/off for airplane mode a few times while testing.

Verify that no errors appear in the JS console

PR Author Checklist

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

Screenshots

Web

Screen.Recording.2022-11-21.at.9.38.03.PM.mp4

Mobile Web - Chrome

Screen.Recording.2022-11-21.at.10.57.44.PM.mp4

Mobile Web - Safari

Screen.Recording.2022-11-21.at.10.34.22.PM.mp4

Desktop

Screen.Recording.2022-11-21.at.9.31.42.PM.mp4

iOS

Screen.Recording.2022-11-21.at.11.40.02.PM.mp4

Android

Screen.Recording.2022-11-21.at.10.23.31.PM.mov

melvin-bot · 2022-11-21T23:10:24Z

@sketchydroide @parasharrajat One of you needs to 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 · 2022-11-21T23:10:36Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

markarmanus · 2022-11-21T23:11:23Z

I have read the CLA Document and I hereby sign the CLA

markarmanus · 2022-11-21T23:11:49Z

recheck

markarmanus · 2022-11-22T03:00:32Z

If you notice the offline avatar shape change in the videos. Its another bug that is currently being fixed. Here is the issue associated with it
#12713

Took a while to hunt down but i was gonna report it my self.

sketchydroide

looks like what it was agreed

sketchydroide · 2022-11-22T11:44:11Z

@parasharrajat let me know once you are done with review :)

parasharrajat · 2022-11-23T00:00:04Z

Now, we just need to filter the extra background color that is being applied to the icon. It looks a little darker as mentioned in #12645 (comment).

I think it won't be safe to remove the fill condition which sets the offline color. Instead, remove the background from the image style for the new View you added but keep it for the image.

You can apply whatever you think is best. But test it carefully. This is the most used component in the app.

markarmanus · 2022-11-23T00:31:13Z

@parasharrajat I just extended the component. Tested it on a few platforms looks good to me.

markarmanus · 2022-11-23T00:39:42Z

@parasharrajat apologies on the styling. still getting used to the app.

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

parasharrajat · 2022-11-23T15:30:37Z

This does not make sense to me. Could you please add a basic offline test?

Turn the Internet off on the device by _____________.
Open New Chat from ➕ FAB button.
Add a new email that does not exist.
Create Chat.
Chat is created successfully.

etc.

markarmanus · 2022-11-23T15:41:38Z

@parasharrajat considering our changes are only applied when this.state.imageError is true Then isnt a better test to set this.state.imageError = true and run through the app. basically testing if all components where using the area of code i changed ?

parasharrajat · 2022-11-23T15:47:02Z

That is a better test for developers but can QA team change the code on staging? we should write QA steps in a way that a non-technical person is able to test them.

markarmanus · 2022-11-23T15:51:09Z

@parasharrajat The steps under the QA section should cover that. as it will be in airplane mode(offline mode)

markarmanus · 2022-11-23T15:53:14Z

i updated the offline section to refer the QA section if that helps.

parasharrajat · 2022-11-23T17:36:36Z

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

...

🔲 Android / native

markarmanus · 2022-11-23T17:50:01Z

@parasharrajat is the build issue on ios related to yoga ?

parasharrajat · 2022-11-23T20:59:54Z

There was cache issue which is resolved now.

parasharrajat

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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and 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 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

cc: @sketchydroide

🎀 👀 🎀 C+ reviewed

markarmanus · 2022-11-23T22:26:50Z

@sketchydroide any updates on the PR ?

sketchydroide · 2022-11-24T13:20:12Z

sorry but you had to wait for me to get back to work :D

OSBotify · 2022-11-24T14:17:49Z

✋ 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 · 2022-11-25T21:34:21Z

🚀 Deployed to staging by @sketchydroide in version: 1.2.32-0 🚀

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

OSBotify · 2022-11-28T21:18:16Z

🚀 Deployed to production by @luacmartins in version: 1.2.32-2 🚀

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

OSBotify · 2022-11-28T21:40:37Z

🚀 Deployed to production by @luacmartins in version: 1.2.32-2 🚀

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

Modify Avatar to add imageStyles when image error

6d7c71f

markarmanus requested a review from a team as a code owner November 21, 2022 23:10

melvin-bot Bot requested review from parasharrajat and sketchydroide and removed request for a team November 21, 2022 23:10

sketchydroide previously approved these changes Nov 22, 2022

View reviewed changes

parasharrajat suggested changes Nov 22, 2022

View reviewed changes

Comment thread src/components/Avatar.js Outdated

markarmanus requested a review from parasharrajat November 22, 2022 20:48

Change based on comments

b93905f

markarmanus dismissed sketchydroide’s stale review via b93905f November 22, 2022 23:42

markarmanus requested review from parasharrajat and sketchydroide and removed request for parasharrajat and sketchydroide November 22, 2022 23:43

Address comments

615f4ed

parasharrajat reviewed Nov 23, 2022

View reviewed changes

Comment thread src/components/Avatar.js Outdated

remove inline styling

550c1c3

Update src/components/Avatar.js

57292e7

Co-authored-by: Rajat Parashar <parasharrajat@users.noreply.github.com>

markarmanus requested a review from parasharrajat November 23, 2022 13:11

markarmanus and others added 3 commits November 23, 2022 11:24

add import

4fc8201

add spacing

bd37756

Merge branch 'main' into main

7a05180

markarmanus requested review from parasharrajat and sketchydroide and removed request for parasharrajat and sketchydroide November 23, 2022 16:53

parasharrajat approved these changes Nov 23, 2022

View reviewed changes

sketchydroide approved these changes Nov 24, 2022

View reviewed changes

sketchydroide merged commit d0fbcf8 into Expensify:main Nov 24, 2022

OSBotify mentioned this pull request Nov 25, 2022

Deploy Checklist: New Expensify 2022-11-25 #13059

Closed

21 tasks

melvin-bot Bot mentioned this pull request Nov 28, 2022

[HOLD for payment 2022-12-05] [$250] Log in - Avatar with user's email are very close to each other #12645

Closed

Uh oh!

Conversation

markarmanus commented Nov 21, 2022 • 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

PR Reviewer Checklist

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Uh oh!

melvin-bot Bot commented Nov 21, 2022

Uh oh!

github-actions Bot commented Nov 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markarmanus commented Nov 21, 2022

Uh oh!

markarmanus commented Nov 21, 2022

Uh oh!

markarmanus commented Nov 22, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sketchydroide left a comment

Choose a reason for hiding this comment

Uh oh!

sketchydroide commented Nov 22, 2022

Uh oh!

Uh oh!

parasharrajat commented Nov 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

parasharrajat commented Nov 23, 2022

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

parasharrajat commented Nov 23, 2022

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

parasharrajat commented Nov 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Screenshots

🔲 iOS / native

🔲 iOS / Safari

🔲 MacOS / Desktop

🔲 MacOS / Chrome

🔲 Android / Chrome

🔲 Android / native

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

parasharrajat commented Nov 23, 2022

Uh oh!

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Uh oh!

markarmanus commented Nov 23, 2022

Uh oh!

sketchydroide commented Nov 24, 2022

Uh oh!

OSBotify commented Nov 24, 2022

Uh oh!

OSBotify commented Nov 25, 2022

markarmanus commented Nov 21, 2022 •

edited

Loading

github-actions Bot commented Nov 21, 2022 •

edited

Loading

markarmanus commented Nov 22, 2022 •

edited

Loading

parasharrajat commented Nov 23, 2022 •

edited

Loading

parasharrajat commented Nov 23, 2022 •

edited

Loading