[HOLD for payment 2023-11-22] [$500] New room - Workspace selector doesn't highlight when selected

[kbecciv]

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

---

Version Number: 1.3.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
Expensify/Expensify Issue URL:
Issue reported by: @namhihi237
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1697209356639479

Action Performed:

1. Create some WS
2. Click FAB button
3. Click send message and select room tab
4. Click workspace section
5. Select any workspace
6. Click workspace section again, Observe that the selected item is not highlighted

Expected Result:

Selected item is highlighted

Actual Result:

Selected item is not highlighted

Workaround:

Unknown

Platforms:

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

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Android: Native

Screen.Recording.2023-10-13.at.22.58.41.mov

Android: mWeb Chrome

Screen.Recording.2023-10-13.at.22.54.20.mov

iOS: Native

Screen.Recording.2023-10-13.at.22.54.40.mov

iOS: mWeb Safari

Screen.Recording.2023-10-13.at.22.08.35.mov

MacOS: Chrome / Safari

Screen.Recording.2023-10-13.at.22.02.51.mov

MacOS: Desktop

Screen.Recording.2023-10-13.at.22.04.20.mov

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~01a505b5f852bd2d0f
• Upwork Job ID: 1713907491046084608
• Last Price Increase: 2023-10-30
• Automatic offers:
• 0xmiroslav | Reviewer | 27552192
• namhihi237 | Contributor | 27552193
• namhihi237 | Reporter | 27552194

[melvin-bot]

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

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~01a505b5f852bd2d0f

[melvin-bot]

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

[melvin-bot]

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

[kbecciv]

Proposal by: @namhihi237
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1697209356639479

Proposal

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

The selected item is highlighted on some selectors on Create Room, we need to fix them

What is the root cause of that problem?

In Visibility and Workspace selectors when creating a room we use ValueSelectorModal component and it uses SelectionList but we pass the initiallyFocusedOptionKey incorrectly.

App/src/components/ValuePicker/ValueSelectorModal.js

Lines 70 to 74 in 9e19e40

	<SelectionList
	sections={[{data: sectionsData}]}
	onSelectRow={onItemSelected}
	initiallyFocusedOptionKey={currentValue}
	/>

It should be the same we create keyForList in itemsData

App/src/components/ValuePicker/ValueSelectorModal.js

Line 47 in 9e19e40

const itemsData = _.map(items, (item) => ({value: item.value, keyForList: item.value, text: item.label, isSelected: item === selectedItem}));

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

We should update correctly initiallyFocusedOptionKey:

initiallyFocusedOptionKey={selectedItem.value}

What alternative solutions did you explore? (Optional)

Also, we can remove currentValue prop because it doesn't used

[dukenv0307]

Proposal

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

Selected item is not highlighted

What is the root cause of that problem?

1. In here, we're passing the currentValue incorrectly, we're passing the label to it, while we should use the value of the selected option (similar patterns for other places like here)
2. The fallback value of focusedIndex here is not ideal. It's defaulting to -1 if initiallyFocusedOptionKey is not found. IMO if initiallyFocusedOptionKey is not passed, it should default to the index of the item that has isSelected true, if there's no item that has isSelected true, then it can be -1.

This unideal design leads to us duplicating the logic by passing initiallyFocusedOptionKey as the key of the selected item in almost all selection list places like here, here, here. If we default to the isSelected item, we can omit initiallyFocusedOptionKey in all those places and only pass it if we need to customize (initially focus on something other than isSelected)

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

1. Change this to

currentValue={value}

2. Fix here so that it finds the focusedIndex based on the following priority:

• initiallyFocusedOptionKey
• item that has isSelected as true
• -1

We can optionally remove initiallyFocusedOptionKey in a lot of places since it's no longer needed after the above correct default is implemented. In the future for SelectionList we also (mostly) don't have to add it, reducing surface for errors like this to happen.

What alternative solutions did you explore? (Optional)

NA

[atef1995]

Proposal for Issue #29675

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

The current implementation of the ValueSelectorModal component does not correctly highlight the selected item when the workspace section is clicked again.

Root Cause

The issue is likely due to how isSelected is being set in the useEffect function. Specifically, the comparison item === selectedItem is an object reference comparison, which may not behave as intended if item and selectedItem are not referring to the exact same object.

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

