Skip to content

N
nexpie-grafana-theme
Commit 0a4c3b87 by Hugo Häggmark Committed by GitHub
Options

LibraryPanels: Syncs panel title with name (#31311)

parent a20119db
Showing with 81 additions and 6 deletions
pkg/services/librarypanels/database.go
package librarypanels package librarypanels
import ( import (
"encoding/json"
"fmt" "fmt"
"time" "time"
...@@ -26,6 +27,23 @@ FROM library_panel AS lp ...@@ -26,6 +27,23 @@ FROM library_panel AS lp
` `
) )
func syncTitleWithName(libraryPanel *LibraryPanel) error {
var model map[string]interface{}
if err := json.Unmarshal(libraryPanel.Model, &model); err != nil {
return err
}
model["title"] = libraryPanel.Name
syncedModel, err := json.Marshal(&model)
if err != nil {
return err
}
libraryPanel.Model = syncedModel
return nil
}
// createLibraryPanel adds a Library Panel. // createLibraryPanel adds a Library Panel.
func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd createLibraryPanelCommand) (LibraryPanelDTO, error) { func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd createLibraryPanelCommand) (LibraryPanelDTO, error) {
libraryPanel := LibraryPanel{ libraryPanel := LibraryPanel{
...@@ -41,6 +59,11 @@ func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd cre ...@@ -41,6 +59,11 @@ func (lps *LibraryPanelService) createLibraryPanel(c *models.ReqContext, cmd cre
CreatedBy: c.SignedInUser.UserId, CreatedBy: c.SignedInUser.UserId,
UpdatedBy: c.SignedInUser.UserId, UpdatedBy: c.SignedInUser.UserId,
} }
if err := syncTitleWithName(&libraryPanel); err != nil {
return LibraryPanelDTO{}, err
}
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 {
if _, err := session.Insert(&libraryPanel); err != nil { if _, err := session.Insert(&libraryPanel); err != nil {
if lps.SQLStore.Dialect.IsUniqueConstraintViolation(err) { if lps.SQLStore.Dialect.IsUniqueConstraintViolation(err) {
...@@ -399,6 +422,9 @@ func (lps *LibraryPanelService) patchLibraryPanel(c *models.ReqContext, cmd patc ...@@ -399,6 +422,9 @@ func (lps *LibraryPanelService) patchLibraryPanel(c *models.ReqContext, cmd patc
if cmd.Model == nil { if cmd.Model == nil {
libraryPanel.Model = panelInDB.Model libraryPanel.Model = panelInDB.Model
} }
if err := syncTitleWithName(&libraryPanel); err != nil {
return err
}
if rowsAffected, err := session.ID(panelInDB.ID).Update(&libraryPanel); err != nil { if rowsAffected, err := session.ID(panelInDB.ID).Update(&libraryPanel); err != nil {
if lps.SQLStore.Dialect.IsUniqueConstraintViolation(err) { if lps.SQLStore.Dialect.IsUniqueConstraintViolation(err) {
......
pkg/services/librarypanels/librarypanels_test.go
...@@ -74,6 +74,51 @@ func TestCreateLibraryPanel(t *testing.T) { ...@@ -74,6 +74,51 @@ func TestCreateLibraryPanel(t *testing.T) {
t.Fatalf("Result mismatch (-want +got):\n%s", diff) t.Fatalf("Result mismatch (-want +got):\n%s", diff)
} }
}) })
testScenario(t, "When an admin tries to create a library panel where name and panel title differ, it should update panel title",
func(t *testing.T, sc scenarioContext) {
command := getCreateCommand(1, "Library Panel Name")
response := sc.service.createHandler(sc.reqContext, command)
require.Equal(t, 200, response.Status())
var result libraryPanelResult
err := json.Unmarshal(response.Body(), &result)
require.NoError(t, err)
var expected = libraryPanelResult{
Result: libraryPanel{
ID: 1,
OrgID: 1,
FolderID: 1,
UID: result.Result.UID,
Name: "Library Panel Name",
Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1),
"title": "Library Panel Name",
"type": "text",
},
Meta: LibraryPanelDTOMeta{
CanEdit: true,
ConnectedDashboards: 0,
Created: result.Result.Meta.Created,
Updated: result.Result.Meta.Updated,
CreatedBy: LibraryPanelDTOMetaUser{
ID: 1,
Name: "signed_in_user",
AvatarUrl: "/avatar/37524e1eb8b3e32850b57db0a19af93b",
},
UpdatedBy: LibraryPanelDTOMetaUser{
ID: 1,
Name: "signed_in_user",
AvatarUrl: "/avatar/37524e1eb8b3e32850b57db0a19af93b",
},
},
},
}
if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff)
}
})
} }
func TestConnectLibraryPanel(t *testing.T) { func TestConnectLibraryPanel(t *testing.T) {
...@@ -355,7 +400,7 @@ func TestGetAllLibraryPanels(t *testing.T) { ...@@ -355,7 +400,7 @@ func TestGetAllLibraryPanels(t *testing.T) {
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "id": float64(1),
"title": "Text - Library Panel", "title": "Text - Library Panel2",
"type": "text", "type": "text",
}, },
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
...@@ -556,7 +601,7 @@ func TestPatchLibraryPanel(t *testing.T) { ...@@ -556,7 +601,7 @@ func TestPatchLibraryPanel(t *testing.T) {
Model: map[string]interface{}{ Model: map[string]interface{}{
"datasource": "${DS_GDEV-TESTDATA}", "datasource": "${DS_GDEV-TESTDATA}",
"id": float64(1), "id": float64(1),
"title": "Model - New name", "title": "Panel - New name",
"type": "text", "type": "text",
}, },
Meta: LibraryPanelDTOMeta{ Meta: LibraryPanelDTOMeta{
...@@ -610,7 +655,7 @@ func TestPatchLibraryPanel(t *testing.T) { ...@@ -610,7 +655,7 @@ func TestPatchLibraryPanel(t *testing.T) {
} }
}) })
testScenario(t, "When an admin tries to patch a library panel with name only, it should change name successfully and return correct result", testScenario(t, "When an admin tries to patch a library panel with name only, it should change name successfully, sync title and return correct result",
func(t *testing.T, sc scenarioContext) { func(t *testing.T, sc scenarioContext) {
command := getCreateCommand(1, "Text - Library Panel") command := getCreateCommand(1, "Text - Library Panel")
response := sc.service.createHandler(sc.reqContext, command) response := sc.service.createHandler(sc.reqContext, command)
...@@ -626,12 +671,15 @@ func TestPatchLibraryPanel(t *testing.T) { ...@@ -626,12 +671,15 @@ func TestPatchLibraryPanel(t *testing.T) {
sc.reqContext.ReplaceAllParams(map[string]string{":uid": existing.Result.UID}) sc.reqContext.ReplaceAllParams(map[string]string{":uid": existing.Result.UID})
response = sc.service.patchHandler(sc.reqContext, cmd) response = sc.service.patchHandler(sc.reqContext, cmd)
require.Equal(t, 200, response.Status()) require.Equal(t, 200, response.Status())
var result libraryPanelResult var result libraryPanelResult
err = json.Unmarshal(response.Body(), &result) err = json.Unmarshal(response.Body(), &result)
require.NoError(t, err) require.NoError(t, err)
existing.Result.Name = "New Name" existing.Result.Name = "New Name"
existing.Result.Meta.CreatedBy.Name = "user_in_db" existing.Result.Meta.CreatedBy.Name = "user_in_db"
existing.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" existing.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad"
existing.Result.Model["title"] = "New Name"
if diff := cmp.Diff(existing.Result, result.Result, getCompareOptions()...); diff != "" { if diff := cmp.Diff(existing.Result, result.Result, getCompareOptions()...); diff != "" {
t.Fatalf("Result mismatch (-want +got):\n%s", diff) t.Fatalf("Result mismatch (-want +got):\n%s", diff)
} }
...@@ -648,7 +696,7 @@ func TestPatchLibraryPanel(t *testing.T) { ...@@ -648,7 +696,7 @@ func TestPatchLibraryPanel(t *testing.T) {
require.NoError(t, err) require.NoError(t, err)
cmd := patchLibraryPanelCommand{ cmd := patchLibraryPanelCommand{
Model: []byte(`{ "name": "New Model Name" }`), Model: []byte(`{ "title": "New Model Title", "name": "New Model Name" }`),
} }
sc.reqContext.ReplaceAllParams(map[string]string{":uid": existing.Result.UID}) sc.reqContext.ReplaceAllParams(map[string]string{":uid": existing.Result.UID})
response = sc.service.patchHandler(sc.reqContext, cmd) response = sc.service.patchHandler(sc.reqContext, cmd)
...@@ -657,7 +705,8 @@ func TestPatchLibraryPanel(t *testing.T) { ...@@ -657,7 +705,8 @@ func TestPatchLibraryPanel(t *testing.T) {
err = json.Unmarshal(response.Body(), &result) err = json.Unmarshal(response.Body(), &result)
require.NoError(t, err) require.NoError(t, err)
existing.Result.Model = map[string]interface{}{ existing.Result.Model = map[string]interface{}{
"name": "New Model Name", "title": "Text - Library Panel",
"name": "New Model Name",
} }
existing.Result.Meta.CreatedBy.Name = "user_in_db" existing.Result.Meta.CreatedBy.Name = "user_in_db"
existing.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad" existing.Result.Meta.CreatedBy.AvatarUrl = "/avatar/402d08de060496d6b6874495fe20f5ad"
...@@ -844,7 +893,7 @@ func TestLoadLibraryPanelsForDashboard(t *testing.T) { ...@@ -844,7 +893,7 @@ func TestLoadLibraryPanelsForDashboard(t *testing.T) {
}, },
}, },
}, },
"title": "Text - Library Panel", "title": "Text - Library Panel1",
"type": "text", "type": "text",
}, },
}, },
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment