fix: Workspace Avatar Error is impossible to dismiss #37874

dukenv0307 · 2024-03-07T09:27:33Z

Details

Fixed Issues

Tests

Go to workspaces and click on one of your workspaces to open the workspace profile page.
Force an error by hard code errors in here with the one below

        errors={{
              0: 'this is an error'
          }}

Verify that: Error should be dismissable/readable

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to workspaces and click on one of your workspaces to open the workspace profile page.
Force an error by hard code errors in here with the one below

        errors={{
              0: 'this is an error'
          }}

Verify that: Error should be dismissable/readable

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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-03-07T10:11:20Z

@shawnborton @jjcoffee 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]

jjcoffee · 2024-03-07T10:21:45Z

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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

jjcoffee · 2024-03-07T10:33:05Z

Force an error in the upload process (I have dev settings that are borked, which caused this error)

@dukenv0307 Could we add some more detail here? e.g. like this comment.

shawnborton · 2024-03-07T13:10:09Z

FWIW this general style seems okay to me though, but of course we need to address @jjcoffee's comments above

dukenv0307 · 2024-03-08T04:15:39Z

@dukenv0307 Could we add some more detail here?

@jjcoffee We can hard code an error by replacing errors in here with the one below

        errors={{
              0: 'this is an error'
          }}

jjcoffee · 2024-03-08T14:07:58Z

@dukenv0307 Can you add that to the test steps, so QA can test easily? 🙏

shawnborton · 2024-03-08T14:32:05Z

Yup, definitely agree with that.

dukenv0307 · 2024-03-11T08:05:36Z

@jjcoffee please check again

jjcoffee · 2024-03-11T10:37:29Z

Much better for long error messages, thanks!

shawnborton · 2024-03-11T14:00:05Z

src/pages/workspace/WorkspaceProfilePage.tsx

-                                    styles.alignItemsStart,
-                                    styles.sectionMenuItemTopDescription,
-                                ]}
+                                style={[styles.mb1, isSmallScreenWidth ? styles.mtn17 : styles.mtn20, styles.alignItemsStart, styles.sectionMenuItemTopDescription]}


Agree, that does not look good.

src/components/AvatarWithImagePicker.tsx

