fix: bug 2 for Personal details list migration #20661

BeeMargarida · 2023-06-13T09:54:42Z

Details

bug2: user details are missing on create new chat. Reported in slack here.

When creating a new chat with a random user (new), the personal details of that random user are not saved until they are received by a pusher event after the creation. We only have access to the user accountID and no data for it, so there's a pop-in of user data after creating the chat.

The fix was adding optimistic temporary user details for PERSONAL_DETAILS_LIST in openReport that contains the user account ID and their login and displayName (equal to the login).

Screen capture in Web.

Fixed Issues

$ Partially #19007

Tests

click on + icon
choose new chat option
enter random emailid and click on that

Verify that no errors appear in the JS console

Offline tests

Should only show optimistic data

QA Steps

click on + icon
choose new chat option
enter random emailid and click on that

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-06-13.at.11.12.15.mov

Mobile Web - Chrome

Mobile Web - Safari

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

Desktop

iOS

Android

melvin-bot · 2023-06-13T09:54:47Z

@neil-marcellini @thesahindia 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]

BeeMargarida · 2023-06-13T09:56:52Z

I think this PR does not follow the usual review process, since it's related to a migration issue
@Beamanator The PR for the bug 2.

mountiny · 2023-06-13T10:12:13Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Beamanator · 2023-06-13T10:57:45Z

src/libs/actions/Report.js

+        // Add optimistic personal details for new participants
+        const optimisticPersonalDetails = {};
+        _.map(participantLoginList, (login, index) => {
+            optimisticPersonalDetails[newReportObject.participantAccountIDs[index]] = {login, displayName: login};


I wonder if it's possible for participantLoginList to be in a different order than newReportObject.participantAccountIDs?

Wouldn't it be a bit safer to do something like: newReportObject.participantAccountIDs.findBy (match accountIDs)

That's valid, but we can't do by findBy, since here we have two lists, participantLoginList = ['test@email.com', 'test+1@email.com'] and newReportObject.participantAccountIDs = [123123123, 345345345]. I think the best solution would be to pass an object keyed by account ID but for that it would be necessary to change the function params

@Beamanator forgot to tag, but what do you think about changing the function to receive an object instead of an array of logins (comment above)

Sorry I didn't see your response 🙃

Hmm actually looking at where we're calling openReport, I see that we basically create the optimistic participantAccountIDs for the new report in the same order we create the list of logins - so I don't really see how they could be mis-matched? Do you? I could have been over-thinking :D

One more thing: Should we add an avatar & accountID here?

@BeeMargarida pinging you in case this helps 😅

That was my logic, but this is taking into consideration that all openReport usages now and in the future will take that into consideration. For now I think it's fine, from what I see, all calls build userLogins using getLoginsByAccountIDs with participantAccountIDs or vice versa, so they should maintain the order.

Should we add an avatar & accountID here?

Perhaps it's better 😄 I'll add it

Ya now I see it, sorry for getting confused before :D 👍

…-migration-bug2

Beamanator

LGTM (assuming tests pass)

Beamanator

LGTM (I'll fix the lint error in the base branch)

OSBotify · 2023-06-16T18:52:04Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.3.29-0 🚀

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

OSBotify · 2023-06-21T02:19:35Z

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

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

fix: add optimistic personal details on report creation

282e54d

BeeMargarida requested a review from a team as a code owner June 13, 2023 09:54

melvin-bot bot requested review from neil-marcellini and thesahindia and removed request for a team June 13, 2023 09:54

mountiny assigned BeeMargarida Jun 13, 2023

mountiny self-requested a review June 13, 2023 10:12

Beamanator reviewed Jun 13, 2023

View reviewed changes

BeeMargarida added 3 commits June 13, 2023 12:50

Merge branch 'personalDetailsList-migration' into personalDetailsList…

61e9a3b

…-migration-bug2

fix: add avatar and account ID to optimistic personal details

251b8a1

Merge branch 'personalDetailsList-migration' into personalDetailsList…

b752d1f

…-migration-bug2

Beamanator approved these changes Jun 13, 2023

View reviewed changes

Beamanator merged commit d7571a3 into Expensify:personalDetailsList-migration Jun 13, 2023

OSBotify mentioned this pull request Jun 16, 2023

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

Closed

yuwenmemon mentioned this pull request Jun 16, 2023

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

Merged

56 tasks

fix: bug 2 for Personal details list migration #20661

fix: bug 2 for Personal details list migration #20661

Uh oh!

Conversation

BeeMargarida commented Jun 13, 2023 • edited by yuwenmemon Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jun 13, 2023

Uh oh!

BeeMargarida commented Jun 13, 2023

Uh oh!

mountiny commented Jun 13, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

Beamanator Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

BeeMargarida Jun 13, 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!

BeeMargarida Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

Beamanator Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

Beamanator Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

BeeMargarida Jun 13, 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!

Beamanator Jun 13, 2023

Choose a reason for hiding this comment

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jun 16, 2023

Uh oh!

OSBotify commented Jun 21, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

BeeMargarida commented Jun 13, 2023 •

edited by yuwenmemon

Loading

BeeMargarida Jun 13, 2023 •

edited

Loading

BeeMargarida Jun 13, 2023 •

edited

Loading