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

Improvement BasePaymentPage #9622

Merged
merged 18 commits into from
Sep 21, 2022
Merged

Conversation

JosueEchandiaAsto
Copy link
Contributor

@JosueEchandiaAsto JosueEchandiaAsto commented Jun 29, 2022

Details

The Add Payment Methods button will align to the bottom edge and menu popups will align to the right

Fixed Issues

#8929

Tests

  • Verify that the Add Payment Methods button aligns to the bottom edge
  • Check that the menus are positioned correctly when resizing the browser
  • Verify that no errors appear in the JS console

PR Review Checklist

Contributor (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 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 included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 tagging the marketing team 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
  • 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 */
    • Any functional components have the displayName property
    • 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 author checklist, including those that don't apply to this PR.

QA Steps

  1. Open app
  2. Log in any account
  3. Setting>Payments
  4. Verify that the Add Payment Methods button aligns to the bottom edge
  5. Show any payment menu
  6. If it is on desktop/web, modify the size of the browser/app and verify that the popup menus are positioned correctly
  7. Check that the menus are positioned correctly when resizing the browser

Screenshots

Web

Safari

Grabacion.de.pantalla.2022-09-16.a.la.s.12.23.05.mov

Chrome

Grabacion.de.pantalla.2022-09-16.a.la.s.12.26.11.mov

Mozila

Grabacion.de.pantalla.2022-09-16.a.la.s.12.27.06.mov

Mobile Web

Simulator.Screen.Recording.-.iPhone.13.-.2022-09-16.at.12.28.35.mp4

Desktop

Grabacion.de.pantalla.2022-09-16.a.la.s.12.31.42.mov

iOS

Simulator.Screen.Recording.-.iPhone.13.-.2022-09-16.at.12.37.35.mp4

Android

Grabacion.de.pantalla.2022-09-16.a.la.s.12.41.12.mov

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Requested small changes, rest on web looks fine. Once fixed, I'll test on other platforms.

@JosueEchandiaAsto
Copy link
Contributor Author

Small requested changes made

@mananjadhav
Copy link
Collaborator

I'll check this today and test.

@JosueEchandiaAsto
Copy link
Contributor Author

JosueEchandiaAsto commented Jul 7, 2022

@mananjadhav @parasharrajat
Can I delete dimensionsSubscription? It is crossing with the withWindowDimensions listener. It seems unnecessary to me because withWindowDimensions will be used.

this.dimensionsSubscription = Dimensions.addEventListener('change', this.setMenuPosition);

Replacing window.innerWidth with this.props.windowWidth of withWindowDimensions does the following:

Grabacion.de.pantalla.2022-07-06.a.la.s.20.21.21.mov

@roryabraham
Copy link
Contributor

roryabraham commented Jul 7, 2022

Can I delete dimensionsSubscription? It is crossing with the withWindowDimensions listener. It seems unnecessary to me because withWindowDimensions will be used.

@JosueEchandiaAsto Yes, you can replace dimensionsSubscription with the withWindowDimensions listener, and just listen for changes in the window dimensions props in componentDidUpdate 👍

@JosueEchandiaAsto
Copy link
Contributor Author

JosueEchandiaAsto commented Jul 7, 2022

the following changes were made

  • bounces={false} was removed on PaymentMethodList
  • dimensionsSubscription replaced with the withWindowDimensions listener
  • Avoided creating the setPositionAddPaymentMenu method but continuing to use setPositionAddPaymentMethod that was used initially

@roryabraham
Copy link
Contributor

@JosueEchandiaAsto Just FYI you've got conflicts in this PR

@JosueEchandiaAsto
Copy link
Contributor Author

@roryabraham
Ok, I'll check it out. Can i create another PR?

@mananjadhav
Copy link
Collaborator

Ok, I'll check it out. Can i create another PR?

@JosueEchandiaAsto You can pull the latest main branch changes and resolve the conflicts.

@JosueEchandiaAsto
Copy link
Contributor Author

Resolved conflicts. Any additional observation?

@mananjadhav
Copy link
Collaborator

mananjadhav commented Jul 11, 2022

@JosueEchandiaAsto I took your latest pull and while code changes look good, I had some trouble testing this with Mac Safari while resizing the window.

screen-resize-payment-button-position.mp4

Also you need to go through every item in the checklist and mark it even if it doesn't apply for the PR. This is to ensure we've verified every item in the checklist, and there's one small change in lint error. Removing FormAlertWrapper import from PaymentMethodList

@JosueEchandiaAsto
Copy link
Contributor Author

JosueEchandiaAsto commented Jul 11, 2022

@mananjadhav wait a moment, in the main branch there is a change that uses FormAlertWrapper, I'm doing the update.
This is new.
<FormAlertWrapper> {isOffline => (

<FormAlertWrapper>
{isOffline => (
<Button
text={item.text}
icon={item.icon}
onPress={item.onPress}
isDisabled={item.isDisabled || isOffline}
style={item.style}
iconStyles={item.iconStyles}
success={item.success}
shouldShowRightIcon={item.shouldShowRightIcon}
extraLarge
/>
)}
</FormAlertWrapper>

@mananjadhav
Copy link
Collaborator

Thanks for picking it up @JosueEchandiaAsto

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

After this change, we only have one type of item that goes in this list: MENU_ITEM. The only other non-menuItem is added right here on lines 140-145, when the list rendered by the FlatList is empty.

FlatList has a prop just for this called ListEmptyComponent, so we should use that.

In summary, the changes I'm requesting are:

  • Get rid of the type field on items in the PaymentMethodList and the MENU_ITEM const.
  • Use the ListEmptyComponent to render the addFirstPaymentMethod test if the list is empty
  • Get rid of the conditional rendering in renderItem

Thanks!

@mananjadhav
Copy link
Collaborator

@JosueEchandiaAsto Did you get a chance to look at @roryabraham's comment?

@JosueEchandiaAsto
Copy link
Contributor Author

@mananjadhav Yes, I will make the change, along with the new conflicts again.

@mananjadhav
Copy link
Collaborator

@JosueEchandiaAsto Do we have any updates on the PR?

@parasharrajat
Copy link
Member

Bump...

@JosueEchandiaAsto
Copy link
Contributor Author

@roryabraham Requested changes are done

Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Few small comments @JosueEchandiaAsto. Apart from that can you please:

  1. Take the latest main pull
  2. Screencasts seem to be outdated (missing > in the button text). Can you please update the screenshot/videos with the latest rerun.

src/pages/settings/Payments/PaymentMethodList.js Outdated Show resolved Hide resolved
src/pages/settings/Payments/PaymentMethodList.js Outdated Show resolved Hide resolved
src/pages/settings/Payments/PaymentMethodList.js Outdated Show resolved Hide resolved
@JosueEchandiaAsto
Copy link
Contributor Author

JosueEchandiaAsto commented Sep 16, 2022

@mananjadhav Requested changes are done. Screencasts updated

This warning appears, but it isn't related to this issue.
Captura de Pantalla 2022-09-16 a la(s) 12 44 21

@mananjadhav
Copy link
Collaborator

mananjadhav commented Sep 17, 2022

This warning appears, but it isn't related to this issue.

Thanks @JosueEchandiaAsto for the changes. Yeah it exists on main as well.

@roryabraham The code looks good to me and tests well.

🎀 👀 🎀 
C+ reviewed

PR Reviewer Checklist

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

  • 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 verified tests pass on all platforms & I tested again on:
    • iOS / native
    • Android / native
    • iOS / Safari
    • Android / Chrome
    • MacOS / Chrome
    • 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 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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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.

@mananjadhav
Copy link
Collaborator

@roryabraham Quick bump.

Copy link
Contributor

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

  • 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 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 tagging the marketing team 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 */
    • Any functional components have the displayName property
    • 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.

@roryabraham roryabraham merged commit c322532 into Expensify:main Sep 21, 2022
@melvin-bot melvin-bot bot added the Emergency label Sep 21, 2022
@melvin-bot
Copy link

melvin-bot bot commented Sep 21, 2022

@roryabraham looks like this was merged without passing tests. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@roryabraham
Copy link
Contributor

Contributor had used an out-of-date checklist, and I chose to merge anyways for the sake of velocity.

@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 @roryabraham in version: 1.2.4-0 🚀

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

@OSBotify
Copy link
Contributor

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

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

5 participants