fix: discard changes modal not show when using browser back button by mkzie2 · Pull Request #56527 · Expensify/App

mkzie2 · 2025-02-07T09:06:03Z

Explanation of Change

Fixed Issues

$ #55287
PROPOSAL: #55287 (comment)

Tests

[Web & mWeb]

Press FAB > Create expense
Complete the flow until confirmation step
Press Description
Type in any description
Press browser's back button
Verify discard changes modal shows (glitchy RHP animation is expected)
Press Discard changes
Verify app navigates back to confirmation step
Repeat step 3 - 6
Press Cancel
Verify discard changes modal dismisses

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Same as Tests

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2025-02-07.at.16.47.22-compressed.mov

Android: mWeb Chrome

Screen.Recording.2025-02-07.at.16.45.46-compressed.mov

iOS: Native

Screen.Recording.2025-02-07.at.16.22.49-compressed.mov

iOS: mWeb Safari

Screen.Recording.2025-02-07.at.16.24.55.mov

MacOS: Chrome / Safari

Screen.Recording.2025-02-07.at.16.14.16-compressed.mov

MacOS: Desktop

Screen.Recording.2025-02-07.at.16.23.27-compressed.mov

melvin-bot · 2025-02-07T09:32:12Z

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

mkzie2 · 2025-02-07T09:51:00Z

@Ollyws As you can see from MacOS: Chrome / Safari and Android: mWeb Chrome, there's a flickering because we re-navigate back to the merchant page, causing the sliding animation. I wonder if we're okay with that.

Ollyws · 2025-02-12T14:56:43Z

src/pages/iou/request/step/DiscardChangesConfirmation/index.tsx

+            }
+
+            event.preventDefault();
+            window.history.go(1);


Hmm using window.history.go(1); seems a bit hacky to me, what do you think @Beamanator?

It definitely does look hacky, though we do use window.history in the Modal component a bit 🤔 Is there no other way to do this piece with our Navigate lib?

Currently I found no other way. Navigation.navigate will rerender the whole merchant page causing all the state (merchant value, discard modal...) to be lost.

@Ollyws What do you think about my comment above?

Hmm if you're sure there is no other solution then I don't really see any way around it.

@Ollyws Cool, would you mind continuing your review then?

…e/55287

Ollyws · 2025-03-05T12:08:50Z

Is there any way we can get rid of the sliding in animation when we press back, it looks pretty bad:

Screen.Recording.2025-03-05.at.12.07.40.mov

…e/55287

mkzie2 · 2025-03-13T10:14:22Z

@Ollyws I cannot completely disable the sliding animation but just can reduce the duration and make it "smoother" like this:

Screen.Recording.2025-03-13.at.17.10.35.mov

