Pierre-Olivier Mercier
46901f23d0
Refactor observation data pipeline to serialize once after collection and keep json.RawMessage throughout storage and API responses. This eliminates double-serialization and makes DB round-trips lossless. Key changes: - ObservationGetter.Get() adopts json.Unmarshal semantics (dest any) - ObservationSnapshot.Data uses map[ObservationKey]json.RawMessage - Add freshness-based observation cache (ObservationCacheStorage) that stores lightweight snapshot pointers, enabling cross-checker reuse of recent observations without re-collecting
121 lines
5.8 KiB
Go
121 lines
5.8 KiB
Go
// This file is part of the happyDomain (R) project.
|
|
// Copyright (c) 2020-2025 happyDomain
|
|
// Authors: Pierre-Olivier Mercier, et al.
|
|
//
|
|
// This program is offered under a commercial and under the AGPL license.
|
|
// For commercial licensing, contact us at <contact@happydomain.org>.
|
|
//
|
|
// For AGPL licensing:
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Affero General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Affero General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Affero General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
package checker
|
|
|
|
import (
|
|
"time"
|
|
|
|
"git.happydns.org/happyDomain/model"
|
|
)
|
|
|
|
// SchedulerStateStorage provides persistence for scheduler state (e.g. last run time).
|
|
type SchedulerStateStorage interface {
|
|
GetLastSchedulerRun() (time.Time, error)
|
|
SetLastSchedulerRun(t time.Time) error
|
|
}
|
|
|
|
// DomainLister is the minimal interface needed by the scheduler to enumerate domains.
|
|
type DomainLister interface {
|
|
ListAllDomains() (happydns.Iterator[happydns.Domain], error)
|
|
}
|
|
|
|
// ZoneGetter is the minimal interface needed by the scheduler to load zones for service discovery.
|
|
type ZoneGetter interface {
|
|
GetZone(id happydns.Identifier) (*happydns.ZoneMessage, error)
|
|
}
|
|
|
|
// CheckAutoFillStorage provides access to domain, zone and user data
|
|
// needed to resolve auto-fill field values at execution time.
|
|
type CheckAutoFillStorage interface {
|
|
GetDomain(id happydns.Identifier) (*happydns.Domain, error)
|
|
GetZone(id happydns.Identifier) (*happydns.ZoneMessage, error)
|
|
ListDomains(u *happydns.User) ([]*happydns.Domain, error)
|
|
GetUser(id happydns.Identifier) (*happydns.User, error)
|
|
}
|
|
|
|
// CheckPlanStorage provides persistence for CheckPlan entities.
|
|
type CheckPlanStorage interface {
|
|
ListAllCheckPlans() (happydns.Iterator[happydns.CheckPlan], error)
|
|
ListCheckPlansByTarget(target happydns.CheckTarget) ([]*happydns.CheckPlan, error)
|
|
ListCheckPlansByChecker(checkerID string) ([]*happydns.CheckPlan, error)
|
|
ListCheckPlansByUser(userId happydns.Identifier) ([]*happydns.CheckPlan, error)
|
|
GetCheckPlan(planID happydns.Identifier) (*happydns.CheckPlan, error)
|
|
CreateCheckPlan(plan *happydns.CheckPlan) error
|
|
UpdateCheckPlan(plan *happydns.CheckPlan) error
|
|
DeleteCheckPlan(planID happydns.Identifier) error
|
|
ClearCheckPlans() error
|
|
}
|
|
|
|
// CheckerOptionsStorage provides persistence for checker options at different levels.
|
|
type CheckerOptionsStorage interface {
|
|
ListAllCheckerConfigurations() (happydns.Iterator[happydns.CheckerOptions], error)
|
|
ListCheckerConfiguration(checkerName string) ([]*happydns.CheckerOptionsPositional, error)
|
|
GetCheckerConfiguration(checkerName string, userId *happydns.Identifier, domainId *happydns.Identifier, serviceId *happydns.Identifier) ([]*happydns.CheckerOptionsPositional, error)
|
|
UpdateCheckerConfiguration(checkerName string, userId *happydns.Identifier, domainId *happydns.Identifier, serviceId *happydns.Identifier, opts happydns.CheckerOptions) error
|
|
DeleteCheckerConfiguration(checkerName string, userId *happydns.Identifier, domainId *happydns.Identifier, serviceId *happydns.Identifier) error
|
|
ClearCheckerConfigurations() error
|
|
}
|
|
|
|
// CheckEvaluationStorage provides persistence for check evaluation results.
|
|
type CheckEvaluationStorage interface {
|
|
ListEvaluationsByPlan(planID happydns.Identifier) ([]*happydns.CheckEvaluation, error)
|
|
ListEvaluationsByChecker(checkerID string, target happydns.CheckTarget, limit int) ([]*happydns.CheckEvaluation, error)
|
|
GetEvaluation(evalID happydns.Identifier) (*happydns.CheckEvaluation, error)
|
|
GetLatestEvaluation(planID happydns.Identifier) (*happydns.CheckEvaluation, error)
|
|
CreateEvaluation(eval *happydns.CheckEvaluation) error
|
|
DeleteEvaluation(evalID happydns.Identifier) error
|
|
DeleteEvaluationsByChecker(checkerID string, target happydns.CheckTarget) error
|
|
ClearEvaluations() error
|
|
}
|
|
|
|
// ExecutionStorage provides persistence for execution records.
|
|
type ExecutionStorage interface {
|
|
ListExecutionsByPlan(planID happydns.Identifier) ([]*happydns.Execution, error)
|
|
ListExecutionsByChecker(checkerID string, target happydns.CheckTarget, limit int) ([]*happydns.Execution, error)
|
|
ListExecutionsByUser(userId happydns.Identifier, limit int) ([]*happydns.Execution, error)
|
|
GetExecution(execID happydns.Identifier) (*happydns.Execution, error)
|
|
CreateExecution(exec *happydns.Execution) error
|
|
UpdateExecution(exec *happydns.Execution) error
|
|
DeleteExecution(execID happydns.Identifier) error
|
|
DeleteExecutionsByChecker(checkerID string, target happydns.CheckTarget) error
|
|
ClearExecutions() error
|
|
}
|
|
|
|
// PlannedJobProvider exposes upcoming scheduler jobs from the in-memory queue.
|
|
type PlannedJobProvider interface {
|
|
GetPlannedJobsForChecker(checkerID string, target happydns.CheckTarget) []*SchedulerJob
|
|
}
|
|
|
|
// ObservationSnapshotStorage provides persistence for observation snapshots.
|
|
type ObservationSnapshotStorage interface {
|
|
GetSnapshot(snapID happydns.Identifier) (*happydns.ObservationSnapshot, error)
|
|
CreateSnapshot(snap *happydns.ObservationSnapshot) error
|
|
DeleteSnapshot(snapID happydns.Identifier) error
|
|
ClearSnapshots() error
|
|
}
|
|
|
|
// ObservationCacheStorage provides a lightweight cache mapping (target, observation key)
|
|
// to the snapshot that holds the most recent data.
|
|
type ObservationCacheStorage interface {
|
|
GetCachedObservation(target happydns.CheckTarget, key happydns.ObservationKey) (*happydns.ObservationCacheEntry, error)
|
|
PutCachedObservation(target happydns.CheckTarget, key happydns.ObservationKey, entry *happydns.ObservationCacheEntry) error
|
|
}
|