Start logging popular search terms (#386)

Author: cbovis

package-lock.json

@@ -45,7 +45,8 @@
     "mongoose-paginate": "5.0.3",
     "ms": "2.1.2",
     "pino": "6.0.0",
-    "pino-elasticsearch": "4.4.0"
+    "pino-elasticsearch": "4.4.0",
+    "slugify": "1.4.0"
   },
   "engines": {
     "node": "10.17.0",

package.json

@@ -3,6 +3,7 @@ const moment = require('moment');
 const mongoose = require('mongoose');
 const Router = require('koa-router');
 
+const { logSearch } = require('../../../search');
 const Fill = require('../../../model/fill');
 const getRelayerLookupId = require('../../../relayers/get-relayer-lookup-id');
 const InvalidParameterError = require('../../errors/invalid-parameter-error');
@@ -138,23 +139,26 @@ const createRouter = () => {
         );
       }
 
-      const { docs, pages, total } = await searchFills(
-        {
-          address,
-          bridgeAddress,
-          bridged,
-          dateFrom,
-          dateTo,
-          protocolVersion,
-          query,
-          relayerId: relayerLookupId,
-          status: reverseMapStatus(status),
-          token,
-          valueFrom,
-          valueTo,
-        },
-        { limit, page },
-      );
+      const [{ docs, pages, total }] = await Promise.all([
+        searchFills(
+          {
+            address,
+            bridgeAddress,
+            bridged,
+            dateFrom,
+            dateTo,
+            protocolVersion,
+            query,
+            relayerId: relayerLookupId,
+            status: reverseMapStatus(status),
+            token,
+            valueFrom,
+            valueTo,
+          },
+          { limit, page },
+        ),
+        query !== undefined ? logSearch(query, new Date()) : Promise.resolve(),
+      ]);
 
       response.body = {
         fills: transformFills(docs),

src/app/routes/v1/fills.js

@@ -0,0 +1,3 @@
+const logSearch = require('./log-search');
+
+module.exports = { logSearch };

src/search/index.js

@@ -0,0 +1,33 @@
+const slugify = require('slugify');
+
+const elasticsearch = require('../util/elasticsearch');
+
+const logSearch = async (terms, date) => {
+  const year = date.getUTCFullYear();
+  const month = date.getUTCMonth();
+  const day = date.getUTCDate();
+  const hour = date.getUTCHours();
+  const logDate = new Date();
+
+  logDate.setTime(Date.UTC(year, month, day, hour));
+
+  const slug = slugify(terms, { replacement: '_', lower: true, strict: true });
+
+  await elasticsearch.getClient().update({
+    id: `${year}_${month + 1}_${day}_${hour}_${slug}`,
+    index: 'search_terms',
+    body: {
+      script: {
+        lang: 'painless',
+        source: 'ctx._source.hits += 1',
+      },
+      upsert: {
+        date: logDate,
+        hits: 1,
+        terms,
+      },
+    },
+  });
+};
+
+module.exports = logSearch;