Restrict workspace settings to admins #22820

esh-g · 2023-07-13T16:38:01Z

Details

Fixed Issues

$ #22013
PROPOSAL: #22013 (comment)

Tests

Test Setup

From account A, create a new workspace.
Invite account B.
Create a workspace from account B.

Therefore, B is admin in workspace B and not an admin in workspace A.

Now we need to prepare a chat with deep links to the correct page for testing. This setup can be done once on web, and then can be tested on other platforms with the same account.

✅ The page will open
❌ The not found page will be open
Refer to the 'Test Setup (Web)' in the screenshots section to make sure steps are followed correctly.

We first need to copy the reportID of #announce of workspace A and workspace B then also #admin of workspace B. This can be done by opening the room and then copying the number in the URL localhost:8080/r/[reportID].
[#announce B] means the reportID of the #announce room of workspace B. The same format applies for all other reportIDs copied.
Go to any chat on account B.
Add a comment 'Welcome message as admin' and add a link like this: https://staging.new.expensify.com/r/[#announce B]/welcomeMessage ✅
Add another comment 'Welcome message not as admin' and add a link like this: https://staging.new.expensify.com/r/[#announce A]/welcomeMessage. ❌
Add another comment 'Who can post (in #admin)' and add this a link like this: https://staging.new.expensify.com/r/[#admin B]/settings-who-can-post. ❌
Add another comment 'Who can post (as admin)' and add a link like this: https://staging.new.expensify.com/r/[#announce B]/settings/who-can-post. ✅
Add another comment 'Who can post (not as admin)' and add a link like this: https://staging.new.expensify.com/r/[#announce A]/settings/who-can-post. ❌
Click on each link and verify that it opens correctly according to ✅ and ❌.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Test Setup

From account A, create a new workspace.
Invite account B.
Create a workspace from account B.

Therefore, B is admin in workspace B and not an admin in workspace A.

Now we need to prepare a chat with deep links to the correct page for testing. This setup can be done once on web, and then can be tested on other platforms with the same account.

✅ The page will open
❌ The not found page will be open
Refer to the 'Test Setup (Web)' in the screenshots section to make sure steps are followed correctly.

We first need to copy the reportID of #announce of workspace A and workspace B then also #admin of workspace B. This can be done by opening the room and then copying the number in the URL staging.new.expensify.com/r/[reportID].
[#announce B] means the reportID of the #announce room of workspace B. The same format applies for all other reportIDs copied.
Go to any chat on account B.
Add a comment 'Welcome message as admin' and add a link like this: https://staging.new.expensify.com/r/[#announce B]/welcomeMessage ✅
Add another comment 'Welcome message not as admin' and add a link like this: https://staging.new.expensify.com/r/[#announce A]/welcomeMessage. ❌
Add another comment 'Who can post (in #admin)' and add this a link like this: https://staging.new.expensify.com/r/[#admin B]/settings-who-can-post. ❌
Add another comment 'Who can post (as admin)' and add a link like this: https://staging.new.expensify.com/r/[#announce B]/settings/who-can-post. ✅
Add another comment 'Who can post (not as admin)' and add a link like this: https://staging.new.expensify.com/r/[#announce A]/settings/who-can-post. ❌
Click on each link and verify that it opens correctly according to ✅ and ❌.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Test Setup (Web)

Web

Screen.Recording.2023-07-15.at.10.41.20.AM.mov

Mobile Web - Chrome

Screen.Recording.2023-07-15.at.10.58.59.AM-1.mov

Mobile Web - Safari

Screen.Recording.2023-07-15.at.10.46.20.AM-1.mov

Desktop

Screen.Recording.2023-07-15.at.10.49.27.AM.mov

iOS

Screen.Recording.2023-07-15.at.10.51.09.AM-1.mov

Android

Screen.Recording.2023-07-15.at.10.58.24.AM-1.mov

melvin-bot · 2023-07-13T16:38:08Z

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

esh-g · 2023-07-13T17:04:13Z

@mollfpr Here are answers to potential concerns you might have:

Why didn't we use withPolicy HOC
Because withPolicy gets the policyID from route and we need it from report.policyID.
Why did we remove _.isEmpty(props.report) from ReportWelcomeMessagePage.js
Because it is already wrapped with the HOC withReportOrNotFound which performs the same.
Why were videos of native platforms not atached?
Because we cannot edit URLs on those.

mollfpr

@esh-g I don't think we need to refactor the policy prop-types. If you need it in the ReportWelcomeMessagePage and WriteCapibilityPage, you can export it from withPolicy.

App/src/components/AvatarWithIndicator.js

Lines 34 to 35 in 12d8a3f

    
           /** All the user's policies (from Onyx via withFullPolicy) */ 
        
           policies: PropTypes.objectOf(policyPropTypes.policy),

mollfpr · 2023-07-14T11:49:08Z

src/pages/settings/Report/WriteCapabilityPage.js

@@ -38,9 +51,11 @@ function WriteCapabilityPage(props) {
        boldStyle: value === (props.report.writeCapability || CONST.REPORT.WRITE_CAPABILITIES.ALL),
    }));

+    const canAccess = !ReportUtils.isAdminRoom(props.report) && PolicyUtils.isPolicyAdmin(props.policy);


Boolean variables and props

Boolean props or variables must be prefixed with should or is to make it clear that they are Boolean. Use should when we are enabling or disabling some features and is in most other cases.

I think we should rename it with the is prefix.

mollfpr · 2023-07-14T12:12:31Z

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 / Chrome
- iOS / native
- iOS / 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 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 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(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 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

Web

22820.Web.mov

Mobile Web - Chrome

22820.mWeb.Chrome.webm

Mobile Web - Safari

22820.mWeb.Safari.mp4

Desktop

22820.Desktop.mov

iOS

22820.iOS.mp4

Android

22820.Android.webm

mollfpr · 2023-07-14T12:30:43Z

@esh-g I got prop-types error on opening WriteCapabilityPage and ReportWelcomePage.

esh-g · 2023-07-14T14:48:06Z

@mollfpr Applied all the suggested changes... Hope it looks good now 😇

mollfpr · 2023-07-14T16:32:30Z

For natives, you can open the page with the deep-link URL in the chat.

https://staging.new.expensify.com/r/4459906896589398/welcomeMessage

https://staging.new.expensify.com/r/8000629965504300/settings/who-can-post

esh-g · 2023-07-14T16:37:02Z

Okay @mollfpr, Adding the videos now..

mollfpr · 2023-07-14T16:49:42Z

We have 2 cases for the welcome message page and 3 for the who can post page.

✅ The page will open
❌ The not found page will be open

Welcome message page:

Open the page as an admin ✅
Open the page as not an admin ❌

Who can post a page

Open the page from the #admin room ❌
Open the page from the #announce room as an admin ✅
Open the page from the #announce room as not an admin ❌

We should add all the cases to the test step.

Here's an example of what I prepare for testing on native.

esh-g · 2023-07-14T17:14:29Z

@mollfpr I have edited the test steps. Please confirm they are as expected and I'll attach all the videos tomorrow morning as soon as possible. (Got a lot of testing to do 6 devices x 5 tests 😅). But I still hope we can get this merged tomorrow

mollfpr · 2023-07-14T17:18:36Z

@esh-g No worries!

I think we can change how to test this; instead of modifying the URL, we can just prepare a chat that has all the links for each test case. But let's take that for tomorrow.

esh-g · 2023-07-15T05:41:06Z

@mollfpr I have updated the tests and the test videos. I hope they are up to the mark but please feel free to point out any suggestions you have! 😇

mollfpr

LGTM and tests well 👍

grgia

Code and QA tests/Screenshots LGTM! Thank you

OSBotify · 2023-07-17T10:21:14Z

✋ 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 · 2023-07-17T19:38:14Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.3.42-0 🚀

platform	result
🤖 android 🤖	cancelled 🔪
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	cancelled 🔪

OSBotify · 2023-07-19T17:59:59Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.3.42-26 🚀

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

Restrict workspace settings to admins

b0ac850

esh-g requested a review from a team as a code owner July 13, 2023 16:38

melvin-bot bot requested review from mollfpr and removed request for a team July 13, 2023 16:38

Add policy prop comment

6192d75

whitespace difference

fd82b35

esh-g mentioned this pull request Jul 13, 2023

[HOLD for payment 2023-07-26] [$1000] Web - UserB can access the room "Welcome message" page and update it without permission #22013

Closed

6 tasks

mollfpr requested changes Jul 14, 2023

View reviewed changes

esh-g added 2 commits July 14, 2023 20:10

prop-type fix

2d0b25d

Fix Lint

10d80e5

esh-g requested a review from mollfpr July 14, 2023 17:17

mollfpr approved these changes Jul 15, 2023

View reviewed changes

melvin-bot bot requested a review from grgia July 15, 2023 06:42

grgia approved these changes Jul 17, 2023

View reviewed changes

grgia merged commit 25c8ae5 into Expensify:main Jul 17, 2023

OSBotify mentioned this pull request Jul 17, 2023

Deploy Checklist: New Expensify 2023-07-17 #23033

Closed

ginsuma mentioned this pull request Jul 20, 2023

Update ReportSettingsPage and NotificationPreferencePage permission #23255

Merged

57 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restrict workspace settings to admins #22820

Restrict workspace settings to admins #22820

esh-g commented Jul 13, 2023 •

edited

Loading

melvin-bot bot commented Jul 13, 2023

esh-g commented Jul 13, 2023 •

edited

Loading

mollfpr left a comment

mollfpr Jul 14, 2023

mollfpr commented Jul 14, 2023 •

edited

Loading

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023 •

edited

Loading

mollfpr commented Jul 14, 2023

esh-g commented Jul 15, 2023

mollfpr left a comment

grgia left a comment

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

	/** All the user's policies (from Onyx via withFullPolicy) */
	policies: PropTypes.objectOf(policyPropTypes.policy),

Restrict workspace settings to admins #22820

Restrict workspace settings to admins #22820

Conversation

esh-g commented Jul 13, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 13, 2023

esh-g commented Jul 13, 2023 • edited Loading

mollfpr left a comment

Choose a reason for hiding this comment

mollfpr Jul 14, 2023

Choose a reason for hiding this comment

Boolean variables and props

mollfpr commented Jul 14, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023

mollfpr commented Jul 14, 2023

esh-g commented Jul 14, 2023 • edited Loading

mollfpr commented Jul 14, 2023

esh-g commented Jul 15, 2023

mollfpr left a comment

Choose a reason for hiding this comment

grgia left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 17, 2023

OSBotify commented Jul 17, 2023

OSBotify commented Jul 19, 2023

esh-g commented Jul 13, 2023 •

edited

Loading

esh-g commented Jul 13, 2023 •

edited

Loading

mollfpr commented Jul 14, 2023 •

edited

Loading

esh-g commented Jul 14, 2023 •

edited

Loading