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

If Paypal.me account is deleted while offline then show it as pending until back online #17903

Merged
merged 7 commits into from
May 3, 2023

Conversation

PauloGasparSv
Copy link
Contributor

@PauloGasparSv PauloGasparSv commented Apr 24, 2023

Details

The logic for deleting a Paypal.me payment method was not following our standard for Pattern B Offline First (Optimistic UI With Feedback Pattern) and instead of showing the option crossed when deleting it in offline mode it was simply removing the option as if the request was successfull.

This P.R. fixes that so now if the user is offline and tries to delete the PayPal.me account it will show that payment option grayed out and "strikethrough'ed" to indicate the deletion is pending.

Fixed Issues

$ #17795
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

  1. Sign into NewDot
  2. Go to your Settings -> Payments and add a Paypal.me account
  3. Delete that Paypal.me account and make sure no errors happen
  4. Refresh the page or exit the screen and return then make sure that deleted Paypal.me account doesn't re-appear
  • Verify that no errors appear in the JS console

Offline tests

  1. Sign into NewDot
  2. Go to your Settings -> Payments and add a Paypal.me account
  3. Go offline
  4. Delete that Paypal.me account
  5. Make sure that Paypal.me account still shows up but as grayed out and "strikethrough'ed"
  6. Navigate in the app then go back to the Payment screen and make sure the option is still there
  7. Go back online and make sure the Paypal.me account disappears

QA Steps

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • 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 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

Web
Web.mov
Mobile Web - Chrome
mWeb.Android.mov
Mobile Web - Safari

Can't test offline functionality in simulator so only tested if adding and removing Paypal.me still works.

mIos.mov
Desktop
Screen.Recording.2023-04-27.at.17.42.02.mov
iOS

Can't test offline functionality in simulator so only tested if adding and removing Paypal.me still works.

Screen.Recording.2023-04-24.at.15.08.33.mov
Android
Screen.Recording.2023-04-27.at.17.25.34.mov

@PauloGasparSv PauloGasparSv self-assigned this Apr 24, 2023
@PauloGasparSv PauloGasparSv marked this pull request as ready for review April 24, 2023 17:45
@PauloGasparSv PauloGasparSv requested a review from a team as a code owner April 24, 2023 17:45
@melvin-bot melvin-bot bot requested review from marcaaron and sobitneupane and removed request for a team April 24, 2023 17:45
@MelvinBot
Copy link

MelvinBot commented Apr 24, 2023

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

@@ -467,7 +475,8 @@ function deletePaypalMeAddress() {
value: {},
Copy link
Contributor

@marcaaron marcaaron Apr 24, 2023

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both Paypal Onyx keys are cleared (set to nothing) in the API side but only PAYPAL is sent back and updated through Onyx in that snippet.

We need that successData to clear NVP_PAYPAL_ME_ADDRESS since only PAYPAL is being updated by the API.

Before submitting the P.R. I searched for usages of NVP_PAYPAL_ME_ADDRESS to understand why aren't both keys sent back through Onyx in the API but I don't think there is a reason.

I think we could and should eventually clear that in Web-E but I didn't want to spin up another P.R. for this small fix.

Does that make sense @marcaaron?

Copy link
Contributor

Choose a reason for hiding this comment

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

@PauloGasparSv Should we also add failureData?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was also wondering that @sobitneupane but since it didn't have failureData before I think that's ok : )

Also, if an error happens I'm pretty sure they can add a new Paypal account and that would overwrite the previous + exiting the payments page and going back will re-load the Paypal account there in case it failed to delete so worst case scenario isn't that bad and IMO we can leave it like that

Copy link
Contributor

Choose a reason for hiding this comment

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

Both Paypal Onyx keys are cleared (set to nothing) in the API side but only PAYPAL is sent back and updated through Onyx in that snippet.

Ok I think my initial confusion here was that there is a paypal key and a nvp_paypalMeAddress. Why do we have both? If the server is clearing one why is it not clearing the other as well? But I got it now, thanks.

I think we could and should eventually clear that in Web-E but I didn't want to spin up another P.R. for this small fix.
Does that make sense @marcaaron?

