[HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search #15661

kavimuru · 2023-03-04T04:29:34Z

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:

Open the app
Navigate to Settings > Workspaces > Select any workspace
Manage members
Write something in Search
Click Invite members then Go back
Notice that the search value is still present
Now go to Invite members > Write something in Search > Go back
Click on Invite members again > You'll notice that previous search value is not present

Expected Result:

Behavior should be consistent for all sections

Actual Result:

Different behavior is being observed

Workaround:

unknown

Platforms:

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

Version Number: 1.2.78-0
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:

manage-vs-invite.mp4

Recording.1627.mp4

Expensify/Expensify Issue URL:
Issue reported by: @daraksha-dk
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1677844622336169

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~011d403a6a3312983b
Upwork Job ID: 1633255400742793216
Last Price Increase: 2023-03-21

MelvinBot · 2023-03-04T04:29:39Z

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

MelvinBot · 2023-03-04T04:29:42Z

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

MelvinBot · 2023-03-07T21:02:44Z

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

MelvinBot · 2023-03-07T23:56:48Z

Job added to Upwork: https://www.upwork.com/jobs/~011d403a6a3312983b

MelvinBot · 2023-03-07T23:56:52Z

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

MelvinBot · 2023-03-07T23:56:59Z

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

MelvinBot · 2023-03-07T23:57:05Z

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

anmurali · 2023-03-07T23:57:43Z

This is where the issue was previously discussed

osofus · 2023-03-08T00:46:55Z

It is not really inconsistent behaviour. If you go back from the 'manage members' page, the search text will get cleared.
The reason it doesn't clear when you go into 'invite members' page is the 'manage members' page is not unmounted.
The app has to be keep the page in memory, so the user can go back to it.
It is unmounted when you go back from the 'manage members' page, which is what happens when you go back from the 'invite members' page.

you1996 · 2023-03-08T01:56:47Z

Proposal

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

The issue at hand pertains to inconsistent behavior observed in Manage Member's search and Invite Member's search, where the inputs are sometimes empty, and sometimes carry over their previous value. This inconsistency needs to be resolved.

What is the root cause of that problem?

The root cause of this issue is related to memory management in React. While this behavior is not necessarily problematic, it is expected that a visited page will be stored for easy access when a user revisits it. In this case, when a user inputs text in the text input, the current page (i.e., members page) and all its values are stored. When the user navigates to the next page (i.e., invite members), the browser mounts the invite members page with all its components. When the user navigates back from invite to members, the browser uses the saved copy of the page.

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

To ensure consistency and resolve the issue, it is suggested to clear the data ( input value) in the Manage Member's search in the componentWillUnmount(). This solution is chosen because users expect that no data will be saved in a search bar when they leave a page.

App/src/pages/workspace/WorkspaceMembersPage.js

Lines 380 to 384 in 7e8e8a1

    
           <TextInput 
        
               value={this.state.searchValue} 
        
               onChangeText={this.updateSearchValue} 
        
               placeholder={this.props.translate('optionsSelector.nameEmailOrPhoneNumber')} 
        
           />

moezh · 2023-03-08T13:58:10Z

Proposal

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

The current issue is that when a user navigates back from the Invite member page, the search text is cleared.

What is the root cause of that problem?

The cause of this issue is that the current component WorkspaceInvitePage is not needed anymore when navigating back. When a component is not needed, it's get unmounted by React and all its states are lost. In our case this will clear the search term.

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

To address the root cause of the problem, we can temporarily save the search term state in the local storage. Here's what we can do:

Save the search value in the local storage when the WorkspaceInvitePage component will unmount.
Retrieve the search value from the local storage when the WorkspaceInvitePage component is being initiated.
Remove the search term value from the local storage when the parent component WorkspaceMembersPage will unmount.

Screen.Recording.2023-03-08.at.2.04.14.PM.mov

What alternative solutions did you explore? (Optional)

No alternative solutions were explored.

anmurali · 2023-03-11T00:34:41Z

@sobitneupane - thoughts on these proposals?

sobitneupane · 2023-03-13T07:41:16Z

@you1996 Thanks for your proposal.

I don't think use of componentWillUnmount will work here as WorkspaceMembersPage is not unmounted on navigating to WorkspaceInvitePage.

sobitneupane · 2023-03-13T07:43:24Z

@moezh Thanks for your proposal.

But I believe the expected result is to remove the search term from WorspaceMembersPage not retain value in WorkspaceInvitePage

tienifr · 2023-03-13T08:06:52Z

Proposal

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

Inconsistent behaviour for Manage Member's search & Invite member's search

What is the root cause of that problem?

When we move into the Invite Page, the Member Page is still mounted so the search value remains. But when back from the invite Page, the invite Page is unmounted immediately so the search value in the invite page doesn't remain

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

We should clear the input value when clicking the Invite Button

inviteUser() {
        this.setState({searchValue: ''});
        Navigation.navigate(ROUTES.getWorkspaceInviteRoute(this.props.route.params.policyID));
}

Result

Screen.Recording.2023-03-13.at.15.07.55.mov

What alternative solutions did you explore? (Optional)

We also could save the search value in the invite page, and the member page,... as a draft value (and save it in ONYX storage) like how we save the draft value in the composer

EDIT: This is more detail for this solution
Firstly, in /App/src/libs/actions/Policy.js we will create a new function to update the draft search value for the invite page

 * @param {String} policyID
 * @param {String} searchValue
 */
function saveinvitePageDraftSearchValue(policyID, searchValue) {
    Onyx.merge(`${ONYXKEYS.COLLECTION.INVITE_PAGE_DRAFT_SEARCH_VALUE}${policyID}`, searchValue);
}

Then in /App/src/pages/workspace/WorkspaceInvitePage.js whenever we update the searchValue we also update the draft value in the ONYX by the above function (consider using debound for this function). Also, we will get the draft value in the invite page

draftSearchValue: {
            key: props => `${ONYXKEYS.COLLECTION.INVITE_PAGE_DRAFT_SEARCH_VALUE}${props.route.params.policyID}`,
        },

and update the draftSearchValue in the constructor if the draftSearchValue is not empty

const {
            personalDetails,
            userToInvite,
        } = OptionsListUtils.getMemberInviteOptions(
            props.personalDetails,
            props.betas,
            **props.draftSearchValue || '',**
            this.getExcludedUsers(),
        );
        this.state = {
            **searchTerm: props.draftSearchValue || '',**
           ....
}

We also could update the draftSearchValue in ComponentDidMount

Result

Screen-Recording-2023-03-14-at-09.25.02.mp4

This is my draft implementation on the invite page, We could do the same on other pages like the manage member Page,...

bernhardoj · 2023-03-13T10:12:27Z

Why would we want to remove the search value after navigating forward? The expected behavior only mentioned "Behavior should be consistent for all sections" but does not tell which behavior. Looking at the last step, they expect the search value at invite members page is saved. Saving/clearing the search value seems like a feature request to me which should be discussed whether it is required because it affects the UX of the app.

Edit: why I think it is a feature request.
I believe we don't have such expected behavior anywhere in the app. The current behavior is already aligned with other parts of the app, for example login form. You input the email, press continue, fill the password, go back and the email is still there. Continue again and you will find the password is empty. 100% not a bug.

MelvinBot · 2023-03-31T10:43:42Z

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

MelvinBot · 2023-03-31T10:43:44Z

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

fix inconsistent search behavior between manage members & invite members #16603

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

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

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

Merged PR within 3 business days of assignment - 50% bonus
Merged PR more than 9 business days after assignment - 50% penalty

MelvinBot · 2023-03-31T10:43:47Z

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:

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

MelvinBot · 2023-04-10T09:36:34Z

@iwiznia, @anmurali, @sobitneupane, @situchan Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

MelvinBot · 2023-04-10T10:06:13Z

@iwiznia, @anmurali, @sobitneupane, @situchan Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

anmurali · 2023-04-10T22:52:19Z

@sobitneupane - can you take care of your checklist items?

sobitneupane · 2023-04-11T04:17:27Z

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:

The PR that introduced the bug has been identified. Link to the PR:

#15123

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:

#15123 (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:

https://expensify.slack.com/archives/C049HHMV9SM/p1681186634307459

sobitneupane · 2023-04-11T04:22:42Z

Regression Test Proposal

Navigate to Settings > Workspaces > Select any workspace
Go to Manage members
Write something in search input
Click Invite button
Click back button on Invite members page
Verify that search value is cleared on Manage members page

Do we agree 👍 or 👎

MelvinBot · 2023-04-14T10:06:18Z

@iwiznia, @anmurali, @sobitneupane, @situchan Uh oh! This issue is overdue by 2 days. Don't forget to update your issues!

iwiznia · 2023-04-14T16:52:00Z

@sobitneupane agree with that regression test (I now realize I should've commented and not reacted to your comment). Can you take care of creating that new regression test?

@anmurali I think you need to pay here?

iwiznia · 2023-04-17T22:54:36Z

Did we pay this already? If so, can we close this?

anmurali · 2023-04-18T02:46:58Z

Sent contracts to them all, will pay and close this once they accept them

sobitneupane · 2023-04-18T03:00:46Z

@anmurali Thanks. Accepted the offer.

situchan · 2023-04-18T03:24:38Z

@anmurali accepted, thanks!

anmurali · 2023-04-18T18:51:21Z

Everyone's paid
https://github.com/Expensify/Expensify/issues/276730

situchan · 2023-04-19T08:10:45Z

Not sure if timeline bonus is applicable here.

Based on https://ex-syt.glitch.me/?issue=15813&pr=16603:
(@anmurali you can use this link for other issues to save your time ⏲️)

Here's the Issue timeline analysis:
🐛 Issue created at: Sat, 04 Mar 2023 04:29:34 GMT
🧯 Help Wanted at: Tue, 07 Mar 2023 23:57:02 GMT
🕵🏻 Contributor assigned at: Mon, 27 Mar 2023 18:43:20 GMT
🛸 PR created at: Tue, 28 Mar 2023 04:31:15 GMT
🎯 PR merged at: Wed, 29 Mar 2023 16:27:24 GMT
⌛ Business Days Elapsed between assignment and PR merge: 2

💰 Timeline Bonus/Penalty: 50% Bonus! 🎉

kavimuru added Daily KSv2 Bug Something is broken. Auto assigns a BugZero manager. labels Mar 4, 2023

melvin-bot bot assigned anmurali Mar 4, 2023

melvin-bot bot locked and limited conversation to collaborators Mar 4, 2023

melvin-bot bot added the Overdue label Mar 6, 2023

anmurali added the External Added to denote the issue can be worked on by a contributor label Mar 7, 2023

melvin-bot bot unlocked this conversation Mar 7, 2023

melvin-bot bot changed the title ~~Inconsistent behaviour for Manage Member's search & Invite member's search~~ [$1000] Inconsistent behaviour for Manage Member's search & Invite member's search Mar 7, 2023

melvin-bot bot assigned sobitneupane Mar 7, 2023

melvin-bot bot added the Help Wanted Apply this label when an issue is open to proposals by contributors label Mar 7, 2023

melvin-bot bot assigned iwiznia Mar 7, 2023

melvin-bot bot removed the Overdue label Mar 7, 2023

melvin-bot bot added the Overdue label Mar 10, 2023

melvin-bot bot removed the Overdue label Mar 11, 2023

melvin-bot bot changed the title ~~[$4000] Inconsistent behaviour for Manage Member's search & Invite member's search~~ [HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search Mar 31, 2023

melvin-bot bot removed the Reviewing Has a PR in review label Mar 31, 2023

melvin-bot bot added Daily KSv2 Overdue and removed Weekly KSv2 labels Apr 7, 2023

melvin-bot bot removed the Overdue label Apr 10, 2023

sobitneupane mentioned this issue Apr 11, 2023

Add Workspace Members Search Feature #15123

Merged

52 tasks

melvin-bot bot added the Overdue label Apr 13, 2023

melvin-bot bot added Overdue and removed Overdue labels Apr 14, 2023

melvin-bot bot removed the Overdue label Apr 17, 2023

anmurali closed this as completed Apr 18, 2023

situchan mentioned this issue Jul 10, 2023

[HOLD for payment 2023-12-15] [$500] Web - Search Term in WorkspaceMembersPage lost when clicking on Invite #22534

Closed

6 tasks

DylanDylann mentioned this issue Dec 6, 2023

[HOLD for payment 2024-01-17] [$500] Distance - Able to request money by distance by adding a stop same as finish point without enterring start point From #29895

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search #15661

[HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search #15661

kavimuru commented Mar 4, 2023 •

edited by melvin-bot bot

Loading

MelvinBot commented Mar 4, 2023

MelvinBot commented Mar 4, 2023 •

edited by anmurali

Loading

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

anmurali commented Mar 7, 2023

osofus commented Mar 8, 2023

you1996 commented Mar 8, 2023

moezh commented Mar 8, 2023

anmurali commented Mar 11, 2023

sobitneupane commented Mar 13, 2023 •

edited

Loading

sobitneupane commented Mar 13, 2023

tienifr commented Mar 13, 2023 •

edited

Loading

bernhardoj commented Mar 13, 2023 •

edited

Loading

MelvinBot commented Mar 31, 2023

MelvinBot commented Mar 31, 2023

MelvinBot commented Mar 31, 2023 •

edited by anmurali

Loading

MelvinBot commented Apr 10, 2023

MelvinBot commented Apr 10, 2023

anmurali commented Apr 10, 2023

sobitneupane commented Apr 11, 2023 •

edited

Loading

sobitneupane commented Apr 11, 2023

MelvinBot commented Apr 14, 2023

iwiznia commented Apr 14, 2023

iwiznia commented Apr 17, 2023

anmurali commented Apr 18, 2023

sobitneupane commented Apr 18, 2023

situchan commented Apr 18, 2023

anmurali commented Apr 18, 2023

situchan commented Apr 19, 2023

[HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search #15661

[HOLD for payment 2023-04-07] [$4000] Inconsistent behaviour for Manage Member's search & Invite member's search #15661

Comments

kavimuru commented Mar 4, 2023 • edited by melvin-bot bot Loading

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

MelvinBot commented Mar 4, 2023

MelvinBot commented Mar 4, 2023 • edited by anmurali Loading

Bug0 Triage Checklist (Main S/O)

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

MelvinBot commented Mar 7, 2023

anmurali commented Mar 7, 2023

osofus commented Mar 8, 2023

you1996 commented Mar 8, 2023

Proposal

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

What is the root cause of that problem?

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

moezh commented Mar 8, 2023

Proposal

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

What is the root cause of that problem?

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

What alternative solutions did you explore? (Optional)

anmurali commented Mar 11, 2023

sobitneupane commented Mar 13, 2023 • edited Loading

sobitneupane commented Mar 13, 2023

tienifr commented Mar 13, 2023 • edited Loading

Proposal

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

What is the root cause of that problem?

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

Result

What alternative solutions did you explore? (Optional)

Result

bernhardoj commented Mar 13, 2023 • edited Loading

MelvinBot commented Mar 31, 2023

MelvinBot commented Mar 31, 2023

MelvinBot commented Mar 31, 2023 • edited by anmurali Loading

MelvinBot commented Apr 10, 2023

MelvinBot commented Apr 10, 2023

anmurali commented Apr 10, 2023

sobitneupane commented Apr 11, 2023 • edited Loading

sobitneupane commented Apr 11, 2023

MelvinBot commented Apr 14, 2023

iwiznia commented Apr 14, 2023

iwiznia commented Apr 17, 2023

anmurali commented Apr 18, 2023

sobitneupane commented Apr 18, 2023

situchan commented Apr 18, 2023

anmurali commented Apr 18, 2023

situchan commented Apr 19, 2023

kavimuru commented Mar 4, 2023 •

edited by melvin-bot bot

Loading

MelvinBot commented Mar 4, 2023 •

edited by anmurali

Loading

sobitneupane commented Mar 13, 2023 •

edited

Loading

tienifr commented Mar 13, 2023 •

edited

Loading

bernhardoj commented Mar 13, 2023 •

edited

Loading

MelvinBot commented Mar 31, 2023 •

edited by anmurali

Loading

sobitneupane commented Apr 11, 2023 •

edited

Loading