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

Web - App allows user to open request money link of other user and displays amount page twice #26149

Merged
merged 18 commits into from
Oct 20, 2023

Conversation

dukenv0307
Copy link
Contributor

@dukenv0307 dukenv0307 commented Aug 29, 2023

Details

Web - App allows user to open request money link of other user and displays amount page twice

Fixed Issues

$ #23755
PROPOSAL: #23755 (comment)

Tests

  • Request money with invalid reportID
  1. Open a chat report
  2. Click on the plus icon > Request money
  3. Enter a valid amount and continue
  4. Copy the URL of the confirm page
  5. Paste the URL to composer, edit the reportID param to an invalid value, and send the message
  6. Click on the URL that is sent and verify that the not found page appears
  • The report that cannot create the money request
  1. Open a chat report
  2. Click on the plus icon > Request money
  3. Copy the URL of the selector page
  4. Paste the URL to composer, edit the reportID param to a report that cannot create the request money. i.e. the ID of the group chat or announce room, and send the message
  5. Click on the URL and verify that the not found page appears
  • Request money with global FAB
  1. Go to FAB > Request money
  2. Verify the selector page is displayed without loading
  3. Open the participant page via deep link without entering an amount
  4. Verify that it will reset to the selector page
  5. Repeat step 3 with the confirm page, and merchant page and verify that the result is the same
  • Test the HOC for some other components
  1. Open the report detail page
  2. Edit the URL with an invalid reportID
  3. Verify that after loading, the not found page appears
  4. Repeat the same step with report participant page, report setting page, report share code page
  5. Verify that the result is the same
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  • Request money with invalid reportID
  1. Open a chat report
  2. Click on the plus icon > Request money
  3. Enter a valid amount and continue
  4. Copy the URL of the confirm page
  5. Paste the URL to composer, edit the reportID param to an invalid value, and send the message
  6. Click on the URL that is sent and verify that the not found page appears
  • The report that cannot create the money request
  1. Open a chat report
  2. Click on the plus icon > Request money
  3. Copy the URL of the selector page
  4. Paste the URL to composer, edit the reportID param to a report that cannot create the request money. i.e. the ID of the group chat or announce room, and send the message
  5. Click on the URL and verify that the not found page appears
  • Request money with global FAB
  1. Go to FAB > Request money
  2. Verify the selector page is displayed without loading
  3. Open the participant page via deep link without entering an amount
  4. Verify that it will reset to the selector page
  5. Repeat step 3 with the confirm page, and merchant page and verify that the result is the same
  • Test the HOC for some other components
  1. Open the report detail page
  2. Edit the URL with an invalid reportID
  3. Verify that after loading, the not found page appears
  4. Repeat the same step with report participant page, report setting page, report share code page
  5. Verify that the result is the same
  • 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
  • Request money with invalid reportID
web.3.mp4
  • The report that cannot create the money request
Screencast.from.19-09-2023.15.18.08.webm
  • Request money with global FAB
Screencast.from.19-09-2023.15.37.37.webm
  • Test the HOC for some other components
Screencast.from.19-09-2023.15.44.24.webm
Mobile Web - Chrome - Request money with invalid `reportID`
chrome.mov
  • The report that cannot create the money request
Record_2023-09-19-15-38-43.mp4
  • Request money with global FAB
Record_2023-09-19-15-26-38.mp4
  • Test the HOC for some other components
Record_2023-09-19-15-45-57.mp4
Mobile Web - Safari - Request money with invalid `reportID`
safari.mov
  • The report that cannot create the money request
Screen.Recording.2023-09-19.at.15.32.08.mp4
  • Request money with global FAB
Screen-Recording-2023-09-19-at-15.41.07.mp4
  • Test the HOC for some other components
Screen-Recording-2023-09-19-at-15.47.01.mp4
Desktop - Request money with invalid `reportID`
desktop.mov
  • The report that cannot create the money request
Screen.Recording.2023-09-19.at.15.59.39.mov
  • Request money with global FAB

  • Test the HOC for some other components

Screen-Recording-2023-09-19-at-16.44.31.mp4
iOS - Request money with invalid `reportID`
ios.mov
  • The report that cannot create the money request
Screen.Recording.2023-09-19.at.15.50.35.mp4
  • Request money with global FAB
Screen-Recording-2023-09-19-at-15.52.13.mp4
  • Test the HOC for some other components
Screen.Recording.2023-09-19.at.15.52.55.mp4
Android - Request money with invalid `reportID`
android.mov
  • The report that cannot create the money request
