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

fix: Approved expense preview does not show GBR when submitter needs to add a bank account #35486

Merged
merged 23 commits into from
Mar 12, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Jan 31, 2024

Details

Fixed Issues

$ #34278
PROPOSAL: #34278 (comment)

Prerequisite:

  1. Go to default WS on New Dot
  2. Go to setting WS -> Bank Account -> Connect Online with Plaid
  3. Follow the instruction to enable bank account on new dot
  4. Go to Old dot -> create the collect WS
  5. Open the created collect WS
  6. Go to Report
  7. Change the currency to USD
  8. Go to Reimbursement
  9. Change to direct and update Default Business Bank Account to the above bank account
  10. Go to members -> add any members

Tests

  1. Create a money request and submit it to a Collect workspace. Approve and pay as the workspace admin.
  2. Verify that after an expense is approved, the submitting user should see a GBR in the expense preview which prompts them to add a bank account by clicking in to reveal the Add bank account CTA.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Create a money request and submit it to a Collect workspace. Approve and pay as the workspace admin.
  2. Verify that after an expense is approved, the submitting user should see a GBR in the expense preview which prompts them to add a bank account by clicking in to reveal the Add bank account CTA.
  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-02-01.at.16.36.19.mov
Android: mWeb Chrome
Screen.Recording.2024-02-01.at.16.41.21.mov
iOS: Native
Screen.Recording.2024-02-01.at.16.25.45.mov
iOS: mWeb Safari
Screen.Recording.2024-02-01.at.16.37.14.mov
MacOS: Chrome / Safari
web-resize.mp4
MacOS: Desktop
Screen.Recording.2024-02-01.at.15.54.48.mov

@tienifr tienifr marked this pull request as ready for review February 1, 2024 09:08
@tienifr tienifr requested a review from a team as a code owner February 1, 2024 09:08
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team February 1, 2024 09:08
Copy link

melvin-bot bot commented Feb 1, 2024

@cubuspl42 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Feb 13, 2024

@cubuspl42 Sorry for this delay. I'm in Lunar New Year holiday. I'll take a look at it tmr

@tienifr
Copy link
Contributor Author

tienifr commented Feb 14, 2024

Added some feedback

src/libs/ReportUtils.ts Outdated Show resolved Hide resolved
@cubuspl42
Copy link
Contributor

I'm having trouble testing this. Would you post a video including both the admin's and the employee's side? I didn't manage to trigger the "Add bank account" prompt so far.

@tienifr
Copy link
Contributor Author

tienifr commented Feb 21, 2024

@cubuspl42 I just mock the data for testing. You can try:

Onyx.merge('reportActions_5279572281778544', {'5279572281778541':{
  actionName : "REIMBURSEMENTQUEUED",
actorAccountID: 16324969,
automatic: false,
avatar: "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/default-avatar_15.png",
childReportID: 6799068073121782,
childReportNotificationPreference: "hidden",
childType: "chat",
created: "2024-01-31 15:32:56.375",
isAttachment: false,
lastModified: "2024-01-31 15:32:56.375",

message : [
  {
    html: "₫123 request",
isDeletedParentAction: false,
isEdited: false,
reactions: [],
text: "₫123 request",
type: "COMMENT",
whisperedTo: [],
}
  ],
person: [
  {
    style: "strong",
text: "tienifr032022+12346@gmail.com",
type: "TEXT",
  }
  ],
  
  previousReportActionID: "6771885160789988443",
reportActionID: "4570058827618751666",
reportActionTimestamp: 1706715176375,
sequenceNumber: 1,
shouldShow: true,
timestamp: 1706775966,
whisperedToAccountIDs: []

}})

I add the mock report action to render the add bank account button. Of course, we need to update these fields above accordingly

@cubuspl42
Copy link
Contributor

@tienifr

You didn't follow your own testing steps from the "Tests" section. This is not fine. Please don't do that again.

Mocking during final testing is the last resort when testing the actual user scenario is impossible or extremely difficult. Is this such a case?

Please fix this. Update the testing steps if necessary. Re-record the video(s) again at least for one platform, let's say MacOS: Chrome / Safari. Include both sides of the user interaction (admin and non-admin).

@tienifr
Copy link
Contributor Author

tienifr commented Feb 23, 2024

@cubuspl42 I just recorded the video for Mac: Chrome within full steps. I also mocked the report action since I didn't know how to reproduce (maybe we need the Expensify account). Is it fit for you? Thanks

@cubuspl42
Copy link
Contributor

This statement must be true in the context of the Expensify project:

The Contributor, the author of the PR, describes the steps they performed to test that the solution works in the "Tests" section of the PR description. They are the same steps they performed when recording the videos in the "Screenshot/Videos" of the PR description.

Is this news?

Make this true ☝️

Either update the "Tests" steps to match what you actually did (including the mocking details), or actually do what you described in the "Tests" section.

