[Awaiting checklist completion] [$500] Workspace - Selected users to invite turn deselected when refresh Add message page

[kbecciv]

If you haven’t already, check out our contributing guidelines for onboarding and email [email protected] to request to join our Slack channel!

---

Version Number: 1.4.11-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: Applause - Internal Team
Slack conversation:

Action Performed:

1. Go to staging.new.expensify.com
2. Navigate to Settings> Workspace> Members> Invite
3. Invite several more members
4. Click on next to advance to the next page
5. Add custom invite message
6. Refresh the page
7. Click on Back button to turn back to Invite members page

Expected Result:

Selected users to invite should remain after refreshing the page

Actual Result:

Selected users to invite turn deselected when refresh Add message page

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

Add any screenshot/video evidence

Bug6309325_1702314309129.Recording__1528.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0126f4ea7df784a0b0
• Upwork Job ID: 1734263366726746112
• Last Price Increase: 2023-12-18
• Automatic offers:
• BhuvaneshPatil | Contributor | 28077747

Issue Owner

Current Issue Owner: @allroundexperts

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~0126f4ea7df784a0b0

[melvin-bot]

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

[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 - @allroundexperts (External)

[BhuvaneshPatil]

Proposal

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

Workspace - Selected users to invite turn deselected when refresh Add message page

What is the root cause of that problem?

We are using selectedOptions to store the invited users. That is being reset to empty [] when initialise.
When we refresh the page, it gets initialized to empty array.

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

• We store the users to invite ONYX object with key

  ${ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MEMBERS_DRAFT}${policyID}

• This contains the dictionary as {login: accountID}.

We can use these logins to populate selectedOptions state in useEffect of WorkspaceInvitePage.
For example if we store value from ONYX in invitedUsersDraft props.
We can populate this newSelectedOptions(line 107) like following

_.each(_.keys(props.invitedUsersDraft), (login) => {
         newSelectedOptions.push(_.has(detailsMap, login) ? {...detailsMap[login], isSelected: true} : inviteOptions[login]);
     });

This will do the work.

Screen.Recording.2023-12-12.at.1.00.01.AM.mov

Question that I have is - what to do if we go back to previous page and come again back to invite page, the options will remain as is.
Observe when we go back from invite page to members page and click next, options are pre-populated.

Screen.Recording.2023-12-12.at.1.03.09.AM.mov

Shall we erase the options?
If yes - Then we can just call setWorkspaceInviteMembersDraft with empty object when we press back.
Or we can call above method in clean up of useEffect with [] dependency.

As called out in this proposal, about changing the WORKSPACE_INVITE_MEMBERS_DRAFT when use clicks the option, we can handle that by taking out all logic(except navigation) of inviteUser() and call that.

What alternative solutions did you explore? (Optional)

[BhuvaneshPatil]

@twisterdotcom I have asked a question in my proposal

Question that I have is - what to do if we go back to previous page and come again back to invite page, the options will remain as is.

Please have a look and suggest the expected behaviour.
Thanks

[DylanDylann]

Proposal

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

Selected users to invite turn deselected when refresh Add message page

What is the root cause of that problem?

The selected option is set to empty when reloading the page

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

Currently, On the Invite Member Page, if the user clicks the next button we will save the selected option to WORKSPACE_INVITE_MEMBERS_DRAFT. So we can use this field to re-set the selected option on the Invite Member Page

App/src/pages/workspace/WorkspaceInvitePage.js

Line 93 in 7f7cfb3

useEffect(() => {

In this useEffect we also need to add WORKSPACE_INVITE_MEMBERS_DRAFT to newSelectedOption

We also need to add more logic to update WORKSPACE_INVITE_MEMBERS_DRAFT:

1. when the user selects or unselects a new option, we need to update WORKSPACE_INVITE_MEMBERS_DRAFT. So that when the user reload the page the newly selected option will be updated
2. Reset WORKSPACE_INVITE_MEMBERS_DRAFT to empty when the Invite Member Page is unmount by using clean up function of useEffect
3. In here
   

   App/src/libs/Navigation/AppNavigator/AuthScreens.tsx

   Line 126 in 7f7cfb3

   beforeRemove: () => {

We also need to add logic to reset WORKSPACE_INVITE_MEMBERS_DRAFT to empty like we did with search input value

What alternative solutions did you explore? (Optional)

NA

[twisterdotcom]

what to do if we go back to previous page and come again back to invite page

I think it's fine for the previously selected invitees to still be selected here. I don't see why we need to clear them.

[twisterdotcom]

@allroundexperts how are these proposals?

[melvin-bot]

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

[melvin-bot]

@twisterdotcom, @allroundexperts Whoops! This issue is 2 days overdue. Let's get this updated quick!

[melvin-bot]

@twisterdotcom, @allroundexperts Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[twisterdotcom]

@Sourcecodedeveloper I'm down to do the easiest solution, so starting fresh is also fine.

[aimane-chnaif]

#32835 is similar to this one

[allroundexperts]

@BhuvaneshPatil's proposal looks good to me. @Sourcecodedeveloper I don't see any good reason to use fallbackRoute when we are already saving the draft state of the workspace in Onyx.

@DylanDylann Thanks for your proposal. However, I don't really see any significant difference from what @BhuvaneshPatil proposed earlier.

🎀 👀 🎀 C+ reviewed

[melvin-bot]

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

[DylanDylann]

@allroundexperts the significant difference between my proposal and @BhuvaneshPatil's proposal is how we update WORKSPACE_INVITE_MEMBERS_DRAFT. At the time I posted the proposal, he didn't mention any way to do that

[melvin-bot]

@twisterdotcom, @cristipaval, @allroundexperts Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

[melvin-bot]

@twisterdotcom @cristipaval @allroundexperts this issue is now 3 weeks old. There is one more week left before this issue breaks WAQ and will need to go internal. What needs to happen to get a PR in review this week? Please create a thread in #expensify-open-source to discuss. Thanks!

[melvin-bot]

@twisterdotcom @cristipaval @allroundexperts this issue is now 3 weeks old. There is one more week left before this issue breaks WAQ and will need to go internal. What needs to happen to get a PR in review this week? Please create a thread in #expensify-open-source to discuss. Thanks!

[twisterdotcom]

Bump on this @cristipaval

[melvin-bot]

📣 @BhuvaneshPatil 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer 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 📖

[cristipaval]

what to do if we go back to previous page and come again back to invite page

I think it's fine for the previously selected invitees to still be selected here. I don't see why we need to clear them.

If the user explicitly leaves the page, I think we should start with a fresh list when they come back 🤔
cc @twisterdotcom

[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.4.26-2 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Select members from ONYX on page open, remove them on unmounting #34028

If no regressions arise, payment will be issued on 2024-01-25. 🎊

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

• @BhuvaneshPatil requires payment automatic offer (Contributor)
• @allroundexperts requires payment through NewDot Manual Requests

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

• [@allroundexperts] The PR that introduced the bug has been identified. Link to the PR:
• [@allroundexperts] 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:
• [@allroundexperts] 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:
• [@allroundexperts] Determine if we should create a regression test for this bug.
• [@allroundexperts] 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.
• [@twisterdotcom] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[twisterdotcom]

Payment Summary:

• @BhuvaneshPatil paid $500 here (Contributor)
• @allroundexperts to be paid $500 via NewDot Manual Requests (C+)

[allroundexperts]

Checklist

1. I think this was more of a feature than a bug. As such, there isn't any PR that is responsible for introducing this.
2. N/A
3. N/A
4. A regression test would be good though. The steps given in the OP seem clear enough to me.

[JmillsExpensify]

$500 payment approved for @twisterdotcom based on this comment.