Remove shouldRetry and canCancel now that deprecatedAPI is gone #19675

madmax330 · 2023-05-26T14:24:05Z

Details

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/215650
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Verify that no errors appear in the JS console
Log into NewDot
Send a message to an account and make sure you get it
Shut down auth sudo systemctl stop auth
Make sure you see the request being retried
Start auth sudo systemctl start auth
Make sure the request completes, you can verify it worked by checking that you got the message on the other account

Offline tests

Go offline
Write a message
Make sure nothing happens since requests aren't queued when offline
Go back online and make sure the request completes

QA Steps

Verify that no errors appear in the JS console
Go offline
Write a message
Make sure nothing happens since requests aren't queued when offline
Go back online and make sure the request completes

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

test.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

melvin-bot · 2023-05-26T14:24:40Z

@parasharrajat @MonilBhavsar 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]

parasharrajat · 2023-05-26T20:50:09Z

@madmax330 It will be good to know some details behind this change as well as what is the expected behavior?

MonilBhavsar · 2023-05-29T07:00:03Z

This is what issue says

When we're done refactoring out deprecatedAPI, we need to remove these parameters from requests as they are no longer needed by the new API.
They are just kept there for backwards compatibility with the old API.

App/src/libs/API.js

Lines 26 to 28 in dc67d1e

// This should be removed once we are no longer using deprecatedAPI

shouldRetry: true,

canCancel: true,

madmax330 · 2023-05-29T07:53:16Z

It will be good to know some details behind this change as well as what is the expected behavior?

Sure @parasharrajat the context is that now this logic is embedded into the choice of queue that the request is in.
So anything in the sequential queue should be retried, but anything in the main queue (read requests) doesn't need to be retried.
Anything in the main queue can be cancelled (except maybe for log requests)
For the sequential queue I'm not sure actually, I will bring this up in slack, but I don't think the requests in the sequential queue should be cancellable otherwise he have data loss.

Is that helpful?

madmax330 · 2023-06-08T11:22:25Z

Alright PR is tested and ready for review. @neil-marcellini I added you as reviewer since you worked on the retry logic improvement as well

neil-marcellini

Looking pretty good. I think there's a few things we should change and I'm also unsure of a few things.

We can also remove this

App/src/libs/actions/Report.js

Lines 378 to 380 in c80e6cd

    
           if (isFromDeepLink) { 
        
               params.shouldRetry = false; 
        
           }

src/libs/Network/MainQueue.js

src/libs/Authentication.js

src/libs/Log.js

src/libs/Middleware/Reauthentication.js

src/libs/Network/MainQueue.js

neil-marcellini

Thanks for the updates and the responses. I think we're moving towards a good solution. There's a few more changes I would like to see.

src/libs/Middleware/Reauthentication.js

src/libs/Network/MainQueue.js

src/libs/HttpUtils.js

madmax330 · 2023-06-15T08:42:05Z

Alright this is ready for review @parasharrajat @MonilBhavsar @neil-marcellini

MonilBhavsar

I think it will be good to add some QA steps to this since this updates core(network) part of the app

src/libs/HttpUtils.js

src/libs/Log.js

src/libs/Middleware/Reauthentication.js

src/libs/Network/MainQueue.js

neil-marcellini

Looks good to me. It would be good to add some QA steps before merging but I also think normal QA will catch bugs if there are any.

parasharrajat · 2023-08-04T20:59:51Z

I will create a new account and try that. Tried with 2 accounts and both had the same error.

parasharrajat · 2023-08-04T21:20:18Z

Ok, tested with a new account and faced the same error. So I found out that error passwordForm.error.twoFactorAuthenticationEnabled" is misleading. Reauthentication API response is as follows:

jsonCode: 402
message: "402 Missing partnerPassword"
onyxData: []
requestID: "7f19bd92cbd88e81-DEL"

we do have a logic to parse these error codes in reauthentication but we are not checking for "402 Missing partnerPassword" instead

