Dedupe multiple UpdateComment requests #51149

zirgulis · 2024-10-21T05:37:43Z

Details

Problem:

When there's no internet connection, UpdateComment network requests get serialized in Onyx. When internet connection is back multiple UpdateComment network request are posted to the backend even though only the last UpdateComment takes effect.

Solution:
Dedupe multiple UpdateComment requests

Changes:

refactor resolveDuplicationConflictAction to accept the requestMatcher function which does the filtering.
update resolveDuplicationConflictAction usage in the code
check for conflicting UpdateComment request when persisting to Onyx.

Fixed Issues

$ #50074

PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

Turn off internet connection
Edit a single comment, save it.
Repeat step 2 multiple times.
Turn on internet connection
Observe a single UpdateCommentsent to BE.

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.mp4

Android: mWeb Chrome

android_browser.mp4

iOS: Native

ios.mp4

iOS: mWeb Safari

ios_browser.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

electron.mp4

github-actions · 2024-10-21T05:37:58Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

melvin-bot · 2024-10-21T05:38:12Z

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

zirgulis · 2024-10-21T05:38:54Z

I have read the CLA Document and I hereby sign the CLA

src/libs/actions/Report.ts

src/libs/actions/RequestConflictUtils.ts

tests/unit/RequestConflictUtilsTest.ts

mountiny · 2024-10-21T11:07:08Z

you need to link issue like this:

### Fixed Issues
$ https://github.com/Expensify/App/issues/50074

dukenv0307 · 2024-10-22T04:39:30Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-10-22.at.11.28.59.mov

Android: mWeb Chrome

Screen.Recording.2024-10-22.at.11.20.49.mov

iOS: Native

Screen.Recording.2024-10-22.at.11.26.48.mov

iOS: mWeb Safari

Screen.Recording.2024-10-22.at.11.17.31.mov

MacOS: Chrome / Safari

web-resize.mp4

MacOS: Desktop

desktop.mp4

dukenv0307 · 2024-10-22T04:39:54Z

@zirgulis Can you update the video/screenshot for other platforms? Thanks

dukenv0307 · 2024-10-22T07:35:55Z

@zirgulis 3 tests are failed

mountiny · 2024-10-22T09:46:42Z

@zirgulis please merge main

zirgulis · 2024-10-22T15:13:59Z

@mountiny I've merged main
@dukenv0307 I've updated the videos for all the platforms.

mountiny

thanks!

mountiny · 2024-10-23T12:30:56Z

Not clear to me why the check is failing right now

mountiny · 2024-10-23T16:58:08Z

Perfect, thanks!

melvin-bot · 2024-10-23T16:58:20Z

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

OSBotify · 2024-10-23T17:08:26Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

mountiny · 2024-10-23T17:25:08Z

Tests were passing, not an emergency

github-actions · 2024-10-25T02:08:38Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.0.54-0 🚀

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

github-actions · 2024-10-29T09:14:18Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

github-actions · 2024-10-29T11:38:35Z

🚀 Deployed to production by https://github.com/Beamanator in version: 9.0.54-11 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	skipped 🚫
🍎🔄 iOS HybridApp 🍎🔄	skipped 🚫

zirgulis requested a review from a team as a code owner October 21, 2024 05:37

melvin-bot bot requested a review from jasperhuangg October 21, 2024 05:38

melvin-bot bot removed the request for review from a team October 21, 2024 05:38

CLABotify added a commit to Expensify/CLA that referenced this pull request Oct 21, 2024

@zirgulis has signed the CLA in Expensify/App#51149

cb75cd1

zirgulis mentioned this pull request Oct 21, 2024

[HOLD for payment 2024-11-11] [HOLD for payment 2024-11-05] [$250] De-dupe AddComment, EditComment, and DeleteComment requests #50074

Closed

gedu reviewed Oct 21, 2024

View reviewed changes

