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] Add "Rules" Row/toggle to "More Features" page #47083

Merged
merged 24 commits into from
Aug 22, 2024

Conversation

WojtekBoman
Copy link
Contributor

@WojtekBoman WojtekBoman commented Aug 8, 2024

Holding on production deploy:

Details

This PR adds a button to toggle rules on the More Features screen. Now the rules screen only contains empty sections that will be added in the next PRs

Fixed Issues

$ #46935
PROPOSAL:

Tests

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

  • Verify that no errors appear in the JS console
  1. Create a new workspace (from the Workspace switcher or the Settings/Workspaces screen).
  2. Go to the More features screen.
  3. Enable the Rules.
  4. Upgrade your workspace if it's necessary.
  5. The rules screen should now be available.

Offline tests

QA Steps

  1. With an account that is not on the beta verify these new features are not accessible.
  2. With an account that is on the beta verify steps 1-5 from the Tests section.
  • 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-14.at.09.10.56.mov
Android: mWeb Chrome
Screen.Recording.2024-08-14.at.09.18.58.mov
iOS: Native
Screen.Recording.2024-08-14.at.08.42.29.mov
iOS: mWeb Safari
Screen.Recording.2024-08-14.at.08.46.42.mov
MacOS: Chrome / Safari
Screen.Recording.2024-08-14.at.08.50.03.mov
MacOS: Desktop
Screen.Recording.2024-08-14.at.08.58.50.mov

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.

Minor things to clarify, but overall seems fine

src/CONST.ts Outdated Show resolved Hide resolved
src/CONST.ts Show resolved Hide resolved
@WojtekBoman WojtekBoman marked this pull request as ready for review August 14, 2024 12:24
@WojtekBoman WojtekBoman requested review from a team as code owners August 14, 2024 12:24
@melvin-bot melvin-bot bot requested a review from mkhutornyi August 14, 2024 12:24
Copy link

melvin-bot bot commented Aug 14, 2024

@mkhutornyi 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 14, 2024 12:24
@shawnborton
Copy link
Contributor

When you go to upgrade your policy after tapping on the Rules toggle, I would think that the rules toggle should be toggled on automatically as soon as you upgrade. But right now it seems like you have to press the toggle a second time after the upgrade is complete.

@dannymcclain
Copy link
Contributor

When you go to upgrade your policy after tapping on the Rules toggle, I would think that the rules toggle should be toggled on automatically as soon as you upgrade.

Totally agree—was just about to make this comment!

The rules toggle is otherwise looking good to me.

@WojtekBoman
Copy link
Contributor Author

When you go to upgrade your policy after tapping on the Rules toggle, I would think that the rules toggle should be toggled on automatically as soon as you upgrade. But right now it seems like you have to press the toggle a second time after the upgrade is complete.

Thanks for noticing that! It has already been fixed :)

Screen.Recording.2024-08-14.at.15.41.02.mov
Screen.Recording.2024-08-14.at.15.40.33.mov

@marcaaron marcaaron self-requested a review August 14, 2024 23:51
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.

Looks good so far. Had a few small notes. Gonna do some testing.