23755-1.webm
  • Request money with global FAB
23755-2.mp4
  • Test the HOC for some other components
223755-3.mp4

@dukenv0307 dukenv0307 marked this pull request as ready for review September 14, 2023 03:35
@dukenv0307 dukenv0307 requested a review from a team as a code owner September 14, 2023 03:35
@melvin-bot melvin-bot bot requested review from sobitneupane and removed request for a team September 14, 2023 03:35
@melvin-bot
Copy link

melvin-bot bot commented Sep 14, 2023

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

@sobitneupane
Copy link
Contributor

@dukenv0307 Let's add test steps for some other components which use withReportOrNotFound. Please add some tests for case of Report Not Found and some for regular flow.

@dukenv0307
Copy link
Contributor Author

@sobitneupane I updated the test step. Do you agree with this? And I will update the screenshots if you agree.

@dukenv0307
Copy link
Contributor Author

@sobitneupane Any update here #26149 (comment).

@sobitneupane
Copy link
Contributor

@dukenv0307 Yup. Test steps look good.

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Sep 19, 2023

@sobitneupane I updated all screenshots. For the case 3 in desktop, because this issue #27085 always happens in desktop, I will update this after this issue is merged.

@sobitneupane
Copy link
Contributor

@sobitneupane I updated all screenshots. For the case 3 in desktop, because this issue #27085 always happens in desktop, I will update this after this issue is merged.

This issue is blocking me from testing. Fortunately, I am assigned to the issue. I will try to get it merged today. After that I will continue the review.

Other than that, @dukenv0307 I'm encountering a 'Not Found' page when attempting to request money from FAB.

@dukenv0307
Copy link
Contributor Author

@sobitneupane Can you share the test step?

@sobitneupane
Copy link
Contributor

@dukenv0307

FAB > Request Money is basically what I did. I might have shared a link of Money Request confirmation page before that.

@sobitneupane
Copy link
Contributor

sobitneupane commented Sep 26, 2023

@dukenv0307 As of now, this PR only solves the issue for /request/new/confirmation but not for /request/new/confirmation/123.

Will the case of /request/new/confirmation/123 handled by this PR? As we are aware of the expected output of the case, can we handle it here? It doesn't look like a complex case.

@dukenv0307
Copy link
Contributor Author

@sobitneupane It's not complex so I think we can handle this here. The root cause is invalid reportID makes report undefined and the app crashes. We only need to make the safe condition here

key: ({report}) => `${ONYXKEYS.COLLECTION.POLICY}${report.policyID}`,

@dukenv0307
Copy link
Contributor Author

@sobitneupane This is fixed in latest main.

@sobitneupane
Copy link
Contributor

@dukenv0307 This issue is still reproducible in my end. Did you get chance to look at it?

Screen.Recording.2023-10-02.at.14.07.17.mov

@dukenv0307
Copy link
Contributor Author

dukenv0307 commented Oct 2, 2023

@sobitneupane This still works well in my end

Screencast.from.02-10-2023.15.33.37.webm

@sobitneupane
Copy link
Contributor

@dukenv0307 Bit surprising, but it's not working on my end. I'm not sure of the exact reason; maybe some beta feature enabled on my account is causing the crash. Could you try it with a highly trafficked account?

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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.

@melvin-bot melvin-bot bot requested a review from dangrous October 5, 2023 10:29
@dukenv0307
Copy link
Contributor Author

@sobitneupane Just updated the code the fix the case in #27113 as well

@dangrous
Copy link
Contributor

dangrous commented Oct 5, 2023

Hi! It looks like this has expanded just a little since the proposal, do you mind giving me a summary of the new ideas? I think the things I noticed are:

  • The new canCreateRequest method and using isAllowedToCreateRequest in MoneyRequestSelectorPage - it sort of feels like this makes the changes to withReportOrNotFound more unnecessary? but I am technically out of office so may have vacation brain :)
  • The isArchived check in MoneyRequestConfirmPage
  • Removing the useEffect from NewRequestAmountPage - is this because it will never be shown due to the canCreateRequest stuff up above?
  • Not a question - does doesRequireReportID or requiresReportID make more sense for our parameter name? isRequireReportID feels strange to me.

Nothing is standing out as bad, but I would love some of the context before doing a full review - thank you!

@dukenv0307
Copy link
Contributor Author

@dangrous

