fix: 15963 - Border line appears, then disappears, above the 1st search result #16094

tienifr · 2023-03-18T08:00:10Z

Details

This PR added this.props.shouldHaveOptionSeparator !== nextProps.shouldHaveOptionSeparator; to the shouldComponentUpdate of OptionRow. This will remove the redundant border line above the first item in the pronoun search.

In addition, the PR also added some other props condition in shouldComponentUpdate that should make the item in OptionRow re-render, as suggested by the reviewer. The addition props being considered are this.props.option.shouldShowSubscript, this.props.option.ownerEmail, this.props.option.subtitle, this.props.option.pendingAction.

Fixed Issues

$ #15963
PROPOSAL: #15963 (comment)

Tests

Navigate to Settings > Profile > Pronouns
Type Hi
Observe that the border doesn't show above the first result
Type Hir
Verify that the border still doesn't show above the first result

Verify that no errors appear in the JS console

Offline tests

n/a

QA Steps

For the main issue

Navigate to Settings > Profile > Pronouns
Type Hi
Observe that the border doesn't show above the first result
Type Hir
Verify that the border still doesn't show above the first result

For the other pages that could be affected

PriorityModePage

Navigate to Settings > Preferences > Priority mode
Verify that the border doesn't show above the first item
Verify that there is no error occur

LanguagePage

Navigate to Settings > Preferences > Language
Verify that the border doesn't show above the first item
Verify that there is no error occur

ReportParticipantsPage

Navigate to a report with multiple participants
Click on the user list on the top to open Details page
Verify that the border doesn't show above the first item
Verify that there is no error occur

IOUConfirmationList

Go to a report
Choose Request money or Send money
Type in an amount and move to the confirmation page
Verify that there is no error occur

NewChatPage

Click the plus button in the LHN page, select New chat
Verify that the border doesn't show above the first item
Verify that there is no error occur

SearchPage

Click the search button in the LHN page
Verify that the border doesn't show above the first item
Verify that there is no error occur

IOUCurrencySelection

Go to a report
Choose Request money or Send money
Select the currency to enter currency selection page
Verify that the border doesn't show above the first item
Verify that there is no error occur

IOUParticipantsRequest

Click the plus button in the LHN page, select Request money
Type in an amount and proceed
Search for users
Verify that the border doesn't show above the first item
Verify that there is no error occur

IOUParticipantsSplit

Click the plus button in the LHN page, select Split bill
Type in an amount and proceed
Search for users
Verify that the border doesn't show above the first item
Verify that there is no error occur

YearPickerPage

Navigate to Settings > Profile > Personal details > Date of birth
Select year dropdown
Search for a year
Verify that the border doesn't show above the first item
Verify that there is no error occur

TimezoneSelectPage

Navigate to Settings > Profile > Timezone
Disable automatic timezone, then go to select time zone
Verify that the border doesn't show above the first item
Verify that there is no error occur

WorkspaceInvitePage

Go to a workspace
Select Manage members > Invite
Search for a user
Verify that the border doesn't show above the first item
Verify that there is no error occur

WorkspaceMembersPage

Go to a workspace
Select Manage members
Verify that the border doesn't show above the first item
Verify that there is no error occur

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web-chrome.mov

web-safari.mov

Mobile Web - Chrome

android-chrome.webm

Mobile Web - Safari

ios-safari.mov

Desktop

desktop.mov

iOS

ios-native.mov

Android

android-native.webm

MelvinBot · 2023-03-20T09:58:03Z

@Beamanator @s77rt 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

Can you please check for other props that we should re-render the item if they got changed e.g. shouldDisableRowInnerPadding, option.isPinned, option.pendingAction, etc. Just add those that are likely to be changed.

…5963

tienifr · 2023-03-21T03:38:03Z

@s77rt

shouldDisableRowInnerPadding, option.isPinned, option.pendingAction

shouldDisableRowInnerPadding is not necessarily to be change, since it’s used as a fixed boolean props with the OptionList component here and here. Similar thing goes for props.showTitleTooltip

option.isPinned is not used in OptionRow, so I think it wouldn’t be necessary to check it in shouldComponentUpdate.

Some attributes of props.option are added, namely shouldShowSubscript, icons, ownerEmail, subtitle, pendingAction. I agree that they should be presented since they're used in OptionRow. Their changes could affect the behavior of the render function.

Thoughts?

s77rt

Thanks for the update. I have requested some minor changes. Also I think we can also add allReportErrors but not sure what cases this would cover as I'd imagine pendingAction will change too most of the time we get an error, so let's skip it for now since it's an object that is not easy to compare and no clear purpose is identified.

src/components/OptionRow.js

tienifr · 2023-03-21T14:57:36Z

@s77rt Thanks for pointing that out, I've removed icons checking and moved props.shouldHaveOptionSeparator check to be after props.isSelected. Please take a look

s77rt · 2023-03-21T15:16:29Z

@tienifr Thanks! Will test asap, in the meantime please update the "Details" description in the PR.

s77rt · 2023-03-21T15:21:25Z

Also please remove the offline tests; write "n/a". I don't think offline tests have any different behavior than being online.

tienifr · 2023-03-21T15:38:25Z

@s77rt Updated as suggested 🎉 Thanks!

s77rt · 2023-03-21T15:48:21Z

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

LGTM! 🚀

cc @Beamanator

tienifr · 2023-03-22T15:52:49Z

@Beamanator Could you help to check this PR?

tienifr · 2023-03-23T08:39:24Z

@Beamanator Can you assist me in reviewing this PR?

s77rt · 2023-03-23T12:19:22Z

@tienifr No need for double-tag. I'm sure Alex will check this once he get the time.

Beamanator · 2023-03-23T18:45:28Z

Ya sorry for the delay, have been quite busy and I'm mainly on vacation this week but I'll be happy to merge soon, but I do have one question:

@s77rt @tienifr did y'all test this change on all pages that have the OptionRow? We don't want to have any regressions, and right now in the QA steps I only see tests for the Pronouns page which doesn't seem sufficient

s77rt · 2023-03-23T19:32:26Z

@Beamanator I confirm OptionRow is working fine on:

PronounsPage
PriorityModePage
LanguagePage
ReportParticipantsPage
IOUConfirmationList
NewChatPage
SearchPage
YearPickerPage
IOUCurrencySelection
IOUParticipantsRequest
IOUParticipantsSplit
TimezoneSelectPage
WorkspaceInvitePage
WorkspaceMembersPage

@tienifr Can you please confirm the same

tienifr · 2023-03-24T11:01:22Z

Beamanator

Ok great! Thanks y'all 👍

@tienifr can you please also add some kind of simple test steps for those pages in the OP as well?

OSBotify · 2023-03-24T12:13:40Z

✋ 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-03-24T19:05:47Z

🚀 Deployed to staging by https://github.com/Beamanator in version: 1.2.89-0 🚀

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

tienifr · 2023-03-25T03:42:33Z

@Beamanator Tests updated in the QA section! Everything seems good. I removed the YearPickerPage, since I think that's not relevant to the current issue.

@s77rt Just for confirmation, are you referring to the date picker page in the birthday section? If not, can you provide the location where it is used, because I cannot find a YearPickerPage component in the code.

s77rt · 2023-03-25T04:09:00Z

@tienifr On birthday page, open date picker, click on year. It will take you to the year picker page which uses OptionsSelector which uses OptionRow.

tienifr · 2023-03-25T16:14:50Z

@s77rt Thanks 🎉 I forgot to sync to the newest change

All tests for the related components are added in the QA section. All yours @Beamanator

s77rt · 2023-03-25T16:15:38Z

@tienifr This has been merged already.

OSBotify · 2023-03-27T10:32:29Z

🚀 Deployed to production by https://github.com/luacmartins in version: 1.2.89-0 🚀

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

