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/29812: Same page has different error text color for different errors #30325

Conversation

Victor-Nyagudi
Copy link
Contributor

@Victor-Nyagudi Victor-Nyagudi commented Oct 25, 2023

Details

Errors in Expensify are shown in red text, but the error shown when trying to create a distance request without adding waypoints has a red dot accompanied by light-greyish green text (the color of success messages when accompanied by a green dot).

This PR restores the red color to the error text.

Fixed Issues

$ #29812
PROPOSAL: #29812 (comment)

Tests

  1. Log into a test account.
  2. Click the green circle with a "+" sign in it at the bottom left of the screen.
  3. Select "Request money" from the modal that appears.
  4. If you're on Mac Chrome, Mac Safari, or the Mac desktop app and the app/browser is at least half the width of the screen, a panel will appear on the right side. If on mobile, a modal this panel/modal will fill the screen. Click on the "Distance" tab.
  5. Click on the large, green pill button at the bottom of the panel/modal that says "Next".
  6. Verify a red dot appears above the button in step 5 with red text to its right that says "Please enter at least two waypoints".
  7. Tap on the left facing caret/arrow at the top of the modal next to the words "Request money" to go back/close the panel/modal.
  8. Click on the avatar at the top left of the screen and then click on "Profile" in the panel/modal that appears.
  9. Click on "Contact method" and then click on the green pill button at the bottom that says "New contact method".
  10. Enter a valid email e.g. another test account you have access to, and then click on the green pill button at the bottom that says "Add". You'll be redirected to the previous screen.
  11. Click on the email you just added. It should have a green dot next to it.
  12. Verify a green dot with light-greyish green text to its right saying "Please enter the magic code sent to [the email you entered in Step 10]" is shown below the header with the Step 10 email and left facing caret/arrow.
  • Verify that no errors appear in the JS console

Offline tests

After logging into an account while online, turn off the wifi/internet connection and perform steps 2 through 6 in the "Tests" section above. You can also force offline by clicking on the avatar at the top left of the screen -> preferences -> toggle offline.

You can add a contact method while offline, but you won't be able to click it (step 11) to navigate to the screen with the green dot and light-greyish green text.

QA Steps

Same as above in the "Tests" section.

  • 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 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 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

expensify-fixed-error-text-color-android-native.jpg

Android: mWeb Chrome

expensify-fixed-error-text-color-android-web.jpg

iOS: Native

expensify-fixed-error-text-color-iOS-native

iOS: mWeb Safari

expensify-fixed-error-text-color-iOS-web

MacOS: Chrome / Safari

expensify-fixed-error-text-color-mac-chrome

expensify-fixed-error-text-color-mac-safari

MacOS: Desktop

expensify-fixed-error-text-color-mac-desktop

@Victor-Nyagudi Victor-Nyagudi changed the title Fix-29812: Different error text colors for different errors Fix/29812: Same page has different error text color for different errors Oct 25, 2023
@Victor-Nyagudi
Copy link
Contributor Author

Victor-Nyagudi commented Oct 25, 2023

It appears this bug occurs in other places too like when you try uploading an image over 6MB as your avatar.

Image upload error before changes

expensify-incorrect-image-upload-text-error-color

Same thing if you input the wrong magic link numbers when trying to add another contact method.

Contact method error before changes

expensify-contact-method-incorrect-error-text

In addition, trying to unlink a login method with account errors (tried but not sure how to reproduce this one) or if it's detected you committed domain fraud (I prefer to stay out of jail, so I won't try reproducing this), the error shows up in the wrong text color.

{!_.isEmpty(props.account.errors) && (
<DotIndicatorMessage
style={[styles.mb5]}
type="error"
messages={props.account.errors}
/>
)}

{hasDetectedDomainFraud ? (
<DotIndicatorMessage
style={[styles.pageWrapper]}
textStyle={[styles.walletLockedMessage]}
messages={{0: translate('cardPage.cardLocked')}}
type="error"
/>
) : null}

