Show discard confirmation modal when going back from a page with unsaved changes by bernhardoj · Pull Request #54176 · Expensify/App

bernhardoj · 2024-12-16T04:12:16Z

Explanation of Change

Fixed Issues

$ #53679
PROPOSAL: #53679 (comment)

Tests

Same as QA Steps

Verify that no errors appear in the JS console

Offline tests

Same as QA Steps

QA Steps

Open submit expense flow page
Proceed to the confirmation page
Open the Description
Go back
Verify the page closes
Open the page again
Type anything
Go back
Verify there is a discard confirmation modal
Press Cancel
Verify the modal closes, but the page doesn't close
Repeat step 8-9
Press Discard changes
Verify the modal and page closes
Repeat step 6-7
Save the changes
Verify the page closes and the change is saved
Repeat step 3-17 but for Merchant field

NOTE for web/desktop: you can test going back by pressing the overlay too

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.17.17.49.mp4

Android: mWeb Chrome

android.mweb.17.17.49.mp4

iOS: Native

ios.17.17.49.mp4

iOS: mWeb Safari

ios.mweb.17.17.49.mp4

MacOS: Chrome / Safari

web.merchant.mp4

web-desc.mp4

MacOS: Desktop

desktop.17.17.49.mp4

… unsaved changes

melvin-bot · 2024-12-16T04:12:21Z

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

bernhardoj · 2024-12-16T04:13:20Z

~~Recording is pending, looks like I have a problem uploading the recording~~

bernhardoj · 2024-12-16T04:14:40Z

I think the idea to add the discard confirmation logic in FormProvider is a good idea, but I think we should use a prop to control whether to enable it because I'm not confident it will work smooth on all cases (for example, we set isSavedRef to true when press the submit button, but there is a submit button that navigate forward to another page instead of closing it). Let me know if I should update it.

bernhardoj · 2024-12-16T04:15:52Z

                        navigation.goBack();
+                        setTimeout(() => {
+                            isExecutingRef.current = false;
+                        }, CONST.ANIMATED_TRANSITION);


isExecutingRef prevent the user to click the overlay multiple times when going back (I can't repro the multiple click issue even after removing the ref). But since we are preventing the going back when there is unsaved change, the next press won't do anything. So, we need to reset isExecutingRef back.

bernhardoj · 2024-12-16T04:16:42Z

+    const updateMerchantRef = (value: string) => {
+        merchantRef.current = value;
+    };
+


I used ref here (same for desc) so it won't trigger a re-render everytime the value is updated since we only use this for getHasUnsavedChanges.

bernhardoj · 2024-12-16T04:19:45Z

+        title: '¿Descartar cambios?',
+        body: '¿Estás seguro de que quieres descartar los cambios que hiciste?',
+        confirmText: 'Descartar cambios',
+    },


Asked for the translation verification here: https://expensify.slack.com/archives/C01GTK53T8Q/p1734322609246139

It approved, Let's add the Slack link in author checklist Link to Slack message:

ahmedGaber93 · 2024-12-23T00:37:50Z

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

a.mp4

Android: mWeb Chrome

aw.mp4

iOS: Native

i.mp4

iOS: mWeb Safari

iw.mp4

MacOS: Chrome / Safari

w.mp4

MacOS: Desktop

d.mp4

ahmedGaber93 · 2024-12-23T06:41:33Z

Looks good overall, we just need to fix the conflict and follow ESlint new rule no-default-id-values to remove '-1' values

bernhardoj · 2024-12-23T12:00:20Z

Done

ahmedGaber93 · 2024-12-24T03:47:31Z

@bernhardoj can we support hardwareBackPress on Android? And also add a TODO or comment on useBeforeRemove file to migrate to original use-prevent-remove in v7.x to support swipe gesture?

bernhardoj · 2024-12-24T05:58:53Z

can we support hardwareBackPress on Android?

Is the modal doesn't show when using hardware back button? I want to test it but getting error again

But I also think we shouldn't use hardwareBackPress since it doesn't always mean a page will close. Maybe there is a modal showing which will close the modal instead.

And also add a TODO or comment on useBeforeRemove file to migrate to original use-prevent-remove in v7.x to support swipe gesture?

Done

ahmedGaber93 · 2024-12-24T19:05:59Z

But I also think we shouldn't use hardwareBackPress since it doesn't always mean a page will close. Maybe there is a modal showing which will close the modal instead.

Yeah, I agree. It will be difficult to implement.

ahmedGaber93

LGTM!

ahmedGaber93 · 2024-12-24T19:10:43Z

@bernhardoj another conflict need to resolved.

bernhardoj · 2024-12-25T02:46:21Z

Fixed.

ahmedGaber93 · 2025-01-01T12:44:52Z

@stitesExpensify All yours!

stitesExpensify

lgtm

OSBotify · 2025-01-06T22:41:05Z

✋ 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-01-08T02:59:59Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.0.82-0 🚀

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

github-actions · 2025-01-08T03:39:48Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.0.82-0 🚀

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

github-actions · 2025-01-10T03:38:24Z

🚀 Deployed to production by https://github.com/thienlnam in version: 9.0.82-12 🚀

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

c3024 · 2025-03-20T07:47:33Z

+            onConfirm={() => {
+                setIsVisible(false);
+                if (blockedNavigationAction.current) {
+                    navigation.dispatch(blockedNavigationAction.current);


navigation obtained with useNavigation scopes only to its parent stack. We should use the full top level navigation object here (with ref). More details here #57512 .

Ollyws · 2025-04-07T14:51:53Z

+    );
+
+    return (
+        <ConfirmModal


We weren't using shouldHandleNavigationBack here which was causing incorrect navigation back (#58449).

add a new discard confirmation modal when going back from a page with…

53beacb

… unsaved changes

bernhardoj requested a review from a team as a code owner December 16, 2024 04:12

melvin-bot Bot requested a review from ahmedGaber93 December 16, 2024 04:12

melvin-bot Bot removed the request for review from a team December 16, 2024 04:12

bernhardoj commented Dec 16, 2024

View reviewed changes

migrate to useOnyx

a478017

dannymcclain requested a review from a team December 16, 2024 14:28

bernhardoj added 2 commits December 23, 2024 18:54

Merge branch 'main' into fix/53679-discard-confirm-dialog

dfaf517

lint

d72f8a0

bernhardoj added 2 commits December 24, 2024 12:58

Merge branch 'main' into fix/53679-discard-confirm-dialog

22a35f0

add comment

93328ea

ahmedGaber93 approved these changes Dec 24, 2024

View reviewed changes

melvin-bot Bot requested a review from stitesExpensify December 24, 2024 19:08

Merge branch 'main' into fix/53679-discard-confirm-dialog

0ccb5f6

shawnborton approved these changes Jan 3, 2025

View reviewed changes

stitesExpensify approved these changes Jan 6, 2025

View reviewed changes

stitesExpensify merged commit e933f4a into Expensify:main Jan 6, 2025

github-actions Bot mentioned this pull request Jan 8, 2025

Deploy Checklist: New Expensify 2025-01-08 #54928

Closed

60 tasks

melvin-bot Bot mentioned this pull request Jan 10, 2025

[HOLD for payment 2025-01-17] [$250] Add confirmation dialog on unsaved changes #53679

Closed

c3024 reviewed Mar 20, 2025

View reviewed changes

Ollyws reviewed Apr 7, 2025

View reviewed changes

Conversation

bernhardoj commented Dec 16, 2024 • 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 Dec 16, 2024

Uh oh!

bernhardoj commented Dec 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bernhardoj commented Dec 16, 2024

Uh oh!

bernhardoj Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

bernhardoj Dec 16, 2024

Choose a reason for hiding this comment

Uh oh!

ahmedGaber93 Dec 23, 2024

Choose a reason for hiding this comment

Uh oh!

ahmedGaber93 commented Dec 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

ahmedGaber93 commented Dec 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bernhardoj commented Dec 23, 2024

Uh oh!

ahmedGaber93 commented Dec 24, 2024

Uh oh!

bernhardoj commented Dec 24, 2024

Uh oh!

ahmedGaber93 commented Dec 24, 2024

Uh oh!

ahmedGaber93 left a comment

Choose a reason for hiding this comment

Uh oh!

ahmedGaber93 commented Dec 24, 2024

Uh oh!

bernhardoj commented Dec 25, 2024

Uh oh!

ahmedGaber93 commented Jan 1, 2025

Uh oh!

stitesExpensify left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Jan 6, 2025

Uh oh!

github-actions Bot commented Jan 8, 2025

Uh oh!

github-actions Bot commented Jan 8, 2025

Uh oh!

github-actions Bot commented Jan 10, 2025

Uh oh!

c3024 Mar 20, 2025

Choose a reason for hiding this comment

Uh oh!

Ollyws Apr 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

bernhardoj commented Dec 16, 2024 •

edited

Loading

bernhardoj commented Dec 16, 2024 •

edited

Loading

ahmedGaber93 commented Dec 23, 2024 •

edited

Loading

ahmedGaber93 commented Dec 23, 2024 •

edited

Loading