Both options would be better from the current state. The latter would be much preferred. Please clarify how to reproduce the original issue on GH issue/Slack.

@tienifr
Copy link
Contributor Author

tienifr commented Feb 24, 2024

@tienifr
Copy link
Contributor Author

tienifr commented Mar 5, 2024

@cubuspl42 how about your test?

@cubuspl42
Copy link
Contributor

I have a weird issue...

I can't see my Collect Workspace on NewDot Dev (on main / 9c49ab65db3f40e719c75516d5655f11b68c0f87)

image

On staging / prod it is available:

image

Is it some recent change or regression? 🤔

@tienifr
Copy link
Contributor Author

tienifr commented Mar 6, 2024

@cubuspl42 I still can add the collect WS on main. Can you help check it soon?

Screen.Recording.2024-03-06.at.10.53.27.mp4

@cubuspl42
Copy link
Contributor

@cubuspl42 I still can add the collect WS on main. Can you help check it soon?
Screen.Recording.2024-03-06.at.10.53.27.mp4

Oh, I get it. So as I understand it, it's not available anymore in the Workspace Switcher, but can be accessed by searching. Thanks, I'll resume the testing!

@cubuspl42
Copy link
Contributor

Maybe my IQ level is not high enough for this issue.

I can only approve the request from the admin's side:

image

What are your currency settings for your Collect workspace on the OldDot side? Do I understand correctly that you use your local currency?

image

What are you Reimbursement settings for your Collect workspace on the OldDot side?

image

Also, changing currency doesn't work for me on the NewDot side:

image

Maybe a recent regression, I don't know... Not strictly related, but I wanted to test with USD to see if it changes anything.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 8, 2024

Do I understand correctly that you use your local currency?

Yes I use my local currency

What are you Reimbursement settings for your Collect workspace on the OldDot side?

Screenshot 2024-03-08 at 11 45 36

What's your next step? Should we raise it in slack channel to hear some advices?

@cubuspl42
Copy link
Contributor

How are you able to "Pay with Expensify" if the app says that you don't have the "Direct" method enabled or the business bank account connected? Is it expected to work like this?

@cubuspl42
Copy link
Contributor

New Slack thread

@cubuspl42
Copy link
Contributor

  • Conflicts
  • In the Slack thread, we concluded that the "Pay with Expensify" option shouldn't be available for the "Indirect" configuration. Would you re-test, double ensuring that you do that on a branch with a recent main merged-in? There is no need to re-record all videos; the Web platform video will be enough.

If you still observe "Pay with Expensify" on the "Indirect" config, we can report this as a problem/regression in the context of #36814.

I'm sorry to drag you through this, but we need to ensure this is end-to-end tested if possible.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 12, 2024

I'm checking

@tienifr
Copy link
Contributor Author

tienifr commented Mar 12, 2024

@cubuspl42 Pls follow these steps to reproduce

Prerequisite:

  1. Go to default WS on New Dot
  2. Go to setting WS -> Bank Account -> Connect Online with Plaid
  3. Follow the instruction to enable bank account on new dot
  4. Go to Old dot -> create the collect WS
  5. Open the created collect WS
  6. Go to Report
  7. Change the currency to USD
  8. Go to Reimbursement
  9. Change to direct and update Default Business Bank Account to the above bank account
  10. Go to members -> add any members

Test steps:

  1. As the member Create a money request and submit it to a Collect workspace.
  2. Approve and pay as the workspace admin.
  3. Verify that after an expense is approved, the submitting user should see a GBR in the expense preview which prompts them to add a bank account by clicking in to reveal the Add bank account CTA.

Videos:

web-resize.mp4

@tienifr
Copy link
Contributor Author

tienifr commented Mar 12, 2024

I updated video for chrome and Prerequisite steps as well

@tienifr
Copy link
Contributor Author

tienifr commented Mar 12, 2024

Hope this helps and we can merge this PR soon

@cubuspl42
Copy link
Contributor

Thanks for the update! I'm on it.

Hope this helps and we can merge this PR soon

So do I! Still, pushing the working and tested changes is the highest priority

@cubuspl42
Copy link
Contributor

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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(theme.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 the PR modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label so the design team can review the changes.
  • 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

Android: Native
add-bank-account-gbr-android-compressed.mp4
Android: mWeb Chrome
add-bank-account-gbr-android-web-compressed.mp4
iOS: Native
add-bank-account-gbr-ios-compressed.mp4
iOS: mWeb Safari
add-bank-account-gbr-ios-web-compressed.mp4
MacOS: Chrome / Safari
add-bank-account-gbr-web-converted.mp4
MacOS: Desktop

@melvin-bot melvin-bot bot requested a review from blimpich March 12, 2024 10:49
Copy link
Contributor

@blimpich blimpich left a comment

Choose a reason for hiding this comment

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

Looks great!

@blimpich blimpich merged commit 46f1f1e into Expensify:main Mar 12, 2024
17 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/blimpich in version: 1.4.52-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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