Refactor names and add bulk handling of available rollbacks

Author: pchila

internal/pkg/api/handleCheckin.go

@@ -22,8 +22,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/dustin/go-humanize"
-
 	"github.com/elastic/fleet-server/v7/internal/pkg/action"
 	"github.com/elastic/fleet-server/v7/internal/pkg/bulk"
 	"github.com/elastic/fleet-server/v7/internal/pkg/cache"
@@ -169,13 +167,13 @@ func invalidateAPIKeysOfInactiveAgent(ctx context.Context, zlog zerolog.Logger,
 
 // validatedCheckin is a struct to wrap all the things that validateRequest returns.
 type validatedCheckin struct {
-	req             *CheckinRequest
-	dur             time.Duration
-	rawMeta         []byte
-	rawComp         []byte
-	seqno           sqn.SeqNo
-	unhealthyReason *[]string
-	rawRollbacks    []byte
+	req                   *CheckinRequest
+	dur                   time.Duration
+	rawMeta               []byte
+	rawComp               []byte
+	seqno                 sqn.SeqNo
+	unhealthyReason       *[]string
+	rawAvailableRollbacks []byte
 }
 
 func (ct *CheckinT) validateRequest(zlog zerolog.Logger, w http.ResponseWriter, r *http.Request, start time.Time, agent *model.Agent) (validatedCheckin, error) {
@@ -254,19 +252,19 @@ func (ct *CheckinT) validateRequest(zlog zerolog.Logger, w http.ResponseWriter,
 		return val, err
 	}
 
-	rawRollbacks, err := parseRollbacks(zlog, agent, &req)
+	rawRollbacks, err := parseAvailableRollbacks(zlog, agent, &req)
 	if err != nil {
 		return val, err
 	}
 
 	return validatedCheckin{
-		req:             &req,
-		dur:             pollDuration,
-		rawMeta:         rawMeta,
-		rawComp:         rawComponents,
-		seqno:           seqno,
-		unhealthyReason: unhealthyReason,
-		rawRollbacks:    rawRollbacks,
+		req:                   &req,
+		dur:                   pollDuration,
+		rawMeta:               rawMeta,
+		rawComp:               rawComponents,
+		seqno:                 seqno,
+		unhealthyReason:       unhealthyReason,
+		rawAvailableRollbacks: rawRollbacks,
 	}, nil
 }
 
@@ -299,7 +297,7 @@ func (ct *CheckinT) ProcessRequest(zlog zerolog.Logger, w http.ResponseWriter, r
 		checkin.WithVer(ver),
 		checkin.WithUnhealthyReason(unhealthyReason),
 		checkin.WithDeleteAudit(agent.AuditUnenrolledReason != "" || agent.UnenrolledAt != ""),
-		checkin.WithRollbacks(req.Rollbacks),
+		checkin.WithAvailableRollbacks(validated.rawAvailableRollbacks),
 	}
 
 	revID, opts, err := ct.processPolicyDetails(r.Context(), zlog, agent, req)
@@ -1142,34 +1140,33 @@ func parseComponents(zlog zerolog.Logger, agent *model.Agent, req *CheckinReques
 	return outComponents, &unhealthyReason, nil
 }
 
-func parseRollbacks(zlog zerolog.Logger, agent *model.Agent, req *CheckinRequest) ([]byte, error) {
-	if req.Rollbacks == nil && agent.Rollbacks == nil {
-		return nil, nil
-	}
-
-	var reqRollbacks []model.Rollback
-	if req.Rollbacks != nil {
-		reqRollbacks = make([]model.Rollback, len(*req.Rollbacks))
-		for i, rr := range *req.Rollbacks {
-			reqRollbacks[i] = model.Rollback{
+func parseAvailableRollbacks(zlog zerolog.Logger, agent *model.Agent, req *CheckinRequest) ([]byte, error) {
+	var reqRollbacks []model.AvailableRollback
+	if req.AvailableRollbacks != nil {
+		reqRollbacks = make([]model.AvailableRollback, len(*req.AvailableRollbacks))
+		for i, rr := range *req.AvailableRollbacks {
+			reqRollbacks[i] = model.AvailableRollback{
 				ValidUntil: rr.ValidUntil.UTC().Format(time.RFC3339),
 				Version:    rr.Version,
 			}
 		}
+	} else {
+		// still set an empty slice in order to clear obsolete information, if any
+		reqRollbacks = []model.AvailableRollback{}
 	}
 
 	var outRollbacks []byte
 	// Compare the deserialized meta structures and return the bytes to update if different
-	if !reflect.DeepEqual(reqRollbacks, agent.Rollbacks) {
+	if !reflect.DeepEqual(reqRollbacks, agent.AvailableRollbacks) {
 		zlog.Trace().
-			Any("oldRollbacks", agent.Rollbacks).
-			Any("req.Rollbacks", req.Rollbacks).
+			Any("oldAvailableRollbacks", agent.AvailableRollbacks).
+			Any("req.AvailableRollbacks", req.AvailableRollbacks).
 			Msg("available rollback data is not equal")
 
 		zlog.Info().Msg("applying new rollback data")
 		marshalled, err := json.Marshal(reqRollbacks)
 		if err != nil {
-			return nil, fmt.Errorf("marshalling rollbacks: %w", err)
+			return nil, fmt.Errorf("marshalling available rollbacks: %w", err)
 		}
 		outRollbacks = marshalled
 	}

internal/pkg/api/openapi.gen.go

@@ -6,7 +6,6 @@
 package checkin
 
 import (
-	"bytes"
 	"context"
 	_ "embed"
 	"encoding/json"
@@ -15,7 +14,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/elastic/fleet-server/v7/internal/pkg/api"
 	"github.com/elastic/fleet-server/v7/internal/pkg/bulk"
 	"github.com/elastic/fleet-server/v7/internal/pkg/dl"
 	"github.com/elastic/fleet-server/v7/internal/pkg/sqn"
@@ -127,29 +125,22 @@ func WithPolicyRevisionIDX(idx int64) Option {
 	}
 }
 
-func WithRollbacks(rollbacks *api.AvailableRollbacks) Option {
+func WithAvailableRollbacks(availableRollbacks []byte) Option {
 	return func(pending *pendingT) {
 		if pending.extra == nil {
 			pending.extra = &extraT{}
 		}
-		if rollbacks == nil {
-			pending.extra.rollbacks = nil
-			return
-		}
-		// FIXME this should be done in the validated checkin
-		buf := bytes.NewBuffer(nil)
-		json.
-			pending.extra.rollbacks = rollbacks
+		pending.extra.availableRollbacks = availableRollbacks
 	}
 }
 
 type extraT struct {
-	meta        []byte
-	seqNo       sqn.SeqNo
-	ver         string
-	components  []byte
-	deleteAudit bool
-	rollbacks   []byte
+	meta               []byte
+	seqNo              sqn.SeqNo
+	ver                string
+	components         []byte
+	deleteAudit        bool
+	availableRollbacks []byte
 }
 
 // Minimize the size of this structure.
@@ -377,6 +368,10 @@ func toUpdateBody(now string, pending pendingT) ([]byte, error) {
 		if pending.extra.seqNo.IsSet() {
 			fields[dl.FieldActionSeqNo] = pending.extra.seqNo
 		}
+
+		if pending.extra.availableRollbacks != nil {
+			fields[dl.FieldAvailableRollbacks] = json.RawMessage(pending.extra.availableRollbacks)
+		}
 	}
 	return fields.Marshal()
 }

internal/pkg/checkin/bulk.go

@@ -45,17 +45,17 @@ const (
 	FieldUnenrolledReason              = "unenrolled_reason"
 	FiledType                          = "type"
 	FieldUnhealthyReason               = "unhealthy_reason"
-
-	FieldActive           = "active"
-	FieldNamespaces       = "namespaces"
-	FieldTags             = "tags"
-	FieldUpdatedAt        = "updated_at"
-	FieldUnenrolledAt     = "unenrolled_at"
-	FieldUpgradedAt       = "upgraded_at"
-	FieldUpgradeStartedAt = "upgrade_started_at"
-	FieldUpgradeStatus    = "upgrade_status"
-	FieldUpgradeDetails   = "upgrade_details"
-	FieldUpgradeAttempts  = "upgrade_attempts"
+	FieldAvailableRollbacks            = "available_rollbacks"
+	FieldActive                        = "active"
+	FieldNamespaces                    = "namespaces"
+	FieldTags                          = "tags"
+	FieldUpdatedAt                     = "updated_at"
+	FieldUnenrolledAt                  = "unenrolled_at"
+	FieldUpgradedAt                    = "upgraded_at"
+	FieldUpgradeStartedAt              = "upgrade_started_at"
+	FieldUpgradeStatus                 = "upgrade_status"
+	FieldUpgradeDetails                = "upgrade_details"
+	FieldUpgradeAttempts               = "upgrade_attempts"
 
 	FieldAuditUnenrolledTime   = "audit_unenrolled_time"
 	FieldAuditUnenrolledReason = "audit_unenrolled_reason"

internal/pkg/dl/constants.go

@@ -448,7 +448,7 @@ components:
             The revision of the policy that the agent is currently running.
           type: integer
           format: int64
-        rollbacks:
+        available_rollbacks:
           $ref: "#/components/schemas/available_rollbacks"
     actionSignature:
       description: Optional action signing data.

internal/pkg/model/schema.go

@@ -732,7 +732,7 @@
           "description": "hash of token provided during enrollment that allows replacement by another enrollment with same ID",
           "type": "string"
         },
-        "rollbacks": {
+        "available_rollbacks": {
           "description": "list of available rollbacks for the agent",
           "type": "array",
           "items": {