supported search argument in options

Author: d-beltran

src/routes/projects/index.js

@@ -7,28 +7,12 @@ const getDatabase = require('../../database');
 // Get the project formatter
 const projectFormatter = require('../../utils/project-formatter');
 // Get auxiliar functions
-const { parseJSON, getConfig } = require('../../utils/auxiliar-functions');
+const { parseJSON, getConfig, parseType, getSearchQuery } = require('../../utils/auxiliar-functions');
 // Standard HTTP response status codes
 const { BAD_REQUEST, INTERNAL_SERVER_ERROR } = require('../../utils/status-codes');
 
 const projectRouter = Router();
 
-// Convert a string input into int, float or boolean type if possible
-const parseType = input => {
-  // Booleans
-  if (input === 'false') return false;
-  if (input === 'true') return true;
-  // Numbers
-  if (+input) return +input;
-  // Other strings
-  return input;
-};
-
-// Escape all regex sensible characters
-const escapeRegExp = input => {
-  return input.replace(/[-[/\]{}()*+?.,\\^$|#\s]/g, '\\$&');
-};
-
 // Root
 projectRouter.route('/').get(
   handler({
@@ -42,24 +26,10 @@ projectRouter.route('/').get(
       // Look for the search text in the accession and some metadata/pdbInfo fields
       const search = request.query.search;
       if (search) {
-        // trim() removes surrounding white spaces
-        const tsearch = escapeRegExp(search.trim());
-        // $regex is a mongo command to search for regular expressions inside fields
-        // $options: 'i' stands for the search to be case insensitive
-        if (!finder.$and) finder.$and = [];
-        finder.$and.push( {
-            $or: [
-              { accession: { $regex: tsearch, $options: 'i' } },
-              { 'metadata.NAME': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.DESCRIPTION': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.AUTHORS': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.GROUPS': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.REFERENCES': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.INCHIKEYS': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.PDBIDS': { $regex: tsearch, $options: 'i' } },
-              { 'metadata.SYSKEYS': { $regex: tsearch, $options: 'i' } },
-            ],
-          });
+        // Parse the search text to a predefined smart query
+        const searchQuert = getSearchQuery(search);
+        if (!finder.$and) finder.$and = [ searchQuert ];
+        else finder.$and.push(searchQuert);
       }
       // Then, filter by 'filter' parameters
       // Look for a specified value in any database field

src/routes/projects/options/index.js

@@ -6,7 +6,7 @@ const getDatabase = require('../../../database');
 // Standard HTTP response status codes
 const { BAD_REQUEST, NOT_FOUND } = require('../../../utils/status-codes');
 // Set a error-proof JSON parser
-const { getValueGetter } = require('../../../utils/auxiliar-functions');
+const { getValueGetter, getSearchQuery } = require('../../../utils/auxiliar-functions');
 // Import references configuration
 const { REFERENCES, REFERENCE_HEADER, TOPOLOGY_HEADER } = require('../../../utils/constants');
 
@@ -21,6 +21,14 @@ router.route('/').get(
       // Set an object with all the parameters to performe the mongo query
       // Start filtering by published projects only if we are in production environment
       const finder = database.getBaseFilter();
+      // Handle when there is an automatic query
+      let search = request.query.search;
+      if (search) {
+        // Process the mongo query to convert references and topology queries
+        const searchQuery = getSearchQuery(search);
+        if (!finder.$and) finder.$and = [ searchQuery ];
+        else finder.$and = finder.$and.concat(searchQuery);
+      }
       // Handle when there is a mongo query
       let query = request.query.query;
       if (query) {

src/utils/auxiliar-functions/index.js

@@ -166,6 +166,43 @@ const min = array => array.reduce((cv, nv) => Math.min(cv, nv), Infinity);
 const round2tenths = number => Math.round(number * 10) / 10;
 const round2cents = number => Math.round(number * 100) / 100;
 
+// Convert a string input into int, float or boolean type if possible
+const parseType = input => {
+  // Booleans
+  if (input === 'false') return false;
+  if (input === 'true') return true;
+  // Numbers
+  if (+input) return +input;
+  // Other strings
+  return input;
+};
+
+// Escape all regex sensible characters
+const escapeRegExp = input => {
+  return input.replace(/[-[/\]{}()*+?.,\\^$|#\s]/g, '\\$&');
+};
+
+// Set the defualt smart query when the user uses the "search" parameters
+const getSearchQuery = searchText => {
+  // Removes surrounding white spaces and escape regular expression characters
+  const trimedText = escapeRegExp(searchText.trim());
+  // $regex is a mongo command to search for regular expressions inside fields
+  // $options: 'i' stands for the search to be case insensitive
+  return {
+    $or: [
+      { accession: { $regex: trimedText, $options: 'i' } },
+      { 'metadata.NAME': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.DESCRIPTION': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.AUTHORS': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.GROUPS': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.REFERENCES': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.INCHIKEYS': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.PDBIDS': { $regex: trimedText, $options: 'i' } },
+      { 'metadata.SYSKEYS': { $regex: trimedText, $options: 'i' } },
+    ],
+  };
+}
+
 module.exports = {
     getRequestUrl,
     parseJSON,
@@ -183,4 +220,7 @@ module.exports = {
     min,
     round2tenths,
     round2cents,
+    parseType,
+    escapeRegExp,
+    getSearchQuery,
 }