Skip to content

Refactor getViolationTranslation to use options object#86463

Merged
neil-marcellini merged 6 commits intomainfrom
claude-refactorGetViolationTranslationOptionsObject
Apr 7, 2026
Merged

Refactor getViolationTranslation to use options object#86463
neil-marcellini merged 6 commits intomainfrom
claude-refactorGetViolationTranslationOptionsObject

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

@MelvinBot MelvinBot commented Mar 26, 2026 •
edited
Loading

Explanation of Change

Refactors getViolationTranslation() to accept a single ViolationTranslationParams object instead of separate positional parameters (violation, translate, options?). All parameters — including violation and translate — are now part of one named-property object, consistent with the params-object pattern used elsewhere in the codebase. This makes call sites more readable and makes it easier to add new parameters in the future.

Fixed Issues

$ #86335

Tests

This is a pure refactor with no behavioral changes. All call sites pass the same values via named properties.

Setup — trigger a "missing category" violation:

  1. Go to Settings > Workspaces and create a new workspace (or use an existing one)
  2. Go to Categories in the workspace settings and enable Members must categorize expenses
  3. Go to the workspace chat and create a new expense (tap + > Submit expense)
  4. Enter an amount (e.g. $25) and submit the expense without selecting a category

Verify violations display correctly:
5. Open the submitted expense — you should see a red "Missing category" violation message on the expense detail view
6. Go back to the chat — the report should show a red brick road (RBR) indicator
7. Tap the RBR to open the report and confirm the violation message is visible in the report header area
8. Verify that no errors appear in the JS console

Offline tests

N/A — this is a code-only refactor that doesn't change runtime behavior or network interactions.

QA Steps

Setup — trigger a "missing category" violation:

  1. Go to Settings > Workspaces and create a new workspace (or use an existing one)
  2. Go to Categories in the workspace settings and enable Members must categorize expenses
  3. Go to the workspace chat and create a new expense (tap + > Submit expense)
  4. Enter an amount (e.g. $25) and submit the expense without selecting a category

Verify violations display correctly:
5. Open the submitted expense — you should see a red "Missing category" violation message on the expense detail view
6. Go back to the chat — the report should show a red brick road (RBR) indicator
7. Tap the RBR to open the report and confirm the violation message is visible in the report header area
8. Verify that no errors appear in the JS console related to violations

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
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native

N/A — pure refactor, no UI changes

Android: mWeb Chrome

N/A — pure refactor, no UI changes

iOS: Native

N/A — pure refactor, no UI changes

iOS: mWeb Safari

N/A — pure refactor, no UI changes

MacOS: Chrome / Safari

N/A — pure refactor, no UI changes

@MelvinBot @neil-marcellini
Refactor getViolationTranslation to accept options object instead of …
a8d2871 
…positional params

Replace 8 positional parameters with a ViolationTranslationOptions object,
eliminating undefined fillers at call sites and improving readability.

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team March 26, 2026 16:24
@MelvinBot MelvinBot mentioned this pull request Mar 26, 2026
Open
neil-marcellini and others added 2 commits April 3, 2026 11:40
@neil-marcellini
Merge remote-tracking branch 'origin/main' into claude-refactorGetVio…
caf25a3 
…lationTranslationOptionsObject

Made-with: Cursor
@MelvinBot @neil-marcellini
Fix: update ViolationUtilsTest to use options object signature
2741620 
The test file was still calling getViolationTranslation with the old
positional parameters instead of the new ViolationTranslationOptions
object, causing TypeScript errors.

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

MelvinBot commented Apr 3, 2026

Fixed the failing typecheck: updated tests/unit/ViolationUtilsTest.ts to use the new ViolationTranslationOptions object signature instead of the old positional parameters.

@codecov
Copy link
Copy Markdown

codecov bot commented Apr 3, 2026 •
edited by github-actions bot
Loading

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
...nents/ReportActionItem/MoneyRequestReceiptView.tsx 70.07% <ø> (ø)
...m/TransactionPreview/TransactionPreviewContent.tsx 77.08% <ø> (ø)
src/components/ViolationMessages.tsx 0.00% <ø> (ø)
src/libs/Violations/ViolationsUtils.ts 75.39% <100.00%> (ø)
...c/components/ReportActionItem/MoneyRequestView.tsx 65.88% <0.00%> (ø)
... and 12 files with indirect coverage changes

@neil-marcellini
Refactor getViolationTranslation to use a single params object
0cee25d 
Replace the (violation, translate, options?) signature with a single
ViolationTranslationParams object containing all parameters, consistent
with other functions in the codebase that use params objects.

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
Made-with: Cursor
@neil-marcellini
Copy link
Copy Markdown
Contributor

neil-marcellini commented Apr 3, 2026

@MelvinBot please test this PR following the test steps in the description. Trigger a missing category violation by creating an expense without a category in a workspace that requires categories, then verify the violation message displays correctly on the expense view and the RBR shows on the report.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

MelvinBot commented Apr 3, 2026

🤖 Test Results: All checks passed ✅

I tested this PR on web by triggering a "Missing category" violation. Here are the results:

Check Status
"Members must categorize expenses" enabled in workspace ✅ Pass
Expense submitted without a category ✅ Pass
"Missing category" violation message on expense detail view ✅ Pass
RBR indicator on report in chat sidebar ✅ Pass
No violation-related JS console errors ✅ Pass

Screenshots:

Chat view — RBR "Fix" indicator in sidebar + "Missing category" on expense card:
Chat view showing RBR Fix indicator and Missing category violation

Expense detail view — "Missing category." violation text in red:
Expense detail view showing Missing category violation text in red

All console errors were pre-existing infrastructure issues (DNS resolution, React prop warnings) — none related to getViolationTranslation() or violation rendering.

@neil-marcellini neil-marcellini marked this pull request as ready for review April 3, 2026 22:16
@neil-marcellini neil-marcellini requested a review from a team as a code owner April 3, 2026 22:16
@melvin-bot melvin-bot bot requested review from heyjennahay and jjcoffee April 3, 2026 22:16
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 3, 2026

@jjcoffee 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 removed request for a team April 3, 2026 22:16
carlosmiceli
carlosmiceli previously approved these changes Apr 4, 2026
View reviewed changes
@jjcoffee
Copy link
Copy Markdown
Contributor

jjcoffee commented Apr 7, 2026 •
edited
Loading

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • 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: HybridApp
android-app-2026-04-07_11.29.58.mp4
Android: mWeb Chrome
android-chrome-2026-04-07_11.31.50.mp4
iOS: HybridApp
ios-app-2026-04-07_11.23.32.mp4
iOS: mWeb Safari
ios-safari-2026-04-07_11.24.50.mp4
MacOS: Chrome / Safari
desktop-chrome-2026-04-07_11.20.18.mp4

@jjcoffee
Copy link
Copy Markdown
Contributor

jjcoffee commented Apr 7, 2026

@MelvinBot Please fill out the QA steps. I don't think this should be No QA as it could potentially cause regressions, even though it's just a refactor.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

MelvinBot commented Apr 7, 2026

Updated the QA steps in the PR description. The steps cover triggering a "missing category" violation and verifying the violation message displays correctly on the expense detail view, RBR indicator, and report header.

jjcoffee
jjcoffee approved these changes Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jjcoffee jjcoffee left a comment

Choose a reason for hiding this comment

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

LGTM!

@melvin-bot melvin-bot bot requested a review from neil-marcellini April 7, 2026 09:33
@neil-marcellini
Merge main and resolve conflict in ViolationUtilsTest
1e73ed1 
Keep the options object style for brokenCardConnection530 test that
main added with positional params, matching this PR's refactor.

Made-with: Cursor
@neil-marcellini neil-marcellini requested a review from a team as a code owner April 7, 2026 15:58
@melvin-bot melvin-bot bot requested review from dukenv0307 and removed request for a team April 7, 2026 15:58
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 7, 2026

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

@MelvinBot @neil-marcellini
Fix typecheck: use positional args for translateLocal('violations.rte…
bd4f4a3 
…r') in test

Co-authored-by: Neil Marcellini <neil-marcellini@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

MelvinBot commented Apr 7, 2026

Fixed the failing typecheck: the test was calling translateLocal('violations.rter', {...}) with an object argument, but the rter translation function takes positional parameters. Updated both calls at lines 1373 and 1381 to use positional arguments.

@neil-marcellini neil-marcellini merged commit 4362d1c into main Apr 7, 2026
31 checks passed
@neil-marcellini neil-marcellini deleted the claude-refactorGetViolationTranslationOptionsObject branch April 7, 2026 16:56
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

🚧 @neil-marcellini has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 7, 2026

🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
Built from App PR #86463.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-android-Adhoc-4362d1c-c55fd38-c6ee6fd7f772485045f1c85b226ef1659ba3dbd6/index.html https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-ios-device-AdHoc-4362d1c-c55fd38-3e8921ae0c4155aa2d3e4412d8a82759cd2dc8b8/index.html
Android iOS
Web 🕸️
https://86463.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 7, 2026

✋ 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 OSBotify mentioned this pull request Apr 7, 2026
Closed
97 tasks
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 8, 2026

🚀 Deployed to staging by https://github.com/neil-marcellini in version: 9.3.54-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor Author

MelvinBot commented Apr 8, 2026

No help site changes are required. This PR is a pure internal code refactor (changing getViolationTranslation() from positional parameters to a named options object) with no changes to user-facing behavior, UI, terminology, or workflows.

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 9, 2026

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.54-7 🚀

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carlosmiceli carlosmiceli carlosmiceli approved these changes

@heyjennahay heyjennahay Awaiting requested review from heyjennahay

@neil-marcellini neil-marcellini Awaiting requested review from neil-marcellini

@dukenv0307 dukenv0307 Awaiting requested review from dukenv0307

+1 more reviewer

@jjcoffee jjcoffee jjcoffee approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@neil-marcellini neil-marcellini

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@MelvinBot @neil-marcellini @jjcoffee @OSBotify @carlosmiceli