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

fix: constrain min and max age date for dob pickers #17072

Merged
merged 4 commits into from
Apr 12, 2023

Conversation

koko57
Copy link
Contributor

@koko57 koko57 commented Apr 6, 2023

Details

Fixed Issues

$ #16691
PROPOSAL: #16691(COMMENT) - alternative solution

Tests

  1. Go Settings -> Workspaces -> [Select your workspace] -> Issue cards -> Connect Bank Account -> Connect manually
  2. Fill out the 1 and 2 steps of the form (Incorporation Date date picker should have no constraints)
  3. Proceed to Personal Information Step - DOB date picker dates should be constrained to the current date - 18 years. Minimum date from the past should be 150 years back from now.
    --- AdditionalDetailsStep
  4. Go to back to Settings then -> Payments -> Transfer Balance (if you have this option) -> Additional Details Step should appear
  5. Date picker for DOB should have the same constraints as described in 3.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

  1. Go Settings -> Workspaces -> [Select your workspace] -> Issue cards -> Connect Bank Account -> Connect manually
  2. Fill out the 1 and 2 steps of the form (Incorporation Date date picker should have no constraints)
  3. Proceed to Personal Information Step - DOB date picker dates should be constrained to the current date - 18 years. Minimum date from the past should be 150 years back from now.
    --- AdditionalDetailsStep
  4. Go to back to Settings then -> Payments -> Transfer Balance (if you have this option) -> Additional Details Step should appear
  5. Date picker for DOB should have the same constraints as described in 3.
  • 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 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 correct English and 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 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

Screenshot 2023-04-06 at 10 24 04
Screenshot 2023-04-06 at 10 24 26
Screenshot 2023-04-06 at 15 34 46

Mobile Web - Chrome

Screenshot_1680770408
Screenshot_1680770406

Mobile Web - Safari

#16691 (comment)

Desktop

Screenshot 2023-04-06 at 10 10 45
Screenshot 2023-04-06 at 10 10 27

iOS

Simulator Screen Shot - iPhone 13 - 2023-04-06 at 12 03 25
Simulator Screen Shot - iPhone 13 - 2023-04-06 at 12 00 33

Android

Screenshot_1680770139
Screenshot_1680770128

@MelvinBot
Copy link

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

@@ -18,11 +18,16 @@ const propTypes = {
* `onInputChange` would always be called with a Date (or null)
*/
defaultValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),

minDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
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
minDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
/** A minimum date (oldest) allowed to select */
minDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),

@@ -18,11 +18,16 @@ const propTypes = {
* `onInputChange` would always be called with a Date (or null)
*/
defaultValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),

minDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
maxDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
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
maxDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
/** A maximum date (earliest) allowed to select */
maxDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),

@@ -18,6 +18,9 @@ class DatePicker extends React.Component {

this.showPicker = this.showPicker.bind(this);
this.setDate = this.setDate.bind(this);

this.maxDate = this.props.maxDate || new Date(CONST.DATE.MAX_DATE);
Copy link
Contributor

Choose a reason for hiding this comment

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

Too many repetition, lets move new new Date(CONST.DATE.MAX_DATE) and new Date(CONST.DATE.MIN_DATE) to default props

@@ -18,11 +18,16 @@ const propTypes = {
* `onInputChange` would always be called with a Date (or null)
*/
defaultValue: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),

minDate: PropTypes.oneOfType([PropTypes.instanceOf(Date), PropTypes.string]),
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest unifying the types to a single type, Date instead of a Date or a string

src/components/DatePicker/index.ios.js Outdated Show resolved Hide resolved
@MelvinBot
Copy link

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

@Santhosh-Sellavel
Copy link
Collaborator

I'm not sure why it doesn't request review from assigned CME or C+ on the issue

@alexxxwork
Copy link
Contributor

alexxxwork commented Apr 7, 2023

I'm not sure why it doesn't request review from assigned CME or C+ on the issue

@Santhosh-Sellavel Because you need to mention them in the first (comment) line of the PR template. And it works only once on PR creation.

@Santhosh-Sellavel
Copy link
Collaborator

Oh yes seems @koko57 missed including issue link while creating PR

@alexxxwork
Copy link
Contributor

Oh yes seems @koko57 missed including issue link while creating PR

@Santhosh-Sellavel automatic reviewers assignment works based on first line of PR only, and not on linked issue.

@Santhosh-Sellavel
Copy link
Collaborator

Sorry, that's not the case, it happens from issue linking only where details of CME & C+ are taken and requests review from them check at old PRs. We had to do it right the first time while submitting it's ready for review or it messes up.

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Adding myself as reviewer

@alexxxwork
Copy link
Contributor

Sorry, that's not the case, it happens from issue linking only where details of CME & C+ are taken and requests review from them check at old PRs. We had to do it right the first time while submitting it's ready for review or it messes up.

Well, then I'm not shure how it works. In this PR there was a correctly linked issue, but I've accidently moved mentioned reviewers on the second line so PullerBear hadn't assigned anyone.

@Santhosh-Sellavel
Copy link
Collaborator

But I'm sure about how this work, that's why have the following as the first checklist item.

I linked the correct issue in the ### Fixed Issues section above

@thienlnam thienlnam requested review from deetergp and removed request for thienlnam April 10, 2023 18:08
@thienlnam
Copy link
Contributor

Adding @deetergp to this since this is from the issue he is CME on

Comment on lines +28 to +29
this.inputRef.setAttribute('max', moment(this.props.maxDate).format(CONST.DATE.MOMENT_FORMAT_STRING));
this.inputRef.setAttribute('min', moment(this.props.minDate).format(CONST.DATE.MOMENT_FORMAT_STRING));
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need to format it here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For min and max attribute input type="date" accepts a formatted string (yyyy-mm-dd). We pass the prop in Date format, so it needs to be formatted to work properly. We do the same for the value and the defaultValue.

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.

Looking good, @Santhosh-Sellavel will you be able to run through the testing and checklist?

@Santhosh-Sellavel
Copy link
Collaborator

Ah missed this one, will get it done today.

@Santhosh-Sellavel
Copy link
Collaborator

Santhosh-Sellavel commented Apr 12, 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 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 correct English and 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 & Desktop
Screen.Recording.2023-04-13.at.12.04.22.AM.mov
Mobile Web - Chrome
Screen_Recording_20230413_002721_Chrome.mp4
Mobile Web - Safari

N/A as it fails we already know

iOS
Simulator.Screen.Recording.-.iPhone.14.-.2023-04-13.at.00.35.11.mp4
Android
Screen_Recording_20230413_002531_New.Expensify.mp4

Copy link
Collaborator

@Santhosh-Sellavel Santhosh-Sellavel left a comment

Choose a reason for hiding this comment

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

Mostly looks and tests wells!

Comment on lines +113 to +114
this.minDate = moment().subtract(CONST.DATE_BIRTH.MAX_AGE, 'Y').toDate();
this.maxDate = moment().subtract(CONST.DATE_BIRTH.MIN_AGE_FOR_PAYMENT, 'Y').toDate();
Copy link
Collaborator

Choose a reason for hiding this comment

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

Repeating this logic twice looks a bit off to me @mountiny @deetergp

Copy link
Contributor

Choose a reason for hiding this comment

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

NAB, since they're one-liners and I'm not going to lose sleep over it. But since you bring it up, maybe it makes more sense to put the logic in the DatePicker component since both pages use it.

Comment on lines +113 to +114
this.minDate = moment().subtract(CONST.DATE_BIRTH.MAX_AGE, 'Y').toDate();
this.maxDate = moment().subtract(CONST.DATE_BIRTH.MIN_AGE_FOR_PAYMENT, 'Y').toDate();
Copy link
Contributor

Choose a reason for hiding this comment

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

NAB, since they're one-liners and I'm not going to lose sleep over it. But since you bring it up, maybe it makes more sense to put the logic in the DatePicker component since both pages use it.

@Santhosh-Sellavel
Copy link
Collaborator

Cool @deetergp Since we are going to remove old DatePicker soon, Lets merge this one.

@deetergp deetergp merged commit 1b756ef into Expensify:main Apr 12, 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/deetergp in version: 1.3.0-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.0-2 🚀

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

@koko57 koko57 deleted the fix/16691-date-picker-no-constraint branch April 18, 2023 06:19
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.

9 participants