[TS migration] Migrate 'Navigation' lib to TypeScript #31543

blazejkustra · 2023-11-20T12:09:42Z

Details

Migration of Navigation to Typescript.

Fixed Issues

$ #24934
PROPOSAL: N/A

Tests

Test the app generally, navigating through the app, login screen, settings, report screen.
Verify that deeplinks redirect to the correct pages
- e.g. https://dev.new.expensify.com:8082/settings/profile/pronouns should open pronouns settings page
- Verify that back button works as expected
On web and desktop, change the size of the window. Verify that screens are displayed correctly

Offline tests

N/A

QA Steps

Same as Tests

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

Screenshots/Videos

Android: Native

android.1.webm

Android: mWeb Chrome

android-web.webm

iOS: Native

ios.mp4

iOS: mWeb Safari

ios-web.mp4

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

0xmiros · 2023-11-24T13:20:18Z

Thanks for the reminder. I will ask for help since I am not available to review today

situchan

Thanks for working on this big PR

contributingGuides/NAVIGATION.md

src/ROUTES.ts

src/libs/Navigation/FreezeWrapper.tsx

src/libs/Navigation/Navigation.ts

src/libs/Navigation/NavigationRoot.tsx

src/libs/Navigation/OnyxTabNavigator.tsx

src/libs/Navigation/linkTo.ts

blazejkustra · 2023-11-24T14:59:26Z

@situchan Thank you for the detailed review from your side! Adjusted the code 🚀

situchan · 2023-11-24T16:14:59Z

BUG: infinite loading on report screen on desktop app when opened from deeplink

Screen.Recording.2023-11-24.at.10.09.51.PM.mov

I will confirm if this also happens on main

blazejkustra · 2023-11-24T16:34:28Z

I didn't know how to test deep links on desktop 😅 - for me the browser was always opened instead..

If it is only reproduced on this branch please describe the reproduction steps precisely.

situchan · 2023-11-24T18:25:34Z

Confirmed happening on main as well so not blocker.

I didn't know how to test deep links on desktop 😅 - for me the browser was always opened instead..

Please comment this line to test desktop deeplinking:

App/src/components/DeeplinkWrapper/index.website.js

Lines 72 to 74 in e355608

    
           if (!isMacOSWeb() || isUnsupportedDeeplinkRoute || CONFIG.ENVIRONMENT === CONST.ENVIRONMENT.DEV || hasShownPrompt) { 
        
               return; 
        
           }

situchan · 2023-11-24T18:27:57Z

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

Android: Native

android.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

situchan

roryabraham · 2023-11-26T15:26:06Z

src/ROUTES.ts

-function getUrlWithBackToParam(url: string, backTo?: string): string {
-    const backToParam = backTo ? `${url.includes('?') ? '&' : '?'}backTo=${encodeURIComponent(backTo)}` : '';
-    return url + backToParam;
+function getUrlWithBackToParam<TUrl extends string>(url: TUrl, backTo?: string): `${TUrl}` | `${TUrl}?backTo=${string}` | `${TUrl}&backTo=${string}` {


Not exactly sure how one would accomplish this, but I feel like a utility type for urls would be helpful, such that you could provide:

a base URL

an object type representing a series of optional or required query params (which of course can be in any order)

And then the resultant type would be any string matching the pattern of a valid URL with the correct base and query params.

I feel like it should be doable @roryabraham, but I believe it's not something that should be handled in this PR, for two reasons:

Preferably JS logic should be untouched in TS migration PRs

This PR is a high prio for SWM team, as we are working on the navigation refactor. This migration could speed up things 😄

Same as here, would you mind creating an issue for this, so it could be worked on in a separate PR?

please comment for assignment: #32143

just submitted a proposal for #32143
@roryabraham

src/ROUTES.ts

src/libs/Navigation/Navigation.ts

src/libs/Navigation/NavigationRoot.tsx

roryabraham · 2023-11-26T15:57:04Z

src/libs/Navigation/types.ts

+
+type SettingsNavigatorParamList = {
+    [SCREENS.SETTINGS.ROOT]: undefined;
+    Settings_Share_Code: undefined;


NAB but I think now is as good a time as any to standardize on always using constants for screen names. I don't like how we have two patterns for defining screen names, as I think it causes confusion when adding new screens or when adding a new constant for a screen name.

I would love to work on this, would you be able to create an issue for this so I can do it in a separate PR? @roryabraham

Comment for assignment: #32141

roryabraham · 2023-11-26T15:59:13Z

src/libs/Navigation/types.ts

@@ -0,0 +1,401 @@
+/* eslint-disable @typescript-eslint/naming-convention  */
+import {CommonActions, NavigationContainerRefWithCurrent, NavigationHelpers, NavigationState, NavigatorScreenParams, PartialRoute, Route} from '@react-navigation/native';


This file overall seems like a lot of duplication. Are you sure we can't derive these types, or is it better to define them separately in case of platform fragmentation?

What part exactly?

Lines 36-399 is just definition for screens params,

Lines 12-34 is something that I had to extract from react navigation because of how we use navigation in the App. I don't think we can remove that part.

Lines 8-10 is kind of redundant but helpful imo.

flodnv · 2023-11-27T13:35:28Z

@roryabraham thanks for reviewing this, as it seems like you're handling it I'll remove my request for review.

blazejkustra · 2023-11-28T08:45:10Z

I think @roryabraham is OOO after Thanksgiving (based on Rory's Slack status). @flodnv could you handle review instead? Thank you in advance 😄

flodnv · 2023-11-28T13:14:04Z

Looks like he'll be back today

…

On Tue, Nov 28, 2023 at 4:45 AM Błażej Kustra ***@***.***> wrote: I think @roryabraham <https://github.com/roryabraham> is OOO after Thanksgiving (based on Rory's Slack status). @flodnv <https://github.com/flodnv> could you handle review instead? Thank you in advance 😄 — Reply to this email directly, view it on GitHub <#31543 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA7Y2OJ4DMOANBVBA6OWA63YGWQCBAVCNFSM6AAAAAA7SZ3SS6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMRZGM2TCMZZHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

OSBotify · 2023-11-28T17:56:20Z

✋ 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-11-30T12:15:15Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.5-7 🚀

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

blazejkustra added 30 commits November 20, 2023 10:32

Migrate getStateFromPath to TS

63bf692

Migrate FreezeWrapper to TS

bb91e5f

Migrate linkingConfig to TS

834aa1a

Migrate linkTo to TS

bdb18b0

Migrate navigationRef to TS

bab420e

Migrate OnyxTabNavigator to TS

20cca5e

Migrate useFlipper to TS

667e9f9

Migrate NavigationRoot to TS

91cbf0a

Augment react navigation to make navigation types global

11369ef

Migrate Navigation to TS

b19ff6b

Migrate getTopmostReportId

abbae01

Rename type augmentation

ab078fc

Improve NavigationState type usage

604a246

Migrate shouldPreventDeeplinkPrompt

bf9d3a7

First type fixes

7a974b2

Remove unused import

8e970d0

Migrate getTopmostReportActionID

a6b06a1

Use RootStackParamList type instead of ReactNavigation.RootParamList

a7edea8

Extract Route string union type

bf08755

Fix OnyxTabNavigator types

a9aa62d

Move RootStackParamList to Navigation/types

c71e7b0

Clean navigation file

21eff8e

Move Navigation types to separate folder

4551b3b

Update Navigation.md

17abe64

Clean types and fix linkTo utility

aa31b00

Fix type error in App.ts

c56d07b

Merge branch 'main' into ts/Navigation

3338376

Make sure Route isn't plain string

ff61b5f

Fix linkTo types

7bca0a9

Get navContainsProtectedRoutes and waitForProtectedRoutes back

b721660

Another portion with small adjustements

e522676

situchan suggested changes Nov 24, 2023

View reviewed changes

Improve types after final reviews

69423c1

situchan approved these changes Nov 24, 2023

View reviewed changes

melvin-bot bot requested a review from flodnv November 24, 2023 18:29

roryabraham reviewed Nov 26, 2023

View reviewed changes

Adjust after internal review

b4727e9

flodnv requested review from roryabraham and removed request for flodnv November 27, 2023 13:35

Fix lint

70f7488

flodnv mentioned this pull request Nov 27, 2023

[HOLD for payment 2023-12-07] [TS migration] Migrate 'Navigation' lib to TypeScript #24934

Closed

blazejkustra added 2 commits November 27, 2023 17:04

Fix the logic

c392e00

Remove a variable

c28b279

This was referenced Nov 28, 2023

[HOLD for payment 2023-12-20] [$250][Cleanup] Always use constants for screen names #32141

Closed

[$250] [Cleanup] Utility URL type for getURLWithBackParam, etc... #32143

Closed

roryabraham approved these changes Nov 28, 2023

View reviewed changes

roryabraham merged commit 27158b0 into Expensify:main Nov 28, 2023
19 checks passed

github-actions bot mentioned this pull request Nov 29, 2023

Deploy Checklist: New Expensify 2023-11-29 #32175

Closed

55 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Navigation' lib to TypeScript #31543

[TS migration] Migrate 'Navigation' lib to TypeScript #31543

blazejkustra commented Nov 20, 2023 •

edited

Loading

0xmiros commented Nov 24, 2023

situchan left a comment

blazejkustra commented Nov 24, 2023

situchan commented Nov 24, 2023

blazejkustra commented Nov 24, 2023

situchan commented Nov 24, 2023

situchan commented Nov 24, 2023

situchan left a comment

roryabraham Nov 26, 2023

blazejkustra Nov 27, 2023

roryabraham Nov 28, 2023

hamzasaleem2 Nov 29, 2023

roryabraham Nov 26, 2023

blazejkustra Nov 27, 2023

roryabraham Nov 28, 2023

roryabraham Nov 26, 2023

blazejkustra Nov 27, 2023

flodnv commented Nov 27, 2023

blazejkustra commented Nov 28, 2023

flodnv commented Nov 28, 2023 via email

OSBotify commented Nov 28, 2023

OSBotify commented Nov 30, 2023

		@@ -0,0 +1,401 @@
		/* eslint-disable @typescript-eslint/naming-convention */
		import {CommonActions, NavigationContainerRefWithCurrent, NavigationHelpers, NavigationState, NavigatorScreenParams, PartialRoute, Route} from '@react-navigation/native';

[TS migration] Migrate 'Navigation' lib to TypeScript #31543

[TS migration] Migrate 'Navigation' lib to TypeScript #31543

Conversation

blazejkustra commented Nov 20, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

0xmiros commented Nov 24, 2023

situchan left a comment

Choose a reason for hiding this comment

blazejkustra commented Nov 24, 2023

situchan commented Nov 24, 2023

blazejkustra commented Nov 24, 2023

situchan commented Nov 24, 2023

situchan commented Nov 24, 2023

Reviewer Checklist

Screenshots/Videos

situchan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flodnv commented Nov 27, 2023

blazejkustra commented Nov 28, 2023

flodnv commented Nov 28, 2023 via email

OSBotify commented Nov 28, 2023

OSBotify commented Nov 30, 2023

blazejkustra commented Nov 20, 2023 •

edited

Loading