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

Feat/workspace categories settings #37133

Merged

Conversation

ArekChr
Copy link
Contributor

@ArekChr ArekChr commented Feb 23, 2024

Details

This PR addresses the implementation of the categories settings page, allowing to enable or disable the expense category requirement.

Fixed Issues

$ #35706
PROPOSAL: https://docs.google.com/document/d/1gk3xqOs7epMbUrSSiX8K7YcqfPLVgqEos0sf-D-GMDA/edit#bookmark=id.2cvhhb9mrm8w

Tests

  • Verify that no errors appear in the JS console
    Pre-requisite: an account in the violations beta
  1. Navigate to the workspace settings as an admin within a paid policy group.
  2. Verify that you can access the workspace categories settings page.
  3. Verify that you can disable and enable "categorize all spend" option.
  4. Access workspace settings as a member/admin with a free group policy or member of paid policy group
  5. Replace the sub-path /profile with /categories/settings in the URL.
  6. Confirm that you are unable to access the categories page.
  7. Navigate to Workspace Settings > Collect Workspace > Categories > Settings
  8. Verify that Members must categorize all spend is off
  9. Navigate to the Workspace chat for that Workspace
  10. + > Request money and verify that Category is not required
  11. Navigate to Workspace Settings > Collect Workspace > Categories > Settings
  12. Turn on Members must categorize all spend
  13. Repeat step 4 and verify that category shows up as required (only shown if account is in the violations beta). Note that we can still submit the request without adding a category, this is intended as we don't block the user and instead show a violation after the request is made.
  14. Make the request, verify that there's a RBR icon next to the request and the category shows an error.
Screen.Recording.2024-02-23.at.10.31.36.AM.mov

Offline tests

  1. Switch network off
  2. Go to workspace with paid policy group as a admin
  3. Go to workspace categories settings
  4. toggle on or off "members must categorize all spend"
  5. Switch network on
  6. Verify that toggle has changed and is not "disabled"

QA Steps

Same as tests

  • 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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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
    • 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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.

Screenshots/Videos

Android: Native Zrzut ekranu 2024-02-23 o 14 30 10 Zrzut ekranu 2024-02-23 o 14 30 18
Android: mWeb Chrome Zrzut ekranu 2024-02-23 o 14 33 48 Zrzut ekranu 2024-02-23 o 14 33 41
iOS: Native Zrzut ekranu 2024-02-23 o 14 30 14 Zrzut ekranu 2024-02-23 o 14 30 12
iOS: mWeb Safari Zrzut ekranu 2024-02-23 o 14 31 25 Zrzut ekranu 2024-02-23 o 14 31 27
MacOS: Chrome / Safari
307329869-4164c182-d822-44b4-b21c-983f5a26a8bb.mov
Zrzut ekranu 2024-02-23 o 14 38 58
MacOS: Desktop Zrzut ekranu 2024-02-23 o 14 11 05

@ArekChr ArekChr marked this pull request as ready for review February 23, 2024 13:47
@ArekChr ArekChr requested a review from a team as a code owner February 23, 2024 13:47
@melvin-bot melvin-bot bot requested review from cubuspl42 and removed request for a team February 23, 2024 13:47
Copy link

melvin-bot bot commented Feb 23, 2024

@cubuspl42 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 Feb 23, 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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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-02-27.at.11.46.02.AM.mov
Android: mWeb Chrome
Screen.Recording.2024-02-27.at.11.43.38.AM.mov
iOS: Native
Screen.Recording.2024-02-27.at.11.37.46.AM.mov
iOS: mWeb Safari
Screen.Recording.2024-02-27.at.11.32.51.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2024-02-27.at.11.20.51.AM.mov
Screen.Recording.2024-02-27.at.11.22.52.AM.mov
MacOS: Desktop
Screen.Recording.2024-02-27.at.11.29.01.AM.mov

