[TS Migration] NewDatePicker #35642

WojtekBoman · 2024-02-02T08:48:15Z

Details

Migration of DatePicker to Typescript. This PR also contains the fix for the dates comparison in the getDayValidationErrorKey function. Currently on the main branch in the getDayValidationErrorKey dates are compared based on getDayOfYear function from date-fns. This function checks if the input date is in the future compared to the reference date. But this function doesn't work correctly when the input date has an earlier day of the year than the reference date, but has a later year. It can be noticed on the main branch when we try to set the date according to the mentioned conditions in StatusClearAfterPage:

Screen.Recording.2024-02-12.at.10.11.08.mov

Fixed Issues

$ #25148
PROPOSAL: N/A

Tests

Verify that no errors appear in the JS console
Open any screen where the DatePicker is available, for example: StatusClearAfterPage.
Check whether all elements of the DatePicker behave correctly: YearPickerModal, switching months by arrows etc.
Verify that the dates comparison now works properly
- Open StatusClearAfterPage
- Try to set the date with a later year and an earlier day than today's date
- Check if any error occurred

Offline tests

N/A

QA Steps

Same as tests

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-02-02.at.13.53.14.mov

Android: mWeb Chrome

Screen.Recording.2024-02-02.at.13.51.10.mov

iOS: Native

Screen.Recording.2024-02-02.at.14.17.23.mov

iOS: mWeb Safari

Screen.Recording.2024-02-02.at.14.28.59.mov

MacOS: Chrome / Safari

Screen.Recording.2024-02-02.at.13.54.49.mov

MacOS: Desktop

Screen.Recording.2024-02-02.at.13.56.34.mov

melvin-bot · 2024-02-02T08:48:19Z

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

blazejkustra

Nice work! LGTM

blazejkustra · 2024-02-02T11:07:59Z

src/components/DatePicker/index.tsx

-DatePickerWithRef.displayName = 'DatePickerWithRef';
-
-export default DatePickerWithRef;
+export default React.forwardRef(DatePicker);


NAB: import forwardRef instead of using React.forwardRef

melvin-bot · 2024-02-06T10:57:01Z

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

akinwale · 2024-02-09T23:07:00Z

@WojtekBoman Are there test steps for validating the getDayValidationErrorKey fix?

akinwale · 2024-02-09T23:07: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(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

35642-android-native.mp4

Android: mWeb Chrome

35642-android-chrome.mp4

iOS: Native

35642-ios-native.mp4

iOS: mWeb Safari

35642-ios-safari.mp4

MacOS: Chrome / Safari

35642-web.mp4

MacOS: Desktop

akinwale · 2024-02-10T08:48:34Z

@WojtekBoman I get the following error trying to access the Date of Birth screen from Personal Details.

Uncaught TypeError: Cannot read properties of undefined (reading 'length')
    at generateMonthMatrix (generateMonthMatrix.ts:54:1)
    at CalendarPicker (index.tsx:141:47)
    at renderWithHooks (react-dom.development.js:16175:18)
    at mountIndeterminateComponent (react-dom.development.js:20908:13)
    at beginWork (react-dom.development.js:22411:16)
    at HTMLUnknownElement.callCallback (react-dom.development.js:4161:14)
    at Object.invokeGuardedCallbackDev (react-dom.development.js:4210:16)
    at invokeGuardedCallback (react-dom.development.js:4274:31)
    at beginWork$1 (react-dom.development.js:27400:7)
    at performUnitOfWork (react-dom.development.js:26511:12)

WojtekBoman · 2024-02-12T09:03:23Z

@WojtekBoman I get the following error trying to access the Date of Birth screen from Personal Details.

Uncaught TypeError: Cannot read properties of undefined (reading 'length')
    at generateMonthMatrix (generateMonthMatrix.ts:54:1)
    at CalendarPicker (index.tsx:141:47)
    at renderWithHooks (react-dom.development.js:16175:18)
    at mountIndeterminateComponent (react-dom.development.js:20908:13)
    at beginWork (react-dom.development.js:22411:16)
    at HTMLUnknownElement.callCallback (react-dom.development.js:4161:14)
    at Object.invokeGuardedCallbackDev (react-dom.development.js:4210:16)
    at invokeGuardedCallback (react-dom.development.js:4274:31)
    at beginWork$1 (react-dom.development.js:27400:7)
    at performUnitOfWork (react-dom.development.js:26511:12)

This issue has been solved :)

WojtekBoman · 2024-02-12T09:34:20Z

@WojtekBoman Are there test steps for validating the getDayValidationErrorKey fix?

I've updated Details and Tests sections :)

akinwale

LGTM.

puneetlath

Just one small question.

src/components/DatePicker/index.tsx

OSBotify · 2024-02-14T15:50:00Z

✋ 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-02-15T05:36:25Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.4.42-0 🚀

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

OSBotify · 2024-02-19T23:34:33Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.42-5 🚀

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

WojtekBoman added 7 commits January 8, 2024 11:29

Migrate ArrowIcon to TS

b768721

Migrate YearPickerModal and generateMonthMatrix with tests to TS

7d2ee90

Rewrite CalendarDatePicker to functional component

0a2d2f0

Migrate CalendarPicker to TS

84ecc82

Migrate DatePicker to TS

3860f2c

Add ts-expect-error to YearPickerModal

9593fd9

Merge branch 'main' into ts-migration/new-date-picker

075e239

WojtekBoman added 5 commits February 2, 2024 11:04

Add type fixes to CalendarPicker

2e73f89

Refactor default values in CalendarPicker components

769bf49

Remove type tests for generateMonthMatrix

4eebd52

Refactor generateMonthMatrixTest

2e5c595

Add DatePicker type to ValidInputs

fe9273a

blazejkustra approved these changes Feb 2, 2024

View reviewed changes

WojtekBoman added 2 commits February 2, 2024 12:19

Add import forwardRef in DatePicker

252e4c0

Fix the dates comparison in getDayValidationErrorKey

5aa45c3

kubabutkiewicz approved these changes Feb 6, 2024

View reviewed changes

WojtekBoman marked this pull request as ready for review February 6, 2024 10:56

WojtekBoman requested a review from a team as a code owner February 6, 2024 10:56

melvin-bot bot requested review from akinwale and removed request for a team February 6, 2024 10:56

WojtekBoman added 2 commits February 12, 2024 08:43

Merge branch 'main' into ts-migration/new-date-picker

cddb4bc

Fix setting default values in CalendarPicker

0e0d50a

akinwale approved these changes Feb 12, 2024

View reviewed changes

melvin-bot bot requested a review from puneetlath February 12, 2024 10:53

WojtekBoman added 2 commits February 12, 2024 17:28

Merge branch 'main' into ts-migration/new-date-picker

a600205

Merge branch 'main' into ts-migration/new-date-picker

8145cf7

puneetlath reviewed Feb 13, 2024

View reviewed changes

src/components/DatePicker/index.tsx Show resolved Hide resolved

WojtekBoman added 2 commits February 14, 2024 09:24

Merge branch 'main' into ts-migration/new-date-picker

7374817

Refactor check in DatePicker

17a89e3

puneetlath approved these changes Feb 14, 2024

View reviewed changes

puneetlath merged commit 41237e3 into Expensify:main Feb 14, 2024
16 checks passed

github-actions bot mentioned this pull request Feb 15, 2024

Deploy Checklist: New Expensify 2024-02-15 #36558

Closed

73 tasks

melvin-bot bot mentioned this pull request Feb 19, 2024

[HOLD for payment 2024-02-26] [TS migration] Migrate 'NewDatePicker' component to TypeScript #25148

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TS Migration] NewDatePicker #35642

[TS Migration] NewDatePicker #35642

WojtekBoman commented Feb 2, 2024 •

edited

Loading

melvin-bot bot commented Feb 2, 2024

blazejkustra left a comment

blazejkustra Feb 2, 2024

melvin-bot bot commented Feb 6, 2024

akinwale commented Feb 9, 2024

akinwale commented Feb 9, 2024 •

edited

Loading

akinwale commented Feb 10, 2024

WojtekBoman commented Feb 12, 2024

WojtekBoman commented Feb 12, 2024

akinwale left a comment

puneetlath left a comment

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

[TS Migration] NewDatePicker #35642

[TS Migration] NewDatePicker #35642

Conversation

WojtekBoman commented Feb 2, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Feb 2, 2024

blazejkustra left a comment

Choose a reason for hiding this comment

blazejkustra Feb 2, 2024

Choose a reason for hiding this comment

melvin-bot bot commented Feb 6, 2024

akinwale commented Feb 9, 2024

akinwale commented Feb 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

akinwale commented Feb 10, 2024

WojtekBoman commented Feb 12, 2024

WojtekBoman commented Feb 12, 2024

akinwale left a comment

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

OSBotify commented Feb 14, 2024

OSBotify commented Feb 15, 2024

OSBotify commented Feb 19, 2024

WojtekBoman commented Feb 2, 2024 •

edited

Loading

akinwale commented Feb 9, 2024 •

edited

Loading