Skip to content

Refactored localeCompare in TagsOptionsListUtils #67397

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.

Sign up for GitHub

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

Merged
tgolen merged 2 commits into from
Jul 31, 2025
Merged

Refactored localeCompare in TagsOptionsListUtils #67397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18c4896
Refactored localeCompare in TagsOptionsListUtils
shubham1206agra Jul 30, 2025
df89d74
Merge branch 'main' into refactor-onyx-10
shubham1206agra Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/components/TagPicker/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ function TagPicker({
selectedOptions,
tags: enabledTags,
recentlyUsedTags: policyRecentlyUsedTagsList,
localeCompare,
});
return shouldOrderListByTagName
? tagSections.map((option) => ({
Expand Down
8 changes: 5 additions & 3 deletions src/libs/TagsOptionsListUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type {OnyxEntry} from 'react-native-onyx';
import type {LocaleContextProps} from '@components/LocaleContextProvider';
import CONST from '@src/CONST';
import type {Policy, PolicyTag, PolicyTagLists, PolicyTags, Transaction} from '@src/types/onyx';
import type {PendingAction} from '@src/types/onyx/OnyxCommon';
import localeCompare from './LocaleCompare';
import {translateLocal} from './Localize';
import {hasEnabledOptions} from './OptionsListUtils';
import type {Option} from './OptionsListUtils';
Expand Down Expand Up @@ -52,19 +52,21 @@ function getTagsOptions(tags: Array<Pick<PolicyTag, 'name' | 'enabled' | 'pendin
*/
function getTagListSections({
tags,
localeCompare,
recentlyUsedTags = [],
selectedOptions = [],
searchValue = '',
maxRecentReportsToShow = CONST.IOU.MAX_RECENT_REPORTS_TO_SHOW,
}: {
tags: PolicyTags | Array<SelectedTagOption | PolicyTag>;
localeCompare: LocaleContextProps['localeCompare'];
recentlyUsedTags?: string[];
selectedOptions?: SelectedTagOption[];
searchValue?: string;
maxRecentReportsToShow?: number;
}) {
const tagSections = [];
const sortedTags = sortTags(tags);
const sortedTags = sortTags(tags, localeCompare);

const selectedOptionNames = selectedOptions.map((selectedOption) => selectedOption.name);
const enabledTags = sortedTags.filter((tag) => tag.enabled);
Expand Down Expand Up @@ -172,7 +174,7 @@ function hasEnabledTags(policyTagList: Array<PolicyTagLists[keyof PolicyTagLists
/**
* Sorts tags alphabetically by name.
*/
function sortTags(tags: Record<string, PolicyTag | SelectedTagOption> | Array<PolicyTag | SelectedTagOption>) {
function sortTags(tags: Record<string, PolicyTag | SelectedTagOption> | Array<PolicyTag | SelectedTagOption>, localeCompare: LocaleContextProps['localeCompare']) {
return Object.values(tags ?? {}).sort((a, b) => localeCompare(a.name, b.name)) as PolicyTag[];
}

Expand Down
22 changes: 12 additions & 10 deletions tests/unit/TagsOptionsListUtilsTest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import IntlStore from '@src/languages/IntlStore';
import type {PolicyTagLists} from '@src/types/onyx';
import createRandomPolicy from '../utils/collections/policies';
import createRandomTransaction from '../utils/collections/transaction';
import {localeCompare} from '../utils/TestHelper';
import waitForBatchedUpdates from '../utils/waitForBatchedUpdates';

describe('TagsOptionsListUtils', () => {
Expand Down Expand Up @@ -335,29 +336,30 @@ describe('TagsOptionsListUtils', () => {
},
];

const smallResult = getTagListSections({searchValue: emptySearch, tags: smallTagsList});
const smallResult = getTagListSections({searchValue: emptySearch, tags: smallTagsList, localeCompare});
expect(smallResult).toStrictEqual(smallResultList);

const smallSearchResult = getTagListSections({searchValue: search, tags: smallTagsList});
const smallSearchResult = getTagListSections({searchValue: search, tags: smallTagsList, localeCompare});
expect(smallSearchResult).toStrictEqual(smallSearchResultList);

const employeeSearchResult = getTagListSections({searchValue: employeeSearch, tags: smallTagsList});
const employeeSearchResult = getTagListSections({searchValue: employeeSearch, tags: smallTagsList, localeCompare});
expect(employeeSearchResult).toStrictEqual(employeeSearchResultList);

const smallWrongSearchResult = getTagListSections({searchValue: wrongSearch, tags: smallTagsList});
const smallWrongSearchResult = getTagListSections({searchValue: wrongSearch, tags: smallTagsList, localeCompare});
expect(smallWrongSearchResult).toStrictEqual(smallWrongSearchResultList);

const largeResult = getTagListSections({searchValue: emptySearch, selectedOptions, tags: largeTagsList, recentlyUsedTags});
const largeResult = getTagListSections({searchValue: emptySearch, selectedOptions, tags: largeTagsList, recentlyUsedTags, localeCompare});
expect(largeResult).toStrictEqual(largeResultList);

const largeSearchResult = getTagListSections({searchValue: search, selectedOptions, tags: largeTagsList, recentlyUsedTags});
const largeSearchResult = getTagListSections({searchValue: search, selectedOptions, tags: largeTagsList, recentlyUsedTags, localeCompare});
expect(largeSearchResult).toStrictEqual(largeSearchResultList);

const largeWrongSearchResult = getTagListSections({
searchValue: wrongSearch,
selectedOptions,
tags: largeTagsList,
recentlyUsedTags,
localeCompare,
});
expect(largeWrongSearchResult).toStrictEqual(largeWrongSearchResultList);
});
Expand All @@ -369,13 +371,13 @@ describe('TagsOptionsListUtils', () => {
const expectedOrderNames = ['!', '@', '#', '$', '0', '0a', '1', '2', '3', '10', '10bc', '20', '20a', 'a', 'a1', 'a20', 'b', 'b1', 'b10', 'c', '中国', '日本'];
const unorderedTags = createTagObjects(unorderedTagNames);
const expectedOrder = createTagObjects(expectedOrderNames);
expect(sortTags(unorderedTags)).toStrictEqual(expectedOrder);
expect(sortTags(unorderedTags, localeCompare)).toStrictEqual(expectedOrder);

@shubham1206agra shubham1206agra Jul 31, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@tgolen There are tests written like here

@tgolen tgolen Jul 31, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

ohhhhh, I see. Thanks for pointing them out. OK, yes. This is just what I wanted. Sorry I missed them!


const unorderedTagNames2 = ['0', 'a1', '1', 'b1', '3', '10', 'b10', 'a', '2', 'c', '20', 'a20', 'b'];
const expectedOrderNames2 = ['0', '1', '2', '3', '10', '20', 'a', 'a1', 'a20', 'b', 'b1', 'b10', 'c'];
const unorderedTags2 = createTagObjects(unorderedTagNames2);
const expectedOrder2 = createTagObjects(expectedOrderNames2);
expect(sortTags(unorderedTags2)).toStrictEqual(expectedOrder2);
expect(sortTags(unorderedTags2, localeCompare)).toStrictEqual(expectedOrder2);

const unorderedTagNames3 = [
'61',
Expand Down Expand Up @@ -583,7 +585,7 @@ describe('TagsOptionsListUtils', () => {
];
const unorderedTags3 = createTagObjects(unorderedTagNames3);
const expectedOrder3 = createTagObjects(expectedOrderNames3);
expect(sortTags(unorderedTags3)).toStrictEqual(expectedOrder3);
expect(sortTags(unorderedTags3, localeCompare)).toStrictEqual(expectedOrder3);
});

it('sortTags by object works the same', () => {
Expand All @@ -607,7 +609,7 @@ describe('TagsOptionsListUtils', () => {
},
};

const sorted = sortTags(tagsObject.tags);
const sorted = sortTags(tagsObject.tags, localeCompare);
expect(Array.isArray(sorted)).toBe(true);
// Expect to be sorted alphabetically
expect(sorted.at(0)?.name).toBe('Car');
Expand Down
Loading