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

LibraryPanels: Adds Type and Description to DB (#32258) (#32288)

Browse Source 
* Refactor: adds description to getCreateCommand

* Refactor: Adds type and description fields

* Chore: Updates FrontEnd

* Update pkg/services/librarypanels/database.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Update pkg/services/librarypanels/database.go

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>

* Chore: fixes backend linting error

Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
(cherry picked from commit 7f5487a461)
This commit is contained in:
Hugo Häggmark
2021-03-24 14:57:02 +01:00
committed by GitHub
parent 15ee6280db
commit 099f5cbf97
10 changed files with 335 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/librarypanels/database.go
+85 -65
View File
@@ -9,14 +9,13 @@ import (
"github.com/grafana/grafana/pkg/api/dtos" "github.com/grafana/grafana/pkg/api/dtos"
"github.com/grafana/grafana/pkg/models" "github.com/grafana/grafana/pkg/models"
"github.com/grafana/grafana/pkg/services/sqlstore" "github.com/grafana/grafana/pkg/services/sqlstore"
"github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/util" "github.com/grafana/grafana/pkg/util"
) )
var ( var (
sqlStatmentLibrayPanelDTOWithMeta = ` sqlStatmentLibrayPanelDTOWithMeta = `
SELECT DISTINCT SELECT DISTINCT
lp.id, lp.org_id, lp.folder_id, lp.uid, lp.name, lp.model, lp.created, lp.created_by, lp.updated, lp.updated_by, lp.version lp.id, lp.org_id, lp.folder_id, lp.uid, lp.name, lp.type, lp.description, lp.model, lp.created, lp.created_by, lp.updated, lp.updated_by, lp.version
, 0 AS can_edit , 0 AS can_edit
, u1.login AS created_by_name , u1.login AS created_by_name
, u1.email AS created_by_email , u1.email AS created_by_email
@@ -29,13 +28,23 @@ FROM library_panel AS lp
` `
) )
func syncTitleWithName(libraryPanel *LibraryPanel) error { func syncFieldsWithModel(libraryPanel *LibraryPanel) error {
var model map[string]interface{} var model map[string]interface{}
if err := json.Unmarshal(libraryPanel.Model, &model); err != nil { if err := json.Unmarshal(libraryPanel.Model, &model); err != nil {
return err return err
} }
model["title"] = libraryPanel.Name model["title"] = libraryPanel.Name
if model["type"] != nil {
libraryPanel.Type = model["type"].(string)
} else {
model["type"] = libraryPanel.Type
}
if model["description"] != nil {
libraryPanel.Description = model["description"].(string)
} else {
model["description"] = libraryPanel.Description
}
syncedModel, err := json.Marshal(&model) syncedModel, err := json.Marshal(&model)
if err != nil { if err != nil {
return err return err
@@ -63,7 +72,7 @@ func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd cre
UpdatedBy: c.SignedInUser.UserId, UpdatedBy: c.SignedInUser.UserId,
} }
if err := syncTitleWithName(&libraryPanel); err != nil { if err := syncFieldsWithModel(&libraryPanel); err != nil {
return LibraryPanelDTO{}, err return LibraryPanelDTO{}, err
} }
@@ -81,13 +90,15 @@ func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd cre
}) })
dto := LibraryPanelDTO{ dto := LibraryPanelDTO{
ID: libraryPanel.ID, ID: libraryPanel.ID,
OrgID: libraryPanel.OrgID, OrgID: libraryPanel.OrgID,
FolderID: libraryPanel.FolderID, FolderID: libraryPanel.FolderID,
UID: libraryPanel.UID, UID: libraryPanel.UID,
Name: libraryPanel.Name, Name: libraryPanel.Name,
Model: libraryPanel.Model, Type: libraryPanel.Type,
Version: libraryPanel.Version, Description: libraryPanel.Description,
Model: libraryPanel.Model,
Version: libraryPanel.Version,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
CanEdit: true, CanEdit: true,
ConnectedDashboards: 0, ConnectedDashboards: 0,
@@ -109,7 +120,17 @@ func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd cre
return dto, err return dto, err
} }
func connectDashboard(session *sqlstore.DBSession, dialect migrator.Dialect, user *models.SignedInUser, uid string, dashboardID int64) error { // connectDashboard adds a connection between a Library Panel and a Dashboard.
func (lps *LibraryPanelService) connectDashboard(c *models.ReqContext, uid string, dashboardID int64) error {
err := lps.SQLStore.WithTransactionalDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
return lps.internalConnectDashboard(session, c.SignedInUser, uid, dashboardID)
})
return err
}
func (lps *LibraryPanelService) internalConnectDashboard(session *sqlstore.DBSession, user *models.SignedInUser,
uid string, dashboardID int64) error {
panel, err := getLibraryPanel(session, uid, user.OrgId) panel, err := getLibraryPanel(session, uid, user.OrgId)
if err != nil { if err != nil {
return err return err
@@ -118,8 +139,6 @@ func connectDashboard(session *sqlstore.DBSession, dialect migrator.Dialect, use
return err return err
} }
// TODO add check that dashboard exists
libraryPanelDashboard := libraryPanelDashboard{ libraryPanelDashboard := libraryPanelDashboard{
DashboardID: dashboardID, DashboardID: dashboardID,
LibraryPanelID: panel.ID, LibraryPanelID: panel.ID,
@@ -127,7 +146,7 @@ func connectDashboard(session *sqlstore.DBSession, dialect migrator.Dialect, use
CreatedBy: user.UserId, CreatedBy: user.UserId,
} }
if _, err := session.Insert(&libraryPanelDashboard); err != nil { if _, err := session.Insert(&libraryPanelDashboard); err != nil {
if dialect.IsUniqueConstraintViolation(err) { if lps.SQLStore.Dialect.IsUniqueConstraintViolation(err) {
return nil return nil
} }
return err return err
@@ -135,15 +154,6 @@ func connectDashboard(session *sqlstore.DBSession, dialect migrator.Dialect, use
return nil return nil
} }
// connectDashboard adds a connection between a Library Panel and a Dashboard.
func (lps *LibraryPanelService) connectDashboard(c *models.ReqContext, uid string, dashboardID int64) error {
err := lps.SQLStore.WithTransactionalDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
return connectDashboard(session, lps.SQLStore.Dialect, c.SignedInUser, uid, dashboardID)
})
return err
}
// connectLibraryPanelsForDashboard adds connections for all Library Panels in a Dashboard. // connectLibraryPanelsForDashboard adds connections for all Library Panels in a Dashboard.
func (lps *LibraryPanelService) connectLibraryPanelsForDashboard(c *models.ReqContext, uids []string, dashboardID int64) error { func (lps *LibraryPanelService) connectLibraryPanelsForDashboard(c *models.ReqContext, uids []string, dashboardID int64) error {
err := lps.SQLStore.WithTransactionalDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error { err := lps.SQLStore.WithTransactionalDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
@@ -152,7 +162,7 @@ func (lps *LibraryPanelService) connectLibraryPanelsForDashboard(c *models.ReqCo
return err return err
} }
for _, uid := range uids { for _, uid := range uids {
err := connectDashboard(session, lps.SQLStore.Dialect, c.SignedInUser, uid, dashboardID) err := lps.internalConnectDashboard(session, c.SignedInUser, uid, dashboardID)
if err != nil { if err != nil {
return err return err
} }
@@ -343,13 +353,15 @@ func (lps *LibraryPanelService) getLibraryPanel(c *models.ReqContext, uid string
}) })
dto := LibraryPanelDTO{ dto := LibraryPanelDTO{
ID: libraryPanel.ID, ID: libraryPanel.ID,
OrgID: libraryPanel.OrgID, OrgID: libraryPanel.OrgID,
FolderID: libraryPanel.FolderID, FolderID: libraryPanel.FolderID,
UID: libraryPanel.UID, UID: libraryPanel.UID,
Name: libraryPanel.Name, Name: libraryPanel.Name,
Model: libraryPanel.Model, Type: libraryPanel.Type,
Version: libraryPanel.Version, Description: libraryPanel.Description,
Model: libraryPanel.Model,
Version: libraryPanel.Version,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
CanEdit: true, CanEdit: true,
ConnectedDashboards: libraryPanel.ConnectedDashboards, ConnectedDashboards: libraryPanel.ConnectedDashboards,
@@ -416,13 +428,15 @@ func (lps *LibraryPanelService) getAllLibraryPanels(c *models.ReqContext, perPag
retDTOs := make([]LibraryPanelDTO, 0) retDTOs := make([]LibraryPanelDTO, 0)
for _, panel := range libraryPanels { for _, panel := range libraryPanels {
retDTOs = append(retDTOs, LibraryPanelDTO{ retDTOs = append(retDTOs, LibraryPanelDTO{
ID: panel.ID, ID: panel.ID,
OrgID: panel.OrgID, OrgID: panel.OrgID,
FolderID: panel.FolderID, FolderID: panel.FolderID,
UID: panel.UID, UID: panel.UID,
Name: panel.Name, Name: panel.Name,
Model: panel.Model, Type: panel.Type,
Version: panel.Version, Description: panel.Description,
Model: panel.Model,
Version: panel.Version,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
CanEdit: true, CanEdit: true,
ConnectedDashboards: panel.ConnectedDashboards, ConnectedDashboards: panel.ConnectedDashboards,
@@ -512,13 +526,15 @@ func (lps *LibraryPanelService) getLibraryPanelsForDashboardID(c *models.ReqCont
for _, panel := range libraryPanels { for _, panel := range libraryPanels {
libraryPanelMap[panel.UID] = LibraryPanelDTO{ libraryPanelMap[panel.UID] = LibraryPanelDTO{
ID: panel.ID, ID: panel.ID,
OrgID: panel.OrgID, OrgID: panel.OrgID,
FolderID: panel.FolderID, FolderID: panel.FolderID,
UID: panel.UID, UID: panel.UID,
Name: panel.Name, Name: panel.Name,
Model: panel.Model, Type: panel.Type,
Version: panel.Version, Description: panel.Description,
Model: panel.Model,
Version: panel.Version,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
CanEdit: panel.CanEdit, CanEdit: panel.CanEdit,
ConnectedDashboards: panel.ConnectedDashboards, ConnectedDashboards: panel.ConnectedDashboards,
@@ -580,17 +596,19 @@ func (lps *LibraryPanelService) patchLibraryPanel(c *models.ReqContext, cmd patc
} }
var libraryPanel = LibraryPanel{ var libraryPanel = LibraryPanel{
ID: panelInDB.ID, ID: panelInDB.ID,
OrgID: c.SignedInUser.OrgId, OrgID: c.SignedInUser.OrgId,
FolderID: cmd.FolderID, FolderID: cmd.FolderID,
UID: uid, UID: uid,
Name: cmd.Name, Name: cmd.Name,
Model: cmd.Model, Type: panelInDB.Type,
Version: panelInDB.Version + 1, Description: panelInDB.Description,
Created: panelInDB.Created, Model: cmd.Model,
CreatedBy: panelInDB.CreatedBy, Version: panelInDB.Version + 1,
Updated: time.Now(), Created: panelInDB.Created,
UpdatedBy: c.SignedInUser.UserId, CreatedBy: panelInDB.CreatedBy,
Updated: time.Now(),
UpdatedBy: c.SignedInUser.UserId,
} }
if cmd.Name == "" { if cmd.Name == "" {
@@ -602,7 +620,7 @@ func (lps *LibraryPanelService) patchLibraryPanel(c *models.ReqContext, cmd patc
if err := handleFolderIDPatches(&libraryPanel, panelInDB.FolderID, cmd.FolderID, c.SignedInUser); err != nil { if err := handleFolderIDPatches(&libraryPanel, panelInDB.FolderID, cmd.FolderID, c.SignedInUser); err != nil {
return err return err
} }
if err := syncTitleWithName(&libraryPanel); err != nil { if err := syncFieldsWithModel(&libraryPanel); err != nil {
return err return err
} }
if rowsAffected, err := session.ID(panelInDB.ID).Update(&libraryPanel); err != nil { if rowsAffected, err := session.ID(panelInDB.ID).Update(&libraryPanel); err != nil {
@@ -615,13 +633,15 @@ func (lps *LibraryPanelService) patchLibraryPanel(c *models.ReqContext, cmd patc
} }
dto = LibraryPanelDTO{ dto = LibraryPanelDTO{
ID: libraryPanel.ID, ID: libraryPanel.ID,
OrgID: libraryPanel.OrgID, OrgID: libraryPanel.OrgID,
FolderID: libraryPanel.FolderID, FolderID: libraryPanel.FolderID,
UID: libraryPanel.UID, UID: libraryPanel.UID,
Name: libraryPanel.Name, Name: libraryPanel.Name,
Model: libraryPanel.Model, Type: libraryPanel.Type,
Version: libraryPanel.Version, Description: libraryPanel.Description,
Model: libraryPanel.Model,
Version: libraryPanel.Version,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
CanEdit: true, CanEdit: true,
ConnectedDashboards: panelInDB.ConnectedDashboards, ConnectedDashboards: panelInDB.ConnectedDashboards,
pkg/services/librarypanels/librarypanels.go
+7 -3
View File
@@ -102,9 +102,11 @@ func (lps *LibraryPanelService) LoadLibraryPanelsForDashboard(c *models.ReqConte
elem.Set("gridPos", panelAsJSON.Get("gridPos").MustMap()) elem.Set("gridPos", panelAsJSON.Get("gridPos").MustMap())
elem.Set("id", panelAsJSON.Get("id").MustInt64()) elem.Set("id", panelAsJSON.Get("id").MustInt64())
elem.Set("libraryPanel", map[string]interface{}{ elem.Set("libraryPanel", map[string]interface{}{
"uid": libraryPanelInDB.UID, "uid": libraryPanelInDB.UID,
"name": libraryPanelInDB.Name, "name": libraryPanelInDB.Name,
"version": libraryPanelInDB.Version, "type": libraryPanelInDB.Type,
"description": libraryPanelInDB.Description,
"version": libraryPanelInDB.Version,
"meta": map[string]interface{}{ "meta": map[string]interface{}{
"canEdit": libraryPanelInDB.Meta.CanEdit, "canEdit": libraryPanelInDB.Meta.CanEdit,
"connectedDashboards": libraryPanelInDB.Meta.ConnectedDashboards, "connectedDashboards": libraryPanelInDB.Meta.ConnectedDashboards,
@@ -242,6 +244,8 @@ func (lps *LibraryPanelService) AddMigration(mg *migrator.Migrator) {
{Name: "folder_id", Type: migrator.DB_BigInt, Nullable: false}, {Name: "folder_id", Type: migrator.DB_BigInt, Nullable: false},
{Name: "uid", Type: migrator.DB_NVarchar, Length: 40, Nullable: false}, {Name: "uid", Type: migrator.DB_NVarchar, Length: 40, Nullable: false},
{Name: "name", Type: migrator.DB_NVarchar, Length: 255, Nullable: false}, {Name: "name", Type: migrator.DB_NVarchar, Length: 255, Nullable: false},
{Name: "type", Type: migrator.DB_NVarchar, Length: 40, Nullable: false},
{Name: "description", Type: migrator.DB_NVarchar, Length: 255, Nullable: false},
{Name: "model", Type: migrator.DB_Text, Nullable: false}, {Name: "model", Type: migrator.DB_Text, Nullable: false},
{Name: "created", Type: migrator.DB_DateTime, Nullable: false}, {Name: "created", Type: migrator.DB_DateTime, Nullable: false},
{Name: "created_by", Type: migrator.DB_BigInt, Nullable: false}, {Name: "created_by", Type: migrator.DB_BigInt, Nullable: false},
pkg/services/librarypanels/librarypanels_create_test.go
+24 -18
View File
@@ -19,16 +19,19 @@ func TestCreateLibraryPanel(t *testing.T) {
func(t *testing.T, sc scenarioContext) { func(t *testing.T, sc scenarioContext) {
var expected = libraryPanelResult{ var expected = libraryPanelResult{
Result: libraryPanel{ Result: libraryPanel{
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: sc.initialResult.Result.UID, UID: sc.initialResult.Result.UID,
Name: "Text - Library Panel", Name: "Text - Library Panel",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel", "id": float64(1),
"type": "text", "title": "Text - Library Panel",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -61,16 +64,19 @@ func TestCreateLibraryPanel(t *testing.T) {
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
var expected = libraryPanelResult{ var expected = libraryPanelResult{
Result: libraryPanel{ Result: libraryPanel{
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.UID, UID: result.Result.UID,
Name: "Library Panel Name", Name: "Library Panel Name",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Library Panel Name", "id": float64(1),
"type": "text", "title": "Library Panel Name",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
pkg/services/librarypanels/librarypanels_get_all_test.go
+72 -54
View File
@@ -51,16 +51,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
PerPage: 100, PerPage: 100,
LibraryPanels: []libraryPanel{ LibraryPanels: []libraryPanel{
{ {
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[0].UID, UID: result.Result.LibraryPanels[0].UID,
Name: "Text - Library Panel", Name: "Text - Library Panel",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel", "id": float64(1),
"type": "text", "title": "Text - Library Panel",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -81,16 +84,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
}, },
}, },
{ {
ID: 2, ID: 2,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[1].UID, UID: result.Result.LibraryPanels[1].UID,
Name: "Text - Library Panel2", Name: "Text - Library Panel2",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel2", "id": float64(1),
"type": "text", "title": "Text - Library Panel2",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -140,16 +146,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
PerPage: 100, PerPage: 100,
LibraryPanels: []libraryPanel{ LibraryPanels: []libraryPanel{
{ {
ID: 2, ID: 2,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[0].UID, UID: result.Result.LibraryPanels[0].UID,
Name: "Text - Library Panel2", Name: "Text - Library Panel2",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel2", "id": float64(1),
"type": "text", "title": "Text - Library Panel2",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -199,16 +208,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
PerPage: 1, PerPage: 1,
LibraryPanels: []libraryPanel{ LibraryPanels: []libraryPanel{
{ {
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[0].UID, UID: result.Result.LibraryPanels[0].UID,
Name: "Text - Library Panel", Name: "Text - Library Panel",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel", "id": float64(1),
"type": "text", "title": "Text - Library Panel",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -259,16 +271,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
PerPage: 1, PerPage: 1,
LibraryPanels: []libraryPanel{ LibraryPanels: []libraryPanel{
{ {
ID: 2, ID: 2,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[0].UID, UID: result.Result.LibraryPanels[0].UID,
Name: "Text - Library Panel2", Name: "Text - Library Panel2",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel2", "id": float64(1),
"type": "text", "title": "Text - Library Panel2",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -320,16 +335,19 @@ func TestGetAllLibraryPanels(t *testing.T) {
PerPage: 1, PerPage: 1,
LibraryPanels: []libraryPanel{ LibraryPanels: []libraryPanel{
{ {
ID: 2, ID: 2,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.LibraryPanels[0].UID, UID: result.Result.LibraryPanels[0].UID,
Name: "Text - Library Panel2", Name: "Text - Library Panel2",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel2", "id": float64(1),
"type": "text", "title": "Text - Library Panel2",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
pkg/services/librarypanels/librarypanels_get_test.go
+12 -9
View File
@@ -24,16 +24,19 @@ func TestGetLibraryPanel(t *testing.T) {
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
var expected = libraryPanelResult{ var expected = libraryPanelResult{
Result: libraryPanel{ Result: libraryPanel{
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: 1, FolderID: 1,
UID: result.Result.UID, UID: result.Result.UID,
Name: "Text - Library Panel", Name: "Text - Library Panel",
Type: "text",
Description: "A description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "A description",
"title": "Text - Library Panel", "id": float64(1),
"type": "text", "title": "Text - Library Panel",
"type": "text",
}, },
Version: 1, Version: 1,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
pkg/services/librarypanels/librarypanels_patch_test.go
+82 -24
View File
@@ -32,9 +32,10 @@ func TestPatchLibraryPanel(t *testing.T) {
Model: []byte(` Model: []byte(`
{ {
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"description": "An updated description",
"id": 1, "id": 1,
"title": "Model - New name", "title": "Model - New name",
"type": "text" "type": "graph"
} }
`), `),
Version: 1, Version: 1,
@@ -45,16 +46,19 @@ func TestPatchLibraryPanel(t *testing.T) {
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
var expected = libraryPanelResult{ var expected = libraryPanelResult{
Result: libraryPanel{ Result: libraryPanel{
ID: 1, ID: 1,
OrgID: 1, OrgID: 1,
FolderID: newFolder.Id, FolderID: newFolder.Id,
UID: sc.initialResult.Result.UID, UID: sc.initialResult.Result.UID,
Name: "Panel - New name", Name: "Panel - New name",
Type: "graph",
Description: "An updated description",
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "description": "An updated description",
"title": "Panel - New name", "id": float64(1),
"type": "text", "title": "Panel - New name",
"type": "graph",
}, },
Version: 2, Version: 2,
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
@@ -64,8 +68,8 @@ func TestPatchLibraryPanel(t *testing.T) {
Updated: result.Result.Meta.Updated, Updated: result.Result.Meta.Updated,
CreatedBy: LibraryPanelDTOMetaUser{ CreatedBy: LibraryPanelDTOMetaUser{
ID: 1, ID: 1,
Name: "user_in_db", Name: UserInDbName,
AvatarUrl: "/avatar/402d08de060496d6b6874495fe20f5ad", AvatarUrl: UserInDbAvatar,
}, },
UpdatedBy: LibraryPanelDTOMetaUser{ UpdatedBy: LibraryPanelDTOMetaUser{
ID: 1, ID: 1,
@@ -92,8 +96,8 @@ func TestPatchLibraryPanel(t *testing.T) {
require.Equal(t, 200, resp.Status()) require.Equal(t, 200, resp.Status())
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.FolderID = newFolder.Id sc.initialResult.Result.FolderID = newFolder.Id
sc.initialResult.Result.Meta.CreatedBy.Name = "user_in_db" sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Version = 2 sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" { if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff) t.Fatalf("Result mismatch (-want +got):\n%s", diff)
@@ -111,8 +115,8 @@ func TestPatchLibraryPanel(t *testing.T) {
resp := sc.service.patchHandler(sc.reqContext, cmd) resp := sc.service.patchHandler(sc.reqContext, cmd)
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.Name = "New Name" sc.initialResult.Result.Name = "New Name"
sc.initialResult.Result.Meta.CreatedBy.Name = "user_in_db" sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Model["title"] = "New Name" sc.initialResult.Result.Model["title"] = "New Name"
sc.initialResult.Result.Version = 2 sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" { if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
@@ -120,22 +124,76 @@ func TestPatchLibraryPanel(t *testing.T) {
} }
}) })
scenarioWithLibraryPanel(t, "When an admin tries to patch a library panel with model only, it should change model successfully and return correct result", scenarioWithLibraryPanel(t, "When an admin tries to patch a library panel with model only, it should change model successfully, sync name, type and description fields and return correct result",
func(t *testing.T, sc scenarioContext) { func(t *testing.T, sc scenarioContext) {
cmd := patchLibraryPanelCommand{ cmd := patchLibraryPanelCommand{
FolderID: -1, FolderID: -1,
Model: []byte(`{ "title": "New Model Title", "name": "New Model Name" }`), Model: []byte(`{ "title": "New Model Title", "name": "New Model Name", "type":"graph", "description": "New description" }`),
Version: 1, Version: 1,
} }
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID}) sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
resp := sc.service.patchHandler(sc.reqContext, cmd) resp := sc.service.patchHandler(sc.reqContext, cmd)
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.Type = "graph"
sc.initialResult.Result.Description = "New description"
sc.initialResult.Result.Model = map[string]interface{}{ sc.initialResult.Result.Model = map[string]interface{}{
"title": "Text - Library Panel", "title": "Text - Library Panel",
"name": "New Model Name", "name": "New Model Name",
"type": "graph",
"description": "New description",
} }
sc.initialResult.Result.Meta.CreatedBy.Name = "user_in_db" sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
}
})
scenarioWithLibraryPanel(t, "When an admin tries to patch a library panel with model.description only, it should change model successfully, sync name, type and description fields and return correct result",
func(t *testing.T, sc scenarioContext) {
cmd := patchLibraryPanelCommand{
FolderID: -1,
Model: []byte(`{ "description": "New description" }`),
Version: 1,
}
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
resp := sc.service.patchHandler(sc.reqContext, cmd)
var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.Type = "text"
sc.initialResult.Result.Description = "New description"
sc.initialResult.Result.Model = map[string]interface{}{
"title": "Text - Library Panel",
"type": "text",
"description": "New description",
}
sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
}
})
scenarioWithLibraryPanel(t, "When an admin tries to patch a library panel with model.type only, it should change model successfully, sync name, type and description fields and return correct result",
func(t *testing.T, sc scenarioContext) {
cmd := patchLibraryPanelCommand{
FolderID: -1,
Model: []byte(`{ "type": "graph" }`),
Version: 1,
}
sc.reqContext.ReplaceAllParams(map[string]string{":uid": sc.initialResult.Result.UID})
resp := sc.service.patchHandler(sc.reqContext, cmd)
var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.Type = "graph"
sc.initialResult.Result.Description = "A description"
sc.initialResult.Result.Model = map[string]interface{}{
"title": "Text - Library Panel",
"type": "graph",
"description": "A description",
}
sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Version = 2 sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" { if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff) t.Fatalf("Result mismatch (-want +got):\n%s", diff)
@@ -150,8 +208,8 @@ func TestPatchLibraryPanel(t *testing.T) {
resp := sc.service.patchHandler(sc.reqContext, cmd) resp := sc.service.patchHandler(sc.reqContext, cmd)
var result = validateAndUnMarshalResponse(t, resp) var result = validateAndUnMarshalResponse(t, resp)
sc.initialResult.Result.Meta.UpdatedBy.ID = int64(2) sc.initialResult.Result.Meta.UpdatedBy.ID = int64(2)
sc.initialResult.Result.Meta.CreatedBy.Name = "user_in_db" sc.initialResult.Result.Meta.CreatedBy.Name = UserInDbName
sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" sc.initialResult.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
sc.initialResult.Result.Version = 2 sc.initialResult.Result.Version = 2
if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" { if diff := cmp.Diff(sc.initialResult.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff) t.Fatalf("Result mismatch (-want +got):\n%s", diff)
pkg/services/librarypanels/librarypanels_test.go
+19 -13
View File
@@ -84,11 +84,14 @@ func TestLoadLibraryPanelsForDashboard(t *testing.T) {
"x": 6, "x": 6,
"y": 0, "y": 0,
}, },
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"description": "A description",
"libraryPanel": map[string]interface{}{ "libraryPanel": map[string]interface{}{
"uid": sc.initialResult.Result.UID, "uid": sc.initialResult.Result.UID,
"name": sc.initialResult.Result.Name, "name": sc.initialResult.Result.Name,
"version": sc.initialResult.Result.Version, "type": sc.initialResult.Result.Type,
"description": sc.initialResult.Result.Description,
"version": sc.initialResult.Result.Version,
"meta": map[string]interface{}{ "meta": map[string]interface{}{
"canEdit": false, "canEdit": false,
"connectedDashboards": int64(1), "connectedDashboards": int64(1),
@@ -664,14 +667,16 @@ func TestDeleteLibraryPanelsInFolder(t *testing.T) {
} }
type libraryPanel struct { type libraryPanel struct {
ID int64 `json:"id"` ID int64 `json:"id"`
OrgID int64 `json:"orgId"` OrgID int64 `json:"orgId"`
FolderID int64 `json:"folderId"` FolderID int64 `json:"folderId"`
UID string `json:"uid"` UID string `json:"uid"`
Name string `json:"name"` Name string `json:"name"`
Model map[string]interface{} `json:"model"` Type string
Version int64 `json:"version"` Description string
Meta LibraryPanelDTOMeta `json:"meta"` Model map[string]interface{} `json:"model"`
Version int64 `json:"version"`
Meta LibraryPanelDTOMeta `json:"meta"`
} }
type libraryPanelResult struct { type libraryPanelResult struct {
@@ -723,7 +728,8 @@ func getCreateCommand(folderID int64, name string) createLibraryPanelCommand {
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": 1, "id": 1,
"title": "Text - Library Panel", "title": "Text - Library Panel",
"type": "text" "type": "text",
"description": "A description"
} }
`), `),
} }
pkg/services/librarypanels/models.go
+28 -22
View File
@@ -8,13 +8,15 @@ import (
// LibraryPanel is the model for library panel definitions. // LibraryPanel is the model for library panel definitions.
type LibraryPanel struct { type LibraryPanel struct {
ID int64 `xorm:"pk autoincr 'id'"` ID int64 `xorm:"pk autoincr 'id'"`
OrgID int64 `xorm:"org_id"` OrgID int64 `xorm:"org_id"`
FolderID int64 `xorm:"folder_id"` FolderID int64 `xorm:"folder_id"`
UID string `xorm:"uid"` UID string `xorm:"uid"`
Name string Name string
Model json.RawMessage Type string
Version int64 Description string
Model json.RawMessage
Version int64
Created time.Time Created time.Time
Updated time.Time Updated time.Time
@@ -25,13 +27,15 @@ type LibraryPanel struct {
// LibraryPanelWithMeta is the model used to retrieve library panels with additional meta information. // LibraryPanelWithMeta is the model used to retrieve library panels with additional meta information.
type LibraryPanelWithMeta struct { type LibraryPanelWithMeta struct {
ID int64 `xorm:"pk autoincr 'id'"` ID int64 `xorm:"pk autoincr 'id'"`
OrgID int64 `xorm:"org_id"` OrgID int64 `xorm:"org_id"`
FolderID int64 `xorm:"folder_id"` FolderID int64 `xorm:"folder_id"`
UID string `xorm:"uid"` UID string `xorm:"uid"`
Name string Name string
Model json.RawMessage Type string
Version int64 Description string
Model json.RawMessage
Version int64
Created time.Time Created time.Time
Updated time.Time Updated time.Time
@@ -48,14 +52,16 @@ type LibraryPanelWithMeta struct {
// LibraryPanelDTO is the frontend DTO for library panels. // LibraryPanelDTO is the frontend DTO for library panels.
type LibraryPanelDTO struct { type LibraryPanelDTO struct {
ID int64 `json:"id"` ID int64 `json:"id"`
OrgID int64 `json:"orgId"` OrgID int64 `json:"orgId"`
FolderID int64 `json:"folderId"` FolderID int64 `json:"folderId"`
UID string `json:"uid"` UID string `json:"uid"`
Name string `json:"name"` Name string `json:"name"`
Model json.RawMessage `json:"model"` Type string `json:"type"`
Version int64 `json:"version"` Description string `json:"description"`
Meta LibraryPanelDTOMeta `json:"meta"` Model json.RawMessage `json:"model"`
Version int64 `json:"version"`
Meta LibraryPanelDTOMeta `json:"meta"`
} }
// LibraryPanelSearchResult is the search result for library panels. // LibraryPanelSearchResult is the search result for library panels.
public/app/features/library-panels/components/LibraryPanelsView/reducer.test.ts
+4
View File
@@ -130,6 +130,8 @@ function mockLibraryPanel({
updatedBy: { id: 2, name: 'User Y', avatarUrl: '/avatar/xyz' }, updatedBy: { id: 2, name: 'User Y', avatarUrl: '/avatar/xyz' },
}, },
version = 1, version = 1,
description = 'a description',
type = 'text',
}: Partial<LibraryPanelDTO> = {}): LibraryPanelDTO { }: Partial<LibraryPanelDTO> = {}): LibraryPanelDTO {
return { return {
uid, uid,
@@ -140,5 +142,7 @@ function mockLibraryPanel({
model, model,
version, version,
meta, meta,
description,
type,
}; };
} }
public/app/features/library-panels/types.ts
+2
View File
@@ -15,6 +15,8 @@ export interface LibraryPanelDTO {
folderId: number; folderId: number;
uid: string; uid: string;
name: string; name: string;
type: string;
description: string;
model: any; model: any;
version: number; version: number;
meta: LibraryPanelDTOMeta; meta: LibraryPanelDTOMeta;