Add delegate avatar component #48564

DylanDylann · 2024-09-04T14:22:09Z

Details

Fixed Issues

$ #46923
PROPOSAL: NA

Tests

Verify the delegate avatar display correct

Verify that no errors appear in the JS console

Offline tests

QA Steps

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-09-04T14:30:39Z

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

allgandalf · 2024-09-04T15:22:07Z

Taking over the review ♻️

allgandalf · 2024-09-04T15:22:49Z

@DylanDylann can you add testing steps here?, i can test this one but if we are going to QA this then we need those ! thanks

allgandalf · 2024-09-04T15:29:08Z

BUG:

When we swtich account to delegate, we cannot see the delegate profile untill we refresh, can you take a look @DylanDylann :

Screen.Recording.2024-09-04.at.8.56.03.PM.mov

allgandalf · 2024-09-04T15:30:53Z

src/pages/home/sidebar/AvatarWithDelegateAvatar.tsx

+
+function AvatarWithDelegateAvatar({delegateEmail, isSelected = false}: AvatarWithDelegateAvatarProps) {
+    const styles = useThemeStyles();
+    const personalDetail = PersonalDetailsUtils.getPersonalDetailByEmail(delegateEmail);


perhaps put this one under useCallback or something which will trigger a re-render

Seems like both of those have something to do with not correctly loading personal details?

@dangrous
I consoled logged the vairable which stores the personal details, it show undefined unless we refresh page:

const personalDetail = PersonalDetailsUtils.getPersonalDetailByEmail(delegateEmail);

Is not working as expected for the first load

Oh i get it, we are calling the wrong util, that util gives us the cache, when we switch account there is none

@DylanDylann can you update the util please

oh nice find. Alternately, is there a way we can preserve the personal details of the delegate account in the cache when we switch accounts (and past reload)? Trying to avoid unnecessary calls to the backend if we already have that info

We have to use useOnyx. Otherwise the variable won't update when underlying data changes

allgandalf · 2024-09-04T15:46:09Z

Another Bug

I noticed if we switch back to original profile, the details do not load

Screen.Recording.2024-09-04.at.9.15.02.PM.mov

This doesn't happen if i switch to main and do the same action

DylanDylann · 2024-09-04T17:25:08Z

For #48564 (comment), I can't reproduce but I think it is a BE bug

dangrous · 2024-09-04T18:41:09Z

Hm so I can reproduce on main, does seem like it's potentially backend. It is only reproducible if the page is reloaded while in the copiloted account (if you don't reload, then it works fine). Does that means something about the original account is being cached/saved and then cleared on reload?

Either way shouldn't block this PR

allgandalf · 2024-09-04T18:44:22Z

Does that means something about the original account is being cached/saved and then cleared on reload?

I feel we should clear all the data related to previous account when switching and load new accounts data, are we doing this currently?

Either way shouldn't block this PR

Ahh we still have a blocking bug though this

dangrous · 2024-09-04T18:47:05Z

Seems like both of those have something to do with not correctly loading personal details?

allgandalf · 2024-09-04T18:58:12Z

Found what is happening here @dangrous , you can have a look here

DylanDylann · 2024-09-05T04:49:38Z

@allgandalf Updated

dangrous · 2024-09-05T14:41:22Z

Love it, I think this one is ready for final review? @allgandalf can you take a look?

allgandalf · 2024-09-05T15:24:04Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-09-05.at.9.56.34.PM.mov

Android: mWeb Chrome

Screen.Recording.2024-09-05.at.9.47.17.PM.mov

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2024-09-05.at.8.57.11.PM.mov

MacOS: Desktop

Screen.Recording.2024-09-05.at.8.59.55.PM.mov

allgandalf

This looks good now, apart from the BE bug we discovered here, this PR looks perfect, we can merge this 🚀

dangrous · 2024-09-05T17:15:39Z

Though I think we determined that BE bug was actually a front end fix, adjusting where it comes from (not from the cache) right?

allgandalf · 2024-09-05T18:28:38Z

Though I think we determined that BE bug was actually a front end fix, adjusting where it comes from (not from the cache) right?

I didn't follow this sorry, can you state again @dangrous

dangrous · 2024-09-05T19:04:53Z

I thought that we figured out that this bug was fixed by this and so doesn't need a backend change.

If it does need a backend change, what is it? Sending the personal details for the original account along with the token maybe? I thought that the OpenApp call should fix that...

allgandalf · 2024-09-05T19:11:57Z

I thought that we figured out that #48564 (comment) was fixed by #48564 (comment) and so doesn't need a backend change.

Oh no, that solution was for the first bug reported here.

But i checked again with @DylanDylann this PR and it seems to be resolved:

Screen.Recording.2024-09-06.at.12.40.39.AM.mov

I thought that the OpenApp call should fix that...

I guess it did fix this, we are good to merge then!

dangrous · 2024-09-05T20:07:23Z

Okay great! Yeah that OpenApp takes a bit of time but it gets there. Will review this fully now!

dangrous

one comment change then we're good to go!

dangrous · 2024-09-05T20:08:49Z

