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

fix: categorize all expense switch is not disabled #39036

Merged
merged 13 commits into from
Apr 3, 2024

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Mar 27, 2024

Details

Fixed Issues

$ #37508
PROPOSAL: #37508 (comment)

Tests

Precondition:

  • User is admin of Collect workspace that has categories.
  • All categories are disabled in the Collect workspace.
  1. Go to workspace settings.
  2. Select the Collect workspace.
  3. Click on Categories.
  4. Disable every categories
  5. Click on Settings.
  6. Verify that "Members must categorize all spend" should be turned off and disabled
  7. Enable at least one category > Settings
  8. Verify that "Members must categorize all spend" can be toggled.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Precondition:

  • User is admin of Collect workspace that has categories.
  • All categories are disabled in the Collect workspace.
  1. Go to workspace settings.
  2. Select the Collect workspace.
  3. Click on Categories.
  4. Disable every categories
  5. Click on Settings.
  6. Verify that "Members must categorize all spend" should be turned off and disabled
  7. Enable at least one category > Settings
  8. Verify that "Members must categorize all spend" can be toggled.
  • 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-03-29.at.11.29.40.mov
Android: mWeb Chrome
Screen.Recording.2024-03-29.at.11.43.00.mov
iOS: Native
Screen.Recording.2024-03-29.at.11.49.53.mov
iOS: mWeb Safari
Screen.Recording.2024-03-29.at.11.45.30.mov
MacOS: Chrome / Safari
Screen.Recording.2024-03-29.at.11.23.43.mov
MacOS: Desktop
Screen.Recording.2024-03-29.at.11.25.27.mov

@tienifr
Copy link
Contributor Author

tienifr commented Mar 27, 2024

  • Currently, we check whether there's any enabled category remaining after the update, if no enabled category remaining, set areCategoriesEnabled as false. That leads to the "Hmmm It 's not here" screen display(see below video) because of this logic:

    const shouldShowNotFoundPage = isEmptyObject(props.policy) || !props.policy?.id || !PolicyUtils.isPolicyFeatureEnabled(props.policy, props.featureName);

  • So I think we should navigate user to another screen in this case (for example, more-feature screen). What do you think @getusha @luacmartins ?

Screen.Recording.2024-03-27.at.19.10.58.mov

@tienifr tienifr marked this pull request as ready for review March 27, 2024 12:16
@tienifr tienifr requested a review from a team as a code owner March 27, 2024 12:16
@melvin-bot melvin-bot bot removed the request for review from a team March 27, 2024 12:16
Copy link

melvin-bot bot commented Mar 27, 2024

@getusha 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 requested a review from getusha March 27, 2024 12:16
@tienifr tienifr changed the title fix categorize all expense switch is not disabled fix: categorize all expense switch is not disabled Mar 27, 2024
@luacmartins luacmartins self-requested a review March 27, 2024 15:57
@luacmartins
Copy link
Contributor

@tienifr yes, I think navigating to the more features page makes sense in this case. cc @JmillsExpensify

src/libs/actions/Policy.ts Show resolved Hide resolved
src/libs/actions/Policy.ts Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
@getusha
Copy link
Contributor

getusha commented Mar 27, 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
Screen.Recording.2024-04-03.at.6.31.00.in.the.evening.mov
Android: mWeb Chrome
Screen.Recording.2024-04-02.at.10.09.04.at.night.mov
iOS: Native
Screen.Recording.2024-04-02.at.10.32.24.at.night.mov
iOS: mWeb Safari
Screen.Recording.2024-04-02.at.10.28.15.at.night.mov
MacOS: Chrome / Safari
Screen.Recording.2024-04-02.at.9.20.24.at.night.mov
MacOS: Desktop
Screen.Recording.2024-04-03.at.6.37.24.in.the.evening.mov

@getusha
Copy link
Contributor

getusha commented Mar 27, 2024

Currently, we check whether there's any enabled category remaining after the update, if no enabled category remaining, set areCategoriesEnabled as false. That leads to the "Hmmm It 's not here" screen display(see below video) because of this logic:

I think we should fix this behavior, it doesn't seem to be something we can ignore. if it is not possible lets use other alternatives.

Screen.Recording.2024-03-27.at.11.13.37.at.night.mov

@luacmartins
Copy link
Contributor

Yea, let's navigate the user to the more features page

@getusha
Copy link
Contributor

getusha commented Mar 28, 2024

Yea, let's navigate the user to the more features page

@luacmartins Is this ideal? i don't see the need to navigate away to that page. it'll definitely be logged as a bug.

@tienifr
Copy link
Contributor Author

tienifr commented Mar 28, 2024

@getusha @luacmartins I resolved all the comments

@luacmartins
Copy link
Contributor

luacmartins commented Mar 28, 2024

cc @JmillsExpensify what do you think? What should happen when the user disables the last enabled category? Currently we also turn off the categories features (since that's what we do in OldDot), but then they see the not found page.

@luacmartins luacmartins self-requested a review March 28, 2024 15:01
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.

One minor comment and we're also pending confirmation on the desired behavior

return acc;
}, {}),
};
const shouldTurnOffCategoriesEnabled = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});
Copy link
Contributor

@luacmartins luacmartins Mar 28, 2024

Choose a reason for hiding this comment

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

Suggested change
const shouldTurnOffCategoriesEnabled = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});
const shouldDisableRequiresCategory = !OptionsListUtils.hasEnabledOptions({...policyCategories, ...optimisticPolicyCategoriesData});

@luacmartins
Copy link
Contributor

@tienifr @getusha we discussed this internally and the toggle that's switched off in OldDot is All members must categorize expenses. OldDot does not have a feature toggle for the whole Categories page, so we should not disable areCategoriesEnabled and just disable requiresCategories instead

src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
@tienifr
Copy link
Contributor Author

tienifr commented Mar 29, 2024

@luacmartins I resolved all your comments

@tienifr
Copy link
Contributor Author

tienifr commented Mar 29, 2024

Also, I updated screenshots and test steps

luacmartins
luacmartins previously approved these changes Mar 29, 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.

@getusha all yours. Let's get this one merged!

@luacmartins
Copy link
Contributor

@getusha did @tienifr's last comment address your concern?

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.

Just one small comment.

const styles = useThemeStyles();
const {translate} = useLocalize();

const updateWorkspaceRequiresCategory = (value: boolean) => {
setWorkspaceRequiresCategory(route.params.policyID, value);
};

const policyCategoriesCount = OptionsListUtils.getEnabledCategoriesCount(policyCategories ?? {});
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we use OptionsListUtils.hasEnabledOptions too? I think that might be slightly better since it short-circuits the loop if it finds an enabled option.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated to use OptionsListUtils.hasEnabledOptions instead

@getusha
Copy link
Contributor

getusha commented Apr 2, 2024

@getusha did @tienifr's last comment address your concern?

yeah, i think it's fine 👍

luacmartins
luacmartins previously approved these changes Apr 2, 2024
@luacmartins
Copy link
Contributor

Nice! Thanks for updating that! @getusha are you available to continue your review? Let's get this one merged!

@getusha
Copy link
Contributor

getusha commented Apr 2, 2024

@getusha are you available to continue your review?

Yes 🙂

@getusha
Copy link
Contributor

getusha commented Apr 2, 2024

  1. Go to workspace settings.
  2. Select the Collect workspace.
  3. Click on Categories.
  4. Disable every categories
  5. Click on Settings.
  6. Verify that "Members must categorize all spend" should be turned off and disabled
  7. Enable at least one category > Settings
  8. Verify that "Members must categorize all spend" can be toggled.

@tienifr QA steps is not clear, can you update it to something like this?

@tienifr
Copy link
Contributor Author

tienifr commented Apr 2, 2024

@getusha I updated test steps

@getusha
Copy link
Contributor

getusha commented Apr 2, 2024

Members must categorize all spend is enabled without any enabled categories

  1. Enable at least 1 category
  2. Settings > Enable Members must categorize all spend
  3. Go offline
  4. Disable all categories > Settings
  5. Go online
Screen.Recording.2024-04-02.at.8.57.11.in.the.evening.mov

Screenshot 2024-04-02 at 8 55 46 in the evening

@luacmartins It looks like a backend issue

@luacmartins
Copy link
Contributor

I can work on a fix for that in the backend. Let's not block this PR on that

@@ -2938,6 +2941,37 @@ function setWorkspaceCategoryEnabled(policyID: string, categoriesToUpdate: Recor
},
],
};
if (shouldDisableRequiresCategory) {
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 do the same for deleteWorkspaceCategories?

function deleteWorkspaceCategories(policyID: string, categoryNamesToDelete: string[]) {

Screen.Recording.2024-04-02.at.9.55.11.at.night.mov

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated to do the same when deleting category

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice catch!

luacmartins
luacmartins previously approved these changes Apr 3, 2024
@@ -826,8 +826,8 @@ function getSearchValueForPhoneOrEmail(searchTerm: string) {
/**
* Verifies that there is at least one enabled option
*/
function hasEnabledOptions(options: PolicyCategories | PolicyTag[]): boolean {
return Object.values(options).some((option) => option.enabled);
function hasEnabledOptions(options: PolicyCategories | PolicyTag[], shouldContainPendingDeleteOption = true): boolean {
Copy link
Contributor

Choose a reason for hiding this comment

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

Why do we need shouldContainPendingDeleteOption? Don't we always want to include those?

Copy link
Contributor Author

@tienifr tienifr Apr 3, 2024

Choose a reason for hiding this comment

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

If we do not use shouldContainPendingDeleteOption: Assume that all our categories are enabled. If we go offline and then delete all our categories, the hasEnabledOptions still returns true, which leads to the user still can toggle the "Required categories" switch

Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, but that's what I meant. Don't we always want to filter our pending delete categories when checking for hasEnabledOptions?

Copy link
Contributor

Choose a reason for hiding this comment

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

Correct, but that's what I meant. Don't we always want to filter our pending delete categories when checking for hasEnabledOptions?

+1

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated based on this suggestion

@luacmartins luacmartins requested a review from getusha April 3, 2024 15:31
@melvin-bot melvin-bot bot requested a review from luacmartins April 3, 2024 15:55
@luacmartins luacmartins merged commit 838206f into Expensify:main Apr 3, 2024
18 checks passed
@OSBotify
Copy link
Contributor

OSBotify commented Apr 3, 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.

@OSBotify
Copy link
Contributor

OSBotify commented Apr 8, 2024

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

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 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.

5 participants