scheduler

Documentation

Index

• func GetFactSituations(fact engine.Fact, t time.Time) ([]situation.HistoryRecord, error)
• func ReplaceGlobalRepository(repository Repository) func()
• func ReplaceGlobals(scheduler *InternalScheduler) func()
• func UpdateSituations(situationsToUpdate map[string]situation.HistoryRecord) ([]evaluator.SituationToEvaluate, error)
• type FactCalculationJob
  • func NewFactCalculationJob(cronExpr string, factIds []int64) FactCalculationJob
  • func (job FactCalculationJob) IsValid() (bool, error)
  • func (job *FactCalculationJob) ResolveFromAndTo(t time.Time) (time.Time, time.Time, error)
  • func (job FactCalculationJob) Run()
  • func (job *FactCalculationJob) UnmarshalJSON(data []byte) error
• type InternalJob
  • func UnmarshalInternalJob(t string, b json.RawMessage, scheduleID int64) (InternalJob, error)
• type InternalSchedule
  • func (schedule *InternalSchedule) IsValid() (bool, error)
  • func (schedule *InternalSchedule) UnmarshalJSON(data []byte) error
• type InternalScheduler
  • func NewScheduler() *InternalScheduler
  • func S() *InternalScheduler
  • func (s *InternalScheduler) AddJobSchedule(schedule InternalSchedule) error
  • func (s *InternalScheduler) AddRunningJob(scheduleID int64)
  • func (s *InternalScheduler) ExistingRunningJob(scheduleID int64) bool
  • func (s *InternalScheduler) Init() error
  • func (s *InternalScheduler) RemoveJobSchedule(scheduleID int64)
  • func (s *InternalScheduler) RemoveRunningJob(scheduleID int64)
• type PostgresRepository
  • func (r *PostgresRepository) Create(schedule InternalSchedule) (int64, error)
  • func (r *PostgresRepository) Delete(id int64) error
  • func (r *PostgresRepository) Get(id int64) (InternalSchedule, bool, error)
  • func (r *PostgresRepository) GetAll() (map[int64]InternalSchedule, error)
  • func (r *PostgresRepository) Update(schedule InternalSchedule) error
• type Repository
  • func NewPostgresRepository(dbClient *sqlx.DB) Repository
  • func R() Repository

Functions

func GetFactSituations

func GetFactSituations(fact engine.Fact, t time.Time) ([]situation.HistoryRecord, error)

GetFactSituations returns all situation linked to a fact

func ReplaceGlobalRepository

func ReplaceGlobalRepository(repository Repository) func()

ReplaceGlobalRepository affect a new repository to the global repository singleton

func ReplaceGlobals

func ReplaceGlobals(scheduler *InternalScheduler) func()

ReplaceGlobals affect a new repository to the global fact scheduler singleton

func UpdateSituations

func UpdateSituations(situationsToUpdate map[string]situation.HistoryRecord) ([]evaluator.SituationToEvaluate, error)

UpdateSituations creates the new instances of the situations in the history and evaluates them

Types

type FactCalculationJob

type FactCalculationJob struct {
	FactIds        []int64 `json:"factIds"`
	From           string  `json:"from,omitempty"`
	To             string  `json:"to,omitempty"`
	LastDailyValue bool    `json:"lastDailyValue,omitempty"`
	Debug          bool    `json:"debug"`
	ScheduleID     int64   `json:"-"`
}

FactCalculationJob represent a scheduler job instance which process a group of facts, and persist the result in postgresql It also generate situations, persists them and notify the rule engine to evaluate them

func NewFactCalculationJob

func NewFactCalculationJob(cronExpr string, factIds []int64) FactCalculationJob

NewFactCalculationJob returns a new isntance of FactCalculationJob

func (FactCalculationJob) IsValid

func (job FactCalculationJob) IsValid() (bool, error)

IsValid checks if an internal schedule job definition is valid and has no missing mandatory fields

func (*FactCalculationJob) ResolveFromAndTo

func (job *FactCalculationJob) ResolveFromAndTo(t time.Time) (time.Time, time.Time, error)

ResolveFromAndTo resolves the expressions in parameters From and To

func (FactCalculationJob) Run

func (job FactCalculationJob) Run()

Run contains all the business logic of the job

