Add option to persist labels to the URL search query

Author: jwforres

labelFilter.js

@@ -3,7 +3,7 @@
 try { angular.module("kubernetesUI") } catch(e) { angular.module("kubernetesUI", []) }
 
 angular.module('kubernetesUI')
-.factory('LabelFilter', [function() {
+.factory('LabelFilter', function($location) {
   function LabelFilter() {
     this._existingLabels = {};
     this._labelSelector = new LabelSelector(null, true);
@@ -34,6 +34,42 @@ angular.module('kubernetesUI')
     }
   };
 
+  LabelFilter.prototype.persistFilterState = function(persist) {
+    this._shouldPersistState = !!persist;
+  };
+
+  LabelFilter.prototype._persistState = function() {
+    if (!this._shouldPersistState)  {
+      return;
+    }
+    if (this._labelSelector.isEmpty()) {
+      var search = $location.search();
+      search.labelFilter = null;
+      $location.replace().search(search);
+    }
+    else {
+      var search = $location.search();
+      search.labelFilter = this._labelSelector.exportJSON();
+      $location.replace().search(search);
+    }
+  };
+
+  LabelFilter.prototype.readPersistedState = function() {
+    var labelFilterStr = $location.search().labelFilter;
+    if (labelFilterStr) {
+      try {
+        this._labelSelector = new LabelSelector(JSON.parse(labelFilterStr), true);
+      }
+      catch(e) {
+        // wasn't valid JSON so don't use the data
+        this._labelSelector = new LabelSelector({}, true);
+      }
+    }
+    else {
+      this._labelSelector = new LabelSelector({}, true);
+    }
+  };
+
   LabelFilter.prototype._extractLabelsFromItem = function(item, map) {
     var labels = item.metadata ? item.metadata.labels : {};
     var self = this;
@@ -71,6 +107,8 @@ angular.module('kubernetesUI')
       }
     }
 
+    this._persistState();
+
     if (!dontFireCallbacks) {
       this._onActiveFiltersChangedCallbacks.fire(this._labelSelector);
     }
@@ -121,11 +159,11 @@ angular.module('kubernetesUI')
         $('<span>')
           .text(opts.addButtonText || "Add Filter")
       );
-    
+
     this._labelFilterActiveFiltersElement = $('<span>')
       .addClass("label-filter-active-filters")
       .appendTo(activeFiltersElement);
-      
+
     // Render active filters area
     this._labelFilterActiveElement = $('<span>')
       .addClass("label-filter-clear")
@@ -347,6 +385,7 @@ angular.module('kubernetesUI')
 
   LabelFilter.prototype._addActiveFilter = function(key, operator, values) {
     var filter = this._labelSelector.addConjunct(key, operator, values);
+    this._persistState();
     this._onActiveFiltersChangedCallbacks.fire(this._labelSelector);
     this._renderActiveFilter(filter);
   };
@@ -378,11 +417,13 @@ angular.module('kubernetesUI')
     }
 
     this._labelSelector.removeConjunct(filter);
+    this._persistState();
     this._onActiveFiltersChangedCallbacks.fire(this._labelSelector);
   };
 
   LabelFilter.prototype._clearActiveFilters = function() {
     this._labelSelector.clearConjuncts();
+    this._persistState();
     this._onActiveFiltersChangedCallbacks.fire(this._labelSelector);
   };
 
@@ -406,4 +447,4 @@ angular.module('kubernetesUI')
   };
 
   return new LabelFilter();
-}]);
+});

labelSelector.js

@@ -13,20 +13,26 @@ function LabelSelector(selector, emptySelectsAll) {
   // as well as the new matchLabel and matchExpression syntax on newer controllers like ReplicaSets
   // For now it will also handle key: null as key exists for backwards compatibility from before
   // the matchExpression support was added.
-  var OPERATOR_MAP = {
+  this._OPERATOR_MAP = {
     "In": "in",
     "NotIn": "not in",
     "Exists": "exists",
     "DoesNotExist": "does not exist"
   };
+  this._REVERSE_OPERATOR_MAP = {
+    "in": "In",
+    "not in": "NotIn",
+    "exists": "Exists",
+    "does not exist": "DoesNotExist"
+  };
 
   if (selector) {
     if (selector.matchLabels || selector.matchExpressions) {
       angular.forEach(selector.matchLabels, function(details, key) {
         this.addConjunct(key, "in", [details]);
       }, this);
       angular.forEach(selector.matchExpressions, function(expression){
-        this.addConjunct(expression.key, OPERATOR_MAP[expression.operator], expression.values);
+        this.addConjunct(expression.key, this._OPERATOR_MAP[expression.operator], expression.values);
       }, this);
     }
     else {
@@ -35,7 +41,7 @@ function LabelSelector(selector, emptySelectsAll) {
           this.addConjunct(key, "in", [details]);
         }
         else {
-          this.addConjunct(key, "exists", []); 
+          this.addConjunct(key, "exists", []);
         }
       }, this);
     }
@@ -59,7 +65,7 @@ LabelSelector.prototype.addConjunct = function(key, operator, values) {
 // object that was returned from a call to addConjunct
 LabelSelector.prototype.removeConjunct = function(conjunct) {
   if (conjunct.id) {
-    delete this._conjuncts[conjunct.id];  
+    delete this._conjuncts[conjunct.id];
   }
   else {
     delete this._conjuncts[conjunct];
@@ -139,7 +145,7 @@ LabelSelector.prototype.matches = function(resource) {
     }
   }
   return true;
-};  
+};
 
 LabelSelector.prototype.hasConjunct = function(conjunct) {
   return this._conjuncts[this._getIdForConjunct(conjunct)] ? true : false;
@@ -164,6 +170,23 @@ LabelSelector.prototype.covers = function(selector) {
   return true;
 };
 
+// Exports the labelSelector as a string in the API format, exports as matchExpressions
+LabelSelector.prototype.exportJSON = function() {
+  var result = {
+    matchExpressions: []
+  };
+  for (var id in this._conjuncts) {
+    var conjunct = this._conjuncts[id];
+    var expression = {
+      key: conjunct.key,
+      operator: this._REVERSE_OPERATOR_MAP[conjunct.operator],
+      values: conjunct.values
+    };
+    result.matchExpressions.push(expression);
+  }
+  return JSON.stringify(result);
+};
+
 // We assume label values have no whitespace, commas, parens, etc. based
 // on k8s def for label values
 LabelSelector.prototype._getStringForConjunct = function(conjunct) {
@@ -201,4 +224,4 @@ LabelSelector.prototype._getIdForConjunct = function(conjunct) {
     id += "-" + conjunct.values.join(",");
   }
   return id;
-}; 
+};