[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details #20951

yuwenmemon · 2023-06-16T22:49:07Z

Details

I believe this was introduced in this PR: #20661
cc @BeeMargarida

We were unnecessarily creating optimistic personal details objects for users we may already have had personal details objects stored in Onyx. Instead of creating an optimistic personal detail for everyone in a new group chat, create an optimistic personal detail only if we can't find one already in Onyx.

Fixed Issues

$ #20943

Tests/QA

Create a new group chat with multiple people with avatars
Make sure that the icons in the initial group chat are the avatars and there is no delay before rendering where you see an alternative avatar.

Verify that no errors appear in the JS console

Offline tests

Perform the same steps when offline. The behavior should be the same.

QA Steps

Perform the offline and online steps above.

PR Author Checklist

Screenshots/Videos

Web

Kapture.2023-06-16.at.15.48.09.mp4

Mobile Web - Chrome

Kapture.2023-06-16.at.16.35.17.mp4

Mobile Web - Safari

Kapture.2023-06-16.at.15.52.36.mp4

Desktop

Kapture.2023-06-16.at.16.37.55.mp4

iOS

Kapture.2023-06-16.at.16.38.58.mp4

Android

Kapture.2023-06-16.at.16.32.10.mp4

…ore creating fake optimistic personal details

melvin-bot · 2023-06-16T23:14:43Z

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

aimane-chnaif

Code looks good but actually I am not convinced about the solution in #20661 which caused this regression.
Was there any reason why we couldn't fix the root cause instead of adding optimistic temporary user details? This used to work before personal details migration even without that optimistic data.

Beamanator · 2023-06-19T07:49:56Z

@aimane-chnaif I know we added this because when the page was redirecting to the new chat (which may not have existed at that point) it was very possible we hadn't loaded the user's personal details at that point - so this was needed. And now'days we're sending less personalDetails from the server to the front-end in order to limit the amount of logins being sent everywhere. A.k.a. we're trying to be more secure about who we send login information to, because we don't want absolutely everyone to be able to see everyone's contact info always.

Additionally, we used to do pretty much everything w/ logins & default to viewing logins everywhere but now since we're trying to only access personalDetailsList - which is keyed by accountID - I thinkkk this was a necessary change

aimane-chnaif · 2023-06-19T07:57:10Z

It makes sense. Thanks for the explanation.

Beamanator · 2023-06-19T08:08:27Z

@aimane-chnaif this is fixing a deploy blocker so it would be great if you could test this quickly today 🙏

aimane-chnaif · 2023-06-19T09:05:53Z

I think one more condition should be added in Tests step:
I already have contacts with avatars to have a new group chat with. Because new contact avatar will still be delayed as I don't know that contact details yet.

aimane-chnaif · 2023-06-19T09:09:57Z

src/libs/actions/Report.js

@@ -420,7 +428,7 @@ function openReport(reportID, participantLoginList = [], newReportObject = {}, p
        const optimisticPersonalDetails = {};
        _.map(participantLoginList, (login, index) => {
            const accountID = newReportObject.participantAccountIDs[index];
-            optimisticPersonalDetails[accountID] = {
+            optimisticPersonalDetails[accountID] = allPersonalDetails[accountID] || {


This can be called before getting allPersonalDetails so just for null safety:

Suggested change

optimisticPersonalDetails[accountID] = allPersonalDetails[accountID] || {

optimisticPersonalDetails[accountID] = (allPersonalDetails && allPersonalDetails[accountID]) || {

I don't know if this is needed since we already default allPersonalDetails to {} at the top of the file, if the data in that key doesn't exist

That's really true. I think this is also redundant:

App/src/libs/ReportUtils.js

Line 842 in ffd9672

(allPersonalDetails && allPersonalDetails[accountID]) || {

Beamanator · 2023-06-19T09:54:20Z

I think one more condition should be added in Tests step: I already have contacts with avatars to have a new group chat with. Because new contact avatar will still be delayed as I don't know that contact details yet.

Sorry @aimane-chnaif can you write this in exact steps you think the test should cover? I don't quite understanding what you're trying to test here, sorry

aimane-chnaif · 2023-06-19T09:58:31Z

A has contact with B, no contact with C. Everyone has avatar set.
Disable network
A creates new group with B, C
While creating chat optimistically, B has avatar but C doesn't have avatar
Enable network
Receives pusher event and C info is added in personalDetails data
Now shows C's avatar correctly

Beamanator · 2023-06-19T10:12:32Z

@aimane-chnaif thanks, yes that sounds like a very useful test to add 👍

aimane-chnaif · 2023-06-19T16:12:00Z

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

Mobile Web - Chrome

mchrome.mov

Mobile Web - Safari

msafari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

aimane-chnaif

Both online / offline tests pass.

Default avatar flickers when create chat with new contact. I think this is inevitable since we don't know accountID before fetching backend.

melvin-bot · 2023-06-19T16:14:10Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #20943... Please reach out for help on Slack if no one gets assigned!

github-actions · 2023-06-19T18:31:31Z

⚠️ ⚠️ Heads up! This pull request has the CP Staging label ⚠️ ⚠️
If you applied the CP Staging label before the PR was merged, the PR will be be immediately deployed to staging even if the open StagingDeployCash deploy checklist is locked.
However if you applied the CP Staging after the PR was merged it's possible it won't be CP'ed automatically. If you need it to be CP'ed to staging, tag a member of @Expensify/mobile-deployers to CP it manually, otherwise you can wait for it to go out with the next deploy.

[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details (cherry picked from commit 8456d27)

…-20951 🍒 Cherry pick PR #20951 to staging 🍒

OSBotify · 2023-06-19T19:12:49Z

🚀 Cherry-picked to staging by https://github.com/luacmartins in version: 1.3.29-3 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2023-06-21T02:17:25Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.29-11 🚀

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

OSBotify · 2023-06-23T22:17:55Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.32-1 🚀

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

OSBotify · 2023-06-26T20:48:32Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.3.32-5 🚀

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

Make sure that we first check the personaldetails we already have bef…

626ee39

…ore creating fake optimistic personal details

yuwenmemon self-assigned this Jun 16, 2023

Prettier

02f8f35

yuwenmemon marked this pull request as ready for review June 16, 2023 23:14

yuwenmemon requested a review from a team as a code owner June 16, 2023 23:14

melvin-bot bot requested review from aimane-chnaif and removed request for a team June 16, 2023 23:14

yuwenmemon requested a review from Beamanator June 16, 2023 23:19

aimane-chnaif reviewed Jun 19, 2023

View reviewed changes

aimane-chnaif approved these changes Jun 19, 2023

View reviewed changes

luacmartins approved these changes Jun 19, 2023

View reviewed changes

luacmartins added the CP Staging label Jun 19, 2023

luacmartins merged commit 8456d27 into main Jun 19, 2023

luacmartins deleted the yuwen-personalDetailFallback branch June 19, 2023 18:31

luacmartins mentioned this pull request Jun 19, 2023

[C+ payment] New group - Users' avatars appear only after some moment #20943

Closed

6 tasks

OSBotify mentioned this pull request Jun 19, 2023

🍒 Cherry pick PR #20951 to staging 🍒 #21071

Merged

OSBotify added a commit that referenced this pull request Jun 19, 2023

Merge pull request #21071 from Expensify/OSBotify-cherry-pick-staging…

da0595e

…-20951 🍒 Cherry pick PR #20951 to staging 🍒

OSBotify mentioned this pull request Jun 19, 2023

Deploy Checklist: New Expensify 2023-06-16 #20928

Closed

lanitochka17 mentioned this pull request Jun 19, 2023

New Group - Unknown broken contact is added to group when selecting contacts with only avatars #21086

Closed

6 tasks

OSBotify mentioned this pull request Jun 21, 2023

Deploy Checklist: New Expensify 2023-06-21 #21172

Closed

67 tasks

OSBotify mentioned this pull request Jun 24, 2023

Deploy Checklist: New Expensify 2023-06-24 #21477

Closed

45 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details #20951

[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details #20951

yuwenmemon commented Jun 16, 2023 •

edited

Loading

melvin-bot bot commented Jun 16, 2023

aimane-chnaif left a comment

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

aimane-chnaif Jun 19, 2023 •

edited

Loading

Beamanator Jun 19, 2023

aimane-chnaif Jun 19, 2023

Beamanator Jun 19, 2023

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

Beamanator commented Jun 19, 2023 •

edited

Loading

aimane-chnaif commented Jun 19, 2023

aimane-chnaif left a comment

melvin-bot bot commented Jun 19, 2023

github-actions bot commented Jun 19, 2023

OSBotify commented Jun 19, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

	optimisticPersonalDetails[accountID] = allPersonalDetails[accountID] \|\| {
	optimisticPersonalDetails[accountID] = (allPersonalDetails && allPersonalDetails[accountID]) \|\| {

[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details #20951

[CP Staging] Make sure that we first check the PersonalDetails we already have before creating fake optimistic personal details #20951

Conversation

yuwenmemon commented Jun 16, 2023 • edited Loading

Details

Fixed Issues

Tests/QA

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 16, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

aimane-chnaif Jun 19, 2023 • edited Loading

Choose a reason for hiding this comment

Beamanator Jun 19, 2023

Choose a reason for hiding this comment

aimane-chnaif Jun 19, 2023

Choose a reason for hiding this comment

Beamanator Jun 19, 2023

Choose a reason for hiding this comment

Beamanator commented Jun 19, 2023

aimane-chnaif commented Jun 19, 2023

Beamanator commented Jun 19, 2023 • edited Loading

aimane-chnaif commented Jun 19, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 19, 2023

github-actions bot commented Jun 19, 2023

OSBotify commented Jun 19, 2023

OSBotify commented Jun 21, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

yuwenmemon commented Jun 16, 2023 •

edited

Loading

aimane-chnaif Jun 19, 2023 •

edited

Loading

Beamanator commented Jun 19, 2023 •

edited

Loading