FIX: Two QA guide entries in the member list after onboarding with Manage my team's expenses #54147

ikevin127 · 2024-12-14T03:07:20Z

Explanation of Change

Sometimes there's two QA guide entries in the member list after onboarding flow with Manage my team's expenses choice which seems to come from BE.

Real example of array with duplicated entries

[
    {
        "text": "qa.guide@team.expensify.com",
        "alternateText": "qa.guide@team.expensify.com",
        "keyForList": "14365522",
        "isSelected": false,
        "isDisabled": false,
        "accountID": 14365522,
        "login": "qa.guide@team.expensify.com",
        "icons": [
            {
                "source": "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/default-avatar_11.png",
                "type": "avatar",
                "name": "qa.guide@team.expensify.com",
                "id": 14365522
            }
        ],
        "reportID": ""
    },
    {
        "text": "qa.guide@team.expensify.com",
        "alternateText": "qa.guide@team.expensify.com",
        "keyForList": "714749267",
        "isSelected": false,
        "isDisabled": false,
        "accountID": 714749267,
        "login": "qa.guide@team.expensify.com",
        "icons": [
            {
                "source": "ƒ SvgFallbackAvatar(props)",
                "type": "avatar",
                "name": "qa.guide@team.expensify.com",
                "id": 714749267
            }
        ],
        "reportID": ""
    }
]

Since we don't have bandwith to investigate this on BE side as stated in this comment, we decided to move forward with a FE fix which simply filters out duplicated values based on login key which is a unique identifier in our app.

Fixed Issues

$ #53579
PROPOSAL: #53579 (comment)

Tests

Note

In order for the issue to be reproduced on DEV and subsequently be able to verify and review whether the fix works, it is necessary that Use Staging Server is set to ON in Onyx storage before creating the new account (random email without +) because when we create the workspace via onboarding flow, if we're not on staging server we won't be assigned the qa.guide@team.expensify.com guide.

To do this we can add Onyx.merge(ONYXKEYS.USER, {shouldUseStagingServer: true}); in src/App.tsx at the top of the functional component here, this would ensure you're using staging server and the issue will be reproduced 100% consistently - this will also help validate and review the proposed fix from this PR.

Sign up with a new Gmail account (random email without +, because using + will be categorized as test account).
On onboarding purpose, choose Manage my team's expenses.
Select any organization size.
On accounting select None of the above and Continue.
Once onboarding is completed, go to workspace settings > Members.
Click + Invite member and verify that there's only one qa.guide@team.expensify.com entry in the list instead of two.

Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

Sign up with a new Gmail account (random email without +, because using + will be categorized as test account).
On onboarding purpose, choose Manage my team's expenses.
Select any organization size.
On accounting select None of the above and Continue.
Once onboarding is completed, go to workspace settings > Members.
Click + Invite member and verify that there's only one qa.guide@team.expensify.com entry in the list instead of two.
Similarly to (6.) ensure the same test is passing for all these additional RHP lists:

FAB -> Start chat list
FAB -> Create expense -> Manual, input amount and Next -> Choose recipient list
Bottom tab -> Reports (Search) -> Expenses -> Filters -> both From and To lists
FAB -> Start chat -> Create group chat -> Click group chat header -> Members -> + Invite member list
Any other list with Contacts within the app should pass the test and only show 1 qa.guide@team.expensify.com entry
Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…nage my team's expenses

melvin-bot · 2024-12-14T03:07:25Z

@dukenv0307 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]

dukenv0307 · 2024-12-16T07:26:35Z

src/pages/workspace/WorkspaceInvitePage.tsx

-        const personalDetailsFormatted = personalDetailsWithoutSelected.map((item) => OptionsListUtils.formatMemberForList(item));
+        const personalDetailsFormatted = personalDetailsWithoutSelected
+            .map((item) => OptionsListUtils.formatMemberForList(item))
+            .filter((item, index, array) => item?.login && index === array.findIndex((i) => i.login === item.login));


We should move the filter logic before map.

Should we check item?.login? We already filterout the item that doesn't have login here, so I think we don't need that check.

We should move the filter logic before map.

@dukenv0307 Any specific reason for this request ? Like performance, proneness to error or anything else, curious to hear why you think the way it is now needs to be changed.

Should we check item?.login? We already filterout the item that doesn't have login here, so I think we don't need that check.

That filters out entries with non-existing login (and other) key values, assuming you're familiar with the issue you just reviewed, the fix is filtering out two entries with the same login key value since we don't want to show duplicates in case BE returns such entries.

@ikevin127

Like performance

Yes, let's imagine we have 1k elements, after filter, there are only 10 items so we just apply map for 10 elements only

the fix is filtering out two entries with the same login key value since we don't want to show duplicates in case BE returns such entries.

That's right, so index === array.findIndex((i) => i.login === item.login) is enough, adding item?.login is useless to me and can cause the regression.

dukenv0307 · 2024-12-16T08:21:35Z

@ikevin127 There're many places that have the same issue like InviteReportParticipantPage, NewChatPage, ...

