[HOLD for payment 2024-10-07] Workspace - Invite message comes back after deleting it

@JmillsExpensify

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: 9.0.41-2
Reproducible in staging?: Y
Reproducible in production?: N
If this was caught during regression testing, add the test name, ID and link from TestRail: N/A
Email or phone of affected tester (no customers): applausetester+ds@applause.expensifail.com
Issue reported by: Applause - Internal Team

Action Performed:

Login to an account
Create a workspace
Go to the created workspace > Members
Click on invite member > Choose a user
On "add message" page try to delete the message

Expected Result:

Message is deleted

Actual Result:

The deleted message comes back

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6618028_1727488696018.Screen_Recording_2024-09-28_at_4.50.36_at_night.mp4

View all open jobs on GitHub

Issue Owner

Current Issue Owner: @JmillsExpensify

@dangrous

Triggered auto assignment to @dangrous (DeployBlockerCash), see https://stackoverflowteams.com/c/expensify/questions/9980/ for more details.

👋 Friendly reminder that deploy blockers are time-sensitive ⏱ issues! Check out the open `StagingDeployCash` deploy checklist to see the list of PRs included in this release, then work quickly to do one of the following:

Identify the pull request that introduced this issue and revert it.
Find someone who can quickly fix the issue.
Fix the issue yourself.

Edited by proposal-police: This proposal was edited at 2024-09-29 18:55:32 UTC.

Proposal

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

Invite message comes back after deleting it

What is the root cause of that problem?

