mirror of
https://github.com/open-policy-agent/opa.git
synced 2026-08-17 22:13:00 -06:00
Bryan Fulton
8ed2f899d1
OPA has support for Delta Bundles. The status object already contains valuable information such as last activation timestamp and the type e.g., snapshot vs delta. This change updates the bundle.Status object to include the bundle size. This can be useful for status endpoints to differentiate between the sizes of snapshot vs delta bundles. Issue: 4477 Signed-off-by: Bryan Fulton <bryan@styra.com>
96 lines
2.8 KiB
Go
96 lines
2.8 KiB
Go
// Copyright 2018 The OPA Authors. All rights reserved.
|
|
// Use of this source code is governed by an Apache2
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package bundle
|
|
|
|
import (
|
|
"encoding/json"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/open-policy-agent/opa/ast"
|
|
"github.com/open-policy-agent/opa/download"
|
|
"github.com/open-policy-agent/opa/metrics"
|
|
"github.com/open-policy-agent/opa/server/types"
|
|
)
|
|
|
|
const (
|
|
errCode = "bundle_error"
|
|
)
|
|
|
|
// Status represents the status of processing a bundle.
|
|
type Status struct {
|
|
Name string `json:"name"`
|
|
ActiveRevision string `json:"active_revision,omitempty"`
|
|
LastSuccessfulActivation time.Time `json:"last_successful_activation,omitempty"`
|
|
Type string `json:"type,omitempty"`
|
|
Size int `json:"size,omitempty"`
|
|
LastSuccessfulDownload time.Time `json:"last_successful_download,omitempty"`
|
|
LastSuccessfulRequest time.Time `json:"last_successful_request,omitempty"`
|
|
LastRequest time.Time `json:"last_request,omitempty"`
|
|
Code string `json:"code,omitempty"`
|
|
Message string `json:"message,omitempty"`
|
|
Errors []error `json:"errors,omitempty"`
|
|
Metrics metrics.Metrics `json:"metrics,omitempty"`
|
|
HTTPCode json.Number `json:"http_code,omitempty"`
|
|
}
|
|
|
|
// SetActivateSuccess updates the status object to reflect a successful
|
|
// activation.
|
|
func (s *Status) SetActivateSuccess(revision string) {
|
|
s.LastSuccessfulActivation = time.Now().UTC()
|
|
s.ActiveRevision = revision
|
|
}
|
|
|
|
// SetDownloadSuccess updates the status object to reflect a successful
|
|
// download.
|
|
func (s *Status) SetDownloadSuccess() {
|
|
s.LastSuccessfulDownload = time.Now().UTC()
|
|
}
|
|
|
|
// SetRequest updates the status object to reflect a download attempt.
|
|
func (s *Status) SetRequest() {
|
|
s.LastRequest = time.Now().UTC()
|
|
}
|
|
|
|
func (s *Status) SetBundleSize(size int) {
|
|
s.Size = size
|
|
}
|
|
|
|
// SetError updates the status object to reflect a failure to download or
|
|
// activate. If err is nil, the error status is cleared.
|
|
func (s *Status) SetError(err error) {
|
|
|
|
if err == nil {
|
|
s.Code = ""
|
|
s.HTTPCode = ""
|
|
s.Message = ""
|
|
s.Errors = nil
|
|
return
|
|
}
|
|
|
|
switch cause := errors.Cause(err).(type) {
|
|
case ast.Errors:
|
|
s.Code = errCode
|
|
s.HTTPCode = ""
|
|
s.Message = types.MsgCompileModuleError
|
|
s.Errors = make([]error, len(cause))
|
|
for i := range cause {
|
|
s.Errors[i] = cause[i]
|
|
}
|
|
case download.HTTPError:
|
|
s.Code = errCode
|
|
s.HTTPCode = json.Number(strconv.Itoa(cause.StatusCode))
|
|
s.Message = err.Error()
|
|
s.Errors = nil
|
|
default:
|
|
s.Code = errCode
|
|
s.HTTPCode = ""
|
|
s.Message = err.Error()
|
|
s.Errors = nil
|
|
}
|
|
}
|