Wildan/fix/21518/client pusher method by wildan-m · Pull Request #24407 · Expensify/App

wildan-m · 2023-08-11T06:57:38Z

@johncschuster , @allroundexperts

Details

Fix leaving a room from multiple devices and fix regression when splitting the bill

Fixed Issues

$ #21518
$ #22964
PROPOSAL: #21518 (comment)

Tests

Leave Room Test

Open a room on the web and on another device (e.g. Android) using the same account
Click room details and click Leave Room on one of the devices (e.g. web)
The user should leave the room on both devices

Split bill test

Go to Website
Split bill.
Verify that some of the recipients are a recipient with no interaction
Click on preview.

Verify that no errors appear in the JS console

Offline tests

Open a room on the web and on another device (e.g. Android) using the same account
disconnect the internet on both
Click room details and click Leave Room on one of the devices (e.g. web)
At this point the user should only leave a room in the web version only.
re-connect the internet connection
The user should leave the room on both devices

QA Steps

Open a room on the web and on another device (e.g. Android) using the same account
Click room details and click Leave Room on one of the devices (e.g. web)
The user should leave the room on both devices

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Recording.53.2.mp4

Mobile Web - Chrome

Recording.48.2.mp4

Mobile Web - Safari

Recording.49.2.mp4

Desktop

Recording.51.2.mp4

iOS

Recording.50.2.mp4

Android

Recording.47.mp4

…bscribe naming

…x/21518/client-pusher-method

melvin-bot · 2023-08-11T06:57:43Z

@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-08-15T06:29:05Z

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 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 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-09-22.at.3.34.18.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-09-22.at.3.43.20.AM.mov

Mobile Web - Safari

Screen.Recording.2023-09-22.at.3.46.25.AM.mov

Desktop

Screen.Recording.2023-09-22.at.3.39.04.AM.mov

iOS

Screen.Recording.2023-09-22.at.3.47.34.AM.mov

Android

Screen.Recording.2023-09-22.at.3.45.26.AM.mov

allroundexperts · 2023-08-15T17:39:31Z

@wildan-m Can you please merge main and resolve conflicts?

…x/21518/client-pusher-method

wildan-m · 2023-08-15T21:29:59Z

@allroundexperts sure. Done.

…x/21518/client-pusher-method

wildan-m · 2023-08-17T13:06:36Z

@allroundexperts any feedback on the implementation?

allroundexperts · 2023-08-21T10:15:40Z

Sorry for the delay @wildan-m. I'll look into it later today / early tomorrow.

allroundexperts · 2023-08-21T21:05:35Z

@wildan-m Can you please merge main again?

…x/21518/client-pusher-method

wildan-m · 2023-08-21T23:23:27Z

@allroundexperts sure. done.

wildan-m · 2023-08-21T23:57:57Z

@allroundexperts not sure what causes some checks to fail. seems not related to this PR

…x/21518/client-pusher-method

wildan-m · 2023-08-22T03:33:02Z

It's related to mapbox integration.

…x/21518/client-pusher-method

wildan-m · 2023-08-22T05:58:01Z

resolved after this post.

deetergp · 2023-08-23T00:57:42Z

@wildan-m It looks like ONYXKEYS.js is modified in your branch but has been replaced by ONYXKEYS.ts in main. Can you please resolve the conflict and push it?

@allroundexperts let's try to get this reviewed before the merge conflict merry-go-round comes back around to haunt Wildan again? 😅

…x/21518/client-pusher-method

wildan-m · 2023-08-23T02:21:16Z

@deetergp, @allroundexperts done.

…x/21518/client-pusher-method

allroundexperts · 2023-09-20T22:59:34Z

I'll recheck this again tomorrow 🤞🤞🤞

luacmartins · 2023-09-21T00:28:02Z

@allroundexperts is this still on your list for today?

allroundexperts · 2023-09-21T00:29:07Z

@allroundexperts is this still on your list for today?

Yep. Once I wake up tomorrow!

allroundexperts

Testing well now!

melvin-bot · 2023-09-22T01:30:14Z

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

OSBotify · 2023-09-22T01:36:43Z

✋ 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-09-22T13:59:35Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:34:26Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:06:27Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:48:48Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

…1518/client-pusher-method" This reverts commit fa6a767, reversing changes made to b50dfac.

fedirjh · 2023-11-01T20:36:58Z

src/pages/home/ReportScreen.js

+    useEffect(() => {
+        // Ensures subscription event succeeds when the report/workspace room is created optimistically.


We should have early returned if reportID is null to avoid the console error mentioned in #29116.

@fedirjh Thanks for your feedback. We did it here and here, but we might also need to put it in useEffect

The issue also related to this function:

App/src/pages/home/ReportScreen.js

Lines 128 to 131 in 6cc9053

function getReportID(route) {

// // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.

return String(lodashGet(route, 'params.reportID', null));

}

it returned 'null' string instead of an actual null.

I'd recommend to change it to:

function getReportID(route) { const reportID = lodashGet(route, 'params.reportID', null); return reportID !== null ? String(reportID) : null; }

@luacmartins, @allroundexperts, considering that this has passed the regression period, and any change would require re-testing. What should we do in this situation? Will there be any adjustments?

I'd recommend to change it to:

We attempted this in PR #29590, but it resulted in a regression, so we reverted the changes in PR #29893. The issue arises from the fact that getReportID is utilized within the withOnyx HOC. When null is passed as its value, Onyx will return the entire collection. Therefore, it was intentional for getReportID to return a 'null' string when the report is empty.

App/src/pages/home/ReportScreen.js

Line 470 in 6cc9053

key: ({route}) => `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${getReportID(route)}`,

@fedirjh seems you've resolved it here. thank you

I think we also need to check onyx report reportId availability to avoid #38174

wildan-m added 5 commits August 10, 2023 10:48

Create is leaving client pusher event

97807c2

implement subscribeToReportLeavingEvents

b769dc8

Remove unnecessary code, run prettier

c87ceb9

refine comment, remove leavingWatchTimers variable, refine checkAndSu…

b57b046

…bscribe naming

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

3ed2c75

…x/21518/client-pusher-method

wildan-m requested a review from a team as a code owner August 11, 2023 06:57

melvin-bot bot requested review from allroundexperts and removed request for a team August 11, 2023 06:57

wildan-m mentioned this pull request Aug 11, 2023

Fix leaving room a room when the split bill with multiple participants #23051

Closed

58 tasks

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

8d92b2b

…x/21518/client-pusher-method

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

9bc367e

…x/21518/client-pusher-method

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

488e320

…x/21518/client-pusher-method

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

09aa78e

…x/21518/client-pusher-method

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

5376bcf

…x/21518/client-pusher-method

wildan-m added 2 commits August 23, 2023 09:12

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

16106f8

…x/21518/client-pusher-method

Move REPORT_USER_IS_LEAVING_ROOM to ONYXKEYS.ts

ea6c6fe

Merge branch 'main' of https://github.com/wildan-m/App into wildan/fi…

fee3986

…x/21518/client-pusher-method

wildan-m added 3 commits September 20, 2023 10:48

resolve leftover conflict

91c533e

remove unnecessary code

8926377

change didSubscribeToReportLeavingEvents check to early return

b2303b2

luacmartins requested review from allroundexperts and luacmartins September 20, 2023 06:54

luacmartins approved these changes Sep 20, 2023

View reviewed changes

sobitneupane mentioned this pull request Sep 20, 2023

[$500] Room - Hmm... it's not here page appears when leaving the room on another device #26136

Closed

6 tasks

allroundexperts approved these changes Sep 21, 2023

View reviewed changes

melvin-bot bot requested a review from luacmartins September 21, 2023 22:53

luacmartins approved these changes Sep 22, 2023

View reviewed changes

luacmartins merged commit fa6a767 into Expensify:main Sep 22, 2023

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

dukenv0307 mentioned this pull request Sep 27, 2023

Fix: Leave thread chat when has no comment #27849

Closed

59 tasks

dukenv0307 mentioned this pull request Oct 1, 2023

[$500] Android - Thread - Back button is not responsive in the parent report after leaving thread #28522

Closed

6 tasks

hoangzinh added a commit to hoangzinh/Expensify-App that referenced this pull request Oct 2, 2023

Revert "Merge pull request Expensify#24407 from wildan-m/wildan/fix/2…

74b25a3

…1518/client-pusher-method" This reverts commit fa6a767, reversing changes made to b50dfac.

fedirjh reviewed Nov 1, 2023

View reviewed changes

fedirjh mentioned this pull request Nov 1, 2023

[HOLD for payment 2023-10-30] [$500] API - 404 Returns On AuthenticatePusher API #29116

Closed

6 tasks

bernhardoj mentioned this pull request Mar 15, 2024

[HOLD for payment 2024-04-03] [$500] Web - Thread - Console error ERR_FAILED 404 shows up when opening thread #38174

Closed

6 tasks

		useEffect(() => {
		// Ensures subscription event succeeds when the report/workspace room is created optimistically.

	function getReportID(route) {
	// // The reportID is used inside a collection key and should not be empty, as an empty reportID will result in the entire collection being returned.
	return String(lodashGet(route, 'params.reportID', null));
	}

Conversation

wildan-m commented Aug 11, 2023

Details

Fixed Issues

Tests

Leave Room Test

Split bill test

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Aug 11, 2023

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

allroundexperts commented Aug 15, 2023

Uh oh!

wildan-m commented Aug 15, 2023

Uh oh!

wildan-m commented Aug 17, 2023

Uh oh!

allroundexperts commented Aug 21, 2023

Uh oh!

allroundexperts commented Aug 21, 2023

Uh oh!

wildan-m commented Aug 21, 2023

Uh oh!

wildan-m commented Aug 21, 2023

Uh oh!

wildan-m commented Aug 22, 2023

Uh oh!

wildan-m commented Aug 22, 2023

Uh oh!

deetergp commented Aug 23, 2023

Uh oh!

wildan-m commented Aug 23, 2023

Uh oh!

allroundexperts commented Sep 20, 2023

Uh oh!

luacmartins commented Sep 21, 2023

Uh oh!

allroundexperts commented Sep 21, 2023

Uh oh!

allroundexperts left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Sep 22, 2023

Uh oh!

OSBotify commented Sep 22, 2023

Uh oh!

OSBotify commented Sep 22, 2023

Uh oh!

OSBotify commented Sep 25, 2023

Uh oh!

OSBotify commented Sep 25, 2023

Uh oh!

OSBotify commented Sep 28, 2023

Uh oh!

fedirjh Nov 1, 2023

Choose a reason for hiding this comment

Uh oh!

wildan-m Nov 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fedirjh Nov 3, 2023

Choose a reason for hiding this comment

Uh oh!

wildan-m Nov 6, 2023

Choose a reason for hiding this comment

Uh oh!

Pujan92 Apr 23, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

allroundexperts commented Aug 15, 2023 •

edited

Loading

wildan-m Nov 3, 2023 •

edited

Loading