From 4e57324d580a3283041dc2a0a6899600104070f9 Mon Sep 17 00:00:00 2001 From: Kat Yang <69819079+yangkb09@users.noreply.github.com> Date: Thu, 9 Nov 2023 10:53:39 -0500 Subject: [PATCH] Chore: Deprecate FolderID from GetDashboardQuery (#77812) --- pkg/services/dashboards/database/database.go | 2 ++ pkg/services/dashboards/database/database_test.go | 4 ++-- pkg/services/dashboards/models.go | 7 ++++--- pkg/services/provisioning/alerting/rules_provisioner.go | 2 +- pkg/services/provisioning/dashboards/file_reader.go | 2 +- 5 files changed, 10 insertions(+), 7 deletions(-) diff --git a/pkg/services/dashboards/database/database.go b/pkg/services/dashboards/database/database.go index 2229af64924..1f81c47e2a5 100644 --- a/pkg/services/dashboards/database/database.go +++ b/pkg/services/dashboards/database/database.go @@ -884,6 +884,7 @@ func (d *dashboardStore) deleteAlertDefinition(dashboardId int64, sess *db.Sessi func (d *dashboardStore) GetDashboard(ctx context.Context, query *dashboards.GetDashboardQuery) (*dashboards.Dashboard, error) { var queryResult *dashboards.Dashboard err := d.store.WithDbSession(ctx, func(sess *db.Session) error { + // nolint:staticcheck if query.ID == 0 && len(query.UID) == 0 && (query.Title == nil || query.FolderID == nil) { return dashboards.ErrDashboardIdentifierNotSet } @@ -894,6 +895,7 @@ func (d *dashboardStore) GetDashboard(ctx context.Context, query *dashboards.Get dashboard.Title = *query.Title mustCols = append(mustCols, "title") } + // nolint:staticcheck if query.FolderID != nil { dashboard.FolderID = *query.FolderID mustCols = append(mustCols, "folder_id") diff --git a/pkg/services/dashboards/database/database_test.go b/pkg/services/dashboards/database/database_test.go index a3607eb1d8f..1c988d92418 100644 --- a/pkg/services/dashboards/database/database_test.go +++ b/pkg/services/dashboards/database/database_test.go @@ -93,7 +93,7 @@ func TestIntegrationDashboardDataAccess(t *testing.T) { setup() query := dashboards.GetDashboardQuery{ Title: util.Pointer("test dash 23"), - FolderID: &savedFolder.ID, + FolderID: &savedFolder.ID, // nolint:staticcheck OrgID: 1, } @@ -122,7 +122,7 @@ func TestIntegrationDashboardDataAccess(t *testing.T) { setup() query := dashboards.GetDashboardQuery{ Title: util.Pointer("test dash 23"), - FolderID: util.Pointer(int64(0)), + FolderID: util.Pointer(int64(0)), // nolint:staticcheck OrgID: 1, } diff --git a/pkg/services/dashboards/models.go b/pkg/services/dashboards/models.go index 4190a7c4cf7..c8a7ed1f1f4 100644 --- a/pkg/services/dashboards/models.go +++ b/pkg/services/dashboards/models.go @@ -302,9 +302,10 @@ type DeleteOrphanedProvisionedDashboardsCommand struct { // // Multiple constraints can be combined. type GetDashboardQuery struct { - ID int64 - UID string - Title *string + ID int64 + UID string + Title *string + // Deprecated: use FolderUID instead FolderID *int64 OrgID int64 } diff --git a/pkg/services/provisioning/alerting/rules_provisioner.go b/pkg/services/provisioning/alerting/rules_provisioner.go index 7abc00f37e2..5a84d0bd13b 100644 --- a/pkg/services/provisioning/alerting/rules_provisioner.go +++ b/pkg/services/provisioning/alerting/rules_provisioner.go @@ -97,7 +97,7 @@ func (prov *defaultAlertRuleProvisioner) getOrCreateFolderUID( ctx context.Context, folderName string, orgID int64) (string, error) { cmd := &dashboards.GetDashboardQuery{ Title: &folderName, - FolderID: util.Pointer(int64(0)), + FolderID: util.Pointer(int64(0)), // nolint:staticcheck OrgID: orgID, } cmdResult, err := prov.dashboardService.GetDashboard(ctx, cmd) diff --git a/pkg/services/provisioning/dashboards/file_reader.go b/pkg/services/provisioning/dashboards/file_reader.go index bd32543fc04..62f7b84879e 100644 --- a/pkg/services/provisioning/dashboards/file_reader.go +++ b/pkg/services/provisioning/dashboards/file_reader.go @@ -318,7 +318,7 @@ func (fr *FileReader) getOrCreateFolder(ctx context.Context, cfg *config, servic cmd := &dashboards.GetDashboardQuery{ Title: &folderName, - FolderID: util.Pointer(int64(0)), + FolderID: util.Pointer(int64(0)), // nolint:staticcheck OrgID: cfg.OrgID, } result, err := fr.dashboardStore.GetDashboard(ctx, cmd)