LibraryPanels: Improves the Get All experience (#32028)

* LibraryPanels: Improves Get All Api

* Refactor: using useReducer instead of useState

* Refactor: adds Pagination to UI

* Tests: adds reducer tests

* Refactor: using Observable instead to avoid flickering

* Refactor: moves exclusion to backend instead

* Chore: changing back the perPage default value

pkg/services/librarypanels/api.go

@@ -81,7 +81,7 @@ func (lps *LibraryPanelService) getHandler(c *models.ReqContext) response.Respon
 
 // getAllHandler handles GET /api/library-panels/.
 func (lps *LibraryPanelService) getAllHandler(c *models.ReqContext) response.Response {
-	libraryPanels, err := lps.getAllLibraryPanels(c, c.QueryInt64("limit"))
+	libraryPanels, err := lps.getAllLibraryPanels(c, c.QueryInt("perPage"), c.QueryInt("page"), c.Query("name"), c.Query("excludeUid"))
 	if err != nil {
 		return toLibraryPanelError(err, "Failed to get library panels")
 	}

pkg/services/librarypanels/database.go

@@ -3,6 +3,7 @@ package librarypanels
 import (
 	"encoding/json"
 	"fmt"
+	"strings"
 	"time"
 
 	"github.com/grafana/grafana/pkg/api/dtos"
@@ -365,60 +366,101 @@ func (lps *LibraryPanelService) getLibraryPanel(c *models.ReqContext, uid string
 }
 
 // getAllLibraryPanels gets all library panels.
-func (lps *LibraryPanelService) getAllLibraryPanels(c *models.ReqContext, limit int64) ([]LibraryPanelDTO, error) {
+func (lps *LibraryPanelService) getAllLibraryPanels(c *models.ReqContext, perPage int, page int, name string, excludeUID string) (LibraryPanelSearchResult, error) {
 	libraryPanels := make([]LibraryPanelWithMeta, 0)
+	result := LibraryPanelSearchResult{}
+	if perPage <= 0 {
+		perPage = 100
+	}
+	if page <= 0 {
+		page = 1
+	}
+
 	err := lps.SQLStore.WithDbSession(c.Context.Req.Context(), func(session *sqlstore.DBSession) error {
 		builder := sqlstore.SQLBuilder{}
 		builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
 		builder.Write(` WHERE lp.org_id=? AND lp.folder_id=0`, c.SignedInUser.OrgId)
+		if len(strings.TrimSpace(name)) > 0 {
+			builder.Write(" AND lp.name "+lps.SQLStore.Dialect.LikeStr()+" ?", "%"+name+"%")
+		}
+		if len(strings.TrimSpace(excludeUID)) > 0 {
+			builder.Write(" AND lp.uid <> ?", excludeUID)
+		}
 		builder.Write(" UNION ")
 		builder.Write(sqlStatmentLibrayPanelDTOWithMeta)
 		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)
+		if len(strings.TrimSpace(name)) > 0 {
+			builder.Write(" AND lp.name "+lps.SQLStore.Dialect.LikeStr()+" ?", "%"+name+"%")
+		}
+		if len(strings.TrimSpace(excludeUID)) > 0 {
+			builder.Write(" AND lp.uid <> ?", excludeUID)
+		}
 		if c.SignedInUser.OrgRole != models.ROLE_ADMIN {
 			builder.WriteDashboardPermissionFilter(c.SignedInUser, models.PERMISSION_VIEW)
 		}
-		if limit == 0 {
-			limit = 1000
+		if perPage != 0 {
+			offset := perPage * (page - 1)
+			builder.Write(lps.SQLStore.Dialect.LimitOffset(int64(perPage), int64(offset)))
 		}
-		builder.Write(lps.SQLStore.Dialect.Limit(limit))
 		if err := session.SQL(builder.GetSQLString(), builder.GetParams()...).Find(&libraryPanels); err != nil {
 			return err
 		}
 
+		retDTOs := make([]LibraryPanelDTO, 0)
+		for _, panel := range libraryPanels {
+			retDTOs = append(retDTOs, LibraryPanelDTO{
+				ID:       panel.ID,
+				OrgID:    panel.OrgID,
+				FolderID: panel.FolderID,
+				UID:      panel.UID,
+				Name:     panel.Name,
+				Model:    panel.Model,
+				Version:  panel.Version,
+				Meta: LibraryPanelDTOMeta{
+					CanEdit:             true,
+					ConnectedDashboards: panel.ConnectedDashboards,
+					Created:             panel.Created,
+					Updated:             panel.Updated,
+					CreatedBy: LibraryPanelDTOMetaUser{
+						ID:        panel.CreatedBy,
+						Name:      panel.CreatedByName,
+						AvatarUrl: dtos.GetGravatarUrl(panel.CreatedByEmail),
+					},
+					UpdatedBy: LibraryPanelDTOMetaUser{
+						ID:        panel.UpdatedBy,
+						Name:      panel.UpdatedByName,
+						AvatarUrl: dtos.GetGravatarUrl(panel.UpdatedByEmail),
+					},
+				},
+			})
+		}
+
+		var panels []LibraryPanel
+		countBuilder := sqlstore.SQLBuilder{}
+		countBuilder.Write("SELECT * FROM library_panel")
+		countBuilder.Write(` WHERE org_id=?`, c.SignedInUser.OrgId)
+		if len(strings.TrimSpace(name)) > 0 {
+			countBuilder.Write(" AND name "+lps.SQLStore.Dialect.LikeStr()+" ?", "%"+name+"%")
+		}
+		if len(strings.TrimSpace(excludeUID)) > 0 {
+			countBuilder.Write(" AND uid <> ?", excludeUID)
+		}
+		if err := session.SQL(countBuilder.GetSQLString(), countBuilder.GetParams()...).Find(&panels); err != nil {
+			return err
+		}
+
+		result = LibraryPanelSearchResult{
+			TotalCount:    int64(len(panels)),
+			LibraryPanels: retDTOs,
+			Page:          page,
+			PerPage:       perPage,
+		}
+
 		return nil
 	})
 
-	retDTOs := make([]LibraryPanelDTO, 0)
-	for _, panel := range libraryPanels {
-		retDTOs = append(retDTOs, LibraryPanelDTO{
-			ID:       panel.ID,
-			OrgID:    panel.OrgID,
-			FolderID: panel.FolderID,
-			UID:      panel.UID,
-			Name:     panel.Name,
-			Model:    panel.Model,
-			Version:  panel.Version,
-			Meta: LibraryPanelDTOMeta{
-				CanEdit:             true,
-				ConnectedDashboards: panel.ConnectedDashboards,
-				Created:             panel.Created,
-				Updated:             panel.Updated,
-				CreatedBy: LibraryPanelDTOMetaUser{
-					ID:        panel.CreatedBy,
-					Name:      panel.CreatedByName,
-					AvatarUrl: dtos.GetGravatarUrl(panel.CreatedByEmail),
-				},
-				UpdatedBy: LibraryPanelDTOMetaUser{
-					ID:        panel.UpdatedBy,
-					Name:      panel.UpdatedByName,
-					AvatarUrl: dtos.GetGravatarUrl(panel.UpdatedByEmail),
-				},
-			},
-		})
-	}
-
-	return retDTOs, err
+	return result, err
 }
 
 // getConnectedDashboards gets all dashboards connected to a Library Panel.

pkg/services/librarypanels/librarypanels_get_all_test.go

@@ -16,11 +16,20 @@ func TestGetAllLibraryPanels(t *testing.T) {
 			resp := sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
 
-			var result libraryPanelsResult
+			var result libraryPanelsSearch
 			err := json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
-			require.NotNil(t, result.Result)
-			require.Equal(t, 0, len(result.Result))
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount:    0,
+					LibraryPanels: []libraryPanel{},
+					Page:          1,
+					PerPage:       100,
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
 		})
 
 	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist, it should succeed",
@@ -32,68 +41,132 @@ func TestGetAllLibraryPanels(t *testing.T) {
 			resp = sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
 
-			var result libraryPanelsResult
+			var result libraryPanelsSearch
 			err := json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
-			var expected = libraryPanelsResult{
-				Result: []libraryPanel{
-					{
-						ID:       1,
-						OrgID:    1,
-						FolderID: 1,
-						UID:      result.Result[0].UID,
-						Name:     "Text - Library Panel",
-						Model: map[string]interface{}{
-							"datasource": "${DS_GDEV-TESTDATA}",
-							"id":         float64(1),
-							"title":      "Text - Library Panel",
-							"type":       "text",
-						},
-						Version: 1,
-						Meta: LibraryPanelDTOMeta{
-							CanEdit:             true,
-							ConnectedDashboards: 0,
-							Created:             result.Result[0].Meta.Created,
-							Updated:             result.Result[0].Meta.Updated,
-							CreatedBy: LibraryPanelDTOMetaUser{
-								ID:        1,
-								Name:      UserInDbName,
-								AvatarUrl: UserInDbAvatar,
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount: 2,
+					Page:       1,
+					PerPage:    100,
+					LibraryPanels: []libraryPanel{
+						{
+							ID:       1,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[0].UID,
+							Name:     "Text - Library Panel",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel",
+								"type":       "text",
 							},
-							UpdatedBy: LibraryPanelDTOMetaUser{
-								ID:        1,
-								Name:      UserInDbName,
-								AvatarUrl: UserInDbAvatar,
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[0].Meta.Created,
+								Updated:             result.Result.LibraryPanels[0].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+							},
+						},
+						{
+							ID:       2,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[1].UID,
+							Name:     "Text - Library Panel2",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel2",
+								"type":       "text",
+							},
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[1].Meta.Created,
+								Updated:             result.Result.LibraryPanels[1].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
 							},
 						},
 					},
-					{
-						ID:       2,
-						OrgID:    1,
-						FolderID: 1,
-						UID:      result.Result[1].UID,
-						Name:     "Text - Library Panel2",
-						Model: map[string]interface{}{
-							"datasource": "${DS_GDEV-TESTDATA}",
-							"id":         float64(1),
-							"title":      "Text - Library Panel2",
-							"type":       "text",
-						},
-						Version: 1,
-						Meta: LibraryPanelDTOMeta{
-							CanEdit:             true,
-							ConnectedDashboards: 0,
-							Created:             result.Result[1].Meta.Created,
-							Updated:             result.Result[1].Meta.Updated,
-							CreatedBy: LibraryPanelDTOMetaUser{
-								ID:        1,
-								Name:      UserInDbName,
-								AvatarUrl: UserInDbAvatar,
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and excludeUID is set, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("excludeUid", sc.initialResult.Result.UID)
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount: 1,
+					Page:       1,
+					PerPage:    100,
+					LibraryPanels: []libraryPanel{
+						{
+							ID:       2,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[0].UID,
+							Name:     "Text - Library Panel2",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel2",
+								"type":       "text",
 							},
-							UpdatedBy: LibraryPanelDTOMetaUser{
-								ID:        1,
-								Name:      UserInDbName,
-								AvatarUrl: UserInDbAvatar,
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[0].Meta.Created,
+								Updated:             result.Result.LibraryPanels[0].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
 							},
 						},
 					},
@@ -104,6 +177,246 @@ func TestGetAllLibraryPanels(t *testing.T) {
 			}
 		})
 
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("perPage", "1")
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount: 2,
+					Page:       1,
+					PerPage:    1,
+					LibraryPanels: []libraryPanel{
+						{
+							ID:       1,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[0].UID,
+							Name:     "Text - Library Panel",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel",
+								"type":       "text",
+							},
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[0].Meta.Created,
+								Updated:             result.Result.LibraryPanels[0].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+							},
+						},
+					},
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 2, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("perPage", "1")
+			sc.reqContext.Req.Form.Add("page", "2")
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount: 2,
+					Page:       2,
+					PerPage:    1,
+					LibraryPanels: []libraryPanel{
+						{
+							ID:       2,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[0].UID,
+							Name:     "Text - Library Panel2",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel2",
+								"type":       "text",
+							},
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[0].Meta.Created,
+								Updated:             result.Result.LibraryPanels[0].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+							},
+						},
+					},
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 1 and name is panel2, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("perPage", "1")
+			sc.reqContext.Req.Form.Add("page", "1")
+			sc.reqContext.Req.Form.Add("name", "panel2")
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount: 1,
+					Page:       1,
+					PerPage:    1,
+					LibraryPanels: []libraryPanel{
+						{
+							ID:       2,
+							OrgID:    1,
+							FolderID: 1,
+							UID:      result.Result.LibraryPanels[0].UID,
+							Name:     "Text - Library Panel2",
+							Model: map[string]interface{}{
+								"datasource": "${DS_GDEV-TESTDATA}",
+								"id":         float64(1),
+								"title":      "Text - Library Panel2",
+								"type":       "text",
+							},
+							Version: 1,
+							Meta: LibraryPanelDTOMeta{
+								CanEdit:             true,
+								ConnectedDashboards: 0,
+								Created:             result.Result.LibraryPanels[0].Meta.Created,
+								Updated:             result.Result.LibraryPanels[0].Meta.Updated,
+								CreatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+								UpdatedBy: LibraryPanelDTOMetaUser{
+									ID:        1,
+									Name:      UserInDbName,
+									AvatarUrl: UserInDbAvatar,
+								},
+							},
+						},
+					},
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 3 and name is panel, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("perPage", "1")
+			sc.reqContext.Req.Form.Add("page", "3")
+			sc.reqContext.Req.Form.Add("name", "panel")
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount:    2,
+					Page:          3,
+					PerPage:       1,
+					LibraryPanels: []libraryPanel{},
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
+	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist and perPage is 1 and page is 3 and name does not exist, it should succeed and the result should be correct",
+		func(t *testing.T, sc scenarioContext) {
+			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
+			resp := sc.service.createHandler(sc.reqContext, command)
+			require.Equal(t, 200, resp.Status())
+
+			err := sc.reqContext.Req.ParseForm()
+			require.NoError(t, err)
+			sc.reqContext.Req.Form.Add("perPage", "1")
+			sc.reqContext.Req.Form.Add("page", "3")
+			sc.reqContext.Req.Form.Add("name", "monkey")
+			resp = sc.service.getAllHandler(sc.reqContext)
+			require.Equal(t, 200, resp.Status())
+
+			var result libraryPanelsSearch
+			err = json.Unmarshal(resp.Body(), &result)
+			require.NoError(t, err)
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount:    0,
+					Page:          3,
+					PerPage:       1,
+					LibraryPanels: []libraryPanel{},
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
+		})
+
 	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels and two exist but only one is connected, it should succeed and return correct connected dashboards",
 		func(t *testing.T, sc scenarioContext) {
 			command := getCreateCommand(sc.folder.Id, "Text - Library Panel2")
@@ -121,11 +434,11 @@ func TestGetAllLibraryPanels(t *testing.T) {
 			resp = sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
 
-			var results libraryPanelsResult
+			var results libraryPanelsSearch
 			err := json.Unmarshal(resp.Body(), &results)
 			require.NoError(t, err)
-			require.Equal(t, int64(0), results.Result[0].Meta.ConnectedDashboards)
-			require.Equal(t, int64(2), results.Result[1].Meta.ConnectedDashboards)
+			require.Equal(t, int64(0), results.Result.LibraryPanels[0].Meta.ConnectedDashboards)
+			require.Equal(t, int64(2), results.Result.LibraryPanels[1].Meta.ConnectedDashboards)
 		})
 
 	scenarioWithLibraryPanel(t, "When an admin tries to get all library panels in a different org, none should be returned",
@@ -133,22 +446,31 @@ func TestGetAllLibraryPanels(t *testing.T) {
 			resp := sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
 
-			var result libraryPanelsResult
+			var result libraryPanelsSearch
 			err := json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
-			require.Equal(t, 1, len(result.Result))
-			require.Equal(t, int64(1), result.Result[0].FolderID)
-			require.Equal(t, "Text - Library Panel", result.Result[0].Name)
+			require.Equal(t, 1, len(result.Result.LibraryPanels))
+			require.Equal(t, int64(1), result.Result.LibraryPanels[0].FolderID)
+			require.Equal(t, "Text - Library Panel", result.Result.LibraryPanels[0].Name)
 
 			sc.reqContext.SignedInUser.OrgId = 2
 			sc.reqContext.SignedInUser.OrgRole = models.ROLE_ADMIN
 			resp = sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
 
-			result = libraryPanelsResult{}
+			result = libraryPanelsSearch{}
 			err = json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
-			require.NotNil(t, result.Result)
-			require.Equal(t, 0, len(result.Result))
+			var expected = libraryPanelsSearch{
+				Result: libraryPanelsSearchResult{
+					TotalCount:    0,
+					LibraryPanels: []libraryPanel{},
+					Page:          1,
+					PerPage:       100,
+				},
+			}
+			if diff := cmp.Diff(expected, result, getCompareOptions()...); diff != "" {
+				t.Fatalf("Result mismatch (-want +got):\n%s", diff)
+			}
 		})
 }