@@ -283,7 +283,7 @@ function AvatarWithImagePicker({

    return (
        <View style={StyleSheet.flatten([styles.alignItemsCenter, style])}>
-            <View style={[styles.pRelative, avatarStyle]}>
+            <View style={errors && styles.w100}>


dukenv0307 · 2024-03-12T09:42:48Z

@jjcoffee i just update the code, please check again 🙏

jjcoffee

LGTM!

dukenv0307 · 2024-03-18T03:18:57Z

@grgia please check this when you get a chance 🙏

grgia

@dukenv0307 mostly LGTM, but could you please take a look at these comments before I merge?

grgia · 2024-03-18T09:52:53Z

src/components/AvatarWithImagePicker.tsx

@@ -287,11 +287,12 @@ function AvatarWithImagePicker({

    return (
        <View style={StyleSheet.flatten([styles.alignItemsCenter, style])}>
-            <View style={[styles.pRelative, avatarStyle]}>
+            <View style={styles.w100}>


Have you QA'd this change on both the Initial Settings Page and the Workspace Profile Page?

Yes, we also reviewed and tested Initial Settings Page.

grgia · 2024-03-18T09:56:32Z

src/pages/workspace/WorkspaceProfilePage.tsx

@@ -128,7 +128,7 @@ function WorkspaceProfilePage({policy, currencyList = {}, route}: WorkSpaceProfi
                                type={CONST.ICON_TYPE_WORKSPACE}
                                fallbackIcon={Expensicons.FallbackWorkspaceAvatar}
                                style={[
-                                    isSmallScreenWidth ? styles.mb1 : styles.mb3,
+                                    policy?.errorFields?.avatar ?? isSmallScreenWidth ? styles.mb1 : styles.mb3,


Should we only be evalutating isSmallScreenWidth ? styles.mb1 : styles.mb3 if there's an error? Before we always hit this check

We should apply style mb1 if there's an error or the device is small screen width.

OSBotify · 2024-03-21T12:24:45Z

✋ 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 · 2024-03-22T16:20:15Z

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

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

kavimuru · 2024-03-22T17:23:26Z

@dukenv0307, where should we run the script? Could you explain a little bit more?

Force an error by hard code errors in here with the one below
errors={{
0: 'this is an error'
}}

dukenv0307 · 2024-03-22T17:42:23Z

@dukenv0307, where should we run the script? Could you explain a little bit more?

@kavimuru When testing in staging we can run this script in the console, and replace B0B6B51E5D9DBDB7 with the policy that we're opening. I forced the error in local to make it easier to test. If we can find a way that will return the error after we upload the workspace avatar to the server, we can do this instead of running this script.

Onyx.merge('policy_B0B6B51E5D9DBDB7', {
    errorFields: {
        avatar: {
            12345679: "This is tje test errorsssss",
        }
    }
})

kavimuru · 2024-03-22T19:18:08Z

@dukenv0307 thanks we will try.

OSBotify · 2024-03-27T04:49:24Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.56-8 🚀

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

dukenv0307 added 4 commits March 7, 2024 16:23

fix: Workspace Avatar Error is impossible to dismiss

33a0c3e

feat: add margin top error

0636836

fix margin bottom workspace detail

f806160

fix lint

800c99c

dukenv0307 marked this pull request as ready for review March 7, 2024 10:11

dukenv0307 requested a review from a team as a code owner March 7, 2024 10:11

melvin-bot bot removed the request for review from a team March 7, 2024 10:11

melvin-bot bot requested review from jjcoffee and shawnborton March 7, 2024 10:11

dukenv0307 mentioned this pull request Mar 7, 2024

[PAY 3RD APRIL] [$250] Upload Workspace Avatar Error is impossible to dismiss #37819

Closed

6 tasks

This comment was marked as resolved.

Sign in to view

dukenv0307 added 2 commits March 11, 2024 14:17

Merge branch 'main' into fix/37819

af8e55a

fix: error style in workspace detail

9aaad39

jjcoffee reviewed Mar 11, 2024

View reviewed changes

fix: style avatar with picker

57f164f

jjcoffee approved these changes Mar 12, 2024

View reviewed changes

melvin-bot bot requested a review from grgia March 12, 2024 11:21

Merge branch 'main' into fix/37819

fa1cedc

grgia approved these changes Mar 18, 2024

View reviewed changes

grgia merged commit 9c8ac29 into Expensify:main Mar 21, 2024
18 checks passed

github-actions bot mentioned this pull request Mar 22, 2024

Deploy Checklist: New Expensify 2024-03-22 #38811

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Workspace Avatar Error is impossible to dismiss #37874

fix: Workspace Avatar Error is impossible to dismiss #37874

dukenv0307 commented Mar 7, 2024 •

edited

Loading

melvin-bot bot commented Mar 7, 2024

jjcoffee commented Mar 7, 2024 •

edited

Loading

This comment was marked as resolved.

jjcoffee commented Mar 7, 2024

shawnborton commented Mar 7, 2024

dukenv0307 commented Mar 8, 2024

jjcoffee commented Mar 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

shawnborton commented Mar 8, 2024

dukenv0307 commented Mar 11, 2024

jjcoffee commented Mar 11, 2024

This comment was marked as resolved.

shawnborton Mar 11, 2024

This comment was marked as resolved.

dukenv0307 commented Mar 12, 2024

jjcoffee left a comment

dukenv0307 commented Mar 18, 2024

grgia left a comment

grgia Mar 18, 2024

dukenv0307 Mar 18, 2024

grgia Mar 18, 2024

dukenv0307 Mar 18, 2024

OSBotify commented Mar 21, 2024

OSBotify commented Mar 22, 2024

kavimuru commented Mar 22, 2024

dukenv0307 commented Mar 22, 2024

kavimuru commented Mar 22, 2024

OSBotify commented Mar 27, 2024

fix: Workspace Avatar Error is impossible to dismiss #37874

fix: Workspace Avatar Error is impossible to dismiss #37874

Conversation

dukenv0307 commented Mar 7, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Mar 7, 2024

jjcoffee commented Mar 7, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

This comment was marked as resolved.

jjcoffee commented Mar 7, 2024

shawnborton commented Mar 7, 2024

dukenv0307 commented Mar 8, 2024

jjcoffee commented Mar 8, 2024

This comment was marked as resolved.

This comment was marked as resolved.

shawnborton commented Mar 8, 2024

dukenv0307 commented Mar 11, 2024

jjcoffee commented Mar 11, 2024

This comment was marked as resolved.

shawnborton Mar 11, 2024

Choose a reason for hiding this comment

This comment was marked as resolved.

dukenv0307 commented Mar 12, 2024

jjcoffee left a comment

Choose a reason for hiding this comment

dukenv0307 commented Mar 18, 2024

grgia left a comment

Choose a reason for hiding this comment

grgia Mar 18, 2024

Choose a reason for hiding this comment

dukenv0307 Mar 18, 2024

Choose a reason for hiding this comment

grgia Mar 18, 2024

Choose a reason for hiding this comment

dukenv0307 Mar 18, 2024

Choose a reason for hiding this comment

OSBotify commented Mar 21, 2024

OSBotify commented Mar 22, 2024

kavimuru commented Mar 22, 2024

dukenv0307 commented Mar 22, 2024

kavimuru commented Mar 22, 2024

OSBotify commented Mar 27, 2024

dukenv0307 commented Mar 7, 2024 •

edited

Loading

jjcoffee commented Mar 7, 2024 •

edited

Loading