1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
package marketpresence
import (
"cmp"
"context"
"errors"
"fmt"
"log/slog"
"reflect"
"strings"
"time"
"github.com/bluesky-social/indigo/atproto/syntax"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
commonv1 "github.com/johnandersen777/socialweb-computer-kcp/api/common/v1alpha1"
"github.com/johnandersen777/socialweb-computer-kcp/api/v1alpha1"
"github.com/johnandersen777/socialweb-computer-kcp/internal/atproto/market"
ctlruntime "github.com/johnandersen777/socialweb-computer-kcp/internal/controllers/runtime"
"github.com/johnandersen777/socialweb-computer-kcp/internal/kit/binding"
"github.com/johnandersen777/socialweb-computer-kcp/internal/kit/conds"
"github.com/johnandersen777/socialweb-computer-kcp/internal/kit/opt"
presence "github.com/johnandersen777/socialweb-computer-kcp/internal/marketpresence"
)
const (
Name = "marketpresence"
Export = "applications"
BidderKind = "Bidder"
ConditionReady = "Ready"
ConditionBidderReady = "BidderReady"
ConditionHeartbeat = "Heartbeat"
DefaultRefresh = time.Minute
)
var errOtherWorkspace = errors.New("the bidderRef names another workspace and no cross-workspace Bidder reader is configured")
type Heartbeats interface {
Observe(ctx context.Context, q presence.Query) presence.Observation
}
type Bidders interface {
Get(ctx context.Context, workspace, name string) (*v1alpha1.Bidder, error)
}
var _ Heartbeats = (*presence.Heartbeats)(nil)
type Options struct {
Heartbeats Heartbeats
Bidders Bidders
Scope func(workspace string) bool
Refresh time.Duration
Now func() time.Time
Log *slog.Logger
}
type Controller struct {
heartbeats Heartbeats
bidders Bidders
refresh time.Duration
now func() time.Time
log *slog.Logger
refs *binding.Table[struct{}]
}
func New(opts Options) (*Controller, error) {
if opts.Heartbeats == nil {
return nil, errors.New("marketpresence: a heartbeat reader is required")
}
log := opts.Log
if log == nil {
log = slog.New(slog.DiscardHandler)
}
now := opts.Now
if now == nil {
now = time.Now
}
return &Controller{heartbeats: opts.Heartbeats, bidders: opts.Bidders, refresh: ctlruntime.Period(opts.Refresh, DefaultRefresh), now: now,
log: log.With("component", "marketpresence-controller"), refs: binding.New[struct{}]()}, nil
}
func Register(m *ctlruntime.Manager, opts Options) (*Controller, error) {
if err := m.AddToScheme(v1alpha1.AddToScheme); err != nil {
return nil, err
}
ctl, err := New(opts)
if err != nil {
return nil, err
}
options := []ctlruntime.Option{ctlruntime.Export(Export), ctlruntime.Watches(ctl.presencesOf), ctlruntime.Gone(ctl.gone)}
if opts.Scope != nil {
options = append(options, ctlruntime.InWorkspaces(opts.Scope))
}
if err := ctlruntime.For[*v1alpha1.MarketPresence](m, Name, ctl, options...); err != nil {
return nil, fmt.Errorf("marketpresence: registering the MarketPresence controller: %w", err)
}
return ctl, nil
}
func (c *Controller) presencesOf(_ context.Context, src ctlruntime.Request, obj *v1alpha1.Bidder) []ctlruntime.Request {
derived := presence.PresenceName(obj.Name)
out := []ctlruntime.Request{{Cluster: src.Cluster, Workspace: src.Workspace, Name: derived}}
for _, t := range c.refs.Users(binding.Key(src.Workspace, BidderKind, obj.Name)) {
if t.Cluster == src.Cluster && t.Name == derived {
continue
}
out = append(out, ctlruntime.Request{Cluster: t.Cluster, Workspace: t.Workspace, Name: t.Name})
}
return out
}
func (c *Controller) Reconcile(ctx context.Context, req ctlruntime.Request, object *v1alpha1.MarketPresence) (ctlruntime.Result, error) {
target := binding.Target{Cluster: req.Cluster, Workspace: req.Workspace, Name: req.Name}
if !object.DeletionTimestamp.IsZero() {
c.refs.Set(target, nil)
return ctlruntime.Result{}, nil
}
ref := object.Spec.BidderRef
workspace := cmp.Or(strings.TrimSpace(ref.Workspace), req.Workspace)
kind := cmp.Or(strings.TrimSpace(ref.Kind), BidderKind)
bidderName := strings.TrimSpace(ref.Name)
c.refs.Set(target, &struct{}{}, binding.Key(workspace, kind, bidderName))
gen := object.Generation
status := object.Status
status.Conditions = append([]metav1.Condition(nil), object.Status.Conditions...)
status.ObservedGeneration = gen
if !strings.EqualFold(kind, BidderKind) || bidderName == "" {
message := "the bidderRef must name a Bidder"
conds.Set(&status.Conditions, gen, ConditionBidderReady, false, "BidderRefInvalid", message)
expire(&status, gen, "BidderRefInvalid", message)
return ctlruntime.Result{}, c.apply(ctx, req, object, status)
}
bidder, err := c.bidder(ctx, req, workspace, bidderName)
switch {
case apierrors.IsNotFound(err):
if workspace == req.Workspace && ownedBy(object, bidderName) {
c.log.Info("a MarketPresence goes with its gone Bidder", "workspace", req.Workspace, "marketpresence", req.Name)
return ctlruntime.Result{}, req.Delete(ctx, object)
}
message := "the Bidder named by the MarketPresence does not exist"
conds.Set(&status.Conditions, gen, ConditionBidderReady, false, "BidderMissing", message)
expire(&status, gen, "BidderMissing", message)
return ctlruntime.Result{}, c.apply(ctx, req, object, status)
case errors.Is(err, errOtherWorkspace):
conds.Set(&status.Conditions, gen, ConditionBidderReady, false, "BidderUnreadable", err.Error())
expire(&status, gen, "BidderUnreadable", err.Error())
return ctlruntime.Result{}, c.apply(ctx, req, object, status)
case err != nil:
message := "the Bidder named by the MarketPresence could not be read"
conds.Set(&status.Conditions, gen, ConditionBidderReady, false, "BidderUnreadable", message)
expire(&status, gen, "BidderUnreadable", message)
return ctlruntime.Result{}, errors.Join(fmt.Errorf("marketpresence: reading the Bidder %s/%s: %w", workspace, bidderName, err),
c.apply(ctx, req, object, status))
}
bidderReady, phase := readiness(bidder)
if bidderReady {
conds.Set(&status.Conditions, gen, ConditionBidderReady, true, "BidderReady", "the Bidder reports Ready")
} else {
message := "the Bidder is not Ready"
if phase != "" && phase != string(v1alpha1.ComponentPhaseReady) {
message = "the Bidder is " + phase
}
conds.Set(&status.Conditions, gen, ConditionBidderReady, false, "BidderNotReady", message)
}
offering := strings.TrimSpace(object.Spec.OfferingURI)
did := bidderDID(bidder)
if offering != "" {
aturi, err := syntax.ParseATURI(offering)
if err != nil || aturi.Collection() == "" || aturi.RecordKey() == "" {
expire(&status, gen, "OfferingInvalid", "spec.offeringUri is not an atproto record URI")
return ctlruntime.Result{}, c.apply(ctx, req, object, status)
}
if did == "" {
did = string(aturi.Authority())
}
}
now := c.now().UTC()
ttl := opt.Positive(time.Duration(object.Spec.TtlSeconds)*time.Second, market.HeartbeatTTL)
plc := ""
if bidder.Spec.Network != nil {
plc = bidder.Spec.Network.PLCDirectoryURL
}
observed := c.heartbeats.Observe(ctx, presence.Query{DID: did, OfferingURI: offering, PLCDirectoryURL: plc, Now: now})
last := status.LastHeartbeatAt
if !observed.At.IsZero() {
if prior, err := time.Parse(time.RFC3339, last); err != nil || observed.At.After(prior) {
last = observed.At.UTC().Format(time.RFC3339)
}
}
status.LastHeartbeatAt = last
fresh := false
if at, err := time.Parse(time.RFC3339, last); err == nil {
age := now.Sub(at)
fresh = age >= -market.HeartbeatMaxSkew && age <= ttl
}
switch {
case !observed.At.IsZero():
conds.Set(&status.Conditions, gen, ConditionHeartbeat, true, "HeartbeatFresh", "the market heartbeat is readable")
case fresh:
conds.Set(&status.Conditions, gen, ConditionHeartbeat, true, "HeartbeatCached",
"the market heartbeat is unreadable; the last observed heartbeat is within the TTL")
default:
conds.Set(&status.Conditions, gen, ConditionHeartbeat, false, observed.Reason, "no fresh market heartbeat is readable")
}
status.Phase = v1alpha1.MarketPresencePhaseExpired
status.Ready = false
switch {
case bidderReady && fresh:
status.Phase = v1alpha1.MarketPresencePhaseActive
status.Ready = true
conds.Set(&status.Conditions, gen, ConditionReady, true, "Active", "the Bidder is Ready and its heartbeat is within the TTL")
case !fresh && last != "":
conds.Set(&status.Conditions, gen, ConditionReady, false, "HeartbeatExpired", "the last market heartbeat is older than ttlSeconds")
case !fresh:
conds.Set(&status.Conditions, gen, ConditionReady, false, observed.Reason, "no fresh market heartbeat is readable")
default:
conds.Set(&status.Conditions, gen, ConditionReady, false, "BidderNotReady", "the Bidder is not Ready")
}
if err := c.apply(ctx, req, object, status); err != nil {
return ctlruntime.Result{}, err
}
if did == "" {
return ctlruntime.Result{}, nil
}
return ctlruntime.RefreshAfter(c.refresh), nil
}
func (c *Controller) gone(ctx context.Context, req ctlruntime.Request) {
c.refs.Set(binding.Target{Cluster: req.Cluster, Workspace: req.Workspace, Name: req.Name}, nil)
if !strings.HasPrefix(req.Name, "bidder-") {
return
}
bidder, err := c.derivedBidder(ctx, req)
if err != nil {
c.log.Warn("finding the Bidder of a missing MarketPresence", "workspace", req.Workspace, "marketpresence", req.Name, "err", err.Error())
return
}
if bidder == nil {
return
}
referenced, err := c.referenced(ctx, req, bidder.Name)
if err != nil {
c.log.Warn("listing the MarketPresences of a Bidder", "workspace", req.Workspace, "bidder", bidder.Name, "err", err.Error())
return
}
if referenced {
return
}
owner := metav1.OwnerReference{APIVersion: v1alpha1.GroupVersion.String(), Kind: BidderKind, Name: bidder.Name, UID: bidder.UID}
next := &v1alpha1.MarketPresence{
ObjectMeta: metav1.ObjectMeta{Name: req.Name, OwnerReferences: []metav1.OwnerReference{owner}},
Spec: v1alpha1.MarketPresenceSpec{
BidderRef: commonv1.ObjectRef{Workspace: req.Workspace, Kind: BidderKind, Name: bidder.Name},
TtlSeconds: int(market.HeartbeatTTL.Seconds()),
},
}
if err := req.Apply(ctx, next); err != nil {
c.log.Warn("applying the MarketPresence of a Bidder", "workspace", req.Workspace, "bidder", bidder.Name, "err", err.Error())
return
}
c.log.Info("a MarketPresence follows its Bidder", "workspace", req.Workspace, "bidder", bidder.Name, "marketpresence", req.Name)
}
func (c *Controller) derivedBidder(ctx context.Context, req ctlruntime.Request) (*v1alpha1.Bidder, error) {
var list v1alpha1.BidderList
if err := req.List(ctx, &list); err != nil {
return nil, err
}
for i := range list.Items {
item := &list.Items[i]
if presence.PresenceName(item.Name) == req.Name && item.DeletionTimestamp.IsZero() {
return item, nil
}
}
return nil, nil
}
func (c *Controller) referenced(ctx context.Context, req ctlruntime.Request, bidderName string) (bool, error) {
if len(c.refs.Users(binding.Key(req.Workspace, BidderKind, bidderName))) > 0 {
return true, nil
}
var list v1alpha1.MarketPresenceList
if err := req.List(ctx, &list); err != nil {
return false, err
}
for i := range list.Items {
ref := list.Items[i].Spec.BidderRef
if cmp.Or(strings.TrimSpace(ref.Workspace), req.Workspace) == req.Workspace &&
strings.EqualFold(cmp.Or(strings.TrimSpace(ref.Kind), BidderKind), BidderKind) && strings.TrimSpace(ref.Name) == bidderName {
return true, nil
}
}
return false, nil
}
func (c *Controller) bidder(ctx context.Context, req ctlruntime.Request, workspace, name string) (*v1alpha1.Bidder, error) {
if workspace != req.Workspace {
if c.bidders == nil {
return nil, errOtherWorkspace
}
return c.bidders.Get(ctx, workspace, name)
}
var bidder v1alpha1.Bidder
if err := req.Get(ctx, "", name, &bidder); err != nil {
return nil, err
}
return &bidder, nil
}
func (c *Controller) apply(ctx context.Context, req ctlruntime.Request, object *v1alpha1.MarketPresence, status v1alpha1.MarketPresenceStatus) error {
if reflect.DeepEqual(object.Status, status) {
return nil
}
next := object.DeepCopy()
next.Status = status
if err := req.ApplyStatus(ctx, next); err != nil {
return err
}
if object.Status.Phase != status.Phase || object.Status.Ready != status.Ready {
c.log.Info("market presence", "workspace", req.Workspace, "marketpresence", req.Name, "phase", string(status.Phase),
"ready", status.Ready, "lastHeartbeatAt", status.LastHeartbeatAt)
}
return nil
}
func expire(status *v1alpha1.MarketPresenceStatus, gen int64, reason, message string) {
status.Phase = v1alpha1.MarketPresencePhaseExpired
status.Ready = false
conds.Set(&status.Conditions, gen, ConditionReady, false, reason, message)
conds.Set(&status.Conditions, gen, ConditionHeartbeat, false, reason, message)
}
func ownedBy(object *v1alpha1.MarketPresence, bidder string) bool {
for _, owner := range object.OwnerReferences {
if owner.Kind == BidderKind && owner.Name == bidder && strings.HasPrefix(owner.APIVersion, v1alpha1.GroupName+"/") {
return true
}
}
return false
}
func readiness(bidder *v1alpha1.Bidder) (bool, string) {
phase := string(bidder.Status.Phase)
if phase != "" && phase != string(v1alpha1.ComponentPhaseReady) {
return false, phase
}
return bidder.Status.Ready, phase
}
func bidderDID(bidder *v1alpha1.Bidder) string {
if bidder.Spec.Identity == nil {
return ""
}
return strings.TrimSpace(bidder.Spec.Identity.Did)
}