Improve report preview action #20941

cristipaval · 2023-06-16T20:36:23Z

Details

This PR handles the avatar and display name for those report actions whose actor is the workspace. This is the case for the report preview when the workspace owes money.

Fixed Issues

$ #21216

Tests

As a non-admin member of a workspace, go to the workspace chat
Request money
Verify that the report preview action has the workspace avatar and display name

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

Same as tests.

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

web.mov

Mobile Web - Chrome

chrome.mobile.mov

Mobile Web - Safari

safari.mobile.mov

Desktop

desktop.mov

iOS

Screen.Recording.2023-06-22.at.01.08.07.mov

Android

android.native.mov

…ce owes money

…rt-preview

… the workspace

melvin-bot · 2023-06-21T14:38:11Z

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

src/pages/home/report/ReportActionItemSingle.js

abdulrahuman5196 · 2023-06-21T19:31:44Z

Did initial testing and the fix is working well. Will continue with reviewers checklist.

Note: The platform videos are unavailable in author's checklist(I am fine if its due to urgent nature of the fix) and kindly check the "Verify that no errors appear in the JS console" in the author's checklist. @cristipaval

Note: Only one issue i noticed is the icon and name of workspace is not updating on the report action alone without refresh. But I think I remember seeing similar issue already being reported sometime before. Not able to find the issue link, but anyways this PR doesn't have to do anything to this issue.

Untitled.2.mp4

abdulrahuman5196 · 2023-06-21T19:41:40Z

Just to note:

Its not just non-admin requests are shown as __fake__, admin requests to workspace is also shown the same and the fix is working for both.

cristipaval · 2023-06-21T19:46:15Z

Note: The platform videos are unavailable in author's checklist(I am fine if its due to urgent nature of the fix) and kindly check the "Verify that no errors appear in the JS console" in the author's checklist. @cristipaval

Aaaah, I missed this. I will record the videos.

Note: Only one issue i noticed is the icon and name of workspace is not updating on the report action alone without refresh. But I think I remember seeing similar issue already being reported sometime before. Not able to find the issue link, but anyways this PR doesn't have to do anything to this issue.

This is a separate issue and I have an open backend PR that adds the pusher updates.

src/pages/home/report/ReportActionItemSingle.js

…orkspace chats

abdulrahuman5196 · 2023-06-21T21:43:53Z

Another issue I am seeing is hover popup is not coming on the display name

Screen.Recording.2023-06-22.at.3.12.26.AM.mov

cristipaval · 2023-06-22T15:40:41Z

Hey, @abdulrahuman5196. I created a follow-up issue for what you reported here.
The reason is that in this case, the implementation supports tooltips with user details only (see here) and I wouldn't enlarge the scope of this PR to add support for tooltips on the report actions whose actor is the workspace.

abdulrahuman5196 · 2023-06-22T16:14:49Z

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-06-22.at.9.31.42.PM.mp4

Mobile Web - Chrome

az_recorder_20230622_213836.mp4

Mobile Web - Safari

Untitled.mp4

Desktop

Screen.Recording.2023-06-22.at.9.43.40.PM.mp4

iOS

Screen.Recording.2023-06-22.at.9.41.43.PM.mp4

Android

az_recorder_20230622_215602.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

🎀👀🎀
C+ Reviewed

All yours. @cristipaval

melvin-bot · 2023-06-22T16:34:21Z

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

abdulrahuman5196 · 2023-06-22T16:34:48Z

Could you also mark the "Verify that no errors appear in the JS console" in authors checklist

cristipaval · 2023-06-22T20:24:06Z

Could you also mark the "Verify that no errors appear in the JS console" in authors checklist

Done.

OSBotify · 2023-06-22T20:29:36Z

✋ 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-06-23T22:17:04Z

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

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

OSBotify · 2023-06-26T20:47:41Z

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

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

Beamanator · 2023-06-29T13:15:45Z

src/pages/home/report/ReportActionItemSingle.js

+    const isWorkspaceActor = ReportUtils.isPolicyExpenseChat(props.report) && !actorAccountID;
+    const actorDetails = props.personalDetailsList[actorAccountID] || {};
+    const displayName = isWorkspaceActor ? ReportUtils.getPolicyName(props.report) : actorDetails.displayName;
+    const actorHint = isWorkspaceActor ? displayName : lodashGet(props.action, 'actorEmail', '').replace(CONST.REGEX.MERGED_ACCOUNT_PREFIX, '');


Quick question @cristipaval : why are we only using displayName if isWorkspaceActor is true here? It looks like we set a displayName no matter what, so can't we just use that as an actorHint no matter what?

I'm working on removing actorEmail from everywhere since we should have actorAccountID everywhere that we have actorEmail - so I'm hoping we can just use displayName here always

yes, displayName would be great. The thing is that this has also to be updated in Web-E as well, here

Groovy!

trueeeee our plan is to basically stop using it in App first, then stop sending from web-e 👍

Show workspace avatar and name for report preview action when workspa…

fc21c08

…ce owes money

cristipaval self-assigned this Jun 16, 2023

cristipaval mentioned this pull request Jun 16, 2023

[HOLD for payment 2023-07-21] Report preview action is not added optimistically when sending money #19119

Closed

cristipaval added 4 commits June 21, 2023 14:22

Merge remote-tracking branch 'origin/main' into cristi_workspace-repo…

9287b19

…rt-preview

don't show the actor name in sidebar when last report action actor is…

38ad14e

… the workspace

Fix tooltip text for report actions where the actor is the workspace

f01a341

Run prettier

fd48471

cristipaval marked this pull request as ready for review June 21, 2023 14:37

cristipaval requested a review from a team as a code owner June 21, 2023 14:37

cristipaval requested review from Julesssss, luacmartins and mountiny June 21, 2023 14:37

melvin-bot bot requested review from PauloGasparSv and removed request for a team June 21, 2023 14:38

cristipaval mentioned this pull request Jun 21, 2023

[HOLD for payment 2023-07-03] __FAKE__ is shown as the actor for the report preview action when requesting money from a workspace #21216

Closed

6 tasks

luacmartins requested changes Jun 21, 2023

View reviewed changes

src/pages/home/report/ReportActionItemSingle.js Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionItemSingle.js Outdated Show resolved Hide resolved

Address feedback after review.

4e0fdcc

cristipaval requested review from abdulrahuman5196 and luacmartins June 21, 2023 18:48

abdulrahuman5196 reviewed Jun 21, 2023

View reviewed changes

src/pages/home/report/ReportActionItemSingle.js Outdated Show resolved Hide resolved

Fix click handler on avatar and display name for report previews in w…

46bf1b9

…orkspace chats

cristipaval mentioned this pull request Jun 22, 2023

[HOLD for payment 2023-08-14] [$1000] Add Tooltip for the report actions whose actor is the workspace #21322

Closed

6 tasks

abdulrahuman5196 approved these changes Jun 22, 2023

View reviewed changes

luacmartins approved these changes Jun 22, 2023

View reviewed changes

cristipaval merged commit 5cbeff6 into main Jun 22, 2023

cristipaval deleted the cristi_workspace-report-preview branch June 22, 2023 20:24

OSBotify mentioned this pull request Jun 24, 2023

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

Closed

45 tasks

Beamanator reviewed Jun 29, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve report preview action #20941

Improve report preview action #20941

cristipaval commented Jun 16, 2023 •

edited

Loading

melvin-bot bot commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023 •

edited

Loading

cristipaval commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023

cristipaval commented Jun 22, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 22, 2023 •

edited

Loading

abdulrahuman5196 left a comment

melvin-bot bot commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

cristipaval commented Jun 22, 2023

OSBotify commented Jun 22, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

Beamanator Jun 29, 2023

cristipaval Jun 29, 2023

Beamanator Jun 29, 2023

Improve report preview action #20941

Improve report preview action #20941

Conversation

cristipaval commented Jun 16, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023 • edited Loading

cristipaval commented Jun 21, 2023

abdulrahuman5196 commented Jun 21, 2023

cristipaval commented Jun 22, 2023 • edited Loading

abdulrahuman5196 commented Jun 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Jun 22, 2023

abdulrahuman5196 commented Jun 22, 2023

cristipaval commented Jun 22, 2023

OSBotify commented Jun 22, 2023

OSBotify commented Jun 23, 2023

OSBotify commented Jun 26, 2023

Beamanator Jun 29, 2023

Choose a reason for hiding this comment

cristipaval Jun 29, 2023

Choose a reason for hiding this comment

Beamanator Jun 29, 2023

Choose a reason for hiding this comment

cristipaval commented Jun 16, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 21, 2023 •

edited

Loading

cristipaval commented Jun 22, 2023 •

edited

Loading

abdulrahuman5196 commented Jun 22, 2023 •

edited

Loading