The new canCreateRequest method and using isAllowedToCreateRequest in MoneyRequestSelectorPage - it sort of feels like this makes the changes to withReportOrNotFound more unnecessary? but I am technically out of office so may have vacation brain :)

withReportOrNotFound only checks whether the report can be accessed or exists or not. So we need a special to check whether the existing report that is passed from withReportOrNotFound can create a money request or not. The example case is we access the money request by deeplink with reportID is the id of the admin room

The isArchived check in MoneyRequestConfirmPage

This is another case that is introduced in #27113

Removing the useEffect from NewRequestAmountPage - is this because it will never be shown due to the canCreateRequest stuff up above?

Yes canCreateRequest can cover this case and we will display not found page now instead of dismissing the modal

Not a question - does doesRequireReportID or requiresReportID make more sense for our parameter name? isRequireReportID feels strange to me.

Do you think about shouldRequireReportID

@dukenv0307
Copy link
Contributor Author

@dangrous any thought in my comment above.

@dangrous
Copy link
Contributor

Hi! Sorry, still catching up on stuff. Should be able to look at this shortly.

@dangrous
Copy link
Contributor

Okay, so apologies for all the questions. I have a couple more clarifications. Your explanations up there made sense though!

So in the new logic:

  • If isRequireReportID is true, which is the default, the behavior is exactly the same. So that will be the case for all components except MoneyRequestSelectorPage. Is this correct? Do we need to adjust any of the other Money Request flow pages?
  • When isRequireReportID is false, if there is a reportID in the route, then it goes through the same logic as if isRequireReportID is true. But, it never actually uses the reportID from the route. So wouldn't it always show NotFoundPage?
  • When isRequireReportID is false, if there is NOT a reportID in the route, then it will just show the Wrapped Component. Which in this case would show the MoneyRequestSelectorPage, which in turn shows the FullPageNotFoundView if there is no report. How does this work if the user IS supposed to see the report? Or is there always props.report except when following an incorrect URL like in the initial issue?
  • Should isReportIdInParam really be named that, or is it more accurately isReportIDInRoute (route v param)

I do prefer shouldRequireReportID too.

Tests okay, I'm just still struggling to make sure I understand the code. If you could add some comments in - for me and for future developers - that would be great!

@dukenv0307
Copy link
Contributor Author

If isRequireReportID is true, which is the default, the behavior is exactly the same. So that will be the case for all components except MoneyRequestSelectorPage. Is this correct? Do we need to adjust any of the other Money Request flow pages?

Yes, that will be the case for all components using the HOC now except MoneyRequestSelectorPage. I think we don't need to add the HOC for other money request flow pages because with invalid report or amount is 0, other pages will go back to MoneyRequestSelectorPage page.

When isRequireReportID is false, if there is a reportID in the route, then it goes through the same logic as if isRequireReportID is true. But, it never actually uses the reportID from the route. So wouldn't it always show NotFoundPage?

When isRequireReportID is false, if there is a reportID in the route, the logic will be the same as if isRequireReportID is true, and not found page will be displayed if the reportID is invalid.

When isRequireReportID is false, if there is NOT a reportID in the route, then it will just show the Wrapped Component.

Yes if there is not a reportID in the route, it will just show the Wrapped Component. And in the MoneyRequestSelectorPage, we checked the props.report.reportID is empty, the not found page will not show because the user is creating a money request in global menu.

@dukenv0307
Copy link
Contributor Author

@dangrous Update the variable, and add some comments.

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Thanks for the explanation! This looks good - one last variable change to make it a bit clearer and then I think we're good to merge!

src/pages/home/report/withReportOrNotFound.js Outdated Show resolved Hide resolved
src/pages/home/report/withReportOrNotFound.js Outdated Show resolved Hide resolved
dukenv0307 and others added 2 commits October 20, 2023 22:33
Co-authored-by: Daniel Gale-Rosen <5487802+dangrous@users.noreply.github.com>
Co-authored-by: Daniel Gale-Rosen <5487802+dangrous@users.noreply.github.com>
@dukenv0307
Copy link
Contributor Author

@dangrous updated.

Copy link
Contributor

@dangrous dangrous left a comment

Choose a reason for hiding this comment

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

Sweet!

@dangrous dangrous merged commit bd6a046 into Expensify:main Oct 20, 2023
13 checks passed
@OSBotify
Copy link
Contributor

✋ 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

🚀 Deployed to staging by https://github.com/dangrous in version: 1.3.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.88-11 🚀

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

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.

4 participants