Browse Source

replaced escape() call, renamed formatter to be more expressive

Benjamin Schweizer 7 years ago
parent
commit
9220f83b3d

+ 1 - 1
docs/sources/reference/templating.md

@@ -52,7 +52,7 @@ Filter Option | Example | Raw | Interpolated | Description
 `csv`| ${servers:csv} |  `'test1', 'test2'` | `test1,test2` | Formats multi-value variable as a comma-separated string
 `csv`| ${servers:csv} |  `'test1', 'test2'` | `test1,test2` | Formats multi-value variable as a comma-separated string
 `distributed`| ${servers:distributed} | `'test1', 'test2'` | `test1,servers=test2` | Formats multi-value variable in custom format for OpenTSDB.
 `distributed`| ${servers:distributed} | `'test1', 'test2'` | `test1,servers=test2` | Formats multi-value variable in custom format for OpenTSDB.
 `lucene`| ${servers:lucene} | `'test', 'test2'` | `("test" OR "test2")` | Formats multi-value variable as a lucene expression.
 `lucene`| ${servers:lucene} | `'test', 'test2'` | `("test" OR "test2")` | Formats multi-value variable as a lucene expression.
-`urlescape` | ${servers:urlescape} |  `'foo()bar baz', 'test2'` | `{foo%28%29bar%20baz%2Ctest2}` | Formats multi-value variable into a glob, url escaped
+`percentencode` | ${servers:percentencode} |  `'foo()bar BAZ', 'test2'` | `{foo%28%29bar%20BAZ%2Ctest2}` | Formats multi-value variable into a glob, percent-escaped
 
 
 Test the formatting options on the [Grafana Play site](http://play.grafana.org/d/cJtIfcWiz/template-variable-formatting-options?orgId=1).
 Test the formatting options on the [Grafana Play site](http://play.grafana.org/d/cJtIfcWiz/template-variable-formatting-options?orgId=1).
 
 

+ 3 - 3
public/app/features/templating/specs/template_srv.jest.ts

@@ -275,9 +275,9 @@ describe('templateSrv', function() {
       expect(result).toBe('test,test2');
       expect(result).toBe('test,test2');
     });
     });
 
 
-    it('multi value and urlescape format should render url-escaped string', function() {
-      var result = _templateSrv.formatValue(['foo()bar baz', 'test2'], 'urlescape');
-      expect(result).toBe('%7Bfoo%28%29bar%20baz%2Ctest2%7D');
+    it('multi value and percentencode format should render percent-encoded string', function() {
+      var result = _templateSrv.formatValue(['foo()bar BAZ', 'test2'], 'percentencode');
+      expect(result).toBe('%7Bfoo%28%29bar%20BAZ%2Ctest2%7D');
     });
     });
 
 
     it('slash should be properly escaped in regex format', function() {
     it('slash should be properly escaped in regex format', function() {

+ 10 - 3
public/app/features/templating/template_srv.ts

@@ -83,6 +83,13 @@ export class TemplateSrv {
     return '(' + quotedValues.join(' OR ') + ')';
     return '(' + quotedValues.join(' OR ') + ')';
   }
   }
 
 
+  // like encodeURIComponent() but for all characters except alpha-numerics
+  encodeURIQueryValue(str) {
+    return str.replace(/[^a-z0-9]/gi, function(c) {
+      return '%' + c.charCodeAt(0).toString(16);
+    });
+  }
+
   formatValue(value, format, variable) {
   formatValue(value, format, variable) {
     // for some scopedVars there is no variable
     // for some scopedVars there is no variable
     variable = variable || {};
     variable = variable || {};
@@ -124,12 +131,12 @@ export class TemplateSrv {
         }
         }
         return value;
         return value;
       }
       }
-      case 'urlescape': {
+      case 'percentencode': {
         // like glob, but url escaped
         // like glob, but url escaped
         if (_.isArray(value)) {
         if (_.isArray(value)) {
-          return escape('{' + value.join(',') + '}');
+          return this.encodeURIQueryValue('{' + value.join(',') + '}');
         }
         }
-        return escape(value);
+        return this.encodeURIQueryValue(value);
       }
       }
       default: {
       default: {
         if (_.isArray(value)) {
         if (_.isArray(value)) {