[Free trial] Implement Restricted Action screen #43855

pac-guerreiro · 2024-06-17T17:42:11Z

Details

Fixed Issues

$#43673
PROPOSAL: N/A

Tests

Since there are three variants of the restricted action screen, which are shown to the user depending on his workspace role, you'll need to test each of the following scenarios:

Scenario A - Workspace User

Create a new workspace with a different account
Invite your primary account to the workspace
On your primary account, go to the workspace page and get the policy ID from the URL
Navigate to /restricted-action/workspace/<policyID> passing the policy ID you got from previous step
Ensure the screen is opened and the UI is correct
Click the Chat with your admin button, ensure you were navigated to the workspace chat.

Scenario B - Workspace Admin

Create a new workspace with a different account
Invite your primary account to the workspace, then promote yourself to admin
On your primary account, go to the workspace page and get the policy ID from the URL
Navigate to /restricted-action/workspace/<policyID> passing the policy ID you got from previous step
Ensure the screen is opened and the UI is correct
Click the Chat in #admins button, ensure you were navigated to the workspace admins chat.

Scenario C - Workspace Owner

Create a new workspace
Go to the workspace page and get the policy ID from the URL
Navigate to /restricted-action/workspace/<policyID> passing the policy ID you got from previous step
Ensure the screen is opened and the UI is correct
Click the Add payment card button, ensure you were navigated to the Subscription screen.

Offline tests

Same as above

QA Steps

Same as above

PR Author Checklist

Screenshots/Videos

Android: Native

Workspace User

Android.-.Native.-.User.mp4

Workspace Admin

Android.-.Native.-.Admin.mp4

Workspace Owner

Android.-.Native.-.Owner.mp4

Android: mWeb Chrome

Workspace User

Android.-.Chrome.-.User.mp4

Workspace Admin

Android.-.Chrome.-.Admin.mp4

Workspace Owner

Android.-.Chrome.-.Owner.mp4

iOS: Native

Workspace User

iOS.-.Native.-.User.mp4

Workspace Admin

iOS.-.Native.-.Admin.mp4

Workspace Owner

iOS.-.Native.-.Owner.mp4

iOS: mWeb Safari

Workspace User

iOS.-.Safari.-.User.mp4

Workspace Admin

iOS.-.Safari.-.Admin.mp4

Workspace Owner

iOS.-.Safari.-.Owner.mp4

MacOS: Chrome / Safari

Workspace User

MacOS.-.Chrome.-.User.mp4

Workspace Admin

MacOS.-.Chrome.-.Admin.mp4

Workspace Owner

MacOS.-.Chrome.-.Owner.mp4

MacOS: Desktop

Workspace User

MacOS.-.Native.-.User.mp4

Workspace Admin

MacOS.-.Native.-.Admin.mp4

Workspace Owner

MacOS.-.Native.-.Owner.mp4

melvin-bot · 2024-06-17T17:42:17Z

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

src/pages/RestrictedAction/Workspace/WorkspaceRestrictedActionPage.tsx

src/pages/RestrictedAction/Workspace/WorkspaceUserRestrictedAction.tsx

src/pages/RestrictedAction/Workspace/WorkspaceRestrictedActionPage.tsx

src/pages/RestrictedAction/Workspace/WorkspaceOwnerRestrictedAction.tsx

src/pages/RestrictedAction/Workspace/WorkspaceAdminRestrictedAction.tsx

rezkiy37

left comments

src/languages/es.ts

src/languages/en.ts

fabioh8010 · 2024-06-18T15:25:46Z

src/languages/es.ts

@@ -2721,6 +2721,18 @@ export default {
            errorDescriptionPartTwo: 'contacta con el conserje',
            errorDescriptionPartThree: 'por ayuda.',
        },
+        restrictedAction: {
+            restricted: 'Restringido',
+            actionsAreCurrentlyRestricted: ({ workspaceName }) => `Los gastos para ${workspaceName} están actualmente restringidos`,


@pac-guerreiro Please resolve this comment once you update the spanish translation with the correct text.

The word in the ES file for workspace is espacio de trabajo

So this would be:

Los gastos para {workspace_name} espacio de trabajo están actualmente restringidos

CC: @Gonals to quickly confirm.

Los gastos para el espacio de trabajo {workspace_name} están actualmente restringidos

😁

@Gonals Muchas gracias! 🙏

Ah coming back here - the copy for this has an additional change that was made in the design doc reviews --

Instead of "Los gastos para el espacio de trabajo {workspace_name} están actualmente restringidos", we want to change the copy to "Las acciones en el espacio de trabajo {workspace_name} están actualmente restringidas"

@Gonals - are you able to confirm if that is the correct formatting to say, "Actions on the {workspace_name} workspace are currently restricted" ? I think we'd also need to change the English file for this as well? As initially the design doc had "Expenses to {workspace_name} are currently restricted."

English file is correct in the PR it seems:

Ah coming back here - the copy for this has an additional change that was made in the design doc reviews --

Instead of "Los gastos para el espacio de trabajo {workspace_name} están actualmente restringidos", we want to change the copy to "Las acciones en el espacio de trabajo {workspace_name} están actualmente restringidas"

@Gonals - are you able to confirm if that is the correct formatting to say, "Actions on the {workspace_name} workspace are currently restricted" ? I think we'd also need to change the English file for this as well? As initially the design doc had "Expenses to {workspace_name} are currently restricted."

Yep! All good!

src/libs/ReportUtils.ts

src/pages/RestrictedAction/Workspace/WorkspaceOwnerRestrictedAction.tsx

src/pages/RestrictedAction/Workspace/WorkspaceUserRestrictedAction.tsx

assets/images/simple-illustrations/simple-illustration__lockclosed_orange.svg

src/pages/RestrictedAction/Workspace/WorkspaceOwnerRestrictedAction.tsx

shawnborton · 2024-06-19T07:55:02Z

Can you make sure all of the green buttons are using our large button size? Thanks!

fabioh8010 · 2024-06-19T18:22:28Z

@pac-guerreiro We got merge conflicts

src/pages/RestrictedAction/Workspace/WorkspaceRestrictedActionPage.tsx

# Conflicts: # src/libs/ReportUtils.ts

hoangzinh · 2024-06-20T10:36:02Z

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

Screen.Recording.2024-06-20.at.18.18.10.android.mov

Android: mWeb Chrome

Screen.Recording.2024-06-20.at.18.14.15.android.chrome.mov

iOS: Native

Screen.Recording.2024-06-20.at.18.23.02.ios.mov

iOS: mWeb Safari

Screen.Recording.2024-06-20.at.18.21.52.ios.safari.mov

MacOS: Chrome / Safari

Screen.Recording.2024-06-20.at.17.55.47.web.mov

MacOS: Desktop

Screen.Recording.2024-06-20.at.18.11.00.desktop.mov

hoangzinh · 2024-06-20T11:03:13Z

Bug 1: Text in Spanish is cut off

pac-guerreiro · 2024-06-20T11:19:59Z

@shawnborton any suggestion on how to handle the situation reported above?

shawnborton · 2024-06-20T15:13:37Z

^ Addressed that comment via Slack.

hoangzinh · 2024-06-20T20:30:46Z

@pac-guerreiro Your turn. We nearly done

pac-guerreiro · 2024-06-21T08:04:23Z

@hoangzinh sorry for the delay, it's is done! 😄

chiragsalian

Very nice, thank you for the changes. Code LGTM. I just left a minor comment update.
Not a blocker so I'll proceed and merge. If possible can you address the comment in a follow up.

chiragsalian · 2024-06-24T20:37:03Z

src/libs/PolicyUtils.ts

@@ -153,6 +153,12 @@ function isExpensifyTeam(email: string | undefined): boolean {
 const isPolicyAdmin = (policy: OnyxInputOrEntry<Policy> | EmptyObject, currentUserLogin?: string): boolean =>
    (policy?.role ?? (currentUserLogin && policy?.employeeList?.[currentUserLogin]?.role)) === CONST.POLICY.ROLE.ADMIN;

+/**
+ * Checks if the current user is an user of the policy.


I find this weird to read current user is an user. Maybe making it more verbose like so would be easier to read,

Suggested change

* Checks if the current user is an user of the policy.

* Checks if the current user is of the role "user" on the policy.

@chiragsalian

Thank you for the suggestion!

I applied it here - https://github.com/Expensify/App/pull/44371/files#diff-89601c1d4ab7d6fb789ea45b8f8e16ead0f925cf0db25d9b5c3561816d7a94c1R157

OSBotify · 2024-06-24T21:12:56Z

✋ 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-06-25T20:09:22Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.0.2-0 🚀

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

OSBotify · 2024-07-03T19:38:30Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.0.3-7 🚀

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

OSBotify · 2024-07-10T10:56:47Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.0.5-13 🚀

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

feature: add workspace restricted action screen

778d9cf

pac-guerreiro requested review from a team as code owners June 17, 2024 17:42

melvin-bot bot requested review from hoangzinh and removed request for a team June 17, 2024 17:42

kubabutkiewicz reviewed Jun 18, 2024

View reviewed changes

src/pages/RestrictedAction/Workspace/WorkspaceRestrictedActionPage.tsx Outdated Show resolved Hide resolved