Fix: Cannot remove RBR when invite an invalid member to workspace #23157

tienifr · 2023-07-19T10:30:10Z

Details

Inviting an invalid member to the workspace returns an error (RBR) but we cannot remove that. This PR fixes that.

Fixed Issues

$ #22359
PROPOSAL: #22359 (comment)

Tests

Login with any account
Go to Settings >> Workspaces >> Members >> Invite
Invite an invalid or not existing account (+916541237890 for example)
Verify that the workspace members page show a RBR under the invited account
Verify that the RBR is dismissible

Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

Login with any account
Go to Settings >> Workspaces >> Members >> Invite
Invite an invalid or not existing account (+916541237890 for example)
Verify that the workspace members page show a RBR under the invited account
Verify that the RBR is dismissible

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-07-19.at.17.22.21.mov

Mobile Web - Chrome

video_2023-07-19_20-11-31.mp4

Mobile Web - Safari

Screen.Recording.2023-07-21.at.13.30.27.mov

Desktop

Screen.Recording.2023-07-19.at.20.14.18.mov

iOS

Screen.Recording.2023-07-19.at.20.16.48.mov

Android

Screen.Recording.2023-07-19.at.20.33.28.mov

melvin-bot · 2023-07-20T05:26:23Z

@eVoloshchak Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

tienifr · 2023-07-21T03:44:08Z

Bump @eVoloshchak

eVoloshchak · 2023-07-21T15:26:38Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Screen.Recording.2023-07-25.at.16.15.36.mov

Mobile Web - Chrome

screen-20230725-161816.mp4

Mobile Web - Safari

Screen.Recording.2023-07-25.at.16.22.57.mov

Desktop

Screen.Recording.2023-07-25.at.16.24.51.mov

iOS

Screen.Recording.2023-07-25.at.16.21.38.mov

Android

screen-20230725-162044.mp4

eVoloshchak · 2023-07-21T16:08:21Z

src/libs/actions/Policy.js

