Remove sideloading of Onyx data for avatar with display name #32304

tgolen · 2023-11-30T21:19:56Z

Details

This PR removes some deprecated methods that were loading data into the components without using Onyx properly.

Fixed Issues

$ #32309

Tests

Go to a 1:1 chat with another person
Hover over their avatar at the top of the page in the report header
Verify the avatar and display name is displayed correctly
Click on the avatar
Verify you are taken to the person's profile

Verify that no errors appear in the JS console

Offline tests

Same as the above

QA Steps

Same as the 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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Unable to test due to HOST issues

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2023-11-30T21:47:22Z

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

situchan · 2023-11-30T21:48:06Z

Interested in reviewing this if requires C+

tgolen · 2023-11-30T21:51:30Z

Ah, thanks @situchan. I created #32309 so that a random C+ was assigned so I think @cubuspl42 has this one.

cubuspl42 · 2023-12-01T10:23:36Z

I'm on it

cubuspl42 · 2023-12-01T12:44:43Z

Was there any buggy / undesirable behavior observable on main in the context of this component? Or is it an architectural refactoring?

cubuspl42 · 2023-12-01T14:58:03Z

I'm not assigned as a reviewer, by the way

situchan · 2023-12-01T14:59:30Z

@cubuspl42 please go ahead your review since you're assigned on the issue @tgolen intentionally created to pull up C+ for this review.

situchan · 2023-12-01T15:01:28Z

Was there any buggy / undesirable behavior observable on main in the context of this component? Or is it an architectural refactoring?

Please check #27262 description.
Or for better understanding with example, check this Problem / Solution in slack - https://expensify.slack.com/archives/C01GTK53T8Q/p1688630003862989

cubuspl42 · 2023-12-01T15:03:34Z

@cubuspl42 please go ahead your review since you're assigned on the issue @tgolen intentionally created to pull up C+ for this review.

I know, I just wasn't sure if the automation will be happy about me not being assigned

amyevans · 2023-12-01T15:10:38Z

I know, I just wasn't sure if the automation will be happy about me not being assigned

Added you, it doesn't really matter though in terms of the automation!

cubuspl42

The code looks good. The diff is not very fortunate, as it's probably bigger than the essential changes because of moving the showActorDetails function around.

cubuspl42 · 2023-12-01T15:52:46Z

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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
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

remove-sideloading-web.mp4

Mobile Web - Chrome

remove-sideloading-android-web-compressed.mp4

Mobile Web - Safari

remove-sideloading-ios-web.mp4

Desktop

iOS

remove-sideloading-ios.mp4

Android

remove-sideloading-android-compressed.mp4

cubuspl42 · 2023-12-01T15:55:41Z

The avatar changed for another account is updated reactively ✅

avatar-update.mp4

cubuspl42

👍

melvin-bot · 2023-12-01T15:57:03Z

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

tgolen · 2023-12-01T17:39:02Z

The diff is not very fortunate, as it's probably bigger than the essential changes because of moving the showActorDetails function around.

Yeah, sorry for adding a lot extra. I like to leave code in a better state than I found it so destructuring the props, cleaning up the unused HOCs, and moving the method around were some extra bonuses.

tgolen · 2023-12-01T17:40:15Z

src/components/AvatarWithDisplayName.js

+    const actorAccountID = useRef(null);
+    useEffect(() => {
+        const parentReportAction = lodashGet(parentReportActions, [report.parentReportActionID], {});
+        actorAccountID.current = lodashGet(parentReportAction, 'actorAccountID', -1);


This was the biggest change on the PR. The actorAccountID was coming from const parentReportAction = ReportActionsUtils.getParentReportAction(report); which was the deprecated method that needed to be removed.

tgolen · 2023-12-01T17:41:55Z

I made a quick update to this where I removed the session key from withOnyx. I think it was a copy/paste mistake that I made and I saw it was unused.

OSBotify · 2023-12-01T18:45:18Z

✋ 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-12-05T02:56:50Z

🚀 Cherry-picked to staging by https://github.com/yuwenmemon in version: 1.4.7-4 🚀

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-12-05T13:41:55Z

🚀 Deployed to staging by https://github.com/amyevans in version: 1.4.8-0 🚀

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

OSBotify · 2023-12-06T20:32:03Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

OSBotify · 2023-12-06T20:41:35Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.8-3 🚀

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

tgolen added 2 commits November 30, 2023 14:02

Remove side-loading of parent report action

dea9ed4

Destructure props and remove unused props

a156200

tgolen self-assigned this Nov 30, 2023

Fix style

7025f47

tgolen marked this pull request as ready for review November 30, 2023 21:46

tgolen requested a review from a team as a code owner November 30, 2023 21:46

melvin-bot bot requested review from amyevans and removed request for a team November 30, 2023 21:47

tgolen mentioned this pull request Nov 30, 2023

[payment due 2023-12-13] [$500] Remove sideloading of Onyx data for avatar with display name #32309

Closed

amyevans requested a review from cubuspl42 December 1, 2023 15:10

cubuspl42 reviewed Dec 1, 2023

View reviewed changes

cubuspl42 approved these changes Dec 1, 2023

View reviewed changes

melvin-bot bot requested a review from srikarparsi December 1, 2023 15:57

tgolen commented Dec 1, 2023

View reviewed changes

Remove unused Onyx key

e056672

amyevans approved these changes Dec 1, 2023

View reviewed changes

amyevans merged commit 1fac143 into main Dec 1, 2023
15 checks passed

amyevans deleted the tgolen-remove-sideloading branch December 1, 2023 18:41

github-actions bot mentioned this pull request Dec 5, 2023

Deploy Checklist: New Expensify 2023-12-05 #32463

Closed

66 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove sideloading of Onyx data for avatar with display name #32304

Remove sideloading of Onyx data for avatar with display name #32304

tgolen commented Nov 30, 2023 •

edited

Loading

melvin-bot bot commented Nov 30, 2023

situchan commented Nov 30, 2023

tgolen commented Nov 30, 2023

cubuspl42 commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

situchan commented Dec 1, 2023

situchan commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

amyevans commented Dec 1, 2023

cubuspl42 left a comment

cubuspl42 commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

cubuspl42 left a comment

melvin-bot bot commented Dec 1, 2023

tgolen commented Dec 1, 2023

tgolen Dec 1, 2023

tgolen commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

Remove sideloading of Onyx data for avatar with display name #32304

Remove sideloading of Onyx data for avatar with display name #32304

Conversation

tgolen commented Nov 30, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 30, 2023

situchan commented Nov 30, 2023

tgolen commented Nov 30, 2023

cubuspl42 commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

situchan commented Dec 1, 2023

situchan commented Dec 1, 2023

cubuspl42 commented Dec 1, 2023

amyevans commented Dec 1, 2023

cubuspl42 left a comment

Choose a reason for hiding this comment

cubuspl42 commented Dec 1, 2023

Reviewer Checklist

Screenshots/Videos

cubuspl42 commented Dec 1, 2023

cubuspl42 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 1, 2023

tgolen commented Dec 1, 2023

tgolen Dec 1, 2023

Choose a reason for hiding this comment

tgolen commented Dec 1, 2023

OSBotify commented Dec 1, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 5, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

tgolen commented Nov 30, 2023 •

edited

Loading