Object Equality: Change the object reference equality check to a value equality check for the relevant fields. This will ensure that items are correctly marked as selected based on their value property.

Logging and Debugging: Temporarily add console logs inside the useEffect to ensure that items and selectedItem are being updated as expected. Remove these logs once the issue is confirmed to be fixed.

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

[melvin-bot]

📣 @atef1995! 📣
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. Make sure you've read and understood the contributing guidelines.
2. 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.
3. 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.
4. 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>

[joekaufmanexpensify]

Going to triage this tomorrow

[joekaufmanexpensify]

Seems like this is a bug, but confirming here that this should not have been fixed in another issue

[joekaufmanexpensify]

Okay, confirmed we can proceed here. @0xmiroslav could you share whether any of these proposals work?

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[joekaufmanexpensify]

Pending review of proposals

[0xmiros]

reviewing

[joekaufmanexpensify]

TY!

[joekaufmanexpensify]

@0xmiroslav any of these proposals work?

[joekaufmanexpensify]

Still pending input on proposals

[0xmiros]

I will provide feedback by Monday

[melvin-bot]

⚠️ Looks like this issue was linked to a Deploy Blocker here

If you are the assigned CME please investigate whether the linked PR caused a regression and leave a comment with the results.

If a regression has occurred and you are the assigned CM follow the instructions here.

If this regression could have been avoided please consider also proposing a recommendation to the PR checklist so that we can avoid it in the future.

[joekaufmanexpensify]

@0xmiroslav I saw your comment on the other issue. That means the PR in this issue is blocked on #31192, is that right?

[0xmiros]

@0xmiroslav I saw your comment on the other issue. That means the PR in this issue is blocked on #31192, is that right?

yes but likely unblocked today again as linked issue is deploy blocker and that offending PR is being reverted

[melvin-bot]

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

[melvin-bot]

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

• fix selector highlight when selected #30958

If no regressions arise, payment will be issued on 2023-11-22. 🎊

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.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

For reference, here are some details about the assignees on this issue:

• @namhihi237 requires payment offer (Contributor)
• @0xmiroslav requires payment offer (Reviewer)
• @namhihi237 requires payment offer (Contributor)

[melvin-bot]

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:

• [@0xmiroslav] The PR that introduced the bug has been identified. Link to the PR: Allow Welcome Message on Room Creation #29541
• [@0xmiroslav] 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: Allow Welcome Message on Room Creation #29541 (comment)
• [@0xmiroslav] 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: N/A
• [@0xmiroslav] Determine if we should create a regression test for this bug.
• [@0xmiroslav] 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.
• [@joekaufmanexpensify] Link the GH issue for creating/updating the regression test once above steps have been agreed upon: N/A

[joekaufmanexpensify]

@0xmiroslav could you please complete your portion of the BZ checklist?

[melvin-bot]

@dangrous, @namhihi237, @joekaufmanexpensify, @0xmiroslav Eep! 4 days overdue now. Issues have feelings too...

[0xmiros]

• The PR that introduced the bug has been identified. Link to the PR: Allow Welcome Message on Room Creation #29541
• 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: Allow Welcome Message on Room Creation #29541 (comment)
• 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: N/A This should have been caught earlier during PR review.
• Determine if we should create a regression test for this bug. I don't suggest regression test as this is minor visual bug.
• 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.

[joekaufmanexpensify]

BZ checklist is done. All set to issue payment!

[joekaufmanexpensify]

We need to issue the following payments:

• @namhihi237 - $500 for PR. Paid via Upwork.
• @namhihi237 - $50 for reporting. Paid via Upwork.
• @0xmiroslav -$500 for C+ review.

[joekaufmanexpensify]

@0xmiroslav looks like an offer was made automatically to an upwork account. But it doesn't look like the correct one. I saw on a previous issue you were tracking payment on your end, so I didn't make any payment to you in the issue. Is that still the case?

[joekaufmanexpensify]

@namhihi237 $500 sent and contract ended!

[joekaufmanexpensify]

@namhihi237 $50 sent and contract ended!

[0xmiros]

yes, let's close this if other payments are done. Thanks

[joekaufmanexpensify]

Sounds good! There was an automatic offer sent to an upwork account for a Volodymyr for C+ review. Going to end that contract without payment for now.

[joekaufmanexpensify]

Closing as this is all set. Thanks everyone!