Merge pull request #21394 from colemanw/debounceGetResults

SearchKit - Prevent race conditions in search display loading
civicrm · Sep 8, 2021 · d83e22b · d83e22b
2 parents 7c5afda + 01aaeae
commit d83e22b
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/ext/search_kit/ang/crmSearchDisplay/traits/searchDisplayBaseTrait.service.js b/ext/search_kit/ang/crmSearchDisplay/traits/searchDisplayBaseTrait.service.js
@@ -3,7 +3,8 @@
 
   // Trait provides base methods and properties common to all search display types
   angular.module('crmSearchDisplay').factory('searchDisplayBaseTrait', function(crmApi4) {
-    var ts = CRM.ts('org.civicrm.search_kit');
+    var ts = CRM.ts('org.civicrm.search_kit'),
+      runCount = 0;
 
     // Replace tokens keyed to rowData.
     // Pass view=true to replace with view value, otherwise raw value is used.
@@ -77,7 +78,7 @@
           $scope.$apply(function() {
             ctrl.runSearch();
           });
-        }, 100);
+        }, 800);
 
         // If search is embedded in contact summary tab, display count in tab-header
         var contactTab = $element.closest('.crm-contact-page .ui-tabs-panel').attr('id');
@@ -142,12 +143,16 @@
       // Call SearchDisplay.run and update ctrl.results and ctrl.rowCount
       runSearch: function(editedRow) {
         var ctrl = this,
+          requestId = ++runCount;
           apiParams = this.getApiParams();
         this.loading = true;
         _.each(ctrl.onPreRun, function(callback) {
           callback.call(ctrl, apiParams);
         });
         return crmApi4('SearchDisplay', 'run', apiParams).then(function(results) {
+          if (requestId < runCount) {
+            return; // Another request started after this one
+          }
           ctrl.results = results;
           ctrl.editing = ctrl.loading = false;
           if (!ctrl.rowCount) {
@@ -164,6 +169,9 @@
             callback.call(ctrl, results, 'success', editedRow);
           });
         }, function(error) {
+          if (requestId < runCount) {
+            return; // Another request started after this one
+          }
           ctrl.results = [];
           ctrl.editing = ctrl.loading = false;
           _.each(ctrl.onPostRun, function(callback) {