Skip to content

Commit 0f4a9f1

Browse files
torkelotorkelo
committed
feat(templating): began refactoring variables into rich behavioral classes
1 parent 94e5001 commit 0f4a9f1

File tree

8 files changed

+138
-27
lines changed

8 files changed

+138
-27
lines changed

‎public/app/features/dashboard/dashboard_ctrl.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export class DashboardCtrl {
1515
private $rootScope,
1616
dashboardKeybindings,
1717
timeSrv,
18-
templateValuesSrv,
18+
variableSrv,
1919
dashboardSrv,
2020
unsavedChangesSrv,
2121
dynamicDashboardSrv,
@@ -46,7 +46,7 @@ export class DashboardCtrl {
4646

4747
// template values service needs to initialize completely before
4848
// the rest of the dashboard can load
49-
templateValuesSrv.init(dashboard)
49+
variableSrv.init(dashboard)
5050
// template values failes are non fatal
5151
.catch($scope.onInitFailed.bind(this, 'Templating init failed', false))
5252
// continue

‎public/app/features/dashboard/submenu/submenu.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ export class SubmenuCtrl {
1010

1111
/** @ngInject */
1212
constructor(private $rootScope,
13-
private templateValuesSrv,
13+
private variableSrv,
1414
private templateSrv,
1515
private $location) {
1616
this.annotations = this.dashboard.templating.list;
17-
this.variables = this.dashboard.templating.list;
17+
this.variables = this.variableSrv.variables;
1818
}
1919

2020
disableAnnotation(annotation) {
@@ -23,11 +23,11 @@ export class SubmenuCtrl {
2323
}
2424

2525
getValuesForTag(variable, tagKey) {
26-
return this.templateValuesSrv.getValuesForTag(variable, tagKey);
26+
return this.variableSrv.getValuesForTag(variable, tagKey);
2727
}
2828

2929
variableUpdated(variable) {
30-
this.templateValuesSrv.variableUpdated(variable).then(() => {
30+
this.variableSrv.variableUpdated(variable).then(() => {
3131
this.$rootScope.$emit('template-variable-value-updated');
3232
this.$rootScope.$broadcast('refresh');
3333
});

‎public/app/features/templating/editorCtrl.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ function (angular, _) {
77

88
var module = angular.module('grafana.controllers');
99

10-
module.controller('TemplateEditorCtrl', function($scope, datasourceSrv, templateSrv, templateValuesSrv) {
10+
module.controller('TemplateEditorCtrl', function($scope, datasourceSrv, variableSrv) {
1111

1212
var replacementDefaults = {
1313
type: 'query',
@@ -63,7 +63,7 @@ function (angular, _) {
6363
return value;
6464
});
6565

66-
$scope.variables = templateSrv.variables;
66+
$scope.variables = variableSrv.variables;
6767
$scope.reset();
6868

6969
$scope.$watch('mode', function(val) {
@@ -113,7 +113,7 @@ function (angular, _) {
113113
};
114114

115115
$scope.runQuery = function() {
116-
return templateValuesSrv.updateOptions($scope.current).then(null, function(err) {
116+
return variableSrv.updateOptions($scope.current).then(null, function(err) {
117117
if (err.data && err.data.message) { err.message = err.data.message; }
118118
$scope.appEvent("alert-error", ['Templating', 'Template variables could not be initialized: ' + err.message]);
119119
});

‎public/app/features/templating/specs/variable_srv_specs.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import {describe, beforeEach, it, sinon, expect, angularMocks} from 'test/lib/common';
2+
3+
describe('VariableSrv', function() {
4+
});

‎public/app/features/templating/templateSrv.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ define([
22
'angular',
33
'lodash',
44
'./editorCtrl',
5+
'./variable_srv',
56
'./templateValuesSrv',
67
],
78
function (angular, _) {

‎public/app/features/templating/templateValuesSrv.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -166,8 +166,7 @@ function (angular, _, $, kbn) {
166166
if (otherVariable === updatedVariable) {
167167
return;
168168
}
169-
if ((otherVariable.type === "datasource" &&
170-
templateSrv.containsVariable(otherVariable.regex, updatedVariable.name)) ||
169+
if (templateSrv.containsVariable(otherVariable.regex, updatedVariable.name) ||
171170
templateSrv.containsVariable(otherVariable.query, updatedVariable.name) ||
172171
templateSrv.containsVariable(otherVariable.datasource, updatedVariable.name)) {
173172
return self.updateOptions(otherVariable);

‎public/app/features/templating/variable_srv.ts

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
///<reference path="../../headers/common.d.ts" />
2+
3+
import angular from 'angular';
4+
import _ from 'lodash';
5+
import $ from 'jquery';
6+
import coreModule from 'app/core/core_module';
7+
import appEvents from 'app/core/app_events';
8+
9+
interface Variable {
10+
}
11+
12+
class ConstantVariable implements Variable {
13+
constructor(private model) {
14+
}
15+
}
16+
17+
class CustomVariable implements Variable {
18+
constructor(private model) {
19+
}
20+
}
21+
22+
class IntervalVariable implements Variable {
23+
constructor(private model) {
24+
}
25+
}
26+
27+
28+
class QueryVariable implements Variable {
29+
30+
constructor(private model,
31+
private variableSrv: VariableSrv,
32+
private datasourceSrv) {
33+
_.extend(this, model);
34+
}
35+
36+
updateOptions() {
37+
return this.datasourceSrv.get(this.datasource)
38+
.then(_.partial(this.updateOptionsFromMetricFindQuery, variable))
39+
.then(_.partial(this.updateTags, variable))
40+
.then(_.partial(this.validateVariableSelectionState, variable));
41+
}
42+
}
43+
44+
class DatasourceVariable implements Variable {
45+
constructor(private model) {
46+
}
47+
}
48+
49+
50+
export class VariableSrv {
51+
dashboard: any;
52+
variables: any;
53+
54+
variableLock: any;
55+
56+
/** @ngInject */
57+
constructor(
58+
private $q,
59+
private $rootScope,
60+
private datasourceSrv,
61+
private $location,
62+
private templateSrv,
63+
private timeSrv) {
64+
65+
}
66+
67+
init(dashboard) {
68+
this.variableLock = {};
69+
this.dashboard = dashboard;
70+
71+
this.variables = dashboard.templating.list.map(item => {
72+
return new QueryVariable(item, this);
73+
});
74+
75+
this.templateSrv.init(this.variables);
76+
return this.$q.when();
77+
}
78+
79+
updateOptions(variable) {
80+
return variable.updateOptions();
81+
}
82+
83+
variableUpdated(variable) {
84+
// if there is a variable lock ignore cascading update because we are in a boot up scenario
85+
if (this.variableLock[variable.name]) {
86+
return this.$q.when();
87+
}
88+
89+
var promises = _.map(this.variables, otherVariable => {
90+
if (otherVariable === variable) {
91+
return;
92+
}
93+
94+
if (this.templateSrv.containsVariable(otherVariable.regex, variable.name) ||
95+
this.templateSrv.containsVariable(otherVariable.query, variable.name) ||
96+
this.templateSrv.containsVariable(otherVariable.datasource, variable.name)) {
97+
return this.updateOptions(otherVariable);
98+
}
99+
});
100+
101+
return this.$q.all(promises);
102+
}
103+
104+
105+
}
106+
107+
coreModule.service('variableSrv', VariableSrv);

‎public/test/specs/templateValuesSrv-specs.js

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -50,22 +50,22 @@ define([
5050
});
5151
});
5252

53-
describe('and setting adhoc variable', function() {
54-
var variable = {name: 'filters', type: 'adhoc'};
55-
56-
beforeEach(function(done) {
57-
var dashboard = { templating: { list: [variable] } };
58-
var urlParams = {};
59-
urlParams["var-filters"] = "hostname|gt|server2";
60-
ctx.$location.search = sinon.stub().returns(urlParams);
61-
ctx.service.init(dashboard).then(function() { done(); });
62-
ctx.$rootScope.$digest();
63-
});
64-
65-
it('should update current value', function() {
66-
expect(variable.tags[0]).to.eq({tag: 'hostname', value: 'server2'});
67-
});
68-
});
53+
// describe('and setting adhoc variable', function() {
54+
// var variable = {name: 'filters', type: 'adhoc'};
55+
//
56+
// beforeEach(function(done) {
57+
// var dashboard = { templating: { list: [variable] } };
58+
// var urlParams = {};
59+
// urlParams["var-filters"] = "hostname|gt|server2";
60+
// ctx.$location.search = sinon.stub().returns(urlParams);
61+
// ctx.service.init(dashboard).then(function() { done(); });
62+
// ctx.$rootScope.$digest();
63+
// });
64+
//
65+
// it('should update current value', function() {
66+
// expect(variable.tags[0]).to.eq({tag: 'hostname', value: 'server2'});
67+
// });
68+
// });
6969
});
7070

7171
describe('when template variable is present in url multiple times', function() {

0 commit comments

Comments
 (0)