Bring auditor role to NewDot #47561

hungvu193 · 2024-08-16T11:24:57Z

Details

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

Fixed Issues

$ #47695
PROPOSAL: N/A

Tests

Create a brand new workspace.
From the workspace room, try to submit 2,3 expenses and create few tasks.
Invite 2,3 members.
Assign one of the member Auditor role.
Login with the member that has Auditor role.
Try to access #admin room of the above workspace
Verify that you can comment and view expenses, tasks but can't edit them.
Go to Search bottom tabs.
Verify that you can see the expenses that Admin submitted.
Select one expense and verify that you can export that expense as csv (via Download action).
Click on View button beside Expense request.
Verify that you can only view and comment, but can't edit that expense.

Verify that no errors appear in the JS console

Offline tests

Same as Tests.

QA Steps

Same as Tests.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

Screen.Recording.2024-08-22.at.16.19.15.mov

Screen.Recording.2024-08-22.at.15.29.59.mov

iOS: Native

Screen.Recording.2024-08-22.at.15.29.59.mov

iOS: mWeb Safari

Screen.Recording.2024-08-22.at.15.39.34.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-22.at.14.24.26.mp4

MacOS: Desktop

Screen.Recording.2024-08-22.at.14.30.21.mov

…le-to-nd

hungvu193 · 2024-08-22T07:30:01Z

Working example:

Screen.Recording.2024-08-22.at.14.24.26.mp4

melvin-bot · 2024-08-22T07:44:25Z

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

…le-to-nd

ishpaul777 · 2024-08-22T13:18:07Z

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

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

iOS: Native

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

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

iOS: mWeb Safari

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

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

MacOS: Chrome / Safari

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

MacOS: Desktop

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

hungvu193 · 2024-08-22T14:40:21Z

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

hungvu193 · 2024-08-23T02:36:13Z

It's now ready!

dubielzyk-expensify · 2024-08-23T03:42:41Z

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)

Also, @JmillsExpensify @shawnborton, do you think we should add a badge for auditor users like so?

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.

hungvu193 · 2024-08-23T03:46:20Z

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

dubielzyk-expensify · 2024-08-23T03:55:26Z

I thought that list talk about the members list from somewhere like a chat room etc:

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 :)

hungvu193 · 2024-08-23T04:09:15Z

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

You're right 🥲 .

trjExpensify · 2024-08-23T09:44:51Z

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.

dangrous

Minor changes, and a question - but this is looking great!

src/languages/es.ts

src/pages/workspace/WorkspaceMembersPage.tsx

src/libs/actions/Task.ts

dangrous · 2024-09-09T21:28:46Z

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

This looks good to me! I think we can probably go ahead and merge, and handle those missing reports afterwards, what do you think?

src/libs/actions/Task.ts

hungvu193 · 2024-09-11T00:41:02Z

Agreed 🚀

dangrous · 2024-09-11T18:03:02Z

Okay conflicts, sorry! And then I pinged the team to review/confirm those translations you posted @hungvu193. Other than those two issues, I think we're good!

As for that backend issue, can you help me diagnose what needs to be sent from the backend that isn't? We can go ahead and merge this but would love to get that sorted in the meantime.

ishpaul777 · 2024-09-11T18:07:55Z

I'll help diagnose this once i am back tomorrow, OOO today if @hungvu193 can get to this first feel free to... 🙇

hungvu193 · 2024-09-12T15:16:54Z

Sorry I can't seem to reproduce 🤦

dangrous · 2024-09-12T16:21:10Z

I'll see if I can get it to work on local - maybe it was a temporary backend thing that's now fixed?

And the translations were confirmed, so I think we're basically good here. I'll take one last look shortly and then merge!

ishpaul777 · 2024-09-12T16:47:31Z

still able to reproduce, it appears that transaction does not exist locally

Screen.Recording.2024-09-12.at.10.11.45.PM.mov

and these coditions here return to be true

App/src/libs/ReportUtils.ts

Lines 1368 to 1370 in cfe3d36

    
           function isClosedExpenseReportWithNoExpenses(report: OnyxEntry<Report>): boolean { 
        
               return report?.statusNum === CONST.REPORT.STATUS_NUM.CLOSED && isExpenseReport(report) && !hasExpenses(report.reportID); 
        
           }

specifically this

App/src/libs/ReportUtils.ts

Lines 1361 to 1363 in cfe3d36

    
           function hasExpenses(reportID?: string): boolean { 
        
               return !!Object.values(allTransactions ?? {}).find((transaction) => `${transaction?.reportID}` === `${reportID}`); 
        
           }

dangrous

one issue, otherwise looks good!

dangrous · 2024-09-12T17:21:07Z

src/libs/ReportUtils.ts

+/**
+ * Checks if the user has auditor permission in the provided report
+ */
+function isAuditor(report: OnyxEntry<Report>): boolean {


Okay so I think this is slightly wrong - I think we should check for isPolicyAuditor first and THEN check report permissions afterwards. Otherwise the following test steps seem to occur:

Create a workspace

Add two members, then make one an admin and one an auditor

Assign a task to each of them in the #admins chat

Log in as the auditor

The auditor will be able to edit both tasks.

I looked at Onyx and the auditor's report permissions for the task assigned to the admin is read, write, share. I'm honestly not sure why that is, but it seems like if we checked isPolicyAuditor first then we wouldn't get to that point.

What do you think? Would this cause any issues I'm not aware of?

Follow up - let me know how you were testing it before if it was seeming to work then? Maybe I did something wrong - or maybe there's a flow (maybe the change role isn't working or something?) that we need to adjust

Thanks let me take a look

Yes, that's pretty weird that on the admin assigned task, when I viewed it as an auditor the permissions are read, write, share which makes isAuditor return false. Meanwhile it should be empty (as I checked/ tested before 😂).

Switch the PolicyUtils.isPolicyAuditor(policy); to the top will make it works because we will use the role to check it. Nevermind, let me update the code.

Thanks for testing it! 💯

…le-to-nd

dangrous

Okay this looks great! @ishpaul777 can you give it one last quick round of tests, now that we have the updated logic for isAuditor?

ishpaul777 · 2024-09-13T17:36:59Z

On it 🙇

ishpaul777 · 2024-09-13T18:07:08Z

Looks good! Verified Auditor can not edit the task assigned to other user. Thanks for catching what i missed @dangrous 🙏

Screen.Recording.2024-09-13.at.11.35.32.PM.mov

OSBotify · 2024-09-13T21:12:02Z

✋ 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 · 2024-09-13T23:05:30Z

🚀 Deployed to staging by https://github.com/dangrous in version: 9.0.35-0 🚀

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

OSBotify · 2024-09-16T18:21:27Z

🚀 Deployed to production by https://github.com/grgia in version: 9.0.35-7 🚀

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

dangrous · 2024-09-20T17:43:35Z

hey @ishpaul777 are you still able to reproduce #47561 (comment) ? I can't get it to happen anymore.

If so, can you let me know what steps I need to follow? Here's what I'm doing:

