Dashboards/SQL: Improve SQL query behavior (grafana#99253)

* update legacy dashboard SQL

* merge main

* trim message

pkg/apis/dashboard/register.go

@@ -4,20 +4,25 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/grafana/grafana/pkg/apimachinery/utils"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apimachinery/pkg/runtime/schema"
+
+	"github.com/grafana/grafana/pkg/apimachinery/utils"
 )
 
 const (
 	GROUP      = "dashboard.grafana.app"
 	VERSION    = runtime.APIVersionInternal
 	APIVERSION = GROUP + "/" + VERSION
+
+	// Resource constants
+	DASHBOARD_RESOURCE     = "dashboards"
+	LIBRARY_PANEL_RESOURCE = "librarypanels"
 )
 
 var DashboardResourceInfo = utils.NewResourceInfo(GROUP, VERSION,
-	"dashboards", "dashboard", "Dashboard",
+	DASHBOARD_RESOURCE, "dashboard", "Dashboard",
 	func() runtime.Object { return &Dashboard{} },
 	func() runtime.Object { return &DashboardList{} },
 	utils.TableColumns{
@@ -43,7 +48,7 @@ var DashboardResourceInfo = utils.NewResourceInfo(GROUP, VERSION,
 )
 
 var LibraryPanelResourceInfo = utils.NewResourceInfo(GROUP, VERSION,
-	"librarypanels", "librarypanel", "LibraryPanel",
+	LIBRARY_PANEL_RESOURCE, "librarypanel", "LibraryPanel",
 	func() runtime.Object { return &LibraryPanel{} },
 	func() runtime.Object { return &LibraryPanelList{} },
 	utils.TableColumns{

pkg/registry/apis/dashboard/legacy/queries_test.go

@@ -69,6 +69,13 @@ func TestDashboardQueries(t *testing.T) {
 						LastID: 22,
 					}),
 				},
+				{
+					Name: "folders",
+					Data: getQuery(&DashboardQuery{
+						OrgID:      2,
+						GetFolders: true,
+					}),
+				},
 			},
 			sqlQueryPanels: {
 				{

pkg/registry/apis/dashboard/legacy/query_dashboards.sql

@@ -1,48 +1,51 @@
 SELECT
-    dashboard.org_id, dashboard.id,
-    dashboard.uid, dashboard.folder_uid,
-    dashboard.deleted, plugin_id,
-    provisioning.name         as origin_name,
-    provisioning.external_id  as origin_path,
-    provisioning.check_sum    as origin_key,
-    provisioning.updated      as origin_ts,
-    dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
-    {{ if .Query.UseHistoryTable }}
-    dashboard_version.created, updated_user.uid as updated_by,updated_user.id as created_by_id,
-    dashboard_version.version, dashboard_version.message, dashboard_version.data
-    {{ else }}
-    dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
-    dashboard.version, '' as message, dashboard.data
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  {{ if .Query.UseHistoryTable }}
+  dashboard_version.created, updated_user.uid as updated_by,updated_user.id as created_by_id,
+  dashboard_version.version, dashboard_version.message, dashboard_version.data
+  {{ else }}
+  dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
+  dashboard.version, '' as message, dashboard.data
+  {{ end }}
+FROM {{ .Ident .DashboardTable }} as dashboard
+{{ if .Query.UseHistoryTable }}
+LEFT OUTER JOIN {{ .Ident .VersionTable }} as dashboard_version ON dashboard.id = dashboard_version.dashboard_id
+{{ end }}
+LEFT OUTER JOIN {{ .Ident .ProvisioningTable }} as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN {{ .Ident .UserTable }} as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN {{ .Ident .UserTable }} as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = {{ .Arg .Query.GetFolders }}
+  AND dashboard.org_id = {{ .Arg .Query.OrgID }}
+  {{ if .Query.UseHistoryTable }}
+  {{ if .Query.UID }}
+  AND dashboard.uid = {{ .Arg .Query.UID }}
+  {{ end }}
+  {{ if .Query.Version }}
+  AND dashboard_version.version = {{ .Arg .Query.Version }}
+  {{ else if .Query.LastID }}
+  AND dashboard_version.version < {{ .Arg .Query.LastID }}
+  {{ end }}
+  ORDER BY 
+    dashboard_version.created ASC,
+    dashboard_version.version ASC,
+    dashboard.uid ASC
+  {{ else }}
+    {{ if .Query.UID }}
+    AND dashboard.uid = {{ .Arg .Query.UID }}
+    {{ else if .Query.LastID }}
+    AND dashboard.id > {{ .Arg .Query.LastID }}
     {{ end }}
-    FROM {{ .Ident .DashboardTable }} as dashboard
-    {{ if .Query.UseHistoryTable }}
-    LEFT OUTER JOIN {{ .Ident .VersionTable }} as dashboard_version ON dashboard.id = dashboard_version.dashboard_id
-    {{ end }}
-    LEFT OUTER JOIN {{ .Ident .ProvisioningTable }} as provisioning ON dashboard.id = provisioning.dashboard_id
-    LEFT OUTER JOIN {{ .Ident .UserTable }} as created_user ON dashboard.created_by = created_user.id
-    LEFT OUTER JOIN {{ .Ident .UserTable }} as updated_user ON dashboard.updated_by = updated_user.id
-    WHERE dashboard.is_folder = false
-      AND dashboard.org_id = {{ .Arg .Query.OrgID }}
-    {{ if .Query.UseHistoryTable }}
-      {{ if .Query.UID }}
-      AND dashboard.uid = {{ .Arg .Query.UID }}
-      {{ end }}
-      {{ if .Query.Version }}
-      AND dashboard_version.version = {{ .Arg .Query.Version }}
-      {{ else if .Query.LastID }}
-      AND dashboard_version.version < {{ .Arg .Query.LastID }}
-      {{ end }}
-    ORDER BY dashboard_version.version DESC
-    {{ else }}
-      {{ if .Query.UID }}
-      AND dashboard.uid = {{ .Arg .Query.UID }}
-      {{ else if .Query.LastID }}
-      AND dashboard.id > {{ .Arg .Query.LastID }}
-      {{ end }}
-      {{ if .Query.GetTrash }}
-      AND dashboard.deleted IS NOT NULL
-      {{ else if .Query.LastID }}
-      AND dashboard.deleted IS NULL
-      {{ end }}
-    ORDER BY dashboard.id DESC
+    {{ if .Query.GetTrash }}
+    AND dashboard.deleted IS NOT NULL
+    {{ else if .Query.LastID }}
+    AND dashboard.deleted IS NULL
     {{ end }}
+  ORDER BY dashboard.id DESC
+  {{ end }}

pkg/registry/apis/dashboard/legacy/sql_dashboards.go

@@ -273,6 +273,9 @@ func (a *dashboardSqlAccess) scanRow(rows *sql.Rows) (*dashboardRow, error) {
 		}
 
 		if message.String != "" {
+			if len(message.String) > 500 {
+				message.String = message.String[0:490] + "..."
+			}
 			meta.SetMessage(message.String)
 		}
 		if folder_uid.String != "" {
@@ -488,6 +491,10 @@ func (a *dashboardSqlAccess) GetLibraryPanels(ctx context.Context, query Library
 		lastID = p.ID
 
 		item := dashboard.LibraryPanel{
+			TypeMeta: metav1.TypeMeta{
+				APIVersion: fmt.Sprintf("%s/%s", dashboard.GROUP, "v0alpha1"),
+				Kind:       "LibraryPanel",
+			},
 			ObjectMeta: metav1.ObjectMeta{
 				Name:              p.UID,
 				CreationTimestamp: metav1.NewTime(p.Created),
@@ -509,13 +516,13 @@ func (a *dashboardSqlAccess) GetLibraryPanels(ctx context.Context, query Library
 		}
 
 		if item.Spec.Title != p.Name {
-			status.Warnings = append(item.Status.Warnings, fmt.Sprintf("title mismatch (expected: %s)", p.Name))
+			status.Warnings = append(status.Warnings, fmt.Sprintf("title mismatch (expected: %s)", p.Name))
 		}
 		if item.Spec.Description != p.Description {
-			status.Warnings = append(item.Status.Warnings, fmt.Sprintf("description mismatch (expected: %s)", p.Description))
+			status.Warnings = append(status.Warnings, fmt.Sprintf("description mismatch (expected: %s)", p.Description))
 		}
 		if item.Spec.Type != p.Type {
-			status.Warnings = append(item.Status.Warnings, fmt.Sprintf("type mismatch (expected: %s)", p.Type))
+			status.Warnings = append(status.Warnings, fmt.Sprintf("type mismatch (expected: %s)", p.Type))
 		}
 		item.Status = status
 
@@ -530,9 +537,15 @@ func (a *dashboardSqlAccess) GetLibraryPanels(ctx context.Context, query Library
 		}
 		meta.SetFolder(p.FolderUID)
 		meta.SetCreatedBy(p.CreatedBy)
-		meta.SetUpdatedBy(p.UpdatedBy)
-		meta.SetUpdatedTimestamp(&p.Updated)
-		meta.SetDeprecatedInternalID(p.ID) // nolint:staticcheck
+		meta.SetGeneration(1)
+		meta.SetDeprecatedInternalID(p.ID) //nolint:staticcheck
+
+		// Only set updated metadata if it is different
+		if p.UpdatedBy != p.CreatedBy || p.Updated.Sub(p.Created) > time.Second {
+			meta.SetUpdatedBy(p.UpdatedBy)
+			meta.SetUpdatedTimestamp(&p.Updated)
+			meta.SetGeneration(2)
+		}
 
 		res.Items = append(res.Items, item)
 		if len(res.Items) > limit {

pkg/registry/apis/dashboard/legacy/testdata/mysql--query_dashboards-dashboard.sql

@@ -1,18 +1,18 @@
 SELECT
-    dashboard.org_id, dashboard.id,
-    dashboard.uid, dashboard.folder_uid,
-    dashboard.deleted, plugin_id,
-    provisioning.name         as origin_name,
-    provisioning.external_id  as origin_path,
-    provisioning.check_sum    as origin_key,
-    provisioning.updated      as origin_ts,
-    dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
-    dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
-    dashboard.version, '' as message, dashboard.data
-    FROM `grafana`.`dashboard` as dashboard
-    LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
-    LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
-    LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
-    WHERE dashboard.is_folder = false
-      AND dashboard.org_id = 2
-    ORDER BY dashboard.id DESC
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
+  dashboard.version, '' as message, dashboard.data
+FROM `grafana`.`dashboard` as dashboard
+LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = FALSE
+  AND dashboard.org_id = 2
+  ORDER BY dashboard.id DESC

pkg/registry/apis/dashboard/legacy/testdata/mysql--query_dashboards-dashboard_next_page.sql

@@ -1,20 +1,20 @@
 SELECT
-    dashboard.org_id, dashboard.id,
-    dashboard.uid, dashboard.folder_uid,
-    dashboard.deleted, plugin_id,
-    provisioning.name         as origin_name,
-    provisioning.external_id  as origin_path,
-    provisioning.check_sum    as origin_key,
-    provisioning.updated      as origin_ts,
-    dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
-    dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
-    dashboard.version, '' as message, dashboard.data
-    FROM `grafana`.`dashboard` as dashboard
-    LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
-    LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
-    LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
-    WHERE dashboard.is_folder = false
-      AND dashboard.org_id = 2
-      AND dashboard.id > 22
-      AND dashboard.deleted IS NULL
-    ORDER BY dashboard.id DESC
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
+  dashboard.version, '' as message, dashboard.data
+FROM `grafana`.`dashboard` as dashboard
+LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = FALSE
+  AND dashboard.org_id = 2
+    AND dashboard.id > 22
+    AND dashboard.deleted IS NULL
+  ORDER BY dashboard.id DESC

pkg/registry/apis/dashboard/legacy/testdata/mysql--query_dashboards-folders.sql

@@ -0,0 +1,18 @@
+SELECT
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
+  dashboard.version, '' as message, dashboard.data
+FROM `grafana`.`dashboard` as dashboard
+LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = TRUE
+  AND dashboard.org_id = 2
+  ORDER BY dashboard.id DESC

pkg/registry/apis/dashboard/legacy/testdata/mysql--query_dashboards-history_uid.sql

@@ -1,19 +1,19 @@
 SELECT
-    dashboard.org_id, dashboard.id,
-    dashboard.uid, dashboard.folder_uid,
-    dashboard.deleted, plugin_id,
-    provisioning.name         as origin_name,
-    provisioning.external_id  as origin_path,
-    provisioning.check_sum    as origin_key,
-    provisioning.updated      as origin_ts,
-    dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
-    dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
-    dashboard.version, '' as message, dashboard.data
-    FROM `grafana`.`dashboard` as dashboard
-    LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
-    LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
-    LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
-    WHERE dashboard.is_folder = false
-      AND dashboard.org_id = 2
-      AND dashboard.uid = 'UUU'
-    ORDER BY dashboard.id DESC
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  dashboard.updated, updated_user.uid as updated_by, dashboard.updated_by   as updated_by_id,
+  dashboard.version, '' as message, dashboard.data
+FROM `grafana`.`dashboard` as dashboard
+LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = FALSE
+  AND dashboard.org_id = 2
+    AND dashboard.uid = 'UUU'
+  ORDER BY dashboard.id DESC

pkg/registry/apis/dashboard/legacy/testdata/mysql--query_dashboards-history_uid_at_version.sql

@@ -1,21 +1,24 @@
 SELECT
-    dashboard.org_id, dashboard.id,
-    dashboard.uid, dashboard.folder_uid,
-    dashboard.deleted, plugin_id,
-    provisioning.name         as origin_name,
-    provisioning.external_id  as origin_path,
-    provisioning.check_sum    as origin_key,
-    provisioning.updated      as origin_ts,
-    dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
-    dashboard_version.created, updated_user.uid as updated_by,updated_user.id as created_by_id,
-    dashboard_version.version, dashboard_version.message, dashboard_version.data
-    FROM `grafana`.`dashboard` as dashboard
-    LEFT OUTER JOIN `grafana`.`dashboard_version` as dashboard_version ON dashboard.id = dashboard_version.dashboard_id
-    LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
-    LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
-    LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
-    WHERE dashboard.is_folder = false
-      AND dashboard.org_id = 2
-      AND dashboard.uid = 'UUU'
-      AND dashboard_version.version = 3
-    ORDER BY dashboard_version.version DESC
+  dashboard.org_id, dashboard.id,
+  dashboard.uid, dashboard.folder_uid,
+  dashboard.deleted, plugin_id,
+  provisioning.name        as repo_name,
+  provisioning.external_id as repo_path,
+  provisioning.check_sum   as repo_hash,
+  provisioning.updated     as repo_ts,
+  dashboard.created, created_user.uid as created_by, dashboard.created_by   as created_by_id,
+  dashboard_version.created, updated_user.uid as updated_by,updated_user.id as created_by_id,
+  dashboard_version.version, dashboard_version.message, dashboard_version.data
+FROM `grafana`.`dashboard` as dashboard
+LEFT OUTER JOIN `grafana`.`dashboard_version` as dashboard_version ON dashboard.id = dashboard_version.dashboard_id
+LEFT OUTER JOIN `grafana`.`dashboard_provisioning` as provisioning ON dashboard.id = provisioning.dashboard_id
+LEFT OUTER JOIN `grafana`.`user` as created_user ON dashboard.created_by = created_user.id
+LEFT OUTER JOIN `grafana`.`user` as updated_user ON dashboard.updated_by = updated_user.id
+WHERE dashboard.is_folder = FALSE
+  AND dashboard.org_id = 2
+  AND dashboard.uid = 'UUU'
+  AND dashboard_version.version = 3
+  ORDER BY 
+    dashboard_version.created ASC,
+    dashboard_version.version ASC,
+    dashboard.uid ASC