The problem of the previous implementation is that popstate only fires after the back navigation is executed and the page at that route is rendered completely (in this case, it's the IOU confirmation page). That causes the confirmation page to show first, then we re-open the merchant page and thus leads to the flickering observed above.

Instead, we can use react-navigation's transitionStart event which occurs before the navigation finalizes (i.e. before popstate).

Ollyws · 2025-03-20T15:52:44Z

src/pages/iou/request/step/DiscardChangesConfirmation/index.tsx

+                    return;
+                }
+                if (shouldNavigateBack.current) {
+                    setTimeout(() => {


Why are we using setTimeout here?

I don't remember why I added it in the first place but I tested again everything and I believe we don't need it.

…e/55287

Ollyws · 2025-04-03T12:04:13Z

Great thanks for the changes. Overall looks very close to being ready but any idea why pressing the back button on Android chrome causes selection of the input field and subsequently the keyboard to open?

Android_Issue.mov

…/55287

mkzie2 · 2025-04-08T17:40:09Z

@Ollyws That's because we're using this hook:

App/src/pages/iou/request/step/IOURequestStepDescription.tsx

Line 64 in 2e0c58b

const {inputCallbackRef} = useAutoFocusInput(true);

Will investigate how to conditionally auto focus.

…/55287

mkzie2 · 2025-04-18T16:59:24Z

@Ollyws Just resolved it.

Ollyws · 2025-04-21T22:14:21Z

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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

04_iOS_Safari.mp4

iOS: mWeb Safari

05_MacOS_Chrome.mp4

MacOS: Chrome / Safari

06_MacOS_Desktop.mp4

MacOS: Desktop

Ollyws

LGTM.

Ollyws · 2025-04-21T22:15:48Z

@Beamanator let us know what you think about the sliding animation, that's really as smooth as we can get it I think.

Beamanator

Looking great! 2 super tiny comments

src/pages/iou/request/step/DiscardChangesConfirmation/index.tsx

Beamanator · 2025-04-22T09:27:03Z

src/pages/iou/request/step/DiscardChangesConfirmation/index.tsx

+    );
+
+    useEffect(() => {
+        const unsubscribe = navigation.addListener('transitionStart', () => {


Similarly, can you please add a comment explaining that we know there's a slight "glitchy" looking animation but this was the best we could do (using transitionStart)

In my opinion, if you at least mentioning it in the comments and people ask questions later, it will be good to know we EXPECTED at least a somewhat glitchy animation, as opposed to people thinking it's a bug we overlooked

Thanks. I added comments.

…/55287

mkzie2 · 2025-04-24T17:43:57Z

Hmm I did not change those pages. I'll merge main later to see if lint check succeeds.

Beamanator

Thanks! And yeah weird that the lint issues are in files that didn't change in this PR

melvin-bot · 2025-04-25T08:46:20Z

@Beamanator looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

Beamanator · 2025-04-25T08:46:29Z

Eslint errors expected, they're on files that weren't changed in this PR 🤔

OSBotify · 2025-04-25T08:55:19Z

✋ 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 · 2025-04-28T20:20:40Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.33-0 🚀

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

github-actions · 2025-04-29T19:54:34Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.35-1 🚀

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

github-actions · 2025-04-29T20:49:36Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.36-3 🚀

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

github-actions · 2025-04-29T22:15:37Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.37-1 🚀

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

github-actions · 2025-04-30T00:43:40Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.1.37-3 🚀

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

c3024 · 2025-08-13T05:33:57Z

src/pages/iou/request/step/DiscardChangesConfirmation/index.tsx

+        // could be less "glitchy" when going back and forth between the previous and current pages
+        const unsubscribe = navigation.addListener('transitionStart', () => {
+            // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+            if (!getHasUnsavedChanges() || blockedNavigationAction.current || shouldNavigateBack.current) {


When clicking on the device back button with the discard confirmation modal open, it goes back to the previous page along with discarding the modal. Fixed here #67010

fix: discard changes modal not show when using back device button

ee740e7

mkzie2 changed the title ~~fix: discard changes modal not show when using back device button~~ fix: discard changes modal not show when using browser back button Feb 7, 2025

mkzie2 marked this pull request as ready for review February 7, 2025 09:32

mkzie2 requested a review from a team as a code owner February 7, 2025 09:32

melvin-bot bot requested review from Ollyws and removed request for a team February 7, 2025 09:32

Ollyws reviewed Feb 12, 2025

View reviewed changes

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

04cd5e2

…e/55287

mkzie2 added 4 commits March 11, 2025 00:55

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

6077e81

…e/55287

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

e70b4a0

…e/55287

resolve conflicts

a35c6cd

fix: flickering when pressing back

e0e4400

Ollyws reviewed Mar 20, 2025

View reviewed changes

mkzie2 added 3 commits April 1, 2025 21:58

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

54a5cdf

…e/55287

Merge branch 'main' of https://github.com/mkzie2/App into mkzie2-issu…

35ea1a4

…e/55287

remove settimeout

90cde0b

Merge branch 'main' of github.com-mkzie2:mkzie2/App into mkzie2-issue…

d3502e9

…/55287

mkzie2 added 3 commits April 18, 2025 08:10

Merge branch 'main' of github.com-mkzie2:mkzie2/App into mkzie2-issue…

197352c

…/55287

fix auto focus when displaying discard change modal

f37176d

fix canBeMissing lint

42e31d9

Ollyws approved these changes Apr 21, 2025

View reviewed changes

melvin-bot bot requested a review from Beamanator April 21, 2025 22:14

Beamanator requested changes Apr 22, 2025

View reviewed changes

mkzie2 added 2 commits April 25, 2025 00:17

Merge branch 'main' of github.com-mkzie2:mkzie2/App into mkzie2-issue…

a3b48ea

…/55287

add explanative comments

1565bb4

Beamanator approved these changes Apr 25, 2025

View reviewed changes

Beamanator merged commit 5f5f4a0 into Expensify:main Apr 25, 2025
16 of 17 checks passed

melvin-bot bot added the Emergency label Apr 25, 2025

Beamanator removed the Emergency label Apr 25, 2025

github-actions bot mentioned this pull request Apr 28, 2025

Deploy Checklist: New Expensify 2025-04-28 #60971

Closed

mkzie2 mentioned this pull request May 5, 2025

[Payment Due May 7] [$250] Expense - Discard Changes modal not displayed when using device back button on Merchant field #55287

Closed

8 tasks

boorad mentioned this pull request May 27, 2025

[$500] Description field doesn't autofocus correctly in submit expense flow #52414

Closed

8 tasks

c3024 mentioned this pull request Jul 1, 2025

[Due for payment 2025-08-13] [$250] mWeb - Incorrect navigation to confirm details page & discard changes popup briefly visible #64107

Closed

8 tasks

c3024 reviewed Aug 13, 2025

View reviewed changes

Conversation

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

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Feb 7, 2025

Uh oh!

mkzie2 commented Feb 7, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Mar 5, 2025

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Apr 3, 2025

Uh oh!

mkzie2 commented Apr 8, 2025

Uh oh!

mkzie2 commented Apr 18, 2025

Uh oh!

Ollyws commented Apr 21, 2025

Reviewer Checklist

Screenshots/Videos

Uh oh!

Ollyws left a comment

Choose a reason for hiding this comment

Uh oh!

Ollyws commented Apr 21, 2025

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mkzie2 commented Apr 24, 2025

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot bot commented Apr 25, 2025

Uh oh!

Beamanator commented Apr 25, 2025

Uh oh!

OSBotify commented Apr 25, 2025

Uh oh!

github-actions bot commented Apr 28, 2025

Uh oh!

github-actions bot commented Apr 29, 2025

Uh oh!

github-actions bot commented Apr 29, 2025

Uh oh!

github-actions bot commented Apr 29, 2025

Uh oh!

github-actions bot commented Apr 30, 2025

mkzie2 commented Feb 7, 2025 •

edited

Loading

mkzie2 commented Mar 13, 2025 •

edited

Loading