chore: migrate withViewportOffsetTop.js class to function component

[teneeto]

Details

This change is made to migrate the withViewportOffsetTop.js from class to a function component

Fixed Issues

$: 16224
PROPOSAL: 16224

Tests

1. Open any chat
2. Focus the chat composer
3. Make sure you can still see the header

• Verify that no errors appear in the JS console

Offline tests

1. Open any chat
2. Focus the chat composer
3. Make sure you can still see the header

QA Steps

1. Open any chat
2. Focus the chat composer
3. Make sure you can still see the header

• 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 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 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

Screen.Recording.2023-09-07.at.02.23.20.mov

Mobile Web - Chrome

Screen.Recording.2023-09-07.at.02.24.24.mov

Mobile Web - Safari

Screen.Recording.2023-09-07.at.02.22.03.mov

Desktop

Screen.Recording.2023-09-07.at.02.25.58.mov

iOS

Screen.Recording.2023-09-07.at.02.17.55.mov

Android

Screen.Recording.2023-09-07.at.02.40.09.mov

[melvin-bot]

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

[amyevans]

This is still in need of a cross-agency Reviewer checklist, will wait to merge until that's set!

[situchan]

C+ can review and checklist for function component migration PRs.
Cross-agency Reviewer checklist is only for TS migration PRs.

[amyevans]

Ah right, thanks for the reminder @situchan!

@thesahindia you're the assigned C+ on the issue, are you able to review?

[thesahindia]

@thesahindia you're the assigned C+ on the issue, are you able to review?

Yes, I will test it today.

[thesahindia]

Hey @teneeto, can you please add some kind of test steps?

[teneeto]

Hey @teneeto, can you please add some kind of test steps?

@thesahindia I have updated the description with the reference link of the initial PR description that authored/created the withViewportOffsetTop HOC. There are detailed steps to test and qa here. Thanks.

[thesahindia]

1. Go to Settings -> Payment
2. Tap on the bank account that doesn't have the "default" label
3. Tap on "Make default payment method" button
4. Ensure the keyboard does not overlap the "Make default payment method" button.

It looks like now we don't ask for the password while trying to set the payment method as default so there is no input field and the keyboard can't be opened, so we can't follow these steps.

We are using viewportOffsetTop at ReportScreen and EmojiPicker, I tried looking at PRs that added them but couldn't find info about why we need them.

The code changes looks good to me but I wanted to check if things are working fine. Not sure what to do next.

cc: @amyevans

[teneeto]

1. Go to Settings -> Payment
2. Tap on the bank account that doesn't have the "default" label
3. Tap on "Make default payment method" button
4. Ensure the keyboard does not overlap the "Make default payment method" button.

It looks like now we don't ask for the password while trying to set the payment method as default so there is no input field and the keyboard can't be opened, so we can't follow these steps.

We are using viewportOffsetTop at ReportScreen and EmojiPicker, I tried looking at PRs that added them but couldn't find info about why we need them.

The code changes looks good to me but I wanted to check if things are working fine. Not sure what to do next.

cc: @amyevans

let me take a look at another possible qa step.

[teneeto]

@thesahindia

1. Goto Settings -> Profile
2. Tap on Personal Details
3. Tap on Legal name
4. TAP on the Legal first name input

Note: Notice how the keyboard pushes the save button rather than overlap.

Screen.Recording.2023-10-02.at.05.41.54.mov

[teneeto]

@thesahindia

1. Goto Settings -> Profile
2. Tap on Personal Details
3. Tap on Legal name
4. TAP on the Legal first name input

Note: Notice how the keyboard pushes the save button rather than overlap.

Screen.Recording.2023-10-02.at.05.41.54.mov

Let me know if this works for you and I'll update the test/qa steps.

[teneeto]

Just a friendly reminder! @thesahindia can we kindly have a look at this again with the updated qa steps.

[thesahindia]

@teneeto, sorry but I am little confused. We are using viewportOffsetTop at ReportScreen and EmojiPicker. So I am not sure how it affects legal name page.

[teneeto]

@teneeto, sorry but I am little confused. We are using viewportOffsetTop at ReportScreen and EmojiPicker. So I am not sure how it affects legal name page.

Ayye! Let me check again....

[teneeto]

1. Go to Settings -> Payment
2. Tap on the bank account that doesn't have the "default" label
3. Tap on "Make default payment method" button
4. Ensure the keyboard does not overlap the "Make default payment method" button.

It looks like now we don't ask for the password while trying to set the payment method as default so there is no input field and the keyboard can't be opened, so we can't follow these steps.

We are using viewportOffsetTop at ReportScreen and EmojiPicker, I tried looking at PRs that added them but couldn't find info about why we need them.

The code changes looks good to me but I wanted to check if things are working fine. Not sure what to do next.

cc: @amyevans

@thesahindia this seem to be the only visible way to test this. But again, since the ViewPortOffsetTop is used within EmojiPicker, the component is called each time you're in a chat screen. can tell visibly exactly what it solves, but i still think it's part of a solution as referenced here.

@amyevans @thesahindia how do we proceed with this?

[thesahindia]

@amyevans, thoughts??

[amyevans]

If you read the proposal linked from the PR that implemented this component, it says:

The same issue occurs on the reportScreen, the way that was fixed there is by using the visualViewport listener and adding padding to the top of ScreenWrapper.

If you then follow the git blame history, you can get to this PR: #10208, where the test steps are:

1. Open any chat
2. Focus the chat composer
3. Make sure you can still see the header

mWeb Safari seems to be the crucial platform to check for a regression in that case.

With const screenWrapperStyle = [styles.appContent, styles.flex1, {marginTop: viewportOffsetTop}];:

With const screenWrapperStyle = [styles.appContent, styles.flex1];:

[thesahindia]

Excellent, thanks! Testing it now.

[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: 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(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 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 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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

[thesahindia]

LGTM!

[melvin-bot]

🎯 @thesahindia, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #29392.

[thesahindia]

@teneeto, please update the testing/QA steps.

[teneeto]

Steps Updated!

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

[OSBotify]

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.84-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

platform	result
🤖 android 🤖	skipped 🚫
🖥 desktop 🖥	skipped 🚫
🍎 iOS 🍎	skipped 🚫
🕸 web 🕸	skipped 🚫

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.84-10 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/amyevans in version: 1.3.85-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/francoisl in version: 1.3.85-4 🚀

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