src/libs/actions/Report.ts Show resolved Hide resolved

gedu reviewed Oct 21, 2024

View reviewed changes

src/libs/actions/RequestConflictUtils.ts Outdated Show resolved Hide resolved

gedu reviewed Oct 21, 2024

View reviewed changes

tests/unit/RequestConflictUtilsTest.ts Outdated Show resolved Hide resolved

mountiny assigned zirgulis Oct 21, 2024

mountiny requested review from mountiny and removed request for jasperhuangg October 21, 2024 11:06

mountiny requested a review from shubham1206agra October 21, 2024 11:07

zirgulis requested a review from gedu October 21, 2024 15:50

mountiny requested review from dukenv0307 and removed request for shubham1206agra and gedu October 22, 2024 03:14

zirgulis added 6 commits October 22, 2024 16:19

add filterUpdateCommentRequest and filterRequestByCommand utils

9d58ea7

use constant instead of string

5846533

rename matcher fn to be more descriptive

a7eb4fd

update requestMatcher by request.command usage

4f752c7

add UpdateComment test

16d8f96

update test with request check

6bbc963

zirgulis force-pushed the zirgulis/dedupe_update_comment_requests branch from d3757cf to 6bbc963 Compare October 22, 2024 13:20

Merge branch 'main' into zirgulis/dedupe_update_comment_requests

6ca645a

dukenv0307 approved these changes Oct 23, 2024

View reviewed changes

mountiny approved these changes Oct 23, 2024

View reviewed changes

Merge branch 'main' into zirgulis/dedupe_update_comment_requests

6f7932c

mountiny merged commit 2712919 into Expensify:main Oct 23, 2024
15 checks passed

melvin-bot bot added the Emergency label Oct 23, 2024

mountiny removed the Emergency label Oct 23, 2024

github-actions bot mentioned this pull request Oct 25, 2024

Deploy Checklist: New Expensify 2024-10-25 #51448

Closed

49 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dedupe multiple UpdateComment requests #51149

Dedupe multiple UpdateComment requests #51149

zirgulis commented Oct 21, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024 •

edited

Loading

melvin-bot bot commented Oct 21, 2024

zirgulis commented Oct 21, 2024

mountiny commented Oct 21, 2024

dukenv0307 commented Oct 22, 2024

dukenv0307 commented Oct 22, 2024

dukenv0307 commented Oct 22, 2024

mountiny commented Oct 22, 2024

zirgulis commented Oct 22, 2024

mountiny left a comment

mountiny commented Oct 23, 2024

mountiny commented Oct 23, 2024

melvin-bot bot commented Oct 23, 2024

OSBotify commented Oct 23, 2024

mountiny commented Oct 23, 2024

github-actions bot commented Oct 25, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

Dedupe multiple UpdateComment requests #51149

Dedupe multiple UpdateComment requests #51149

Conversation

zirgulis commented Oct 21, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

github-actions bot commented Oct 21, 2024 • edited Loading

melvin-bot bot commented Oct 21, 2024

zirgulis commented Oct 21, 2024

mountiny commented Oct 21, 2024

dukenv0307 commented Oct 22, 2024

Reviewer Checklist

Screenshots/Videos

dukenv0307 commented Oct 22, 2024

dukenv0307 commented Oct 22, 2024

mountiny commented Oct 22, 2024

zirgulis commented Oct 22, 2024

mountiny left a comment

Choose a reason for hiding this comment

mountiny commented Oct 23, 2024

mountiny commented Oct 23, 2024

melvin-bot bot commented Oct 23, 2024

OSBotify commented Oct 23, 2024

mountiny commented Oct 23, 2024

github-actions bot commented Oct 25, 2024

github-actions bot commented Oct 29, 2024

github-actions bot commented Oct 29, 2024

zirgulis commented Oct 21, 2024 •

edited

Loading

github-actions bot commented Oct 21, 2024 •

edited

Loading