src/CONST.ts Outdated
@@ -86,6 +86,9 @@ const CONST = {
DEFAULT_TABLE_NAME: 'keyvaluepairs',
DEFAULT_ONYX_DUMP_FILE_NAME: 'onyx-state.txt',
DEFAULT_POLICY_ROOM_CHAT_TYPES: [chatTypes.POLICY_ADMINS, chatTypes.POLICY_ANNOUNCE, chatTypes.DOMAIN_ALL],
EMPTY_MAX_EXPENSE_AMOUNT_NO_RECEIPT: 10000000000,
EMPTY_MAX_EXPENSE_AMOUNT: 10000000000,
EMPTY_MAX_EXPENSE_AGE: 10000000000,
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we call this DISABLED_MAX_EXPENSE_VALUE and just use it for all three of these cases?

@@ -548,6 +550,7 @@ type WriteCommandParameters = {
[WRITE_COMMANDS.REQUEST_EXPENSIFY_CARD_LIMIT_INCREASE]: Parameters.RequestExpensifyCardLimitIncreaseParams;
[WRITE_COMMANDS.CLEAR_OUTSTANDING_BALANCE]: null;
[WRITE_COMMANDS.CANCEL_BILLING_SUBSCRIPTION]: Parameters.CancelBillingSubscriptionParams;

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change

rules: {
individualExpenseRules: {
title: 'Expenses',
subtitle: 'Set spend controls and defaults for individual expenses. You can also create rules for categories and tags.',
Copy link
Contributor

Choose a reason for hiding this comment

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

Did we want "categories" and "tags" to be links?

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, these should be links :) I've already fixed that

Screen.Recording.2024-08-19.at.15.59.16.mov
Screen.Recording.2024-08-19.at.15.58.44.mov

@marcaaron
Copy link
Contributor

In terms of roll out, it might be good to have at least one setting in these cards? Does this look too much like a bug?

2024-08-14_15-42-48

Another option could be to use a beta. But I think it's probably fine to incrementally add more rules as we go.

What do you guys think?

@WojtekBoman
Copy link
Contributor Author

WojtekBoman commented Aug 19, 2024

I hid this feature behind the rules beta, if this beta should have a different name, I'll adjust it.

@marcaaron All comments have been resolved :)

@mkhutornyi
Copy link
Contributor

mkhutornyi commented Aug 19, 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 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.mp4
Android: mWeb Chrome
mchrome.mp4
iOS: Native
ios.mov
iOS: mWeb Safari
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

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.

Still waiting for translations to be reviewed internall. But everything looks good here!

I renamed the rules beta to workspaceRules. We will have to wait some time for the beta changes to reach production.

src/CONST.ts Outdated Show resolved Hide resolved
src/libs/Permissions.ts Outdated Show resolved Hide resolved
src/libs/Permissions.ts Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceInitialPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/WorkspaceInitialPage.tsx Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
src/languages/es.ts Outdated Show resolved Hide resolved
@WojtekBoman
Copy link
Contributor Author

@marcaaron @pecanoro I updated translations and renamed the beta :)

pecanoro
pecanoro previously approved these changes Aug 20, 2024
@marcaaron
Copy link
Contributor

Awesome thanks @pecanoro again for checking the translations 🙇

Just gonna pop a quick hold on here as we need the beta code to get deployed, but everything LGTM @WojtekBoman.

@mkhutornyi looks like you started testing here are you going to review this PR and/or finish testing?

@marcaaron marcaaron changed the title [OldDot Rules Migration] Add "Rules" Row/toggle to "More Features" page [HOLD Web-E #43192] [OldDot Rules Migration] Add "Rules" Row/toggle to "More Features" page Aug 20, 2024
@marcaaron marcaaron self-requested a review August 20, 2024 21:04
marcaaron
marcaaron previously approved these changes Aug 20, 2024
@@ -36,6 +36,10 @@ function canUseNetSuiteUSATax(betas: OnyxEntry<Beta[]>): boolean {
return !!betas?.includes(CONST.BETAS.NETSUITE_USA_TAX) || canUseAllBetas(betas);
}

function canWorkspaceRules(betas: OnyxEntry<Beta[]>): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

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

should this be canUseWorkspaceRules to be consistent with other names?

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, it should be :) I've adjusted it

@WojtekBoman WojtekBoman dismissed stale reviews from marcaaron and pecanoro via 8970dd4 August 21, 2024 14:37
@melvin-bot melvin-bot bot requested a review from marcaaron August 21, 2024 14:43
@marcaaron marcaaron changed the title [HOLD Web-E #43192] [OldDot Rules Migration] Add "Rules" Row/toggle to "More Features" page [OldDot Rules Migration] Add "Rules" Row/toggle to "More Features" page Aug 22, 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.

LGTM. The beta PR should be on production now so pulling out all the stops here! Nice changes overall and also thank you @mkhutornyi for the review and testing 🙇

@marcaaron marcaaron merged commit 174afa7 into Expensify:main Aug 22, 2024
23 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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.25-0 🚀

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

1 similar comment
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/marcaaron in version: 9.0.25-0 🚀

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

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

Successfully merging this pull request may close these issues.

10 participants