[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript #30646

VickyStash · 2023-10-31T16:56:27Z

Details

[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript

Fixed Issues

$ #25063
$ #25091
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console

First test case:

Go to Settings
Open Workspaces -> open any workspace
Tap on Bank Account and add Bank Account using Plaid
Make sure the Account picker works as expected and press 'Next'
Make sure the Company type picker works as expected

Second test case:

Go to Settings
Open Workspaces -> open any workspace
Tap on Reimbursements
Press on the rate item in the Track Distance block
Check that Unit picker works as expected

Third test case:

Go to the Login screen and scroll down.
Make sure the Language picker works as expected.

Storybook
Look through Pickers in the storybook and make sure it looks as expected.

Offline tests

QA Steps

Verify that no errors appear in the JS console

The same as the Tests steps.

PR Author Checklist

Screenshots/Videos

Android: Native

android_locale.mp4

android1.mp4

android2.mp4

Android: mWeb Chrome

android_web3.mp4

android_web2.mp4

android_web1.mp4

iOS: Native

ios1.mp4

ios2.mp4

ios_locale.mp4

iOS: mWeb Safari

ios_web_locale.mp4

ios_web1.mp4

ios_web2.mp4

MacOS: Chrome / Safari

web_locale.mp4

web2.mp4

web1.mp4

MacOS: Desktop

desktop_locale.mp4

desktop2.mp4

desktop1.mp4

Storybook

melvin-bot · 2023-10-31T16:56:32Z

Hey! I see that you made changes to our Form component. Make sure to update the docs in FORMS.md accordingly. Cheers!

src/components/Picker/BasePicker.tsx

src/components/LocalePicker.tsx

src/components/Picker/index.native.tsx

src/components/Picker/index.tsx

src/components/Picker/BasePicker.tsx

# Conflicts: # src/components/Picker/BasePicker.js

# Conflicts: # src/components/LocalePicker.js

src/components/LocalePicker.tsx

src/components/Picker/BasePicker.tsx

kubabutkiewicz · 2023-11-21T11:50:38Z

src/components/Picker/BasePicker.tsx

+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [items]);
+
+    const context = useContext(ScrollContext);


I think it would be good to move it to ScrollContext file and extract it to seperate function lik

Suggested change

const context = useContext(ScrollContext);

const useScrollContext = () => useContext(ScrollContext);

so then we only need to import useScrollContext here

@kubabutkiewicz Maybe we should create a separate custom hook then? Cause I have found only two approaches in the codebase:

using context as in the current version (another example is PopoverContext usage)

separate custom hook - useLocalize for example

Separate custom hook is what I was suggesting here, so I would go with similar approach as useLocalize 😄

src/hooks/useScroll.ts

src/components/Picker/types.ts

src/components/Picker/BasePicker.tsx

fabioh8010 · 2023-11-22T11:13:28Z

src/components/Picker/BasePicker.tsx

+
+    if (isDisabled) {
+        return (
+            <View key={inputID}>


Why did you add key={inputID}? afaik inputID is only used internally inside Form logic.

Initially there was a forwardRef which also added an inputID key to the element.

But during this discussion it was updated.

@fabioh8010 So do you think it makes sense to revert it all (including forwardRef logic)?

Yeah I think it would be safer to revert it 🤔

src/components/Picker/BasePicker.tsx

src/components/Text.tsx

melvin-bot · 2023-11-24T16:50:48Z

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

# Conflicts: # package-lock.json # package.json # src/components/Picker/BasePicker.js

VickyStash · 2023-12-01T15:11:25Z

@aimane-chnaif kind bump 🙂

aimane-chnaif · 2023-12-03T20:40:37Z

package.json

@@ -143,7 +143,7 @@
    "react-native-pdf": "^6.7.3",
    "react-native-performance": "^5.1.0",
    "react-native-permissions": "^3.9.3",
-    "react-native-picker-select": "git+https://github.com/Expensify/react-native-picker-select.git#eae05855286dc699954415cc1d629bfd8e8e47e2",
+    "react-native-picker-select": "git+https://github.com/Expensify/react-native-picker-select.git#0d15d4618f58e99c1261921111e68ee85bb3c2a8",


Picker needs to be fully tested as this change includes Expensify/react-native-picker-select#14 which has lots of upstream changes

aimane-chnaif · 2023-12-03T20:53:29Z

src/components/Picker/index.tsx

+            // but doesn't open the picker (which we don't want), like it does on
+            // Native.
+            shouldFocusPicker
+            key={props.inputID}


Any error without this line? This was not existed before

@aimane-chnaif Initially there was a forwardRef which also added a key with inputID.

App/src/components/Picker/BasePicker.js

Lines 298 to 307 in d2056af

const BasePickerWithRef = React.forwardRef((props, ref) => (

<BasePicker

// eslint-disable-next-line react/jsx-props-no-spreading

{...props}

// Forward the ref to BasePicker, as we implement imperative methods there

forwardedRef={ref}

// eslint-disable-next-line react/prop-types

key={props.inputID}

/>

));

During TS migration forwardRef was refactored to align with other TS files so the key prop was moved from the BasePicker file to the BasePicker usage inside Picker files.

aimane-chnaif · 2023-12-04T04:08: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 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

android2.mov

Android: mWeb Chrome

mchrome.mov

iOS: Native

ios.mov

ios2.mov

iOS: mWeb Safari

msafari.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

desktop.mov

aimane-chnaif

LGTM 🎉

melvin-bot · 2023-12-04T12:50:48Z

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

deetergp · 2023-12-05T19:25:29Z

The two failing Snyk tests report that your package-lock.json is out of sync.

You also have a merge conflict. Please pull main and resolve it.

aimane-chnaif · 2023-12-05T19:27:29Z

Regarding snyk tests failure, I think this happens on all PRs which touched package file

# Conflicts: # src/components/Picker/BasePicker.js

aimane-chnaif · 2023-12-05T21:03:51Z

As there was conflict, please retest all 3 test cases on platforms to be safe

VickyStash · 2023-12-05T21:13:24Z

@aimane-chnaif I've retested only one case on all platforms and will be able to test 2 more tomorrow morning only 🌃.
At the same time the conflict was related just to hooks call order update and I just applied same update in relevant .tsx file, which looks straightforward.

aimane-chnaif

🎉

deetergp

Looks good and tests well 👍

OSBotify · 2023-12-06T01:11:16Z

✋ 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-12-06T22:17:16Z

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-06T23:11:26Z

🚀 Deployed to staging by https://github.com/deetergp in version: 1.4.9-0 🚀

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

OSBotify · 2023-12-08T01:08:33Z

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.4.9-5 🚀

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

[TS migration] Migrate 'Picker' and 'LocalePicker' components

2997f68

VickyStash added 3 commits October 31, 2023 18:00

Update picker style type

25f87b6

Update TODO messages

80816b6

Update react-native-picker-select lib version to resolve ts issues

4a1773e

VickyStash mentioned this pull request Nov 3, 2023

[TS migration] Update CustomPickerProps and Icon types Expensify/react-native-picker-select#15

Merged

VickyStash added 2 commits November 6, 2023 14:16

Merge branch 'main' into ts-migration/picker-component

192998e

Update react-native-picker-select lib to fix TS issues

a8b8188

kubabutkiewicz approved these changes Nov 6, 2023

View reviewed changes

BartoszGrajdek reviewed Nov 7, 2023

View reviewed changes

src/components/Picker/BasePicker.tsx Outdated Show resolved Hide resolved

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

src/components/LocalePicker.tsx Show resolved Hide resolved

blazejkustra suggested changes Nov 7, 2023

View reviewed changes

VickyStash added 10 commits November 8, 2023 17:55

Merge branch 'main' into ts-migration/picker-component

2cd2771

# Conflicts: # src/components/Picker/BasePicker.js

Update forwardRef logic

e376918

Merge branch 'main' into ts-migration/picker-component

977058f

Merge branch 'main' into ts-migration/picker-component

dbc9fca

# Conflicts: # src/components/LocalePicker.js

Updates after merging main

f17b26e

Trigger snyk checks

548c98a

Merge branch 'main' into ts-migration/picker-component

2222de7

Replace withLocalize HOC with hook usage

a73ba69

Update picker props type to be generic

da35fc0

Create separate function for default picker icon

aac29da

kubabutkiewicz reviewed Nov 21, 2023

View reviewed changes

Create separate Locale type and add useScroll hook

a53ec87

kubabutkiewicz reviewed Nov 21, 2023

View reviewed changes

src/hooks/useScroll.ts Outdated Show resolved Hide resolved

kubabutkiewicz approved these changes Nov 21, 2023

View reviewed changes

Rename custom hook

8914066

fabioh8010 reviewed Nov 22, 2023

View reviewed changes

VickyStash added 3 commits November 22, 2023 12:25

Minor code improvements

e9b526c

Update key usage

b6edfdc

Merge branch 'main' into ts-migration/picker-component

3ce21d3

VickyStash marked this pull request as ready for review November 24, 2023 16:50

VickyStash requested a review from a team as a code owner November 24, 2023 16:50

melvin-bot bot requested review from aimane-chnaif and removed request for a team November 24, 2023 16:50

VickyStash added 3 commits December 1, 2023 15:13

Merge branch 'main' into ts-migration/picker-component

9e3c8f7

# Conflicts: # package-lock.json # package.json # src/components/Picker/BasePicker.js

Updates after merging main

275a908

Remove old BasePicker js file

eb53666

aimane-chnaif reviewed Dec 3, 2023

View reviewed changes

aimane-chnaif approved these changes Dec 4, 2023

View reviewed changes

melvin-bot bot requested a review from deetergp December 4, 2023 12:50

VickyStash added 2 commits December 5, 2023 21:46

Merge branch 'main' into ts-migration/picker-component

01ea064

# Conflicts: # src/components/Picker/BasePicker.js

Update hooks call order to follow main updates

237bb94

aimane-chnaif approved these changes Dec 5, 2023

View reviewed changes

deetergp approved these changes Dec 6, 2023

View reviewed changes

deetergp merged commit 2f80993 into Expensify:main Dec 6, 2023
16 of 18 checks passed

github-actions bot mentioned this pull request Dec 6, 2023

Deploy Checklist: New Expensify 2023-12-06 #32589

Closed

74 tasks

This was referenced Dec 8, 2023

[HOLD for payment 2023-12-15] [TS migration] Migrate 'LocalePicker.js' component to TypeScript #25063

Closed

[HOLD for payment 2023-12-15] [TS migration] Migrate 'Picker' component to TypeScript #25091

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript #30646

[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript #30646

VickyStash commented Oct 31, 2023 •

edited by github-actions bot

Loading

melvin-bot bot commented Oct 31, 2023

kubabutkiewicz Nov 21, 2023

VickyStash Nov 21, 2023

kubabutkiewicz Nov 21, 2023

fabioh8010 Nov 22, 2023

VickyStash Nov 22, 2023

fabioh8010 Nov 22, 2023

melvin-bot bot commented Nov 24, 2023

VickyStash commented Dec 1, 2023

aimane-chnaif Dec 3, 2023

aimane-chnaif Dec 3, 2023

VickyStash Dec 4, 2023

aimane-chnaif commented Dec 4, 2023

aimane-chnaif left a comment

melvin-bot bot commented Dec 4, 2023

deetergp commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

VickyStash commented Dec 5, 2023

aimane-chnaif left a comment

deetergp left a comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

	const context = useContext(ScrollContext);
	const useScrollContext = () => useContext(ScrollContext);

	const BasePickerWithRef = React.forwardRef((props, ref) => (
	<BasePicker
	// eslint-disable-next-line react/jsx-props-no-spreading
	{...props}
	// Forward the ref to BasePicker, as we implement imperative methods there
	forwardedRef={ref}
	// eslint-disable-next-line react/prop-types
	key={props.inputID}
	/>
	));

[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript #30646

[TS migration] Migrate 'Picker' and 'LocalePicker' components to TypeScript #30646

Conversation

VickyStash commented Oct 31, 2023 • edited by github-actions bot Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Oct 31, 2023

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

melvin-bot bot commented Nov 24, 2023

VickyStash commented Dec 1, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aimane-chnaif commented Dec 4, 2023

Reviewer Checklist

Screenshots/Videos

aimane-chnaif left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 4, 2023

deetergp commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

aimane-chnaif commented Dec 5, 2023

VickyStash commented Dec 5, 2023

aimane-chnaif left a comment

Choose a reason for hiding this comment

deetergp left a comment

Choose a reason for hiding this comment

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 6, 2023

OSBotify commented Dec 8, 2023

VickyStash commented Oct 31, 2023 •

edited by github-actions bot

Loading