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

[kavimuru]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Action Performed:

1. Navigate to Settings > Profile > Pronouns
2. Type Hi
3. Observe that the border doesn't show above the first result
4. Type Hir
5. Observe that the border now shows above the first result
6. Hover over the first result
7. Observe that the border no longer show above the first result

Expected Result:

There should not be a border line above the first item

Actual Result:

Initially there is a border above the first searched result and disappears when hovering over the item

Workaround:

unknown

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.2.84-1
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Notes/Photos/Videos:

Recording.1707.mp4

pronounns-border-issue.mov

Border doesn't show above the first result	Border shows above the first result	After hover, border doesn't show above the first result

Expensify/Expensify Issue URL:
Issue reported by: @jayeshmangwani
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1678739463694459

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~019f108d0e7679c2b4
• Upwork Job ID: 1635885788604809216
• Last Price Increase: 2023-03-15

[MelvinBot]

Triggered auto assignment to @conorpendergrast (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[MelvinBot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[conorpendergrast]

I've added a few more details to the reproduction steps, and a set of 3 screenshots to show more precisely the issue. Thanks!

[MelvinBot]

Job added to Upwork: https://www.upwork.com/jobs/~019f108d0e7679c2b4

[MelvinBot]

Current assignee @conorpendergrast is eligible for the External assigner, not assigning anyone new.

[MelvinBot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @s77rt (External)

[MelvinBot]

Triggered auto assignment to @Beamanator (External), see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[tienifr]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Initially there is a border above the first searched result and disappears when hovering over the item in the pronoun list.

What is the root cause of that problem?

We're not checking the shouldHaveOptionSeparator prop in shouldComponentUpdate of OptionRow. So when shouldHaveOptionSeparator changes but other props remain the same, the component style is not updated and the border top remains.

What changes do you think we should make in order to solve the problem?

Adding || this.props.shouldHaveOptionSeparator !== nextProps.shouldHaveOptionSeparator; to the shouldComponentUpdate of OptionRow here

App/src/components/OptionRow.js

Line 88 in 1823b1c

shouldComponentUpdate(nextProps, nextState) {

will solve the issue.

What alternative solutions did you explore? (Optional)

NA

Result

Working well after the fix:

Screen.Recording.2023-03-15.at.13.24.59.mov

[jayeshmangwani]

Proposal

Please re-state the problem that we are trying to solve in this issue.

When searching the pronounce then listing first item shows the top border

What is the root cause of that problem?

Initially, when we render the list we pass the shouldHaveOptionSeparator prop for checking if the index is greater than 0 and then show the top border, so initially, it is working but when we search the new list and the after new updated index of the OptionRow list does not rendering again due to keyExtractor function, where we have added only keyForList change to the render list

What changes do you think we should make in order to solve the problem?

We can update the keyExtractor function of the SectionList to the when if index is updated then also render the list again

before
extractKey(option) {
    return option.keyForList;
}


after
extractKey(option, index) {
    return `${option.keyForList}${index}`
}

Fix

15963-solve.mov

What alternative solutions did you explore? (Optional)

• none

[MelvinBot]

📣 @jayeshmangwani! 📣

Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
2. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
3. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.

Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[jayeshmangwani]

Contributor details
Your Expensify account email: jayeshmangwani@gmail.com
Upwork Profile Link: https://www.upwork.com/freelancers/~0113380ca9ab9a0820

[MelvinBot]

✅ Contributor details stored successfully. Thank you for contributing to Expensify!

[MuhammadArslanKhan96]

the problem is in shouldComponentUpdate under OptionRow.js componenet, we are not re-rendering the component after update of border top condition.

I've fixed the issue please check

Screen.Recording.2023-03-15.at.3.14.02.PM.mov

[MelvinBot]

📣 @MuhammadArslanKhan96! 📣

Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
2. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
3. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.

Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[MuhammadArslanKhan96]

Contributor details
Your Expensify account email: m.arslan2201@gmail.com
Upwork Profile Link: https://www.upwork.com/freelancers/~01cec63d38b37d453e

[MelvinBot]

✅ Contributor details stored successfully. Thank you for contributing to Expensify!

[Pujan92]

Proposal

Please re-state the problem that we are trying to solve in this issue.

Top border remains for the first option on filtering the pronouns list

What is the root cause of that problem?

OptionRow component seems not updated as it is not considering shouldHaveOptionSeparator property.

What changes do you think we should make in order to solve the problem?

Instead of adding the separator(top border) manually, we can use the ItemSeparatorComponent prop for the SectionList which will take care of the separator of 1px border with the <View style={styles.borderTop} />} here in case the shouldHaveOptionSeparator is true.

App/src/components/OptionsList/BaseOptionsList.js

Line 219 in eedd92a

<SectionList

What alternative solutions did you explore? (Optional)

We can add and consider prop shouldHaveOptionSeparator in shouldComponentUpdate of OptionRow as @tienifr proposed.

[s77rt]

@tienifr Thanks for the proposal! Your RCA is correct and the fix is straightforward 👍

🎀 👀 🎀 C+ reviewed

cc @Beamanator

[s77rt]

@jayeshmangwani Thanks for the proposal! I don't think the RCA is correct, it is intentional to use a constant key otherwise we will re-render every item that changes position even if it's content (and styles) didn't change.

[MelvinBot]

📣 @tienifr You have been assigned to this job by @Beamanator!
Please apply to this job in Upwork and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[Beamanator]

@s77rt it looks like you approved this proposal and I agree it looks perfect, so assigning @tienifr ! 👍

[Beamanator]

(p.s. sorry for the delay, had a crazy busy week last week at ExpensiConX)

[s77rt]

@tienifr Please make sure to cover other missing cases besides props.shouldHaveOptionSeparator.

[conorpendergrast]

Hiring for this job:

• The Contributor+ @ $1000: @s77rt
• The contributor fixing the issue @ $1000: @tienifr
• The contributor who reported the issue/bug @ $250: @jayeshmangwani

[tienifr]

Regression Test Proposal

Bug: Border line appears, then disappears, above the 1st search result

Proposed Test Steps:

For the main issue

1. Navigate to Settings > Profile > Pronouns
2. Type Hi
3. Observe that the border doesn't show above the first result
4. Type Hir
5. Verify that the border still doesn't show above the first result

For the other pages that could be affected

PriorityModePage

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

LanguagePage

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

ReportParticipantsPage

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

IOUConfirmationList

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

NewChatPage

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

SearchPage

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

IOUCurrencySelection

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

IOUParticipantsRequest

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

IOUParticipantsSplit

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

YearPickerPage

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

TimezoneSelectPage

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

WorkspaceInvitePage

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

WorkspaceMembersPage

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

Do we 👍 or 👎

[MelvinBot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[MelvinBot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 1.2.89-0 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

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

If no regressions arise, payment will be issued on 2023-04-03. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

Assigned 2023-03-20
Merged 2023-03-24
Standard payment (no bonus or penalty)

• The Contributor+ @ $1000: @s77rt
• The contributor fixing the issue @ $1000: @tienifr
• The contributor who reported the issue/bug @ $250: @jayeshmangwani

[MelvinBot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@s77rt / @Beamanator] The PR that introduced the bug has been identified. Link to the PR:
• [@s77rt / @Beamanator] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@s77rt / @Beamanator] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@conorpendergrast] Determine if we should create a regression test for this bug.
• [@s77rt] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@conorpendergrast] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: https://github.com/Expensify/Expensify/issues/273857

[s77rt]

• The PR that introduced the bug has been identified: 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
• The offending PR has been commented on: 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 (comment)
• A discussion in #expensify-bugs has been started: https://expensify.slack.com/archives/C049HHMV9SM/p1679936488302459

---

Regression Test Proposal

1. Go to Settings > Profile > Pronouns
2. In the search field, type Hi
3. Verify that the border doesn't show above the first result
4. Type Hir
5. Verify that the border still doesn't show above the first result

[Beamanator]

Bump @conorpendergrast if you don't mind doing the payments here soon please :D

[conorpendergrast]

Sorry, missed this on Monday 🤦

[conorpendergrast]

Payments made (this comment)

[conorpendergrast]

Regression test steps proposed. All done!