@@ -743,6 +773,13 @@ function clearAddMemberError(policyID, accountID) {
    Onyx.merge(`${ONYXKEYS.COLLECTION.POLICY_MEMBERS}${policyID}`, {
        [accountID]: null,
    });
+
+    // Remove draft accountID
+    if (accountID.toString().length >= 15) {


@tienifr, why do we delete it only if accountID.length >= 15?

It's a "dummy" accountID, generated locally by

App/src/libs/UserUtils.js

Line 214 in d3a13d6

function generateAccountID(searchValue) {

In other words, they're invalid account that we've just invited. Otherwise, even after dismissing the error, the invalid accounts still appear in the suggested invite list.

I don't know if there's already a function for checking "dummy" accountID so I manually check based on length.

What would happen if we deleted accountID here no matter if it's the dummy one or not?
We will remove a valid accountID from PERSONAL_DETAILS_LIST, but will it be there after a refresh?
I'm basically wondering what would happen if in the future we had accountID's longer than 15

How about adding isDummyAccount (or sth else) into these account personal details when we create the optimisticPersonalDetails?

Yeah, that would be better, let's do that instead

I've updated that. Please check again.

dummy-account-compressed.mov

Now that I think about it more, we shouldn't delete the account info when we dismiss an error. The error doesn't necessarily mean "This account is invalid", just that there was some kind of a problem when inviting the user.
We might want to add the ability to "clear" recent users if this is considered a problem, but I don't think this should be a part of this PR

So that we're good with showing the invalid accounts in the invite suggestion list; and will implement another feature to clear that later?

Asking in https://expensify.slack.com/archives/C01GTK53T8Q/p1690239157923059

Well that didn't get a lot of traction 😄
But still, it's 2 vs 1 in favor of removing the user, so let's leave it as it is, no changes needed, I'll finish the checklist shortly

NikkiWines

Looks good + tests well - one small question

NikkiWines · 2023-07-26T01:51:56Z

src/libs/actions/Policy.js

+                        avatar: UserUtils.getDefaultAvatarURL(accountID),
+                        displayName: LocalePhoneNumber.formatPhoneNumber(memberLogin),
+                        login: OptionsListUtils.addSMSDomainIfPhoneNumber(memberLogin),
+                        isDummy: true,


Do we actually need isDummy? We are able to get the personalDetails to be removed in ~~clearDeleteMemberError~~ clearAddMemberError by accountID. Tested locally and seemed to work fine without including this

(edited function name)

Ah, I guess for the cases where we have an error we want to dismiss but where we don't want to remove that user from the policy details 🤔 Though... do we have a case like that? I don't think so?

If we do (and it's entirely possible I'm missing/unaware of some flow like that) I guess I would call this something a little more descriptive like isOptimisticDetails / isOptimisicData or something like that.

The error is cleared in clearAddMemberError, not delete. The point is to remove the invalid personal details on clearing the error. Otherwise, those invalid details would still be shown in the invite suggestion page. And isDummy is to check for those invalid ones. I've tried removing isDummy but it didn't work.

Also, isOptimisticData sounds great to me, thanks for the suggestion.

Oops, sorry, you're right about that, I mistyped the function name. But the comment still holds, why do we need isDummy/isOptimisticData if we can remove the optimistically added member by accountID?

Hmm, sorry I might not understand your point. Inside clearAddMemberError we only remove the accountID from the policy's members list ONYXKEYS.COLLECTION.POLICY_MEMBERS but we haven't remove it from personal details list, which we should do as explained above:

Otherwise, those invalid details would still be shown in the invite suggestion page

Also as you've mentioned here:

Tested locally and seemed to work fine without including this

Can you elaborate on the test you've made?

No worries, I'm not explaining things very clearly 😅 Effectively, I'm not sure I understand why we need to include the isOptimisticData value at all.

The logic you have here conditionally retrieves the personal details that match the accountID and where isOptimisticData = true, and then removes those details from ONYXKEYS.PERSONAL_DETAILS_LIST, right?

But whenever we call clearAddMemberError, we're going to want to update ONYXKEYS.PERSONAL_DETAILS_LIST to remove the details for the provided accountID, because that user won't have been added to the workspace successfully. We can do this based on accountID alone, so why do we need isOptimisticData = true as a condition to be met?

Hopefully, that's a bit clearer? Let me know if I'm misunderstanding something or if it's still unclear.

Can you elaborate on the test you've made?

Yeah, for sure. I just removed this line and adjusted this line to be as follows:

- if (lodashGet(allPersonalDetails, [accountID, 'isOptimisticData'])) { + if (lodashGet(allPersonalDetails, [accountID])) {

Then retested using the testing steps for this PR.

Cool! Thanks for your patience and detailed explanation. At first we tried to only remove the "dummy" account personal details but there's no way to do it. But as mentioned above, we should remove all errored account from personal details list.

Please check again!

NikkiWines

One minor adjustment otherwise looks great

src/libs/actions/Policy.js

NikkiWines

OSBotify · 2023-07-26T19:04:26Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-07-27T22:07:10Z

🚀 Deployed to staging by https://github.com/NikkiWines in version: 1.3.47-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Beamanator · 2023-07-31T13:00:06Z

Not passing staging QA :(

OSBotify · 2023-07-31T18:35:39Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.3.47-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

tienifr added 4 commits July 19, 2023 17:22

fix: cannot remove rbr when invite an invalid workspace member

a5a6b64

exclude current account id

304a5e6

refactor using chain

012b2aa

dummy account ID length

9d734b9

tienifr marked this pull request as ready for review July 20, 2023 05:26

tienifr requested a review from a team as a code owner July 20, 2023 05:26

melvin-bot bot requested review from eVoloshchak and removed request for a team July 20, 2023 05:26

tienifr mentioned this pull request Jul 20, 2023

[HOLD for payment 2023-08-14] [HOLD for payment 2023-08-07] [$1000] Invite Member - No way to remove RBR from avatar after inviting an invalid number into a workspace #22359

Closed

6 tasks

eVoloshchak reviewed Jul 21, 2023

View reviewed changes

isDummy account

ca996a6

eVoloshchak approved these changes Jul 25, 2023

View reviewed changes

melvin-bot bot requested a review from NikkiWines July 25, 2023 13:29

NikkiWines reviewed Jul 26, 2023

View reviewed changes

tienifr added 2 commits July 26, 2023 11:06

change isDummy to isOptimisticData

78f8ba1

remove isOptimisticData

b3998dc

NikkiWines requested changes Jul 26, 2023

View reviewed changes

src/libs/actions/Policy.js Outdated Show resolved Hide resolved

remove isOptimisticData

9eba1dd

NikkiWines approved these changes Jul 26, 2023

View reviewed changes

NikkiWines merged commit 1205a74 into Expensify:main Jul 26, 2023
11 checks passed

OSBotify mentioned this pull request Jul 27, 2023

Deploy Checklist: New Expensify 2023-07-27 #23765

Closed

79 tasks

NikkiWines mentioned this pull request Jul 31, 2023

Persist failed personal details when adding workspace member #23947

Merged

58 tasks

mollfpr mentioned this pull request Aug 30, 2023

[HOLD for payment 2023-09-27] [$1000] After deleting a mobile contact from a WorkSpace, it starts showing up in contacts as @expensify.sms #26121

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Cannot remove RBR when invite an invalid member to workspace #23157

Fix: Cannot remove RBR when invite an invalid member to workspace #23157

tienifr commented Jul 19, 2023 •

edited

Loading

melvin-bot bot commented Jul 20, 2023

tienifr commented Jul 21, 2023

eVoloshchak commented Jul 21, 2023 •

edited

Loading

eVoloshchak Jul 21, 2023

tienifr Jul 21, 2023 •

edited

Loading

eVoloshchak Jul 21, 2023 •

edited

Loading

tienifr Jul 21, 2023 •

edited

Loading

eVoloshchak Jul 21, 2023

tienifr Jul 21, 2023 •

edited

Loading

eVoloshchak Jul 24, 2023

tienifr Jul 24, 2023

eVoloshchak Jul 24, 2023

eVoloshchak Jul 25, 2023

NikkiWines left a comment

NikkiWines Jul 26, 2023 •

edited

Loading

NikkiWines Jul 26, 2023 •

edited

Loading

tienifr Jul 26, 2023 •

edited

Loading

NikkiWines Jul 26, 2023

tienifr Jul 26, 2023 •

edited

Loading

NikkiWines Jul 26, 2023

tienifr Jul 26, 2023

NikkiWines left a comment

NikkiWines left a comment

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

Beamanator commented Jul 31, 2023

OSBotify commented Jul 31, 2023

Fix: Cannot remove RBR when invite an invalid member to workspace #23157

Fix: Cannot remove RBR when invite an invalid member to workspace #23157

Conversation

tienifr commented Jul 19, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 20, 2023

tienifr commented Jul 21, 2023

eVoloshchak commented Jul 21, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

Choose a reason for hiding this comment

tienifr Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

eVoloshchak Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

tienifr Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Jul 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NikkiWines left a comment

Choose a reason for hiding this comment

NikkiWines Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

NikkiWines Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

tienifr Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tienifr Jul 26, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NikkiWines left a comment

Choose a reason for hiding this comment

NikkiWines left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 26, 2023

OSBotify commented Jul 27, 2023

Beamanator commented Jul 31, 2023

OSBotify commented Jul 31, 2023

tienifr commented Jul 19, 2023 •

edited

Loading

eVoloshchak commented Jul 21, 2023 •

edited

Loading

tienifr Jul 21, 2023 •

edited

Loading

eVoloshchak Jul 21, 2023 •

edited

Loading

tienifr Jul 21, 2023 •

edited

Loading

tienifr Jul 21, 2023 •

edited

Loading

NikkiWines Jul 26, 2023 •

edited

Loading

NikkiWines Jul 26, 2023 •

edited

Loading

tienifr Jul 26, 2023 •

edited

Loading

tienifr Jul 26, 2023 •

edited

Loading