fix: optimistically add personal details #22904

samh-nl · 2023-07-14T17:16:48Z

Details

When inviting members to a Workspace, optimistically add the personal details where non-existent.

Fixed Issues

$ #22442
PROPOSAL: #22442 (comment)

Tests

Go to Settings
Go to Workspaces
Click the New workspace button
Go to Members
Click on the Invite button
Invite a member you have not yet interacted with
Verify that the newly added member is immediately shown in the workspace members list

Verify that no errors appear in the JS console

Offline tests

Go to Settings
Go to Workspaces
Click the New workspace button
Go to Members
Click on the Invite button
Invite a member you have not yet interacted with
Verify that the newly added member is immediately shown in the workspace members list

QA Steps

Go to Settings
Go to Workspaces
Click the New workspace button
Go to Members
Click on the Invite button
Invite a member you have not yet interacted with
Verify that the newly added member is immediately shown in the workspace members list

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Web.Screen.Recording.2023-07-14.at.15.55.27.mp4

Mobile Web - Chrome

mWeb.Chrome.Screen.Recording.2023-07-14.at.16.09.52.mp4

Mobile Web - Safari

mWeb.Safari.Screen.Recording.2023-07-14.at.15.58.30.mp4

Desktop

Desktop.Screen.Recording.2023-07-14.at.16.01.31.mp4

iOS

Native.ios.Screen.Recording.2023-07-14.at.15.52.18.mp4

Android

Native.android.Screen.Recording.2023-07-14.at.19.12.55.mp4

melvin-bot · 2023-07-14T17:16:53Z

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

src/libs/actions/Policy.js

s77rt · 2023-07-14T18:04:14Z

src/libs/actions/Policy.js

+                displayName: login,
+            };
+
+            policyPersonalDetails.successData[accountID] = null;


Won't this cause a flicker?

Optimistically set account

On success, remove account

On success (server response), add account (probably another account)

The swapping of the optimistic data with the server data on success should happen within the same rendering cycle.
I did not observe a flickering in the sense that members are removed and then reappear.
Avatars and display names, however, can update upon retrieving the server data. This behavior is consistent with other instances where one adds a user, for example if you create a report with or assign a task to a user that you have not interacted with yet.

The reason is that the optimistically set data is derived from the search result, and the search result is not an accurate depiction as no backend calls are made. In an ideal situation the search result is accurate and contains all information, but there may be performance/UX/privacy reasons why this was not pursued.

I see that when creating a report with a new user, both the optimistic user and the BE user remain in personalDetailsList.
If you subsequently search for the user, you will see 2 search results instead of 1.

My addition of policyPersonalDetails.successData[accountID] = null; prevents such problem by ensuring the optimistic user is cleaned up. So I think in other parts of the codebase a similar cleanup mechanism needs to be put in place, however this is outside the scope of this issue (in my opinion).

Alternatively, we could add a boolean flag to the optimistic user and filter these out in the search results.

Hmm, same thing goes for policyMembers_ We will have redundant members. I think we can keep that outside the scope as well. Let's just make sure we have optimistic data for new non existing members.

s77rt · 2023-07-15T14:36:01Z

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

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt · 2023-07-15T14:40:55Z

src/libs/actions/Policy.js

+ * @param {Array<number>} accountIDs Array of user accountIDs
+ * @returns {Object} - object with optimisticData, successData and failureData (object of personal details objects)
+ */
+function buildPolicyPersonalDetails(logins, accountIDs) {


The function name is not the most accurate, this data is not explicit to policies. Can we move this function to somewhere more fitting? e.g. PersonalDetails.js. Also I think we should indicate that the function will only return onyx data for non existing users.

I have:

Moved it to PersonalDetailsUtils.js.

Renamed it to getNewPersonalDetailsOnyxData.

Updated the JSDoc.

Made a small modification to ensure compatibility with PersonalDetailsUtils.js, where personalDetails is an array instead of an object.

It now returns complete Onyx data (including onyxMethod and key) instead of just the personal detail objects. This makes it consistent with other functions that have "OnyxData" in their name.

Can we move that to PersonalDetails instead? Having personalDetails as an object is faster to access.

Would moving it to PersonalDetails.js be semantically correct? It's placed in the actions/ folder and primarily contains functions triggering API calls, although also a few helper functions so it might be reasonable.

Yes iterating over the array is less efficient. It may have been done as a speed optimization if the other util functions are called often, so it's more efficient to cast it to an array at Onyx.connect instead of within the util function (executed many times). I would therefore be hesitant to change it to an object and put an extra cast to array inside the other existing functions, without further testing the performance implications.

Maybe we should add another value to PersonalDetailsUtils? keeping personalDetails as array and adding allPersonalDetails as object.

Then we make make a follow up PR to rewrite the util functions that use the array to use the object and remove the array variable.

That seems like a good way forward. I have committed the change and will work on the refactor in a separate PR.

s77rt · 2023-07-17T18:46:17Z

src/libs/PersonalDetailsUtils.js

+                displayName: login,
+            };
+
+            // Cleanup the optimistic user to ensure it does not permanently persist


I think this comment is incomplete. Can you please indicate that this is done to prevent duplicated entries since the server will return other personal details with the correct account ids.

Good idea, I've expanded it. Let me know what you think.

s77rt

LGTM! 🚀

samh-nl · 2023-07-19T17:03:00Z

@yuwenmemon Looking forward to your review. Please keep in mind it is day 8 at this point, thank you.

I will subsequently work on the follow-up PR (i.e. refactor to make use of the personal details object).

OSBotify · 2023-07-19T21:33:50Z

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

0xmiros · 2023-07-20T03:18:25Z

src/libs/actions/Policy.js

    const accountIDs = _.values(invitedEmailsToAccountIDs);
+    const newPersonalDetailsOnyxData = PersonalDetailsUtils.getNewPersonalDetailsOnyxData(logins, accountIDs);

    // create onyx data for policy expense chats for each new member
    const membersChats = createPolicyExpenseChats(policyID, invitedEmailsToAccountIDs, betas);


It seems we're doing same work in different issues.
Is it fine to revert this PR and apply changes in #22410?
We should add members optimistically to policy expense chat as well (if policyExpenseChat beta enabled), not only to workspace.

cc: @rezkiy37 @madmax330

We should add members optimistically to policy expense chat as well (if policyExpenseChat beta enabled), not only to workspace.

@0xmiroslav can you update your PR to do this?

Then the two would complement each other right?

#22410 is more optimized code as reusing optimistic members from workspace chat.

Alright, go ahead and resolve the conflict in #22410 and we will review.

OSBotify · 2023-07-21T18:51:24Z

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 1.3.44-0 🚀

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

OSBotify · 2023-07-25T01:25:21Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.44-2 🚀

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

OSBotify · 2023-07-25T01:46:00Z

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

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

OSBotify · 2023-07-26T15:55:31Z

🚀 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: optimistically add personal details

9cbe95d

samh-nl requested a review from a team as a code owner July 14, 2023 17:16

melvin-bot bot requested review from s77rt and removed request for a team July 14, 2023 17:16

samh-nl mentioned this pull request Jul 14, 2023

[HOLD for payment 2023-08-01] [$1000] User was not shown on Invite members page after immediately inviting #22442

Closed

6 tasks

s77rt suggested changes Jul 14, 2023

View reviewed changes

refactor: use each instead of map

571da94

s77rt suggested changes Jul 15, 2023

View reviewed changes

samh-nl added 3 commits July 16, 2023 12:46

refactor: moved to PersonalDetailsUtils

f0d3a67

style: prettify

e6881a1

refactor: use personal details object

67258bf

s77rt suggested changes Jul 17, 2023

View reviewed changes

docs: expanded comment

1ee57d8

s77rt approved these changes Jul 17, 2023

View reviewed changes

melvin-bot bot requested a review from yuwenmemon July 17, 2023 20:55

yuwenmemon approved these changes Jul 19, 2023

View reviewed changes

yuwenmemon merged commit 555621c into Expensify:main Jul 19, 2023
11 of 12 checks passed

0xmiros mentioned this pull request Jul 20, 2023

Fix invited members does not reflect in offline mode #22410

Merged

58 tasks

0xmiros reviewed Jul 20, 2023

View reviewed changes

OSBotify mentioned this pull request Jul 21, 2023

Deploy Checklist: New Expensify 2023-07-21 #23362

Closed

OSBotify mentioned this pull request Jul 25, 2023

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

Closed

NikkiWines mentioned this pull request Jul 31, 2023

Persist failed personal details when adding workspace member #23947

Merged

58 tasks

mollfpr mentioned this pull request Aug 30, 2023

[HOLD for payment 2023-09-27] [$1000] After deleting a mobile contact from a WorkSpace, it starts showing up in contacts as @expensify.sms #26121

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: optimistically add personal details #22904

fix: optimistically add personal details #22904

samh-nl commented Jul 14, 2023 •

edited

Loading

melvin-bot bot commented Jul 14, 2023

s77rt Jul 14, 2023

samh-nl Jul 14, 2023 •

edited

Loading

samh-nl Jul 15, 2023 •

edited

Loading

s77rt Jul 15, 2023

s77rt commented Jul 15, 2023 •

edited

Loading

s77rt Jul 15, 2023

samh-nl Jul 16, 2023 •

edited

Loading

s77rt Jul 16, 2023

samh-nl Jul 16, 2023

s77rt Jul 16, 2023

samh-nl Jul 17, 2023

s77rt Jul 17, 2023

samh-nl Jul 17, 2023

s77rt left a comment

samh-nl commented Jul 19, 2023

OSBotify commented Jul 19, 2023

0xmiros Jul 20, 2023

0xmiros Jul 20, 2023

madmax330 Jul 20, 2023

0xmiros Jul 20, 2023

madmax330 Jul 20, 2023

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

fix: optimistically add personal details #22904

fix: optimistically add personal details #22904

Conversation

samh-nl commented Jul 14, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 14, 2023

Choose a reason for hiding this comment

samh-nl Jul 14, 2023 • edited Loading

Choose a reason for hiding this comment

samh-nl Jul 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt commented Jul 15, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

samh-nl Jul 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s77rt left a comment

Choose a reason for hiding this comment

samh-nl commented Jul 19, 2023

OSBotify commented Jul 19, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Jul 21, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 25, 2023

OSBotify commented Jul 26, 2023

samh-nl commented Jul 14, 2023 •

edited

Loading

samh-nl Jul 14, 2023 •

edited

Loading

samh-nl Jul 15, 2023 •

edited

Loading

s77rt commented Jul 15, 2023 •

edited

Loading

samh-nl Jul 16, 2023 •

edited

Loading