Feature: Add search field for mongo queries (#474) (#477)

* Feature: Add search field for mongo queries

* Bump version up to 1.1.15

* add search in comment

* Update eventsFactory.js

* Update project.js

* Update project.ts

* rm unused

* fix eslint

---------

Co-authored-by: Pavel Zotikov <pavelzotikov@gmail.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Peter Savchenko <specc.dev@gmail.com>

Author: 3 people

.eslintrc.js

@@ -11,5 +11,13 @@ module.exports = {
     'require-jsdoc': 'warn',
     'no-shadow': 'warn',
     'no-unused-expressions': 'warn'
-  }
+  },
+  overrides: [
+    {
+      files: ['*.js'],
+      rules: {
+        '@typescript-eslint/explicit-function-return-type': 'off'
+      }
+    }
+  ]
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hawk.api",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "main": "index.ts",
   "license": "UNLICENSED",
   "scripts": {

src/models/eventsFactory.js

@@ -149,15 +149,23 @@ class EventsFactory extends Factory {
    * @param {Number} skip - certain number of documents to skip
    * @param {'BY_DATE' | 'BY_COUNT'} sort - events sort order
    * @param {EventsFilters} filters - marks by which events should be filtered
+   * @param {String} search - Search query
    *
    * @return {RecentEventSchema[]}
    */
   async findRecent(
     limit = 10,
     skip = 0,
     sort = 'BY_DATE',
-    filters = {}
+    filters = {},
+    search = ''
   ) {
+    if (typeof search !== 'string') {
+      throw new Error('Search parameter must be a string');
+    }
+
+    const escapedSearch = search.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
     limit = this.validateLimit(limit);
 
     switch (sort) {
@@ -184,71 +192,64 @@ class EventsFactory extends Factory {
       },
     ];
 
-    /**
-     * If some events should be omitted, use alternative pipeline
-     */
-    if (Object.values(filters).length > 0) {
-      pipeline.push(
-        /**
-         * Lookup events object for each daily event
-         */
-        {
-          $lookup: {
-            from: 'events:' + this.projectId,
-            localField: 'groupHash',
-            foreignField: 'groupHash',
-            as: 'event',
+    const searchFilter = search.trim().length > 0
+      ? {
+        $or: [
+          {
+            'event.payload.title': {
+              $regex: escapedSearch,
+              $options: 'i',
+            },
           },
-        },
-        {
-          $unwind: '$event',
-        },
-        /**
-         * Match filters
-         */
-        {
-          $match: {
-            ...Object.fromEntries(
-              Object
-                .entries(filters)
-                .map(([mark, exists]) => [`event.marks.${mark}`, { $exists: exists } ])
-            ),
+          {
+            'event.payload.backtrace.file': {
+              $regex: escapedSearch,
+              $options: 'i',
+            },
           },
+        ],
+      }
+      : {};
+
+    const matchFilter = filters
+      ? Object.fromEntries(
+        Object
+          .entries(filters)
+          .map(([mark, exists]) => [`event.marks.${mark}`, { $exists: exists } ])
+      )
+      : {};
+
+    pipeline.push(
+      {
+        $lookup: {
+          from: 'events:' + this.projectId,
+          localField: 'groupHash',
+          foreignField: 'groupHash',
+          as: 'event',
         },
-        { $skip: skip },
-        { $limit: limit },
-        {
-          $group: {
-            _id: null,
-            dailyInfo: { $push: '$$ROOT' },
-            events: { $push: '$event' },
-          },
+      },
+      {
+        $unwind: '$event',
+      },
+      {
+        $match: {
+          ...matchFilter,
+          ...searchFilter,
         },
-        {
-          $unset: 'dailyInfo.event',
-        }
-      );
-    } else {
-      pipeline.push(
-        { $skip: skip },
-        { $limit: limit },
-        {
-          $group: {
-            _id: null,
-            groupHash: { $addToSet: '$groupHash' },
-            dailyInfo: { $push: '$$ROOT' },
-          },
+      },
+      { $skip: skip },
+      { $limit: limit },
+      {
+        $group: {
+          _id: null,
+          dailyInfo: { $push: '$$ROOT' },
+          events: { $push: '$event' },
         },
-        {
-          $lookup: {
-            from: 'events:' + this.projectId,
-            localField: 'groupHash',
-            foreignField: 'groupHash',
-            as: 'events',
-          },
-        }
-      );
-    }
+      },
+      {
+        $unset: 'dailyInfo.event',
+      }
+    );
 
     const cursor = this.getCollection(this.TYPES.DAILY_EVENTS).aggregate(pipeline);
 
@@ -316,7 +317,7 @@ class EventsFactory extends Factory {
     });
 
     /**
-     * Group events using 'groupByTimestamp:NNNNNNNN' key
+     * Group events using 'groupingTimestamp:NNNNNNNN' key
      * @type {ProjectChartItem[]}
      */
     const groupedData = groupBy('groupingTimestamp')(dailyEvents);

src/resolvers/project.js

@@ -11,6 +11,7 @@ const ProjectModel = require('../models/project').default;
 const EVENTS_GROUP_HASH_INDEX_NAME = 'groupHashUnique';
 const REPETITIONS_GROUP_HASH_INDEX_NAME = 'groupHash_hashed';
 const REPETITIONS_USER_ID_INDEX_NAME = 'userId';
+const MAX_SEARCH_QUERY_LENGTH = 50;
 
 /**
  * See all types and fields here {@see ../typeDefs/project.graphql}
@@ -304,13 +305,20 @@ module.exports = {
      * @param {Number} skip - certain number of documents to skip
      * @param {'BY_DATE' | 'BY_COUNT'} sort - events sort order
      * @param {EventsFilters} filters - marks by which events should be filtered
+     * @param {String} search - search query
      *
      * @return {Promise<RecentEventSchema[]>}
      */
-    async recentEvents(project, { limit, skip, sort, filters }) {
+    async recentEvents(project, { limit, skip, sort, filters, search }) {
+      if (search) {
+        if (search.length > MAX_SEARCH_QUERY_LENGTH) {
+          search = search.slice(0, MAX_SEARCH_QUERY_LENGTH);
+        }
+      }
+
       const factory = new EventsFactory(project._id);
 
-      return factory.findRecent(limit, skip, sort, filters);
+      return factory.findRecent(limit, skip, sort, filters, search);
     },
 
     /**

src/typeDefs/project.ts

@@ -124,6 +124,9 @@ type Project {
 
     "Event marks by which events should be sorted"
     filters: EventsFiltersInput
+
+    "Search query"
+    search: String
   ): RecentEvents
   """
   Return events that occurred after a certain timestamp