fix: delete provisioned dashboard in unified if forceDeleteRules is set

Author: RafaelPaulovic

pkg/api/dashboard.go

@@ -381,7 +381,7 @@ func (hs *HTTPServer) deleteDashboard(c *contextmodel.ReqContext) response.Respo
 			"error", err)
 	}
 
-	err = hs.DashboardService.DeleteDashboard(c.Req.Context(), dash.ID, dash.UID, c.GetOrgID())
+	err = hs.DashboardService.DeleteDashboard(c.Req.Context(), dash.ID, dash.UID, c.GetOrgID(), true)
 	if err != nil {
 		return dashboardErrResponse(err, "Failed to delete dashboard")
 	}

pkg/services/dashboards/dashboard.go

@@ -20,7 +20,7 @@ import (
 //go:generate mockery --name DashboardService --structname FakeDashboardService --inpackage --filename dashboard_service_mock.go
 type DashboardService interface {
 	BuildSaveDashboardCommand(ctx context.Context, dto *SaveDashboardDTO, validateProvisionedDashboard bool) (*SaveDashboardCommand, error)
-	DeleteDashboard(ctx context.Context, dashboardId int64, dashboardUID string, orgId int64) error
+	DeleteDashboard(ctx context.Context, dashboardId int64, dashboardUID string, orgId int64, validateProvisionedDashboard bool) error
 	DeleteAllDashboards(ctx context.Context, orgID int64) error
 	FindDashboards(ctx context.Context, query *FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error)
 	// GetDashboard fetches a dashboard.

pkg/services/dashboards/dashboard_provisioning_mock.go

@@ -365,8 +365,10 @@ func (dr *DashboardServiceImpl) Run(ctx context.Context) error {
 	return ctx.Err()
 }
 
-var _ dashboards.PermissionsRegistrationService = (*DashboardServiceImpl)(nil)
-var _ registry.BackgroundService = (*DashboardServiceImpl)(nil)
+var (
+	_ dashboards.PermissionsRegistrationService = (*DashboardServiceImpl)(nil)
+	_ registry.BackgroundService                = (*DashboardServiceImpl)(nil)
+)
 
 // This is the uber service that implements a three smaller services
 func ProvideDashboardServiceImpl(
@@ -645,7 +647,8 @@ func (dr *DashboardServiceImpl) ValidateBasicDashboardProperties(title string, u
 
 //nolint:gocyclo
 func (dr *DashboardServiceImpl) BuildSaveDashboardCommand(ctx context.Context, dto *dashboards.SaveDashboardDTO,
-	validateProvisionedDashboard bool) (*dashboards.SaveDashboardCommand, error) {
+	validateProvisionedDashboard bool,
+) (*dashboards.SaveDashboardCommand, error) {
 	ctx, span := tracer.Start(ctx, "dashboards.service.BuildSaveDashboardcommand")
 	defer span.End()
 
@@ -976,7 +979,8 @@ func (dr *DashboardServiceImpl) ValidateDashboardRefreshInterval(minRefreshInter
 }
 
 func (dr *DashboardServiceImpl) SaveProvisionedDashboard(ctx context.Context, dto *dashboards.SaveDashboardDTO,
-	provisioning *dashboards.DashboardProvisioning) (*dashboards.Dashboard, error) {
+	provisioning *dashboards.DashboardProvisioning,
+) (*dashboards.Dashboard, error) {
 	ctx, span := tracer.Start(ctx, "dashboards.service.SaveProvisionedDashboard")
 	defer span.End()
 
@@ -1050,7 +1054,8 @@ func (dr *DashboardServiceImpl) UpdateFolderWithManagedByAnnotation(ctx context.
 }
 
 func (dr *DashboardServiceImpl) SaveDashboard(ctx context.Context, dto *dashboards.SaveDashboardDTO,
-	allowUiUpdate bool) (*dashboards.Dashboard, error) {
+	allowUiUpdate bool,
+) (*dashboards.Dashboard, error) {
 	ctx, span := tracer.Start(ctx, "dashboards.service.SaveDashboard")
 	defer span.End()
 
@@ -1085,8 +1090,8 @@ func (dr *DashboardServiceImpl) saveDashboard(ctx context.Context, cmd *dashboar
 
 // DeleteDashboard removes dashboard from the DB. Errors out if the dashboard was provisioned. Should be used for
 // operations by the user where we want to make sure user does not delete provisioned dashboard.
-func (dr *DashboardServiceImpl) DeleteDashboard(ctx context.Context, dashboardId int64, dashboardUID string, orgId int64) error {
-	return dr.deleteDashboard(ctx, dashboardId, dashboardUID, orgId, true)
+func (dr *DashboardServiceImpl) DeleteDashboard(ctx context.Context, dashboardId int64, dashboardUID string, orgId int64, validateProvisionedDashboard bool) error {
+	return dr.deleteDashboard(ctx, dashboardId, dashboardUID, orgId, validateProvisionedDashboard)
 }
 
 // DeleteAllDashboards will delete all dashboards within a given org.
@@ -1114,7 +1119,8 @@ func (dr *DashboardServiceImpl) deleteDashboard(ctx context.Context, dashboardId
 }
 
 func (dr *DashboardServiceImpl) ImportDashboard(ctx context.Context, dto *dashboards.SaveDashboardDTO) (
-	*dashboards.Dashboard, error) {
+	*dashboards.Dashboard, error,
+) {
 	ctx, span := tracer.Start(ctx, "dashboards.service.ImportDashboard")
 	defer span.End()
 
@@ -1638,7 +1644,8 @@ func (dr *DashboardServiceImpl) GetDashboardTags(ctx context.Context, query *das
 				Limit: 100000,
 			},
 		},
-		Limit: 100000})
+		Limit: 100000,
+	})
 	if err != nil {
 		return nil, err
 	}
@@ -1682,7 +1689,6 @@ func (dr *DashboardServiceImpl) DeleteInFolders(ctx context.Context, orgID int64
 		OrgId:        orgID,
 		FolderUIDs:   folderUIDs,
 	})
-
 	if err != nil {
 		return folder.ErrInternal.Errorf("failed to fetch dashboards: %w", err)
 	}
@@ -1698,7 +1704,7 @@ func (dr *DashboardServiceImpl) DeleteInFolders(ctx context.Context, orgID int64
 	}
 
 	for _, dash := range dashes {
-		errDel := dr.DeleteDashboard(ctx, dash.ID, dash.UID, orgID)
+		errDel := dr.DeleteDashboard(ctx, dash.ID, dash.UID, orgID, false)
 		if errDel != nil {
 			dr.log.Error("failed to delete dashboard inside folder", "dashboardUID", dash.UID, "folderUIDs", folderUIDs, "error", errDel)
 		}
@@ -1714,7 +1720,7 @@ func (dr *DashboardServiceImpl) CleanUpDashboard(ctx context.Context, dashboardU
 	defer span.End()
 
 	// cleanup things related to dashboards that are not stored in unistore yet
-	var err = dr.publicDashboardService.DeleteByDashboardUIDs(ctx, orgId, []string{dashboardUID})
+	err := dr.publicDashboardService.DeleteByDashboardUIDs(ctx, orgId, []string{dashboardUID})
 	if err != nil {
 		return err
 	}
@@ -1894,7 +1900,8 @@ func (dr *DashboardServiceImpl) searchDashboardsThroughK8sRaw(ctx context.Contex
 			Fields: []*resourcepb.Requirement{},
 			Labels: []*resourcepb.Requirement{},
 		},
-		Limit: 100000}
+		Limit: 100000,
+	}
 
 	if len(query.DashboardUIDs) > 0 {
 		request.Options.Fields = []*resourcepb.Requirement{{

pkg/services/dashboards/dashboard_service_mock.go

@@ -1236,7 +1236,7 @@ func TestDeleteDashboard(t *testing.T) {
 		ctx, k8sCliMock := setupK8sDashboardTests(service)
 		k8sCliMock.On("Delete", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil).Once()
 
-		err := service.DeleteDashboard(ctx, 1, "uid", 1)
+		err := service.DeleteDashboard(ctx, 1, "uid", 1, true)
 		require.NoError(t, err)
 		k8sCliMock.AssertExpectations(t)
 	})
@@ -1272,7 +1272,7 @@ func TestDeleteDashboard(t *testing.T) {
 			},
 			TotalHits: 1,
 		}, nil)
-		err := service.DeleteDashboard(ctx, 1, "", 1)
+		err := service.DeleteDashboard(ctx, 1, "", 1, true)
 		require.NoError(t, err)
 		k8sCliMock.AssertExpectations(t)
 		k8sCliMock.AssertExpectations(t)
@@ -1967,7 +1967,8 @@ func TestSearchDashboardsThroughK8sRaw(t *testing.T) {
 			Results: &resourcepb.ResourceTable{
 				Columns: []*resourcepb.ResourceTableColumnDefinition{},
 				Rows:    []*resourcepb.ResourceTableRow{},
-			}}, nil)
+			},
+		}, nil)
 		_, err := service.searchDashboardsThroughK8s(ctx, query)
 		require.NoError(t, err)
 	})

