Remove Typeahead Service (#3257)

* Remove Typeahead search service to focus on search service to return better results * Remove unecessary API request params * remove srchscope now that the queries aren't shared anymore * update typeahead script to use doc_list instead of tag_list
publiclab · Aug 28, 2018 · 8d51151 · 8d51151
1 parent 4b0e408
commit 8d51151
Show file tree

Hide file tree

Showing 18 changed files with 74 additions and 809 deletions.
diff --git a/app/api/srch/api.rb b/app/api/srch/api.rb
@@ -8,7 +8,6 @@ class API < Grape::API
     format :json
 
     # mount the individual api modules here
-    mount Srch::Typeahead
     mount Srch::Search
 
     # Add the swagger documentation
@@ -19,9 +18,7 @@ class API < Grape::API
                               models: [
                                 SearchRequest::Entity,
                                 DocResult::Entity,
-                                TagResult::Entity,
-                                DocList::Entity,
-                                TagList::Entity
+                                DocList::Entity
                               ],
                               info: {
                                 title: 'RESTful API calls for Public Lab site',

diff --git a/app/api/srch/search.rb b/app/api/srch/search.rb
@@ -9,7 +9,7 @@ class Search < Grape::API
 
     # Endpoint definitions
     resource :srch do
-      # Request URL should be /api/srch/all?srchString=QRY[&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/all?srchString=QRY
       # Basic implementation from classic plots2 SearchController
       desc 'Perform a search of all available resources', hidden: false,
                                                           is_array: false,
@@ -21,7 +21,7 @@ class Search < Grape::API
         Search.execute(:all, params)
       end
 
-      # Request URL should be /api/srch/profiles?srchString=QRY[&sort_by=recent&order_direction=desc&field=username&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/profiles?srchString=QRY[&sort_by=recent&order_direction=desc&field=username]
       # Basic implementation from classic plots2 SearchController
       desc 'Perform a search of profiles', hidden: false,
                                            is_array: false,
@@ -34,7 +34,7 @@ class Search < Grape::API
         Search.execute(:profiles, params)
       end
 
-      # Request URL should be /api/srch/notes?srchString=QRY[&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/notes?srchString=QRY
       # Basic implementation from classic plots2 SearchController
       desc 'Perform a search of research notes', hidden: false,
                                                  is_array: false,
@@ -47,7 +47,7 @@ class Search < Grape::API
         Search.execute(:notes, params)
       end
 
-      # Request URL should be /api/srch/questions?srchString=QRY[&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/questions?srchString=QRY
       # Basic implementation from classic plots2 SearchController
       desc 'Perform a search of questions tables', hidden: false,
                                                    is_array: false,
@@ -60,7 +60,7 @@ class Search < Grape::API
         Search.execute(:questions, params)
       end
 
-      # Request URL should be /api/srch/tags?srchString=QRY[&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/tags?srchString=QRY
       # Basic implementation from classic plots2 SearchController
       desc 'Perform a search of documents associated with tags within the system', hidden: false,
                                                                                    is_array: false,
@@ -73,7 +73,7 @@ class Search < Grape::API
         Search.execute(:tags, params)
       end
 
-      # Request URL should be /api/srch/taglocations?srchString=QRY[&tagName=awesome&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/taglocations?srchString=QRY[&tagName=awesome]
       # Note: Query(QRY as above) must have latitude and longitude as srchString=lat,lon
       desc 'Perform a search of documents having nearby latitude and longitude tag values', hidden: false,
                                                                                             is_array: false,
@@ -87,7 +87,7 @@ class Search < Grape::API
       end
 
       # API TO FETCH QRY RECENT CONTRIBUTORS
-      # Request URL should be /api/srch/peoplelocations?srchString=QRY[&tagName=group:partsandcrafts&seq=KEYCOUNT&showCount=NUM_ROWS&pageNum=PAGE_NUM]
+      # Request URL should be /api/srch/peoplelocations?srchString=QRY[&tagName=group:partsandcrafts]
       # QRY should be a number
       desc 'Perform a search to show x Recent People',  hidden: false,
                                                         is_array: false,

diff --git a/app/api/srch/shared_params.rb b/app/api/srch/shared_params.rb
@@ -6,9 +6,6 @@ module SharedParams
 
     params :common do
       requires :srchString, type: String, documentation: { example: 'Spec' }
-      optional :seq, type: Integer, documentation: { example: 995 }
-      optional :showCount, type: Integer, documentation: { example: 3 }
-      optional :pageNum, type: Integer, documentation: { example: 0 }
     end
 
     params :additional do
@@ -27,10 +24,5 @@ module SharedParams
       optional :field, type: String, documentation: { example: 'username' }
       optional :limit, type: Integer, documentation: { example: 0 }
     end
-
-    params :commontypeahead do
-      requires :srchString, type: String, documentation: { example: 'Spec' }
-      optional :seq, type: Integer, documentation: { example: 995 }
-    end
   end
 end
diff --git a/app/api/srch/typeahead.rb b/app/api/srch/typeahead.rb
diff --git a/app/assets/javascripts/restful_typeahead.js b/app/assets/javascripts/restful_typeahead.js
@@ -1,8 +1,8 @@
 /**
   The restful_typeahead.js script provides generic typeahead functionality for the plots2 Rails app.
-  The set of functions here are intended to provide a link between the data available through the RESTful 
-  search API and the UI components.  
-  
+  The set of functions here are intended to provide a link between the data available through the RESTful
+  search API and the UI components.
+
   Documentation here: https://github.com/bassjobsen/Bootstrap-3-Typeahead
 **/
 
@@ -13,26 +13,26 @@ jQuery(document).ready(function() {
     minLength: 3,
     autoSelect: false,
     source: function (query, process) {
-      return $.getJSON('/api/typeahead/all?srchString=' + query, function (data) {
+      return $.getJSON('/api/search/all?srchString=' + query, function (data) {
         return process(data.items);
       },'json');
     },
     highlighter: function (text, item) {
-      return '<i class="fa fa-' + item.tagType + '"></i> ' + item.tagVal;
+      return '<i class="fa fa-' + item.docType + '"></i> ' + item.docTitle;
     },
     matcher: function() {
       return true;
     },
     displayText: function(item) {
-      return item.tagVal;
+      return item.docTitle;
     },
-    updater: function(item) { 
-      if (item.hasOwnProperty('tagSource') && item.tagSource) {
-        window.location = window.location.origin + item.tagSource;
+    updater: function(item) {
+      if (item.hasOwnProperty('docUrl') && item.docUrl) {
+        window.location = window.location.origin + item.docUrl;
       } else {
-        window.location = window.location.origin + '/tag/' + item.tagVal;
+        window.location = window.location.origin + '/tag/' + item.docTitle;
       }
-      item = item.tagVal;
+      item = item.docTitle;
       return item;
     }
   });

diff --git a/app/controllers/searches_controller.rb b/app/controllers/searches_controller.rb
@@ -13,8 +13,8 @@ def new; end
   def results
     @title = 'Search'
     @tagnames = params[:id].split(',')
-    @users = SrchScope.find_users(params[:id], limit = nil)
-    @nodes = TypeaheadService.new.nodes(params[:id], 100, params[:order].to_s.to_sym)
+    @users = SearchService.new.find_users(params[:id], limit = 10)
+    @nodes = SearchService.new.find_nodes(params[:id], 100, params[:order].to_s.to_sym)
       .paginate(page: params[:page], per_page: 24)
   end
 end
diff --git a/app/models/tag_list.rb b/app/models/tag_list.rb
diff --git a/app/models/tag_result.rb b/app/models/tag_result.rb
diff --git a/app/services/execute_typeahead.rb b/app/services/execute_typeahead.rb