Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Group Chat Avatar Offline Feedback in Chat #42088

Merged
merged 10 commits into from
May 28, 2024

Conversation

nexarvo
Copy link
Contributor

@nexarvo nexarvo commented May 13, 2024

Details

Fixed Issues

$ #41770
PROPOSAL: #41770 (comment)

Tests

Group Chat Grayed out Case:

  1. Go to any group chat.
  2. Click on the header > Report Details Page.
  3. Go offline.
  4. Click on the avatar
  5. Change the avatar.
  6. Go back to group chat
  7. Verify that the group chat avatar in the Report is grayed out.

Profile Setting Page > Avatar edit is not Grayed out Case:

  1. Go to Profile Setting Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.

Workspace Setting Page > Avatar edit is not Grayed out Case:

  1. Go to Workspace Setting Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.

Group Chat Details Page > Avatar edit is not Grayed out Case:

  1. Go to Group Chat Details Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.
  • Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Group Chat Grayed out Case:

  1. Go to any group chat.
  2. Click on the header > Report Details Page .
  3. Go offline.
  4. Click on the avatar
  5. Change the avatar.
  6. Go back to group chat
  7. Verify that the group chat avatar in the Report is grayed out.

Profile Setting Page > Avatar edit is not Grayed out Case:

  1. Go to Profile Setting Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.

Workspace Setting Page > Avatar edit is not Grayed out Case:

  1. Go to Workspace Setting Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.

Group Chat Details Page > Avatar edit is not Grayed out Case:

  1. Go to Group Chat Details Page.
  2. Go offline.
  3. Click on the avatar
  4. Change the avatar.
  5. Verify that the edit / pencil icon is not grayed out.
  • 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 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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed 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.js 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 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.
  • 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
  1. Report avatar is grayed out:
Screenshot 2024-05-14 at 1 11 41 AM
  1. Edit Icon in Profile Setting page is not grayed out:
Screenshot 2024-05-14 at 1 13 19 AM
  1. Edit Icon in Workspace Setting page is not grayed out:
Screenshot 2024-05-14 at 1 15 29 AM
Android: mWeb Chrome
  1. Report avatar is grayed out:
Screenshot 2024-05-14 at 1 21 37 AM
  1. Edit Icon in Profile Setting page is not grayed out:
Screenshot 2024-05-14 at 1 22 46 AM
  1. Edit Icon in Workspace Setting page is not grayed out:
Screenshot 2024-05-14 at 1 24 15 AM
iOS: Native

Getting build errors.

iOS: mWeb Safari
  1. Report avatar is grayed out:
    IMG_1577

  2. Edit Icon in Profile Setting page is not grayed out:
    IMG_1578

  3. Edit Icon in Workspace Setting page is not grayed out:
    IMG_1579

MacOS: Chrome / Safari
  1. Report avatar is grayed out:
Screen.20Recording.202024-05-14.20at.2012.mp4
  1. Edit Icon in Profile Setting page is not grayed out:
Screen.20Recording.202024-05-14.20at.2012-2.mp4
  1. Edit Icon in Workspace Setting page is not grayed out:
Screen.20Recording.202024-05-14.20at.2012-3.mp4
MacOS: Desktop
  1. Report avatar is grayed out:
Screenshot 2024-05-14 at 12 25 26 AM
  1. Edit Icon in Profile Setting page is not grayed out:
Screenshot 2024-05-14 at 12 27 03 AM
  1. Edit Icon in Workspace Setting page is not grayed out:
Screenshot 2024-05-14 at 12 28 06 AM

@nexarvo nexarvo requested a review from a team as a code owner May 13, 2024 16:19
@melvin-bot melvin-bot bot requested review from s77rt and removed request for a team May 13, 2024 16:19
Copy link

melvin-bot bot commented May 13, 2024

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

@nexarvo
Copy link
Contributor Author

nexarvo commented May 13, 2024

Hi @s77rt, There are a few things I wanted to confirm:

  1. Do we need to show error message for avatar in report? Here:
Screenshot 2024-05-13 at 9 23 41 PM Asking this because we are updating the avatar in report details page and we are showing error there.

2. We don't need to show error message for avatar in report header and LHN right ?

3. Do we need to implement offline feedback for avatar in tooltip ? Here: Screenshot 2024-05-13 at 9 28 52 PM

@nexarvo
Copy link
Contributor Author

