rendering

package
v11.1.4-modfix Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 20, 2024 License: AGPL-3.0 Imports: 36 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrConcurrentLimitReached = errors.New("rendering concurrent limit reached")
View Source 
var ErrInvalidPluginVersion = errors.New("invalid plugin version")
View Source 
var ErrRenderUnavailable = errors.New("rendering plugin not available")
View Source 
var ErrServerTimeout = errutil.NewBase(errutil.StatusUnknown, "rendering.serverTimeout", errutil.WithPublicMessage("error trying to connect to image-renderer service"))
View Source 
var ErrTimeout = errors.New("timeout error - you can set timeout in seconds with &timeout url parameter")
View Source 
var ErrUnknownCapability = errors.New("unknown capability")

Functions

This section is empty.

Types

type AuthOpts 

type AuthOpts struct {
	OrgID   int64
	UserID  int64
	OrgRole org.RoleType
}

type CSVOpts 

type CSVOpts struct {
	CommonOpts
}

type Capability 

type Capability struct {
	// contains filtered or unexported fields
}

type CapabilityName 

type CapabilityName string
const (
	ScalingDownImages CapabilityName = "ScalingDownImages"
	FullHeightImages  CapabilityName = "FullHeightImages"
	SVGSanitization   CapabilityName = "SvgSanitization"
	PDFRendering      CapabilityName = "PdfRendering"
)

type CapabilitySupportRequestResult 

type CapabilitySupportRequestResult struct {
	IsSupported      bool
	SemverConstraint string
}

type CommonOpts 

type CommonOpts struct {
	TimeoutOpts
	AuthOpts
	Path            string
	Timezone        string
	ConcurrentLimit int
	Headers         map[string][]string
}

type ErrorOpts 

type ErrorOpts struct {
	// ErrorConcurrentLimitReached returns an ErrConcurrentLimitReached
	// error instead of a rendering limit exceeded image.
	ErrorConcurrentLimitReached bool
	// ErrorRenderUnavailable returns an ErrRunderUnavailable error
	// instead of a rendering unavailable image.
	ErrorRenderUnavailable bool
}

type MockService 

type MockService struct {
	// contains filtered or unexported fields
}

MockService is a mock of Service interface.

func NewMockService 

func NewMockService(ctrl *gomock.Controller) *MockService

NewMockService creates a new mock instance.

func (*MockService) CreateRenderingSession 

func (m *MockService) CreateRenderingSession(ctx context.Context, authOpts AuthOpts, sessionOpts SessionOpts) (Session, error)

CreateRenderingSession mocks base method.

func (*MockService) EXPECT 

func (m *MockService) EXPECT() *MockServiceMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockService) GetRenderUser 

func (m *MockService) GetRenderUser(ctx context.Context, key string) (*RenderUser, bool)

GetRenderUser mocks base method.

func (*MockService) HasCapability 

func (m *MockService) HasCapability(ctx context.Context, capability CapabilityName) (CapabilitySupportRequestResult, error)

HasCapability mocks base method.

func (*MockService) IsAvailable 

func (m *MockService) IsAvailable(ctx context.Context) bool

IsAvailable mocks base method.

func (*MockService) IsCapabilitySupported 

func (m *MockService) IsCapabilitySupported(ctx context.Context, capability CapabilityName) error

IsCapabilitySupported mocks base method.

func (*MockService) Render 

func (m *MockService) Render(ctx context.Context, renderType RenderType, opts Opts, session Session) (*RenderResult, error)

Render mocks base method.

func (*MockService) RenderCSV 

func (m *MockService) RenderCSV(ctx context.Context, opts CSVOpts, session Session) (*RenderCSVResult, error)

RenderCSV mocks base method.

func (*MockService) RenderErrorImage 

func (m *MockService) RenderErrorImage(theme models.Theme, err error) (*RenderResult, error)

RenderErrorImage mocks base method.

func (*MockService) SanitizeSVG 

func (m *MockService) SanitizeSVG(ctx context.Context, req *SanitizeSVGRequest) (*SanitizeSVGResponse, error)

SanitizeSVG mocks base method.

func (*MockService) Version 

func (m *MockService) Version() string

Version mocks base method.

type MockServiceMockRecorder 

type MockServiceMockRecorder struct {
	// contains filtered or unexported fields
}

MockServiceMockRecorder is the mock recorder for MockService.

func (*MockServiceMockRecorder) CreateRenderingSession 

func (mr *MockServiceMockRecorder) CreateRenderingSession(ctx, authOpts, sessionOpts interface{}) *gomock.Call

CreateRenderingSession indicates an expected call of CreateRenderingSession.

func (*MockServiceMockRecorder) GetRenderUser 

func (mr *MockServiceMockRecorder) GetRenderUser(ctx, key interface{}) *gomock.Call

GetRenderUser indicates an expected call of GetRenderUser.

func (*MockServiceMockRecorder) HasCapability 

func (mr *MockServiceMockRecorder) HasCapability(ctx, capability interface{}) *gomock.Call

HasCapability indicates an expected call of HasCapability.

func (*MockServiceMockRecorder) IsAvailable 

func (mr *MockServiceMockRecorder) IsAvailable(ctx interface{}) *gomock.Call

IsAvailable indicates an expected call of IsAvailable.

func (*MockServiceMockRecorder) IsCapabilitySupported 

func (mr *MockServiceMockRecorder) IsCapabilitySupported(ctx, capability interface{}) *gomock.Call

IsCapabilitySupported indicates an expected call of IsCapabilitySupported.

func (*MockServiceMockRecorder) Render 

func (mr *MockServiceMockRecorder) Render(ctx, renderType, opts, session interface{}) *gomock.Call

Render indicates an expected call of Render.

func (*MockServiceMockRecorder) RenderCSV 

func (mr *MockServiceMockRecorder) RenderCSV(ctx, opts, session interface{}) *gomock.Call

RenderCSV indicates an expected call of RenderCSV.

func (*MockServiceMockRecorder) RenderErrorImage 

func (mr *MockServiceMockRecorder) RenderErrorImage(theme, error interface{}) *gomock.Call

RenderErrorImage indicates an expected call of RenderErrorImage.

func (*MockServiceMockRecorder) SanitizeSVG 

func (mr *MockServiceMockRecorder) SanitizeSVG(ctx, req interface{}) *gomock.Call

SanitizeSVG indicates an expected call of SanitizeSVG.

func (*MockServiceMockRecorder) Version 

func (mr *MockServiceMockRecorder) Version() *gomock.Call

Version indicates an expected call of Version.

type Opts 

type Opts struct {
	CommonOpts
	ErrorOpts
	Width             int
	Height            int
	DeviceScaleFactor float64
	Theme             models.Theme
}

type Plugin 

type Plugin interface {
	Client() (pluginextensionv2.RendererPlugin, error)
	Start(ctx context.Context) error
	Version() string
}

type PluginManager 

type PluginManager interface {
	Renderer(ctx context.Context) (Plugin, bool)
}

type RenderCSVResult 

type RenderCSVResult struct {
	FilePath string
	FileName string
}

type RenderResult 

type RenderResult struct {
	FilePath string
}

type RenderType 

type RenderType string
const (
	RenderCSV RenderType = "csv"
	RenderPNG RenderType = "png"
	RenderPDF RenderType = "pdf"
)

type RenderUser 

type RenderUser struct {
	OrgID   int64  `json:"org_id"`
	UserID  int64  `json:"user_id"`
	OrgRole string `json:"org_role"`
}

type RenderingService 

type RenderingService struct {
	Cfg *setting.Cfg

	RemoteCacheService    *remotecache.RemoteCache
	RendererPluginManager PluginManager
	// contains filtered or unexported fields
}

func ProvideService 

func ProvideService(cfg *setting.Cfg, features featuremgmt.FeatureToggles, remoteCache *remotecache.RemoteCache, rm PluginManager) (*RenderingService, error)

func (*RenderingService) CreateRenderingSession 

func (rs *RenderingService) CreateRenderingSession(ctx context.Context, opts AuthOpts, sessionOpts SessionOpts) (Session, error)

func (*RenderingService) GetRenderUser 

func (rs *RenderingService) GetRenderUser(ctx context.Context, key string) (*RenderUser, bool)

func (*RenderingService) HasCapability 

func (rs *RenderingService) HasCapability(ctx context.Context, capability CapabilityName) (CapabilitySupportRequestResult, error)

func (*RenderingService) IsAvailable 

func (rs *RenderingService) IsAvailable(ctx context.Context) bool

func (*RenderingService) IsCapabilitySupported 

func (rs *RenderingService) IsCapabilitySupported(ctx context.Context, capabilityName CapabilityName) error

func (*RenderingService) Render 

func (rs *RenderingService) Render(ctx context.Context, renderType RenderType, opts Opts, session Session) (*RenderResult, error)

Render calls the grafana image renderer and returns Grafana resource as PNG or PDF

func (*RenderingService) RenderCSV 

func (rs *RenderingService) RenderCSV(ctx context.Context, opts CSVOpts, session Session) (*RenderCSVResult, error)

func (*RenderingService) RenderErrorImage 

func (rs *RenderingService) RenderErrorImage(theme models.Theme, err error) (*RenderResult, error)

func (*RenderingService) Run 

func (rs *RenderingService) Run(ctx context.Context) error

func (*RenderingService) SanitizeSVG 

func (rs *RenderingService) SanitizeSVG(ctx context.Context, req *SanitizeSVGRequest) (*SanitizeSVGResponse, error)

func (*RenderingService) Version 

func (rs *RenderingService) Version() string

type Result 

type Result struct {
	FilePath string
	FileName string
}

type SanitizeSVGRequest 

type SanitizeSVGRequest struct {
	Filename string
	Content  []byte
}

type SanitizeSVGResponse 

type SanitizeSVGResponse struct {
	Sanitized []byte
}

type Service 

type Service interface {
	IsAvailable(ctx context.Context) bool
	Version() string
	Render(ctx context.Context, renderType RenderType, opts Opts, session Session) (*RenderResult, error)
	RenderCSV(ctx context.Context, opts CSVOpts, session Session) (*RenderCSVResult, error)
	RenderErrorImage(theme models.Theme, error error) (*RenderResult, error)
	GetRenderUser(ctx context.Context, key string) (*RenderUser, bool)
	HasCapability(ctx context.Context, capability CapabilityName) (CapabilitySupportRequestResult, error)
	IsCapabilitySupported(ctx context.Context, capability CapabilityName) error
	CreateRenderingSession(ctx context.Context, authOpts AuthOpts, sessionOpts SessionOpts) (Session, error)
	SanitizeSVG(ctx context.Context, req *SanitizeSVGRequest) (*SanitizeSVGResponse, error)
}

type Session 

type Session interface {
	Dispose(ctx context.Context)
	// contains filtered or unexported methods
}

type SessionOpts 

type SessionOpts struct {
	Expiry                     time.Duration
	RefreshExpiryOnEachRequest bool
}

type TimeoutOpts 

type TimeoutOpts struct {
	Timeout                  time.Duration // Timeout param passed to image-renderer service
	RequestTimeoutMultiplier time.Duration // RequestTimeoutMultiplier used for plugin/HTTP request context timeout
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.