Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement details page for expense/iouReport #24533

Merged
merged 23 commits into from
Oct 3, 2023

Conversation

fedirjh
Copy link
Contributor

@fedirjh fedirjh commented Aug 14, 2023

Details

In this PR, we have implemented the details page for the IOU reports. :

UI

image

Fixed Issues

$ #19342
#19342 (comment)

Tests

Test 1: IOU Report

  1. Request money from user B as user A
  2. Navigate to the money request report as user A
  3. Click on the avatar in the header of the IOU Report.
  4. Verify that the Details page is opened
  5. Verify that the share code, members, and setting pages work
  6. Verify that the design matches the above UI design
  7. As user B, navigate to the same iou report
  8. Verify the same steps 3 -> 6
  9. Verify that only user A and user B can access the details page.

Test 2: Expense Report

  1. As user A, create a new workspace Workspace A and invite user B
  2. As user B, request money from Workspace A
  3. Navigate to the money expense report as user A
  4. Click on the avatar in the header of the Expense Report.
  5. Verify that the Details page is opened
  6. Verify that the share code, members, and setting pages work
  7. Verify that the design matches the above UI design
  8. As user B, navigate to the same expense report
  9. Verify the same steps 4 -> 7
  10. Verify that only user A and user B can access the details page.
  • Verify that no errors appear in the JS console

Offline tests

Same Tests

QA Steps

Same 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web Screenshot 2023-08-14 at 2 22 18 PM Screenshot 2023-08-14 at 2 22 23 PM Screenshot 2023-08-14 at 2 22 28 PM Screenshot 2023-08-14 at 5 37 28 PM Screenshot 2023-08-14 at 5 37 32 PM Screenshot 2023-08-14 at 5 37 37 PM Screenshot 2023-08-14 at 5 37 52 PM Screenshot 2023-08-14 at 5 37 58 PM Screenshot 2023-08-14 at 5 38 05 PM
Mobile Web - Chrome Screenshot 2023-08-14 at 11 36 11 PM Screenshot 2023-08-14 at 11 36 21 PM Screenshot 2023-08-14 at 11 36 26 PM Screenshot 2023-08-14 at 11 37 26 PM Screenshot 2023-08-14 at 11 37 42 PM Screenshot 2023-08-14 at 11 48 01 PM
Mobile Web - Safari Screenshot 2023-08-14 at 11 14 33 PM Screenshot 2023-08-14 at 11 14 39 PM Screenshot 2023-08-14 at 11 14 43 PM
Desktop Screenshot 2023-08-14 at 11 16 40 PM Screenshot 2023-08-14 at 11 16 44 PM Screenshot 2023-08-14 at 11 16 48 PM Screenshot 2023-08-14 at 11 17 29 PM Screenshot 2023-08-14 at 11 17 34 PM Screenshot 2023-08-14 at 11 17 37 PM
iOS Screenshot 2023-08-14 at 11 12 06 PM Screenshot 2023-08-14 at 11 12 11 PM Screenshot 2023-08-14 at 11 12 23 PM Screenshot 2023-08-14 at 11 12 55 PM Screenshot 2023-08-14 at 11 13 06 PM Screenshot 2023-08-14 at 11 13 14 PM
Android Screenshot 2023-08-15 at 12 06 29 AM Screenshot 2023-08-15 at 12 06 36 AM Screenshot 2023-08-15 at 12 06 42 AM Screenshot 2023-08-15 at 12 06 58 AM Screenshot 2023-08-15 at 12 07 04 AM

@fedirjh
Copy link
Contributor Author

fedirjh commented Aug 16, 2023

cc @grgia Could you please help review this PR?

@fedirjh
Copy link
Contributor Author

fedirjh commented Aug 18, 2023

Hey @Expensify/contributor-plus, I need another C+ to test/review this PR.

@allroundexperts
Copy link
Contributor

I can review.

@mountiny
Copy link
Contributor

@fedirjh Can you please add to the test steps:

  • creating expense report hence request from a workspace and clicking on those details
  • accessing the details page as payee and payer / employee and employer
  • accessing the page with a url as user who does not have access - handled this gracefully.

