Fix/15048: Add successData into DeleteMembersFromWorkspace API #17078

tienifr · 2023-04-06T15:48:19Z

Details

As soon as we receive a successful response, we ought to remove the user from Onyx without waiting for a pusher event. This will not fix the issue completely but make it harder to reproduce

Fixed Issues

$ #15048
PROPOSAL: #15048 (comment)

Tests

Open the App
Go to Settings -> Workspaces -> Open any workspace -> Manage members
Invite a new user if you haven't yet
Turn off the internet connection
Remove some users (it should become crossed out)
Turn on network and wait until offline indicator message ("You appear to be offline") disappears
Verify that deleted users disappear immediately when offline indicator disappears
Wait a bit(about 1,2s) then turn on the internet (deleted users disappear)
Turn off the internet connection
Verify that users who have been removed offline disappear

Verify that no errors appear in the JS console

Offline tests

None

QA Steps

Open the App
Go to Settings -> Workspaces -> Open any workspace -> Manage members
Invite a new user if you haven't yet
Turn off the internet connection
Remove some users (it should become crossed out)
Turn on network and wait until offline indicator message ("You appear to be offline") disappears
Verify that deleted users disappear immediately when offline indicator disappears
Wait a bit(about 1,2s) then turn on the internet (deleted users disappear)
Turn off the internet connection
Verify that users who have been removed offline disappear

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

228515935-e51a54dc-099d-4442-981f-c13c1c3467b7.mp4

Mobile Web - Chrome

15048chorme.mp4

Mobile Web - Safari

Screen.Recording.2023-04-06.at.23.06.23.mp4

Desktop

Screen.Recording.2023-04-06.at.23.09.03.mp4

iOS

Screen.Recording.2023-04-06.at.23.36.19.mp4

Android

Screen.Recording.2023-04-07.at.00.40.13.mp4

MelvinBot · 2023-04-06T17:45:11Z

@grgia @aimane-chnaif 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]

tienifr · 2023-04-07T07:08:49Z

@aimane-chnaif Could you help to check this PR?

aimane-chnaif · 2023-04-07T07:09:49Z

@aimane-chnaif Could you help to check this PR?

on it

src/libs/actions/Policy.js

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

aimane-chnaif · 2023-04-07T07:28:38Z

src/libs/actions/Policy.js

+    const successData = [{
+        onyxMethod: CONST.ONYX.METHOD.MERGE,
+        key: membersListKey,
+        value: _.object(members, Array(members.length).fill(null)),
+    }];


(NAB) Also, let's move this between optimisticData and failureData

Just updated

aimane-chnaif · 2023-04-07T09:37:12Z

Pusher seems stable at the moment. I am not able to reproduce pusher event received after api response, so cannot check the benefit of this PR.
@tienifr same to you?

tienifr · 2023-04-07T09:39:44Z

@aimane-chnaif Could you disable the Pusher before testing this PR?

aimane-chnaif · 2023-04-07T09:40:32Z

@aimane-chnaif Could you disable the Pusher before testing this PR?

what is your best way of doing this?

tienifr · 2023-04-07T09:41:37Z

We can comment entire lines

App/src/libs/Pusher/pusher.js

Lines 128 to 177 in 64f4a78

    
           if (shouldForceOffline) { 
        
               Log.info('[Pusher] Ignoring a Push event because shouldForceOffline = true'); 
        
               return; 
        
           } 
        
           let data; 
        
           try { 
        
               data = _.isObject(eventData) ? eventData : JSON.parse(eventData); 
        
           } catch (err) { 
        
               Log.alert('[Pusher] Unable to parse JSON response from Pusher', {error: err, eventData}); 
        
               return; 
        
           } 
        
           if (data.id === undefined || data.chunk === undefined || data.final === undefined) { 
        
               eventCallback(data); 
        
               return; 
        
           } 
        
           // If we are chunking the requests, we need to construct a rolling list of all packets that have come through 
        
           // Pusher. If we've completed one of these full packets, we'll combine the data and act on the event that it's 
        
           // assigned to. 
        
           // If we haven't seen this eventID yet, initialize it into our rolling list of packets. 
        
           if (!chunkedDataEvents[data.id]) { 
        
               chunkedDataEvents[data.id] = {chunks: [], receivedFinal: false}; 
        
           } 
        
           // Add it to the rolling list. 
        
           const chunkedEvent = chunkedDataEvents[data.id]; 
        
           chunkedEvent.chunks[data.index] = data.chunk; 
        
           // If this is the last packet, mark that we've hit the end. 
        
           if (data.final) { 
        
               chunkedEvent.receivedFinal = true; 
        
           } 
        
           // Only call the event callback if we've received the last packet and we don't have any holes in the complete 
        
           // packet. 
        
           if (chunkedEvent.receivedFinal && chunkedEvent.chunks.length === _.keys(chunkedEvent.chunks).length) { 
        
               eventCallback(JSON.parse(chunkedEvent.chunks.join(''))); 
        
               try { 
        
                   eventCallback(JSON.parse(chunkedEvent.chunks.join(''))); 
        
               } catch (err) { 
        
                   Log.alert('[Pusher] Unable to parse chunked JSON response from Pusher', { 
        
                       error: err, 
        
                       eventData: chunkedEvent.chunks.join(''), 
        
                   }); 
        
               } 
        
               delete chunkedDataEvents[data.id]; 
        
           }

So that when receiving the eventdata from BE, The app will not update data to ONYX

aimane-chnaif · 2023-04-07T09:48:32Z

ok, force updating this to true should be enough

App/src/libs/Pusher/pusher.js

Line 128 in 64f4a78

if (shouldForceOffline) {

aimane-chnaif · 2023-04-07T10:53:43Z

Wait a bit(about 1,2s) then turn on the internet (deleted users disappear)

Turn off the internet connection

@tienifr this description needs updated. I tested on physical android device and it usually takes a few seconds (or more) to be online after turn on wifi.
So something like this makes more sense:

Turn on network and wait until offline indicator message ("You appear to be offline") disappears

Verify that deleted users disappear immediately when offline indicator disappears

Wait a bit(about 1,2s) then turn off the internet connection

tienifr · 2023-04-07T11:31:42Z

@aimane-chnaif I just updated the description. Thanks for your comments

aimane-chnaif · 2023-04-07T12:00:11Z

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 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 correct English and 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 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

with pusher

with.pusher.mov

without pusher

without.pusher.mov

Mobile Web - Chrome

android.mp4

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mp4

aimane-chnaif

Looks good, tests as expected.

Note for QA team: this doesn't completely fix original issue, so it will fail when they quickly switch network (offline -> online -> offline) which isn't enough time to get api response.

@grgia all you!

OSBotify · 2023-04-10T09:48:42Z

✋ 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-04-10T19:26:58Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.2.98-0 🚀

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

OSBotify · 2023-04-11T21:27:30Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.2.98-2 🚀

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

tienifr force-pushed the fix/issue-15048 branch from 2abcfba to 40b720d Compare April 6, 2023 15:51

tienifr changed the title ~~Fix/issue 15048~~ Fix/15048: Add successData into DeleteMembersFromWorkspace API Apr 6, 2023

fix: add successData into DeleteMembersFromWorkspace API

9d52163

tienifr force-pushed the fix/issue-15048 branch from 40b720d to 9d52163 Compare April 6, 2023 15:57

tienifr mentioned this pull request Apr 6, 2023

[HOLD for payment 2023-04-18] [$8000] Manage member - User deleted offline becomes visible again when the Internet is turned off #15048

Closed

6 tasks

tienifr marked this pull request as ready for review April 6, 2023 17:45

tienifr requested a review from a team as a code owner April 6, 2023 17:45

melvin-bot bot requested review from aimane-chnaif and grgia and removed request for a team April 6, 2023 17:45

aimane-chnaif reviewed Apr 7, 2023

View reviewed changes

src/libs/actions/Policy.js Outdated Show resolved Hide resolved

Update src/libs/actions/Policy.js

3fe2c2d

Co-authored-by: Aimane Chnaif <96077027+aimane-chnaif@users.noreply.github.com>

aimane-chnaif reviewed Apr 7, 2023

View reviewed changes

fix: move successData into between optimisticData and failureData

80d7bb3

aimane-chnaif approved these changes Apr 7, 2023

View reviewed changes

grgia approved these changes Apr 10, 2023

View reviewed changes

grgia merged commit f3f0e37 into Expensify:main Apr 10, 2023

OSBotify mentioned this pull request Apr 10, 2023

Deploy Checklist: New Expensify 2023-04-10 #17230

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/15048: Add successData into DeleteMembersFromWorkspace API #17078

Fix/15048: Add successData into DeleteMembersFromWorkspace API #17078

tienifr commented Apr 6, 2023 •

edited

Loading

MelvinBot commented Apr 6, 2023

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

aimane-chnaif Apr 7, 2023

tienifr Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

tienifr commented Apr 7, 2023 •

edited

Loading

aimane-chnaif commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023 •

edited

Loading

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

aimane-chnaif left a comment

OSBotify commented Apr 10, 2023

OSBotify commented Apr 10, 2023

OSBotify commented Apr 11, 2023

Fix/15048: Add successData into DeleteMembersFromWorkspace API #17078

Fix/15048: Add successData into DeleteMembersFromWorkspace API #17078

Conversation

tienifr commented Apr 6, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Apr 6, 2023

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

aimane-chnaif Apr 7, 2023

Choose a reason for hiding this comment

tienifr Apr 7, 2023

Choose a reason for hiding this comment

aimane-chnaif commented Apr 7, 2023

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

tienifr commented Apr 7, 2023 • edited Loading

aimane-chnaif commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023 • edited Loading

tienifr commented Apr 7, 2023

aimane-chnaif commented Apr 7, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 10, 2023

OSBotify commented Apr 10, 2023

OSBotify commented Apr 11, 2023

tienifr commented Apr 6, 2023 •

edited

Loading

tienifr commented Apr 7, 2023 •

edited

Loading

aimane-chnaif commented Apr 7, 2023 •

edited

Loading