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

LibraryPanels: Adds folder name to Library Panel card (#33697)

Browse Source 
* LibraryPanels: Adds folder filter

* Refactor: Adds folder filter to library search

* Refactor: splits huge function into smaller functions

* LibraryPanels: Adds Panels Page to Manage Folder tabs (#33618)

* Chore: adds tests to LibraryPanelsSearch

* Refactor: Adds reducer and tests

* Chore: changes GrafanaThemeV2

* Refactor: adds folderName to get all result

* Refactor: adds folderName to get result

* Refactor: adds folder name to LibraryPanelDTOMeta

* Refactor: adds folder name to lbirary panels result

* Chore: reverts public/app/routes/routes.tsx to master

* Minor style tweak

* Refactor: adds folder uid to meta

* Chore: updates after PR comments

Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
This commit is contained in:
Hugo Häggmark
2021-05-05 11:09:12 +02:00
committed by GitHub
co-authored by Torkel Ödegaard
parent a5c13feb61
commit 605bae8e2c
14 changed files with 146 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/librarypanels/database.go
+32 -7
View File
@@ -14,7 +14,7 @@ import (
)
var (
sqlStatmentLibrayPanelDTOWithMeta = `
selectLibrayPanelDTOWithMeta = `
SELECT DISTINCT
lp.name, lp.id, lp.org_id, lp.folder_id, lp.uid, lp.type, lp.description, lp.model, lp.created, lp.created_by, lp.updated, lp.updated_by, lp.version
, 0 AS can_edit
@@ -23,10 +23,13 @@ SELECT DISTINCT
, u2.login AS updated_by_name
, u2.email AS updated_by_email
, (SELECT COUNT(dashboard_id) FROM library_panel_dashboard WHERE librarypanel_id = lp.id) AS connected_dashboards
`
fromLibrayPanelDTOWithMeta = `
FROM library_panel AS lp
LEFT JOIN user AS u1 ON lp.created_by = u1.id
LEFT JOIN user AS u2 ON lp.updated_by = u2.id
`
sqlStatmentLibrayPanelDTOWithMeta = selectLibrayPanelDTOWithMeta + fromLibrayPanelDTOWithMeta
)
func syncFieldsWithModel(libraryPanel *LibraryPanel) error {
@@ -328,10 +331,16 @@ func (lps *LibraryPanelService) getLibraryPanel(c *models.ReqContext, uid string
err := lps.SQLStore.WithDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
libraryPanels := make([]LibraryPanelWithMeta, 0)
builder := sqlstore.SQLBuilder{}
builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
builder.Write(selectLibrayPanelDTOWithMeta)
builder.Write(", 'General' as folder_name ")
builder.Write(", '' as folder_uid ")
builder.Write(fromLibrayPanelDTOWithMeta)
builder.Write(` WHERE lp.uid=? AND lp.org_id=? AND lp.folder_id=0`, uid, c.SignedInUser.OrgId)
builder.Write(" UNION ")
builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
builder.Write(selectLibrayPanelDTOWithMeta)
builder.Write(", dashboard.title as folder_name ")
builder.Write(", dashboard.uid as folder_uid ")
builder.Write(fromLibrayPanelDTOWithMeta)
builder.Write(" INNER JOIN dashboard AS dashboard on lp.folder_id = dashboard.id AND lp.folder_id <> 0")
builder.Write(` WHERE lp.uid=? AND lp.org_id=?`, uid, c.SignedInUser.OrgId)
if c.SignedInUser.OrgRole != models.ROLE_ADMIN {
@@ -365,6 +374,8 @@ func (lps *LibraryPanelService) getLibraryPanel(c *models.ReqContext, uid string
Version: libraryPanel.Version,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: libraryPanel.FolderName,
FolderUID: libraryPanel.FolderUID,
ConnectedDashboards: libraryPanel.ConnectedDashboards,
Created: libraryPanel.Created,
Updated: libraryPanel.Updated,
@@ -405,14 +416,20 @@ func (lps *LibraryPanelService) getAllLibraryPanels(c *models.ReqContext, query
err := lps.SQLStore.WithDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
builder := sqlstore.SQLBuilder{}
if folderFilter.includeGeneralFolder {
builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
builder.Write(selectLibrayPanelDTOWithMeta)
builder.Write(", 'General' as folder_name ")
builder.Write(", '' as folder_uid ")
builder.Write(fromLibrayPanelDTOWithMeta)
builder.Write(` WHERE lp.org_id=? AND lp.folder_id=0`, c.SignedInUser.OrgId)
writeSearchStringSQL(query, lps.SQLStore, &builder)
writeExcludeSQL(query, &builder)
writePanelFilterSQL(panelFilter, &builder)
builder.Write(" UNION ")
}
builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
builder.Write(selectLibrayPanelDTOWithMeta)
builder.Write(", dashboard.title as folder_name ")
builder.Write(", dashboard.uid as folder_uid ")
builder.Write(fromLibrayPanelDTOWithMeta)
builder.Write(" INNER JOIN dashboard AS dashboard on lp.folder_id = dashboard.id AND lp.folder_id<>0")
builder.Write(` WHERE lp.org_id=?`, c.SignedInUser.OrgId)
writeSearchStringSQL(query, lps.SQLStore, &builder)
@@ -448,6 +465,8 @@ func (lps *LibraryPanelService) getAllLibraryPanels(c *models.ReqContext, query
Version: panel.Version,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: panel.FolderName,
FolderUID: panel.FolderUID,
ConnectedDashboards: panel.ConnectedDashboards,
Created: panel.Created,
Updated: panel.Updated,
@@ -526,8 +545,12 @@ func (lps *LibraryPanelService) getLibraryPanelsForDashboardID(c *models.ReqCont
libraryPanelMap := make(map[string]LibraryPanelDTO)
err := lps.SQLStore.WithDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
var libraryPanels []LibraryPanelWithMeta
sql := sqlStatmentLibrayPanelDTOWithMeta + "INNER JOIN library_panel_dashboard AS lpd ON lpd.librarypanel_id = lp.id AND lpd.dashboard_id=?"
sess := session.SQL(sql, dashboardID)
sql := selectLibrayPanelDTOWithMeta + ", coalesce(dashboard.title, 'General') AS folder_name, coalesce(dashboard.uid, '') AS folder_uid " + fromLibrayPanelDTOWithMeta + `
LEFT JOIN dashboard AS dashboard ON dashboard.id = lp.folder_id AND dashboard.id=?
INNER JOIN library_panel_dashboard AS lpd ON lpd.librarypanel_id = lp.id AND lpd.dashboard_id=?
`
sess := session.SQL(sql, dashboardID, dashboardID)
err := sess.Find(&libraryPanels)
if err != nil {
return err
@@ -546,6 +569,8 @@ func (lps *LibraryPanelService) getLibraryPanelsForDashboardID(c *models.ReqCont
Version: panel.Version,
Meta: LibraryPanelDTOMeta{
CanEdit: panel.CanEdit,
FolderName: panel.FolderName,
FolderUID: panel.FolderUID,
ConnectedDashboards: panel.ConnectedDashboards,
Created: panel.Created,
Updated: panel.Updated,
pkg/services/librarypanels/librarypanels.go
+2
View File
@@ -109,6 +109,8 @@ func (lps *LibraryPanelService) LoadLibraryPanelsForDashboard(c *models.ReqConte
"version": libraryPanelInDB.Version,
"meta": map[string]interface{}{
"canEdit": libraryPanelInDB.Meta.CanEdit,
"folderName": libraryPanelInDB.Meta.FolderName,
"folderUid": libraryPanelInDB.Meta.FolderUID,
"connectedDashboards": libraryPanelInDB.Meta.ConnectedDashboards,
"created": libraryPanelInDB.Meta.Created,
"updated": libraryPanelInDB.Meta.Updated,
pkg/services/librarypanels/librarypanels_get_all_test.go
+32
View File
@@ -71,6 +71,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -104,6 +106,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[1].Meta.Created,
Updated: result.Result.LibraryPanels[1].Meta.Updated,
@@ -166,6 +170,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -199,6 +205,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[1].Meta.Created,
Updated: result.Result.LibraryPanels[1].Meta.Updated,
@@ -281,6 +289,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -314,6 +324,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[1].Meta.Created,
Updated: result.Result.LibraryPanels[1].Meta.Updated,
@@ -414,6 +426,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "NewFolder",
FolderUID: newFolder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -507,6 +521,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -540,6 +556,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[1].Meta.Created,
Updated: result.Result.LibraryPanels[1].Meta.Updated,
@@ -602,6 +620,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -664,6 +684,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -727,6 +749,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -799,6 +823,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -869,6 +895,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
@@ -902,6 +930,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[1].Meta.Created,
Updated: result.Result.LibraryPanels[1].Meta.Updated,
@@ -966,6 +996,8 @@ func TestGetAllLibraryPanels(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.LibraryPanels[0].Meta.Created,
Updated: result.Result.LibraryPanels[0].Meta.Updated,
pkg/services/librarypanels/librarypanels_get_test.go
+2
View File
@@ -41,6 +41,8 @@ func TestGetLibraryPanel(t *testing.T) {
Version: 1,
Meta: LibraryPanelDTOMeta{
CanEdit: true,
FolderName: "ScenarioFolder",
FolderUID: sc.folder.Uid,
ConnectedDashboards: 0,
Created: result.Result.Meta.Created,
Updated: result.Result.Meta.Updated,
pkg/services/librarypanels/librarypanels_permissions_test.go
+7
View File
@@ -337,6 +337,8 @@ func TestLibraryPanelPermissions(t *testing.T) {
result.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.UpdatedBy.Name = UserInDbName
result.Result.Meta.UpdatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.FolderName = folder.Title
result.Result.Meta.FolderUID = folder.Uid
results = append(results, result.Result)
}
sc.reqContext.SignedInUser.OrgRole = testCase.role
@@ -382,6 +384,7 @@ func TestLibraryPanelPermissions(t *testing.T) {
result.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.UpdatedBy.Name = UserInDbName
result.Result.Meta.UpdatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.FolderName = "General"
sc.reqContext.SignedInUser.OrgRole = testCase.role
resp = sc.service.getAllHandler(sc.reqContext)
@@ -442,6 +445,8 @@ func TestLibraryPanelPermissions(t *testing.T) {
result.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.UpdatedBy.Name = UserInDbName
result.Result.Meta.UpdatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.FolderName = folder.Title
result.Result.Meta.FolderUID = folder.Uid
results = append(results, result.Result)
}
sc.reqContext.SignedInUser.OrgRole = testCase.role
@@ -462,6 +467,8 @@ func TestLibraryPanelPermissions(t *testing.T) {
result.Result.Meta.CreatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.UpdatedBy.Name = UserInDbName
result.Result.Meta.UpdatedBy.AvatarUrl = UserInDbAvatar
result.Result.Meta.FolderName = "General"
result.Result.Meta.FolderUID = ""
sc.reqContext.SignedInUser.OrgRole = testCase.role
sc.reqContext.ReplaceAllParams(map[string]string{":uid": result.Result.UID})
pkg/services/librarypanels/librarypanels_test.go
+2
View File
@@ -94,6 +94,8 @@ func TestLoadLibraryPanelsForDashboard(t *testing.T) {
"version": sc.initialResult.Result.Version,
"meta": map[string]interface{}{
"canEdit": false,
"folderName": "ScenarioFolder",
"folderUid": sc.folder.Uid,
"connectedDashboards": int64(1),
"created": sc.initialResult.Result.Meta.Created,
"updated": sc.initialResult.Result.Meta.Updated,
pkg/services/librarypanels/models.go
+6 -2
View File
@@ -41,6 +41,8 @@ type LibraryPanelWithMeta struct {
Updated time.Time
CanEdit bool
FolderName string
FolderUID string `xorm:"folder_uid"`
ConnectedDashboards int64
CreatedBy int64
UpdatedBy int64
@@ -74,8 +76,10 @@ type LibraryPanelSearchResult struct {
// LibraryPanelDTOMeta is the meta information for LibraryPanelDTO.
type LibraryPanelDTOMeta struct {
CanEdit bool `json:"canEdit"`
ConnectedDashboards int64 `json:"connectedDashboards"`
CanEdit bool `json:"canEdit"`
FolderName string `json:"folderName"`
FolderUID string `json:"folderUid"`
ConnectedDashboards int64 `json:"connectedDashboards"`
Created time.Time `json:"created"`
Updated time.Time `json:"updated"`