We are setting setWelcomeNote(getDefaultWelcomeNote()) again here

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 89 to 94 in 3047c1b

    
           useEffect(() => { 
        
               if (isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   return; 
        
               } 
        
               setWelcomeNote(getDefaultWelcomeNote()); 
        
           }, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

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

We can remove this code block

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 89 to 94 in 3047c1b

    
           useEffect(() => { 
        
               if (isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   return; 
        
               } 
        
               setWelcomeNote(getDefaultWelcomeNote()); 
        
           }, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

We should test the code to make sure everything is working properly

What alternative solutions did you explore? (Optional)

Edited by proposal-police: This proposal was edited at 2024-09-29 19:17:45 UTC.

Proposal 

Offending PR: #48660

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

Workspace - Invite message comes back after deleting it

What is the root cause of that problem?

We have multiple useEffect hooks to set the welcome note when the component mounts or the members change.

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 77 to 94 in 3047c1b

    
           useEffect(() => { 
        
               if (!isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   setWelcomeNote(getDefaultWelcomeNote()); 
        
                   return; 
        
               } 
        
               if (isEmptyObject(policy)) { 
        
                   return; 
        
               } 
        
               Navigation.goBack(ROUTES.WORKSPACE_INVITE.getRoute(route.params.policyID), true); 
        
               // eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps 
        
           }, []); 
        
           useEffect(() => { 
        
               if (isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   return; 
        
               } 
        
               setWelcomeNote(getDefaultWelcomeNote()); 
        
           }, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

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

We can remove the second useEffect hook here:

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 89 to 94 in 3047c1b

    
           useEffect(() => { 
        
               if (isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   return; 
        
               } 
        
               setWelcomeNote(getDefaultWelcomeNote()); 
        
           }, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

And in WorkspaceInvitePage.tsx we need to clear the draft invite message when the component unmounts.

App/src/pages/workspace/WorkspaceInvitePage.tsx

Lines 78 to 83 in 3047c1b

    
           useEffect(() => { 
        
               return () => { 
        
                   Member.setWorkspaceInviteMembersDraft(route.params.policyID, {}); 
        
               }; 
        
               // eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps 
        
           }, [route.params.policyID]);

TO:

    useEffect(() => {
        return () => {
            Member.setWorkspaceInviteMembersDraft(route.params.policyID, {});
            Policy.setWorkspaceInviteMessageDraft(route.params.policyID, null);
        };
        // eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
    }, [route.params.policyID]);

If we want to clear the draft message when invite members list changes, we can clear the message draft here or here.

What alternative solutions did you explore? (Optional)

Result

Proposal

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

when a user deletes the invite message in the workspace invite process, the message reappears unexpectedly.

What is the root cause of that problem?

The root cause of this problem is that the component was automatically resetting the welcome message to its default value, even when the user had intentionally deleted it

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

we should update the useEffect to add a check that skips resetting the invite message if it is already empty. This ensures that when the user deletes the message, it doesn't get reset to the default value.

Add!welcomeNotecheck here:

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Lines 89 to 92 in 3047c1b

    
           useEffect(() => { 
        
               if (isEmptyObject(invitedEmailsToAccountIDsDraft)) { 
        
                   return; 
        
               }

to:

 useEffect(() => {
        if (isEmptyObject(invitedEmailsToAccountIDsDraft) || !welcomeNote) {
            return;
        }

Screen.20Recording.202024-09-30.20at.203.mp4

Proposal

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

Invite message comes back after deleting it

What is the root cause of that problem?

Since we set getDefaultWelcomeNote as a dependency of this hook, the hook is triggered every time the input's onChange event occurs

App/src/pages/workspace/WorkspaceInviteMessagePage.tsx

Line 94 in 3634670

}, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

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

We should remove getDefaultWelcomeNote from the dependency array to avoid re-renders when the input changes.

// .src/pages/workspace/WorkspaceInviteMessagePage.tsx#L94
    useEffect(() => {
        if (isEmptyObject(invitedEmailsToAccountIDsDraft)) {
            return;
        }
        setWelcomeNote(getDefaultWelcomeNote());
-    }, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);
+    }, [invitedEmailsToAccountIDsDraft]);

and We need to validate this input, if necessary, to avoid empty values ("")

// .src/pages/workspace/WorkspaceInviteMessagePage.tsx#L119
        if (isEmptyObject(invitedEmailsToAccountIDsDraft)) {
            errorFields.welcomeMessage = translate('workspace.inviteMessage.inviteNoMembersError');
-        }
+        } else if (isEmptyObject(welcomeNote)) {
+            errorFields.welcomeMessage = 'Please enter a welcome note.';
        }

Details

POC

Screen.Recording.2024-09-30.at.09.24.15.mp4

Seems to be a frontend issue, so removing Web-E blocker

Yeah this was caused by PR #48660 and issue #34929 . We can just remove that new useEffect but I'm not sure what the point of it was originally, so pinged the PR authors. Thanks!

@dangrous

Yeah this was caused by PR #48660 and issue #34929 .

@dangrous Yeah. Fixing an eslint error (i.e. using useOnyx instead of withOnyx) during some last-minute changes caused this issue. I think we can consider this as a separate issue. Please assign me here as I have the context.

We can just remove that new useEffect but I'm not sure what the point of it was originally, so pinged the PR authors. Thanks!

We need the second useEffect to ensure workspaceInviteMessageDraft is populated from the Onyx. However, an edge case got left out i.e. when the user intentionally deletes the entire welcome note in which case we should not reset.
@Shahidullah-Muffakir proposal LGTM

@JmillsExpensify

Current assignee @JmillsExpensify is eligible for the Bug assigner, not assigning anyone new.

@rojiphil

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:

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

@rojiphil

[@rojiphil] The PR that introduced the bug has been identified. Link to the PR: Offending PR
[@rojiphil] 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: Added comment
[@rojiphil] 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: Not Required. Existing checklist is good enough to capture such issues.
[@rojiphil] Determine if we should create a regression test for this bug. : Yes. We can
[@rojiphil] 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.

Steps:

Go to Account Settings -> Workspaces
Select a workspace and go to Members->Invite new members
Select a member to invite and click on Next to go to the invite message view.
Delete the default welcome message text.
Verify that the message text remains empty and does not come back.

@tgolen

@tgolen BZ Checklist done

@tgolen

@tgolen The payment step is completed as mentioned here.
Can we close this issue if nothing else is pending? Thanks.

Yep, we should be good here now. I'll close it out. Thanks!

@JmillsExpensify

Actually, I was wrong. @JmillsExpensify this needs a regression test created and I think that's your part of the checklist.

Test created and linked above, so closing this issue.

Navigation Menu

Repository navigation

[HOLD for payment 2024-10-07] Workspace - Invite message comes back after deleting it #49899

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

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)

Proposal

Offending PR: #48660

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)

Result

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?

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?

62 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	useEffect(() => {
	if (isEmptyObject(invitedEmailsToAccountIDsDraft)) {
	return;
	}
	setWelcomeNote(getDefaultWelcomeNote());
	}, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

	useEffect(() => {
	if (!isEmptyObject(invitedEmailsToAccountIDsDraft)) {
	setWelcomeNote(getDefaultWelcomeNote());
	return;
	}
	if (isEmptyObject(policy)) {
	return;
	}
	Navigation.goBack(ROUTES.WORKSPACE_INVITE.getRoute(route.params.policyID), true);
	// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
	}, []);

	useEffect(() => {
	if (isEmptyObject(invitedEmailsToAccountIDsDraft)) {
	return;
	}
	setWelcomeNote(getDefaultWelcomeNote());
	}, [getDefaultWelcomeNote, invitedEmailsToAccountIDsDraft]);

	useEffect(() => {
	return () => {
	Member.setWorkspaceInviteMembersDraft(route.params.policyID, {});
	};
	// eslint-disable-next-line react-compiler/react-compiler, react-hooks/exhaustive-deps
	}, [route.params.policyID]);

[HOLD for payment 2024-10-07] Workspace - Invite message comes back after deleting it #49899

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Sep 29, 2024

github-actions commented on Sep 29, 2024

Nodebrute commented on Sep 29, 2024

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)

Krishna2323 commented on Sep 29, 2024

Proposal

Offending PR: #48660

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)

Result

Shahidullah-Muffakir commented on Sep 29, 2024

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?

huult commented on Sep 30, 2024

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?

Gonals commented on Sep 30, 2024

dangrous commented on Sep 30, 2024

rojiphil commented on Sep 30, 2024

62 remaining items

melvin-bot commented on Oct 23, 2024

tgolen commented on Oct 23, 2024

rojiphil commented on Oct 24, 2024

rojiphil commented on Oct 24, 2024

rojiphil commented on Oct 26, 2024

tgolen commented on Oct 28, 2024

tgolen commented on Oct 28, 2024

JmillsExpensify commented on Oct 31, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions

Proposal 

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