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

[No QA] Create Money Request Header component #18148

Merged
merged 25 commits into from
May 4, 2023
Merged

Conversation

yuwenmemon
Copy link
Contributor

@yuwenmemon yuwenmemon commented Apr 28, 2023

@mountiny @luacmartins please review

Right now to get this to show I do a couple of things

Web

  1. Find an IOU report, since this has the same structure as the type of report we'll be showing here
  2. Get the reportID for it
  3. Apply this diff:
diff --git a/src/pages/home/ReportScreen.js b/src/pages/home/ReportScreen.js
index df5ba50e62..83aed35fed 100644
--- a/src/pages/home/ReportScreen.js
+++ b/src/pages/home/ReportScreen.js
@@ -39,6 +39,7 @@ import personalDetailsPropType from '../personalDetailsPropType';
 import getIsReportFullyVisible from '../../libs/getIsReportFullyVisible';
 import EmojiPicker from '../../components/EmojiPicker/EmojiPicker';
 import * as EmojiPickerAction from '../../libs/actions/EmojiPickerAction';
+import MoneyRequestHeader from '../../components/MoneyRequestHeader';
 
 const propTypes = {
     /** Navigation route context info provided by react navigation */
@@ -241,6 +242,16 @@ class ReportScreen extends React.Component {
         // (which is shown, until all the actual views of the ReportScreen have been rendered)
         const shouldAnimate = !shouldFreeze;
 
+        const moneyRequestHeader = this.props.report.type === 'iou' && this.props.report.reportID === '5571340985182399'
+            ? <MoneyRequestHeader report={this.props.report} policies={this.props.policies} personalDetails={this.props.personalDetails} />
+            : (<HeaderView
+                reportID={reportID}
+                onNavigationMenuButtonClicked={() => Navigation.navigate(ROUTES.HOME)}
+                personalDetails={this.props.personalDetails}
+                report={this.props.report}
+                policies={this.props.policies}
+            />);
+
         return (
             <ScreenWrapper
                 style={screenWrapperStyle}
@@ -273,13 +284,7 @@ class ReportScreen extends React.Component {
                                     errors={addWorkspaceRoomOrChatErrors}
                                     shouldShowErrorMessages={false}
                                 >
-                                    <HeaderView
-                                        reportID={reportID}
-                                        onNavigationMenuButtonClicked={() => Navigation.navigate(ROUTES.HOME)}
-                                        personalDetails={this.props.personalDetails}
-                                        report={this.props.report}
-                                        policies={this.props.policies}
-                                    />
+                                    {moneyRequestHeader}
                                 </OfflineWithFeedback>
                                 {Boolean(this.props.accountManagerReportID) && ReportUtils.isConciergeChatReport(this.props.report) && this.state.isBannerVisible && (
                                     <Banner
  1. Replace 5571340985182399 with the reportID of your IOU
  2. Navigate to that report in your browser URL, i.e. http://localhost:8080/r/5571340985182399
  3. If you want to test the Expense Report Only Features you can apply this diff
diff --git a/src/libs/ReportUtils.js b/src/libs/ReportUtils.js
index 7aae22feee..0f03fc99d1 100644
--- a/src/libs/ReportUtils.js
+++ b/src/libs/ReportUtils.js
@@ -105,7 +105,7 @@ function getReportParticipantsTitle(logins) {
  * @returns {Boolean}
  */
 function isExpenseReport(report) {
-    return lodashGet(report, 'type') === CONST.REPORT.TYPE.EXPENSE;
+    return true;
 }

Mobile

  1. In addition to the diff above add the following so that every time you click and IOU you load the MoneyRequestHeader instead:
diff --git a/src/components/ReportActionItem/IOUAction.js b/src/components/ReportActionItem/IOUAction.js
index a7fe3f1710..6835776a87 100644
--- a/src/components/ReportActionItem/IOUAction.js
+++ b/src/components/ReportActionItem/IOUAction.js
@@ -67,7 +67,7 @@ const defaultProps = {
 
 const IOUAction = (props) => {
     const launchDetailsModal = () => {
-        Navigation.navigate(ROUTES.getIouDetailsRoute(props.chatReportID, props.action.originalMessage.IOUReportID));
+        Navigation.navigate(ROUTES.getReportRoute(props.action.originalMessage.IOUReportID));
     };
 
     const shouldShowIOUPreview = (
  1. To view the Header, click "Pay" on the IOU preview:

Screenshot 2023-05-01 at 3 56 54 PM

Details

Adds the Money Request Header component into the code so that it can be used in Money Request Flows.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/270587

Tests

  1. Use the instructions above to apply a diff and load an IOU report to display in the header.
  2. Load the header
  3. Click the three dot menu item makes sure it load the menu in the correct spot
  4. On Mobile or any other small screen, make sure that a back button is rendered and that takes you back to the Chat List Menu. On large screens (web and desktop) make sure there is no back button present.

Offline tests

QA Steps

  • No QA - this cannot be as there's no currently logic that loads this component

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 Screenshot 2023-05-01 at 4 14 05 PM
Mobile Web - Chrome

Screenshot 2023-05-01 at 8 47 52 PM

Mobile Web - Safari

Screenshot 2023-05-01 at 9 25 54 PM

Desktop Screenshot 2023-05-01 at 8 08 42 PM

Note: The Header gap here is a different color. This is because the ScreenWrapper component in ReportScreen does not have a background color set and we'll most likely need to pass it in as a prop. However, because we're not showing the component yet I'm not sure this is the time to take care of this - since this exists outside of the component.

iOS Screenshot 2023-05-03 at 3 19 14 PM
Android Screenshot 2023-05-03 at 3 19 32 PM

@yuwenmemon yuwenmemon self-assigned this Apr 28, 2023
@yuwenmemon yuwenmemon changed the title Create Money Request Header component [No QA] Create Money Request Header component May 1, 2023
@yuwenmemon yuwenmemon marked this pull request as ready for review May 1, 2023 22:30
@yuwenmemon yuwenmemon requested a review from a team as a code owner May 1, 2023 22:30
@yuwenmemon yuwenmemon requested review from mountiny and luacmartins May 1, 2023 22:30
@melvin-bot melvin-bot bot requested review from bondydaa and parasharrajat and removed request for a team May 1, 2023 22:30
@MelvinBot
Copy link

@parasharrajat @bondydaa One of you needs to 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]

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Looking good. Left a few comments.

@yuwenmemon yuwenmemon force-pushed the yuwen-moneyRequestHeader branch from b54c13b to a4a9226 Compare May 2, 2023 18:11
@yuwenmemon
Copy link
Contributor Author

@parasharrajat apologies but what error are you getting?

@parasharrajat
Copy link
Member

It was login.toLowerCase related from hashLogin function in ReportUtils.js

@yuwenmemon yuwenmemon dismissed stale reviews from grgia, Julesssss, and luacmartins via eadd538 May 4, 2023 18:44
@yuwenmemon
Copy link
Contributor Author

Okay - @parasharrajat do you want me to do something about it? What are you getting at exactly? I tested and I did see a different JS error which I fixed - but I'm not seeing what you're reporting.

@JmillsExpensify
Copy link

Can we pull out whatever remaining issues we're seeing, get a checklist in this PR, and then merge? Unfortunately this PR holds up a cascading series of downstream PRs for our upcoming conference. I'd love to get this merged and still keep working on whatever issues we're finding separately.

@JmillsExpensify
Copy link

Also for what it's worth, we are going to purposefully break IOUs in the coming week.

@yuwenmemon
Copy link
Contributor Author

yuwenmemon commented May 4, 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 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
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

Copy link
Contributor

@bondydaa bondydaa left a comment

Choose a reason for hiding this comment

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

👍 my one comment is def NAB and is maybe something we consider as we keep iterating on this.

Comment on lines +88 to +101
report: iouReportPropTypes,

/** Policies, if we're showing the details for a report and need info about it for AvatarWithDisplay */
policies: PropTypes.shape({
/** Name of the policy */
name: PropTypes.string,
}),

/** Policies, if we're showing the details for a report and need participant details for AvatarWithDisplay */
personalDetails: PropTypes.objectOf(participantPropTypes),

/** Additional styles to render on the container of this component */
// eslint-disable-next-line react/forbid-prop-types
containerStyles: PropTypes.arrayOf(PropTypes.object),
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB but if these are only used when shouldShowAvatarWithDisplay is true then maybe that's a case for having a completely separate component HeaderWithCloseButtonAndAvavtar or something like that 🤷.

@bondydaa
Copy link
Contributor

bondydaa commented May 4, 2023

Okay I'm merging this, for the other reviews on here if you have outstanding concerns please spin up new issue(s) for them and we can get them addressed then.

@bondydaa bondydaa merged commit 5f649d5 into main May 4, 2023
@bondydaa bondydaa deleted the yuwen-moneyRequestHeader branch May 4, 2023 21:31
@OSBotify
Copy link
Contributor

OSBotify commented May 4, 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.

@parasharrajat
Copy link
Member

parasharrajat commented May 5, 2023

Thanks for merging this. Meanwhile, there is a critical bug #18148 (comment) which should have been solved on this. Should I create a new slack report for it or someone will create a follow up?

@hungvu193
Copy link
Contributor

hungvu193 commented May 5, 2023

I was going to report the issue but then slack conversation leaded me here.
I think this line broke the header.

<View style={[styles.flexRow, styles.flex1]}>

Screenshot 2023-05-05 at 10 39 41

@parasharrajat
Copy link
Member

Yes, I also tried to point out above but it got merged while I was sleeping... 😄

@yuwenmemon
Copy link
Contributor Author

Ah, my b. Will look at this.

@luacmartins
Copy link
Contributor

@yuwenmemon feel free to assign me for review

@JmillsExpensify
Copy link

Yep, our bad.

@OSBotify
Copy link
Contributor

OSBotify commented May 5, 2023

🚀 Deployed to staging by https://github.com/bondydaa in version: 1.3.11-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented May 9, 2023

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.12-0 🚀

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

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Jun 3, 2023

We missed a case here, which led to this issue. More details on the issue

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.