Fix: Scroll to picker regression

[chrispader]

Details

Fixes a regression where refs ScrollViewWithContext are not forwarded to ScrollView component.

Additionally this introduces a mechanism to conditionally set if the ScrollContext should be used. This PR adds two props (scrollToOverflowEnabled and scrollContextEnabled) to the <Form /> component, so that the ScrollContext only gets used if there's some sort of nested <Picker /> in the form. (Can also be StatePicker or LocalePicker)

Fixed Issues

$ #13909
PROPOSAL: #13909 (comment)

Tests

1. Log in any account
2. Navigate to Settings > Any workspace > Connect bank account > Connect Manually > Press Save&Continue without any data
3. Will not show “fix the errors” press on ‘fix the error’ in the console anymore

---

1. Go to a the workspace settings
2. Go to the "Reimburse expenses" setting
3. Under "Track Distance", tap on the input for "Unit"
4. For iOS, the entire unit field should be visible above the picker. For all other platforms, there should be no changes to the input or the picker (they will all have different pickers).

---

1. Login in New Dot
2. Go to Settings > Payments
3. Click "Add payment method" and select "Debit card"
4. Click "Save" without entering any data
5. Verify that all inputs have errors
6. if you are in web or desktop, resize the window enough to have scrolling in the RHN:

7. Scroll down and click "fix the errors"
8. Verify that the first input gets focused and you are scrolled until it is fully visible (including the top border)
9. Input something in the first input "Name on card"
10. Scroll down and click again "fix the errors"
11. Verify that the second input gets focused and you are scrolled until it is fully visible (including the top border)
12. Go back to the Settings > Payments page
13. Click "Add payment method" and select "Bank account"
14. Verify that the spinner is in the middle and not in the top

---

1. Login in New Dot
2. Go to Settings -> Workspaces -> Any workspace -> Connect bank account -> Connect manually
3. Leave inputs empty
4. Click on "Continue"
5. Page shouldn't bounce up to the top, like in this video:

211917338-e6cfea51-ad43-4acf-bd05-bcb965cde43f.mov

---

• Verify that no errors appear in the JS console

Offline tests

Same as regular tests.

QA Steps

Same as regular tests.

• 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.
• I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

No UI changes.

Mobile Web - Chrome

No UI changes.

Mobile Web - Safari

No UI changes.

Desktop

No UI changes.

iOS

No UI changes.

Android

No UI changes.

[melvin-bot]

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

[melvin-bot]

@aldo-expensify @thesahindia 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]

[aldo-expensify]

I'm not sure if this is caused by this PR yet but there seem to be some dark overlay that doesn't allow me to click on a unit (correction: I can click the unit despite the dark overlay) in Android:

I was following this QA in Android

Update: This seems to be like this in main too

[aldo-expensify]

I think it would be good to also include in the test/qa steps the steps from these other PR to make sure this is still working:

• Fix: Scroll to Picker TextInput on open #13514
• Use measureLayout to calculate scrolling #13499

And the steps from this comment to make sure it doesn't bounce weirdly in small forms: #13909 (comment)

[chrispader]

I think it would be good to also include in the test/qa steps the steps from these other PR to make sure this is still working:

• Fix: Scroll to Picker TextInput on open #13514
• Use measureLayout to calculate scrolling #13499

And the steps from this comment to make sure it doesn't bounce weirdly in small forms: #13909 (comment)

done!

[aldo-expensify]

I tested this in web/ios/android, following the QA (check that the error is not there anymore), and also checking this: #14409 (comment) and I didn't spot any problem. Things seems to be fixed.

I still requested another pair of eyes to review the PR because I'm not very familiarized with this.

[chrispader]

I'm not sure if this is caused by this PR yet but there seem to be some dark overlay that doesn't allow me to click on a unit (correction: I can click the unit despite the dark overlay) in Android:

I was following this QA in Android

Update: This seems to be like this in main too

You're right, i'm getting this on main as well. Seems to be some other bug, but definitely not related to this PR

[luacmartins]

Great start! I left a few comments. Additionally, there are two bugs that are also on main, but maybe we should address them in a different PR.

No error displayed for input in short screens

1. In either iOS or Android, navigate to Settings > Workspace > Connect bank account > Connect manually
2. Have the keyboard active
3. Press Continue
4. Notice that the error does not show for Account number and the Terms checkbox
5. You can reproduce on web too, if you resize the browser to a short height.

bug1-chrome.mov

bug1.mov

Form scrolls to random position on submit with errors

1. Navigate to Settings > Workspace > Connect bank account > Connect manually > Company step
2. Press Save & continue without entering values
3. Verify that the errors show but the form is scrolled to a random position.

[thesahindia]

Works well! Some changes are needed as mentioned by @luacmartins

[chrispader]

Great start! I left a few comments. Additionally, there are two bugs that are also on main, but maybe we should address them in a different PR.

No error displayed for input in short screens

1. In either iOS or Android, navigate to Settings > Workspace > Connect bank account > Connect manually
2. Have the keyboard active
3. Press Continue
4. Notice that the error does not show for Account number and the Terms checkbox
5. You can reproduce on web too, if you resize the browser to a short height.

Maybe this got fixed already on main, because i can't reproduce this on my emulator after merging main into this branch (at approx. 01/20/2023 9am CET):

Android (emulator):

android.recording.webm

Web:

Screen.Recording.2023-01-20.at.10.43.18.mov

[luacmartins]

Left a couple of suggestions for the docs.

Additionally, I think we might need to pass the props to the following pages too:

• AddPersonalBankAccountPage since AddPlaidBankAccount has a nested Picker
• RequestorStep since IdentityForm has a nested Picker
• WorkspaceSettingsPage

[luacmartins]

@chrispader as far as I know FormScrollView should be deprecated in favor of Form - we are refactoring ACHContractStep to use Form here and we shouldn't introduce any new instances of it. I don't think that we need to worry about the other existing pages using FormScrollView because they don't seem to have nested Pickers.

[luacmartins]

LGTM!

[aldo-expensify]

Thanks @luacmartins for the thorough review! I'll do my review later today.

[thesahindia]

@chrispader, I am seeing this error -

Screen.Recording.2023-01-24.at.1.14.44.AM.mov

[aldo-expensify]

Sorry guys, I failed to get to review this today. I'll get to it first thing tomorrow

[chrispader]

@chrispader, I am seeing this error -

Screen.Recording.2023-01-24.at.1.14.44.AM.mov

Fixed! I just forgot to change the ref variable in two calls in Form

[thesahindia]

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.
• 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-01-25.at.1.22.44.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-01-25.at.2.37.30.AM.mov

Mobile Web - Safari

Screen.Recording.2023-01-25.at.2.33.41.AM.mov

Desktop

Screen.Recording.2023-01-25.at.2.42.22.AM.mov

iOS

Screen.Recording.2023-01-25.at.1.08.50.AM.mov

Android

Screen.Recording.2023-01-25.at.2.52.43.AM.mov

[thesahindia]

Looks good to me!

[aldo-expensify]

Tested well for me! thanks!

[melvin-bot]

Congrats, that’s your 5th PR merged! 🎉 Do you know about the ContributorPlus role? It’s an opportunity to earn more in the Expensify Open Source community. Keep up the great work - thanks!

[OSBotify]

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

[github-actions]

Performance Comparison Report 📊

Significant Changes To Duration

There are no entries

Meaningless Changes To Duration

Show entries

Name	Duration
App start TTI	690.637 ms → 700.945 ms (+10.308 ms, +1.5%)
Open Search Page TTI	607.000 ms → 609.273 ms (+2.272 ms, ±0.0%)
App start runJsBundle	191.355 ms → 192.188 ms (+0.833 ms, ±0.0%)
App start regularAppStart	0.021 ms → 0.016 ms (-0.005 ms, -25.6%) 🟢
App start nativeLaunch	20.233 ms → 19.968 ms (-0.266 ms, -1.3%)

Show details

Name	Duration
App start TTI	Baseline Mean: 690.637 ms Stdev: 36.023 ms (5.2%) Runs: 641.3079690001905 646.4787329994142 651.129899000749 651.6138630006462 652.9169139992446 652.9449710007757 657.6872499994934 660.0264909993857 663.6851449999958 665.4018309991807 674.4801010005176 675.3473639991134 676.8049010001123 677.188456999138 679.0711620002985 684.2066070009023 686.8091930001974 687.0647379998118 689.146074000746 689.2963239997625 693.1498360000551 693.1950359996408 701.9195300005376 704.6118850000203 723.4697399996221 724.8008009996265 724.8559230007231 731.6063540000468 735.729591999203 747.4874869994819 760.7465220000595 796.202688999474 Current Mean: 700.945 ms Stdev: 33.851 ms (4.8%) Runs: 647.0219940003008 647.6031270008534 649.7048509996384 657.8555599991232 660.4519829992205 669.211697999388 671.709016000852 676.9583909995854 677.9206460006535 682.5191070009023 684.610259000212 686.182141000405 686.6171320006251 687.1189510002732 689.4384380001575 692.0600589998066 696.9732489995658 706.0379189997911 708.465950999409 715.705388000235 718.4997610002756 720.4606340005994 721.6378850005567 726.9351390004158 729.4676660001278 730.0113970004022 730.4429720006883 731.1911800000817 732.7260270006955 746.1688429992646 751.5449289996177 796.9938399996608
Open Search Page TTI	Baseline Mean: 607.000 ms Stdev: 15.656 ms (2.6%) Runs: 580.9267170000821 580.933796999976 583.5817059986293 583.6670329999179 585.8896490000188 588.7260340005159 593.3621830008924 594.0476890001446 594.5509849991649 595.4505209997296 597.2823079992086 602.7884519994259 604.2021479997784 604.3090830016881 604.6134440004826 608.1275639999658 608.9748130012304 609.7856040000916 610.8638920001686 611.2298990003765 611.590779999271 612.128011001274 617.7000740002841 620.5220140013844 620.8521739989519 624.285116000101 624.5710049998015 626.0859780013561 627.3276370000094 629.2167159989476 632.3190509993583 634.1000159997493 Current Mean: 609.273 ms Stdev: 23.047 ms (3.8%) Runs: 574.6698000002652 575.9138190001249 577.2212330009788 581.7084149997681 584.8958329986781 586.1634929999709 587.8372809998691 588.1066490001976 595.9029139988124 597.5360110010952 597.8319099992514 597.9383140001446 599.4581300001591 602.5617679990828 602.968221001327 603.5171710010618 603.8741050008684 604.2260340005159 604.7195640001446 607.3486330006272 613.3006189987063 615.6880700010806 619.0170900002122 620.9625649992377 622.6920159999281 628.0214440003037 631.4286299999803 631.5798749998212 635.0434169992805 647.2831220012158 647.3306480012834 652.9028329998255 666.3429780006409
App start runJsBundle	Baseline Mean: 191.355 ms Stdev: 18.857 ms (9.9%) Runs: 158 163 172 172 173 173 174 174 176 177 179 179 184 186 187 191 193 194 195 198 199 200 201 208 209 212 213 214 217 220 241 Current Mean: 192.188 ms Stdev: 17.915 ms (9.3%) Runs: 162 169 170 171 172 175 176 178 179 181 182 183 184 185 186 188 189 192 193 194 194 196 201 208 209 210 212 214 220 220 224 233
App start regularAppStart	Baseline Mean: 0.021 ms Stdev: 0.002 ms (10.5%) Runs: 0.01826999895274639 0.018554000183939934 0.019001999869942665 0.019165001809597015 0.019245998933911324 0.019246000796556473 0.019286999478936195 0.019286999478936195 0.019408999010920525 0.01953200064599514 0.019694000482559204 0.019694000482559204 0.019856998696923256 0.01989700086414814 0.019938001409173012 0.020222999155521393 0.02087399922311306 0.021240999922156334 0.02132199890911579 0.021362001076340675 0.02160699851810932 0.021646998822689056 0.022419998422265053 0.022867999970912933 0.023315001279115677 0.023437000811100006 0.02364099957048893 0.023884998634457588 0.023885000497102737 0.025268999859690666 0.02538999915122986 0.026936998590826988 Current Mean: 0.016 ms Stdev: 0.001 ms (6.2%) Runs: 0.014159999787807465 0.014242000877857208 0.0143630001693964 0.014444999396800995 0.01448499970138073 0.014608001336455345 0.014893000945448875 0.015177000313997269 0.015299001708626747 0.01534000039100647 0.015420999377965927 0.015543999150395393 0.015544001013040543 0.015665000304579735 0.01574699953198433 0.01574699953198433 0.015828000381588936 0.015829000622034073 0.015949999913573265 0.015991000458598137 0.016234999522566795 0.016357000917196274 0.01643899828195572 0.016560999676585197 0.016560999676585197 0.0167239997535944 0.01684500090777874 0.0168869998306036 0.017456000670790672 0.017618998885154724 0.017781998962163925
App start nativeLaunch	Baseline Mean: 20.233 ms Stdev: 2.108 ms (10.4%) Runs: 18 18 18 18 18 18 18 18 19 19 19 19 19 19 20 20 20 20 21 21 21 21 22 22 22 22 23 24 24 26 Current Mean: 19.968 ms Stdev: 2.265 ms (11.3%) Runs: 17 17 17 17 18 18 18 18 18 19 19 19 19 19 20 20 20 20 20 20 21 21 21 21 21 22 22 22 23 26 26

[OSBotify]

🚀 Deployed to staging by https://github.com/aldo-expensify in version: 1.2.59-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.59-1 🚀

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

[fedirjh]

@aldo-expensify, @chrispader Here could've been a better implementation instead of DRY code , something like

const ScrollViewComponent = this.props.scrollContextEnabled ? ScrollViewWithContext : ScrollView;

[aldo-expensify]

I agree, that would have resulted in nicer code 🥲

[0xmiros]

This PR caused regression on iOS - #15483, especially enabling scrollToOverflowEnabled in combination with programatic scroll.
To fix this, we removed this prop and instead introduced new PickerAvoidingView in upstream similar to KeyboardAvoidingView.