The changes in this PR will address those cases. Here's a sample.

Image upload error after changes

expensify-image-upload-error-red-text

However, during my testing, I stumbled on this other error that doesn't show red text if you deny location permissions when adding a start position to a distance request i.e. click on FAB -> Request money -> Distance -> Click start -> Select "Use your location" from dropdown when input is focused-> deny location permission

Denied location permission error

expensify-denied-location-incorrect-error-text

The current changes won't apply because this particular error is rendered using LocationErrorMessage, not DotIndicatorMessage.

{isPermissionDenied ? (
<Text>
<Text style={[styles.offlineFeedback.text]}>{`${translate('location.permissionDenied')} ${translate('location.please')}`}</Text>
<TextLink
onPress={onAllowLocationLinkPress}
style={styles.locationErrorLinkText}
>
{` ${translate('location.allowPermission')} `}
</TextLink>
<Text style={[styles.offlineFeedback.text]}>{translate('location.tryAgain')}</Text>

The text there is styled using styles.offlineFeedback.text, similar to the text in DotIndicatorMessage, except the color isn't set back to red.

I figured I'd ask first before making any changes other than the ones agreed upon in my proposal.

Should we opt to fix the denied permission error in this PR, we could potentially create a helper method like getFormErrorColor() in StyleUtils that returns the {color: styles.formError.color} style and apply it in both DotIndicatorMessage and BaseLocationErrorMessage.

We could even create a new style seeing as it will be used twice in LocationErrorMessage. Something like:

locationErrorMessage {
    ...offlineFeedback.text,
    color: formError.color
}

Let me know your thoughts on this.

@Victor-Nyagudi
Copy link
Contributor Author

I'm yet to find other places where the error text color is light greyish-green isn't of red.

@Victor-Nyagudi Victor-Nyagudi marked this pull request as ready for review October 25, 2023 17:12
@Victor-Nyagudi Victor-Nyagudi requested a review from a team as a code owner October 25, 2023 17:12
@melvin-bot melvin-bot bot requested review from thesahindia and removed request for a team October 25, 2023 17:12
@melvin-bot
Copy link

melvin-bot bot commented Oct 25, 2023

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

@Victor-Nyagudi
Copy link
Contributor Author

Friendly bump @thesahindia for a review.

@thesahindia
Copy link
Member

Should we opt to fix the denied permission error in this PR, we could potentially create a helper method like getFormErrorColor() in StyleUtils that returns the {color: styles.formError.color} style and apply it in both DotIndicatorMessage and BaseLocationErrorMessage.

Yeah, let's do it.

@Victor-Nyagudi
Copy link
Contributor Author

I'm on it.

@Victor-Nyagudi
Copy link
Contributor Author

All yours, @thesahindia.

Tests well too.

expensify-fixed-denied-permission-error

@thesahindia
Copy link
Member

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 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

Android: Native Screenshot 2023-10-29 at 12 39 23 AM
Android: mWeb Chrome Screenshot 2023-10-29 at 12 43 31 AM
iOS: Native Screenshot 2023-10-29 at 12 48 57 AM
iOS: mWeb Safari Screenshot 2023-10-29 at 12 50 15 AM
MacOS: Chrome / Safari Screenshot 2023-10-28 at 11 01 48 PM
MacOS: Desktop Screenshot 2023-10-28 at 11 04 15 PM

@thesahindia
Copy link
Member

@Victor-Nyagudi please resolve the conflicts.

@Victor-Nyagudi
Copy link
Contributor Author

@thesahindia All conflicts have been resolved.

We're good to move forward.

Copy link
Member

@thesahindia thesahindia left a comment

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 bondydaa October 29, 2023 03:37
@bondydaa bondydaa merged commit 50a327c into Expensify:main Oct 30, 2023
13 checks passed
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.94-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

OSBotify commented Nov 1, 2023

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.94-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 2, 2023

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.94-2 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 2, 2023

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.95-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Nov 6, 2023

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.95-9 🚀

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