Skip to content

[Search v1] Add small followups for sorting in search #42980

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
luacmartins merged 6 commits into from
Jun 5, 2024
Merged

[Search v1] Add small followups for sorting in search #42980

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f2e215b
refactor getting search transaction item data
Kicu Jun 3, 2024
1bc65f9
make category and tag Search columns thinner
Kicu Jun 3, 2024
deb5917
remove temporary transaction key rename
Kicu Jun 4, 2024
808ced7
Merge branch 'main' into kicu/42856-sorting-followups
Kicu Jun 4, 2024
3e23b0e
disable sorting on Search tabs other than ALL
Kicu Jun 5, 2024
38c1293
rename total to amount
Kicu Jun 5, 2024
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
2 changes: 1 addition & 1 deletion src/CONST.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -937,7 +937,7 @@ const CONST = {
TO: 'to',
CATEGORY: 'category',
TAG: 'tag',
TOTAL: 'total',
TOTAL_AMOUNT: 'amount',
TYPE: 'type',
ACTION: 'action',
TAX_AMOUNT: 'taxAmount',
Expand Down
6 changes: 5 additions & 1 deletion src/components/Search.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ type SearchProps = {
sortOrder?: SortOrder;
};

const sortableSearchTabs: SearchQuery[] = [CONST.TAB_SEARCH.ALL];

function isReportListItemType(item: TransactionListItemType | ReportListItemType): item is ReportListItemType {
const reportListItem = item as ReportListItemType;
return reportListItem.transactions !== undefined;
Expand Down Expand Up @@ -100,6 +102,7 @@ function Search({query, policyIDs, sortBy, sortOrder}: SearchProps) {
const ListItem = SearchUtils.getListItem(type);

const data = SearchUtils.getSections(searchResults?.data ?? {}, type);
const sortedData = SearchUtils.getSortedSections(type, data, sortBy, sortOrder);

const onSortPress = (column: SearchColumnType, order: SortOrder) => {
navigation.setParams({
Expand All @@ -108,7 +111,7 @@ function Search({query, policyIDs, sortBy, sortOrder}: SearchProps) {
});
};

const sortedData = SearchUtils.getSortedSections(type, data, sortBy, sortOrder);
const isSortingAllowed = sortableSearchTabs.includes(query);

return (
<SelectionList<ReportListItemType | TransactionListItemType>
Expand All @@ -117,6 +120,7 @@ function Search({query, policyIDs, sortBy, sortOrder}: SearchProps) {
data={searchResults?.data}
onSortPress={onSortPress}
sortOrder={sortOrder}
isSortingAllowed={isSortingAllowed}
sortBy={sortBy}
/>
}
Expand Down
2 changes: 1 addition & 1 deletion src/components/SelectionList/Search/TransactionListItemRow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ function TransactionListItemRow({item, showTooltip, onButtonPress, showItemHeade
</View>
)}

<View style={[StyleUtils.getSearchTableColumnStyles(CONST.SEARCH_TABLE_COLUMNS.TOTAL)]}>
<View style={[StyleUtils.getSearchTableColumnStyles(CONST.SEARCH_TABLE_COLUMNS.TOTAL_AMOUNT)]}>
<TotalCell
showTooltip={showTooltip}
transactionItem={item}
Expand Down
19 changes: 13 additions & 6 deletions src/components/SelectionList/SearchTableHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import SortableHeaderText from './SortableHeaderText';
type SearchColumnConfig = {
columnName: SearchColumnType;
translationKey: TranslationPaths;
isSortable?: boolean;
isColumnSortable?: boolean;
shouldShow: (data: OnyxTypes.SearchResults['data']) => boolean;
};

Expand All @@ -23,7 +23,7 @@ const SearchColumns: SearchColumnConfig[] = [
columnName: CONST.SEARCH_TABLE_COLUMNS.RECEIPT,
translationKey: 'common.receipt',
shouldShow: () => true,
isSortable: false,
isColumnSortable: false,
},
{
columnName: CONST.SEARCH_TABLE_COLUMNS.DATE,
Expand Down Expand Up @@ -66,30 +66,33 @@ const SearchColumns: SearchColumnConfig[] = [
shouldShow: (data: OnyxTypes.SearchResults['data']) => SearchUtils.getShouldShowColumn(data, CONST.SEARCH_TABLE_COLUMNS.TAX_AMOUNT),
},
{
columnName: CONST.SEARCH_TABLE_COLUMNS.TOTAL,
columnName: CONST.SEARCH_TABLE_COLUMNS.TOTAL_AMOUNT,
translationKey: 'common.total',
shouldShow: () => true,
},
{
columnName: CONST.SEARCH_TABLE_COLUMNS.TYPE,
translationKey: 'common.type',
shouldShow: () => true,
isColumnSortable: false,
},
{
columnName: CONST.SEARCH_TABLE_COLUMNS.ACTION,
translationKey: 'common.action',
shouldShow: () => true,
isColumnSortable: false,
},
];

type SearchTableHeaderProps = {
data: OnyxTypes.SearchResults['data'];
sortBy?: SearchColumnType;
sortOrder?: SortOrder;
isSortingAllowed: boolean;
onSortPress: (column: SearchColumnType, order: SortOrder) => void;
};

function SearchTableHeader({data, sortBy, sortOrder, onSortPress}: SearchTableHeaderProps) {
function SearchTableHeader({data, sortBy, sortOrder, isSortingAllowed, onSortPress}: SearchTableHeaderProps) {
const styles = useThemeStyles();
const StyleUtils = useStyleUtils();
const {isSmallScreenWidth, isMediumScreenWidth} = useWindowDimensions();
Expand All @@ -103,9 +106,14 @@ function SearchTableHeader({data, sortBy, sortOrder, onSortPress}: SearchTableHe
return (
<View style={[styles.ph5, styles.pb3]}>
<View style={[styles.flex1, styles.flexRow, styles.gap3, styles.ph4]}>
{SearchColumns.map(({columnName, translationKey, shouldShow, isSortable}) => {
{SearchColumns.map(({columnName, translationKey, shouldShow, isColumnSortable}) => {
if (!shouldShow(data)) {
return null;
}

const isActive = sortBy === columnName;
const textStyle = columnName === CONST.SEARCH_TABLE_COLUMNS.RECEIPT ? StyleUtils.getTextOverflowStyle('clip') : null;
const isSortable = isSortingAllowed && isColumnSortable;

return (
<SortableHeaderText
Expand All @@ -115,7 +123,6 @@ function SearchTableHeader({data, sortBy, sortOrder, onSortPress}: SearchTableHe
sortOrder={sortOrder ?? CONST.SORT_ORDER.ASC}
isActive={isActive}
containerStyle={[StyleUtils.getSearchTableColumnStyles(columnName)]}
shouldShow={shouldShow(data)}
isSortable={isSortable}
onPress={(order: SortOrder) => onSortPress(columnName, order)}
/>
Expand Down
21 changes: 16 additions & 5 deletions src/components/SelectionList/SortableHeaderText.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,34 @@ type SearchTableHeaderColumnProps = {
text: string;
isActive: boolean;
sortOrder: SortOrder;
shouldShow?: boolean;
isSortable?: boolean;
containerStyle?: StyleProp<ViewStyle>;
textStyle?: StyleProp<TextStyle>;
onPress: (order: SortOrder) => void;
};

export default function SortableHeaderText({text, sortOrder, isActive, textStyle, containerStyle, shouldShow = true, isSortable = true, onPress}: SearchTableHeaderColumnProps) {
export default function SortableHeaderText({text, sortOrder, isActive, textStyle, containerStyle, isSortable = true, onPress}: SearchTableHeaderColumnProps) {
const styles = useThemeStyles();
const theme = useTheme();

if (!shouldShow) {
return null;
if (!isSortable) {
return (
<View style={containerStyle}>
<View style={[styles.flexRow, styles.alignItemsCenter, styles.gap1]}>
<Text
numberOfLines={1}
style={[styles.textMicroSupporting, textStyle]}
>
{text}
</Text>
</View>
</View>
);
}

const icon = sortOrder === CONST.SORT_ORDER.ASC ? Expensicons.ArrowUpLong : Expensicons.ArrowDownLong;
const displayIcon = isActive;
const activeColumnStyle = isSortable && isActive && styles.searchTableHeaderActive;

const nextSortOrder = isActive && sortOrder === CONST.SORT_ORDER.DESC ? CONST.SORT_ORDER.ASC : CONST.SORT_ORDER.DESC;

Expand All @@ -46,7 +57,7 @@ export default function SortableHeaderText({text, sortOrder, isActive, textStyle
<View style={[styles.flexRow, styles.alignItemsCenter, styles.gap1]}>
<Text
numberOfLines={1}
style={[styles.textMicroSupporting, textStyle, isActive && styles.searchTableHeaderActive]}
style={[styles.textMicroSupporting, activeColumnStyle, textStyle]}
>
{text}
</Text>
Expand Down
48 changes: 32 additions & 16 deletions src/libs/SearchUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import type {ReportListItemType, TransactionListItemType} from '@components/Sele
import CONST from '@src/CONST';
import ONYXKEYS from '@src/ONYXKEYS';
import type * as OnyxTypes from '@src/types/onyx';
import type {SearchAccountDetails, SearchDataTypes, SearchTypeToItemMap, SectionsType} from '@src/types/onyx/SearchResults';
import type {SearchAccountDetails, SearchDataTypes, SearchPersonalDetails, SearchTransaction, SearchTypeToItemMap, SectionsType} from '@src/types/onyx/SearchResults';
import getTopmostCentralPaneRoute from './Navigation/getTopmostCentralPaneRoute';
import navigationRef from './Navigation/navigationRef';
import type {RootStackParamList, State} from './Navigation/types';
Expand All @@ -21,7 +21,7 @@ const columnNamesToSortingProperty = {
[CONST.SEARCH_TABLE_COLUMNS.DATE]: 'date' as const,
[CONST.SEARCH_TABLE_COLUMNS.TAG]: 'tag' as const,
[CONST.SEARCH_TABLE_COLUMNS.MERCHANT]: 'formattedMerchant' as const,
[CONST.SEARCH_TABLE_COLUMNS.TOTAL]: 'formattedTotal' as const,
[CONST.SEARCH_TABLE_COLUMNS.TOTAL_AMOUNT]: 'formattedTotal' as const,
[CONST.SEARCH_TABLE_COLUMNS.CATEGORY]: 'category' as const,
[CONST.SEARCH_TABLE_COLUMNS.TYPE]: 'type' as const,
[CONST.SEARCH_TABLE_COLUMNS.ACTION]: 'action' as const,
Expand All @@ -30,6 +30,32 @@ const columnNamesToSortingProperty = {
[CONST.SEARCH_TABLE_COLUMNS.RECEIPT]: null,
};

/**
* @private
*/
function getTransactionItemCommonFormattedProperties(
transactionItem: SearchTransaction,
from: SearchPersonalDetails,
to: SearchAccountDetails,
): Pick<TransactionListItemType, 'formattedFrom' | 'formattedTo' | 'formattedTotal' | 'formattedMerchant' | 'date'> {
const isExpenseReport = transactionItem.reportType === CONST.REPORT.TYPE.EXPENSE;

const formattedFrom = from?.displayName ?? from?.login ?? '';
const formattedTo = to?.name ?? to?.displayName ?? to?.login ?? '';
const formattedTotal = TransactionUtils.getAmount(transactionItem, isExpenseReport);
const date = transactionItem?.modifiedCreated ? transactionItem.modifiedCreated : transactionItem?.created;
const merchant = TransactionUtils.getMerchant(transactionItem);
const formattedMerchant = merchant === CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT || merchant === CONST.TRANSACTION.DEFAULT_MERCHANT ? '' : merchant;
Copy link
Contributor

@ishpaul777 ishpaul777 Jan 6, 2025

Choose a reason for hiding this comment

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

coming from #50794 {BZ checklist}, we decided to remove merchant === CONST.TRANSACTION.DEFAULT_MERCHANT check from here


return {
formattedFrom,
formattedTo,
date,
formattedTotal,
formattedMerchant,
};
}

function isSearchDataType(type: string): type is SearchDataTypes {
const searchDataTypes: string[] = Object.values(CONST.SEARCH_DATA_TYPES);
return searchDataTypes.includes(type);
Expand Down Expand Up @@ -69,22 +95,17 @@ function getTransactionsSections(data: OnyxTypes.SearchResults['data']): Transac
? (data[`${ONYXKEYS.COLLECTION.POLICY}${transactionItem.policyID}`] as SearchAccountDetails)
: (data.personalDetailsList?.[transactionItem.managerID] as SearchAccountDetails);

const formattedFrom = from.displayName ?? from.login ?? '';
const formattedTo = to?.name ?? to?.displayName ?? to?.login ?? '';
const formattedTotal = TransactionUtils.getAmount(transactionItem, isExpenseReport);
const date = transactionItem?.modifiedCreated ? transactionItem.modifiedCreated : transactionItem?.created;
const merchant = TransactionUtils.getMerchant(transactionItem);
const formattedMerchant = merchant === CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT || merchant === CONST.TRANSACTION.DEFAULT_MERCHANT ? '' : merchant;
const {formattedFrom, formattedTo, formattedTotal, formattedMerchant, date} = getTransactionItemCommonFormattedProperties(transactionItem, from, to);

return {
...transactionItem,
from,
to,
formattedFrom,
formattedTo,
date,
formattedTotal,
formattedMerchant,
date,
shouldShowMerchant,
shouldShowCategory,
shouldShowTag,
Expand Down Expand Up @@ -119,12 +140,7 @@ function getReportSections(data: OnyxTypes.SearchResults['data']): ReportListIte
? (data[`${ONYXKEYS.COLLECTION.POLICY}${transactionItem.policyID}`] as SearchAccountDetails)
: (data.personalDetailsList?.[transactionItem.managerID] as SearchAccountDetails);

const formattedFrom = from.displayName ?? from.login ?? '';
const formattedTo = to?.name ?? to?.displayName ?? to?.login ?? '';
const formattedTotal = TransactionUtils.getAmount(transactionItem, isExpenseReport);
const date = transactionItem?.modifiedCreated ? transactionItem.modifiedCreated : transactionItem?.created;
const merchant = TransactionUtils.getMerchant(transactionItem);
const formattedMerchant = merchant === CONST.TRANSACTION.PARTIAL_TRANSACTION_MERCHANT || merchant === CONST.TRANSACTION.DEFAULT_MERCHANT ? '' : merchant;
const {formattedFrom, formattedTo, formattedTotal, formattedMerchant, date} = getTransactionItemCommonFormattedProperties(transactionItem, from, to);

const transaction = {
...transactionItem,
Expand All @@ -133,8 +149,8 @@ function getReportSections(data: OnyxTypes.SearchResults['data']): ReportListIte
formattedFrom,
formattedTo,
formattedTotal,
date,
formattedMerchant,
date,
shouldShowMerchant,
shouldShowCategory,
shouldShowTag,
Expand Down
6 changes: 4 additions & 2 deletions src/styles/utils/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1568,12 +1568,14 @@ const createStyleUtils = (theme: ThemeColors, styles: ThemeStyles) => ({
case CONST.SEARCH_TABLE_COLUMNS.MERCHANT:
case CONST.SEARCH_TABLE_COLUMNS.FROM:
case CONST.SEARCH_TABLE_COLUMNS.TO:
columnWidth = styles.flex1;
break;
case CONST.SEARCH_TABLE_COLUMNS.CATEGORY:
case CONST.SEARCH_TABLE_COLUMNS.TAG:
columnWidth = styles.flex1;
columnWidth = {...getWidthStyle(variables.w36), ...styles.flex1};
break;
case CONST.SEARCH_TABLE_COLUMNS.TAX_AMOUNT:
case CONST.SEARCH_TABLE_COLUMNS.TOTAL:
case CONST.SEARCH_TABLE_COLUMNS.TOTAL_AMOUNT:
columnWidth = {...getWidthStyle(variables.w96), ...styles.alignItemsEnd};
break;
case CONST.SEARCH_TABLE_COLUMNS.TYPE:
Expand Down