[TS migration] Migrate 'DistanceMapView' component to TypeScript by esh-g · Pull Request #33553 · Expensify/App

esh-g · 2023-12-23T18:39:59Z

Details

Fixed Issues

$ #31958
PROPOSAL: #31958 (comment)

Tests

Go to request money
Select the distance tab
Enter any waypoints
Select any workspace.
Make sure the map view works correctly.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to request money
Select the distance tab
Enter any waypoints
Select any workspace.
Make sure the map view works correctly.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

c67a5708-fb46-4ea7-afe8-549aad567566.mp4

Android: mWeb Chrome

2c641428-e7dd-4a6f-9e95-ecae4d2d1d4e.mp4

iOS: Native

80b92d97-6bcf-4bbd-8fb7-ffcd8a0ef60a.mp4

iOS: mWeb Safari

MacOS: Chrome / Safari

Screen.Recording.2023-12-23.at.11.47.23.PM-1.mov

MacOS: Desktop

bebd4eb0-842a-43c7-9f38-58fb77bec7b4.mp4

melvin-bot · 2023-12-23T18:40:04Z

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

esh-g · 2023-12-27T16:07:34Z

@cubuspl42 I was unable to add testing video for ios mWeb because for some reason the web is not loading locally on the simulator... Could you please help me to test that?

VickyStash · 2023-12-28T09:54:30Z

+import {StyleProp, ViewStyle} from 'react-native';
+import {ComponentProps} from '@components/MapView/types';
+
+type DistanceMapViewProps = ComponentProps & {
+    overlayStyle: StyleProp<ViewStyle>;
+};
+
+export default DistanceMapViewProps;


Since ComponentProps consists of MapViewProps & MapViewOnyxProps, and we don't pass MapViewOnyxProps userLocation to the component (you can test usage of DistanceMapView component, with current implementation it will give TS error requiring userLocation param), I think we should use MapViewProps only.

Suggested change

import {StyleProp, ViewStyle} from 'react-native';

import {ComponentProps} from '@components/MapView/types';

type DistanceMapViewProps = ComponentProps & {

overlayStyle: StyleProp<ViewStyle>;

};

export default DistanceMapViewProps;

import {StyleProp, ViewStyle} from 'react-native';

import type {MapViewProps} from '@components/MapView/MapViewTypes';

type DistanceMapViewProps = MapViewProps & {

overlayStyle: StyleProp<ViewStyle>;

};

export default DistanceMapViewProps;

Besides that we need to update MapView index.tsx to use MapViewProps only as well.

This way the combination of MapViewProps & MapViewOnyxProps will be used only in MapView component files (1,2) which wrapped into withOnyx HOC and have the Onyx values.

@VickyStash Made the requested change here: 975ebad
Please resolve the conversation if it is as expected 😇

VickyStash

LGTM, just minor comment

Co-authored-by: VickyStash <vikstash@gmail.com>

VickyStash · 2023-12-28T13:31:42Z

Also please update PR name to follow the issue name, so
[TS migration] Migrate 'DistanceMapView' component to TypeScript

esh-g · 2023-12-28T13:32:45Z

Done!

jakub-trzebiatowski · 2024-01-02T13:03:58Z

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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

ts-distance-map-view-android-compressed.mp4

Android: mWeb Chrome

ts-distance-map-view-android-web-compressed.mp4

iOS: Native

iOS: mWeb Safari

ts-distance-map-view-ios-web.mp4

MacOS: Chrome / Safari

ts-distance-map-view-web.mp4

MacOS: Desktop

jakub-trzebiatowski

@esh-g Please merge main

esh-g · 2024-01-02T13:13:34Z

@cubuspl42 Merged!

OSBotify · 2024-01-02T19:12:37Z

✋ 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 · 2024-01-02T23:52:13Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.4.21-0 🚀

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

OSBotify · 2024-01-04T18:54:49Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T19:19:39Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

OSBotify · 2024-01-04T20:17:06Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.21-4 🚀

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

[TS Migration] DistanceMapView

3619114

esh-g requested a review from a team as a code owner December 23, 2023 18:40

melvin-bot Bot removed the request for review from a team December 23, 2023 18:40

melvin-bot Bot requested a review from jakub-trzebiatowski December 23, 2023 18:40

esh-g mentioned this pull request Dec 23, 2023

[HOLD for payment 2024-01-11] [$250] [TS migration] Migrate 'DistanceMapView' component to TypeScript #31958

Closed

jakub-trzebiatowski suggested changes Dec 27, 2023

View reviewed changes

Comment thread src/components/DistanceMapView/index.tsx Outdated

esh-g added 2 commits December 27, 2023 21:25

Change style

e7976ad

Fix lint

3c5633f

VickyStash reviewed Dec 28, 2023

View reviewed changes

jakub-trzebiatowski suggested changes Dec 28, 2023

View reviewed changes

Comment thread src/components/DistanceMapView/index.android.tsx Outdated

esh-g added 2 commits December 28, 2023 18:34

Remove Stylesheet.flatten

804b01c

Fix ComponentProps -> MapViewProps

975ebad

VickyStash approved these changes Dec 28, 2023

View reviewed changes

Comment thread src/components/DistanceMapView/types.ts Outdated

Make overlayStyle optional

be52246

Co-authored-by: VickyStash <vikstash@gmail.com>

esh-g changed the title ~~[TS Migration] DistanceMapView~~ [TS migration] Migrate 'DistanceMapView' component to TypeScript Dec 28, 2023

jakub-trzebiatowski suggested changes Jan 2, 2024

View reviewed changes

Merge branch 'main' into ts-distance-map-view

79ab0dd

jakub-trzebiatowski approved these changes Jan 2, 2024

View reviewed changes

melvin-bot Bot requested a review from cristipaval January 2, 2024 13:20

cristipaval approved these changes Jan 2, 2024

View reviewed changes

cristipaval merged commit 58f97cd into Expensify:main Jan 2, 2024

github-actions Bot mentioned this pull request Jan 2, 2024

Deploy Checklist: New Expensify 2024-01-02 #33855

Closed

58 tasks

Uh oh!

Conversation

esh-g commented Dec 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot Bot commented Dec 23, 2023

Uh oh!

Uh oh!

esh-g commented Dec 27, 2023

Uh oh!

Uh oh!

VickyStash Dec 28, 2023

Choose a reason for hiding this comment

Uh oh!

esh-g Dec 28, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VickyStash left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VickyStash commented Dec 28, 2023

Uh oh!

esh-g commented Dec 28, 2023

Uh oh!

jakub-trzebiatowski commented Jan 2, 2024

Reviewer Checklist

Screenshots/Videos

Uh oh!

jakub-trzebiatowski left a comment

Choose a reason for hiding this comment

Uh oh!

esh-g commented Jan 2, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OSBotify commented Jan 2, 2024

Uh oh!

OSBotify commented Jan 2, 2024

Uh oh!

OSBotify commented Jan 4, 2024

Uh oh!

OSBotify commented Jan 4, 2024

Uh oh!

OSBotify commented Jan 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

esh-g commented Dec 23, 2023 •

edited

Loading

esh-g commented Jan 2, 2024 •

edited

Loading