pkg/services/librarypanels/librarypanels_permissions_test.go

@@ -343,10 +343,10 @@ func TestLibraryPanelPermissions(t *testing.T) {
 
 				resp := sc.service.getAllHandler(sc.reqContext)
 				require.Equal(t, 200, resp.Status())
-				var actual libraryPanelsResult
+				var actual libraryPanelsSearch
 				err := json.Unmarshal(resp.Body(), &actual)
 				require.NoError(t, err)
-				require.Equal(t, testCase.panels, len(actual.Result))
+				require.Equal(t, testCase.panels, len(actual.Result.LibraryPanels))
 				for _, folderIndex := range testCase.folderIndexes {
 					var folderID = int64(folderIndex + 2) // testScenario creates one folder and general folder doesn't count
 					var foundResult libraryPanel
@@ -359,7 +359,7 @@ func TestLibraryPanelPermissions(t *testing.T) {
 					}
 					require.NotEmpty(t, foundResult)
 
-					for _, result := range actual.Result {
+					for _, result := range actual.Result.LibraryPanels {
 						if result.FolderID == folderID {
 							actualResult = result
 							break
@@ -386,11 +386,11 @@ func TestLibraryPanelPermissions(t *testing.T) {
 
 				resp = sc.service.getAllHandler(sc.reqContext)
 				require.Equal(t, 200, resp.Status())
-				var actual libraryPanelsResult
+				var actual libraryPanelsSearch
 				err := json.Unmarshal(resp.Body(), &actual)
 				require.NoError(t, err)
-				require.Equal(t, 1, len(actual.Result))
-				if diff := cmp.Diff(result.Result, actual.Result[0], getCompareOptions()...); diff != "" {
+				require.Equal(t, 1, len(actual.Result.LibraryPanels))
+				if diff := cmp.Diff(result.Result, actual.Result.LibraryPanels[0], getCompareOptions()...); diff != "" {
 					t.Fatalf("Result mismatch (-want +got):\n%s", diff)
 				}
 			})

pkg/services/librarypanels/librarypanels_test.go

@@ -646,11 +646,11 @@ func TestDeleteLibraryPanelsInFolder(t *testing.T) {
 		func(t *testing.T, sc scenarioContext) {
 			resp := sc.service.getAllHandler(sc.reqContext)
 			require.Equal(t, 200, resp.Status())
-			var result libraryPanelsResult
+			var result libraryPanelsSearch
 			err := json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
 			require.NotNil(t, result.Result)
-			require.Equal(t, 1, len(result.Result))
+			require.Equal(t, 1, len(result.Result.LibraryPanels))
 
 			err = sc.service.DeleteLibraryPanelsInFolder(sc.reqContext, sc.folder.Uid)
 			require.NoError(t, err)
@@ -659,7 +659,7 @@ func TestDeleteLibraryPanelsInFolder(t *testing.T) {
 			err = json.Unmarshal(resp.Body(), &result)
 			require.NoError(t, err)
 			require.NotNil(t, result.Result)
-			require.Equal(t, 0, len(result.Result))
+			require.Equal(t, 0, len(result.Result.LibraryPanels))
 		})
 }
 
@@ -678,8 +678,15 @@ type libraryPanelResult struct {
 	Result libraryPanel `json:"result"`
 }
 
-type libraryPanelsResult struct {
-	Result []libraryPanel `json:"result"`
+type libraryPanelsSearch struct {
+	Result libraryPanelsSearchResult `json:"result"`
+}
+
+type libraryPanelsSearchResult struct {
+	TotalCount    int64          `json:"totalCount"`
+	LibraryPanels []libraryPanel `json:"libraryPanels"`
+	Page          int            `json:"page"`
+	PerPage       int            `json:"perPage"`
 }
 
 type libraryPanelDashboardsResult struct {

pkg/services/librarypanels/models.go

@@ -58,6 +58,14 @@ type LibraryPanelDTO struct {
 	Meta     LibraryPanelDTOMeta `json:"meta"`
 }
 
+// LibraryPanelSearchResult is the search result for library panels.
+type LibraryPanelSearchResult struct {
+	TotalCount    int64             `json:"totalCount"`
+	LibraryPanels []LibraryPanelDTO `json:"libraryPanels"`
+	Page          int               `json:"page"`
+	PerPage       int               `json:"perPage"`
+}
+
 // LibraryPanelDTOMeta is the meta information for LibraryPanelDTO.
 type LibraryPanelDTOMeta struct {
 	CanEdit             bool  `json:"canEdit"`