App/src/libs/ErrorUtils.js

Line 22 in be9c400

if (response.message === '402 Missing partnerUserSecret') {

So either we need to add another condition for handling this error code or change the string to a new one in the above code.

Now about reauthentication, I check that before the authentication call is made PARTNER_PASSWORD is present but it is not sent in the payload. This seems like an issue.

In the end, the Reauthentication call is made after I destroy the creds so I think it that ~~reauthentication logic is working and not disturbed with this PR.~~ Need to validate.

parasharrajat · 2023-08-04T21:28:58Z

So this issue is not present on the main. If we can reproduce this after merging the main then it is a issue in this PR.

@madmax330 Can you please merge the main?

madmax330 · 2023-08-07T10:15:48Z

Done @parasharrajat Merged main

parasharrajat · 2023-08-07T12:57:10Z

Ok. Thanks I tested reauthentication and it is working after merging the main.

Steps;

Open any chat on the web.
Go to preferences page.
invalidates authentication status.
Go back to the composer.
Send a new message.
Observe that the message is sent and reauthentication was successful.

parasharrajat

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.

🎀 👀 🎀 C+ reviewed

melvin-bot · 2023-08-07T12:58:17Z

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

melvin-bot · 2023-08-07T12:58:21Z

🎯 @parasharrajat, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #24209.

madmax330 · 2023-08-07T13:02:48Z

Awesome! Thanks @parasharrajat 🎉

OSBotify · 2023-08-07T13:07:01Z

✋ 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 · 2023-08-07T18:54:40Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.51-0 🚀

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

MonilBhavsar · 2023-08-08T07:23:56Z

❗ This PR was reverted #24240

parasharrajat · 2023-08-09T08:34:57Z

I didn't quite get the root cause as provided info is not sufficient #24240 (comment). @madmax330 because PR was reverted, do you want to create a new one?

OSBotify · 2023-08-09T08:43:48Z

🚀 Deployed to production by https://github.com/Julesssss in version: 1.3.51-2 🚀

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

OSBotify · 2023-08-09T09:12:44Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:51:27Z

🚀 Deployed to staging by https://github.com/madmax330 in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:09:53Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

parasharrajat · 2023-08-18T13:10:03Z

@madmax330 The PR was reverted. Do you have the bandwidth to create a new one with the fix?

madmax330 · 2023-08-18T18:32:13Z

Yeah I discussed a bit with @neil-marcellini and he saw the issue even after the PR was reverted. So not 100% sure it was this PR. I'll still retry and test next week to see.

parasharrajat · 2023-08-31T18:36:40Z

@madmax330 Any update for me.

Remove shouldRetry and canCancel now that deprecatedAPI is gone

f827a2b

madmax330 requested a review from a team as a code owner May 26, 2023 14:24

madmax330 self-assigned this May 26, 2023

melvin-bot bot requested review from MonilBhavsar and parasharrajat and removed request for a team May 26, 2023 14:24

madmax330 added 4 commits June 8, 2023 09:14

Merge branch 'main' into maxence-rracfa

c80e6cd

fix tests

a3be1c2

fix last test

e6caa84

lint

50dead1

madmax330 changed the title ~~[WIP] Remove shouldRetry and canCancel now that deprecatedAPI is gone~~ Remove shouldRetry and canCancel now that deprecatedAPI is gone Jun 8, 2023

madmax330 requested a review from neil-marcellini June 8, 2023 07:27

madmax330 changed the title ~~Remove shouldRetry and canCancel now that deprecatedAPI is gone~~ [NoQA] Remove shouldRetry and canCancel now that deprecatedAPI is gone Jun 8, 2023

neil-marcellini requested changes Jun 8, 2023

View reviewed changes

src/libs/Network/MainQueue.js Outdated Show resolved Hide resolved

src/libs/Authentication.js Show resolved Hide resolved

src/libs/Log.js Show resolved Hide resolved

src/libs/Middleware/Reauthentication.js Outdated Show resolved Hide resolved

madmax330 commented Jun 9, 2023

View reviewed changes

src/libs/Network/MainQueue.js Outdated Show resolved Hide resolved

madmax330 added 2 commits June 9, 2023 10:41

keep logs

bc6bfe0

fix

a0322a9

neil-marcellini requested changes Jun 9, 2023

View reviewed changes

src/libs/Middleware/Reauthentication.js Outdated Show resolved Hide resolved

src/libs/Network/MainQueue.js Outdated Show resolved Hide resolved

add comment

564c9e1

madmax330 commented Jun 14, 2023

View reviewed changes

src/libs/HttpUtils.js Outdated Show resolved Hide resolved

don't cancel log requests

8e647fa

MonilBhavsar reviewed Jun 15, 2023

View reviewed changes

src/libs/HttpUtils.js Outdated Show resolved Hide resolved

src/libs/Log.js Outdated Show resolved Hide resolved

src/libs/Middleware/Reauthentication.js Show resolved Hide resolved

src/libs/Network/MainQueue.js Outdated Show resolved Hide resolved

add comment

f8e16e0

neil-marcellini previously approved these changes Jun 15, 2023

View reviewed changes

Merge branch 'main' into maxence-rracfa

e6089d6

parasharrajat approved these changes Aug 7, 2023

View reviewed changes

melvin-bot bot requested a review from srikarparsi August 7, 2023 12:58

melvin-bot bot mentioned this pull request Aug 7, 2023

Payment issue for E/App PR#19675 #24209

Closed

madmax330 merged commit 80df2ed into main Aug 7, 2023

madmax330 deleted the maxence-rracfa branch August 7, 2023 13:02

OSBotify mentioned this pull request Aug 7, 2023

Deploy Checklist: New Expensify 2023-08-07 #24230

Closed

98 tasks

This was referenced Aug 7, 2023

[HOLD for payment 2023-08-17] BUG: iOS simulator crashes on sign in #24239

Closed

Revert "Remove shouldRetry and canCancel now that deprecatedAPI is gone" #24240

Merged

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

parasharrajat mentioned this pull request Oct 30, 2023

[HOLD for payment 2023-10-13] [$500] Chat - Requests with "500" response get retried forever #27886

Closed

6 tasks

Remove shouldRetry and canCancel now that deprecatedAPI is gone #19675

Remove shouldRetry and canCancel now that deprecatedAPI is gone #19675

Uh oh!

Conversation

madmax330 commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 26, 2023

Uh oh!

parasharrajat commented May 26, 2023

Uh oh!

MonilBhavsar commented May 29, 2023

Uh oh!

madmax330 commented May 29, 2023

Uh oh!

madmax330 commented Jun 8, 2023

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

madmax330 commented Jun 15, 2023

Uh oh!

MonilBhavsar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

neil-marcellini left a comment

Choose a reason for hiding this comment

Uh oh!

parasharrajat commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parasharrajat commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parasharrajat commented Aug 4, 2023

Uh oh!

madmax330 commented Aug 7, 2023

Uh oh!

parasharrajat commented Aug 7, 2023

Uh oh!

parasharrajat left a comment

Choose a reason for hiding this comment

Reviewer Checklist

Uh oh!

melvin-bot bot commented Aug 7, 2023

Uh oh!

melvin-bot bot commented Aug 7, 2023

Uh oh!

madmax330 commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

OSBotify commented Aug 7, 2023

Uh oh!

MonilBhavsar commented Aug 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parasharrajat commented Aug 9, 2023

madmax330 commented May 26, 2023 •

edited

Loading

parasharrajat commented Aug 4, 2023 •

edited

Loading

parasharrajat commented Aug 4, 2023 •

edited

Loading

MonilBhavsar commented Aug 8, 2023 •

edited

Loading