mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
A simple version control system for dashboards. Closes #1504. Goals 1. To create a new dashboard version every time a dashboard is saved. 2. To allow users to view all versions of a given dashboard. 3. To allow users to rollback to a previous version of a dashboard. 4. To allow users to compare two versions of a dashboard. Usage Navigate to a dashboard, and click the settings cog. From there, click the "Changelog" button to be brought to the Changelog view. In this view, a table containing each version of a dashboard can be seen. Each entry in the table represents a dashboard version. A selectable checkbox, the version number, date created, name of the user who created that version, and commit message is shown in the table, along with a button that allows a user to restore to a previous version of that dashboard. If a user wants to restore to a previous version of their dashboard, they can do so by clicking the previously mentioned button. If a user wants to compare two different versions of a dashboard, they can do so by clicking the checkbox of two different dashboard versions, then clicking the "Compare versions" button located below the dashboard. From there, the user is brought to a view showing a summary of the dashboard differences. Each summarized change contains a link that can be clicked to take the user a JSON diff highlighting the changes line by line. Overview of Changes Backend Changes - A `dashboard_version` table was created to store each dashboard version, along with a dashboard version model and structs to represent the queries and commands necessary for the dashboard version API methods. - API endpoints were created to support working with dashboard versions. - Methods were added to create, update, read, and destroy dashboard versions in the database. - Logic was added to compute the diff between two versions, and display it to the user. - The dashboard migration logic was updated to save a "Version 1" of each existing dashboard in the database. Frontend Changes - New views - Methods to pull JSON and HTML from endpoints New API Endpoints Each endpoint requires the authorization header to be sent in the format, ``` Authorization: Bearer <jwt> ``` where `<jwt>` is a JSON web token obtained from the Grafana admin panel. `GET "/api/dashboards/db/:dashboardId/versions?orderBy=<string>&limit=<int>&start=<int>"` Get all dashboard versions for the given dashboard ID. Accepts three URL parameters: - `orderBy` String to order the results by. Possible values are `version`, `created`, `created_by`, `message`. Default is `versions`. Ordering is always in descending order. - `limit` Maximum number of results to return - `start` Position in results to start from `GET "/api/dashboards/db/:dashboardId/versions/:id"` Get an individual dashboard version by ID, for the given dashboard ID. `POST "/api/dashboards/db/:dashboardId/restore"` Restore to the given dashboard version. Post body is of content-type `application/json`, and must contain. ```json { "dashboardId": <int>, "version": <int> } ``` `GET "/api/dashboards/db/:dashboardId/compare/:versionA...:versionB"` Compare two dashboard versions by ID for the given dashboard ID, returning a JSON delta formatted representation of the diff. The URL format follows what GitHub does. For example, visiting [/api/dashboards/db/18/compare/22...33](http://ec2-54-80-139-44.compute-1.amazonaws.com:3000/api/dashboards/db/18/compare/22...33) will return the diff between versions 22 and 33 for the dashboard ID 18. Dependencies Added - The Go package [gojsondiff](https://github.com/yudai/gojsondiff) was added and vendored.
89 lines
2.4 KiB
Go
89 lines
2.4 KiB
Go
// 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
|
|
}
|