fix remove only first request #22727

namhihi237 · 2023-07-12T01:58:50Z

Details

Delete only the first matching request

Fixed Issues

$ #19640
PROPOSAL: #19640 (comment)

Tests

Open the same account on 2 devices or browser
Open preferences on both
Click "Force offline" on device 1
Click 3 times on Notifications toggle
Click on "Force offline" toggle to go online
verify that the settings of both are the same

Verify that no errors appear in the JS console

Offline tests

The same test

QA Steps

The same test

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

m-web.mov

Mobile Web - Safari

safari.mov

Desktop

desktop.mov

iOS

native-ios.mov

Android

native.-android.mov

melvin-bot · 2023-07-12T01:58:55Z

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

allroundexperts · 2023-07-12T18:19:18Z

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.

Screenshots/Videos

Web

Screen.Recording.2023-07-13.at.1.18.33.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-13.at.1.28.22.AM.mov

Mobile Web - Safari

Screen.Recording.2023-07-13.at.1.47.10.AM.mov

Desktop

Screen.Recording.2023-07-13.at.1.21.40.AM.mov

iOS

Screen.Recording.2023-07-13.at.1.34.10.AM.mov

Android

Screen.Recording.2023-07-13.at.1.32.42.AM.mov

allroundexperts · 2023-07-12T19:59:36Z

src/libs/actions/PersistedRequests.js

-    persistedRequests = _.reject(persistedRequests, (persistedRequest) => _.isEqual(persistedRequest, requestToRemove));
+    const index = _.findIndex(persistedRequests, (persistedRequest) => _.isEqual(persistedRequest, requestToRemove));
+    if (index !== -1) {
+        persistedRequests.splice(index, 1);


@namhihi237 Mutating the original persistedRequests array really makes me anxious. Can we please mutate a copy of the original?

@allroundexperts yes sure to avoid mutating the original persistedRequests array, we can make a copy of the array before modifying it.

updated @allroundexperts

allroundexperts · 2023-07-13T16:21:35Z

src/libs/actions/PersistedRequests.js

+    const index = _.findIndex(persistedRequestsCopy, (persistedRequest) => _.isEqual(persistedRequest, requestToRemove));
+    if (index !== -1) {
+        persistedRequestsCopy.splice(index, 1);
+        persistedRequests = persistedRequestsCopy;


Why do we need this line?

we need to update persistedRequests array define global as you can see the current code:
persistedRequests = _.reject(persistedRequests, (persistedRequest) => _.isEqual(persistedRequest, requestToRemove));

Hm... Thinking about it again, I think your previous changes were fine. Can you revert?

allroundexperts

Looking good!

namhihi237 · 2023-07-14T17:29:20Z

Hi @puneetlath, when you have free time can you take a look at this.

puneetlath

Sorry for the delay! This looks good to me!

Just one request -- can we add a comment or function description explaining that we are removing the first matching request only, even if there are multiple matching requests.

namhihi237 · 2023-07-21T08:22:28Z

Added @puneetlath Thanks for back review

namhihi237 · 2023-07-24T05:02:08Z

Bump on this @puneetlath

puneetlath · 2023-07-24T15:49:05Z

src/libs/actions/PersistedRequests.js

-    persistedRequests = _.reject(persistedRequests, (persistedRequest) => _.isEqual(persistedRequest, requestToRemove));
+    /**
+     * Removes the first matching request, even if there are multiple matching requests.
+     * Because if multiple identical requests are queued. We want to keep the same requests then see more here: https://github.com/Expensify/App/issues/19640


Suggested change

* Because if multiple identical requests are queued. We want to keep the same requests then see more here: https://github.com/Expensify/App/issues/19640

* We only remove the first matching request because the order of requests matters.

* If we were to remove all matching requests, we can end up with a final state that is different than what the user intended.

namhihi237 · 2023-07-24T15:53:50Z

@puneetlath updated with your suggestion, thanks

OSBotify · 2023-07-24T16:23:58Z

✋ 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-07-25T01:43:12Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:52:43Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

fix remove only first request

a36139b

namhihi237 requested a review from a team as a code owner July 12, 2023 01:58

melvin-bot bot removed the request for review from a team July 12, 2023 01:58

melvin-bot bot requested a review from allroundexperts July 12, 2023 01:58

allroundexperts reviewed Jul 12, 2023

View reviewed changes

namhihi237 added 2 commits July 13, 2023 09:13

fix use clone object

09774bb

use underscore clone

a52c6d5

allroundexperts reviewed Jul 13, 2023

View reviewed changes

revert change directly

46595c3

allroundexperts approved these changes Jul 13, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath July 13, 2023 18:30

greg-schroeder mentioned this pull request Jul 18, 2023

[HOLD for payment 2023-08-07] [$1000] Preferences- Notification toggle updating inconsistently on devices #19640

Closed

6 tasks

puneetlath requested changes Jul 21, 2023

View reviewed changes

add comment

94683d9

puneetlath requested changes Jul 24, 2023

View reviewed changes

fix comment

9489b25

allroundexperts approved these changes Jul 24, 2023

View reviewed changes

melvin-bot bot requested a review from puneetlath July 24, 2023 15:52

puneetlath approved these changes Jul 24, 2023

View reviewed changes

puneetlath merged commit ff54c9e into Expensify:main Jul 24, 2023

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

flodnv mentioned this pull request Jul 25, 2023

[HOLD for payment 2023-08-03] [HOLD for payment 2023-08-02] Workspace - System throws an error when refreshing 'Invite new members' page immediately after creating a workspace #23536

Closed

6 tasks

s-alves10 mentioned this pull request Jul 25, 2023

[HOLD for payment 2023-08-03] [HOLD for payment 2023-08-02] Contact methods - System throws an error when refreshing the secondary login verification page #23542

Closed

6 tasks

puneetlath mentioned this pull request Jul 25, 2023

[CP Staging] Revert "fix remove only first request" #23551

Merged

58 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix remove only first request #22727

fix remove only first request #22727

namhihi237 commented Jul 12, 2023

melvin-bot bot commented Jul 12, 2023

allroundexperts commented Jul 12, 2023 •

edited

Loading

allroundexperts Jul 12, 2023

namhihi237 Jul 13, 2023

namhihi237 Jul 13, 2023

allroundexperts Jul 13, 2023

namhihi237 Jul 13, 2023

allroundexperts Jul 13, 2023

allroundexperts left a comment

namhihi237 commented Jul 14, 2023

puneetlath left a comment

namhihi237 commented Jul 21, 2023

namhihi237 commented Jul 24, 2023

puneetlath Jul 24, 2023

namhihi237 commented Jul 24, 2023

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

	* Because if multiple identical requests are queued. We want to keep the same requests then see more here: https://github.com/Expensify/App/issues/19640
	* We only remove the first matching request because the order of requests matters.
	* If we were to remove all matching requests, we can end up with a final state that is different than what the user intended.

fix remove only first request #22727

fix remove only first request #22727

Conversation

namhihi237 commented Jul 12, 2023

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 12, 2023

allroundexperts commented Jul 12, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

allroundexperts Jul 12, 2023

Choose a reason for hiding this comment

namhihi237 Jul 13, 2023

Choose a reason for hiding this comment

namhihi237 Jul 13, 2023

Choose a reason for hiding this comment

allroundexperts Jul 13, 2023

Choose a reason for hiding this comment

namhihi237 Jul 13, 2023

Choose a reason for hiding this comment

allroundexperts Jul 13, 2023

Choose a reason for hiding this comment

allroundexperts left a comment

Choose a reason for hiding this comment

namhihi237 commented Jul 14, 2023

puneetlath left a comment

Choose a reason for hiding this comment

namhihi237 commented Jul 21, 2023

namhihi237 commented Jul 24, 2023

puneetlath Jul 24, 2023

Choose a reason for hiding this comment

namhihi237 commented Jul 24, 2023

OSBotify commented Jul 24, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

allroundexperts commented Jul 12, 2023 •

edited

Loading