refactor: forward ref to datepicker instance #16779

ArekChr · 2023-03-31T08:39:53Z

Details

Fixed Issues

$ #16551
$ #16551 (comment)

Tests

Go to settings -> Profile -> Personal Details
Click Date of birth
It should open the date of birth page with opened new calendar picker

Verify that no errors appear in the JS console

Offline tests

No offline tests needed

QA Steps

Go to settings -> Profile -> Personal Details
Click Date of birth
It should open the date of birth page with opened new calendar picker

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

web.mov

Mobile Web - Chrome

mWeb.Chrome.mov

Mobile Web - Safari

mWeb.Safari.mov

Desktop

desktop.mov

iOS

ios.mov

Android

Android.mov

MelvinBot · 2023-03-31T08:40:01Z

@mountiny @mollfpr One of you needs to 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]

ArekChr · 2023-03-31T08:42:03Z

I faced a ref forwarding issue, componentDidMount is called before the ref callback, so I wrapped it with setTimeout.
Does anyone know why this issue is happening?

ArekChr · 2023-03-31T10:08:10Z

@mountiny This PR is ready for review 🚀

mountiny

I am not sure why this is happening, but can you try to think of other way to solve this without using setTimeout, those are usually very hacky solutions we try to avoid almost at all cost.

cc @mollfpr what do you think?

ArekChr · 2023-03-31T13:08:40Z

I saw some places in the code base where InteractionManager.runAfterInteractions is used to call a methods using ref

ArekChr · 2023-03-31T13:11:06Z

I tried to fix it in many ways, but none of them helped. I'm guessing this problem with ref forwarding may be caused by HOC

mountiny · 2023-03-31T13:14:47Z

Yeah runAfterInteractions uses setTimeout under the hood, its discouraged to use it, but if this is the only way we are able to achieve this 🤷

might be good to bring this to the open source channel and see if others have some ideas of why it does not work, at least we can confirm there is no other way

ArekChr · 2023-03-31T13:25:04Z

Good point 👌 Let's see. I asked in opensource channel

mollfpr · 2023-03-31T13:36:40Z

@mountiny @ArekChr I think it's because NewDatePicker is inside the Form.js component.

mollfpr · 2023-03-31T15:55:02Z

We can create a callback function from Form.js where it's called after the form is mounted, and change a state in DateOfBirthPage to determine if the form is ready, then we call show picker in the componentDidUpdate after the form is ready.

fedirjh · 2023-03-31T17:09:52Z

@ArekChr We can implement a new prop, such as autoFocus or autoOpen, in NewDatePicker and use it to initiate the state of the component to show or hide accordingly.

        this.state = {
            isPickerVisible: props.autoFocus || false,
            ...
        };
        ...
        this.opacity = new Animated.Value(props.autoFocus ? 1 : 0);

Screen.Recording.2023-03-31.at.4.58.21.PM.mov

mollfpr · 2023-04-03T16:51:34Z

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

16779.Web.mov

Mobile Web - Chrome

16779.mWeb.Chrome.mov

Mobile Web - Safari

16779.mWeb.Safari.mp4

Desktop

16779.Desktop.mov

iOS

16779.iOS.mp4

Android

16779.Android.mov

mollfpr

LGTM 👍

All yours @mountiny!

mountiny

Very nice, thank you very much @mollfpr @ArekChr

Also thank you @fedirjh for great input 🙇

OSBotify · 2023-04-03T17:23:32Z

✋ 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-04-03T19:27:36Z

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

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

s77rt · 2023-04-04T16:22:19Z

src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js

-                if (_.isFunction(this.datePicker.click)) {
-                    this.datePicker.click();
-                }
+                this.datePicker.showPicker();


This introduced a regression https://expensify.slack.com/archives/C049HHMV9SM/p1680625096406979 The reason is that the text input is now no longer focused so no blur event will be emitted and the calendar will not hide on clicking outside. Fix:

diff --git a/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js b/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js index 4983c2cc5f..51d3dc5c55 100644 --- a/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js +++ b/src/pages/settings/Profile/PersonalDetails/DateOfBirthPage.js @@ -67,6 +67,7 @@ class DateOfBirthPage extends Component { this.setState({selectedYear: params.year}); if (this.datePicker) { this.datePicker.showPicker(); + this.datePicker.textInputRef.focus(); } } }

Discussing in slack I dont think this is a regression, we have a different issue.

OSBotify · 2023-04-05T02:28:23Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.2.94-3 🚀

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

ArekChr requested a review from a team as a code owner March 31, 2023 08:39

melvin-bot bot requested review from mollfpr and mountiny and removed request for a team March 31, 2023 08:39

refactor: forward ref to datepicker instance

4cdc921

ArekChr force-pushed the feat/datepicker_always_open_dob branch from e60e8dd to 4cdc921 Compare March 31, 2023 09:33

refactor: add 100ms ensuring ref is always set

7c65040

ArekChr added 2 commits March 31, 2023 12:08

fix: linter error

e667e05

fix: linter error

b169573

mountiny assigned ArekChr Mar 31, 2023

mountiny reviewed Mar 31, 2023

View reviewed changes

ArekChr added 2 commits April 3, 2023 12:09

refactor: implement autoFocus prop

20c0502

fix: focus text input when autofocus enabled (web)

e87f2ea

mollfpr approved these changes Apr 3, 2023

View reviewed changes

mountiny approved these changes Apr 3, 2023

View reviewed changes

mountiny merged commit 08b5055 into Expensify:main Apr 3, 2023

OSBotify mentioned this pull request Apr 3, 2023

Deploy Checklist: New Expensify 2023-04-03 #16880

Closed

21 tasks

mountiny mentioned this pull request Apr 4, 2023

[HOLD for payment 2023-03-31] Implement New Date Picker Design #14322

Closed

s77rt reviewed Apr 4, 2023

View reviewed changes

MelvinBot mentioned this pull request Apr 5, 2023

[HOLD for payment 2023-04-12] Make a datepicker always open on DOB page #16551

Closed

s77rt mentioned this pull request Apr 5, 2023

Don't hide picker on esc key press or tap outside #16941

Merged

53 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: forward ref to datepicker instance #16779

refactor: forward ref to datepicker instance #16779

ArekChr commented Mar 31, 2023 •

edited

Loading

MelvinBot commented Mar 31, 2023

ArekChr commented Mar 31, 2023

ArekChr commented Mar 31, 2023

mountiny left a comment

ArekChr commented Mar 31, 2023

ArekChr commented Mar 31, 2023 •

edited

Loading

mountiny commented Mar 31, 2023

ArekChr commented Mar 31, 2023

mollfpr commented Mar 31, 2023

mollfpr commented Mar 31, 2023

fedirjh commented Mar 31, 2023

mollfpr commented Apr 3, 2023

mollfpr left a comment

mountiny left a comment

OSBotify commented Apr 3, 2023

OSBotify commented Apr 3, 2023

s77rt Apr 4, 2023

mountiny Apr 4, 2023

OSBotify commented Apr 5, 2023

refactor: forward ref to datepicker instance #16779

refactor: forward ref to datepicker instance #16779

Conversation

ArekChr commented Mar 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

MelvinBot commented Mar 31, 2023

ArekChr commented Mar 31, 2023

ArekChr commented Mar 31, 2023

mountiny left a comment

Choose a reason for hiding this comment

ArekChr commented Mar 31, 2023

ArekChr commented Mar 31, 2023 • edited Loading

mountiny commented Mar 31, 2023

ArekChr commented Mar 31, 2023

mollfpr commented Mar 31, 2023

mollfpr commented Mar 31, 2023

fedirjh commented Mar 31, 2023

mollfpr commented Apr 3, 2023

Reviewer Checklist

Screenshots/Videos

mollfpr left a comment

Choose a reason for hiding this comment

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Apr 3, 2023

OSBotify commented Apr 3, 2023

s77rt Apr 4, 2023

Choose a reason for hiding this comment

mountiny Apr 4, 2023

Choose a reason for hiding this comment

OSBotify commented Apr 5, 2023

ArekChr commented Mar 31, 2023 •

edited

Loading

ArekChr commented Mar 31, 2023 •

edited

Loading