From 9c35d3f87c3c5ca5f8d9db4f6e3dbdb6dc2d09cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=94=B0=E5=AD=90=E5=AE=BD?= Date: Fri, 19 May 2017 11:38:28 +0800 Subject: [PATCH 001/130] Add kibana like readable label to elasticsearch query builder --- .../datasource/elasticsearch/partials/bucket_agg.html | 2 ++ public/app/plugins/datasource/elasticsearch/query_builder.js | 5 +++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/partials/bucket_agg.html b/public/app/plugins/datasource/elasticsearch/partials/bucket_agg.html index f1e650f6830..ea60ac76958 100644 --- a/public/app/plugins/datasource/elasticsearch/partials/bucket_agg.html +++ b/public/app/plugins/datasource/elasticsearch/partials/bucket_agg.html @@ -96,6 +96,8 @@
+ +
+ + +
+
+
+ + +
+
+ + Fetching changes… +
+ +
+ +   Restore to version {{new}} + +

+ Comparing Version {{ctrl.selected[0]}} + + Version {{ctrl.selected[1]}} + (Current) +

+
+

+ Version {{new}} updated by + {{ctrl.getMeta(new, 'createdBy')}} + {{ctrl.formatBasicDate(ctrl.getMeta(new, 'created'))}} + - {{ctrl.getMeta(new, 'message')}} +

+

+ Version {{original}} updated by + {{ctrl.getMeta(original, 'createdBy')}} + {{ctrl.formatBasicDate(ctrl.getMeta(original, 'created'))}} + - {{ctrl.getMeta(original, 'message')}} +

+
+
+
+
+
+
+
+
+
+
+ +
+
diff --git a/public/app/features/dashboard/audit/partials/link-json.html b/public/app/features/dashboard/audit/partials/link-json.html new file mode 100644 index 00000000000..0ad398486c8 --- /dev/null +++ b/public/app/features/dashboard/audit/partials/link-json.html @@ -0,0 +1,4 @@ + + Line {{ line }} + + diff --git a/public/app/features/dashboard/dashboard_srv.ts b/public/app/features/dashboard/dashboard_srv.ts index 5939ff83a15..b075af7352e 100644 --- a/public/app/features/dashboard/dashboard_srv.ts +++ b/public/app/features/dashboard/dashboard_srv.ts @@ -23,32 +23,7 @@ export class DashboardSrv { return this.dash; } - saveDashboard(options) { - if (!this.dash.meta.canSave && options.makeEditable !== true) { - return Promise.resolve(); - } - - if (this.dash.title === 'New dashboard') { - return this.saveDashboardAs(); - } - - var clone = this.dash.getSaveModelClone(); - - return this.backendSrv.saveDashboard(clone, options).then(data => { - this.dash.version = data.version; - - this.$rootScope.appEvent('dashboard-saved', this.dash); - - var dashboardUrl = '/dashboard/db/' + data.slug; - if (dashboardUrl !== this.$location.path()) { - this.$location.url(dashboardUrl); - } - - this.$rootScope.appEvent('alert-success', ['Dashboard saved', 'Saved as ' + clone.title]); - }).catch(this.handleSaveDashboardError.bind(this)); - } - - handleSaveDashboardError(err) { + handleSaveDashboardError(clone, err) { if (err.data && err.data.status === "version-mismatch") { err.isHandled = true; @@ -59,7 +34,7 @@ export class DashboardSrv { yesText: "Save & Overwrite", icon: "fa-warning", onConfirm: () => { - this.saveDashboard({overwrite: true}); + this.saveDashboard({overwrite: true}, clone); } }); } @@ -74,7 +49,7 @@ export class DashboardSrv { yesText: "Save & Overwrite", icon: "fa-warning", onConfirm: () => { - this.saveDashboard({overwrite: true}); + this.saveDashboard({overwrite: true}, clone); } }); } @@ -93,12 +68,50 @@ export class DashboardSrv { this.saveDashboardAs(); }, onConfirm: () => { - this.saveDashboard({overwrite: true}); + this.saveDashboard({overwrite: true}, clone); } }); } } + postSave(clone, data) { + this.dash.version = data.version; + + var dashboardUrl = '/dashboard/db/' + data.slug; + if (dashboardUrl !== this.$location.path()) { + this.$location.url(dashboardUrl); + } + + this.$rootScope.appEvent('dashboard-saved', this.dash); + this.$rootScope.appEvent('alert-success', ['Dashboard saved', 'Saved as ' + clone.title]); + } + + save(clone, options) { + return this.backendSrv.saveDashboard(clone, options) + .then(this.postSave.bind(this, clone)) + .catch(this.handleSaveDashboardError.bind(this, clone)); + } + + saveDashboard(options, clone) { + if (clone) { + this.setCurrent(this.create(clone, this.dash.meta)); + } + + if (!this.dash.meta.canSave && options.makeEditable !== true) { + return Promise.resolve(); + } + + if (this.dash.title === 'New dashboard') { + return this.saveDashboardAs(); + } + + if (this.dash.version > 0) { + return this.saveDashboardMessage(); + } + + return this.save(this.dash.getSaveModelClone(), options); + } + saveDashboardAs() { var newScope = this.$rootScope.$new(); newScope.clone = this.dash.getSaveModelClone(); @@ -112,6 +125,16 @@ export class DashboardSrv { }); } + saveDashboardMessage() { + var newScope = this.$rootScope.$new(); + newScope.clone = this.dash.getSaveModelClone(); + + this.$rootScope.appEvent('show-modal', { + src: 'public/app/features/dashboard/partials/saveDashboardMessage.html', + scope: newScope, + modalClass: 'modal--narrow' + }); + } } coreModule.service('dashboardSrv', DashboardSrv); diff --git a/public/app/features/dashboard/dashnav/dashnav.html b/public/app/features/dashboard/dashnav/dashnav.html index 7deb46931c2..36e523cd189 100644 --- a/public/app/features/dashboard/dashnav/dashnav.html +++ b/public/app/features/dashboard/dashnav/dashnav.html @@ -56,7 +56,8 @@
  • - + +
  • @@ -66,6 +67,7 @@
    • Settings
    • Annotations
      • +
    • Changelog
    • Templating
    • View JSON
    • Make Editable
      • diff --git a/public/app/features/dashboard/partials/saveDashboardMessage.html b/public/app/features/dashboard/partials/saveDashboardMessage.html new file mode 100644 index 00000000000..62930defa14 --- /dev/null +++ b/public/app/features/dashboard/partials/saveDashboardMessage.html @@ -0,0 +1,49 @@ +
      +
      +

      + + Save to changelog +

      + + + + +
      + +
      +
      Add a note to describe the changes in this version
      +
      +
      + +
      +
      + +
      + + +
      +
      +
      + + diff --git a/public/app/features/dashboard/saveDashboardAsCtrl.js b/public/app/features/dashboard/saveDashboardAsCtrl.js index 09ac7f55d2e..6f91591feca 100644 --- a/public/app/features/dashboard/saveDashboardAsCtrl.js +++ b/public/app/features/dashboard/saveDashboardAsCtrl.js @@ -6,7 +6,7 @@ function (angular) { var module = angular.module('grafana.controllers'); - module.controller('SaveDashboardAsCtrl', function($scope, backendSrv, $location) { + module.controller('SaveDashboardAsCtrl', function($scope, dashboardSrv) { $scope.init = function() { $scope.clone.id = null; @@ -24,17 +24,6 @@ function (angular) { delete $scope.clone.autoUpdate; }; - function saveDashboard(options) { - return backendSrv.saveDashboard($scope.clone, options).then(function(result) { - $scope.appEvent('alert-success', ['Dashboard saved', 'Saved as ' + $scope.clone.title]); - - $location.url('/dashboard/db/' + result.slug); - - $scope.appEvent('dashboard-saved', $scope.clone); - $scope.dismiss(); - }); - } - $scope.keyDown = function (evt) { if (evt.keyCode === 13) { $scope.saveClone(); @@ -42,22 +31,8 @@ function (angular) { }; $scope.saveClone = function() { - saveDashboard({overwrite: false}).then(null, function(err) { - if (err.data && err.data.status === "name-exists") { - err.isHandled = true; - - $scope.appEvent('confirm-modal', { - title: 'Conflict', - text: 'Dashboard with the same name exists.', - text2: 'Would you still like to save this dashboard?', - yesText: "Save & Overwrite", - icon: "fa-warning", - onConfirm: function() { - saveDashboard({overwrite: true}); - } - }); - } - }); + return dashboardSrv.save($scope.clone, {overwrite: false}) + .then(function() { $scope.dismiss(); }); }; }); diff --git a/public/app/features/dashboard/saveDashboardMessageCtrl.js b/public/app/features/dashboard/saveDashboardMessageCtrl.js new file mode 100644 index 00000000000..90f1c0c6c6d --- /dev/null +++ b/public/app/features/dashboard/saveDashboardMessageCtrl.js @@ -0,0 +1,29 @@ +define([ + 'angular', +], +function (angular) { + 'use strict'; + + var module = angular.module('grafana.controllers'); + + module.controller('SaveDashboardMessageCtrl', function($scope, dashboardSrv) { + + $scope.init = function() { + $scope.clone.message = ''; + $scope.clone.max = 64; + }; + + function saveDashboard(options) { + options.message = $scope.clone.message; + return dashboardSrv.save($scope.clone, options) + .then(function() { $scope.dismiss(); }); + } + + $scope.saveVersion = function(isValid) { + if (!isValid) { return; } + saveDashboard({overwrite: false}); + }; + }); + +}); + diff --git a/public/app/features/dashboard/specs/audit_ctrl_specs.ts b/public/app/features/dashboard/specs/audit_ctrl_specs.ts new file mode 100644 index 00000000000..0e3ef4af33d --- /dev/null +++ b/public/app/features/dashboard/specs/audit_ctrl_specs.ts @@ -0,0 +1,416 @@ +import {describe, beforeEach, it, sinon, expect, angularMocks} from 'test/lib/common'; + +import _ from 'lodash'; +import {AuditLogCtrl} from 'app/features/dashboard/audit/audit_ctrl'; +import { versions, compare, restore } from 'test/mocks/audit-mocks'; +import config from 'app/core/config'; + +describe('AuditLogCtrl', function() { + var RESTORE_ID = 4; + + var ctx: any = {}; + var versionsResponse: any = versions(); + var restoreResponse: any = restore(7, RESTORE_ID); + + beforeEach(angularMocks.module('grafana.core')); + beforeEach(angularMocks.module('grafana.services')); + beforeEach(angularMocks.inject($rootScope => { + ctx.scope = $rootScope.$new(); + })); + + var auditSrv; + var $rootScope; + beforeEach(function() { + auditSrv = { + getAuditLog: sinon.stub(), + compareVersions: sinon.stub(), + restoreDashboard: sinon.stub(), + }; + $rootScope = { + appEvent: sinon.spy(), + onAppEvent: sinon.spy(), + }; + }); + + describe('when the audit log component is loaded', function() { + var deferred; + + beforeEach(angularMocks.inject(($controller, $q) => { + deferred = $q.defer(); + auditSrv.getAuditLog.returns(deferred.promise); + ctx.ctrl = $controller(AuditLogCtrl, { + auditSrv, + $rootScope, + $scope: ctx.scope, + }); + })); + + it('should immediately attempt to fetch the audit log', function() { + expect(auditSrv.getAuditLog.calledOnce).to.be(true); + }); + + describe('and the audit log is successfully fetched', function() { + beforeEach(function() { + deferred.resolve(versionsResponse); + ctx.ctrl.$scope.$apply(); + }); + + it('should reset the controller\'s state', function() { + expect(ctx.ctrl.mode).to.be('list'); + expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); + expect(ctx.ctrl.selected.length).to.be(0); + expect(ctx.ctrl.selected).to.eql([]); + expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + + it('should store the revisions sorted desc by version id', function() { + expect(ctx.ctrl.revisions[0].version).to.be(4); + expect(ctx.ctrl.revisions[1].version).to.be(3); + expect(ctx.ctrl.revisions[2].version).to.be(2); + expect(ctx.ctrl.revisions[3].version).to.be(1); + }); + + it('should add a checked property to each revision', function() { + var actual = _.filter(ctx.ctrl.revisions, rev => rev.hasOwnProperty('checked')); + expect(actual.length).to.be(4); + }); + + it('should set all checked properties to false on reset', function() { + ctx.ctrl.revisions[0].checked = true; + ctx.ctrl.revisions[2].checked = true; + ctx.ctrl.selected = [0, 2]; + ctx.ctrl.reset(); + var actual = _.filter(ctx.ctrl.revisions, rev => !rev.checked); + expect(actual.length).to.be(4); + expect(ctx.ctrl.selected).to.eql([]); + }); + + it('should add a default message to versions without a message', function() { + expect(ctx.ctrl.revisions[0].message).to.be('Dashboard saved'); + }); + + it('should add a message to revisions restored from another version', function() { + expect(ctx.ctrl.revisions[1].message).to.be('Restored from version 1'); + }); + + it('should add a message to entries that overwrote version history', function() { + expect(ctx.ctrl.revisions[2].message).to.be('Dashboard overwritten'); + }); + + it('should add a message to the initial dashboard save', function() { + expect(ctx.ctrl.revisions[3].message).to.be('Dashboard\'s initial save'); + }); + }); + + describe('and fetching the audit log fails', function() { + beforeEach(function() { + deferred.reject(new Error('AuditLogError')); + ctx.ctrl.$scope.$apply(); + }); + + it('should reset the controller\'s state', function() { + expect(ctx.ctrl.mode).to.be('list'); + expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); + expect(ctx.ctrl.selected.length).to.be(0); + expect(ctx.ctrl.selected).to.eql([]); + expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + + it('should broadcast an event indicating the failure', function() { + expect($rootScope.appEvent.calledOnce).to.be(true); + expect($rootScope.appEvent.calledWith('alert-error')).to.be(true); + }); + + it('should have an empty revisions list', function() { + expect(ctx.ctrl.revisions).to.eql([]); + }); + }); + + describe('should update the audit log when the dashboard is saved', function() { + beforeEach(function() { + ctx.ctrl.dashboard = { version: 3 }; + ctx.ctrl.resetFromSource = sinon.spy(); + }); + + it('should listen for the `dashboard-saved` appEvent', function() { + expect($rootScope.onAppEvent.calledOnce).to.be(true); + expect($rootScope.onAppEvent.getCall(0).args[0]).to.be('dashboard-saved'); + }); + + it('should call `onDashboardSaved` when the appEvent is received', function() { + expect($rootScope.onAppEvent.getCall(0).args[1]).to.not.be(ctx.ctrl.onDashboardSaved); + expect($rootScope.onAppEvent.getCall(0).args[1].toString).to.be(ctx.ctrl.onDashboardSaved.toString); + }); + + it('should emit an appEvent to hide the changelog', function() { + ctx.ctrl.onDashboardSaved(); + expect($rootScope.appEvent.calledOnce).to.be(true); + expect($rootScope.appEvent.getCall(0).args[0]).to.be('hide-dash-editor'); + }); + }); + }); + + describe('when the user wants to compare two revisions', function() { + var deferred; + + beforeEach(angularMocks.inject(($controller, $q) => { + deferred = $q.defer(); + auditSrv.getAuditLog.returns($q.when(versionsResponse)); + auditSrv.compareVersions.returns(deferred.promise); + ctx.ctrl = $controller(AuditLogCtrl, { + auditSrv, + $rootScope, + $scope: ctx.scope, + }); + ctx.ctrl.$scope.onDashboardSaved = sinon.spy(); + ctx.ctrl.$scope.$apply(); + })); + + it('should have already fetched the audit log', function() { + expect(auditSrv.getAuditLog.calledOnce).to.be(true); + expect(ctx.ctrl.revisions.length).to.be.above(0); + }); + + it('should check that two valid versions are selected', function() { + // [] + expect(ctx.ctrl.isComparable()).to.be(false); + + // single value + ctx.ctrl.selected = [4]; + expect(ctx.ctrl.isComparable()).to.be(false); + + // both values in range + ctx.ctrl.selected = [4, 2]; + expect(ctx.ctrl.isComparable()).to.be(true); + + // values out of range + ctx.ctrl.selected = [7, 4]; + expect(ctx.ctrl.isComparable()).to.be(false); + }); + + describe('and the basic diff is successfully fetched', function() { + beforeEach(function() { + deferred.resolve(compare('basic')); + ctx.ctrl.selected = [3, 1]; + ctx.ctrl.getDiff('basic'); + ctx.ctrl.$scope.$apply(); + }); + + it('should fetch the basic diff if two valid versions are selected', function() { + expect(auditSrv.compareVersions.calledOnce).to.be(true); + expect(ctx.ctrl.delta.basic).to.be('
      '); + expect(ctx.ctrl.delta.html).to.be(''); + }); + + it('should set the basic diff view as active', function() { + expect(ctx.ctrl.mode).to.be('compare'); + expect(ctx.ctrl.diff).to.be('basic'); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + }); + + describe('and the json diff is successfully fetched', function() { + beforeEach(function() { + deferred.resolve(compare('html')); + ctx.ctrl.selected = [3, 1]; + ctx.ctrl.getDiff('html'); + ctx.ctrl.$scope.$apply(); + }); + + it('should fetch the json diff if two valid versions are selected', function() { + expect(auditSrv.compareVersions.calledOnce).to.be(true); + expect(ctx.ctrl.delta.basic).to.be(''); + expect(ctx.ctrl.delta.html).to.be('
      '); + }); + + it('should set the json diff view as active', function() { + expect(ctx.ctrl.mode).to.be('compare'); + expect(ctx.ctrl.diff).to.be('html'); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + }); + + describe('and diffs have already been fetched', function() { + beforeEach(function() { + deferred.resolve(compare('basic')); + ctx.ctrl.selected = [3, 1]; + ctx.ctrl.delta.basic = 'cached basic'; + ctx.ctrl.getDiff('basic'); + ctx.ctrl.$scope.$apply(); + }); + + it('should use the cached diffs instead of fetching', function() { + expect(auditSrv.compareVersions.calledOnce).to.be(false); + expect(ctx.ctrl.delta.basic).to.be('cached basic'); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + }); + + describe('and fetching the diff fails', function() { + beforeEach(function() { + deferred.reject(new Error('DiffError')); + ctx.ctrl.selected = [4, 2]; + ctx.ctrl.getDiff('basic'); + ctx.ctrl.$scope.$apply(); + }); + + it('should fetch the diff if two valid versions are selected', function() { + expect(auditSrv.compareVersions.calledOnce).to.be(true); + }); + + it('should return to the audit log view', function() { + expect(ctx.ctrl.mode).to.be('list'); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + + it('should broadcast an event indicating the failure', function() { + expect($rootScope.appEvent.calledOnce).to.be(true); + expect($rootScope.appEvent.calledWith('alert-error')).to.be(true); + }); + + it('should have an empty delta/changeset', function() { + expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); + }); + }); + }); + + describe('when the user wants to restore a revision', function() { + var deferred; + + beforeEach(angularMocks.inject(($controller, $q) => { + deferred = $q.defer(); + auditSrv.getAuditLog.returns($q.when(versionsResponse)); + auditSrv.restoreDashboard.returns(deferred.promise); + ctx.ctrl = $controller(AuditLogCtrl, { + auditSrv, + contextSrv: { user: { name: 'Carlos' }}, + $rootScope, + $scope: ctx.scope, + }); + ctx.ctrl.$scope.setupDashboard = sinon.stub(); + ctx.ctrl.dashboard = { id: 1 }; + ctx.ctrl.restore(); + ctx.ctrl.$scope.$apply(); + })); + + it('should display a modal allowing the user to restore or cancel', function() { + expect($rootScope.appEvent.calledOnce).to.be(true); + expect($rootScope.appEvent.calledWith('confirm-modal')).to.be(true); + }); + + describe('from the diff view', function() { + it('should return to the list view on restore', function() { + ctx.ctrl.mode = 'compare'; + deferred.resolve(restoreResponse); + ctx.ctrl.restoreConfirm(RESTORE_ID); + ctx.ctrl.$scope.$apply(); + expect(ctx.ctrl.mode).to.be('list'); + }); + }); + + describe('and restore is selected and successful', function() { + beforeEach(function() { + deferred.resolve(restoreResponse); + ctx.ctrl.restoreConfirm(RESTORE_ID); + ctx.ctrl.$scope.$apply(); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + + it('should add an entry for the restored revision to the audit log', function() { + expect(ctx.ctrl.revisions.length).to.be(5); + }); + + describe('the restored revision', function() { + var first; + beforeEach(function() { first = ctx.ctrl.revisions[0]; }); + + it('should have its `id` and `version` numbers incremented', function() { + expect(first.id).to.be(5); + expect(first.version).to.be(5); + }); + + it('should set `parentVersion` to the reverted version', function() { + expect(first.parentVersion).to.be(RESTORE_ID); + }); + + it('should set `dashboardId` to the dashboard\'s id', function() { + expect(first.dashboardId).to.be(1); + }); + + it('should set `created` to date to the current time', function() { + expect(_.isDate(first.created)).to.be(true); + }); + + it('should set `createdBy` to the username of the user who reverted', function() { + expect(first.createdBy).to.be('Carlos'); + }); + + it('should set `message` to the user\'s commit message', function() { + expect(first.message).to.be('Restored from version 4'); + }); + }); + + it('should reset the controller\'s state', function() { + expect(ctx.ctrl.mode).to.be('list'); + expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); + expect(ctx.ctrl.selected.length).to.be(0); + expect(ctx.ctrl.selected).to.eql([]); + expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; + }); + + it('should set the dashboard object to the response dashboard data', function() { + expect(ctx.ctrl.dashboard).to.eql(restoreResponse.dashboard.dashboard); + expect(ctx.ctrl.dashboard.meta).to.eql(restoreResponse.dashboard.meta); + }); + + it('should call setupDashboard to render new revision', function() { + expect(ctx.ctrl.$scope.setupDashboard.calledOnce).to.be(true); + expect(ctx.ctrl.$scope.setupDashboard.getCall(0).args[0]).to.eql(restoreResponse.dashboard); + }); + }); + + describe('and restore fails to fetch', function() { + beforeEach(function() { + deferred.reject(new Error('RestoreError')); + ctx.ctrl.restoreConfirm(RESTORE_ID); + ctx.ctrl.$scope.$apply(); + }); + + it('should indicate loading has finished', function() { + expect(ctx.ctrl.loading).to.be(false); + }); + + it('should broadcast an event indicating the failure', function() { + expect($rootScope.appEvent.callCount).to.be(2); + expect($rootScope.appEvent.getCall(0).calledWith('confirm-modal')).to.be(true); + expect($rootScope.appEvent.getCall(1).args[0]).to.be('alert-error'); + expect($rootScope.appEvent.getCall(1).args[1][0]).to.be('There was an error restoring the dashboard'); + }); + + // TODO: test state after failure i.e. do we hide the modal or keep it visible + }); + }); +}); diff --git a/public/app/features/dashboard/specs/audit_srv_specs.ts b/public/app/features/dashboard/specs/audit_srv_specs.ts new file mode 100644 index 00000000000..fa25aa5af5b --- /dev/null +++ b/public/app/features/dashboard/specs/audit_srv_specs.ts @@ -0,0 +1,92 @@ +import {describe, beforeEach, it, sinon, expect, angularMocks} from 'test/lib/common'; + +import helpers from 'test/specs/helpers'; +import AuditSrv from '../audit/audit_srv'; +import { versions, compare, restore } from 'test/mocks/audit-mocks'; + +describe('auditSrv', function() { + var ctx = new helpers.ServiceTestContext(); + + var versionsResponse = versions(); + var compareResponse = compare(); + var restoreResponse = restore; + + beforeEach(angularMocks.module('grafana.core')); + beforeEach(angularMocks.module('grafana.services')); + beforeEach(angularMocks.inject(function($httpBackend) { + ctx.$httpBackend = $httpBackend; + $httpBackend.whenRoute('GET', 'api/dashboards/db/:id/versions').respond(versionsResponse); + $httpBackend.whenRoute('GET', 'api/dashboards/db/:id/compare/:original...:new').respond(compareResponse); + $httpBackend.whenRoute('POST', 'api/dashboards/db/:id/restore') + .respond(function(method, url, data, headers, params) { + const parsedData = JSON.parse(data); + return [200, restoreResponse(parsedData.version)]; + }); + })); + beforeEach(ctx.createService('auditSrv')); + + describe('getAuditLog', function() { + it('should return a versions array for the given dashboard id', function(done) { + ctx.service.getAuditLog({ id: 1 }).then(function(versions) { + expect(versions).to.eql(versionsResponse); + done(); + }); + ctx.$httpBackend.flush(); + }); + + it('should return an empty array when not given an id', function(done) { + ctx.service.getAuditLog({ }).then(function(versions) { + expect(versions).to.eql([]); + done(); + }); + ctx.$httpBackend.flush(); + }); + + it('should return an empty array when not given a dashboard', function(done) { + ctx.service.getAuditLog().then(function(versions) { + expect(versions).to.eql([]); + done(); + }); + ctx.$httpBackend.flush(); + }); + }); + + describe('compareVersions', function() { + it('should return a diff object for the given dashboard revisions', function(done) { + var compare = { original: 6, new: 4 }; + ctx.service.compareVersions({ id: 1 }, compare).then(function(response) { + expect(response).to.eql(compareResponse); + done(); + }); + ctx.$httpBackend.flush(); + }); + + it('should return an empty object when not given an id', function(done) { + var compare = { original: 6, new: 4 }; + ctx.service.compareVersions({ }, compare).then(function(response) { + expect(response).to.eql({}); + done(); + }); + ctx.$httpBackend.flush(); + }); + }); + + describe('restoreDashboard', function() { + it('should return a success response given valid parameters', function(done) { + var version = 6; + ctx.service.restoreDashboard({ id: 1 }, version).then(function(response) { + expect(response).to.eql(restoreResponse(version)); + done(); + }); + ctx.$httpBackend.flush(); + }); + + it('should return an empty object when not given an id', function(done) { + ctx.service.restoreDashboard({}, 6).then(function(response) { + expect(response).to.eql({}); + done(); + }); + ctx.$httpBackend.flush(); + }); + }); +}); diff --git a/public/app/features/dashboard/unsavedChangesSrv.js b/public/app/features/dashboard/unsavedChangesSrv.js index 5ce3661100b..df38c7843f8 100644 --- a/public/app/features/dashboard/unsavedChangesSrv.js +++ b/public/app/features/dashboard/unsavedChangesSrv.js @@ -7,7 +7,7 @@ function(angular, _) { var module = angular.module('grafana.services'); - module.service('unsavedChangesSrv', function($rootScope, $q, $location, $timeout, contextSrv, $window) { + module.service('unsavedChangesSrv', function($rootScope, $q, $location, $timeout, contextSrv, dashboardSrv, $window) { function Tracker(dashboard, scope, originalCopyDelay) { var self = this; @@ -136,28 +136,28 @@ function(angular, _) { p.open_modal = function() { var tracker = this; + var dashboard = this.current; var modalScope = this.scope.$new(); + var clone = dashboard.getSaveModelClone(); + + modalScope.clone = clone; modalScope.ignore = function() { tracker.original = null; tracker.goto_next(); }; - modalScope.save = function() { - var cancel = $rootScope.$on('dashboard-saved', function() { - cancel(); - $timeout(function() { - tracker.goto_next(); - }); + var cancel = $rootScope.$on('dashboard-saved', function() { + cancel(); + $timeout(function() { + tracker.goto_next(); }); - - $rootScope.$emit('save-dashboard'); - }; + }); $rootScope.appEvent('show-modal', { src: 'public/app/partials/unsaved-changes.html', - modalClass: 'confirm-modal', scope: modalScope, + modalClass: 'modal--narrow' }); }; diff --git a/public/app/partials/unsaved-changes.html b/public/app/partials/unsaved-changes.html index 7c7d5013ca7..949cef55e7b 100644 --- a/public/app/partials/unsaved-changes.html +++ b/public/app/partials/unsaved-changes.html @@ -1,7 +1,7 @@ -
      +

      - + Unsaved changes

      @@ -10,18 +10,45 @@
      -
      - -
      - What do you want to do? +
      +
      + You're leaving without saving your changes, are you sure you want to leave? To save, add a small note to describe the changes in this version. +
      +
      +
      + +
      -
      - - - +
      + + +
      -
      +
      diff --git a/public/sass/_grafana.scss b/public/sass/_grafana.scss index 6266bd9c98f..9005b433248 100644 --- a/public/sass/_grafana.scss +++ b/public/sass/_grafana.scss @@ -82,6 +82,7 @@ @import "pages/playlist"; @import "pages/admin"; @import "pages/alerting"; +@import "pages/audit"; @import "pages/plugins"; @import "pages/signup"; @import "pages/styleguide"; diff --git a/public/sass/_variables.dark.scss b/public/sass/_variables.dark.scss index 7e7865b6b88..90366da6087 100644 --- a/public/sass/_variables.dark.scss +++ b/public/sass/_variables.dark.scss @@ -280,3 +280,28 @@ $card-shadow: -1px -1px 0 0 hsla(0, 0%, 100%, .1), 1px 1px 0 0 rgba(0, 0, 0, .3) $footer-link-color: $gray-1; $footer-link-hover: $gray-4; + +// Changelog and diff +// ------------------------- +$diff-label-bg: $dark-2; +$diff-label-fg: $white; + +$diff-switch-bg: $dark-5; +$diff-switch-disabled: $gray-1; + +$diff-group-bg: $dark-4; +$diff-arrow-color: $white; + +$diff-json-bg: $dark-4; +$diff-json-fg: $gray-5; + +$diff-json-added: #2f5f40; +$diff-json-deleted: #862d2d; + +$diff-json-old: #5a372a; +$diff-json-new: #664e33; + +$diff-json-changed-fg: $gray-5; +$diff-json-changed-num: $text-muted; + +$diff-json-icon: $gray-7; diff --git a/public/sass/_variables.light.scss b/public/sass/_variables.light.scss index a10f94afc1b..cd6469cbc04 100644 --- a/public/sass/_variables.light.scss +++ b/public/sass/_variables.light.scss @@ -303,3 +303,28 @@ $card-shadow: -1px -1px 0 0 hsla(0, 0%, 100%, .1), 1px 1px 0 0 rgba(0, 0, 0, .1) // footer $footer-link-color: $gray-3; $footer-link-hover: $dark-5; + + +// Changelog and diff +// ------------------------- +$diff-label-bg: $gray-5; +$diff-label-fg: $gray-2; + +$diff-switch-bg: $gray-7; +$diff-switch-disabled: $gray-5; + +$diff-arrow-color: $dark-3; +$diff-group-bg: $gray-7; + +$diff-json-bg: $gray-5; +$diff-json-fg: $gray-2; + +$diff-json-added: lighten(desaturate($green, 30%), 10%); +$diff-json-deleted: desaturate($red, 35%); + +$diff-json-old: #5a372a; +$diff-json-new: #664e33; + +$diff-json-changed-fg: $gray-6; +$diff-json-changed-num: $gray-4; +$diff-json-icon: $gray-4; diff --git a/public/sass/components/_buttons.scss b/public/sass/components/_buttons.scss index a6813c2766c..88752e49064 100644 --- a/public/sass/components/_buttons.scss +++ b/public/sass/components/_buttons.scss @@ -118,5 +118,16 @@ .btn-outline-danger { @include button-outline-variant($btn-danger-bg); } +.btn-outline-disabled { + @include button-outline-variant($gray-1); + @include box-shadow(none); + cursor: default; + + &:hover, &:active, &:active:hover, &:focus { + color: $gray-1; + background-color: transparent; + border-color: $gray-1; + } +} diff --git a/public/sass/components/_gf-form.scss b/public/sass/components/_gf-form.scss index 9c88435fcc2..acd2db00595 100644 --- a/public/sass/components/_gf-form.scss +++ b/public/sass/components/_gf-form.scss @@ -178,6 +178,16 @@ $gf-form-margin: 0.25rem; } } +.gf-form-hint { + width: 100%; +} + +.gf-form-hint-text { + display: block; + text-align: right; + padding-top: 0.5em; +} + .gf-form-select-wrapper { margin-right: $gf-form-margin; position: relative; diff --git a/public/sass/pages/_audit.scss b/public/sass/pages/_audit.scss new file mode 100644 index 00000000000..7377198b2aa --- /dev/null +++ b/public/sass/pages/_audit.scss @@ -0,0 +1,268 @@ +// Audit Table +.audit-table { + // .gf-form overrides + .gf-form-label { display: none; } + + .gf-form-switch { + margin-bottom: 0; + + input + label { + height: 3.6rem; + width: 110%; + } + + input + label::before, input + label::after { + background-color: $diff-switch-bg; + background-image: none; + border: 0; + height: 50px; + line-height: 3.7rem; + } + } + + gf-form-switch[disabled] { + .gf-form-switch input + label { + &::before { + color: $diff-switch-disabled; + text-shadow: none; + } + } + } + + // .filter-table overrides + .filter-table { + tr { + border-bottom: 3px solid $page-bg; + } + + thead tr { + border-width: 3px; + } + + $date-padding: 1em; + + td { + padding: 0; + + &:nth-child(2) { + border-left: 5px solid $page-bg; + padding-left: 1.5em; + } + &:nth-child(3) { padding-left: $date-padding; } + &:last-child { padding-right: 1.5em; } + } + + th:nth-child(2) { padding-left: 0.5em; } + th:nth-child(3) { padding-left: $date-padding; } + } +} + +// Diff View +.audit-log { + h4 { + margin-bottom: 0.75em; + } + + .page-container { + padding: 0; + background: none; + } + + .page-sidebar { + margin-left: 0; + margin-right: 3em; + } + + .small.muted { margin-bottom: 0.25em; } + + .ui-list > li { + margin-bottom: 1.5em; + + & > a { padding-left: 15px; } + & > a.active { @include left-brand-border-gradient(); } + } +} + +// Actual Diff +#delta { + margin: 2em 0; +} + +// JSON +@for $i from 0 through 16 { + .diff-indent-#{$i} { + padding-left: $i * 1.5rem; + margin-left: 10px; + } +} + +.delta-html { + background: $diff-json-bg; + padding-top: 5px; + padding-bottom: 5px; + user-select: none; +} + +.diff-line { + color: $diff-json-fg; + font-family: $font-family-monospace; + font-size: $font-size-sm; + line-height: 2; + margin-bottom: 0; + overflow: hidden; + text-overflow: ellipsis; + white-space: nowrap; + position: relative; + + &:before, &:after { + } + + &:after { left: -40px; } +} + +.diff-line-number { + color: $text-muted; + display: inline-block; + font-size: $font-size-xs; + line-height: 2.3; + text-align: right; + width: 30px; +} + +.diff-line-number-hide { visibility: hidden; } + +.diff-line-icon { + color: $diff-json-icon; + font-size: $font-size-xs; + float: right; + position: relative; + top: 2px; + right: 10px; +} + +.diff-json-new, .diff-json-old { + color: $diff-json-changed-fg; + + & .diff-line-number { color: $diff-json-changed-num; } +} + +.diff-json-new { background-color: $diff-json-new; } +.diff-json-old { background-color: $diff-json-old; } +.diff-json-added { background-color: $diff-json-added; } +.diff-json-deleted { background-color: $diff-json-deleted; } + +.diff-value { + user-select: all; +} + +// Basic +.diff-circle { margin-right: .5em; } +.diff-circle-changed { color: #f59433; } +.diff-circle-added { color: #29D761; } +.diff-circle-deleted { color: #fd474a; } + +.diff-item-added, .diff-item-deleted { list-style: none; } + +.diff-restore-btn { + float: right; +} + +.diff-group { + background: $diff-group-bg; + font-size: 16px; + font-style: normal; + padding: 10px 15px; + margin: 1rem 0; + + & .diff-group { padding: 0 5px; } +} + +.diff-group-name { + display: inline-block; + width: 100%; + font-size: 16px; + padding-left: 1.75em; + margin: 0 0 14px 0; +} + +.diff-summary-key { + padding-left: .25em; +} + +.diff-list { + padding-left: 40px; + + & .diff-list { padding-left: 0; } +} + +.diff-item { + color: $gray-2; + line-height: 2.5; + + & > div { display: inline; } +} + +.diff-item-changeset { + list-style: none; +} + +.diff-label { + background-color: $diff-label-bg; + border-radius: 3px; + color: $diff-label-fg; + display: inline; + font-size: .95rem; + margin: 0 5px; + padding: 3px 8px; +} + +.diff-linenum { + float: right; +} + +.diff-arrow { + color: $diff-arrow-color; +} + +.diff-block { + width: 100%; + display: inline-block; +} + +.diff-block-title { + font-size: 16px; + display: inline-block; +} + +.diff-title { + font-size: 16px; +} + +.diff-change-container { + margin: 0 0; + padding-left: 3em; + padding-right: 0; +} + +.diff-change-group { + width: 100%; + color: rgba(223,224,225, .6); + margin-bottom: 14px; +} + +.diff-change-item { + display: inline-block; +} + +.diff-change-title { + font-size: 16px; +} + +.bullet-position-container { + position: relative; + left: -6px; +} + +.diff-list-circle { + font-size: 10px; +} diff --git a/public/sass/pages/_dashboard.scss b/public/sass/pages/_dashboard.scss index e75406c2c8a..2a35a8742b5 100644 --- a/public/sass/pages/_dashboard.scss +++ b/public/sass/pages/_dashboard.scss @@ -255,4 +255,3 @@ div.flot-text { padding: 0.5rem .5rem .2rem .5rem; } } - diff --git a/public/test/mocks/audit-mocks.js b/public/test/mocks/audit-mocks.js new file mode 100644 index 00000000000..e92f152558d --- /dev/null +++ b/public/test/mocks/audit-mocks.js @@ -0,0 +1,197 @@ +define([], + function() { + 'use strict'; + + return { + versions: function() { + return [{ + id: 4, + dashboardId: 1, + parentVersion: 3, + restoredFrom: 0, + version: 4, + created: '2017-02-22T17:43:01-08:00', + createdBy: 'admin', + message: '', + }, + { + id: 3, + dashboardId: 1, + parentVersion: 1, + restoredFrom: 1, + version: 3, + created: '2017-02-22T17:43:01-08:00', + createdBy: 'admin', + message: '', + }, + { + id: 2, + dashboardId: 1, + parentVersion: 0, + restoredFrom: -1, + version: 2, + created: '2017-02-22T17:29:52-08:00', + createdBy: 'admin', + message: '', + }, + { + id: 1, + dashboardId: 1, + parentVersion: 0, + restoredFrom: -1, + slug: 'audit-dashboard', + version: 1, + created: '2017-02-22T17:06:37-08:00', + createdBy: 'admin', + message: '', + }]; + }, + compare: function(type) { + return type === 'basic' ? '
      ' : '
      '; + }, + restore: function(version, restoredFrom) { + return { + dashboard: { + meta: { + type: 'db', + canSave: true, + canEdit: true, + canStar: true, + slug: 'audit-dashboard', + expires: '0001-01-01T00:00:00Z', + created: '2017-02-21T18:40:45-08:00', + updated: '2017-04-11T21:31:22.59219665-07:00', + updatedBy: 'admin', + createdBy: 'admin', + version: version, + }, + dashboard: { + annotations: { + list: [] + }, + description: 'A random dashboard for implementing the audit log', + editable: true, + gnetId: null, + graphTooltip: 0, + hideControls: false, + id: 1, + links: [], + restoredFrom: restoredFrom, + rows: [{ + collapse: false, + height: '250px', + panels: [{ + aliasColors: {}, + bars: false, + datasource: null, + fill: 1, + id: 1, + legend: { + avg: false, + current: false, + max: false, + min: false, + show: true, + total: false, + values: false + }, + lines: true, + linewidth: 1, + nullPointMode: "null", + percentage: false, + pointradius: 5, + points: false, + renderer: 'flot', + seriesOverrides: [], + span: 12, + stack: false, + steppedLine: false, + targets: [{}], + thresholds: [], + timeFrom: null, + timeShift: null, + title: 'Panel Title', + tooltip: { + shared: true, + sort: 0, + value_type: 'individual' + }, + type: 'graph', + xaxis: { + mode: 'time', + name: null, + show: true, + values: [] + }, + yaxes: [{ + format: 'short', + label: null, + logBase: 1, + max: null, + min: null, + show: true + }, { + format: 'short', + label: null, + logBase: 1, + max: null, + min: null, + show: true + }] + }], + repeat: null, + repeatIteration: null, + repeatRowId: null, + showTitle: false, + title: 'Dashboard Row', + titleSize: 'h6' + } + ], + schemaVersion: 14, + style: 'dark', + tags: [ + 'development' + ], + templating: { + 'list': [] + }, + time: { + from: 'now-6h', + to: 'now' + }, + timepicker: { + refresh_intervals: [ + '5s', + '10s', + '30s', + '1m', + '5m', + '15m', + '30m', + '1h', + '2h', + '1d', + ], + time_options: [ + '5m', + '15m', + '1h', + '6h', + '12h', + '24h', + '2d', + '7d', + '30d' + ] + }, + timezone: 'utc', + title: 'Audit Dashboard', + version: version, + } + }, + message: 'Dashboard restored to version ' + version, + version: version + }; + }, + }; +}); diff --git a/vendor/github.com/sergi/go-diff/LICENSE b/vendor/github.com/sergi/go-diff/LICENSE new file mode 100644 index 00000000000..937942c2b2c --- /dev/null +++ b/vendor/github.com/sergi/go-diff/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2012-2016 The go-diff Authors. All rights reserved. + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + diff --git a/vendor/github.com/sergi/go-diff/diffmatchpatch/diff.go b/vendor/github.com/sergi/go-diff/diffmatchpatch/diff.go new file mode 100644 index 00000000000..59b8851683f --- /dev/null +++ b/vendor/github.com/sergi/go-diff/diffmatchpatch/diff.go @@ -0,0 +1,1339 @@ +// Copyright (c) 2012-2016 The go-diff authors. All rights reserved. +// https://github.com/sergi/go-diff +// See the included LICENSE file for license details. +// +// go-diff is a Go implementation of Google's Diff, Match, and Patch library +// Original library is Copyright (c) 2006 Google Inc. +// http://code.google.com/p/google-diff-match-patch/ + +package diffmatchpatch + +import ( + "bytes" + "errors" + "fmt" + "html" + "math" + "net/url" + "regexp" + "strconv" + "strings" + "time" + "unicode/utf8" +) + +// Operation defines the operation of a diff item. +type Operation int8 + +const ( + // DiffDelete item represents a delete diff. + DiffDelete Operation = -1 + // DiffInsert item represents an insert diff. + DiffInsert Operation = 1 + // DiffEqual item represents an equal diff. + DiffEqual Operation = 0 +) + +// Diff represents one diff operation +type Diff struct { + Type Operation + Text string +} + +func splice(slice []Diff, index int, amount int, elements ...Diff) []Diff { + return append(slice[:index], append(elements, slice[index+amount:]...)...) +} + +// DiffMain finds the differences between two texts. +// If an invalid UTF-8 sequence is encountered, it will be replaced by the Unicode replacement character. +func (dmp *DiffMatchPatch) DiffMain(text1, text2 string, checklines bool) []Diff { + return dmp.DiffMainRunes([]rune(text1), []rune(text2), checklines) +} + +// DiffMainRunes finds the differences between two rune sequences. +// If an invalid UTF-8 sequence is encountered, it will be replaced by the Unicode replacement character. +func (dmp *DiffMatchPatch) DiffMainRunes(text1, text2 []rune, checklines bool) []Diff { + var deadline time.Time + if dmp.DiffTimeout > 0 { + deadline = time.Now().Add(dmp.DiffTimeout) + } + return dmp.diffMainRunes(text1, text2, checklines, deadline) +} + +func (dmp *DiffMatchPatch) diffMainRunes(text1, text2 []rune, checklines bool, deadline time.Time) []Diff { + if runesEqual(text1, text2) { + var diffs []Diff + if len(text1) > 0 { + diffs = append(diffs, Diff{DiffEqual, string(text1)}) + } + return diffs + } + // Trim off common prefix (speedup). + commonlength := commonPrefixLength(text1, text2) + commonprefix := text1[:commonlength] + text1 = text1[commonlength:] + text2 = text2[commonlength:] + + // Trim off common suffix (speedup). + commonlength = commonSuffixLength(text1, text2) + commonsuffix := text1[len(text1)-commonlength:] + text1 = text1[:len(text1)-commonlength] + text2 = text2[:len(text2)-commonlength] + + // Compute the diff on the middle block. + diffs := dmp.diffCompute(text1, text2, checklines, deadline) + + // Restore the prefix and suffix. + if len(commonprefix) != 0 { + diffs = append([]Diff{Diff{DiffEqual, string(commonprefix)}}, diffs...) + } + if len(commonsuffix) != 0 { + diffs = append(diffs, Diff{DiffEqual, string(commonsuffix)}) + } + + return dmp.DiffCleanupMerge(diffs) +} + +// diffCompute finds the differences between two rune slices. Assumes that the texts do not have any common prefix or suffix. +func (dmp *DiffMatchPatch) diffCompute(text1, text2 []rune, checklines bool, deadline time.Time) []Diff { + diffs := []Diff{} + if len(text1) == 0 { + // Just add some text (speedup). + return append(diffs, Diff{DiffInsert, string(text2)}) + } else if len(text2) == 0 { + // Just delete some text (speedup). + return append(diffs, Diff{DiffDelete, string(text1)}) + } + + var longtext, shorttext []rune + if len(text1) > len(text2) { + longtext = text1 + shorttext = text2 + } else { + longtext = text2 + shorttext = text1 + } + + if i := runesIndex(longtext, shorttext); i != -1 { + op := DiffInsert + // Swap insertions for deletions if diff is reversed. + if len(text1) > len(text2) { + op = DiffDelete + } + // Shorter text is inside the longer text (speedup). + return []Diff{ + Diff{op, string(longtext[:i])}, + Diff{DiffEqual, string(shorttext)}, + Diff{op, string(longtext[i+len(shorttext):])}, + } + } else if len(shorttext) == 1 { + // Single character string. + // After the previous speedup, the character can't be an equality. + return []Diff{ + Diff{DiffDelete, string(text1)}, + Diff{DiffInsert, string(text2)}, + } + // Check to see if the problem can be split in two. + } else if hm := dmp.diffHalfMatch(text1, text2); hm != nil { + // A half-match was found, sort out the return data. + text1A := hm[0] + text1B := hm[1] + text2A := hm[2] + text2B := hm[3] + midCommon := hm[4] + // Send both pairs off for separate processing. + diffsA := dmp.diffMainRunes(text1A, text2A, checklines, deadline) + diffsB := dmp.diffMainRunes(text1B, text2B, checklines, deadline) + // Merge the results. + return append(diffsA, append([]Diff{Diff{DiffEqual, string(midCommon)}}, diffsB...)...) + } else if checklines && len(text1) > 100 && len(text2) > 100 { + return dmp.diffLineMode(text1, text2, deadline) + } + return dmp.diffBisect(text1, text2, deadline) +} + +// diffLineMode does a quick line-level diff on both []runes, then rediff the parts for greater accuracy. This speedup can produce non-minimal diffs. +func (dmp *DiffMatchPatch) diffLineMode(text1, text2 []rune, deadline time.Time) []Diff { + // Scan the text on a line-by-line basis first. + text1, text2, linearray := dmp.diffLinesToRunes(text1, text2) + + diffs := dmp.diffMainRunes(text1, text2, false, deadline) + + // Convert the diff back to original text. + diffs = dmp.DiffCharsToLines(diffs, linearray) + // Eliminate freak matches (e.g. blank lines) + diffs = dmp.DiffCleanupSemantic(diffs) + + // Rediff any replacement blocks, this time character-by-character. + // Add a dummy entry at the end. + diffs = append(diffs, Diff{DiffEqual, ""}) + + pointer := 0 + countDelete := 0 + countInsert := 0 + + // NOTE: Rune slices are slower than using strings in this case. + textDelete := "" + textInsert := "" + + for pointer < len(diffs) { + switch diffs[pointer].Type { + case DiffInsert: + countInsert++ + textInsert += diffs[pointer].Text + case DiffDelete: + countDelete++ + textDelete += diffs[pointer].Text + case DiffEqual: + // Upon reaching an equality, check for prior redundancies. + if countDelete >= 1 && countInsert >= 1 { + // Delete the offending records and add the merged ones. + diffs = splice(diffs, pointer-countDelete-countInsert, + countDelete+countInsert) + + pointer = pointer - countDelete - countInsert + a := dmp.diffMainRunes([]rune(textDelete), []rune(textInsert), false, deadline) + for j := len(a) - 1; j >= 0; j-- { + diffs = splice(diffs, pointer, 0, a[j]) + } + pointer = pointer + len(a) + } + + countInsert = 0 + countDelete = 0 + textDelete = "" + textInsert = "" + } + pointer++ + } + + return diffs[:len(diffs)-1] // Remove the dummy entry at the end. +} + +// DiffBisect finds the 'middle snake' of a diff, split the problem in two and return the recursively constructed diff. +// If an invalid UTF-8 sequence is encountered, it will be replaced by the Unicode replacement character. +// See Myers 1986 paper: An O(ND) Difference Algorithm and Its Variations. +func (dmp *DiffMatchPatch) DiffBisect(text1, text2 string, deadline time.Time) []Diff { + // Unused in this code, but retained for interface compatibility. + return dmp.diffBisect([]rune(text1), []rune(text2), deadline) +} + +// diffBisect finds the 'middle snake' of a diff, splits the problem in two and returns the recursively constructed diff. +// See Myers's 1986 paper: An O(ND) Difference Algorithm and Its Variations. +func (dmp *DiffMatchPatch) diffBisect(runes1, runes2 []rune, deadline time.Time) []Diff { + // Cache the text lengths to prevent multiple calls. + runes1Len, runes2Len := len(runes1), len(runes2) + + maxD := (runes1Len + runes2Len + 1) / 2 + vOffset := maxD + vLength := 2 * maxD + + v1 := make([]int, vLength) + v2 := make([]int, vLength) + for i := range v1 { + v1[i] = -1 + v2[i] = -1 + } + v1[vOffset+1] = 0 + v2[vOffset+1] = 0 + + delta := runes1Len - runes2Len + // If the total number of characters is odd, then the front path will collide with the reverse path. + front := (delta%2 != 0) + // Offsets for start and end of k loop. Prevents mapping of space beyond the grid. + k1start := 0 + k1end := 0 + k2start := 0 + k2end := 0 + for d := 0; d < maxD; d++ { + // Bail out if deadline is reached. + if !deadline.IsZero() && time.Now().After(deadline) { + break + } + + // Walk the front path one step. + for k1 := -d + k1start; k1 <= d-k1end; k1 += 2 { + k1Offset := vOffset + k1 + var x1 int + + if k1 == -d || (k1 != d && v1[k1Offset-1] < v1[k1Offset+1]) { + x1 = v1[k1Offset+1] + } else { + x1 = v1[k1Offset-1] + 1 + } + + y1 := x1 - k1 + for x1 < runes1Len && y1 < runes2Len { + if runes1[x1] != runes2[y1] { + break + } + x1++ + y1++ + } + v1[k1Offset] = x1 + if x1 > runes1Len { + // Ran off the right of the graph. + k1end += 2 + } else if y1 > runes2Len { + // Ran off the bottom of the graph. + k1start += 2 + } else if front { + k2Offset := vOffset + delta - k1 + if k2Offset >= 0 && k2Offset < vLength && v2[k2Offset] != -1 { + // Mirror x2 onto top-left coordinate system. + x2 := runes1Len - v2[k2Offset] + if x1 >= x2 { + // Overlap detected. + return dmp.diffBisectSplit(runes1, runes2, x1, y1, deadline) + } + } + } + } + // Walk the reverse path one step. + for k2 := -d + k2start; k2 <= d-k2end; k2 += 2 { + k2Offset := vOffset + k2 + var x2 int + if k2 == -d || (k2 != d && v2[k2Offset-1] < v2[k2Offset+1]) { + x2 = v2[k2Offset+1] + } else { + x2 = v2[k2Offset-1] + 1 + } + var y2 = x2 - k2 + for x2 < runes1Len && y2 < runes2Len { + if runes1[runes1Len-x2-1] != runes2[runes2Len-y2-1] { + break + } + x2++ + y2++ + } + v2[k2Offset] = x2 + if x2 > runes1Len { + // Ran off the left of the graph. + k2end += 2 + } else if y2 > runes2Len { + // Ran off the top of the graph. + k2start += 2 + } else if !front { + k1Offset := vOffset + delta - k2 + if k1Offset >= 0 && k1Offset < vLength && v1[k1Offset] != -1 { + x1 := v1[k1Offset] + y1 := vOffset + x1 - k1Offset + // Mirror x2 onto top-left coordinate system. + x2 = runes1Len - x2 + if x1 >= x2 { + // Overlap detected. + return dmp.diffBisectSplit(runes1, runes2, x1, y1, deadline) + } + } + } + } + } + // Diff took too long and hit the deadline or number of diffs equals number of characters, no commonality at all. + return []Diff{ + Diff{DiffDelete, string(runes1)}, + Diff{DiffInsert, string(runes2)}, + } +} + +func (dmp *DiffMatchPatch) diffBisectSplit(runes1, runes2 []rune, x, y int, + deadline time.Time) []Diff { + runes1a := runes1[:x] + runes2a := runes2[:y] + runes1b := runes1[x:] + runes2b := runes2[y:] + + // Compute both diffs serially. + diffs := dmp.diffMainRunes(runes1a, runes2a, false, deadline) + diffsb := dmp.diffMainRunes(runes1b, runes2b, false, deadline) + + return append(diffs, diffsb...) +} + +// DiffLinesToChars splits two texts into a list of strings, and educes the texts to a string of hashes where each Unicode character represents one line. +// It's slightly faster to call DiffLinesToRunes first, followed by DiffMainRunes. +func (dmp *DiffMatchPatch) DiffLinesToChars(text1, text2 string) (string, string, []string) { + chars1, chars2, lineArray := dmp.DiffLinesToRunes(text1, text2) + return string(chars1), string(chars2), lineArray +} + +// DiffLinesToRunes splits two texts into a list of runes. Each rune represents one line. +func (dmp *DiffMatchPatch) DiffLinesToRunes(text1, text2 string) ([]rune, []rune, []string) { + // '\x00' is a valid character, but various debuggers don't like it. So we'll insert a junk entry to avoid generating a null character. + lineArray := []string{""} // e.g. lineArray[4] == 'Hello\n' + lineHash := map[string]int{} // e.g. lineHash['Hello\n'] == 4 + + chars1 := dmp.diffLinesToRunesMunge(text1, &lineArray, lineHash) + chars2 := dmp.diffLinesToRunesMunge(text2, &lineArray, lineHash) + + return chars1, chars2, lineArray +} + +func (dmp *DiffMatchPatch) diffLinesToRunes(text1, text2 []rune) ([]rune, []rune, []string) { + return dmp.DiffLinesToRunes(string(text1), string(text2)) +} + +// diffLinesToRunesMunge splits a text into an array of strings, and reduces the texts to a []rune where each Unicode character represents one line. +// We use strings instead of []runes as input mainly because you can't use []rune as a map key. +func (dmp *DiffMatchPatch) diffLinesToRunesMunge(text string, lineArray *[]string, lineHash map[string]int) []rune { + // Walk the text, pulling out a substring for each line. text.split('\n') would would temporarily double our memory footprint. Modifying text would create many large strings to garbage collect. + lineStart := 0 + lineEnd := -1 + runes := []rune{} + + for lineEnd < len(text)-1 { + lineEnd = indexOf(text, "\n", lineStart) + + if lineEnd == -1 { + lineEnd = len(text) - 1 + } + + line := text[lineStart : lineEnd+1] + lineStart = lineEnd + 1 + lineValue, ok := lineHash[line] + + if ok { + runes = append(runes, rune(lineValue)) + } else { + *lineArray = append(*lineArray, line) + lineHash[line] = len(*lineArray) - 1 + runes = append(runes, rune(len(*lineArray)-1)) + } + } + + return runes +} + +// DiffCharsToLines rehydrates the text in a diff from a string of line hashes to real lines of text. +func (dmp *DiffMatchPatch) DiffCharsToLines(diffs []Diff, lineArray []string) []Diff { + hydrated := make([]Diff, 0, len(diffs)) + for _, aDiff := range diffs { + chars := aDiff.Text + text := make([]string, len(chars)) + + for i, r := range chars { + text[i] = lineArray[r] + } + + aDiff.Text = strings.Join(text, "") + hydrated = append(hydrated, aDiff) + } + return hydrated +} + +// DiffCommonPrefix determines the common prefix length of two strings. +func (dmp *DiffMatchPatch) DiffCommonPrefix(text1, text2 string) int { + // Unused in this code, but retained for interface compatibility. + return commonPrefixLength([]rune(text1), []rune(text2)) +} + +// DiffCommonSuffix determines the common suffix length of two strings. +func (dmp *DiffMatchPatch) DiffCommonSuffix(text1, text2 string) int { + // Unused in this code, but retained for interface compatibility. + return commonSuffixLength([]rune(text1), []rune(text2)) +} + +// commonPrefixLength returns the length of the common prefix of two rune slices. +func commonPrefixLength(text1, text2 []rune) int { + short, long := text1, text2 + if len(short) > len(long) { + short, long = long, short + } + for i, r := range short { + if r != long[i] { + return i + } + } + return len(short) +} + +// commonSuffixLength returns the length of the common suffix of two rune slices. +func commonSuffixLength(text1, text2 []rune) int { + n := min(len(text1), len(text2)) + for i := 0; i < n; i++ { + if text1[len(text1)-i-1] != text2[len(text2)-i-1] { + return i + } + } + return n + + // TODO research and benchmark this, why is it not activated? https://github.com/sergi/go-diff/issues/54 + // Binary search. + // Performance analysis: http://neil.fraser.name/news/2007/10/09/ + /* + pointermin := 0 + pointermax := math.Min(len(text1), len(text2)) + pointermid := pointermax + pointerend := 0 + for pointermin < pointermid { + if text1[len(text1)-pointermid:len(text1)-pointerend] == + text2[len(text2)-pointermid:len(text2)-pointerend] { + pointermin = pointermid + pointerend = pointermin + } else { + pointermax = pointermid + } + pointermid = math.Floor((pointermax-pointermin)/2 + pointermin) + } + return pointermid + */ +} + +// DiffCommonOverlap determines if the suffix of one string is the prefix of another. +func (dmp *DiffMatchPatch) DiffCommonOverlap(text1 string, text2 string) int { + // Cache the text lengths to prevent multiple calls. + text1Length := len(text1) + text2Length := len(text2) + // Eliminate the null case. + if text1Length == 0 || text2Length == 0 { + return 0 + } + // Truncate the longer string. + if text1Length > text2Length { + text1 = text1[text1Length-text2Length:] + } else if text1Length < text2Length { + text2 = text2[0:text1Length] + } + textLength := int(math.Min(float64(text1Length), float64(text2Length))) + // Quick check for the worst case. + if text1 == text2 { + return textLength + } + + // Start by looking for a single character match and increase length until no match is found. Performance analysis: http://neil.fraser.name/news/2010/11/04/ + best := 0 + length := 1 + for { + pattern := text1[textLength-length:] + found := strings.Index(text2, pattern) + if found == -1 { + break + } + length += found + if found == 0 || text1[textLength-length:] == text2[0:length] { + best = length + length++ + } + } + + return best +} + +// DiffHalfMatch checks whether the two texts share a substring which is at least half the length of the longer text. This speedup can produce non-minimal diffs. +func (dmp *DiffMatchPatch) DiffHalfMatch(text1, text2 string) []string { + // Unused in this code, but retained for interface compatibility. + runeSlices := dmp.diffHalfMatch([]rune(text1), []rune(text2)) + if runeSlices == nil { + return nil + } + + result := make([]string, len(runeSlices)) + for i, r := range runeSlices { + result[i] = string(r) + } + return result +} + +func (dmp *DiffMatchPatch) diffHalfMatch(text1, text2 []rune) [][]rune { + if dmp.DiffTimeout <= 0 { + // Don't risk returning a non-optimal diff if we have unlimited time. + return nil + } + + var longtext, shorttext []rune + if len(text1) > len(text2) { + longtext = text1 + shorttext = text2 + } else { + longtext = text2 + shorttext = text1 + } + + if len(longtext) < 4 || len(shorttext)*2 < len(longtext) { + return nil // Pointless. + } + + // First check if the second quarter is the seed for a half-match. + hm1 := dmp.diffHalfMatchI(longtext, shorttext, int(float64(len(longtext)+3)/4)) + + // Check again based on the third quarter. + hm2 := dmp.diffHalfMatchI(longtext, shorttext, int(float64(len(longtext)+1)/2)) + + hm := [][]rune{} + if hm1 == nil && hm2 == nil { + return nil + } else if hm2 == nil { + hm = hm1 + } else if hm1 == nil { + hm = hm2 + } else { + // Both matched. Select the longest. + if len(hm1[4]) > len(hm2[4]) { + hm = hm1 + } else { + hm = hm2 + } + } + + // A half-match was found, sort out the return data. + if len(text1) > len(text2) { + return hm + } + + return [][]rune{hm[2], hm[3], hm[0], hm[1], hm[4]} +} + +// diffHalfMatchI checks if a substring of shorttext exist within longtext such that the substring is at least half the length of longtext? +// Returns a slice containing the prefix of longtext, the suffix of longtext, the prefix of shorttext, the suffix of shorttext and the common middle, or null if there was no match. +func (dmp *DiffMatchPatch) diffHalfMatchI(l, s []rune, i int) [][]rune { + var bestCommonA []rune + var bestCommonB []rune + var bestCommonLen int + var bestLongtextA []rune + var bestLongtextB []rune + var bestShorttextA []rune + var bestShorttextB []rune + + // Start with a 1/4 length substring at position i as a seed. + seed := l[i : i+len(l)/4] + + for j := runesIndexOf(s, seed, 0); j != -1; j = runesIndexOf(s, seed, j+1) { + prefixLength := commonPrefixLength(l[i:], s[j:]) + suffixLength := commonSuffixLength(l[:i], s[:j]) + + if bestCommonLen < suffixLength+prefixLength { + bestCommonA = s[j-suffixLength : j] + bestCommonB = s[j : j+prefixLength] + bestCommonLen = len(bestCommonA) + len(bestCommonB) + bestLongtextA = l[:i-suffixLength] + bestLongtextB = l[i+prefixLength:] + bestShorttextA = s[:j-suffixLength] + bestShorttextB = s[j+prefixLength:] + } + } + + if bestCommonLen*2 < len(l) { + return nil + } + + return [][]rune{ + bestLongtextA, + bestLongtextB, + bestShorttextA, + bestShorttextB, + append(bestCommonA, bestCommonB...), + } +} + +// DiffCleanupSemantic reduces the number of edits by eliminating semantically trivial equalities. +func (dmp *DiffMatchPatch) DiffCleanupSemantic(diffs []Diff) []Diff { + changes := false + // Stack of indices where equalities are found. + type equality struct { + data int + next *equality + } + var equalities *equality + + var lastequality string + // Always equal to diffs[equalities[equalitiesLength - 1]][1] + var pointer int // Index of current position. + // Number of characters that changed prior to the equality. + var lengthInsertions1, lengthDeletions1 int + // Number of characters that changed after the equality. + var lengthInsertions2, lengthDeletions2 int + + for pointer < len(diffs) { + if diffs[pointer].Type == DiffEqual { + // Equality found. + + equalities = &equality{ + data: pointer, + next: equalities, + } + lengthInsertions1 = lengthInsertions2 + lengthDeletions1 = lengthDeletions2 + lengthInsertions2 = 0 + lengthDeletions2 = 0 + lastequality = diffs[pointer].Text + } else { + // An insertion or deletion. + + if diffs[pointer].Type == DiffInsert { + lengthInsertions2 += len(diffs[pointer].Text) + } else { + lengthDeletions2 += len(diffs[pointer].Text) + } + // Eliminate an equality that is smaller or equal to the edits on both sides of it. + difference1 := int(math.Max(float64(lengthInsertions1), float64(lengthDeletions1))) + difference2 := int(math.Max(float64(lengthInsertions2), float64(lengthDeletions2))) + if len(lastequality) > 0 && + (len(lastequality) <= difference1) && + (len(lastequality) <= difference2) { + // Duplicate record. + insPoint := equalities.data + diffs = append( + diffs[:insPoint], + append([]Diff{Diff{DiffDelete, lastequality}}, diffs[insPoint:]...)...) + + // Change second copy to insert. + diffs[insPoint+1].Type = DiffInsert + // Throw away the equality we just deleted. + equalities = equalities.next + + if equalities != nil { + equalities = equalities.next + } + if equalities != nil { + pointer = equalities.data + } else { + pointer = -1 + } + + lengthInsertions1 = 0 // Reset the counters. + lengthDeletions1 = 0 + lengthInsertions2 = 0 + lengthDeletions2 = 0 + lastequality = "" + changes = true + } + } + pointer++ + } + + // Normalize the diff. + if changes { + diffs = dmp.DiffCleanupMerge(diffs) + } + diffs = dmp.DiffCleanupSemanticLossless(diffs) + // Find any overlaps between deletions and insertions. + // e.g: abcxxxxxxdef + // -> abcxxxdef + // e.g: xxxabcdefxxx + // -> defxxxabc + // Only extract an overlap if it is as big as the edit ahead or behind it. + pointer = 1 + for pointer < len(diffs) { + if diffs[pointer-1].Type == DiffDelete && + diffs[pointer].Type == DiffInsert { + deletion := diffs[pointer-1].Text + insertion := diffs[pointer].Text + overlapLength1 := dmp.DiffCommonOverlap(deletion, insertion) + overlapLength2 := dmp.DiffCommonOverlap(insertion, deletion) + if overlapLength1 >= overlapLength2 { + if float64(overlapLength1) >= float64(len(deletion))/2 || + float64(overlapLength1) >= float64(len(insertion))/2 { + + // Overlap found. Insert an equality and trim the surrounding edits. + diffs = append( + diffs[:pointer], + append([]Diff{Diff{DiffEqual, insertion[:overlapLength1]}}, diffs[pointer:]...)...) + + diffs[pointer-1].Text = + deletion[0 : len(deletion)-overlapLength1] + diffs[pointer+1].Text = insertion[overlapLength1:] + pointer++ + } + } else { + if float64(overlapLength2) >= float64(len(deletion))/2 || + float64(overlapLength2) >= float64(len(insertion))/2 { + // Reverse overlap found. Insert an equality and swap and trim the surrounding edits. + overlap := Diff{DiffEqual, deletion[:overlapLength2]} + diffs = append( + diffs[:pointer], + append([]Diff{overlap}, diffs[pointer:]...)...) + + diffs[pointer-1].Type = DiffInsert + diffs[pointer-1].Text = insertion[0 : len(insertion)-overlapLength2] + diffs[pointer+1].Type = DiffDelete + diffs[pointer+1].Text = deletion[overlapLength2:] + pointer++ + } + } + pointer++ + } + pointer++ + } + + return diffs +} + +// Define some regex patterns for matching boundaries. +var ( + nonAlphaNumericRegex = regexp.MustCompile(`[^a-zA-Z0-9]`) + whitespaceRegex = regexp.MustCompile(`\s`) + linebreakRegex = regexp.MustCompile(`[\r\n]`) + blanklineEndRegex = regexp.MustCompile(`\n\r?\n$`) + blanklineStartRegex = regexp.MustCompile(`^\r?\n\r?\n`) +) + +// diffCleanupSemanticScore computes a score representing whether the internal boundary falls on logical boundaries. +// Scores range from 6 (best) to 0 (worst). Closure, but does not reference any external variables. +func diffCleanupSemanticScore(one, two string) int { + if len(one) == 0 || len(two) == 0 { + // Edges are the best. + return 6 + } + + // Each port of this function behaves slightly differently due to subtle differences in each language's definition of things like 'whitespace'. Since this function's purpose is largely cosmetic, the choice has been made to use each language's native features rather than force total conformity. + rune1, _ := utf8.DecodeLastRuneInString(one) + rune2, _ := utf8.DecodeRuneInString(two) + char1 := string(rune1) + char2 := string(rune2) + + nonAlphaNumeric1 := nonAlphaNumericRegex.MatchString(char1) + nonAlphaNumeric2 := nonAlphaNumericRegex.MatchString(char2) + whitespace1 := nonAlphaNumeric1 && whitespaceRegex.MatchString(char1) + whitespace2 := nonAlphaNumeric2 && whitespaceRegex.MatchString(char2) + lineBreak1 := whitespace1 && linebreakRegex.MatchString(char1) + lineBreak2 := whitespace2 && linebreakRegex.MatchString(char2) + blankLine1 := lineBreak1 && blanklineEndRegex.MatchString(one) + blankLine2 := lineBreak2 && blanklineEndRegex.MatchString(two) + + if blankLine1 || blankLine2 { + // Five points for blank lines. + return 5 + } else if lineBreak1 || lineBreak2 { + // Four points for line breaks. + return 4 + } else if nonAlphaNumeric1 && !whitespace1 && whitespace2 { + // Three points for end of sentences. + return 3 + } else if whitespace1 || whitespace2 { + // Two points for whitespace. + return 2 + } else if nonAlphaNumeric1 || nonAlphaNumeric2 { + // One point for non-alphanumeric. + return 1 + } + return 0 +} + +// DiffCleanupSemanticLossless looks for single edits surrounded on both sides by equalities which can be shifted sideways to align the edit to a word boundary. +// E.g: The cat came. -> The cat came. +func (dmp *DiffMatchPatch) DiffCleanupSemanticLossless(diffs []Diff) []Diff { + pointer := 1 + + // Intentionally ignore the first and last element (don't need checking). + for pointer < len(diffs)-1 { + if diffs[pointer-1].Type == DiffEqual && + diffs[pointer+1].Type == DiffEqual { + + // This is a single edit surrounded by equalities. + equality1 := diffs[pointer-1].Text + edit := diffs[pointer].Text + equality2 := diffs[pointer+1].Text + + // First, shift the edit as far left as possible. + commonOffset := dmp.DiffCommonSuffix(equality1, edit) + if commonOffset > 0 { + commonString := edit[len(edit)-commonOffset:] + equality1 = equality1[0 : len(equality1)-commonOffset] + edit = commonString + edit[:len(edit)-commonOffset] + equality2 = commonString + equality2 + } + + // Second, step character by character right, looking for the best fit. + bestEquality1 := equality1 + bestEdit := edit + bestEquality2 := equality2 + bestScore := diffCleanupSemanticScore(equality1, edit) + + diffCleanupSemanticScore(edit, equality2) + + for len(edit) != 0 && len(equality2) != 0 { + _, sz := utf8.DecodeRuneInString(edit) + if len(equality2) < sz || edit[:sz] != equality2[:sz] { + break + } + equality1 += edit[:sz] + edit = edit[sz:] + equality2[:sz] + equality2 = equality2[sz:] + score := diffCleanupSemanticScore(equality1, edit) + + diffCleanupSemanticScore(edit, equality2) + // The >= encourages trailing rather than leading whitespace on edits. + if score >= bestScore { + bestScore = score + bestEquality1 = equality1 + bestEdit = edit + bestEquality2 = equality2 + } + } + + if diffs[pointer-1].Text != bestEquality1 { + // We have an improvement, save it back to the diff. + if len(bestEquality1) != 0 { + diffs[pointer-1].Text = bestEquality1 + } else { + diffs = splice(diffs, pointer-1, 1) + pointer-- + } + + diffs[pointer].Text = bestEdit + if len(bestEquality2) != 0 { + diffs[pointer+1].Text = bestEquality2 + } else { + diffs = append(diffs[:pointer+1], diffs[pointer+2:]...) + pointer-- + } + } + } + pointer++ + } + + return diffs +} + +// DiffCleanupEfficiency reduces the number of edits by eliminating operationally trivial equalities. +func (dmp *DiffMatchPatch) DiffCleanupEfficiency(diffs []Diff) []Diff { + changes := false + // Stack of indices where equalities are found. + type equality struct { + data int + next *equality + } + var equalities *equality + // Always equal to equalities[equalitiesLength-1][1] + lastequality := "" + pointer := 0 // Index of current position. + // Is there an insertion operation before the last equality. + preIns := false + // Is there a deletion operation before the last equality. + preDel := false + // Is there an insertion operation after the last equality. + postIns := false + // Is there a deletion operation after the last equality. + postDel := false + for pointer < len(diffs) { + if diffs[pointer].Type == DiffEqual { // Equality found. + if len(diffs[pointer].Text) < dmp.DiffEditCost && + (postIns || postDel) { + // Candidate found. + equalities = &equality{ + data: pointer, + next: equalities, + } + preIns = postIns + preDel = postDel + lastequality = diffs[pointer].Text + } else { + // Not a candidate, and can never become one. + equalities = nil + lastequality = "" + } + postIns = false + postDel = false + } else { // An insertion or deletion. + if diffs[pointer].Type == DiffDelete { + postDel = true + } else { + postIns = true + } + + // Five types to be split: + // ABXYCD + // AXCD + // ABXC + // AXCD + // ABXC + var sumPres int + if preIns { + sumPres++ + } + if preDel { + sumPres++ + } + if postIns { + sumPres++ + } + if postDel { + sumPres++ + } + if len(lastequality) > 0 && + ((preIns && preDel && postIns && postDel) || + ((len(lastequality) < dmp.DiffEditCost/2) && sumPres == 3)) { + + insPoint := equalities.data + + // Duplicate record. + diffs = append(diffs[:insPoint], + append([]Diff{Diff{DiffDelete, lastequality}}, diffs[insPoint:]...)...) + + // Change second copy to insert. + diffs[insPoint+1].Type = DiffInsert + // Throw away the equality we just deleted. + equalities = equalities.next + lastequality = "" + + if preIns && preDel { + // No changes made which could affect previous entry, keep going. + postIns = true + postDel = true + equalities = nil + } else { + if equalities != nil { + equalities = equalities.next + } + if equalities != nil { + pointer = equalities.data + } else { + pointer = -1 + } + postIns = false + postDel = false + } + changes = true + } + } + pointer++ + } + + if changes { + diffs = dmp.DiffCleanupMerge(diffs) + } + + return diffs +} + +// DiffCleanupMerge reorders and merges like edit sections. Merge equalities. +// Any edit section can move as long as it doesn't cross an equality. +func (dmp *DiffMatchPatch) DiffCleanupMerge(diffs []Diff) []Diff { + // Add a dummy entry at the end. + diffs = append(diffs, Diff{DiffEqual, ""}) + pointer := 0 + countDelete := 0 + countInsert := 0 + commonlength := 0 + textDelete := []rune(nil) + textInsert := []rune(nil) + + for pointer < len(diffs) { + switch diffs[pointer].Type { + case DiffInsert: + countInsert++ + textInsert = append(textInsert, []rune(diffs[pointer].Text)...) + pointer++ + break + case DiffDelete: + countDelete++ + textDelete = append(textDelete, []rune(diffs[pointer].Text)...) + pointer++ + break + case DiffEqual: + // Upon reaching an equality, check for prior redundancies. + if countDelete+countInsert > 1 { + if countDelete != 0 && countInsert != 0 { + // Factor out any common prefixies. + commonlength = commonPrefixLength(textInsert, textDelete) + if commonlength != 0 { + x := pointer - countDelete - countInsert + if x > 0 && diffs[x-1].Type == DiffEqual { + diffs[x-1].Text += string(textInsert[:commonlength]) + } else { + diffs = append([]Diff{Diff{DiffEqual, string(textInsert[:commonlength])}}, diffs...) + pointer++ + } + textInsert = textInsert[commonlength:] + textDelete = textDelete[commonlength:] + } + // Factor out any common suffixies. + commonlength = commonSuffixLength(textInsert, textDelete) + if commonlength != 0 { + insertIndex := len(textInsert) - commonlength + deleteIndex := len(textDelete) - commonlength + diffs[pointer].Text = string(textInsert[insertIndex:]) + diffs[pointer].Text + textInsert = textInsert[:insertIndex] + textDelete = textDelete[:deleteIndex] + } + } + // Delete the offending records and add the merged ones. + if countDelete == 0 { + diffs = splice(diffs, pointer-countInsert, + countDelete+countInsert, + Diff{DiffInsert, string(textInsert)}) + } else if countInsert == 0 { + diffs = splice(diffs, pointer-countDelete, + countDelete+countInsert, + Diff{DiffDelete, string(textDelete)}) + } else { + diffs = splice(diffs, pointer-countDelete-countInsert, + countDelete+countInsert, + Diff{DiffDelete, string(textDelete)}, + Diff{DiffInsert, string(textInsert)}) + } + + pointer = pointer - countDelete - countInsert + 1 + if countDelete != 0 { + pointer++ + } + if countInsert != 0 { + pointer++ + } + } else if pointer != 0 && diffs[pointer-1].Type == DiffEqual { + // Merge this equality with the previous one. + diffs[pointer-1].Text += diffs[pointer].Text + diffs = append(diffs[:pointer], diffs[pointer+1:]...) + } else { + pointer++ + } + countInsert = 0 + countDelete = 0 + textDelete = nil + textInsert = nil + break + } + } + + if len(diffs[len(diffs)-1].Text) == 0 { + diffs = diffs[0 : len(diffs)-1] // Remove the dummy entry at the end. + } + + // Second pass: look for single edits surrounded on both sides by equalities which can be shifted sideways to eliminate an equality. E.g: ABAC -> ABAC + changes := false + pointer = 1 + // Intentionally ignore the first and last element (don't need checking). + for pointer < (len(diffs) - 1) { + if diffs[pointer-1].Type == DiffEqual && + diffs[pointer+1].Type == DiffEqual { + // This is a single edit surrounded by equalities. + if strings.HasSuffix(diffs[pointer].Text, diffs[pointer-1].Text) { + // Shift the edit over the previous equality. + diffs[pointer].Text = diffs[pointer-1].Text + + diffs[pointer].Text[:len(diffs[pointer].Text)-len(diffs[pointer-1].Text)] + diffs[pointer+1].Text = diffs[pointer-1].Text + diffs[pointer+1].Text + diffs = splice(diffs, pointer-1, 1) + changes = true + } else if strings.HasPrefix(diffs[pointer].Text, diffs[pointer+1].Text) { + // Shift the edit over the next equality. + diffs[pointer-1].Text += diffs[pointer+1].Text + diffs[pointer].Text = + diffs[pointer].Text[len(diffs[pointer+1].Text):] + diffs[pointer+1].Text + diffs = splice(diffs, pointer+1, 1) + changes = true + } + } + pointer++ + } + + // If shifts were made, the diff needs reordering and another shift sweep. + if changes { + diffs = dmp.DiffCleanupMerge(diffs) + } + + return diffs +} + +// DiffXIndex returns the equivalent location in s2. +func (dmp *DiffMatchPatch) DiffXIndex(diffs []Diff, loc int) int { + chars1 := 0 + chars2 := 0 + lastChars1 := 0 + lastChars2 := 0 + lastDiff := Diff{} + for i := 0; i < len(diffs); i++ { + aDiff := diffs[i] + if aDiff.Type != DiffInsert { + // Equality or deletion. + chars1 += len(aDiff.Text) + } + if aDiff.Type != DiffDelete { + // Equality or insertion. + chars2 += len(aDiff.Text) + } + if chars1 > loc { + // Overshot the location. + lastDiff = aDiff + break + } + lastChars1 = chars1 + lastChars2 = chars2 + } + if lastDiff.Type == DiffDelete { + // The location was deleted. + return lastChars2 + } + // Add the remaining character length. + return lastChars2 + (loc - lastChars1) +} + +// DiffPrettyHtml converts a []Diff into a pretty HTML report. +// It is intended as an example from which to write one's own display functions. +func (dmp *DiffMatchPatch) DiffPrettyHtml(diffs []Diff) string { + var buff bytes.Buffer + for _, diff := range diffs { + text := strings.Replace(html.EscapeString(diff.Text), "\n", "¶
      ", -1) + switch diff.Type { + case DiffInsert: + _, _ = buff.WriteString("") + _, _ = buff.WriteString(text) + _, _ = buff.WriteString("") + case DiffDelete: + _, _ = buff.WriteString("") + _, _ = buff.WriteString(text) + _, _ = buff.WriteString("") + case DiffEqual: + _, _ = buff.WriteString("") + _, _ = buff.WriteString(text) + _, _ = buff.WriteString("") + } + } + return buff.String() +} + +// DiffPrettyText converts a []Diff into a colored text report. +func (dmp *DiffMatchPatch) DiffPrettyText(diffs []Diff) string { + var buff bytes.Buffer + for _, diff := range diffs { + text := diff.Text + + switch diff.Type { + case DiffInsert: + _, _ = buff.WriteString("\x1b[32m") + _, _ = buff.WriteString(text) + _, _ = buff.WriteString("\x1b[0m") + case DiffDelete: + _, _ = buff.WriteString("\x1b[31m") + _, _ = buff.WriteString(text) + _, _ = buff.WriteString("\x1b[0m") + case DiffEqual: + _, _ = buff.WriteString(text) + } + } + + return buff.String() +} + +// DiffText1 computes and returns the source text (all equalities and deletions). +func (dmp *DiffMatchPatch) DiffText1(diffs []Diff) string { + //StringBuilder text = new StringBuilder() + var text bytes.Buffer + + for _, aDiff := range diffs { + if aDiff.Type != DiffInsert { + _, _ = text.WriteString(aDiff.Text) + } + } + return text.String() +} + +// DiffText2 computes and returns the destination text (all equalities and insertions). +func (dmp *DiffMatchPatch) DiffText2(diffs []Diff) string { + var text bytes.Buffer + + for _, aDiff := range diffs { + if aDiff.Type != DiffDelete { + _, _ = text.WriteString(aDiff.Text) + } + } + return text.String() +} + +// DiffLevenshtein computes the Levenshtein distance that is the number of inserted, deleted or substituted characters. +func (dmp *DiffMatchPatch) DiffLevenshtein(diffs []Diff) int { + levenshtein := 0 + insertions := 0 + deletions := 0 + + for _, aDiff := range diffs { + switch aDiff.Type { + case DiffInsert: + insertions += len(aDiff.Text) + case DiffDelete: + deletions += len(aDiff.Text) + case DiffEqual: + // A deletion and an insertion is one substitution. + levenshtein += max(insertions, deletions) + insertions = 0 + deletions = 0 + } + } + + levenshtein += max(insertions, deletions) + return levenshtein +} + +// DiffToDelta crushes the diff into an encoded string which describes the operations required to transform text1 into text2. +// E.g. =3\t-2\t+ing -> Keep 3 chars, delete 2 chars, insert 'ing'. Operations are tab-separated. Inserted text is escaped using %xx notation. +func (dmp *DiffMatchPatch) DiffToDelta(diffs []Diff) string { + var text bytes.Buffer + for _, aDiff := range diffs { + switch aDiff.Type { + case DiffInsert: + _, _ = text.WriteString("+") + _, _ = text.WriteString(strings.Replace(url.QueryEscape(aDiff.Text), "+", " ", -1)) + _, _ = text.WriteString("\t") + break + case DiffDelete: + _, _ = text.WriteString("-") + _, _ = text.WriteString(strconv.Itoa(utf8.RuneCountInString(aDiff.Text))) + _, _ = text.WriteString("\t") + break + case DiffEqual: + _, _ = text.WriteString("=") + _, _ = text.WriteString(strconv.Itoa(utf8.RuneCountInString(aDiff.Text))) + _, _ = text.WriteString("\t") + break + } + } + delta := text.String() + if len(delta) != 0 { + // Strip off trailing tab character. + delta = delta[0 : utf8.RuneCountInString(delta)-1] + delta = unescaper.Replace(delta) + } + return delta +} + +// DiffFromDelta given the original text1, and an encoded string which describes the operations required to transform text1 into text2, comAdde the full diff. +func (dmp *DiffMatchPatch) DiffFromDelta(text1 string, delta string) (diffs []Diff, err error) { + i := 0 + + for _, token := range strings.Split(delta, "\t") { + if len(token) == 0 { + // Blank tokens are ok (from a trailing \t). + continue + } + + // Each token begins with a one character parameter which specifies the operation of this token (delete, insert, equality). + param := token[1:] + + switch op := token[0]; op { + case '+': + // Decode would Diff all "+" to " " + param = strings.Replace(param, "+", "%2b", -1) + param, err = url.QueryUnescape(param) + if err != nil { + return nil, err + } + if !utf8.ValidString(param) { + return nil, fmt.Errorf("invalid UTF-8 token: %q", param) + } + + diffs = append(diffs, Diff{DiffInsert, param}) + case '=', '-': + n, err := strconv.ParseInt(param, 10, 0) + if err != nil { + return nil, err + } else if n < 0 { + return nil, errors.New("Negative number in DiffFromDelta: " + param) + } + + // Remember that string slicing is by byte - we want by rune here. + text := string([]rune(text1)[i : i+int(n)]) + i += int(n) + + if op == '=' { + diffs = append(diffs, Diff{DiffEqual, text}) + } else { + diffs = append(diffs, Diff{DiffDelete, text}) + } + default: + // Anything else is an error. + return nil, errors.New("Invalid diff operation in DiffFromDelta: " + string(token[0])) + } + } + + if i != len([]rune(text1)) { + return nil, fmt.Errorf("Delta length (%v) smaller than source text length (%v)", i, len(text1)) + } + + return diffs, nil +} diff --git a/vendor/github.com/sergi/go-diff/diffmatchpatch/diffmatchpatch.go b/vendor/github.com/sergi/go-diff/diffmatchpatch/diffmatchpatch.go new file mode 100644 index 00000000000..d3acc32ce13 --- /dev/null +++ b/vendor/github.com/sergi/go-diff/diffmatchpatch/diffmatchpatch.go @@ -0,0 +1,46 @@ +// Copyright (c) 2012-2016 The go-diff authors. All rights reserved. +// https://github.com/sergi/go-diff +// See the included LICENSE file for license details. +// +// go-diff is a Go implementation of Google's Diff, Match, and Patch library +// Original library is Copyright (c) 2006 Google Inc. +// http://code.google.com/p/google-diff-match-patch/ + +// Package diffmatchpatch offers robust algorithms to perform the operations required for synchronizing plain text. +package diffmatchpatch + +import ( + "time" +) + +// DiffMatchPatch holds the configuration for diff-match-patch operations. +type DiffMatchPatch struct { + // Number of seconds to map a diff before giving up (0 for infinity). + DiffTimeout time.Duration + // Cost of an empty edit operation in terms of edit characters. + DiffEditCost int + // How far to search for a match (0 = exact location, 1000+ = broad match). A match this many characters away from the expected location will add 1.0 to the score (0.0 is a perfect match). + MatchDistance int + // When deleting a large block of text (over ~64 characters), how close do the contents have to be to match the expected contents. (0.0 = perfection, 1.0 = very loose). Note that MatchThreshold controls how closely the end points of a delete need to match. + PatchDeleteThreshold float64 + // Chunk size for context length. + PatchMargin int + // The number of bits in an int. + MatchMaxBits int + // At what point is no match declared (0.0 = perfection, 1.0 = very loose). + MatchThreshold float64 +} + +// New creates a new DiffMatchPatch object with default parameters. +func New() *DiffMatchPatch { + // Defaults. + return &DiffMatchPatch{ + DiffTimeout: time.Second, + DiffEditCost: 4, + MatchThreshold: 0.5, + MatchDistance: 1000, + PatchDeleteThreshold: 0.5, + PatchMargin: 4, + MatchMaxBits: 32, + } +} diff --git a/vendor/github.com/sergi/go-diff/diffmatchpatch/match.go b/vendor/github.com/sergi/go-diff/diffmatchpatch/match.go new file mode 100644 index 00000000000..17374e109fe --- /dev/null +++ b/vendor/github.com/sergi/go-diff/diffmatchpatch/match.go @@ -0,0 +1,160 @@ +// Copyright (c) 2012-2016 The go-diff authors. All rights reserved. +// https://github.com/sergi/go-diff +// See the included LICENSE file for license details. +// +// go-diff is a Go implementation of Google's Diff, Match, and Patch library +// Original library is Copyright (c) 2006 Google Inc. +// http://code.google.com/p/google-diff-match-patch/ + +package diffmatchpatch + +import ( + "math" +) + +// MatchMain locates the best instance of 'pattern' in 'text' near 'loc'. +// Returns -1 if no match found. +func (dmp *DiffMatchPatch) MatchMain(text, pattern string, loc int) int { + // Check for null inputs not needed since null can't be passed in C#. + + loc = int(math.Max(0, math.Min(float64(loc), float64(len(text))))) + if text == pattern { + // Shortcut (potentially not guaranteed by the algorithm) + return 0 + } else if len(text) == 0 { + // Nothing to match. + return -1 + } else if loc+len(pattern) <= len(text) && text[loc:loc+len(pattern)] == pattern { + // Perfect match at the perfect spot! (Includes case of null pattern) + return loc + } + // Do a fuzzy compare. + return dmp.MatchBitap(text, pattern, loc) +} + +// MatchBitap locates the best instance of 'pattern' in 'text' near 'loc' using the Bitap algorithm. +// Returns -1 if no match was found. +func (dmp *DiffMatchPatch) MatchBitap(text, pattern string, loc int) int { + // Initialise the alphabet. + s := dmp.MatchAlphabet(pattern) + + // Highest score beyond which we give up. + scoreThreshold := dmp.MatchThreshold + // Is there a nearby exact match? (speedup) + bestLoc := indexOf(text, pattern, loc) + if bestLoc != -1 { + scoreThreshold = math.Min(dmp.matchBitapScore(0, bestLoc, loc, + pattern), scoreThreshold) + // What about in the other direction? (speedup) + bestLoc = lastIndexOf(text, pattern, loc+len(pattern)) + if bestLoc != -1 { + scoreThreshold = math.Min(dmp.matchBitapScore(0, bestLoc, loc, + pattern), scoreThreshold) + } + } + + // Initialise the bit arrays. + matchmask := 1 << uint((len(pattern) - 1)) + bestLoc = -1 + + var binMin, binMid int + binMax := len(pattern) + len(text) + lastRd := []int{} + for d := 0; d < len(pattern); d++ { + // Scan for the best match; each iteration allows for one more error. Run a binary search to determine how far from 'loc' we can stray at this error level. + binMin = 0 + binMid = binMax + for binMin < binMid { + if dmp.matchBitapScore(d, loc+binMid, loc, pattern) <= scoreThreshold { + binMin = binMid + } else { + binMax = binMid + } + binMid = (binMax-binMin)/2 + binMin + } + // Use the result from this iteration as the maximum for the next. + binMax = binMid + start := int(math.Max(1, float64(loc-binMid+1))) + finish := int(math.Min(float64(loc+binMid), float64(len(text))) + float64(len(pattern))) + + rd := make([]int, finish+2) + rd[finish+1] = (1 << uint(d)) - 1 + + for j := finish; j >= start; j-- { + var charMatch int + if len(text) <= j-1 { + // Out of range. + charMatch = 0 + } else if _, ok := s[text[j-1]]; !ok { + charMatch = 0 + } else { + charMatch = s[text[j-1]] + } + + if d == 0 { + // First pass: exact match. + rd[j] = ((rd[j+1] << 1) | 1) & charMatch + } else { + // Subsequent passes: fuzzy match. + rd[j] = ((rd[j+1]<<1)|1)&charMatch | (((lastRd[j+1] | lastRd[j]) << 1) | 1) | lastRd[j+1] + } + if (rd[j] & matchmask) != 0 { + score := dmp.matchBitapScore(d, j-1, loc, pattern) + // This match will almost certainly be better than any existing match. But check anyway. + if score <= scoreThreshold { + // Told you so. + scoreThreshold = score + bestLoc = j - 1 + if bestLoc > loc { + // When passing loc, don't exceed our current distance from loc. + start = int(math.Max(1, float64(2*loc-bestLoc))) + } else { + // Already passed loc, downhill from here on in. + break + } + } + } + } + if dmp.matchBitapScore(d+1, loc, loc, pattern) > scoreThreshold { + // No hope for a (better) match at greater error levels. + break + } + lastRd = rd + } + return bestLoc +} + +// matchBitapScore computes and returns the score for a match with e errors and x location. +func (dmp *DiffMatchPatch) matchBitapScore(e, x, loc int, pattern string) float64 { + accuracy := float64(e) / float64(len(pattern)) + proximity := math.Abs(float64(loc - x)) + if dmp.MatchDistance == 0 { + // Dodge divide by zero error. + if proximity == 0 { + return accuracy + } + + return 1.0 + } + return accuracy + (proximity / float64(dmp.MatchDistance)) +} + +// MatchAlphabet initialises the alphabet for the Bitap algorithm. +func (dmp *DiffMatchPatch) MatchAlphabet(pattern string) map[byte]int { + s := map[byte]int{} + charPattern := []byte(pattern) + for _, c := range charPattern { + _, ok := s[c] + if !ok { + s[c] = 0 + } + } + i := 0 + + for _, c := range charPattern { + value := s[c] | int(uint(1)< y { + return x + } + return y +} diff --git a/vendor/github.com/sergi/go-diff/diffmatchpatch/patch.go b/vendor/github.com/sergi/go-diff/diffmatchpatch/patch.go new file mode 100644 index 00000000000..116c0434811 --- /dev/null +++ b/vendor/github.com/sergi/go-diff/diffmatchpatch/patch.go @@ -0,0 +1,556 @@ +// Copyright (c) 2012-2016 The go-diff authors. All rights reserved. +// https://github.com/sergi/go-diff +// See the included LICENSE file for license details. +// +// go-diff is a Go implementation of Google's Diff, Match, and Patch library +// Original library is Copyright (c) 2006 Google Inc. +// http://code.google.com/p/google-diff-match-patch/ + +package diffmatchpatch + +import ( + "bytes" + "errors" + "math" + "net/url" + "regexp" + "strconv" + "strings" +) + +// Patch represents one patch operation. +type Patch struct { + diffs []Diff + start1 int + start2 int + length1 int + length2 int +} + +// String emulates GNU diff's format. +// Header: @@ -382,8 +481,9 @@ +// Indicies are printed as 1-based, not 0-based. +func (p *Patch) String() string { + var coords1, coords2 string + + if p.length1 == 0 { + coords1 = strconv.Itoa(p.start1) + ",0" + } else if p.length1 == 1 { + coords1 = strconv.Itoa(p.start1 + 1) + } else { + coords1 = strconv.Itoa(p.start1+1) + "," + strconv.Itoa(p.length1) + } + + if p.length2 == 0 { + coords2 = strconv.Itoa(p.start2) + ",0" + } else if p.length2 == 1 { + coords2 = strconv.Itoa(p.start2 + 1) + } else { + coords2 = strconv.Itoa(p.start2+1) + "," + strconv.Itoa(p.length2) + } + + var text bytes.Buffer + _, _ = text.WriteString("@@ -" + coords1 + " +" + coords2 + " @@\n") + + // Escape the body of the patch with %xx notation. + for _, aDiff := range p.diffs { + switch aDiff.Type { + case DiffInsert: + _, _ = text.WriteString("+") + case DiffDelete: + _, _ = text.WriteString("-") + case DiffEqual: + _, _ = text.WriteString(" ") + } + + _, _ = text.WriteString(strings.Replace(url.QueryEscape(aDiff.Text), "+", " ", -1)) + _, _ = text.WriteString("\n") + } + + return unescaper.Replace(text.String()) +} + +// PatchAddContext increases the context until it is unique, but doesn't let the pattern expand beyond MatchMaxBits. +func (dmp *DiffMatchPatch) PatchAddContext(patch Patch, text string) Patch { + if len(text) == 0 { + return patch + } + + pattern := text[patch.start2 : patch.start2+patch.length1] + padding := 0 + + // Look for the first and last matches of pattern in text. If two different matches are found, increase the pattern length. + for strings.Index(text, pattern) != strings.LastIndex(text, pattern) && + len(pattern) < dmp.MatchMaxBits-2*dmp.PatchMargin { + padding += dmp.PatchMargin + maxStart := max(0, patch.start2-padding) + minEnd := min(len(text), patch.start2+patch.length1+padding) + pattern = text[maxStart:minEnd] + } + // Add one chunk for good luck. + padding += dmp.PatchMargin + + // Add the prefix. + prefix := text[max(0, patch.start2-padding):patch.start2] + if len(prefix) != 0 { + patch.diffs = append([]Diff{Diff{DiffEqual, prefix}}, patch.diffs...) + } + // Add the suffix. + suffix := text[patch.start2+patch.length1 : min(len(text), patch.start2+patch.length1+padding)] + if len(suffix) != 0 { + patch.diffs = append(patch.diffs, Diff{DiffEqual, suffix}) + } + + // Roll back the start points. + patch.start1 -= len(prefix) + patch.start2 -= len(prefix) + // Extend the lengths. + patch.length1 += len(prefix) + len(suffix) + patch.length2 += len(prefix) + len(suffix) + + return patch +} + +// PatchMake computes a list of patches. +func (dmp *DiffMatchPatch) PatchMake(opt ...interface{}) []Patch { + if len(opt) == 1 { + diffs, _ := opt[0].([]Diff) + text1 := dmp.DiffText1(diffs) + return dmp.PatchMake(text1, diffs) + } else if len(opt) == 2 { + text1 := opt[0].(string) + switch t := opt[1].(type) { + case string: + diffs := dmp.DiffMain(text1, t, true) + if len(diffs) > 2 { + diffs = dmp.DiffCleanupSemantic(diffs) + diffs = dmp.DiffCleanupEfficiency(diffs) + } + return dmp.PatchMake(text1, diffs) + case []Diff: + return dmp.patchMake2(text1, t) + } + } else if len(opt) == 3 { + return dmp.PatchMake(opt[0], opt[2]) + } + return []Patch{} +} + +// patchMake2 computes a list of patches to turn text1 into text2. +// text2 is not provided, diffs are the delta between text1 and text2. +func (dmp *DiffMatchPatch) patchMake2(text1 string, diffs []Diff) []Patch { + // Check for null inputs not needed since null can't be passed in C#. + patches := []Patch{} + if len(diffs) == 0 { + return patches // Get rid of the null case. + } + + patch := Patch{} + charCount1 := 0 // Number of characters into the text1 string. + charCount2 := 0 // Number of characters into the text2 string. + // Start with text1 (prepatchText) and apply the diffs until we arrive at text2 (postpatchText). We recreate the patches one by one to determine context info. + prepatchText := text1 + postpatchText := text1 + + for i, aDiff := range diffs { + if len(patch.diffs) == 0 && aDiff.Type != DiffEqual { + // A new patch starts here. + patch.start1 = charCount1 + patch.start2 = charCount2 + } + + switch aDiff.Type { + case DiffInsert: + patch.diffs = append(patch.diffs, aDiff) + patch.length2 += len(aDiff.Text) + postpatchText = postpatchText[:charCount2] + + aDiff.Text + postpatchText[charCount2:] + case DiffDelete: + patch.length1 += len(aDiff.Text) + patch.diffs = append(patch.diffs, aDiff) + postpatchText = postpatchText[:charCount2] + postpatchText[charCount2+len(aDiff.Text):] + case DiffEqual: + if len(aDiff.Text) <= 2*dmp.PatchMargin && + len(patch.diffs) != 0 && i != len(diffs)-1 { + // Small equality inside a patch. + patch.diffs = append(patch.diffs, aDiff) + patch.length1 += len(aDiff.Text) + patch.length2 += len(aDiff.Text) + } + if len(aDiff.Text) >= 2*dmp.PatchMargin { + // Time for a new patch. + if len(patch.diffs) != 0 { + patch = dmp.PatchAddContext(patch, prepatchText) + patches = append(patches, patch) + patch = Patch{} + // Unlike Unidiff, our patch lists have a rolling context. http://code.google.com/p/google-diff-match-patch/wiki/Unidiff Update prepatch text & pos to reflect the application of the just completed patch. + prepatchText = postpatchText + charCount1 = charCount2 + } + } + } + + // Update the current character count. + if aDiff.Type != DiffInsert { + charCount1 += len(aDiff.Text) + } + if aDiff.Type != DiffDelete { + charCount2 += len(aDiff.Text) + } + } + + // Pick up the leftover patch if not empty. + if len(patch.diffs) != 0 { + patch = dmp.PatchAddContext(patch, prepatchText) + patches = append(patches, patch) + } + + return patches +} + +// PatchDeepCopy returns an array that is identical to a given an array of patches. +func (dmp *DiffMatchPatch) PatchDeepCopy(patches []Patch) []Patch { + patchesCopy := []Patch{} + for _, aPatch := range patches { + patchCopy := Patch{} + for _, aDiff := range aPatch.diffs { + patchCopy.diffs = append(patchCopy.diffs, Diff{ + aDiff.Type, + aDiff.Text, + }) + } + patchCopy.start1 = aPatch.start1 + patchCopy.start2 = aPatch.start2 + patchCopy.length1 = aPatch.length1 + patchCopy.length2 = aPatch.length2 + patchesCopy = append(patchesCopy, patchCopy) + } + return patchesCopy +} + +// PatchApply merges a set of patches onto the text. Returns a patched text, as well as an array of true/false values indicating which patches were applied. +func (dmp *DiffMatchPatch) PatchApply(patches []Patch, text string) (string, []bool) { + if len(patches) == 0 { + return text, []bool{} + } + + // Deep copy the patches so that no changes are made to originals. + patches = dmp.PatchDeepCopy(patches) + + nullPadding := dmp.PatchAddPadding(patches) + text = nullPadding + text + nullPadding + patches = dmp.PatchSplitMax(patches) + + x := 0 + // delta keeps track of the offset between the expected and actual location of the previous patch. If there are patches expected at positions 10 and 20, but the first patch was found at 12, delta is 2 and the second patch has an effective expected position of 22. + delta := 0 + results := make([]bool, len(patches)) + for _, aPatch := range patches { + expectedLoc := aPatch.start2 + delta + text1 := dmp.DiffText1(aPatch.diffs) + var startLoc int + endLoc := -1 + if len(text1) > dmp.MatchMaxBits { + // PatchSplitMax will only provide an oversized pattern in the case of a monster delete. + startLoc = dmp.MatchMain(text, text1[:dmp.MatchMaxBits], expectedLoc) + if startLoc != -1 { + endLoc = dmp.MatchMain(text, + text1[len(text1)-dmp.MatchMaxBits:], expectedLoc+len(text1)-dmp.MatchMaxBits) + if endLoc == -1 || startLoc >= endLoc { + // Can't find valid trailing context. Drop this patch. + startLoc = -1 + } + } + } else { + startLoc = dmp.MatchMain(text, text1, expectedLoc) + } + if startLoc == -1 { + // No match found. :( + results[x] = false + // Subtract the delta for this failed patch from subsequent patches. + delta -= aPatch.length2 - aPatch.length1 + } else { + // Found a match. :) + results[x] = true + delta = startLoc - expectedLoc + var text2 string + if endLoc == -1 { + text2 = text[startLoc:int(math.Min(float64(startLoc+len(text1)), float64(len(text))))] + } else { + text2 = text[startLoc:int(math.Min(float64(endLoc+dmp.MatchMaxBits), float64(len(text))))] + } + if text1 == text2 { + // Perfect match, just shove the Replacement text in. + text = text[:startLoc] + dmp.DiffText2(aPatch.diffs) + text[startLoc+len(text1):] + } else { + // Imperfect match. Run a diff to get a framework of equivalent indices. + diffs := dmp.DiffMain(text1, text2, false) + if len(text1) > dmp.MatchMaxBits && float64(dmp.DiffLevenshtein(diffs))/float64(len(text1)) > dmp.PatchDeleteThreshold { + // The end points match, but the content is unacceptably bad. + results[x] = false + } else { + diffs = dmp.DiffCleanupSemanticLossless(diffs) + index1 := 0 + for _, aDiff := range aPatch.diffs { + if aDiff.Type != DiffEqual { + index2 := dmp.DiffXIndex(diffs, index1) + if aDiff.Type == DiffInsert { + // Insertion + text = text[:startLoc+index2] + aDiff.Text + text[startLoc+index2:] + } else if aDiff.Type == DiffDelete { + // Deletion + startIndex := startLoc + index2 + text = text[:startIndex] + + text[startIndex+dmp.DiffXIndex(diffs, index1+len(aDiff.Text))-index2:] + } + } + if aDiff.Type != DiffDelete { + index1 += len(aDiff.Text) + } + } + } + } + } + x++ + } + // Strip the padding off. + text = text[len(nullPadding) : len(nullPadding)+(len(text)-2*len(nullPadding))] + return text, results +} + +// PatchAddPadding adds some padding on text start and end so that edges can match something. +// Intended to be called only from within patchApply. +func (dmp *DiffMatchPatch) PatchAddPadding(patches []Patch) string { + paddingLength := dmp.PatchMargin + nullPadding := "" + for x := 1; x <= paddingLength; x++ { + nullPadding += string(x) + } + + // Bump all the patches forward. + for i := range patches { + patches[i].start1 += paddingLength + patches[i].start2 += paddingLength + } + + // Add some padding on start of first diff. + if len(patches[0].diffs) == 0 || patches[0].diffs[0].Type != DiffEqual { + // Add nullPadding equality. + patches[0].diffs = append([]Diff{Diff{DiffEqual, nullPadding}}, patches[0].diffs...) + patches[0].start1 -= paddingLength // Should be 0. + patches[0].start2 -= paddingLength // Should be 0. + patches[0].length1 += paddingLength + patches[0].length2 += paddingLength + } else if paddingLength > len(patches[0].diffs[0].Text) { + // Grow first equality. + extraLength := paddingLength - len(patches[0].diffs[0].Text) + patches[0].diffs[0].Text = nullPadding[len(patches[0].diffs[0].Text):] + patches[0].diffs[0].Text + patches[0].start1 -= extraLength + patches[0].start2 -= extraLength + patches[0].length1 += extraLength + patches[0].length2 += extraLength + } + + // Add some padding on end of last diff. + last := len(patches) - 1 + if len(patches[last].diffs) == 0 || patches[last].diffs[len(patches[last].diffs)-1].Type != DiffEqual { + // Add nullPadding equality. + patches[last].diffs = append(patches[last].diffs, Diff{DiffEqual, nullPadding}) + patches[last].length1 += paddingLength + patches[last].length2 += paddingLength + } else if paddingLength > len(patches[last].diffs[len(patches[last].diffs)-1].Text) { + // Grow last equality. + lastDiff := patches[last].diffs[len(patches[last].diffs)-1] + extraLength := paddingLength - len(lastDiff.Text) + patches[last].diffs[len(patches[last].diffs)-1].Text += nullPadding[:extraLength] + patches[last].length1 += extraLength + patches[last].length2 += extraLength + } + + return nullPadding +} + +// PatchSplitMax looks through the patches and breaks up any which are longer than the maximum limit of the match algorithm. +// Intended to be called only from within patchApply. +func (dmp *DiffMatchPatch) PatchSplitMax(patches []Patch) []Patch { + patchSize := dmp.MatchMaxBits + for x := 0; x < len(patches); x++ { + if patches[x].length1 <= patchSize { + continue + } + bigpatch := patches[x] + // Remove the big old patch. + patches = append(patches[:x], patches[x+1:]...) + x-- + + start1 := bigpatch.start1 + start2 := bigpatch.start2 + precontext := "" + for len(bigpatch.diffs) != 0 { + // Create one of several smaller patches. + patch := Patch{} + empty := true + patch.start1 = start1 - len(precontext) + patch.start2 = start2 - len(precontext) + if len(precontext) != 0 { + patch.length1 = len(precontext) + patch.length2 = len(precontext) + patch.diffs = append(patch.diffs, Diff{DiffEqual, precontext}) + } + for len(bigpatch.diffs) != 0 && patch.length1 < patchSize-dmp.PatchMargin { + diffType := bigpatch.diffs[0].Type + diffText := bigpatch.diffs[0].Text + if diffType == DiffInsert { + // Insertions are harmless. + patch.length2 += len(diffText) + start2 += len(diffText) + patch.diffs = append(patch.diffs, bigpatch.diffs[0]) + bigpatch.diffs = bigpatch.diffs[1:] + empty = false + } else if diffType == DiffDelete && len(patch.diffs) == 1 && patch.diffs[0].Type == DiffEqual && len(diffText) > 2*patchSize { + // This is a large deletion. Let it pass in one chunk. + patch.length1 += len(diffText) + start1 += len(diffText) + empty = false + patch.diffs = append(patch.diffs, Diff{diffType, diffText}) + bigpatch.diffs = bigpatch.diffs[1:] + } else { + // Deletion or equality. Only take as much as we can stomach. + diffText = diffText[:min(len(diffText), patchSize-patch.length1-dmp.PatchMargin)] + + patch.length1 += len(diffText) + start1 += len(diffText) + if diffType == DiffEqual { + patch.length2 += len(diffText) + start2 += len(diffText) + } else { + empty = false + } + patch.diffs = append(patch.diffs, Diff{diffType, diffText}) + if diffText == bigpatch.diffs[0].Text { + bigpatch.diffs = bigpatch.diffs[1:] + } else { + bigpatch.diffs[0].Text = + bigpatch.diffs[0].Text[len(diffText):] + } + } + } + // Compute the head context for the next patch. + precontext = dmp.DiffText2(patch.diffs) + precontext = precontext[max(0, len(precontext)-dmp.PatchMargin):] + + postcontext := "" + // Append the end context for this patch. + if len(dmp.DiffText1(bigpatch.diffs)) > dmp.PatchMargin { + postcontext = dmp.DiffText1(bigpatch.diffs)[:dmp.PatchMargin] + } else { + postcontext = dmp.DiffText1(bigpatch.diffs) + } + + if len(postcontext) != 0 { + patch.length1 += len(postcontext) + patch.length2 += len(postcontext) + if len(patch.diffs) != 0 && patch.diffs[len(patch.diffs)-1].Type == DiffEqual { + patch.diffs[len(patch.diffs)-1].Text += postcontext + } else { + patch.diffs = append(patch.diffs, Diff{DiffEqual, postcontext}) + } + } + if !empty { + x++ + patches = append(patches[:x], append([]Patch{patch}, patches[x:]...)...) + } + } + } + return patches +} + +// PatchToText takes a list of patches and returns a textual representation. +func (dmp *DiffMatchPatch) PatchToText(patches []Patch) string { + var text bytes.Buffer + for _, aPatch := range patches { + _, _ = text.WriteString(aPatch.String()) + } + return text.String() +} + +// PatchFromText parses a textual representation of patches and returns a List of Patch objects. +func (dmp *DiffMatchPatch) PatchFromText(textline string) ([]Patch, error) { + patches := []Patch{} + if len(textline) == 0 { + return patches, nil + } + text := strings.Split(textline, "\n") + textPointer := 0 + patchHeader := regexp.MustCompile("^@@ -(\\d+),?(\\d*) \\+(\\d+),?(\\d*) @@$") + + var patch Patch + var sign uint8 + var line string + for textPointer < len(text) { + + if !patchHeader.MatchString(text[textPointer]) { + return patches, errors.New("Invalid patch string: " + text[textPointer]) + } + + patch = Patch{} + m := patchHeader.FindStringSubmatch(text[textPointer]) + + patch.start1, _ = strconv.Atoi(m[1]) + if len(m[2]) == 0 { + patch.start1-- + patch.length1 = 1 + } else if m[2] == "0" { + patch.length1 = 0 + } else { + patch.start1-- + patch.length1, _ = strconv.Atoi(m[2]) + } + + patch.start2, _ = strconv.Atoi(m[3]) + + if len(m[4]) == 0 { + patch.start2-- + patch.length2 = 1 + } else if m[4] == "0" { + patch.length2 = 0 + } else { + patch.start2-- + patch.length2, _ = strconv.Atoi(m[4]) + } + textPointer++ + + for textPointer < len(text) { + if len(text[textPointer]) > 0 { + sign = text[textPointer][0] + } else { + textPointer++ + continue + } + + line = text[textPointer][1:] + line = strings.Replace(line, "+", "%2b", -1) + line, _ = url.QueryUnescape(line) + if sign == '-' { + // Deletion. + patch.diffs = append(patch.diffs, Diff{DiffDelete, line}) + } else if sign == '+' { + // Insertion. + patch.diffs = append(patch.diffs, Diff{DiffInsert, line}) + } else if sign == ' ' { + // Minor equality. + patch.diffs = append(patch.diffs, Diff{DiffEqual, line}) + } else if sign == '@' { + // Start of next patch. + break + } else { + // WTF? + return patches, errors.New("Invalid patch mode '" + string(sign) + "' in: " + string(line)) + } + textPointer++ + } + + patches = append(patches, patch) + } + return patches, nil +} diff --git a/vendor/github.com/sergi/go-diff/diffmatchpatch/stringutil.go b/vendor/github.com/sergi/go-diff/diffmatchpatch/stringutil.go new file mode 100644 index 00000000000..265f29cc7e5 --- /dev/null +++ b/vendor/github.com/sergi/go-diff/diffmatchpatch/stringutil.go @@ -0,0 +1,88 @@ +// Copyright (c) 2012-2016 The go-diff authors. All rights reserved. +// https://github.com/sergi/go-diff +// See the included LICENSE file for license details. +// +// go-diff is a Go implementation of Google's Diff, Match, and Patch library +// Original library is Copyright (c) 2006 Google Inc. +// http://code.google.com/p/google-diff-match-patch/ + +package diffmatchpatch + +import ( + "strings" + "unicode/utf8" +) + +// unescaper unescapes selected chars for compatibility with JavaScript's encodeURI. +// In speed critical applications this could be dropped since the receiving application will certainly decode these fine. Note that this function is case-sensitive. Thus "%3F" would not be unescaped. But this is ok because it is only called with the output of HttpUtility.UrlEncode which returns lowercase hex. Example: "%3f" -> "?", "%24" -> "$", etc. +var unescaper = strings.NewReplacer( + "%21", "!", "%7E", "~", "%27", "'", + "%28", "(", "%29", ")", "%3B", ";", + "%2F", "/", "%3F", "?", "%3A", ":", + "%40", "@", "%26", "&", "%3D", "=", + "%2B", "+", "%24", "$", "%2C", ",", "%23", "#", "%2A", "*") + +// indexOf returns the first index of pattern in str, starting at str[i]. +func indexOf(str string, pattern string, i int) int { + if i > len(str)-1 { + return -1 + } + if i <= 0 { + return strings.Index(str, pattern) + } + ind := strings.Index(str[i:], pattern) + if ind == -1 { + return -1 + } + return ind + i +} + +// lastIndexOf returns the last index of pattern in str, starting at str[i]. +func lastIndexOf(str string, pattern string, i int) int { + if i < 0 { + return -1 + } + if i >= len(str) { + return strings.LastIndex(str, pattern) + } + _, size := utf8.DecodeRuneInString(str[i:]) + return strings.LastIndex(str[:i+size], pattern) +} + +// runesIndexOf returns the index of pattern in target, starting at target[i]. +func runesIndexOf(target, pattern []rune, i int) int { + if i > len(target)-1 { + return -1 + } + if i <= 0 { + return runesIndex(target, pattern) + } + ind := runesIndex(target[i:], pattern) + if ind == -1 { + return -1 + } + return ind + i +} + +func runesEqual(r1, r2 []rune) bool { + if len(r1) != len(r2) { + return false + } + for i, c := range r1 { + if c != r2[i] { + return false + } + } + return true +} + +// runesIndex is the equivalent of strings.Index for rune slices. +func runesIndex(r1, r2 []rune) int { + last := len(r1) - len(r2) + for i := 0; i <= last; i++ { + if runesEqual(r1[i:i+len(r2)], r2) { + return i + } + } + return -1 +} diff --git a/vendor/github.com/yudai/gojsondiff/LICENSE b/vendor/github.com/yudai/gojsondiff/LICENSE new file mode 100644 index 00000000000..445f43cdf11 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/LICENSE @@ -0,0 +1,145 @@ +The MIT License (MIT) + +Copyright (c) 2015 Iwasaki Yudai + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +============================================================================ + +This repository is build with following third party libraries. Thank you! + +## go-diff - https://github.com/sergi/go-diff + +Copyright (c) 2012 Sergi Mansilla + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included +in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + + +## golcs - https://github.com/yudai/golcs + +The MIT License (MIT) + +Copyright (c) 2015 Iwasaki Yudai + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + + +## cli.go - https://github.com/urfave/cli + +Copyright (C) 2013 Jeremy Saenz +All Rights Reserved. + +MIT LICENSE + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +## ginkgo - https://github.com/onsi/ginkgo + +Copyright (c) 2013-2014 Onsi Fakhouri + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +# gomega - https://github.com/onsi/gomega + +Copyright (c) 2013-2014 Onsi Fakhouri + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/vendor/github.com/yudai/gojsondiff/Makefile b/vendor/github.com/yudai/gojsondiff/Makefile new file mode 100644 index 00000000000..50ed3d601d0 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/Makefile @@ -0,0 +1,2 @@ +test: + if [ `go fmt $(go list ./... | grep -v /vendor/) | wc -l` -gt 0 ]; then echo "go fmt error"; exit 1; fi diff --git a/vendor/github.com/yudai/gojsondiff/README.md b/vendor/github.com/yudai/gojsondiff/README.md new file mode 100644 index 00000000000..2f0f6f8c5d2 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/README.md @@ -0,0 +1,157 @@ +# Go JSON Diff (and Patch) + +[![Wercker](https://app.wercker.com/status/00d70daaf40ce277fd4f10290f097b9d/s/master)][wercker] +[![GoDoc](https://godoc.org/github.com/yudai/gojsondiff?status.svg)][godoc] +[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg)][license] + +[wercker]: https://app.wercker.com/project/bykey/00d70daaf40ce277fd4f10290f097b9d +[godoc]: https://godoc.org/github.com/yudai/gojsondiff +[license]: https://github.com/yudai/gojsondiff/blob/master/LICENSE + +## How to use + +### Installation + +```sh +go get github.com/yudai/gojsondiff +``` + +### Comparing two JSON strings + +See `jd/main.go` for how to use this library. + + +## CLI tool + +This repository contains a package that you can use as a CLI tool. + +### Installation + +```sh +go get github.com/yudai/gojsondiff/jd +``` + +### Usage + +#### Diff + +Just give two json files to the `jd` command: + +```sh +jd one.json another.json +``` + +Outputs would be something like: + +```diff + { + "arr": [ + 0: "arr0", + 1: 21, + 2: { + "num": 1, +- "str": "pek3f" ++ "str": "changed" + }, + 3: [ + 0: 0, +- 1: "1" ++ 1: "changed" + ] + ], + "bool": true, + "num_float": 39.39, + "num_int": 13, + "obj": { + "arr": [ + 0: 17, + 1: "str", + 2: { +- "str": "eafeb" ++ "str": "changed" + } + ], ++ "new": "added", +- "num": 19, + "obj": { +- "num": 14, ++ "num": 9999 +- "str": "efj3" ++ "str": "changed" + }, + "str": "bcded" + }, + "str": "abcde" + } +``` + +When you prefer the delta foramt of [jsondiffpatch](https://github.com/benjamine/jsondiffpatch), add the `-f delta` option. + +```sh +jd -f delta one.json another.json +``` + +This command shows: + +```json +{ + "arr": { + "2": { + "str": [ + "pek3f", + "changed" + ] + }, + "3": { + "1": [ + "1", + "changed" + ], + "_t": "a" + }, + "_t": "a" + }, + "obj": { + "arr": { + "2": { + "str": [ + "eafeb", + "changed" + ] + }, + "_t": "a" + }, + "new": [ + "added" + ], + "num": [ + 19, + 0, + 0 + ], + "obj": { + "num": [ + 14, + 9999 + ], + "str": [ + "efj3", + "changed" + ] + } + } +} +``` + +#### Patch + +Give a diff file in the delta format and the JSON file to the `jp` command. + +```sh +jp diff.delta one.json +``` + + +## License + +MIT License (see `LICENSE` for detail) diff --git a/vendor/github.com/yudai/gojsondiff/deltas.go b/vendor/github.com/yudai/gojsondiff/deltas.go new file mode 100644 index 00000000000..403c5bf4ce9 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/deltas.go @@ -0,0 +1,461 @@ +package gojsondiff + +import ( + "errors" + dmp "github.com/sergi/go-diff/diffmatchpatch" + "reflect" + "strconv" +) + +// A Delta represents an atomic difference between two JSON objects. +type Delta interface { + // Similarity calculates the similarity of the Delta values. + // The return value is normalized from 0 to 1, + // 0 is completely different and 1 is they are same + Similarity() (similarity float64) +} + +// To cache the calculated similarity, +// concrete Deltas can use similariter and similarityCache +type similariter interface { + similarity() (similarity float64) +} + +type similarityCache struct { + similariter + value float64 +} + +func newSimilarityCache(sim similariter) similarityCache { + cache := similarityCache{similariter: sim, value: -1} + return cache +} + +func (cache similarityCache) Similarity() (similarity float64) { + if cache.value < 0 { + cache.value = cache.similariter.similarity() + } + return cache.value +} + +// A Position represents the position of a Delta in an object or an array. +type Position interface { + // String returns the position as a string + String() (name string) + + // CompareTo returns a true if the Position is smaller than another Position. + // This function is used to sort Positions by the sort package. + CompareTo(another Position) bool +} + +// A Name is a Postition with a string, which means the delta is in an object. +type Name string + +func (n Name) String() (name string) { + return string(n) +} + +func (n Name) CompareTo(another Position) bool { + return n < another.(Name) +} + +// A Index is a Position with an int value, which means the Delta is in an Array. +type Index int + +func (i Index) String() (name string) { + return strconv.Itoa(int(i)) +} + +func (i Index) CompareTo(another Position) bool { + return i < another.(Index) +} + +// A PreDelta is a Delta that has a position of the left side JSON object. +// Deltas implements this interface should be applies before PostDeltas. +type PreDelta interface { + // PrePosition returns the Position. + PrePosition() Position + + // PreApply applies the delta to object. + PreApply(object interface{}) interface{} +} + +type preDelta struct{ Position } + +func (i preDelta) PrePosition() Position { + return Position(i.Position) +} + +type preDeltas []PreDelta + +// for sorting +func (s preDeltas) Len() int { + return len(s) +} + +// for sorting +func (s preDeltas) Swap(i, j int) { + s[i], s[j] = s[j], s[i] +} + +// for sorting +func (s preDeltas) Less(i, j int) bool { + return !s[i].PrePosition().CompareTo(s[j].PrePosition()) +} + +// A PreDelta is a Delta that has a position of the right side JSON object. +// Deltas implements this interface should be applies after PreDeltas. +type PostDelta interface { + // PostPosition returns the Position. + PostPosition() Position + + // PostApply applies the delta to object. + PostApply(object interface{}) interface{} +} + +type postDelta struct{ Position } + +func (i postDelta) PostPosition() Position { + return Position(i.Position) +} + +type postDeltas []PostDelta + +// for sorting +func (s postDeltas) Len() int { + return len(s) +} + +// for sorting +func (s postDeltas) Swap(i, j int) { + s[i], s[j] = s[j], s[i] +} + +// for sorting +func (s postDeltas) Less(i, j int) bool { + return s[i].PostPosition().CompareTo(s[j].PostPosition()) +} + +// An Object is a Delta that represents an object of JSON +type Object struct { + postDelta + similarityCache + + // Deltas holds internal Deltas + Deltas []Delta +} + +// NewObject returns an Object +func NewObject(position Position, deltas []Delta) *Object { + d := Object{postDelta: postDelta{position}, Deltas: deltas} + d.similarityCache = newSimilarityCache(&d) + return &d +} + +func (d *Object) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + o := object.(map[string]interface{}) + n := string(d.PostPosition().(Name)) + o[n] = applyDeltas(d.Deltas, o[n]) + case []interface{}: + o := object.([]interface{}) + n := int(d.PostPosition().(Index)) + o[n] = applyDeltas(d.Deltas, o[n]) + } + return object +} + +func (d *Object) similarity() (similarity float64) { + similarity = deltasSimilarity(d.Deltas) + return +} + +// An Array is a Delta that represents an array of JSON +type Array struct { + postDelta + similarityCache + + // Deltas holds internal Deltas + Deltas []Delta +} + +// NewArray returns an Array +func NewArray(position Position, deltas []Delta) *Array { + d := Array{postDelta: postDelta{position}, Deltas: deltas} + d.similarityCache = newSimilarityCache(&d) + return &d +} + +func (d *Array) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + o := object.(map[string]interface{}) + n := string(d.PostPosition().(Name)) + o[n] = applyDeltas(d.Deltas, o[n]) + case []interface{}: + o := object.([]interface{}) + n := int(d.PostPosition().(Index)) + o[n] = applyDeltas(d.Deltas, o[n]) + } + return object +} + +func (d *Array) similarity() (similarity float64) { + similarity = deltasSimilarity(d.Deltas) + return +} + +// An Added represents a new added field of an object or an array +type Added struct { + postDelta + similarityCache + + // Values holds the added value + Value interface{} +} + +// NewAdded returns a new Added +func NewAdded(position Position, value interface{}) *Added { + d := Added{postDelta: postDelta{position}, Value: value} + return &d +} + +func (d *Added) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + object.(map[string]interface{})[string(d.PostPosition().(Name))] = d.Value + case []interface{}: + i := int(d.PostPosition().(Index)) + o := object.([]interface{}) + if i < len(o) { + o = append(o, 0) //dummy + copy(o[i+1:], o[i:]) + o[i] = d.Value + object = o + } else { + object = append(o, d.Value) + } + } + + return object +} + +func (d *Added) similarity() (similarity float64) { + return 0 +} + +// A Modified represents a field whose value is changed. +type Modified struct { + postDelta + similarityCache + + // The value before modification + OldValue interface{} + + // The value after modification + NewValue interface{} +} + +// NewModified returns a Modified +func NewModified(position Position, oldValue, newValue interface{}) *Modified { + d := Modified{ + postDelta: postDelta{position}, + OldValue: oldValue, + NewValue: newValue, + } + d.similarityCache = newSimilarityCache(&d) + return &d + +} + +func (d *Modified) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + // TODO check old value + object.(map[string]interface{})[string(d.PostPosition().(Name))] = d.NewValue + case []interface{}: + object.([]interface{})[int(d.PostPosition().(Index))] = d.NewValue + } + return object +} + +func (d *Modified) similarity() (similarity float64) { + similarity += 0.3 // at least, they are at the same position + if reflect.TypeOf(d.OldValue) == reflect.TypeOf(d.NewValue) { + similarity += 0.3 // types are same + + switch d.OldValue.(type) { + case string: + similarity += 0.4 * stringSimilarity(d.OldValue.(string), d.NewValue.(string)) + case float64: + ratio := d.OldValue.(float64) / d.NewValue.(float64) + if ratio > 1 { + ratio = 1 / ratio + } + similarity += 0.4 * ratio + } + } + return +} + +// A TextDiff represents a Modified with TextDiff between the old and the new values. +type TextDiff struct { + Modified + + // Diff string + Diff []dmp.Patch +} + +// NewTextDiff returns +func NewTextDiff(position Position, diff []dmp.Patch, oldValue, newValue interface{}) *TextDiff { + d := TextDiff{ + Modified: *NewModified(position, oldValue, newValue), + Diff: diff, + } + return &d +} + +func (d *TextDiff) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + o := object.(map[string]interface{}) + i := string(d.PostPosition().(Name)) + // TODO error + d.OldValue = o[i] + // TODO error + d.patch() + o[i] = d.NewValue + case []interface{}: + o := object.([]interface{}) + i := d.PostPosition().(Index) + d.OldValue = o[i] + // TODO error + d.patch() + o[i] = d.NewValue + } + return object +} + +func (d *TextDiff) patch() error { + if d.OldValue == nil { + return errors.New("Old Value is not set") + } + patcher := dmp.New() + patched, successes := patcher.PatchApply(d.Diff, d.OldValue.(string)) + for _, success := range successes { + if !success { + return errors.New("Failed to apply a patch") + } + } + d.NewValue = patched + return nil +} + +func (d *TextDiff) DiffString() string { + dmp := dmp.New() + return dmp.PatchToText(d.Diff) +} + +// A Delted represents deleted field or index of an Object or an Array. +type Deleted struct { + preDelta + + // The value deleted + Value interface{} +} + +// NewDeleted returns a Deleted +func NewDeleted(position Position, value interface{}) *Deleted { + d := Deleted{ + preDelta: preDelta{position}, + Value: value, + } + return &d + +} + +func (d *Deleted) PreApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + // TODO check old value + delete(object.(map[string]interface{}), string(d.PrePosition().(Name))) + case []interface{}: + i := int(d.PrePosition().(Index)) + o := object.([]interface{}) + object = append(o[:i], o[i+1:]...) + } + return object +} + +func (d Deleted) Similarity() (similarity float64) { + return 0 +} + +// A Moved represents field that is moved, which means the index or name is +// changed. Note that, in this library, assigning a Moved and a Modified to +// a single position is not allowed. For the compatibility with jsondiffpatch, +// the Moved in this library can hold the old and new value in it. +type Moved struct { + preDelta + postDelta + similarityCache + // The value before moving + Value interface{} + // The delta applied after moving (for compatibility) + Delta interface{} +} + +func NewMoved(oldPosition Position, newPosition Position, value interface{}, delta Delta) *Moved { + d := Moved{ + preDelta: preDelta{oldPosition}, + postDelta: postDelta{newPosition}, + Value: value, + Delta: delta, + } + d.similarityCache = newSimilarityCache(&d) + return &d +} + +func (d *Moved) PreApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + //not supported + case []interface{}: + i := int(d.PrePosition().(Index)) + o := object.([]interface{}) + d.Value = o[i] + object = append(o[:i], o[i+1:]...) + } + return object +} + +func (d *Moved) PostApply(object interface{}) interface{} { + switch object.(type) { + case map[string]interface{}: + //not supported + case []interface{}: + i := int(d.PostPosition().(Index)) + o := object.([]interface{}) + o = append(o, 0) //dummy + copy(o[i+1:], o[i:]) + o[i] = d.Value + object = o + } + + if d.Delta != nil { + d.Delta.(PostDelta).PostApply(object) + } + + return object +} + +func (d *Moved) similarity() (similarity float64) { + similarity = 0.6 // as type and contens are same + ratio := float64(d.PrePosition().(Index)) / float64(d.PostPosition().(Index)) + if ratio > 1 { + ratio = 1 / ratio + } + similarity += 0.4 * ratio + return +} diff --git a/vendor/github.com/yudai/gojsondiff/formatter/ascii.go b/vendor/github.com/yudai/gojsondiff/formatter/ascii.go new file mode 100644 index 00000000000..b30781327b6 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/formatter/ascii.go @@ -0,0 +1,370 @@ +package formatter + +import ( + "bytes" + "errors" + "fmt" + "sort" + + diff "github.com/yudai/gojsondiff" +) + +func NewAsciiFormatter(left interface{}, config AsciiFormatterConfig) *AsciiFormatter { + return &AsciiFormatter{ + left: left, + config: config, + } +} + +type AsciiFormatter struct { + left interface{} + config AsciiFormatterConfig + buffer *bytes.Buffer + path []string + size []int + inArray []bool + line *AsciiLine +} + +type AsciiFormatterConfig struct { + ShowArrayIndex bool + Coloring bool +} + +var AsciiFormatterDefaultConfig = AsciiFormatterConfig{} + +type AsciiLine struct { + marker string + indent int + buffer *bytes.Buffer +} + +func (f *AsciiFormatter) Format(diff diff.Diff) (result string, err error) { + f.buffer = bytes.NewBuffer([]byte{}) + f.path = []string{} + f.size = []int{} + f.inArray = []bool{} + + if v, ok := f.left.(map[string]interface{}); ok { + f.formatObject(v, diff) + } else if v, ok := f.left.([]interface{}); ok { + f.formatArray(v, diff) + } else { + return "", fmt.Errorf("expected map[string]interface{} or []interface{}, got %T", + f.left) + } + + return f.buffer.String(), nil +} + +func (f *AsciiFormatter) formatObject(left map[string]interface{}, df diff.Diff) { + f.addLineWith(AsciiSame, "{") + f.push("ROOT", len(left), false) + f.processObject(left, df.Deltas()) + f.pop() + f.addLineWith(AsciiSame, "}") +} + +func (f *AsciiFormatter) formatArray(left []interface{}, df diff.Diff) { + f.addLineWith(AsciiSame, "[") + f.push("ROOT", len(left), true) + f.processArray(left, df.Deltas()) + f.pop() + f.addLineWith(AsciiSame, "]") +} + +func (f *AsciiFormatter) processArray(array []interface{}, deltas []diff.Delta) error { + patchedIndex := 0 + for index, value := range array { + f.processItem(value, deltas, diff.Index(index)) + patchedIndex++ + } + + // additional Added + for _, delta := range deltas { + switch delta.(type) { + case *diff.Added: + d := delta.(*diff.Added) + // skip items already processed + if int(d.Position.(diff.Index)) < len(array) { + continue + } + f.printRecursive(d.Position.String(), d.Value, AsciiAdded) + } + } + + return nil +} + +func (f *AsciiFormatter) processObject(object map[string]interface{}, deltas []diff.Delta) error { + names := sortedKeys(object) + for _, name := range names { + value := object[name] + f.processItem(value, deltas, diff.Name(name)) + } + + // Added + for _, delta := range deltas { + switch delta.(type) { + case *diff.Added: + d := delta.(*diff.Added) + f.printRecursive(d.Position.String(), d.Value, AsciiAdded) + } + } + + return nil +} + +func (f *AsciiFormatter) processItem(value interface{}, deltas []diff.Delta, position diff.Position) error { + matchedDeltas := f.searchDeltas(deltas, position) + positionStr := position.String() + if len(matchedDeltas) > 0 { + for _, matchedDelta := range matchedDeltas { + + switch matchedDelta.(type) { + case *diff.Object: + d := matchedDelta.(*diff.Object) + switch value.(type) { + case map[string]interface{}: + //ok + default: + return errors.New("Type mismatch") + } + o := value.(map[string]interface{}) + + f.newLine(AsciiSame) + f.printKey(positionStr) + f.print("{") + f.closeLine() + f.push(positionStr, len(o), false) + f.processObject(o, d.Deltas) + f.pop() + f.newLine(AsciiSame) + f.print("}") + f.printComma() + f.closeLine() + + case *diff.Array: + d := matchedDelta.(*diff.Array) + switch value.(type) { + case []interface{}: + //ok + default: + return errors.New("Type mismatch") + } + a := value.([]interface{}) + + f.newLine(AsciiSame) + f.printKey(positionStr) + f.print("[") + f.closeLine() + f.push(positionStr, len(a), true) + f.processArray(a, d.Deltas) + f.pop() + f.newLine(AsciiSame) + f.print("]") + f.printComma() + f.closeLine() + + case *diff.Added: + d := matchedDelta.(*diff.Added) + f.printRecursive(positionStr, d.Value, AsciiAdded) + f.size[len(f.size)-1]++ + + case *diff.Modified: + d := matchedDelta.(*diff.Modified) + savedSize := f.size[len(f.size)-1] + f.printRecursive(positionStr, d.OldValue, AsciiDeleted) + f.size[len(f.size)-1] = savedSize + f.printRecursive(positionStr, d.NewValue, AsciiAdded) + + case *diff.TextDiff: + savedSize := f.size[len(f.size)-1] + d := matchedDelta.(*diff.TextDiff) + f.printRecursive(positionStr, d.OldValue, AsciiDeleted) + f.size[len(f.size)-1] = savedSize + f.printRecursive(positionStr, d.NewValue, AsciiAdded) + + case *diff.Deleted: + d := matchedDelta.(*diff.Deleted) + f.printRecursive(positionStr, d.Value, AsciiDeleted) + + default: + return errors.New("Unknown Delta type detected") + } + + } + } else { + f.printRecursive(positionStr, value, AsciiSame) + } + + return nil +} + +func (f *AsciiFormatter) searchDeltas(deltas []diff.Delta, postion diff.Position) (results []diff.Delta) { + results = make([]diff.Delta, 0) + for _, delta := range deltas { + switch delta.(type) { + case diff.PostDelta: + if delta.(diff.PostDelta).PostPosition() == postion { + results = append(results, delta) + } + case diff.PreDelta: + if delta.(diff.PreDelta).PrePosition() == postion { + results = append(results, delta) + } + default: + panic("heh") + } + } + return +} + +const ( + AsciiSame = " " + AsciiAdded = "+" + AsciiDeleted = "-" +) + +var AsciiStyles = map[string]string{ + AsciiAdded: "30;42", + AsciiDeleted: "30;41", +} + +func (f *AsciiFormatter) push(name string, size int, array bool) { + f.path = append(f.path, name) + f.size = append(f.size, size) + f.inArray = append(f.inArray, array) +} + +func (f *AsciiFormatter) pop() { + f.path = f.path[0 : len(f.path)-1] + f.size = f.size[0 : len(f.size)-1] + f.inArray = f.inArray[0 : len(f.inArray)-1] +} + +func (f *AsciiFormatter) addLineWith(marker string, value string) { + f.line = &AsciiLine{ + marker: marker, + indent: len(f.path), + buffer: bytes.NewBufferString(value), + } + f.closeLine() +} + +func (f *AsciiFormatter) newLine(marker string) { + f.line = &AsciiLine{ + marker: marker, + indent: len(f.path), + buffer: bytes.NewBuffer([]byte{}), + } +} + +func (f *AsciiFormatter) closeLine() { + style, ok := AsciiStyles[f.line.marker] + if f.config.Coloring && ok { + f.buffer.WriteString("\x1b[" + style + "m") + } + + f.buffer.WriteString(f.line.marker) + for n := 0; n < f.line.indent; n++ { + f.buffer.WriteString(" ") + } + f.buffer.Write(f.line.buffer.Bytes()) + + if f.config.Coloring && ok { + f.buffer.WriteString("\x1b[0m") + } + + f.buffer.WriteRune('\n') +} + +func (f *AsciiFormatter) printKey(name string) { + if !f.inArray[len(f.inArray)-1] { + fmt.Fprintf(f.line.buffer, `"%s": `, name) + } else if f.config.ShowArrayIndex { + fmt.Fprintf(f.line.buffer, `%s: `, name) + } +} + +func (f *AsciiFormatter) printComma() { + f.size[len(f.size)-1]-- + if f.size[len(f.size)-1] > 0 { + f.line.buffer.WriteRune(',') + } +} + +func (f *AsciiFormatter) printValue(value interface{}) { + switch value.(type) { + case string: + fmt.Fprintf(f.line.buffer, `"%s"`, value) + case nil: + f.line.buffer.WriteString("null") + default: + fmt.Fprintf(f.line.buffer, `%#v`, value) + } +} + +func (f *AsciiFormatter) print(a string) { + f.line.buffer.WriteString(a) +} + +func (f *AsciiFormatter) printRecursive(name string, value interface{}, marker string) { + switch value.(type) { + case map[string]interface{}: + f.newLine(marker) + f.printKey(name) + f.print("{") + f.closeLine() + + m := value.(map[string]interface{}) + size := len(m) + f.push(name, size, false) + + keys := sortedKeys(m) + for _, key := range keys { + f.printRecursive(key, m[key], marker) + } + f.pop() + + f.newLine(marker) + f.print("}") + f.printComma() + f.closeLine() + + case []interface{}: + f.newLine(marker) + f.printKey(name) + f.print("[") + f.closeLine() + + s := value.([]interface{}) + size := len(s) + f.push("", size, true) + for _, item := range s { + f.printRecursive("", item, marker) + } + f.pop() + + f.newLine(marker) + f.print("]") + f.printComma() + f.closeLine() + + default: + f.newLine(marker) + f.printKey(name) + f.printValue(value) + f.printComma() + f.closeLine() + } +} + +func sortedKeys(m map[string]interface{}) (keys []string) { + keys = make([]string, 0, len(m)) + for key, _ := range m { + keys = append(keys, key) + } + sort.Strings(keys) + return +} diff --git a/vendor/github.com/yudai/gojsondiff/formatter/delta.go b/vendor/github.com/yudai/gojsondiff/formatter/delta.go new file mode 100644 index 00000000000..f7ccefda744 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/formatter/delta.go @@ -0,0 +1,124 @@ +package formatter + +import ( + "encoding/json" + "errors" + "fmt" + + diff "github.com/yudai/gojsondiff" +) + +const ( + DeltaDelete = 0 + DeltaTextDiff = 2 + DeltaMove = 3 +) + +func NewDeltaFormatter() *DeltaFormatter { + return &DeltaFormatter{ + PrintIndent: true, + } +} + +type DeltaFormatter struct { + PrintIndent bool +} + +func (f *DeltaFormatter) Format(diff diff.Diff) (result string, err error) { + jsonObject, err := f.formatObject(diff.Deltas()) + if err != nil { + return "", err + } + var resultBytes []byte + if f.PrintIndent { + resultBytes, err = json.MarshalIndent(jsonObject, "", " ") + } else { + resultBytes, err = json.Marshal(jsonObject) + } + if err != nil { + return "", err + } + + return string(resultBytes) + "\n", nil +} + +func (f *DeltaFormatter) FormatAsJson(diff diff.Diff) (json map[string]interface{}, err error) { + return f.formatObject(diff.Deltas()) +} + +func (f *DeltaFormatter) formatObject(deltas []diff.Delta) (deltaJson map[string]interface{}, err error) { + deltaJson = map[string]interface{}{} + for _, delta := range deltas { + switch delta.(type) { + case *diff.Object: + d := delta.(*diff.Object) + deltaJson[d.Position.String()], err = f.formatObject(d.Deltas) + if err != nil { + return nil, err + } + case *diff.Array: + d := delta.(*diff.Array) + deltaJson[d.Position.String()], err = f.formatArray(d.Deltas) + if err != nil { + return nil, err + } + case *diff.Added: + d := delta.(*diff.Added) + deltaJson[d.PostPosition().String()] = []interface{}{d.Value} + case *diff.Modified: + d := delta.(*diff.Modified) + deltaJson[d.PostPosition().String()] = []interface{}{d.OldValue, d.NewValue} + case *diff.TextDiff: + d := delta.(*diff.TextDiff) + deltaJson[d.PostPosition().String()] = []interface{}{d.DiffString(), 0, DeltaTextDiff} + case *diff.Deleted: + d := delta.(*diff.Deleted) + deltaJson[d.PrePosition().String()] = []interface{}{d.Value, 0, DeltaDelete} + case *diff.Moved: + return nil, errors.New("Delta type 'Move' is not supported in objects") + default: + return nil, errors.New(fmt.Sprintf("Unknown Delta type detected: %#v", delta)) + } + } + return +} + +func (f *DeltaFormatter) formatArray(deltas []diff.Delta) (deltaJson map[string]interface{}, err error) { + deltaJson = map[string]interface{}{ + "_t": "a", + } + for _, delta := range deltas { + switch delta.(type) { + case *diff.Object: + d := delta.(*diff.Object) + deltaJson[d.Position.String()], err = f.formatObject(d.Deltas) + if err != nil { + return nil, err + } + case *diff.Array: + d := delta.(*diff.Array) + deltaJson[d.Position.String()], err = f.formatArray(d.Deltas) + if err != nil { + return nil, err + } + case *diff.Added: + d := delta.(*diff.Added) + deltaJson[d.PostPosition().String()] = []interface{}{d.Value} + case *diff.Modified: + d := delta.(*diff.Modified) + deltaJson[d.PostPosition().String()] = []interface{}{d.OldValue, d.NewValue} + case *diff.TextDiff: + d := delta.(*diff.TextDiff) + deltaJson[d.PostPosition().String()] = []interface{}{d.DiffString(), 0, DeltaTextDiff} + case *diff.Deleted: + d := delta.(*diff.Deleted) + deltaJson["_"+d.PrePosition().String()] = []interface{}{d.Value, 0, DeltaDelete} + case *diff.Moved: + d := delta.(*diff.Moved) + deltaJson["_"+d.PrePosition().String()] = []interface{}{"", d.PostPosition(), DeltaMove} + default: + return nil, errors.New(fmt.Sprintf("Unknown Delta type detected: %#v", delta)) + } + } + return +} diff --git a/vendor/github.com/yudai/gojsondiff/gojsondiff.go b/vendor/github.com/yudai/gojsondiff/gojsondiff.go new file mode 100644 index 00000000000..26560e0f38b --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/gojsondiff.go @@ -0,0 +1,426 @@ +// Package gojsondiff implements "Diff" that compares two JSON objects and +// generates Deltas that describes differences between them. The package also +// provides "Patch" that apply Deltas to a JSON object. +package gojsondiff + +import ( + "container/list" + "encoding/json" + "reflect" + "sort" + + dmp "github.com/sergi/go-diff/diffmatchpatch" + "github.com/yudai/golcs" +) + +// A Diff holds deltas generated by a Differ +type Diff interface { + // Deltas returns Deltas that describe differences between two JSON objects + Deltas() []Delta + // Modified returnes true if Diff has at least one Delta. + Modified() bool +} + +type diff struct { + deltas []Delta +} + +func (diff *diff) Deltas() []Delta { + return diff.deltas +} + +func (diff *diff) Modified() bool { + return len(diff.deltas) > 0 +} + +// A Differ conmapres JSON objects and apply patches +type Differ struct { + textDiffMinimumLength int +} + +// New returns new Differ with default configuration +func New() *Differ { + return &Differ{ + textDiffMinimumLength: 30, + } +} + +// Compare compares two JSON strings as []bytes and return a Diff object. +func (differ *Differ) Compare( + left []byte, + right []byte, +) (Diff, error) { + var leftMap, rightMap map[string]interface{} + err := json.Unmarshal(left, &leftMap) + if err != nil { + return nil, err + } + + err = json.Unmarshal(right, &rightMap) + if err != nil { + return nil, err + } + return differ.CompareObjects(leftMap, rightMap), nil +} + +// CompareObjects compares two JSON object as map[string]interface{} +// and return a Diff object. +func (differ *Differ) CompareObjects( + left map[string]interface{}, + right map[string]interface{}, +) Diff { + deltas := differ.compareMaps(left, right) + return &diff{deltas: deltas} +} + +// CompareArrays compares two JSON arrays as []interface{} +// and return a Diff object. +func (differ *Differ) CompareArrays( + left []interface{}, + right []interface{}, +) Diff { + deltas := differ.compareArrays(left, right) + return &diff{deltas: deltas} +} + +func (differ *Differ) compareMaps( + left map[string]interface{}, + right map[string]interface{}, +) (deltas []Delta) { + deltas = make([]Delta, 0) + + names := sortedKeys(left) // stabilize delta order + for _, name := range names { + if rightValue, ok := right[name]; ok { + same, delta := differ.compareValues(Name(name), left[name], rightValue) + if !same { + deltas = append(deltas, delta) + } + } else { + deltas = append(deltas, NewDeleted(Name(name), left[name])) + } + } + + names = sortedKeys(right) // stabilize delta order + for _, name := range names { + if _, ok := left[name]; !ok { + deltas = append(deltas, NewAdded(Name(name), right[name])) + } + } + + return deltas +} + +// ApplyPatch applies a Diff to an JSON object. This method is destructive. +func (differ *Differ) ApplyPatch(json map[string]interface{}, patch Diff) { + applyDeltas(patch.Deltas(), json) +} + +type maybe struct { + index int + lcsIndex int + item interface{} +} + +func (differ *Differ) compareArrays( + left []interface{}, + right []interface{}, +) (deltas []Delta) { + deltas = make([]Delta, 0) + // LCS index pairs + lcsPairs := lcs.New(left, right).IndexPairs() + + // list up items not in LCS, they are maybe deleted + maybeDeleted := list.New() // but maybe moved or modified + lcsI := 0 + for i, leftValue := range left { + if lcsI < len(lcsPairs) && lcsPairs[lcsI].Left == i { + lcsI++ + } else { + maybeDeleted.PushBack(maybe{index: i, lcsIndex: lcsI, item: leftValue}) + } + } + + // list up items not in LCS, they are maybe Added + maybeAdded := list.New() // but maybe moved or modified + lcsI = 0 + for i, rightValue := range right { + if lcsI < len(lcsPairs) && lcsPairs[lcsI].Right == i { + lcsI++ + } else { + maybeAdded.PushBack(maybe{index: i, lcsIndex: lcsI, item: rightValue}) + } + } + + // find moved items + var delNext *list.Element // for prefetch to remove item in iteration + for delCandidate := maybeDeleted.Front(); delCandidate != nil; delCandidate = delNext { + delCan := delCandidate.Value.(maybe) + delNext = delCandidate.Next() + + for addCandidate := maybeAdded.Front(); addCandidate != nil; addCandidate = addCandidate.Next() { + addCan := addCandidate.Value.(maybe) + if reflect.DeepEqual(delCan.item, addCan.item) { + deltas = append(deltas, NewMoved(Index(delCan.index), Index(addCan.index), delCan.item, nil)) + maybeAdded.Remove(addCandidate) + maybeDeleted.Remove(delCandidate) + break + } + } + } + + // find modified or add+del + prevIndexDel := 0 + prevIndexAdd := 0 + delElement := maybeDeleted.Front() + addElement := maybeAdded.Front() + for i := 0; i <= len(lcsPairs); i++ { // not "< len(lcsPairs)" + var lcsPair lcs.IndexPair + var delSize, addSize int + if i < len(lcsPairs) { + lcsPair = lcsPairs[i] + delSize = lcsPair.Left - prevIndexDel - 1 + addSize = lcsPair.Right - prevIndexAdd - 1 + prevIndexDel = lcsPair.Left + prevIndexAdd = lcsPair.Right + } + + var delSlice []maybe + if delSize > 0 { + delSlice = make([]maybe, 0, delSize) + } else { + delSlice = make([]maybe, 0, maybeDeleted.Len()) + } + for ; delElement != nil; delElement = delElement.Next() { + d := delElement.Value.(maybe) + if d.lcsIndex != i { + break + } + delSlice = append(delSlice, d) + } + + var addSlice []maybe + if addSize > 0 { + addSlice = make([]maybe, 0, addSize) + } else { + addSlice = make([]maybe, 0, maybeAdded.Len()) + } + for ; addElement != nil; addElement = addElement.Next() { + a := addElement.Value.(maybe) + if a.lcsIndex != i { + break + } + addSlice = append(addSlice, a) + } + + if len(delSlice) > 0 && len(addSlice) > 0 { + var bestDeltas []Delta + bestDeltas, delSlice, addSlice = differ.maximizeSimilarities(delSlice, addSlice) + for _, delta := range bestDeltas { + deltas = append(deltas, delta) + } + } + + for _, del := range delSlice { + deltas = append(deltas, NewDeleted(Index(del.index), del.item)) + } + for _, add := range addSlice { + deltas = append(deltas, NewAdded(Index(add.index), add.item)) + } + } + + return deltas +} + +func (differ *Differ) compareValues( + position Position, + left interface{}, + right interface{}, +) (same bool, delta Delta) { + if reflect.TypeOf(left) != reflect.TypeOf(right) { + return false, NewModified(position, left, right) + } + + switch left.(type) { + + case map[string]interface{}: + l := left.(map[string]interface{}) + childDeltas := differ.compareMaps(l, right.(map[string]interface{})) + if len(childDeltas) > 0 { + return false, NewObject(position, childDeltas) + } + + case []interface{}: + l := left.([]interface{}) + childDeltas := differ.compareArrays(l, right.([]interface{})) + + if len(childDeltas) > 0 { + return false, NewArray(position, childDeltas) + } + + default: + if !reflect.DeepEqual(left, right) { + + if reflect.ValueOf(left).Kind() == reflect.String && + reflect.ValueOf(right).Kind() == reflect.String && + differ.textDiffMinimumLength <= len(left.(string)) { + + textDiff := dmp.New() + patchs := textDiff.PatchMake(left.(string), right.(string)) + return false, NewTextDiff(position, patchs, left, right) + + } else { + return false, NewModified(position, left, right) + } + } + } + + return true, nil +} + +func applyDeltas(deltas []Delta, object interface{}) interface{} { + preDeltas := make(preDeltas, 0) + for _, delta := range deltas { + switch delta.(type) { + case PreDelta: + preDeltas = append(preDeltas, delta.(PreDelta)) + } + } + sort.Sort(preDeltas) + for _, delta := range preDeltas { + object = delta.PreApply(object) + } + + postDeltas := make(postDeltas, 0, len(deltas)-len(preDeltas)) + for _, delta := range deltas { + switch delta.(type) { + case PostDelta: + postDeltas = append(postDeltas, delta.(PostDelta)) + } + } + sort.Sort(postDeltas) + + for _, delta := range postDeltas { + object = delta.PostApply(object) + } + + return object +} + +func (differ *Differ) maximizeSimilarities(left []maybe, right []maybe) (resultDeltas []Delta, freeLeft, freeRight []maybe) { + deltaTable := make([][]Delta, len(left)) + for i := 0; i < len(left); i++ { + deltaTable[i] = make([]Delta, len(right)) + } + for i, leftValue := range left { + for j, rightValue := range right { + _, delta := differ.compareValues(Index(rightValue.index), leftValue.item, rightValue.item) + deltaTable[i][j] = delta + } + } + + sizeX := len(left) + 1 // margins for both sides + sizeY := len(right) + 1 + + // fill out with similarities + dpTable := make([][]float64, sizeX) + for i := 0; i < sizeX; i++ { + dpTable[i] = make([]float64, sizeY) + } + for x := sizeX - 2; x >= 0; x-- { + for y := sizeY - 2; y >= 0; y-- { + prevX := dpTable[x+1][y] + prevY := dpTable[x][y+1] + score := deltaTable[x][y].Similarity() + dpTable[x+1][y+1] + + dpTable[x][y] = max(prevX, prevY, score) + } + } + + minLength := len(left) + if minLength > len(right) { + minLength = len(right) + } + maxInvalidLength := minLength - 1 + + freeLeft = make([]maybe, 0, len(left)-minLength) + freeRight = make([]maybe, 0, len(right)-minLength) + + resultDeltas = make([]Delta, 0, minLength) + var x, y int + for x, y = 0, 0; x <= sizeX-2 && y <= sizeY-2; { + current := dpTable[x][y] + nextX := dpTable[x+1][y] + nextY := dpTable[x][y+1] + + xValidLength := len(left) - maxInvalidLength + y + yValidLength := len(right) - maxInvalidLength + x + + if x+1 < xValidLength && current == nextX { + freeLeft = append(freeLeft, left[x]) + x++ + } else if y+1 < yValidLength && current == nextY { + freeRight = append(freeRight, right[y]) + y++ + } else { + resultDeltas = append(resultDeltas, deltaTable[x][y]) + x++ + y++ + } + } + for ; x < sizeX-1; x++ { + freeLeft = append(freeLeft, left[x-1]) + } + for ; y < sizeY-1; y++ { + freeRight = append(freeRight, right[y-1]) + } + + return resultDeltas, freeLeft, freeRight +} + +func deltasSimilarity(deltas []Delta) (similarity float64) { + for _, delta := range deltas { + similarity += delta.Similarity() + } + similarity = similarity / float64(len(deltas)) + return +} + +func stringSimilarity(left, right string) (similarity float64) { + matchingLength := float64( + lcs.New( + stringToInterfaceSlice(left), + stringToInterfaceSlice(right), + ).Length(), + ) + similarity = + (matchingLength / float64(len(left))) * (matchingLength / float64(len(right))) + return +} + +func stringToInterfaceSlice(str string) []interface{} { + s := make([]interface{}, len(str)) + for i, v := range str { + s[i] = v + } + return s +} + +func sortedKeys(m map[string]interface{}) (keys []string) { + keys = make([]string, 0, len(m)) + for key, _ := range m { + keys = append(keys, key) + } + sort.Strings(keys) + return +} + +func max(first float64, rest ...float64) (max float64) { + max = first + for _, value := range rest { + if max < value { + max = value + } + } + return max +} diff --git a/vendor/github.com/yudai/gojsondiff/unmarshaler.go b/vendor/github.com/yudai/gojsondiff/unmarshaler.go new file mode 100644 index 00000000000..8c26ef5b674 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/unmarshaler.go @@ -0,0 +1,131 @@ +package gojsondiff + +import ( + "encoding/json" + "errors" + dmp "github.com/sergi/go-diff/diffmatchpatch" + "io" + "strconv" +) + +type Unmarshaller struct { +} + +func NewUnmarshaller() *Unmarshaller { + return &Unmarshaller{} +} + +func (um *Unmarshaller) UnmarshalBytes(diffBytes []byte) (Diff, error) { + var diffObj map[string]interface{} + json.Unmarshal(diffBytes, &diffObj) + return um.UnmarshalObject(diffObj) +} + +func (um *Unmarshaller) UnmarshalString(diffString string) (Diff, error) { + return um.UnmarshalBytes([]byte(diffString)) +} + +func (um *Unmarshaller) UnmarshalReader(diffReader io.Reader) (Diff, error) { + var diffBytes []byte + io.ReadFull(diffReader, diffBytes) + return um.UnmarshalBytes(diffBytes) +} + +func (um *Unmarshaller) UnmarshalObject(diffObj map[string]interface{}) (Diff, error) { + result, err := process(Name(""), diffObj) + if err != nil { + return nil, err + } + return &diff{deltas: result.(*Object).Deltas}, nil +} + +func process(position Position, object interface{}) (Delta, error) { + var delta Delta + switch object.(type) { + case map[string]interface{}: + o := object.(map[string]interface{}) + if isArray, typed := o["_t"]; typed && isArray == "a" { + deltas := make([]Delta, 0, len(o)) + for name, value := range o { + if name == "_t" { + continue + } + + normalizedName := name + if normalizedName[0] == '_' { + normalizedName = name[1:] + } + index, err := strconv.Atoi(normalizedName) + if err != nil { + return nil, err + } + + childDelta, err := process(Index(index), value) + if err != nil { + return nil, err + } + + deltas = append(deltas, childDelta) + } + + for _, d := range deltas { + switch d.(type) { + case *Moved: + moved := d.(*Moved) + + var dd interface{} + var i int + for i, dd = range deltas { + switch dd.(type) { + case *Moved: + case PostDelta: + pd := dd.(PostDelta) + if moved.PostPosition() == pd.PostPosition() { + moved.Delta = pd + deltas = append(deltas[:i], deltas[i+1:]...) + } + } + } + } + } + + delta = NewArray(position, deltas) + } else { + deltas := make([]Delta, 0, len(o)) + for name, value := range o { + childDelta, err := process(Name(name), value) + if err != nil { + return nil, err + } + deltas = append(deltas, childDelta) + } + delta = NewObject(position, deltas) + } + case []interface{}: + o := object.([]interface{}) + switch len(o) { + case 1: + delta = NewAdded(position, o[0]) + case 2: + delta = NewModified(position, o[0], o[1]) + case 3: + switch o[2] { + case float64(0): + delta = NewDeleted(position, o[0]) + case float64(2): + dmp := dmp.New() + patches, err := dmp.PatchFromText(o[0].(string)) + if err != nil { + return nil, err + } + delta = NewTextDiff(position, patches, nil, nil) + case float64(3): + delta = NewMoved(position, Index(int(o[1].(float64))), nil, nil) + default: + return nil, errors.New("Unknown delta type") + } + } + } + + return delta, nil +} diff --git a/vendor/github.com/yudai/gojsondiff/wercker.yml b/vendor/github.com/yudai/gojsondiff/wercker.yml new file mode 100644 index 00000000000..1a401f87bf3 --- /dev/null +++ b/vendor/github.com/yudai/gojsondiff/wercker.yml @@ -0,0 +1,8 @@ +box: golang:1.6.3 + +build: + steps: + - setup-go-workspace + - script: + name: test + code: make test diff --git a/vendor/github.com/yudai/golcs/LICENSE b/vendor/github.com/yudai/golcs/LICENSE new file mode 100644 index 00000000000..6e61196b44b --- /dev/null +++ b/vendor/github.com/yudai/golcs/LICENSE @@ -0,0 +1,73 @@ +The MIT License (MIT) + +Copyright (c) 2015 Iwasaki Yudai + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. + +============================================================================ + +This repository is build with following third party libraries. Thank you! + + +## ginkgo - https://github.com/onsi/ginkgo + +Copyright (c) 2013-2014 Onsi Fakhouri + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + +# gomega - https://github.com/onsi/gomega + +Copyright (c) 2013-2014 Onsi Fakhouri + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/vendor/github.com/yudai/golcs/README.md b/vendor/github.com/yudai/golcs/README.md new file mode 100644 index 00000000000..8af24e9e895 --- /dev/null +++ b/vendor/github.com/yudai/golcs/README.md @@ -0,0 +1,54 @@ +# Go Longest Common Subsequence (LCS) + +A package to calculate [LCS](http://en.wikipedia.org/wiki/Longest_common_subsequence_problem) of slices. + +## Usage + +```sh +go get github.com/yudai/golcs +``` + +```go +import " github.com/yudai/golcs" + +left = []interface{}{1, 2, 5, 3, 1, 1, 5, 8, 3} +right = []interface{}{1, 2, 3, 3, 4, 4, 5, 1, 6} + +lcs := golcs.New(left, right) + +lcs.Values() // LCS values => []interface{}{1, 2, 5, 1} +lcs.IndexPairs() // Matched indices => [{Left: 0, Right: 0}, {Left: 1, Right: 1}, {Left: 2, Right: 6}, {Left: 4, Right: 7}] +lcs.Length() // Matched length => 4 + +lcs.Table() // Memo table +``` + +All the methods of `Lcs` cache their return values. For example, the memo table is calculated only once and reused when `Values()`, `Length()` and other methods are called. + + +## FAQ + +### How can I give `[]byte` values to `Lcs()` as its arguments? + +As `[]interface{}` is incompatible with `[]othertype` like `[]byte`, you need to create a `[]interface{}` slice and copy the values in your `[]byte` slice into it. Unfortunately, Go doesn't provide any mesure to cast a slice into `[]interface{}` with zero cost. Your copy costs O(n). + +```go +leftBytes := []byte("TGAGTA") +left = make([]interface{}, len(leftBytes)) +for i, v := range leftBytes { + left[i] = v +} + +rightBytes := []byte("GATA") +right = make([]interface{}, len(rightBytes)) +for i, v := range rightBytes { + right[i] = v +} + +lcs.New(left, right) +``` + + +## LICENSE + +The MIT license (See `LICENSE` for detail) diff --git a/vendor/github.com/yudai/golcs/golcs.go b/vendor/github.com/yudai/golcs/golcs.go new file mode 100644 index 00000000000..cd653d16695 --- /dev/null +++ b/vendor/github.com/yudai/golcs/golcs.go @@ -0,0 +1,130 @@ +package lcs + +import ( + "reflect" +) + +type Lcs interface { + Values() (values []interface{}) + IndexPairs() (pairs []IndexPair) + Length() (length int) + Left() (leftValues []interface{}) + Right() (righttValues []interface{}) +} + +type IndexPair struct { + Left int + Right int +} + +type lcs struct { + left []interface{} + right []interface{} + /* for caching */ + table [][]int + indexPairs []IndexPair + values []interface{} +} + +func New(left, right []interface{}) Lcs { + return &lcs{ + left: left, + right: right, + table: nil, + indexPairs: nil, + values: nil, + } +} + +func (lcs *lcs) Table() (table [][]int) { + if lcs.table != nil { + return lcs.table + } + + sizeX := len(lcs.left) + 1 + sizeY := len(lcs.right) + 1 + + table = make([][]int, sizeX) + for x := 0; x < sizeX; x++ { + table[x] = make([]int, sizeY) + } + + for y := 1; y < sizeY; y++ { + for x := 1; x < sizeX; x++ { + increment := 0 + if reflect.DeepEqual(lcs.left[x-1], lcs.right[y-1]) { + increment = 1 + } + table[x][y] = max(table[x-1][y-1]+increment, table[x-1][y], table[x][y-1]) + } + } + + lcs.table = table + return +} + +func (lcs *lcs) Length() (length int) { + length = lcs.Table()[len(lcs.left)][len(lcs.right)] + return +} + +func (lcs *lcs) IndexPairs() (pairs []IndexPair) { + if lcs.indexPairs != nil { + return lcs.indexPairs + } + + table := lcs.Table() + pairs = make([]IndexPair, table[len(table)-1][len(table[0])-1]) + + for x, y := len(lcs.left), len(lcs.right); x > 0 && y > 0; { + if reflect.DeepEqual(lcs.left[x-1], lcs.right[y-1]) { + pairs[table[x][y]-1] = IndexPair{Left: x - 1, Right: y - 1} + x-- + y-- + } else { + if table[x-1][y] >= table[x][y-1] { + x-- + } else { + y-- + } + } + } + + lcs.indexPairs = pairs + + return +} + +func (lcs *lcs) Values() (values []interface{}) { + if lcs.values != nil { + return lcs.values + } + + pairs := lcs.IndexPairs() + values = make([]interface{}, len(pairs)) + for i, pair := range pairs { + values[i] = lcs.left[pair.Left] + } + lcs.values = values + return +} + +func (lcs *lcs) Left() (leftValues []interface{}) { + leftValues = lcs.left + return +} + +func (lcs *lcs) Right() (rightValues []interface{}) { + rightValues = lcs.right + return +} + +func max(first int, rest ...int) (max int) { + max = first + for _, value := range rest { + if value > max { + max = value + } + } + return +} diff --git a/vendor/vendor.json b/vendor/vendor.json index 9d80bd38f84..7f1ba48fd82 100644 --- a/vendor/vendor.json +++ b/vendor/vendor.json @@ -452,6 +452,12 @@ "revision": "9a94032291f2192936512bab367bc45e77990d6a", "revisionTime": "2016-09-17T18:44:01Z" }, + { + "checksumSHA1": "iWCtyR1TkJ22Bi/ygzfKDvOQdQY=", + "path": "github.com/sergi/go-diff/diffmatchpatch", + "revision": "24e2351369ec4949b2ed0dc5c477afdd4c4034e8", + "revisionTime": "2017-01-18T13:12:30Z" + }, { "checksumSHA1": "6AYg4fjEvFuAVN3wHakGApjhZAM=", "path": "github.com/smartystreets/assertions", @@ -494,6 +500,24 @@ "revision": "3543873453996aaab2fc6b3928a35fc5ca2b5afb", "revisionTime": "2017-04-18T16:44:36Z" }, + { + "checksumSHA1": "r7o16T0WQ/XSe2mlQuioMi8gxbw=", + "path": "github.com/yudai/gojsondiff", + "revision": "9209d1532c51cabe0439993586a71c207b09a0ac", + "revisionTime": "2017-02-27T22:09:00Z" + }, + { + "checksumSHA1": "7/V6fDOOfkmSHQahCK+J5G4Y1uk=", + "path": "github.com/yudai/gojsondiff/formatter", + "revision": "9209d1532c51cabe0439993586a71c207b09a0ac", + "revisionTime": "2017-02-27T22:09:00Z" + }, + { + "checksumSHA1": "OCkp7qxxdxjpoM3T6Q3CTiMP5kM=", + "path": "github.com/yudai/golcs", + "revision": "d1c525dea8ce39ea9a783d33cf08932305373f2c", + "revisionTime": "2015-04-05T16:34:35Z" + }, { "checksumSHA1": "WHc3uByvGaMcnSoI21fhzYgbOgg=", "path": "golang.org/x/net/context/ctxhttp", From 0a1c2a7024d9e1940e8df434a37d22998a8ab0a9 Mon Sep 17 00:00:00 2001 From: Victor Azevedo Date: Thu, 25 May 2017 11:43:29 -0400 Subject: [PATCH 043/130] use fielddata_fields in elasticsearch 2.x queries Resolves issue #8467 --- .../app/plugins/datasource/elasticsearch/query_builder.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index ecbbb9c7e48..62a7b379c8e 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -119,8 +119,12 @@ function (queryDef) { query.fields = ["*", "_source"]; } - query.script_fields = {}, - query.docvalue_fields = [this.timeField]; + query.script_fields = {}; + if (this.esVersion < 5) { + query.fielddata_fields = [this.timeField]; + } else { + query.docvalue_fields = [this.timeField]; + } return query; }; From 09267bbfe8f1ab724a3880dd53876a26387e9a6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 25 May 2017 20:11:53 +0200 Subject: [PATCH 044/130] docs: elasticsearch, added info about size property in templating query --- docs/sources/features/datasources/elasticsearch.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/sources/features/datasources/elasticsearch.md b/docs/sources/features/datasources/elasticsearch.md index 6462d026366..25cdb98c8c5 100644 --- a/docs/sources/features/datasources/elasticsearch.md +++ b/docs/sources/features/datasources/elasticsearch.md @@ -92,9 +92,10 @@ The Elasticsearch data source supports two types of queries you can use in the * Query | Description ------------ | ------------- *{"find": "fields", "type": "keyword"} | Returns a list of field names with the index type `keyword`. -*{"find": "terms", "field": "@hostname"}* | Returns a list of values for a field using term aggregation. Query will user current dashboard time range as time range for query. +*{"find": "terms", "field": "@hostname", "size": 1000}* | Returns a list of values for a field using term aggregation. Query will user current dashboard time range as time range for query. *{"find": "terms", "field": "@hostname", "query": ''}* | Returns a list of values for a field using term aggregation & and a specified lucene query filter. Query will use current dashboard time range as time range for query. +There is a default size limit of 500 on terms queries. Set the size property in your query to set a custom limit. You can use other variables inside the query. Example query definition for a variable named `$host`. ``` From 60d5d5fb1530d0dcbc5dad63bc6c2009973c40f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 25 May 2017 20:37:01 +0200 Subject: [PATCH 045/130] docs: updated changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index acec4e8cdf9..0480e9b971c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,7 @@ * **InfluxDB**: Fixed issue with query editor not showing ALIAS BY input field when in text editor mode [#8459](https://github.com/grafana/grafana/issues/8459) * **Graph Log Scale**: Fixed issue with log scale going below x-axis [#8244](https://github.com/grafana/grafana/issues/8244) * **Playlist**: Fixed dashboard play order issue [#7688](https://github.com/grafana/grafana/issues/7688) +* **Elasticsearch**: Fixed table query issue with ES 2.x [#8467](https://github.com/grafana/grafana/issues/8467), thx [@goldeelox](https://github.com/goldeelox) # 4.3.1 (2017-05-23) From a927b893ae1e1f63348f888ae9bc08b600ff02c4 Mon Sep 17 00:00:00 2001 From: Ben Tranter Date: Thu, 25 May 2017 23:04:00 -0400 Subject: [PATCH 046/130] Use DBSession for getMaxVersion --- pkg/services/sqlstore/dashboard_version.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index bf0a6212ff7..bda2c6970d3 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -5,7 +5,6 @@ import ( "errors" "time" - "github.com/go-xorm/xorm" "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/formatter" "github.com/grafana/grafana/pkg/components/simplejson" @@ -115,7 +114,7 @@ func GetDashboardVersions(query *m.GetDashboardVersionsCommand) error { // RestoreDashboardVersion restores the dashboard data to the given version. func RestoreDashboardVersion(cmd *m.RestoreDashboardVersionCommand) error { - return inTransaction(func(sess *xorm.Session) error { + return inTransaction(func(sess *DBSession) error { // check if dashboard version exists in dashboard_version table // // normally we could use the getDashboardVersion func here, but since @@ -256,7 +255,7 @@ type version struct { // way that Postgres or MySQL do, so we use this to get around that. Since it's // impossible to delete a version in Grafana, this is believed to be a // safe-enough alternative. -func getMaxVersion(sess *xorm.Session, dashboardId int64) (int, error) { +func getMaxVersion(sess *DBSession, dashboardId int64) (int, error) { v := version{} has, err := sess.Table("dashboard_version"). Select("MAX(version) AS max"). From 8422697199ffa21cda664644d7af459ad4efc3cc Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Fri, 26 May 2017 08:35:32 -0400 Subject: [PATCH 047/130] centralize oauth http calls, validate response status (#8470) --- pkg/api/login_oauth.go | 7 +++++ pkg/social/common.go | 26 ++++++++++++++++ pkg/social/generic_oauth.go | 53 ++++++++++++--------------------- pkg/social/github_oauth.go | 48 +++++++++++++---------------- pkg/social/google_oauth.go | 14 +++++---- pkg/social/grafana_com_oauth.go | 13 ++++---- public/views/500.html | 40 +++++++++---------------- 7 files changed, 100 insertions(+), 101 deletions(-) diff --git a/pkg/api/login_oauth.go b/pkg/api/login_oauth.go index 5fbd9fea709..939e9b163e6 100644 --- a/pkg/api/login_oauth.go +++ b/pkg/api/login_oauth.go @@ -28,6 +28,7 @@ var ( ErrEmailNotAllowed = errors.New("Required email domain not fulfilled") ErrSignUpNotAllowed = errors.New("Signup is not allowed for this adapter") ErrUsersQuotaReached = errors.New("Users quota reached") + ErrNoEmail = errors.New("Login provider didn't return an email address") ) func GenStateString() string { @@ -134,6 +135,12 @@ func OAuthLogin(ctx *middleware.Context) { ctx.Logger.Debug("OAuthLogin got user info", "userInfo", userInfo) + // validate that we got at least an email address + if userInfo.Email == "" { + redirectWithError(ctx, ErrNoEmail) + return + } + // validate that the email is allowed to login to grafana if !connect.IsEmailAllowed(userInfo.Email) { redirectWithError(ctx, ErrEmailNotAllowed) diff --git a/pkg/social/common.go b/pkg/social/common.go index 7bce5d2ae8f..a5b8973306f 100644 --- a/pkg/social/common.go +++ b/pkg/social/common.go @@ -2,7 +2,11 @@ package social import ( "fmt" + "io/ioutil" + "net/http" "strings" + + "github.com/grafana/grafana/pkg/log" ) func isEmailAllowed(email string, allowedDomains []string) bool { @@ -18,3 +22,25 @@ func isEmailAllowed(email string, allowedDomains []string) bool { return valid } + +func HttpGet(client *http.Client, url string) ([]byte, error) { + r, err := client.Get(url) + if err != nil { + return nil, err + } + + defer r.Body.Close() + + body, err := ioutil.ReadAll(r.Body) + if err != nil { + return nil, err + } + + if r.StatusCode >= 300 { + return nil, fmt.Errorf(string(body)) + } + + log.Trace("HTTP GET %s: %s %s", url, r.Status, string(body)) + + return body, nil +} diff --git a/pkg/social/generic_oauth.go b/pkg/social/generic_oauth.go index 04b0536852a..76b2b734cd6 100644 --- a/pkg/social/generic_oauth.go +++ b/pkg/social/generic_oauth.go @@ -4,7 +4,6 @@ import ( "encoding/json" "errors" "fmt" - "io/ioutil" "net/http" "github.com/grafana/grafana/pkg/models" @@ -84,22 +83,14 @@ func (s *GenericOAuth) FetchPrivateEmail(client *http.Client) (string, error) { IsConfirmed bool `json:"is_confirmed"` } - emailsUrl := fmt.Sprintf(s.apiUrl + "/emails") - r, err := client.Get(emailsUrl) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/emails")) if err != nil { - return "", err + return "", fmt.Errorf("Error getting email address: %s", err) } - defer r.Body.Close() - var records []Record - body, err := ioutil.ReadAll(r.Body) - if err != nil { - return "", err - } - - err = json.Unmarshal(body, records) + err = json.Unmarshal(body, &records) if err != nil { var data struct { Values []Record `json:"values"` @@ -107,7 +98,7 @@ func (s *GenericOAuth) FetchPrivateEmail(client *http.Client) (string, error) { err = json.Unmarshal(body, &data) if err != nil { - return "", err + return "", fmt.Errorf("Error getting email address: %s", err) } records = data.Values @@ -129,18 +120,16 @@ func (s *GenericOAuth) FetchTeamMemberships(client *http.Client) ([]int, error) Id int `json:"id"` } - membershipUrl := fmt.Sprintf(s.apiUrl + "/teams") - r, err := client.Get(membershipUrl) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/teams")) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting team memberships: %s", err) } - defer r.Body.Close() - var records []Record - if err = json.NewDecoder(r.Body).Decode(&records); err != nil { - return nil, err + err = json.Unmarshal(body, &records) + if err != nil { + return nil, fmt.Errorf("Error getting team memberships: %s", err) } var ids = make([]int, len(records)) @@ -156,18 +145,16 @@ func (s *GenericOAuth) FetchOrganizations(client *http.Client) ([]string, error) Login string `json:"login"` } - url := fmt.Sprintf(s.apiUrl + "/orgs") - r, err := client.Get(url) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/orgs")) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting organizations: %s", err) } - defer r.Body.Close() - var records []Record - if err = json.NewDecoder(r.Body).Decode(&records); err != nil { - return nil, err + err = json.Unmarshal(body, &records) + if err != nil { + return nil, fmt.Errorf("Error getting organizations: %s", err) } var logins = make([]string, len(records)) @@ -188,16 +175,14 @@ func (s *GenericOAuth) UserInfo(client *http.Client) (*BasicUserInfo, error) { Attributes map[string][]string `json:"attributes"` } - var err error - r, err := client.Get(s.apiUrl) + body, err := HttpGet(client, s.apiUrl) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting user info: %s", err) } - defer r.Body.Close() - - if err = json.NewDecoder(r.Body).Decode(&data); err != nil { - return nil, err + err = json.Unmarshal(body, &data) + if err != nil { + return nil, fmt.Errorf("Error getting user info: %s", err) } userInfo := &BasicUserInfo{ diff --git a/pkg/social/github_oauth.go b/pkg/social/github_oauth.go index 271a472be84..b7b8d7c8156 100644 --- a/pkg/social/github_oauth.go +++ b/pkg/social/github_oauth.go @@ -85,18 +85,16 @@ func (s *SocialGithub) FetchPrivateEmail(client *http.Client) (string, error) { Verified bool `json:"verified"` } - emailsUrl := fmt.Sprintf(s.apiUrl + "/emails") - r, err := client.Get(emailsUrl) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/emails")) if err != nil { - return "", err + return "", fmt.Errorf("Error getting email address: %s", err) } - defer r.Body.Close() - var records []Record - if err = json.NewDecoder(r.Body).Decode(&records); err != nil { - return "", err + err = json.Unmarshal(body, &records) + if err != nil { + return "", fmt.Errorf("Error getting email address: %s", err) } var email = "" @@ -114,18 +112,16 @@ func (s *SocialGithub) FetchTeamMemberships(client *http.Client) ([]int, error) Id int `json:"id"` } - membershipUrl := fmt.Sprintf(s.apiUrl + "/teams") - r, err := client.Get(membershipUrl) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/teams")) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting team memberships: %s", err) } - defer r.Body.Close() - var records []Record - if err = json.NewDecoder(r.Body).Decode(&records); err != nil { - return nil, err + err = json.Unmarshal(body, &records) + if err != nil { + return nil, fmt.Errorf("Error getting team memberships: %s", err) } var ids = make([]int, len(records)) @@ -141,18 +137,16 @@ func (s *SocialGithub) FetchOrganizations(client *http.Client) ([]string, error) Login string `json:"login"` } - url := fmt.Sprintf(s.apiUrl + "/orgs") - r, err := client.Get(url) + body, err := HttpGet(client, fmt.Sprintf(s.apiUrl+"/orgs")) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting organizations: %s", err) } - defer r.Body.Close() - var records []Record - if err = json.NewDecoder(r.Body).Decode(&records); err != nil { - return nil, err + err = json.Unmarshal(body, &records) + if err != nil { + return nil, fmt.Errorf("Error getting organizations: %s", err) } var logins = make([]string, len(records)) @@ -170,16 +164,14 @@ func (s *SocialGithub) UserInfo(client *http.Client) (*BasicUserInfo, error) { Email string `json:"email"` } - var err error - r, err := client.Get(s.apiUrl) + body, err := HttpGet(client, s.apiUrl) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting user info: %s", err) } - defer r.Body.Close() - - if err = json.NewDecoder(r.Body).Decode(&data); err != nil { - return nil, err + err = json.Unmarshal(body, &data) + if err != nil { + return nil, fmt.Errorf("Error getting user info: %s", err) } userInfo := &BasicUserInfo{ diff --git a/pkg/social/google_oauth.go b/pkg/social/google_oauth.go index d140f385b66..94a05b25140 100644 --- a/pkg/social/google_oauth.go +++ b/pkg/social/google_oauth.go @@ -2,6 +2,7 @@ package social import ( "encoding/json" + "fmt" "net/http" "github.com/grafana/grafana/pkg/models" @@ -34,16 +35,17 @@ func (s *SocialGoogle) UserInfo(client *http.Client) (*BasicUserInfo, error) { Name string `json:"name"` Email string `json:"email"` } - var err error - r, err := client.Get(s.apiUrl) + body, err := HttpGet(client, s.apiUrl) if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting user info: %s", err) } - defer r.Body.Close() - if err = json.NewDecoder(r.Body).Decode(&data); err != nil { - return nil, err + + err = json.Unmarshal(body, &data) + if err != nil { + return nil, fmt.Errorf("Error getting user info: %s", err) } + return &BasicUserInfo{ Name: data.Name, Email: data.Email, diff --git a/pkg/social/grafana_com_oauth.go b/pkg/social/grafana_com_oauth.go index 498af7f1935..dd693f18d5d 100644 --- a/pkg/social/grafana_com_oauth.go +++ b/pkg/social/grafana_com_oauth.go @@ -2,6 +2,7 @@ package social import ( "encoding/json" + "fmt" "net/http" "github.com/grafana/grafana/pkg/models" @@ -57,16 +58,14 @@ func (s *SocialGrafanaCom) UserInfo(client *http.Client) (*BasicUserInfo, error) Orgs []OrgRecord `json:"orgs"` } - var err error - r, err := client.Get(s.url + "/api/oauth2/user") + body, err := HttpGet(client, s.url+"/api/oauth2/user") if err != nil { - return nil, err + return nil, fmt.Errorf("Error getting user info: %s", err) } - defer r.Body.Close() - - if err = json.NewDecoder(r.Body).Decode(&data); err != nil { - return nil, err + err = json.Unmarshal(body, &data) + if err != nil { + return nil, fmt.Errorf("Error getting user info: %s", err) } userInfo := &BasicUserInfo{ diff --git a/public/views/500.html b/public/views/500.html index cb2e99595f1..dca1245535f 100644 --- a/public/views/500.html +++ b/public/views/500.html @@ -4,33 +4,21 @@ - Grafana - Error - - - - - + + - - - + - - - -
      -
      -

      - Server side error :( -

      -
      - -

      [[.Title]]

      - - 
      [[.ErrorMsg]]
      - -
      - - + +
      +
      +

      Server side error :(

      +
      +

      [[.Title]]

      + [[if .ErrorMsg]] + 
      [[.ErrorMsg]]
      + [[end]] +
      + From 3292a48381a28d2aca596bc60047a7da810e0044 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Fri, 26 May 2017 15:04:34 +0200 Subject: [PATCH 048/130] graph: dashes with linewidth fix. Fixes #8469 Adds series override options for dash spaces and dash length. --- public/app/core/time_series2.ts | 4 +++- .../plugins/panel/graph/series_overrides_ctrl.js | 2 ++ public/test/core/time_series_specs.js | 13 +++++++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/public/app/core/time_series2.ts b/public/app/core/time_series2.ts index 782543787d7..b8b7ef6ed26 100644 --- a/public/app/core/time_series2.ts +++ b/public/app/core/time_series2.ts @@ -87,9 +87,11 @@ export default class TimeSeries { if (override.fill !== void 0) { this.lines.fill = translateFillOption(override.fill); } if (override.stack !== void 0) { this.stack = override.stack; } if (override.linewidth !== void 0) { - this.lines.lineWidth = override.linewidth; + this.lines.lineWidth = this.dashes.show ? 0: override.linewidth; this.dashes.lineWidth = override.linewidth; } + if (override.dashLength !== void 0) { this.dashes.dashLength[0] = override.dashLength; } + if (override.spaceLength !== void 0) { this.dashes.dashLength[1] = override.spaceLength; } if (override.nullPointMode !== void 0) { this.nullPointMode = override.nullPointMode; } if (override.pointradius !== void 0) { this.points.radius = override.pointradius; } if (override.steppedLine !== void 0) { this.lines.steps = override.steppedLine; } diff --git a/public/app/plugins/panel/graph/series_overrides_ctrl.js b/public/app/plugins/panel/graph/series_overrides_ctrl.js index bca1a9e5587..945f8340b33 100644 --- a/public/app/plugins/panel/graph/series_overrides_ctrl.js +++ b/public/app/plugins/panel/graph/series_overrides_ctrl.js @@ -101,6 +101,8 @@ define([ $scope.addOverrideOption('Fill below to', 'fillBelowTo', $scope.getSeriesNames()); $scope.addOverrideOption('Staircase line', 'steppedLine', [true, false]); $scope.addOverrideOption('Dashes', 'dashes', [true, false]); + $scope.addOverrideOption('Dash Length', 'dashLength', [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20]); + $scope.addOverrideOption('Dash Space', 'spaceLength', [1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20]); $scope.addOverrideOption('Points', 'points', [true, false]); $scope.addOverrideOption('Points Radius', 'pointradius', [1,2,3,4,5]); $scope.addOverrideOption('Stack', 'stack', [true, false, 'A', 'B', 'C', 'D']); diff --git a/public/test/core/time_series_specs.js b/public/test/core/time_series_specs.js index 04efa8a2249..08434e58b81 100644 --- a/public/test/core/time_series_specs.js +++ b/public/test/core/time_series_specs.js @@ -211,6 +211,19 @@ define([ }); }); + describe('series option overrides, dashes and lineWidth', function() { + beforeEach(function() { + series.alias = 'test'; + series.applySeriesOverrides([{ alias: 'test', linewidth: 5, dashes: true }]); + }); + + it('should enable dashes, set dashes lineWidth to 5 and lines lineWidth to 0', function() { + expect(series.dashes.show).to.be(true); + expect(series.dashes.lineWidth).to.be(5); + expect(series.lines.lineWidth).to.be(0); + }); + }); + describe('series option overrides, fill below to', function() { beforeEach(function() { series.alias = 'test'; From f484b4c34700db540cea3e2cc5caf8a2c7f2865f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Reginster?= Date: Wed, 3 May 2017 17:28:01 +0200 Subject: [PATCH 049/130] Make csv export date time format configurable - Move export csv options to modal dialog --- public/app/core/utils/file_export.ts | 11 ++++--- public/app/features/dashboard/all.js | 1 + .../features/dashboard/exportCsvModalCtrl.ts | 32 +++++++++++++++++++ .../dashboard/partials/exportCsvModal.html | 32 +++++++++++++++++++ public/app/plugins/panel/graph/module.ts | 16 +++++----- 5 files changed, 80 insertions(+), 12 deletions(-) create mode 100644 public/app/features/dashboard/exportCsvModalCtrl.ts create mode 100644 public/app/features/dashboard/partials/exportCsvModal.html diff --git a/public/app/core/utils/file_export.ts b/public/app/core/utils/file_export.ts index 24b501eee28..dd616ca77e7 100644 --- a/public/app/core/utils/file_export.ts +++ b/public/app/core/utils/file_export.ts @@ -1,20 +1,23 @@ /// import _ from 'lodash'; +import moment from 'moment'; declare var window: any; -export function exportSeriesListToCsv(seriesList) { +const DEFAULT_DATETIME_FORMAT: String = 'YYYY-MM-DDTHH:mm:ssZ'; + +export function exportSeriesListToCsv(seriesList, dateTimeFormat = DEFAULT_DATETIME_FORMAT) { var text = 'sep=;\nSeries;Time;Value\n'; _.each(seriesList, function(series) { _.each(series.datapoints, function(dp) { - text += series.alias + ';' + new Date(dp[1]).toISOString() + ';' + dp[0] + '\n'; + text += series.alias + ';' + moment(dp[1]).format(dateTimeFormat) + ';' + dp[0] + '\n'; }); }); saveSaveBlob(text, 'grafana_data_export.csv'); } -export function exportSeriesListToCsvColumns(seriesList) { +export function exportSeriesListToCsvColumns(seriesList, dateTimeFormat = DEFAULT_DATETIME_FORMAT) { var text = 'sep=;\nTime;'; // add header _.each(seriesList, function(series) { @@ -30,7 +33,7 @@ export function exportSeriesListToCsvColumns(seriesList) { var cIndex = 0; dataArr.push([]); _.each(series.datapoints, function(dp) { - dataArr[0][cIndex] = new Date(dp[1]).toISOString(); + dataArr[0][cIndex] = moment(dp[1]).format(dateTimeFormat); dataArr[sIndex][cIndex] = dp[0]; cIndex++; }); diff --git a/public/app/features/dashboard/all.js b/public/app/features/dashboard/all.js index c362f9cd032..3315371a78f 100644 --- a/public/app/features/dashboard/all.js +++ b/public/app/features/dashboard/all.js @@ -21,4 +21,5 @@ define([ './ad_hoc_filters', './row/row_ctrl', './repeat_option/repeat_option', + './exportCsvModalCtrl' ], function () {}); diff --git a/public/app/features/dashboard/exportCsvModalCtrl.ts b/public/app/features/dashboard/exportCsvModalCtrl.ts new file mode 100644 index 00000000000..0e2e2d3f232 --- /dev/null +++ b/public/app/features/dashboard/exportCsvModalCtrl.ts @@ -0,0 +1,32 @@ +/// + +import config from 'app/core/config'; +import angular from 'angular'; +import _ from 'lodash'; +import * as fileExport from 'app/core/utils/file_export'; + +const module = angular.module('grafana.controllers'); + +export class ExportCsvModalCtrl { + scope: any; + seriesList: any = []; + /** @ngInject */ + constructor(private $scope) { + this.seriesList = $scope.seriesList; + this.$scope = $scope; + $scope.asRows = true; + $scope.dateTimeFormat = 'YYYY-MM-DDTHH:mm:ssZ'; + $scope.export = this.export.bind(this); + } + + export() { + if (this.$scope.asRows) { + fileExport.exportSeriesListToCsv(this.seriesList, this.$scope.dateTimeFormat); + } else { + fileExport.exportSeriesListToCsvColumns(this.seriesList, this.$scope.dateTimeFormat); + } + this.$scope.dismiss(); + } +} + +module.controller('ExportCsvModalCtrl', ExportCsvModalCtrl); diff --git a/public/app/features/dashboard/partials/exportCsvModal.html b/public/app/features/dashboard/partials/exportCsvModal.html new file mode 100644 index 00000000000..ae3b4dfdf7d --- /dev/null +++ b/public/app/features/dashboard/partials/exportCsvModal.html @@ -0,0 +1,32 @@ +
      +
      +

      + Export CSV +

      + + + + +
      + +
      +
      +
      + +
      + +
      +
      +
      + + +
      +
      + +
      + Export + Cancel +
      +
      +
      diff --git a/public/app/plugins/panel/graph/module.ts b/public/app/plugins/panel/graph/module.ts index e2dce12168d..89c280ed5e5 100644 --- a/public/app/plugins/panel/graph/module.ts +++ b/public/app/plugins/panel/graph/module.ts @@ -11,7 +11,6 @@ import moment from 'moment'; import _ from 'lodash'; import TimeSeries from 'app/core/time_series2'; import config from 'app/core/config'; -import * as fileExport from 'app/core/utils/file_export'; import {MetricsPanelCtrl, alertTab} from 'app/plugins/sdk'; import {DataProcessor} from './data_processor'; import {axesEditorComponent} from './axes_editor'; @@ -147,8 +146,7 @@ class GraphCtrl extends MetricsPanelCtrl { } onInitPanelActions(actions) { - actions.push({text: 'Export CSV (series as rows)', click: 'ctrl.exportCsv()'}); - actions.push({text: 'Export CSV (series as columns)', click: 'ctrl.exportCsvColumns()'}); + actions.push({text: 'Export CSV', click: 'ctrl.exportCsv()'}); actions.push({text: 'Toggle legend', click: 'ctrl.toggleLegend()'}); } @@ -313,13 +311,15 @@ class GraphCtrl extends MetricsPanelCtrl { } exportCsv() { - fileExport.exportSeriesListToCsv(this.seriesList); - } + var scope = this.$scope.$new(); + scope.seriesList = this.seriesList; - exportCsvColumns() { - fileExport.exportSeriesListToCsvColumns(this.seriesList); + this.publishAppEvent('show-modal', { + src: 'public/app/features/dashboard/partials/exportCsvModal.html', + scope, + modalClass: 'modal--narrow' + }); } - } export {GraphCtrl, GraphCtrl as PanelCtrl}; From ee0d0155a572a3fbe3677e52deb8c99151706bc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Reginster?= Date: Thu, 4 May 2017 15:09:48 +0200 Subject: [PATCH 050/130] Refactor to component based style --- public/app/features/dashboard/all.js | 2 +- .../features/dashboard/exportCsvModalCtrl.ts | 32 --------------- .../export_data_modal.html} | 12 +++--- .../export_data/export_data_modal.ts | 41 +++++++++++++++++++ public/app/plugins/panel/graph/module.ts | 5 +-- 5 files changed, 50 insertions(+), 42 deletions(-) delete mode 100644 public/app/features/dashboard/exportCsvModalCtrl.ts rename public/app/features/dashboard/{partials/exportCsvModal.html => export_data/export_data_modal.html} (53%) create mode 100644 public/app/features/dashboard/export_data/export_data_modal.ts diff --git a/public/app/features/dashboard/all.js b/public/app/features/dashboard/all.js index 3315371a78f..242d464d77b 100644 --- a/public/app/features/dashboard/all.js +++ b/public/app/features/dashboard/all.js @@ -17,9 +17,9 @@ define([ './upload', './import/dash_import', './export/export_modal', + './export_data/export_data_modal', './dash_list_ctrl', './ad_hoc_filters', './row/row_ctrl', './repeat_option/repeat_option', - './exportCsvModalCtrl' ], function () {}); diff --git a/public/app/features/dashboard/exportCsvModalCtrl.ts b/public/app/features/dashboard/exportCsvModalCtrl.ts deleted file mode 100644 index 0e2e2d3f232..00000000000 --- a/public/app/features/dashboard/exportCsvModalCtrl.ts +++ /dev/null @@ -1,32 +0,0 @@ -/// - -import config from 'app/core/config'; -import angular from 'angular'; -import _ from 'lodash'; -import * as fileExport from 'app/core/utils/file_export'; - -const module = angular.module('grafana.controllers'); - -export class ExportCsvModalCtrl { - scope: any; - seriesList: any = []; - /** @ngInject */ - constructor(private $scope) { - this.seriesList = $scope.seriesList; - this.$scope = $scope; - $scope.asRows = true; - $scope.dateTimeFormat = 'YYYY-MM-DDTHH:mm:ssZ'; - $scope.export = this.export.bind(this); - } - - export() { - if (this.$scope.asRows) { - fileExport.exportSeriesListToCsv(this.seriesList, this.$scope.dateTimeFormat); - } else { - fileExport.exportSeriesListToCsvColumns(this.seriesList, this.$scope.dateTimeFormat); - } - this.$scope.dismiss(); - } -} - -module.controller('ExportCsvModalCtrl', ExportCsvModalCtrl); diff --git a/public/app/features/dashboard/partials/exportCsvModal.html b/public/app/features/dashboard/export_data/export_data_modal.html similarity index 53% rename from public/app/features/dashboard/partials/exportCsvModal.html rename to public/app/features/dashboard/export_data/export_data_modal.html index ae3b4dfdf7d..ad6494f16cc 100644 --- a/public/app/features/dashboard/partials/exportCsvModal.html +++ b/public/app/features/dashboard/export_data/export_data_modal.html @@ -1,10 +1,10 @@ -
      +

      Export CSV

      - +
      @@ -14,19 +14,19 @@
      -
      - +
      - Export - Cancel + Export + Cancel
      diff --git a/public/app/features/dashboard/export_data/export_data_modal.ts b/public/app/features/dashboard/export_data/export_data_modal.ts new file mode 100644 index 00000000000..80b2ff7d2f2 --- /dev/null +++ b/public/app/features/dashboard/export_data/export_data_modal.ts @@ -0,0 +1,41 @@ +/// + +import angular from 'angular'; +import * as fileExport from 'app/core/utils/file_export'; +import appEvents from 'app/core/app_events'; + +export class ExportDataModalCtrl { + private data: any[]; + asRows: Boolean = true; + dateTimeFormat: String = 'YYYY-MM-DDTHH:mm:ssZ'; + /** @ngInject */ + constructor(private $scope) { } + + export() { + if (this.asRows) { + fileExport.exportSeriesListToCsv(this.data, this.dateTimeFormat); + } else { + fileExport.exportSeriesListToCsvColumns(this.data, this.dateTimeFormat); + } + this.dismiss(); + } + + dismiss() { + appEvents.emit('hide-modal'); + } +} + +export function exportDataModal() { + return { + restrict: 'E', + templateUrl: 'public/app/features/dashboard/export_data/export_data_modal.html', + controller: ExportDataModalCtrl, + controllerAs: 'ctrl', + scope: { + data: '<' // The difference to '=' is that the bound properties are not watched + }, + bindToController: true + }; +} + +angular.module('grafana.directives').directive('exportDataModal', exportDataModal); diff --git a/public/app/plugins/panel/graph/module.ts b/public/app/plugins/panel/graph/module.ts index 89c280ed5e5..e9ca8c5c4e2 100644 --- a/public/app/plugins/panel/graph/module.ts +++ b/public/app/plugins/panel/graph/module.ts @@ -311,11 +311,10 @@ class GraphCtrl extends MetricsPanelCtrl { } exportCsv() { - var scope = this.$scope.$new(); + var scope = this.$scope.$new(true); scope.seriesList = this.seriesList; - this.publishAppEvent('show-modal', { - src: 'public/app/features/dashboard/partials/exportCsvModal.html', + templateHtml: '', scope, modalClass: 'modal--narrow' }); From c17d02e4963e2921a9d41881dcdb205d184b2481 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Fri, 26 May 2017 15:41:50 +0200 Subject: [PATCH 051/130] csv: remove sep metadata as only works for excel --- public/app/core/utils/file_export.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/public/app/core/utils/file_export.ts b/public/app/core/utils/file_export.ts index dd616ca77e7..960be37230c 100644 --- a/public/app/core/utils/file_export.ts +++ b/public/app/core/utils/file_export.ts @@ -8,7 +8,7 @@ declare var window: any; const DEFAULT_DATETIME_FORMAT: String = 'YYYY-MM-DDTHH:mm:ssZ'; export function exportSeriesListToCsv(seriesList, dateTimeFormat = DEFAULT_DATETIME_FORMAT) { - var text = 'sep=;\nSeries;Time;Value\n'; + var text = 'Series;Time;Value\n'; _.each(seriesList, function(series) { _.each(series.datapoints, function(dp) { text += series.alias + ';' + moment(dp[1]).format(dateTimeFormat) + ';' + dp[0] + '\n'; @@ -18,7 +18,7 @@ export function exportSeriesListToCsv(seriesList, dateTimeFormat = DEFAULT_DATET } export function exportSeriesListToCsvColumns(seriesList, dateTimeFormat = DEFAULT_DATETIME_FORMAT) { - var text = 'sep=;\nTime;'; + var text = 'Time;'; // add header _.each(seriesList, function(series) { text += series.alias + ';'; @@ -53,7 +53,7 @@ export function exportSeriesListToCsvColumns(seriesList, dateTimeFormat = DEFAUL } export function exportTableDataToCsv(table) { - var text = 'sep=;\n'; + var text = ''; // add header _.each(table.columns, function(column) { text += (column.title || column.text) + ';'; From e65f86147f63f3137bce338a89d1a125adbbde57 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Fri, 26 May 2017 15:56:44 +0200 Subject: [PATCH 052/130] changelog: note for #8058 --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0480e9b971c..98f489e3ce3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,7 @@ ## Enhancements * **Elasticsearch**: Added filter aggregation label [#8420](https://github.com/grafana/grafana/pull/8420), thx [@tianzk](github.com/tianzk) * **Sensu**: Added option for source and handler [#8405](https://github.com/grafana/grafana/pull/8405), thx [@joemiller](github.com/joemiller) +* **CSV**: Configurable csv export datetime format [#8058](https://github.com/grafana/grafana/issues/8058), thx [@cederigo](github.com/cederigo) # 4.3.2 (upcoming patch release) From c2885430bd45f1a083e0340520497ef609eb2975 Mon Sep 17 00:00:00 2001 From: Anton Yackushev Date: Mon, 29 May 2017 09:12:54 +0300 Subject: [PATCH 053/130] fix "no formatting directive in Fatalf call" (vet) (#8487) --- scripts/build/publish.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/build/publish.go b/scripts/build/publish.go index ed738e2312a..7e88c06f67f 100644 --- a/scripts/build/publish.go +++ b/scripts/build/publish.go @@ -75,7 +75,7 @@ func packageWalker(path string, f os.FileInfo, err error) error { shaBytes, err := ioutil.ReadFile(path + ".sha256") if err != nil { - log.Fatalf("Failed to read sha256 file", err) + log.Fatalf("Failed to read sha256 file %v", err) } os := "" From 7004a84c30417a22e89f8c1e8a422334e6d816ee Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Fri, 26 May 2017 13:39:52 -0400 Subject: [PATCH 054/130] tweak column lengths for utf8mb4 support on older mysql --- pkg/services/sqlstore/migrations/alert_mig.go | 4 ++-- pkg/services/sqlstore/migrations/dashboard_mig.go | 4 ++-- pkg/services/sqlstore/migrations/temp_user.go | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pkg/services/sqlstore/migrations/alert_mig.go b/pkg/services/sqlstore/migrations/alert_mig.go index 7b6558656f1..2a364d5f464 100644 --- a/pkg/services/sqlstore/migrations/alert_mig.go +++ b/pkg/services/sqlstore/migrations/alert_mig.go @@ -16,7 +16,7 @@ func addAlertMigrations(mg *Migrator) { {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "frequency", Type: DB_BigInt, Nullable: false}, {Name: "handler", Type: DB_BigInt, Nullable: false}, @@ -70,7 +70,7 @@ func addAlertMigrations(mg *Migrator) { mg.AddMigration("Update alert table charset", NewTableCharsetMigration("alert", []*Column{ {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "severity", Type: DB_Text, Nullable: false}, {Name: "execution_error", Type: DB_Text, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/dashboard_mig.go b/pkg/services/sqlstore/migrations/dashboard_mig.go index 0ef2f3be54f..0519194ae31 100644 --- a/pkg/services/sqlstore/migrations/dashboard_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_mig.go @@ -56,7 +56,7 @@ func addDashboardMigration(mg *Migrator) { Columns: []*Column{ {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "data", Type: DB_Text, Nullable: false}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, @@ -127,7 +127,7 @@ func addDashboardMigration(mg *Migrator) { })) mg.AddMigration("Update dashboard table charset", NewTableCharsetMigration("dashboard", []*Column{ - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 255}, {Name: "data", Type: DB_MediumText, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/temp_user.go b/pkg/services/sqlstore/migrations/temp_user.go index 5592ab7e4ad..3913b18b3d8 100644 --- a/pkg/services/sqlstore/migrations/temp_user.go +++ b/pkg/services/sqlstore/migrations/temp_user.go @@ -9,10 +9,10 @@ func addTempUserMigrations(mg *Migrator) { {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "invited_by_user_id", Type: DB_BigInt, Nullable: true}, {Name: "email_sent", Type: DB_Bool}, @@ -37,10 +37,10 @@ func addTempUserMigrations(mg *Migrator) { addTableIndicesMigrations(mg, "v1-7", tempUserV1) mg.AddMigration("Update temp_user table charset", NewTableCharsetMigration("temp_user", []*Column{ - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "remote_addr", Type: DB_Varchar, Length: 255, Nullable: true}, })) From c0d5b6140346471eb81017a688870938ad411111 Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Mon, 29 May 2017 02:31:36 -0400 Subject: [PATCH 055/130] tweak column lengths for utf8mb4 support on older mysql (#8483) --- pkg/services/sqlstore/migrations/alert_mig.go | 4 ++-- pkg/services/sqlstore/migrations/dashboard_mig.go | 4 ++-- pkg/services/sqlstore/migrations/temp_user.go | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pkg/services/sqlstore/migrations/alert_mig.go b/pkg/services/sqlstore/migrations/alert_mig.go index 7b6558656f1..2a364d5f464 100644 --- a/pkg/services/sqlstore/migrations/alert_mig.go +++ b/pkg/services/sqlstore/migrations/alert_mig.go @@ -16,7 +16,7 @@ func addAlertMigrations(mg *Migrator) { {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "frequency", Type: DB_BigInt, Nullable: false}, {Name: "handler", Type: DB_BigInt, Nullable: false}, @@ -70,7 +70,7 @@ func addAlertMigrations(mg *Migrator) { mg.AddMigration("Update alert table charset", NewTableCharsetMigration("alert", []*Column{ {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "severity", Type: DB_Text, Nullable: false}, {Name: "execution_error", Type: DB_Text, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/dashboard_mig.go b/pkg/services/sqlstore/migrations/dashboard_mig.go index 0ef2f3be54f..0519194ae31 100644 --- a/pkg/services/sqlstore/migrations/dashboard_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_mig.go @@ -56,7 +56,7 @@ func addDashboardMigration(mg *Migrator) { Columns: []*Column{ {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "data", Type: DB_Text, Nullable: false}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, @@ -127,7 +127,7 @@ func addDashboardMigration(mg *Migrator) { })) mg.AddMigration("Update dashboard table charset", NewTableCharsetMigration("dashboard", []*Column{ - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 255}, {Name: "data", Type: DB_MediumText, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/temp_user.go b/pkg/services/sqlstore/migrations/temp_user.go index 5592ab7e4ad..3913b18b3d8 100644 --- a/pkg/services/sqlstore/migrations/temp_user.go +++ b/pkg/services/sqlstore/migrations/temp_user.go @@ -9,10 +9,10 @@ func addTempUserMigrations(mg *Migrator) { {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "invited_by_user_id", Type: DB_BigInt, Nullable: true}, {Name: "email_sent", Type: DB_Bool}, @@ -37,10 +37,10 @@ func addTempUserMigrations(mg *Migrator) { addTableIndicesMigrations(mg, "v1-7", tempUserV1) mg.AddMigration("Update temp_user table charset", NewTableCharsetMigration("temp_user", []*Column{ - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "remote_addr", Type: DB_Varchar, Length: 255, Nullable: true}, })) From ed2092e287fa8a287270770b65848fbb12439d83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 29 May 2017 08:51:56 +0200 Subject: [PATCH 056/130] docs: updated alerting docs to make query conditions easier to understand, fixes #8486 --- docs/sources/alerting/rules.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/sources/alerting/rules.md b/docs/sources/alerting/rules.md index a2688de3100..c4a3a012c46 100644 --- a/docs/sources/alerting/rules.md +++ b/docs/sources/alerting/rules.md @@ -52,12 +52,22 @@ Here you can specify the name of the alert rule and how often the scheduler shou ### Conditions Currently the only condition type that exists is a `Query` condition that allows you to -specify a query letter, time range and an aggregation function. The letter refers to -a query you already have added in the **Metrics** tab. The result from the query and the aggregation function is -a single value that is then used in the threshold check. The query used in an alert rule cannot -contain any template variables. Currently we only support `AND` and `OR` operators between conditions and they are executed serially. +specify a query letter, time range and an aggregation function. + + +### Query condition example + +```sql +avg() OF query(A, 5m, now) IS BELOW 14 +``` + +- `avg()` Controls how the values for **each** serie should be reduced to a value that can be compared against the threshold. Click on the function to change it to another aggregation function. +- `query(A, 5m, now)` The letter defines what query to execute from the **Metrics** tab. The second two parameters defines the time range, `5m, now` means 5 minutes from now to now. You can also do `10m, now-2m` to define a time range that will be 10 minutes from now to 2 minutes from now. This is useful if you want to ignore the last 2 minutes of data. +- `IS BELOW 14` Defines the type of threshold and the threshold value. You can click on `IS BELOW` to change the type of threshold. + +The query used in an alert rule cannot contain any template variables. Currently we only support `AND` and `OR` operators between conditions and they are executed serially. For example, we have 3 conditions in the following order: -`condition:A(evaluates to: TRUE) OR condition:B(evaluates to: FALSE) AND condition:C(evaluates to: TRUE)` +*condition:A(evaluates to: TRUE) OR condition:B(evaluates to: FALSE) AND condition:C(evaluates to: TRUE)* so the result will be calculated as ((TRUE OR FALSE) AND TRUE) = TRUE. We plan to add other condition types in the future, like `Other Alert`, where you can include the state From 0d39852ef4aef6360143295e5677437546e1c8a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 29 May 2017 10:48:38 +0200 Subject: [PATCH 057/130] fix: fixed test data fake metric query, fixes #8474 --- pkg/api/api.go | 1 + pkg/api/metrics.go | 27 +++++++++++++++++++ .../plugins/datasource/grafana/datasource.ts | 26 +++++++++++++++--- .../grafana/partials/query.editor.html | 6 ++++- 4 files changed, 56 insertions(+), 4 deletions(-) diff --git a/pkg/api/api.go b/pkg/api/api.go index 6dcc900c16f..eb17c65ac73 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -253,6 +253,7 @@ func (hs *HttpServer) registerRoutes() { r.Post("/tsdb/query", bind(dtos.MetricRequest{}), wrap(QueryMetrics)) r.Get("/tsdb/testdata/scenarios", wrap(GetTestDataScenarios)) r.Get("/tsdb/testdata/gensql", reqGrafanaAdmin, wrap(GenerateSqlTestData)) + r.Get("/tsdb/testdata/random-walk", wrap(GetTestDataRandomWalk)) // metrics r.Get("/metrics", wrap(GetInternalMetrics)) diff --git a/pkg/api/metrics.go b/pkg/api/metrics.go index abd6527431a..e35e35cdab6 100644 --- a/pkg/api/metrics.go +++ b/pkg/api/metrics.go @@ -7,6 +7,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" "github.com/grafana/grafana/pkg/models" @@ -144,3 +145,29 @@ func GenerateSqlTestData(c *middleware.Context) Response { return Json(200, &util.DynMap{"message": "OK"}) } + +// GET /api/tsdb/testdata/random-walk +func GetTestDataRandomWalk(c *middleware.Context) Response { + from := c.Query("from") + to := c.Query("to") + intervalMs := c.QueryInt64("intervalMs") + + timeRange := tsdb.NewTimeRange(from, to) + request := &tsdb.Request{TimeRange: timeRange} + + request.Queries = append(request.Queries, &tsdb.Query{ + RefId: "A", + IntervalMs: intervalMs, + Model: simplejson.NewFromAny(&util.DynMap{ + "scenario": "random_walk", + }), + DataSource: &models.DataSource{Type: "grafana-testdata-datasource"}, + }) + + resp, err := tsdb.HandleRequest(context.Background(), request) + if err != nil { + return ApiError(500, "Metric request error", err) + } + + return Json(200, &resp) +} diff --git a/public/app/plugins/datasource/grafana/datasource.ts b/public/app/plugins/datasource/grafana/datasource.ts index 8fb987e75e5..2960af6b062 100644 --- a/public/app/plugins/datasource/grafana/datasource.ts +++ b/public/app/plugins/datasource/grafana/datasource.ts @@ -8,11 +8,31 @@ class GrafanaDatasource { constructor(private backendSrv, private $q) {} query(options) { - return this.$q.when({data: []}); + return this.backendSrv.get('/api/tsdb/testdata/random-walk', { + from: options.range.from.valueOf(), + to: options.range.to.valueOf(), + intervalMs: options.intervalMs, + maxDataPoints: options.maxDataPoints, + }).then(res => { + var data = []; + + if (res.results) { + _.forEach(res.results, queryRes => { + for (let series of queryRes.series) { + data.push({ + target: series.name, + datapoints: series.points + }); + } + }); + } + + return {data: data}; + }); } - metricFindQuery() { - return this.$q.when([]); + metricFindQuery(options) { + return this.$q.when({data: []}); } annotationQuery(options) { diff --git a/public/app/plugins/datasource/grafana/partials/query.editor.html b/public/app/plugins/datasource/grafana/partials/query.editor.html index 880402573d5..91ec2bc8faa 100644 --- a/public/app/plugins/datasource/grafana/partials/query.editor.html +++ b/public/app/plugins/datasource/grafana/partials/query.editor.html @@ -1,7 +1,11 @@
      - + +
      + +
      +
      From beced6f3a625e600a6d30c95e87a651d250d11e1 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Mon, 29 May 2017 11:04:49 +0200 Subject: [PATCH 058/130] graph: Handle data with zeroes for log scale fixes #8446. Data with all values equal to zero, creates a max with the value of Infinite. The for loop for creating ticks then gets stuck in an infinite loop. This fix resets min and max and creates some fake ticks for the y-axis if the min and max are not finite numbers. --- public/app/plugins/panel/graph/graph.ts | 17 ++++++++++---- .../plugins/panel/graph/specs/graph_specs.ts | 23 +++++++++++++++++++ 2 files changed, 35 insertions(+), 5 deletions(-) diff --git a/public/app/plugins/panel/graph/graph.ts b/public/app/plugins/panel/graph/graph.ts index e0cec3febbf..726f8be5628 100755 --- a/public/app/plugins/panel/graph/graph.ts +++ b/public/app/plugins/panel/graph/graph.ts @@ -555,12 +555,19 @@ coreModule.directive('grafanaGraph', function($rootScope, timeSrv, popoverSrv) { return; } - axis.ticks = []; - var nextTick; - for (nextTick = min; nextTick <= max; nextTick *= axis.logBase) { - axis.ticks.push(nextTick); + if (Number.isFinite(min) && Number.isFinite(max)) { + axis.ticks = []; + var nextTick; + for (nextTick = min; nextTick <= max; nextTick *= axis.logBase) { + axis.ticks.push(nextTick); + } + axis.tickDecimals = decimalPlaces(min); + } else { + axis.ticks = [1, 2]; + delete axis.min; + delete axis.max; } - axis.tickDecimals = decimalPlaces(min); + } function decimalPlaces(num) { diff --git a/public/app/plugins/panel/graph/specs/graph_specs.ts b/public/app/plugins/panel/graph/specs/graph_specs.ts index 161aca11e42..9595c3dd544 100644 --- a/public/app/plugins/panel/graph/specs/graph_specs.ts +++ b/public/app/plugins/panel/graph/specs/graph_specs.ts @@ -153,6 +153,29 @@ describe('grafanaGraph', function() { }); }); + graphScenario('when logBase is log 10 and data points contain only zeroes', function(ctx) { + ctx.setup(function(ctrl, data) { + ctrl.panel.yaxes[0].logBase = 10; + data[0] = new TimeSeries({ + datapoints: [[0,1],[0,2],[0,3],[0,4]], + alias: 'seriesAutoscale', + }); + data[0].yaxis = 1; + }); + + it('should not set min and max and should create some fake ticks', function() { + var axisAutoscale = ctx.plotOptions.yaxes[0]; + expect(axisAutoscale.transform(100)).to.be(2); + expect(axisAutoscale.inverseTransform(-3)).to.be(0.001); + expect(axisAutoscale.min).to.be(undefined); + expect(axisAutoscale.max).to.be(undefined); + expect(axisAutoscale.ticks.length).to.be(2); + expect(axisAutoscale.ticks[0]).to.be(1); + expect(axisAutoscale.ticks[1]).to.be(2); + expect(axisAutoscale.tickDecimals).to.be(undefined); + }); + }); + graphScenario('dashed lines options', function(ctx) { ctx.setup(function(ctrl) { ctrl.panel.lines = true; From 980b9b5ca05baa2eb414aeaa755652057f95ce3a Mon Sep 17 00:00:00 2001 From: Victor Azevedo Date: Thu, 25 May 2017 11:43:29 -0400 Subject: [PATCH 059/130] use fielddata_fields in elasticsearch 2.x queries Resolves issue #8467 --- .../app/plugins/datasource/elasticsearch/query_builder.js | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index dd296c00a34..571eea14399 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -118,8 +118,12 @@ function (queryDef) { query.fields = ["*", "_source"]; } - query.script_fields = {}, - query.docvalue_fields = [this.timeField]; + query.script_fields = {}; + if (this.esVersion < 5) { + query.fielddata_fields = [this.timeField]; + } else { + query.docvalue_fields = [this.timeField]; + } return query; }; From 0d865a83bc7b21b36fdae6fdf305a9dea894883a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 29 May 2017 10:48:38 +0200 Subject: [PATCH 060/130] fix: fixed test data fake metric query, fixes #8474 --- pkg/api/api.go | 1 + pkg/api/metrics.go | 27 +++++++++++++++++++ .../plugins/datasource/grafana/datasource.ts | 26 +++++++++++++++--- .../grafana/partials/query.editor.html | 6 ++++- 4 files changed, 56 insertions(+), 4 deletions(-) diff --git a/pkg/api/api.go b/pkg/api/api.go index 6dcc900c16f..eb17c65ac73 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -253,6 +253,7 @@ func (hs *HttpServer) registerRoutes() { r.Post("/tsdb/query", bind(dtos.MetricRequest{}), wrap(QueryMetrics)) r.Get("/tsdb/testdata/scenarios", wrap(GetTestDataScenarios)) r.Get("/tsdb/testdata/gensql", reqGrafanaAdmin, wrap(GenerateSqlTestData)) + r.Get("/tsdb/testdata/random-walk", wrap(GetTestDataRandomWalk)) // metrics r.Get("/metrics", wrap(GetInternalMetrics)) diff --git a/pkg/api/metrics.go b/pkg/api/metrics.go index abd6527431a..e35e35cdab6 100644 --- a/pkg/api/metrics.go +++ b/pkg/api/metrics.go @@ -7,6 +7,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/metrics" "github.com/grafana/grafana/pkg/middleware" "github.com/grafana/grafana/pkg/models" @@ -144,3 +145,29 @@ func GenerateSqlTestData(c *middleware.Context) Response { return Json(200, &util.DynMap{"message": "OK"}) } + +// GET /api/tsdb/testdata/random-walk +func GetTestDataRandomWalk(c *middleware.Context) Response { + from := c.Query("from") + to := c.Query("to") + intervalMs := c.QueryInt64("intervalMs") + + timeRange := tsdb.NewTimeRange(from, to) + request := &tsdb.Request{TimeRange: timeRange} + + request.Queries = append(request.Queries, &tsdb.Query{ + RefId: "A", + IntervalMs: intervalMs, + Model: simplejson.NewFromAny(&util.DynMap{ + "scenario": "random_walk", + }), + DataSource: &models.DataSource{Type: "grafana-testdata-datasource"}, + }) + + resp, err := tsdb.HandleRequest(context.Background(), request) + if err != nil { + return ApiError(500, "Metric request error", err) + } + + return Json(200, &resp) +} diff --git a/public/app/plugins/datasource/grafana/datasource.ts b/public/app/plugins/datasource/grafana/datasource.ts index 8fb987e75e5..2960af6b062 100644 --- a/public/app/plugins/datasource/grafana/datasource.ts +++ b/public/app/plugins/datasource/grafana/datasource.ts @@ -8,11 +8,31 @@ class GrafanaDatasource { constructor(private backendSrv, private $q) {} query(options) { - return this.$q.when({data: []}); + return this.backendSrv.get('/api/tsdb/testdata/random-walk', { + from: options.range.from.valueOf(), + to: options.range.to.valueOf(), + intervalMs: options.intervalMs, + maxDataPoints: options.maxDataPoints, + }).then(res => { + var data = []; + + if (res.results) { + _.forEach(res.results, queryRes => { + for (let series of queryRes.series) { + data.push({ + target: series.name, + datapoints: series.points + }); + } + }); + } + + return {data: data}; + }); } - metricFindQuery() { - return this.$q.when([]); + metricFindQuery(options) { + return this.$q.when({data: []}); } annotationQuery(options) { diff --git a/public/app/plugins/datasource/grafana/partials/query.editor.html b/public/app/plugins/datasource/grafana/partials/query.editor.html index 880402573d5..91ec2bc8faa 100644 --- a/public/app/plugins/datasource/grafana/partials/query.editor.html +++ b/public/app/plugins/datasource/grafana/partials/query.editor.html @@ -1,7 +1,11 @@
      - + +
      + +
      +
      From c95162e0679eb3729f815eeb145c2e6e0be6e38f Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Mon, 29 May 2017 02:31:36 -0400 Subject: [PATCH 061/130] tweak column lengths for utf8mb4 support on older mysql (#8483) --- pkg/services/sqlstore/migrations/alert_mig.go | 4 ++-- pkg/services/sqlstore/migrations/dashboard_mig.go | 4 ++-- pkg/services/sqlstore/migrations/temp_user.go | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pkg/services/sqlstore/migrations/alert_mig.go b/pkg/services/sqlstore/migrations/alert_mig.go index 7b6558656f1..2a364d5f464 100644 --- a/pkg/services/sqlstore/migrations/alert_mig.go +++ b/pkg/services/sqlstore/migrations/alert_mig.go @@ -16,7 +16,7 @@ func addAlertMigrations(mg *Migrator) { {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "frequency", Type: DB_BigInt, Nullable: false}, {Name: "handler", Type: DB_BigInt, Nullable: false}, @@ -70,7 +70,7 @@ func addAlertMigrations(mg *Migrator) { mg.AddMigration("Update alert table charset", NewTableCharsetMigration("alert", []*Column{ {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "message", Type: DB_Text, Nullable: false}, - {Name: "state", Type: DB_NVarchar, Length: 255, Nullable: false}, + {Name: "state", Type: DB_NVarchar, Length: 190, Nullable: false}, {Name: "settings", Type: DB_Text, Nullable: false}, {Name: "severity", Type: DB_Text, Nullable: false}, {Name: "execution_error", Type: DB_Text, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/dashboard_mig.go b/pkg/services/sqlstore/migrations/dashboard_mig.go index 0ef2f3be54f..0519194ae31 100644 --- a/pkg/services/sqlstore/migrations/dashboard_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_mig.go @@ -56,7 +56,7 @@ func addDashboardMigration(mg *Migrator) { Columns: []*Column{ {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "data", Type: DB_Text, Nullable: false}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, @@ -127,7 +127,7 @@ func addDashboardMigration(mg *Migrator) { })) mg.AddMigration("Update dashboard table charset", NewTableCharsetMigration("dashboard", []*Column{ - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 255}, {Name: "data", Type: DB_MediumText, Nullable: false}, diff --git a/pkg/services/sqlstore/migrations/temp_user.go b/pkg/services/sqlstore/migrations/temp_user.go index 5592ab7e4ad..3913b18b3d8 100644 --- a/pkg/services/sqlstore/migrations/temp_user.go +++ b/pkg/services/sqlstore/migrations/temp_user.go @@ -9,10 +9,10 @@ func addTempUserMigrations(mg *Migrator) { {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "org_id", Type: DB_BigInt, Nullable: false}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "invited_by_user_id", Type: DB_BigInt, Nullable: true}, {Name: "email_sent", Type: DB_Bool}, @@ -37,10 +37,10 @@ func addTempUserMigrations(mg *Migrator) { addTableIndicesMigrations(mg, "v1-7", tempUserV1) mg.AddMigration("Update temp_user table charset", NewTableCharsetMigration("temp_user", []*Column{ - {Name: "email", Type: DB_NVarchar, Length: 255}, + {Name: "email", Type: DB_NVarchar, Length: 190}, {Name: "name", Type: DB_NVarchar, Length: 255, Nullable: true}, {Name: "role", Type: DB_NVarchar, Length: 20, Nullable: true}, - {Name: "code", Type: DB_NVarchar, Length: 255}, + {Name: "code", Type: DB_NVarchar, Length: 190}, {Name: "status", Type: DB_Varchar, Length: 20}, {Name: "remote_addr", Type: DB_Varchar, Length: 255, Nullable: true}, })) From d318c9093fc2fcf610f38bf22550fb0f66849626 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Mon, 29 May 2017 11:04:49 +0200 Subject: [PATCH 062/130] graph: Handle data with zeroes for log scale fixes #8446. Data with all values equal to zero, creates a max with the value of Infinite. The for loop for creating ticks then gets stuck in an infinite loop. This fix resets min and max and creates some fake ticks for the y-axis if the min and max are not finite numbers. --- public/app/plugins/panel/graph/graph.ts | 17 ++++++++++---- .../plugins/panel/graph/specs/graph_specs.ts | 23 +++++++++++++++++++ 2 files changed, 35 insertions(+), 5 deletions(-) diff --git a/public/app/plugins/panel/graph/graph.ts b/public/app/plugins/panel/graph/graph.ts index e0cec3febbf..726f8be5628 100755 --- a/public/app/plugins/panel/graph/graph.ts +++ b/public/app/plugins/panel/graph/graph.ts @@ -555,12 +555,19 @@ coreModule.directive('grafanaGraph', function($rootScope, timeSrv, popoverSrv) { return; } - axis.ticks = []; - var nextTick; - for (nextTick = min; nextTick <= max; nextTick *= axis.logBase) { - axis.ticks.push(nextTick); + if (Number.isFinite(min) && Number.isFinite(max)) { + axis.ticks = []; + var nextTick; + for (nextTick = min; nextTick <= max; nextTick *= axis.logBase) { + axis.ticks.push(nextTick); + } + axis.tickDecimals = decimalPlaces(min); + } else { + axis.ticks = [1, 2]; + delete axis.min; + delete axis.max; } - axis.tickDecimals = decimalPlaces(min); + } function decimalPlaces(num) { diff --git a/public/app/plugins/panel/graph/specs/graph_specs.ts b/public/app/plugins/panel/graph/specs/graph_specs.ts index 161aca11e42..9595c3dd544 100644 --- a/public/app/plugins/panel/graph/specs/graph_specs.ts +++ b/public/app/plugins/panel/graph/specs/graph_specs.ts @@ -153,6 +153,29 @@ describe('grafanaGraph', function() { }); }); + graphScenario('when logBase is log 10 and data points contain only zeroes', function(ctx) { + ctx.setup(function(ctrl, data) { + ctrl.panel.yaxes[0].logBase = 10; + data[0] = new TimeSeries({ + datapoints: [[0,1],[0,2],[0,3],[0,4]], + alias: 'seriesAutoscale', + }); + data[0].yaxis = 1; + }); + + it('should not set min and max and should create some fake ticks', function() { + var axisAutoscale = ctx.plotOptions.yaxes[0]; + expect(axisAutoscale.transform(100)).to.be(2); + expect(axisAutoscale.inverseTransform(-3)).to.be(0.001); + expect(axisAutoscale.min).to.be(undefined); + expect(axisAutoscale.max).to.be(undefined); + expect(axisAutoscale.ticks.length).to.be(2); + expect(axisAutoscale.ticks[0]).to.be(1); + expect(axisAutoscale.ticks[1]).to.be(2); + expect(axisAutoscale.tickDecimals).to.be(undefined); + }); + }); + graphScenario('dashed lines options', function(ctx) { ctx.setup(function(ctrl) { ctrl.panel.lines = true; From e4cb103966c087d01802960e13cf6de9e4b23b74 Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Wed, 24 May 2017 04:39:40 -0700 Subject: [PATCH 063/130] remove X-Forwarded-* headers added by nginx when proxying data source & plugin requests (#8418) * remove X-Forwarded-* headers added by nginx when proxying data source & plugin requests * properly handle X-Forwarded-For --- pkg/api/dataproxy.go | 22 ++++++++++++++++++++++ pkg/api/pluginproxy/pluginproxy.go | 23 ++++++++++++++++++++++- 2 files changed, 44 insertions(+), 1 deletion(-) diff --git a/pkg/api/dataproxy.go b/pkg/api/dataproxy.go index 612d013e802..965653c2501 100644 --- a/pkg/api/dataproxy.go +++ b/pkg/api/dataproxy.go @@ -3,6 +3,7 @@ package api import ( "bytes" "io/ioutil" + "net" "net/http" "net/http/httputil" "net/url" @@ -62,6 +63,27 @@ func NewReverseProxy(ds *m.DataSource, proxyPath string, targetUrl *url.URL) *ht // clear cookie headers req.Header.Del("Cookie") req.Header.Del("Set-Cookie") + + // clear X-Forwarded Host/Port/Proto headers + req.Header.Del("X-Forwarded-Host") + req.Header.Del("X-Forwarded-Port") + req.Header.Del("X-Forwarded-Proto") + + // set X-Forwarded-For header + if req.RemoteAddr != "" { + remoteAddr, _, err := net.SplitHostPort(req.RemoteAddr) + if err != nil { + remoteAddr = req.RemoteAddr + } + if req.Header.Get("X-Forwarded-For") != "" { + req.Header.Set("X-Forwarded-For", req.Header.Get("X-Forwarded-For")+", "+remoteAddr) + } else { + req.Header.Set("X-Forwarded-For", remoteAddr) + } + } + + // reqBytes, _ := httputil.DumpRequestOut(req, true); + // log.Trace("Proxying datasource request: %s", string(reqBytes)) } return &httputil.ReverseProxy{Director: director, FlushInterval: time.Millisecond * 200} diff --git a/pkg/api/pluginproxy/pluginproxy.go b/pkg/api/pluginproxy/pluginproxy.go index 21d40ecb948..a5139bb69f7 100644 --- a/pkg/api/pluginproxy/pluginproxy.go +++ b/pkg/api/pluginproxy/pluginproxy.go @@ -5,6 +5,7 @@ import ( "encoding/json" "errors" "fmt" + "net" "net/http" "net/http/httputil" "net/url" @@ -71,7 +72,25 @@ func NewApiPluginProxy(ctx *middleware.Context, proxyPath string, route *plugins req.Header.Del("Cookie") req.Header.Del("Set-Cookie") - //Create a HTTP header with the context in it. + // clear X-Forwarded Host/Port/Proto headers + req.Header.Del("X-Forwarded-Host") + req.Header.Del("X-Forwarded-Port") + req.Header.Del("X-Forwarded-Proto") + + // set X-Forwarded-For header + if req.RemoteAddr != "" { + remoteAddr, _, err := net.SplitHostPort(req.RemoteAddr) + if err != nil { + remoteAddr = req.RemoteAddr + } + if req.Header.Get("X-Forwarded-For") != "" { + req.Header.Set("X-Forwarded-For", req.Header.Get("X-Forwarded-For")+", "+remoteAddr) + } else { + req.Header.Set("X-Forwarded-For", remoteAddr) + } + } + + // Create a HTTP header with the context in it. ctxJson, err := json.Marshal(ctx.SignedInUser) if err != nil { ctx.JsonApiErr(500, "failed to marshal context to json.", err) @@ -93,6 +112,8 @@ func NewApiPluginProxy(ctx *middleware.Context, proxyPath string, route *plugins } } + // reqBytes, _ := httputil.DumpRequestOut(req, true); + // log.Trace("Proxying plugin request: %s", string(reqBytes)) } return &httputil.ReverseProxy{Director: director} From 26ec874fb1b548a54edad9e7792c25248b7f86c9 Mon Sep 17 00:00:00 2001 From: Pranay Kanwar Date: Tue, 30 May 2017 13:23:11 +0530 Subject: [PATCH 064/130] Frontend query changes corresponding #8336 (#8489) --- public/app/plugins/datasource/opentsdb/datasource.js | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/public/app/plugins/datasource/opentsdb/datasource.js b/public/app/plugins/datasource/opentsdb/datasource.js index ecd939d8f74..f460c1a1c91 100644 --- a/public/app/plugins/datasource/opentsdb/datasource.js +++ b/public/app/plugins/datasource/opentsdb/datasource.js @@ -28,8 +28,8 @@ function (angular, _, dateMath) { _.each(options.targets, function(target) { if (!target.metric) { return; } - qs.push(convertTargetToQuery(target, options)); - }); + qs.push(convertTargetToQuery(target, options, this.tsdbVersion)); + }.bind(this)); var queries = _.compact(qs); @@ -366,7 +366,7 @@ function (angular, _, dateMath) { return label; } - function convertTargetToQuery(target, options) { + function convertTargetToQuery(target, options, tsdbVersion) { if (!target.metric || target.hide) { return null; } @@ -393,6 +393,11 @@ function (angular, _, dateMath) { if (target.counterResetValue && target.counterResetValue.length) { query.rateOptions.resetValue = parseInt(target.counterResetValue); } + + if(tsdbVersion >= 2) { + query.rateOptions.dropResets = !query.rateOptions.counterMax && + (!query.rateOptions.ResetValue || query.rateOptions.ResetValue === 0); + } } if (!target.disableDownsampling) { From cd3807055e8d5de760fd00baca9cafb2e5fdf423 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 30 May 2017 13:50:03 +0200 Subject: [PATCH 065/130] chrome: an attempt to fix scroll issue with chrome, but this did not fix the problem as it seems to be caused by some interaction between graph rendering and scrolling, #8494 --- public/app/core/components/grafana_app.ts | 12 ++++++++++++ public/app/features/panel/panel_directive.ts | 3 ++- public/app/headers/common.d.ts | 1 + 3 files changed, 15 insertions(+), 1 deletion(-) diff --git a/public/app/core/components/grafana_app.ts b/public/app/core/components/grafana_app.ts index f48d941a8ba..09326de6481 100644 --- a/public/app/core/components/grafana_app.ts +++ b/public/app/core/components/grafana_app.ts @@ -122,6 +122,18 @@ export function grafanaAppDirective(playlistSrv, contextSrv) { body.toggleClass('page-kiosk-mode'); }); + var ticking = false; + window.addEventListener('scroll', function(e) { + if (!ticking) { + ticking = true; + setTimeout(function() { + appEvents.emit('scroll'); + ticking = false; + }, 100); + } + ticking = true; + }); + // handle in active view state class var lastActivity = new Date().getTime(); var activeUser = true; diff --git a/public/app/features/panel/panel_directive.ts b/public/app/features/panel/panel_directive.ts index 63fdba693cb..c7ccbb62eab 100644 --- a/public/app/features/panel/panel_directive.ts +++ b/public/app/features/panel/panel_directive.ts @@ -4,6 +4,7 @@ import angular from 'angular'; import $ from 'jquery'; import _ from 'lodash'; import Drop from 'tether-drop'; +import {appEvents} from 'app/core/core'; var module = angular.module('grafana.directives'); @@ -196,7 +197,7 @@ module.directive('grafanaPanel', function($rootScope, $document) { } }; - $document.on('scroll', refreshOnScroll); + appEvents.on('scroll', refreshOnScroll, scope); scope.$on('$destroy', function() { elem.off(); diff --git a/public/app/headers/common.d.ts b/public/app/headers/common.d.ts index 9ea5e96654d..314258be21e 100644 --- a/public/app/headers/common.d.ts +++ b/public/app/headers/common.d.ts @@ -72,3 +72,4 @@ declare module 'd3' { var d3: any; export default d3; } + From 812958162a69b24dff14e8dbb30758b1597c4de4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 31 May 2017 10:47:04 +0200 Subject: [PATCH 066/130] revert: removed lazy loading feature, closes #8500 --- public/app/features/panel/panel_ctrl.ts | 9 --------- public/app/features/panel/panel_directive.ts | 14 -------------- 2 files changed, 23 deletions(-) diff --git a/public/app/features/panel/panel_ctrl.ts b/public/app/features/panel/panel_ctrl.ts index 8de78291baa..83c79f4123b 100644 --- a/public/app/features/panel/panel_ctrl.ts +++ b/public/app/features/panel/panel_ctrl.ts @@ -35,8 +35,6 @@ export class PanelCtrl { containerHeight: any; events: Emitter; timing: any; - skippedLastRefresh: boolean; - isPanelVisible: any; constructor($scope, $injector) { this.$injector = $injector; @@ -77,13 +75,6 @@ export class PanelCtrl { } refresh() { - if (!this.isPanelVisible() && !this.dashboard.meta.soloMode && !this.dashboard.snapshot) { - this.skippedLastRefresh = true; - return; - } - - this.skippedLastRefresh = false; - this.events.emit('refresh', null); } diff --git a/public/app/features/panel/panel_directive.ts b/public/app/features/panel/panel_directive.ts index 63fdba693cb..11906ab7d8d 100644 --- a/public/app/features/panel/panel_directive.ts +++ b/public/app/features/panel/panel_directive.ts @@ -185,23 +185,9 @@ module.directive('grafanaPanel', function($rootScope, $document) { elem.on('mouseenter', mouseEnter); elem.on('mouseleave', mouseLeave); - ctrl.isPanelVisible = function () { - var position = panelContainer[0].getBoundingClientRect(); - return (0 < position.top) && (position.top < window.innerHeight); - }; - - const refreshOnScroll = function () { - if (ctrl.skippedLastRefresh) { - ctrl.refresh(); - } - }; - - $document.on('scroll', refreshOnScroll); - scope.$on('$destroy', function() { elem.off(); cornerInfoElem.off(); - $document.off('scroll', refreshOnScroll); if (infoDrop) { infoDrop.destroy(); From ed4d170bcce8697bda28a65a33c630a2628d989e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 31 May 2017 10:48:16 +0200 Subject: [PATCH 067/130] build: updated version to v4.3.2 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9f9a4364e33..5d028de93b0 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "company": "Coding Instinct AB" }, "name": "grafana", - "version": "4.3.1", + "version": "4.3.2", "repository": { "type": "git", "url": "http://github.com/grafana/grafana.git" From 6783d1000ca8a656011f82c6b2f622559e270a3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 31 May 2017 14:04:02 +0200 Subject: [PATCH 068/130] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 98f489e3ce3..d6f8cecd7d0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,9 @@ * **Playlist**: Fixed dashboard play order issue [#7688](https://github.com/grafana/grafana/issues/7688) * **Elasticsearch**: Fixed table query issue with ES 2.x [#8467](https://github.com/grafana/grafana/issues/8467), thx [@goldeelox](https://github.com/goldeelox) +## Changes +* **Lazy Loading Of Panels**: Panels are no longer loaded as they are scrolled into view, this was reverted due to Chrome bug, might be reintroduced when Chrome fixes it's JS blocking behavior on scroll. [#8500](https://github.com/grafana/grafana/issues/8500) + # 4.3.1 (2017-05-23) ## Bug fixes From 1bdf82dca3882452eac6454e19d64d5e77cb1bfb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 31 May 2017 14:04:19 +0200 Subject: [PATCH 069/130] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6f8cecd7d0..eef674b4bec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ * **Sensu**: Added option for source and handler [#8405](https://github.com/grafana/grafana/pull/8405), thx [@joemiller](github.com/joemiller) * **CSV**: Configurable csv export datetime format [#8058](https://github.com/grafana/grafana/issues/8058), thx [@cederigo](github.com/cederigo) -# 4.3.2 (upcoming patch release) +# 4.3.2 (2017-05-31) ## Bug fixes From 77c046aac6d0160c383f3664be9c01e147047650 Mon Sep 17 00:00:00 2001 From: sanchitraizada Date: Thu, 1 Jun 2017 17:57:09 -0400 Subject: [PATCH 070/130] Implement review feedback --- pkg/api/api.go | 10 +- pkg/api/dashboard.go | 153 +++++++----------- pkg/models/dashboard_version.go | 2 +- pkg/services/sqlstore/dashboard_version.go | 26 ++- public/app/core/directives/dash_edit_link.js | 2 +- public/app/core/directives/diff-view.ts | 3 +- public/app/features/all.js | 1 - public/app/features/dashboard/all.js | 2 +- .../features/dashboard/dashnav/dashnav.html | 2 +- .../audit.html => history/history.html} | 18 +-- .../audit_ctrl.ts => history/history.ts} | 36 +++-- .../audit_srv.ts => history/history_srv.ts} | 10 +- .../dashboard/{audit => history}/models.ts | 2 +- .../dashboard/history/partials/history.html | 1 + .../partials/link-json.html | 0 ...it_ctrl_specs.ts => history_ctrl_specs.ts} | 64 ++++---- ...udit_srv_specs.ts => history_srv_specs.ts} | 16 +- public/sass/_grafana.scss | 2 +- .../sass/pages/{_audit.scss => _history.scss} | 6 +- .../{audit-mocks.js => history-mocks.js} | 8 +- 20 files changed, 173 insertions(+), 191 deletions(-) rename public/app/features/dashboard/{audit/partials/audit.html => history/history.html} (92%) rename public/app/features/dashboard/{audit/audit_ctrl.ts => history/history.ts} (87%) rename public/app/features/dashboard/{audit/audit_srv.ts => history/history_srv.ts} (84%) rename public/app/features/dashboard/{audit => history}/models.ts (87%) create mode 100644 public/app/features/dashboard/history/partials/history.html rename public/app/features/dashboard/{audit => history}/partials/link-json.html (100%) rename public/app/features/dashboard/specs/{audit_ctrl_specs.ts => history_ctrl_specs.ts} (87%) rename public/app/features/dashboard/specs/{audit_srv_specs.ts => history_srv_specs.ts} (86%) rename public/sass/pages/{_audit.scss => _history.scss} (98%) rename public/test/mocks/{audit-mocks.js => history-mocks.js} (97%) diff --git a/pkg/api/api.go b/pkg/api/api.go index 354bb5bdc5d..46a636cb8eb 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -224,11 +224,11 @@ func (hs *HttpServer) registerRoutes() { r.Group("/dashboards", func() { r.Combo("/db/:slug").Get(GetDashboard).Delete(DeleteDashboard) - r.Get("/db/:dashboardId/versions", GetDashboardVersions) - r.Get("/db/:dashboardId/versions/:id", GetDashboardVersion) - r.Get("/db/:dashboardId/compare/:versions", CompareDashboardVersions) - r.Get("/db/:dashboardId/compare/:versions/html", CompareDashboardVersionsJSON) - r.Get("/db/:dashboardId/compare/:versions/basic", CompareDashboardVersionsBasic) + r.Get("/db/:dashboardId/versions", wrap(GetDashboardVersions)) + r.Get("/db/:dashboardId/versions/:id", wrap(GetDashboardVersion)) + r.Get("/db/:dashboardId/compare/:versions", wrap(CompareDashboardVersions)) + r.Get("/db/:dashboardId/compare/:versions/html", wrap(CompareDashboardVersionsJSON)) + r.Get("/db/:dashboardId/compare/:versions/basic", wrap(CompareDashboardVersionsBasic)) r.Post("/db/:dashboardId/restore", reqEditorRole, bind(m.RestoreDashboardVersionCommand{}), wrap(RestoreDashboardVersion)) r.Post("/db", reqEditorRole, bind(m.SaveDashboardCommand{}), wrap(PostDashboard)) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 44d0e52388c..79e0e2b05cf 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -258,16 +258,9 @@ func GetDashboardFromJsonFile(c *middleware.Context) { c.JSON(200, &dash) } -// GetDashboardVersions returns all dashboardversions as JSON -func GetDashboardVersions(c *middleware.Context) { - dashboardIdStr := c.Params(":dashboardId") - dashboardId, err := strconv.Atoi(dashboardIdStr) - if err != nil { - c.JsonApiErr(400, err.Error(), err) - return - } - - // TODO(ben) the orderBy arg should be split into snake_case? +// GetDashboardVersions returns all dashboard versions as JSON +func GetDashboardVersions(c *middleware.Context) Response { + dashboardId := c.ParamsInt64(":dashboardId") orderBy := c.Query("orderBy") limit := c.QueryInt("limit") start := c.QueryInt("start") @@ -279,62 +272,54 @@ func GetDashboardVersions(c *middleware.Context) { } query := m.GetDashboardVersionsCommand{ - DashboardId: int64(dashboardId), + DashboardId: dashboardId, OrderBy: orderBy, Limit: limit, Start: start, } if err := bus.Dispatch(&query); err != nil { - c.JsonApiErr(404, fmt.Sprintf("No versions found for dashboardId %d", dashboardId), err) - return + return ApiError(404, fmt.Sprintf("No versions found for dashboardId %d", dashboardId), err) } - dashboardVersions := make([]*m.DashboardVersionDTO, len(query.Result)) - for i, dashboardVersion := range query.Result { - creator := "Anonymous" - if dashboardVersion.CreatedBy > 0 { - creator = getUserLogin(dashboardVersion.CreatedBy) - } + // // TODO(ben) use inner join with DTO + // dashboardVersions := make([]*m.DashboardVersionDTO, len(query.Result)) + // for i, dashboardVersion := range query.Result { + // creator := "Anonymous" + // if dashboardVersion.CreatedBy > 0 { + // creator = getUserLogin(dashboardVersion.CreatedBy) + // } - dashboardVersions[i] = &m.DashboardVersionDTO{ - Id: dashboardVersion.Id, - DashboardId: dashboardVersion.DashboardId, - ParentVersion: dashboardVersion.ParentVersion, - RestoredFrom: dashboardVersion.RestoredFrom, - Version: dashboardVersion.Version, - Created: dashboardVersion.Created, - CreatedBy: creator, - Message: dashboardVersion.Message, - } - } + // dashboardVersions[i] = &m.DashboardVersionDTO{ + // Id: dashboardVersion.Id, + // DashboardId: dashboardVersion.DashboardId, + // ParentVersion: dashboardVersion.ParentVersion, + // RestoredFrom: dashboardVersion.RestoredFrom, + // Version: dashboardVersion.Version, + // Created: dashboardVersion.Created, + // CreatedBy: creator, + // Message: dashboardVersion.Message, + // } + // } - c.JSON(200, dashboardVersions) + return Json(200, query.Result) } // GetDashboardVersion returns the dashboard version with the given ID. -func GetDashboardVersion(c *middleware.Context) { - dashboardIdStr := c.Params(":dashboardId") - dashboardId, err := strconv.Atoi(dashboardIdStr) - if err != nil { - c.JsonApiErr(400, err.Error(), err) - return - } - - versionStr := c.Params(":id") - version, err := strconv.Atoi(versionStr) - if err != nil { - c.JsonApiErr(400, err.Error(), err) - return - } +func GetDashboardVersion(c *middleware.Context) Response { + dashboardId := c.ParamsInt64(":dashboardId") + version := c.ParamsInt(":id") query := m.GetDashboardVersionCommand{ - DashboardId: int64(dashboardId), + DashboardId: dashboardId, Version: version, } if err := bus.Dispatch(&query); err != nil { - c.JsonApiErr(500, err.Error(), err) - return + return ApiError( + 500, + fmt.Sprintf("Dashboard version %d not found for dashboardId %d", version, dashboardId), + err, + ) } creator := "Anonymous" @@ -347,10 +332,10 @@ func GetDashboardVersion(c *middleware.Context) { CreatedBy: creator, } - c.JSON(200, dashVersionMeta) + return Json(200, dashVersionMeta) } -func dashCmd(c *middleware.Context) (m.CompareDashboardVersionsCommand, error) { +func createCompareDashboardVersionCommand(c *middleware.Context) (m.CompareDashboardVersionsCommand, error) { cmd := m.CompareDashboardVersionsCommand{} dashboardIdStr := c.Params(":dashboardId") @@ -381,106 +366,82 @@ func dashCmd(c *middleware.Context) (m.CompareDashboardVersionsCommand, error) { } // CompareDashboardVersions compares dashboards the way the GitHub API does. -func CompareDashboardVersions(c *middleware.Context) { - cmd, err := dashCmd(c) +func CompareDashboardVersions(c *middleware.Context) Response { + cmd, err := createCompareDashboardVersionCommand(c) if err != nil { - c.JsonApiErr(500, err.Error(), err) + return ApiError(500, err.Error(), err) } cmd.DiffType = m.DiffDelta if err := bus.Dispatch(&cmd); err != nil { - c.JsonApiErr(500, "cannot-compute-diff", err) - return + return ApiError(500, "Unable to compute diff", err) } + // here the output is already JSON, so we need to unmarshal it into a // map before marshaling the entire response deltaMap := make(map[string]interface{}) err = json.Unmarshal(cmd.Delta, &deltaMap) if err != nil { - c.JsonApiErr(500, err.Error(), err) - return + return ApiError(500, err.Error(), err) } - c.JSON(200, simplejson.NewFromAny(util.DynMap{ + return Json(200, util.DynMap{ "meta": util.DynMap{ "original": cmd.Original, "new": cmd.New, }, "delta": deltaMap, - })) + }) } // CompareDashboardVersionsJSON compares dashboards the way the GitHub API does, // returning a human-readable JSON diff. -func CompareDashboardVersionsJSON(c *middleware.Context) { - cmd, err := dashCmd(c) +func CompareDashboardVersionsJSON(c *middleware.Context) Response { + cmd, err := createCompareDashboardVersionCommand(c) if err != nil { - c.JsonApiErr(500, err.Error(), err) + return ApiError(500, err.Error(), err) } cmd.DiffType = m.DiffJSON if err := bus.Dispatch(&cmd); err != nil { - c.JsonApiErr(500, err.Error(), err) - return + return ApiError(500, err.Error(), err) } - c.Header().Set("Content-Type", "text/html") - c.WriteHeader(200) - c.Write(cmd.Delta) + return Respond(200, cmd.Delta).Header("Content-Type", "text/html") } // CompareDashboardVersionsBasic compares dashboards the way the GitHub API does, // returning a human-readable diff. -func CompareDashboardVersionsBasic(c *middleware.Context) { - cmd, err := dashCmd(c) +func CompareDashboardVersionsBasic(c *middleware.Context) Response { + cmd, err := createCompareDashboardVersionCommand(c) if err != nil { - c.JsonApiErr(500, err.Error(), err) + return ApiError(500, err.Error(), err) } cmd.DiffType = m.DiffBasic if err := bus.Dispatch(&cmd); err != nil { - c.JsonApiErr(500, err.Error(), err) - return + return ApiError(500, err.Error(), err) } - c.Header().Set("Content-Type", "text/html") - c.WriteHeader(200) - c.Write(cmd.Delta) + return Respond(200, cmd.Delta).Header("Content-Type", "text/html") } // RestoreDashboardVersion restores a dashboard to the given version. func RestoreDashboardVersion(c *middleware.Context, cmd m.RestoreDashboardVersionCommand) Response { if !c.IsSignedIn { - return Json(401, util.DynMap{ - "message": "Must be signed in to restore a version", - "status": "unauthorized", - }) + return ApiError(401, "Must be signed in to restore a version", nil) } cmd.UserId = c.UserId - dashboardIdStr := c.Params(":dashboardId") - dashboardId, err := strconv.Atoi(dashboardIdStr) - if err != nil { - return Json(404, util.DynMap{ - "message": err.Error(), - "status": "cannot-find-dashboard", - }) - } - cmd.DashboardId = int64(dashboardId) + cmd.DashboardId = c.ParamsInt64(":dashboardId") if err := bus.Dispatch(&cmd); err != nil { - return Json(500, util.DynMap{ - "message": err.Error(), - "status": "cannot-restore-version", - }) + return ApiError(500, "Cannot restore version", err) } isStarred, err := isDashboardStarredByUser(c, cmd.Result.Id) if err != nil { - return Json(500, util.DynMap{ - "message": "Error while checking if dashboard was starred by user", - "status": err.Error(), - }) + return ApiError(500, "Error checking if dashboard is starred by user", err) } // Finding creator and last updater of the dashboard diff --git a/pkg/models/dashboard_version.go b/pkg/models/dashboard_version.go index 18a4783a627..fd375db951c 100644 --- a/pkg/models/dashboard_version.go +++ b/pkg/models/dashboard_version.go @@ -80,7 +80,7 @@ type GetDashboardVersionsCommand struct { Limit int `json:"limit"` Start int `json:"start"` - Result []*DashboardVersion + Result []*DashboardVersionDTO } // RestoreDashboardVersionCommand creates a new dashboard version. diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index bda2c6970d3..c3695dc778f 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -91,15 +91,25 @@ func GetDashboardVersion(query *m.GetDashboardVersionCommand) error { // GetDashboardVersions gets all dashboard versions for the given dashboard ID. func GetDashboardVersions(query *m.GetDashboardVersionsCommand) error { - order := "" - - // the query builder in xorm doesn't provide a way to set - // a default order, so we perform this check - if query.OrderBy != "" { - order = " desc" + if query.OrderBy == "" { + query.OrderBy = "version" } - err := x.In("dashboard_id", query.DashboardId). - OrderBy(query.OrderBy+order). + query.OrderBy += " desc" + + err := x.Table("dashboard_version"). + Select(`dashboard_version.id, + dashboard_version.dashboard_id, + dashboard_version.parent_version, + dashboard_version.restored_from, + dashboard_version.version, + dashboard_version.created, + dashboard_version.created_by as created_by_id, + dashboard_version.message, + dashboard_version.data, + "user".login as created_by`). + Join("LEFT", "user", `dashboard_version.created_by = "user".id`). + Where("dashboard_version.dashboard_id=?", query.DashboardId). + OrderBy("dashboard_version."+query.OrderBy). Limit(query.Limit, query.Start). Find(&query.Result) if err != nil { diff --git a/public/app/core/directives/dash_edit_link.js b/public/app/core/directives/dash_edit_link.js index 45b2760ea57..a54a4f54e6d 100644 --- a/public/app/core/directives/dash_edit_link.js +++ b/public/app/core/directives/dash_edit_link.js @@ -8,7 +8,7 @@ function ($, coreModule) { var editViewMap = { 'settings': { src: 'public/app/features/dashboard/partials/settings.html'}, 'annotations': { src: 'public/app/features/annotations/partials/editor.html'}, - 'audit': { src: 'public/app/features/dashboard/audit/partials/audit.html'}, + 'history': { src: 'public/app/features/dashboard/history/partials/history.html'}, 'templating': { src: 'public/app/features/templating/partials/editor.html'}, 'import': { src: '' } }; diff --git a/public/app/core/directives/diff-view.ts b/public/app/core/directives/diff-view.ts index 05415273702..567e01dd472 100644 --- a/public/app/core/directives/diff-view.ts +++ b/public/app/core/directives/diff-view.ts @@ -6,6 +6,7 @@ import coreModule from '../core_module'; export class DeltaCtrl { observer: any; + /** @ngInject */ constructor(private $rootScope) { const waitForCompile = function(mutations) { if (mutations.length === 1) { @@ -70,7 +71,7 @@ export function linkJson() { link: '@lineLink', switchView: '&', }, - templateUrl: 'public/app/features/dashboard/audit/partials/link-json.html', + templateUrl: 'public/app/features/dashboard/history/partials/link-json.html', }; } coreModule.directive('diffLinkJson', linkJson); diff --git a/public/app/features/all.js b/public/app/features/all.js index ef88fbf6ea2..96c28288e8e 100644 --- a/public/app/features/all.js +++ b/public/app/features/all.js @@ -2,7 +2,6 @@ define([ './panellinks/module', './dashlinks/module', './annotations/all', - './annotations/annotations_srv', './templating/all', './dashboard/all', './playlist/all', diff --git a/public/app/features/dashboard/all.js b/public/app/features/dashboard/all.js index 69ed18fe98b..f6c1a6e035f 100644 --- a/public/app/features/dashboard/all.js +++ b/public/app/features/dashboard/all.js @@ -1,7 +1,7 @@ define([ './dashboard_ctrl', './alerting_srv', - './audit/audit_srv', + './history/history', './dashboardLoaderSrv', './dashnav/dashnav', './submenu/submenu', diff --git a/public/app/features/dashboard/dashnav/dashnav.html b/public/app/features/dashboard/dashnav/dashnav.html index 36e523cd189..f0cbb433739 100644 --- a/public/app/features/dashboard/dashnav/dashnav.html +++ b/public/app/features/dashboard/dashnav/dashnav.html @@ -67,7 +67,7 @@
      • Settings
      • Annotations
        • -
      • Changelog
        • +
      • Changelog
      • Templating
      • View JSON
      • Make Editable
        • diff --git a/public/app/features/dashboard/audit/partials/audit.html b/public/app/features/dashboard/history/history.html similarity index 92% rename from public/app/features/dashboard/audit/partials/audit.html rename to public/app/features/dashboard/history/history.html index 3fcac20db66..08b470524f0 100644 --- a/public/app/features/dashboard/audit/partials/audit.html +++ b/public/app/features/dashboard/history/history.html @@ -1,4 +1,4 @@ -
        +

        Changelog @@ -12,10 +12,10 @@
      • - Version {{ctrl.selected[0]}} Current + Version {{ctrl.selected[0]}} Current - Version {{ctrl.selected[0]}} Version {{ctrl.selected[1]}} + Version {{ctrl.selected[0]}} Version {{ctrl.selected[1]}}

      @@ -30,11 +30,11 @@
      - Fetching audit log… + Fetching history list…
      -
      +
      @@ -102,7 +102,7 @@ -
      +
      diff --git a/public/app/features/alerting/alert_list_ctrl.ts b/public/app/features/alerting/alert_list_ctrl.ts index c74f61c8a1c..169d38612c5 100644 --- a/public/app/features/alerting/alert_list_ctrl.ts +++ b/public/app/features/alerting/alert_list_ctrl.ts @@ -2,13 +2,12 @@ import angular from 'angular'; import _ from 'lodash'; -import coreModule from '../../core/core_module'; -import appEvents from '../../core/app_events'; import moment from 'moment'; + +import {coreModule, appEvents} from 'app/core/core'; import alertDef from './alert_def'; export class AlertListCtrl { - alerts: any; stateFilters = [ {text: 'All', value: null}, @@ -17,13 +16,15 @@ export class AlertListCtrl { {text: 'No Data', value: 'no_data'}, {text: 'Paused', value: 'paused'}, ]; - filters = { state: 'ALL' }; + navModel: any; /** @ngInject */ - constructor(private backendSrv, private $location, private $scope) { + constructor(private backendSrv, private $location, private $scope, navModelSrv) { + this.navModel = navModelSrv.getAlertingNav(0); + var params = $location.search(); this.filters.state = params.state || null; this.loadAlerts(); diff --git a/public/app/features/alerting/notification_edit_ctrl.ts b/public/app/features/alerting/notification_edit_ctrl.ts index 6ad11cb9023..768cc16266e 100644 --- a/public/app/features/alerting/notification_edit_ctrl.ts +++ b/public/app/features/alerting/notification_edit_ctrl.ts @@ -7,6 +7,7 @@ import {appEvents, coreModule} from 'app/core/core'; export class AlertNotificationEditCtrl { theForm: any; + navModel: any; testSeverity = "critical"; notifiers: any; notifierTemplateId: string; @@ -23,7 +24,9 @@ export class AlertNotificationEditCtrl { }; /** @ngInject */ - constructor(private $routeParams, private backendSrv, private $location, private $templateCache) { + constructor(private $routeParams, private backendSrv, private $location, private $templateCache, navModelSrv) { + this.navModel = navModelSrv.getAlertingNav(); + this.backendSrv.get(`/api/alert-notifiers`).then(notifiers => { this.notifiers = notifiers; diff --git a/public/app/features/alerting/notifications_list_ctrl.ts b/public/app/features/alerting/notifications_list_ctrl.ts index 705f3a27c4f..c55668c1ed2 100644 --- a/public/app/features/alerting/notifications_list_ctrl.ts +++ b/public/app/features/alerting/notifications_list_ctrl.ts @@ -2,16 +2,19 @@ import angular from 'angular'; import _ from 'lodash'; -import coreModule from '../../core/core_module'; import config from 'app/core/config'; -export class AlertNotificationsListCtrl { +import {coreModule} from 'app/core/core'; + +export class AlertNotificationsListCtrl { notifications: any; + navModel: any; /** @ngInject */ - constructor(private backendSrv, private $scope) { + constructor(private backendSrv, private $scope, navModelSrv) { this.loadNotifications(); + this.navModel = navModelSrv.getAlertingNav(1); } loadNotifications() { diff --git a/public/app/features/alerting/partials/alert_list.html b/public/app/features/alerting/partials/alert_list.html index 5b723386904..cb76e381bec 100644 --- a/public/app/features/alerting/partials/alert_list.html +++ b/public/app/features/alerting/partials/alert_list.html @@ -1,5 +1,4 @@ - - +
      diff --git a/public/app/features/alerting/partials/notification_edit.html b/public/app/features/alerting/partials/notification_edit.html index 6bf45eff660..9b716e02ce6 100644 --- a/public/app/features/alerting/partials/notification_edit.html +++ b/public/app/features/alerting/partials/notification_edit.html @@ -1,9 +1,4 @@ - - - - Notification channels - - +
      diff --git a/public/app/features/alerting/partials/notifications_list.html b/public/app/features/alerting/partials/notifications_list.html index 32ac4a44476..ca69e651d6a 100644 --- a/public/app/features/alerting/partials/notifications_list.html +++ b/public/app/features/alerting/partials/notifications_list.html @@ -1,5 +1,4 @@ - - +
      diff --git a/public/app/features/dashboard/dashnav/dashnav.html b/public/app/features/dashboard/dashnav/dashnav.html index 7deb46931c2..ad1e575abba 100644 --- a/public/app/features/dashboard/dashnav/dashnav.html +++ b/public/app/features/dashboard/dashnav/dashnav.html @@ -1,93 +1,62 @@ - + - - - {{dashboard.title}} - - - - - - - {{dashboard.title}} -   (snapshot) - - - -
        +
        • - +
        • - +
        • - +
        diff --git a/public/app/features/dashboard/dashnav/dashnav.ts b/public/app/features/dashboard/dashnav/dashnav.ts index faaac986ee7..339e911c81d 100644 --- a/public/app/features/dashboard/dashnav/dashnav.ts +++ b/public/app/features/dashboard/dashnav/dashnav.ts @@ -3,92 +3,98 @@ import _ from 'lodash'; import moment from 'moment'; import angular from 'angular'; - +import {appEvents, NavModel} from 'app/core/core'; +import {DashboardModel} from '../model'; import {DashboardExporter} from '../export/exporter'; export class DashNavCtrl { + dashboard: DashboardModel; + navModel: NavModel; + titleTooltip: string; /** @ngInject */ - constructor($scope, $rootScope, dashboardSrv, $location, playlistSrv, backendSrv, $timeout, datasourceSrv) { + constructor( + private $scope, + private $rootScope, + private dashboardSrv, + private $location, + private playlistSrv, + private backendSrv, + private $timeout, + private datasourceSrv, + private navModelSrv) { - $scope.init = function() { - $scope.onAppEvent('save-dashboard', $scope.saveDashboard); - $scope.onAppEvent('delete-dashboard', $scope.deleteDashboard); - $scope.onAppEvent('quick-snapshot', $scope.quickSnapshot); + this.navModel = navModelSrv.getDashboardNav(this.dashboard, this); - $scope.showSettingsMenu = $scope.dashboardMeta.canEdit || $scope.contextSrv.isEditor; + appEvents.on('save-dashboard', this.saveDashboard.bind(this), $scope); + appEvents.on('delete-dashboard', this.deleteDashboard.bind(this), $scope); - if ($scope.dashboardMeta.isSnapshot) { - $scope.showSettingsMenu = false; - var meta = $scope.dashboardMeta; - $scope.titleTooltip = 'Created:  ' + moment(meta.created).calendar(); + if (this.dashboard.meta.isSnapshot) { + var meta = this.dashboard.meta; + this.titleTooltip = 'Created:  ' + moment(meta.created).calendar(); if (meta.expires) { - $scope.titleTooltip += '
        Expires:  ' + moment(meta.expires).fromNow() + '
        '; + this.titleTooltip += '
        Expires:  ' + moment(meta.expires).fromNow() + '
        '; } } - }; + } - $scope.openEditView = function(editview) { - var search = _.extend($location.search(), {editview: editview}); - $location.search(search); - }; + openEditView(editview) { + var search = _.extend(this.$location.search(), {editview: editview}); + this.$location.search(search); + } - $scope.showHelpModal = function() { - $scope.appEvent('show-modal', {templateHtml: ''}); - }; + showHelpModal() { + appEvents.emit('show-modal', {templateHtml: ''}); + } - $scope.starDashboard = function() { - if ($scope.dashboardMeta.isStarred) { - backendSrv.delete('/api/user/stars/dashboard/' + $scope.dashboard.id).then(function() { - $scope.dashboardMeta.isStarred = false; - }); - } else { - backendSrv.post('/api/user/stars/dashboard/' + $scope.dashboard.id).then(function() { - $scope.dashboardMeta.isStarred = true; + starDashboard() { + if (this.dashboard.meta.isStarred) { + return this.backendSrv.delete('/api/user/stars/dashboard/' + this.dashboard.id).then(() => { + this.dashboard.meta.isStarred = false; }); } - }; - $scope.shareDashboard = function(tabIndex) { - var modalScope = $scope.$new(); + this.backendSrv.post('/api/user/stars/dashboard/' + this.dashboard.id).then(() => { + this.dashboard.meta.isStarred = true; + }); + } + + shareDashboard(tabIndex) { + var modalScope = this.$scope.$new(); modalScope.tabIndex = tabIndex; + modalScope.dashboard = this.dashboard; - $scope.appEvent('show-modal', { + appEvents.emit('show-modal', { src: 'public/app/features/dashboard/partials/shareModal.html', scope: modalScope }); - }; + } - $scope.quickSnapshot = function() { - $scope.shareDashboard(1); - }; - - $scope.openSearch = function() { - $scope.appEvent('show-dash-search'); - }; - - $scope.hideTooltip = function(evt) { + hideTooltip(evt) { angular.element(evt.currentTarget).tooltip('hide'); - $scope.appEvent('hide-dash-search'); - }; + } - $scope.makeEditable = function() { - $scope.dashboard.editable = true; + makeEditable() { + this.dashboard.editable = true; - return dashboardSrv.saveDashboard({makeEditable: true, overwrite: false}).then(function() { + return this.dashboardSrv.saveDashboard({makeEditable: true, overwrite: false}).then(() => { // force refresh whole page window.location.href = window.location.href; }); - }; + } - $scope.saveDashboard = function(options) { - return dashboardSrv.saveDashboard(options); - }; + exitFullscreen() { + this.$rootScope.appEvent('panel-change-view', {fullscreen: false, edit: false}); + } - $scope.deleteDashboard = function() { + saveDashboard(options) { + return this.dashboardSrv.saveDashboard(options); + } + + deleteDashboard() { var confirmText = ""; - var text2 = $scope.dashboard.title; - var alerts = $scope.dashboard.rows.reduce((memo, row) => { + var text2 = this.dashboard.title; + var alerts = this.dashboard.rows.reduce((memo, row) => { memo += row.panels.filter(panel => panel.alert).length; return memo; }, 0); @@ -98,60 +104,37 @@ export class DashNavCtrl { text2 = `This dashboad contains ${alerts} alerts. Deleting this dashboad will also delete those alerts`; } - $scope.appEvent('confirm-modal', { + appEvents.emit('confirm-modal', { title: 'Delete', text: 'Do you want to delete this dashboard?', text2: text2, icon: 'fa-trash', confirmText: confirmText, yesText: 'Delete', - onConfirm: function() { - $scope.dashboardMeta.canSave = false; - $scope.deleteDashboardConfirmed(); + onConfirm: () => { + this.dashboard.meta.canSave = false; + this.deleteDashboardConfirmed(); } }); - }; + } - $scope.deleteDashboardConfirmed = function() { - backendSrv.delete('/api/dashboards/db/' + $scope.dashboardMeta.slug).then(function() { - $scope.appEvent('alert-success', ['Dashboard Deleted', $scope.dashboard.title + ' has been deleted']); - $location.url('/'); + deleteDashboardConfirmed() { + this.backendSrv.delete('/api/dashboards/db/' + this.dashboard.meta.slug).then(() => { + appEvents.emit('alert-success', ['Dashboard Deleted', this.dashboard.title + ' has been deleted']); + this.$location.url('/'); }); - }; + } - $scope.saveDashboardAs = function() { - return dashboardSrv.saveDashboardAs(); - }; + saveDashboardAs() { + return this.dashboardSrv.saveDashboardAs(); + } - $scope.viewJson = function() { - var clone = $scope.dashboard.getSaveModelClone(); + viewJson() { + var clone = this.dashboard.getSaveModelClone(); var html = angular.toJson(clone, true); var uri = "data:application/json;charset=utf-8," + encodeURIComponent(html); var newWindow = window.open(uri); - }; - - $scope.snapshot = function() { - $scope.dashboard.snapshot = true; - $rootScope.$broadcast('refresh'); - - $timeout(function() { - $scope.dashboard.snapshot = false; - $scope.appEvent('dashboard-snapshot-cleanup'); - }, 1000); - - }; - - $scope.editJson = function() { - var clone = $scope.dashboard.getSaveModelClone(); - $scope.appEvent('show-json-editor', { object: clone }); - }; - - $scope.stopPlaylist = function() { - playlistSrv.stop(1); - }; - - $scope.init(); - } + } } export function dashNavDirective() { @@ -159,7 +142,10 @@ export function dashNavDirective() { restrict: 'E', templateUrl: 'public/app/features/dashboard/dashnav/dashnav.html', controller: DashNavCtrl, + bindToController: true, + controllerAs: 'ctrl', transclude: true, + scope: { dashboard: "=" } }; } diff --git a/public/app/features/dashboard/viewStateSrv.js b/public/app/features/dashboard/viewStateSrv.js index 70590e3c497..2847e52ebfa 100644 --- a/public/app/features/dashboard/viewStateSrv.js +++ b/public/app/features/dashboard/viewStateSrv.js @@ -20,12 +20,6 @@ function (angular, _, $, config) { self.$scope = $scope; self.dashboard = $scope.dashboard; - $scope.exitFullscreen = function() { - if (self.state.fullscreen) { - self.update({ fullscreen: false }); - } - }; - $scope.onAppEvent('$routeUpdate', function() { var urlState = self.getQueryStringState(); if (self.needsSync(urlState)) { @@ -41,6 +35,9 @@ function (angular, _, $, config) { self.registerPanel(payload.scope); }); + // this marks changes to location during this digest cycle as not to add history item + // dont want url changes like adding orgId to add browser history + $location.replace(); this.update(this.getQueryStringState()); this.expandRowForPanel(); } diff --git a/public/app/features/org/change_password_ctrl.js b/public/app/features/org/change_password_ctrl.js index 6e9826275ad..fea22deb4f5 100644 --- a/public/app/features/org/change_password_ctrl.js +++ b/public/app/features/org/change_password_ctrl.js @@ -7,11 +7,12 @@ function (angular, config) { var module = angular.module('grafana.controllers'); - module.controller('ChangePasswordCtrl', function($scope, backendSrv, $location) { + module.controller('ChangePasswordCtrl', function($scope, backendSrv, $location, navModelSrv) { $scope.command = {}; $scope.authProxyEnabled = config.authProxyEnabled; $scope.ldapEnabled = config.ldapEnabled; + $scope.navModel = navModelSrv.getProfileNav(); $scope.changePassword = function() { if (!$scope.userForm.$valid) { return; } diff --git a/public/app/features/org/newOrgCtrl.js b/public/app/features/org/newOrgCtrl.js index 0e2eaaf7a8e..4c79a5ca6af 100644 --- a/public/app/features/org/newOrgCtrl.js +++ b/public/app/features/org/newOrgCtrl.js @@ -7,8 +7,9 @@ function (angular, config) { var module = angular.module('grafana.controllers'); - module.controller('NewOrgCtrl', function($scope, $http, backendSrv) { + module.controller('NewOrgCtrl', function($scope, $http, backendSrv, navModelSrv) { + $scope.navModel = navModelSrv.getOrgNav(0); $scope.newOrg = {name: ''}; $scope.createOrg = function() { diff --git a/public/app/features/org/orgApiKeysCtrl.js b/public/app/features/org/orgApiKeysCtrl.js index d0b08b57d32..345f21cabfd 100644 --- a/public/app/features/org/orgApiKeysCtrl.js +++ b/public/app/features/org/orgApiKeysCtrl.js @@ -6,8 +6,9 @@ function (angular) { var module = angular.module('grafana.controllers'); - module.controller('OrgApiKeysCtrl', function($scope, $http, backendSrv) { + module.controller('OrgApiKeysCtrl', function($scope, $http, backendSrv, navModelSrv) { + $scope.navModel = navModelSrv.getOrgNav(0); $scope.roleTypes = ['Viewer', 'Editor', 'Admin']; $scope.token = { role: 'Viewer' }; diff --git a/public/app/features/org/orgDetailsCtrl.js b/public/app/features/org/orgDetailsCtrl.js index b900e295b99..08c965fd333 100644 --- a/public/app/features/org/orgDetailsCtrl.js +++ b/public/app/features/org/orgDetailsCtrl.js @@ -6,10 +6,11 @@ function (angular) { var module = angular.module('grafana.controllers'); - module.controller('OrgDetailsCtrl', function($scope, $http, backendSrv, contextSrv) { + module.controller('OrgDetailsCtrl', function($scope, $http, backendSrv, contextSrv, navModelSrv) { $scope.init = function() { $scope.getOrgInfo(); + $scope.navModel = navModelSrv.getOrgNav(0); }; $scope.getOrgInfo = function() { diff --git a/public/app/features/org/org_users_ctrl.ts b/public/app/features/org/org_users_ctrl.ts index 6181edddc9a..fb746307ee9 100644 --- a/public/app/features/org/org_users_ctrl.ts +++ b/public/app/features/org/org_users_ctrl.ts @@ -11,13 +11,15 @@ export class OrgUsersCtrl { pendingInvites: any; editor: any; showInviteUI: boolean; + navModel: any; /** @ngInject */ - constructor(private $scope, private $http, private backendSrv) { + constructor(private $scope, private $http, private backendSrv, navModelSrv) { this.user = { loginOrEmail: '', role: 'Viewer', }; + this.navModel = navModelSrv.getOrgNav(0); this.get(); this.editor = { index: 0 }; diff --git a/public/app/features/org/partials/change_password.html b/public/app/features/org/partials/change_password.html index 647817b4faa..e7ab7c0a128 100644 --- a/public/app/features/org/partials/change_password.html +++ b/public/app/features/org/partials/change_password.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/org/partials/newOrg.html b/public/app/features/org/partials/newOrg.html index 1c0a19ddec0..bd2fce86bf7 100644 --- a/public/app/features/org/partials/newOrg.html +++ b/public/app/features/org/partials/newOrg.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/org/partials/orgApiKeys.html b/public/app/features/org/partials/orgApiKeys.html index daa9801c468..c4ec261cf64 100644 --- a/public/app/features/org/partials/orgApiKeys.html +++ b/public/app/features/org/partials/orgApiKeys.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/org/partials/orgDetails.html b/public/app/features/org/partials/orgDetails.html index 5f264517b0d..d6fb84d1c0d 100644 --- a/public/app/features/org/partials/orgDetails.html +++ b/public/app/features/org/partials/orgDetails.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/org/partials/orgUsers.html b/public/app/features/org/partials/orgUsers.html index 8d348721301..0a10a4324cd 100644 --- a/public/app/features/org/partials/orgUsers.html +++ b/public/app/features/org/partials/orgUsers.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/org/partials/profile.html b/public/app/features/org/partials/profile.html index 7f52fbbd9d1..d83d8a6b6a5 100644 --- a/public/app/features/org/partials/profile.html +++ b/public/app/features/org/partials/profile.html @@ -1,9 +1,8 @@ - - +
        -

        Profile

        +

        User Profile

        diff --git a/public/app/features/org/profile_ctrl.ts b/public/app/features/org/profile_ctrl.ts index 4687218826c..02f20553e3f 100644 --- a/public/app/features/org/profile_ctrl.ts +++ b/public/app/features/org/profile_ctrl.ts @@ -11,11 +11,13 @@ export class ProfileCtrl { userForm: any; showOrgsList = false; readonlyLoginFields = config.disableLoginForm; + navModel: any; /** @ngInject **/ - constructor(private backendSrv, private contextSrv, private $location) { + constructor(private backendSrv, private contextSrv, private $location, navModelSrv) { this.getUser(); this.getUserOrgs(); + this.navModel = navModelSrv.getProfileNav(); } getUser() { diff --git a/public/app/features/playlist/partials/playlist.html b/public/app/features/playlist/partials/playlist.html index 6dfb8b2f8e0..bb9d1ffc110 100644 --- a/public/app/features/playlist/partials/playlist.html +++ b/public/app/features/playlist/partials/playlist.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/playlist/partials/playlists.html b/public/app/features/playlist/partials/playlists.html index 9c5f84a5c56..582174e44ff 100644 --- a/public/app/features/playlist/partials/playlists.html +++ b/public/app/features/playlist/partials/playlists.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/playlist/playlist_edit_ctrl.ts b/public/app/features/playlist/playlist_edit_ctrl.ts index 50cd810af93..9919e0b3b21 100644 --- a/public/app/features/playlist/playlist_edit_ctrl.ts +++ b/public/app/features/playlist/playlist_edit_ctrl.ts @@ -16,21 +16,30 @@ export class PlaylistEditCtrl { playlistItems: any = []; dashboardresult: any = []; tagresult: any = []; + navModel: any; /** @ngInject */ - constructor(private $scope, private playlistSrv, private backendSrv, private $location, private $route) { + constructor( + private $scope, + private playlistSrv, + private backendSrv, + private $location, + private $route, + private navModelSrv + ) { + + this.navModel = navModelSrv.getPlaylistsNav(0); + if ($route.current.params.id) { var playlistId = $route.current.params.id; - backendSrv.get('/api/playlists/' + playlistId) - .then((result) => { - this.playlist = result; - }); + backendSrv.get('/api/playlists/' + playlistId).then(result => { + this.playlist = result; + }); - backendSrv.get('/api/playlists/' + playlistId + '/items') - .then((result) => { - this.playlistItems = result; - }); + backendSrv.get('/api/playlists/' + playlistId + '/items').then(result => { + this.playlistItems = result; + }); } } @@ -85,7 +94,7 @@ export class PlaylistEditCtrl { ? this.backendSrv.put('/api/playlists/' + playlist.id, playlist) : this.backendSrv.post('/api/playlists', playlist); - savePromise + savePromise .then(() => { this.$scope.appEvent('alert-success', ['Playlist saved', '']); this.$location.path('/playlists'); diff --git a/public/app/features/playlist/playlist_srv.ts b/public/app/features/playlist/playlist_srv.ts index e231a645f92..5ddfe572cda 100644 --- a/public/app/features/playlist/playlist_srv.ts +++ b/public/app/features/playlist/playlist_srv.ts @@ -11,6 +11,7 @@ class PlaylistSrv { private interval: any; private playlistId: number; private startUrl: string; + public isPlaying: boolean; /** @ngInject */ constructor(private $rootScope: any, private $location: any, private $timeout: any, private backendSrv: any) { } @@ -42,7 +43,7 @@ class PlaylistSrv { this.startUrl = window.location.href; this.index = 0; this.playlistId = playlistId; - this.$rootScope.playlistSrv = this; + this.isPlaying = true; this.backendSrv.get(`/api/playlists/${playlistId}`).then(playlist => { this.backendSrv.get(`/api/playlists/${playlistId}/dashboards`).then(dashboards => { @@ -55,13 +56,12 @@ class PlaylistSrv { stop() { this.index = 0; + this.isPlaying = false; this.playlistId = 0; if (this.cancelPromise) { this.$timeout.cancel(this.cancelPromise); } - - this.$rootScope.playlistSrv = null; } } diff --git a/public/app/features/playlist/playlists_ctrl.ts b/public/app/features/playlist/playlists_ctrl.ts index 59758f0db1f..0f7b863e6a6 100644 --- a/public/app/features/playlist/playlists_ctrl.ts +++ b/public/app/features/playlist/playlists_ctrl.ts @@ -6,20 +6,22 @@ import coreModule from '../../core/core_module'; export class PlaylistsCtrl { playlists: any; + navModel: any; /** @ngInject */ - constructor(private $scope, private $location, private backendSrv) { - backendSrv.get('/api/playlists') - .then((result) => { - this.playlists = result; - }); + constructor(private $scope, private $location, private backendSrv, private navModelSrv) { + this.navModel = navModelSrv.getPlaylistsNav(0); + + backendSrv.get('/api/playlists').then(result => { + this.playlists = result; + }); } removePlaylistConfirmed(playlist) { _.remove(this.playlists, { id: playlist.id }); this.backendSrv.delete('/api/playlists/' + playlist.id) - .then(() => { + .then(() => { this.$scope.appEvent('alert-success', ['Playlist deleted', '']); }, () => { this.$scope.appEvent('alert-error', ['Unable to delete playlist', '']); diff --git a/public/app/features/playlist/specs/playlist_edit_ctrl_specs.ts b/public/app/features/playlist/specs/playlist_edit_ctrl_specs.ts index 900992f4314..e27eb53e644 100644 --- a/public/app/features/playlist/specs/playlist_edit_ctrl_specs.ts +++ b/public/app/features/playlist/specs/playlist_edit_ctrl_specs.ts @@ -5,7 +5,11 @@ import {PlaylistEditCtrl} from '../playlist_edit_ctrl'; describe('PlaylistEditCtrl', () => { var ctx: any; beforeEach(() => { - ctx = new PlaylistEditCtrl(null, null, null, null, { current: { params: {} } }); + let navModelSrv = { + getPlaylistsNav: page => {}, + }; + + ctx = new PlaylistEditCtrl(null, null, null, null, { current: { params: {} } }, navModelSrv); ctx.dashboardresult = [ { id: 2, title: 'dashboard: 2' }, diff --git a/public/app/features/plugins/ds_edit_ctrl.ts b/public/app/features/plugins/ds_edit_ctrl.ts index 57028fe4adc..b577ad3131b 100644 --- a/public/app/features/plugins/ds_edit_ctrl.ts +++ b/public/app/features/plugins/ds_edit_ctrl.ts @@ -30,6 +30,7 @@ export class DataSourceEditCtrl { hasDashboards: boolean; editForm: any; gettingStarted: boolean; + navModel: any; /** @ngInject */ constructor( @@ -38,141 +39,144 @@ export class DataSourceEditCtrl { private backendSrv, private $routeParams, private $location, - private datasourceSrv) { + private datasourceSrv, + private navModelSrv, + ) { - this.isNew = true; - this.datasources = []; - this.tabIndex = 0; + this.navModel = navModelSrv.getDatasourceNav(0); + this.isNew = true; + this.datasources = []; + this.tabIndex = 0; - this.loadDatasourceTypes().then(() => { - if (this.$routeParams.id) { - this.getDatasourceById(this.$routeParams.id); - } else { - this.initNewDatasourceModel(); - } - }); - } - - initNewDatasourceModel() { - this.current = angular.copy(defaults); - - // We are coming from getting started - if (this.$location.search().gettingstarted) { - this.gettingStarted = true; - this.current.isDefault = true; + this.loadDatasourceTypes().then(() => { + if (this.$routeParams.id) { + this.getDatasourceById(this.$routeParams.id); + } else { + this.initNewDatasourceModel(); } + }); + } - this.typeChanged(); + initNewDatasourceModel() { + this.current = angular.copy(defaults); + + // We are coming from getting started + if (this.$location.search().gettingstarted) { + this.gettingStarted = true; + this.current.isDefault = true; } - loadDatasourceTypes() { - if (datasourceTypes.length > 0) { - this.types = datasourceTypes; - return this.$q.when(null); + this.typeChanged(); + } + + loadDatasourceTypes() { + if (datasourceTypes.length > 0) { + this.types = datasourceTypes; + return this.$q.when(null); + } + + return this.backendSrv.get('/api/plugins', {enabled: 1, type: 'datasource'}).then(plugins => { + datasourceTypes = plugins; + this.types = plugins; + }); + } + + getDatasourceById(id) { + this.backendSrv.get('/api/datasources/' + id).then(ds => { + this.isNew = false; + this.current = ds; + if (datasourceCreated) { + datasourceCreated = false; + this.testDatasource(); } + return this.typeChanged(); + }); + } - return this.backendSrv.get('/api/plugins', {enabled: 1, type: 'datasource'}).then(plugins => { - datasourceTypes = plugins; - this.types = plugins; - }); - } + typeChanged() { + this.hasDashboards = false; + return this.backendSrv.get('/api/plugins/' + this.current.type + '/settings').then(pluginInfo => { + this.datasourceMeta = pluginInfo; + console.log(this.datasourceMeta) ; + this.hasDashboards = _.find(pluginInfo.includes, {type: 'dashboard'}); + }); + } - getDatasourceById(id) { - this.backendSrv.get('/api/datasources/' + id).then(ds => { - this.isNew = false; - this.current = ds; - if (datasourceCreated) { - datasourceCreated = false; - this.testDatasource(); - } - return this.typeChanged(); - }); - } + updateFrontendSettings() { + return this.backendSrv.get('/api/frontend/settings').then(settings => { + config.datasources = settings.datasources; + config.defaultDatasource = settings.defaultDatasource; + this.datasourceSrv.init(); + }); + } - typeChanged() { - this.hasDashboards = false; - return this.backendSrv.get('/api/plugins/' + this.current.type + '/settings').then(pluginInfo => { - this.datasourceMeta = pluginInfo; - console.log(this.datasourceMeta) ; - this.hasDashboards = _.find(pluginInfo.includes, {type: 'dashboard'}); - }); - } + testDatasource() { + this.testing = { done: false }; - updateFrontendSettings() { - return this.backendSrv.get('/api/frontend/settings').then(settings => { - config.datasources = settings.datasources; - config.defaultDatasource = settings.defaultDatasource; - this.datasourceSrv.init(); - }); - } - - testDatasource() { - this.testing = { done: false }; - - this.datasourceSrv.get(this.current.name).then(datasource => { - if (!datasource.testDatasource) { - delete this.testing; - return; - } - - return datasource.testDatasource().then(result => { - this.testing.message = result.message; - this.testing.status = result.status; - this.testing.title = result.title; - }).catch(err => { - if (err.statusText) { - this.testing.message = err.statusText; - this.testing.title = "HTTP Error"; - } else { - this.testing.message = err.message; - this.testing.title = "Unknown error"; - } - }); - }).finally(() => { - if (this.testing) { - this.testing.done = true; - } - }); - } - - saveChanges() { - if (!this.editForm.$valid) { + this.datasourceSrv.get(this.current.name).then(datasource => { + if (!datasource.testDatasource) { + delete this.testing; return; } - if (this.current.id) { - return this.backendSrv.put('/api/datasources/' + this.current.id, this.current).then(() => { - this.updateFrontendSettings().then(() => { - this.testDatasource(); - }); - }); - } else { - return this.backendSrv.post('/api/datasources', this.current).then(result => { - this.updateFrontendSettings(); - - datasourceCreated = true; - this.$location.path('datasources/edit/' + result.id); - }); - } - } - - confirmDelete() { - this.backendSrv.delete('/api/datasources/' + this.current.id).then(() => { - this.$location.path('datasources'); - }); - } - - delete(s) { - appEvents.emit('confirm-modal', { - title: 'Delete', - text: 'Are you sure you want to delete this datasource?', - yesText: "Delete", - icon: "fa-trash", - onConfirm: () => { - this.confirmDelete(); + return datasource.testDatasource().then(result => { + this.testing.message = result.message; + this.testing.status = result.status; + this.testing.title = result.title; + }).catch(err => { + if (err.statusText) { + this.testing.message = err.statusText; + this.testing.title = "HTTP Error"; + } else { + this.testing.message = err.message; + this.testing.title = "Unknown error"; } }); + }).finally(() => { + if (this.testing) { + this.testing.done = true; + } + }); + } + + saveChanges() { + if (!this.editForm.$valid) { + return; } + + if (this.current.id) { + return this.backendSrv.put('/api/datasources/' + this.current.id, this.current).then(() => { + this.updateFrontendSettings().then(() => { + this.testDatasource(); + }); + }); + } else { + return this.backendSrv.post('/api/datasources', this.current).then(result => { + this.updateFrontendSettings(); + + datasourceCreated = true; + this.$location.path('datasources/edit/' + result.id); + }); + } + } + + confirmDelete() { + this.backendSrv.delete('/api/datasources/' + this.current.id).then(() => { + this.$location.path('datasources'); + }); + } + + delete(s) { + appEvents.emit('confirm-modal', { + title: 'Delete', + text: 'Are you sure you want to delete this datasource?', + yesText: "Delete", + icon: "fa-trash", + onConfirm: () => { + this.confirmDelete(); + } + }); + } } coreModule.controller('DataSourceEditCtrl', DataSourceEditCtrl); diff --git a/public/app/features/plugins/ds_list_ctrl.ts b/public/app/features/plugins/ds_list_ctrl.ts index d7b08dcd312..b26883bd4b5 100644 --- a/public/app/features/plugins/ds_list_ctrl.ts +++ b/public/app/features/plugins/ds_list_ctrl.ts @@ -6,31 +6,41 @@ import coreModule from '../../core/core_module'; export class DataSourcesCtrl { datasources: any; + navModel: any; /** @ngInject */ - constructor(private $scope, private $location, private $http, private backendSrv, private datasourceSrv) { - backendSrv.get('/api/datasources') - .then((result) => { - this.datasources = result; - }); + constructor( + private $scope, + private $location, + private $http, + private backendSrv, + private datasourceSrv, + private navModelSrv + ) { + + this.navModel = this.navModelSrv.getDatasourceNav(0); + + backendSrv.get('/api/datasources').then(result => { + this.datasources = result; + }); } removeDataSourceConfirmed(ds) { this.backendSrv.delete('/api/datasources/' + ds.id) - .then(() => { - this.$scope.appEvent('alert-success', ['Datasource deleted', '']); - }, () => { - this.$scope.appEvent('alert-error', ['Unable to delete datasource', '']); - }).then(() => { + .then(() => { + this.$scope.appEvent('alert-success', ['Datasource deleted', '']); + }, () => { + this.$scope.appEvent('alert-error', ['Unable to delete datasource', '']); + }).then(() => { this.backendSrv.get('/api/datasources') - .then((result) => { - this.datasources = result; - }); + .then((result) => { + this.datasources = result; + }); this.backendSrv.get('/api/frontend/settings') - .then((settings) => { - this.datasourceSrv.init(settings.datasources); - }); + .then((settings) => { + this.datasourceSrv.init(settings.datasources); + }); }); } diff --git a/public/app/features/plugins/partials/ds_edit.html b/public/app/features/plugins/partials/ds_edit.html index 5cd1470e1b1..73691b16b2e 100644 --- a/public/app/features/plugins/partials/ds_edit.html +++ b/public/app/features/plugins/partials/ds_edit.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/plugins/partials/ds_list.html b/public/app/features/plugins/partials/ds_list.html index c4625abfe6b..f6748b37d61 100644 --- a/public/app/features/plugins/partials/ds_list.html +++ b/public/app/features/plugins/partials/ds_list.html @@ -1,8 +1,4 @@ - - +
        diff --git a/public/app/features/plugins/partials/plugin_edit.html b/public/app/features/plugins/partials/plugin_edit.html index e6659191961..e2569681a70 100644 --- a/public/app/features/plugins/partials/plugin_edit.html +++ b/public/app/features/plugins/partials/plugin_edit.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/plugins/partials/plugin_list.html b/public/app/features/plugins/partials/plugin_list.html index 88911a0ec2f..91b2162175b 100644 --- a/public/app/features/plugins/partials/plugin_list.html +++ b/public/app/features/plugins/partials/plugin_list.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/plugins/partials/plugin_page.html b/public/app/features/plugins/partials/plugin_page.html index b08089ebb1d..9c4c72121f0 100644 --- a/public/app/features/plugins/partials/plugin_page.html +++ b/public/app/features/plugins/partials/plugin_page.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/plugins/plugin_edit_ctrl.ts b/public/app/features/plugins/plugin_edit_ctrl.ts index 8d7f360aeeb..4910ee95490 100644 --- a/public/app/features/plugins/plugin_edit_ctrl.ts +++ b/public/app/features/plugins/plugin_edit_ctrl.ts @@ -13,17 +13,22 @@ export class PluginEditCtrl { includedDatasources: any; tabIndex: number; tabs: any; + navModel: any; hasDashboards: any; preUpdateHook: () => any; postUpdateHook: () => any; /** @ngInject */ - constructor(private $scope, - private $rootScope, - private backendSrv, - private $routeParams, - private $sce, - private $http) { + constructor( + private $scope, + private $rootScope, + private backendSrv, + private $routeParams, + private $sce, + private $http, + private navModelSrv, + ) { + this.navModel = navModelSrv.getPluginsNav(); this.model = {}; this.pluginId = $routeParams.pluginId; this.tabIndex = 0; @@ -31,7 +36,7 @@ export class PluginEditCtrl { this.preUpdateHook = () => Promise.resolve(); this.postUpdateHook = () => Promise.resolve(); - } + } init() { return this.backendSrv.get(`/api/plugins/${this.pluginId}/settings`).then(result => { diff --git a/public/app/features/plugins/plugin_list_ctrl.ts b/public/app/features/plugins/plugin_list_ctrl.ts index 9e9b679c6c1..2a1209c14b0 100644 --- a/public/app/features/plugins/plugin_list_ctrl.ts +++ b/public/app/features/plugins/plugin_list_ctrl.ts @@ -5,10 +5,12 @@ import angular from 'angular'; export class PluginListCtrl { plugins: any[]; tabIndex: number; + navModel: any; /** @ngInject */ - constructor(private backendSrv: any, $location) { + constructor(private backendSrv: any, $location, navModelSrv) { this.tabIndex = 0; + this.navModel = navModelSrv.getPluginsNav(); var pluginType = $location.search().type || 'panel'; switch (pluginType) { diff --git a/public/app/features/plugins/plugin_page_ctrl.ts b/public/app/features/plugins/plugin_page_ctrl.ts index 9dfcb73c7a1..f3d2e3b5f53 100644 --- a/public/app/features/plugins/plugin_page_ctrl.ts +++ b/public/app/features/plugins/plugin_page_ctrl.ts @@ -2,6 +2,7 @@ import angular from 'angular'; import _ from 'lodash'; +import {NavModel} from 'app/core/core'; var pluginInfoCache = {}; @@ -9,7 +10,7 @@ export class AppPageCtrl { page: any; pluginId: any; appModel: any; - appLogoUrl: any; + navModel: NavModel; /** @ngInject */ constructor(private backendSrv, private $routeParams: any, private $rootScope) { @@ -25,13 +26,53 @@ export class AppPageCtrl { initPage(app) { this.appModel = app; this.page = _.find(app.includes, {slug: this.$routeParams.slug}); - this.appLogoUrl = app.info.logos.small; pluginInfoCache[this.pluginId] = app; if (!this.page) { this.$rootScope.appEvent('alert-error', ['App Page Not Found', '']); + + this.navModel = { + section: { + title: "Page not found", + url: app.defaultNavUrl, + icon: 'icon-gf icon-gf-sadface', + }, + menu: [], + }; + + return; } + + let menu = []; + + for (let item of app.includes) { + if (item.addToNav) { + if (item.type === 'dashboard') { + menu.push({ + title: item.name, + url: 'dashboard/db/' + item.slug, + icon: 'fa fa-fw fa-dot-circle-o', + }); + } + if (item.type === 'page') { + menu.push({ + title: item.name, + url: `plugins/${app.id}/page/${item.slug}`, + icon: 'fa fa-fw fa-dot-circle-o', + }); + } + } + } + + this.navModel = { + section: { + title: app.name, + url: app.defaultNavUrl, + iconUrl: app.info.logos.small, + }, + menu: menu, + }; } loadPluginInfo() { diff --git a/public/app/features/snapshot/partials/snapshots.html b/public/app/features/snapshot/partials/snapshots.html index 99aac73bce6..526d319ac10 100644 --- a/public/app/features/snapshot/partials/snapshots.html +++ b/public/app/features/snapshot/partials/snapshots.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/snapshot/snapshot_ctrl.ts b/public/app/features/snapshot/snapshot_ctrl.ts index 7085c058046..2817238203b 100644 --- a/public/app/features/snapshot/snapshot_ctrl.ts +++ b/public/app/features/snapshot/snapshot_ctrl.ts @@ -4,11 +4,20 @@ import angular from 'angular'; import _ from 'lodash'; export class SnapshotsCtrl { - + navModel: any; snapshots: any; /** @ngInject */ constructor(private $rootScope, private backendSrv) { + this.navModel = { + section: { + title: 'Snapshots', + icon: 'icon-gf icon-gf-snapshot', + url: 'dashboard/snapshots', + }, + menu: [], + }; + this.backendSrv.get('/api/dashboard/snapshots').then(result => { this.snapshots = result; }); diff --git a/public/app/features/styleguide/styleguide.html b/public/app/features/styleguide/styleguide.html index 573d720831e..b6f1d626a13 100644 --- a/public/app/features/styleguide/styleguide.html +++ b/public/app/features/styleguide/styleguide.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/app/features/styleguide/styleguide.ts b/public/app/features/styleguide/styleguide.ts index de9da6aafd7..36afdd1d7c2 100644 --- a/public/app/features/styleguide/styleguide.ts +++ b/public/app/features/styleguide/styleguide.ts @@ -12,9 +12,11 @@ class StyleGuideCtrl { icons: any = []; page: any; pages = ['colors', 'buttons', 'icons', 'plugins']; + navModel: any; /** @ngInject **/ - constructor(private $http, private $routeParams, private $location, private backendSrv) { + constructor(private $http, private $routeParams, private $location, private backendSrv, navModelSrv) { + this.navModel = navModelSrv.getAdminNav(); this.theme = config.bootData.user.lightTheme ? 'light': 'dark'; this.page = {}; diff --git a/public/app/partials/dashboard.html b/public/app/partials/dashboard.html index 7c8ac3e6aed..95f0fb87ec8 100644 --- a/public/app/partials/dashboard.html +++ b/public/app/partials/dashboard.html @@ -1,9 +1,8 @@
        - +
        -
        diff --git a/public/app/partials/error.html b/public/app/partials/error.html index 0401d6d98db..16a5815295d 100644 --- a/public/app/partials/error.html +++ b/public/app/partials/error.html @@ -1,5 +1,4 @@ - - +
        diff --git a/public/sass/_old_responsive.scss b/public/sass/_old_responsive.scss index 4a69a1bbb9e..be56bbae485 100644 --- a/public/sass/_old_responsive.scss +++ b/public/sass/_old_responsive.scss @@ -40,14 +40,14 @@ @include media-breakpoint-down(xs) { .page-dashboard .navbar-page-btn { - max-width: 150px; + max-width: 250px; } } // form styles @include media-breakpoint-up(md) { .page-dashboard .navbar-page-btn { - max-width: 180px; + max-width: 280px; } .gf-timepicker-nav-btn { max-width: 120px; diff --git a/public/sass/components/_dropdown.scss b/public/sass/components/_dropdown.scss index 7b0cbc5fd36..6031c05db3f 100644 --- a/public/sass/components/_dropdown.scss +++ b/public/sass/components/_dropdown.scss @@ -15,13 +15,13 @@ } .dropdown-desc { - position: relative; - top: -3px; - width: 250px; - font-size: 80%; - margin-left: 22px; - color: $gray-2; - white-space: normal; + position: relative; + top: -3px; + width: 250px; + font-size: 80%; + margin-left: 22px; + color: $gray-2; + white-space: normal; } // Dropdown arrow/caret @@ -75,7 +75,7 @@ // Links within the dropdown menu > li { - > a { + > a { display: block; padding: 3px 20px 3px 15px; clear: both; diff --git a/public/sass/components/_navbar.scss b/public/sass/components/_navbar.scss index 7ac46505f1b..44678afe6e1 100644 --- a/public/sass/components/_navbar.scss +++ b/public/sass/components/_navbar.scss @@ -42,7 +42,6 @@ // Hover/focus .navbar .nav > li > a:focus, .navbar .nav > li > a:hover { - background-color: $navbarLinkBackgroundHover; // "transparent" is default to differentiate :hover/:focus from .active color: $navbarLinkColorHover; text-decoration: none; } @@ -64,10 +63,12 @@ border-right: 1px solid $tight-form-border; background-color: $navbarButtonBackground; padding: 0.4rem 1.0rem 0.4rem 1rem; + min-height:: $navbarHeight; .fa-caret-down { font-size: 70%; } + .fa-chevron-left{ display: none; } @@ -95,7 +96,7 @@ .icon-gf-grafana_wordmark { font-size: 21px; position: relative; - top: 4px; + top: 5px; padding-left: 5px; display: none; } @@ -108,16 +109,16 @@ float: left; display: block; margin: 0; - font-size: 1.4em; + font-size: 1.4rem; border-right: 1px solid $tight-form-border; color: darken($link-color, 5%); background-color: $navbarButtonBackground; font-size: $font-size-lg; - padding: 1rem 1rem 0.7rem 1rem; + padding: 1rem 1rem 0.75rem 1rem; + min-height:: $navbarHeight; - &:hover { + &:hover, &.active { background: $navbarButtonBackgroundHighlight; - color: $link-color; } .fa-caret-down { @@ -138,9 +139,36 @@ } } +.navbar-page-btn-wrapper { + display: inline-block; + position: relative; +} + +.dropdown-menu.dropdown-menu--navbar { + top: 100%; + min-width: 100%; + margin-top: 0px; + + li a { + padding: $spacer/2 $spacer; + border-left: 2px solid $side-menu-bg; + background: $side-menu-bg; + + i { + display: inline-block; + padding-right: 21px; + } + + &:hover { + @include left-brand-border-gradient(); + color: $link-hover-color; + background: $input-label-bg; + } + } +} + .sidemenu-pinned { .navbar-brand-btn { - background-color: $page-bg; width: $side-menu-width; .icon-gf-grafana_wordmark { @@ -160,3 +188,7 @@ } } +.navbar-section-wrapper { + position: relative; + float: left; +} diff --git a/public/sass/components/_search.scss b/public/sass/components/_search.scss index dc4ba998f63..c5d7d65224f 100644 --- a/public/sass/components/_search.scss +++ b/public/sass/components/_search.scss @@ -1,14 +1,20 @@ +.search-backdrop { + position: fixed; + right: 0; + bottom: 0; + left: 0; + top: $navbarHeight; + z-index: $zindex-modal-backdrop; + background-color: $black; + @include opacity(70); +} + .search-container { - left: 72px; - top: 39px; - margin: 16px 0 0 2px; - z-index: 1000; + left: 78px; + top: 0; + right: 0; + z-index: ($zindex-modal-backdrop + 10); position: absolute; - width: 700px; - box-shadow: $search-shadow; - padding: 10px; - background-color: $panel-bg; - border: $panel-border; .label-tag { margin-left: 6px; @@ -19,19 +25,48 @@ // Search .search-field-wrapper { - padding-bottom: 10px; + width: 100%; + display: flex; + background-color: $navbarButtonBackground; + input { - width: 100%; - padding: 8px 8px; - height: 100%; + max-width: 653px; + //padding: 0.5rem 1.5rem 0.5rem 0; + padding: 1rem 1rem 0.75rem 1rem; + height: 51px; + line-height: 51px; box-sizing: border-box; + outline: none; + background: $side-menu-bg; + background-color: $navbarButtonBackground; + flex-grow: 10; } - button { - margin: 0 4px 0 0; - } - > span { - display: block; - overflow: hidden; +} + +.search-field-spacer { + flex-grow: 1; +} +.search-switches { + flex-grow: 1; + padding: 1rem 1rem 0.75rem 1rem; + white-space: nowrap; +} + +.search-field-icon { + font-size: $font-size-lg; + padding: 1rem 1rem 0.75rem 1rem; +} + +.search-dropdown { + display: flex; + max-width: 1100px; + visibility: none; + opacity: 0; + + &--fade-in { + visibility: visible; + opacity: 1; + transition: opacity 0.3s; } } @@ -40,10 +75,9 @@ overflow: auto; display: block; line-height: 28px; - - .search-item:hover, .search-item.selected { - background-color: $grafanaListHighlight; - } + padding: $spacer; + background: $panel-bg; + flex-grow: 10; .selected { .search-result-tag { @@ -71,8 +105,10 @@ word-wrap: break-word; display: block; padding: 3px 10px; - background-color: $grafanaListBackground; + white-space: nowrap; + background-color: $tight-form-bg; margin-bottom: 4px; + @include left-brand-border(); .search-result-icon::before { content: "\f009"; @@ -81,6 +117,15 @@ &.search-item-dash-home .search-result-icon::before { content: "\f015"; } + + &:hover { + background-color: $tight-form-func-bg; + @include left-brand-border-gradient(); + } + + &.selected { + background-color: $grafanaListBackground; + } } .search-result-tags { @@ -93,17 +138,15 @@ } } -.search-switches { - position: absolute; - top: 19px; - right: 21px; -} .search-button-row { - padding-top: 20px; + padding: $spacer*2; + display: flex; + flex-direction: column; + align-items: flex-start; button, a { - margin-right: 10px; + margin-bottom: $spacer; } .search-button-row-explore-link { diff --git a/public/sass/components/_sidemenu.scss b/public/sass/components/_sidemenu.scss index 6f16913a084..616fbb784a5 100644 --- a/public/sass/components/_sidemenu.scss +++ b/public/sass/components/_sidemenu.scss @@ -9,7 +9,8 @@ width: $side-menu-width; background-color: rgba($side-menu-bg,$side-menu-opacity); z-index: 101; - transform: translate3d(0, -100%, 0); + //transform: translate3d(0, -100%, 0); + opacity: 0; visibility: hidden; a:focus { @@ -20,8 +21,9 @@ .sidemenu-open { .sidemenu-wrapper { visibility: visible; - transform: translate3d(0, 0, 0); - transition: all 0.2s; + //transform: translate3d(0, 0, 0); + opacity: 1; + transition: opacity 0.3s; } } diff --git a/public/sass/components/_view_states.scss b/public/sass/components/_view_states.scss index a1ed89f9888..900c9d1489b 100644 --- a/public/sass/components/_view_states.scss +++ b/public/sass/components/_view_states.scss @@ -51,7 +51,7 @@ .navbar-page-btn { border-color: transparent; background: transparent; - transform: translate3d(-50px, 0, 0); + transform: translate3d(-95px, 0, 0); transition: all 1.5s ease-in-out 1s; .icon-gf { opacity: 0; From 3bea304bab7e6d2cd97ec8c040036da4c3f6662e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Fri, 2 Jun 2017 14:19:39 +0200 Subject: [PATCH 072/130] ux: made new search more responsive --- public/app/core/components/search/search.html | 2 +- public/sass/components/_search.scss | 11 ++++++++++- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/public/app/core/components/search/search.html b/public/app/core/components/search/search.html index e64ffc845ca..8cf537ac137 100644 --- a/public/app/core/components/search/search.html +++ b/public/app/core/components/search/search.html @@ -4,7 +4,7 @@
        -
        +
        diff --git a/public/sass/components/_search.scss b/public/sass/components/_search.scss index c5d7d65224f..2190e55f318 100644 --- a/public/sass/components/_search.scss +++ b/public/sass/components/_search.scss @@ -10,7 +10,7 @@ } .search-container { - left: 78px; + left: 0; top: 0; right: 0; z-index: ($zindex-modal-backdrop + 10); @@ -59,6 +59,7 @@ .search-dropdown { display: flex; + flex-direction: column; max-width: 1100px; visibility: none; opacity: 0; @@ -163,3 +164,11 @@ } } +@include media-breakpoint-up(md) { + .search-dropdown { + flex-direction: row; + } + .search-container { + left: 78px; + } +} From d47c47853a0f8327cf9a065f8adc371acaa5f396 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Fri, 2 Jun 2017 15:29:25 +0200 Subject: [PATCH 073/130] ux: added css annimations for dash edit views --- public/app/core/directives/dash_edit_link.js | 17 +++++++++++++---- public/app/partials/dashboard.html | 2 +- public/sass/components/_sidemenu.scss | 3 +-- public/sass/pages/_dashboard.scss | 8 ++++++++ 4 files changed, 23 insertions(+), 7 deletions(-) diff --git a/public/app/core/directives/dash_edit_link.js b/public/app/core/directives/dash_edit_link.js index 7486d0ada18..fcf5d87487d 100644 --- a/public/app/core/directives/dash_edit_link.js +++ b/public/app/core/directives/dash_edit_link.js @@ -1,8 +1,9 @@ define([ 'jquery', + 'angular', '../core_module', ], -function ($, coreModule) { +function ($, angular, coreModule) { 'use strict'; var editViewMap = { @@ -47,6 +48,7 @@ function ($, coreModule) { elem.empty(); lastEditor = null; editorScope = null; + elem.removeClass('dash-edit-view--open'); if (editview) { var urlParams = $location.search(); @@ -74,11 +76,18 @@ function ($, coreModule) { var view = payload.src; if (view.indexOf('.html') > 0) { - view = $('
        '); + view = angular.element(document.createElement('div')); + view.append($('
        ')); } - elem.append(view); - $compile(elem.contents())(editorScope); + $compile(view)(editorScope); + + setTimeout(function() { + elem.append(view); + setTimeout(function() { + elem.addClass('dash-edit-view--open'); + }, 10); + }, 10); } scope.$watch("dashboardViewState.state.editview", function(newValue, oldValue) { diff --git a/public/app/partials/dashboard.html b/public/app/partials/dashboard.html index 95f0fb87ec8..b25ba94ff84 100644 --- a/public/app/partials/dashboard.html +++ b/public/app/partials/dashboard.html @@ -2,7 +2,7 @@
        -
        +
        diff --git a/public/sass/components/_sidemenu.scss b/public/sass/components/_sidemenu.scss index 616fbb784a5..500f3b06ede 100644 --- a/public/sass/components/_sidemenu.scss +++ b/public/sass/components/_sidemenu.scss @@ -8,8 +8,7 @@ left: 0; width: $side-menu-width; background-color: rgba($side-menu-bg,$side-menu-opacity); - z-index: 101; - //transform: translate3d(0, -100%, 0); + z-index: 1000; opacity: 0; visibility: hidden; diff --git a/public/sass/pages/_dashboard.scss b/public/sass/pages/_dashboard.scss index e75406c2c8a..242f76b41bc 100644 --- a/public/sass/pages/_dashboard.scss +++ b/public/sass/pages/_dashboard.scss @@ -256,3 +256,11 @@ div.flot-text { } } +.dash-edit-view { + opacity: 0; + + &--open{ + opacity: 1; + transition: opacity 200ms ease-in-out; + } +} From 966c2912fc1e262eca962659e21c520a1d85f85f Mon Sep 17 00:00:00 2001 From: Dhia MOAKHAR Date: Fri, 2 Jun 2017 23:56:48 +0000 Subject: [PATCH 074/130] [elasticsearch] Add option for result set size in raw_dcument it allows to specify the result set size in raw_document. Example: table panel could show more (or less) than 500 line if needed. Added test to spec --- .../plugins/datasource/elasticsearch/metric_agg.js | 2 ++ .../datasource/elasticsearch/partials/metric_agg.html | 5 +++++ .../plugins/datasource/elasticsearch/query_builder.js | 8 +++++--- .../elasticsearch/specs/query_builder_specs.ts | 11 ++++++++++- 4 files changed, 22 insertions(+), 4 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/metric_agg.js b/public/app/plugins/datasource/elasticsearch/metric_agg.js index c0c4ffc08d4..90c303a5722 100644 --- a/public/app/plugins/datasource/elasticsearch/metric_agg.js +++ b/public/app/plugins/datasource/elasticsearch/metric_agg.js @@ -103,6 +103,8 @@ function (angular, _, queryDef) { break; } case 'raw_document': { + $scope.agg.settings.size = $scope.agg.settings.size || 500; + $scope.settingsLinkText = 'Size: ' + $scope.agg.settings.size ; $scope.target.metrics = [$scope.agg]; $scope.target.bucketAggs = []; break; diff --git a/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html b/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html index 8c25c2d5347..cc2ec8e4918 100644 --- a/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html +++ b/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html @@ -72,6 +72,11 @@
        +
        + + +
        +
        diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index 62a7b379c8e..ee7e9265f08 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -109,8 +109,8 @@ function (queryDef) { return filterObj; }; - ElasticQueryBuilder.prototype.documentQuery = function(query) { - query.size = 500; + ElasticQueryBuilder.prototype.documentQuery = function(query, size) { + query.size = size === undefined ? 500 : parseInt(size , 10); query.sort = {}; query.sort[this.timeField] = {order: 'desc', unmapped_type: 'boolean'}; @@ -196,7 +196,9 @@ function (queryDef) { if (metric && metric.type !== 'raw_document') { throw {message: 'Invalid query'}; } - return this.documentQuery(query, target); + var size = metric && metric.hasOwnProperty("settings") && metric.settings.hasOwnProperty("size") + && metric.settings["size"] !== null ? metric.settings["size"] : 500 ; + return this.documentQuery(query,size); } nestedAggs = query; diff --git a/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts b/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts index 18645ad498d..201459e65d9 100644 --- a/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts +++ b/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts @@ -156,13 +156,22 @@ describe('ElasticQueryBuilder', function() { it('with raw_document metric', function() { var query = builder.build({ - metrics: [{type: 'raw_document', id: '1'}], + metrics: [{type: 'raw_document', id: '1',settings: {}}], timeField: '@timestamp', bucketAggs: [], }); expect(query.size).to.be(500); }); + it('with raw_document metric size set', function() { + var query = builder.build({ + metrics: [{type: 'raw_document', id: '1',settings: {size: '1337'}}], + timeField: '@timestamp', + bucketAggs: [], + }); + + expect(query.size).to.be(1337); + }); it('with moving average', function() { var query = builder.build({ From d55cc4e2a3c26d823611d06c25c20b0a6eead68c Mon Sep 17 00:00:00 2001 From: Dhia MOAKHAR Date: Sat, 3 Jun 2017 02:50:10 +0000 Subject: [PATCH 075/130] [elasticsearch] Fix add metric that was not working properly when selecting Raw Documet metric type, the $scope.target.metrics was replaced by [$scope.agg], however the pointer to this variables is shared with metricAggs. Instead we free the array and add $scope.agg --- public/app/plugins/datasource/elasticsearch/metric_agg.js | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/metric_agg.js b/public/app/plugins/datasource/elasticsearch/metric_agg.js index 90c303a5722..88053b0efac 100644 --- a/public/app/plugins/datasource/elasticsearch/metric_agg.js +++ b/public/app/plugins/datasource/elasticsearch/metric_agg.js @@ -67,7 +67,6 @@ function (angular, _, queryDef) { } else if (!$scope.agg.field) { $scope.agg.field = 'select field'; } - switch($scope.agg.type) { case 'cardinality': { var precision_threshold = $scope.agg.settings.precision_threshold || ''; @@ -105,12 +104,12 @@ function (angular, _, queryDef) { case 'raw_document': { $scope.agg.settings.size = $scope.agg.settings.size || 500; $scope.settingsLinkText = 'Size: ' + $scope.agg.settings.size ; - $scope.target.metrics = [$scope.agg]; + $scope.target.metrics.splice(0,$scope.target.metrics.length, $scope.agg); + $scope.target.bucketAggs = []; break; } } - if ($scope.aggDef.supportsInlineScript) { // I know this stores the inline script twice // but having it like this simplifes the query_builder From 045f5e11fccee952312b77c792e4cdeb13797955 Mon Sep 17 00:00:00 2001 From: Dhia MOAKHAR Date: Sat, 3 Jun 2017 02:55:26 +0000 Subject: [PATCH 076/130] [elasticsearch] Fix bug when switching from "Raw Document" metric type when switch to "raw Document" metric type we do free all "Group by" however when we switch back to another type we do not reset the default aggregation (date histogram) Thus all modification will through exception as no "Group by" is defined and panel should be recreated the fix will reintialize the "Group by" by setting default value --- .../plugins/datasource/elasticsearch/query_builder.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index ee7e9265f08..d753a2666c6 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -194,11 +194,12 @@ function (queryDef) { if (target.bucketAggs.length === 0) { metric = target.metrics[0]; if (metric && metric.type !== 'raw_document') { - throw {message: 'Invalid query'}; - } - var size = metric && metric.hasOwnProperty("settings") && metric.settings.hasOwnProperty("size") + target.bucketAggs = [{type: 'date_histogram', id: '2', settings: {interval: 'auto'}}]; + } else { + var size = metric && metric.hasOwnProperty("settings") && metric.settings.hasOwnProperty("size") && metric.settings["size"] !== null ? metric.settings["size"] : 500 ; - return this.documentQuery(query,size); + return this.documentQuery(query,size); + } } nestedAggs = query; From d2eca2faa16211d186a75473b52dd308e1e4a986 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Sun, 4 Jun 2017 14:18:25 +0200 Subject: [PATCH 077/130] ux: new navbar fixes, restored delete option in dashboard dropdown, fixes #8521 --- public/app/core/nav_model_srv.ts | 33 ++++++++++++++++++++------------ 1 file changed, 21 insertions(+), 12 deletions(-) diff --git a/public/app/core/nav_model_srv.ts b/public/app/core/nav_model_srv.ts index 0f3e8ce233d..ba442924018 100644 --- a/public/app/core/nav_model_srv.ts +++ b/public/app/core/nav_model_srv.ts @@ -43,8 +43,8 @@ export class NavModelSrv { icon: 'icon-gf icon-gf-datasources' }, menu: [ - {title: 'List view', active: subPage === 0, url: '/datasources', icon: 'fa fa-list-ul'}, - {title: 'Add data source', active: subPage === 1, url: '/datasources/new', icon: 'fa fa-plus'}, + {title: 'List view', active: subPage === 0, url: 'datasources', icon: 'fa fa-list-ul'}, + {title: 'Add data source', active: subPage === 1, url: 'datasources/new', icon: 'fa fa-plus'}, ] }; } @@ -57,8 +57,8 @@ export class NavModelSrv { icon: 'fa fa-fw fa-film' }, menu: [ - {title: 'List view', active: subPage === 0, url: '/playlists', icon: 'fa fa-list-ul'}, - {title: 'Add Playlist', active: subPage === 1, url: '/playlists/create', icon: 'fa fa-plus'}, + {title: 'List view', active: subPage === 0, url: 'playlists', icon: 'fa fa-list-ul'}, + {title: 'Add Playlist', active: subPage === 1, url: 'playlists/create', icon: 'fa fa-plus'}, ] }; } @@ -93,9 +93,9 @@ export class NavModelSrv { icon: 'icon-gf icon-gf-users' }, menu: [ - {title: 'Preferences', active: subPage === 0, url: '/org', icon: 'fa fa-fw fa-cog'}, - {title: 'Org Users', active: subPage === 1, url: '/org/users', icon: 'fa fa-fw fa-users'}, - {title: 'API Keys', active: subPage === 2, url: '/org/apikeys', icon: 'fa fa-fw fa-key'}, + {title: 'Preferences', active: subPage === 0, url: 'org', icon: 'fa fa-fw fa-cog'}, + {title: 'Org Users', active: subPage === 1, url: 'org/users', icon: 'fa fa-fw fa-users'}, + {title: 'API Keys', active: subPage === 2, url: 'org/apikeys', icon: 'fa fa-fw fa-key'}, ] }; } @@ -108,11 +108,11 @@ export class NavModelSrv { icon: 'fa fa-fw fa-cogs' }, menu: [ - {title: 'Users', active: subPage === 0, url: '/admin/users', icon: 'fa fa-fw fa-user'}, - {title: 'Orgs', active: subPage === 1, url: '/admin/orgs', icon: 'fa fa-fw fa-users'}, - {title: 'Server Settings', active: subPage === 2, url: '/admin/settings', icon: 'fa fa-fw fa-cogs'}, - {title: 'Server Stats', active: subPage === 2, url: '/admin/stats', icon: 'fa fa-fw fa-line-chart'}, - {title: 'Style Guide', active: subPage === 2, url: '/styleguide', icon: 'fa fa-fw fa-key'}, + {title: 'Users', active: subPage === 0, url: 'admin/users', icon: 'fa fa-fw fa-user'}, + {title: 'Orgs', active: subPage === 1, url: 'admin/orgs', icon: 'fa fa-fw fa-users'}, + {title: 'Server Settings', active: subPage === 2, url: 'admin/settings', icon: 'fa fa-fw fa-cogs'}, + {title: 'Server Stats', active: subPage === 2, url: 'admin/stats', icon: 'fa fa-fw fa-line-chart'}, + {title: 'Style Guide', active: subPage === 2, url: 'styleguide', icon: 'fa fa-fw fa-key'}, ] }; } @@ -196,6 +196,15 @@ export class NavModelSrv { }); } + if (dashboard.meta.canSave) { + menu.push({ + title: 'Delete', + icon: 'fa fa-fw fa-trash', + clickHandler: () => dashNavCtrl.deleteDashboard() + }); + + } + return { section: { title: dashboard.title, From d996275f8f35c7aff5671dfe11ecf5ebc474bb7d Mon Sep 17 00:00:00 2001 From: aykim17 Date: Sun, 4 Jun 2017 08:23:52 -0400 Subject: [PATCH 078/130] Updated the graphTooltip description (#8532) I added in a description since there was just TODO there originally. --- docs/sources/reference/dashboard.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sources/reference/dashboard.md b/docs/sources/reference/dashboard.md index 595a10e5081..3bbecfcef4d 100644 --- a/docs/sources/reference/dashboard.md +++ b/docs/sources/reference/dashboard.md @@ -65,7 +65,7 @@ Each field in the dashboard JSON is explained below with its usage: | **timezone** | timezone of dashboard, i.e. `utc` or `browser` | | **editable** | whether a dashboard is editable or not | | **hideControls** | whether row controls on the left in green are hidden or not | -| **graphTooltip** | TODO | +| **graphTooltip** | 0 for no shared crosshair or tooltip (default), 1 for shared crosshair, 2 for shared crosshair AND shared tooltip | | **rows** | row metadata, see [rows section](#rows) for details | | **time** | time range for dashboard, i.e. last 6 hours, last 7 days, etc | | **timepicker** | timepicker metadata, see [timepicker section](#timepicker) for details | From 4fe993532150c711905da12736d32ca5013dfa79 Mon Sep 17 00:00:00 2001 From: Tom Gardiner Date: Sun, 4 Jun 2017 05:24:04 -0700 Subject: [PATCH 079/130] Add support for AWS/VPN metrics (#8528) --- pkg/api/cloudwatch/metrics.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/api/cloudwatch/metrics.go b/pkg/api/cloudwatch/metrics.go index f32cf8ca23a..3ad63ceec75 100644 --- a/pkg/api/cloudwatch/metrics.go +++ b/pkg/api/cloudwatch/metrics.go @@ -90,6 +90,7 @@ func init() { "CacheHitPercent", "CachePercentUsed", "CachePercentDirty", "ReadBytes", "ReadTime", "WriteBytes", "WriteTime", "QueuedWrites"}, "AWS/SWF": {"DecisionTaskScheduleToStartTime", "DecisionTaskStartToCloseTime", "DecisionTasksCompleted", "StartedDecisionTasksTimedOutOnClose", "WorkflowStartToCloseTime", "WorkflowsCanceled", "WorkflowsCompleted", "WorkflowsContinuedAsNew", "WorkflowsFailed", "WorkflowsTerminated", "WorkflowsTimedOut", "ActivityTaskScheduleToCloseTime", "ActivityTaskScheduleToStartTime", "ActivityTaskStartToCloseTime", "ActivityTasksCanceled", "ActivityTasksCompleted", "ActivityTasksFailed", "ScheduledActivityTasksTimedOutOnClose", "ScheduledActivityTasksTimedOutOnStart", "StartedActivityTasksTimedOutOnClose", "StartedActivityTasksTimedOutOnHeartbeat"}, + "AWS/VPN": {"TunnelState", "TunnelDataIn", "TunnelDataOut"}, "AWS/WAF": {"AllowedRequests", "BlockedRequests", "CountedRequests"}, "AWS/WorkSpaces": {"Available", "Unhealthy", "ConnectionAttempt", "ConnectionSuccess", "ConnectionFailure", "SessionLaunchTime", "InSessionLatency", "SessionDisconnect"}, "KMS": {"SecondsUntilKeyMaterialExpiration"}, @@ -131,6 +132,7 @@ func init() { "AWS/SQS": {"QueueName"}, "AWS/StorageGateway": {"GatewayId", "GatewayName", "VolumeId"}, "AWS/SWF": {"Domain", "WorkflowTypeName", "WorkflowTypeVersion", "ActivityTypeName", "ActivityTypeVersion"}, + "AWS/VPN": {"VpnId", "TunnelIpAddress"}, "AWS/WAF": {"Rule", "WebACL"}, "AWS/WorkSpaces": {"DirectoryId", "WorkspaceId"}, "KMS": {"KeyId"}, From f224fd8310076092a6926cdc2afa7d3c46317f61 Mon Sep 17 00:00:00 2001 From: Dan Cech Date: Sun, 4 Jun 2017 08:28:03 -0400 Subject: [PATCH 080/130] reduce length of dashboard columns used in compound indexes (#8507) --- pkg/services/sqlstore/migrations/dashboard_mig.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/services/sqlstore/migrations/dashboard_mig.go b/pkg/services/sqlstore/migrations/dashboard_mig.go index 0519194ae31..ee0cc1d893f 100644 --- a/pkg/services/sqlstore/migrations/dashboard_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_mig.go @@ -8,7 +8,7 @@ func addDashboardMigration(mg *Migrator) { Columns: []*Column{ {Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true}, {Name: "version", Type: DB_Int, Nullable: false}, - {Name: "slug", Type: DB_NVarchar, Length: 190, Nullable: false}, + {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, {Name: "data", Type: DB_Text, Nullable: false}, {Name: "account_id", Type: DB_BigInt, Nullable: false}, @@ -114,7 +114,7 @@ func addDashboardMigration(mg *Migrator) { // add column to store plugin_id mg.AddMigration("Add column plugin_id in dashboard", NewAddColumnMigration(dashboardV2, &Column{ - Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 255, + Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 189, })) mg.AddMigration("Add index for plugin_id in dashboard", NewAddIndexMigration(dashboardV2, &Index{ @@ -129,7 +129,7 @@ func addDashboardMigration(mg *Migrator) { mg.AddMigration("Update dashboard table charset", NewTableCharsetMigration("dashboard", []*Column{ {Name: "slug", Type: DB_NVarchar, Length: 189, Nullable: false}, {Name: "title", Type: DB_NVarchar, Length: 255, Nullable: false}, - {Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 255}, + {Name: "plugin_id", Type: DB_NVarchar, Nullable: true, Length: 189}, {Name: "data", Type: DB_MediumText, Nullable: false}, })) From 7c1dc2444d6a7b70dd02d12a38b241e572580213 Mon Sep 17 00:00:00 2001 From: Dhia MOAKHAR Date: Sun, 4 Jun 2017 13:20:58 +0000 Subject: [PATCH 081/130] change size in raw_document from text to number update query builder and specs --- .../plugins/datasource/elasticsearch/partials/metric_agg.html | 2 +- public/app/plugins/datasource/elasticsearch/query_builder.js | 2 +- .../datasource/elasticsearch/specs/query_builder_specs.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html b/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html index cc2ec8e4918..b4a1a61ed32 100644 --- a/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html +++ b/public/app/plugins/datasource/elasticsearch/partials/metric_agg.html @@ -74,7 +74,7 @@
        - +
        diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index d753a2666c6..1493fd3eb95 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -110,7 +110,7 @@ function (queryDef) { }; ElasticQueryBuilder.prototype.documentQuery = function(query, size) { - query.size = size === undefined ? 500 : parseInt(size , 10); + query.size = size === undefined ? 500 : size; query.sort = {}; query.sort[this.timeField] = {order: 'desc', unmapped_type: 'boolean'}; diff --git a/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts b/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts index 201459e65d9..4ea108359a1 100644 --- a/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts +++ b/public/app/plugins/datasource/elasticsearch/specs/query_builder_specs.ts @@ -165,7 +165,7 @@ describe('ElasticQueryBuilder', function() { }); it('with raw_document metric size set', function() { var query = builder.build({ - metrics: [{type: 'raw_document', id: '1',settings: {size: '1337'}}], + metrics: [{type: 'raw_document', id: '1',settings: {size: 1337}}], timeField: '@timestamp', bucketAggs: [], }); From 1efdd92ae86724ea85df98514763d5c578232005 Mon Sep 17 00:00:00 2001 From: Eirik Nygaard Date: Mon, 5 Jun 2017 10:09:27 +0200 Subject: [PATCH 082/130] Update oauth2 lib (#8524) * Update to latest oauth2 library using govendor * Follow API changes --- pkg/api/login_oauth.go | 2 +- vendor/golang.org/x/oauth2/.travis.yml | 14 - vendor/golang.org/x/oauth2/README.md | 12 +- .../golang.org/x/oauth2/client_appengine.go | 7 +- vendor/golang.org/x/oauth2/example_test.go | 45 -- .../golang.org/x/oauth2/facebook/facebook.go | 16 - vendor/golang.org/x/oauth2/github/github.go | 16 - .../golang.org/x/oauth2/google/appengine.go | 83 ---- .../x/oauth2/google/appengine_hook.go | 13 - vendor/golang.org/x/oauth2/google/default.go | 154 ------ .../x/oauth2/google/example_test.go | 150 ------ vendor/golang.org/x/oauth2/google/google.go | 145 ------ .../golang.org/x/oauth2/google/google_test.go | 67 --- vendor/golang.org/x/oauth2/google/sdk.go | 168 ------- vendor/golang.org/x/oauth2/google/sdk_test.go | 46 -- .../oauth2/google/testdata/gcloud/credentials | 122 ----- .../oauth2/google/testdata/gcloud/properties | 2 - vendor/golang.org/x/oauth2/internal/oauth2.go | 11 +- .../x/oauth2/internal/oauth2_test.go | 62 --- vendor/golang.org/x/oauth2/internal/token.go | 249 ++++++++++ .../golang.org/x/oauth2/internal/transport.go | 69 +++ vendor/golang.org/x/oauth2/jws/jws.go | 160 ------- .../golang.org/x/oauth2/jwt/example_test.go | 31 -- vendor/golang.org/x/oauth2/jwt/jwt.go | 147 ------ vendor/golang.org/x/oauth2/jwt/jwt_test.go | 134 ------ .../golang.org/x/oauth2/linkedin/linkedin.go | 16 - vendor/golang.org/x/oauth2/oauth2.go | 267 ++--------- vendor/golang.org/x/oauth2/oauth2_test.go | 439 ------------------ .../x/oauth2/odnoklassniki/odnoklassniki.go | 16 - vendor/golang.org/x/oauth2/paypal/paypal.go | 22 - vendor/golang.org/x/oauth2/token.go | 66 ++- vendor/golang.org/x/oauth2/token_test.go | 50 -- vendor/golang.org/x/oauth2/transport.go | 8 +- vendor/golang.org/x/oauth2/transport_test.go | 53 --- vendor/golang.org/x/oauth2/vk/vk.go | 16 - vendor/vendor.json | 12 + 36 files changed, 458 insertions(+), 2432 deletions(-) delete mode 100644 vendor/golang.org/x/oauth2/.travis.yml delete mode 100644 vendor/golang.org/x/oauth2/example_test.go delete mode 100644 vendor/golang.org/x/oauth2/facebook/facebook.go delete mode 100644 vendor/golang.org/x/oauth2/github/github.go delete mode 100644 vendor/golang.org/x/oauth2/google/appengine.go delete mode 100644 vendor/golang.org/x/oauth2/google/appengine_hook.go delete mode 100644 vendor/golang.org/x/oauth2/google/default.go delete mode 100644 vendor/golang.org/x/oauth2/google/example_test.go delete mode 100644 vendor/golang.org/x/oauth2/google/google.go delete mode 100644 vendor/golang.org/x/oauth2/google/google_test.go delete mode 100644 vendor/golang.org/x/oauth2/google/sdk.go delete mode 100644 vendor/golang.org/x/oauth2/google/sdk_test.go delete mode 100644 vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials delete mode 100644 vendor/golang.org/x/oauth2/google/testdata/gcloud/properties delete mode 100644 vendor/golang.org/x/oauth2/internal/oauth2_test.go create mode 100644 vendor/golang.org/x/oauth2/internal/token.go create mode 100644 vendor/golang.org/x/oauth2/internal/transport.go delete mode 100644 vendor/golang.org/x/oauth2/jws/jws.go delete mode 100644 vendor/golang.org/x/oauth2/jwt/example_test.go delete mode 100644 vendor/golang.org/x/oauth2/jwt/jwt.go delete mode 100644 vendor/golang.org/x/oauth2/jwt/jwt_test.go delete mode 100644 vendor/golang.org/x/oauth2/linkedin/linkedin.go delete mode 100644 vendor/golang.org/x/oauth2/oauth2_test.go delete mode 100644 vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go delete mode 100644 vendor/golang.org/x/oauth2/paypal/paypal.go delete mode 100644 vendor/golang.org/x/oauth2/token_test.go delete mode 100644 vendor/golang.org/x/oauth2/transport_test.go delete mode 100644 vendor/golang.org/x/oauth2/vk/vk.go diff --git a/pkg/api/login_oauth.go b/pkg/api/login_oauth.go index 939e9b163e6..0d9ab83282c 100644 --- a/pkg/api/login_oauth.go +++ b/pkg/api/login_oauth.go @@ -64,7 +64,7 @@ func OAuthLogin(ctx *middleware.Context) { if setting.OAuthService.OAuthInfos[name].HostedDomain == "" { ctx.Redirect(connect.AuthCodeURL(state, oauth2.AccessTypeOnline)) } else { - ctx.Redirect(connect.AuthCodeURL(state, oauth2.SetParam("hd", setting.OAuthService.OAuthInfos[name].HostedDomain), oauth2.AccessTypeOnline)) + ctx.Redirect(connect.AuthCodeURL(state, oauth2.SetAuthURLParam("hd", setting.OAuthService.OAuthInfos[name].HostedDomain), oauth2.AccessTypeOnline)) } return } diff --git a/vendor/golang.org/x/oauth2/.travis.yml b/vendor/golang.org/x/oauth2/.travis.yml deleted file mode 100644 index a035125c358..00000000000 --- a/vendor/golang.org/x/oauth2/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -language: go - -go: - - 1.3 - - 1.4 - -install: - - export GOPATH="$HOME/gopath" - - mkdir -p "$GOPATH/src/golang.org/x" - - mv "$TRAVIS_BUILD_DIR" "$GOPATH/src/golang.org/x/oauth2" - - go get -v -t -d golang.org/x/oauth2/... - -script: - - go test -v golang.org/x/oauth2/... diff --git a/vendor/golang.org/x/oauth2/README.md b/vendor/golang.org/x/oauth2/README.md index a5afeca2216..b0ddf3c10c0 100644 --- a/vendor/golang.org/x/oauth2/README.md +++ b/vendor/golang.org/x/oauth2/README.md @@ -1,6 +1,7 @@ # OAuth2 for Go [![Build Status](https://travis-ci.org/golang/oauth2.svg?branch=master)](https://travis-ci.org/golang/oauth2) +[![GoDoc](https://godoc.org/golang.org/x/oauth2?status.svg)](https://godoc.org/golang.org/x/oauth2) oauth2 package contains a client implementation for OAuth 2.0 spec. @@ -43,7 +44,7 @@ with the `oauth2` package. "golang.org/x/oauth2" "golang.org/x/oauth2/google" newappengine "google.golang.org/appengine" - newurlftech "google.golang.org/urlfetch" + newurlfetch "google.golang.org/appengine/urlfetch" "appengine" ) @@ -62,3 +63,12 @@ with the `oauth2` package. client.Get("...") } +## Contributing + +We appreciate your help! + +To contribute, please read the contribution guidelines: + https://golang.org/doc/contribute.html + +Note that the Go project does not use GitHub pull requests but +uses Gerrit for code reviews. See the contribution guide for details. diff --git a/vendor/golang.org/x/oauth2/client_appengine.go b/vendor/golang.org/x/oauth2/client_appengine.go index 10aaf917d62..8962c49d1de 100644 --- a/vendor/golang.org/x/oauth2/client_appengine.go +++ b/vendor/golang.org/x/oauth2/client_appengine.go @@ -1,8 +1,8 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. +// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. -// +build appengine appenginevm +// +build appengine // App Engine hooks. @@ -12,11 +12,12 @@ import ( "net/http" "golang.org/x/net/context" + "golang.org/x/oauth2/internal" "google.golang.org/appengine/urlfetch" ) func init() { - registerContextClientFunc(contextClientAppEngine) + internal.RegisterContextClientFunc(contextClientAppEngine) } func contextClientAppEngine(ctx context.Context) (*http.Client, error) { diff --git a/vendor/golang.org/x/oauth2/example_test.go b/vendor/golang.org/x/oauth2/example_test.go deleted file mode 100644 index 8be27885567..00000000000 --- a/vendor/golang.org/x/oauth2/example_test.go +++ /dev/null @@ -1,45 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package oauth2_test - -import ( - "fmt" - "log" - - "golang.org/x/oauth2" -) - -func ExampleConfig() { - conf := &oauth2.Config{ - ClientID: "YOUR_CLIENT_ID", - ClientSecret: "YOUR_CLIENT_SECRET", - Scopes: []string{"SCOPE1", "SCOPE2"}, - Endpoint: oauth2.Endpoint{ - AuthURL: "https://provider.com/o/oauth2/auth", - TokenURL: "https://provider.com/o/oauth2/token", - }, - } - - // Redirect user to consent page to ask for permission - // for the scopes specified above. - url := conf.AuthCodeURL("state", oauth2.AccessTypeOffline) - fmt.Printf("Visit the URL for the auth dialog: %v", url) - - // Use the authorization code that is pushed to the redirect URL. - // NewTransportWithCode will do the handshake to retrieve - // an access token and initiate a Transport that is - // authorized and authenticated by the retrieved token. - var code string - if _, err := fmt.Scan(&code); err != nil { - log.Fatal(err) - } - tok, err := conf.Exchange(oauth2.NoContext, code) - if err != nil { - log.Fatal(err) - } - - client := conf.Client(oauth2.NoContext, tok) - client.Get("...") -} diff --git a/vendor/golang.org/x/oauth2/facebook/facebook.go b/vendor/golang.org/x/oauth2/facebook/facebook.go deleted file mode 100644 index 962e86b0eb8..00000000000 --- a/vendor/golang.org/x/oauth2/facebook/facebook.go +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package facebook provides constants for using OAuth2 to access Facebook. -package facebook // import "golang.org/x/oauth2/facebook" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is Facebook's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://www.facebook.com/dialog/oauth", - TokenURL: "https://graph.facebook.com/oauth/access_token", -} diff --git a/vendor/golang.org/x/oauth2/github/github.go b/vendor/golang.org/x/oauth2/github/github.go deleted file mode 100644 index 1648cb58daa..00000000000 --- a/vendor/golang.org/x/oauth2/github/github.go +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package github provides constants for using OAuth2 to access Github. -package github // import "golang.org/x/oauth2/github" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is Github's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://github.com/login/oauth/authorize", - TokenURL: "https://github.com/login/oauth/access_token", -} diff --git a/vendor/golang.org/x/oauth2/google/appengine.go b/vendor/golang.org/x/oauth2/google/appengine.go deleted file mode 100644 index 65dc347314d..00000000000 --- a/vendor/golang.org/x/oauth2/google/appengine.go +++ /dev/null @@ -1,83 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package google - -import ( - "sort" - "strings" - "sync" - "time" - - "golang.org/x/net/context" - "golang.org/x/oauth2" -) - -// Set at init time by appengine_hook.go. If nil, we're not on App Engine. -var appengineTokenFunc func(c context.Context, scopes ...string) (token string, expiry time.Time, err error) - -// AppEngineTokenSource returns a token source that fetches tokens -// issued to the current App Engine application's service account. -// If you are implementing a 3-legged OAuth 2.0 flow on App Engine -// that involves user accounts, see oauth2.Config instead. -// -// The provided context must have come from appengine.NewContext. -func AppEngineTokenSource(ctx context.Context, scope ...string) oauth2.TokenSource { - if appengineTokenFunc == nil { - panic("google: AppEngineTokenSource can only be used on App Engine.") - } - scopes := append([]string{}, scope...) - sort.Strings(scopes) - return &appEngineTokenSource{ - ctx: ctx, - scopes: scopes, - key: strings.Join(scopes, " "), - } -} - -// aeTokens helps the fetched tokens to be reused until their expiration. -var ( - aeTokensMu sync.Mutex - aeTokens = make(map[string]*tokenLock) // key is space-separated scopes -) - -type tokenLock struct { - mu sync.Mutex // guards t; held while fetching or updating t - t *oauth2.Token -} - -type appEngineTokenSource struct { - ctx context.Context - scopes []string - key string // to aeTokens map; space-separated scopes -} - -func (ts *appEngineTokenSource) Token() (*oauth2.Token, error) { - if appengineTokenFunc == nil { - panic("google: AppEngineTokenSource can only be used on App Engine.") - } - - aeTokensMu.Lock() - tok, ok := aeTokens[ts.key] - if !ok { - tok = &tokenLock{} - aeTokens[ts.key] = tok - } - aeTokensMu.Unlock() - - tok.mu.Lock() - defer tok.mu.Unlock() - if tok.t.Valid() { - return tok.t, nil - } - access, exp, err := appengineTokenFunc(ts.ctx, ts.scopes...) - if err != nil { - return nil, err - } - tok.t = &oauth2.Token{ - AccessToken: access, - Expiry: exp, - } - return tok.t, nil -} diff --git a/vendor/golang.org/x/oauth2/google/appengine_hook.go b/vendor/golang.org/x/oauth2/google/appengine_hook.go deleted file mode 100644 index 2f9b15432fa..00000000000 --- a/vendor/golang.org/x/oauth2/google/appengine_hook.go +++ /dev/null @@ -1,13 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// +build appengine appenginevm - -package google - -import "google.golang.org/appengine" - -func init() { - appengineTokenFunc = appengine.AccessToken -} diff --git a/vendor/golang.org/x/oauth2/google/default.go b/vendor/golang.org/x/oauth2/google/default.go deleted file mode 100644 index 817bfb720f6..00000000000 --- a/vendor/golang.org/x/oauth2/google/default.go +++ /dev/null @@ -1,154 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package google - -import ( - "encoding/json" - "errors" - "fmt" - "io/ioutil" - "net/http" - "os" - "path/filepath" - "runtime" - - "golang.org/x/net/context" - "golang.org/x/oauth2" - "golang.org/x/oauth2/jwt" - "google.golang.org/cloud/compute/metadata" -) - -// DefaultClient returns an HTTP Client that uses the -// DefaultTokenSource to obtain authentication credentials. -// -// This client should be used when developing services -// that run on Google App Engine or Google Compute Engine -// and use "Application Default Credentials." -// -// For more details, see: -// https://developers.google.com/accounts/application-default-credentials -// -func DefaultClient(ctx context.Context, scope ...string) (*http.Client, error) { - ts, err := DefaultTokenSource(ctx, scope...) - if err != nil { - return nil, err - } - return oauth2.NewClient(ctx, ts), nil -} - -// DefaultTokenSource is a token source that uses -// "Application Default Credentials". -// -// It looks for credentials in the following places, -// preferring the first location found: -// -// 1. A JSON file whose path is specified by the -// GOOGLE_APPLICATION_CREDENTIALS environment variable. -// 2. A JSON file in a location known to the gcloud command-line tool. -// On Windows, this is %APPDATA%/gcloud/application_default_credentials.json. -// On other systems, $HOME/.config/gcloud/application_default_credentials.json. -// 3. On Google App Engine it uses the appengine.AccessToken function. -// 4. On Google Compute Engine, it fetches credentials from the metadata server. -// (In this final case any provided scopes are ignored.) -// -// For more details, see: -// https://developers.google.com/accounts/application-default-credentials -// -func DefaultTokenSource(ctx context.Context, scope ...string) (oauth2.TokenSource, error) { - // First, try the environment variable. - const envVar = "GOOGLE_APPLICATION_CREDENTIALS" - if filename := os.Getenv(envVar); filename != "" { - ts, err := tokenSourceFromFile(ctx, filename, scope) - if err != nil { - return nil, fmt.Errorf("google: error getting credentials using %v environment variable: %v", envVar, err) - } - return ts, nil - } - - // Second, try a well-known file. - filename := wellKnownFile() - _, err := os.Stat(filename) - if err == nil { - ts, err2 := tokenSourceFromFile(ctx, filename, scope) - if err2 == nil { - return ts, nil - } - err = err2 - } else if os.IsNotExist(err) { - err = nil // ignore this error - } - if err != nil { - return nil, fmt.Errorf("google: error getting credentials using well-known file (%v): %v", filename, err) - } - - // Third, if we're on Google App Engine use those credentials. - if appengineTokenFunc != nil { - return AppEngineTokenSource(ctx, scope...), nil - } - - // Fourth, if we're on Google Compute Engine use the metadata server. - if metadata.OnGCE() { - return ComputeTokenSource(""), nil - } - - // None are found; return helpful error. - const url = "https://developers.google.com/accounts/application-default-credentials" - return nil, fmt.Errorf("google: could not find default credentials. See %v for more information.", url) -} - -func wellKnownFile() string { - const f = "application_default_credentials.json" - if runtime.GOOS == "windows" { - return filepath.Join(os.Getenv("APPDATA"), "gcloud", f) - } - return filepath.Join(guessUnixHomeDir(), ".config", "gcloud", f) -} - -func tokenSourceFromFile(ctx context.Context, filename string, scopes []string) (oauth2.TokenSource, error) { - b, err := ioutil.ReadFile(filename) - if err != nil { - return nil, err - } - var d struct { - // Common fields - Type string - ClientID string `json:"client_id"` - - // User Credential fields - ClientSecret string `json:"client_secret"` - RefreshToken string `json:"refresh_token"` - - // Service Account fields - ClientEmail string `json:"client_email"` - PrivateKeyID string `json:"private_key_id"` - PrivateKey string `json:"private_key"` - } - if err := json.Unmarshal(b, &d); err != nil { - return nil, err - } - switch d.Type { - case "authorized_user": - cfg := &oauth2.Config{ - ClientID: d.ClientID, - ClientSecret: d.ClientSecret, - Scopes: append([]string{}, scopes...), // copy - Endpoint: Endpoint, - } - tok := &oauth2.Token{RefreshToken: d.RefreshToken} - return cfg.TokenSource(ctx, tok), nil - case "service_account": - cfg := &jwt.Config{ - Email: d.ClientEmail, - PrivateKey: []byte(d.PrivateKey), - Scopes: append([]string{}, scopes...), // copy - TokenURL: JWTTokenURL, - } - return cfg.TokenSource(ctx), nil - case "": - return nil, errors.New("missing 'type' field in credentials") - default: - return nil, fmt.Errorf("unknown credential type: %q", d.Type) - } -} diff --git a/vendor/golang.org/x/oauth2/google/example_test.go b/vendor/golang.org/x/oauth2/google/example_test.go deleted file mode 100644 index 17262802a91..00000000000 --- a/vendor/golang.org/x/oauth2/google/example_test.go +++ /dev/null @@ -1,150 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// +build appenginevm !appengine - -package google_test - -import ( - "fmt" - "io/ioutil" - "log" - "net/http" - - "golang.org/x/oauth2" - "golang.org/x/oauth2/google" - "golang.org/x/oauth2/jwt" - "google.golang.org/appengine" - "google.golang.org/appengine/urlfetch" -) - -func ExampleDefaultClient() { - client, err := google.DefaultClient(oauth2.NoContext, - "https://www.googleapis.com/auth/devstorage.full_control") - if err != nil { - log.Fatal(err) - } - client.Get("...") -} - -func Example_webServer() { - // Your credentials should be obtained from the Google - // Developer Console (https://console.developers.google.com). - conf := &oauth2.Config{ - ClientID: "YOUR_CLIENT_ID", - ClientSecret: "YOUR_CLIENT_SECRET", - RedirectURL: "YOUR_REDIRECT_URL", - Scopes: []string{ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/blogger", - }, - Endpoint: google.Endpoint, - } - // Redirect user to Google's consent page to ask for permission - // for the scopes specified above. - url := conf.AuthCodeURL("state") - fmt.Printf("Visit the URL for the auth dialog: %v", url) - - // Handle the exchange code to initiate a transport. - tok, err := conf.Exchange(oauth2.NoContext, "authorization-code") - if err != nil { - log.Fatal(err) - } - client := conf.Client(oauth2.NoContext, tok) - client.Get("...") -} - -func ExampleJWTConfigFromJSON() { - // Your credentials should be obtained from the Google - // Developer Console (https://console.developers.google.com). - // Navigate to your project, then see the "Credentials" page - // under "APIs & Auth". - // To create a service account client, click "Create new Client ID", - // select "Service Account", and click "Create Client ID". A JSON - // key file will then be downloaded to your computer. - data, err := ioutil.ReadFile("/path/to/your-project-key.json") - if err != nil { - log.Fatal(err) - } - conf, err := google.JWTConfigFromJSON(data, "https://www.googleapis.com/auth/bigquery") - if err != nil { - log.Fatal(err) - } - // Initiate an http.Client. The following GET request will be - // authorized and authenticated on the behalf of - // your service account. - client := conf.Client(oauth2.NoContext) - client.Get("...") -} - -func ExampleSDKConfig() { - // The credentials will be obtained from the first account that - // has been authorized with `gcloud auth login`. - conf, err := google.NewSDKConfig("") - if err != nil { - log.Fatal(err) - } - // Initiate an http.Client. The following GET request will be - // authorized and authenticated on the behalf of the SDK user. - client := conf.Client(oauth2.NoContext) - client.Get("...") -} - -func Example_serviceAccount() { - // Your credentials should be obtained from the Google - // Developer Console (https://console.developers.google.com). - conf := &jwt.Config{ - Email: "xxx@developer.gserviceaccount.com", - // The contents of your RSA private key or your PEM file - // that contains a private key. - // If you have a p12 file instead, you - // can use `openssl` to export the private key into a pem file. - // - // $ openssl pkcs12 -in key.p12 -passin pass:notasecret -out key.pem -nodes - // - // The field only supports PEM containers with no passphrase. - // The openssl command will convert p12 keys to passphrase-less PEM containers. - PrivateKey: []byte("-----BEGIN RSA PRIVATE KEY-----..."), - Scopes: []string{ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/blogger", - }, - TokenURL: google.JWTTokenURL, - // If you would like to impersonate a user, you can - // create a transport with a subject. The following GET - // request will be made on the behalf of user@example.com. - // Optional. - Subject: "user@example.com", - } - // Initiate an http.Client, the following GET request will be - // authorized and authenticated on the behalf of user@example.com. - client := conf.Client(oauth2.NoContext) - client.Get("...") -} - -func ExampleAppEngineTokenSource() { - var req *http.Request // from the ServeHTTP handler - ctx := appengine.NewContext(req) - client := &http.Client{ - Transport: &oauth2.Transport{ - Source: google.AppEngineTokenSource(ctx, "https://www.googleapis.com/auth/bigquery"), - Base: &urlfetch.Transport{ - Context: ctx, - }, - }, - } - client.Get("...") -} - -func ExampleComputeTokenSource() { - client := &http.Client{ - Transport: &oauth2.Transport{ - // Fetch from Google Compute Engine's metadata server to retrieve - // an access token for the provided account. - // If no account is specified, "default" is used. - Source: google.ComputeTokenSource(""), - }, - } - client.Get("...") -} diff --git a/vendor/golang.org/x/oauth2/google/google.go b/vendor/golang.org/x/oauth2/google/google.go deleted file mode 100644 index 69f8ff42590..00000000000 --- a/vendor/golang.org/x/oauth2/google/google.go +++ /dev/null @@ -1,145 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package google provides support for making OAuth2 authorized and -// authenticated HTTP requests to Google APIs. -// It supports the Web server flow, client-side credentials, service accounts, -// Google Compute Engine service accounts, and Google App Engine service -// accounts. -// -// For more information, please read -// https://developers.google.com/accounts/docs/OAuth2 -// and -// https://developers.google.com/accounts/application-default-credentials. -package google // import "golang.org/x/oauth2/google" - -import ( - "encoding/json" - "errors" - "fmt" - "strings" - "time" - - "golang.org/x/oauth2" - "golang.org/x/oauth2/jwt" - "google.golang.org/cloud/compute/metadata" -) - -// Endpoint is Google's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://accounts.google.com/o/oauth2/auth", - TokenURL: "https://accounts.google.com/o/oauth2/token", -} - -// JWTTokenURL is Google's OAuth 2.0 token URL to use with the JWT flow. -const JWTTokenURL = "https://accounts.google.com/o/oauth2/token" - -// ConfigFromJSON uses a Google Developers Console client_credentials.json -// file to construct a config. -// client_credentials.json can be downloadable from https://console.developers.google.com, -// under "APIs & Auth" > "Credentials". Download the Web application credentials in the -// JSON format and provide the contents of the file as jsonKey. -func ConfigFromJSON(jsonKey []byte, scope ...string) (*oauth2.Config, error) { - type cred struct { - ClientID string `json:"client_id"` - ClientSecret string `json:"client_secret"` - RedirectURIs []string `json:"redirect_uris"` - AuthURI string `json:"auth_uri"` - TokenURI string `json:"token_uri"` - } - var j struct { - Web *cred `json:"web"` - Installed *cred `json:"installed"` - } - if err := json.Unmarshal(jsonKey, &j); err != nil { - return nil, err - } - var c *cred - switch { - case j.Web != nil: - c = j.Web - case j.Installed != nil: - c = j.Installed - default: - return nil, fmt.Errorf("oauth2/google: no credentials found") - } - if len(c.RedirectURIs) < 1 { - return nil, errors.New("oauth2/google: missing redirect URL in the client_credentials.json") - } - return &oauth2.Config{ - ClientID: c.ClientID, - ClientSecret: c.ClientSecret, - RedirectURL: c.RedirectURIs[0], - Scopes: scope, - Endpoint: oauth2.Endpoint{ - AuthURL: c.AuthURI, - TokenURL: c.TokenURI, - }, - }, nil -} - -// JWTConfigFromJSON uses a Google Developers service account JSON key file to read -// the credentials that authorize and authenticate the requests. -// Create a service account on "Credentials" page under "APIs & Auth" for your -// project at https://console.developers.google.com to download a JSON key file. -func JWTConfigFromJSON(jsonKey []byte, scope ...string) (*jwt.Config, error) { - var key struct { - Email string `json:"client_email"` - PrivateKey string `json:"private_key"` - } - if err := json.Unmarshal(jsonKey, &key); err != nil { - return nil, err - } - return &jwt.Config{ - Email: key.Email, - PrivateKey: []byte(key.PrivateKey), - Scopes: scope, - TokenURL: JWTTokenURL, - }, nil -} - -// ComputeTokenSource returns a token source that fetches access tokens -// from Google Compute Engine (GCE)'s metadata server. It's only valid to use -// this token source if your program is running on a GCE instance. -// If no account is specified, "default" is used. -// Further information about retrieving access tokens from the GCE metadata -// server can be found at https://cloud.google.com/compute/docs/authentication. -func ComputeTokenSource(account string) oauth2.TokenSource { - return oauth2.ReuseTokenSource(nil, computeSource{account: account}) -} - -type computeSource struct { - account string -} - -func (cs computeSource) Token() (*oauth2.Token, error) { - if !metadata.OnGCE() { - return nil, errors.New("oauth2/google: can't get a token from the metadata service; not running on GCE") - } - acct := cs.account - if acct == "" { - acct = "default" - } - tokenJSON, err := metadata.Get("instance/service-accounts/" + acct + "/token") - if err != nil { - return nil, err - } - var res struct { - AccessToken string `json:"access_token"` - ExpiresInSec int `json:"expires_in"` - TokenType string `json:"token_type"` - } - err = json.NewDecoder(strings.NewReader(tokenJSON)).Decode(&res) - if err != nil { - return nil, fmt.Errorf("oauth2/google: invalid token JSON from metadata: %v", err) - } - if res.ExpiresInSec == 0 || res.AccessToken == "" { - return nil, fmt.Errorf("oauth2/google: incomplete token received from metadata") - } - return &oauth2.Token{ - AccessToken: res.AccessToken, - TokenType: res.TokenType, - Expiry: time.Now().Add(time.Duration(res.ExpiresInSec) * time.Second), - }, nil -} diff --git a/vendor/golang.org/x/oauth2/google/google_test.go b/vendor/golang.org/x/oauth2/google/google_test.go deleted file mode 100644 index 4cc01884b2c..00000000000 --- a/vendor/golang.org/x/oauth2/google/google_test.go +++ /dev/null @@ -1,67 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package google - -import ( - "strings" - "testing" -) - -var webJSONKey = []byte(` -{ - "web": { - "auth_uri": "https://google.com/o/oauth2/auth", - "client_secret": "3Oknc4jS_wA2r9i", - "token_uri": "https://google.com/o/oauth2/token", - "client_email": "222-nprqovg5k43uum874cs9osjt2koe97g8@developer.gserviceaccount.com", - "redirect_uris": ["https://www.example.com/oauth2callback"], - "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/222-nprqovg5k43uum874cs9osjt2koe97g8@developer.gserviceaccount.com", - "client_id": "222-nprqovg5k43uum874cs9osjt2koe97g8.apps.googleusercontent.com", - "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs", - "javascript_origins": ["https://www.example.com"] - } -}`) - -var installedJSONKey = []byte(`{ - "installed": { - "client_id": "222-installed.apps.googleusercontent.com", - "redirect_uris": ["https://www.example.com/oauth2callback"] - } -}`) - -func TestConfigFromJSON(t *testing.T) { - conf, err := ConfigFromJSON(webJSONKey, "scope1", "scope2") - if err != nil { - t.Error(err) - } - if got, want := conf.ClientID, "222-nprqovg5k43uum874cs9osjt2koe97g8.apps.googleusercontent.com"; got != want { - t.Errorf("ClientID = %q; want %q", got, want) - } - if got, want := conf.ClientSecret, "3Oknc4jS_wA2r9i"; got != want { - t.Errorf("ClientSecret = %q; want %q", got, want) - } - if got, want := conf.RedirectURL, "https://www.example.com/oauth2callback"; got != want { - t.Errorf("RedictURL = %q; want %q", got, want) - } - if got, want := strings.Join(conf.Scopes, ","), "scope1,scope2"; got != want { - t.Errorf("Scopes = %q; want %q", got, want) - } - if got, want := conf.Endpoint.AuthURL, "https://google.com/o/oauth2/auth"; got != want { - t.Errorf("AuthURL = %q; want %q", got, want) - } - if got, want := conf.Endpoint.TokenURL, "https://google.com/o/oauth2/token"; got != want { - t.Errorf("TokenURL = %q; want %q", got, want) - } -} - -func TestConfigFromJSON_Installed(t *testing.T) { - conf, err := ConfigFromJSON(installedJSONKey) - if err != nil { - t.Error(err) - } - if got, want := conf.ClientID, "222-installed.apps.googleusercontent.com"; got != want { - t.Errorf("ClientID = %q; want %q", got, want) - } -} diff --git a/vendor/golang.org/x/oauth2/google/sdk.go b/vendor/golang.org/x/oauth2/google/sdk.go deleted file mode 100644 index 01ba0ecb008..00000000000 --- a/vendor/golang.org/x/oauth2/google/sdk.go +++ /dev/null @@ -1,168 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package google - -import ( - "encoding/json" - "errors" - "fmt" - "net/http" - "os" - "os/user" - "path/filepath" - "runtime" - "strings" - "time" - - "golang.org/x/net/context" - "golang.org/x/oauth2" - "golang.org/x/oauth2/internal" -) - -type sdkCredentials struct { - Data []struct { - Credential struct { - ClientID string `json:"client_id"` - ClientSecret string `json:"client_secret"` - AccessToken string `json:"access_token"` - RefreshToken string `json:"refresh_token"` - TokenExpiry *time.Time `json:"token_expiry"` - } `json:"credential"` - Key struct { - Account string `json:"account"` - Scope string `json:"scope"` - } `json:"key"` - } -} - -// An SDKConfig provides access to tokens from an account already -// authorized via the Google Cloud SDK. -type SDKConfig struct { - conf oauth2.Config - initialToken *oauth2.Token -} - -// NewSDKConfig creates an SDKConfig for the given Google Cloud SDK -// account. If account is empty, the account currently active in -// Google Cloud SDK properties is used. -// Google Cloud SDK credentials must be created by running `gcloud auth` -// before using this function. -// The Google Cloud SDK is available at https://cloud.google.com/sdk/. -func NewSDKConfig(account string) (*SDKConfig, error) { - configPath, err := sdkConfigPath() - if err != nil { - return nil, fmt.Errorf("oauth2/google: error getting SDK config path: %v", err) - } - credentialsPath := filepath.Join(configPath, "credentials") - f, err := os.Open(credentialsPath) - if err != nil { - return nil, fmt.Errorf("oauth2/google: failed to load SDK credentials: %v", err) - } - defer f.Close() - - var c sdkCredentials - if err := json.NewDecoder(f).Decode(&c); err != nil { - return nil, fmt.Errorf("oauth2/google: failed to decode SDK credentials from %q: %v", credentialsPath, err) - } - if len(c.Data) == 0 { - return nil, fmt.Errorf("oauth2/google: no credentials found in %q, run `gcloud auth login` to create one", credentialsPath) - } - if account == "" { - propertiesPath := filepath.Join(configPath, "properties") - f, err := os.Open(propertiesPath) - if err != nil { - return nil, fmt.Errorf("oauth2/google: failed to load SDK properties: %v", err) - } - defer f.Close() - ini, err := internal.ParseINI(f) - if err != nil { - return nil, fmt.Errorf("oauth2/google: failed to parse SDK properties %q: %v", propertiesPath, err) - } - core, ok := ini["core"] - if !ok { - return nil, fmt.Errorf("oauth2/google: failed to find [core] section in %v", ini) - } - active, ok := core["account"] - if !ok { - return nil, fmt.Errorf("oauth2/google: failed to find %q attribute in %v", "account", core) - } - account = active - } - - for _, d := range c.Data { - if account == "" || d.Key.Account == account { - if d.Credential.AccessToken == "" && d.Credential.RefreshToken == "" { - return nil, fmt.Errorf("oauth2/google: no token available for account %q", account) - } - var expiry time.Time - if d.Credential.TokenExpiry != nil { - expiry = *d.Credential.TokenExpiry - } - return &SDKConfig{ - conf: oauth2.Config{ - ClientID: d.Credential.ClientID, - ClientSecret: d.Credential.ClientSecret, - Scopes: strings.Split(d.Key.Scope, " "), - Endpoint: Endpoint, - RedirectURL: "oob", - }, - initialToken: &oauth2.Token{ - AccessToken: d.Credential.AccessToken, - RefreshToken: d.Credential.RefreshToken, - Expiry: expiry, - }, - }, nil - } - } - return nil, fmt.Errorf("oauth2/google: no such credentials for account %q", account) -} - -// Client returns an HTTP client using Google Cloud SDK credentials to -// authorize requests. The token will auto-refresh as necessary. The -// underlying http.RoundTripper will be obtained using the provided -// context. The returned client and its Transport should not be -// modified. -func (c *SDKConfig) Client(ctx context.Context) *http.Client { - return &http.Client{ - Transport: &oauth2.Transport{ - Source: c.TokenSource(ctx), - }, - } -} - -// TokenSource returns an oauth2.TokenSource that retrieve tokens from -// Google Cloud SDK credentials using the provided context. -// It will returns the current access token stored in the credentials, -// and refresh it when it expires, but it won't update the credentials -// with the new access token. -func (c *SDKConfig) TokenSource(ctx context.Context) oauth2.TokenSource { - return c.conf.TokenSource(ctx, c.initialToken) -} - -// Scopes are the OAuth 2.0 scopes the current account is authorized for. -func (c *SDKConfig) Scopes() []string { - return c.conf.Scopes -} - -// sdkConfigPath tries to guess where the gcloud config is located. -// It can be overridden during tests. -var sdkConfigPath = func() (string, error) { - if runtime.GOOS == "windows" { - return filepath.Join(os.Getenv("APPDATA"), "gcloud"), nil - } - homeDir := guessUnixHomeDir() - if homeDir == "" { - return "", errors.New("unable to get current user home directory: os/user lookup failed; $HOME is empty") - } - return filepath.Join(homeDir, ".config", "gcloud"), nil -} - -func guessUnixHomeDir() string { - usr, err := user.Current() - if err == nil { - return usr.HomeDir - } - return os.Getenv("HOME") -} diff --git a/vendor/golang.org/x/oauth2/google/sdk_test.go b/vendor/golang.org/x/oauth2/google/sdk_test.go deleted file mode 100644 index 79df8896443..00000000000 --- a/vendor/golang.org/x/oauth2/google/sdk_test.go +++ /dev/null @@ -1,46 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package google - -import "testing" - -func TestSDKConfig(t *testing.T) { - sdkConfigPath = func() (string, error) { - return "testdata/gcloud", nil - } - - tests := []struct { - account string - accessToken string - err bool - }{ - {"", "bar_access_token", false}, - {"foo@example.com", "foo_access_token", false}, - {"bar@example.com", "bar_access_token", false}, - {"baz@serviceaccount.example.com", "", true}, - } - for _, tt := range tests { - c, err := NewSDKConfig(tt.account) - if got, want := err != nil, tt.err; got != want { - if !tt.err { - t.Errorf("expected no error, got error: %v", tt.err, err) - } else { - t.Errorf("expected error, got none") - } - continue - } - if err != nil { - continue - } - tok := c.initialToken - if tok == nil { - t.Errorf("expected token %q, got: nil", tt.accessToken) - continue - } - if tok.AccessToken != tt.accessToken { - t.Errorf("expected token %q, got: %q", tt.accessToken, tok.AccessToken) - } - } -} diff --git a/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials b/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials deleted file mode 100644 index ff5eefbd0a8..00000000000 --- a/vendor/golang.org/x/oauth2/google/testdata/gcloud/credentials +++ /dev/null @@ -1,122 +0,0 @@ -{ - "data": [ - { - "credential": { - "_class": "OAuth2Credentials", - "_module": "oauth2client.client", - "access_token": "foo_access_token", - "client_id": "foo_client_id", - "client_secret": "foo_client_secret", - "id_token": { - "at_hash": "foo_at_hash", - "aud": "foo_aud", - "azp": "foo_azp", - "cid": "foo_cid", - "email": "foo@example.com", - "email_verified": true, - "exp": 1420573614, - "iat": 1420569714, - "id": "1337", - "iss": "accounts.google.com", - "sub": "1337", - "token_hash": "foo_token_hash", - "verified_email": true - }, - "invalid": false, - "refresh_token": "foo_refresh_token", - "revoke_uri": "https://accounts.google.com/o/oauth2/revoke", - "token_expiry": "2015-01-09T00:51:51Z", - "token_response": { - "access_token": "foo_access_token", - "expires_in": 3600, - "id_token": "foo_id_token", - "token_type": "Bearer" - }, - "token_uri": "https://accounts.google.com/o/oauth2/token", - "user_agent": "Cloud SDK Command Line Tool" - }, - "key": { - "account": "foo@example.com", - "clientId": "foo_client_id", - "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting", - "type": "google-cloud-sdk" - } - }, - { - "credential": { - "_class": "OAuth2Credentials", - "_module": "oauth2client.client", - "access_token": "bar_access_token", - "client_id": "bar_client_id", - "client_secret": "bar_client_secret", - "id_token": { - "at_hash": "bar_at_hash", - "aud": "bar_aud", - "azp": "bar_azp", - "cid": "bar_cid", - "email": "bar@example.com", - "email_verified": true, - "exp": 1420573614, - "iat": 1420569714, - "id": "1337", - "iss": "accounts.google.com", - "sub": "1337", - "token_hash": "bar_token_hash", - "verified_email": true - }, - "invalid": false, - "refresh_token": "bar_refresh_token", - "revoke_uri": "https://accounts.google.com/o/oauth2/revoke", - "token_expiry": "2015-01-09T00:51:51Z", - "token_response": { - "access_token": "bar_access_token", - "expires_in": 3600, - "id_token": "bar_id_token", - "token_type": "Bearer" - }, - "token_uri": "https://accounts.google.com/o/oauth2/token", - "user_agent": "Cloud SDK Command Line Tool" - }, - "key": { - "account": "bar@example.com", - "clientId": "bar_client_id", - "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting", - "type": "google-cloud-sdk" - } - }, - { - "credential": { - "_class": "ServiceAccountCredentials", - "_kwargs": {}, - "_module": "oauth2client.client", - "_private_key_id": "00000000000000000000000000000000", - "_private_key_pkcs8_text": "-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBAAKBgQCt3fpiynPSaUhWSIKMGV331zudwJ6GkGmvQtwsoK2S2LbvnSwU\nNxgj4fp08kIDR5p26wF4+t/HrKydMwzftXBfZ9UmLVJgRdSswmS5SmChCrfDS5OE\nvFFcN5+6w1w8/Nu657PF/dse8T0bV95YrqyoR0Osy8WHrUOMSIIbC3hRuwIDAQAB\nAoGAJrGE/KFjn0sQ7yrZ6sXmdLawrM3mObo/2uI9T60+k7SpGbBX0/Pi6nFrJMWZ\nTVONG7P3Mu5aCPzzuVRYJB0j8aldSfzABTY3HKoWCczqw1OztJiEseXGiYz4QOyr\nYU3qDyEpdhS6q6wcoLKGH+hqRmz6pcSEsc8XzOOu7s4xW8kCQQDkc75HjhbarCnd\nJJGMe3U76+6UGmdK67ltZj6k6xoB5WbTNChY9TAyI2JC+ppYV89zv3ssj4L+02u3\nHIHFGxsHAkEAwtU1qYb1tScpchPobnYUFiVKJ7KA8EZaHVaJJODW/cghTCV7BxcJ\nbgVvlmk4lFKn3lPKAgWw7PdQsBTVBUcCrQJATPwoIirizrv3u5soJUQxZIkENAqV\nxmybZx9uetrzP7JTrVbFRf0SScMcyN90hdLJiQL8+i4+gaszgFht7sNMnwJAAbfj\nq0UXcauQwALQ7/h2oONfTg5S+MuGC/AxcXPSMZbMRGGoPh3D5YaCv27aIuS/ukQ+\n6dmm/9AGlCb64fsIWQJAPaokbjIifo+LwC5gyK73Mc4t8nAOSZDenzd/2f6TCq76\nS1dcnKiPxaED7W/y6LJiuBT2rbZiQ2L93NJpFZD/UA==\n-----END RSA PRIVATE KEY-----\n", - "_revoke_uri": "https://accounts.google.com/o/oauth2/revoke", - "_scopes": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting", - "_service_account_email": "baz@serviceaccount.example.com", - "_service_account_id": "baz.serviceaccount.example.com", - "_token_uri": "https://accounts.google.com/o/oauth2/token", - "_user_agent": "Cloud SDK Command Line Tool", - "access_token": null, - "assertion_type": null, - "client_id": null, - "client_secret": null, - "id_token": null, - "invalid": false, - "refresh_token": null, - "revoke_uri": "https://accounts.google.com/o/oauth2/revoke", - "service_account_name": "baz@serviceaccount.example.com", - "token_expiry": null, - "token_response": null, - "user_agent": "Cloud SDK Command Line Tool" - }, - "key": { - "account": "baz@serviceaccount.example.com", - "clientId": "baz_client_id", - "scope": "https://www.googleapis.com/auth/appengine.admin https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/devstorage.full_control https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/ndev.cloudman https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/sqlservice.admin https://www.googleapis.com/auth/prediction https://www.googleapis.com/auth/projecthosting", - "type": "google-cloud-sdk" - } - } - ], - "file_version": 1 -} diff --git a/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties b/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties deleted file mode 100644 index 025de886cf7..00000000000 --- a/vendor/golang.org/x/oauth2/google/testdata/gcloud/properties +++ /dev/null @@ -1,2 +0,0 @@ -[core] -account = bar@example.com \ No newline at end of file diff --git a/vendor/golang.org/x/oauth2/internal/oauth2.go b/vendor/golang.org/x/oauth2/internal/oauth2.go index 37571a12928..e31541b39e7 100644 --- a/vendor/golang.org/x/oauth2/internal/oauth2.go +++ b/vendor/golang.org/x/oauth2/internal/oauth2.go @@ -1,4 +1,4 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. +// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. @@ -42,7 +42,7 @@ func ParseKey(key []byte) (*rsa.PrivateKey, error) { func ParseINI(ini io.Reader) (map[string]map[string]string, error) { result := map[string]map[string]string{ - "": map[string]string{}, // root section + "": {}, // root section } scanner := bufio.NewScanner(ini) currentSection := "" @@ -67,3 +67,10 @@ func ParseINI(ini io.Reader) (map[string]map[string]string, error) { } return result, nil } + +func CondVal(v string) []string { + if v == "" { + return nil + } + return []string{v} +} diff --git a/vendor/golang.org/x/oauth2/internal/oauth2_test.go b/vendor/golang.org/x/oauth2/internal/oauth2_test.go deleted file mode 100644 index 014a351e006..00000000000 --- a/vendor/golang.org/x/oauth2/internal/oauth2_test.go +++ /dev/null @@ -1,62 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package internal contains support packages for oauth2 package. -package internal - -import ( - "reflect" - "strings" - "testing" -) - -func TestParseINI(t *testing.T) { - tests := []struct { - ini string - want map[string]map[string]string - }{ - { - `root = toor -[foo] -bar = hop -ini = nin -`, - map[string]map[string]string{ - "": map[string]string{"root": "toor"}, - "foo": map[string]string{"bar": "hop", "ini": "nin"}, - }, - }, - { - `[empty] -[section] -empty= -`, - map[string]map[string]string{ - "": map[string]string{}, - "empty": map[string]string{}, - "section": map[string]string{"empty": ""}, - }, - }, - { - `ignore -[invalid -=stuff -;comment=true -`, - map[string]map[string]string{ - "": map[string]string{}, - }, - }, - } - for _, tt := range tests { - result, err := ParseINI(strings.NewReader(tt.ini)) - if err != nil { - t.Errorf("ParseINI(%q) error %v, want: no error", tt.ini, err) - continue - } - if !reflect.DeepEqual(result, tt.want) { - t.Errorf("ParseINI(%q) = %#v, want: %#v", tt.ini, result, tt.want) - } - } -} diff --git a/vendor/golang.org/x/oauth2/internal/token.go b/vendor/golang.org/x/oauth2/internal/token.go new file mode 100644 index 00000000000..7cce374caa4 --- /dev/null +++ b/vendor/golang.org/x/oauth2/internal/token.go @@ -0,0 +1,249 @@ +// Copyright 2014 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package internal contains support packages for oauth2 package. +package internal + +import ( + "encoding/json" + "fmt" + "io" + "io/ioutil" + "mime" + "net/http" + "net/url" + "strconv" + "strings" + "time" + + "golang.org/x/net/context" +) + +// Token represents the crendentials used to authorize +// the requests to access protected resources on the OAuth 2.0 +// provider's backend. +// +// This type is a mirror of oauth2.Token and exists to break +// an otherwise-circular dependency. Other internal packages +// should convert this Token into an oauth2.Token before use. +type Token struct { + // AccessToken is the token that authorizes and authenticates + // the requests. + AccessToken string + + // TokenType is the type of token. + // The Type method returns either this or "Bearer", the default. + TokenType string + + // RefreshToken is a token that's used by the application + // (as opposed to the user) to refresh the access token + // if it expires. + RefreshToken string + + // Expiry is the optional expiration time of the access token. + // + // If zero, TokenSource implementations will reuse the same + // token forever and RefreshToken or equivalent + // mechanisms for that TokenSource will not be used. + Expiry time.Time + + // Raw optionally contains extra metadata from the server + // when updating a token. + Raw interface{} +} + +// tokenJSON is the struct representing the HTTP response from OAuth2 +// providers returning a token in JSON form. +type tokenJSON struct { + AccessToken string `json:"access_token"` + TokenType string `json:"token_type"` + RefreshToken string `json:"refresh_token"` + ExpiresIn expirationTime `json:"expires_in"` // at least PayPal returns string, while most return number + Expires expirationTime `json:"expires"` // broken Facebook spelling of expires_in +} + +func (e *tokenJSON) expiry() (t time.Time) { + if v := e.ExpiresIn; v != 0 { + return time.Now().Add(time.Duration(v) * time.Second) + } + if v := e.Expires; v != 0 { + return time.Now().Add(time.Duration(v) * time.Second) + } + return +} + +type expirationTime int32 + +func (e *expirationTime) UnmarshalJSON(b []byte) error { + var n json.Number + err := json.Unmarshal(b, &n) + if err != nil { + return err + } + i, err := n.Int64() + if err != nil { + return err + } + *e = expirationTime(i) + return nil +} + +var brokenAuthHeaderProviders = []string{ + "https://accounts.google.com/", + "https://api.codeswholesale.com/oauth/token", + "https://api.dropbox.com/", + "https://api.dropboxapi.com/", + "https://api.instagram.com/", + "https://api.netatmo.net/", + "https://api.odnoklassniki.ru/", + "https://api.pushbullet.com/", + "https://api.soundcloud.com/", + "https://api.twitch.tv/", + "https://app.box.com/", + "https://connect.stripe.com/", + "https://graph.facebook.com", // see https://github.com/golang/oauth2/issues/214 + "https://login.microsoftonline.com/", + "https://login.salesforce.com/", + "https://oauth.sandbox.trainingpeaks.com/", + "https://oauth.trainingpeaks.com/", + "https://oauth.vk.com/", + "https://openapi.baidu.com/", + "https://slack.com/", + "https://test-sandbox.auth.corp.google.com", + "https://test.salesforce.com/", + "https://user.gini.net/", + "https://www.douban.com/", + "https://www.googleapis.com/", + "https://www.linkedin.com/", + "https://www.strava.com/oauth/", + "https://www.wunderlist.com/oauth/", + "https://api.patreon.com/", + "https://sandbox.codeswholesale.com/oauth/token", + "https://api.sipgate.com/v1/authorization/oauth", +} + +// brokenAuthHeaderDomains lists broken providers that issue dynamic endpoints. +var brokenAuthHeaderDomains = []string{ + ".force.com", + ".myshopify.com", + ".okta.com", + ".oktapreview.com", +} + +func RegisterBrokenAuthHeaderProvider(tokenURL string) { + brokenAuthHeaderProviders = append(brokenAuthHeaderProviders, tokenURL) +} + +// providerAuthHeaderWorks reports whether the OAuth2 server identified by the tokenURL +// implements the OAuth2 spec correctly +// See https://code.google.com/p/goauth2/issues/detail?id=31 for background. +// In summary: +// - Reddit only accepts client secret in the Authorization header +// - Dropbox accepts either it in URL param or Auth header, but not both. +// - Google only accepts URL param (not spec compliant?), not Auth header +// - Stripe only accepts client secret in Auth header with Bearer method, not Basic +func providerAuthHeaderWorks(tokenURL string) bool { + for _, s := range brokenAuthHeaderProviders { + if strings.HasPrefix(tokenURL, s) { + // Some sites fail to implement the OAuth2 spec fully. + return false + } + } + + if u, err := url.Parse(tokenURL); err == nil { + for _, s := range brokenAuthHeaderDomains { + if strings.HasSuffix(u.Host, s) { + return false + } + } + } + + // Assume the provider implements the spec properly + // otherwise. We can add more exceptions as they're + // discovered. We will _not_ be adding configurable hooks + // to this package to let users select server bugs. + return true +} + +func RetrieveToken(ctx context.Context, clientID, clientSecret, tokenURL string, v url.Values) (*Token, error) { + hc, err := ContextClient(ctx) + if err != nil { + return nil, err + } + bustedAuth := !providerAuthHeaderWorks(tokenURL) + if bustedAuth { + if clientID != "" { + v.Set("client_id", clientID) + } + if clientSecret != "" { + v.Set("client_secret", clientSecret) + } + } + req, err := http.NewRequest("POST", tokenURL, strings.NewReader(v.Encode())) + if err != nil { + return nil, err + } + req.Header.Set("Content-Type", "application/x-www-form-urlencoded") + if !bustedAuth { + req.SetBasicAuth(clientID, clientSecret) + } + r, err := hc.Do(req) + if err != nil { + return nil, err + } + defer r.Body.Close() + body, err := ioutil.ReadAll(io.LimitReader(r.Body, 1<<20)) + if err != nil { + return nil, fmt.Errorf("oauth2: cannot fetch token: %v", err) + } + if code := r.StatusCode; code < 200 || code > 299 { + return nil, fmt.Errorf("oauth2: cannot fetch token: %v\nResponse: %s", r.Status, body) + } + + var token *Token + content, _, _ := mime.ParseMediaType(r.Header.Get("Content-Type")) + switch content { + case "application/x-www-form-urlencoded", "text/plain": + vals, err := url.ParseQuery(string(body)) + if err != nil { + return nil, err + } + token = &Token{ + AccessToken: vals.Get("access_token"), + TokenType: vals.Get("token_type"), + RefreshToken: vals.Get("refresh_token"), + Raw: vals, + } + e := vals.Get("expires_in") + if e == "" { + // TODO(jbd): Facebook's OAuth2 implementation is broken and + // returns expires_in field in expires. Remove the fallback to expires, + // when Facebook fixes their implementation. + e = vals.Get("expires") + } + expires, _ := strconv.Atoi(e) + if expires != 0 { + token.Expiry = time.Now().Add(time.Duration(expires) * time.Second) + } + default: + var tj tokenJSON + if err = json.Unmarshal(body, &tj); err != nil { + return nil, err + } + token = &Token{ + AccessToken: tj.AccessToken, + TokenType: tj.TokenType, + RefreshToken: tj.RefreshToken, + Expiry: tj.expiry(), + Raw: make(map[string]interface{}), + } + json.Unmarshal(body, &token.Raw) // no error checks for optional fields + } + // Don't overwrite `RefreshToken` with an empty value + // if this was a token refreshing request. + if token.RefreshToken == "" { + token.RefreshToken = v.Get("refresh_token") + } + return token, nil +} diff --git a/vendor/golang.org/x/oauth2/internal/transport.go b/vendor/golang.org/x/oauth2/internal/transport.go new file mode 100644 index 00000000000..f1f173e345d --- /dev/null +++ b/vendor/golang.org/x/oauth2/internal/transport.go @@ -0,0 +1,69 @@ +// Copyright 2014 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +// Package internal contains support packages for oauth2 package. +package internal + +import ( + "net/http" + + "golang.org/x/net/context" +) + +// HTTPClient is the context key to use with golang.org/x/net/context's +// WithValue function to associate an *http.Client value with a context. +var HTTPClient ContextKey + +// ContextKey is just an empty struct. It exists so HTTPClient can be +// an immutable public variable with a unique type. It's immutable +// because nobody else can create a ContextKey, being unexported. +type ContextKey struct{} + +// ContextClientFunc is a func which tries to return an *http.Client +// given a Context value. If it returns an error, the search stops +// with that error. If it returns (nil, nil), the search continues +// down the list of registered funcs. +type ContextClientFunc func(context.Context) (*http.Client, error) + +var contextClientFuncs []ContextClientFunc + +func RegisterContextClientFunc(fn ContextClientFunc) { + contextClientFuncs = append(contextClientFuncs, fn) +} + +func ContextClient(ctx context.Context) (*http.Client, error) { + if ctx != nil { + if hc, ok := ctx.Value(HTTPClient).(*http.Client); ok { + return hc, nil + } + } + for _, fn := range contextClientFuncs { + c, err := fn(ctx) + if err != nil { + return nil, err + } + if c != nil { + return c, nil + } + } + return http.DefaultClient, nil +} + +func ContextTransport(ctx context.Context) http.RoundTripper { + hc, err := ContextClient(ctx) + // This is a rare error case (somebody using nil on App Engine). + if err != nil { + return ErrorTransport{err} + } + return hc.Transport +} + +// ErrorTransport returns the specified error on RoundTrip. +// This RoundTripper should be used in rare error cases where +// error handling can be postponed to response handling time. +type ErrorTransport struct{ Err error } + +func (t ErrorTransport) RoundTrip(*http.Request) (*http.Response, error) { + return nil, t.Err +} diff --git a/vendor/golang.org/x/oauth2/jws/jws.go b/vendor/golang.org/x/oauth2/jws/jws.go deleted file mode 100644 index 362323c4e74..00000000000 --- a/vendor/golang.org/x/oauth2/jws/jws.go +++ /dev/null @@ -1,160 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package jws provides encoding and decoding utilities for -// signed JWS messages. -package jws // import "golang.org/x/oauth2/jws" - -import ( - "bytes" - "crypto" - "crypto/rand" - "crypto/rsa" - "crypto/sha256" - "encoding/base64" - "encoding/json" - "errors" - "fmt" - "strings" - "time" -) - -// ClaimSet contains information about the JWT signature including the -// permissions being requested (scopes), the target of the token, the issuer, -// the time the token was issued, and the lifetime of the token. -type ClaimSet struct { - Iss string `json:"iss"` // email address of the client_id of the application making the access token request - Scope string `json:"scope,omitempty"` // space-delimited list of the permissions the application requests - Aud string `json:"aud"` // descriptor of the intended target of the assertion (Optional). - Exp int64 `json:"exp"` // the expiration time of the assertion - Iat int64 `json:"iat"` // the time the assertion was issued. - Typ string `json:"typ,omitempty"` // token type (Optional). - - // Email for which the application is requesting delegated access (Optional). - Sub string `json:"sub,omitempty"` - - // The old name of Sub. Client keeps setting Prn to be - // complaint with legacy OAuth 2.0 providers. (Optional) - Prn string `json:"prn,omitempty"` - - // See http://tools.ietf.org/html/draft-jones-json-web-token-10#section-4.3 - // This array is marshalled using custom code (see (c *ClaimSet) encode()). - PrivateClaims map[string]interface{} `json:"-"` - - exp time.Time - iat time.Time -} - -func (c *ClaimSet) encode() (string, error) { - if c.exp.IsZero() || c.iat.IsZero() { - // Reverting time back for machines whose time is not perfectly in sync. - // If client machine's time is in the future according - // to Google servers, an access token will not be issued. - now := time.Now().Add(-10 * time.Second) - c.iat = now - c.exp = now.Add(time.Hour) - } - - c.Exp = c.exp.Unix() - c.Iat = c.iat.Unix() - - b, err := json.Marshal(c) - if err != nil { - return "", err - } - - if len(c.PrivateClaims) == 0 { - return base64Encode(b), nil - } - - // Marshal private claim set and then append it to b. - prv, err := json.Marshal(c.PrivateClaims) - if err != nil { - return "", fmt.Errorf("jws: invalid map of private claims %v", c.PrivateClaims) - } - - // Concatenate public and private claim JSON objects. - if !bytes.HasSuffix(b, []byte{'}'}) { - return "", fmt.Errorf("jws: invalid JSON %s", b) - } - if !bytes.HasPrefix(prv, []byte{'{'}) { - return "", fmt.Errorf("jws: invalid JSON %s", prv) - } - b[len(b)-1] = ',' // Replace closing curly brace with a comma. - b = append(b, prv[1:]...) // Append private claims. - return base64Encode(b), nil -} - -// Header represents the header for the signed JWS payloads. -type Header struct { - // The algorithm used for signature. - Algorithm string `json:"alg"` - - // Represents the token type. - Typ string `json:"typ"` -} - -func (h *Header) encode() (string, error) { - b, err := json.Marshal(h) - if err != nil { - return "", err - } - return base64Encode(b), nil -} - -// Decode decodes a claim set from a JWS payload. -func Decode(payload string) (*ClaimSet, error) { - // decode returned id token to get expiry - s := strings.Split(payload, ".") - if len(s) < 2 { - // TODO(jbd): Provide more context about the error. - return nil, errors.New("jws: invalid token received") - } - decoded, err := base64Decode(s[1]) - if err != nil { - return nil, err - } - c := &ClaimSet{} - err = json.NewDecoder(bytes.NewBuffer(decoded)).Decode(c) - return c, err -} - -// Encode encodes a signed JWS with provided header and claim set. -func Encode(header *Header, c *ClaimSet, signature *rsa.PrivateKey) (string, error) { - head, err := header.encode() - if err != nil { - return "", err - } - cs, err := c.encode() - if err != nil { - return "", err - } - ss := fmt.Sprintf("%s.%s", head, cs) - h := sha256.New() - h.Write([]byte(ss)) - b, err := rsa.SignPKCS1v15(rand.Reader, signature, crypto.SHA256, h.Sum(nil)) - if err != nil { - return "", err - } - sig := base64Encode(b) - return fmt.Sprintf("%s.%s", ss, sig), nil -} - -// base64Encode returns and Base64url encoded version of the input string with any -// trailing "=" stripped. -func base64Encode(b []byte) string { - return strings.TrimRight(base64.URLEncoding.EncodeToString(b), "=") -} - -// base64Decode decodes the Base64url encoded string -func base64Decode(s string) ([]byte, error) { - // add back missing padding - switch len(s) % 4 { - case 2: - s += "==" - case 3: - s += "=" - } - return base64.URLEncoding.DecodeString(s) -} diff --git a/vendor/golang.org/x/oauth2/jwt/example_test.go b/vendor/golang.org/x/oauth2/jwt/example_test.go deleted file mode 100644 index 6d618836ea3..00000000000 --- a/vendor/golang.org/x/oauth2/jwt/example_test.go +++ /dev/null @@ -1,31 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package jwt_test - -import ( - "golang.org/x/oauth2" - "golang.org/x/oauth2/jwt" -) - -func ExampleJWTConfig() { - conf := &jwt.Config{ - Email: "xxx@developer.com", - // The contents of your RSA private key or your PEM file - // that contains a private key. - // If you have a p12 file instead, you - // can use `openssl` to export the private key into a pem file. - // - // $ openssl pkcs12 -in key.p12 -out key.pem -nodes - // - // It only supports PEM containers with no passphrase. - PrivateKey: []byte("-----BEGIN RSA PRIVATE KEY-----..."), - Subject: "user@example.com", - TokenURL: "https://provider.com/o/oauth2/token", - } - // Initiate an http.Client, the following GET request will be - // authorized and authenticated on the behalf of user@example.com. - client := conf.Client(oauth2.NoContext) - client.Get("...") -} diff --git a/vendor/golang.org/x/oauth2/jwt/jwt.go b/vendor/golang.org/x/oauth2/jwt/jwt.go deleted file mode 100644 index 205d23ed438..00000000000 --- a/vendor/golang.org/x/oauth2/jwt/jwt.go +++ /dev/null @@ -1,147 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package jwt implements the OAuth 2.0 JSON Web Token flow, commonly -// known as "two-legged OAuth 2.0". -// -// See: https://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-12 -package jwt - -import ( - "encoding/json" - "fmt" - "io" - "io/ioutil" - "net/http" - "net/url" - "strings" - "time" - - "golang.org/x/net/context" - "golang.org/x/oauth2" - "golang.org/x/oauth2/internal" - "golang.org/x/oauth2/jws" -) - -var ( - defaultGrantType = "urn:ietf:params:oauth:grant-type:jwt-bearer" - defaultHeader = &jws.Header{Algorithm: "RS256", Typ: "JWT"} -) - -// Config is the configuration for using JWT to fetch tokens, -// commonly known as "two-legged OAuth 2.0". -type Config struct { - // Email is the OAuth client identifier used when communicating with - // the configured OAuth provider. - Email string - - // PrivateKey contains the contents of an RSA private key or the - // contents of a PEM file that contains a private key. The provided - // private key is used to sign JWT payloads. - // PEM containers with a passphrase are not supported. - // Use the following command to convert a PKCS 12 file into a PEM. - // - // $ openssl pkcs12 -in key.p12 -out key.pem -nodes - // - PrivateKey []byte - - // Subject is the optional user to impersonate. - Subject string - - // Scopes optionally specifies a list of requested permission scopes. - Scopes []string - - // TokenURL is the endpoint required to complete the 2-legged JWT flow. - TokenURL string -} - -// TokenSource returns a JWT TokenSource using the configuration -// in c and the HTTP client from the provided context. -func (c *Config) TokenSource(ctx context.Context) oauth2.TokenSource { - return oauth2.ReuseTokenSource(nil, jwtSource{ctx, c}) -} - -// Client returns an HTTP client wrapping the context's -// HTTP transport and adding Authorization headers with tokens -// obtained from c. -// -// The returned client and its Transport should not be modified. -func (c *Config) Client(ctx context.Context) *http.Client { - return oauth2.NewClient(ctx, c.TokenSource(ctx)) -} - -// jwtSource is a source that always does a signed JWT request for a token. -// It should typically be wrapped with a reuseTokenSource. -type jwtSource struct { - ctx context.Context - conf *Config -} - -func (js jwtSource) Token() (*oauth2.Token, error) { - pk, err := internal.ParseKey(js.conf.PrivateKey) - if err != nil { - return nil, err - } - hc := oauth2.NewClient(js.ctx, nil) - claimSet := &jws.ClaimSet{ - Iss: js.conf.Email, - Scope: strings.Join(js.conf.Scopes, " "), - Aud: js.conf.TokenURL, - } - if subject := js.conf.Subject; subject != "" { - claimSet.Sub = subject - // prn is the old name of sub. Keep setting it - // to be compatible with legacy OAuth 2.0 providers. - claimSet.Prn = subject - } - payload, err := jws.Encode(defaultHeader, claimSet, pk) - if err != nil { - return nil, err - } - v := url.Values{} - v.Set("grant_type", defaultGrantType) - v.Set("assertion", payload) - resp, err := hc.PostForm(js.conf.TokenURL, v) - if err != nil { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v", err) - } - defer resp.Body.Close() - body, err := ioutil.ReadAll(io.LimitReader(resp.Body, 1<<20)) - if err != nil { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v", err) - } - if c := resp.StatusCode; c < 200 || c > 299 { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v\nResponse: %s", resp.Status, body) - } - // tokenRes is the JSON response body. - var tokenRes struct { - AccessToken string `json:"access_token"` - TokenType string `json:"token_type"` - IDToken string `json:"id_token"` - ExpiresIn int64 `json:"expires_in"` // relative seconds from now - } - if err := json.Unmarshal(body, &tokenRes); err != nil { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v", err) - } - token := &oauth2.Token{ - AccessToken: tokenRes.AccessToken, - TokenType: tokenRes.TokenType, - } - raw := make(map[string]interface{}) - json.Unmarshal(body, &raw) // no error checks for optional fields - token = token.WithExtra(raw) - - if secs := tokenRes.ExpiresIn; secs > 0 { - token.Expiry = time.Now().Add(time.Duration(secs) * time.Second) - } - if v := tokenRes.IDToken; v != "" { - // decode returned id token to get expiry - claimSet, err := jws.Decode(v) - if err != nil { - return nil, fmt.Errorf("oauth2: error decoding JWT token: %v", err) - } - token.Expiry = time.Unix(claimSet.Exp, 0) - } - return token, nil -} diff --git a/vendor/golang.org/x/oauth2/jwt/jwt_test.go b/vendor/golang.org/x/oauth2/jwt/jwt_test.go deleted file mode 100644 index da922c3d00d..00000000000 --- a/vendor/golang.org/x/oauth2/jwt/jwt_test.go +++ /dev/null @@ -1,134 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package jwt - -import ( - "net/http" - "net/http/httptest" - "testing" - - "golang.org/x/oauth2" -) - -var dummyPrivateKey = []byte(`-----BEGIN RSA PRIVATE KEY----- -MIIEpAIBAAKCAQEAx4fm7dngEmOULNmAs1IGZ9Apfzh+BkaQ1dzkmbUgpcoghucE -DZRnAGd2aPyB6skGMXUytWQvNYav0WTR00wFtX1ohWTfv68HGXJ8QXCpyoSKSSFY -fuP9X36wBSkSX9J5DVgiuzD5VBdzUISSmapjKm+DcbRALjz6OUIPEWi1Tjl6p5RK -1w41qdbmt7E5/kGhKLDuT7+M83g4VWhgIvaAXtnhklDAggilPPa8ZJ1IFe31lNlr -k4DRk38nc6sEutdf3RL7QoH7FBusI7uXV03DC6dwN1kP4GE7bjJhcRb/7jYt7CQ9 -/E9Exz3c0yAp0yrTg0Fwh+qxfH9dKwN52S7SBwIDAQABAoIBAQCaCs26K07WY5Jt -3a2Cw3y2gPrIgTCqX6hJs7O5ByEhXZ8nBwsWANBUe4vrGaajQHdLj5OKfsIDrOvn -2NI1MqflqeAbu/kR32q3tq8/Rl+PPiwUsW3E6Pcf1orGMSNCXxeducF2iySySzh3 -nSIhCG5uwJDWI7a4+9KiieFgK1pt/Iv30q1SQS8IEntTfXYwANQrfKUVMmVF9aIK -6/WZE2yd5+q3wVVIJ6jsmTzoDCX6QQkkJICIYwCkglmVy5AeTckOVwcXL0jqw5Kf -5/soZJQwLEyBoQq7Kbpa26QHq+CJONetPP8Ssy8MJJXBT+u/bSseMb3Zsr5cr43e -DJOhwsThAoGBAPY6rPKl2NT/K7XfRCGm1sbWjUQyDShscwuWJ5+kD0yudnT/ZEJ1 -M3+KS/iOOAoHDdEDi9crRvMl0UfNa8MAcDKHflzxg2jg/QI+fTBjPP5GOX0lkZ9g -z6VePoVoQw2gpPFVNPPTxKfk27tEzbaffvOLGBEih0Kb7HTINkW8rIlzAoGBAM9y -1yr+jvfS1cGFtNU+Gotoihw2eMKtIqR03Yn3n0PK1nVCDKqwdUqCypz4+ml6cxRK -J8+Pfdh7D+ZJd4LEG6Y4QRDLuv5OA700tUoSHxMSNn3q9As4+T3MUyYxWKvTeu3U -f2NWP9ePU0lV8ttk7YlpVRaPQmc1qwooBA/z/8AdAoGAW9x0HWqmRICWTBnpjyxx -QGlW9rQ9mHEtUotIaRSJ6K/F3cxSGUEkX1a3FRnp6kPLcckC6NlqdNgNBd6rb2rA -cPl/uSkZP42Als+9YMoFPU/xrrDPbUhu72EDrj3Bllnyb168jKLa4VBOccUvggxr -Dm08I1hgYgdN5huzs7y6GeUCgYEAj+AZJSOJ6o1aXS6rfV3mMRve9bQ9yt8jcKXw -5HhOCEmMtaSKfnOF1Ziih34Sxsb7O2428DiX0mV/YHtBnPsAJidL0SdLWIapBzeg -KHArByIRkwE6IvJvwpGMdaex1PIGhx5i/3VZL9qiq/ElT05PhIb+UXgoWMabCp84 -OgxDK20CgYAeaFo8BdQ7FmVX2+EEejF+8xSge6WVLtkaon8bqcn6P0O8lLypoOhd -mJAYH8WU+UAy9pecUnDZj14LAGNVmYcse8HFX71MoshnvCTFEPVo4rZxIAGwMpeJ -5jgQ3slYLpqrGlcbLgUXBUgzEO684Wk/UV9DFPlHALVqCfXQ9dpJPg== ------END RSA PRIVATE KEY-----`) - -func TestJWTFetch_JSONResponse(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{ - "access_token": "90d64460d14870c08c81352a05dedd3465940a7c", - "scope": "user", - "token_type": "bearer", - "expires_in": 3600 - }`)) - })) - defer ts.Close() - - conf := &Config{ - Email: "aaa@xxx.com", - PrivateKey: dummyPrivateKey, - TokenURL: ts.URL, - } - tok, err := conf.TokenSource(oauth2.NoContext).Token() - if err != nil { - t.Fatal(err) - } - if !tok.Valid() { - t.Errorf("Token invalid") - } - if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" { - t.Errorf("Unexpected access token, %#v", tok.AccessToken) - } - if tok.TokenType != "bearer" { - t.Errorf("Unexpected token type, %#v", tok.TokenType) - } - if tok.Expiry.IsZero() { - t.Errorf("Unexpected token expiry, %#v", tok.Expiry) - } - scope := tok.Extra("scope") - if scope != "user" { - t.Errorf("Unexpected value for scope: %v", scope) - } -} - -func TestJWTFetch_BadResponse(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"scope": "user", "token_type": "bearer"}`)) - })) - defer ts.Close() - - conf := &Config{ - Email: "aaa@xxx.com", - PrivateKey: dummyPrivateKey, - TokenURL: ts.URL, - } - tok, err := conf.TokenSource(oauth2.NoContext).Token() - if err != nil { - t.Fatal(err) - } - if tok == nil { - t.Fatalf("token is nil") - } - if tok.Valid() { - t.Errorf("token is valid. want invalid.") - } - if tok.AccessToken != "" { - t.Errorf("Unexpected non-empty access token %q.", tok.AccessToken) - } - if want := "bearer"; tok.TokenType != want { - t.Errorf("TokenType = %q; want %q", tok.TokenType, want) - } - scope := tok.Extra("scope") - if want := "user"; scope != want { - t.Errorf("token scope = %q; want %q", scope, want) - } -} - -func TestJWTFetch_BadResponseType(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"access_token":123, "scope": "user", "token_type": "bearer"}`)) - })) - defer ts.Close() - conf := &Config{ - Email: "aaa@xxx.com", - PrivateKey: dummyPrivateKey, - TokenURL: ts.URL, - } - tok, err := conf.TokenSource(oauth2.NoContext).Token() - if err == nil { - t.Error("got a token; expected error") - if tok.AccessToken != "" { - t.Errorf("Unexpected access token, %#v.", tok.AccessToken) - } - } -} diff --git a/vendor/golang.org/x/oauth2/linkedin/linkedin.go b/vendor/golang.org/x/oauth2/linkedin/linkedin.go deleted file mode 100644 index de91d5b9400..00000000000 --- a/vendor/golang.org/x/oauth2/linkedin/linkedin.go +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package linkedin provides constants for using OAuth2 to access LinkedIn. -package linkedin // import "golang.org/x/oauth2/linkedin" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is LinkedIn's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://www.linkedin.com/uas/oauth2/authorization", - TokenURL: "https://www.linkedin.com/uas/oauth2/accessToken", -} diff --git a/vendor/golang.org/x/oauth2/oauth2.go b/vendor/golang.org/x/oauth2/oauth2.go index 0c6a1ed980d..3e4835d7e95 100644 --- a/vendor/golang.org/x/oauth2/oauth2.go +++ b/vendor/golang.org/x/oauth2/oauth2.go @@ -1,4 +1,4 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. +// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. @@ -9,28 +9,38 @@ package oauth2 // import "golang.org/x/oauth2" import ( "bytes" - "encoding/json" "errors" - "fmt" - "io" - "io/ioutil" - "mime" "net/http" "net/url" - "strconv" "strings" "sync" - "time" "golang.org/x/net/context" + "golang.org/x/oauth2/internal" ) // NoContext is the default context you should supply if not using // your own context.Context (see https://golang.org/x/net/context). +// +// Deprecated: Use context.Background() or context.TODO() instead. var NoContext = context.TODO() +// RegisterBrokenAuthHeaderProvider registers an OAuth2 server +// identified by the tokenURL prefix as an OAuth2 implementation +// which doesn't support the HTTP Basic authentication +// scheme to authenticate with the authorization server. +// Once a server is registered, credentials (client_id and client_secret) +// will be passed as query parameters rather than being present +// in the Authorization header. +// See https://code.google.com/p/goauth2/issues/detail?id=31 for background. +func RegisterBrokenAuthHeaderProvider(tokenURL string) { + internal.RegisterBrokenAuthHeaderProvider(tokenURL) +} + // Config describes a typical 3-legged OAuth2 flow, with both the // client application information and the server's endpoint URLs. +// For the client credentials 2-legged OAuth2 flow, see the clientcredentials +// package (https://golang.org/x/oauth2/clientcredentials). type Config struct { // ClientID is the application's ID. ClientID string @@ -79,13 +89,13 @@ var ( // result in your application obtaining a refresh token the // first time your application exchanges an authorization // code for a user. - AccessTypeOnline AuthCodeOption = SetParam("access_type", "online") - AccessTypeOffline AuthCodeOption = SetParam("access_type", "offline") + AccessTypeOnline AuthCodeOption = SetAuthURLParam("access_type", "online") + AccessTypeOffline AuthCodeOption = SetAuthURLParam("access_type", "offline") // ApprovalForce forces the users to view the consent dialog // and confirm the permissions request at the URL returned // from AuthCodeURL, even if they've already done so. - ApprovalForce AuthCodeOption = SetParam("approval_prompt", "force") + ApprovalForce AuthCodeOption = SetAuthURLParam("approval_prompt", "force") ) // An AuthCodeOption is passed to Config.AuthCodeURL. @@ -97,9 +107,9 @@ type setParam struct{ k, v string } func (p setParam) setValue(m url.Values) { m.Set(p.k, p.v) } -// SetParam builds an AuthCodeOption which passes key/value parameters +// SetAuthURLParam builds an AuthCodeOption which passes key/value parameters // to a provider's authorization endpoint. -func SetParam(key, value string) AuthCodeOption { +func SetAuthURLParam(key, value string) AuthCodeOption { return setParam{key, value} } @@ -119,9 +129,9 @@ func (c *Config) AuthCodeURL(state string, opts ...AuthCodeOption) string { v := url.Values{ "response_type": {"code"}, "client_id": {c.ClientID}, - "redirect_uri": condVal(c.RedirectURL), - "scope": condVal(strings.Join(c.Scopes, " ")), - "state": condVal(state), + "redirect_uri": internal.CondVal(c.RedirectURL), + "scope": internal.CondVal(strings.Join(c.Scopes, " ")), + "state": internal.CondVal(state), } for _, opt := range opts { opt.setValue(v) @@ -151,7 +161,7 @@ func (c *Config) PasswordCredentialsToken(ctx context.Context, username, passwor "grant_type": {"password"}, "username": {username}, "password": {password}, - "scope": condVal(strings.Join(c.Scopes, " ")), + "scope": internal.CondVal(strings.Join(c.Scopes, " ")), }) } @@ -169,51 +179,10 @@ func (c *Config) Exchange(ctx context.Context, code string) (*Token, error) { return retrieveToken(ctx, c, url.Values{ "grant_type": {"authorization_code"}, "code": {code}, - "redirect_uri": condVal(c.RedirectURL), - "scope": condVal(strings.Join(c.Scopes, " ")), + "redirect_uri": internal.CondVal(c.RedirectURL), }) } -// contextClientFunc is a func which tries to return an *http.Client -// given a Context value. If it returns an error, the search stops -// with that error. If it returns (nil, nil), the search continues -// down the list of registered funcs. -type contextClientFunc func(context.Context) (*http.Client, error) - -var contextClientFuncs []contextClientFunc - -func registerContextClientFunc(fn contextClientFunc) { - contextClientFuncs = append(contextClientFuncs, fn) -} - -func contextClient(ctx context.Context) (*http.Client, error) { - for _, fn := range contextClientFuncs { - c, err := fn(ctx) - if err != nil { - return nil, err - } - if c != nil { - return c, nil - } - } - if hc, ok := ctx.Value(HTTPClient).(*http.Client); ok { - return hc, nil - } - return http.DefaultClient, nil -} - -func contextTransport(ctx context.Context) http.RoundTripper { - hc, err := contextClient(ctx) - if err != nil { - // This is a rare error case (somebody using nil on App Engine), - // so I'd rather not everybody do an error check on this Client - // method. They can get the error that they're doing it wrong - // later, at client.Get/PostForm time. - return errorTransport{err} - } - return hc.Transport -} - // Client returns an HTTP client using the provided token. // The token will auto-refresh as necessary. The underlying // HTTP transport will be obtained using the provided context. @@ -299,177 +268,25 @@ func (s *reuseTokenSource) Token() (*Token, error) { return t, nil } -func retrieveToken(ctx context.Context, c *Config, v url.Values) (*Token, error) { - hc, err := contextClient(ctx) - if err != nil { - return nil, err - } - v.Set("client_id", c.ClientID) - bustedAuth := !providerAuthHeaderWorks(c.Endpoint.TokenURL) - if bustedAuth && c.ClientSecret != "" { - v.Set("client_secret", c.ClientSecret) - } - req, err := http.NewRequest("POST", c.Endpoint.TokenURL, strings.NewReader(v.Encode())) - if err != nil { - return nil, err - } - req.Header.Set("Content-Type", "application/x-www-form-urlencoded") - if !bustedAuth { - req.SetBasicAuth(c.ClientID, c.ClientSecret) - } - r, err := hc.Do(req) - if err != nil { - return nil, err - } - defer r.Body.Close() - body, err := ioutil.ReadAll(io.LimitReader(r.Body, 1<<20)) - if err != nil { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v", err) - } - if code := r.StatusCode; code < 200 || code > 299 { - return nil, fmt.Errorf("oauth2: cannot fetch token: %v\nResponse: %s", r.Status, body) - } - - var token *Token - content, _, _ := mime.ParseMediaType(r.Header.Get("Content-Type")) - switch content { - case "application/x-www-form-urlencoded", "text/plain": - vals, err := url.ParseQuery(string(body)) - if err != nil { - return nil, err - } - token = &Token{ - AccessToken: vals.Get("access_token"), - TokenType: vals.Get("token_type"), - RefreshToken: vals.Get("refresh_token"), - raw: vals, - } - e := vals.Get("expires_in") - if e == "" { - // TODO(jbd): Facebook's OAuth2 implementation is broken and - // returns expires_in field in expires. Remove the fallback to expires, - // when Facebook fixes their implementation. - e = vals.Get("expires") - } - expires, _ := strconv.Atoi(e) - if expires != 0 { - token.Expiry = time.Now().Add(time.Duration(expires) * time.Second) - } - default: - var tj tokenJSON - if err = json.Unmarshal(body, &tj); err != nil { - return nil, err - } - token = &Token{ - AccessToken: tj.AccessToken, - TokenType: tj.TokenType, - RefreshToken: tj.RefreshToken, - Expiry: tj.expiry(), - raw: make(map[string]interface{}), - } - json.Unmarshal(body, &token.raw) // no error checks for optional fields - } - // Don't overwrite `RefreshToken` with an empty value - // if this was a token refreshing request. - if token.RefreshToken == "" { - token.RefreshToken = v.Get("refresh_token") - } - return token, nil +// StaticTokenSource returns a TokenSource that always returns the same token. +// Because the provided token t is never refreshed, StaticTokenSource is only +// useful for tokens that never expire. +func StaticTokenSource(t *Token) TokenSource { + return staticTokenSource{t} } -// tokenJSON is the struct representing the HTTP response from OAuth2 -// providers returning a token in JSON form. -type tokenJSON struct { - AccessToken string `json:"access_token"` - TokenType string `json:"token_type"` - RefreshToken string `json:"refresh_token"` - ExpiresIn expirationTime `json:"expires_in"` // at least PayPal returns string, while most return number - Expires expirationTime `json:"expires"` // broken Facebook spelling of expires_in +// staticTokenSource is a TokenSource that always returns the same Token. +type staticTokenSource struct { + t *Token } -func (e *tokenJSON) expiry() (t time.Time) { - if v := e.ExpiresIn; v != 0 { - return time.Now().Add(time.Duration(v) * time.Second) - } - if v := e.Expires; v != 0 { - return time.Now().Add(time.Duration(v) * time.Second) - } - return -} - -type expirationTime int32 - -func (e *expirationTime) UnmarshalJSON(b []byte) error { - var n json.Number - err := json.Unmarshal(b, &n) - if err != nil { - return err - } - i, err := n.Int64() - if err != nil { - return err - } - *e = expirationTime(i) - return nil -} - -func condVal(v string) []string { - if v == "" { - return nil - } - return []string{v} -} - -var brokenAuthHeaderProviders = []string{ - "https://accounts.google.com/", - "https://www.googleapis.com/", - "https://github.com/", - "https://api.instagram.com/", - "https://www.douban.com/", - "https://api.dropbox.com/", - "https://api.soundcloud.com/", - "https://www.linkedin.com/", - "https://api.twitch.tv/", - "https://oauth.vk.com/", - "https://api.odnoklassniki.ru/", - "https://connect.stripe.com/", - "https://api.pushbullet.com/", - "https://oauth.sandbox.trainingpeaks.com/", - "https://oauth.trainingpeaks.com/", - "https://www.strava.com/oauth/", -} - -// providerAuthHeaderWorks reports whether the OAuth2 server identified by the tokenURL -// implements the OAuth2 spec correctly -// See https://code.google.com/p/goauth2/issues/detail?id=31 for background. -// In summary: -// - Reddit only accepts client secret in the Authorization header -// - Dropbox accepts either it in URL param or Auth header, but not both. -// - Google only accepts URL param (not spec compliant?), not Auth header -// - Stripe only accepts client secret in Auth header with Bearer method, not Basic -func providerAuthHeaderWorks(tokenURL string) bool { - for _, s := range brokenAuthHeaderProviders { - if strings.HasPrefix(tokenURL, s) { - // Some sites fail to implement the OAuth2 spec fully. - return false - } - } - - // Assume the provider implements the spec properly - // otherwise. We can add more exceptions as they're - // discovered. We will _not_ be adding configurable hooks - // to this package to let users select server bugs. - return true +func (s staticTokenSource) Token() (*Token, error) { + return s.t, nil } // HTTPClient is the context key to use with golang.org/x/net/context's // WithValue function to associate an *http.Client value with a context. -var HTTPClient contextKey - -// contextKey is just an empty struct. It exists so HTTPClient can be -// an immutable public variable with a unique type. It's immutable -// because nobody else can create a contextKey, being unexported. -type contextKey struct{} +var HTTPClient internal.ContextKey // NewClient creates an *http.Client from a Context and TokenSource. // The returned client is not valid beyond the lifetime of the context. @@ -479,15 +296,15 @@ type contextKey struct{} // packages. func NewClient(ctx context.Context, src TokenSource) *http.Client { if src == nil { - c, err := contextClient(ctx) + c, err := internal.ContextClient(ctx) if err != nil { - return &http.Client{Transport: errorTransport{err}} + return &http.Client{Transport: internal.ErrorTransport{Err: err}} } return c } return &http.Client{ Transport: &Transport{ - Base: contextTransport(ctx), + Base: internal.ContextTransport(ctx), Source: ReuseTokenSource(nil, src), }, } diff --git a/vendor/golang.org/x/oauth2/oauth2_test.go b/vendor/golang.org/x/oauth2/oauth2_test.go deleted file mode 100644 index 0bc612934cc..00000000000 --- a/vendor/golang.org/x/oauth2/oauth2_test.go +++ /dev/null @@ -1,439 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package oauth2 - -import ( - "encoding/json" - "errors" - "fmt" - "io/ioutil" - "net/http" - "net/http/httptest" - "reflect" - "strconv" - "testing" - "time" - - "golang.org/x/net/context" -) - -type mockTransport struct { - rt func(req *http.Request) (resp *http.Response, err error) -} - -func (t *mockTransport) RoundTrip(req *http.Request) (resp *http.Response, err error) { - return t.rt(req) -} - -type mockCache struct { - token *Token - readErr error -} - -func (c *mockCache) ReadToken() (*Token, error) { - return c.token, c.readErr -} - -func (c *mockCache) WriteToken(*Token) { - // do nothing -} - -func newConf(url string) *Config { - return &Config{ - ClientID: "CLIENT_ID", - ClientSecret: "CLIENT_SECRET", - RedirectURL: "REDIRECT_URL", - Scopes: []string{"scope1", "scope2"}, - Endpoint: Endpoint{ - AuthURL: url + "/auth", - TokenURL: url + "/token", - }, - } -} - -func TestAuthCodeURL(t *testing.T) { - conf := newConf("server") - url := conf.AuthCodeURL("foo", AccessTypeOffline, ApprovalForce) - if url != "server/auth?access_type=offline&approval_prompt=force&client_id=CLIENT_ID&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=foo" { - t.Errorf("Auth code URL doesn't match the expected, found: %v", url) - } -} - -func TestAuthCodeURL_CustomParam(t *testing.T) { - conf := newConf("server") - param := SetParam("foo", "bar") - url := conf.AuthCodeURL("baz", param) - if url != "server/auth?client_id=CLIENT_ID&foo=bar&redirect_uri=REDIRECT_URL&response_type=code&scope=scope1+scope2&state=baz" { - t.Errorf("Auth code URL doesn't match the expected, found: %v", url) - } -} - -func TestAuthCodeURL_Optional(t *testing.T) { - conf := &Config{ - ClientID: "CLIENT_ID", - Endpoint: Endpoint{ - AuthURL: "/auth-url", - TokenURL: "/token-url", - }, - } - url := conf.AuthCodeURL("") - if url != "/auth-url?client_id=CLIENT_ID&response_type=code" { - t.Fatalf("Auth code URL doesn't match the expected, found: %v", url) - } -} - -func TestExchangeRequest(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.URL.String() != "/token" { - t.Errorf("Unexpected exchange request URL, %v is found.", r.URL) - } - headerAuth := r.Header.Get("Authorization") - if headerAuth != "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" { - t.Errorf("Unexpected authorization header, %v is found.", headerAuth) - } - headerContentType := r.Header.Get("Content-Type") - if headerContentType != "application/x-www-form-urlencoded" { - t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType) - } - body, err := ioutil.ReadAll(r.Body) - if err != nil { - t.Errorf("Failed reading request body: %s.", err) - } - if string(body) != "client_id=CLIENT_ID&code=exchange-code&grant_type=authorization_code&redirect_uri=REDIRECT_URL&scope=scope1+scope2" { - t.Errorf("Unexpected exchange payload, %v is found.", string(body)) - } - w.Header().Set("Content-Type", "application/x-www-form-urlencoded") - w.Write([]byte("access_token=90d64460d14870c08c81352a05dedd3465940a7c&scope=user&token_type=bearer")) - })) - defer ts.Close() - conf := newConf(ts.URL) - tok, err := conf.Exchange(NoContext, "exchange-code") - if err != nil { - t.Error(err) - } - if !tok.Valid() { - t.Fatalf("Token invalid. Got: %#v", tok) - } - if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" { - t.Errorf("Unexpected access token, %#v.", tok.AccessToken) - } - if tok.TokenType != "bearer" { - t.Errorf("Unexpected token type, %#v.", tok.TokenType) - } - scope := tok.Extra("scope") - if scope != "user" { - t.Errorf("Unexpected value for scope: %v", scope) - } -} - -func TestExchangeRequest_JSONResponse(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.URL.String() != "/token" { - t.Errorf("Unexpected exchange request URL, %v is found.", r.URL) - } - headerAuth := r.Header.Get("Authorization") - if headerAuth != "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" { - t.Errorf("Unexpected authorization header, %v is found.", headerAuth) - } - headerContentType := r.Header.Get("Content-Type") - if headerContentType != "application/x-www-form-urlencoded" { - t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType) - } - body, err := ioutil.ReadAll(r.Body) - if err != nil { - t.Errorf("Failed reading request body: %s.", err) - } - if string(body) != "client_id=CLIENT_ID&code=exchange-code&grant_type=authorization_code&redirect_uri=REDIRECT_URL&scope=scope1+scope2" { - t.Errorf("Unexpected exchange payload, %v is found.", string(body)) - } - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"access_token": "90d64460d14870c08c81352a05dedd3465940a7c", "scope": "user", "token_type": "bearer", "expires_in": 86400}`)) - })) - defer ts.Close() - conf := newConf(ts.URL) - tok, err := conf.Exchange(NoContext, "exchange-code") - if err != nil { - t.Error(err) - } - if !tok.Valid() { - t.Fatalf("Token invalid. Got: %#v", tok) - } - if tok.AccessToken != "90d64460d14870c08c81352a05dedd3465940a7c" { - t.Errorf("Unexpected access token, %#v.", tok.AccessToken) - } - if tok.TokenType != "bearer" { - t.Errorf("Unexpected token type, %#v.", tok.TokenType) - } - scope := tok.Extra("scope") - if scope != "user" { - t.Errorf("Unexpected value for scope: %v", scope) - } -} - -const day = 24 * time.Hour - -func TestExchangeRequest_JSONResponse_Expiry(t *testing.T) { - seconds := int32(day.Seconds()) - jsonNumberType := reflect.TypeOf(json.Number("0")) - for _, c := range []struct { - expires string - expect error - }{ - {fmt.Sprintf(`"expires_in": %d`, seconds), nil}, - {fmt.Sprintf(`"expires_in": "%d"`, seconds), nil}, // PayPal case - {fmt.Sprintf(`"expires": %d`, seconds), nil}, // Facebook case - {`"expires": false`, &json.UnmarshalTypeError{Value: "bool", Type: jsonNumberType}}, // wrong type - {`"expires": {}`, &json.UnmarshalTypeError{Value: "object", Type: jsonNumberType}}, // wrong type - {`"expires": "zzz"`, &strconv.NumError{Func: "ParseInt", Num: "zzz", Err: strconv.ErrSyntax}}, // wrong value - } { - testExchangeRequest_JSONResponse_expiry(t, c.expires, c.expect) - } -} - -func testExchangeRequest_JSONResponse_expiry(t *testing.T, exp string, expect error) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(fmt.Sprintf(`{"access_token": "90d", "scope": "user", "token_type": "bearer", %s}`, exp))) - })) - defer ts.Close() - conf := newConf(ts.URL) - t1 := time.Now().Add(day) - tok, err := conf.Exchange(NoContext, "exchange-code") - t2 := time.Now().Add(day) - // Do a fmt.Sprint comparison so either side can be - // nil. fmt.Sprint just stringifies them to "", and no - // non-nil expected error ever stringifies as "", so this - // isn't terribly disgusting. We do this because Go 1.4 and - // Go 1.5 return a different deep value for - // json.UnmarshalTypeError. In Go 1.5, the - // json.UnmarshalTypeError contains a new field with a new - // non-zero value. Rather than ignore it here with reflect or - // add new files and +build tags, just look at the strings. - if fmt.Sprint(err) != fmt.Sprint(expect) { - t.Errorf("Error = %v; want %v", err, expect) - } - if err != nil { - return - } - if !tok.Valid() { - t.Fatalf("Token invalid. Got: %#v", tok) - } - expiry := tok.Expiry - if expiry.Before(t1) || expiry.After(t2) { - t.Errorf("Unexpected value for Expiry: %v (shold be between %v and %v)", expiry, t1, t2) - } -} - -func TestExchangeRequest_BadResponse(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"scope": "user", "token_type": "bearer"}`)) - })) - defer ts.Close() - conf := newConf(ts.URL) - tok, err := conf.Exchange(NoContext, "code") - if err != nil { - t.Fatal(err) - } - if tok.AccessToken != "" { - t.Errorf("Unexpected access token, %#v.", tok.AccessToken) - } -} - -func TestExchangeRequest_BadResponseType(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"access_token":123, "scope": "user", "token_type": "bearer"}`)) - })) - defer ts.Close() - conf := newConf(ts.URL) - _, err := conf.Exchange(NoContext, "exchange-code") - if err == nil { - t.Error("expected error from invalid access_token type") - } -} - -func TestExchangeRequest_NonBasicAuth(t *testing.T) { - tr := &mockTransport{ - rt: func(r *http.Request) (w *http.Response, err error) { - headerAuth := r.Header.Get("Authorization") - if headerAuth != "" { - t.Errorf("Unexpected authorization header, %v is found.", headerAuth) - } - return nil, errors.New("no response") - }, - } - c := &http.Client{Transport: tr} - conf := &Config{ - ClientID: "CLIENT_ID", - Endpoint: Endpoint{ - AuthURL: "https://accounts.google.com/auth", - TokenURL: "https://accounts.google.com/token", - }, - } - - ctx := context.WithValue(context.Background(), HTTPClient, c) - conf.Exchange(ctx, "code") -} - -func TestPasswordCredentialsTokenRequest(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - defer r.Body.Close() - expected := "/token" - if r.URL.String() != expected { - t.Errorf("URL = %q; want %q", r.URL, expected) - } - headerAuth := r.Header.Get("Authorization") - expected = "Basic Q0xJRU5UX0lEOkNMSUVOVF9TRUNSRVQ=" - if headerAuth != expected { - t.Errorf("Authorization header = %q; want %q", headerAuth, expected) - } - headerContentType := r.Header.Get("Content-Type") - expected = "application/x-www-form-urlencoded" - if headerContentType != expected { - t.Errorf("Content-Type header = %q; want %q", headerContentType, expected) - } - body, err := ioutil.ReadAll(r.Body) - if err != nil { - t.Errorf("Failed reading request body: %s.", err) - } - expected = "client_id=CLIENT_ID&grant_type=password&password=password1&scope=scope1+scope2&username=user1" - if string(body) != expected { - t.Errorf("res.Body = %q; want %q", string(body), expected) - } - w.Header().Set("Content-Type", "application/x-www-form-urlencoded") - w.Write([]byte("access_token=90d64460d14870c08c81352a05dedd3465940a7c&scope=user&token_type=bearer")) - })) - defer ts.Close() - conf := newConf(ts.URL) - tok, err := conf.PasswordCredentialsToken(NoContext, "user1", "password1") - if err != nil { - t.Error(err) - } - if !tok.Valid() { - t.Fatalf("Token invalid. Got: %#v", tok) - } - expected := "90d64460d14870c08c81352a05dedd3465940a7c" - if tok.AccessToken != expected { - t.Errorf("AccessToken = %q; want %q", tok.AccessToken, expected) - } - expected = "bearer" - if tok.TokenType != expected { - t.Errorf("TokenType = %q; want %q", tok.TokenType, expected) - } -} - -func TestTokenRefreshRequest(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.URL.String() == "/somethingelse" { - return - } - if r.URL.String() != "/token" { - t.Errorf("Unexpected token refresh request URL, %v is found.", r.URL) - } - headerContentType := r.Header.Get("Content-Type") - if headerContentType != "application/x-www-form-urlencoded" { - t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType) - } - body, _ := ioutil.ReadAll(r.Body) - if string(body) != "client_id=CLIENT_ID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN" { - t.Errorf("Unexpected refresh token payload, %v is found.", string(body)) - } - })) - defer ts.Close() - conf := newConf(ts.URL) - c := conf.Client(NoContext, &Token{RefreshToken: "REFRESH_TOKEN"}) - c.Get(ts.URL + "/somethingelse") -} - -func TestFetchWithNoRefreshToken(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if r.URL.String() == "/somethingelse" { - return - } - if r.URL.String() != "/token" { - t.Errorf("Unexpected token refresh request URL, %v is found.", r.URL) - } - headerContentType := r.Header.Get("Content-Type") - if headerContentType != "application/x-www-form-urlencoded" { - t.Errorf("Unexpected Content-Type header, %v is found.", headerContentType) - } - body, _ := ioutil.ReadAll(r.Body) - if string(body) != "client_id=CLIENT_ID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN" { - t.Errorf("Unexpected refresh token payload, %v is found.", string(body)) - } - })) - defer ts.Close() - conf := newConf(ts.URL) - c := conf.Client(NoContext, nil) - _, err := c.Get(ts.URL + "/somethingelse") - if err == nil { - t.Errorf("Fetch should return an error if no refresh token is set") - } -} - -func TestRefreshToken_RefreshTokenReplacement(t *testing.T) { - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - w.Header().Set("Content-Type", "application/json") - w.Write([]byte(`{"access_token":"ACCESS TOKEN", "scope": "user", "token_type": "bearer", "refresh_token": "NEW REFRESH TOKEN"}`)) - return - })) - defer ts.Close() - conf := newConf(ts.URL) - tkr := tokenRefresher{ - conf: conf, - ctx: NoContext, - refreshToken: "OLD REFRESH TOKEN", - } - tk, err := tkr.Token() - if err != nil { - t.Errorf("Unexpected refreshToken error returned: %v", err) - return - } - if tk.RefreshToken != tkr.refreshToken { - t.Errorf("tokenRefresher.refresh_token = %s; want %s", tkr.refreshToken, tk.RefreshToken) - } -} - -func TestConfigClientWithToken(t *testing.T) { - tok := &Token{ - AccessToken: "abc123", - } - ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if got, want := r.Header.Get("Authorization"), fmt.Sprintf("Bearer %s", tok.AccessToken); got != want { - t.Errorf("Authorization header = %q; want %q", got, want) - } - return - })) - defer ts.Close() - conf := newConf(ts.URL) - - c := conf.Client(NoContext, tok) - req, err := http.NewRequest("GET", ts.URL, nil) - if err != nil { - t.Error(err) - } - _, err = c.Do(req) - if err != nil { - t.Error(err) - } -} - -func Test_providerAuthHeaderWorks(t *testing.T) { - for _, p := range brokenAuthHeaderProviders { - if providerAuthHeaderWorks(p) { - t.Errorf("URL: %s not found in list", p) - } - p := fmt.Sprintf("%ssomesuffix", p) - if providerAuthHeaderWorks(p) { - t.Errorf("URL: %s not found in list", p) - } - } - p := "https://api.not-in-the-list-example.com/" - if !providerAuthHeaderWorks(p) { - t.Errorf("URL: %s found in list", p) - } - -} diff --git a/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go b/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go deleted file mode 100644 index 2f7a9621e48..00000000000 --- a/vendor/golang.org/x/oauth2/odnoklassniki/odnoklassniki.go +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package odnoklassniki provides constants for using OAuth2 to access Odnoklassniki. -package odnoklassniki // import "golang.org/x/oauth2/odnoklassniki" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is Odnoklassniki's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://www.odnoklassniki.ru/oauth/authorize", - TokenURL: "https://api.odnoklassniki.ru/oauth/token.do", -} diff --git a/vendor/golang.org/x/oauth2/paypal/paypal.go b/vendor/golang.org/x/oauth2/paypal/paypal.go deleted file mode 100644 index baeaa237276..00000000000 --- a/vendor/golang.org/x/oauth2/paypal/paypal.go +++ /dev/null @@ -1,22 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package paypal provides constants for using OAuth2 to access PayPal. -package paypal // import "golang.org/x/oauth2/paypal" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is PayPal's OAuth 2.0 endpoint in live (production) environment. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://www.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize", - TokenURL: "https://api.paypal.com/v1/identity/openidconnect/tokenservice", -} - -// SandboxEndpoint is PayPal's OAuth 2.0 endpoint in sandbox (testing) environment. -var SandboxEndpoint = oauth2.Endpoint{ - AuthURL: "https://www.sandbox.paypal.com/webapps/auth/protocol/openidconnect/v1/authorize", - TokenURL: "https://api.sandbox.paypal.com/v1/identity/openidconnect/tokenservice", -} diff --git a/vendor/golang.org/x/oauth2/token.go b/vendor/golang.org/x/oauth2/token.go index 9852ceb4a6a..7a3167f15b0 100644 --- a/vendor/golang.org/x/oauth2/token.go +++ b/vendor/golang.org/x/oauth2/token.go @@ -1,4 +1,4 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. +// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. @@ -7,7 +7,12 @@ package oauth2 import ( "net/http" "net/url" + "strconv" + "strings" "time" + + "golang.org/x/net/context" + "golang.org/x/oauth2/internal" ) // expiryDelta determines how earlier a token should be considered @@ -50,6 +55,15 @@ type Token struct { // Type returns t.TokenType if non-empty, else "Bearer". func (t *Token) Type() string { + if strings.EqualFold(t.TokenType, "bearer") { + return "Bearer" + } + if strings.EqualFold(t.TokenType, "mac") { + return "MAC" + } + if strings.EqualFold(t.TokenType, "basic") { + return "Basic" + } if t.TokenType != "" { return t.TokenType } @@ -79,14 +93,28 @@ func (t *Token) WithExtra(extra interface{}) *Token { // Extra fields are key-value pairs returned by the server as a // part of the token retrieval response. func (t *Token) Extra(key string) interface{} { - if vals, ok := t.raw.(url.Values); ok { - // TODO(jbd): Cast numeric values to int64 or float64. - return vals.Get(key) - } if raw, ok := t.raw.(map[string]interface{}); ok { return raw[key] } - return nil + + vals, ok := t.raw.(url.Values) + if !ok { + return nil + } + + v := vals.Get(key) + switch s := strings.TrimSpace(v); strings.Count(s, ".") { + case 0: // Contains no "."; try to parse as int + if i, err := strconv.ParseInt(s, 10, 64); err == nil { + return i + } + case 1: // Contains a single "."; try to parse as float + if f, err := strconv.ParseFloat(s, 64); err == nil { + return f + } + } + + return v } // expired reports whether the token is expired. @@ -102,3 +130,29 @@ func (t *Token) expired() bool { func (t *Token) Valid() bool { return t != nil && t.AccessToken != "" && !t.expired() } + +// tokenFromInternal maps an *internal.Token struct into +// a *Token struct. +func tokenFromInternal(t *internal.Token) *Token { + if t == nil { + return nil + } + return &Token{ + AccessToken: t.AccessToken, + TokenType: t.TokenType, + RefreshToken: t.RefreshToken, + Expiry: t.Expiry, + raw: t.Raw, + } +} + +// retrieveToken takes a *Config and uses that to retrieve an *internal.Token. +// This token is then mapped from *internal.Token into an *oauth2.Token which is returned along +// with an error.. +func retrieveToken(ctx context.Context, c *Config, v url.Values) (*Token, error) { + tk, err := internal.RetrieveToken(ctx, c.ClientID, c.ClientSecret, c.Endpoint.TokenURL, v) + if err != nil { + return nil, err + } + return tokenFromInternal(tk), nil +} diff --git a/vendor/golang.org/x/oauth2/token_test.go b/vendor/golang.org/x/oauth2/token_test.go deleted file mode 100644 index 739eeb2a205..00000000000 --- a/vendor/golang.org/x/oauth2/token_test.go +++ /dev/null @@ -1,50 +0,0 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -package oauth2 - -import ( - "testing" - "time" -) - -func TestTokenExtra(t *testing.T) { - type testCase struct { - key string - val interface{} - want interface{} - } - const key = "extra-key" - cases := []testCase{ - {key: key, val: "abc", want: "abc"}, - {key: key, val: 123, want: 123}, - {key: key, val: "", want: ""}, - {key: "other-key", val: "def", want: nil}, - } - for _, tc := range cases { - extra := make(map[string]interface{}) - extra[tc.key] = tc.val - tok := &Token{raw: extra} - if got, want := tok.Extra(key), tc.want; got != want { - t.Errorf("Extra(%q) = %q; want %q", key, got, want) - } - } -} - -func TestTokenExpiry(t *testing.T) { - now := time.Now() - cases := []struct { - name string - tok *Token - want bool - }{ - {name: "12 seconds", tok: &Token{Expiry: now.Add(12 * time.Second)}, want: false}, - {name: "10 seconds", tok: &Token{Expiry: now.Add(expiryDelta)}, want: true}, - } - for _, tc := range cases { - if got, want := tc.tok.expired(), tc.want; got != want { - t.Errorf("expired (%q) = %v; want %v", tc.name, got, want) - } - } -} diff --git a/vendor/golang.org/x/oauth2/transport.go b/vendor/golang.org/x/oauth2/transport.go index 10339a0be7d..92ac7e2531f 100644 --- a/vendor/golang.org/x/oauth2/transport.go +++ b/vendor/golang.org/x/oauth2/transport.go @@ -1,4 +1,4 @@ -// Copyright 2014 The oauth2 Authors. All rights reserved. +// Copyright 2014 The Go Authors. All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. @@ -130,9 +130,3 @@ func (r *onEOFReader) runFunc() { r.fn = nil } } - -type errorTransport struct{ err error } - -func (t errorTransport) RoundTrip(*http.Request) (*http.Response, error) { - return nil, t.err -} diff --git a/vendor/golang.org/x/oauth2/transport_test.go b/vendor/golang.org/x/oauth2/transport_test.go deleted file mode 100644 index efb8232ac4c..00000000000 --- a/vendor/golang.org/x/oauth2/transport_test.go +++ /dev/null @@ -1,53 +0,0 @@ -package oauth2 - -import ( - "net/http" - "net/http/httptest" - "testing" - "time" -) - -type tokenSource struct{ token *Token } - -func (t *tokenSource) Token() (*Token, error) { - return t.token, nil -} - -func TestTransportTokenSource(t *testing.T) { - ts := &tokenSource{ - token: &Token{ - AccessToken: "abc", - }, - } - tr := &Transport{ - Source: ts, - } - server := newMockServer(func(w http.ResponseWriter, r *http.Request) { - if r.Header.Get("Authorization") != "Bearer abc" { - t.Errorf("Transport doesn't set the Authorization header from the fetched token") - } - }) - defer server.Close() - client := http.Client{Transport: tr} - client.Get(server.URL) -} - -func TestTokenValidNoAccessToken(t *testing.T) { - token := &Token{} - if token.Valid() { - t.Errorf("Token should not be valid with no access token") - } -} - -func TestExpiredWithExpiry(t *testing.T) { - token := &Token{ - Expiry: time.Now().Add(-5 * time.Hour), - } - if token.Valid() { - t.Errorf("Token should not be valid if it expired in the past") - } -} - -func newMockServer(handler func(w http.ResponseWriter, r *http.Request)) *httptest.Server { - return httptest.NewServer(http.HandlerFunc(handler)) -} diff --git a/vendor/golang.org/x/oauth2/vk/vk.go b/vendor/golang.org/x/oauth2/vk/vk.go deleted file mode 100644 index 5acdeb18ff1..00000000000 --- a/vendor/golang.org/x/oauth2/vk/vk.go +++ /dev/null @@ -1,16 +0,0 @@ -// Copyright 2015 The oauth2 Authors. All rights reserved. -// Use of this source code is governed by a BSD-style -// license that can be found in the LICENSE file. - -// Package vk provides constants for using OAuth2 to access VK.com. -package vk // import "golang.org/x/oauth2/vk" - -import ( - "golang.org/x/oauth2" -) - -// Endpoint is VK's OAuth 2.0 endpoint. -var Endpoint = oauth2.Endpoint{ - AuthURL: "https://oauth.vk.com/authorize", - TokenURL: "https://oauth.vk.com/access_token", -} diff --git a/vendor/vendor.json b/vendor/vendor.json index 75adf575b15..3cf4b731013 100644 --- a/vendor/vendor.json +++ b/vendor/vendor.json @@ -518,6 +518,18 @@ "revision": "4971afdc2f162e82d185353533d3cf16188a9f4e", "revisionTime": "2016-11-15T21:05:04Z" }, + { + "checksumSHA1": "SjCoL7KD7qBmgSuqGTCAuUhigDk=", + "path": "golang.org/x/oauth2", + "revision": "f047394b6d14284165300fd82dad67edb3a4d7f6", + "revisionTime": "2017-05-17T17:14:19Z" + }, + { + "checksumSHA1": "Umx4Fmn5FyXJyUVzKWhnQdvFNkc=", + "path": "golang.org/x/oauth2/internal", + "revision": "f047394b6d14284165300fd82dad67edb3a4d7f6", + "revisionTime": "2017-05-17T17:14:19Z" + }, { "checksumSHA1": "S0DP7Pn7sZUmXc55IzZnNvERu6s=", "path": "golang.org/x/sync/errgroup", From bab21c90693125e7482b6071bcda5c944b2fab95 Mon Sep 17 00:00:00 2001 From: Anton Yackushev Date: Mon, 5 Jun 2017 15:20:34 +0300 Subject: [PATCH 083/130] misspell: Corrected some misspelled words --- pkg/metrics/meter.go | 2 +- pkg/services/alerting/extractor.go | 2 +- pkg/services/alerting/notifiers/sensu.go | 2 +- pkg/services/sqlstore/sqlstore.go | 2 +- pkg/setting/setting.go | 6 +++--- pkg/setting/setting_test.go | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/pkg/metrics/meter.go b/pkg/metrics/meter.go index 8744a5cd040..265bff99cb6 100644 --- a/pkg/metrics/meter.go +++ b/pkg/metrics/meter.go @@ -124,7 +124,7 @@ func (m *StandardMeter) Count() int64 { return count } -// Mark records the occurance of n events. +// Mark records the occurrence of n events. func (m *StandardMeter) Mark(n int64) { m.lock.Lock() defer m.lock.Unlock() diff --git a/pkg/services/alerting/extractor.go b/pkg/services/alerting/extractor.go index 28a6b8c61a0..7f14e195799 100644 --- a/pkg/services/alerting/extractor.go +++ b/pkg/services/alerting/extractor.go @@ -89,7 +89,7 @@ func (e *DashAlertExtractor) GetAlerts() ([]*m.Alert, error) { continue } - // backward compatability check, can be removed later + // backward compatibility check, can be removed later enabled, hasEnabled := jsonAlert.CheckGet("enabled") if hasEnabled && enabled.MustBool() == false { continue diff --git a/pkg/services/alerting/notifiers/sensu.go b/pkg/services/alerting/notifiers/sensu.go index 0f2123eb9b8..00661f864b3 100644 --- a/pkg/services/alerting/notifiers/sensu.go +++ b/pkg/services/alerting/notifiers/sensu.go @@ -26,7 +26,7 @@ func init() {
        Source - +
        Handler diff --git a/pkg/services/sqlstore/sqlstore.go b/pkg/services/sqlstore/sqlstore.go index 848dd884323..7c267517b90 100644 --- a/pkg/services/sqlstore/sqlstore.go +++ b/pkg/services/sqlstore/sqlstore.go @@ -199,7 +199,7 @@ func LoadConfig() { if DbCfg.Type == "sqlite3" { UseSQLite3 = true - // only allow one connection as sqlite3 has multi threading issues that casue table locks + // only allow one connection as sqlite3 has multi threading issues that cause table locks // DbCfg.MaxIdleConn = 1 // DbCfg.MaxOpenConn = 1 } diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index 0e1740efdff..9ec995dd96e 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -306,7 +306,7 @@ func evalEnvVarExpression(value string) string { envVar = strings.TrimSuffix(envVar, "}") envValue := os.Getenv(envVar) - // if env variable is hostname and it is emtpy use os.Hostname as default + // if env variable is hostname and it is empty use os.Hostname as default if envVar == "HOSTNAME" && envValue == "" { envValue, _ = os.Hostname() } @@ -635,14 +635,14 @@ func LogConfigurationInfo() { if len(appliedCommandLineProperties) > 0 { for _, prop := range appliedCommandLineProperties { - logger.Info("Config overriden from command line", "arg", prop) + logger.Info("Config overridden from command line", "arg", prop) } } if len(appliedEnvOverrides) > 0 { text.WriteString("\tEnvironment variables used:\n") for _, prop := range appliedEnvOverrides { - logger.Info("Config overriden from Environment variable", "var", prop) + logger.Info("Config overridden from Environment variable", "var", prop) } } diff --git a/pkg/setting/setting_test.go b/pkg/setting/setting_test.go index 586cd8ff61d..b213c2795af 100644 --- a/pkg/setting/setting_test.go +++ b/pkg/setting/setting_test.go @@ -73,7 +73,7 @@ func TestLoadingSettings(t *testing.T) { So(Domain, ShouldEqual, "test2") }) - Convey("Defaults can be overriden in specified config file", func() { + Convey("Defaults can be overridden in specified config file", func() { NewConfigContext(&CommandLineArgs{ HomePath: "../../", Config: filepath.Join(HomePath, "tests/config-files/override.ini"), @@ -103,7 +103,7 @@ func TestLoadingSettings(t *testing.T) { So(DataPath, ShouldEqual, "/tmp/env_override") }) - Convey("instance_name default to hostname even if hostname env is emtpy", func() { + Convey("instance_name default to hostname even if hostname env is empty", func() { NewConfigContext(&CommandLineArgs{ HomePath: "../../", }) From fdfcd5cbf01c3257f90d473d27b75c54c5cee0dc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 14:56:11 +0200 Subject: [PATCH 084/130] refactoring:: dashboard save modal and save as modal needed an update --- public/app/core/services/backend_srv.ts | 8 +- public/app/features/dashboard/all.js | 5 +- .../app/features/dashboard/dash_list_ctrl.ts | 11 --- .../app/features/dashboard/dashboard_srv.ts | 19 ++-- .../app/features/dashboard/dashnav/dashnav.ts | 6 +- .../dashboard/partials/dash_list.html | 10 -- .../dashboard/partials/graphiteImport.html | 35 ------- .../dashboard/partials/saveDashboardAs.html | 27 ------ .../partials/saveDashboardMessage.html | 49 ---------- .../features/dashboard/saveDashboardAsCtrl.js | 39 -------- .../dashboard/saveDashboardMessageCtrl.js | 29 ------ .../app/features/dashboard/save_as_modal.ts | 79 +++++++++++++++ public/app/features/dashboard/save_modal.ts | 95 +++++++++++++++++++ 13 files changed, 193 insertions(+), 219 deletions(-) delete mode 100644 public/app/features/dashboard/dash_list_ctrl.ts delete mode 100644 public/app/features/dashboard/partials/dash_list.html delete mode 100644 public/app/features/dashboard/partials/graphiteImport.html delete mode 100644 public/app/features/dashboard/partials/saveDashboardAs.html delete mode 100644 public/app/features/dashboard/partials/saveDashboardMessage.html delete mode 100644 public/app/features/dashboard/saveDashboardAsCtrl.js delete mode 100644 public/app/features/dashboard/saveDashboardMessageCtrl.js create mode 100644 public/app/features/dashboard/save_as_modal.ts create mode 100644 public/app/features/dashboard/save_modal.ts diff --git a/public/app/core/services/backend_srv.ts b/public/app/core/services/backend_srv.ts index 2c3102f1811..cc1a8644a51 100644 --- a/public/app/core/services/backend_srv.ts +++ b/public/app/core/services/backend_srv.ts @@ -202,8 +202,12 @@ export class BackendSrv { saveDashboard(dash, options) { options = (options || {}); - const message = options.message || ''; - return this.post('/api/dashboards/db/', {dashboard: dash, overwrite: options.overwrite === true, message}); + + return this.post('/api/dashboards/db/', { + dashboard: dash, + overwrite: options.overwrite === true, + message: options.message || '', + }); } } diff --git a/public/app/features/dashboard/all.js b/public/app/features/dashboard/all.js index 4255651d6b4..9ca6f190c63 100644 --- a/public/app/features/dashboard/all.js +++ b/public/app/features/dashboard/all.js @@ -5,8 +5,8 @@ define([ './dashboardLoaderSrv', './dashnav/dashnav', './submenu/submenu', - './saveDashboardAsCtrl', - './saveDashboardMessageCtrl', + './save_as_modal', + './save_modal', './shareModalCtrl', './shareSnapshotCtrl', './dashboard_srv', @@ -20,7 +20,6 @@ define([ './import/dash_import', './export/export_modal', './export_data/export_data_modal', - './dash_list_ctrl', './ad_hoc_filters', './row/row_ctrl', './repeat_option/repeat_option', diff --git a/public/app/features/dashboard/dash_list_ctrl.ts b/public/app/features/dashboard/dash_list_ctrl.ts deleted file mode 100644 index f08d7507e65..00000000000 --- a/public/app/features/dashboard/dash_list_ctrl.ts +++ /dev/null @@ -1,11 +0,0 @@ -/// - -import coreModule from 'app/core/core_module'; - -export class DashListCtrl { - /** @ngInject */ - constructor() { - } -} - -coreModule.controller('DashListCtrl', DashListCtrl); diff --git a/public/app/features/dashboard/dashboard_srv.ts b/public/app/features/dashboard/dashboard_srv.ts index b075af7352e..30ba7defdfd 100644 --- a/public/app/features/dashboard/dashboard_srv.ts +++ b/public/app/features/dashboard/dashboard_srv.ts @@ -65,7 +65,7 @@ export class DashboardSrv { icon: "fa-warning", altActionText: "Save As", onAltAction: () => { - this.saveDashboardAs(); + this.showSaveAsModal(); }, onConfirm: () => { this.saveDashboard({overwrite: true}, clone); @@ -102,36 +102,33 @@ export class DashboardSrv { } if (this.dash.title === 'New dashboard') { - return this.saveDashboardAs(); + return this.showSaveAsModal(); } if (this.dash.version > 0) { - return this.saveDashboardMessage(); + return this.showSaveModal(); } return this.save(this.dash.getSaveModelClone(), options); } - saveDashboardAs() { + showSaveAsModal() { var newScope = this.$rootScope.$new(); newScope.clone = this.dash.getSaveModelClone(); newScope.clone.editable = true; newScope.clone.hideControls = false; this.$rootScope.appEvent('show-modal', { - src: 'public/app/features/dashboard/partials/saveDashboardAs.html', + templateHtml: '', scope: newScope, modalClass: 'modal--narrow' }); } - saveDashboardMessage() { - var newScope = this.$rootScope.$new(); - newScope.clone = this.dash.getSaveModelClone(); - + showSaveModal() { this.$rootScope.appEvent('show-modal', { - src: 'public/app/features/dashboard/partials/saveDashboardMessage.html', - scope: newScope, + templateHtml: '"', + scope: this.$rootScope.$new(), modalClass: 'modal--narrow' }); } diff --git a/public/app/features/dashboard/dashnav/dashnav.ts b/public/app/features/dashboard/dashnav/dashnav.ts index 339e911c81d..e77c2bb3e09 100644 --- a/public/app/features/dashboard/dashnav/dashnav.ts +++ b/public/app/features/dashboard/dashnav/dashnav.ts @@ -87,8 +87,8 @@ export class DashNavCtrl { this.$rootScope.appEvent('panel-change-view', {fullscreen: false, edit: false}); } - saveDashboard(options) { - return this.dashboardSrv.saveDashboard(options); + saveDashboard() { + return this.dashboardSrv.saveDashboard(); } deleteDashboard() { @@ -126,7 +126,7 @@ export class DashNavCtrl { } saveDashboardAs() { - return this.dashboardSrv.saveDashboardAs(); + return this.dashboardSrv.showSaveAsModal(); } viewJson() { diff --git a/public/app/features/dashboard/partials/dash_list.html b/public/app/features/dashboard/partials/dash_list.html deleted file mode 100644 index 3058715e0e6..00000000000 --- a/public/app/features/dashboard/partials/dash_list.html +++ /dev/null @@ -1,10 +0,0 @@ - - - -
        -
        -

        Dashboards

        -
        -
        - - diff --git a/public/app/features/dashboard/partials/graphiteImport.html b/public/app/features/dashboard/partials/graphiteImport.html deleted file mode 100644 index d23d506d17f..00000000000 --- a/public/app/features/dashboard/partials/graphiteImport.html +++ /dev/null @@ -1,35 +0,0 @@ -
        - -
        -

        Load dashboard from Graphite-Web

        - -
        -
        -
        - Data source -
        -
        -
        - -
        -
        -
        - -
        -
        -
        - -
      - - - - -
      {{dash.name}} - -
      - -
      -
      diff --git a/public/app/features/dashboard/partials/saveDashboardAs.html b/public/app/features/dashboard/partials/saveDashboardAs.html deleted file mode 100644 index 106f54fb85f..00000000000 --- a/public/app/features/dashboard/partials/saveDashboardAs.html +++ /dev/null @@ -1,27 +0,0 @@ -
      -
      -

      - - Save As... -

      - - - - -
      - -
      -
      -
      - - -
      -
      - -
      - Save - Cancel -
      -
      -
      - diff --git a/public/app/features/dashboard/partials/saveDashboardMessage.html b/public/app/features/dashboard/partials/saveDashboardMessage.html deleted file mode 100644 index d3df2aa1ce3..00000000000 --- a/public/app/features/dashboard/partials/saveDashboardMessage.html +++ /dev/null @@ -1,49 +0,0 @@ -
      -
      -

      - - Save Dashboard -

      - - - - -
      - - -
      Add a note to describe the changes in this version
      -
      -
      - -
      -
      - -
      - - -
      - -
      - - diff --git a/public/app/features/dashboard/saveDashboardAsCtrl.js b/public/app/features/dashboard/saveDashboardAsCtrl.js deleted file mode 100644 index 6f91591feca..00000000000 --- a/public/app/features/dashboard/saveDashboardAsCtrl.js +++ /dev/null @@ -1,39 +0,0 @@ -define([ - 'angular', -], -function (angular) { - 'use strict'; - - var module = angular.module('grafana.controllers'); - - module.controller('SaveDashboardAsCtrl', function($scope, dashboardSrv) { - - $scope.init = function() { - $scope.clone.id = null; - $scope.clone.editable = true; - $scope.clone.title = $scope.clone.title + " Copy"; - - // remove alerts - $scope.clone.rows.forEach(function(row) { - row.panels.forEach(function(panel) { - delete panel.alert; - }); - }); - - // remove auto update - delete $scope.clone.autoUpdate; - }; - - $scope.keyDown = function (evt) { - if (evt.keyCode === 13) { - $scope.saveClone(); - } - }; - - $scope.saveClone = function() { - return dashboardSrv.save($scope.clone, {overwrite: false}) - .then(function() { $scope.dismiss(); }); - }; - }); - -}); diff --git a/public/app/features/dashboard/saveDashboardMessageCtrl.js b/public/app/features/dashboard/saveDashboardMessageCtrl.js deleted file mode 100644 index 90f1c0c6c6d..00000000000 --- a/public/app/features/dashboard/saveDashboardMessageCtrl.js +++ /dev/null @@ -1,29 +0,0 @@ -define([ - 'angular', -], -function (angular) { - 'use strict'; - - var module = angular.module('grafana.controllers'); - - module.controller('SaveDashboardMessageCtrl', function($scope, dashboardSrv) { - - $scope.init = function() { - $scope.clone.message = ''; - $scope.clone.max = 64; - }; - - function saveDashboard(options) { - options.message = $scope.clone.message; - return dashboardSrv.save($scope.clone, options) - .then(function() { $scope.dismiss(); }); - } - - $scope.saveVersion = function(isValid) { - if (!isValid) { return; } - saveDashboard({overwrite: false}); - }; - }); - -}); - diff --git a/public/app/features/dashboard/save_as_modal.ts b/public/app/features/dashboard/save_as_modal.ts new file mode 100644 index 00000000000..22382f2867d --- /dev/null +++ b/public/app/features/dashboard/save_as_modal.ts @@ -0,0 +1,79 @@ +/// + +import coreModule from 'app/core/core_module'; + +const template = ` +
      +
      +

      + + Save As... +

      + + + + +
      + +
      +
      +
      + + +
      +
      + +
      + Save + Cancel +
      +
      +
      +`; + +export class SaveDashboardAsModalCtrl { + clone: any; + dismiss: () => void; + + /** @ngInject */ + constructor(private $scope, private dashboardSrv) { + var dashboard = this.dashboardSrv.getCurrent(); + this.clone = dashboard.getSaveModelClone(); + this.clone.id = null; + this.clone.title += ' Copy'; + this.clone.editable = true; + this.clone.hideControls = false; + + // remove alerts + this.clone.rows.forEach(row => { + row.panels.forEach(panel => { + delete panel.alert; + }); + }); + + delete this.clone.autoUpdate; + } + + save() { + return this.dashboardSrv.save(this.clone).then(this.dismiss); + } + + keyDown(evt) { + if (evt.keyCode === 13) { + this.save(); + } + } +} + +export function saveDashboardAsDirective() { + return { + restrict: 'E', + template: template, + controller: SaveDashboardAsModalCtrl, + bindToController: true, + controllerAs: 'ctrl', + scope: {dismiss: "&"} + }; +} + +coreModule.directive('saveDashboardAsModal', saveDashboardAsDirective); diff --git a/public/app/features/dashboard/save_modal.ts b/public/app/features/dashboard/save_modal.ts new file mode 100644 index 00000000000..101d5ddf11f --- /dev/null +++ b/public/app/features/dashboard/save_modal.ts @@ -0,0 +1,95 @@ +/// + +import coreModule from 'app/core/core_module'; + +const template = ` +
      +
      +

      + + Save Dashboard +

      + + + + +
      + +
      +
      Add a note to describe your changes
      +
      +
      + +
      +
      + +
      + + +
      +
      +
      +`; + +export class SaveDashboardModalCtrl { + message: string; + max: number; + saveForm: any; + dismiss: () => void; + + /** @ngInject */ + constructor(private $scope, private dashboardSrv) { + this.message = ''; + this.max = 64; + } + + save() { + if (!this.saveForm.$valid) { + return; + } + + var dashboard = this.dashboardSrv.getCurrent(); + var saveModel = dashboard.getSaveModelClone(); + var options = {message: this.message}; + + return this.dashboardSrv.save(saveModel, options).then(this.dismiss); + } + + keyDown(evt) { + if (evt.keyCode === 13) { + this.save(); + } + } +} + +export function saveDashboardModalDirective() { + return { + restrict: 'E', + template: template, + controller: SaveDashboardModalCtrl, + bindToController: true, + controllerAs: 'ctrl', + scope: {dismiss: "&"} + }; +} + +coreModule.directive('saveDashboardModal', saveDashboardModalDirective); From 1b79e179707f2f6d220e295a1474fef3b9e8b36a Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Mon, 5 Jun 2017 14:55:59 +0200 Subject: [PATCH 085/130] graph: better generation of y-axis ticks for log-scale If there are too many ticks generated for the y-axis (which can occur for log scale 2, with a small y-min and a large max), then the ticks will be regenerated using larger jumps between the ticks. This also handles the case when y-min is set to 0. Previously, y-min of 0 was ignored as zero is not a valid value for log scale. Now the tick generator approximates zero by setting min to 0.1. Ref #8244 Ref #8516 --- public/app/plugins/panel/graph/graph.ts | 38 +++++++++++-- .../plugins/panel/graph/specs/graph_specs.ts | 54 +++++++++++++++++++ 2 files changed, 88 insertions(+), 4 deletions(-) diff --git a/public/app/plugins/panel/graph/graph.ts b/public/app/plugins/panel/graph/graph.ts index 726f8be5628..408d89854cb 100755 --- a/public/app/plugins/panel/graph/graph.ts +++ b/public/app/plugins/panel/graph/graph.ts @@ -506,6 +506,8 @@ coreModule.directive('grafanaGraph', function($rootScope, timeSrv, popoverSrv) { return; } + const minSetToZero = axis.min === 0; + if (axis.min < Number.MIN_VALUE) { axis.min = null; } @@ -556,10 +558,17 @@ coreModule.directive('grafanaGraph', function($rootScope, timeSrv, popoverSrv) { } if (Number.isFinite(min) && Number.isFinite(max)) { - axis.ticks = []; - var nextTick; - for (nextTick = min; nextTick <= max; nextTick *= axis.logBase) { - axis.ticks.push(nextTick); + if (minSetToZero) { + axis.min = 0.1; + min = 1; + } + + axis.ticks = generateTicksForLogScaleYAxis(min, max, axis.logBase); + if (minSetToZero) { + axis.ticks.unshift(0.1); + } + if (axis.ticks[axis.ticks.length - 1] > axis.max) { + axis.max = axis.ticks[axis.ticks.length - 1]; } axis.tickDecimals = decimalPlaces(min); } else { @@ -567,7 +576,28 @@ coreModule.directive('grafanaGraph', function($rootScope, timeSrv, popoverSrv) { delete axis.min; delete axis.max; } + } + function generateTicksForLogScaleYAxis(min, max, logBase) { + let ticks = []; + + var nextTick; + for (nextTick = min; nextTick <= max; nextTick *= logBase) { + ticks.push(nextTick); + } + + const maxNumTicks = Math.ceil(ctrl.height/25); + const numTicks = ticks.length; + if (numTicks > maxNumTicks) { + const factor = Math.ceil(numTicks/maxNumTicks) * logBase; + ticks = []; + + for (nextTick = min; nextTick <= (max * factor); nextTick *= factor) { + ticks.push(nextTick); + } + } + + return ticks; } function decimalPlaces(num) { diff --git a/public/app/plugins/panel/graph/specs/graph_specs.ts b/public/app/plugins/panel/graph/specs/graph_specs.ts index 9595c3dd544..40cfdb2fcdd 100644 --- a/public/app/plugins/panel/graph/specs/graph_specs.ts +++ b/public/app/plugins/panel/graph/specs/graph_specs.ts @@ -176,6 +176,60 @@ describe('grafanaGraph', function() { }); }); + // y-min set 0 is a special case for log scale, + // this approximates it by setting min to 0.1 + graphScenario('when logBase is log 10 and y-min is set to 0 and auto min is > 0.1', function(ctx) { + ctx.setup(function(ctrl, data) { + ctrl.panel.yaxes[0].logBase = 10; + ctrl.panel.yaxes[0].min = '0'; + data[0] = new TimeSeries({ + datapoints: [[2000,1],[4 ,2],[500,3],[3000,4]], + alias: 'seriesAutoscale', + }); + data[0].yaxis = 1; + }); + + it('should set min to 0.1 and add a tick for 0.1 and tickDecimals to be 0', function() { + var axisAutoscale = ctx.plotOptions.yaxes[0]; + expect(axisAutoscale.transform(100)).to.be(2); + expect(axisAutoscale.inverseTransform(-3)).to.be(0.001); + expect(axisAutoscale.min).to.be(0.1); + expect(axisAutoscale.max).to.be(10000); + expect(axisAutoscale.ticks.length).to.be(6); + expect(axisAutoscale.ticks[0]).to.be(0.1); + expect(axisAutoscale.ticks[5]).to.be(10000); + expect(axisAutoscale.tickDecimals).to.be(0); + }); + }); + + graphScenario('when logBase is log 2 and y-min is set to 0 and num of ticks exceeds max', function(ctx) { + ctx.setup(function(ctrl, data) { + const heightForApprox5Ticks = 125; + ctrl.height = heightForApprox5Ticks; + ctrl.panel.yaxes[0].logBase = 2; + ctrl.panel.yaxes[0].min = '0'; + data[0] = new TimeSeries({ + datapoints: [[2000,1],[4 ,2],[500,3],[3000,4], [10000,5], [100000,6]], + alias: 'seriesAutoscale', + }); + data[0].yaxis = 1; + }); + + it('should regenerate ticks so that if fits on the y-axis', function() { + var axisAutoscale = ctx.plotOptions.yaxes[0]; + expect(axisAutoscale.min).to.be(0.1); + expect(axisAutoscale.ticks.length).to.be(8); + expect(axisAutoscale.ticks[0]).to.be(0.1); + expect(axisAutoscale.ticks[7]).to.be(262144); + expect(axisAutoscale.max).to.be(262144); + expect(axisAutoscale.tickDecimals).to.be(0); + }); + + it('should set axis max to be max tick value', function() { + expect(ctx.plotOptions.yaxes[0].max).to.be(262144); + }); + }); + graphScenario('dashed lines options', function(ctx) { ctx.setup(function(ctrl) { ctrl.panel.lines = true; From e18007153d386660adbc4051700ba8316e2ae0c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 16:34:32 +0200 Subject: [PATCH 086/130] refactoring: Renamed dashboard version queries that wrongly had Command suffix, added missing OrgId to dashboard history commands and queries --- pkg/api/dashboard.go | 55 ++++--------------- pkg/models/dashboard_version.go | 43 ++++++++------- pkg/models/dashboards.go | 11 +++- pkg/services/sqlstore/dashboard.go | 18 +++--- pkg/services/sqlstore/dashboard_version.go | 54 ++++++++---------- .../app/features/dashboard/dashboard_srv.ts | 6 +- .../features/dashboard/history/history.html | 2 +- .../app/features/dashboard/history/history.ts | 3 - .../app/features/dashboard/history/models.ts | 1 - public/app/features/dashboard/save_modal.ts | 2 +- 10 files changed, 77 insertions(+), 118 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 79e0e2b05cf..62f83d5dc43 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -116,13 +116,9 @@ func DeleteDashboard(c *middleware.Context) { } func PostDashboard(c *middleware.Context, cmd m.SaveDashboardCommand) Response { - cmd.OrgId = c.OrgId - if !c.IsSignedIn { - cmd.UserId = -1 - } else { - cmd.UserId = c.UserId - } + cmd.OrgId = c.OrgId + cmd.UserId = c.UserId dash := cmd.GetDashboardModel() // Check if Title is empty @@ -261,19 +257,16 @@ func GetDashboardFromJsonFile(c *middleware.Context) { // GetDashboardVersions returns all dashboard versions as JSON func GetDashboardVersions(c *middleware.Context) Response { dashboardId := c.ParamsInt64(":dashboardId") - orderBy := c.Query("orderBy") limit := c.QueryInt("limit") start := c.QueryInt("start") - if orderBy == "" { - orderBy = "version" - } + if limit == 0 { limit = 1000 } - query := m.GetDashboardVersionsCommand{ + query := m.GetDashboardVersionsQuery{ + OrgId: c.OrgId, DashboardId: dashboardId, - OrderBy: orderBy, Limit: limit, Start: start, } @@ -282,26 +275,6 @@ func GetDashboardVersions(c *middleware.Context) Response { return ApiError(404, fmt.Sprintf("No versions found for dashboardId %d", dashboardId), err) } - // // TODO(ben) use inner join with DTO - // dashboardVersions := make([]*m.DashboardVersionDTO, len(query.Result)) - // for i, dashboardVersion := range query.Result { - // creator := "Anonymous" - // if dashboardVersion.CreatedBy > 0 { - // creator = getUserLogin(dashboardVersion.CreatedBy) - // } - - // dashboardVersions[i] = &m.DashboardVersionDTO{ - // Id: dashboardVersion.Id, - // DashboardId: dashboardVersion.DashboardId, - // ParentVersion: dashboardVersion.ParentVersion, - // RestoredFrom: dashboardVersion.RestoredFrom, - // Version: dashboardVersion.Version, - // Created: dashboardVersion.Created, - // CreatedBy: creator, - // Message: dashboardVersion.Message, - // } - // } - return Json(200, query.Result) } @@ -310,16 +283,14 @@ func GetDashboardVersion(c *middleware.Context) Response { dashboardId := c.ParamsInt64(":dashboardId") version := c.ParamsInt(":id") - query := m.GetDashboardVersionCommand{ + query := m.GetDashboardVersionQuery{ + OrgId: c.OrgId, DashboardId: dashboardId, Version: version, } + if err := bus.Dispatch(&query); err != nil { - return ApiError( - 500, - fmt.Sprintf("Dashboard version %d not found for dashboardId %d", version, dashboardId), - err, - ) + return ApiError(500, fmt.Sprintf("Dashboard version %d not found for dashboardId %d", version, dashboardId), err) } creator := "Anonymous" @@ -360,6 +331,7 @@ func createCompareDashboardVersionCommand(c *middleware.Context) (m.CompareDashb } cmd.DashboardId = int64(dashboardId) + cmd.OrgId = c.OrgId cmd.Original = originalDash cmd.New = newDash return cmd, nil @@ -428,12 +400,9 @@ func CompareDashboardVersionsBasic(c *middleware.Context) Response { // RestoreDashboardVersion restores a dashboard to the given version. func RestoreDashboardVersion(c *middleware.Context, cmd m.RestoreDashboardVersionCommand) Response { - if !c.IsSignedIn { - return ApiError(401, "Must be signed in to restore a version", nil) - } - - cmd.UserId = c.UserId cmd.DashboardId = c.ParamsInt64(":dashboardId") + cmd.UserId = c.UserId + cmd.OrgId = c.OrgId if err := bus.Dispatch(&cmd); err != nil { return ApiError(500, "Cannot restore version", err) diff --git a/pkg/models/dashboard_version.go b/pkg/models/dashboard_version.go index fd375db951c..4d4a49fea63 100644 --- a/pkg/models/dashboard_version.go +++ b/pkg/models/dashboard_version.go @@ -29,9 +29,8 @@ type DashboardVersion struct { RestoredFrom int `json:"restoredFrom"` Version int `json:"version"` - Created time.Time `json:"created"` - - CreatedBy int64 `json:"createdBy"` + Created time.Time `json:"created"` + CreatedBy int64 `json:"createdBy"` Message string `json:"message"` Data *simplejson.Json `json:"data"` @@ -59,45 +58,47 @@ type DashboardVersionDTO struct { } // -// COMMANDS +// Queries // -// GetDashboardVersionCommand contains the data required to execute the -// sqlstore.GetDashboardVersionCommand, which returns the DashboardVersion for -// the given Version. -type GetDashboardVersionCommand struct { - DashboardId int64 `json:"dashboardId" binding:"Required"` - Version int `json:"version" binding:"Required"` +type GetDashboardVersionQuery struct { + DashboardId int64 + OrgId int64 + Version int Result *DashboardVersion } -// GetDashboardVersionsCommand contains the data required to execute the -// sqlstore.GetDashboardVersionsCommand, which returns all dashboard versions. -type GetDashboardVersionsCommand struct { - DashboardId int64 `json:"dashboardId" binding:"Required"` - OrderBy string `json:"orderBy"` - Limit int `json:"limit"` - Start int `json:"start"` +type GetDashboardVersionsQuery struct { + DashboardId int64 + OrgId int64 + Limit int + Start int Result []*DashboardVersionDTO } +// +// Commands +// + // RestoreDashboardVersionCommand creates a new dashboard version. type RestoreDashboardVersionCommand struct { DashboardId int64 `json:"dashboardId"` Version int `json:"version" binding:"Required"` UserId int64 `json:"-"` + OrgId int64 `json:"-"` Result *Dashboard } // CompareDashboardVersionsCommand is used to compare two versions. type CompareDashboardVersionsCommand struct { - DashboardId int64 `json:"dashboardId"` - Original int `json:"original" binding:"Required"` - New int `json:"new" binding:"Required"` - DiffType DiffType `json:"-"` + OrgId int64 + DashboardId int64 + Original int + New int + DiffType DiffType Delta []byte `json:"delta"` } diff --git a/pkg/models/dashboards.go b/pkg/models/dashboards.go index f0d00af380f..a6ebdd0220a 100644 --- a/pkg/models/dashboards.go +++ b/pkg/models/dashboards.go @@ -98,12 +98,17 @@ func NewDashboardFromJson(data *simplejson.Json) *Dashboard { // GetDashboardModel turns the command into the savable model func (cmd *SaveDashboardCommand) GetDashboardModel() *Dashboard { dash := NewDashboardFromJson(cmd.Dashboard) + userId := cmd.UserId - if dash.Data.Get("version").MustInt(0) == 0 { - dash.CreatedBy = cmd.UserId + if userId == 0 { + userId = -1 } - dash.UpdatedBy = cmd.UserId + if dash.Data.Get("version").MustInt(0) == 0 { + dash.CreatedBy = userId + } + + dash.UpdatedBy = userId dash.OrgId = cmd.OrgId dash.PluginId = cmd.PluginId dash.UpdateSlug() diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index 7a02045d4fa..66b2e79b85d 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -70,24 +70,22 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { } parentVersion := dash.Version - version, err := getMaxVersion(sess, dash.Id) - if err != nil { - return err - } - dash.Version = version - affectedRows := int64(0) + if dash.Id == 0 { metrics.M_Models_Dashboard_Insert.Inc(1) dash.Data.Set("version", dash.Version) affectedRows, err = sess.Insert(dash) } else { + dash.Version += 1 dash.Data.Set("version", dash.Version) affectedRows, err = sess.Id(dash.Id).Update(dash) } + if err != nil { return err } + if affectedRows == 0 { return m.ErrDashboardNotFound } @@ -102,11 +100,11 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { Message: cmd.Message, Data: dash.Data, } - affectedRows, err = sess.Insert(dashVersion) - if err != nil { + + // insert version entry + if affectedRows, err = sess.Insert(dashVersion); err != nil { return err - } - if affectedRows == 0 { + } else if affectedRows == 0 { return m.ErrDashboardNotFound } diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index c3695dc778f..92bed305a7c 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -32,12 +32,12 @@ func init() { // CompareDashboardVersionsCommand computes the JSON diff of two versions, // assigning the delta of the diff to the `Delta` field. func CompareDashboardVersionsCommand(cmd *m.CompareDashboardVersionsCommand) error { - original, err := getDashboardVersion(cmd.DashboardId, cmd.Original) + original, err := getDashboardVersion(cmd.DashboardId, cmd.Original, cmd.OrgId) if err != nil { return err } - newDashboard, err := getDashboardVersion(cmd.DashboardId, cmd.New) + newDashboard, err := getDashboardVersion(cmd.DashboardId, cmd.New, cmd.OrgId) if err != nil { return err } @@ -79,8 +79,8 @@ func CompareDashboardVersionsCommand(cmd *m.CompareDashboardVersionsCommand) err // GetDashboardVersion gets the dashboard version for the given dashboard ID // and version number. -func GetDashboardVersion(query *m.GetDashboardVersionCommand) error { - result, err := getDashboardVersion(query.DashboardId, query.Version) +func GetDashboardVersion(query *m.GetDashboardVersionQuery) error { + result, err := getDashboardVersion(query.DashboardId, query.Version, query.OrgId) if err != nil { return err } @@ -90,12 +90,7 @@ func GetDashboardVersion(query *m.GetDashboardVersionCommand) error { } // GetDashboardVersions gets all dashboard versions for the given dashboard ID. -func GetDashboardVersions(query *m.GetDashboardVersionsCommand) error { - if query.OrderBy == "" { - query.OrderBy = "version" - } - query.OrderBy += " desc" - +func GetDashboardVersions(query *m.GetDashboardVersionsQuery) error { err := x.Table("dashboard_version"). Select(`dashboard_version.id, dashboard_version.dashboard_id, @@ -108,8 +103,9 @@ func GetDashboardVersions(query *m.GetDashboardVersionsCommand) error { dashboard_version.data, "user".login as created_by`). Join("LEFT", "user", `dashboard_version.created_by = "user".id`). - Where("dashboard_version.dashboard_id=?", query.DashboardId). - OrderBy("dashboard_version."+query.OrderBy). + Join("LEFT", "dashboard", `dashboard.id = "dashboard_version".dashboard_id`). + Where("dashboard_version.dashboard_id=? AND dashboard.org_id=?", query.DashboardId, query.OrgId). + OrderBy("dashboard_version.version DESC"). Limit(query.Limit, query.Start). Find(&query.Result) if err != nil { @@ -132,26 +128,21 @@ func RestoreDashboardVersion(cmd *m.RestoreDashboardVersionCommand) error { // session instead of using the global `x`, so we copy those functions // here, replacing `x` with `sess` dashboardVersion := m.DashboardVersion{} - has, err := sess.Where( - "dashboard_id=? AND version=?", - cmd.DashboardId, - cmd.Version, - ).Get(&dashboardVersion) + has, err := sess.Where("dashboard_id=? AND version=? AND org_id=?", cmd.DashboardId, cmd.Version, cmd.OrgId).Get(&dashboardVersion) if err != nil { return err } if !has { return m.ErrDashboardVersionNotFound } + dashboardVersion.Data.Set("id", dashboardVersion.DashboardId) - // get the dashboard version dashboard := m.Dashboard{Id: cmd.DashboardId} - has, err = sess.Get(&dashboard) - if err != nil { + // Get the dashboard version + if has, err = sess.Get(&dashboard); err != nil { return err - } - if has == false { + } else if !has { return m.ErrDashboardNotFound } @@ -166,11 +157,11 @@ func RestoreDashboardVersion(cmd *m.RestoreDashboardVersionCommand) error { dashboard.UpdatedBy = cmd.UserId dashboard.Version = version dashboard.Data.Set("version", dashboard.Version) - affectedRows, err := sess.Id(dashboard.Id).Update(dashboard) - if err != nil { + + // Update dashboard + if affectedRows, err := sess.Id(dashboard.Id).Update(dashboard); err != nil { return err - } - if affectedRows == 0 { + } else if affectedRows == 0 { return m.ErrDashboardNotFound } @@ -185,11 +176,10 @@ func RestoreDashboardVersion(cmd *m.RestoreDashboardVersionCommand) error { Message: "", Data: dashboard.Data, } - affectedRows, err = sess.Insert(dashVersion) - if err != nil { + + if affectedRows, err := sess.Insert(dashVersion); err != nil { return err - } - if affectedRows == 0 { + } else if affectedRows == 0 { return m.ErrDashboardNotFound } @@ -200,9 +190,9 @@ func RestoreDashboardVersion(cmd *m.RestoreDashboardVersionCommand) error { // getDashboardVersion is a helper function that gets the dashboard version for // the given dashboard ID and version ID. -func getDashboardVersion(dashboardId int64, version int) (*m.DashboardVersion, error) { +func getDashboardVersion(dashboardId int64, version int, orgId int64) (*m.DashboardVersion, error) { dashboardVersion := m.DashboardVersion{} - has, err := x.Where("dashboard_id=? AND version=?", dashboardId, version).Get(&dashboardVersion) + has, err := x.Where("dashboard_id=? AND version=? AND org_id=?", dashboardId, version, orgId).Get(&dashboardVersion) if err != nil { return nil, err } diff --git a/public/app/features/dashboard/dashboard_srv.ts b/public/app/features/dashboard/dashboard_srv.ts index 30ba7defdfd..205e7a8f9c6 100644 --- a/public/app/features/dashboard/dashboard_srv.ts +++ b/public/app/features/dashboard/dashboard_srv.ts @@ -34,7 +34,7 @@ export class DashboardSrv { yesText: "Save & Overwrite", icon: "fa-warning", onConfirm: () => { - this.saveDashboard({overwrite: true}, clone); + this.save(clone, {overwrite: true}); } }); } @@ -49,7 +49,7 @@ export class DashboardSrv { yesText: "Save & Overwrite", icon: "fa-warning", onConfirm: () => { - this.saveDashboard({overwrite: true}, clone); + this.save(clone, {overwrite: true}); } }); } @@ -68,7 +68,7 @@ export class DashboardSrv { this.showSaveAsModal(); }, onConfirm: () => { - this.saveDashboard({overwrite: true}, clone); + this.save(clone, {overwrite: true}); } }); } diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 889a186021c..696265667dd 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -1,6 +1,6 @@

      - Changelog + Version History

      `; diff --git a/public/app/features/dashboard/save_modal.ts b/public/app/features/dashboard/save_modal.ts index 8c08aa9a1db..01a42655a5f 100644 --- a/public/app/features/dashboard/save_modal.ts +++ b/public/app/features/dashboard/save_modal.ts @@ -29,7 +29,6 @@ const template = ` ng-model="ctrl.message" ng-model-options="{allowInvalid: true}" ng-maxlength="this.max" - ng-keydown="ctrl.keyDown($event)" autocomplete="off" required /> @@ -73,12 +72,6 @@ export class SaveDashboardModalCtrl { return this.dashboardSrv.save(saveModel, options).then(this.dismiss); } - - keyDown(evt) { - if (evt.keyCode === 13) { - this.save(); - } - } } export function saveDashboardModalDirective() { From cabbfe9adc784e95c38cb3cc76ca7e2454891bfd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 22:59:04 +0200 Subject: [PATCH 091/130] refactoring: moved dashboard history item formating (message) and fixed dashboard history migration issue, and removed from frontend tests that where no longer needed --- pkg/api/dashboard.go | 19 +++- pkg/models/dashboards.go | 13 ++- pkg/services/sqlstore/dashboard.go | 2 +- .../migrations/dashboard_version_mig.go | 2 +- .../features/dashboard/history/history.html | 2 +- .../app/features/dashboard/history/history.ts | 26 +---- .../dashboard/specs/history_ctrl_specs.ts | 103 +----------------- 7 files changed, 34 insertions(+), 133 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index eb1df4785ac..94e47b9b85d 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -276,6 +276,22 @@ func GetDashboardVersions(c *middleware.Context) Response { return ApiError(404, fmt.Sprintf("No versions found for dashboardId %d", dashboardId), err) } + for _, version := range query.Result { + if version.RestoredFrom == version.Version { + version.Message = "Initial save (created migration)" + continue + } + + if version.RestoredFrom > 0 { + version.Message = fmt.Sprintf("Restored from version %d", version.RestoredFrom) + continue + } + + if version.ParentVersion == 0 { + version.Message = "Initial save" + } + } + return Json(200, query.Result) } @@ -417,11 +433,12 @@ func RestoreDashboardVersion(c *middleware.Context, apiCmd dtos.RestoreDashboard version := versionQuery.Result saveCmd := m.SaveDashboardCommand{} + saveCmd.RestoredFrom = version.Version saveCmd.OrgId = c.OrgId saveCmd.UserId = c.UserId saveCmd.Dashboard = version.Data saveCmd.Dashboard.Set("version", dashboard.Version) - saveCmd.Message = fmt.Sprintf("Dashboard restored from version %d", version.Version) + saveCmd.Message = fmt.Sprintf("Restored from version %d", version.Version) return PostDashboard(c, saveCmd) } diff --git a/pkg/models/dashboards.go b/pkg/models/dashboards.go index eb0e442ad9a..0463e9c209b 100644 --- a/pkg/models/dashboards.go +++ b/pkg/models/dashboards.go @@ -131,12 +131,13 @@ func (dash *Dashboard) UpdateSlug() { // type SaveDashboardCommand struct { - Dashboard *simplejson.Json `json:"dashboard" binding:"Required"` - UserId int64 `json:"userId"` - OrgId int64 `json:"-"` - Overwrite bool `json:"overwrite"` - PluginId string `json:"-"` - Message string `json:"message"` + Dashboard *simplejson.Json `json:"dashboard" binding:"Required"` + UserId int64 `json:"userId"` + Overwrite bool `json:"overwrite"` + Message string `json:"message"` + OrgId int64 `json:"-"` + RestoredFrom int `json:"-"` + PluginId string `json:"-"` Result *Dashboard } diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index d3f3c115ca3..b46d1961305 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -93,7 +93,7 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { dashVersion := &m.DashboardVersion{ DashboardId: dash.Id, ParentVersion: parentVersion, - RestoredFrom: -1, + RestoredFrom: cmd.RestoredFrom, Version: dash.Version, Created: time.Now(), CreatedBy: dash.UpdatedBy, diff --git a/pkg/services/sqlstore/migrations/dashboard_version_mig.go b/pkg/services/sqlstore/migrations/dashboard_version_mig.go index dbc3dc46007..01bced00dea 100644 --- a/pkg/services/sqlstore/migrations/dashboard_version_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_version_mig.go @@ -39,7 +39,7 @@ func addDashboardVersionMigration(mg *Migrator) { ) SELECT dashboard.id, - dashboard.version + 1, + dashboard.version, dashboard.version, dashboard.version, dashboard.updated, diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 696265667dd..a739871b144 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -60,7 +60,7 @@ {{revision.message}} -   Restore +   Restore   Current diff --git a/public/app/features/dashboard/history/history.ts b/public/app/features/dashboard/history/history.ts index c1fb78a0e30..11091c6010f 100644 --- a/public/app/features/dashboard/history/history.ts +++ b/public/app/features/dashboard/history/history.ts @@ -125,31 +125,9 @@ export class HistoryListCtrl { limit: this.limit, start: this.start, }; + return this.historySrv.getHistoryList(this.dashboard, options).then(revisions => { - const formattedRevisions = _.flow( - _.partialRight(_.map, rev => _.extend({}, rev, { - checked: false, - message: (revision => { - if (revision.message === '') { - if (revision.version === 1) { - return 'Dashboard\'s initial save'; - } - - if (revision.restoredFrom > 0) { - return `Restored from version ${revision.restoredFrom}`; - } - - if (revision.parentVersion === 0) { - return 'Dashboard overwritten'; - } - - return 'Dashboard saved'; - } - return revision.message; - })(rev), - })))(revisions); - - this.revisions = append ? this.revisions.concat(formattedRevisions) : formattedRevisions; + this.revisions = append ? this.revisions.concat(revisions) : revisions; }).catch(err => { this.$rootScope.appEvent('alert-error', ['There was an error fetching the history list', (err.message || err)]); }).finally(() => { diff --git a/public/app/features/dashboard/specs/history_ctrl_specs.ts b/public/app/features/dashboard/specs/history_ctrl_specs.ts index e4fe847c4cc..fe64da04755 100644 --- a/public/app/features/dashboard/specs/history_ctrl_specs.ts +++ b/public/app/features/dashboard/specs/history_ctrl_specs.ts @@ -89,21 +89,6 @@ describe('HistoryListCtrl', function() { expect(ctx.ctrl.selected).to.eql([]); }); - it('should add a default message to versions without a message', function() { - expect(ctx.ctrl.revisions[0].message).to.be('Dashboard saved'); - }); - - it('should add a message to revisions restored from another version', function() { - expect(ctx.ctrl.revisions[1].message).to.be('Restored from version 1'); - }); - - it('should add a message to entries that overwrote version history', function() { - expect(ctx.ctrl.revisions[2].message).to.be('Dashboard overwritten'); - }); - - it('should add a message to the initial dashboard save', function() { - expect(ctx.ctrl.revisions[3].message).to.be('Dashboard\'s initial save'); - }); }); describe('and fetching the history list fails', function() { @@ -307,7 +292,6 @@ describe('HistoryListCtrl', function() { $rootScope, $scope: ctx.scope, }); - ctx.ctrl.$scope.setupDashboard = sinon.stub(); ctx.ctrl.dashboard = { id: 1 }; ctx.ctrl.restore(); ctx.ctrl.$scope.$apply(); @@ -318,99 +302,20 @@ describe('HistoryListCtrl', function() { expect($rootScope.appEvent.calledWith('confirm-modal')).to.be(true); }); - describe('from the diff view', function() { - it('should return to the list view on restore', function() { - ctx.ctrl.mode = 'compare'; - deferred.resolve(restoreResponse); - ctx.ctrl.restoreConfirm(RESTORE_ID); - ctx.ctrl.$scope.$apply(); - expect(ctx.ctrl.mode).to.be('list'); - }); - }); - - describe('and restore is selected and successful', function() { - beforeEach(function() { - deferred.resolve(restoreResponse); - ctx.ctrl.restoreConfirm(RESTORE_ID); - ctx.ctrl.$scope.$apply(); - }); - - it('should indicate loading has finished', function() { - expect(ctx.ctrl.loading).to.be(false); - }); - - it('should add an entry for the restored revision to the history list', function() { - expect(ctx.ctrl.revisions.length).to.be(5); - }); - - describe('the restored revision', function() { - var first; - beforeEach(function() { first = ctx.ctrl.revisions[0]; }); - - it('should have its `id` and `version` numbers incremented', function() { - expect(first.id).to.be(5); - expect(first.version).to.be(5); - }); - - it('should set `parentVersion` to the reverted version', function() { - expect(first.parentVersion).to.be(RESTORE_ID); - }); - - it('should set `dashboardId` to the dashboard\'s id', function() { - expect(first.dashboardId).to.be(1); - }); - - it('should set `created` to date to the current time', function() { - expect(_.isDate(first.created)).to.be(true); - }); - - it('should set `createdBy` to the username of the user who reverted', function() { - expect(first.createdBy).to.be('Carlos'); - }); - - it('should set `message` to the user\'s commit message', function() { - expect(first.message).to.be('Restored from version 4'); - }); - }); - - it('should reset the controller\'s state', function() { - expect(ctx.ctrl.mode).to.be('list'); - expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); - expect(ctx.ctrl.selected.length).to.be(0); - expect(ctx.ctrl.selected).to.eql([]); - expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; - }); - - it('should set the dashboard object to the response dashboard data', function() { - expect(ctx.ctrl.dashboard).to.eql(restoreResponse.dashboard.dashboard); - expect(ctx.ctrl.dashboard.meta).to.eql(restoreResponse.dashboard.meta); - }); - - it('should call setupDashboard to render new revision', function() { - expect(ctx.ctrl.$scope.setupDashboard.calledOnce).to.be(true); - expect(ctx.ctrl.$scope.setupDashboard.getCall(0).args[0]).to.eql(restoreResponse.dashboard); - }); - }); - describe('and restore fails to fetch', function() { beforeEach(function() { deferred.reject(new Error('RestoreError')); ctx.ctrl.restoreConfirm(RESTORE_ID); - ctx.ctrl.$scope.$apply(); + try { + // this throws error, due to promise rejection + ctx.ctrl.$scope.$apply(); + } catch (e) {} }); it('should indicate loading has finished', function() { expect(ctx.ctrl.loading).to.be(false); }); - it('should broadcast an event indicating the failure', function() { - expect($rootScope.appEvent.callCount).to.be(2); - expect($rootScope.appEvent.getCall(0).calledWith('confirm-modal')).to.be(true); - expect($rootScope.appEvent.getCall(1).args[0]).to.be('alert-error'); - expect($rootScope.appEvent.getCall(1).args[1][0]).to.be('There was an error restoring the dashboard'); - }); - - // TODO: test state after failure i.e. do we hide the modal or keep it visible }); }); }); From 2a52e25d5bc5f53bb22ed07052426e4dd1a2412e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 23:06:31 +0200 Subject: [PATCH 092/130] refactoring: removed double error alert, backendSrv is already showing an error alert --- public/app/features/dashboard/history/history.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/public/app/features/dashboard/history/history.ts b/public/app/features/dashboard/history/history.ts index 11091c6010f..44d8a0f2226 100644 --- a/public/app/features/dashboard/history/history.ts +++ b/public/app/features/dashboard/history/history.ts @@ -113,7 +113,6 @@ export class HistoryListCtrl { this.delta[this.diff] = response; }).catch(err => { this.mode = 'list'; - this.$rootScope.appEvent('alert-error', ['There was an error fetching the diff', (err.message || err)]); }).finally(() => { this.loading = false; }); } } From 9c1401849e53a0277efc6b7dec6c7dc5c374fdb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 23:14:07 +0200 Subject: [PATCH 093/130] fix: always show dashboard history for now, need a way to make dropdown more dynamic --- public/app/core/nav_model_srv.ts | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/public/app/core/nav_model_srv.ts b/public/app/core/nav_model_srv.ts index ee5869763bb..99f09916753 100644 --- a/public/app/core/nav_model_srv.ts +++ b/public/app/core/nav_model_srv.ts @@ -167,13 +167,11 @@ export class NavModelSrv { clickHandler: () => dashNavCtrl.openEditView('annotations') }); - if (dashboard.version > 0) { - menu.push({ - title: 'Version History', - icon: 'fa fa-fw fa-history', - clickHandler: () => dashNavCtrl.openEditView('history') - }); - } + menu.push({ + title: 'Version History', + icon: 'fa fa-fw fa-history', + clickHandler: () => dashNavCtrl.openEditView('history') + }); menu.push({ title: 'View JSON', From 746d6cdc8842b00184f87953b10bd20fc5be9802 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 23:29:25 +0200 Subject: [PATCH 094/130] refactoring: changed name on compare command to make properties more explainatory --- pkg/api/dashboard.go | 39 ++++++++++--------- pkg/models/dashboard_version.go | 4 +- pkg/services/sqlstore/dashboard_version.go | 6 +-- .../sqlstore/dashboard_version_test.go | 12 +++--- 4 files changed, 32 insertions(+), 29 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 94e47b9b85d..b0a38c63eb1 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -2,6 +2,7 @@ package api import ( "encoding/json" + "errors" "fmt" "os" "path" @@ -323,34 +324,34 @@ func GetDashboardVersion(c *middleware.Context) Response { return Json(200, dashVersionMeta) } -func createCompareDashboardVersionCommand(c *middleware.Context) (m.CompareDashboardVersionsCommand, error) { - cmd := m.CompareDashboardVersionsCommand{} +func createCompareDashboardVersionCommand(c *middleware.Context) (*m.CompareDashboardVersionsCommand, error) { + cmd := &m.CompareDashboardVersionsCommand{} - dashboardIdStr := c.Params(":dashboardId") - dashboardId, err := strconv.Atoi(dashboardIdStr) - if err != nil { - return cmd, err + dashId := c.ParamsInt64(":dashboardId") + if dashId == 0 { + return nil, errors.New("Missing dashboardId") } versionStrings := strings.Split(c.Params(":versions"), "...") if len(versionStrings) != 2 { - return cmd, fmt.Errorf("bad format: urls should be in the format /versions/0...1") + return nil, fmt.Errorf("bad format: urls should be in the format /versions/0...1") } - originalDash, err := strconv.Atoi(versionStrings[0]) + BaseVersion, err := strconv.Atoi(versionStrings[0]) if err != nil { - return cmd, fmt.Errorf("bad format: first argument is not of type int") + return nil, fmt.Errorf("bad format: first argument is not of type int") } - newDash, err := strconv.Atoi(versionStrings[1]) + newVersion, err := strconv.Atoi(versionStrings[1]) if err != nil { - return cmd, fmt.Errorf("bad format: second argument is not of type int") + return nil, fmt.Errorf("bad format: second argument is not of type int") } - cmd.DashboardId = int64(dashboardId) + cmd.DashboardId = dashId cmd.OrgId = c.OrgId - cmd.Original = originalDash - cmd.New = newDash + cmd.BaseVersion = BaseVersion + cmd.NewVersion = newVersion + return cmd, nil } @@ -360,6 +361,7 @@ func CompareDashboardVersions(c *middleware.Context) Response { if err != nil { return ApiError(500, err.Error(), err) } + cmd.DiffType = m.DiffDelta if err := bus.Dispatch(&cmd); err != nil { @@ -376,8 +378,8 @@ func CompareDashboardVersions(c *middleware.Context) Response { return Json(200, util.DynMap{ "meta": util.DynMap{ - "original": cmd.Original, - "new": cmd.New, + "baseVersion": cmd.BaseVersion, + "newVersion": cmd.NewVersion, }, "delta": deltaMap, }) @@ -392,7 +394,7 @@ func CompareDashboardVersionsJSON(c *middleware.Context) Response { } cmd.DiffType = m.DiffJSON - if err := bus.Dispatch(&cmd); err != nil { + if err := bus.Dispatch(cmd); err != nil { return ApiError(500, err.Error(), err) } @@ -406,9 +408,10 @@ func CompareDashboardVersionsBasic(c *middleware.Context) Response { if err != nil { return ApiError(500, err.Error(), err) } + cmd.DiffType = m.DiffBasic - if err := bus.Dispatch(&cmd); err != nil { + if err := bus.Dispatch(cmd); err != nil { return ApiError(500, err.Error(), err) } diff --git a/pkg/models/dashboard_version.go b/pkg/models/dashboard_version.go index e14e414e02b..949ad5f1f6a 100644 --- a/pkg/models/dashboard_version.go +++ b/pkg/models/dashboard_version.go @@ -86,8 +86,8 @@ type GetDashboardVersionsQuery struct { type CompareDashboardVersionsCommand struct { OrgId int64 DashboardId int64 - Original int - New int + BaseVersion int + NewVersion int DiffType DiffType Delta []byte `json:"delta"` diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index 64459962348..bb7502bf0ad 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -30,17 +30,17 @@ func init() { // CompareDashboardVersionsCommand computes the JSON diff of two versions, // assigning the delta of the diff to the `Delta` field. func CompareDashboardVersionsCommand(cmd *m.CompareDashboardVersionsCommand) error { - original, err := getDashboardVersion(cmd.DashboardId, cmd.Original) + baseVersion, err := getDashboardVersion(cmd.DashboardId, cmd.BaseVersion) if err != nil { return err } - newDashboard, err := getDashboardVersion(cmd.DashboardId, cmd.New) + newVersion, err := getDashboardVersion(cmd.DashboardId, cmd.NewVersion) if err != nil { return err } - left, jsonDiff, err := getDiff(original, newDashboard) + left, jsonDiff, err := getDiff(baseVersion, newVersion) if err != nil { return err } diff --git a/pkg/services/sqlstore/dashboard_version_test.go b/pkg/services/sqlstore/dashboard_version_test.go index fa054b70a0b..d36db78d9cd 100644 --- a/pkg/services/sqlstore/dashboard_version_test.go +++ b/pkg/services/sqlstore/dashboard_version_test.go @@ -117,8 +117,8 @@ func TestCompareDashboardVersions(t *testing.T) { cmd := m.CompareDashboardVersionsCommand{ DashboardId: savedDash.Id, - Original: query.Result[0].Version, - New: query.Result[1].Version, + BaseVersion: query.Result[0].Version, + NewVersion: query.Result[1].Version, DiffType: m.DiffDelta, } @@ -130,8 +130,8 @@ func TestCompareDashboardVersions(t *testing.T) { Convey("Compare two versions that are the same", func() { cmd := m.CompareDashboardVersionsCommand{ DashboardId: savedDash.Id, - Original: savedDash.Version, - New: savedDash.Version, + BaseVersion: savedDash.Version, + NewVersion: savedDash.Version, DiffType: m.DiffDelta, } @@ -143,8 +143,8 @@ func TestCompareDashboardVersions(t *testing.T) { Convey("Compare two versions that don't exist", func() { cmd := m.CompareDashboardVersionsCommand{ DashboardId: savedDash.Id, - Original: 123, - New: 456, + BaseVersion: 123, + NewVersion: 456, DiffType: m.DiffDelta, } From e43d09e15b315ca688ea78e797ac47247927928e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Mon, 5 Jun 2017 23:31:45 +0200 Subject: [PATCH 095/130] fix: fixed failing frontend test --- public/app/features/dashboard/specs/history_ctrl_specs.ts | 5 ----- 1 file changed, 5 deletions(-) diff --git a/public/app/features/dashboard/specs/history_ctrl_specs.ts b/public/app/features/dashboard/specs/history_ctrl_specs.ts index fe64da04755..f8e4a3d25f1 100644 --- a/public/app/features/dashboard/specs/history_ctrl_specs.ts +++ b/public/app/features/dashboard/specs/history_ctrl_specs.ts @@ -268,11 +268,6 @@ describe('HistoryListCtrl', function() { expect(ctx.ctrl.loading).to.be(false); }); - it('should broadcast an event indicating the failure', function() { - expect($rootScope.appEvent.calledOnce).to.be(true); - expect($rootScope.appEvent.calledWith('alert-error')).to.be(true); - }); - it('should have an empty delta/changeset', function() { expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); }); From e2061312f583628015c20c061914da055a3b7f7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 00:14:40 +0200 Subject: [PATCH 096/130] refactoring: moved compare dashboard version command out of sqlstore, the code in this command did not use any sql operations and was more high level, could be moved out and use existing queries to get the versions --- pkg/api/dashboard.go | 50 +++---- pkg/components/dashdiffs/compare.go | 124 ++++++++++++++++++ .../formatter_basic.go | 8 +- .../formatter_json.go | 2 +- pkg/models/dashboard_version.go | 23 ---- pkg/services/sqlstore/dashboard_version.go | 91 ------------- .../sqlstore/dashboard_version_test.go | 56 -------- 7 files changed, 156 insertions(+), 198 deletions(-) create mode 100644 pkg/components/dashdiffs/compare.go rename pkg/components/{formatter => dashdiffs}/formatter_basic.go (99%) rename pkg/components/{formatter => dashdiffs}/formatter_json.go (99%) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index b0a38c63eb1..736461cabae 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -11,6 +11,7 @@ import ( "github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/components/dashdiffs" "github.com/grafana/grafana/pkg/components/simplejson" "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/metrics" @@ -324,8 +325,7 @@ func GetDashboardVersion(c *middleware.Context) Response { return Json(200, dashVersionMeta) } -func createCompareDashboardVersionCommand(c *middleware.Context) (*m.CompareDashboardVersionsCommand, error) { - cmd := &m.CompareDashboardVersionsCommand{} +func getDashboardVersionDiffOptions(c *middleware.Context, diffType dashdiffs.DiffType) (*dashdiffs.Options, error) { dashId := c.ParamsInt64(":dashboardId") if dashId == 0 { @@ -347,39 +347,42 @@ func createCompareDashboardVersionCommand(c *middleware.Context) (*m.CompareDash return nil, fmt.Errorf("bad format: second argument is not of type int") } - cmd.DashboardId = dashId - cmd.OrgId = c.OrgId - cmd.BaseVersion = BaseVersion - cmd.NewVersion = newVersion + options := &dashdiffs.Options{} + options.DashboardId = dashId + options.OrgId = c.OrgId + options.BaseVersion = BaseVersion + options.NewVersion = newVersion + options.DiffType = diffType - return cmd, nil + return options, nil } // CompareDashboardVersions compares dashboards the way the GitHub API does. func CompareDashboardVersions(c *middleware.Context) Response { - cmd, err := createCompareDashboardVersionCommand(c) + options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffDelta) + if err != nil { return ApiError(500, err.Error(), err) } - cmd.DiffType = m.DiffDelta - - if err := bus.Dispatch(&cmd); err != nil { + result, err := dashdiffs.GetVersionDiff(options) + if err != nil { return ApiError(500, "Unable to compute diff", err) } // here the output is already JSON, so we need to unmarshal it into a // map before marshaling the entire response + deltaMap := make(map[string]interface{}) - err = json.Unmarshal(cmd.Delta, &deltaMap) + err = json.Unmarshal(result.Delta, &deltaMap) if err != nil { return ApiError(500, err.Error(), err) } return Json(200, util.DynMap{ "meta": util.DynMap{ - "baseVersion": cmd.BaseVersion, - "newVersion": cmd.NewVersion, + "baseVersion": options.BaseVersion, + "newVersion": options.NewVersion, }, "delta": deltaMap, }) @@ -388,34 +391,35 @@ func CompareDashboardVersions(c *middleware.Context) Response { // CompareDashboardVersionsJSON compares dashboards the way the GitHub API does, // returning a human-readable JSON diff. func CompareDashboardVersionsJSON(c *middleware.Context) Response { - cmd, err := createCompareDashboardVersionCommand(c) + options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffJSON) + if err != nil { return ApiError(500, err.Error(), err) } - cmd.DiffType = m.DiffJSON - if err := bus.Dispatch(cmd); err != nil { + result, err := dashdiffs.GetVersionDiff(options) + if err != nil { return ApiError(500, err.Error(), err) } - return Respond(200, cmd.Delta).Header("Content-Type", "text/html") + return Respond(200, result.Delta).Header("Content-Type", "text/html") } // CompareDashboardVersionsBasic compares dashboards the way the GitHub API does, // returning a human-readable diff. func CompareDashboardVersionsBasic(c *middleware.Context) Response { - cmd, err := createCompareDashboardVersionCommand(c) + options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffBasic) + if err != nil { return ApiError(500, err.Error(), err) } - cmd.DiffType = m.DiffBasic - - if err := bus.Dispatch(cmd); err != nil { + result, err := dashdiffs.GetVersionDiff(options) + if err != nil { return ApiError(500, err.Error(), err) } - return Respond(200, cmd.Delta).Header("Content-Type", "text/html") + return Respond(200, result.Delta).Header("Content-Type", "text/html") } // RestoreDashboardVersion restores a dashboard to the given version. diff --git a/pkg/components/dashdiffs/compare.go b/pkg/components/dashdiffs/compare.go new file mode 100644 index 00000000000..a559c5b16f9 --- /dev/null +++ b/pkg/components/dashdiffs/compare.go @@ -0,0 +1,124 @@ +package dashdiffs + +import ( + "encoding/json" + "errors" + + "github.com/grafana/grafana/pkg/bus" + "github.com/grafana/grafana/pkg/components/simplejson" + "github.com/grafana/grafana/pkg/models" + diff "github.com/yudai/gojsondiff" + deltaFormatter "github.com/yudai/gojsondiff/formatter" +) + +type DiffType int + +const ( + DiffJSON DiffType = iota + DiffBasic + DiffDelta +) + +var ( + // ErrUnsupportedDiffType occurs when an invalid diff type is used. + ErrUnsupportedDiffType = errors.New("dashdiff: unsupported diff type") + + // ErrNilDiff occurs when two compared interfaces are identical. + ErrNilDiff = errors.New("dashdiff: diff is nil") +) + +type Options struct { + OrgId int64 + DashboardId int64 + BaseVersion int + NewVersion int + DiffType DiffType +} + +type Result struct { + Delta []byte `json:"delta"` +} + +// CompareDashboardVersionsCommand computes the JSON diff of two versions, +// assigning the delta of the diff to the `Delta` field. +func GetVersionDiff(options *Options) (*Result, error) { + baseVersionQuery := models.GetDashboardVersionQuery{ + DashboardId: options.DashboardId, + Version: options.BaseVersion, + } + + if err := bus.Dispatch(&baseVersionQuery); err != nil { + return nil, err + } + + newVersionQuery := models.GetDashboardVersionQuery{ + DashboardId: options.DashboardId, + Version: options.NewVersion, + } + + if err := bus.Dispatch(&newVersionQuery); err != nil { + return nil, err + } + + left, jsonDiff, err := getDiff(baseVersionQuery.Result, newVersionQuery.Result) + if err != nil { + return nil, err + } + + result := &Result{} + + switch options.DiffType { + case DiffDelta: + + deltaOutput, err := deltaFormatter.NewDeltaFormatter().Format(jsonDiff) + if err != nil { + return nil, err + } + result.Delta = []byte(deltaOutput) + + case DiffJSON: + jsonOutput, err := NewJSONFormatter(left).Format(jsonDiff) + if err != nil { + return nil, err + } + result.Delta = []byte(jsonOutput) + + case DiffBasic: + basicOutput, err := NewBasicFormatter(left).Format(jsonDiff) + if err != nil { + return nil, err + } + result.Delta = basicOutput + + default: + return nil, ErrUnsupportedDiffType + } + + return result, nil +} + +// getDiff computes the diff of two dashboard versions. +func getDiff(originalDash, newDash *models.DashboardVersion) (interface{}, diff.Diff, error) { + leftBytes, err := simplejson.NewFromAny(originalDash).Encode() + if err != nil { + return nil, nil, err + } + + rightBytes, err := simplejson.NewFromAny(newDash).Encode() + if err != nil { + return nil, nil, err + } + + jsonDiff, err := diff.New().Compare(leftBytes, rightBytes) + if err != nil { + return nil, nil, err + } + + if !jsonDiff.Modified() { + return nil, nil, ErrNilDiff + } + + left := make(map[string]interface{}) + err = json.Unmarshal(leftBytes, &left) + return left, jsonDiff, nil +} diff --git a/pkg/components/formatter/formatter_basic.go b/pkg/components/dashdiffs/formatter_basic.go similarity index 99% rename from pkg/components/formatter/formatter_basic.go rename to pkg/components/dashdiffs/formatter_basic.go index bf460f95f90..ea935604349 100644 --- a/pkg/components/formatter/formatter_basic.go +++ b/pkg/components/dashdiffs/formatter_basic.go @@ -1,4 +1,4 @@ -package formatter +package dashdiffs import ( "bytes" @@ -261,7 +261,7 @@ var ( line-display="{{ .LineStart }}{{ if .LineEnd }} - {{ .LineEnd }}{{ end }}" switch-view="ctrl.getDiff('html')" /> - {{ end }} + {{ end }}
      @@ -286,7 +286,7 @@ var (
    • {{ getChange .Change }} {{ .Key }}
      - +
      {{ if .Old }}
      {{ .Old }}
      @@ -312,7 +312,7 @@ var ( tplSummary = `{{ define "summary" -}}
      - + {{ if .Count }} {{ .Count }} {{ end }} diff --git a/pkg/components/formatter/formatter_json.go b/pkg/components/dashdiffs/formatter_json.go similarity index 99% rename from pkg/components/formatter/formatter_json.go rename to pkg/components/dashdiffs/formatter_json.go index 97d9aaf9e42..a2807b15992 100644 --- a/pkg/components/formatter/formatter_json.go +++ b/pkg/components/dashdiffs/formatter_json.go @@ -1,4 +1,4 @@ -package formatter +package dashdiffs import ( "bytes" diff --git a/pkg/models/dashboard_version.go b/pkg/models/dashboard_version.go index 949ad5f1f6a..06b5797e57c 100644 --- a/pkg/models/dashboard_version.go +++ b/pkg/models/dashboard_version.go @@ -7,14 +7,6 @@ import ( "github.com/grafana/grafana/pkg/components/simplejson" ) -type DiffType int - -const ( - DiffJSON DiffType = iota - DiffBasic - DiffDelta -) - var ( ErrDashboardVersionNotFound = errors.New("Dashboard version not found") ErrNoVersionsForDashboardId = errors.New("No dashboard versions found for the given DashboardId") @@ -77,18 +69,3 @@ type GetDashboardVersionsQuery struct { Result []*DashboardVersionDTO } - -// -// Commands -// - -// CompareDashboardVersionsCommand is used to compare two versions. -type CompareDashboardVersionsCommand struct { - OrgId int64 - DashboardId int64 - BaseVersion int - NewVersion int - DiffType DiffType - - Delta []byte `json:"delta"` -} diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index bb7502bf0ad..4079cd9ddf7 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -1,80 +1,15 @@ package sqlstore import ( - "encoding/json" - "errors" - "github.com/grafana/grafana/pkg/bus" - "github.com/grafana/grafana/pkg/components/formatter" - "github.com/grafana/grafana/pkg/components/simplejson" m "github.com/grafana/grafana/pkg/models" - - diff "github.com/yudai/gojsondiff" - deltaFormatter "github.com/yudai/gojsondiff/formatter" -) - -var ( - // ErrUnsupportedDiffType occurs when an invalid diff type is used. - ErrUnsupportedDiffType = errors.New("sqlstore: unsupported diff type") - - // ErrNilDiff occurs when two compared interfaces are identical. - ErrNilDiff = errors.New("sqlstore: diff is nil") ) func init() { - bus.AddHandler("sql", CompareDashboardVersionsCommand) bus.AddHandler("sql", GetDashboardVersion) bus.AddHandler("sql", GetDashboardVersions) } -// CompareDashboardVersionsCommand computes the JSON diff of two versions, -// assigning the delta of the diff to the `Delta` field. -func CompareDashboardVersionsCommand(cmd *m.CompareDashboardVersionsCommand) error { - baseVersion, err := getDashboardVersion(cmd.DashboardId, cmd.BaseVersion) - if err != nil { - return err - } - - newVersion, err := getDashboardVersion(cmd.DashboardId, cmd.NewVersion) - if err != nil { - return err - } - - left, jsonDiff, err := getDiff(baseVersion, newVersion) - if err != nil { - return err - } - - switch cmd.DiffType { - case m.DiffDelta: - - deltaOutput, err := deltaFormatter.NewDeltaFormatter().Format(jsonDiff) - if err != nil { - return err - } - cmd.Delta = []byte(deltaOutput) - - case m.DiffJSON: - jsonOutput, err := formatter.NewJSONFormatter(left).Format(jsonDiff) - if err != nil { - return err - } - cmd.Delta = []byte(jsonOutput) - - case m.DiffBasic: - basicOutput, err := formatter.NewBasicFormatter(left).Format(jsonDiff) - if err != nil { - return err - } - cmd.Delta = basicOutput - - default: - return ErrUnsupportedDiffType - } - - return nil -} - // GetDashboardVersion gets the dashboard version for the given dashboard ID // and version number. func GetDashboardVersion(query *m.GetDashboardVersionQuery) error { @@ -145,29 +80,3 @@ func getDashboard(dashboardId int64) (*m.Dashboard, error) { } return &dashboard, nil } - -// getDiff computes the diff of two dashboard versions. -func getDiff(originalDash, newDash *m.DashboardVersion) (interface{}, diff.Diff, error) { - leftBytes, err := simplejson.NewFromAny(originalDash).Encode() - if err != nil { - return nil, nil, err - } - - rightBytes, err := simplejson.NewFromAny(newDash).Encode() - if err != nil { - return nil, nil, err - } - - jsonDiff, err := diff.New().Compare(leftBytes, rightBytes) - if err != nil { - return nil, nil, err - } - - if !jsonDiff.Modified() { - return nil, nil, ErrNilDiff - } - - left := make(map[string]interface{}) - err = json.Unmarshal(leftBytes, &left) - return left, jsonDiff, nil -} diff --git a/pkg/services/sqlstore/dashboard_version_test.go b/pkg/services/sqlstore/dashboard_version_test.go index d36db78d9cd..eb7e549ba7c 100644 --- a/pkg/services/sqlstore/dashboard_version_test.go +++ b/pkg/services/sqlstore/dashboard_version_test.go @@ -98,59 +98,3 @@ func TestGetDashboardVersions(t *testing.T) { }) }) } - -func TestCompareDashboardVersions(t *testing.T) { - Convey("Testing dashboard version comparison", t, func() { - InitTestDB(t) - - savedDash := insertTestDashboard("test dash 43", 1, "x") - updateTestDashboard(savedDash, map[string]interface{}{ - "tags": "y", - }) - - Convey("Compare two versions that are different", func() { - query := m.GetDashboardVersionsQuery{DashboardId: savedDash.Id, OrgId: 1} - - err := GetDashboardVersions(&query) - So(err, ShouldBeNil) - So(len(query.Result), ShouldEqual, 2) - - cmd := m.CompareDashboardVersionsCommand{ - DashboardId: savedDash.Id, - BaseVersion: query.Result[0].Version, - NewVersion: query.Result[1].Version, - DiffType: m.DiffDelta, - } - - err = CompareDashboardVersionsCommand(&cmd) - So(err, ShouldBeNil) - So(cmd.Delta, ShouldNotBeNil) - }) - - Convey("Compare two versions that are the same", func() { - cmd := m.CompareDashboardVersionsCommand{ - DashboardId: savedDash.Id, - BaseVersion: savedDash.Version, - NewVersion: savedDash.Version, - DiffType: m.DiffDelta, - } - - err := CompareDashboardVersionsCommand(&cmd) - So(err, ShouldNotBeNil) - So(cmd.Delta, ShouldBeNil) - }) - - Convey("Compare two versions that don't exist", func() { - cmd := m.CompareDashboardVersionsCommand{ - DashboardId: savedDash.Id, - BaseVersion: 123, - NewVersion: 456, - DiffType: m.DiffDelta, - } - - err := CompareDashboardVersionsCommand(&cmd) - So(err, ShouldNotBeNil) - So(cmd.Delta, ShouldBeNil) - }) - }) -} From 689e366f59aa3e2bc77a7e63bb501eafc35f294b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 09:51:14 +0200 Subject: [PATCH 097/130] refactoring: updated api url routes so they do not conflict with slug route --- pkg/api/api.go | 12 ++++++------ public/app/features/dashboard/history/history_srv.ts | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/pkg/api/api.go b/pkg/api/api.go index aba3ed348ab..636d61e14d3 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -224,12 +224,12 @@ func (hs *HttpServer) registerRoutes() { r.Group("/dashboards", func() { r.Combo("/db/:slug").Get(GetDashboard).Delete(DeleteDashboard) - r.Get("/db/:dashboardId/versions", wrap(GetDashboardVersions)) - r.Get("/db/:dashboardId/versions/:id", wrap(GetDashboardVersion)) - r.Get("/db/:dashboardId/compare/:versions", wrap(CompareDashboardVersions)) - r.Get("/db/:dashboardId/compare/:versions/html", wrap(CompareDashboardVersionsJSON)) - r.Get("/db/:dashboardId/compare/:versions/basic", wrap(CompareDashboardVersionsBasic)) - r.Post("/db/:dashboardId/restore", reqEditorRole, bind(dtos.RestoreDashboardVersionCommand{}), wrap(RestoreDashboardVersion)) + r.Get("/id/:dashboardId/versions", wrap(GetDashboardVersions)) + r.Get("/id/:dashboardId/versions/:id", wrap(GetDashboardVersion)) + r.Get("/id/:dashboardId/compare/:versions", wrap(CompareDashboardVersions)) + r.Get("/id/:dashboardId/compare/:versions/html", wrap(CompareDashboardVersionsJSON)) + r.Get("/id/:dashboardId/compare/:versions/basic", wrap(CompareDashboardVersionsBasic)) + r.Post("/id/:dashboardId/restore", reqEditorRole, bind(dtos.RestoreDashboardVersionCommand{}), wrap(RestoreDashboardVersion)) r.Post("/db", reqEditorRole, bind(m.SaveDashboardCommand{}), wrap(PostDashboard)) r.Get("/file/:file", GetDashboardFromJsonFile) diff --git a/public/app/features/dashboard/history/history_srv.ts b/public/app/features/dashboard/history/history_srv.ts index 1069e9be8e2..ba9ad3975de 100644 --- a/public/app/features/dashboard/history/history_srv.ts +++ b/public/app/features/dashboard/history/history_srv.ts @@ -11,18 +11,18 @@ export class HistorySrv { getHistoryList(dashboard: DashboardModel, options: HistoryListOpts) { const id = dashboard && dashboard.id ? dashboard.id : void 0; - return id ? this.backendSrv.get(`api/dashboards/db/${id}/versions`, options) : this.$q.when([]); + return id ? this.backendSrv.get(`api/dashboards/id/${id}/versions`, options) : this.$q.when([]); } compareVersions(dashboard: DashboardModel, compare: { new: number, original: number }, view = 'html') { const id = dashboard && dashboard.id ? dashboard.id : void 0; - const url = `api/dashboards/db/${id}/compare/${compare.original}...${compare.new}/${view}`; + const url = `api/dashboards/id/${id}/compare/${compare.original}...${compare.new}/${view}`; return id ? this.backendSrv.get(url) : this.$q.when({}); } restoreDashboard(dashboard: DashboardModel, version: number) { const id = dashboard && dashboard.id ? dashboard.id : void 0; - const url = `api/dashboards/db/${id}/restore`; + const url = `api/dashboards/id/${id}/restore`; return id && _.isNumber(version) ? this.backendSrv.post(url, { version }) : this.$q.when({}); } } From 88da3a99e17ef8b9d3c32d98e2c6f3eebea85ac6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 11:03:56 +0200 Subject: [PATCH 098/130] refactoring: trying to remove all the css overrides in history tab and make the styles more more inline with best practice css, and if needed use modifier overrides instead --- public/app/core/components/switch.ts | 3 +- .../features/dashboard/history/history.html | 123 +++++++++--------- public/sass/components/_filter-table.scss | 17 ++- public/sass/components/_gf-form.scss | 4 - public/sass/components/_switch.scss | 17 ++- public/sass/pages/_history.scss | 58 --------- 6 files changed, 87 insertions(+), 135 deletions(-) diff --git a/public/app/core/components/switch.ts b/public/app/core/components/switch.ts index 889398d5138..371b1ffe112 100644 --- a/public/app/core/components/switch.ts +++ b/public/app/core/components/switch.ts @@ -7,7 +7,7 @@ import coreModule from 'app/core/core_module'; import Drop from 'tether-drop'; var template = ` -
      diff --git a/public/sass/components/_filter-table.scss b/public/sass/components/_filter-table.scss index 67ea8327c0c..65ca43cc6a9 100644 --- a/public/sass/components/_filter-table.scss +++ b/public/sass/components/_filter-table.scss @@ -19,24 +19,21 @@ .filter-table tr { background: $grafanaListBackground; - border-bottom: 2px solid $page-bg; + border-bottom: 3px solid $page-bg; } .filter-table th { width: auto; - padding: 10px 15px 10px 0; + padding: $table-cell-padding; text-align: left; - - &:first-child { - padding-left: 15px; - } } .filter-table td { - padding: 15px 15px 15px 0; + padding: $table-cell-padding; - &:first-child { - padding-left: 15px; + &.filter-table__switch-cell { + padding: 0; + border-right: 3px solid $page-bg; } } @@ -55,3 +52,5 @@ .filter-table .expanded > td { padding-bottom: 0; } + + diff --git a/public/sass/components/_gf-form.scss b/public/sass/components/_gf-form.scss index 888b9bad238..7ff07b6e887 100644 --- a/public/sass/components/_gf-form.scss +++ b/public/sass/components/_gf-form.scss @@ -232,10 +232,6 @@ $gf-form-margin: 0.25rem; flex-grow: 0; } -.gf-form-switch { - margin-right: $gf-form-margin; -} - .natural-language-input { &input[type="number"] { font-size: $font-size-base; diff --git a/public/sass/components/_switch.scss b/public/sass/components/_switch.scss index 00b50c6da9a..f09e83f8908 100644 --- a/public/sass/components/_switch.scss +++ b/public/sass/components/_switch.scss @@ -11,6 +11,7 @@ $switch-height: 1.5rem; max-width: 4.5rem; flex-grow: 1; min-width: 4.0rem; + margin-right: $gf-form-margin; input { position: absolute; @@ -42,8 +43,10 @@ $switch-height: 1.5rem; color: #fff; font-size: $font-size-sm; text-align: center; - line-height: 2.8rem; font-size: 150%; + display: flex; + flex-direction: column; + justify-content: center; } &:hover { @@ -89,6 +92,14 @@ $switch-height: 1.5rem; transform: rotateY(0); } + &--table-cell { + margin-bottom: 0; + margin-right: 0; + + input + label { + height: 3.6rem; + } + } } gf-form-switch[disabled] { @@ -96,5 +107,9 @@ gf-form-switch[disabled] { .gf-form-switch input + label { cursor: default; pointer-events: none !important; + &::before { + color: $text-color-faint; + text-shadow: none; + } } } diff --git a/public/sass/pages/_history.scss b/public/sass/pages/_history.scss index bb3770a1836..eb2ac4181ee 100644 --- a/public/sass/pages/_history.scss +++ b/public/sass/pages/_history.scss @@ -1,61 +1,3 @@ -// History Table -.history-table { - // .gf-form overrides - .gf-form-label { display: none; } - - .gf-form-switch { - margin-bottom: 0; - - input + label { - height: 3.6rem; - width: 110%; - } - - input + label::before, input + label::after { - background-color: $diff-switch-bg; - background-image: none; - border: 0; - height: 50px; - line-height: 3.7rem; - } - } - - gf-form-switch[disabled] { - .gf-form-switch input + label { - &::before { - color: $diff-switch-disabled; - text-shadow: none; - } - } - } - - // .filter-table overrides - .filter-table { - tr { - border-bottom: 3px solid $page-bg; - } - - thead tr { - border-width: 3px; - } - - $date-padding: 1em; - - td { - padding: 0; - - &:nth-child(2) { - border-left: 5px solid $page-bg; - padding-left: 1.5em; - } - &:nth-child(3) { padding-left: $date-padding; } - &:last-child { padding-right: 1.5em; } - } - - th:nth-child(2) { padding-left: 0.5em; } - th:nth-child(3) { padding-left: $date-padding; } - } -} // Diff View .history-list { From 546d489dd3e0105dd5a00535a63064315100bcd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 14:27:30 +0200 Subject: [PATCH 099/130] dashboard_history: restored unsaved changes modal to simple cancel, discard, save --- public/app/features/dashboard/all.js | 1 + .../features/dashboard/unsavedChangesSrv.js | 46 +++++++------- .../dashboard/unsaved_changes_modal.ts | 63 +++++++++++++++++++ public/app/partials/unsaved-changes.html | 54 ---------------- 4 files changed, 86 insertions(+), 78 deletions(-) create mode 100644 public/app/features/dashboard/unsaved_changes_modal.ts delete mode 100644 public/app/partials/unsaved-changes.html diff --git a/public/app/features/dashboard/all.js b/public/app/features/dashboard/all.js index 9ca6f190c63..cdea7aab3c6 100644 --- a/public/app/features/dashboard/all.js +++ b/public/app/features/dashboard/all.js @@ -13,6 +13,7 @@ define([ './viewStateSrv', './time_srv', './unsavedChangesSrv', + './unsaved_changes_modal', './timepicker/timepicker', './graphiteImportCtrl', './impression_store', diff --git a/public/app/features/dashboard/unsavedChangesSrv.js b/public/app/features/dashboard/unsavedChangesSrv.js index df38c7843f8..766ebce0b59 100644 --- a/public/app/features/dashboard/unsavedChangesSrv.js +++ b/public/app/features/dashboard/unsavedChangesSrv.js @@ -134,34 +134,31 @@ function(angular, _) { return currentJson !== originalJson; }; + p.discardChanges = function() { + this.original = null; + this.gotoNext(); + }; + p.open_modal = function() { - var tracker = this; - var dashboard = this.current; - - var modalScope = this.scope.$new(); - var clone = dashboard.getSaveModelClone(); - - modalScope.clone = clone; - modalScope.ignore = function() { - tracker.original = null; - tracker.goto_next(); - }; - - var cancel = $rootScope.$on('dashboard-saved', function() { - cancel(); - $timeout(function() { - tracker.goto_next(); - }); - }); - $rootScope.appEvent('show-modal', { - src: 'public/app/partials/unsaved-changes.html', - scope: modalScope, - modalClass: 'modal--narrow' + templateHtml: '', + modalClass: 'modal--narrow confirm-modal' }); }; - p.goto_next = function() { + p.saveChanges = function() { + var self = this; + var cancel = $rootScope.$on('dashboard-saved', function() { + cancel(); + $timeout(function() { + self.gotoNext(); + }); + }); + + $rootScope.appEvent('save-dashboard'); + }; + + p.gotoNext = function() { var baseLen = $location.absUrl().length - $location.url().length; var nextUrl = this.next.substring(baseLen); $location.url(nextUrl); @@ -169,7 +166,8 @@ function(angular, _) { this.Tracker = Tracker; this.init = function(dashboard, scope) { - return new Tracker(dashboard, scope, 1000); + this.tracker = new Tracker(dashboard, scope, 1000); + return this.tracker; }; }); }); diff --git a/public/app/features/dashboard/unsaved_changes_modal.ts b/public/app/features/dashboard/unsaved_changes_modal.ts new file mode 100644 index 00000000000..c206ecc2d21 --- /dev/null +++ b/public/app/features/dashboard/unsaved_changes_modal.ts @@ -0,0 +1,63 @@ +/// + +import coreModule from 'app/core/core_module'; + +const template = ` +
      +
      +

      + + Unsaved changes +

      + + + + +
      + +
      + +
      + What do you want to do? +
      + +
      + + + +
      +
      +
      +`; + +export class UnsavedChangesModalCtrl { + clone: any; + dismiss: () => void; + + /** @ngInject */ + constructor(private $rootScope, private unsavedChangesSrv) { + } + + discard() { + this.dismiss(); + this.unsavedChangesSrv.tracker.discardChanges(); + } + + save() { + this.dismiss(); + this.unsavedChangesSrv.tracker.saveChanges(); + } +} + +export function unsavedChangesModalDirective() { + return { + restrict: 'E', + template: template, + controller: UnsavedChangesModalCtrl, + bindToController: true, + controllerAs: 'ctrl', + scope: {dismiss: "&"} + }; +} + +coreModule.directive('unsavedChangesModal', unsavedChangesModalDirective); diff --git a/public/app/partials/unsaved-changes.html b/public/app/partials/unsaved-changes.html deleted file mode 100644 index 949cef55e7b..00000000000 --- a/public/app/partials/unsaved-changes.html +++ /dev/null @@ -1,54 +0,0 @@ -
      -
      -

      - - Unsaved changes -

      - - - - -
      - -
      -
      - You're leaving without saving your changes, are you sure you want to leave? To save, add a small note to describe the changes in this version. -
      -
      -
      - -
      -
      - -
      - - - -
      -
      - -
      - From 9b629cd5a68b1cc0d422addc1b745d19e1107ec7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 14:28:21 +0200 Subject: [PATCH 100/130] dashboard_history: fixed history srv unit tests --- public/app/features/dashboard/specs/history_srv_specs.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/public/app/features/dashboard/specs/history_srv_specs.ts b/public/app/features/dashboard/specs/history_srv_specs.ts index 18a114490f9..2d01f323d35 100644 --- a/public/app/features/dashboard/specs/history_srv_specs.ts +++ b/public/app/features/dashboard/specs/history_srv_specs.ts @@ -15,9 +15,9 @@ describe('historySrv', function() { beforeEach(angularMocks.module('grafana.services')); beforeEach(angularMocks.inject(function($httpBackend) { ctx.$httpBackend = $httpBackend; - $httpBackend.whenRoute('GET', 'api/dashboards/db/:id/versions').respond(versionsResponse); - $httpBackend.whenRoute('GET', 'api/dashboards/db/:id/compare/:original...:new').respond(compareResponse); - $httpBackend.whenRoute('POST', 'api/dashboards/db/:id/restore') + $httpBackend.whenRoute('GET', 'api/dashboards/id/:id/versions').respond(versionsResponse); + $httpBackend.whenRoute('GET', 'api/dashboards/id/:id/compare/:original...:new').respond(compareResponse); + $httpBackend.whenRoute('POST', 'api/dashboards/id/:id/restore') .respond(function(method, url, data, headers, params) { const parsedData = JSON.parse(data); return [200, restoreResponse(parsedData.version)]; From 5409f4c0ebb7aac143dd8dff95a15a5f2d83f9df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 14:39:57 +0200 Subject: [PATCH 101/130] dashboard_history: fixed issue with save as & overwrite --- pkg/services/sqlstore/dashboard.go | 1 + 1 file changed, 1 insertion(+) diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index b46d1961305..33b67cefd43 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -63,6 +63,7 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { if dash.Id != sameTitle.Id { if cmd.Overwrite { dash.Id = sameTitle.Id + dash.Version = sameTitle.Version } else { return m.ErrDashboardWithSameNameExists } From 7b5f7ed5538b711defbd42f80722904fb87e6668 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 15:40:10 +0200 Subject: [PATCH 102/130] dashboard_history: SQL did not work when using MySQL, fixes to dashboard version numbering, so inserts start at 1, added migration to fix old dashboards with version 0 --- pkg/api/dashboard.go | 3 +++ pkg/services/sqlstore/dashboard.go | 1 + pkg/services/sqlstore/dashboard_version.go | 8 ++++---- pkg/services/sqlstore/migrations/dashboard_version_mig.go | 7 +++++++ public/app/core/nav_model_srv.ts | 2 +- public/app/features/dashboard/history/history.html | 2 +- 6 files changed, 17 insertions(+), 6 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 736461cabae..8556dcf2994 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -64,6 +64,9 @@ func GetDashboard(c *middleware.Context) { creator = getUserLogin(dash.CreatedBy) } + // make sure db version is in sync with json model version + dash.Data.Set("version", dash.Version) + dto := dtos.DashboardFullWithMeta{ Dashboard: dash.Data, Meta: dtos.DashboardMeta{ diff --git a/pkg/services/sqlstore/dashboard.go b/pkg/services/sqlstore/dashboard.go index 33b67cefd43..50b02bf0970 100644 --- a/pkg/services/sqlstore/dashboard.go +++ b/pkg/services/sqlstore/dashboard.go @@ -74,6 +74,7 @@ func SaveDashboard(cmd *m.SaveDashboardCommand) error { affectedRows := int64(0) if dash.Id == 0 { + dash.Version = 1 metrics.M_Models_Dashboard_Insert.Inc(1) dash.Data.Set("version", dash.Version) affectedRows, err = sess.Insert(dash) diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index 4079cd9ddf7..3ff93b59bbf 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -33,10 +33,10 @@ func GetDashboardVersions(query *m.GetDashboardVersionsQuery) error { dashboard_version.created, dashboard_version.created_by as created_by_id, dashboard_version.message, - dashboard_version.data, - "user".login as created_by`). - Join("LEFT", "user", `dashboard_version.created_by = "user".id`). - Join("LEFT", "dashboard", `dashboard.id = "dashboard_version".dashboard_id`). + dashboard_version.data,`+ + dialect.Quote("user")+`.login as created_by`). + Join("LEFT", "user", `dashboard_version.created_by = `+dialect.Quote("user")+`.id`). + Join("LEFT", "dashboard", `dashboard.id = dashboard_version.dashboard_id`). Where("dashboard_version.dashboard_id=? AND dashboard.org_id=?", query.DashboardId, query.OrgId). OrderBy("dashboard_version.version DESC"). Limit(query.Limit, query.Start). diff --git a/pkg/services/sqlstore/migrations/dashboard_version_mig.go b/pkg/services/sqlstore/migrations/dashboard_version_mig.go index 01bced00dea..fee69b9ef4c 100644 --- a/pkg/services/sqlstore/migrations/dashboard_version_mig.go +++ b/pkg/services/sqlstore/migrations/dashboard_version_mig.go @@ -26,6 +26,13 @@ func addDashboardVersionMigration(mg *Migrator) { mg.AddMigration("add index dashboard_version.dashboard_id", NewAddIndexMigration(dashboardVersionV1, dashboardVersionV1.Indices[0])) mg.AddMigration("add unique index dashboard_version.dashboard_id and dashboard_version.version", NewAddIndexMigration(dashboardVersionV1, dashboardVersionV1.Indices[1])) + // before new dashboards where created with version 0, now they are always inserted with version 1 + const setVersionTo1WhereZeroSQL = `UPDATE dashboard SET version = 1 WHERE version = 0` + mg.AddMigration("Set dashboard version to 1 where 0", new(RawSqlMigration). + Sqlite(setVersionTo1WhereZeroSQL). + Postgres(setVersionTo1WhereZeroSQL). + Mysql(setVersionTo1WhereZeroSQL)) + const rawSQL = `INSERT INTO dashboard_version ( dashboard_id, diff --git a/public/app/core/nav_model_srv.ts b/public/app/core/nav_model_srv.ts index 99f09916753..a12b57752d1 100644 --- a/public/app/core/nav_model_srv.ts +++ b/public/app/core/nav_model_srv.ts @@ -168,7 +168,7 @@ export class NavModelSrv { }); menu.push({ - title: 'Version History', + title: 'Version history', icon: 'fa fa-fw fa-history', clickHandler: () => dashNavCtrl.openEditView('history') }); diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 431c37705c8..415bb3b794f 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -1,6 +1,6 @@

      - Version History + Version history

        From c4e872b9da626265f7c40d60fc2a833c873088a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 16:27:28 +0200 Subject: [PATCH 103/130] dashboard_history: minor changes and fixes --- public/app/core/nav_model_srv.ts | 12 +++++++----- public/app/features/dashboard/dashboard_srv.ts | 2 +- .../app/features/dashboard/unsaved_changes_modal.ts | 2 +- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/public/app/core/nav_model_srv.ts b/public/app/core/nav_model_srv.ts index a12b57752d1..4771f8c191c 100644 --- a/public/app/core/nav_model_srv.ts +++ b/public/app/core/nav_model_srv.ts @@ -167,11 +167,13 @@ export class NavModelSrv { clickHandler: () => dashNavCtrl.openEditView('annotations') }); - menu.push({ - title: 'Version history', - icon: 'fa fa-fw fa-history', - clickHandler: () => dashNavCtrl.openEditView('history') - }); + if (!dashboard.meta.isHome) { + menu.push({ + title: 'Version history', + icon: 'fa fa-fw fa-history', + clickHandler: () => dashNavCtrl.openEditView('history') + }); + } menu.push({ title: 'View JSON', diff --git a/public/app/features/dashboard/dashboard_srv.ts b/public/app/features/dashboard/dashboard_srv.ts index 205e7a8f9c6..9d622f4bbc7 100644 --- a/public/app/features/dashboard/dashboard_srv.ts +++ b/public/app/features/dashboard/dashboard_srv.ts @@ -127,7 +127,7 @@ export class DashboardSrv { showSaveModal() { this.$rootScope.appEvent('show-modal', { - templateHtml: '"', + templateHtml: '', scope: this.$rootScope.$new(), modalClass: 'modal--narrow' }); diff --git a/public/app/features/dashboard/unsaved_changes_modal.ts b/public/app/features/dashboard/unsaved_changes_modal.ts index c206ecc2d21..27ff094ca47 100644 --- a/public/app/features/dashboard/unsaved_changes_modal.ts +++ b/public/app/features/dashboard/unsaved_changes_modal.ts @@ -18,7 +18,7 @@ const template = `
        - What do you want to do? + Do you want to save you changes?
        From 948e5ae74df6409a30f3f6e56db065bf4eabe32e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 6 Jun 2017 23:04:14 +0200 Subject: [PATCH 104/130] dashboard_history: further css & markup fixes, removing style overrides & resuing existing styles and markup components --- pkg/api/dashboard.go | 2 +- .../features/dashboard/history/history.html | 100 ++++++++---------- public/sass/_variables.dark.scss | 3 - public/sass/components/edit_sidemenu.scss | 1 - public/sass/pages/_history.scss | 31 ------ 5 files changed, 48 insertions(+), 89 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 8556dcf2994..4b4f6fe8597 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -283,7 +283,7 @@ func GetDashboardVersions(c *middleware.Context) Response { for _, version := range query.Result { if version.RestoredFrom == version.Version { - version.Message = "Initial save (created migration)" + version.Message = "Initial save (created by migration)" continue } diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 415bb3b794f..53d960fd620 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -78,7 +78,7 @@
        -
        -
        -
        - +
        + -
        -
        - - Fetching changes… -
        +
        +
        + + Fetching changes… +
        -
        - -   Restore to version {{new}} - -

        - Comparing Version {{ctrl.selected[0]}} - - Version {{ctrl.selected[1]}} - (Current) -

        -
        -

        - Version {{new}} updated by - {{ctrl.getMeta(new, 'createdBy')}} - {{ctrl.formatBasicDate(ctrl.getMeta(new, 'created'))}} - - {{ctrl.getMeta(new, 'message')}} -

        -

        - Version {{original}} updated by - {{ctrl.getMeta(original, 'createdBy')}} - {{ctrl.formatBasicDate(ctrl.getMeta(original, 'created'))}} - - {{ctrl.getMeta(original, 'message')}} -

        -
        -
        -
        -
        -
        -
        -
        -
        -
        -
        +
        + +   Restore to version {{new}} + +

        + Comparing Version {{ctrl.selected[0]}} + + Version {{ctrl.selected[1]}} + (Current) +

        +
        +

        + Version {{new}} updated by + {{ctrl.getMeta(new, 'createdBy')}} + {{ctrl.formatBasicDate(ctrl.getMeta(new, 'created'))}} + - {{ctrl.getMeta(new, 'message')}} +

        +

        + Version {{original}} updated by + {{ctrl.getMeta(original, 'createdBy')}} + {{ctrl.formatBasicDate(ctrl.getMeta(original, 'created'))}} + - {{ctrl.getMeta(original, 'message')}} +

        +
        +
        +
        +
        +
        +
        +
        +
        diff --git a/public/sass/_variables.dark.scss b/public/sass/_variables.dark.scss index 90366da6087..cedaf096988 100644 --- a/public/sass/_variables.dark.scss +++ b/public/sass/_variables.dark.scss @@ -286,9 +286,6 @@ $footer-link-hover: $gray-4; $diff-label-bg: $dark-2; $diff-label-fg: $white; -$diff-switch-bg: $dark-5; -$diff-switch-disabled: $gray-1; - $diff-group-bg: $dark-4; $diff-arrow-color: $white; diff --git a/public/sass/components/edit_sidemenu.scss b/public/sass/components/edit_sidemenu.scss index 5da2f6a21ce..e84ae2c1914 100644 --- a/public/sass/components/edit_sidemenu.scss +++ b/public/sass/components/edit_sidemenu.scss @@ -10,7 +10,6 @@ } .edit-sidemenu-aside { - min-width: 6rem; margin-right: $spacer*2; } diff --git a/public/sass/pages/_history.scss b/public/sass/pages/_history.scss index eb2ac4181ee..3637907fb1a 100644 --- a/public/sass/pages/_history.scss +++ b/public/sass/pages/_history.scss @@ -1,30 +1,3 @@ - -// Diff View -.history-list { - h4 { - margin-bottom: 0.75em; - } - - .page-container { - padding: 0; - background: none; - } - - .page-sidebar { - margin-left: 0; - margin-right: 3em; - } - - .small.muted { margin-bottom: 0.25em; } - - .ui-list > li { - margin-bottom: 1.5em; - - & > a { padding-left: 15px; } - & > a.active { @include left-brand-border-gradient(); } - } -} - // Actual Diff #delta { margin: 2em 0; @@ -105,10 +78,6 @@ .diff-item-added, .diff-item-deleted { list-style: none; } -.diff-restore-btn { - float: right; -} - .diff-group { background: $diff-group-bg; font-size: 16px; From ef1dfed0d8a81cc5c388df54bcd50b169738c947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 11:50:09 +0200 Subject: [PATCH 105/130] dasboard_history: big refactoring of how the compare api looked, now a POST with a model for new & base version, refactored a simplified UI code as well, this was done to lay foundation to make it possible to do diff against current in browser unsaved version --- pkg/api/api.go | 5 +- pkg/api/dashboard.go | 109 +++----------- pkg/api/dtos/dashboard.go | 12 ++ pkg/components/dashdiffs/compare.go | 53 ++++--- .../features/dashboard/history/history.html | 57 ++++---- .../app/features/dashboard/history/history.ts | 138 ++++++++---------- .../features/dashboard/history/history_srv.ts | 35 ++++- .../app/features/dashboard/history/models.ts | 15 -- public/app/features/dashboard/model.ts | 2 +- .../dashboard/specs/history_ctrl_specs.ts | 89 ++++++----- .../dashboard/specs/history_srv_specs.ts | 22 --- 11 files changed, 235 insertions(+), 302 deletions(-) delete mode 100644 public/app/features/dashboard/history/models.ts diff --git a/pkg/api/api.go b/pkg/api/api.go index 636d61e14d3..c3a3728338d 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -226,11 +226,10 @@ func (hs *HttpServer) registerRoutes() { r.Get("/id/:dashboardId/versions", wrap(GetDashboardVersions)) r.Get("/id/:dashboardId/versions/:id", wrap(GetDashboardVersion)) - r.Get("/id/:dashboardId/compare/:versions", wrap(CompareDashboardVersions)) - r.Get("/id/:dashboardId/compare/:versions/html", wrap(CompareDashboardVersionsJSON)) - r.Get("/id/:dashboardId/compare/:versions/basic", wrap(CompareDashboardVersionsBasic)) r.Post("/id/:dashboardId/restore", reqEditorRole, bind(dtos.RestoreDashboardVersionCommand{}), wrap(RestoreDashboardVersion)) + r.Post("/calculate-diff", bind(dtos.CalculateDiffOptions{}), wrap(CalculateDashboardDiff)) + r.Post("/db", reqEditorRole, bind(m.SaveDashboardCommand{}), wrap(PostDashboard)) r.Get("/file/:file", GetDashboardFromJsonFile) r.Get("/home", wrap(GetHomeDashboard)) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 4b4f6fe8597..129faa3d01e 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -2,11 +2,9 @@ package api import ( "encoding/json" - "errors" "fmt" "os" "path" - "strconv" "strings" "github.com/grafana/grafana/pkg/api/dtos" @@ -328,101 +326,34 @@ func GetDashboardVersion(c *middleware.Context) Response { return Json(200, dashVersionMeta) } -func getDashboardVersionDiffOptions(c *middleware.Context, diffType dashdiffs.DiffType) (*dashdiffs.Options, error) { +// POST /api/dashboards/calculate-diff performs diffs on two dashboards +func CalculateDashboardDiff(c *middleware.Context, apiOptions dtos.CalculateDiffOptions) Response { - dashId := c.ParamsInt64(":dashboardId") - if dashId == 0 { - return nil, errors.New("Missing dashboardId") + options := dashdiffs.Options{ + OrgId: c.OrgId, + DiffType: dashdiffs.ParseDiffType(apiOptions.DiffType), + Base: dashdiffs.DiffTarget{ + DashboardId: apiOptions.Base.DashboardId, + Version: apiOptions.Base.Version, + UnsavedDashboard: apiOptions.Base.UnsavedDashboard, + }, + New: dashdiffs.DiffTarget{ + DashboardId: apiOptions.New.DashboardId, + Version: apiOptions.New.Version, + UnsavedDashboard: apiOptions.New.UnsavedDashboard, + }, } - versionStrings := strings.Split(c.Params(":versions"), "...") - if len(versionStrings) != 2 { - return nil, fmt.Errorf("bad format: urls should be in the format /versions/0...1") - } - - BaseVersion, err := strconv.Atoi(versionStrings[0]) - if err != nil { - return nil, fmt.Errorf("bad format: first argument is not of type int") - } - - newVersion, err := strconv.Atoi(versionStrings[1]) - if err != nil { - return nil, fmt.Errorf("bad format: second argument is not of type int") - } - - options := &dashdiffs.Options{} - options.DashboardId = dashId - options.OrgId = c.OrgId - options.BaseVersion = BaseVersion - options.NewVersion = newVersion - options.DiffType = diffType - - return options, nil -} - -// CompareDashboardVersions compares dashboards the way the GitHub API does. -func CompareDashboardVersions(c *middleware.Context) Response { - options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffDelta) - - if err != nil { - return ApiError(500, err.Error(), err) - } - - result, err := dashdiffs.GetVersionDiff(options) + result, err := dashdiffs.CalculateDiff(&options) if err != nil { return ApiError(500, "Unable to compute diff", err) } - // here the output is already JSON, so we need to unmarshal it into a - // map before marshaling the entire response - - deltaMap := make(map[string]interface{}) - err = json.Unmarshal(result.Delta, &deltaMap) - if err != nil { - return ApiError(500, err.Error(), err) + if options.DiffType == dashdiffs.DiffDelta { + return Respond(200, result.Delta).Header("Content-Type", "application/json") + } else { + return Respond(200, result.Delta).Header("Content-Type", "text/html") } - - return Json(200, util.DynMap{ - "meta": util.DynMap{ - "baseVersion": options.BaseVersion, - "newVersion": options.NewVersion, - }, - "delta": deltaMap, - }) -} - -// CompareDashboardVersionsJSON compares dashboards the way the GitHub API does, -// returning a human-readable JSON diff. -func CompareDashboardVersionsJSON(c *middleware.Context) Response { - options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffJSON) - - if err != nil { - return ApiError(500, err.Error(), err) - } - - result, err := dashdiffs.GetVersionDiff(options) - if err != nil { - return ApiError(500, err.Error(), err) - } - - return Respond(200, result.Delta).Header("Content-Type", "text/html") -} - -// CompareDashboardVersionsBasic compares dashboards the way the GitHub API does, -// returning a human-readable diff. -func CompareDashboardVersionsBasic(c *middleware.Context) Response { - options, err := getDashboardVersionDiffOptions(c, dashdiffs.DiffBasic) - - if err != nil { - return ApiError(500, err.Error(), err) - } - - result, err := dashdiffs.GetVersionDiff(options) - if err != nil { - return ApiError(500, err.Error(), err) - } - - return Respond(200, result.Delta).Header("Content-Type", "text/html") } // RestoreDashboardVersion restores a dashboard to the given version. diff --git a/pkg/api/dtos/dashboard.go b/pkg/api/dtos/dashboard.go index fd8a7115de2..6a11199bb1c 100644 --- a/pkg/api/dtos/dashboard.go +++ b/pkg/api/dtos/dashboard.go @@ -32,6 +32,18 @@ type DashboardRedirect struct { RedirectUri string `json:"redirectUri"` } +type CalculateDiffOptions struct { + Base CalculateDiffTarget `json:"base" binding:"Required"` + New CalculateDiffTarget `json:"new" binding:"Required"` + DiffType string `json:"DiffType" binding:"Required"` +} + +type CalculateDiffTarget struct { + DashboardId int64 `json:"dashboardId"` + Version int `json:"version"` + UnsavedDashboard *simplejson.Json `json:"unsavedDashboard"` +} + type RestoreDashboardVersionCommand struct { Version int `json:"version" binding:"Required"` } diff --git a/pkg/components/dashdiffs/compare.go b/pkg/components/dashdiffs/compare.go index a559c5b16f9..51c8a947ce1 100644 --- a/pkg/components/dashdiffs/compare.go +++ b/pkg/components/dashdiffs/compare.go @@ -11,14 +11,6 @@ import ( deltaFormatter "github.com/yudai/gojsondiff/formatter" ) -type DiffType int - -const ( - DiffJSON DiffType = iota - DiffBasic - DiffDelta -) - var ( // ErrUnsupportedDiffType occurs when an invalid diff type is used. ErrUnsupportedDiffType = errors.New("dashdiff: unsupported diff type") @@ -27,24 +19,49 @@ var ( ErrNilDiff = errors.New("dashdiff: diff is nil") ) +type DiffType int + +const ( + DiffJSON DiffType = iota + DiffBasic + DiffDelta +) + type Options struct { - OrgId int64 - DashboardId int64 - BaseVersion int - NewVersion int - DiffType DiffType + OrgId int64 + Base DiffTarget + New DiffTarget + DiffType DiffType +} + +type DiffTarget struct { + DashboardId int64 + Version int + UnsavedDashboard *simplejson.Json } type Result struct { Delta []byte `json:"delta"` } +func ParseDiffType(diff string) DiffType { + switch diff { + case "json": + return DiffJSON + case "basic": + return DiffBasic + case "delta": + return DiffDelta + } + return DiffBasic +} + // CompareDashboardVersionsCommand computes the JSON diff of two versions, // assigning the delta of the diff to the `Delta` field. -func GetVersionDiff(options *Options) (*Result, error) { +func CalculateDiff(options *Options) (*Result, error) { baseVersionQuery := models.GetDashboardVersionQuery{ - DashboardId: options.DashboardId, - Version: options.BaseVersion, + DashboardId: options.Base.DashboardId, + Version: options.Base.Version, } if err := bus.Dispatch(&baseVersionQuery); err != nil { @@ -52,8 +69,8 @@ func GetVersionDiff(options *Options) (*Result, error) { } newVersionQuery := models.GetDashboardVersionQuery{ - DashboardId: options.DashboardId, - Version: options.NewVersion, + DashboardId: options.New.DashboardId, + Version: options.New.Version, } if err := bus.Dispatch(&newVersionQuery); err != nil { diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 53d960fd620..ab64b48d342 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -5,16 +5,13 @@
        • - + List
        • - - Version {{ctrl.selected[0]}} Current - - - Version {{ctrl.selected[0]}} Version {{ctrl.selected[1]}} + + Version {{ctrl.baseInfo.version}} Version {{ctrl.newInfo.version}}
        @@ -47,15 +44,15 @@ - + + on-change="ctrl.revisionSelectionChanged()" + ng-disabled="!revision.checked && ctrl.canCompare"> {{revision.version}} - {{ctrl.formatDate(revision.created)}} + {{revision.createdDateString}} {{revision.createdBy}} {{revision.message}} @@ -63,7 +60,7 @@   Restore -   Current +   Latest @@ -80,9 +77,9 @@ + bs-tooltip="ctrl.canCompare ? '' : 'Select 2 versions to start comparing'" data-placement="bottom">   Compare versions @@ -113,36 +110,36 @@ Fetching changes…
        -
        +
        -   Restore to version {{new}} + ng-click="ctrl.restore(ctrl.baseInfo.version)" + ng-if="ctrl.isNewLatest"> +   Restore to version {{ctrl.baseInfo.version}}

        - Comparing Version {{ctrl.selected[0]}} + Comparing Version {{ctrl.baseInfo.version}} - Version {{ctrl.selected[1]}} - (Current) + Version {{ctrl.newInfo.version}} + (Latest)

        - Version {{new}} updated by - {{ctrl.getMeta(new, 'createdBy')}} - {{ctrl.formatBasicDate(ctrl.getMeta(new, 'created'))}} - - {{ctrl.getMeta(new, 'message')}} + Version {{ctrl.newInfo.version}} updated by + {{ctrl.newInfo.createdBy}} + {{ctrl.newInfo.ageString}} + - {{ctrl.newInfo.message}}

        - Version {{original}} updated by - {{ctrl.getMeta(original, 'createdBy')}} - {{ctrl.formatBasicDate(ctrl.getMeta(original, 'created'))}} - - {{ctrl.getMeta(original, 'message')}} + Version {{ctrl.baseInfo.version}} updated by + {{ctrl.baseInfo.createdBy}} + {{ctrl.baseInfo.ageString}} + - {{ctrl.baseInfo.message}}

        -
        +
        diff --git a/public/app/features/dashboard/history/history.ts b/public/app/features/dashboard/history/history.ts index 44d8a0f2226..5bd8ef7c895 100644 --- a/public/app/features/dashboard/history/history.ts +++ b/public/app/features/dashboard/history/history.ts @@ -7,20 +7,23 @@ import angular from 'angular'; import moment from 'moment'; import {DashboardModel} from '../model'; -import {HistoryListOpts, RevisionsModel} from './models'; +import {HistoryListOpts, RevisionsModel, CalculateDiffOptions, HistorySrv} from './history_srv'; export class HistoryListCtrl { appending: boolean; dashboard: DashboardModel; - delta: { basic: string; html: string; }; + delta: { basic: string; json: string; }; diff: string; limit: number; loading: boolean; max: number; mode: string; revisions: RevisionsModel[]; - selected: number[]; start: number; + newInfo: RevisionsModel; + baseInfo: RevisionsModel; + canCompare: boolean; + isNewLatest: boolean; /** @ngInject */ constructor(private $scope, @@ -29,9 +32,7 @@ export class HistoryListCtrl { private $window, private $timeout, private $q, - private contextSrv, - private historySrv) { - $scope.ctrl = this; + private historySrv: HistorySrv) { this.appending = false; this.diff = 'basic'; @@ -39,19 +40,22 @@ export class HistoryListCtrl { this.loading = false; this.max = 2; this.mode = 'list'; - this.selected = []; this.start = 0; + this.canCompare = false; + this.$rootScope.onAppEvent('dashboard-saved', this.onDashboardSaved.bind(this), $scope); this.resetFromSource(); + } - $scope.$watch('ctrl.mode', newVal => { - $window.scrollTo(0, 0); - if (newVal === 'list') { - this.reset(); - } - }); + onDashboardSaved() { + this.resetFromSource(); + } - $rootScope.onAppEvent('dashboard-saved', this.onDashboardSaved.bind(this)); + switchMode(mode: string) { + this.mode = mode; + if (this.mode === 'list') { + this.reset(); + } } dismiss() { @@ -63,26 +67,13 @@ export class HistoryListCtrl { this.getLog(true); } - compareRevisionStateChanged(revision: any) { - if (revision.checked) { - this.selected.push(revision.version); - } else { - _.remove(this.selected, version => version === revision.version); - } - this.selected = _.sortBy(this.selected); - } - - compareRevisionDisabled(checked: boolean) { - return (this.selected.length === this.max && !checked) || this.revisions.length === 1; + revisionSelectionChanged() { + let selected = _.filter(this.revisions, {checked: true}).length; + this.canCompare = selected === 2; } formatDate(date) { - date = moment.isMoment(date) ? date : moment(date); - const format = 'YYYY-MM-DD HH:mm:ss'; - - return this.dashboard.timezone === 'browser' ? - moment(date).format(format) : - moment.utc(date).format(format); + return this.dashboard.formatDate(date); } formatBasicDate(date) { @@ -92,29 +83,40 @@ export class HistoryListCtrl { } getDiff(diff: string) { - if (!this.isComparable()) { return; } // disable button but not tooltip - this.diff = diff; this.mode = 'compare'; - this.loading = true; - // instead of using lodash to find min/max we use the index - // due to the array being sorted in ascending order - const compare = { - new: this.selected[1], - original: this.selected[0], + // have it already been fetched? + if (this.delta[this.diff]) { + return this.$q.when(this.delta[this.diff]); + } + + const selected = _.filter(this.revisions, {checked: true}); + + this.newInfo = selected[0]; + this.baseInfo = selected[1]; + this.isNewLatest = this.newInfo.version === this.dashboard.version; + + this.loading = true; + const options: CalculateDiffOptions = { + new: { + dashboardId: this.dashboard.id, + version: this.newInfo.version, + }, + base: { + dashboardId: this.dashboard.id, + version: this.baseInfo.version, + }, + diffType: diff, }; - if (this.delta[this.diff]) { + return this.historySrv.calculateDiff(options).then(response => { + this.delta[this.diff] = response; + }).catch(() => { + this.mode = 'list'; + }).finally(() => { this.loading = false; - return this.$q.when(this.delta[this.diff]); - } else { - return this.historySrv.compareVersions(this.dashboard, compare, diff).then(response => { - this.delta[this.diff] = response; - }).catch(err => { - this.mode = 'list'; - }).finally(() => { this.loading = false; }); - } + }); } getLog(append = false) { @@ -126,48 +128,35 @@ export class HistoryListCtrl { }; return this.historySrv.getHistoryList(this.dashboard, options).then(revisions => { + // set formated dates & default values + for (let rev of revisions) { + rev.createdDateString = this.formatDate(rev.created); + rev.ageString = this.formatBasicDate(rev.created); + rev.checked = false; + } + this.revisions = append ? this.revisions.concat(revisions) : revisions; + }).catch(err => { - this.$rootScope.appEvent('alert-error', ['There was an error fetching the history list', (err.message || err)]); + this.loading = false; }).finally(() => { this.loading = false; this.appending = false; }); } - getMeta(version: number, property: string) { - const revision = _.find(this.revisions, rev => rev.version === version); - return revision[property]; - } - - isOriginalCurrent() { - return this.selected[1] === this.dashboard.version; - } - - isComparable() { - const isParamLength = this.selected.length === 2; - const areNumbers = this.selected.every(version => _.isNumber(version)); - const areValidVersions = _.filter(this.revisions, revision => { - return revision.version === this.selected[0] || revision.version === this.selected[1]; - }).length === 2; - return isParamLength && areNumbers && areValidVersions; - } - isLastPage() { return _.find(this.revisions, rev => rev.version === 1); } - onDashboardSaved() { - this.$rootScope.appEvent('hide-dash-editor'); - } - reset() { - this.delta = { basic: '', html: '' }; + this.delta = { basic: '', json: '' }; this.diff = 'basic'; this.mode = 'list'; this.revisions = _.map(this.revisions, rev => _.extend({}, rev, { checked: false })); - this.selected = []; + this.canCompare = false; this.start = 0; + this.isNewLatest = false; } resetFromSource() { @@ -191,7 +180,8 @@ export class HistoryListCtrl { return this.historySrv.restoreDashboard(this.dashboard, version).then(response => { this.$route.reload(); this.$rootScope.appEvent('alert-success', ['Dashboard restored', 'Restored from version ' + version]); - }).finally(() => { + }).catch(() => { + this.mode = 'list'; this.loading = false; }); } diff --git a/public/app/features/dashboard/history/history_srv.ts b/public/app/features/dashboard/history/history_srv.ts index ba9ad3975de..6517c36e1a7 100644 --- a/public/app/features/dashboard/history/history_srv.ts +++ b/public/app/features/dashboard/history/history_srv.ts @@ -3,7 +3,34 @@ import _ from 'lodash'; import coreModule from 'app/core/core_module'; import {DashboardModel} from '../model'; -import {HistoryListOpts} from './models'; + +export interface HistoryListOpts { + limit: number; + start: number; +} + +export interface RevisionsModel { + id: number; + checked: boolean; + dashboardId: number; + parentVersion: number; + version: number; + created: Date; + createdBy: string; + message: string; +} + +export interface CalculateDiffOptions { + new: DiffTarget; + base: DiffTarget; + diffType: string; +} + +export interface DiffTarget { + dashboardId: number; + version: number; + unsavedDashboard?: DashboardModel; // when doing diffs against unsaved dashboard version +} export class HistorySrv { /** @ngInject */ @@ -14,10 +41,8 @@ export class HistorySrv { return id ? this.backendSrv.get(`api/dashboards/id/${id}/versions`, options) : this.$q.when([]); } - compareVersions(dashboard: DashboardModel, compare: { new: number, original: number }, view = 'html') { - const id = dashboard && dashboard.id ? dashboard.id : void 0; - const url = `api/dashboards/id/${id}/compare/${compare.original}...${compare.new}/${view}`; - return id ? this.backendSrv.get(url) : this.$q.when({}); + calculateDiff(options: CalculateDiffOptions) { + return this.backendSrv.post('api/dashboards/calculate-diff', options); } restoreDashboard(dashboard: DashboardModel, version: number) { diff --git a/public/app/features/dashboard/history/models.ts b/public/app/features/dashboard/history/models.ts deleted file mode 100644 index b3cc2829511..00000000000 --- a/public/app/features/dashboard/history/models.ts +++ /dev/null @@ -1,15 +0,0 @@ -export interface HistoryListOpts { - limit: number; - start: number; -} - -export interface RevisionsModel { - id: number; - checked: boolean; - dashboardId: number; - parentVersion: number; - version: number; - created: Date; - createdBy: string; - message: string; -} diff --git a/public/app/features/dashboard/model.ts b/public/app/features/dashboard/model.ts index e62c98b8598..cdb61ac4ad7 100644 --- a/public/app/features/dashboard/model.ts +++ b/public/app/features/dashboard/model.ts @@ -244,7 +244,7 @@ export class DashboardModel { return newPanel; } - formatDate(date, format) { + formatDate(date, format?) { date = moment.isMoment(date) ? date : moment(date); format = format || 'YYYY-MM-DD HH:mm:ss'; this.timezone = this.getTimezone(); diff --git a/public/app/features/dashboard/specs/history_ctrl_specs.ts b/public/app/features/dashboard/specs/history_ctrl_specs.ts index f8e4a3d25f1..0bb09546a34 100644 --- a/public/app/features/dashboard/specs/history_ctrl_specs.ts +++ b/public/app/features/dashboard/specs/history_ctrl_specs.ts @@ -23,7 +23,7 @@ describe('HistoryListCtrl', function() { beforeEach(function() { historySrv = { getHistoryList: sinon.stub(), - compareVersions: sinon.stub(), + calculateDiff: sinon.stub(), restoreDashboard: sinon.stub(), }; $rootScope = { @@ -42,6 +42,12 @@ describe('HistoryListCtrl', function() { historySrv, $rootScope, $scope: ctx.scope, + }, { + dashboard: { + id: 2, + version: 3, + formatDate: sinon.stub().returns('date'), + } }); })); @@ -57,9 +63,8 @@ describe('HistoryListCtrl', function() { it('should reset the controller\'s state', function() { expect(ctx.ctrl.mode).to.be('list'); - expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); - expect(ctx.ctrl.selected.length).to.be(0); - expect(ctx.ctrl.selected).to.eql([]); + expect(ctx.ctrl.delta).to.eql({ basic: '', json: '' }); + expect(ctx.ctrl.canCompare).to.be(false); expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; }); @@ -82,11 +87,9 @@ describe('HistoryListCtrl', function() { it('should set all checked properties to false on reset', function() { ctx.ctrl.revisions[0].checked = true; ctx.ctrl.revisions[2].checked = true; - ctx.ctrl.selected = [0, 2]; ctx.ctrl.reset(); var actual = _.filter(ctx.ctrl.revisions, rev => !rev.checked); expect(actual.length).to.be(4); - expect(ctx.ctrl.selected).to.eql([]); }); }); @@ -99,9 +102,7 @@ describe('HistoryListCtrl', function() { it('should reset the controller\'s state', function() { expect(ctx.ctrl.mode).to.be('list'); - expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); - expect(ctx.ctrl.selected.length).to.be(0); - expect(ctx.ctrl.selected).to.eql([]); + expect(ctx.ctrl.delta).to.eql({ basic: '', json: '' }); expect(_.find(ctx.ctrl.revisions, rev => rev.checked)).to.be.undefined; }); @@ -109,11 +110,6 @@ describe('HistoryListCtrl', function() { expect(ctx.ctrl.loading).to.be(false); }); - it('should broadcast an event indicating the failure', function() { - expect($rootScope.appEvent.calledOnce).to.be(true); - expect($rootScope.appEvent.calledWith('alert-error')).to.be(true); - }); - it('should have an empty revisions list', function() { expect(ctx.ctrl.revisions).to.eql([]); }); @@ -121,7 +117,7 @@ describe('HistoryListCtrl', function() { describe('should update the history list when the dashboard is saved', function() { beforeEach(function() { - ctx.ctrl.dashboard = { version: 3 }; + ctx.ctrl.dashboard = {version: 3 }; ctx.ctrl.resetFromSource = sinon.spy(); }); @@ -134,12 +130,6 @@ describe('HistoryListCtrl', function() { expect($rootScope.onAppEvent.getCall(0).args[1]).to.not.be(ctx.ctrl.onDashboardSaved); expect($rootScope.onAppEvent.getCall(0).args[1].toString).to.be(ctx.ctrl.onDashboardSaved.toString); }); - - it('should emit an appEvent to hide the changelog', function() { - ctx.ctrl.onDashboardSaved(); - expect($rootScope.appEvent.calledOnce).to.be(true); - expect($rootScope.appEvent.getCall(0).args[0]).to.be('hide-dash-editor'); - }); }); }); @@ -149,12 +139,19 @@ describe('HistoryListCtrl', function() { beforeEach(angularMocks.inject(($controller, $q) => { deferred = $q.defer(); historySrv.getHistoryList.returns($q.when(versionsResponse)); - historySrv.compareVersions.returns(deferred.promise); + historySrv.calculateDiff.returns(deferred.promise); ctx.ctrl = $controller(HistoryListCtrl, { historySrv, $rootScope, $scope: ctx.scope, + }, { + dashboard: { + id: 2, + version: 3, + formatDate: sinon.stub().returns('date'), + } }); + ctx.ctrl.$scope.onDashboardSaved = sinon.spy(); ctx.ctrl.$scope.$apply(); })); @@ -166,33 +163,32 @@ describe('HistoryListCtrl', function() { it('should check that two valid versions are selected', function() { // [] - expect(ctx.ctrl.isComparable()).to.be(false); + expect(ctx.ctrl.canCompare).to.be(false); // single value - ctx.ctrl.selected = [4]; - expect(ctx.ctrl.isComparable()).to.be(false); + ctx.ctrl.revisions = [{checked: true}]; + ctx.ctrl.revisionSelectionChanged(); + expect(ctx.ctrl.canCompare).to.be(false); // both values in range - ctx.ctrl.selected = [4, 2]; - expect(ctx.ctrl.isComparable()).to.be(true); - - // values out of range - ctx.ctrl.selected = [7, 4]; - expect(ctx.ctrl.isComparable()).to.be(false); + ctx.ctrl.revisions = [{checked: true}, {checked: true}]; + ctx.ctrl.revisionSelectionChanged(); + expect(ctx.ctrl.canCompare).to.be(true); }); describe('and the basic diff is successfully fetched', function() { beforeEach(function() { deferred.resolve(compare('basic')); - ctx.ctrl.selected = [3, 1]; + ctx.ctrl.revisions[1].checked = true; + ctx.ctrl.revisions[3].checked = true; ctx.ctrl.getDiff('basic'); ctx.ctrl.$scope.$apply(); }); it('should fetch the basic diff if two valid versions are selected', function() { - expect(historySrv.compareVersions.calledOnce).to.be(true); + expect(historySrv.calculateDiff.calledOnce).to.be(true); expect(ctx.ctrl.delta.basic).to.be('
        '); - expect(ctx.ctrl.delta.html).to.be(''); + expect(ctx.ctrl.delta.json).to.be(''); }); it('should set the basic diff view as active', function() { @@ -207,21 +203,22 @@ describe('HistoryListCtrl', function() { describe('and the json diff is successfully fetched', function() { beforeEach(function() { - deferred.resolve(compare('html')); - ctx.ctrl.selected = [3, 1]; - ctx.ctrl.getDiff('html'); + deferred.resolve(compare('json')); + ctx.ctrl.revisions[1].checked = true; + ctx.ctrl.revisions[3].checked = true; + ctx.ctrl.getDiff('json'); ctx.ctrl.$scope.$apply(); }); it('should fetch the json diff if two valid versions are selected', function() { - expect(historySrv.compareVersions.calledOnce).to.be(true); + expect(historySrv.calculateDiff.calledOnce).to.be(true); expect(ctx.ctrl.delta.basic).to.be(''); - expect(ctx.ctrl.delta.html).to.be('
        '); + expect(ctx.ctrl.delta.json).to.be('
        '); }); it('should set the json diff view as active', function() { expect(ctx.ctrl.mode).to.be('compare'); - expect(ctx.ctrl.diff).to.be('html'); + expect(ctx.ctrl.diff).to.be('json'); }); it('should indicate loading has finished', function() { @@ -232,14 +229,15 @@ describe('HistoryListCtrl', function() { describe('and diffs have already been fetched', function() { beforeEach(function() { deferred.resolve(compare('basic')); - ctx.ctrl.selected = [3, 1]; + ctx.ctrl.revisions[3].checked = true; + ctx.ctrl.revisions[1].checked = true; ctx.ctrl.delta.basic = 'cached basic'; ctx.ctrl.getDiff('basic'); ctx.ctrl.$scope.$apply(); }); it('should use the cached diffs instead of fetching', function() { - expect(historySrv.compareVersions.calledOnce).to.be(false); + expect(historySrv.calculateDiff.calledOnce).to.be(false); expect(ctx.ctrl.delta.basic).to.be('cached basic'); }); @@ -251,13 +249,14 @@ describe('HistoryListCtrl', function() { describe('and fetching the diff fails', function() { beforeEach(function() { deferred.reject(new Error('DiffError')); - ctx.ctrl.selected = [4, 2]; + ctx.ctrl.revisions[3].checked = true; + ctx.ctrl.revisions[1].checked = true; ctx.ctrl.getDiff('basic'); ctx.ctrl.$scope.$apply(); }); it('should fetch the diff if two valid versions are selected', function() { - expect(historySrv.compareVersions.calledOnce).to.be(true); + expect(historySrv.calculateDiff.calledOnce).to.be(true); }); it('should return to the history list view', function() { @@ -269,7 +268,7 @@ describe('HistoryListCtrl', function() { }); it('should have an empty delta/changeset', function() { - expect(ctx.ctrl.delta).to.eql({ basic: '', html: '' }); + expect(ctx.ctrl.delta).to.eql({ basic: '', json: '' }); }); }); }); diff --git a/public/app/features/dashboard/specs/history_srv_specs.ts b/public/app/features/dashboard/specs/history_srv_specs.ts index 2d01f323d35..4678759c438 100644 --- a/public/app/features/dashboard/specs/history_srv_specs.ts +++ b/public/app/features/dashboard/specs/history_srv_specs.ts @@ -8,7 +8,6 @@ describe('historySrv', function() { var ctx = new helpers.ServiceTestContext(); var versionsResponse = versions(); - var compareResponse = compare(); var restoreResponse = restore; beforeEach(angularMocks.module('grafana.core')); @@ -16,7 +15,6 @@ describe('historySrv', function() { beforeEach(angularMocks.inject(function($httpBackend) { ctx.$httpBackend = $httpBackend; $httpBackend.whenRoute('GET', 'api/dashboards/id/:id/versions').respond(versionsResponse); - $httpBackend.whenRoute('GET', 'api/dashboards/id/:id/compare/:original...:new').respond(compareResponse); $httpBackend.whenRoute('POST', 'api/dashboards/id/:id/restore') .respond(function(method, url, data, headers, params) { const parsedData = JSON.parse(data); @@ -51,26 +49,6 @@ describe('historySrv', function() { }); }); - describe('compareVersions', function() { - it('should return a diff object for the given dashboard revisions', function(done) { - var compare = { original: 6, new: 4 }; - ctx.service.compareVersions({ id: 1 }, compare).then(function(response) { - expect(response).to.eql(compareResponse); - done(); - }); - ctx.$httpBackend.flush(); - }); - - it('should return an empty object when not given an id', function(done) { - var compare = { original: 6, new: 4 }; - ctx.service.compareVersions({ }, compare).then(function(response) { - expect(response).to.eql({}); - done(); - }); - ctx.$httpBackend.flush(); - }); - }); - describe('restoreDashboard', function() { it('should return a success response given valid parameters', function(done) { var version = 6; From 8f6c9c59468a75023a01b9ec36145d8cb696ed0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 12:39:06 +0200 Subject: [PATCH 106/130] dasboard_history: some polish around styles & diff colors, and minor fixes --- pkg/api/dtos/dashboard.go | 2 +- pkg/components/dashdiffs/formatter_basic.go | 12 ++++++------ public/app/core/directives/diff-view.ts | 2 +- public/app/features/dashboard/history/history.html | 2 +- .../dashboard/history/partials/link-json.html | 4 ---- public/sass/_variables.dark.scss | 10 +++++----- 6 files changed, 14 insertions(+), 18 deletions(-) delete mode 100644 public/app/features/dashboard/history/partials/link-json.html diff --git a/pkg/api/dtos/dashboard.go b/pkg/api/dtos/dashboard.go index 6a11199bb1c..9ef9a96edc4 100644 --- a/pkg/api/dtos/dashboard.go +++ b/pkg/api/dtos/dashboard.go @@ -35,7 +35,7 @@ type DashboardRedirect struct { type CalculateDiffOptions struct { Base CalculateDiffTarget `json:"base" binding:"Required"` New CalculateDiffTarget `json:"new" binding:"Required"` - DiffType string `json:"DiffType" binding:"Required"` + DiffType string `json:"diffType" binding:"Required"` } type CalculateDiffTarget struct { diff --git a/pkg/components/dashdiffs/formatter_basic.go b/pkg/components/dashdiffs/formatter_basic.go index ea935604349..819d0a1fd86 100644 --- a/pkg/components/dashdiffs/formatter_basic.go +++ b/pkg/components/dashdiffs/formatter_basic.go @@ -248,11 +248,11 @@ var ( {{ if .Old }} -
        {{ .Old }}
        +
        {{ .Old }}
        {{ end }} {{ if .New }} -
        {{ .New }}
        +
        {{ .New }}
        {{ end }} {{ if .LineStart }} @@ -289,11 +289,11 @@ var (
        {{ if .Old }} -
        {{ .Old }}
        +
        {{ .Old }}
        {{ end }} {{ if .New }} -
        {{ .New }}
        +
        {{ .New }}
        {{ end }}
        @@ -301,7 +301,7 @@ var ( {{ end }} @@ -326,7 +326,7 @@ var ( {{ end }}
        diff --git a/public/app/core/directives/diff-view.ts b/public/app/core/directives/diff-view.ts index 567e01dd472..01aa19fdd0c 100644 --- a/public/app/core/directives/diff-view.ts +++ b/public/app/core/directives/diff-view.ts @@ -71,7 +71,7 @@ export function linkJson() { link: '@lineLink', switchView: '&', }, - templateUrl: 'public/app/features/dashboard/history/partials/link-json.html', + template: `Line {{ line }}` }; } coreModule.directive('diffLinkJson', linkJson); diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index ab64b48d342..4290cc7266b 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -100,7 +100,7 @@ diff --git a/public/app/features/dashboard/history/partials/link-json.html b/public/app/features/dashboard/history/partials/link-json.html deleted file mode 100644 index 0ad398486c8..00000000000 --- a/public/app/features/dashboard/history/partials/link-json.html +++ /dev/null @@ -1,4 +0,0 @@ - - Line {{ line }} - - diff --git a/public/sass/_variables.dark.scss b/public/sass/_variables.dark.scss index cedaf096988..27def5ed4b1 100644 --- a/public/sass/_variables.dark.scss +++ b/public/sass/_variables.dark.scss @@ -292,13 +292,13 @@ $diff-arrow-color: $white; $diff-json-bg: $dark-4; $diff-json-fg: $gray-5; -$diff-json-added: #2f5f40; -$diff-json-deleted: #862d2d; +$diff-json-added: #457740; +$diff-json-deleted: #a04338; -$diff-json-old: #5a372a; -$diff-json-new: #664e33; +$diff-json-old: #a04338; +$diff-json-new: #457740; $diff-json-changed-fg: $gray-5; -$diff-json-changed-num: $text-muted; +$diff-json-changed-num: $text-color; $diff-json-icon: $gray-7; From 577dfee086733a95e7a9fa01e026d94edaaaba20 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 13:36:03 +0200 Subject: [PATCH 107/130] dasboard_history: fixed json diff so only dashbord is compared and not the whole dashboard revision object (message and restoreFrom etc was showing up in json diff) --- pkg/components/dashdiffs/compare.go | 14 ++++++++++---- pkg/components/dashdiffs/formatter_basic.go | 11 ++++++++--- public/app/features/dashboard/history/history.html | 4 ++-- 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/pkg/components/dashdiffs/compare.go b/pkg/components/dashdiffs/compare.go index 51c8a947ce1..7e4df0e67b2 100644 --- a/pkg/components/dashdiffs/compare.go +++ b/pkg/components/dashdiffs/compare.go @@ -6,6 +6,7 @@ import ( "github.com/grafana/grafana/pkg/bus" "github.com/grafana/grafana/pkg/components/simplejson" + "github.com/grafana/grafana/pkg/log" "github.com/grafana/grafana/pkg/models" diff "github.com/yudai/gojsondiff" deltaFormatter "github.com/yudai/gojsondiff/formatter" @@ -17,6 +18,8 @@ var ( // ErrNilDiff occurs when two compared interfaces are identical. ErrNilDiff = errors.New("dashdiff: diff is nil") + + diffLogger = log.New("dashdiffs") ) type DiffType int @@ -77,7 +80,10 @@ func CalculateDiff(options *Options) (*Result, error) { return nil, err } - left, jsonDiff, err := getDiff(baseVersionQuery.Result, newVersionQuery.Result) + baseData := baseVersionQuery.Result.Data + newData := newVersionQuery.Result.Data + + left, jsonDiff, err := getDiff(baseData, newData) if err != nil { return nil, err } @@ -115,13 +121,13 @@ func CalculateDiff(options *Options) (*Result, error) { } // getDiff computes the diff of two dashboard versions. -func getDiff(originalDash, newDash *models.DashboardVersion) (interface{}, diff.Diff, error) { - leftBytes, err := simplejson.NewFromAny(originalDash).Encode() +func getDiff(baseData, newData *simplejson.Json) (interface{}, diff.Diff, error) { + leftBytes, err := baseData.Encode() if err != nil { return nil, nil, err } - rightBytes, err := simplejson.NewFromAny(newDash).Encode() + rightBytes, err := newData.Encode() if err != nil { return nil, nil, err } diff --git a/pkg/components/dashdiffs/formatter_basic.go b/pkg/components/dashdiffs/formatter_basic.go index 819d0a1fd86..01c7757112d 100644 --- a/pkg/components/dashdiffs/formatter_basic.go +++ b/pkg/components/dashdiffs/formatter_basic.go @@ -97,14 +97,17 @@ func (b *BasicDiff) Basic(lines []*JSONLine) []*BasicBlock { // iterate through each line for _, line := range lines { - if b.LastIndent == 3 && line.Indent == 2 && line.Change == ChangeNil { + // TODO: this condition needs an explaination? what does it mean? + if b.LastIndent == 2 && line.Indent == 1 && line.Change == ChangeNil { if b.Block != nil { blocks = append(blocks, b.Block) } } + b.LastIndent = line.Indent - if line.Indent == 2 { + // TODO: why special handling for indent 2? + if line.Indent == 1 { switch line.Change { case ChangeNil: if line.Change == ChangeNil { @@ -143,12 +146,14 @@ func (b *BasicDiff) Basic(lines []*JSONLine) []*BasicBlock { } } + // TODO: why special handling for indent > 2 ? // Other Lines - if line.Indent > 2 { + if line.Indent > 1 { // Ensure single line change if line.Key != "" && line.Val != nil && !b.writing { switch line.Change { case ChangeAdded, ChangeDeleted: + b.Block.Changes = append(b.Block.Changes, &BasicChange{ Key: line.Key, Change: line.Change, diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 4290cc7266b..375daa8d87f 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -11,7 +11,7 @@
      • - Version {{ctrl.baseInfo.version}} Version {{ctrl.newInfo.version}} + Version Comparison
      @@ -123,7 +123,7 @@ Version {{ctrl.newInfo.version}} (Latest) -
      +

      Version {{ctrl.newInfo.version}} updated by {{ctrl.newInfo.createdBy}} From 56b3c4a3a01ff340783b9e35ecfc57ba51c37518 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 13:46:36 +0200 Subject: [PATCH 108/130] dasboard_history: fixed disabled attribute so it works both by disabling and fixing style, no need for disabled class and disabled attribute --- public/app/features/dashboard/history/history.html | 11 +++++------ public/sass/components/_buttons.scss | 1 + 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 375daa8d87f..5aca9186ebe 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -74,22 +74,21 @@

      -   Compare versions - - +
      diff --git a/public/sass/components/_buttons.scss b/public/sass/components/_buttons.scss index 88752e49064..4be896d8ec0 100644 --- a/public/sass/components/_buttons.scss +++ b/public/sass/components/_buttons.scss @@ -41,6 +41,7 @@ } &.disabled, + &[disabled], &:disabled { cursor: $cursor-disabled; opacity: .65; From f4debbf501f640f67d13a03f08eb020a1229120c Mon Sep 17 00:00:00 2001 From: Peter Mounce Date: Wed, 7 Jun 2017 12:47:08 +0100 Subject: [PATCH 109/130] typo (#8565) --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index eef674b4bec..958877033bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -55,7 +55,7 @@ * **Heatmap**: Heatmap Panel [#7934](https://github.com/grafana/grafana/pull/7934) * **Elasticsearch**: histogram aggregation [#3164](https://github.com/grafana/grafana/issues/3164) -## Minor Enchancements +## Minor Enhancements * **InfluxDB**: Small fix for the "glow" when focus the field for LIMIT and SLIMIT [#7799](https://github.com/grafana/grafana/pull/7799) thx [@thuck](https://github.com/thuck) * **Prometheus**: Make Prometheus query field a textarea [#7663](https://github.com/grafana/grafana/issues/7663), thx [@hagen1778](https://github.com/hagen1778) From 64d620c9871700f5e026afadd9411647783602b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 13:50:59 +0200 Subject: [PATCH 110/130] dasboard_history: minor style fix change --- public/sass/pages/_history.scss | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/public/sass/pages/_history.scss b/public/sass/pages/_history.scss index 3637907fb1a..707a3a40545 100644 --- a/public/sass/pages/_history.scss +++ b/public/sass/pages/_history.scss @@ -55,7 +55,10 @@ right: 10px; } -.diff-json-new, .diff-json-old { +.diff-json-new, +.diff-json-old, +.diff-json-deleted, +.diff-json-added, { color: $diff-json-changed-fg; & .diff-line-number { color: $diff-json-changed-num; } From 3ba8aeb9a742eec05bf29125802a6997b59062ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 14:02:45 +0200 Subject: [PATCH 111/130] dashboard_history: fix for scenario where reverted dashbord has different title and url must change not just route reload --- public/app/features/dashboard/history/history.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/public/app/features/dashboard/history/history.ts b/public/app/features/dashboard/history/history.ts index 5bd8ef7c895..10ab3f3fa28 100644 --- a/public/app/features/dashboard/history/history.ts +++ b/public/app/features/dashboard/history/history.ts @@ -28,7 +28,7 @@ export class HistoryListCtrl { /** @ngInject */ constructor(private $scope, private $rootScope, - private $route, + private $location, private $window, private $timeout, private $q, @@ -178,7 +178,7 @@ export class HistoryListCtrl { restoreConfirm(version: number) { this.loading = true; return this.historySrv.restoreDashboard(this.dashboard, version).then(response => { - this.$route.reload(); + this.$location.path('dashboard/db/' + response.slug); this.$rootScope.appEvent('alert-success', ['Dashboard restored', 'Restored from version ' + version]); }).catch(() => { this.mode = 'list'; From 46412c8475e559849382121874c3c5031b67cb80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 14:21:40 +0200 Subject: [PATCH 112/130] dasboard_history: security fix, added orgId filter to dashboard version lookup --- pkg/api/dashboard.go | 3 ++ pkg/components/dashdiffs/compare.go | 2 + pkg/services/sqlstore/dashboard_version.go | 45 ++++++---------------- pkg/services/sqlstore/logger.go | 27 +++++-------- 4 files changed, 25 insertions(+), 52 deletions(-) diff --git a/pkg/api/dashboard.go b/pkg/api/dashboard.go index 129faa3d01e..df0cbbd745c 100644 --- a/pkg/api/dashboard.go +++ b/pkg/api/dashboard.go @@ -346,6 +346,9 @@ func CalculateDashboardDiff(c *middleware.Context, apiOptions dtos.CalculateDiff result, err := dashdiffs.CalculateDiff(&options) if err != nil { + if err == m.ErrDashboardVersionNotFound { + return ApiError(404, "Dashboard version not found", err) + } return ApiError(500, "Unable to compute diff", err) } diff --git a/pkg/components/dashdiffs/compare.go b/pkg/components/dashdiffs/compare.go index 7e4df0e67b2..f5f2104cb92 100644 --- a/pkg/components/dashdiffs/compare.go +++ b/pkg/components/dashdiffs/compare.go @@ -65,6 +65,7 @@ func CalculateDiff(options *Options) (*Result, error) { baseVersionQuery := models.GetDashboardVersionQuery{ DashboardId: options.Base.DashboardId, Version: options.Base.Version, + OrgId: options.OrgId, } if err := bus.Dispatch(&baseVersionQuery); err != nil { @@ -74,6 +75,7 @@ func CalculateDiff(options *Options) (*Result, error) { newVersionQuery := models.GetDashboardVersionQuery{ DashboardId: options.New.DashboardId, Version: options.New.Version, + OrgId: options.OrgId, } if err := bus.Dispatch(&newVersionQuery); err != nil { diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index 3ff93b59bbf..14924839b53 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -10,15 +10,22 @@ func init() { bus.AddHandler("sql", GetDashboardVersions) } -// GetDashboardVersion gets the dashboard version for the given dashboard ID -// and version number. +// GetDashboardVersion gets the dashboard version for the given dashboard ID and version number. func GetDashboardVersion(query *m.GetDashboardVersionQuery) error { - result, err := getDashboardVersion(query.DashboardId, query.Version) + version := m.DashboardVersion{} + has, err := x.Where("dashboard_version.dashboard_id=? AND dashboard_version.version=? AND dashboard.org_id=?", query.DashboardId, query.Version, query.OrgId). + Join("LEFT", "dashboard", `dashboard.id = dashboard_version.dashboard_id`). + Get(&version) + if err != nil { return err } - query.Result = result + if !has { + return m.ErrDashboardVersionNotFound + } + + query.Result = &version return nil } @@ -50,33 +57,3 @@ func GetDashboardVersions(query *m.GetDashboardVersionsQuery) error { } return nil } - -// getDashboardVersion is a helper function that gets the dashboard version for -// the given dashboard ID and version ID. -func getDashboardVersion(dashboardId int64, version int) (*m.DashboardVersion, error) { - dashboardVersion := m.DashboardVersion{} - has, err := x.Where("dashboard_id=? AND version=?", dashboardId, version).Get(&dashboardVersion) - if err != nil { - return nil, err - } - if !has { - return nil, m.ErrDashboardVersionNotFound - } - - dashboardVersion.Data.Set("id", dashboardVersion.DashboardId) - return &dashboardVersion, nil -} - -// getDashboard gets a dashboard by ID. Used for retrieving the dashboard -// associated with dashboard versions. -func getDashboard(dashboardId int64) (*m.Dashboard, error) { - dashboard := m.Dashboard{Id: dashboardId} - has, err := x.Get(&dashboard) - if err != nil { - return nil, err - } - if has == false { - return nil, m.ErrDashboardNotFound - } - return &dashboard, nil -} diff --git a/pkg/services/sqlstore/logger.go b/pkg/services/sqlstore/logger.go index ae1145c21b0..9b0b068c918 100644 --- a/pkg/services/sqlstore/logger.go +++ b/pkg/services/sqlstore/logger.go @@ -23,67 +23,59 @@ func NewXormLogger(level glog.Lvl, grafanaLog glog.Logger) *XormLogger { } // Error implement core.ILogger -func (s *XormLogger) Err(v ...interface{}) error { +func (s *XormLogger) Error(v ...interface{}) { if s.level <= glog.LvlError { s.grafanaLog.Error(fmt.Sprint(v...)) } - return nil } // Errorf implement core.ILogger -func (s *XormLogger) Errf(format string, v ...interface{}) error { +func (s *XormLogger) Errorf(format string, v ...interface{}) { if s.level <= glog.LvlError { s.grafanaLog.Error(fmt.Sprintf(format, v...)) } - return nil } // Debug implement core.ILogger -func (s *XormLogger) Debug(v ...interface{}) error { +func (s *XormLogger) Debug(v ...interface{}) { if s.level <= glog.LvlDebug { s.grafanaLog.Debug(fmt.Sprint(v...)) } - return nil } // Debugf implement core.ILogger -func (s *XormLogger) Debugf(format string, v ...interface{}) error { +func (s *XormLogger) Debugf(format string, v ...interface{}) { if s.level <= glog.LvlDebug { s.grafanaLog.Debug(fmt.Sprintf(format, v...)) } - return nil } // Info implement core.ILogger -func (s *XormLogger) Info(v ...interface{}) error { +func (s *XormLogger) Info(v ...interface{}) { if s.level <= glog.LvlInfo { s.grafanaLog.Info(fmt.Sprint(v...)) } - return nil } // Infof implement core.ILogger -func (s *XormLogger) Infof(format string, v ...interface{}) error { +func (s *XormLogger) Infof(format string, v ...interface{}) { if s.level <= glog.LvlInfo { s.grafanaLog.Info(fmt.Sprintf(format, v...)) } - return nil } // Warn implement core.ILogger -func (s *XormLogger) Warning(v ...interface{}) error { +func (s *XormLogger) Warn(v ...interface{}) { if s.level <= glog.LvlWarn { s.grafanaLog.Warn(fmt.Sprint(v...)) } - return nil } // Warnf implement core.ILogger -func (s *XormLogger) Warningf(format string, v ...interface{}) error { +func (s *XormLogger) Warnf(format string, v ...interface{}) { if s.level <= glog.LvlWarn { s.grafanaLog.Warn(fmt.Sprintf(format, v...)) } - return nil } // Level implement core.ILogger @@ -103,8 +95,7 @@ func (s *XormLogger) Level() core.LogLevel { } // SetLevel implement core.ILogger -func (s *XormLogger) SetLevel(l core.LogLevel) error { - return nil +func (s *XormLogger) SetLevel(l core.LogLevel) { } // ShowSQL implement core.ILogger From 391dc1e2259a2e120b984533ac3bb7b294fc9270 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 14:25:46 +0200 Subject: [PATCH 113/130] dasboard_history: fixed sql integration test --- pkg/services/sqlstore/dashboard_version_test.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/services/sqlstore/dashboard_version_test.go b/pkg/services/sqlstore/dashboard_version_test.go index eb7e549ba7c..12f23cdb54a 100644 --- a/pkg/services/sqlstore/dashboard_version_test.go +++ b/pkg/services/sqlstore/dashboard_version_test.go @@ -33,6 +33,7 @@ func TestGetDashboardVersion(t *testing.T) { query := m.GetDashboardVersionQuery{ DashboardId: savedDash.Id, Version: savedDash.Version, + OrgId: 1, } err := GetDashboardVersion(&query) @@ -54,6 +55,7 @@ func TestGetDashboardVersion(t *testing.T) { query := m.GetDashboardVersionQuery{ DashboardId: int64(999), Version: 123, + OrgId: 1, } err := GetDashboardVersion(&query) From 5225e4283f9ca68abb8e59b3b4b4a5fb301b5ee1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 14:39:44 +0200 Subject: [PATCH 114/130] Update CHANGELOG.md --- CHANGELOG.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 958877033bb..f2e27dade77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # 4.4.0 (unreleased) +## New Features +**Dashboard History**: View dashboard version history, compare any two versions (summary & json diffs), restore to old version. This big feature +was contributed by **Walmart Labs**. Big thanks to them for this massive contribution! +Initial feature request: [#4638](https://github.com/grafana/grafana/issues/4638) +Pull Request: [#8472](https://github.com/grafana/grafana/pull/8472) + ## Enhancements * **Elasticsearch**: Added filter aggregation label [#8420](https://github.com/grafana/grafana/pull/8420), thx [@tianzk](github.com/tianzk) * **Sensu**: Added option for source and handler [#8405](https://github.com/grafana/grafana/pull/8405), thx [@joemiller](github.com/joemiller) From 08b37186a5afeb85cf9de6feb1f240b2a50c58b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 15:41:30 +0200 Subject: [PATCH 115/130] fix: fixed failing sql unit test --- pkg/services/sqlstore/dashboard_version.go | 1 + pkg/services/sqlstore/dashboard_version_test.go | 1 + 2 files changed, 2 insertions(+) diff --git a/pkg/services/sqlstore/dashboard_version.go b/pkg/services/sqlstore/dashboard_version.go index 14924839b53..0b296650b4b 100644 --- a/pkg/services/sqlstore/dashboard_version.go +++ b/pkg/services/sqlstore/dashboard_version.go @@ -25,6 +25,7 @@ func GetDashboardVersion(query *m.GetDashboardVersionQuery) error { return m.ErrDashboardVersionNotFound } + version.Data.Set("id", version.DashboardId) query.Result = &version return nil } diff --git a/pkg/services/sqlstore/dashboard_version_test.go b/pkg/services/sqlstore/dashboard_version_test.go index 12f23cdb54a..8ac636c1682 100644 --- a/pkg/services/sqlstore/dashboard_version_test.go +++ b/pkg/services/sqlstore/dashboard_version_test.go @@ -45,6 +45,7 @@ func TestGetDashboardVersion(t *testing.T) { OrgId: savedDash.OrgId, Slug: savedDash.Slug, } + err = GetDashboard(&dashCmd) So(err, ShouldBeNil) eq := reflect.DeepEqual(dashCmd.Result.Data, query.Result.Data) From 61bdc9127203401ee80c8271df4411f42a456753 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 21:54:55 +0200 Subject: [PATCH 116/130] ux: css fix to search position when sidemenu is pinned --- public/app/features/dashboard/history/history.html | 2 +- public/sass/components/_sidemenu.scss | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/public/app/features/dashboard/history/history.html b/public/app/features/dashboard/history/history.html index 5aca9186ebe..7968f1162c5 100644 --- a/public/app/features/dashboard/history/history.html +++ b/public/app/features/dashboard/history/history.html @@ -38,7 +38,7 @@ Version Date Updated By - Notes + Notes diff --git a/public/sass/components/_sidemenu.scss b/public/sass/components/_sidemenu.scss index 500f3b06ede..0e5402403e5 100644 --- a/public/sass/components/_sidemenu.scss +++ b/public/sass/components/_sidemenu.scss @@ -37,7 +37,7 @@ margin-left: $side-menu-width; } .search-container { - left: auto; + left: $side-menu-width; } } From 01ff3bbe0ae5893169562f2c880a9c65226c42fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Wed, 7 Jun 2017 22:03:10 +0200 Subject: [PATCH 117/130] ux: mini css position fix --- public/sass/components/_navbar.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/sass/components/_navbar.scss b/public/sass/components/_navbar.scss index 44678afe6e1..89918d18e59 100644 --- a/public/sass/components/_navbar.scss +++ b/public/sass/components/_navbar.scss @@ -96,7 +96,7 @@ .icon-gf-grafana_wordmark { font-size: 21px; position: relative; - top: 5px; + top: 6px; padding-left: 5px; display: none; } From 922073a357d4ce57b6dd225bf4d8c1a3449f7063 Mon Sep 17 00:00:00 2001 From: Mitsuhiro Tanda Date: Thu, 8 Jun 2017 14:01:33 +0900 Subject: [PATCH 118/130] (cloudwatch) add new metrics (#8569) --- pkg/api/cloudwatch/metrics.go | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pkg/api/cloudwatch/metrics.go b/pkg/api/cloudwatch/metrics.go index 3ad63ceec75..f8b93d361f5 100644 --- a/pkg/api/cloudwatch/metrics.go +++ b/pkg/api/cloudwatch/metrics.go @@ -30,13 +30,13 @@ var customMetricsDimensionsMap map[string]map[string]map[string]*CustomMetricsCa func init() { metricsMap = map[string][]string{ "AWS/ApiGateway": {"4XXError", "5XXError", "CacheHitCount", "CacheMissCount", "Count", "IntegrationLatency", "Latency"}, - "AWS/ApplicationELB": {"ActiveConnectionCount", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "HTTPCode_ELB_4XX_Count", "HTTPCode_ELB_5XX_Count", "HTTPCode_Target_2XX_Count", "HTTPCode_Target_3XX_Count", "HTTPCode_Target_4XX_Count", "HTTPCode_Target_5XX_Count", "NewConnectionCount", "ProcessedBytes", "RejectedConnectionCount", "RequestCount", "TargetConnectionErrorCount", "TargetResponseTime", "TargetTLSNegotiationErrorCount", "UnHealthyHostCount"}, + "AWS/ApplicationELB": {"ActiveConnectionCount", "ClientTLSNegotiationErrorCount", "HealthyHostCount", "HTTPCode_ELB_4XX_Count", "HTTPCode_ELB_5XX_Count", "HTTPCode_Target_2XX_Count", "HTTPCode_Target_3XX_Count", "HTTPCode_Target_4XX_Count", "HTTPCode_Target_5XX_Count", "IPv6ProcessedBytes", "IPv6RequestCount", "NewConnectionCount", "ProcessedBytes", "RejectedConnectionCount", "RequestCount", "TargetConnectionErrorCount", "TargetResponseTime", "TargetTLSNegotiationErrorCount", "UnHealthyHostCount"}, "AWS/AutoScaling": {"GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances"}, "AWS/Billing": {"EstimatedCharges"}, "AWS/CloudFront": {"Requests", "BytesDownloaded", "BytesUploaded", "TotalErrorRate", "4xxErrorRate", "5xxErrorRate"}, "AWS/CloudSearch": {"SuccessfulRequests", "SearchableDocuments", "IndexUtilization", "Partitions"}, "AWS/DMS": {"FreeableMemory", "WriteIOPS", "ReadIOPS", "WriteThroughput", "ReadThroughput", "WriteLatency", "ReadLatency", "SwapUsage", "NetworkTransmitThroughput", "NetworkReceiveThroughput", "FullLoadThroughputBandwidthSource", "FullLoadThroughputBandwidthTarget", "FullLoadThroughputRowsSource", "FullLoadThroughputRowsTarget", "CDCIncomingChanges", "CDCChangesMemorySource", "CDCChangesMemoryTarget", "CDCChangesDiskSource", "CDCChangesDiskTarget", "CDCThroughputBandwidthTarget", "CDCThroughputRowsSource", "CDCThroughputRowsTarget", "CDCLatencySource", "CDCLatencyTarget"}, - "AWS/DynamoDB": {"ConditionalCheckFailedRequests", "ConsumedReadCapacityUnits", "ConsumedWriteCapacityUnits", "OnlineIndexConsumedWriteCapacity", "OnlineIndexPercentageProgress", "OnlineIndexThrottleEvents", "ProvisionedReadCapacityUnits", "ProvisionedWriteCapacityUnits", "ReadThrottleEvents", "ReturnedBytes", "ReturnedItemCount", "ReturnedRecordsCount", "SuccessfulRequestLatency", "SystemErrors", "ThrottledRequests", "UserErrors", "WriteThrottleEvents"}, + "AWS/DynamoDB": {"ConditionalCheckFailedRequests", "ConsumedReadCapacityUnits", "ConsumedWriteCapacityUnits", "OnlineIndexConsumedWriteCapacity", "OnlineIndexPercentageProgress", "OnlineIndexThrottleEvents", "ProvisionedReadCapacityUnits", "ProvisionedWriteCapacityUnits", "ReadThrottleEvents", "ReturnedBytes", "ReturnedItemCount", "ReturnedRecordsCount", "SuccessfulRequestLatency", "SystemErrors", "TimeToLiveDeletedItemCount", "ThrottledRequests", "UserErrors", "WriteThrottleEvents"}, "AWS/EBS": {"VolumeReadBytes", "VolumeWriteBytes", "VolumeReadOps", "VolumeWriteOps", "VolumeTotalReadTime", "VolumeTotalWriteTime", "VolumeIdleTime", "VolumeQueueLength", "VolumeThroughputPercentage", "VolumeConsumedReadWriteOps", "BurstBalance"}, "AWS/EC2": {"CPUCreditUsage", "CPUCreditBalance", "CPUUtilization", "DiskReadOps", "DiskWriteOps", "DiskReadBytes", "DiskWriteBytes", "NetworkIn", "NetworkOut", "NetworkPacketsIn", "NetworkPacketsOut", "StatusCheckFailed", "StatusCheckFailed_Instance", "StatusCheckFailed_System"}, "AWS/EC2Spot": {"AvailableInstancePoolsCount", "BidsSubmittedForCapacity", "EligibleInstancePoolCount", "FulfilledCapacity", "MaxPercentCapacityAllocation", "PendingCapacity", "PercentCapacityAllocation", "TargetCapacity", "TerminatingCapacity"}, @@ -69,23 +69,23 @@ func init() { "CoreNodesRunning", "CoreNodesPending", "LiveDataNodes", "MRTotalNodes", "MRActiveNodes", "MRLostNodes", "MRUnhealthyNodes", "MRDecommissionedNodes", "MRRebootedNodes", "S3BytesWritten", "S3BytesRead", "HDFSUtilization", "HDFSBytesRead", "HDFSBytesWritten", "MissingBlocks", "CorruptBlocks", "TotalLoad", "MemoryTotalMB", "MemoryReservedMB", "MemoryAvailableMB", "MemoryAllocatedMB", "PendingDeletionBlocks", "UnderReplicatedBlocks", "DfsPendingReplicationBlocks", "CapacityRemainingGB", "HbaseBackupFailed", "MostRecentBackupDuration", "TimeSinceLastSuccessfulBackup"}, - "AWS/ES": {"ClusterStatus.green", "ClusterStatus.yellow", "ClusterStatus.red", "Nodes", "SearchableDocuments", "DeletedDocuments", "CPUUtilization", "FreeStorageSpace", "JVMMemoryPressure", "AutomatedSnapshotFailure", "MasterCPUUtilization", "MasterFreeStorageSpace", "MasterJVMMemoryPressure", "ReadLatency", "WriteLatency", "ReadThroughput", "WriteThroughput", "DiskQueueLength", "ReadIOPS", "WriteIOPS"}, + "AWS/ES": {"ClusterStatus.green", "ClusterStatus.yellow", "ClusterStatus.red", "ClusterUsedSpace", "Nodes", "SearchableDocuments", "DeletedDocuments", "CPUCreditBalance", "CPUUtilization", "FreeStorageSpace", "JVMMemoryPressure", "AutomatedSnapshotFailure", "MasterCPUCreditBalance", "MasterCPUUtilization", "MasterFreeStorageSpace", "MasterJVMMemoryPressure", "ReadLatency", "WriteLatency", "ReadThroughput", "WriteThroughput", "DiskQueueDepth", "ReadIOPS", "WriteIOPS"}, "AWS/Events": {"Invocations", "FailedInvocations", "TriggeredRules", "MatchedEvents", "ThrottledRules"}, "AWS/Firehose": {"DeliveryToElasticsearch.Bytes", "DeliveryToElasticsearch.Records", "DeliveryToElasticsearch.Success", "DeliveryToRedshift.Bytes", "DeliveryToRedshift.Records", "DeliveryToRedshift.Success", "DeliveryToS3.Bytes", "DeliveryToS3.DataFreshness", "DeliveryToS3.Records", "DeliveryToS3.Success", "IncomingBytes", "IncomingRecords", "DescribeDeliveryStream.Latency", "DescribeDeliveryStream.Requests", "ListDeliveryStreams.Latency", "ListDeliveryStreams.Requests", "PutRecord.Bytes", "PutRecord.Latency", "PutRecord.Requests", "PutRecordBatch.Bytes", "PutRecordBatch.Latency", "PutRecordBatch.Records", "PutRecordBatch.Requests", "UpdateDeliveryStream.Latency", "UpdateDeliveryStream.Requests"}, "AWS/IoT": {"PublishIn.Success", "PublishOut.Success", "Subscribe.Success", "Ping.Success", "Connect.Success", "GetThingShadow.Accepted"}, "AWS/Kinesis": {"GetRecords.Bytes", "GetRecords.IteratorAge", "GetRecords.IteratorAgeMilliseconds", "GetRecords.Latency", "GetRecords.Records", "GetRecords.Success", "IncomingBytes", "IncomingRecords", "PutRecord.Bytes", "PutRecord.Latency", "PutRecord.Success", "PutRecords.Bytes", "PutRecords.Latency", "PutRecords.Records", "PutRecords.Success", "ReadProvisionedThroughputExceeded", "WriteProvisionedThroughputExceeded", "IteratorAgeMilliseconds", "OutgoingBytes", "OutgoingRecords"}, "AWS/KinesisAnalytics": {"Bytes", "MillisBehindLatest", "Records", "Success"}, - "AWS/Lambda": {"Invocations", "Errors", "Duration", "Throttles"}, + "AWS/Lambda": {"Invocations", "Errors", "Duration", "Throttles", "IteratorAge"}, "AWS/Logs": {"IncomingBytes", "IncomingLogEvents", "ForwardedBytes", "ForwardedLogEvents", "DeliveryErrors", "DeliveryThrottling"}, "AWS/ML": {"PredictCount", "PredictFailureCount"}, "AWS/OpsWorks": {"cpu_idle", "cpu_nice", "cpu_system", "cpu_user", "cpu_waitio", "load_1", "load_5", "load_15", "memory_buffers", "memory_cached", "memory_free", "memory_swap", "memory_total", "memory_used", "procs"}, "AWS/Redshift": {"CPUUtilization", "DatabaseConnections", "HealthStatus", "MaintenanceMode", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "PercentageDiskSpaceUsed", "ReadIOPS", "ReadLatency", "ReadThroughput", "WriteIOPS", "WriteLatency", "WriteThroughput"}, - "AWS/RDS": {"ActiveTransactions", "AuroraBinlogReplicaLag", "AuroraReplicaLag", "AuroraReplicaLagMaximum", "AuroraReplicaLagMinimum", "BinLogDiskUsage", "BlockedTransactions", "BufferCacheHitRatio", "CommitLatency", "CommitThroughput", "CPUCreditBalance", "CPUCreditUsage", "CPUUtilization", "DatabaseConnections", "DDLLatency", "DDLThroughput", "Deadlocks", "DiskQueueDepth", "DMLLatency", "DMLThroughput", "FailedSqlStatements", "FreeableMemory", "FreeStorageSpace", "LoginFailures", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "ReadIOPS", "ReadLatency", "ReadThroughput", "ReplicaLag", "ResultSetCacheHitRatio", "SelectLatency", "SelectThroughput", "SwapUsage", "TotalConnections", "VolumeReadIOPS", "VolumeWriteIOPS", "WriteIOPS", "WriteLatency", "WriteThroughput"}, - "AWS/Route53": {"HealthCheckStatus", "HealthCheckPercentageHealthy", "ConnectionTime", "SSLHandshakeTime", "TimeToFirstByte"}, + "AWS/RDS": {"ActiveTransactions", "AuroraBinlogReplicaLag", "AuroraReplicaLag", "AuroraReplicaLagMaximum", "AuroraReplicaLagMinimum", "BinLogDiskUsage", "BlockedTransactions", "BufferCacheHitRatio", "CommitLatency", "CommitThroughput", "BinLogDiskUsage", "CPUCreditBalance", "CPUCreditUsage", "CPUUtilization", "DatabaseConnections", "DDLLatency", "DDLThroughput", "Deadlocks", "DeleteLatency", "DeleteThroughput", "DiskQueueDepth", "DMLLatency", "DMLThroughput", "EngineUptime", "FailedSqlStatements", "FreeableMemory", "FreeLocalStorage", "FreeStorageSpace", "InsertLatency", "InsertThroughput", "LoginFailures", "NetworkReceiveThroughput", "NetworkTransmitThroughput", "NetworkThroughput", "Queries", "ReadIOPS", "ReadLatency", "ReadThroughput", "ReplicaLag", "ResultSetCacheHitRatio", "SelectLatency", "SelectThroughput", "SwapUsage", "TotalConnections", "UpdateLatency", "UpdateThroughput", "VolumeBytesUsed", "VolumeReadIOPS", "VolumeWriteIOPS", "WriteIOPS", "WriteLatency", "WriteThroughput"}, + "AWS/Route53": {"ChildHealthCheckHealthyCount", "HealthCheckStatus", "HealthCheckPercentageHealthy", "ConnectionTime", "SSLHandshakeTime", "TimeToFirstByte"}, "AWS/S3": {"BucketSizeBytes", "NumberOfObjects", "AllRequests", "GetRequests", "PutRequests", "DeleteRequests", "HeadRequests", "PostRequests", "ListRequests", "BytesDownloaded", "BytesUploaded", "4xxErrors", "5xxErrors", "FirstByteLatency", "TotalRequestLatency"}, "AWS/SES": {"Bounce", "Complaint", "Delivery", "Reject", "Send"}, "AWS/SNS": {"NumberOfMessagesPublished", "PublishSize", "NumberOfNotificationsDelivered", "NumberOfNotificationsFailed"}, - "AWS/SQS": {"NumberOfMessagesSent", "SentMessageSize", "NumberOfMessagesReceived", "NumberOfEmptyReceives", "NumberOfMessagesDeleted", "ApproximateNumberOfMessagesDelayed", "ApproximateNumberOfMessagesVisible", "ApproximateNumberOfMessagesNotVisible"}, + "AWS/SQS": {"NumberOfMessagesSent", "SentMessageSize", "NumberOfMessagesReceived", "NumberOfEmptyReceives", "NumberOfMessagesDeleted", "ApproximateAgeOfOldestMessage", "ApproximateNumberOfMessagesDelayed", "ApproximateNumberOfMessagesVisible", "ApproximateNumberOfMessagesNotVisible"}, "AWS/StorageGateway": {"CacheHitPercent", "CachePercentUsed", "CachePercentDirty", "CloudBytesDownloaded", "CloudDownloadLatency", "CloudBytesUploaded", "UploadBufferFree", "UploadBufferPercentUsed", "UploadBufferUsed", "QueuedWrites", "ReadBytes", "ReadTime", "TotalCacheSize", "WriteBytes", "WriteTime", "TimeSinceLastRecoveryPoint", "WorkingStorageFree", "WorkingStoragePercentUsed", "WorkingStorageUsed", "CacheHitPercent", "CachePercentUsed", "CachePercentDirty", "ReadBytes", "ReadTime", "WriteBytes", "WriteTime", "QueuedWrites"}, "AWS/SWF": {"DecisionTaskScheduleToStartTime", "DecisionTaskStartToCloseTime", "DecisionTasksCompleted", "StartedDecisionTasksTimedOutOnClose", "WorkflowStartToCloseTime", "WorkflowsCanceled", "WorkflowsCompleted", "WorkflowsContinuedAsNew", "WorkflowsFailed", "WorkflowsTerminated", "WorkflowsTimedOut", @@ -124,8 +124,8 @@ func init() { "AWS/ML": {"MLModelId", "RequestMode"}, "AWS/OpsWorks": {"StackId", "LayerId", "InstanceId"}, "AWS/Redshift": {"NodeID", "ClusterIdentifier"}, - "AWS/RDS": {"DBInstanceIdentifier", "DBClusterIdentifier", "DatabaseClass", "EngineName"}, - "AWS/Route53": {"HealthCheckId"}, + "AWS/RDS": {"DBInstanceIdentifier", "DBClusterIdentifier", "DatabaseClass", "EngineName", "Role"}, + "AWS/Route53": {"HealthCheckId", "Region"}, "AWS/S3": {"BucketName", "StorageType", "FilterId"}, "AWS/SES": {}, "AWS/SNS": {"Application", "Platform", "TopicName"}, From 71b62f5cf9ab897d980ae5a0f4b8130d9236ff88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 8 Jun 2017 09:15:10 +0200 Subject: [PATCH 119/130] Create README.md --- docs/README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index ea3f8394ace..8db3afd7f91 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,7 @@ # Building The Docs To build the docs locally, you need to have docker installed. The -docs are built using a custom [docker](https://www.docker.com/) image -and the [mkdocs](http://www.mkdocs.org/) tool. +docs are built using a hugo. **Prepare the Docker Image**: @@ -11,19 +10,19 @@ when running ``make docs-build`` depending on how your system's docker service is configured): ``` -$ git clone https://github.com/grafana/grafana.org -$ cd grafana.org -$ make docs-build +git clone https://github.com/grafana/grafana.org +cd grafana.org +make docs-build ``` **Build the Documentation**: Now that the docker image has been prepared we can build the -docs. Switch your working directory back to the directory this file +grafana docs and start a docs server. Switch your working directory back to the directory this file (README.md) is in and run (possibly with ``sudo``): ``` -$ make docs +make watch ``` This command will not return control of the shell to the user. Instead @@ -32,4 +31,21 @@ we created in the previous step. Open [localhost:3004](http://localhost:3004) to view the docs. +### Images & Content +All markdown files are located in this repo (main grafana repo). But all images are added to the https://github.com/grafana/grafana.org repo. So the process of adding images is a bit complicated. + +First you need create a feature (PR) branch of https://github.com/grafana/grafana.org so you can make change. Then add the image to the `/static/img/docs` directory. Then make a commit that adds the image. + +The run +``` +make docs-build +``` + +This will rebuild the docs docker container. + +To be able to use the image your have to quit (CTRL-C) the `make watch` command (that you run in the same directory as this README). Then simply rerun `make watch`, it will restart the docs server but now with access to your image. + +### Editing content + +Changes to the markdown files should automatically cause a docs rebuild and live reload should reload the page in your browser. From c5d5d7ac5ac71220a879a57c4f5ee34f7c592095 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Thu, 8 Jun 2017 10:32:57 +0200 Subject: [PATCH 120/130] docs: instruction on creating dummy awsconfig To be able to build the docs an awsconfig file must exist for the Dockerfile to copy. This adds an instruction to create an empty, dummy file so that the build will work. --- docs/README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8db3afd7f91..7aeab15888b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,7 @@ # Building The Docs To build the docs locally, you need to have docker installed. The -docs are built using a hugo. +docs are built using [Hugo](http://gohugo.io/) - a static site generator. **Prepare the Docker Image**: @@ -19,7 +19,11 @@ make docs-build Now that the docker image has been prepared we can build the grafana docs and start a docs server. Switch your working directory back to the directory this file -(README.md) is in and run (possibly with ``sudo``): +(README.md) is in. + +An AWS config file is required to build the docs Docker image and to publish the site to AWS. If you are building locally only and do not have any AWS credentials for docs.grafana.org then create an empty file named `awsconfig` in the current directory. + +Then run (possibly with ``sudo``): ``` make watch @@ -37,7 +41,7 @@ All markdown files are located in this repo (main grafana repo). But all images First you need create a feature (PR) branch of https://github.com/grafana/grafana.org so you can make change. Then add the image to the `/static/img/docs` directory. Then make a commit that adds the image. -The run +Then run: ``` make docs-build ``` From f7c48c5a5fb04d3ec15872f1b5a989adc207353e Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Thu, 8 Jun 2017 11:06:37 +0200 Subject: [PATCH 121/130] singlestat: fix ignoring zero value for table data When table data returns a column with the value 0, it should not ignore it. This change checks for undefined instead of if the value is truthy. Fixes #8531 --- public/app/plugins/panel/singlestat/module.ts | 2 +- .../panel/singlestat/specs/singlestat_specs.ts | 16 ++++++++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/public/app/plugins/panel/singlestat/module.ts b/public/app/plugins/panel/singlestat/module.ts index 3b3fb928b74..dce82f17ce2 100644 --- a/public/app/plugins/panel/singlestat/module.ts +++ b/public/app/plugins/panel/singlestat/module.ts @@ -165,7 +165,7 @@ class SingleStatCtrl extends MetricsPanelCtrl { return; } - if (tableData[0].length === 0 || !tableData[0][0][this.panel.tableColumn]) { + if (tableData[0].length === 0 || tableData[0][0][this.panel.tableColumn] === undefined) { return; } diff --git a/public/app/plugins/panel/singlestat/specs/singlestat_specs.ts b/public/app/plugins/panel/singlestat/specs/singlestat_specs.ts index 6e05266b8fe..210196a24cc 100644 --- a/public/app/plugins/panel/singlestat/specs/singlestat_specs.ts +++ b/public/app/plugins/panel/singlestat/specs/singlestat_specs.ts @@ -65,7 +65,7 @@ describe('SingleStatCtrl', function() { expect(ctx.data.valueRounded).to.be(0); }); - it('should set formatted falue', function() { + it('should set formatted value', function() { expect(ctx.data.valueFormatted).to.be('test.cpu1'); }); }); @@ -82,7 +82,7 @@ describe('SingleStatCtrl', function() { expect(ctx.data.valueRounded).to.be(100); }); - it('should set formatted falue', function() { + it('should set formatted value', function() { expect(ctx.data.valueFormatted).to.be('100'); }); }); @@ -254,6 +254,18 @@ describe('SingleStatCtrl', function() { expect(ctx.data.valueFormatted).to.be('ignore1'); }); }); + + singleStatScenario('When value is zero', function(ctx) { + ctx.setup(function() { + ctx.data = tableData; + ctx.data[0].rows[0] = [1492759673649, 'ignore1', 0, 'ignore2']; + ctx.ctrl.panel.tableColumn = 'mean'; + }); + + it('Should return zero', function() { + expect(ctx.data.value).to.be(0); + }); + }); }); }); From 2c75593c1a61a391235b3f0a3b448ae984718d05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 8 Jun 2017 11:53:12 +0200 Subject: [PATCH 122/130] refactoring: elasticsearch raw doc size limit option PR, #8527 --- .../datasource/elasticsearch/query_builder.js | 13 ++++++------- .../elasticsearch/specs/datasource_specs.ts | 2 +- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/public/app/plugins/datasource/elasticsearch/query_builder.js b/public/app/plugins/datasource/elasticsearch/query_builder.js index 1493fd3eb95..b3d623b6189 100644 --- a/public/app/plugins/datasource/elasticsearch/query_builder.js +++ b/public/app/plugins/datasource/elasticsearch/query_builder.js @@ -110,7 +110,7 @@ function (queryDef) { }; ElasticQueryBuilder.prototype.documentQuery = function(query, size) { - query.size = size === undefined ? 500 : size; + query.size = size; query.sort = {}; query.sort[this.timeField] = {order: 'desc', unmapped_type: 'boolean'}; @@ -193,13 +193,12 @@ function (queryDef) { // handle document query if (target.bucketAggs.length === 0) { metric = target.metrics[0]; - if (metric && metric.type !== 'raw_document') { - target.bucketAggs = [{type: 'date_histogram', id: '2', settings: {interval: 'auto'}}]; - } else { - var size = metric && metric.hasOwnProperty("settings") && metric.settings.hasOwnProperty("size") - && metric.settings["size"] !== null ? metric.settings["size"] : 500 ; - return this.documentQuery(query,size); + if (!metric || metric.type !== 'raw_document') { + throw {message: 'Invalid query'}; } + + var size = (metric.settings && metric.settings.size) || 500; + return this.documentQuery(query, size); } nestedAggs = query; diff --git a/public/app/plugins/datasource/elasticsearch/specs/datasource_specs.ts b/public/app/plugins/datasource/elasticsearch/specs/datasource_specs.ts index 944aeae1bc4..f9684a3cd3f 100644 --- a/public/app/plugins/datasource/elasticsearch/specs/datasource_specs.ts +++ b/public/app/plugins/datasource/elasticsearch/specs/datasource_specs.ts @@ -62,7 +62,7 @@ describe('ElasticDatasource', function() { from: moment.utc([2015, 4, 30, 10]), to: moment.utc([2015, 5, 1, 10]) }, - targets: [{ bucketAggs: [], metrics: [], query: 'escape\\:test' }] + targets: [{ bucketAggs: [], metrics: [{type: 'raw_document'}], query: 'escape\\:test' }] }); ctx.$rootScope.$apply(); From a8e970033438e1902ee4b62f372dfbaaef787db4 Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Thu, 8 Jun 2017 13:38:18 +0200 Subject: [PATCH 123/130] docs: add whitelist option for auth.proxy --- docs/sources/installation/configuration.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/sources/installation/configuration.md b/docs/sources/installation/configuration.md index bc1b0eaa360..20f191b26e1 100644 --- a/docs/sources/installation/configuration.md +++ b/docs/sources/installation/configuration.md @@ -444,20 +444,29 @@ false only pre-existing Grafana users will be able to login (if ldap authenticat
      ## [auth.proxy] + This feature allows you to handle authentication in a http reverse proxy. ### enabled + Defaults to `false` ### header_name + Defaults to X-WEBAUTH-USER #### header_property + Defaults to username but can also be set to email ### auto_sign_up + Set to `true` to enable auto sign up of users who do not exist in Grafana DB. Defaults to `true`. +### whitelist + +Limit where auth proxy requests come from by configuring a list of IP addresses. This can be used to prevent users spoofing the X-WEBAUTH-USER header. +
      ## [session] From 95c8a76aa6907f537913b3359ca6d10fc1cb4347 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 8 Jun 2017 13:56:51 +0200 Subject: [PATCH 124/130] ux: minor search style improvements --- public/app/core/components/navbar/navbar.html | 2 +- public/sass/components/_navbar.scss | 4 ++++ public/sass/components/_search.scss | 22 ++++++++++++++----- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/public/app/core/components/navbar/navbar.html b/public/app/core/components/navbar/navbar.html index c2cd5e2b624..ea8eb21d6d6 100644 --- a/public/app/core/components/navbar/navbar.html +++ b/public/app/core/components/navbar/navbar.html @@ -8,7 +8,7 @@ - + diff --git a/public/sass/components/_navbar.scss b/public/sass/components/_navbar.scss index 89918d18e59..fd336ad94bf 100644 --- a/public/sass/components/_navbar.scss +++ b/public/sass/components/_navbar.scss @@ -137,6 +137,10 @@ max-width: 27px; max-height: 27px; } + + &--search { + padding: 1rem 1.5rem 0.75rem 1.5rem; + } } .navbar-page-btn-wrapper { diff --git a/public/sass/components/_search.scss b/public/sass/components/_search.scss index 2190e55f318..3c9f44afb2f 100644 --- a/public/sass/components/_search.scss +++ b/public/sass/components/_search.scss @@ -13,8 +13,9 @@ left: 0; top: 0; right: 0; + bottom: 0; z-index: ($zindex-modal-backdrop + 10); - position: absolute; + position: fixed; .label-tag { margin-left: 6px; @@ -46,6 +47,7 @@ .search-field-spacer { flex-grow: 1; } + .search-switches { flex-grow: 1; padding: 1rem 1rem 0.75rem 1rem; @@ -54,7 +56,7 @@ .search-field-icon { font-size: $font-size-lg; - padding: 1rem 1rem 0.75rem 1rem; + padding: 1rem 1rem 0.75rem 1.5rem; } .search-dropdown { @@ -63,6 +65,7 @@ max-width: 1100px; visibility: none; opacity: 0; + height: 100%; &--fade-in { visibility: visible; @@ -72,7 +75,7 @@ } .search-results-container { - height: 450px; + height: 90%; overflow: auto; display: block; line-height: 28px; @@ -143,8 +146,10 @@ .search-button-row { padding: $spacer*2; display: flex; - flex-direction: column; + flex-direction: row; align-items: flex-start; + justify-content: space-around; + height: 30%; button, a { margin-bottom: $spacer; @@ -164,10 +169,17 @@ } } -@include media-breakpoint-up(md) { +@include media-breakpoint-up(lg) { .search-dropdown { flex-direction: row; } + .search-button-row { + flex-direction: column; + justify-content: flex-start; + } +} + +@include media-breakpoint-up(md) { .search-container { left: 78px; } From 217c746445956dafc09ace159b4f109a32e6e9d9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 8 Jun 2017 14:23:51 +0200 Subject: [PATCH 125/130] ux: close edit views when opening panel in edit mode --- public/app/core/directives/dash_edit_link.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/public/app/core/directives/dash_edit_link.js b/public/app/core/directives/dash_edit_link.js index 5f7bdb956de..3e4bdd4c5c7 100644 --- a/public/app/core/directives/dash_edit_link.js +++ b/public/app/core/directives/dash_edit_link.js @@ -113,12 +113,18 @@ function ($, angular, coreModule) { }); scope.$on("$destroy", hideEditorPane); + scope.onAppEvent('hide-dash-editor', function() { hideEditorPane(false); }); scope.onAppEvent('show-dash-editor', showEditorPane); + + scope.onAppEvent('panel-fullscreen-enter', function() { + scope.appEvent('hide-dash-editor'); + }); } }; }); }); + From cdd5ba61987446ef46e9dc12299b533ef95c25ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Thu, 8 Jun 2017 21:41:58 +0200 Subject: [PATCH 126/130] fix: influxdb test data source error handling now works better, fixes #8577 --- public/app/plugins/datasource/influxdb/datasource.ts | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/public/app/plugins/datasource/influxdb/datasource.ts b/public/app/plugins/datasource/influxdb/datasource.ts index 6af6a849e95..0cbdcabcf10 100644 --- a/public/app/plugins/datasource/influxdb/datasource.ts +++ b/public/app/plugins/datasource/influxdb/datasource.ts @@ -200,10 +200,7 @@ export default class InfluxDatasource { } return { status: "success", message: "Data source is working", title: "Success" }; }).catch(err => { - if (err.data && err.message) { - return { status: "error", message: err.data.message, title: "InfluxDB Error" }; - } - return { status: "error", message: err.toString(), title: "InfluxDB Error" }; + return { status: "error", message: err.message, title: "Test Failed" }; }); } @@ -250,9 +247,9 @@ export default class InfluxDatasource { }, function(err) { if (err.status !== 0 || err.status >= 300) { if (err.data && err.data.error) { - throw { message: 'InfluxDB Error Response: ' + err.data.error, data: err.data, config: err.config }; + throw { message: 'InfluxDB Error: ' + err.data.error, data: err.data, config: err.config }; } else { - throw { message: 'InfluxDB Error: ' + err.message, data: err.data, config: err.config }; + throw { message: 'Network Error: ' + err.statusText + '(' + err.status + ')', data: err.data, config: err.config }; } } }); From 6992b484bc461cc0d2c02bafb621e1a283ce02db Mon Sep 17 00:00:00 2001 From: Daniel Lee Date: Fri, 9 Jun 2017 14:27:27 +0200 Subject: [PATCH 127/130] docs: improvements to building the docs readme Explains that you need to clone the grafana repo if you have not done that already. --- docs/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 7aeab15888b..ff5ef6a4131 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,11 +18,28 @@ make docs-build **Build the Documentation**: Now that the docker image has been prepared we can build the -grafana docs and start a docs server. Switch your working directory back to the directory this file +grafana docs and start a docs server. + +If you have not cloned the Grafana repository already then: + +``` +cd .. +git clone https://github.com/grafana/grafana +``` + +Switch your working directory to the directory this file (README.md) is in. +``` +cd grafana/docs +``` + An AWS config file is required to build the docs Docker image and to publish the site to AWS. If you are building locally only and do not have any AWS credentials for docs.grafana.org then create an empty file named `awsconfig` in the current directory. +``` +touch awsconfig +``` + Then run (possibly with ``sudo``): ``` From d10d897d6546f45a36f338ec9aca276d061fc0f7 Mon Sep 17 00:00:00 2001 From: Martin Molnar Date: Mon, 12 Jun 2017 15:11:00 +0200 Subject: [PATCH 128/130] fix: component name of plugin page contains 'undefined' (#8590) --- public/app/core/directives/plugin_component.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/public/app/core/directives/plugin_component.ts b/public/app/core/directives/plugin_component.ts index 4c098f60a4c..22c83f9b557 100644 --- a/public/app/core/directives/plugin_component.ts +++ b/public/app/core/directives/plugin_component.ts @@ -181,7 +181,7 @@ function pluginDirectiveLoader($compile, datasourceSrv, $rootScope, $q, $http, $ return System.import(appModel.module).then(function(appModule) { return { baseUrl: appModel.baseUrl, - name: 'app-page-' + appModel.appId + '-' + scope.ctrl.page.slug, + name: 'app-page-' + appModel.id + '-' + scope.ctrl.page.slug, bindings: {appModel: "="}, attrs: {"app-model": "ctrl.appModel"}, Component: appModule[scope.ctrl.page.component], From 192c447c2ce05367dbe1b66e68b5c451bdbb9abe Mon Sep 17 00:00:00 2001 From: Trent White Date: Mon, 12 Jun 2017 11:17:00 -0400 Subject: [PATCH 129/130] create new auth icon for grafana.com so it doesn't share the same file as the main logo (#8581) --- public/app/partials/login.html | 2 +- public/img/grafana_com_auth_icon.svg | 57 +++++++++++++ public/img/grafana_icon.svg | 115 +++++++++++++-------------- public/sass/pages/_login.scss | 1 + 4 files changed, 116 insertions(+), 59 deletions(-) create mode 100644 public/img/grafana_com_auth_icon.svg diff --git a/public/app/partials/login.html b/public/app/partials/login.html index 38517951cea..fe19d34f8d5 100644 --- a/public/app/partials/login.html +++ b/public/app/partials/login.html @@ -60,7 +60,7 @@ GitHub - + Grafana.com diff --git a/public/img/grafana_com_auth_icon.svg b/public/img/grafana_com_auth_icon.svg new file mode 100644 index 00000000000..72702223dc7 --- /dev/null +++ b/public/img/grafana_com_auth_icon.svg @@ -0,0 +1,57 @@ + + + + + + + + + + + + diff --git a/public/img/grafana_icon.svg b/public/img/grafana_icon.svg index 8616d369046..72702223dc7 100644 --- a/public/img/grafana_icon.svg +++ b/public/img/grafana_icon.svg @@ -1,58 +1,57 @@ - - - - - - - - - - - - - - + + + + + + + + + + + + diff --git a/public/sass/pages/_login.scss b/public/sass/pages/_login.scss index 67218f4dc71..2b3426b45b5 100644 --- a/public/sass/pages/_login.scss +++ b/public/sass/pages/_login.scss @@ -119,6 +119,7 @@ img { width: 19px; + vertical-align: sub; } } } From 7d642546b3fcf8ac8876fa46ee42d394670b832b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Torkel=20=C3=96degaard?= Date: Tue, 13 Jun 2017 13:21:22 -0400 Subject: [PATCH 130/130] fix: restore dashboard history version did not reload route correctly when slug did not change --- public/app/features/dashboard/history/history.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/public/app/features/dashboard/history/history.ts b/public/app/features/dashboard/history/history.ts index 10ab3f3fa28..f199d84ffb4 100644 --- a/public/app/features/dashboard/history/history.ts +++ b/public/app/features/dashboard/history/history.ts @@ -27,6 +27,7 @@ export class HistoryListCtrl { /** @ngInject */ constructor(private $scope, + private $route, private $rootScope, private $location, private $window, @@ -179,6 +180,7 @@ export class HistoryListCtrl { this.loading = true; return this.historySrv.restoreDashboard(this.dashboard, version).then(response => { this.$location.path('dashboard/db/' + response.slug); + this.$route.reload(); this.$rootScope.appEvent('alert-success', ['Dashboard restored', 'Restored from version ' + version]); }).catch(() => { this.mode = 'list';