Migrate BaseKeyboardSpacer.js to fc component by vadymbokatov · Pull Request #22886 · Expensify/App

vadymbokatov · 2023-07-14T11:22:58Z

Details

Migrated baseKeyboardSpace.js to fc component

Fixed Issues

$ #16173
PROPOSAL:

Tests

Verify that no errors appear in the JS console
Verify that keyboard is aligned correctly when input password in adding payment page.
- Open the app authenticated.
- Go to the Settings and click payments.
- If you didn't add your payment method, add paypal as payment method.
- Click the paypal in the payments methods.
- Click the "Make default payment method" button.
- Input text and observe that the keyboard is aligned correctly.

Offline tests

QA Steps

Same as test

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-07-17.at.22.24.37.mov

Android

Screen.Recording.2023-07-17.at.22.25.39.mov

melvin-bot · 2023-07-14T11:23:04Z

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

vadymbokatov · 2023-07-14T11:24:34Z

@mollfpr I have created pr again. Please review and give me feedback.

mollfpr · 2023-07-14T11:59:08Z

@vadymbokatov Thanks! As I said before you don't need to do this #22886 (comment) 😅

Also, you need to complete all the platform recordings.

mollfpr · 2023-07-14T12:04:40Z

Although this is just a refactor, you must add a test step. You can see the example #20186

vadymbokatov · 2023-07-14T12:06:09Z

Gotcha. This is my first commit. I will update as soon as possible.

vadymbokatov · 2023-07-14T12:08:48Z

And I have a question. BaseKeyboardSpacer component is only used for Android. Should I check it on all other devices?

mollfpr · 2023-07-14T12:11:30Z

Good question! We can skip the Web, mWeb, and Desktop because it's returning null. We still need the test for iOS.

vadymbokatov · 2023-07-14T19:33:41Z

@mollfpr I have completed. Please review my PR and give me feedback. Thank you.

mollfpr

For the test step, we need to guide the QA. The KeyboardSpacer is use for the PasswordPopover. To observe that component, we need to use account that has permission expensifyWallet and doesn't have permission passwordless. Also, the account need an bank account or paypal account to be able to show option make default payment method option.

mollfpr · 2023-07-15T05:00:33Z

src/components/KeyboardSpacer/BaseKeyboardSpacer.js

+        return () => {
+            keyboardListeners.forEach((listener) => listener.remove());
+        }
+    }, [props.keyboardShowMethod, props.keyboardHideMethod, updateKeyboardSpace, resetKeyboardSpace]);


We only want to have this side effect on the mount. With passing the dependency, we will have several times call this.

Suggested change

}, [props.keyboardShowMethod, props.keyboardHideMethod, updateKeyboardSpace, resetKeyboardSpace]);

// eslint-disable-next-line react-hooks/exhaustive-deps

}, []);

vadymbokatov · 2023-07-15T21:05:22Z

Gotcha. Can I update it on Monday?

mollfpr · 2023-07-16T01:24:49Z

@vadymbokatov Sure!

vadymbokatov · 2023-07-17T11:43:39Z

@mollfpr I have a question. How to create expensify wallet on my account?

mollfpr · 2023-07-17T12:00:53Z

You can ask the internal team to invite your account, but for dev purposes, you can update the permission in Permissions.js.

…er.js component

vadymbokatov · 2023-07-17T14:28:02Z

@mollfpr Please review again. Thank you.

mollfpr · 2023-07-18T13:09:46Z

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

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

22886.iOS.mp4

Android

22886.Android.webm

mollfpr

It almost looks good, just couple of NAB and a minor state on callback.

mollfpr · 2023-07-18T15:11:17Z

src/components/KeyboardSpacer/BaseKeyboardSpacer.js

-    }
+        const space = screenHeight - event.endCoordinates.screenY + props.topSpacing;
+        setKeyboardSpace(space);
+        props.onToggle(true, keyboardSpace);


The next value of keyboardSpace is not yet available and still has the previous state value.

Suggested change

props.onToggle(true, keyboardSpace);

props.onToggle(true, space);

mollfpr · 2023-07-18T15:12:09Z

src/components/KeyboardSpacer/BaseKeyboardSpacer.js

+        return () => {
+            keyboardListeners.forEach((listener) => listener.remove());
+        }
+    }, []);


NAB: lint error

Suggested change

}, []);

// eslint-disable-next-line react-hooks/exhaustive-deps

}, []);

mollfpr · 2023-07-18T15:14:00Z

src/components/KeyboardSpacer/BaseKeyboardSpacer.js

 BaseKeyboardSpacer.propTypes = propTypes;

-export default BaseKeyboardSpacer;
+export default BaseKeyboardSpacer;


NAB

Suggested change

export default BaseKeyboardSpacer;

export default BaseKeyboardSpacer;

vadymbokatov · 2023-07-18T15:33:34Z

@mollfpr Resolved eslint errors and other NAB. Thank you

mollfpr

LGTM and tests well 👍

Just single NAB and we are ready to go.

mollfpr · 2023-07-18T16:24:26Z

src/components/KeyboardSpacer/BaseKeyboardSpacer.js

+        const space = screenHeight - event.endCoordinates.screenY + props.topSpacing;
+        setKeyboardSpace(space);
+        props.onToggle(true, space);
+    }, [keyboardSpace, props]);


NAB: lint error on unnecessary dependency.

vadymbokatov · 2023-07-19T11:53:27Z

@cristipaval Could you review this PR?

cristipaval · 2023-07-22T21:46:57Z

@cristipaval Could you review this PR?

Sorry @vadymbokatov , I was out of office.

cristipaval · 2023-07-22T21:53:57Z

Could you please solve the lint errors?

cristipaval

lint errors

vadymbokatov · 2023-07-24T10:01:30Z

@cristipaval I will update asap.

melvin-bot · 2023-07-24T18:11:30Z

@cristipaval looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2023-07-24T18:16:29Z

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

cristipaval · 2023-07-24T18:33:19Z

@cristipaval looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

All the checks passed, Melv.

OSBotify · 2023-07-25T01:43:06Z

🚀 Deployed to staging by https://github.com/cristipaval in version: 1.3.45-0 🚀

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

OSBotify · 2023-07-26T15:52:37Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.45-7 🚀

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

Migrate BaseKeyboardSpacer.js to fc component

b062dc4

vadymbokatov requested a review from a team as a code owner July 14, 2023 11:22

melvin-bot bot requested review from mollfpr and removed request for a team July 14, 2023 11:23

mollfpr requested changes Jul 15, 2023

View reviewed changes

Remove unnecessary dependencies of useEffect hook in BaseKeyboardSpac…

3cfe37a

…er.js component

mollfpr requested changes Jul 18, 2023

View reviewed changes

Resolve lint error

684621d

mollfpr approved these changes Jul 18, 2023

View reviewed changes

melvin-bot bot requested a review from cristipaval July 18, 2023 16:25

Resolve eslint error

5590765

vadymbokatov mentioned this pull request Jul 19, 2023

[HOLD for payment 2023-08-02] [$250] Migrate BaseKeyboardSpacer.js to function component #16173

Closed

1 task

cristipaval requested changes Jul 22, 2023

View reviewed changes

Resolve lint error

cf70085

vadymbokatov requested a review from cristipaval July 24, 2023 10:32

Remove unnecessary dependancies

904603f

cristipaval approved these changes Jul 24, 2023

View reviewed changes

cristipaval merged commit dc0cf77 into Expensify:main Jul 24, 2023

melvin-bot bot added the Emergency label Jul 24, 2023

cristipaval removed the Emergency label Jul 24, 2023

OSBotify mentioned this pull request Jul 25, 2023

Deploy Checklist: New Expensify 2023-07-25 #23522

Closed

kbecciv mentioned this pull request Jul 25, 2023

[HOLD] [$1000] Payments - Option "Make default payment method" is unavailable for PayPal #23565

Closed

6 tasks

	}, [props.keyboardShowMethod, props.keyboardHideMethod, updateKeyboardSpace, resetKeyboardSpace]);
	// eslint-disable-next-line react-hooks/exhaustive-deps
	}, []);

	props.onToggle(true, keyboardSpace);
	props.onToggle(true, space);

	export default BaseKeyboardSpacer;
	export default BaseKeyboardSpacer;

Conversation

vadymbokatov commented Jul 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Jul 14, 2023

Uh oh!

vadymbokatov commented Jul 14, 2023

Uh oh!

mollfpr commented Jul 14, 2023

Uh oh!

mollfpr commented Jul 14, 2023

Uh oh!

vadymbokatov commented Jul 14, 2023

Uh oh!

vadymbokatov commented Jul 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mollfpr commented Jul 14, 2023

Uh oh!

vadymbokatov commented Jul 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Jul 15, 2023

Choose a reason for hiding this comment

Uh oh!

vadymbokatov Jul 17, 2023

Choose a reason for hiding this comment

Uh oh!

vadymbokatov commented Jul 15, 2023

Uh oh!

mollfpr commented Jul 16, 2023

Uh oh!

vadymbokatov commented Jul 17, 2023

Uh oh!

mollfpr commented Jul 17, 2023

Uh oh!

vadymbokatov commented Jul 17, 2023

Uh oh!

mollfpr commented Jul 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

mollfpr Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

vadymbokatov commented Jul 18, 2023

Uh oh!

mollfpr left a comment

Choose a reason for hiding this comment

Uh oh!

mollfpr Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

vadymbokatov Jul 18, 2023

Choose a reason for hiding this comment

Uh oh!

vadymbokatov commented Jul 19, 2023

Uh oh!

cristipaval commented Jul 22, 2023

Uh oh!

vadymbokatov commented Jul 14, 2023 •

edited

Loading

vadymbokatov commented Jul 14, 2023 •

edited

Loading

vadymbokatov commented Jul 14, 2023 •

edited

Loading

mollfpr commented Jul 18, 2023 •

edited

Loading