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: update next step for approver #42018

Merged
merged 7 commits into from
May 27, 2024
Merged

Conversation

dominictb
Copy link
Contributor

@dominictb dominictb commented May 11, 2024

Details

Fixed Issues

$ #41614
PROPOSAL: #41614 (comment)

Tests

Prerequisite: Have a collect workspace with admin, approver, and employee.

  1. Employee submits report to approver
  2. Approver approves the report
  3. Observe the next step header for approver.
  4. "No further action required!" should be shown for non-payer
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Prerequisite: Have a collect workspace with admin, approver, and employee.

  1. Employee submits report to approver
  2. Approver approves the report
  3. Observe the next step header for approver.
  4. "No further action required!" should be shown for non-payer
  • 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
anative-8MB.mp4
Android: mWeb Chrome
aweb-8MB.mp4
iOS: Native
ina-8MB.mp4
iOS: mWeb Safari
ios-web-8MB.mp4
MacOS: Chrome / Safari
web-8MB.mp4
MacOS: Desktop
desktop-8MB.mp4

@dominictb dominictb marked this pull request as ready for review May 13, 2024 06:13
@dominictb dominictb requested a review from a team as a code owner May 13, 2024 06:13
@melvin-bot melvin-bot bot removed the request for review from a team May 13, 2024 06:13
Copy link

melvin-bot bot commented May 13, 2024

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

@melvin-bot melvin-bot bot requested a review from dukenv0307 May 13, 2024 06:14
@dominictb dominictb requested a review from dukenv0307 May 13, 2024 11:24
@dominictb
Copy link
Contributor Author

@dukenv0307 ready for review again

@dukenv0307
Copy link
Contributor

@dominictb Ah I see, code looks good. I'll start to review in a few hours

@dukenv0307
Copy link
Contributor

dukenv0307 commented May 14, 2024

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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design 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
Screen.Recording.2024-05-14.at.11.38.40.mov
Android: mWeb Chrome
web-resize.mp4
iOS: Native
Screen.Recording.2024-05-14.at.11.37.32.mov
iOS: mWeb Safari
web-resize.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-05-14.at.11.14.08.mov
MacOS: Desktop
Screen.Recording.2024-05-14.at.11.41.31.mov

@dukenv0307
Copy link
Contributor

@dominictb Can you add Prerequisite: Have a collect workspace with admin, approver, and employee. at the beginning of the test steps?

@dukenv0307
Copy link
Contributor

@dominictb @mountiny I found the bug if the approver is admin. Next steps change from Waiting for... to No further.... I believe it's BE bug since admin still can pay the request.

web-resize.mp4

@mountiny
Copy link
Contributor

@dukenv0307 even after signing out and back/ opening the report again, does the backend return "no further action" for that report? It might be because of a reimburser set up, maybe.

Is the approver, the admin and the submitter the same user?

Can you please list out these steps in a numbered list where you saw this bug?

@dukenv0307
Copy link
Contributor

@mountiny

Prerequisite: Have a collect workspace with admin, approver, and employee. Approver and admin is the same user, submitter is someone else

  1. Employee submits report to approver
  2. Approver approves the report
  3. Observe the next step header for approver.
  4. Next steps change from Waiting for... to No further...

@dominictb
Copy link
Contributor Author

@dukenv0307 I mean if the approver (admin) clicks on Pay button, he can still pay the report right?

@dukenv0307
Copy link
Contributor

@dominictb Yes, the approver (admin) can pay the request

Screen.Recording.2024-05-15.at.10.14.57.mov

@dominictb
Copy link
Contributor Author

@mountiny what do u think in this case?

@dominictb
Copy link
Contributor Author

@mountiny could we have someone on the BE team to check this case mentioned by @dukenv0307?

@mountiny mountiny self-requested a review May 20, 2024 08:34
@mountiny
Copy link
Contributor

@dominictb @dukenv0307 I think we have to fix this in scope fo this issue as basically we are just moving this problem along the chain.

When the user is an approver and admin at the same time, after approving the report, the next steps should instruct them to pay the report as the next step.

@dukenv0307 can you confirm what is returned from the backend as the next step in this case (approver/ admin is the same user) and admin approves the report first without paying

@dukenv0307
Copy link
Contributor

will give an update in a hour

@dukenv0307
Copy link
Contributor

@mountiny @dominictb BE return title: Finished! after approver( is admin as well) approve the request.

Screenshot 2024-05-21 at 10 56 15

@mountiny
Copy link
Contributor

Cool in that case I think we can go ahead with this PR

@dukenv0307
Copy link
Contributor

Thanks @mountiny. Code looks good and tests well, we're go to merge

@dominictb
Copy link
Contributor Author

@mountiny pls help approve and merge this one. Thanks!

@mountiny mountiny changed the title fix: update next step for approver [HOLD merge freeze] fix: update next step for approver May 22, 2024
@dominictb
Copy link
Contributor Author

@mountiny let's merge this PR. Thanks!

@dukenv0307
Copy link
Contributor

@mountiny It shouldn't be held by merge freeze

@mountiny mountiny changed the title [HOLD merge freeze] fix: update next step for approver fix: update next step for approver May 27, 2024
Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Thanks

@mountiny mountiny merged commit 63a20f4 into Expensify:main May 27, 2024
15 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/mountiny in version: 1.4.77-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.77-11 🚀

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