Remove 'withNavigationFallback.js' HOC #29449

VickyStash · 2023-10-12T14:23:28Z

Details

Initially, this PR was related to the migration of 'withNavigationFallback.js' HOC to TypeScript. During review the discussion was raised, and as a result, we came up with removing the withNavigationFallback HOC.

Fixed Issues

$ #24953
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

First case: Button component. It uses isFocused param in the keypress handler for pressing the button with the Enter key. You can test that it works as expected:

In the sidebar, press the Add (plus) button -> Request Money.
Select the Manual tab.
Enter the amount of money and press the Enter key -> you should be navigated to the next step.
Select the user to split the request with -> the next step will be opened.
Press Enter -> Money Request should be created.

Second case: Button component in Storybook:

Open Storybook
Select Button -> Press On Enter
Press Enter key and make sure the button works

Third case: Composer component in Storybook:

Open Storybook
Select Composer -> Default
Make sure there are no errors about the navigation container

Offline tests

N/A

QA Steps

Verify that no errors appear in the JS console

First case: Button component. It uses isFocused param in the keypress handler for pressing the button with the Enter key. You can test that it works as expected:

In the sidebar, press the Add (plus) button -> Request Money.
Select the Manual tab.
Enter the amount of money and press the Enter key -> you should be navigated to the next step.
Select the user to split the request with -> the next step will be opened.
Press Enter -> Money Request should be created.

Second case: Button component in Storybook:

Open Storybook
Select Button -> Press On Enter
Press Enter key and make sure the button works

Third case: Composer component in Storybook:

Open Storybook
Select Composer -> Default
Make sure there are no errors about the navigation container

PR Author Checklist

Screenshots/Videos

Storybook

storybook.button.mp4

MacOS: Chrome / Safari

web.google.mp4

web.safari.mp4

MacOS: Desktop

Desktop.mp4

src/components/withNavigationFallback.tsx

blazejkustra · 2023-10-13T13:52:18Z

This HOC looks like a workaround to me, imo the best would be to remove it from the codebase completely. Raised a discussion on the open source channel here

VickyStash · 2023-10-16T15:26:45Z

@blazejkustra I've updated the PR, let me know what you think, please

blazejkustra

LGTM

melvin-bot · 2023-10-17T09:19:18Z

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

akinwale · 2023-10-17T15:00:19Z

.eslintrc.js

@@ -116,7 +116,7 @@ module.exports = {
                    },
                    {
                        selector: ['parameter', 'method'],
-                        format: ['camelCase'],
+                        format: ['camelCase', 'PascalCase'],


Why are we using pascal case for method parameters here?

@akinwale It's left from TS migration. It shouldn't hurt, though, cause it's necessary for other HOCs anyway where we have WrappedComponent as a param (and it's in CamelCase). But I can remove it from this PR if necessary.

Ok, makes sense to leave it in if it's going to be used it in the future. Just wanted to make sure. Thanks.

akinwale · 2023-10-17T15:07:05Z

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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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(themeColors.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 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

Web

29449-web.mp4

29449-web-storybook-button-pressed.mp4

29449-web-storybook-composer-default.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

29449-desktop.mp4

iOS

Android

akinwale

LGTM.

Tests well.

melvin-bot · 2023-10-17T15:10:40Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #24953 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

OSBotify · 2023-10-17T17:42:33Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-10-17T23:57:06Z

🚀 Deployed to staging by https://github.com/techievivek in version: 1.3.86-0 🚀

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

OSBotify · 2023-10-18T23:54:36Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.86-5 🚀

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

VickyStash added 3 commits October 12, 2023 15:58

[TS migration] Migrate 'withNavigationFallback.js' HOC

808d2c3

Fix NavigationContextValue type

52b6a0e

Add callbacks types

8480a8f

kubabutkiewicz reviewed Oct 12, 2023

View reviewed changes

src/components/withNavigationFallback.tsx Outdated Show resolved Hide resolved

kubabutkiewicz approved these changes Oct 12, 2023

View reviewed changes

Remove withNavigationFallback HOC

bdf5836

VickyStash changed the title ~~[No QA] [TS migration] Migrate 'withNavigationFallback.js' HOC to TypeScript~~ Remove 'withNavigationFallback.js' HOC Oct 16, 2023

blazejkustra approved these changes Oct 17, 2023

View reviewed changes

VickyStash marked this pull request as ready for review October 17, 2023 09:19

VickyStash requested a review from a team as a code owner October 17, 2023 09:19

melvin-bot bot requested review from akinwale and removed request for a team October 17, 2023 09:19

akinwale reviewed Oct 17, 2023

View reviewed changes

akinwale approved these changes Oct 17, 2023

View reviewed changes

melvin-bot bot requested a review from techievivek October 17, 2023 15:10

techievivek approved these changes Oct 17, 2023

View reviewed changes

techievivek merged commit 9390cf1 into Expensify:main Oct 17, 2023
15 of 19 checks passed

OSBotify mentioned this pull request Oct 17, 2023

Deploy Checklist: New Expensify 2023-10-17 #29837

Closed

This was referenced Oct 18, 2023

[HOLD for payment 2023-10-27] [HOLD for payment 2023-10-25] [$250] Chat - Deleting message in chat causes black screen #29839

Closed

[CP Staging] Revert "Remove withNavigationFallback.js HOC" #29844

Merged

izarutskaya mentioned this pull request Oct 18, 2023

[$500] Split - Contact method of the participants is shown in Merchant instead of display name #29858

Closed

6 tasks

melvin-bot bot mentioned this pull request Oct 18, 2023

[TS migration] Migrate 'withNavigationFallback.js' HOC to TypeScript #24953

Closed

VickyStash mentioned this pull request Oct 25, 2023

[No QA] [TS migration] Migrate 'withNavigationFallback.js' HOC to TypeScript #30072

Merged

59 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove 'withNavigationFallback.js' HOC #29449

Remove 'withNavigationFallback.js' HOC #29449

VickyStash commented Oct 12, 2023 •

edited

Loading

blazejkustra commented Oct 13, 2023

VickyStash commented Oct 16, 2023

blazejkustra left a comment

melvin-bot bot commented Oct 17, 2023

akinwale Oct 17, 2023

VickyStash Oct 17, 2023

akinwale Oct 17, 2023

akinwale commented Oct 17, 2023 •

edited

Loading

akinwale left a comment

melvin-bot bot commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

Remove 'withNavigationFallback.js' HOC #29449

Remove 'withNavigationFallback.js' HOC #29449

Conversation

VickyStash commented Oct 12, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

blazejkustra commented Oct 13, 2023

VickyStash commented Oct 16, 2023

blazejkustra left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 17, 2023

akinwale Oct 17, 2023

Choose a reason for hiding this comment

VickyStash Oct 17, 2023

Choose a reason for hiding this comment

akinwale Oct 17, 2023

Choose a reason for hiding this comment

akinwale commented Oct 17, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

akinwale left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 17, 2023

OSBotify commented Oct 18, 2023

VickyStash commented Oct 12, 2023 •

edited

Loading

akinwale commented Oct 17, 2023 •

edited

Loading