report

Documentation

Index

• Variables
• func NewProcessor(log *log.Logger, generateUCC map[model.ReportType]GenerateUC, ...) (queue.Processor, error)
• type GenerateUC
  • func NewGenerateUC(typ model.ReportType, logger *log.Logger, generator Generator, ...) (GenerateUC, error)
• type Generator
  • func NewGenerator(typ string, config interface{}, log *log.Logger, db *sql.DB) (Generator, error)

Variables

var (
	// ErrInvalidGeneratorType indicates that the specified generator type is invalid.
	ErrInvalidGeneratorType = errors.New("Invalid generator type")
	// ErrInvalidConfiguration indicates that the supplied configuration is invalid.
	ErrInvalidConfiguration = errors.New("Invalid configuration")
)

var (
	// ErrInvalidRequest indicates that the request format is invalid.
	ErrInvalidRequest = errors.New("Invalid request")
	// ErrUnsupportedReportType indicates that the specified report type is not supported.
	ErrUnsupportedReportType = errors.New("The requested report type is not supported")
)

Functions

func NewProcessor

func NewProcessor(log *log.Logger, generateUCC map[model.ReportType]GenerateUC, uploader upload.Uploader,
	notifier notify.Notifier, metricsClient metrics.Client) (queue.Processor, error)

NewProcessor builds and returns a new Reports Processor.

Types

type GenerateUC

type GenerateUC interface {
	// Generate generates the report based on request data.
	Generate(ctx context.Context, teamInfo teamInfo, reportData interface{}) (model.Report, error)
	// Finish finishes report generation updating its status.
	Finish(ctx context.Context, reportID, status string) error
}

GenerateUC represents the Use Case interface for a report generation.

func NewGenerateUC

func NewGenerateUC(typ model.ReportType, logger *log.Logger, generator Generator, repository storage.ReportsRepository) (GenerateUC, error)

NewGenerateUC creates a new report generate use case based on specified type.

type Generator

type Generator interface {
	Generate(ctx context.Context, teamInfo teamInfo, reportData interface{}) (interface{}, error)
}

Generator represents the interface for a report generator.

func NewGenerator

func NewGenerator(typ string, config interface{}, log *log.Logger, db *sql.DB) (Generator, error)

NewGenerator builds and returns a new generator for the specified type.