pkg/services/dashboards/service/dashboard_service.go

@@ -18,7 +18,8 @@ import (
 
 func ProvideDashboardUpdater(bus bus.Bus, pluginStore pluginstore.Store, pluginDashboardService plugindashboards.Service,
 	dashboardImportService dashboardimport.Service, pluginSettingsService pluginsettings.Service,
-	dashboardPluginService dashboards.PluginService, dashboardService dashboards.DashboardService) *DashboardUpdater {
+	dashboardPluginService dashboards.PluginService, dashboardService dashboards.DashboardService,
+) *DashboardUpdater {
 	du := newDashboardUpdater(bus, pluginStore, pluginDashboardService, dashboardImportService,
 		pluginSettingsService, dashboardPluginService, dashboardService)
 	return du
@@ -27,7 +28,8 @@ func ProvideDashboardUpdater(bus bus.Bus, pluginStore pluginstore.Store, pluginD
 func newDashboardUpdater(bus bus.Bus, pluginStore pluginstore.Store,
 	pluginDashboardService plugindashboards.Service, dashboardImportService dashboardimport.Service,
 	pluginSettingsService pluginsettings.Service, dashboardPluginService dashboards.PluginService,
-	dashboardService dashboards.DashboardService) *DashboardUpdater {
+	dashboardService dashboards.DashboardService,
+) *DashboardUpdater {
 	s := &DashboardUpdater{
 		pluginStore:            pluginStore,
 		pluginDashboardService: pluginDashboardService,
@@ -101,7 +103,7 @@ func (du *DashboardUpdater) syncPluginDashboards(ctx context.Context, plugin plu
 		if dash.Removed {
 			du.logger.Info("Deleting plugin dashboard", "pluginId", plugin.ID, "dashboard", dash.Slug)
 
-			if err := du.dashboardService.DeleteDashboard(ctx, dash.DashboardId, dash.UID, orgID); err != nil {
+			if err := du.dashboardService.DeleteDashboard(ctx, dash.DashboardId, dash.UID, orgID, true); err != nil {
 				du.logger.Error("Failed to auto update app dashboard", "pluginId", plugin.ID, "error", err)
 				return
 			}
@@ -157,7 +159,7 @@ func (du *DashboardUpdater) handlePluginStateChanged(ctx context.Context, event
 
 		for _, dash := range queryResult {
 			du.logger.Info("Deleting plugin dashboard", "pluginId", event.PluginId, "dashboard", dash.Slug)
-			if err := du.dashboardService.DeleteDashboard(ctx, dash.ID, dash.UID, dash.OrgID); err != nil {
+			if err := du.dashboardService.DeleteDashboard(ctx, dash.ID, dash.UID, dash.OrgID, true); err != nil {
 				return err
 			}
 		}

pkg/services/dashboards/service/dashboard_service_test.go

@@ -449,7 +449,7 @@ type dashboardServiceMock struct {
 	}
 }
 
-func (s *dashboardServiceMock) DeleteDashboard(_ context.Context, dashboardId int64, dashboardUID string, orgId int64) error {
+func (s *dashboardServiceMock) DeleteDashboard(_ context.Context, dashboardId int64, dashboardUID string, orgId int64, _ bool) error {
 	s.deleteDashboardArgs = append(s.deleteDashboardArgs, struct {
 		orgId        int64
 		dashboardId  int64