Skip to content

Add discard changes handling to spend rule merchant pages#88973

Merged
JS00001 merged 7 commits intomainfrom
claude-spendRuleMerchantDiscardChanges
May 6, 2026
Merged

Add discard changes handling to spend rule merchant pages#88973
JS00001 merged 7 commits intomainfrom
claude-spendRuleMerchantDiscardChanges

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

@MelvinBot MelvinBot commented Apr 27, 2026

Explanation of Change

When editing a spend rule merchant, navigating back without pressing Save still persisted the merchant data to the Onyx form state. This happened because SpendRuleMerchantEditPage committed changes to Onyx on submit, but SpendRuleMerchantsPage didn't distinguish between "saved" and "unsaved" states on back navigation.

Changes:

  • SpendRuleMerchantEditPage: Added useDiscardChangesConfirmation hook that shows a "Discard changes?" confirmation modal when navigating back (in-app or browser) with unsaved input changes. Tracks a didSaveRef to skip the prompt after a successful save.
  • SpendRuleMerchantsPage: Added a cleanup effect that silently rolls back merchantNames and merchantMatchTypes to their original values (captured on mount) when the page unmounts without the user pressing Save. The Save button now sets a didSaveRef flag to skip the rollback.

Fixed Issues

$ #87442
PROPOSAL: #87442 (comment)

Tests

Precondition: Have an account with a workspace that has Expensify Cards and Rules enabled.

  1. Navigate to Workspace → Rules → Add spend rule.
  2. In the Spend Rule section, add a new merchant rule.
  3. On the Merchant Rules list page, click Add Merchant.
  4. Enter any merchant name and select any type.
  5. Press the back icon on the header of the New Merchant page.
  6. Verify that the “Discard changes” confirmation is shown.
  7. Select Cancel, then save the new merchant rule.
  8. Verify that the Merchant Rules list page includes the saved rule from step 7.
  9. Press the back icon on the header of the Merchant Rules list page.
  10. Verify that the Spend Rule section does not include the merchant rule, since it was not saved at step 9.

Offline tests

N/A

QA Steps

Same as tests

  • 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
  • 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

Screen.Recording.2026-05-01.at.9.01.05.AM.mov
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

SpendRuleMerchantEditPage now shows a discard changes confirmation
modal when navigating back with unsaved input changes.

SpendRuleMerchantsPage now silently rolls back merchant data to its
original state when navigating back without pressing Save.

Co-authored-by: Carlos Martins <luacmartins@users.noreply.github.com>
… React Compiler compliance

Add refs to useEffect dependency array instead of disabling the rule.
Refs are stable across renders so behavior is unchanged.

Co-authored-by: Carlos Martins <luacmartins@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Fixed the failing React Compiler Compliance check: removed the eslint-disable-next-line react-hooks/exhaustive-deps comment and added the refs to the useEffect dependency array instead. Refs are stable across renders, so behavior is unchanged.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 27, 2026

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
src/libs/actions/User.ts 38.22% <0.00%> (-0.35%) ⬇️
...kspace/rules/SpendRules/SpendRuleMerchantsPage.tsx 0.00% <0.00%> (ø)
...ace/rules/SpendRules/SpendRuleMerchantEditPage.tsx 0.00% <0.00%> (ø)
... and 11 files with indirect coverage changes

@suneox
Copy link
Copy Markdown
Contributor

suneox commented Apr 30, 2026

I’ll start taking a look at this one in an hour

@suneox
Copy link
Copy Markdown
Contributor

suneox commented Apr 30, 2026

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

Ad-Hoc

az_recorder_20260502_155902.1.mp4
CleanShot.2026-04-30.at.19.53.45.5.mp4
Android: mWeb Chrome
CleanShot.2026-04-30.at.19.49.21.4.mp4
iOS: HybridApp
CleanShot.2026-04-30.at.19.35.11.2.mp4
iOS: mWeb Safari
CleanShot.2026-04-30.at.19.37.52.3.mp4
MacOS: Chrome / Safari
CleanShot.2026-04-30.at.19.21.12.1.mp4

@suneox
Copy link
Copy Markdown
Contributor

suneox commented Apr 30, 2026