luacmartins
luacmartins previously approved these changes Feb 23, 2024
Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Nice, changes LGTM. Did some basic testing and things seem to work well. I'm gonna add the following to the test steps:

  1. Navigate to Workspace Settings > Collect Workspace > Categories > Settings
  2. Verify that Members must categorize all spend is off
  3. Navigate to the Workspace chat for that Workspace
  4. + > Request money and verify that Category` is not required
  5. Navigate to Workspace Settings > Collect Workspace > Categories > Settings
  6. Turn on Members must categorize all spend
  7. Repeat step 4 and verify that category shows up as required. Note that we can still submit the request without adding a category, this is intended as we don't block the user and instead show a violation after the request is made.
  8. Make the request, verify that there's a RBR icon next to the request and the category shows an error.
Screen.Recording.2024-02-23.at.10.31.36.AM.mov

@allroundexperts
Copy link
Contributor

allroundexperts commented Feb 23, 2024

BUG

Setting the toggle optimistically does not result in the category option showing up as required.

Screen.Recording.2024-02-23.at.11.11.38.PM.mov

@allroundexperts
Copy link
Contributor

NitPick: I don't see You are offline message being shown anywhere else on the RHN. Are we sure that we want to show it here?

Screenshot 2024-02-23 at 11 10 54 PM

@luacmartins
Copy link
Contributor

@ArekChr we also have conflicts now

@luacmartins luacmartins self-requested a review February 23, 2024 18:27
@allroundexperts
Copy link
Contributor

Even when I am online, the required flag is not showing up for me. I'm using a paid policy with id 1F27FEAE0B1064E5.

Screen.Recording.2024-02-23.at.11.30.38.PM.mov

@luacmartins
Copy link
Contributor

@allroundexperts oh that's weird. I definitely saw the required flag (see my video in the OP). Is the call to SetWorkspaceRequiresCategoryParams returning an error for you?

@allroundexperts
Copy link
Contributor

Getting the following. Let's wait for the conflicts to get resolved I guess?

Screenshot 2024-02-24 at 12 02 30 AM

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 26, 2024

Conflicts resolved

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 26, 2024

NitPick: I don't see You are offline message being shown anywhere else on the RHN. Are we sure that we want to show it here?

You're right, last time i saw in year of birth page but it seems it has been removed, fixing

@cubuspl42
Copy link
Contributor

Will this require a double C+ review? I see that @allroundexperts started working on this

@allroundexperts
Copy link
Contributor

@ArekChr Did you manage to find a solution for #37133 (comment)?

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

Left a comment about the offline styles. Everything else looks good to me.

I'm not seeing the issue with the required flag that @allroundexperts mentioned. It works for me both online and offline.

Screen.Recording.2024-02-26.at.12.12.01.PM.mov

@luacmartins
Copy link
Contributor

@cubuspl42 I think we can let @allroundexperts handle this once since they already got started. Thanks for checking though

@luacmartins luacmartins removed the request for review from cubuspl42 February 26, 2024 19:45
@shawnborton
Copy link
Contributor

Cool, I agree with the prior feedback that the Offline indicator should be at the very bottom of the view.

Otherwise this screen looks good to me:
CleanShot 2024-02-26 at 21 22 24@2x

@allroundexperts
Copy link
Contributor

@ArekChr Are you waiting on translations for the checklist?

@allroundexperts
Copy link
Contributor

On a Paid workspace whose trial is expired, we're showing the option to enforce categories but when requesting money from the workspace, the category does not show up as required. @ArekChr Can you maybe check why is this the case?

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 27, 2024

@ArekChr Did you manage to find a solution for #37133 (comment)?

I have the same issue when setting requires category to true, category is still not required in manual request. Checked that and this is because requires category flag is set to require a logical AND condition together with the canUseViolations flag, I'm not pretty sure what means canUseViolations. cc @luacmartins

const isCategoryRequired = canUseViolations && lodashGet(policy, 'requiresCategory', false);

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 27, 2024

@ArekChr Are you waiting on translations for the checklist?

Translations reviewed, all good!

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 27, 2024

On a Paid workspace whose trial is expired, we're showing the option to enforce categories but when requesting money from the workspace, the category does not show up as required. @ArekChr Can you maybe check why is this the case?

The same as above, I think this relates to canUseViolations flag from permissions

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 27, 2024

Cool, I agree with the prior feedback that the Offline indicator should be at the very bottom of the view.

Otherwise this screen looks good to me: CleanShot 2024-02-26 at 21 22 24@2x

I'm confused again, so do we want to show it at very bottom or remove at all?

Double checked it, we don't show offline indicator in other RHP pages

@shawnborton
Copy link
Contributor

Ah, ignore me then - didn't mean to suggest we add it back if we decided not to include it. Though it does look like we show the offline indicator in the RHP on mobile views as a heads up.

CleanShot 2024-02-27 at 08 02 22@2x

@luacmartins
Copy link
Contributor

luacmartins commented Feb 27, 2024

I have the same issue when setting requires category to true, category is still not required in manual request. Checked that and this is because requires category flag is set to require a logical AND condition together with the canUseViolations flag, I'm not pretty sure what means canUseViolations

Nice find @ArekChr. That's just a check to verify that the user is part of the violations beta, but we can remove that and always show the required flag if requiresCategory = true. NAB though.

Copy link
Contributor

@luacmartins luacmartins left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

Looks good other than the NAB.

@luacmartins
Copy link
Contributor

Hmm actually @JmillsExpensify just mentioned that we should keep that beta check for now. So I'm just gonna update the test steps and I think we're good to merge.

@luacmartins luacmartins merged commit 04644d8 into Expensify:main Feb 27, 2024
17 of 18 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.

@ArekChr
Copy link
Contributor Author

ArekChr commented Feb 28, 2024

🚀

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.4.45-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.45-6 🚀

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

>
<View style={[styles.mt2, styles.mh4]}>
<View style={[styles.flexRow, styles.mb5, styles.mr2, styles.alignItemsCenter, styles.justifyContentBetween]}>
<Text style={[styles.textNormal, styles.colorMuted]}>{translate('workspace.categories.requiresCategory')}</Text>
Copy link
Member

Choose a reason for hiding this comment

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

The text does not wrap properly which caused #38370

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants