[BUGFIX] Onboarding - Modal can be dismissed by ESC key #39927

cdOut · 2024-04-09T13:10:35Z

Details

Fixed Issues

$ #39834

Tests

Navigate to onboarding flow through Settings > About > Troubleshoot and the temporary Onboarding flow button
Using a keyboard verify that both the Onboarding Personal Details and the Onboarding Purpose are not dismissable using the Escape key.

Verify that no errors appear in the JS console

Offline tests

QA Steps

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

Screenshots/Videos

Android: Native

ANDROID-NATIVE.mov

Android: mWeb Chrome

ANDROID-CHROME.mov

iOS: Native

IOS-NATIVE.mov

iOS: mWeb Safari

IOS-SAFARI.mov

MacOS: Chrome / Safari

CHROME.mov

MacOS: Desktop

DESKTOP.mov

filip-solecki

LGTM, add some video

merge main into onboarding/escape-button-fix

melvin-bot · 2024-04-10T09:46:20Z

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

hoangzinh · 2024-04-10T17:38:55Z

src/pages/OnboardingPersonalDetails/BaseOnboardingPersonalDetails.tsx

@@ -36,6 +37,10 @@ function BaseOnboardingPersonalDetails({currentUserPersonalDetails, shouldUseNat
    const {isSmallScreenWidth} = useWindowDimensions();
    const {shouldUseNarrowLayout} = useOnboardingLayout();

+    useEffect(() => {
+        Modal.setDisableDismissOnEscape(true);
+    }, []);


I believe it works but I think it's not really good. We set on/off for this prop disableDismissOnEscape on 2 components, thus in order to keep it working:

We need to ensure their order

And if we replace OnboardingPurpose component with another component, we need to remember to copy that setter as well.

So I think they're not independent. What do you think if we set it on on mount, and off on unmount for each component? We can wrap it into a custom hook and use it on every modal that needs to disable dismiss on ESC.

I agree with @hoangzinh this is a bit fragile logic

Yeah I understand what you mean, I'll rework it accordingly so it applies more properly here.

cdOut · 2024-04-11T12:58:09Z

@hoangzinh I've remade this functionality into a simple hook and added it to the onboarding pages, you can recheck it.

hoangzinh · 2024-04-11T15:14:28Z

Thanks @cdOut I'm going to complete review checklist

hoangzinh · 2024-04-11T15:14: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 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
- 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.js 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.
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

Screen.Recording.2024-04-11.at.23.01.51.android.mov

Android: mWeb Chrome

Screen.Recording.2024-04-11.at.22.34.37.android.chrome.mov

iOS: Native

Screen.Recording.2024-04-11.at.23.13.34.mov

iOS: mWeb Safari

Screen.Recording.2024-04-11.at.22.54.31.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-04-11.at.22.29.56.web.mov

MacOS: Desktop

Screen.Recording.2024-04-11.at.22.32.00.desktop.mov

hoangzinh

LGTM

mountiny

Thank you

OSBotify · 2024-04-18T04:57:26Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.4.63-0 🚀

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

kbecciv · 2024-04-19T12:47:15Z

This PR is failing because of issue #39834

The issue is reproducible in: Web and Desktop environments

2024-04-19.17-22-54.mp4

OSBotify · 2024-04-22T14:58:25Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.63-21 🚀

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

cdOut added 2 commits April 9, 2024 15:07

add option to disable escape for modal dismiss

ea0fe8a

fix prettier

6ec63ca

filip-solecki approved these changes Apr 9, 2024

View reviewed changes

mountiny changed the title ~~[BUGFIX] Onboarding - Modal can bn be dismissed by ESC key~~ [BUGFIX] Onboarding - Modal can be dismissed by ESC key Apr 9, 2024

mountiny assigned cdOut Apr 9, 2024

mountiny requested review from hoangzinh and mountiny April 9, 2024 23:55

Merge branch 'main' into onboarding/escape-button-fix

f48d38b

merge main into onboarding/escape-button-fix

cdOut marked this pull request as ready for review April 10, 2024 09:45

cdOut requested a review from a team as a code owner April 10, 2024 09:45

melvin-bot bot requested review from johnmlee101 and removed request for a team April 10, 2024 09:46

hoangzinh reviewed Apr 10, 2024

View reviewed changes

cdOut added 2 commits April 11, 2024 14:13

rework functionality into a reusable hook

443539c

fix prettier

5facddb

hoangzinh approved these changes Apr 11, 2024

View reviewed changes

mountiny approved these changes Apr 14, 2024

View reviewed changes

mountiny merged commit 8bb2788 into Expensify:main Apr 15, 2024
16 checks passed

github-actions bot mentioned this pull request Apr 18, 2024

Deploy Checklist: New Expensify 2024-04-18 #40392

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BUGFIX] Onboarding - Modal can be dismissed by ESC key #39927

[BUGFIX] Onboarding - Modal can be dismissed by ESC key #39927

cdOut commented Apr 9, 2024 •

edited

Loading

filip-solecki left a comment •

edited

Loading

melvin-bot bot commented Apr 10, 2024

hoangzinh Apr 10, 2024

mountiny Apr 10, 2024

cdOut Apr 11, 2024

cdOut commented Apr 11, 2024

hoangzinh commented Apr 11, 2024

hoangzinh commented Apr 11, 2024 •

edited

Loading

hoangzinh left a comment

mountiny left a comment

OSBotify commented Apr 18, 2024

kbecciv commented Apr 19, 2024

OSBotify commented Apr 22, 2024

[BUGFIX] Onboarding - Modal can be dismissed by ESC key #39927

[BUGFIX] Onboarding - Modal can be dismissed by ESC key #39927

Conversation

cdOut commented Apr 9, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

filip-solecki left a comment • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Apr 10, 2024

hoangzinh Apr 10, 2024

Choose a reason for hiding this comment

mountiny Apr 10, 2024

Choose a reason for hiding this comment

cdOut Apr 11, 2024

Choose a reason for hiding this comment

cdOut commented Apr 11, 2024

hoangzinh commented Apr 11, 2024

hoangzinh commented Apr 11, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hoangzinh left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 18, 2024

kbecciv commented Apr 19, 2024

OSBotify commented Apr 22, 2024

cdOut commented Apr 9, 2024 •

edited

Loading

filip-solecki left a comment •

edited

Loading

hoangzinh commented Apr 11, 2024 •

edited

Loading