@MelvinBot The change set looks good, mark it as ready for review.

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 I can't mark this PR as ready for review because suneox is not the PR author, assignee, or co-author on this PR.

The PR assignee (luacmartins) should mark it as ready for review. Note that the Tests, Offline tests, and QA Steps sections still have unfilled TODOs that the human co-author needs to complete first.

@suneox
Copy link
Copy Markdown
Contributor

suneox commented Apr 30, 2026

🤖 I can't mark this PR as ready for review because suneox is not the PR author, assignee, or co-author on this PR.

The PR assignee (luacmartins) should mark it as ready for review. Note that the Tests, Offline tests, and QA Steps sections still have unfilled TODOs that the human co-author needs to complete first.

@MelvinBot Test step:

Precondition: Have an account with a workspace that has Expensify Cards and Rules enabled.

  1. Navigate to Workspace → Rules → Add spend rule.
  2. In the Spend Rule section, add a new merchant rule.
  3. On the Merchant Rules list page, click Add Merchant.
  4. Enter any merchant name and select any type.
  5. Press the back icon on the header of the New Merchant page.
  6. Verify that the “Discard changes” confirmation is shown.
  7. Select Cancel, then save the new merchant rule.
  8. Verify that the Merchant Rules list page includes the saved rule from step 7.
  9. Press the back icon on the header of the Merchant Rules list page.
  10. Verify that the Spend Rule section does not include the merchant rule, since it was not saved at step 9.

@luacmartins The current PR is ready for behavior verification on an ad hoc build

@MelvinBot
Copy link
Copy Markdown
Contributor Author

🤖 Thanks for the test steps, suneox. However, I can't update the PR body or mark this PR as ready for review on your behalf — you're not the PR author, assignee, or co-author.

luacmartins (the assignee and co-author) should:

  1. Add the provided test steps to the Tests, Offline tests, and QA Steps sections in the PR body
  2. Mark the PR as ready for review when satisfied

@luacmartins luacmartins marked this pull request as ready for review April 30, 2026 16:34
@luacmartins luacmartins requested a review from a team as a code owner April 30, 2026 16:34
@melvin-bot melvin-bot Bot requested review from suneox and removed request for a team April 30, 2026 16:34
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented Apr 30, 2026

@suneox 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 review from trjExpensify and removed request for a team April 30, 2026 16:34
@luacmartins
Copy link
Copy Markdown
Contributor

Running an adhoc

@github-actions
Copy link
Copy Markdown
Contributor

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

@github-actions

This comment has been minimized.

trjExpensify
trjExpensify previously approved these changes Apr 30, 2026
Copy link
Copy Markdown
Contributor

@trjExpensify trjExpensify left a comment

Choose a reason for hiding this comment

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

Spend rules project bug fix.

@luacmartins
Copy link
Copy Markdown
Contributor

Sorry for the delay. @suneox ready for review.

@suneox
Copy link
Copy Markdown
Contributor

suneox commented May 2, 2026

Sorry for the delay. @suneox ready for review.

I’ve completed the checklist, and the current behavior LGTM

@melvin-bot melvin-bot Bot requested a review from JS00001 May 2, 2026 09:03
@luacmartins
Copy link
Copy Markdown
Contributor

All yours @JS00001

Comment thread src/pages/workspace/rules/SpendRules/SpendRuleMerchantEditPage.tsx Outdated
Comment thread src/pages/workspace/rules/SpendRules/SpendRuleMerchantEditPage.tsx
Comment thread src/pages/workspace/rules/SpendRules/SpendRuleMerchantsPage.tsx Outdated
@MelvinBot MelvinBot requested a review from a team as a code owner May 4, 2026 18:38
@melvin-bot melvin-bot Bot requested review from suneox and removed request for a team May 4, 2026 18:38
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 4, 2026

@suneox 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
Copy link
Copy Markdown
Contributor Author

