Hide approve/pay buttons if the report contains violations

[abzokhattab]

Details

Fixed Issues

$ https://github.com/Expensify/App/issues/50479 PROPOSAL: https://github.com/Expensify/App/issues/50479#issuecomment-2400712506

Tests

1. Create two accounts: User A and User B.
2. In User A, create a workspace and invite User B.
3. Go to workspace settings > More Features and toggle on the Workflows and Rules options.
4. Go to the workflow page and assign User B as the first approver.
5. Create an expense report with a high amount, ensuring that it triggers a violation, then submit the report for approval.
6. Open the expense report and verify that a violation error is displayed appropriately.
7. In User B's account, go to the submitted expense report and ensure that the Approve button is not visible both in the report preview and the report header.

Offline tests

Same as tests

QA Steps

Same as tests

PR Author Checklist

• [X] I linked the correct issue in the ### Fixed Issues section above
• [X] I wrote clear testing steps that cover the changes made in this PR
  • [X] I added steps for local testing in the Tests section
  • [X] I added steps for the expected offline behavior in the Offline steps section
  • [X] I added steps for Staging and/or Production testing in the QA steps section
  • [X] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
  • [X] 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)
  • [X] 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).
• [X] I included screenshots or videos for tests on all platforms
• [X] I ran the tests on all platforms & verified they passed on:
  • [X] Android: Native
  • [X] Android: mWeb Chrome
  • [X] iOS: Native
  • [X] iOS: mWeb Safari
  • [X] MacOS: Chrome / Safari
  • [X] MacOS: Desktop
• [X] 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)
• [X] I followed proper code patterns (see Reviewing the code)
  • [X] 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)
  • [X] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [X] I verified that comments were added to code that is not self explanatory
  • [X] 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.
  • [X] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [X] 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:
  • [X] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [X] 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)
  • [X] 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.
  • [X] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [X] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [X] I followed the guidelines as stated in the Review Guidelines
• [X] 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)
• [X] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [X] 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
• [X] I verified that if a function's arguments changed that all usages have also been updated correctly
• [X] If any new file was added I verified that:
  • [X] 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
• [X] If a new CSS style is added I verified that:
  • [X] A similar style doesn't already exist
  • [X] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
• [X] 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.
• [X] 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)
• [X] 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.
• [X] 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.
• [X] 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:
  • [X] I verified that all the inputs inside a form are aligned with each other.
  • [X] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [X] 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.
• [X] 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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

[melvin-bot[bot]]

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

[hoangzinh]

Reviewer Checklist

• [x] I have verified the author checklist is complete (all boxes are checked off).
• [x] I verified the correct issue is linked in the ### Fixed Issues section above
• [x] I verified testing steps are clear and they cover the changes made in this PR
  • [x] I verified the steps for local testing are in the Tests section
  • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
  • [x] 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)
  • [x] 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)
• [x] I checked that screenshots or videos are included for tests on all platforms
• [x] I included screenshots or videos for tests on all platforms
• [x] I verified tests pass on all platforms & I tested again on:
  • [x] Android: Native
  • [x] Android: mWeb Chrome
  • [x] iOS: Native
  • [x] iOS: mWeb Safari
  • [x] MacOS: Chrome / Safari
  • [x] MacOS: Desktop
• [x] 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
• [x] I verified proper code patterns were followed (see Reviewing the code)
  • [x] 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).
  • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
  • [x] I verified that comments were added to code that is not self explanatory
  • [x] 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.
  • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
  • [x] 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)
  • [x] 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.
  • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
• [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
• [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
• [x] 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)
• [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
• [x] 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
• [x] If a new component is created I verified that:
  • [x] A similar component doesn't exist in the codebase
  • [x] All props are defined accurately and each prop has a /** comment above it */
  • [x] The file is named correctly
  • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
  • [x] The only data being stored in the state is data necessary for rendering and nothing else
  • [x] 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)
  • [x] 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)
  • [x] All JSX used for rendering exists in the render method
  • [x] 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
• [x] If any new file was added I verified that:
  • [x] 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
• [x] If a new CSS style is added I verified that:
  • [x] A similar style doesn't already exist
  • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
• [x] 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.
• [x] 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)
• [x] 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.
• [x] 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.
• [x] 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:
  • [x] I verified that all the inputs inside a form are aligned with each other.
  • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
• [x] 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.
• [x] 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.
• [x] I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

https://github.com/user-attachments/assets/694a296c-0e75-4e0d-854f-84320b64e6cb

Android: mWeb Chrome

https://github.com/user-attachments/assets/1c5d510e-9c05-40f8-8d6c-859453ca9dc6

iOS: Native

https://github.com/user-attachments/assets/b6685d73-dcf0-4352-ae11-a0db34eb38ad

iOS: mWeb Safari

https://github.com/user-attachments/assets/a3c7f568-5c5a-4c2b-a605-e37380f154e5

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/d78df691-575c-4060-a5e4-b42f0f425235

MacOS: Desktop

https://github.com/user-attachments/assets/bc9c0029-570f-4d21-bf88-eb335d6d48c6

[hoangzinh]

@abzokhattab can you recheck your recordings?

[hoangzinh]

Bug 1: App shows the "Paid" button in the step 7 of Testing steps

[abzokhattab]

@abzokhattab can you recheck your recordings?

oh sorry i needed to insert a new line for the images to render

Bug 1: App shows the "Paid" button in the step 7 of Testing steps

Should we also hide the pay button if there is a violation ?

[hoangzinh]

Sorry for late response, I thought we won't' show pay button until an expense is approved 👀

[abzokhattab]

sorry i missed your comment.

I am trying to reproduce the bug you have but i am not able to ... is there a specific step i am missing?

here is the result with another account

[hoangzinh]

Hi @abzokhattab I finally found it. If you're policy owner/admin and also an approver, then instead of hide both Approve and Paid button, we only hide Approve and show Paid

https://github.com/user-attachments/assets/8849d4bf-66d5-46da-a248-8a280adfb2e6

I think it's related to this logic

https://github.com/Expensify/App/blob/30b0b8d55587810e7ab08f62b5ddbd6ba45a6482/src/libs/actions/IOU.ts#L7102

[abzokhattab]

Good catch!

Thank you, @hoangzinh, for identifying this issue. I’ve disabled the pay button whenever the report contains violations.

[hoangzinh]

Bug 2: App still shows the "Approve" button in the report screen, it will hide when you go to IOU details then go back to the report screen

https://github.com/user-attachments/assets/629e59f0-77be-4b47-9e3a-34dabe4f6803

[hoangzinh]

cc @abzokhattab on the above bug ^

[abzokhattab]

i tried couple of times to reproduce the previous bug but i cannot ... i always get the submit button after submitting the report then after submission no other buttons are shown... is there a step am i missing?

[hoangzinh]

It's not always reproducible @abzokhattab. I'm guessing because the component doesn't subscribe to Onyx allTransactionViolations, and we get allTransactionViolations in the memory of util src/libs/actions/IOU.ts. If there is a gap between the data of allTransactionViolations in the memory is not updated when component is rerender -> it still show the "Approve" btn. What do you think?

[abzokhattab]

i see .. but the thing is i am not able to reproduce it so i cant tell how it could be solved, i always get the submit button after submitting the report unlike your case (the approve btn). is there a specific reproduction step i am missing?

[hoangzinh]

It can be reproducible in native apps (specific Android).

Step to reproduce:

1. [On Android] Sign in as an approver
2. [On Android] Go to Workspace chat
3. [On Web] Sign in as an employee
4. [On Web] Submit expense with violations
5. [On Android] Wait expense request is updated in workspace chat

Example: https://github.com/Expensify/App/pull/51133#issuecomment-2453619882

[abzokhattab]

following those steps i am still not able to reproduce your case.. can you please recheck that its still reproducible?

ios

https://github.com/user-attachments/assets/56c536ae-16d9-455f-a1e8-a5776d9f03b6

android

https://github.com/user-attachments/assets/1adc8358-ced0-4e92-9119-8fc460046173

[hoangzinh]

It's weird that I can still reproduce it in both Android & IOS. Can you confirm if you're logged in as approver in Android/IOS device? Also can you take a step further by go to IOU, then fix error and verify if the Approve button is displayed? Thank you.

https://github.com/user-attachments/assets/e9a25706-7b2c-4c4b-b6ef-c3d5780750cc

[abzokhattab]

Sorry for the late response ... i had an emergency the last few days ...

Yes i am logged in as an approver ... here is the full rerproduction steps starting from creating a workspace and inviting the other user ... please let me know which step is wrong in this case:

https://github.com/user-attachments/assets/87eaa36a-8b65-4636-b551-a155c0c22a79

[hoangzinh]

Hi @abzokhattab can you change to "auto-submit" then in the approver device (mobile device)? And can you go to IOU page and then fix error to see if the approve button appears after resolving all errors?

[abzokhattab]

approve button appears after resolving all errors?

it doesnt appear on main as well... so this change is not the root cause of that ... it appears after resubmitting though.

[hoangzinh]

@abzokhattab with auto submit, on the mobile device, the approver doesn't see "Approve" button with my testing steps here?

[abzokhattab]

i see the approve button appears normally with the auto submit ... can you please point which step is wrong ?

or you can provide a poc for the complete process that i can reproduce it :D

https://github.com/user-attachments/assets/7a0c9eeb-2242-475d-995b-ec482e851c27

[hoangzinh]

@abzokhattab can you turn off "Delay submissions" in your testing workspace? I think it's different between your recording and my testing here. Thank you

[abzokhattab]

I am now able to reproduce it ... i agree we should pass the violations object as a param to the can approve and pay functions..

the bug is fixed on my side after this change ... can you please double check

[hoangzinh]

Looks good. Thanks @abzokhattab I will review today

[Gonals]

There are some conflicts @abzokhattab

[abzokhattab]

thanks @Gonals, i have just resolved the conflicts

[Gonals]

We have conflicts again 😅

[abzokhattab]

ops .. just merged again :D

[OSBotify]

:hand: This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.