Thank you!

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 18, 2023

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
Screen.Recording.2023-08-31.at.4.09.01.PM.mov
Mobile Web - Chrome
Screen.Recording.2023-08-31.at.4.16.03.PM.mov
Mobile Web - Safari
Screen.Recording.2023-08-31.at.4.11.08.PM.mov
Desktop
Screen.Recording.2023-08-31.at.4.20.47.PM.mov
iOS
Screen.Recording.2023-08-31.at.4.14.30.PM.mov
Android
Screen.Recording.2023-08-31.at.4.17.20.PM.mov

@allroundexperts
Copy link
Contributor

BUG

  1. Go offline.
  2. Create a IOU report.
  3. Open the details screen (RHP)
  4. Click on Settings.

The app crashes.

Screen.Recording.2023-08-18.at.8.38.19.PM.mov

@fedirjh
Copy link
Contributor Author

fedirjh commented Aug 19, 2023

Can you please add to the test steps

Tests are updated.

cc @allroundexperts The crash is fixed.

@mountiny
Copy link
Contributor

@allroundexperts Ready for another look

@allroundexperts
Copy link
Contributor

On my list for today!

@allroundexperts
Copy link
Contributor

Hi @fedirjh,
Can you please resolve the conflicts?

@allroundexperts

This comment was marked as resolved.

@mountiny
Copy link
Contributor

Thanks for great work, I think we can leave this one on hold for after the conferences

grgia
grgia previously approved these changes Sep 1, 2023
Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

code looks good, just a question about tests!

src/components/MultipleAvatars.js Show resolved Hide resolved
@grgia
Copy link
Contributor

grgia commented Sep 12, 2023

@fedirjh looks like we need to merge main 😁

@grgia
Copy link
Contributor

grgia commented Sep 26, 2023

What is this holding on?

@allroundexperts
Copy link
Contributor

I think this was held for the conference.

@trjExpensify
Copy link
Contributor

Can we remove Hold in the title then? Let's fix those conflicts and get this shipped!

@trjExpensify trjExpensify changed the title [HOLD] Implement details page for expense/iouReport Implement details page for expense/iouReport Sep 26, 2023
@fedirjh
Copy link
Contributor Author

fedirjh commented Sep 26, 2023

I have resolved conflicts with the main. should be ready to get merged.

cc @allroundexperts @grgia

@fedirjh
Copy link
Contributor Author

fedirjh commented Sep 29, 2023

Bump !!

@allroundexperts
Copy link
Contributor

allroundexperts commented Oct 1, 2023

BUG
Empty private notes showing up when requesting money from a workspace (whom you're not an admin of)

Screen.Recording.2023-10-02.at.1.45.36.AM.mov

@allroundexperts
Copy link
Contributor

Another possible issue is that the list of members show workspace owner as a member as well. Do we want to do that?

Screenshot 2023-10-02 at 1 48 00 AM

@fedirjh
Copy link
Contributor Author

fedirjh commented Oct 2, 2023

Empty private notes showing up when requesting money from a workspace (whom you're not an admin of)

Fixed. Removed the private notes from the details page for expense reports.

Another possible issue is that the list of members show workspace owner as a member as well. Do we want to do that?

@allroundexperts It should display both the payer and the payee. In the case of user-created Workspaces, it is reasonable to expect that the owner will be the payer.

Copy link
Contributor

@grgia grgia left a comment

Choose a reason for hiding this comment

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

Code looks good, some minor comments. I'll hold on approving/merging until @allroundexperts takes a look

src/components/MultipleAvatars.js Show resolved Hide resolved
src/libs/ReportUtils.js Show resolved Hide resolved
Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Looks good!

@melvin-bot melvin-bot bot requested a review from grgia October 2, 2023 15:49
@grgia grgia merged commit d4746a8 into Expensify:main Oct 3, 2023
19 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Oct 3, 2023

✋ 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
Copy link
Contributor

OSBotify commented Oct 3, 2023

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.77-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Oct 5, 2023

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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

@fedirjh fedirjh deleted the Implment_Details_Page_For_IOU branch October 5, 2023 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants