Show comment/requests in report preview by Gonals · Pull Request #23651 · Expensify/App

Gonals · 2023-07-26T14:40:42Z

Details

cc @JmillsExpensify, @trjExpensify

Fixed Issues

$ #21178

Tests

Log into your account in newdot
Request money from someone else and add a comment while doing so
Confirm the comment immediately shows in the request:

Request money again from the same person.
Confirm that, instead of the comment, the number of requests show immediately:

Verify that no errors appear in the JS console

Offline tests

Same as tests but offline

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

melvin-bot · 2023-07-26T14:40:47Z

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

abdulrahuman5196 · 2023-07-27T16:51:17Z

@Gonals Is the PR complete for review? We had some commits today as well? Wanted to check if i can start review on the same or wait.

Gonals · 2023-07-31T08:37:04Z

Yes, this should be ready for review

Gonals · 2023-08-02T11:02:54Z

@abdulrahuman5196 bump!

abdulrahuman5196 · 2023-08-02T11:06:22Z

Sorry for the delay. Will review in couple of hours.

abdulrahuman5196 · 2023-08-02T16:07:38Z

@Gonals
Request count is not updated in the preview if a request is deleted, the preview is only updated when the request is added. I assume it has to do with backend(not sure though).

Screen.Recording.2023-08-02.at.9.35.02.PM.mov

Gonals · 2023-08-08T09:50:40Z

@Gonals Request count is not updated in the preview if a request is deleted, the preview is only updated when the request is added. I assume it has to do with backend(not sure though).

Screen.Recording.2023-08-02.at.9.35.02.PM.mov

Nice catch! it is 50-50.

@abdulrahuman5196 I have fixed the frontend here to optimistically update it, but the backend bug remains. Let's ignore it for this PR and I'll fix it in a different issue. Let's see if we can merge today, as I'm OOO staring tomorrow!

abdulrahuman5196 · 2023-08-08T10:31:58Z

@Gonals Got it. I tested now. I think the optimistically updating data is also not complete and in cases I still seeing issues.

Like

Description is not updating in preview if we delete all requests and keep only one request with description

But I am fine with this, given we are planning to create separate bug to address the request count not getting updating on requests deletion/updation. I think it would be best to re-test the optimistic function and backend verification as well in that issue. For now IMO we can keep that deletion/updation is not working properly reflection on the preview.

abdulrahuman5196 · 2023-08-08T11:48:02Z

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-08-08.at.4.12.42.PM.mp4

Mobile Web - Chrome

az_recorder_20230808_163452.mp4

Mobile Web - Safari

Untitled.1.mp4

Desktop

Screen.Recording.2023-08-08.at.4.32.29.PM.mp4

iOS

Screen.Recording.2023-08-08.at.4.36.44.PM.mp4

Android

Screen.Recording.2023-08-08.at.5.12.51.PM.mp4

abdulrahuman5196 · 2023-08-08T11:59:24Z

@Gonals Changes looks good. We have to create 2 issues

Request count/description is not properly updated on request deletion/updation
Request count/description is not updated on workspace chat money requests during addition for any pre-existing workspace. But working fine for new workspaces.

Screen.Recording.2023-08-08.at.4.39.58.PM.mov

abdulrahuman5196

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

All yours. @Gonals

🎀 👀 🎀
C+ Reviewed

melvin-bot · 2023-08-08T12:01:08Z

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

MonilBhavsar · 2023-08-08T12:30:06Z

Do we need to update this function usage to pass comment param https://github.com/Expensify/App/blame/2335cbaf854f236db28cbbc72fa0446a6584d78c/src/libs/actions/IOU.js#L1257

Gonals · 2023-08-08T13:15:17Z

Do we need to update this function usage to pass comment param https://github.com/Expensify/App/blame/2335cbaf854f236db28cbbc72fa0446a6584d78c/src/libs/actions/IOU.js#L1257

Done!

luacmartins · 2023-08-08T16:14:13Z

    const isCurrentUserManager = managerID === lodashGet(props.session, 'accountID');
+    const moneyRequestCount = lodashGet(props.action, 'childMoneyRequestCount', 0);
+    const moneyRequestComment = lodashGet(props.action, 'childLastMoneyRequestComment', '');
+    const showComment = moneyRequestComment || moneyRequestCount > 1;


NAB

Suggested change

const showComment = moneyRequestComment || moneyRequestCount > 1;

const shouldShowComment = moneyRequestComment || moneyRequestCount > 1;

