Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor new date picker #21792

Merged
merged 24 commits into from
Jul 10, 2023

Conversation

ArekChr
Copy link
Contributor

@ArekChr ArekChr commented Jun 28, 2023

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

  1. Go to Date of Birth in Personal Details
  2. Select the year (nothing changes in the input)
  3. Select month (nothing changes in the input)
  4. Click on the day (the date is changing in the input)
  5. Change the month using right-left arrows (nothing changes in the input)
  6. 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

  1. Go to Date of Birth in Personal Details
  2. Select the year (nothing changes in the input)
  3. Select month (nothing changes in the input)
  4. Click on the day (the date is changing in the input)
  5. Change the month using right-left arrows (nothing changes in the input)
  6. Click on the day (the date is changing in the input)
  • Verify that no errors appear in the JS console

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 / Chrome
    • iOS / native
    • iOS / 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 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 author checklist, including those that don't apply to this PR.

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

Copy link
Contributor

@fabioh8010 fabioh8010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just nitpicks

@ArekChr ArekChr marked this pull request as ready for review June 29, 2023 11:34
@ArekChr ArekChr requested a review from a team as a code owner June 29, 2023 11:34
@melvin-bot melvin-bot bot requested review from fedirjh and removed request for a team June 29, 2023 11:34
@melvin-bot
Copy link

melvin-bot bot commented Jun 29, 2023

@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
Copy link
Contributor

fedirjh commented Jul 3, 2023

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
Screenshot 2023-07-03 at 11 58 19 AM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

mountiny commented Jul 7, 2023

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

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks we are very close, left few comments.

import {radioListItemPropTypes} from '../../SelectionListRadio/selectionListRadioPropTypes';

const propTypes = {
...withLocalizePropTypes,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
...withLocalizePropTypes,

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

    const {translate} = useLocalize();

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wasn't aware, thanks for this!


const propTypes = {
...withLocalizePropTypes,
...withCurrentUserPersonalDetailsPropTypes,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
...withCurrentUserPersonalDetailsPropTypes,

Not needed.

};

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines 73 to 74
textInputValue: '',
yearsFiltered: this.years,
Copy link
Contributor

@fedirjh fedirjh Jul 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

};

this.filterYears = this.filterYears.bind(this);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Same

@@ -305,12 +243,21 @@ class CalendarPicker extends React.PureComponent {
})}
</View>
))}
<YearPickerModal
isVisible={this.state.isYearPickerVisible}
years={this.state.yearsFiltered}
Copy link
Contributor

@fedirjh fedirjh Jul 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
years={this.state.yearsFiltered}
years={this.years}

we only need to pass initial years array.

Comment on lines 251 to 252
textInputValue={this.state.textInputValue}
onChangeText={this.filterYears}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
textInputValue={this.state.textInputValue}
onChangeText={this.filterYears}

As suggested , Not needed.

};

const defaultProps = {
...withCurrentUserPersonalDetailsDefaultProps,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
...withCurrentUserPersonalDetailsDefaultProps,

unused.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

unused.

@thiagobrez
Copy link
Contributor

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

@thiagobrez
Copy link
Contributor

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

@thiagobrez
Copy link
Contributor

Fixed 👌🏻

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good to me. Left one small comment.

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

@fedirjh fedirjh Jul 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

This will prevent searching for non num characters

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, done

@fedirjh
Copy link
Contributor

fedirjh commented Jul 10, 2023

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

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@mountiny
Copy link
Contributor

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

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks everyone, great job on this one 🎉

@mountiny mountiny merged commit 03b26f0 into Expensify:main Jul 10, 2023
@OSBotify
Copy link
Contributor

✋ 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
Copy link
Contributor

🚀 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 s77rt mentioned this pull request Jul 12, 2023
58 tasks
@s77rt
Copy link
Contributor

s77rt commented Jul 12, 2023

Awesome work! Love the simplification.

@OSBotify
Copy link
Contributor

🚀 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
Copy link
Contributor

Coming from #19073:

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

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✋ Coming from #33006

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

<Modal
type={CONST.MODAL.MODAL_TYPE.RIGHT_DOCKED}
isVisible={props.isVisible}
onClose={props.onClose}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.