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

show #admins room only when there is value #45048

Merged

Conversation

rojiphil
Copy link
Contributor

@rojiphil rojiphil commented Jul 9, 2024

@allroundexperts @francoisl

Details

This PR prevents showing the #admins room in LHN when it does provide any value.
We do this by showing the #admins room in LHN only when there are more than one admin or there are policy audit log available for review.

Fixed Issues

$ #36236
PROPOSAL: #36236 (comment)

Tests

  1. Sign-in using a new account
  2. When the onboarding modal is displayed, select Manage my Team’s expenses and Continue.
  3. Enter the Business Name and Name details and Continue to complete the onboarding steps.
  4. Verify that the LHN does not show #admins room (#Test 1)
  5. Go to Account Settings—>Workspaces—>3DotMenu
  6. Select the Menu Option Go to #admins room
    Alternative to Steps (5) And (6), we can also go to #admins room by clicking on #admins link in Chat with your setup specialist in #admins for help within Expensify system DM chat (created for odd account IDs)
  7. Verify that the #admins report is shown and the LHN displays the #admins report (#Test 2)
  8. Navigate to any other report.
  9. Verify that the #admins report is not shown in LHN (#Test 3)
  10. Follow steps 5,6 and navigate back to #admins room
  11. Leave a comment in #admins room and navigate to any other report.
  12. Verify that the #admins report remains shown and does not hide anymore. (#Test 4)
  13. Navigate to Settings->Workspaces and click on New Workspace to create a new workspace
  14. Navigate back to LHN and verify that the #admins room is not shown (#Test 5)
  • Verify that no errors appear in the JS console

Offline tests

Same as Steps for Tests Section.

QA Steps

Same as Steps for Tests Section.

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed 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 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 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.js 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
45048-web-safari-001.mp4
36236-web-safari-02.mp4
Desktop
36236-desktop-02.mp4
iOS
36236-ios-native-02.mp4
Android
36236-android-native-02.mp4
Mobile Web - Chrome
36236-mweb-chrome-02.mp4
Mobile Web - Safari
45048-mweb-safari-001.mp4
36236-mweb-safari-02.mp4

@rojiphil rojiphil marked this pull request as ready for review July 9, 2024 09:29
@rojiphil rojiphil requested a review from a team as a code owner July 9, 2024 09:29
@melvin-bot melvin-bot bot removed the request for review from a team July 9, 2024 09:29
Copy link

melvin-bot bot commented Jul 9, 2024

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

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 11, 2024

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

Having build issues on Android

Android: mWeb Chrome
Screen.Recording.2024-07-24.at.2.59.22.AM.mov
iOS: Native
Screen.Recording.2024-07-24.at.2.57.21.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-07-24.at.2.54.41.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-07-15.at.3.39.04.PM.mov
MacOS: Desktop
Screen.Recording.2024-07-24.at.2.52.39.AM.mov

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 12, 2024

@rojiphil Admin still shows up for new workspace.

Screen.Recording.2024-07-12.at.1.52.23.PM.mov

@rojiphil
Copy link
Contributor Author

@rojiphil Admin still shows up for new workspace.

Screen.Recording.2024-07-12.at.1.52.23.PM.mov

@allroundexperts Maybe it is shown because it was pinned earlier. Can you please remove the pin on the #admins room and check if it is displayed?

@allroundexperts
Copy link
Contributor

@rojiphil I created a new workspace and it gets pinned by default.

@rojiphil
Copy link
Contributor Author

I created a new workspace and it gets pinned by default.

hmm.. Interesting. Let me check this.

@rojiphil
Copy link
Contributor Author

I created a new workspace and it gets pinned by default.

@allroundexperts That was a good catch.
I have fixed this and have extended the test cases to include this scenario.
Please review again.

@allroundexperts
Copy link
Contributor

@rojiphil The #admins room disappears even after I send a message.

Screen.Recording.2024-07-15.at.3.42.24.PM.mov

@rojiphil
Copy link
Contributor Author

The #admins room disappears even after I send a message.

@allroundexperts I checked this but I am unable to reproduce this.
The only possible explanation I can think of is if the priority mode preference is set to #focus. Can you please confirm if this is the case by any chance?
Otherwise, I would need your help in reproducing this.

@rojiphil
Copy link
Contributor Author

Meanwhile, I notice that we need to fallback to report.lastActionType which will be useful in cases of fresh signin during which reportActions are not available in FE. I have added the fix for this too.
Please have a look. Thanks.

45048-web-safari-002.mp4

@francoisl francoisl self-requested a review July 15, 2024 17:12
@rojiphil
Copy link
Contributor Author

@allroundexperts Gentle bump to take this further. Thanks

@allroundexperts
Copy link
Contributor

This went out of my radar. On it today!

@allroundexperts
Copy link
Contributor

@rojiphil This is still not working for me. As you can see, the focus mode is off. I'm creating a new account for testing.

Screen.Recording.2024-07-23.at.1.29.36.AM.mov

@rojiphil
Copy link
Contributor Author

rojiphil commented Jul 23, 2024

This is still not working for me. As you can see, the focus mode is off. I'm creating a new account for testing.

@allroundexperts Sorry. That was my problem. We should check the report's lastActionType only as a fallback and give preference to lastVisibleAction instead. I have fixed this. Please check if it works for you now.

45058-web-safari-003.mp4

Copy link
Contributor

@allroundexperts allroundexperts left a comment

Choose a reason for hiding this comment

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

Works good!

@francoisl francoisl merged commit 8cde16f into Expensify:main Jul 23, 2024
15 checks passed
@OSBotify
Copy link
Contributor

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

@rojiphil rojiphil deleted the 36236-show-admins-only-when-required branch July 24, 2024 02:08
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/francoisl in version: 9.0.13-0 🚀

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

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