OSBotify · 2023-08-08T17:55: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-08-09T09:11:20Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-09T09:50:03Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.52-0 🚀

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

OSBotify · 2023-08-10T20:08:29Z

🚀 Deployed to production by https://github.com/puneetlath in version: 1.3.52-5 🚀

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

eVoloshchak · 2023-10-02T13:19:36Z

            },
        ],
+        childLastMoneyRequestComment: comment || reportPreviewAction.childLastMoneyRequestComment,
+        childMoneyRequestCount: reportPreviewAction.childMoneyRequestCount + 1,


👋 Coming from #26767
We shouldn't increase childMoneyRequestCount if you selected "Pay Elsewhere"
More details here

Gonals added 3 commits July 26, 2023 12:49

Display comment or money requests

b0109a4

build optimistic report preview correctly

2fbf07c

Optimistically update info

0138260

Gonals requested a review from a team as a code owner July 26, 2023 14:40

Gonals self-assigned this Jul 26, 2023

melvin-bot bot removed the request for review from a team July 26, 2023 14:40

melvin-bot bot requested a review from abdulrahuman5196 July 26, 2023 14:40

Gonals added 5 commits July 26, 2023 16:49

lint

384e441

Merge branch 'main' into alberto-showComment

4efc3b2

Internationalize

26a9c12

fix translation

8940143

prettier

cd7a8f6

conflicts

c3a78de

add param to header

5cad2d7

Gonals added 2 commits August 8, 2023 11:37

conflicts

587cd0e

optimistically reduce the count

a36364e

abdulrahuman5196 approved these changes Aug 8, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar August 8, 2023 12:01

MonilBhavsar previously approved these changes Aug 8, 2023

View reviewed changes

Comment thread src/components/ReportActionItem/ReportPreview.js Outdated

set default

dbecd1a

Gonals dismissed MonilBhavsar’s stale review via dbecd1a August 8, 2023 12:18

MonilBhavsar previously approved these changes Aug 8, 2023

View reviewed changes

handle optional comment

787ad6c

Gonals dismissed MonilBhavsar’s stale review via 787ad6c August 8, 2023 12:44

use ||

f2ac9f7

MonilBhavsar reviewed Aug 8, 2023

View reviewed changes

Comment thread src/libs/ReportUtils.js Outdated

make comment optional

2c0bbc7

luacmartins approved these changes Aug 8, 2023

View reviewed changes

luacmartins merged commit 32326f6 into main Aug 8, 2023

luacmartins deleted the alberto-showComment branch August 8, 2023 17:51

OSBotify mentioned this pull request Aug 9, 2023

Deploy Checklist: New Expensify 2023-08-09 #24307

Closed

87 tasks

melvin-bot bot mentioned this pull request Aug 10, 2023

[HOLD for payment 2023-08-17] Add comment/number of requests to IOUReport display #21178

Closed

eVoloshchak mentioned this pull request Sep 30, 2023

[HOLD for payment 2023-09-29] [$500] Web - 2 requests appears for few seconds on click of pay elsewhere button #26767

Closed

6 tasks

eVoloshchak reviewed Oct 2, 2023

View reviewed changes

parasharrajat mentioned this pull request May 13, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [$250] Optimistic map missing when tracking distance expense #41653

Closed

6 tasks

	const showComment = moneyRequestComment \|\| moneyRequestCount > 1;
	const shouldShowComment = moneyRequestComment \|\| moneyRequestCount > 1;

Conversation

Gonals commented Jul 26, 2023 • edited 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 Jul 26, 2023

Uh oh!

abdulrahuman5196 commented Jul 27, 2023

Uh oh!

Gonals commented Jul 31, 2023

Uh oh!

Gonals commented Aug 2, 2023

Uh oh!

abdulrahuman5196 commented Aug 2, 2023

Uh oh!

abdulrahuman5196 commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Gonals commented Aug 8, 2023

Uh oh!

abdulrahuman5196 commented Aug 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abdulrahuman5196 commented Aug 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

abdulrahuman5196 commented Aug 8, 2023

Uh oh!

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

Uh oh!

melvin-bot bot commented Aug 8, 2023

Uh oh!

Uh oh!

MonilBhavsar commented Aug 8, 2023

Uh oh!

Gonals commented Aug 8, 2023

Uh oh!

Uh oh!

luacmartins Aug 8, 2023

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Aug 8, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 9, 2023

Uh oh!

OSBotify commented Aug 10, 2023

Uh oh!

eVoloshchak Oct 2, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Gonals commented Jul 26, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 2, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 8, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 8, 2023 •

edited

Loading