App icon indicating copy to clipboard operation
App copied to clipboard

Bring auditor role to NewDot

Open hungvu193 opened this issue 1 year ago • 28 comments

Details

https://docs.google.com/document/d/1Okva7PJJwmOEFPbsD74pWUzB2R8EzOqnz4EKjcLnTJQ

Fixed Issues

$ https://github.com/Expensify/App/issues/47695 PROPOSAL: N/A

Tests

  1. Create a brand new workspace.
  2. From the workspace room, try to submit 2,3 expenses and create few tasks.
  3. Invite 2,3 members.
  4. Assign one of the member Auditor role.
  5. Login with the member that has Auditor role.
  6. Try to access #admin room of the above workspace
  7. Verify that you can comment and view expenses, tasks but can't edit them.
  8. Go to Search bottom tabs.
  9. Verify that you can see the expenses that Admin submitted.
  10. Select one expense and verify that you can export that expense as csv (via Download action).
  11. Click on View button beside Expense request.
  12. Verify that you can only view and comment, but can't edit that expense.
  • [x] Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

  • [x] Verify that no errors appear in the JS console

PR Author Checklist

  • [x] I linked the correct issue in the ### Fixed Issues section above
  • [x] I wrote clear testing steps that cover the changes made in this PR
    • [x] I added steps for local testing in the Tests section
    • [x] I added steps for the expected offline behavior in the Offline steps section
    • [x] I added steps for Staging and/or Production testing in the QA steps section
    • [x] I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • [x] 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)
    • [x] 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).
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I ran the tests on all platforms & verified they passed on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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)
  • [x] I followed proper code patterns (see Reviewing the code)
    • [x] 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)
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • [x] 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:
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I followed the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] I verified that if a function's arguments changed that all usages have also been updated correctly
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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: mWeb Chrome

https://github.com/user-attachments/assets/d60e92b0-240c-434f-ac78-f5ea4e797df2

https://github.com/user-attachments/assets/530574ae-6e7a-4179-bf31-ef709df5c4a6

iOS: Native

https://github.com/user-attachments/assets/4a4e8762-fcbd-4344-a980-e03f9919faae

iOS: mWeb Safari

https://github.com/user-attachments/assets/d240e557-025e-420f-854f-e921f2d70f16

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/4b2986a3-35cf-4a89-ac3f-5417172ab344

MacOS: Desktop

https://github.com/user-attachments/assets/b8ba275d-8ef1-4008-b883-b4ccd6023bc8

hungvu193 avatar Aug 16 '24 11:08 hungvu193

Working example:

https://github.com/user-attachments/assets/4b2986a3-35cf-4a89-ac3f-5417172ab344

hungvu193 avatar Aug 22 '24 07:08 hungvu193

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

melvin-bot[bot] avatar Aug 22 '24 07:08 melvin-bot[bot]

Reviewer Checklist

  • [x] I have verified the author checklist is complete (all boxes are checked off).
  • [x] I verified the correct issue is linked in the ### Fixed Issues section above
  • [x] I verified testing steps are clear and they cover the changes made in this PR
    • [x] I verified the steps for local testing are in the Tests section
    • [x] I verified the steps for Staging and/or Production testing are in the QA steps section
    • [x] 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)
    • [x] 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)
  • [x] I checked that screenshots or videos are included for tests on all platforms
  • [x] I included screenshots or videos for tests on all platforms
  • [x] I verified tests pass on all platforms & I tested again on:
    • [x] Android: Native
    • [x] Android: mWeb Chrome
    • [x] iOS: Native
    • [x] iOS: mWeb Safari
    • [x] MacOS: Chrome / Safari
    • [x] MacOS: Desktop
  • [x] 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
  • [x] I verified proper code patterns were followed (see Reviewing the code)
    • [x] 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).
    • [x] I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • [x] I verified that comments were added to code that is not self explanatory
    • [x] 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.
    • [x] I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • [x] I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • [x] 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)
    • [x] 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.
    • [x] I verified the JSDocs style guidelines (in STYLE.md) were followed
  • [x] If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • [x] I verified that this PR follows the guidelines as stated in the Review Guidelines
  • [x] 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)
  • [x] I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • [x] 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
  • [x] If a new component is created I verified that:
    • [x] A similar component doesn't exist in the codebase
    • [x] All props are defined accurately and each prop has a /** comment above it */
    • [x] The file is named correctly
    • [x] The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • [x] The only data being stored in the state is data necessary for rendering and nothing else
    • [x] 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)
    • [x] 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)
    • [x] All JSX used for rendering exists in the render method
    • [x] 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
  • [x] If any new file was added I verified that:
    • [x] 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
  • [x] If a new CSS style is added I verified that:
    • [x] A similar style doesn't already exist
    • [x] The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • [x] 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.
  • [x] 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)
  • [x] 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.
  • [x] 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.
  • [x] 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:
    • [x] I verified that all the inputs inside a form are aligned with each other.
    • [x] I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • [x] 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.
  • [x] 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.
  • [x] 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

https://github.com/user-attachments/assets/01b7f1b1-b6b4-4cbc-99eb-90a233719c84

iOS: Native

https://github.com/user-attachments/assets/bc08e3cd-c809-42b1-a19e-a5babd80aa25

https://github.com/user-attachments/assets/e9ae36e9-6b57-4471-8037-7a1b6becbb7d

iOS: mWeb Safari

https://github.com/user-attachments/assets/005d3193-df91-4bb4-b6ec-56717dfee79d

https://github.com/user-attachments/assets/39920a09-2989-4e2d-89e9-0c3047213b9a

MacOS: Chrome / Safari

https://github.com/user-attachments/assets/1ed25646-de1b-4008-ac1d-57fd8e3cb242

MacOS: Desktop

https://github.com/user-attachments/assets/f148e594-fc8e-40c4-af0e-fa9a8ae7935b

ishpaul777 avatar Aug 22 '24 13:08 ishpaul777

I've just remembered that we should wait for Auditor icon and also the Spanish translation confirmation

hungvu193 avatar Aug 22 '24 14:08 hungvu193

It's now ready!

hungvu193 avatar Aug 23 '24 02:08 hungvu193

Looks good to me, though minor nit, I think we should make Make auditor the last option in the list since it's the least common option (I'm assuming). (Keen on Jason and Shawns thoughts here too)

CleanShot 2024-08-23 at 13 44 58@2x

Also, @JmillsExpensify @shawnborton, do you think we should add a badge for auditor users like so? CleanShot 2024-08-23 at 13 42 14@2x

Assuming this was discussed in the past, but just wanted to check. Currently there's no way to separate a auditor and a member from a list.

dubielzyk-expensify avatar Aug 23 '24 03:08 dubielzyk-expensify

Totally agree with you @dubielzyk-expensify. But when reading the docs I noticed this note:

We discussed here the possibility of including a badge indicating which role a given member is when viewing the member’s list from the room view, but we opted to punt it as out-of-scope polish.

Here's the slack thread: https://app.slack.com/client/E047TPA624F/C06ML6X0W9L

hungvu193 avatar Aug 23 '24 03:08 hungvu193

I thought that list talk about the members list from somewhere like a chat room etc: CleanShot 2024-08-23 at 13 54 36@2x

Not the actual Workspace Editor Member list which is what I screenshotted above.

Totally accepting if I'm just confused haha.

I'll let @JmillsExpensify and @shawnborton weigh in :)

dubielzyk-expensify avatar Aug 23 '24 03:08 dubielzyk-expensify

Not the actual Workspace Editor Member list which is what I screenshotted above.

You're right 🥲 .

hungvu193 avatar Aug 23 '24 04:08 hungvu193

though minor nit, I think we should make Make auditor the last option in the list since it's the least common option (I'm assuming). (Keen on Jason and Shawns thoughts here too)

100% agree, least common option by far.

Assuming this was discussed in the past, but just wanted to check. Currently there's no way to separate a auditor and a member from a list.

Also agree that the auditors in the members table in the workspace settings should get an Auditor label.

trjExpensify avatar Aug 23 '24 09:08 trjExpensify

Added Auditor badge for WorkspaceMemberPage.

hungvu193 avatar Aug 24 '24 10:08 hungvu193