Implemented the SPEND_RULE_FORM_DRAFT buffer approach in d13a916:

  • User.ts: Added initDraftSpendRuleMerchants(), updateSpendRuleFormDraft(), and clearSpendRuleFormDraft() helpers
  • SpendRuleMerchantsPage: Reads from draft for display. On mount, copies merchant fields from SPEND_RULE_FORMSPEND_RULE_FORM_DRAFT. On Save, commits draft → SPEND_RULE_FORM. On unmount, clears the draft. All ref-based rollback logic removed
  • SpendRuleMerchantEditPage: Reads/writes SPEND_RULE_FORM_DRAFT instead of SPEND_RULE_FORM. useDiscardChangesConfirmation stays as-is

Typecheck passes. Ready for review.

…mpiler rule

Co-authored-by: Carlos Martins <luacmartins@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Fixed the failing ESLint check: removed an eslint-disable-next-line react-compiler/react-compiler comment that referenced a nonexistent rule. This repo uses a custom React Compiler compat processor instead of the react-compiler/react-compiler ESLint rule, so the disable comment was invalid.

Copy link
Copy Markdown
Contributor

@suneox suneox left a comment

Choose a reason for hiding this comment

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

The updated alternative solution, using draft form values instead of resetting the original value still works as expected.

CleanShot.2026-05-05.at.17.02.10.1.mp4

@melvin-bot melvin-bot Bot requested a review from JS00001 May 5, 2026 10:08
Comment thread src/pages/workspace/rules/SpendRules/SpendRuleMerchantEditPage.tsx
Comment thread src/pages/workspace/rules/SpendRules/SpendRuleMerchantsPage.tsx Outdated
@luacmartins luacmartins requested a review from JS00001 May 5, 2026 18:04
@luacmartins
Copy link
Copy Markdown
Contributor

Ok, I updated the code to:

  • Remove the ref and use useState instead. Following the same isSaved pattern we have here
  • Remove the init function and use a clear effect

Copy link
Copy Markdown
Contributor

@JS00001 JS00001 left a comment

Choose a reason for hiding this comment

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

I am confused by this approach, it seems really complicated. The issue is that we want to not persist the changes to the draft spend rule if 'save' is not clicked', so can we use local state & mirror it to the draft spend rule when save is clicked?


const goBack = useCallback(() => navigation.goBack(), [navigation]);

useEffect(() => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is this a 'wait for the changes to be saved, then go back'?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Correct

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is this needed? Why is this not part of the onSave handler?

@luacmartins
Copy link
Copy Markdown
Contributor

I am confused by this approach, it seems really complicated. The issue is that we want to not persist the changes to the draft spend rule if 'save' is not clicked', so can we use local state & mirror it to the draft spend rule when save is clicked?

That's the issue, yea. Generally, our flows persist values so that it survives a page refresh, so I don't think keeping it in state would help.

@luacmartins luacmartins requested a review from JS00001 May 6, 2026 11:36

const goBack = useCallback(() => navigation.goBack(), [navigation]);

useEffect(() => {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why is this needed? Why is this not part of the onSave handler?

@luacmartins
Copy link
Copy Markdown
Contributor

Why is this needed? Why is this not part of the onSave handler?

We need the navigation to happen on the render after isSaved flips, because getHasUnsavedChanges is recreated each render and useBeforeRemove reads it synchronously. This is why the original code used a ref, since those are updated synchronously. With useState, we have a deferred render, so we need to wait for the new state before we can navigate away.

@JS00001 JS00001 merged commit b30f01d into main May 6, 2026
51 checks passed
@JS00001 JS00001 deleted the claude-spendRuleMerchantDiscardChanges branch May 6, 2026 14:39
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented May 6, 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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

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

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented May 6, 2026

🚀 Deployed to staging by https://github.com/JS00001 in version: 9.3.68-0 🚀

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

Bundle Size Analysis (Sentry):

@MelvinBot
Copy link
Copy Markdown
Contributor Author

No help site changes are required for this PR.

Reason: This PR is a UX bug fix that adds a "Discard changes?" confirmation dialog and proper rollback of unsaved merchant data on the Spend Rule merchant edit pages. It doesn't introduce new features, change terminology, alter navigation paths, or modify any user-facing settings. There are no existing help site articles covering Spend Rules (the docs cover "Workspace Merchant Rules" and "Workspace Rules", which are separate features), so there is nothing to update.

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented May 8, 2026

🚀 Deployed to production by https://github.com/francoisl in version: 9.3.68-3 🚀

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants