Replace navigation blur listeners with `useFocusEffect` #53735

CyberAndrii · 2024-12-07T14:33:36Z

Explanation of Change

Replaces navigation.addListener('blur', () => { ... }); with useFocusEffect as the former does not invoke the event handler on unmount on native platforms. This is a known issue with @react-navigation/native-stack.

Fixed Issues

$ #53360
$ #53505
PROPOSAL: #53360 (comment)

Tests

Same as QA Steps.

Offline tests

N/A

QA Steps

Create a Collect workspace
Go to More features
Enable Rules
Tap Upgrade
Tap Got it, thanks
Verify that the Rules feature is enabled

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

53360.WorkshopUpgradePage.android.native.new.webm

Android: mWeb Chrome

53360.WorkshopUpgradePage.android.chrome.new.webm

iOS: Native

53360.ios.native.mp4

iOS: mWeb Safari

53360.ios.safari.mp4

MacOS: Chrome / Safari

53360.macos.chrome.mov

MacOS: Desktop

53360.macos.desktop.mov

Caused by `CONST.UPGRADE_FEATURE_INTRO_MAPPING` returning a new object on each invocation

CyberAndrii · 2024-12-08T11:50:17Z

Not updating these as they just set a state. They won't be re-rendered anyway

App/src/components/MapView/MapView.tsx

Lines 135 to 137 in b595f5d

    
           const unsubscribe = navigation.addListener('blur', () => { 
        
               setIsIdle(false); 
        
           });

App/src/pages/home/report/ReportActionCompose/ReportActionCompose.tsx

Lines 322 to 324 in b595f5d

    
           const unsubscribe = navigation.addListener('blur', () => { 
        
               setShouldHideEducationalTooltip(true); 
        
           });

These are web only so the issue won't occur here. The first one checks for if(!browser) return; and the second has a separate index.native.ts file

App/src/components/Lottie/index.tsx

Lines 71 to 74 in b595f5d

    
           if (!browser || !navigationContainerRef || !navigator) { 
        
               return; 
        
           } 
        
           const unsubscribeNavigationBlur = navigator.addListener('blur', () => {

App/src/hooks/useHtmlPaste/index.ts

Line 139 in b595f5d

    
           unsubscribeBlur = navigation.addListener('blur', () => document.removeEventListener('paste', handlePaste, true));

This one manually calls KeyDownListener.removeKeyDownPressListener(focusComposerOnKeyPress) from the useEffect cleanup function, so the issue won’t occur here

App/src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx

Line 609 in b595f5d

const unsubscribeNavigationBlur = navigation.addListener('blur', () => KeyDownListener.removeKeyDownPressListener(focusComposerOnKeyPress));

src/hooks/useWaitForNavigation.ts

melvin-bot · 2024-12-08T16:39:56Z

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

CyberAndrii · 2024-12-08T16:43:13Z

@dukenv0307 please ignore

mountiny · 2024-12-08T23:43:44Z

@Ollyws Can you please jump on this one on monday?

@kirillzyusko can you please review as well? thanks!

github-actions · 2024-12-08T23:43:49Z

🚧 @mountiny has triggered a test build. You can view the workflow run here.

github-actions · 2024-12-09T00:09:36Z

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖	iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/53735/index.html	https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/53735/index.html

Desktop 💻	Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/53735/NewExpensify.dmg	https://53735.pr-testing.expensify.com

👀 View the workflow run that generated this build 👀

src/hooks/useWaitForNavigation.ts

src/components/Button/index.tsx

kirillzyusko · 2024-12-09T16:19:30Z

From code perspective it looks good to me
I haven't tested the PR - plan to do that tomorrow 👍

Ollyws · 2024-12-09T19:12:31Z

Looks good, will test a bit more and hopefully will be good to go tomorrow.

kirillzyusko · 2024-12-10T15:36:52Z

I can confirm both #53360 #53505 are fixed with this PR!

Small concern: useWaitForNavigation is used in 11 files - potentially it's worth to check that the functionality is not broken there as well 👀 But I think that everything should be fine, so I approve it 👍

Ollyws · 2024-12-10T21:00:25Z

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

01_Android_Native.mp4

Android: mWeb Chrome

02_Android_Chrome.mp4

iOS: Native

03_iOS_Native.mp4

iOS: mWeb Safari

04_iOS_Safari.mp4

MacOS: Chrome / Safari

05_MacOS_Chrome.mp4

MacOS: Desktop

06_MacOS_Desktop.mp4

Ollyws

Tested the flows using useWaitForNavigation and it all looks good.

mountiny · 2024-12-11T15:09:33Z

src/hooks/useWaitForNavigation.ts

-            unsubscribeBlur();
-        };
-    }, [navigation]);
+    useFocusEffect(


@adamgrzybowski @WojtekBoman could you also please review this change in case you could see any issue with it in future?

I don't see anything weird about these changes.

One thing I wonder is why useFocusEffect works and addEventListnere('blur', ()=> {...}) doesn't while useFocusEffect uses the blur event underneath 🤔

https://github.com/react-navigation/react-navigation/blob/2a745c8c598f95fcec5bbf5442045478d4046663/packages/core/src/useFocusEffect.tsx#L95-L101

@adamgrzybowski because useFocusEffect runs cleanup on unmount (in native-stack we can't get blur event n that code)

mountiny · 2024-12-11T15:10:19Z

tests/ui/WorkspaceUpgradeTest.tsx

Nice, great job adding such test!

mountiny

Lets give this a try!

OSBotify · 2024-12-12T15:42:08Z

✋ 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 · 2024-12-13T16:03:39Z

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

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

luacmartins · 2024-12-17T21:57:33Z

@CyberAndrii @kirillzyusko @mountiny @Ollyws we ended up reverting this PR in an attempt to fix the issue that caused #fireroom-2024-12-17-hybridapp-crash. This PR was NOT the cause of the issue. I'm reverting the revert here

github-actions · 2024-12-18T13:15:55Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.76-12 🚀

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

CyberAndrii force-pushed the 53360-replace-blur-listeners-with-useFocusEffect branch from c8aefed to c55bde7 Compare December 7, 2024 18:47

CyberAndrii added 2 commits December 8, 2024 13:38

Replace navigation blur listeners with useFocusEffect

88d4706

Fix infinite re-render

8bbeaef

Caused by `CONST.UPGRADE_FEATURE_INTRO_MAPPING` returning a new object on each invocation

CyberAndrii force-pushed the 53360-replace-blur-listeners-with-useFocusEffect branch from c55bde7 to 8bbeaef Compare December 8, 2024 11:46

CyberAndrii commented Dec 8, 2024

View reviewed changes

src/hooks/useWaitForNavigation.ts Show resolved Hide resolved

Add tests for upgrading workspace and enabling rules

2f89f4c

CyberAndrii force-pushed the 53360-replace-blur-listeners-with-useFocusEffect branch from 942b3e2 to 2f89f4c Compare December 8, 2024 16:20

CyberAndrii marked this pull request as ready for review December 8, 2024 16:39

CyberAndrii requested a review from a team as a code owner December 8, 2024 16:39

melvin-bot bot requested review from dukenv0307 and removed request for a team December 8, 2024 16:39

CyberAndrii mentioned this pull request Dec 8, 2024

[HOLD for payment 2024-12-25] [$250] iOS/Android WS features -Feature is not enabled after enabling it and upgrading workspace to Control #53360

Open

8 tasks

mountiny requested review from Ollyws and removed request for dukenv0307 December 8, 2024 23:43

mountiny assigned CyberAndrii Dec 8, 2024

mountiny added the Ready To Build label Dec 8, 2024

mountiny self-requested a review December 8, 2024 23:43

youneshenniwrites suggested changes Dec 9, 2024

View reviewed changes

src/hooks/useWaitForNavigation.ts Show resolved Hide resolved

kirillzyusko reviewed Dec 9, 2024

View reviewed changes

src/components/Button/index.tsx Show resolved Hide resolved

kirillzyusko approved these changes Dec 10, 2024

View reviewed changes

Ollyws approved these changes Dec 10, 2024

View reviewed changes

mountiny reviewed Dec 11, 2024

View reviewed changes

mountiny approved these changes Dec 12, 2024

View reviewed changes

mountiny merged commit 94ab9cd into Expensify:main Dec 12, 2024
20 of 26 checks passed

CyberAndrii deleted the 53360-replace-blur-listeners-with-useFocusEffect branch December 12, 2024 15:40

github-actions bot mentioned this pull request Dec 13, 2024

Deploy Checklist: New Expensify 2024-12-13 #54111

Closed

60 tasks

Julesssss mentioned this pull request Dec 17, 2024

Revert "Replace navigation blur listeners with useFocusEffect" #54244

Merged

luacmartins mentioned this pull request Dec 17, 2024

Revert "Replace navigation blur listeners with useFocusEffect" #54268

Closed

melvin-bot bot mentioned this pull request Dec 18, 2024

[HOLD for payment 2024-12-25] [Hold for #53360] [$250] Company cards toggle is disabled after upgrading workspace on mobile #53505

Open

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace navigation blur listeners with `useFocusEffect` #53735

Replace navigation blur listeners with `useFocusEffect` #53735

CyberAndrii commented Dec 7, 2024 •

edited

Loading

CyberAndrii commented Dec 8, 2024

melvin-bot bot commented Dec 8, 2024

CyberAndrii commented Dec 8, 2024

mountiny commented Dec 8, 2024

github-actions bot commented Dec 8, 2024

github-actions bot commented Dec 9, 2024

kirillzyusko commented Dec 9, 2024

Ollyws commented Dec 9, 2024

kirillzyusko commented Dec 10, 2024 •

edited

Loading

Ollyws commented Dec 10, 2024

Ollyws left a comment

mountiny Dec 11, 2024

adamgrzybowski Dec 11, 2024

kirillzyusko Dec 11, 2024

mountiny Dec 11, 2024

mountiny left a comment

OSBotify commented Dec 12, 2024

github-actions bot commented Dec 13, 2024

luacmartins commented Dec 17, 2024 •

edited

Loading

github-actions bot commented Dec 18, 2024

Replace navigation blur listeners with useFocusEffect #53735

Replace navigation blur listeners with useFocusEffect #53735

Conversation

CyberAndrii commented Dec 7, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

CyberAndrii commented Dec 8, 2024

melvin-bot bot commented Dec 8, 2024

CyberAndrii commented Dec 8, 2024

mountiny commented Dec 8, 2024

github-actions bot commented Dec 8, 2024

github-actions bot commented Dec 9, 2024

kirillzyusko commented Dec 9, 2024

Ollyws commented Dec 9, 2024

kirillzyusko commented Dec 10, 2024 • edited Loading

Ollyws commented Dec 10, 2024

Reviewer Checklist

Screenshots/Videos

Ollyws left a comment

Choose a reason for hiding this comment

mountiny Dec 11, 2024

Choose a reason for hiding this comment

adamgrzybowski Dec 11, 2024

Choose a reason for hiding this comment

kirillzyusko Dec 11, 2024

Choose a reason for hiding this comment

mountiny Dec 11, 2024

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 12, 2024

github-actions bot commented Dec 13, 2024

luacmartins commented Dec 17, 2024 • edited Loading

github-actions bot commented Dec 18, 2024

Replace navigation blur listeners with `useFocusEffect` #53735

Replace navigation blur listeners with `useFocusEffect` #53735

CyberAndrii commented Dec 7, 2024 •

edited

Loading

kirillzyusko commented Dec 10, 2024 •

edited

Loading

luacmartins commented Dec 17, 2024 •

edited

Loading