Add prohibited expense feature by AndrewGable · Pull Request #56550 · Expensify/App

AndrewGable · 2025-02-07T19:38:54Z

Explanation of Change

held on https://github.com/Expensify/Web-Expensify/pull/45470

Adds the ability to configure prohibited expenses as a workspace rule.

Tests

Verify that by default there are no prohibited expenses enabled
Verify that when there are no prohibited expenses enabled, the value says None
Verify that when toggling a prohibited expense, the value says the prohibited one
(If you have the ability to SmartScan - locally or on staging)
Upload a receipt with a prohibited line item (e.g. a beer)
Prohibit that expense category
Confirm you get a violation listed under the receipt image
Disable that prohibited expense
Confirm the violation is removed as well.

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

Same as tests

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.
I verified that similar component doesn't exist in the codebase
I verified that all props are defined accurately and each prop has a /** comment above it */
I verified that each file is named correctly
I verified that each component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
I verified that the only data being stored in component state is data necessary for rendering and nothing else
In component 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)
I verified that component 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)
I verified that all JSX used for rendering exists in the render method
I verified that each 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

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2025-02-07T22:02:58Z

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

dubielzyk-expensify · 2025-02-07T22:11:49Z

Looks great 😄 If I were to nitpick I'd say have sentence case for the toggles...

dannymcclain · 2025-02-07T22:14:19Z

+1! James will come after you if you don't sentence case it 😂

Alcohol
Hotel incidentals
Gambling
Tobacco
Adult entertainment

shawnborton · 2025-02-07T22:25:53Z

Agree with the previous comments, and wow this is a cool feature!!

dangrous · 2025-02-07T22:37:42Z

+                alcohol: 'Alcohol',
+                hotelIncidentals: 'Hotel Incidentals',
+                gambling: 'Gambling',
+                tobacco: 'Tobacco',


on the backend we're doing drugsAndTobacco but could change it.

(update - i just updated the BE to be just tobacco)

AndrewGable · 2025-02-07T23:06:17Z

Updated casing and alphabetized order for toggles

carlosmiceli · 2025-02-13T02:37:32Z

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 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.ts 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

dangrous · 2025-03-10T14:27:47Z

Web-E PR is in final review so we should be good to move on this one soon, thanks for your patience.

dangrous · 2025-03-17T14:26:11Z

web-e is merged, just waiting on deploy then I'll update the conflicts and we should be good to go!

dangrous · 2025-03-18T18:44:08Z

eyyy we're deployed. Will aim to fix this up for final review today

trjExpensify · 2025-03-19T00:20:33Z

Out of curiosity, are there issues for the below for this new feature?

Add regression tests for QA
Update resources to document the feature in NewDot help pages, useDot etc
Announce the release of the feature (vendor comms, external announcement GTM etc)

dangrous · 2025-03-19T00:29:36Z

@trjExpensify I think we're still a ways away from that so not yet, as far as I know. This is more for an internal demo to go along with the predesign @MitchExpensify is about to run

dangrous · 2025-03-19T00:30:09Z

fixed conflicts, retested. Looking good to me!

trjExpensify · 2025-03-19T01:17:04Z

@trjExpensify I think we're still a ways away from that so not yet, as far as I know. This is more for an internal demo to go along with the predesign @MitchExpensify is about to run

Ah cool okay, so it's behind a beta and those items will be taken care of in a more formal project tracker at some point before removing said beta? 👍

dangrous · 2025-03-19T13:48:46Z

yep, exactly!

dangrous · 2025-03-21T15:40:33Z

conflicts resolved - ready for a final look/merge @carlosmiceli, thanks! (I can't unassign myself as a reviewer for some reason but since I wrote part of this I can't review, it's all you!)

OSBotify · 2025-03-21T16:58:07Z

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

kavimuru · 2025-03-21T22:34:54Z

@AndrewGable If our QA team does not have a receipt with prohibited expense category, could you share any receipt?

github-actions · 2025-03-21T22:43:58Z

🚀 Deployed to staging by https://github.com/carlosmiceli in version: 9.1.17-0 🚀

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

dangrous · 2025-03-24T14:11:40Z

@kavimuru I can take care of testing for this! Just waiting for the beta to register on my test account

dangrous · 2025-03-24T15:19:38Z

tests well @kavimuru!

github-actions · 2025-03-24T21:14:27Z

🚀 Deployed to production by https://github.com/cristipaval in version: 9.1.17-1 🚀

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

rayane-d · 2025-05-06T11:47:08Z

            return message;
        },