func (*FactCalculationJob) UnmarshalJSON

func (job *FactCalculationJob) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals a quoted json string to a valid FactCalculationJob struct

type InternalJob

type InternalJob interface {
	cron.Job
	IsValid() (bool, error)
}

InternalJob embed the external "standard" cron job with some additionnal data

func UnmarshalInternalJob

func UnmarshalInternalJob(t string, b json.RawMessage, scheduleID int64) (InternalJob, error)

UnmarshalInternalJob unmarshal a fact from a json string

type InternalSchedule

type InternalSchedule struct {
	ID       int64       `json:"id"`
	Name     string      `json:"name"`
	CronExpr string      `json:"cronexpr" example:"0 */15 * * *"`
	JobType  string      `json:"jobtype" enums:"fact,baseline"`
	Job      InternalJob `json:"job"`
}

InternalSchedule wrap a schedule

func (*InternalSchedule) IsValid

func (schedule *InternalSchedule) IsValid() (bool, error)

IsValid checks if an internal schedule definition is valid and has no missing mandatory fields

func (*InternalSchedule) UnmarshalJSON

func (schedule *InternalSchedule) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals a json object as a InternalSchedule

type InternalScheduler

type InternalScheduler struct {
	C    *cron.Cron
	Jobs map[int64]cron.EntryID

	RuleEngine chan string
	// contains filtered or unexported fields
}

InternalScheduler represents an instance of a scheduler used for fact processing

func NewScheduler

func NewScheduler() *InternalScheduler

NewScheduler returns a pointer to a new instance of InternalScheduler

func S

func S() *InternalScheduler

S is used to access the global fact scheduler singleton

func (*InternalScheduler) AddJobSchedule

func (s *InternalScheduler) AddJobSchedule(schedule InternalSchedule) error

AddJobSchedule add a new schedule to the current scheduler

func (*InternalScheduler) AddRunningJob

func (s *InternalScheduler) AddRunningJob(scheduleID int64)

AddRunningJob add a job ID to the running job list

func (*InternalScheduler) ExistingRunningJob

func (s *InternalScheduler) ExistingRunningJob(scheduleID int64) bool

ExistingRunningJob check if a job is already running

func (*InternalScheduler) Init

func (s *InternalScheduler) Init() error

Init loads the job schedules from Data Base

func (*InternalScheduler) RemoveJobSchedule

func (s *InternalScheduler) RemoveJobSchedule(scheduleID int64)

RemoveJobSchedule add a new job to the current scheduler

func (*InternalScheduler) RemoveRunningJob

func (s *InternalScheduler) RemoveRunningJob(scheduleID int64)

RemoveRunningJob remove a job ID to the running job list

type PostgresRepository

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

PostgresRepository is a repository containing the rules based on a PSQL database and implementing the repository interface

func (*PostgresRepository) Create

func (r *PostgresRepository) Create(schedule InternalSchedule) (int64, error)

Create creates a new schedule in the repository

func (*PostgresRepository) Delete

func (r *PostgresRepository) Delete(id int64) error

Delete deletes an entry from the repository by it's ID

func (*PostgresRepository) Get

func (r *PostgresRepository) Get(id int64) (InternalSchedule, bool, error)

Get search and returns a job schedule from the repository by its id

func (*PostgresRepository) GetAll

func (r *PostgresRepository) GetAll() (map[int64]InternalSchedule, error)

GetAll returns all job schedules in the repository

func (*PostgresRepository) Update

func (r *PostgresRepository) Update(schedule InternalSchedule) error

Update updates a schedule in the repository by its name

type Repository

type Repository interface {
	Create(schedule InternalSchedule) (int64, error)
	Get(id int64) (InternalSchedule, bool, error)
	Update(schedule InternalSchedule) error
	Delete(id int64) error
	GetAll() (map[int64]InternalSchedule, error)
}

Repository is a storage interface which can be implemented by multiple backend (in-memory map, sql database, in-memory cache, file system, ...) It allows standard CRUD operation on situations

func NewPostgresRepository

func NewPostgresRepository(dbClient *sqlx.DB) Repository

NewPostgresRepository returns a new instance of PostgresRulesRepository

func R

func R() Repository

R is used to access the global repository singleton