From 1dfd3e9dde75003fa62fd853b6a1ee96f2e669bc Mon Sep 17 00:00:00 2001
From: luccioman <luccioman@users.noreply.github.com>
Date: Tue, 22 May 2018 07:55:09 +0200
Subject: [PATCH] Limit the rate of calls to the suggest API when typing in
 search field

---
 htroot/index.html      | 47 ++++++++++++++++++++----------------
 htroot/yacysearch.html | 54 +++++++++++++++++++++++-------------------
 2 files changed, 57 insertions(+), 44 deletions(-)

diff --git a/htroot/index.html b/htroot/index.html
index 59659a78e..fb4678334 100644
--- a/htroot/index.html
+++ b/htroot/index.html
@@ -6,32 +6,39 @@
     #%env/templates/metas.template%#
     <link rel="alternate" type="application/rss+xml" title="Search for #[former]#" href="yacysearch.rss?query=#[former]#" />
     <link rel="search" type="application/opensearchdescription+xml" title="YaCy '#[clientname]#'" href="opensearchdescription.xml" />
-    <script type="text/javascript" src="env/bootstrap/js/typeahead.jquery.min.js"></script>
+    <script type="text/javascript" src="env/bootstrap/js/typeahead.jquery.js"></script>
     <script type="text/javascript" src="js/html.js"></script>
     <script type="text/javascript">
-     var suggestMatcher = function() {
-       return function opensearch(q, cb) {
-       	 $.getJSON("suggest.json?q=" + q, function(data) {
-           	var parsed = [];
-            for (var i = 0; i < data[1].length; i++) {
-                var row = data[1][i];
-                if (row) {
-                    parsed[parsed.length] = {
-                        data: [row],
-                        value: row,
-                        result: row
-                    };  
-                };
-            };
-            cb(parsed); 
-          });
-        };
-      };     
     $(document).ready(function() {
+      var suggestTimeoutId = null;
+      
+      /* Configure the search input field to get suggestions on key strokes */
       $('#search').typeahead({hint:false,highlight:true,minLength:1}, {
     	name: 'states',
     	displayKey: 'value',
-    	source: suggestMatcher()
+    	source: function(query, render) {
+    		if(suggestTimeoutId != null) {
+    			/* Remove delayed call not yet done */
+    			clearTimeout(suggestTimeoutId);
+    		}
+			/* Limit the rate of calls to the suggest API by adding a delay before effective call */
+    		suggestTimeoutId = setTimeout(function() {
+    	       	 $.getJSON("suggest.json?q=" + query, function(data) {
+    	            var parsed = [];
+    	             for (var i = 0; i < data[1].length; i++) {
+    	                 var row = data[1][i];
+    	                 if (row) {
+    	                     parsed[parsed.length] = {
+    	                         data: [row],
+    	                         value: row,
+    	                         result: row
+    	                     };  
+    	                 };
+    	             };
+    	             render(parsed); 
+    	           });
+    		}, 300);
+    	}
       });
     });
     </script>
diff --git a/htroot/yacysearch.html b/htroot/yacysearch.html
index 687439f25..deb616439 100644
--- a/htroot/yacysearch.html
+++ b/htroot/yacysearch.html
@@ -22,25 +22,6 @@
   <link rel="stylesheet" type="text/css" media="screen" href="env/yacysort.css" />
   #(/jsResort)#
   <script type="text/javascript">
-     var suggestMatcher = function() {
-       return function opensearch(q, cb) {
-       	 $.getJSON("suggest.json?q=" + q, function(data) {
-           	var parsed = [];
-            for (var i = 0; i < data[1].length; i++) {
-                var row = data[1][i];
-                if (row) {
-                    parsed[parsed.length] = {
-                        data: [row],
-                        value: row,
-                        result: row
-                    };
-                };
-            };
-            cb(parsed);
-          });
-        };
-      };
-
     $(document).ready(function() {
       #(jsResort)#::
         $.get(
@@ -53,11 +34,36 @@
         );
       #(/jsResort)#
 
-      $('#search').typeahead({hint:false,highlight:true,minLength:1}, {
-    	name: 'states',
-    	displayKey: 'value',
-    	source: suggestMatcher()
-      });
+		var suggestTimeoutId = null;
+
+		/* Configure the search input field to get suggestions on key strokes */
+		$('#search').typeahead({hint:false,highlight:true,minLength:1}, {
+			name: 'states',
+			displayKey: 'value',
+			source: function(query, render) {
+				if(suggestTimeoutId != null) {
+					/* Remove delayed call not yet done */
+					clearTimeout(suggestTimeoutId);
+				}
+				/* Limit the rate of calls to the suggest API by adding a delay before effective call */
+				suggestTimeoutId = setTimeout(function() {
+					$.getJSON("suggest.json?q=" + query, function(data) {
+	    	    		var parsed = [];
+    	    	    	for (var i = 0; i < data[1].length; i++) {
+	    	    	    	var row = data[1][i];
+    	    	        	if (row) {
+	    	    	        	parsed[parsed.length] = {
+    	    	            		data: [row],
+    	    	                	value: row,
+    	    	                	result: row
+								};  
+							};
+						};
+						render(parsed); 
+					});
+				}, 300);
+			}
+		});
     });
   </script>
   <style type="text/css">.twitter-typeahead {margin: 0px;padding: 0px;top:2px;}</style> <!-- fix for input window -->