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

Handle cancelled requests correctly #9101

Merged
merged 3 commits into from
May 20, 2022

Conversation

marcaaron
Copy link
Contributor

@marcaaron marcaaron commented May 19, 2022

cc @neil-marcellini

Details

Introduces better handling for cancelled requests.

Fixed Issues (Related to PR)

#8855

Tests & QA

This is probably best tested in connection with the linked PR above. But I think another test is...

  1. Sign in
  2. Sign out as quickly as possible
  3. Verify that cancelled requests are not retried by looking at the logs.

Bad Logs

2022-05-19_15-45-56

Good Logs

2022-05-19_15-46-44

  • Verify that no errors appear in the JS console

PR Review Checklist

PR Reviewer Checklist

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

@marcaaron marcaaron self-assigned this May 20, 2022
@marcaaron marcaaron requested a review from neil-marcellini May 20, 2022 01:49
@marcaaron marcaaron changed the title [WIP] Handle canceled requests correctly \Handle canceled requests correctly May 20, 2022
@marcaaron marcaaron changed the title \Handle canceled requests correctly Handle cancelled requests correctly May 20, 2022
@marcaaron marcaaron marked this pull request as ready for review May 20, 2022 01:50
@marcaaron marcaaron requested a review from a team as a code owner May 20, 2022 01:50
@melvin-bot melvin-bot bot requested review from alex-mechler and removed request for a team May 20, 2022 01:50
Copy link
Contributor

@alex-mechler alex-mechler left a comment

Choose a reason for hiding this comment

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

LGTM, but I'm not super familiar with this code. All you @neil-marcellini

Copy link
Contributor

@neil-marcellini neil-marcellini left a comment

Choose a reason for hiding this comment

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

The changes look good, the QA with the transition flow works, and the automated test passes.

@neil-marcellini neil-marcellini merged commit ff42d7a into main May 20, 2022
@neil-marcellini neil-marcellini deleted the marcaaron-stopRetryingCancelledRequests branch May 20, 2022 18:01
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @neil-marcellini in version: 1.1.65-4 🚀

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

@Julesssss
Copy link
Contributor

Hey @Expensify/applauseleads, this PR needs to be tested too I believe.

@isagoico
Copy link

isagoico commented May 23, 2022

@Julesssss something weird happened to this PR, it looks like it was merged to staging 3 days ago but added and mentioned in the Staging Checklist an hour ago 🤔 that's why it has not been QAd yet.

@isagoico
Copy link

@marcaaron I checked the PR in staging an looks like it's a pass could you give a quick look to verify it's ok?

image
image

@marcaaron
Copy link
Contributor Author

That looks correct and I just tested again and verified the issue has been resolved. Thanks!

@OSBotify
Copy link
Contributor

🚀 Deployed to production by @Julesssss in version: 1.1.65-6 🚀

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.

6 participants