[No QA] [Search v2] [App] Create Search input parser

.eslintrc.js

@@ -100,7 +100,9 @@ module.exports = {
         'prettier',
     ],
     plugins: ['@typescript-eslint', 'jsdoc', 'you-dont-need-lodash-underscore', 'react-native-a11y', 'react', 'testing-library', 'eslint-plugin-react-compiler'],
-    ignorePatterns: ['lib/**'],
+
+    // Ignore the searchParser.js file as it's generated by the peggy parser generator.
+    ignorePatterns: ['lib/**', 'src/lib/Search/searchParser.js'],
     parser: '@typescript-eslint/parser',
     parserOptions: {
         project: path.resolve(__dirname, './tsconfig.json'),

.gitignore

@@ -133,3 +133,6 @@ web-build/
 
 # Storage location for downloaded app source maps (see scripts/symbolicate-profile.ts)
 .sourcemaps/
+
+# Generated search parser
+src/libs/Search/searchParser.js

package.json

@@ -61,7 +61,8 @@
     "workflow-test:generate": "ts-node workflow_tests/utils/preGenerateTest.ts",
     "setup-https": "mkcert -install && mkcert -cert-file config/webpack/certificate.pem -key-file config/webpack/key.pem dev.new.expensify.com localhost 127.0.0.1",
     "e2e-test-runner-build": "ncc build tests/e2e/testRunner.ts -o tests/e2e/dist/",
-    "react-compiler-healthcheck": "react-compiler-healthcheck --verbose"
+    "react-compiler-healthcheck": "react-compiler-healthcheck --verbose",
+    "generate-search-parser": "peggy --format es -o src/libs/Search/searchParser.js src/libs/Search/searchParser.peggy "
   },
   "dependencies": {
     "@babel/plugin-proposal-private-methods": "^7.18.6",
@@ -287,6 +288,7 @@
     "memfs": "^4.6.0",
     "onchange": "^7.1.0",
     "patch-package": "^8.0.0",
+    "peggy": "^4.0.3",
     "portfinder": "^1.0.28",
     "prettier": "^2.8.8",
     "pusher-js-mock": "^0.3.3",

scripts/postInstall.sh

@@ -10,6 +10,9 @@ cd "$ROOT_DIR" || exit 1
 # Apply packages using patch-package
 scripts/applyPatches.sh
 
+# Generate the search query parser
+npm run generate-search-parser
+
 # Install node_modules in subpackages, unless we're in a CI/CD environment,
 # where the node_modules for subpackages are cached separately.
 # See `.github/actions/composite/setupNode/action.yml` for more context.

src/libs/Search/searchParser.peggy

@@ -0,0 +1,87 @@
+// src/libs/Search/searchParser.peggy
+{
+  const defaultValues = {
+    "type": "expense",
+    "status": "all",
+    "sortBy": "date",
+    "sortOrder": "desc",
+    "offset": 0
+  };
+
+  function buildFilter(operator, left, right) {
+    return { operator, left, right };
+  }
+
+  function applyDefaults(filters) {
+    return {
+      ...defaultValues,
+      filters
+    };
+  }
+}
+
+query
+  = _ filters:filterList { return applyDefaults(filters); }
+
+filterList
+  = head:filter tail:(filter logicalAnd)* {
+      return tail.reduce((result, [right, op]) => buildFilter(op, result, right), head);
+    }
+
+filter
+  = _ field:key? _ op:operator? _ value:identifier {
+      if (!field && !op) {
+        return buildFilter('eq', 'freeText', value.trim());
+      } else {
+        const values = value.split(',');
+        return values.slice(1).reduce((acc, val) => buildFilter('or', acc, buildFilter('eq', field, val.trim())), buildFilter('eq', field, values[0]));
+      }
+    }
+
+operator
+  = (":" / "=") { return "eq"; }
+  / "!=" { return "neq"; }
+  / ">" { return "gt"; }
+  / ">=" { return "gte"; }
+  / "<" { return "lt"; }
+  / "<=" { return "lte"; }
+
+key
+  = "type" { return "type"; }
+  / "status" { return "status"; }
+  / "date" { return "date"; }
+  / "amount" { return "amount"; }
+  / "expenseType" { return "expenseType"; }
+  / "in" { return "in"; }
+  / "currency" { return "currency"; }
+  / "merchant" { return "merchant"; }
+  / "description" { return "description"; }
+  / "from" { return "from"; }
+  / "to" { return "to"; }
+  / "category" { return "category"; }
+  / "tag" { return "tag"; }
+  / "taxRate" { return "taxRate"; }
+  / "card" { return "card"; }
+  / "reportID" { return "reportID"; }
+  / "freeText" { return "freeText"; }
+  / "sortBy" { return "sortBy"; }
+  / "sortOrder" { return "sortOrder"; }
+  / "offset" { return "offset"; }
+
+identifier
+ = parts:(quotedString / alphanumeric)+ { return parts.join(''); }
+
+quotedString
+  = '"' chars:[^"\r\n]* '"' { return chars.join(''); }
+
+alphanumeric
+  = chars:[A-Za-z0-9_@./#&+\-\\',]+ { return chars.join(''); }
+
+logicalAnd
+  = _ { return "and"; }
+
+_ "whitespace"
+  = [ \t\r\n]*
+
+start
+  = query

src/libs/SearchUtils.ts

@@ -11,6 +11,8 @@
 import getTopmostCentralPaneRoute from './Navigation/getTopmostCentralPaneRoute';
 import navigationRef from './Navigation/navigationRef';
 import type {AuthScreensParamList, RootStackParamList, State} from './Navigation/types';
+// This file is generated by the npm run generate-search-parser command.
+import * as searchParser from './Search/searchParser';
 import * as TransactionUtils from './TransactionUtils';
 import * as UserUtils from './UserUtils';
 
@@ -301,7 +303,26 @@
     return !Object.keys(searchResults?.data).some((key) => key.startsWith(ONYXKEYS.COLLECTION.TRANSACTION));
 }
 
+// This function should replace the current getQueryParams after the search v2.1 implementation.
+function __getQueryHash(query: string): number {
+    return UserUtils.hashText(query, 2 ** 32);
+}
+
+function buildJSONQuery(query: string) {
+    try {
+        // Add the full input and hash to the results
+        const result = searchParser.parse(query);
+        result['input'] = query;
+        result['hash'] = __getQueryHash(result);
+        return result;
+    } catch (e) {
+        // TODO: We need better error handling here.
+        console.log(e);
+    }
+}
+
 export {
+    buildJSONQuery,
     getListItem,
     getQueryHash,
     getSections,