nexarvo commented May 13, 2024

Also, I will complete the checklist once PR is complete.

@s77rt
Copy link
Contributor

s77rt commented May 13, 2024

For 1 and 2: The error should show only on the place where we can edit the avatar.
For 3: Test with the profile avatar and apply the opacity for report avatar only if it's applied for profile avatar

@s77rt
Copy link
Contributor

s77rt commented May 14, 2024

This broke the error message on Settings and Workspace Profile pages (issue also exists on ReportDetails in native but it may have different root cause, don't focus on this one)

Screenshot 2024-05-14 at 10 57 59 AM Screenshot 2024-05-14 at 11 02 02 AM

@nexarvo
Copy link
Contributor Author

nexarvo commented May 14, 2024

Taking a look into this now. I think changing the errorRowStyles passed to AvatarWithImagePicker should fix this problem.

@nexarvo
Copy link
Contributor Author

nexarvo commented May 14, 2024

@s77rt I just checked out main and it seems that the workspace error is already broken there:
Screenshot 2024-05-14 at 5 29 48 PM


Can you please confirm if you are getting same issue in main. Thanks.

@s77rt
Copy link
Contributor

s77rt commented May 14, 2024

The error is an array, you probably types a string, try with errors={["error goes here message"]}

@nexarvo
Copy link
Contributor Author

nexarvo commented May 14, 2024

Thanks for catching that. The error message is fixed now at every place.

<DefaultAvatar />
)}
</View>
<OfflineWithFeedback pendingAction={pendingAction}>
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we have two OfflineWithFeedback?

Copy link
Contributor Author

@nexarvo nexarvo May 14, 2024

Choose a reason for hiding this comment

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

We only want to apply pendingAction to avatar. But if we apply error in the second OfflineWithFeedback then it messes with the overall styles of error message. That's why I removed pendingAction from the first OfflineWithFeedback and it will only responsible to show errors if any. If we only apply OfflineWithFeedback to avatar only then we need to change the style of error message and I tried different padding and margins also but it was not working. The error message overlaps with the title and description as well here.

Copy link
Contributor

Choose a reason for hiding this comment

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

Having two OfflineWithFeedback for the same underlaying component feels like a workaround. Can you get ride of one of them and try to fix the error message? (try use styles.w100 if it helps)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @s77rt, I have tried a couple of ways to resolve this issue and some of them worked as well but they broke some other stuff. We will need to refactor the whole AvatarWithImagePicker component to make this work. We are already using multiple OfflineFeedback for error and pending action like in this file:

<OfflineWithFeedback
shouldShowErrorMessages
errors={report.errorFields?.editTask ?? report.errorFields?.createTask}
onClose={() => Task.clearTaskErrors(report.reportID)}
errorRowStyles={styles.ph5}
>
<Hoverable>

And for only pendingAction:
<OfflineWithFeedback pendingAction={report.pendingFields?.reportName}>
<Text style={styles.taskTitleDescription}>{translate('task.title')}</Text>

My suggestion is we use 2 OfflineFeedback as we are already using this way in other places in the App. Please let me know if there is any better approach for this ?

Copy link
Contributor

Choose a reason for hiding this comment

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

@nexarvo Let's not block on that. Can you just remove the extra wrapping View that's inside <OfflineWithFeedback />

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed extra view in this commit

@marcaaron
Copy link
Contributor

@nexarvo Everything good here? It's been a week since this comment.

@s77rt
Copy link
Contributor

s77rt commented May 23, 2024

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: mWeb Chrome
    • iOS: Native
    • 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 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 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.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(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.
  • 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: Native
android.mov
android.2.mov
Android: mWeb Chrome

Networking issue

iOS: Native ios
iOS: mWeb Safari mweb-safari
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@s77rt
Copy link
Contributor

s77rt commented May 23, 2024

@nexarvo Please fix the first test, we don't need to go to the Members page. Also please check #42088 (comment). Once this is resolved please tag me

@nexarvo
Copy link
Contributor Author

nexarvo commented May 23, 2024

@s77rt changes are done.

@melvin-bot melvin-bot bot requested a review from marcaaron May 23, 2024 22:45
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

LGTM!

@marcaaron marcaaron merged commit 9830f15 into Expensify:main May 28, 2024
17 checks passed
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 1.4.77-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 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.

4 participants