Merge pull request Expensify#81127 from shubham1206agra/groupBy-cleanup

Fixed required columns list + Fixed parser for default sortBy and column name parsing

Author: cristipaval

src/libs/SearchParser/autocompleteParser.js

@@ -559,10 +559,10 @@ function peg$parse(input, options) {
   var peg$f78 = function() { return "groupCategory"; };
   var peg$f79 = function() { return "groupTag"; };
   var peg$f80 = function() { return "groupMerchant"; };
-  var peg$f81 = function() { return "groupMonth"; };
-  var peg$f82 = function() { return "groupWeek"; };
-  var peg$f83 = function() { return "groupYear"; };
-  var peg$f84 = function() { return "groupQuarter"; };
+  var peg$f81 = function() { return "groupmonth"; };
+  var peg$f82 = function() { return "groupweek"; };
+  var peg$f83 = function() { return "groupyear"; };
+  var peg$f84 = function() { return "groupquarter"; };
   var peg$f85 = function() { return "eq"; };
   var peg$f86 = function() { return "neq"; };
   var peg$f87 = function() { return "gte"; };

src/libs/SearchParser/baseRules.peggy

@@ -146,10 +146,10 @@ groupWithdrawalId       = "group-withdrawal-id"i &wordBoundary      { return "gr
 groupCategory           = "group-category"i &wordBoundary          { return "groupCategory"; }
 groupTag                = "group-tag"i &wordBoundary               { return "groupTag"; }
 groupMerchant           = "group-merchant"i &wordBoundary          { return "groupMerchant"; }
-groupMonth              = "group-month"i &wordBoundary              { return "groupMonth"; }
-groupWeek               = "group-week"i &wordBoundary               { return "groupWeek"; }
-groupYear               = "group-year"i &wordBoundary               { return "groupYear"; }
-groupQuarter            = "group-quarter"i &wordBoundary            { return "groupQuarter"; }
+groupMonth              = "group-month"i &wordBoundary              { return "groupmonth"; }
+groupWeek               = "group-week"i &wordBoundary               { return "groupweek"; }
+groupYear               = "group-year"i &wordBoundary               { return "groupyear"; }
+groupQuarter            = "group-quarter"i &wordBoundary            { return "groupquarter"; }
 
 
 operator "operator"

src/libs/SearchParser/searchParser.js

@@ -586,10 +586,10 @@ function peg$parse(input, options) {
   var peg$f79 = function() { return "groupCategory"; };
   var peg$f80 = function() { return "groupTag"; };
   var peg$f81 = function() { return "groupMerchant"; };
-  var peg$f82 = function() { return "groupMonth"; };
-  var peg$f83 = function() { return "groupWeek"; };
-  var peg$f84 = function() { return "groupYear"; };
-  var peg$f85 = function() { return "groupQuarter"; };
+  var peg$f82 = function() { return "groupmonth"; };
+  var peg$f83 = function() { return "groupweek"; };
+  var peg$f84 = function() { return "groupyear"; };
+  var peg$f85 = function() { return "groupquarter"; };
   var peg$f86 = function() { return "eq"; };
   var peg$f87 = function() { return "neq"; };
   var peg$f88 = function() { return "gte"; };
@@ -4493,11 +4493,11 @@ function peg$parse(input, options) {
 
 
   const GROUP_BY_DEFAULT_SORT = {
-    from: "from",
-    card: "card",
-    "withdrawal-id": "withdrawn",
+    from: "groupFrom",
+    card: "groupCard",
+    "withdrawal-id": "groupWithdrawn",
     category: "groupCategory",
-    tag: "tag",
+    tag: "groupTag",
     merchant: "groupMerchant",
     month: "groupmonth",
     week: "groupweek",

src/libs/SearchParser/searchParser.peggy

@@ -29,11 +29,11 @@
 // per-parser initializer (code executed before every parse)
 {  
   const GROUP_BY_DEFAULT_SORT = {
-    from: "from",
-    card: "card",
-    "withdrawal-id": "withdrawn",
+    from: "groupFrom",
+    card: "groupCard",
+    "withdrawal-id": "groupWithdrawn",
     category: "groupCategory",
-    tag: "tag",
+    tag: "groupTag",
     merchant: "groupMerchant",
     month: "groupmonth",
     week: "groupweek",

src/pages/Search/SearchColumnsPage.tsx

@@ -65,6 +65,9 @@ function SearchColumnsPage() {
         CONST.SEARCH.TABLE_COLUMNS.GROUP_MERCHANT,
         CONST.SEARCH.TABLE_COLUMNS.GROUP_TAG,
         CONST.SEARCH.TABLE_COLUMNS.GROUP_MONTH,
+        CONST.SEARCH.TABLE_COLUMNS.GROUP_WEEK,
+        CONST.SEARCH.TABLE_COLUMNS.GROUP_YEAR,
+        CONST.SEARCH.TABLE_COLUMNS.GROUP_QUARTER,
     ]);
 
     const sortColumns = (columnsToSort: ColumnItem[]): ColumnItem[] => {

src/styles/utils/index.ts

@@ -1769,6 +1769,7 @@ const createStyleUtils = (theme: ThemeColors, styles: ThemeStyles) => ({
             case CONST.SEARCH.TABLE_COLUMNS.GROUP_YEAR:
             case CONST.SEARCH.TABLE_COLUMNS.GROUP_QUARTER:
             case CONST.SEARCH.TABLE_COLUMNS.TAG:
+            case CONST.SEARCH.TABLE_COLUMNS.GROUP_TAG:
                 columnWidth = {...getWidthStyle(variables.w36), ...styles.flex1};
                 break;
             case CONST.SEARCH.TABLE_COLUMNS.TAX_AMOUNT:

tests/unit/SearchParserTest.ts

@@ -544,6 +544,126 @@ const tests = [
             },
         },
     },
+    {
+        query: 'type:expense group-by:from',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_FROM,
+            sortOrder: CONST.SEARCH.SORT_ORDER.ASC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.FROM,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:card',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_CARD,
+            sortOrder: CONST.SEARCH.SORT_ORDER.ASC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.CARD,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:withdrawal-id',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_WITHDRAWN,
+            sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.WITHDRAWAL_ID,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:category',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_CATEGORY,
+            sortOrder: CONST.SEARCH.SORT_ORDER.ASC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.CATEGORY,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:tag',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_TAG,
+            sortOrder: CONST.SEARCH.SORT_ORDER.ASC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.TAG,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:merchant',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_MERCHANT,
+            sortOrder: CONST.SEARCH.SORT_ORDER.ASC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.MERCHANT,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:month',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_MONTH,
+            sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.MONTH,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:week',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_WEEK,
+            sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.WEEK,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:year',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_YEAR,
+            sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.YEAR,
+            filters: null,
+        },
+    },
+    {
+        query: 'type:expense group-by:quarter',
+        expected: {
+            type: CONST.SEARCH.DATA_TYPES.EXPENSE,
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: CONST.SEARCH.TABLE_COLUMNS.GROUP_QUARTER,
+            sortOrder: CONST.SEARCH.SORT_ORDER.DESC,
+            view: 'table',
+            groupBy: CONST.SEARCH.GROUP_BY.QUARTER,
+            filters: null,
+        },
+    },
     {
         query: 'type:chat is:read',
         expected: {
@@ -815,6 +935,44 @@ const keywordTests = [
             },
         },
     },
+    {
+        query: 'columns:per-diem,drafts,draft,tax-rate,policy-name,withdrawal-id,bank-account',
+        expected: {
+            type: 'expense',
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: 'date',
+            sortOrder: 'desc',
+            view: 'table',
+            columns: [
+                'perDiem',
+                'drafts',
+                'drafts',
+                CONST.SEARCH.TABLE_COLUMNS.TAX_RATE,
+                CONST.SEARCH.TABLE_COLUMNS.POLICY_NAME,
+                CONST.SEARCH.TABLE_COLUMNS.WITHDRAWAL_ID,
+                CONST.SEARCH.TABLE_COLUMNS.BANK_ACCOUNT,
+            ],
+            filters: null,
+        },
+    },
+    {
+        query: 'columns:long-report-id,exported-to,exchange-rate,reimbursable-total,non-reimbursable-total',
+        expected: {
+            type: 'expense',
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: 'date',
+            sortOrder: 'desc',
+            view: 'table',
+            columns: [
+                CONST.SEARCH.TABLE_COLUMNS.REPORT_ID,
+                CONST.SEARCH.TABLE_COLUMNS.EXPORTED_TO,
+                CONST.SEARCH.TABLE_COLUMNS.EXCHANGE_RATE,
+                CONST.SEARCH.TABLE_COLUMNS.REIMBURSABLE_TOTAL,
+                CONST.SEARCH.TABLE_COLUMNS.NON_REIMBURSABLE_TOTAL,
+            ],
+            filters: null,
+        },
+    },
     {
         query: 'columns:original-amount,tax,report-id',
         expected: {
@@ -823,7 +981,48 @@ const keywordTests = [
             sortBy: 'date',
             sortOrder: 'desc',
             view: 'table',
-            columns: ['originalamount', 'taxAmount', 'base62ReportID'],
+            columns: [CONST.SEARCH.TABLE_COLUMNS.ORIGINAL_AMOUNT, CONST.SEARCH.TABLE_COLUMNS.TAX_AMOUNT, CONST.SEARCH.TABLE_COLUMNS.BASE_62_REPORT_ID],
+            filters: null,
+        },
+    },
+    {
+        query: 'columns:group-from,group-expenses,group-total,group-card,group-feed,group-bank-account,group-withdrawn,group-withdrawal-id',
+        expected: {
+            type: 'expense',
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: 'date',
+            sortOrder: 'desc',
+            view: 'table',
+            columns: [
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_FROM,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_EXPENSES,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_TOTAL,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_CARD,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_FEED,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_BANK_ACCOUNT,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_WITHDRAWN,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_WITHDRAWAL_ID,
+            ],
+            filters: null,
+        },
+    },
+    {
+        query: 'columns:group-category,group-tag,group-merchant,group-month,group-week,group-year,group-quarter',
+        expected: {
+            type: 'expense',
+            status: CONST.SEARCH.STATUS.EXPENSE.ALL,
+            sortBy: 'date',
+            sortOrder: 'desc',
+            view: 'table',
+            columns: [
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_CATEGORY,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_TAG,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_MERCHANT,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_MONTH,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_WEEK,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_YEAR,
+                CONST.SEARCH.TABLE_COLUMNS.GROUP_QUARTER,
+            ],
             filters: null,
         },
     },