mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
6c76aa71e8
* 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>
88 lines
2.9 KiB
Go
88 lines
2.9 KiB
Go
package thumbs
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/grafana/grafana/pkg/models"
|
|
"github.com/grafana/grafana/pkg/services/rendering"
|
|
)
|
|
|
|
type CrawlerMode string
|
|
|
|
const (
|
|
|
|
// CrawlerModeThumbs will create small thumbnails for everything.
|
|
CrawlerModeThumbs CrawlerMode = "thumbs"
|
|
|
|
// CrawlerModeAnalytics will get full page results for everything.
|
|
CrawlerModeAnalytics CrawlerMode = "analytics"
|
|
|
|
// CrawlerModeMigrate will migrate all dashboards with old schema.
|
|
CrawlerModeMigrate CrawlerMode = "migrate"
|
|
)
|
|
|
|
type crawlerState string
|
|
|
|
const (
|
|
initializing crawlerState = "initializing"
|
|
running crawlerState = "running"
|
|
stopping crawlerState = "stopping"
|
|
stopped crawlerState = "stopped"
|
|
)
|
|
|
|
type previewRequest struct {
|
|
OrgID int64 `json:"orgId"`
|
|
UID string `json:"uid"`
|
|
Kind models.ThumbnailKind `json:"kind"`
|
|
Theme models.Theme `json:"theme"`
|
|
}
|
|
|
|
type crawlCmd struct {
|
|
Mode CrawlerMode `json:"mode"` // thumbs | analytics | migrate
|
|
Theme models.Theme `json:"theme"` // light | dark
|
|
}
|
|
|
|
type crawlStatus struct {
|
|
State crawlerState `json:"state"`
|
|
Started time.Time `json:"started,omitempty"`
|
|
Finished time.Time `json:"finished,omitempty"`
|
|
Complete int `json:"complete"`
|
|
Errors int `json:"errors"`
|
|
Queue int `json:"queue"`
|
|
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.
|
|
Run(ctx context.Context, authOpts rendering.AuthOpts, mode CrawlerMode, theme models.Theme, kind models.ThumbnailKind) error
|
|
|
|
// Assumes you have already authenticated as admin.
|
|
Stop() (crawlStatus, error)
|
|
|
|
// Assumes you have already authenticated as admin.
|
|
Status() (crawlStatus, error)
|
|
|
|
IsRunning() bool
|
|
}
|
|
|
|
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)
|
|
findDashboardsWithStaleThumbnails(ctx context.Context, theme models.Theme, thumbnailKind models.ThumbnailKind) ([]*models.DashboardWithStaleThumbnail, error)
|
|
}
|