Creating a new workspace
Submitting two expenses to the workspace chat (they only show as one report, not two)
Adding a new member to the workspace
Separately signing in to that member's account
Updating that member's role to auditor
Waiting for the workspace chat between the first user and the workspace to show up (for the auditor)
Navigating to that workspace chat
[I'm then able to see the report correctly, not as deleted]

Thanks!

dangrous · 2024-09-23T17:08:20Z

bumping this ^ when you have time, @ishpaul777 - thank you!

ishpaul777 · 2024-09-23T17:11:36Z

Sorry i missed ping earlier, will retest in few minutes

ishpaul777 · 2024-09-23T21:05:25Z

I am sorry took me longer than expected, I tested and i could not reproduce as well

Screen.Recording.2024-09-24.at.2.32.02.AM.mov

hungvu193 added 6 commits August 16, 2024 17:42

bring auditor role to NewDot

a986e71

fix linting

fec77ba

refactor bulkaction logic

0f6423c

fix lint

5b59e2c

update auditor role for expense

c34ae3c

remove local changes

f08c970

hungvu193 force-pushed the feat/bring-auditor-role-to-nd branch from 48e7c53 to f08c970 Compare August 20, 2024 07:53

hungvu193 added 3 commits August 20, 2024 14:54

merge main

775b47d

Merge remote-tracking branch 'origin/main' into feat/bring-auditor-ro…

79c7b28

…le-to-nd

prevent auditor from editing room description

97df3fd

hungvu193 marked this pull request as ready for review August 22, 2024 07:44

hungvu193 requested a review from a team as a code owner August 22, 2024 07:44

melvin-bot bot requested review from ishpaul777 and removed request for a team August 22, 2024 07:44

hungvu193 mentioned this pull request Aug 22, 2024

[ready for payment] Project: Bring the Auditor role to NewDot #47695

Closed

20 tasks

Merge remote-tracking branch 'origin/main' into feat/bring-auditor-ro…

740fde0

…le-to-nd

update icon and rename isOnlyAllowedToComment

59abfac

hungvu193 requested a review from a team as a code owner August 23, 2024 02:26

merge main

a9ca0d6

fix linting

429cac3

dangrous requested changes Sep 9, 2024

View reviewed changes

src/languages/es.ts Show resolved Hide resolved

src/pages/workspace/WorkspaceMembersPage.tsx Outdated Show resolved Hide resolved

src/libs/actions/Task.ts Show resolved Hide resolved

address comment

1d6aecc

dangrous previously approved these changes Sep 10, 2024

View reviewed changes

src/libs/actions/Task.ts Show resolved Hide resolved

merge main

e6ff8f1

hungvu193 dismissed dangrous’s stale review via e6ff8f1 September 12, 2024 01:47

dangrous requested changes Sep 12, 2024

View reviewed changes

hungvu193 added 2 commits September 13, 2024 15:12

update isAudiot func

e6bd7aa

Merge remote-tracking branch 'origin/main' into feat/bring-auditor-ro…

bd55006

…le-to-nd

dangrous approved these changes Sep 13, 2024

View reviewed changes

ishpaul777 approved these changes Sep 13, 2024

View reviewed changes

melvin-bot bot requested a review from dangrous September 13, 2024 18:07

dangrous approved these changes Sep 13, 2024

View reviewed changes

dangrous merged commit 89c0ca5 into Expensify:main Sep 13, 2024
18 checks passed

github-actions bot mentioned this pull request Sep 13, 2024

Deploy Checklist: New Expensify 2024-09-13 #49195

Closed

55 tasks

Bring auditor role to NewDot #47561

Bring auditor role to NewDot #47561

Conversation

hungvu193 commented Aug 16, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

hungvu193 commented Aug 22, 2024

melvin-bot bot commented Aug 22, 2024

ishpaul777 commented Aug 22, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

hungvu193 commented Aug 22, 2024

hungvu193 commented Aug 23, 2024

dubielzyk-expensify commented Aug 23, 2024 • edited Loading

hungvu193 commented Aug 23, 2024 • edited Loading

dubielzyk-expensify commented Aug 23, 2024

hungvu193 commented Aug 23, 2024

trjExpensify commented Aug 23, 2024

dangrous left a comment

Choose a reason for hiding this comment

dangrous commented Sep 9, 2024

dangrous left a comment

Choose a reason for hiding this comment

hungvu193 commented Sep 11, 2024

dangrous commented Sep 11, 2024

ishpaul777 commented Sep 11, 2024

hungvu193 commented Sep 12, 2024

dangrous commented Sep 12, 2024

ishpaul777 commented Sep 12, 2024 • edited Loading

dangrous left a comment

Choose a reason for hiding this comment

dangrous Sep 12, 2024

Choose a reason for hiding this comment

dangrous Sep 12, 2024

Choose a reason for hiding this comment

hungvu193 Sep 13, 2024

Choose a reason for hiding this comment

hungvu193 Sep 13, 2024

Choose a reason for hiding this comment

hungvu193 Sep 13, 2024

Choose a reason for hiding this comment

dangrous left a comment

Choose a reason for hiding this comment

ishpaul777 commented Sep 13, 2024

ishpaul777 commented Sep 13, 2024 • edited Loading

OSBotify commented Sep 13, 2024

OSBotify commented Sep 13, 2024

OSBotify commented Sep 16, 2024

dangrous commented Sep 20, 2024 • edited Loading

dangrous commented Sep 23, 2024

ishpaul777 commented Sep 23, 2024

ishpaul777 commented Sep 23, 2024

hungvu193 commented Aug 16, 2024 •

edited

Loading

ishpaul777 commented Aug 22, 2024 •

edited

Loading

dubielzyk-expensify commented Aug 23, 2024 •

edited

Loading

hungvu193 commented Aug 23, 2024 •

edited

Loading

ishpaul777 commented Sep 12, 2024 •

edited

Loading

ishpaul777 commented Sep 13, 2024 •

edited

Loading

dangrous commented Sep 20, 2024 •

edited

Loading