Migrate SwipableView to functional component #23928

ojasjadhav2 · 2023-07-31T15:14:46Z

Details

Migrated SwipableView. > index.native.js to a functional component

Fixed Issues

$ #16203
PROPOSAL: #16203 (comment)

Tests

login to expensify
open any chat(Report view)
observe it is scrolling perfectly

Verify that no errors appear in the JS console

Offline tests

same as online steps

QA Steps

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Screen.Recording.2023-08-13.at.10.44.30.PM.mov

Android

SVID_20230813_225011_1.mp4

melvin-bot · 2023-07-31T15:14:52Z

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

github-actions · 2023-07-31T15:15:02Z

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

ojasjadhav2 · 2023-07-31T15:15:32Z

I have read the CLA Document and I hereby sign the CLA

ojasjadhav2 · 2023-07-31T15:15:55Z

adding the screenshots shortly

ojasjadhav2 · 2023-08-01T04:47:05Z

@abdulrahuman5196 screenshots are added!

ojasjadhav2 · 2023-08-01T07:43:58Z

@abdulrahuman5196 please let me know if any change is required.
The PR is ready from my side!

ojasjadhav2 · 2023-08-02T04:57:31Z

@abdulrahuman5196 please respond here

abdulrahuman5196 · 2023-08-02T09:47:41Z

Hi, @ojasjadhav2 Will review this.

ojasjadhav2 · 2023-08-02T09:54:01Z

@abdulrahuman5196 thank you for replying, let's try to make it within the priority bonus period!
I'm available all day today.

abdulrahuman5196 · 2023-08-02T09:59:20Z

@ojasjadhav2 Time bonus is not applicable for functional component migration issues.

ojasjadhav2 · 2023-08-02T10:03:55Z

@abdulrahuman5196 i think that is updated lately.
have a look, mevin just commented here:
#16219 (comment)

abdulrahuman5196 · 2023-08-02T10:11:18Z

@ojasjadhav2 Melvin just posted wrongly there. Here is the slack thread on the same - https://expensify.slack.com/archives/C01GTK53T8Q/p1685728627868429?thread_ts=1685727883.004839&cid=C01GTK53T8Q

AFAIK migration PRs don't have speed bonus.

ojasjadhav2 · 2023-08-04T00:44:17Z

@abdulrahuman5196 can you please review it today

abdulrahuman5196 · 2023-08-06T11:16:29Z

src/components/SwipeableView/index.native.js

-        const minimumPixelDistance = CONST.COMPOSER_MAX_HEIGHT;
-        this.oldY = 0;
-        this.panResponder = PanResponder.create({
+function SwipeableView({children, onSwipeDown}) {


We should just get param props instead of spreading the params directly. It will be consistent with all other places in our codebase and it would be easy to understand from where the value came from when using

@ojasjadhav2

abdulrahuman5196 · 2023-08-06T11:17:45Z

And for these cases kindly attach videos on the author's checklist since it is related to swipe/pan behaviour.

@ojasjadhav2

ojasjadhav2 · 2023-08-06T17:34:52Z

@abdulrahuman5196 added the requested change. will be adding screen recordings shortly. you can continue with your review.

ojasjadhav2 · 2023-08-07T08:12:33Z

@abdulrahuman5196 added the videos, Please review now.

ojasjadhav2 · 2023-08-10T09:32:36Z

@abdulrahuman5196 please review

abdulrahuman5196 · 2023-08-11T09:06:10Z

@ojasjadhav2

SwipableView is not used for scrolling the report.
It was introduced for this case. - #2074

Can you test the same and update the videos and update the test steps as well?

abdulrahuman5196 · 2023-08-13T15:50:02Z

@ojasjadhav2 bump

ojasjadhav2 · 2023-08-13T16:56:33Z

@abdulrahuman5196 sorry, it was weekend so i didn't work. will update tomorrow.

abdulrahuman5196 · 2023-08-13T17:04:04Z

@ojasjadhav2 sure no issues. Sorry forgot I pinged before weekend.

ojasjadhav2 · 2023-08-13T17:13:46Z

@abdulrahuman5196 Do i just need to add IOS native screenshot? because that's the only place this is being used

ojasjadhav2 · 2023-08-13T17:16:59Z

@abdulrahuman5196 added IOS native screen recording. do i need to add anything else?

ojasjadhav2 · 2023-08-13T17:27:37Z

added android native screen recording too

ojasjadhav2 · 2023-08-15T06:37:35Z

@abdulrahuman5196 please review

ojasjadhav2 · 2023-08-17T17:48:45Z

@abdulrahuman5196 please check, it is very late already.

abdulrahuman5196 · 2023-08-18T15:48:04Z

Sorry will review this out in couple of hours

abdulrahuman5196 · 2023-08-18T16:58:03Z

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

N/A

Mobile Web - Chrome

N/A

Mobile Web - Safari

N/A

Desktop

N/A

iOS

Screen.Recording.2023-08-18.at.10.29.45.PM.mp4

Android

az_recorder_20230818_225642.mp4

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @MonilBhavsar

🎀 👀 🎀
C+ Reviewed

abdulrahuman5196 · 2023-08-18T17:47:17Z

@MonilBhavsar Kindly run the checklist before approving, since for first time contributors it is not running

OSBotify · 2023-08-21T21:12:41Z

✋ 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-08-21T22:23:01Z

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 1.3.56-0 🚀

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

OSBotify · 2023-08-24T03:06:02Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.56-24 🚀

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

migrated SwipableView > index.native.js

c463bf9

ojasjadhav2 requested a review from a team as a code owner July 31, 2023 15:14

melvin-bot bot requested review from abdulrahuman5196 and removed request for a team July 31, 2023 15:14

added displayName

68a6ec6

abdulrahuman5196 reviewed Aug 6, 2023

View reviewed changes

using props instead of spreading

ef896f7

abdulrahuman5196 approved these changes Aug 18, 2023

View reviewed changes

melvin-bot bot requested a review from MonilBhavsar August 18, 2023 17:46

MonilBhavsar changed the title ~~migrated SwipableView > index.native.js~~ Migrate SwipableView to functional component Aug 21, 2023

MonilBhavsar approved these changes Aug 21, 2023

View reviewed changes

MonilBhavsar merged commit 37ac252 into Expensify:main Aug 21, 2023

OSBotify mentioned this pull request Aug 21, 2023

Deploy Checklist: New Expensify 2023-08-21 #25625

Closed

Migrate SwipableView to functional component #23928

Migrate SwipableView to functional component #23928

Conversation

ojasjadhav2 commented Jul 31, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 31, 2023

github-actions bot commented Jul 31, 2023 • edited Loading

ojasjadhav2 commented Jul 31, 2023

ojasjadhav2 commented Jul 31, 2023

ojasjadhav2 commented Aug 1, 2023

ojasjadhav2 commented Aug 1, 2023

ojasjadhav2 commented Aug 2, 2023

abdulrahuman5196 commented Aug 2, 2023

ojasjadhav2 commented Aug 2, 2023

abdulrahuman5196 commented Aug 2, 2023

ojasjadhav2 commented Aug 2, 2023

abdulrahuman5196 commented Aug 2, 2023 • edited Loading

ojasjadhav2 commented Aug 4, 2023

abdulrahuman5196 Aug 6, 2023

Choose a reason for hiding this comment

ojasjadhav2 Aug 6, 2023

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 6, 2023 • edited Loading

ojasjadhav2 commented Aug 6, 2023

ojasjadhav2 commented Aug 7, 2023

ojasjadhav2 commented Aug 10, 2023

abdulrahuman5196 commented Aug 11, 2023

abdulrahuman5196 commented Aug 13, 2023

ojasjadhav2 commented Aug 13, 2023

abdulrahuman5196 commented Aug 13, 2023

ojasjadhav2 commented Aug 13, 2023

ojasjadhav2 commented Aug 13, 2023

ojasjadhav2 commented Aug 13, 2023

ojasjadhav2 commented Aug 15, 2023

ojasjadhav2 commented Aug 17, 2023

abdulrahuman5196 commented Aug 18, 2023

abdulrahuman5196 commented Aug 18, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

abdulrahuman5196 commented Aug 18, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 21, 2023

OSBotify commented Aug 24, 2023

ojasjadhav2 commented Jul 31, 2023 •

edited

Loading

github-actions bot commented Jul 31, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 2, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 6, 2023 •

edited

Loading

abdulrahuman5196 commented Aug 18, 2023 •

edited

Loading