Previews: capability check (#44601)

* add SQL migrations

* dashboard previews from sql: poc

* added todos

* refactor: use the same enums where possible

* use useEffect, always return json

* added todo

* refactor + delete files after use

* refactor + fix manual thumbnail upload

* refactor: move all interactions with sqlStore to thumbnail repo

* refactor: remove file operations in thumb crawler/service

* refactor: fix dashboard_thumbs sql store

* refactor: extracted thumbnail fetching/updating to a hook

* refactor: store thumbnails in redux store

* refactor: store thumbnails in redux store

* refactor: private'd repo methods

* removed redux storage, saving images as blobs

* allow for configurable rendering timeouts

* added 1) query for dashboards with stale thumbnails, 2) command for marking thumbnails as stale

* use sql-based queue in crawler

* ui for marking thumbnails as stale

* replaced `stale` boolean prop with `state` enum

* introduce rendering session

* compilation errors

* fix crawler stop button

* rename thumbnail state frozen to locked

* #44449: fix merge conflicts

* #44449: remove thumb methods from `Store` interface

* #44449: clean filepath, defer file closing

* #44449: fix rendering.Theme cyclic import

* #44449: linting

* #44449: linting

* #44449: mutex'd crawlerStatus access

* #44449: added integration tests for `sqlstore.dashboard_thumbs`

* #44449: added comments to explain the `ThumbnailState` enum

* #44449: use os.ReadFile rather then os.Open

* #44449: always enable dashboardPreviews feature during integration tests

* #44449: add /previews/system-requirements API

* #44449: remove sleep time, adjust number of threads

* #44449: review fix: add `orgId` to `DashboardThumbnailMeta`

* #44449: review fix: automatic parsing of thumbnailState

* #44449: update returned json

* #44449: UI changes - dashboard previews sytem req check

* #44449: lint fixes

* #44449: fix tests

* #44449: typo

* #44449: fix getSystemRequirements API: return 200 even if we plugin version is invalid

* #44449: fix getSystemRequirements API: don't return SemverConstraint on error

* #44449: fix getSystemRequirements API

* #44449: fix previews sytem requirements text

* #44449: add `doThumbnailsExist` to repo

* #44449: remove redux api

* #44449: add missing model

* #44449: implement frontedsettings-driven capability check

* #44449: simplify

* #44449: revert test changes

* #44449: add dummy setup settings

* #44449: implicit typing over `FC<Props>`

* #44449: refactor conditionals

* #44449: replace `getText` with a react component

* #44449: fix component interface

* #44449: add onRemove to `PreviewsSystemRequirements` alert

* #44449: add bottom/top margin to previewSystemRequirements modal

* #44449: merge conflict fix

* #44449: remove console.log

Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
Co-authored-by: Alexander Emelin <frvzmb@gmail.com>

pkg/services/thumbs/dummy.go

@@ -26,6 +26,16 @@ func (ds *dummyService) Enabled() bool {
 	return false
 }
 