For member page, I checked and role always return undefined here so I can't add Auditor badge, we might need to update the BE cc @dangrous https://github.com/Expensify/App/blob/0c8455280c738a5db596f34409a0a3177e682e7f/src/pages/ReportParticipantsPage.tsx#L67

hungvu193 avatar Aug 25 '24 09:08 hungvu193

Like, it always returns undefined for all roles? or just for auditors?

dangrous avatar Aug 26 '24 14:08 dangrous

Like, it always returns undefined for all roles? or just for auditors?

Yeah, undefined for every role.

hungvu193 avatar Aug 26 '24 14:08 hungvu193

But you see them in group chats right? Asking because on the backend we send role for group chats but nothing else. Seems like it's working there for me...

image

We will need to update to always send though, if that's the case

dangrous avatar Aug 26 '24 14:08 dangrous

Yeah, I can see the role value for group chat, but I don't think we have Auditor role inside a group chat right? Because we only have auditor role inside a policy #room which is linked with a workspace,

hungvu193 avatar Aug 26 '24 14:08 hungvu193

ah okay cool then yeah, I'll see how to send roles for policy rooms. Just making sure it wasn't a wider bug!

dangrous avatar Aug 26 '24 15:08 dangrous

Okay i've added the details of that change to the design doc for review!

dangrous avatar Aug 26 '24 16:08 dangrous

waiting Design Doc approval, will complete review once i have 🟢 https://github.com/Expensify/App/issues/47695#issuecomment-2305316859

ishpaul777 avatar Sep 02 '24 19:09 ishpaul777

Reviewing 👀

ishpaul777 avatar Sep 05 '24 16:09 ishpaul777

@hungvu193 please merge main when you get the chance

ishpaul777 avatar Sep 05 '24 16:09 ishpaul777

Just a quick question / note (haven't looked at the code here yet) - in starting my backend PR, I've found that it's not... actually necessary? I think? I think in all cases the report.permissions is always returned as auditor from the backend, so I don't need to make any changes to pass the role in the report.participants array. Is this correct as far as you know?

dangrous avatar Sep 05 '24 19:09 dangrous

i am not sure i follow, according to this in DD we dont need to show badge in report participant page. then why do we need to send role in the report.participants

We discussed here the possibility of including a badge indicating which role a given member is when viewing the member’s list from the room view, but we opted to punt it as out-of-scope polish.

Anything i am missing 🤔

ishpaul777 avatar Sep 05 '24 19:09 ishpaul777

Yeah I think that's correct - basically I wrote here that I'd need to send the role to the front end but I don't think that's actually true. Sounds like you agree!

dangrous avatar Sep 05 '24 20:09 dangrous

All good! Can you trigger a build @dangrous?

hungvu193 avatar Sep 06 '24 06:09 hungvu193

I'll run a build quickly.

shawnborton avatar Sep 06 '24 08:09 shawnborton

:test_tube::test_tube: Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! :test_tube::test_tube:

Android :robot: iOS :apple:
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/47561/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/47561/index.html
Android iOS
Desktop :computer: Web :spider_web:
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/47561/NewExpensify.dmg https://47561.pr-testing.expensify.com
Desktop Web

:eyes: View the workflow run that generated this build :eyes:

github-actions[bot] avatar Sep 06 '24 09:09 github-actions[bot]

We have a small Backend bug:

When workspace chat appears for auditor it has expenses that are not deleted but it shows as [Deleted] because transaction does not exist locally for user when navigating to expense chat through search it works fine.

https://github.com/user-attachments/assets/80adbcb2-68e8-40e4-86ab-177c7d009c09

ishpaul777 avatar Sep 06 '24 20:09 ishpaul777

From a design/visual perspective this is looking good to me 👍

dubielzyk-expensify avatar Sep 08 '24 22:09 dubielzyk-expensify

We have a small Backend bug:

When workspace chat appears for auditor it has expenses that are not deleted but it shows as [Deleted] because transaction does not exist locally for user when navigating to expense chat through search it works fine.

Screen.Recording.2024-09-07.at.1.24.41.AM.mov

So for this, what needs to be sent that isn't being sent right now? Is OpenApp / ReconnectApp not sending the expense reports, or sending them in the wrong format? Something else?

dangrous avatar Sep 09 '24 21:09 dangrous