grafana-dash-gen 3.3.2 → 3.3.4

package/grafana/templates/custom.js

@@ -20,30 +20,49 @@
 
 'use strict';
 
+// For some reason Grafana will interpret this as a specific string if provided
+// as the allValue of the Custom object. In order to correctly support Grafanas
+// fallback $__all variable, allValue must be null or empty string, and the
+// $__all variable must be provided as the value in the "All" entry in the
+// options list.
+const DEFAULT_VARIABLE_ALL = '$__all';
+
 function Custom(opts) {
     opts = opts || {};
-    var self = this;
-    var defaultState = {
+    this.state = {
         allFormat: 'glob',
         current: null,
         datasource: null,
         includeAll: false,
+        allValue: '',
         name: 'template',
         options: [],
         query: null,
         'refresh_on_load': false,
         type: 'custom'
     };
-    this.state = defaultState;
+    this.defaultValue = '';
 
     // Overwrite defaults with custom values
-    Object.keys(opts).forEach(function eachOpt(opt) {
-        self.state[opt] = opts[opt];
+    Object.keys(opts).forEach(key => {
+      switch (key) {
+        case 'defaultValue':
+          this.defaultValue = opts[key];
+          break;
+        default:
+          this.state[key] = opts[key];
+      }
     });
+    this._processAll();
+    this._processOptions();
+}
 
-    if (this.state.options.length) {
-        this._processOptions();
-    }
+Custom.prototype._processAll = function _processAll() {
+  if (!this.state.includeAll) {
+    return;
+  }
+  const allValue = !this.state.allValue ? DEFAULT_VARIABLE_ALL : this.state.allValue;
+  this.state.options = [{ text: "All", value: allValue }, ...this.state.options];
 }
 
 /*
@@ -51,26 +70,46 @@ function Custom(opts) {
  * values.
  */
 Custom.prototype._processOptions = function _processOptions() {
-    var self = this;
+    if (!this.state.options.length) {
+      if (this.defaultValue !== '') {
+        throw new SyntaxError("cannot define default value without any options")
+      }
+      return;
+    }
 
-    var newOptions = [];
-    var newQuery = [];
+    let self = this;
+    let newOptions = [];
+    let newQuery = [];
 
-    this.state.options.forEach(function processOption(option) {
-        var opt = {};
-        if (typeof option === 'object') {
-            opt = option;
-        } else {
-            opt = {
-                text: option,
-                value: option
-            };
+    let hasAll = false;
+    for (let i = 0; i < this.state.options.length; i++) {
+      const option = this.state.options[i];
+      const isObject = typeof option === 'object' && option.constructor === Object;
+      const opt = isObject ? option : {
+        text: option,
+        value: option
+      };
+      if (opt.value === DEFAULT_VARIABLE_ALL) {
+        if (hasAll) {
+          continue;
         }
-        newOptions.push(opt);
-        newQuery.push(opt.value);
-    });
+        hasAll = true;
+      }
+
+      newOptions.push(opt);
+      newQuery.push(opt.value);
+    }
 
-    self.state.current = newOptions[0];
+    if (this.defaultValue !== '') {
+      const defaultOption = newOptions.find(option => option.value === this.defaultValue);
+      console.log(defaultOption);
+      if (!defaultOption) {
+        throw new SyntaxError("default value not found in options list")
+      }
+      self.state.current = defaultOption
+    } else {
+      self.state.current = newOptions[0];
+    }
 
     this.state.options = newOptions;
     this.state.query = newQuery.join(',');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "grafana-dash-gen",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "description": "A grafana dashboard generator",
   "main": "index.js",
   "scripts": {

package/test/fixtures/override_dashboard.js

@@ -18,8 +18,6 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-var ExternalLink = require('../../grafana/external-link')
-
 'use strict';
 module.exports = {
   id: null,
@@ -45,6 +43,7 @@ module.exports = {
         },
         datasource: null,
         includeAll: false,
+        allValue: '',
         name: 'myvar',
         options: [{
             text: 'a',
@@ -64,6 +63,7 @@ module.exports = {
         },
         datasource: null,
         includeAll: false,
+        allValue: '',
         name: 'smoothing',
         options: [{
             text: '30min',

package/test/fixtures/templates/override_custom.js

@@ -33,6 +33,7 @@ module.exports = {
     datasource: null,
     'refresh_on_load': false,
     includeAll: false,
+    allValue: '',
     allFormat: 'glob',
     query: 'a,b',
     current: {

package/test/fixtures/templates/override_custom_text_value.js

@@ -30,6 +30,7 @@ module.exports = {
     datasource: null,
     'refresh_on_load': false,
     includeAll: false,
+    allValue: '',
     allFormat: 'glob',
     query: 'myValue',
     current: {

package/test/fixtures/templates/simple_custom.js

@@ -25,6 +25,7 @@ module.exports = {
     datasource: null,
     refresh_on_load: false,
     includeAll: false,
+    allValue: '',
     allFormat: 'glob',
     query: null,
     current: null

package/test/templates/custom.js

@@ -94,5 +94,66 @@ test('Custom template overwrites default state', function t(assert) {
         arbitraryProperty: 'foo'
     });
     assert.equal(customTemplate.state.includeAll, true);
+    assert.equal(customTemplate.state.allValue, '');
+    assert.equal(customTemplate.state.current.text, "All");
+    assert.equal(customTemplate.state.current.value, '$__all');
+
+    var customWithAllValue = new Custom({
+      includeAll: true,
+      arbitraryProperty: 'foo',
+      allValue: 'grafana',
+    });
+    assert.equal(customWithAllValue.state.includeAll, true);
+    assert.equal(customWithAllValue.state.allValue, 'grafana')
+
+    var allIsDefault = new Custom({
+      includeAll: true,
+      arbitraryProperty: 'foo',
+      options: [{ text: 'grafana', value: 'grafana' }]
+    });
+    assert.equal(allIsDefault.state.includeAll, true);
+    assert.equal(allIsDefault.state.allValue, '')
+    assert.equal(allIsDefault.state.current.text, "All");
+    assert.equal(allIsDefault.state.current.value, '$__all');
+
     assert.end();
 });
+
+test('Custom template supports custom default', function t(assert) {
+  const defaultOption = { text: 'dash-gen', value: 'dash-gen' }
+  var definedDefault = new Custom({
+    includeAll: true,
+    defaultValue: defaultOption.value,
+    options: [{ text: 'grafana', value: 'grafana' }, defaultOption]
+  });
+  assert.equal(definedDefault.state.includeAll, true);
+  assert.equal(definedDefault.state.allValue, '')
+  assert.equal(definedDefault.state.current, defaultOption);
+
+  assert.throws(
+    () => new Custom({
+      includeAll: true,
+      defaultValue: defaultOption.value,
+      options: [{ text: 'grafana', value: 'grafana' }]
+    }),
+    new SyntaxError("default value not found in options list"),
+  );
+
+  assert.throws(
+    () => new Custom({
+      includeAll: true,
+      defaultValue: defaultOption.value,
+    }),
+    new SyntaxError("default value not found in options list"),
+  );
+
+  assert.throws(
+    () => new Custom({
+      defaultValue: defaultOption.value,
+    }),
+    new SyntaxError("cannot define default value without any options"),
+  );
+
+  assert.end();
+});
+