Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Conversation

ikevin127
Copy link
Contributor

@ikevin127 ikevin127 commented Jan 6, 2025

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 comes from BE and renders 3 entries of the same login QA team member in the SuggestionMention list, this PR addresses the issue by filtering out any duplicated entries.

Real example of array with duplicated entries
[
    {
        "text": "[email protected]",
        "alternateText": "[email protected]",
        "keyForList": "14365522",
        "isSelected": false,
        "isDisabled": false,
        "accountID": 14365522,
        "login": "[email protected]",
        "icons": [
            {
                "source": "https://d2k5nsl2zxldvw.cloudfront.net/images/avatars/default-avatar_11.png",
                "type": "avatar",
                "name": "[email protected]",
                "id": 14365522
            }
        ],
        "reportID": ""
    },
    {
        "text": "[email protected]",
        "alternateText": "[email protected]",
        "keyForList": "714749267",
        "isSelected": false,
        "isDisabled": false,
        "accountID": 714749267,
        "login": "[email protected]",
        "icons": [
            {
                "source": "ƒ SvgFallbackAvatar(props)",
                "type": "avatar",
                "name": "[email protected]",
                "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

$ #54563
PROPOSAL: #54563 (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 [email protected] 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.

  1. Sign up with a new Gmail account (random email without +, because using + will be categorized as test account).
  2. On onboarding purpose, choose Manage my team's expenses.
  3. Select any organization size.
  4. On accounting select None of the above and Continue.
  5. Once onboarding is completed, go to workspace chat.
  6. Type @ symbol in composer to open suggestions popup and verify that there's only one [email protected] entry in the list instead of three.
  7. After @, type qa and verify that there's only one [email protected] entry in the suggestions list.
  • Verify that no errors appear in the JS console

Offline tests

N/A.

QA Steps

  1. Sign up with a new Gmail account (random email without +, because using + will be categorized as test account).
  2. On onboarding purpose, choose Manage my team's expenses.
  3. Select any organization size.
  4. On accounting select None of the above and Continue.
  5. Once onboarding is completed, go to workspace chat.
  6. Type @ symbol in composer to open suggestions popup and verify that there's only one [email protected] entry in the list instead of three.
  7. After @, type qa and verify that there's only one [email protected] entry in the suggestions list.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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 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
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • 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.

Screenshots/Videos

Android: Native
android.mp4
Android: mWeb Chrome
android-mweb.webm
iOS: Native
ios.mp4
iOS: mWeb Safari
ios-mweb.mp4
MacOS: Chrome / Safari
after.mov
MacOS: Desktop
desktop.mov

@ikevin127 ikevin127 requested a review from a team as a code owner January 6, 2025 05:00
@melvin-bot melvin-bot bot requested a review from dukenv0307 January 6, 2025 05:00
Copy link

melvin-bot bot commented Jan 6, 2025

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

@ikevin127
Copy link
Contributor Author

@dukenv0307 The lint issue is not cause directly by my changes but by the fact that we had changes in the SuggestionMention component and the rulesdir/no-default-id-values rule vas implemented in the meantime.

Same like with the other PR, explanations in #54147 (comment) and #54147 (comment), I think we should move forward and disregard the lint issue even when merging as the other option would be to default to DEFAULT_NUMBER_ID which is 0 while the current value is -1 and 0 might cause issues for the current logic.

@dukenv0307
Copy link
Contributor

@ikevin127 I think we just need to fix the lint issue on SuggestionMention. It's pretty simple.

@dukenv0307
Copy link
Contributor

@ikevin127 You missed the video on android native platform as well.

@ikevin127
Copy link
Contributor Author

Thanks, will add the missing parts in a few hours.

@ikevin127
Copy link
Contributor Author

@dukenv0307 I added the missing Android: Native video and fixed the eslint issue according to the documentation.
PR is ready for review!

@dukenv0307
Copy link
Contributor

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 Screenshot 2025-01-06 at 15 38 56
Android: mWeb Chrome Screenshot 2025-01-06 at 15 37 22
iOS: Native Screenshot 2025-01-06 at 15 44 54
iOS: mWeb Safari Screenshot 2025-01-06 at 15 37 47
MacOS: Chrome / Safari
Screen.Recording.2025-01-06.at.15.34.55.mov
MacOS: Desktop Screenshot 2025-01-06 at 15 46 48

Copy link
Contributor

@dukenv0307 dukenv0307 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot bot requested a review from MarioExpensify January 7, 2025 03:50
Copy link
Contributor

@MarioExpensify MarioExpensify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thank you!

@MarioExpensify MarioExpensify merged commit adb8ddc into Expensify:main Jan 7, 2025
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Jan 7, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants