Replace `report.participants` with `*.participantAccountIDs` (Pt 1) #22639

Beamanator · 2023-07-11T12:40:52Z

Details

Migrating one of the last places we store emails in onyx to accountIDs 👍

Note: this issue (#21184) will be handled in a PR that remove use of report.participants, but not in this one 👍

Fixed Issues

$ Related to https://github.com/Expensify/Expensify/issues/294647

Tests

Start a few chats with "Known" users (1:1 & group)
- A "Known" user is someone that either:
  - Shares a private domain with you
  - Shares a private workspace chat with you
  - Has DM'd you (1:1 or group) before
Go to the chat search page
Verify you can search for chat reports by the people's email addresses (their logins should exist in personalDetailsList)

Note: The following case doesn't need to be tested, there's a bug that's being handled in this issue: #21706

Start a few chats with "Unknown" users

Go to the chat search page

Verify you CAN NOT search for those chat reports by unknown users' email addresses (their logins SHOULD NOT exist in personalDetailsList)

Verify that no errors appear in the JS console

Offline tests

Same as above, all tests should also work while offline

QA Steps

Same as above

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (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
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- 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 followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
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
I verified that if a function's arguments changed that all usages have also been updated correctly
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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

Beamanator · 2023-07-11T14:01:37Z

src/components/MoneyRequestConfirmationList.js

Updated this prop name to try to be a bit more clear

Beamanator · 2023-07-11T14:03:07Z

src/libs/OptionsListUtils.js

+                const accountID = participantAccountIDs[i];
+
+                if (allPersonalDetails[accountID] && allPersonalDetails[accountID].login) {
+                    searchTerms = searchTerms.concat(allPersonalDetails[accountID].login);


It would be interesting to also allow search by display name, but i think search improvements are coming in Daniel S's proj

src/libs/ReportUtils.js

Beamanator · 2023-07-11T14:04:50Z

src/libs/ReportUtils.js

+        // TODO: update to use report.participantAccountIDs
+        // Note: To migrate we have to make sure the "duplicate chat report" issue doesn't come back:
+        // https://github.com/Expensify/App/issues/21184


MAIN TODO WE'RE BLOCKED ON IS HERE

Nevermind - this case will be handled here: #21184

so it's expected we still access report.participants here

melvin-bot · 2023-07-11T14:55:41Z

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

0xmiros · 2023-07-11T17:52:30Z

This is sample of duplicate chat:

A, B are non-expensify users yet.

Login new account A
Create chat with new account B
On DM, send any message
Notice that account B is duplicated with different IDs

accountID: 15055700
avatar: "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/default-avatar_18.png"
displayName: "miroslav.stevanovic317+32@gmail.com"

accountID: 1812433538100742
avatar: "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/avatar_7.png"
displayName: "miroslav.stevanovic317+32@gmail.com"
login: "miroslav.stevanovic317+32@gmail.com"

0xmiros · 2023-07-11T19:11:13Z

I confirmed that this also happens on main so not a blocker.

Screen.Recording.2023-07-11.at.9.09.01.PM.mov

Beamanator · 2023-07-12T07:12:14Z

Thanks @0xmiroslav - yeah that duplicate chat issue is working on getting solved in @puneetlath 's PR: #22147 (with a backend change too #22147)

0xmiros · 2023-07-12T07:18:44Z

Thanks @0xmiroslav - yeah that duplicate chat issue is working on getting solved in @puneetlath 's PR: #22147 (with a backend change too #22147)

Will that possibly fix #21877 (comment) as well?

Beamanator · 2023-07-12T07:42:56Z

Ooh that's interesting @0xmiroslav - I don't thinkkkk so, I think the PR addresses creating new chats w/ users you don't have personal details for

Beamanator · 2023-07-12T10:42:04Z

@0xmiroslav anything you need from me before you can continue testing?

0xmiros · 2023-07-12T15:22:30Z

Start a few chats with "Unknown" users

Go to the chat search page

Verify you CAN NOT search for those chat reports by unknown users' email addresses (their logins SHOULD NOT exist in personalDetailsList)

@Beamanator these are failing for me. There are 2 duplicate accounts data in personalDetailsList.
One has login, another has no login.
It seems like when create new chat, contact is already made even though they didn't respond in DM.

Screen.Recording.2023-07-12.at.5.18.24.PM.mov

…ortParticipantsArray

Beamanator · 2023-07-13T08:18:57Z

@0xmiroslav arggggg thanks, will check that out now 👍

Beamanator · 2023-07-13T08:38:03Z

@0xmiroslav it looks like that's easily reproduced in staging (probably in prod too), so I will change my test steps actually - this seems similar to this issue (#21706) but there could already be an exact issue for this.

Screen.Recording.2023-07-13.at.11.36.11.AM.mov

Beamanator · 2023-07-13T09:07:09Z

@0xmiroslav removed that test case since it's being handled elsewhere, please re-review 🙏

0xmiros · 2023-07-13T17:51: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 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

Screen.Recording.2023-07-12.at.5.18.24.PM.mov

offline

Screen.Recording.2023-07-12.at.5.27.40.PM.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

0xmiros

Please fix conflict

src/libs/ReportUtils.js

…ortParticipantsArray

Co-authored-by: Miroslav Stevanovic <97473779+0xmiroslav@users.noreply.github.com>

Beamanator · 2023-07-14T07:20:43Z

Conflicts fixed! (they were only in test files thankfully) - @AndrewGable ready for your review 👍

melvin-bot · 2023-07-14T08:23:40Z

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

Beamanator · 2023-07-14T10:40:29Z

@roryabraham removing your review request b/c @AndrewGable is already assigned to review - however please feel free to review if you'd like :D

Beamanator · 2023-07-17T14:14:54Z

@AndrewGable can you please review or assign someone else to review this today?? This is part of the initiative to remove emails from Onyx and we'd like to get this merged ASAP!

OSBotify · 2023-07-17T14:37:28Z

✋ 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-07-17T19:38:08Z

🚀 Deployed to staging by https://github.com/AndrewGable in version: 1.3.42-0 🚀

platform	result
🤖 android 🤖	cancelled 🔪
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	cancelled 🔪

OSBotify · 2023-07-19T17:59:53Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

Use report.participantAccountIDs

3d11ce4

Beamanator self-assigned this Jul 11, 2023

Beamanator added 8 commits July 11, 2023 15:44

Rename prop to be more clear

ba76146

Clean up old participants from tests

b4f638f

Make params more specific

c728ce9

remove participants from tests

d2ca32e

Improve empty array logic & clean unused code

4e08ff9

Simplify & only use accountIDs

4c2b6ad

Two TODOs before this is ready

5731df8

Prettify

294d341

Beamanator commented Jul 11, 2023

View reviewed changes

src/components/MoneyRequestConfirmationList.js Outdated

Copy link

Contributor Author

Beamanator Jul 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated this prop name to try to be a bit more clear

Beamanator commented Jul 11, 2023

View reviewed changes

src/libs/ReportUtils.js Show resolved Hide resolved

Beamanator commented Jul 11, 2023

View reviewed changes

Clean up TODOs not handling here

7106398

Beamanator changed the title ~~Replace report.participants with *.participantAccountIDs~~ Replace report.participants with *.participantAccountIDs (Pt 1) Jul 11, 2023

Beamanator marked this pull request as ready for review July 11, 2023 14:55

Beamanator requested a review from a team as a code owner July 11, 2023 14:55

melvin-bot bot requested review from AndrewGable and removed request for a team July 11, 2023 14:55

Beamanator requested a review from 0xmiros July 11, 2023 15:00

Merge branch 'main' of github.com:Expensify/App into beaman-removeRep…

ca67bf2

…ortParticipantsArray

0xmiros suggested changes Jul 13, 2023

View reviewed changes

src/libs/ReportUtils.js Outdated Show resolved Hide resolved

src/libs/ReportUtils.js Outdated Show resolved Hide resolved

Beamanator and others added 2 commits July 14, 2023 10:17

Merge branch 'main' of github.com:Expensify/App into beaman-removeRep…

e1601aa

…ortParticipantsArray

Simplify empty participants check

293da4f

Co-authored-by: Miroslav Stevanovic <97473779+0xmiroslav@users.noreply.github.com>

0xmiros approved these changes Jul 14, 2023

View reviewed changes

melvin-bot bot requested a review from roryabraham July 14, 2023 08:23

Beamanator removed the request for review from roryabraham July 14, 2023 10:40

AndrewGable approved these changes Jul 17, 2023

View reviewed changes

AndrewGable merged commit 798016a into main Jul 17, 2023

AndrewGable deleted the beaman-removeReportParticipantsArray branch July 17, 2023 14:29

0xmiros mentioned this pull request Jul 17, 2023

Migrate ReportActionCompose to function #18648

Merged

56 tasks

OSBotify mentioned this pull request Jul 17, 2023

Deploy Checklist: New Expensify 2023-07-17 #23033

Closed

0xmiros mentioned this pull request Jul 26, 2023

[HOLD for payment 2023-06-28] [Secure Logins] Replace login uses with accountIDs throughout App (when accessing Onyx) #19007

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace `report.participants` with `*.participantAccountIDs` (Pt 1) #22639

Replace `report.participants` with `*.participantAccountIDs` (Pt 1) #22639

Beamanator commented Jul 11, 2023 •

edited

Loading

Beamanator Jul 11, 2023

Beamanator Jul 11, 2023

Beamanator Jul 11, 2023

Beamanator Jul 11, 2023

melvin-bot bot commented Jul 11, 2023

0xmiros commented Jul 11, 2023

0xmiros commented Jul 11, 2023

Beamanator commented Jul 12, 2023

0xmiros commented Jul 12, 2023

Beamanator commented Jul 12, 2023

Beamanator commented Jul 12, 2023

0xmiros commented Jul 12, 2023 •

edited

Loading

Beamanator commented Jul 13, 2023

Beamanator commented Jul 13, 2023

Beamanator commented Jul 13, 2023

0xmiros commented Jul 13, 2023

0xmiros left a comment

Beamanator commented Jul 14, 2023

melvin-bot bot commented Jul 14, 2023

Beamanator commented Jul 14, 2023

Beamanator commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

Replace report.participants with *.participantAccountIDs (Pt 1) #22639

Replace report.participants with *.participantAccountIDs (Pt 1) #22639

Conversation

Beamanator commented Jul 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Beamanator Jul 11, 2023

Choose a reason for hiding this comment

Beamanator Jul 11, 2023

Choose a reason for hiding this comment

Beamanator Jul 11, 2023

Choose a reason for hiding this comment

Beamanator Jul 11, 2023

Choose a reason for hiding this comment

melvin-bot bot commented Jul 11, 2023

0xmiros commented Jul 11, 2023

0xmiros commented Jul 11, 2023

Beamanator commented Jul 12, 2023

0xmiros commented Jul 12, 2023

Beamanator commented Jul 12, 2023

Beamanator commented Jul 12, 2023

0xmiros commented Jul 12, 2023 • edited Loading

Beamanator commented Jul 13, 2023

Beamanator commented Jul 13, 2023

Beamanator commented Jul 13, 2023

0xmiros commented Jul 13, 2023

Reviewer Checklist

Screenshots/Videos

0xmiros left a comment

Choose a reason for hiding this comment

Beamanator commented Jul 14, 2023

melvin-bot bot commented Jul 14, 2023

Beamanator commented Jul 14, 2023

Beamanator commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

Replace `report.participants` with `*.participantAccountIDs` (Pt 1) #22639

Replace `report.participants` with `*.participantAccountIDs` (Pt 1) #22639

Beamanator commented Jul 11, 2023 •

edited

Loading

0xmiros commented Jul 12, 2023 •

edited

Loading