tienifr force-pushed the fix/15963 branch 3 times, most recently from 1263c36 to 9fc0a41 Compare March 19, 2023 14:46

fix 15963: Add condition for border line display

706aa70

tienifr force-pushed the fix/15963 branch from 9fc0a41 to 706aa70 Compare March 19, 2023 14:56

fix: Add condition for border line display

3cc5761

tienifr force-pushed the fix/15963 branch from 706aa70 to 3cc5761 Compare March 20, 2023 09:57

tienifr marked this pull request as ready for review March 20, 2023 09:57

tienifr requested a review from a team as a code owner March 20, 2023 09:57

melvin-bot bot requested review from Beamanator and s77rt and removed request for a team March 20, 2023 09:58

s77rt suggested changes Mar 20, 2023

View reviewed changes

tienifr added 2 commits March 21, 2023 10:28

Additional checks in OptionRow shouldComponentUpdate

e8a2a0c

Merge branch 'fix/15963' of https://github.com/tienifr/App into fix/1…

4cc5a3d

…5963

s77rt suggested changes Mar 21, 2023

View reviewed changes

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

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

fix: optimize code

40f6fba

s77rt approved these changes Mar 21, 2023

View reviewed changes

Beamanator approved these changes Mar 24, 2023

View reviewed changes

Beamanator merged commit 9bf4fd0 into Expensify:main Mar 24, 2023

OSBotify mentioned this pull request Mar 24, 2023

Deploy Checklist: New Expensify 2023-03-24 #16489

Closed

44 tasks

MelvinBot mentioned this pull request Mar 27, 2023

[HOLD for payment 2023-04-03] [$1000] Border line appears, then disappears, above the 1st search result #15963

Closed

6 tasks

fedirjh mentioned this pull request Apr 4, 2023

Double Tapping Options Row Navigating Twice Fix And Navigation Refactoring To Resolve It From Queueing When There’s Already a Navigation Is In Progress #14426

Merged

54 tasks

fix: 15963 - Border line appears, then disappears, above the 1st search result #16094

fix: 15963 - Border line appears, then disappears, above the 1st search result #16094

Uh oh!

Conversation

tienifr commented Mar 18, 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

For the main issue

For the other pages that could be affected

PriorityModePage

LanguagePage

ReportParticipantsPage

IOUConfirmationList

NewChatPage

SearchPage

IOUCurrencySelection

IOUParticipantsRequest

IOUParticipantsSplit

YearPickerPage

TimezoneSelectPage

WorkspaceInvitePage

WorkspaceMembersPage

PR Author Checklist

Screenshots/Videos

Uh oh!

MelvinBot commented Mar 20, 2023

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

tienifr commented Mar 21, 2023

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

tienifr commented Mar 21, 2023

Uh oh!

s77rt commented Mar 21, 2023

Uh oh!

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

Uh oh!

Uh oh!

tienifr commented Mar 21, 2023

Uh oh!

s77rt commented Mar 21, 2023

Reviewer Checklist

Screenshots/Videos

Uh oh!

s77rt left a comment

Choose a reason for hiding this comment

Uh oh!

tienifr commented Mar 22, 2023

Uh oh!

tienifr commented Mar 23, 2023

Uh oh!

s77rt commented Mar 23, 2023

Uh oh!

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

Uh oh!

Uh oh!

s77rt commented Mar 23, 2023

Uh oh!

tienifr commented Mar 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Beamanator left a comment

Choose a reason for hiding this comment

Uh oh!

OSBotify commented Mar 24, 2023

Uh oh!

OSBotify commented Mar 24, 2023

Uh oh!

tienifr commented Mar 25, 2023

Uh oh!

tienifr commented Mar 18, 2023 •

edited

Loading

s77rt commented Mar 21, 2023 •

edited

Loading

Beamanator commented Mar 23, 2023 •

edited

Loading

tienifr commented Mar 24, 2023 •

edited

Loading