public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: Remove implicit anys for DashboardModel and tests (#16553)

Browse Source 
Progress: #14714
This commit is contained in:
Hugo Häggmark
2019-04-12 17:05:44 +02:00
committed by Torkel Ödegaard
parent c17226af95
commit 3f7aaedd8c
3 changed files with 71 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public/app/features/dashboard/state/DashboardModel.test.ts
+17 -16
View File
@@ -1,3 +1,4 @@
// @ts-ignore
import _ from 'lodash';
import { DashboardModel } from '../state/DashboardModel';
import { PanelModel } from '../state/PanelModel';
@@ -6,7 +7,7 @@ jest.mock('app/core/services/context_srv', () => ({}));
describe('DashboardModel', () => {
describe('when creating new dashboard model defaults only', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({}, {});
@@ -27,7 +28,7 @@ describe('DashboardModel', () => {
});
describe('when getting next panel id', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({
@@ -69,7 +70,7 @@ describe('DashboardModel', () => {
});
describe('row and panel manipulation', () => {
let dashboard;
let dashboard: DashboardModel;
beforeEach(() => {
dashboard = new DashboardModel({});
@@ -112,7 +113,7 @@ describe('DashboardModel', () => {
});
describe('Given editable false dashboard', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({ editable: false });
@@ -130,8 +131,8 @@ describe('DashboardModel', () => {
});
describe('when loading dashboard with old influxdb query schema', () => {
let model;
let target;
let model: DashboardModel;
let target: any;
beforeEach(() => {
model = new DashboardModel({
@@ -197,7 +198,7 @@ describe('DashboardModel', () => {
});
describe('when creating dashboard model with missing list for annoations or templating', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({
@@ -222,7 +223,7 @@ describe('DashboardModel', () => {
});
describe('Formatting epoch timestamp when timezone is set as utc', () => {
let dashboard;
let dashboard: DashboardModel;
beforeEach(() => {
dashboard = new DashboardModel({ timezone: 'utc' });
@@ -242,7 +243,7 @@ describe('DashboardModel', () => {
});
describe('updateSubmenuVisibility with empty lists', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({});
@@ -255,7 +256,7 @@ describe('DashboardModel', () => {
});
describe('updateSubmenuVisibility with annotation', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({
@@ -272,7 +273,7 @@ describe('DashboardModel', () => {
});
describe('updateSubmenuVisibility with template var', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({
@@ -289,7 +290,7 @@ describe('DashboardModel', () => {
});
describe('updateSubmenuVisibility with hidden template var', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
model = new DashboardModel({
@@ -306,7 +307,7 @@ describe('DashboardModel', () => {
});
describe('updateSubmenuVisibility with hidden annotation toggle', () => {
let dashboard;
let dashboard: DashboardModel;
beforeEach(() => {
dashboard = new DashboardModel({
@@ -323,7 +324,7 @@ describe('DashboardModel', () => {
});
describe('When collapsing row', () => {
let dashboard;
let dashboard: DashboardModel;
beforeEach(() => {
dashboard = new DashboardModel({
@@ -365,7 +366,7 @@ describe('DashboardModel', () => {
});
describe('When expanding row', () => {
let dashboard;
let dashboard: DashboardModel;
beforeEach(() => {
dashboard = new DashboardModel({
@@ -637,7 +638,7 @@ describe('DashboardModel', () => {
});
describe('Given a dashboard with one panel legend on and two off', () => {
let model;
let model: DashboardModel;
beforeEach(() => {
const data = {
public/app/features/dashboard/state/DashboardModel.ts
+52 -43
View File
@@ -1,5 +1,6 @@
// Libaries
import moment from 'moment';
import moment, { MomentInput } from 'moment';
// @ts-ignore
import _ from 'lodash';
// Constants
@@ -12,11 +13,17 @@ import { contextSrv } from 'app/core/services/context_srv';
import sortByKeys from 'app/core/utils/sort_by_keys';
// Types
import { PanelModel } from './PanelModel';
import { PanelModel, GridPos } from './PanelModel';
import { DashboardMigrator } from './DashboardMigrator';
import { TimeRange } from '@grafana/ui/src';
import { UrlQueryValue, KIOSK_MODE_TV, DashboardMeta } from 'app/types';
export interface CloneOptions {
saveVariables?: boolean;
saveTimerange?: boolean;
message?: string;
}
export class DashboardModel {
id: any;
uid: string;
@@ -31,9 +38,9 @@ export class DashboardModel {
time: any;
private originalTime: any;
timepicker: any;
templating: any;
templating: { list: any[] };
private originalTemplating: any;
annotations: any;
annotations: { list: any[] };
refresh: any;
snapshot: any;
schemaVersion: number;
@@ -61,7 +68,7 @@ export class DashboardModel {
originalTemplating: true,
};
constructor(data, meta?) {
constructor(data: any, meta?: DashboardMeta) {
if (!data) {
data = {};
}
@@ -88,7 +95,7 @@ export class DashboardModel {
this.version = data.version || 0;
this.links = data.links || [];
this.gnetId = data.gnetId || null;
this.panels = _.map(data.panels || [], panelData => new PanelModel(panelData));
this.panels = _.map(data.panels || [], (panelData: any) => new PanelModel(panelData));
this.resetOriginalVariables();
this.resetOriginalTime();
@@ -124,7 +131,7 @@ export class DashboardModel {
});
}
private initMeta(meta) {
private initMeta(meta: DashboardMeta) {
meta = meta || {};
meta.canShare = meta.canShare !== false;
@@ -146,7 +153,7 @@ export class DashboardModel {
}
// cleans meta data and other non persistent state
getSaveModelClone(options?) {
getSaveModelClone(options?: CloneOptions) {
const defaults = _.defaults(options || {}, {
saveVariables: true,
saveTimerange: true,
@@ -164,7 +171,9 @@ export class DashboardModel {
// get variable save models
copy.templating = {
list: _.map(this.templating.list, variable => (variable.getSaveModel ? variable.getSaveModel() : variable)),
list: _.map(this.templating.list, (variable: any) =>
variable.getSaveModel ? variable.getSaveModel() : variable
),
};
if (!defaults.saveVariables) {
@@ -190,8 +199,8 @@ export class DashboardModel {
// get panel save models
copy.panels = _.chain(this.panels)
.filter(panel => panel.type !== 'add-panel')
.map(panel => panel.getSaveModel())
.filter((panel: PanelModel) => panel.type !== 'add-panel')
.map((panel: PanelModel) => panel.getSaveModel())
.value();
// sort by keys
@@ -243,7 +252,7 @@ export class DashboardModel {
return this.meta.fullscreen && !panel.fullscreen;
}
private ensureListExist(data) {
private ensureListExist(data: any) {
if (!data) {
data = {};
}
@@ -273,13 +282,13 @@ export class DashboardModel {
return max + 1;
}
forEachPanel(callback) {
forEachPanel(callback: (panel: PanelModel, index: number) => void) {
for (let i = 0; i < this.panels.length; i++) {
callback(this.panels[i], i);
}
}
getPanelById(id): PanelModel {
getPanelById(id: number): PanelModel {
for (const panel of this.panels) {
if (panel.id === id) {
return panel;
@@ -288,7 +297,7 @@ export class DashboardModel {
return null;
}
addPanel(panelData) {
addPanel(panelData: any) {
panelData.id = this.getNextPanelId();
const panel = new PanelModel(panelData);
@@ -357,7 +366,7 @@ export class DashboardModel {
this.events.emit('repeats-processed');
}
cleanUpRowRepeats(rowPanels) {
cleanUpRowRepeats(rowPanels: PanelModel[]) {
const panelsToRemove = [];
for (let i = 0; i < rowPanels.length; i++) {
const panel = rowPanels[i];
@@ -376,7 +385,7 @@ export class DashboardModel {
let rowPanels = row.panels;
if (!row.collapsed) {
const rowPanelIndex = _.findIndex(this.panels, p => p.id === row.id);
const rowPanelIndex = _.findIndex(this.panels, (p: PanelModel) => p.id === row.id);
rowPanels = this.getRowPanels(rowPanelIndex);
}
@@ -385,13 +394,13 @@ export class DashboardModel {
for (let i = 0; i < rowPanels.length; i++) {
const panel = rowPanels[i];
if (panel.repeat) {
const panelIndex = _.findIndex(this.panels, p => p.id === panel.id);
const panelIndex = _.findIndex(this.panels, (p: PanelModel) => p.id === panel.id);
this.repeatPanel(panel, panelIndex);
}
}
}
getPanelRepeatClone(sourcePanel, valueIndex, sourcePanelIndex) {
getPanelRepeatClone(sourcePanel: PanelModel, valueIndex: number, sourcePanelIndex: number) {
// if first clone return source
if (valueIndex === 0) {
return sourcePanel;
@@ -409,7 +418,7 @@ export class DashboardModel {
return clone;
}
getRowRepeatClone(sourceRowPanel, valueIndex, sourcePanelIndex) {
getRowRepeatClone(sourceRowPanel: PanelModel, valueIndex: number, sourcePanelIndex: number) {
// if first clone return source
if (valueIndex === 0) {
if (!sourceRowPanel.collapsed) {
@@ -421,7 +430,7 @@ export class DashboardModel {
const clone = new PanelModel(sourceRowPanel.getSaveModel());
// for row clones we need to figure out panels under row to clone and where to insert clone
let rowPanels, insertPos;
let rowPanels: PanelModel[], insertPos: number;
if (sourceRowPanel.collapsed) {
rowPanels = _.cloneDeep(sourceRowPanel.panels);
clone.panels = rowPanels;
@@ -429,7 +438,7 @@ export class DashboardModel {
insertPos = sourcePanelIndex + valueIndex;
} else {
rowPanels = this.getRowPanels(sourcePanelIndex);
clone.panels = _.map(rowPanels, panel => panel.getSaveModel());
clone.panels = _.map(rowPanels, (panel: PanelModel) => panel.getSaveModel());
// insert copied row after preceding row's panels
insertPos = sourcePanelIndex + (rowPanels.length + 1) * valueIndex;
}
@@ -495,11 +504,11 @@ export class DashboardModel {
}
}
repeatRow(panel: PanelModel, panelIndex: number, variable) {
repeatRow(panel: PanelModel, panelIndex: number, variable: any) {
const selectedOptions = this.getSelectedVariableOptions(variable);
let yPos = panel.gridPos.y;
function setScopedVars(panel, variableOption) {
function setScopedVars(panel: PanelModel, variableOption: any) {
panel.scopedVars = panel.scopedVars || {};
panel.scopedVars[variable.name] = variableOption;
}
@@ -515,7 +524,7 @@ export class DashboardModel {
if (panel.collapsed) {
// For collapsed row just copy its panels and set scoped vars and proper IDs
_.each(rowPanels, (rowPanel, i) => {
_.each(rowPanels, (rowPanel: PanelModel, i: number) => {
setScopedVars(rowPanel, option);
if (optionIndex > 0) {
this.updateRepeatedPanelIds(rowPanel, true);
@@ -527,7 +536,7 @@ export class DashboardModel {
} else {
// insert after 'row' panel
const insertPos = panelIndex + (rowPanels.length + 1) * optionIndex + 1;
_.each(rowPanels, (rowPanel, i) => {
_.each(rowPanels, (rowPanel: PanelModel, i: number) => {
setScopedVars(rowPanel, option);
if (optionIndex > 0) {
const cloneRowPanel = new PanelModel(rowPanel);
@@ -562,8 +571,8 @@ export class DashboardModel {
return panel;
}
getSelectedVariableOptions(variable) {
let selectedOptions;
getSelectedVariableOptions(variable: any) {
let selectedOptions: any[];
if (variable.current.text === 'All') {
selectedOptions = variable.options.slice(1, variable.options.length);
} else {
@@ -578,7 +587,7 @@ export class DashboardModel {
}
const rowYPos = rowPanel.gridPos.y;
const positions = _.map(rowPanel.panels, 'gridPos');
const maxPos = _.maxBy(positions, pos => {
const maxPos = _.maxBy(positions, (pos: GridPos) => {
return pos.y + pos.h;
});
return maxPos.y + maxPos.h - rowYPos;
@@ -628,7 +637,7 @@ export class DashboardModel {
}
}
setPanelFocus(id) {
setPanelFocus(id: number) {
this.meta.focusPanelId = id;
}
@@ -638,12 +647,12 @@ export class DashboardModel {
return true;
}
const visibleVars = _.filter(this.templating.list, variable => variable.hide !== 2);
const visibleVars = _.filter(this.templating.list, (variable: any) => variable.hide !== 2);
if (visibleVars.length > 0) {
return true;
}
const visibleAnnotations = _.filter(this.annotations.list, annotation => annotation.hide !== true);
const visibleAnnotations = _.filter(this.annotations.list, (annotation: any) => annotation.hide !== true);
if (visibleAnnotations.length > 0) {
return true;
}
@@ -652,7 +661,7 @@ export class DashboardModel {
})();
}
getPanelInfoById(panelId) {
getPanelInfoById(panelId: number) {
for (let i = 0; i < this.panels.length; i++) {
if (this.panels[i].id === panelId) {
return {
@@ -665,7 +674,7 @@ export class DashboardModel {
return null;
}
duplicatePanel(panel) {
duplicatePanel(panel: PanelModel) {
const newPanel = panel.getSaveModel();
newPanel.id = this.getNextPanelId();
@@ -690,7 +699,7 @@ export class DashboardModel {
return newPanel;
}
formatDate(date, format?) {
formatDate(date: MomentInput, format?: string) {
date = moment.isMoment(date) ? date : moment(date);
format = format || 'YYYY-MM-DD HH:mm:ss';
const timezone = this.getTimezone();
@@ -710,7 +719,7 @@ export class DashboardModel {
if (row.collapsed) {
row.collapsed = false;
const hasRepeat = _.some(row.panels, p => p.repeat);
const hasRepeat = _.some(row.panels, (p: PanelModel) => p.repeat);
if (row.panels.length > 0) {
// Use first panel to figure out if it was moved or pushed
@@ -761,7 +770,7 @@ export class DashboardModel {
// remove panels
_.pull(this.panels, ...rowPanels);
// save panel models inside row panel
row.panels = _.map(rowPanels, panel => panel.getSaveModel());
row.panels = _.map(rowPanels, (panel: PanelModel) => panel.getSaveModel());
row.collapsed = true;
// emit change event
@@ -789,11 +798,11 @@ export class DashboardModel {
return rowPanels;
}
on(eventName, callback) {
on(eventName: string, callback: Function) {
this.events.on(eventName, callback);
}
off(eventName, callback?) {
off(eventName: string, callback?: Function) {
this.events.off(eventName, callback);
}
@@ -809,7 +818,7 @@ export class DashboardModel {
return this.graphTooltip === 1;
}
getRelativeTime(date) {
getRelativeTime(date: MomentInput) {
date = moment.isMoment(date) ? date : moment(date);
return this.timezone === 'browser' ? moment(date).fromNow() : moment.utc(date).fromNow();
@@ -827,7 +836,7 @@ export class DashboardModel {
return this.timezone ? this.timezone : contextSrv.user.timezone;
}
private updateSchema(old) {
private updateSchema(old: any) {
const migrator = new DashboardMigrator(this);
migrator.updateSchema(old);
}
@@ -841,7 +850,7 @@ export class DashboardModel {
}
resetOriginalVariables() {
this.originalTemplating = _.map(this.templating.list, variable => {
this.originalTemplating = _.map(this.templating.list, (variable: any) => {
return {
name: variable.name,
type: variable.type,
@@ -856,7 +865,7 @@ export class DashboardModel {
return false;
}
const updated = _.map(this.templating.list, variable => {
const updated = _.map(this.templating.list, (variable: any) => {
return {
name: variable.name,
type: variable.type,
public/app/types/dashboard.ts
+2 -1
View File
@@ -15,6 +15,7 @@ export interface DashboardDTO {
export interface DashboardMeta {
canSave?: boolean;
canEdit?: boolean;
canDelete?: boolean;
canShare?: boolean;
canStar?: boolean;
canAdmin?: boolean;
@@ -25,7 +26,7 @@ export interface DashboardMeta {
canMakeEditable?: boolean;
submenuEnabled?: boolean;
provisioned?: boolean;
focusPanelId?: boolean;
focusPanelId?: number;
isStarred?: boolean;
showSettings?: boolean;
expires?: string;