I think we should fix this issue in filterAndOrderOptions. Wdyt?

ikevin127 · 2024-12-16T19:49:41Z

There're many places that have the same issue like InviteReportParticipantPage, NewChatPage, ...

I think we should fix this issue in filterAndOrderOptions. Wdyt?

@dukenv0307 Usually I tend to keep things within scope as the proposal suggested since changing other parts of the logic exposes us to regressions. Have you been able to reproduce the issue where you are shown duplicated entries in any of the other lists ?

If that's the case I wound't have any issue bringing this up in the issue and asking for a bounty increase since we're extending the scope which requires more work and testing, another reason why this would complicate things a lot is that:

App/src/libs/OptionsListUtils.ts

Lines 1736 to 1739 in 886d7ec

    
            * Filters and orders the options based on the search input value. 
        
            * Note that personal details that are part of the recent reports will always be shown as part of the recent reports (ie. DMs). 
        
            */ 
        
           function filterAndOrderOptions(options: Options, searchInputValue: string, config: FilterAndOrderConfig = {}): Options {

filterAndOrderOptions is used broadly which means lots of tests to be done and cases to be considered, for which I did not yet see any proof that there's an issue with duplicated entries, other than just a hunch based on reading the code and attempting a fix more broadly (unfounded so far).

Will bring attention to these conversations within the issue as well, maybe I'm missing something.

dukenv0307 · 2024-12-17T14:43:54Z

Have you been able to reproduce the issue where you are shown duplicated entries in any of the other lists ?

Yes, I can. Pls check:

Start new chat:

Add members to WS:

And many places...

dukenv0307 · 2024-12-17T14:44:10Z

I believe we need to fix them all.

ikevin127 · 2024-12-18T00:08:39Z

I believe we need to fix them all.

Thanks for argumenting each change, they make the reasons clear - I will apply all changes then will tag for review.

…7-fixInvideQAGuideDupe

dukenv0307 · 2024-12-18T02:39:39Z

@ikevin127 Is it ready for review? Seem like we have 1 lint error but I'm not sure we have to fix it.

ikevin127 · 2024-12-18T03:18:15Z

@dukenv0307 Yes, it is ready for review.

Seem like we have 1 lint error but I'm not sure we have to fix it.

I wanted to check first and I confirm that none of the lint issues are related to this PRs changes directly, they are showing because there were changes in the OptionsListUtils.ts file and the eslint rule no-default-id-values was added, enforcing the new style mentioned here.

The thing is that most of the default values causing the errors in OptionsListUtils.ts are -1 and I'm not confident that replacing all instances of -1 with DEFAULT_NUMBER_ID which is 0 wouldn't cause any issues in those parts of the app that use the logic which are unrelated to this PRs changes.

dukenv0307 · 2024-12-18T15:11:46Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

dukenv0307

LGTM

Julesssss

Do we know what's causing the ESLint failures? Perhaps another main merge would help?

#54147 (comment)

Also, thanks for fixing the additional cases, but could we add a few more test cases to ensure that are verified by QA?

…7-fixInvideQAGuideDupe

ikevin127 · 2024-12-18T19:06:44Z

Do we know what's causing the ESLint failures? Perhaps another main merge would help?

@Julesssss I doubt that sync with main will help and yes, I described exactly what causes the failures in #54147 (comment), it happens because there were changes in a file - this case is similar to instances related to withOnyx being deprecated and even a 1 line change would fail eslint asking for the whole component to be migrated to useOnyx.

I've seen eslint issues like this being ignored before and that's my suggestion for this one as well since changing all the fallback values from -1 (currently) to 0 as asked by the lint error could bring about regressions.

✅ Done: Added step (7.) on QA Steps detailing a wider range of lists with Contacts where the fix should apply.

Julesssss · 2024-12-19T10:59:44Z

Thanks for the explanation and additional tests @ikevin127. Looks good to me

melvin-bot · 2024-12-19T11:00:03Z

@Julesssss looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

OSBotify · 2024-12-19T11:08:48Z

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

github-actions · 2024-12-23T20:58:22Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

platform	result
🤖 android 🤖	cancelled 🔪
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	cancelled 🔪
🍎🔄 iOS HybridApp 🍎🔄	cancelled 🔪

github-actions · 2024-12-23T21:42:18Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-12-23T21:49:48Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-12-24T00:05:33Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

github-actions · 2024-12-24T00:53:12Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T19:43:19Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

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

github-actions · 2024-12-24T20:00:15Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 9.0.78-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	success ✅
🍎🔄 iOS HybridApp 🍎🔄	success ✅

IuliiaHerets · 2024-12-25T14:55:17Z

This PR is failing because of issue #54563

github-actions · 2024-12-26T20:27:30Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.78-6 🚀

platform	result
🤖 android 🤖	true ❌
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅
🤖🔄 android HybridApp 🤖🔄	failure ❌
🍎🔄 iOS HybridApp 🍎🔄	success ✅

FIX: Two QA guide entries in the member list after onboarding with Ma…

9baa2f0

…nage my team's expenses

ikevin127 requested a review from a team as a code owner December 14, 2024 03:07

melvin-bot bot requested a review from dukenv0307 December 14, 2024 03:07

melvin-bot bot removed the request for review from a team December 14, 2024 03:07

ikevin127 mentioned this pull request Dec 14, 2024

[HOLD for payment 2025-01-02] [$250] Invite - Two same QA guides in the member list after onboarding with Manage my team's expenses #53579

Closed

8 tasks

dukenv0307 reviewed Dec 16, 2024

View reviewed changes

ikevin127 added 2 commits December 17, 2024 18:15

Merge branch 'main' of https://github.com/Expensify/App into ikevin12…

91c572e

…7-fixInvideQAGuideDupe

added fix to filterAndOrderOptions instead + test

55a6f85

dukenv0307 approved these changes Dec 18, 2024

View reviewed changes

melvin-bot bot requested a review from Julesssss December 18, 2024 15:12

Julesssss reviewed Dec 18, 2024

View reviewed changes

Merge branch 'main' of https://github.com/Expensify/App into ikevin12…

518bcbf

…7-fixInvideQAGuideDupe

Julesssss approved these changes Dec 19, 2024

View reviewed changes

Julesssss merged commit 9c2fa9e into Expensify:main Dec 19, 2024
16 of 17 checks passed

melvin-bot bot added the Emergency label Dec 19, 2024

hannojg added a commit to margelo/expensify-app-fork that referenced this pull request Dec 20, 2024

add changes from Expensify#54147 back

e90d899

github-actions bot mentioned this pull request Dec 23, 2024

Deploy Checklist: New Expensify 2024-12-23 #54476

Closed

IuliiaHerets mentioned this pull request Dec 25, 2024

[HOLD for payment 2025-01-17] [$250] Three QA guides in mention suggestion list after onboarding with Manage my team's expenses #54563

Closed

8 tasks

ikevin127 mentioned this pull request Jan 6, 2025

FIX: Three QA guides in mention suggestion list after onboarding with Manage my team's expenses #54805

Merged

50 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIX: Two QA guide entries in the member list after onboarding with Manage my team's expenses #54147

FIX: Two QA guide entries in the member list after onboarding with Manage my team's expenses #54147

ikevin127 commented Dec 14, 2024 •

edited

Loading

melvin-bot bot commented Dec 14, 2024

dukenv0307 Dec 16, 2024

dukenv0307 Dec 16, 2024

ikevin127 Dec 16, 2024

dukenv0307 Dec 17, 2024

dukenv0307 Dec 17, 2024

dukenv0307 commented Dec 16, 2024

ikevin127 commented Dec 16, 2024

dukenv0307 commented Dec 17, 2024

dukenv0307 commented Dec 17, 2024

ikevin127 commented Dec 18, 2024

dukenv0307 commented Dec 18, 2024

ikevin127 commented Dec 18, 2024

dukenv0307 commented Dec 18, 2024

dukenv0307 left a comment

Julesssss left a comment

ikevin127 commented Dec 18, 2024 •

edited

Loading

Julesssss commented Dec 19, 2024

melvin-bot bot commented Dec 19, 2024

OSBotify commented Dec 19, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

IuliiaHerets commented Dec 25, 2024

github-actions bot commented Dec 26, 2024

FIX: Two QA guide entries in the member list after onboarding with Manage my team's expenses #54147

FIX: Two QA guide entries in the member list after onboarding with Manage my team's expenses #54147

Conversation

ikevin127 commented Dec 14, 2024 • edited Loading

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 14, 2024

dukenv0307 Dec 16, 2024

Choose a reason for hiding this comment

dukenv0307 Dec 16, 2024

Choose a reason for hiding this comment

ikevin127 Dec 16, 2024

Choose a reason for hiding this comment

dukenv0307 Dec 17, 2024

Choose a reason for hiding this comment

dukenv0307 Dec 17, 2024

Choose a reason for hiding this comment

dukenv0307 commented Dec 16, 2024

ikevin127 commented Dec 16, 2024

dukenv0307 commented Dec 17, 2024

dukenv0307 commented Dec 17, 2024

ikevin127 commented Dec 18, 2024

dukenv0307 commented Dec 18, 2024

ikevin127 commented Dec 18, 2024

dukenv0307 commented Dec 18, 2024

Reviewer Checklist

Screenshots/Videos

dukenv0307 left a comment

Choose a reason for hiding this comment

Julesssss left a comment

Choose a reason for hiding this comment

ikevin127 commented Dec 18, 2024 • edited Loading

Julesssss commented Dec 19, 2024

melvin-bot bot commented Dec 19, 2024

OSBotify commented Dec 19, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 23, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

github-actions bot commented Dec 24, 2024

IuliiaHerets commented Dec 25, 2024

github-actions bot commented Dec 26, 2024

ikevin127 commented Dec 14, 2024 •

edited

Loading

ikevin127 commented Dec 18, 2024 •

edited

Loading