[HOLD for payment 2024-01-24] [$500] Workspace - Invite message does not remain when refresh page

@bfitzexpensify

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

Open staging.new.expensify.com
Navigate to Settings> Workspace> Members> Invite
Select few members to invite and click Next
Add random invite message and confirm Invite button
Refresh the page
Repeat steps 2 & 3

Expected Result:

Once entered invite message should remain when invite more users when refresh the page

Actual Result:

Invite message does not remain when refresh page

Workaround:

Unknown

Platforms:

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

Screenshots/Videos

Add any screenshot/video evidence

Bug6309308_1702313690749.Recording__1529.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

Upwork Job URL: https://www.upwork.com/jobs/~01e780374dd3bf487d
Upwork Job ID: 1734260347582304256
Last Price Increase: 2023-12-18
Automatic offers:

DylanDylann | Contributor | 28064891

Issue Owner

Current Issue Owner: @bfitzexpensify

@bfitzexpensify

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

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

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

@rushatgabhane

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

Proposal

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

Refreshing the web app and revisiting the workspace invite message page won't show the previously saved invite message.

What is the root cause of that problem?

In workspace invite message page, we get the message from the onyx and use a selector.

App/src/pages/workspace/WorkspaceInviteMessagePage.js

Lines 264 to 267 in eebd7ee

    
           workspaceInviteMessageDraft: { 
        
               key: ({route}) => `${ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MESSAGE_DRAFT}${route.params.policyID.toString()}`, 
        
               selector: (draft) => (isEmpty(draft) ? '' : draft), 
        
           },

Then, in the component constructor, we set the message state to the message from onyx if found.

App/src/pages/workspace/WorkspaceInviteMessagePage.js

Lines 84 to 86 in eebd7ee

    
           this.state = { 
        
               welcomeNote: this.props.workspaceInviteMessageDraft || this.getDefaultWelcomeNote(), 
        
           };

But after we refresh the page, somehow the selector of onyx returns undefined value and will return the correct value for the 2nd render or after reopening the page. That's why the message from Onyx is empty and we get the default message.

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

I haven't dug deeper into the onyx code as to why selector gives an undefined value after refresh, but removing the selector will fix the issue. We previously used the selector when the message is in the form of an object.

But now the selector is useless.

Proposal

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

Workspace - Invite message does not remain when refresh page

What is the root cause of that problem?

The issue here is a simple case of react lifecycle no aligning with the intended behaviour, the welcomeNote is a state variable with a default value of either this.props.workspaceInviteMessageDraft or this.getDefaultWelcomeNote(), But workspaceInviteMessageDraft is populated from an asynchronous data fetch, therefore on the component mounting it will be empty and the code will default to the default welcome message.

App/src/pages/workspace/WorkspaceInviteMessagePage.js

Lines 84 to 86 in bc77287

    
           this.state = { 
        
               welcomeNote: this.props.workspaceInviteMessageDraft || this.getDefaultWelcomeNote(), 
        
           };

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

We already have a componentDidUpdate being used to ensure state variables are populated correctly so we just have to add a simple check in there to ensure that the welcomeNote is included

componentDidUpdate(prevProps) {
    ...
    if(prevProps.workspaceInviteMessageDraft !== this.props.workspaceInviteMessageDraft){
        this.setState({welcomeNote: this.props.workspaceInviteMessageDraft});
    }

Result

Screen.Recording.2023-12-11.at.11.45.38.PM.mov

Proposal

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

Workspace - Invite message does not remain when refresh page

What is the root cause of that problem?

Refer to react-native-onyx docs:

withOnyx() will delay the rendering of the wrapped component until all keys/entities have been fetched and passed to the component

And, we know that whether all the keys/entities have been fetched or not based on the value, if any key have value is undefined, so its data is not fetched, if any key have value is nulll, so its data is fetched successfully and have null value.

In this bug, we have the selector:

App/src/pages/workspace/WorkspaceInviteMessagePage.js

Lines 264 to 267 in 4239252

    
           workspaceInviteMessageDraft: { 
        
               key: ({route}) => `${ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MESSAGE_DRAFT}${route.params.policyID.toString()}`, 
        
               selector: (draft) => (isEmpty(draft) ? '' : draft), 
        
           },

that always returns a value that is not undefined value. And as I mentioned above, it will consider that all the keys have been fetched successfully but the fact is that the workspaceInviteMessageDraft `s data is not fetched, and goes to render the wrapped component, in this case, is WorkspaceInviteMessage page.

Then, it will set the message invite with the default message:

App/src/pages/workspace/WorkspaceInviteMessagePage.js

Line 85 in 4239252

welcomeNote: this.props.workspaceInviteMessageDraft || this.getDefaultWelcomeNote(),

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

Based on the above RCA, we need to make sure that all keys/entities are fetched before render the page. We can just update the selector to:

 selector: (draft) => {
                if (isUndefined(draft)) {
                    return draft;
                }
                return isEmpty(draft) ? '' : draft;
            },

What alternative solutions did you explore? (Optional)

NA

fix workspace invitation message still preserved

The PR that introduced the bug has been identified. Link to the PR: Fix/30992: Workspace invitation message still preserved #31770
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: https://github.com/Expensify/App/pull/31770/files#r1454592244
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.
Determine if we should create a regression test for this bug. No
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 - N.A.

@bfitzexpensify

PR on prod 1 week ago. @bfitzexpensify could you please attach a payment summary. Thank you 🙇

@bfitzexpensify

@bfitzexpensify Could you help to move forward this issue?

@DylanDylann

I'll step in on this one, as Ben is OOO.

Payment summary:

Issue reporter: QA
Contributor: @DylanDylann $500
Contributor+: @rushatgabhane $500

@DylanDylann

@DylanDylann Your contract has been paid out.

@rushatgabhane

$500 payment approved for @rushatgabhane based on summary above.

Closing this issue, as no regression test is required.

Navigation Menu

Repository navigation

[HOLD for payment 2024-01-24] [$500] Workspace - Invite message does not remain when refresh page #32835

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Bug0 Triage Checklist (Main S/O)

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?

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?

What alternative solutions did you explore? (Optional)

22 remaining items

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	workspaceInviteMessageDraft: {
	key: ({route}) => `${ONYXKEYS.COLLECTION.WORKSPACE_INVITE_MESSAGE_DRAFT}${route.params.policyID.toString()}`,
	selector: (draft) => (isEmpty(draft) ? '' : draft),
	},

	this.state = {
	welcomeNote: this.props.workspaceInviteMessageDraft \|\| this.getDefaultWelcomeNote(),
	};

[HOLD for payment 2024-01-24] [$500] Workspace - Invite message does not remain when refresh page #32835

Description

Action Performed:

Expected Result:

Actual Result:

Workaround:

Platforms:

Screenshots/Videos

Activity

melvin-bot commented on Dec 11, 2023

melvin-bot commented on Dec 11, 2023

melvin-bot commented on Dec 11, 2023

Bug0 Triage Checklist (Main S/O)

melvin-bot commented on Dec 11, 2023

bernhardoj commented on Dec 11, 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?

AmjedNazzal commented on Dec 11, 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?

Result

DylanDylann commented on Dec 12, 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)

22 remaining items

rushatgabhane commented on Jan 17, 2024

rushatgabhane commented on Jan 17, 2024

DylanDylann commented on Jan 26, 2024

JmillsExpensify commented on Jan 30, 2024

JmillsExpensify commented on Jan 30, 2024

JmillsExpensify commented on Jan 30, 2024

JmillsExpensify commented on Jan 30, 2024

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions