Fix incorrect ordering of subcategories #29281

rezkiy37 · 2023-10-11T10:29:19Z

Details

The PR fixes the ordering of categories and sub-categories.

Fixed Issues

$ #28964
PROPOSAL: N/A

Tests

Advice: before testing, please prepare a few workspaces with varying category lengths (<8 and >=8), levels of nesting, and sorting. There are no restrictions. Use OldDot to manipulate the category lists.

Initiate the money request flow with a workspace.
Open the categories page.
Verify that categories are properly nested in a parent: child relationship.
Ensure all subcategories are sorted alphabetically. The most "parent" categories are not required to be sorted alphabetically.

Verify that no errors appear in the JS console

Offline tests

Same as "Tests".

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
  - 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 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
- 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(themeColors.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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android.Large.mov

Android: mWeb Chrome

Android.Chrome.Large.mov

iOS: Native

IOS.Large.mov

iOS: mWeb Safari

IOS.Safari.Large.mov

MacOS: Chrome / Safari

MacOS: Desktop

Desktop.Large.mov

…/28964-incorrect-ordering-subcategories

src/libs/OptionsListUtils.js

rezkiy37 · 2023-10-16T17:01:48Z

@BeeMargarida, I've applied your suggestions 🙂

melvin-bot · 2023-10-16T17:51:49Z

@cubuspl42 @puneetlath One of you needs to 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]

puneetlath · 2023-10-17T18:43:31Z

@cubuspl42 mind providing an ETA for when you'll be able to review? This is the last issue keeping us from removing the Categories beta and opening the feature to everyone, so I'm eager to finish 😄

cubuspl42 · 2023-10-17T18:46:47Z

@puneetlath Would tomorrow morning (in ~12 hours from now) work for you?

puneetlath · 2023-10-17T18:50:10Z

Yes, that works. Thanks!

src/libs/OptionsListUtils.js

cubuspl42 · 2023-10-18T07:10:11Z

src/libs/OptionsListUtils.js

