Refactor new date picker by ArekChr · Pull Request #21792 · Expensify/App

ArekChr · 2023-06-28T13:01:54Z

Details

This pull request introduces significant improvements to the Date Picker component by refactoring the codebase and implementing logic changes. The main objectives are to enhance reusability by removing navigation.

Fixed Issues

$ #20630
PROPOSAL: #20630 (comment)

Tests

Go to Date of Birth in Personal Details
Select the year (nothing changes in the input)
Select month (nothing changes in the input)
Click on the day (the date is changing in the input)
Change the month using right-left arrows (nothing changes in the input)
Click on the day (the date is changing in the input)

Verify that no errors appear in the JS console

Offline tests

No offline tests needed.

QA Steps

Go to Date of Birth in Personal Details
Select the year (nothing changes in the input)
Select month (nothing changes in the input)
Click on the day (the date is changing in the input)
Change the month using right-left arrows (nothing changes in the input)
Click on the day (the date is changing in the input)

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mobile.chrome.mov

Mobile Web - Safari

mobile.safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

android.mov

…n, poc for year picker modal

fabioh8010

Just nitpicks

melvin-bot · 2023-06-29T11:34:40Z

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

fedirjh · 2023-07-03T13:51:54Z

Hey there @ArekChr , We have some bugs :

When Selecting a Year or a Month, it doesn’t update the date

Screen.Recording.2023-07-03.at.2.45.41.PM.mov

Text selected upon clicking arrows or calendar icon

Screen.Recording.2023-07-03.at.11.59.24.AM.mov

Screen.Recording.2023-07-03.at.11.59.54.AM.mov

Extra horizontal margin for the years selector

fedirjh · 2023-07-04T15:49:31Z

@ArekChr I believe we implemented something different for a similar case , specifically the AvatarCropModal , we utilized the modal to display a new screen. It appears that the modal possesses the necessary animations and props to handle this scenario as well. I'm uncertain about the optimal approach we should adopt, but for the sake of consistency, I think it's best to adhere to a single approach.

Great idea! What you proposed works flawlessly, with the only difference being that the modal has a backdrop, that the YearPickerPage did not have previously. But this matches the AvatarCropModal and brings more design consistency, so I think it's a even bigger win

Screen.Recording.2023-07-06.at.14.53.57.mov

mountiny · 2023-07-07T23:03:30Z

thanks for the reviews and testing so far. great job, lets egt this done on Monday 🎉

fedirjh

Looks we are very close, left few comments.

fedirjh · 2023-07-09T19:27:14Z

+import {radioListItemPropTypes} from '../../SelectionListRadio/selectionListRadioPropTypes';
+
+const propTypes = {
+    ...withLocalizePropTypes,


Suggested change

...withLocalizePropTypes,

Since this is a functional component we should use localize hook :

const {translate} = useLocalize();

I wasn't aware, thanks for this!

fedirjh · 2023-07-09T19:27:27Z

+
+const propTypes = {
+    ...withLocalizePropTypes,
+    ...withCurrentUserPersonalDetailsPropTypes,


Suggested change

...withCurrentUserPersonalDetailsPropTypes,

Not needed.

fedirjh · 2023-07-09T19:36:49Z

+};
+
+function YearPickerModal(props) {
+    const headerMessage = props.textInputValue.trim() && !props.years.length ? props.translate('common.noResultsFound') : '';


I think we should handle the search (filtering) inside this component something similar to :

const [searchText, setSearchText] = useState(''); const {sections, headerMessage} = useMemo( () => { const yearsList = searchText === '' ? props.years : _.filter(props.years, (year) => year.text.includes(searchText)); return { headerMessage: !yearsList.length ? translate('common.noResultsFound') : '', sections: [{data: yearsList, indexOffset: 0}], } }, [props.years, searchText], )

This will avoids unnecessary renders of calendar when we filter the list. It will also resets the search and fix this bug :

Screen.Recording.2023-07-09.at.8.34.52.PM.mov

Cool, I like this approach. But that does not reset the search alone, because the modal is never unmounted, it just becomes invisible. So I also added an effect to clear the search text when it closes

fedirjh · 2023-07-09T19:38:20Z

+            textInputValue: '',
+            yearsFiltered: this.years,


As suggested , let's move filtering logic to YearPickerModal.

fedirjh · 2023-07-09T19:38:31Z

+            yearsFiltered: this.years,
        };

+        this.filterYears = this.filterYears.bind(this);


Suggested change

this.filterYears = this.filterYears.bind(this);

Same

fedirjh · 2023-07-09T19:39:50Z

                ))}
+                <YearPickerModal
+                    isVisible={this.state.isYearPickerVisible}
+                    years={this.state.yearsFiltered}


Suggested change

years={this.state.yearsFiltered}