src/pages/home/sidebar/AvatarWithDelegateAvatar.tsx

+import ProfileAvatarWithIndicator from './ProfileAvatarWithIndicator';
+
+type AvatarWithDelegateAvatarProps = {
+    /** Emoji status */


Suggested change

/** Emoji status */

/** Original account of delegate */

@DylanDylann is off for the night, i guess you can force push this commit @dangrous ? lets get the ball rolling imo

I think I won't be able to merge if I do that unfortunately, a little wonky but @allgandalf can you add it into your PR? I'll go ahead and merge this as is.

dangrous

Going to fix that comment in another PR, merging this to keep things moving.

OSBotify · 2024-09-05T21:24:03Z

✋ 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 · 2024-09-05T22:13:32Z

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.30-4 🚀

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

DylanDylann added 2 commits September 4, 2024 21:21

add delegate avatar component

531033a

update logic

9677de5

DylanDylann marked this pull request as ready for review September 4, 2024 14:30

DylanDylann requested a review from a team as a code owner September 4, 2024 14:30

melvin-bot bot requested review from rushatgabhane and removed request for a team September 4, 2024 14:30

allgandalf reviewed Sep 4, 2024

View reviewed changes

fix loading bug

7538aef

allgandalf approved these changes Sep 5, 2024

View reviewed changes

melvin-bot bot requested a review from dangrous September 5, 2024 16:19

dangrous requested changes Sep 5, 2024

View reviewed changes

dangrous approved these changes Sep 5, 2024

View reviewed changes

dangrous merged commit 248ae5e into Expensify:main Sep 5, 2024
20 checks passed

allgandalf mentioned this pull request Sep 6, 2024

[feature]: Using the product as a copilot #48594

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add delegate avatar component #48564

Add delegate avatar component #48564

DylanDylann commented Sep 4, 2024 •

edited

Loading

melvin-bot bot commented Sep 4, 2024

allgandalf commented Sep 4, 2024

allgandalf commented Sep 4, 2024

allgandalf commented Sep 4, 2024

allgandalf Sep 4, 2024

allgandalf Sep 4, 2024 •

edited

Loading

allgandalf Sep 4, 2024 •

edited

Loading

dangrous Sep 4, 2024 •

edited

Loading

rushatgabhane Sep 4, 2024

allgandalf commented Sep 4, 2024 •

edited

Loading

DylanDylann commented Sep 4, 2024

dangrous commented Sep 4, 2024

allgandalf commented Sep 4, 2024

dangrous commented Sep 4, 2024 •

edited

Loading

allgandalf commented Sep 4, 2024

DylanDylann commented Sep 5, 2024

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024 •

edited

Loading

allgandalf left a comment

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024 •

edited

Loading

dangrous commented Sep 5, 2024

dangrous left a comment

dangrous Sep 5, 2024 •

edited

Loading

allgandalf Sep 5, 2024

dangrous Sep 5, 2024

allgandalf Sep 6, 2024

dangrous left a comment

OSBotify commented Sep 5, 2024

OSBotify commented Sep 5, 2024

Add delegate avatar component #48564

Add delegate avatar component #48564

Conversation

DylanDylann commented Sep 4, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Sep 4, 2024

allgandalf commented Sep 4, 2024

allgandalf commented Sep 4, 2024

allgandalf commented Sep 4, 2024

BUG:

allgandalf Sep 4, 2024

Choose a reason for hiding this comment

allgandalf Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

allgandalf Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

dangrous Sep 4, 2024 • edited Loading

Choose a reason for hiding this comment

rushatgabhane Sep 4, 2024

Choose a reason for hiding this comment

allgandalf commented Sep 4, 2024 • edited Loading

Another Bug

DylanDylann commented Sep 4, 2024

dangrous commented Sep 4, 2024

allgandalf commented Sep 4, 2024

dangrous commented Sep 4, 2024 • edited Loading

allgandalf commented Sep 4, 2024

DylanDylann commented Sep 5, 2024

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

allgandalf left a comment

Choose a reason for hiding this comment

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024

dangrous commented Sep 5, 2024

allgandalf commented Sep 5, 2024 • edited Loading

dangrous commented Sep 5, 2024

dangrous left a comment

Choose a reason for hiding this comment

dangrous Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

allgandalf Sep 5, 2024

Choose a reason for hiding this comment

dangrous Sep 5, 2024

Choose a reason for hiding this comment

allgandalf Sep 6, 2024

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

OSBotify commented Sep 5, 2024

OSBotify commented Sep 5, 2024

DylanDylann commented Sep 4, 2024 •

edited

Loading

allgandalf Sep 4, 2024 •

edited

Loading

allgandalf Sep 4, 2024 •

edited

Loading

dangrous Sep 4, 2024 •

edited

Loading

allgandalf commented Sep 4, 2024 •

edited

Loading

dangrous commented Sep 4, 2024 •

edited

Loading

allgandalf commented Sep 5, 2024 •

edited

Loading

allgandalf commented Sep 5, 2024 •

edited

Loading

dangrous Sep 5, 2024 •

edited

Loading