I personally think it makes more sense to just fix it just once in the backend so we don't need to spread the changes across 3 PRs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh haha nice even better :D

Copy link
Contributor

Choose a reason for hiding this comment

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

@PauloGasparSv successData might be required to reset pendingAction for ONYXKEYS.PAYPAL

const successData = [
        {
            onyxMethod: CONST.ONYX.METHOD.SET,
            key: ONYXKEYS.PAYPAL,
            value: {},
        },

Issue found in the PR: On small screen, Paypal.me option is missing even after deleting Paypal.me.

Screen.Recording.2023-04-27.at.16.25.44.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice catch @sobitneupane thks so much :D
Will try to figure out what's happening

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Had some time to investigate this, sadly I have no idea why this doesn't work for Android (could only replicate it in Android so far).

Both Paypal keys are being cleared in the API and if I debug with breakpoints the bug doesn't usually happen.
I think this may be related to reconnectApp running at the same time maybe?

I won't waste more time on this so I'm re-adding the successData here with a comment : )

Copy link
Contributor

@s77rt s77rt Jul 3, 2023

Choose a reason for hiding this comment

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

Hey, I think the android bug is universal but was easily reproducible on Android. Seems like some kind of race condition and the successData fix only helped reduce the occurrences of that. We have this issue #22064 where we are looking for a solution for that. So far we think the bug is due to the use of mixed merge and set methods.

@sobitneupane
Copy link
Contributor

sobitneupane commented Apr 25, 2023

Screenshots/Videos

Web
Screen.Recording.2023-04-25.at.14.09.45.mov
Mobile Web - Chrome
Screen.Recording.2023-04-25.at.20.49.43.mov
Mobile Web - Safari
Screen.Recording.2023-04-25.at.20.51.49.mov
Desktop
Screen.Recording.2023-04-25.at.20.44.59.mov
iOS
Screen.Recording.2023-04-25.at.20.55.51.mov
Android
Screen.Recording.2023-04-25.at.20.54.12.mov

@PauloGasparSv PauloGasparSv requested a review from marcaaron April 26, 2023 21:31
@marcaaron
Copy link
Contributor

Can we get the checklists fixed up on this one? Ready to do the final review whenever that is sorted out.

@PauloGasparSv
Copy link
Contributor Author

Can we get the checklists fixed up on this one? Ready to do the final review whenever that is sorted out.

Doing that right now @marcaaron! Latest update here

@PauloGasparSv
Copy link
Contributor Author

Ready for re-reviews @marcaaron @sobitneupane

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

Screenshots/Videos

Web
Screen.Recording.2023-04-28.at.11.59.03.mov
Mobile Web - Chrome
Screen.Recording.2023-04-28.at.11.56.25.mov
Mobile Web - Safari
Screen.Recording.2023-04-28.at.12.24.59.mov
Desktop
Screen.Recording.2023-04-28.at.12.01.33.mov
iOS
Screen.Recording.2023-04-28.at.12.09.27.mov
Android
Screen.Recording.2023-04-28.at.12.06.05.mov

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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 / Chrome
    • iOS / native
    • iOS / 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 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.

@PauloGasparSv
Copy link
Contributor Author

Bump @marcaaron : )

@marcaaron marcaaron merged commit aa6bd41 into main May 3, 2023
@marcaaron marcaaron deleted the paulogasparsv-paypal-delete-offline branch May 3, 2023 20:59
@OSBotify
Copy link
Contributor

OSBotify commented May 3, 2023

✋ 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

OSBotify commented May 4, 2023

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

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

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

@rushatgabhane
Copy link
Member

rushatgabhane commented May 25, 2023

Hi everyone! We missed offline testing of this PR and caused the bug - Paypal.me account isn't "strikethrough'ed" in App after go offline and deleted#18459

This is a reviewer checklist item. Please make sure to go through it properly next time :)
Thanks!

@PauloGasparSv
Copy link
Contributor Author

Offline testing was not missed here! We didn't realize that both texts should be striked-through'ed but werent for native iOS and Android I think (as can be seen in the description of #18524)

@rushatgabhane
Copy link
Member

Ohhh got it! It's a new UX improvement. Not a bug. Sorry!!

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.

7 participants