+func (ds *dummyService) GetDashboardPreviewsSetupSettings(c *models.ReqContext) dashboardPreviewsSetupConfig {
+	return dashboardPreviewsSetupConfig{
+		SystemRequirements: dashboardPreviewsSystemRequirements{
+			Met:                                false,
+			RequiredImageRendererPluginVersion: "",
+		},
+		ThumbnailsExist: false,
+	}
+}
+
 func (ds *dummyService) StartCrawler(c *models.ReqContext) response.Response {
 	result := make(map[string]string)
 	result["error"] = "Not enabled"

pkg/services/thumbs/models.go

@@ -53,6 +53,16 @@ type crawlStatus struct {
 	Last     time.Time    `json:"last,omitempty"`
 }
 
+type dashboardPreviewsSystemRequirements struct {
+	Met                                bool   `json:"met"`
+	RequiredImageRendererPluginVersion string `json:"requiredImageRendererPluginVersion"`
+}
+
+type dashboardPreviewsSetupConfig struct {
+	SystemRequirements dashboardPreviewsSystemRequirements `json:"systemRequirements"`
+	ThumbnailsExist    bool                                `json:"thumbnailsExist"`
+}
+
 type dashRenderer interface {
 
 	// Run Assumes you have already authenticated as admin.
@@ -69,6 +79,7 @@ type dashRenderer interface {
 
 type thumbnailRepo interface {
 	updateThumbnailState(ctx context.Context, state models.ThumbnailState, meta models.DashboardThumbnailMeta) error
+	doThumbnailsExist(ctx context.Context) (bool, error)
 	saveFromFile(ctx context.Context, filePath string, meta models.DashboardThumbnailMeta, dashboardVersion int) (int64, error)
 	saveFromBytes(ctx context.Context, bytes []byte, mimeType string, meta models.DashboardThumbnailMeta, dashboardVersion int) (int64, error)
 	getThumbnail(ctx context.Context, meta models.DashboardThumbnailMeta) (*models.DashboardThumbnail, error)

pkg/services/thumbs/repo.go

@@ -63,7 +63,7 @@ func (r *sqlThumbnailRepository) saveFromBytes(ctx context.Context, content []by
 
 	_, err := r.store.SaveThumbnail(ctx, cmd)
 	if err != nil {
-		r.log.Error("error saving to the db", "dashboardUID", meta.DashboardUID, "err", err)
+		r.log.Error("Error saving to the db", "dashboardUID", meta.DashboardUID, "err", err)
 		return 0, err
 	}
 
@@ -91,3 +91,13 @@ func (r *sqlThumbnailRepository) findDashboardsWithStaleThumbnails(ctx context.C
 		Kind:                              kind,
 	})
 }
+
+func (r *sqlThumbnailRepository) doThumbnailsExist(ctx context.Context) (bool, error) {
+	cmd := &models.FindDashboardThumbnailCountCommand{}
+	count, err := r.store.FindThumbnailCount(ctx, cmd)
+	if err != nil {
+		r.log.Error("Error finding thumbnails", "err", err)
+		return false, err
+	}
+	return count > 0, err
+}

pkg/services/thumbs/service.go

@@ -27,6 +27,7 @@ type Service interface {
 	Run(ctx context.Context) error
 	Enabled() bool
 	GetImage(c *models.ReqContext)
+	GetDashboardPreviewsSetupSettings(c *models.ReqContext) dashboardPreviewsSetupConfig
 
 	// from dashboard page
 	SetImage(c *models.ReqContext) // form post
@@ -41,6 +42,7 @@ type Service interface {
 type thumbService struct {
 	scheduleOptions            crawlerScheduleOptions
 	renderer                   dashRenderer
+	renderingService           rendering.Service
 	thumbnailRepo              thumbnailRepo
 	lockService                *serverlock.ServerLockService
 	features                   featuremgmt.FeatureToggles
@@ -71,6 +73,7 @@ func ProvideService(cfg *setting.Cfg, features featuremgmt.FeatureToggles, lockS
 		OrgRole: models.ROLE_ADMIN,
 	}
 	return &thumbService{
+		renderingService:           renderService,
 		renderer:                   newSimpleCrawler(renderService, gl, thumbnailRepo),
 		thumbnailRepo:              thumbnailRepo,
 		features:                   features,
@@ -196,6 +199,44 @@ func (hs *thumbService) GetImage(c *models.ReqContext) {
 	}
 }
 
+func (hs *thumbService) GetDashboardPreviewsSetupSettings(c *models.ReqContext) dashboardPreviewsSetupConfig {
+	systemRequirements := hs.getSystemRequirements()
+	thumbnailsExist, err := hs.thumbnailRepo.doThumbnailsExist(c.Req.Context())
+
+	if err != nil {
+		return dashboardPreviewsSetupConfig{
+			SystemRequirements: systemRequirements,
+			ThumbnailsExist:    false,
+		}
+	}
+
+	return dashboardPreviewsSetupConfig{
+		SystemRequirements: systemRequirements,
+		ThumbnailsExist:    thumbnailsExist,
+	}
+}
+
+func (hs *thumbService) getSystemRequirements() dashboardPreviewsSystemRequirements {
+	res, err := hs.renderingService.HasCapability(rendering.ScalingDownImages)
+	if err != nil {
+		hs.log.Error("Error when verifying dashboard previews system requirements thumbnail", "err", err.Error())
+		return dashboardPreviewsSystemRequirements{
+			Met: false,
+		}
+	}
+
+	if !res.IsSupported {
+		return dashboardPreviewsSystemRequirements{
+			Met:                                false,
+			RequiredImageRendererPluginVersion: res.SemverConstraint,
+		}
+	}
+
+	return dashboardPreviewsSystemRequirements{
+		Met: true,
+	}
+}
+
 // Hack for now -- lets you upload images explicitly
 func (hs *thumbService) SetImage(c *models.ReqContext) {
 	req := hs.parseImageReq(c, false)