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

dominictb · 2024-07-11T06:12:27Z

Details

Fixed Issues

$ #44922
PROPOSAL: #44922 (comment)

Tests

Go to workspace/or create one > Categories
Clear all the default categories.
Add a few categories.
Go to workspace tags page.
Add a few tags that have the same key as the categories key in step 3
Verify that in WorkspaceTagsPage and WorkspaceCategoriesPage, the order of the Tags and Categories are the same.

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Screen.Recording.2024-07-11.at.20.20.58.mov

Android: mWeb Chrome

Screen.Recording.2024-07-11.at.20.23.25.mov

iOS: Native

Screen.Recording.2024-07-11.at.20.18.55.mov

iOS: mWeb Safari

Screen.Recording.2024-07-11.at.20.25.14.mov

MacOS: Chrome / Safari

Screen.Recording.2024-07-11.at.17.36.01.mov

MacOS: Desktop

Screen.Recording.2024-07-11.at.17.36.01.mov

melvin-bot · 2024-07-11T10:37:52Z

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

ishpaul777 · 2024-07-12T20:50:31Z

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

Record_2024-07-15-01-58-54.mp4

Android: mWeb Chrome

Record_2024-07-15-02-20-31.mp4

iOS: Native

Screen.Recording.2024-07-13.at.2.59.49.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-07-13.at.2.55.33.AM.mov

MacOS: Chrome / Safari

MacOS: Desktop

Screen.Recording.2024-07-13.at.3.08.04.AM.mov

src/libs/OptionsListUtils.ts

dominictb · 2024-07-17T11:17:09Z

@ishpaul777 PR is updated

dominictb · 2024-07-17T11:22:41Z

Also, I updated the test steps to match the current code changes.

ishpaul777 · 2024-07-17T17:11:46Z

src/pages/workspace/categories/WorkspaceCategoriesPage.tsx

@@ -59,6 +61,7 @@ function WorkspaceCategoriesPage({route}: WorkspaceCategoriesPageProps) {
    const backTo = route.params?.backTo;
    const [policy] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY}${policyId}`);
    const [policyCategories] = useOnyx(`${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policyId}`);
+    const sortedPolicyCategories = lodashSortBy(Object.values(policyCategories ?? {}), 'name', localeCompare) as PolicyCategory[];


is there a reason to sort this outside useMemo @dominictb ?

gentle bump @dominictb

I do it for easier readability

i think we can put this as it is, inside usememo, just so it is memoized we dont sort on every render

@ishpaul777 I updated

ishpaul777 · 2024-07-18T14:24:52Z

Just for clarity, We are aligning sorting behaviour for tags sectionlist, WorkspaceCategories list , WorkspaceTags list. Category list will be as is and its expected behviour since doing it same way broke parent: child list structure in list, Am i correct ? @dominictb

dominictb · 2024-07-19T23:11:16Z

Just for clarity, We are aligning sorting behaviour for tags sectionlist, WorkspaceCategories list , WorkspaceTags list. Category list will be as is and its expected behviour since doing it same way broke parent: child list structure in list, Am i correct

Yes

OSBotify · 2024-07-22T18:58:29Z

✋ 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 · 2024-07-23T08:35:50Z

🚀 Deployed to staging by https://github.com/chiragsalian in version: 9.0.11-0 🚀

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

OSBotify · 2024-07-24T00:16:08Z

🚀 Cherry-picked to staging by https://github.com/francoisl in version: 9.0.11-2 🚀

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

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

OSBotify · 2024-07-25T03:14:33Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.11-5 🚀

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

OSBotify · 2024-07-26T05:13:25Z

🚀 Deployed to production by https://github.com/francoisl in version: 9.0.12-0 🚀

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

dominictb added 4 commits July 11, 2024 13:10

fix The tag and category lists lack consistent alphabetical order

fa5f408

merge main

9b7a14b

fix lint

8027861

fix lint

b16268e

dominictb marked this pull request as ready for review July 11, 2024 10:37

dominictb requested a review from a team as a code owner July 11, 2024 10:37

melvin-bot bot removed the request for review from a team July 11, 2024 10:37

melvin-bot bot requested a review from ishpaul777 July 11, 2024 10:37

fix sorted category issue

932b6b8

dominictb mentioned this pull request Jul 11, 2024

[HOLD for payment 2024-08-01] [$250] Workspace - The tag and category lists lack consistent alphabetical order #44922

Closed

6 tasks

ishpaul777 reviewed Jul 12, 2024

View reviewed changes

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

dominictb added 4 commits July 16, 2024 16:44

merge main

83085ce

add comment

fa58232

merge main

2a57a74

revert change in sortCategories

deb54bc

ishpaul777 reviewed Jul 17, 2024

View reviewed changes

dominictb added 2 commits July 22, 2024 17:16

merge latest main

28fc5de

remove sortedPolicyCategories

4d06761

ishpaul777 approved these changes Jul 22, 2024

View reviewed changes

melvin-bot bot requested a review from chiragsalian July 22, 2024 12:51

chiragsalian approved these changes Jul 22, 2024

View reviewed changes

chiragsalian merged commit 757a6ac into Expensify:main Jul 22, 2024
16 checks passed

github-actions bot mentioned this pull request Jul 23, 2024

Deploy Checklist: New Expensify 2024-07-23 #45991

Closed

95 tasks

dominictb deleted the fix/44922 branch August 21, 2024 02:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

dominictb commented Jul 11, 2024 •

edited

Loading

melvin-bot bot commented Jul 11, 2024

ishpaul777 commented Jul 12, 2024 •

edited

Loading

dominictb commented Jul 17, 2024

dominictb commented Jul 17, 2024

ishpaul777 Jul 17, 2024 •

edited

Loading

ishpaul777 Jul 18, 2024

dominictb Jul 19, 2024

ishpaul777 Jul 21, 2024 •

edited

Loading

dominictb Jul 22, 2024

ishpaul777 commented Jul 18, 2024 •

edited

Loading

dominictb commented Jul 19, 2024

OSBotify commented Jul 22, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

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

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

Conversation

dominictb commented Jul 11, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jul 11, 2024

ishpaul777 commented Jul 12, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

dominictb commented Jul 17, 2024

dominictb commented Jul 17, 2024

ishpaul777 Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

ishpaul777 Jul 18, 2024

Choose a reason for hiding this comment

dominictb Jul 19, 2024

Choose a reason for hiding this comment

ishpaul777 Jul 21, 2024 • edited Loading

Choose a reason for hiding this comment

dominictb Jul 22, 2024

Choose a reason for hiding this comment

ishpaul777 commented Jul 18, 2024 • edited Loading

dominictb commented Jul 19, 2024

OSBotify commented Jul 22, 2024

OSBotify commented Jul 23, 2024

OSBotify commented Jul 24, 2024

OSBotify commented Jul 25, 2024

OSBotify commented Jul 26, 2024

dominictb commented Jul 11, 2024 •

edited

Loading

ishpaul777 commented Jul 12, 2024 •

edited

Loading

ishpaul777 Jul 17, 2024 •

edited

Loading

ishpaul777 Jul 21, 2024 •

edited

Loading

ishpaul777 commented Jul 18, 2024 •

edited

Loading