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/categories bulk actions #37734

Merged
merged 39 commits into from
Mar 13, 2024

Conversation

ArekChr
Copy link
Contributor

@ArekChr ArekChr commented Mar 5, 2024

Details

This PR adds the ability to perform bulk actions on categories, such as disable, enable, or remove multiple categories at once.

image

Fixed Issues

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

Tests

  • Verify that no errors appear in the JS console
  1. Log in as an admin of a paid policy group and navigate to the workspace categories settings.
  2. Choose some categories that are currently disabled.
  3. Click the options menu in the top right corner and select "Enable Categories".
  4. Confirm that the selected categories are now enabled.
  5. Choose some categories that are currently enabled.
  6. Click the options menu in the top right corner again and select "Disable Categories".
  7. Check that these categories are now disabled.
  8. Choose any categories you wish to delete.
  9. In the top right corner, click the options menu and choose "Delete Categories".
  10. Verify that the selected categories have been deleted.

Network Failures Test

  1. Log in as the admin of a paid policy group.
  2. Go to profile settings, then navigate to "About" -> "Troubleshooting" and enable "Simulate Network Failures".
  3. Go to the workspace categories settings.
  4. Select some categories, whether they are currently disabled or enabled.
  5. Use the options menu in the top right corner to either enable or disable the selected categories.
  6. Wait for a moment, then look for an error message to appear under each category you tried to update, indicating a request failure.
  7. Repeat steps 3 to 6 for the action of deleting categories.

Offline tests

Here are the simplified and clarified test steps:

  1. Log in as an admin of a paid policy group and open the workspace categories settings.
  2. Disable your internet connection.
  3. Choose some categories that are currently disabled.
  4. Click the options menu in the top right corner and select "Enable Categories".
  5. Check that the selected categories now appear as pending (shown in gray).
  6. Choose some categories that are currently enabled.
  7. Click the options menu in the top right corner again and select "Disable Categories".
  8. Ensure that these categories now show as pending (in gray).
  9. Select any categories you want to delete.
  10. In the top right corner, click the options menu and choose "Delete Categories".
  11. Confirm that the chosen categories are marked as pending (grayed out) and have a strikethrough.
  12. Reconnect to the internet and verify that:
    • Categories that were pending disable are now enabled.
    • Categories that were pending enable are now disabled.
    • Categories marked for deletion are removed.

QA Steps

The same steps as above.

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
mobile.chrome.mov
Android: mWeb Chrome
android.mov
iOS: Native
ios.mov
iOS: mWeb Safari
ios.safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@ArekChr ArekChr marked this pull request as ready for review March 6, 2024 12:23
@ArekChr ArekChr requested a review from a team as a code owner March 6, 2024 12:23
@melvin-bot melvin-bot bot requested review from akinwale and removed request for a team March 6, 2024 12:23
Copy link

melvin-bot bot commented Mar 6, 2024

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

Copy link
Contributor

@rezkiy37 rezkiy37 left a comment

Choose a reason for hiding this comment

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

Left comments.

assets/images/documentSlash.svg Outdated Show resolved Hide resolved
src/libs/actions/Policy.ts Outdated Show resolved Hide resolved
src/pages/workspace/categories/WorkspaceCategoriesPage.tsx Outdated Show resolved Hide resolved
src/pages/workspace/categories/WorkspaceCategoriesPage.tsx Outdated Show resolved Hide resolved
@ArekChr
Copy link
Contributor Author

ArekChr commented Mar 6, 2024

@luacmartins There is an issue with the openWorkspace API call that seems to override pending actions for categories. Specifically, when a category is removed while offline, and then the page is reloaded or, on mobile, when navigating back and reopening the categories list, the action no longer appears as pending.

@ArekChr
Copy link
Contributor Author

ArekChr commented Mar 11, 2024

@ArekChr A couple things for dealing with network request failures.

  1. The enabled / disabled state does not revert back to its previous value. Is this expected behaviour?
  2. If a category or multiple categories are deleted, and the request fails, there is nothing to indicate that the operation failed. I assume this isn't as critical, but just want to confirm that this is also expected.

37734-web-network-failure.mp4

@akinwale I encountered the same issue again and after re-logging in, the updated state is still visible despite receiving an error message. It seems the state updates are going through even when we encounter simulation failure requests. Should we consider filing a bug report on this matter? @lucamartins, have you dealt with something similar in your experience?

@luacmartins
Copy link
Contributor

@ArekChr we have conflicts again

@luacmartins
Copy link
Contributor

@lucamartins, have you dealt with something similar in your experience?

TBH I've never gotten the Simulate failing network requests feature to work reliably. I always throw an error on our dev API to test these. I think we can move forward without blocking on that.

Copy link
Contributor

@akinwale akinwale left a comment

Choose a reason for hiding this comment

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

LGTM.

@melvin-bot melvin-bot bot requested a review from luacmartins March 12, 2024 00:56
luacmartins
luacmartins previously approved these changes Mar 12, 2024
@luacmartins
Copy link
Contributor

@ArekChr more conflicts and TS is failing again

@luacmartins luacmartins merged commit 5ab989b into Expensify:main Mar 13, 2024
15 checks passed
Copy link

melvin-bot bot commented Mar 13, 2024

@luacmartins looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify
Copy link
Contributor

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

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

@luacmartins
Copy link
Contributor

Tests passed when I merged it

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.52-6 🚀

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

@cubuspl42
Copy link
Contributor

Coming from #38262

When a category is disabled while offline, the expected behavior was to make the entire category row grayed out. Only the status column was grayed out.

Comment on lines +3424 to +3427
errors: {
[oldName]: oldName,
[newName]: ErrorUtils.getMicroSecondOnyxError('workspace.tags.genericFailureMessage'),
},
Copy link
Contributor

Choose a reason for hiding this comment

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

This change caused this issue.
We don't need to pass errors separately from tag objects (This is also confirmed by typing and methods for POLICY_TAGS )

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.

9 participants