+    const hierarchy = {};
+
+    _.each(categories, (category) => {
+        const path = category.name.replaceAll(CONST.PARENT_CHILD_SEPARATOR, '.');


Is dot (.) a forbidden character in the category name?

Perhaps, but path is not a category name anymore. It is keys for hierarchy's object.

What I meant is if it's guranateed that category.name doesn't contain dots.

Example: Movies: Mr. Nobody -> Movies . Mr . Nobody

If you're not sure that Mr. Nobody is not an invalid category name part, it would be a good idea to add such case to unit tests

I got you. Actually, a good catch!
We need to test this case 🧐

@cubuspl42, I've added logic to handle the case - 21a25fa.

cubuspl42 · 2023-10-20T17:33:18Z

@rezkiy37 can you help me understand how the sorting works? Why are Parent and Meals under Utilities here?

I understood that this was a non-requirement for top-level categories to be sorted, as this was explicitly noted in tests.

Originally:

The most "parent" categories could not be sorted alphabetically.

After my suggestion to improve the language:

The most "parent" categories are not required to be sorted alphabetically.

cubuspl42 · 2023-10-20T17:33:47Z

But maybe this is misunderstanding, and it actually was required?

puneetlath · 2023-10-20T17:59:34Z

Ohhhh I see. I think this is a misunderstanding and we should sort the top-level categories. Sorry for any confusion!

rezkiy37 · 2023-10-21T11:15:40Z

Okay, I will add this logic for sorting top-level categories.

rezkiy37 · 2023-10-21T11:28:30Z

@puneetlath, in general, the sorting uses a JS feature with objects. It builds an object, where sets each category by path (Parent: Child is being converted to Parent.Child). So, it allows to keep categories uniquely and reserve their nesting.

Example:

// Initial categories come from the backend =
const categories = {
  Movies: {
    name: "Movies",
    enabled: true,
  },
  "Movies: Servant of the People": {
    name: "Movies: Servant of the People",
    enabled: true,
  },
  "Movies: Servant of the People: Season 1: Episode 1": {
    name: "Movies: Servant of the People: Season 1: Episode 1",
    enabled: true,
  },
}

// The app coverts them to hierarchy
const hierarchy = {
  Movies: {
    name: "Movies",
    "Servant of the People": {
      name: "Servant of the People",
      "Season 1": {
        name: "Movies: Servant of the People: Season 1",
        "Episode 1": {
          name: "Movies: Servant of the People: Season 1: Episode 1",
        }
      }
    }
  }
}

After that, the app iterates hierarchy key by key, and takes name. If there are nesting categories (const {name, ...subcategories} = "key"), the app runs sorting for them. Also, on this stage it sorts subcategories alphabetically.

Does it make sense now?

puneetlath · 2023-10-22T16:12:37Z

That makes sense! So then if we just add sorting for the top-level I think we'll be good to go.

…/28964-incorrect-ordering-subcategories

rezkiy37 · 2023-10-23T12:48:42Z

@cubuspl42, @puneetlath, I've added the sorting of top-level categories.
Commit - 354b515.

puneetlath · 2023-10-23T13:57:33Z

Ok great. @cubuspl42 if you can do a quick review, then I can do a final review and we can hopefully get this merged today!

puneetlath · 2023-10-23T13:57:52Z

@rezkiy37 looks like you actually have a failing Jest test.

rezkiy37 · 2023-10-23T14:04:10Z

@puneetlath, sorry, my bad. Just fixed 🙂

cubuspl42 · 2023-10-24T09:01:31Z

src/libs/OptionsListUtils.js

+ */
+function sortCategories(categories) {
+    // Sorts categories alphabetically by name.
+    const sortedCategories = _.values(categories).sort((a, b) => {


https://lodash.com/docs/4.17.15#sortBy

Done - 015cc04.

cubuspl42 · 2023-10-24T09:08:54Z

src/libs/OptionsListUtils.js

+     *   }
+     * }
+     */
+    _.each(sortedCategories, (category) => {


You used _.reduce a few lines later, maybe this would be a bit cleaner if we used reduction instead of mutating the hierarchy object?

Yes, I use the reduction to covert the hierarchy object into a sorted array. Before the reduction, we need do 2 actions:

Sort all categories alphabetically. It helps with top-level categories.

Build the hierarchy object. It helps sort subcategories, keep them uniquely and store initial names.

So, I don't see a variant how to combine these 2 different functions.

I just meant that the hierarchy itself could probably also be built in a mostly functionally-pure way

Hmmm... Could you please share an example?
It is a simple loop right now, where the app sets values one by one. I don't see any concerns with functional programming patterns here.

Okey, let's leave this. I agree that the code is acceptable as-is.

cubuspl42 · 2023-10-24T09:10:21Z

src/libs/OptionsListUtils.js

@@ -796,6 +870,15 @@ function getCategoryListSections(categories, recentlyUsedCategories, selectedOpt
        indexOffset += selectedOptions.length;
    }

+    const selectedOptionNames = _.map(selectedOptions, (selectedOption) => selectedOption.name);
+    const filteredRecentlyUsedCategories = _.chain(recentlyUsedCategories)
+        .filter((categoryName) => !_.includes(selectedOptionNames, categoryName) && lodashGet(categories, `${categoryName}.enabled`, false))


Maybe let's use array-based lodashGet here, as we modify this code (also a few lines later)

I am not sure I understand what you want here.
Should we use lodashGet instead of includes? Actually, selectedOptions and selectedOptionNames are both arrays, therefore lodashGet is not a good choice to iterate here.

lodashGet(categories, `${categoryName}.enabled`)

It's just a follow-up to our earlier conclusions about using lodashGet with a dot-based string argument. The variant which accepts an array is safer when the strings are dynamic.

Ah, okay.
Done - 411db80.

…/28964-incorrect-ordering-subcategories

puneetlath · 2023-10-24T14:47:40Z

Great job!

OSBotify · 2023-10-24T14:52:56Z

✋ 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 · 2023-10-25T17:00:47Z

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.3.91-0 🚀

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

OSBotify · 2023-10-26T22:42:48Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

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

rezkiy37 added 5 commits October 11, 2023 12:24

improve getCategoryOptionTree

7f3e6c8

add one-line test case

bc9b952

fix keys

7ac0ec5

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

99da058

…/28964-incorrect-ordering-subcategories

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

2f3c120

…/28964-incorrect-ordering-subcategories

rezkiy37 mentioned this pull request Oct 12, 2023

[HOLD for payment 2023-11-02] Category IOU - Incorrect ordering of subcategories in the category menu #28964

Closed

6 tasks

rezkiy37 added 6 commits October 15, 2023 15:48

single responsibility of filtering disabled categories

10a5788

create sortCategories helper

c21dc53

use sortCategories helper

638837e

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

44b45a5

…/28964-incorrect-ordering-subcategories

minor grammar fix

ad432b1

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

443cc02

…/28964-incorrect-ordering-subcategories

BeeMargarida reviewed Oct 16, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

improvements

1c447e2

rezkiy37 requested a review from BeeMargarida October 16, 2023 17:01

rezkiy37 marked this pull request as ready for review October 16, 2023 17:51

rezkiy37 requested a review from a team as a code owner October 16, 2023 17:51

melvin-bot bot requested review from cubuspl42 and removed request for a team and BeeMargarida October 16, 2023 17:51

melvin-bot bot requested a review from puneetlath October 16, 2023 17:51

BeeMargarida approved these changes Oct 16, 2023

View reviewed changes

puneetlath reviewed Oct 17, 2023

View reviewed changes

src/libs/OptionsListUtils.js Outdated Show resolved Hide resolved

puneetlath reviewed Oct 17, 2023

View reviewed changes

src/libs/OptionsListUtils.js Show resolved Hide resolved

cubuspl42 reviewed Oct 18, 2023

View reviewed changes

rezkiy37 added 2 commits October 23, 2023 10:45

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

8269bab

…/28964-incorrect-ordering-subcategories

sort top-level category

354b515

expect sorted categories

8a31777

cubuspl42 suggested changes Oct 24, 2023

View reviewed changes

rezkiy37 added 2 commits October 24, 2023 11:14

Merge branch 'main' of https://github.com/rezkiy37/Expensify into fix…

87c35b8

…/28964-incorrect-ordering-subcategories

sort via underscore

015cc04

rezkiy37 requested a review from cubuspl42 October 24, 2023 09:51

use array instead of string in lodashGet

411db80

cubuspl42 approved these changes Oct 24, 2023

View reviewed changes

puneetlath approved these changes Oct 24, 2023

View reviewed changes

puneetlath merged commit a04a01d into Expensify:main Oct 24, 2023

honnamkuan mentioned this pull request Oct 25, 2023

sort category list in alphabetical order #30161

Closed

59 tasks

OSBotify mentioned this pull request Oct 25, 2023

Deploy Checklist: New Expensify 2023-10-25 #30365

Closed

99 tasks

cubuspl42 mentioned this pull request Oct 31, 2023

Category list helpers #25777

Merged

59 tasks

dominictb mentioned this pull request Jul 16, 2024

fix The tag and category lists lack consistent alphabetical order #45236

Merged

50 tasks

Fix incorrect ordering of subcategories #29281

Fix incorrect ordering of subcategories #29281

Conversation

rezkiy37 commented Oct 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rezkiy37 commented Oct 16, 2023

melvin-bot bot commented Oct 16, 2023

puneetlath commented Oct 17, 2023

cubuspl42 commented Oct 17, 2023

puneetlath commented Oct 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cubuspl42 Oct 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cubuspl42 commented Oct 20, 2023

cubuspl42 commented Oct 20, 2023

puneetlath commented Oct 20, 2023

rezkiy37 commented Oct 21, 2023

rezkiy37 commented Oct 21, 2023 • edited Loading

puneetlath commented Oct 22, 2023

rezkiy37 commented Oct 23, 2023

puneetlath commented Oct 23, 2023

puneetlath commented Oct 23, 2023

rezkiy37 commented Oct 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cubuspl42 Oct 24, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

puneetlath commented Oct 24, 2023

OSBotify commented Oct 24, 2023

OSBotify commented Oct 25, 2023

OSBotify commented Oct 26, 2023

rezkiy37 commented Oct 11, 2023 •

edited

Loading

cubuspl42 Oct 18, 2023 •

edited

Loading

rezkiy37 commented Oct 21, 2023 •

edited

Loading

cubuspl42 Oct 24, 2023 •

edited

Loading