years={this.years}

we only need to pass initial years array.

fedirjh · 2023-07-09T19:40:44Z

+                    textInputValue={this.state.textInputValue}
+                    onChangeText={this.filterYears}


Suggested change

textInputValue={this.state.textInputValue}

onChangeText={this.filterYears}

As suggested , Not needed.

fedirjh · 2023-07-09T19:41:51Z

+};
+
+const defaultProps = {
+    ...withCurrentUserPersonalDetailsDefaultProps,


Suggested change

...withCurrentUserPersonalDetailsDefaultProps,

unused.

fedirjh · 2023-07-09T19:42:07Z

@@ -0,0 +1,84 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import {withCurrentUserPersonalDetailsDefaultProps, withCurrentUserPersonalDetailsPropTypes} from '../../withCurrentUserPersonalDetails';


Suggested change

import {withCurrentUserPersonalDetailsDefaultProps, withCurrentUserPersonalDetailsPropTypes} from '../../withCurrentUserPersonalDetails';

unused.

thiagobrez · 2023-07-10T10:11:37Z

@fedirjh Sent fixes to all your latest comments! :)

thiagobrez · 2023-07-10T11:04:33Z

I see that some unit tests failed and I'm working on it 👍🏻

thiagobrez · 2023-07-10T12:48:50Z

Fixed 👌🏻

fedirjh

Code looks good to me. Left one small comment.

fedirjh · 2023-07-10T13:32:29Z

+                textInputLabel={translate('yearPickerPage.selectYear')}
+                textInputValue={searchText}
+                textInputMaxLength={4}
+                onChangeText={setSearchText}


Suggested change

onChangeText={setSearchText}

onChangeText={(text) => setSearchText(text.replace(CONST.REGEX.NON_NUMERIC, '').trim())}

This will prevent searching for non num characters

fedirjh · 2023-07-10T15:08:17Z

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 / Chrome
- iOS / native
- iOS / 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 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

Screen.Recording.2023-07-10.at.3.34.56.PM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-10.at.3.33.59.PM.mov

Mobile Web - Safari

Screen.Recording.2023-07-10.at.3.09.31.PM.mov

Desktop

Desktop.mov

iOS

Screen.Recording.2023-07-10.at.2.24.08.PM.mov

Android

Screen.Recording.2023-07-10.at.3.32.34.PM.mov

fedirjh

Looks good to me.

mountiny · 2023-07-10T16:32:22Z

@fedirjh Great job on the review and thanks @thiagobrez for acting fast!

mountiny

Thanks everyone, great job on this one 🎉

OSBotify · 2023-07-10T17:01:30Z

✋ 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-07-11T00:19:40Z

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

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

s77rt · 2023-07-12T14:08:16Z

Awesome work! Love the simplification.

OSBotify · 2023-07-13T01:43:42Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.39-11 🚀

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

aimane-chnaif · 2023-08-31T13:15:32Z

Coming from #19073:

This refactor (page > modal) caused modal overlay regression again which was fixed during navigation refactor, though it's minor UI inconsistency.

mollfpr · 2024-01-18T16:47:47Z

-                this.props.onSelected(this.getSelectedDateString());
-            },
-        );
+        this.setState((prev) => ({currentDateView: moment(prev.currentDateView).subtract(1, 'months').toDate()}));


✋ Coming from #33006

The refactor for moveToPrevMonth and moveToNextMonth doesn't update the year.

hungvu193 · 2024-12-12T03:05:00Z

+        <Modal
+            type={CONST.MODAL.MODAL_TYPE.RIGHT_DOCKED}
+            isVisible={props.isVisible}
+            onClose={props.onClose}


We should include shouldHandleNavigationBack props to handle physical back button on mWeb. More details in:
#52383 (comment)

@hungvu193 shouldHandleNavigationBack was not present when this PR was implemented. It was added in #38693.

ArekChr added 12 commits June 28, 2023 14:51

refactor: remove navigation, fix props passing, remove unused functio…

3db9586

…n, poc for year picker modal

refactor: move CalendarPicker components to NewDatePicker dir

1fab207

refactor: move ScreenSlideAnimation to separated file

cc26bc1

refactor: move ScreenSlideAnimation to separated file

9bd8759

refactor: YearPickerPage constructor

dc1c96c

fix: withlocalizeprops import

c65f5a1

refactor: remove old functionalities

a6a69de

fix: window animation jumping bug

be2e0d0

refactor: undo imports order

8abedfd

refactor: mv default props to calendar picker

0481fe3

fix: eslint-disable-next-line in useImperativeHandle and useEffect

ad29d05

refactor: remove Select Year from navigator

ab4ca50

fabioh8010 reviewed Jun 28, 2023

View reviewed changes

gedu reviewed Jun 28, 2023

View reviewed changes