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

[OldDot Rules Migration] Category Rules #48171

Merged
merged 37 commits into from
Sep 9, 2024

Conversation

WojtekBoman
Copy link
Contributor

@WojtekBoman WojtekBoman commented Aug 28, 2024

cc: @marcaaron

Details

This PR adds a new section to the Category settings: Category rules. This section allows user to:

  • update the category approver
  • set whether description is required
  • update the description hint
  • update the default tax rate
  • update the flag amounts over field
  • update the require receipt over field

Implementation details on how the actions listed above work can be found here

Fixed Issues

$ #47015
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Precondition:

  • Make sure you have access to the workspaceRules beta. If you run the app locally you can modify the canUseWorkspaceRules or canUseAllBetas function in Permissions.ts to always return true.
  • Enable rules if they are disabled for the selected workspace. This feature can be enabled on the More Features page.
  1. Open the settings of any category.
  2. Check that the buttons in the Category rules section work correctly in offline and online mode (check that values ​​are updated correctly, that the correct screens are opened, etc.)

Offline tests

QA Steps

  • 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
      • 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:
    • 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 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 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.

Screenshots/Videos

Android: Native
Screen.Recording.2024-08-30.at.16.28.19.mp4
Android: mWeb Chrome
Screen.Recording.2024-08-30.at.16.33.34.mov
iOS: Native
Screen.Recording.2024-08-30.at.16.24.41.mp4
iOS: mWeb Safari
Screen.Recording.2024-08-30.at.16.21.56.mp4
MacOS: Chrome / Safari
Screen.Recording.2024-08-30.at.17.18.56.mp4
MacOS: Desktop
Screen.Recording.2024-08-30.at.16.39.39.mov

@WojtekBoman WojtekBoman changed the title Rules/category rules [OldDot Rules Migration] Category Rules Aug 28, 2024
Copy link
Contributor

@BrtqKr BrtqKr left a comment

Choose a reason for hiding this comment

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

Couple small details

getRoute: (policyID: string, categoryName: string) => `settings/workspaces/${policyID}/categories/${encodeURIComponent(categoryName)}/tax-rate` as const,
},
WORSKPACE_CATEGORY_FLAG_AMOUNTS_OVER: {
route: 'settings/workspaces/:policyID/categories/:categoryName/flag-amounts',
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't it be flag-amount as in the design doc table?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is correct, I named it wrong in the design doc, I thought the site was called Flag Amount over. I'll adjust the table in the doc

getRoute: (policyID: string, categoryName: string) => `settings/workspaces/${policyID}/categories/${encodeURIComponent(categoryName)}/require-receipts-over` as const,
},
WORSKPACE_CATEGORY_APPROVER: {
route: 'settings/workspaces/:policyID/categories/:categoryName/approver',
Copy link
Contributor

Choose a reason for hiding this comment

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

i think that the same table is missing the /workspaces/ in the category rules urls

Copy link
Contributor

Choose a reason for hiding this comment

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

@WojtekBoman Did you resolve this comment?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, I've updated the category urls in the doc :)

@@ -429,6 +429,11 @@ const SCREENS = {
CATEGORY_PAYROLL_CODE: 'Category_Payroll_Code',
CATEGORY_GL_CODE: 'Category_GL_Code',
CATEGORY_SETTINGS: 'Category_Settings',
CATEGORY_DEFAULT_TAX_RATE: 'Category_Default_Tax_Rate',
CATEGORY_FLAG_AMOUNTS_OVER: 'Category_Flag_Amounts_Over',
Copy link
Contributor

Choose a reason for hiding this comment

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

as above

src/components/WorkspaceMembersSelectionList.tsx Outdated Show resolved Hide resolved
src/languages/es.ts Show resolved Hide resolved
@WojtekBoman WojtekBoman marked this pull request as ready for review August 30, 2024 15:22
@WojtekBoman WojtekBoman requested a review from a team as a code owner August 30, 2024 15:22
@melvin-bot melvin-bot bot requested a review from dukenv0307 August 30, 2024 15:22
Copy link

melvin-bot bot commented Aug 30, 2024

@dukenv0307 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 melvin-bot bot removed the request for review from a team August 30, 2024 15:22
@dylanexpensify
Copy link
Contributor

bump @dukenv0307 for review!

@melvin-bot melvin-bot bot requested a review from marcaaron September 4, 2024 15:21
@marcaaron
Copy link
Contributor

Going in for the final review now...

@marcaaron Should we be able to reset the approver or default tax rate? I haven't implemented this functionality in terms of selecting the default tax rate, but I've included it when selecting approvers. The second time we click on the currently selected approver, this field will be reset.

I think what you have there for resetting the approver makes sense.

WRT the tax rate. I don't think we need to do anything there. In the old app there are only 3 options to choose from so "none" isn't an option whereas for the approver, yes, they can be removed. Overall, LGTM 👍

marcaaron
marcaaron previously approved these changes Sep 4, 2024
Copy link
Contributor

@marcaaron marcaaron left a comment

Choose a reason for hiding this comment

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

Changes LGTM

@marcaaron marcaaron requested a review from a team September 4, 2024 21:00
@marcaaron
Copy link
Contributor

marcaaron commented Sep 4, 2024

Tagging in Design for a last look as I'm not sure if anyone's had a chance to check these changes yet (running an AdHoc build so maybe @shawnborton or someone can peep this before I hit merge).

This comment has been minimized.

@dubielzyk-expensify
Copy link
Contributor

Sorry if I missed something, but do I have to be in a beta or something? I don't see the approvers in my categories?

@WojtekBoman
Copy link
Contributor Author

WojtekBoman commented Sep 5, 2024

@dubielzyk-expensify Could you send a screenshot? And can you check if the members list is available on the Members page in the workspace settings? (/settings/workspaces/:policyID/members)

@marcaaron
Copy link
Contributor

Yes there is a beta!

Copy link
Contributor

github-actions bot commented Sep 6, 2024

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

Android 🤖 iOS 🍎
❌ FAILED ❌ ❌ FAILED ❌
The QR code can't be generated, because the android build failed The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/48171/NewExpensify.dmg https://48171.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@shawnborton
Copy link
Contributor

Just took this for a spin and it looks pretty good from a design perspective!

marcaaron
marcaaron previously approved these changes Sep 8, 2024
@WojtekBoman
Copy link
Contributor Author

@marcaaron Conflicts solved :)

Copy link
Contributor

@dubielzyk-expensify dubielzyk-expensify 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 for me too. Great work

@marcaaron
Copy link
Contributor

thanks @WojtekBoman. Stellar job here 🙇

@marcaaron marcaaron merged commit 61ee515 into Expensify:main Sep 9, 2024
17 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Sep 9, 2024

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

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

Successfully merging this pull request may close these issues.

9 participants