fix 17664: use googleEmptyListViewHeight variable with correct value #17832

aman-atg · 2023-04-22T22:49:02Z

Details

This is a fix for the regression caused by PR.

Even when the list view is empty, it will always have some height. We hide the list view by comparing its height against a certain value (currently: 2px). However, in the previous PR, the height value was increased by adding vertical padding, but this change wasn't reflected in the comparison value. As a solution, I added a new variable named googleEmptyListViewHeight with the correct value of 14 pixels. This value takes into account the 2 pixels required for borders and 12 pixels for vertical padding.

Fixed Issues

$ #17664
$ #17277
PROPOSAL: #17664 (comment)

Tests

Go to the Settings > Profile > Personal details
Enter some spaces on Address line 1
Then use a letter and remove it OR Enter random values till you have no results
Ensure that the dropdown box is not visible

Alternative Steps

Go to Workspaces > Choose any workspace > connect bank account
Choose connect manually > fill details till you reach "Company Information" page or "Personal Information" page
Enter some spaces on the address input > use a letter like "x" and remove it OR Enter random values till you have no results
Ensure that the dropdown box is not visible

Verify that no errors appear in the JS console

Offline tests

QA Steps

Go to the Settings > Profile > Personal details
Enter some spaces on Address line 1
Then use a letter and remove it OR Enter random values till you have no results
Ensure that the dropdown box is not visible

Alternative Steps

Go to Workspaces > Choose any workspace > connect bank account
Choose connect manually > fill details till you reach "Company Information" page or "Personal Information" page
Enter some spaces on the address input > use a letter like "x" and remove it OR Enter random values till you have no results
Ensure that the dropdown box is not visible

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-04-23.at.4.40.05.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-04-23.at.2.29.38.PM.mov

Mobile Web - Safari

Screen.Recording.2023-04-24.at.11.01.31.AM.mov

Screen.Recording.2023-04-23.at.2.41.38.PM.mov

Desktop

Screen.Recording.2023-04-23.at.3.27.57.PM.mov

iOS

Screen.Recording.2023-04-23.at.2.32.30.PM.mov

Android

Screen.Recording.2023-04-23.at.2.41.38.PM.mov

MelvinBot · 2023-04-22T22:49:06Z

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

src/components/AddressSearch.js

aman-atg · 2023-04-23T09:51:45Z

@s77rt I think we should divide the comments in two parts like below:

Inside variables.js

// This is calculated based on the values specified in the 'getGoogleListViewStyle' function of the 'StyleUtils' utility
googleEmptyListViewHeight: 14,

Inside AddressSearch.js

 onLayout={(event) => {
    // We use the height of the element to determine if we should hide the border of the listView dropdown
    // to prevent a lingering border when there are no address suggestions.
    setDisplayListViewBorder(event.nativeEvent.layout.height > variables.googleEmptyListViewHeight);
 }}

// The height of the empty element is 14px (2px height for borders and 12px height for vertical padding)

I'm also suggesting that we remove this line following our coding patterns since this is not explaining any "why" and not adding much value here

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.

Let me know your thoughts.

Thanks for reviewing on a off day! 🙏

s77rt · 2023-04-23T10:02:33Z

I'm not sure if we want to remove that comment, it's not explaining the why but also not the what, it's explaining the how, Maybe we should keep it so other dev can know how to adjust the value accordingly.

aman-atg · 2023-04-23T10:10:53Z

Maybe we should keep it so other dev can know how to adjust the value accordingly.

Makes sense.

I think we should divide the comments in two parts

Let me know your thoughts on this as well. Thanks.

s77rt · 2023-04-23T10:19:42Z

I think we should divide the comments in two parts

Let me know your thoughts on this as well. Thanks.

That's what I meant actually. Please apply the changes and let's discuss further code on code review comments and not on PR comments like this.

src/styles/variables.js

MelvinBot · 2023-04-23T11:09:02Z

@youssef-lr @0xmiroslav 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]

s77rt · 2023-04-23T11:11:58Z

@aman-atg You should have waited till we get assigned to the linked issue so pullerbear do it's job correctly 😅

aman-atg · 2023-04-23T11:24:18Z

@aman-atg You should have waited till we get assigned to the linked issue so pullerbear do it's job correctly 😅

oops! Sorry about that 😬

s77rt · 2023-04-23T22:17:51Z

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

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt · 2023-04-23T22:18:23Z

@aman-atg Please double check the screenshot/video for mWeb - Safari.

s77rt · 2023-04-24T08:41:41Z

@aman-atg It would have helped if you tagged me again. We don't get notifications for comments reactions 😅.

s77rt

LGTM! 🚀

cc @mountiny

mountiny

Thanks everyone

OSBotify · 2023-04-24T08:50:27Z

✋ 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-25T06:09:14Z

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

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

OSBotify · 2023-04-26T05:51:14Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.5-6 🚀

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

use googleEmptyListViewHeight variable with correct value

390c486

s77rt suggested changes Apr 23, 2023

View reviewed changes

src/components/AddressSearch.js Show resolved Hide resolved

aman-atg commented Apr 23, 2023

View reviewed changes

src/components/AddressSearch.js Outdated Show resolved Hide resolved

s77rt suggested changes Apr 23, 2023

View reviewed changes

src/components/AddressSearch.js Outdated Show resolved Hide resolved

aman-atg added 2 commits April 23, 2023 15:52

fix typo

3eef41f

move comments to the variable location

a325299

s77rt suggested changes Apr 23, 2023

View reviewed changes

src/styles/variables.js Outdated Show resolved Hide resolved

add suggested changes for comment

f3afada

aman-atg marked this pull request as ready for review April 23, 2023 11:08

aman-atg requested a review from a team as a code owner April 23, 2023 11:08

melvin-bot bot requested review from 0xmiroslav and youssef-lr and removed request for a team April 23, 2023 11:08

mountiny assigned aman-atg Apr 24, 2023

mountiny requested review from mountiny and s77rt April 24, 2023 05:39

s77rt approved these changes Apr 24, 2023

View reviewed changes

mountiny approved these changes Apr 24, 2023

View reviewed changes

mountiny merged commit 8544f63 into Expensify:main Apr 24, 2023

OSBotify mentioned this pull request Apr 25, 2023

Deploy Checklist: New Expensify 2023-04-25 #17948

Closed

37 tasks

fix 17664: use googleEmptyListViewHeight variable with correct value #17832

fix 17664: use googleEmptyListViewHeight variable with correct value #17832

Uh oh!

Conversation

aman-atg commented Apr 22, 2023 • edited by mountiny 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!

MelvinBot commented Apr 22, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aman-atg commented Apr 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

s77rt commented Apr 23, 2023

Uh oh!

aman-atg commented Apr 23, 2023

Uh oh!

s77rt commented Apr 23, 2023

Uh oh!

Uh oh!

MelvinBot commented Apr 23, 2023

Uh oh!

s77rt commented Apr 23, 2023

Uh oh!

aman-atg commented Apr 23, 2023

Uh oh!

s77rt commented Apr 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt commented Apr 23, 2023

Uh oh!

s77rt commented Apr 24, 2023

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Apr 24, 2023

Uh oh!

OSBotify commented Apr 25, 2023

Uh oh!

OSBotify commented Apr 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

aman-atg commented Apr 22, 2023 •

edited by mountiny

Loading

aman-atg commented Apr 23, 2023 •

edited

Loading

s77rt commented Apr 23, 2023 •

edited

Loading