+        prohibitedExpense: ({prohibitedExpenseType}: ViolationsProhibitedExpenseParams) => {
+            const preMessage = 'Prohibited Expense: ';


Hi!, coming from #60216 (BugZero Checklist), the copy has capitalization errors.

AndrewGable added 14 commits February 7, 2025 11:38

Add alcohol and hotel incidentals as prohibited expenses

ce32a0e

Fix type errors and add API commands

1745cf3

Update switch on name

eab99cf

Add spanish

3566d1a

Add more types

cbe5404

Fixing more lint

caddee5

Add api types

a1bc562

Fix more lint

ba86262

Merge branch 'main' into smarterscan

6b7d9c5

Remove duplicate row

6bb05f8

Fix string bug

e04647b

Remove unused variable

3c6c4fd

Add ;

f90daf6

Change submodule

a90247d

AndrewGable marked this pull request as ready for review February 7, 2025 22:02

AndrewGable requested review from a team as code owners February 7, 2025 22:02

AndrewGable self-assigned this Feb 7, 2025

AndrewGable requested review from dangrous and johnmlee101 February 7, 2025 22:02

melvin-bot Bot requested a review from carlosmiceli February 7, 2025 22:02

melvin-bot Bot removed the request for review from a team February 7, 2025 22:02

dangrous reviewed Feb 7, 2025

View reviewed changes

AndrewGable added 2 commits February 7, 2025 14:59

Tweak casing of items

38fd924

Alphabatize all items

528609b

dangrous added 2 commits February 12, 2025 16:15

prettier

39cdd2f

fix type errors

ebc1bee

dangrous removed the request for review from johnmlee101 February 13, 2025 00:27

carlosmiceli previously approved these changes Feb 13, 2025

View reviewed changes

dangrous changed the title ~~[HOLD Web-E#45470] Add prohibited expense feature~~ Add prohibited expense feature Mar 18, 2025

merge conflicts

94dd8d9

dangrous dismissed carlosmiceli’s stale review via 94dd8d9 March 19, 2025 00:29

merge conflicts

3677d8f

carlosmiceli approved these changes Mar 21, 2025

View reviewed changes

carlosmiceli merged commit 803df86 into main Mar 21, 2025

carlosmiceli deleted the smarterscan branch March 21, 2025 16:49

github-actions Bot mentioned this pull request Mar 21, 2025

Deploy Checklist: New Expensify 2025-03-21 #58928

Closed

65 tasks

layacat mentioned this pull request Mar 22, 2025

[Due for payment 2025-04-14] [$250] iOS - Rules - Prohibited expenses - Offline indicator is not at the page bottom #58931

Closed

8 tasks

rayane-d reviewed May 6, 2025

View reviewed changes

Conversation

AndrewGable commented Feb 7, 2025 • edited by dangrous Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Feb 7, 2025

Uh oh!

dubielzyk-expensify commented Feb 7, 2025

Uh oh!

dannymcclain commented Feb 7, 2025

Uh oh!

shawnborton commented Feb 7, 2025

Uh oh!

dangrous Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

dangrous Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

AndrewGable commented Feb 7, 2025

Uh oh!

carlosmiceli commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

dangrous commented Mar 10, 2025

Uh oh!

dangrous commented Mar 17, 2025

Uh oh!

dangrous commented Mar 18, 2025

Uh oh!

trjExpensify commented Mar 19, 2025

Uh oh!

dangrous commented Mar 19, 2025

Uh oh!

dangrous commented Mar 19, 2025

Uh oh!

trjExpensify commented Mar 19, 2025

Uh oh!

dangrous commented Mar 19, 2025

Uh oh!

dangrous commented Mar 21, 2025

Uh oh!

OSBotify commented Mar 21, 2025

Uh oh!

kavimuru commented Mar 21, 2025

Uh oh!

github-actions Bot commented Mar 21, 2025

Uh oh!

dangrous commented Mar 24, 2025

Uh oh!

dangrous commented Mar 24, 2025

Uh oh!

github-actions Bot commented Mar 24, 2025

Uh oh!

rayane-d May 6, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

AndrewGable commented Feb 7, 2025 •

edited by dangrous

Loading

carlosmiceli commented Feb 13, 2025 •

edited

Loading