-
Notifications
You must be signed in to change notification settings - Fork 9
/
actions.go
708 lines (585 loc) · 16.6 KB
/
actions.go
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
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
// Copyright 2022 Namespace Labs Inc; All rights reserved.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
package tasks
import (
"context"
"encoding/json"
"errors"
"fmt"
"time"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/trace"
statuscodes "google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"namespacelabs.dev/foundation/schema"
"namespacelabs.dev/foundation/schema/storage"
"namespacelabs.dev/foundation/std/tasks/protocol"
"namespacelabs.dev/go-ids"
)
type ActionState string
// Globally keeps track of all running actions in order to be able to reconstruct action trace for errors.
var runningActionsSink = NewStatefulSink(nil, false)
var ActionStorer func(*RunningAction)
const (
ActionCreated = "fn.action.created"
ActionWaiting = "fn.action.waiting"
ActionRunning = "fn.action.running"
ActionDone = "fn.action.done"
ActionInstant = "fn.action.instant"
)
func (a ActionState) IsRunning() bool { return a == ActionWaiting || a == ActionRunning }
func (a ActionState) IsDone() bool { return a == ActionDone || a == ActionInstant }
type OnDoneFunc func(*protocol.Task)
type ActionID string
func (a ActionID) String() string { return string(a) }
type EventData struct {
ActionID ActionID
ParentID ActionID
AnchorID ActionID // This action represents "waiting" on the action represented by `anchorID`.
SpanID string
State ActionState
Name string
HumanReadable string // If not set, name is used.
Category string
Created time.Time
Started time.Time
Completed time.Time
Arguments []ActionArgument
Scope schema.PackageList
Level int
HasPrivateData bool
Indefinite bool
Err error
}
func (ev *EventData) Proto() *protocol.Task {
return makeProto(ev, nil)
}
type ActionEvent struct {
data EventData
progress ActionProgress
onDone OnDoneFunc
}
type ResultData struct {
Items []*ActionArgument
Progress ActionProgress
}
type RunningAction struct {
Data EventData
Progress ActionProgress
sink ActionSink
span trace.Span
attachments *EventAttachments
onDone OnDoneFunc
}
type ActionArgument struct {
Name string
Msg interface{}
}
func allocEvent() *ActionEvent {
return &ActionEvent{}
}
func Action(name string) *ActionEvent {
ev := allocEvent()
ev.data.Name = name
ev.data.State = ActionCreated
return ev
}
func (ev *ActionEvent) HumanReadablef(label string, args ...interface{}) *ActionEvent {
if len(args) == 0 {
ev.data.HumanReadable = label
} else {
ev.data.HumanReadable = fmt.Sprintf(label, args...)
}
return ev
}
func (ev *ActionEvent) OnDone(f OnDoneFunc) *ActionEvent {
ev.onDone = f
return ev
}
func (ev *ActionEvent) ID(id ActionID) *ActionEvent {
ev.data.ActionID = id
return ev
}
func (ev *ActionEvent) Anchor(id ActionID) *ActionEvent {
ev.data.AnchorID = id
return ev
}
func (ev *ActionEvent) StartTimestamp(ts time.Time) *ActionEvent {
ev.data.Started = ts
return ev
}
func (ev *ActionEvent) Category(category string) *ActionEvent {
ev.data.Category = category
return ev
}
func (ev *ActionEvent) Parent(tid ActionID) *ActionEvent {
ev.data.ParentID = tid
return ev
}
func (ev *ActionEvent) Scope(pkgs ...schema.PackageName) *ActionEvent {
ev.data.Scope.AddMultiple(pkgs...)
return ev
}
func (ev *ActionEvent) IncludesPrivateData() *ActionEvent {
ev.data.HasPrivateData = true
return ev
}
func NewActionID() ActionID { return ActionID(ids.NewRandomBase62ID(16)) }
func (ev *ActionEvent) initMissing() {
if ev.data.ActionID == "" {
ev.data.ActionID = NewActionID()
}
ev.data.Created = time.Now()
}
// Sets the level for this action (by default it's zero). The lower the level, the higher the importance.
func (ev *ActionEvent) LogLevel(level int) *ActionEvent {
ev.data.Level = level
return ev
}
func (ev *ActionEvent) Str(name string, msg fmt.Stringer) *ActionEvent {
ev.data.Arguments = append(ev.data.Arguments, ActionArgument{Name: name, Msg: msg.String()})
return ev
}
func (ev *ActionEvent) Arg(name string, msg interface{}) *ActionEvent {
ev.data.Arguments = append(ev.data.Arguments, ActionArgument{Name: name, Msg: msg})
return ev
}
type ActionProgress interface {
FormatProgress() string
}
func (ev *ActionEvent) Progress(p ActionProgress) *ActionEvent {
ev.progress = p
return ev
}
func (ev *ActionEvent) Indefinite() *ActionEvent {
ev.data.Indefinite = true
return ev
}
func (ev *ActionEvent) Clone(makeName func(string) string) *ActionEvent {
copy := &ActionEvent{
data: ev.data,
}
name := copy.data.Name
if copy.data.Category != "" {
name = copy.data.Category + "::" + name
copy.data.Category = ""
}
copy.data.Name = makeName(name)
return copy
}
func parentID(ctx context.Context) *ActionID {
var parent *RunningAction
action := ctx.Value(_actionKey)
if action != nil {
parent = action.(*RunningAction)
return &parent.Data.ActionID
}
return nil
}
func (ev *ActionEvent) toAction(ctx context.Context, state ActionState) *RunningAction {
sink := SinkFrom(ctx)
if sink == nil {
panic("compute: action sink required in the context")
}
parentId := parentID(ctx)
if parentId != nil {
ev.data.ParentID = *parentId
}
ev.initMissing()
ev.data.State = state
return &RunningAction{
sink: sink,
Data: ev.data,
Progress: ev.progress,
attachments: &EventAttachments{actionID: ev.data.ActionID, sink: sink},
onDone: ev.onDone,
}
}
func (ev *ActionEvent) Start(ctx context.Context) *RunningAction {
ra := ev.toAction(ctx, ActionRunning)
ra.markStarted(ctx)
return ra
}
type RunOpts struct {
// If Wait returns true, then the action is considered to be cached, and Run is skipped.
Wait func(context.Context) (bool, error)
Run func(context.Context) error
}
type handledPanic struct {
v any
}
// Separate function to make the stack trace more readable.
func panicHandler(ctx context.Context) {
r := recover()
if r == nil {
return
}
if _, ok := r.(handledPanic); ok {
// bubble up panic.
panic(r)
}
// Mark panic as handled and bubble it up.
panic(handledPanic{v: r})
}
func (ev *ActionEvent) RunWithOpts(ctx context.Context, opts RunOpts) error {
defer panicHandler(ctx)
ra := ev.toAction(ctx, ActionWaiting)
ra.sink.Waiting(ra)
var wasCached bool
var releaseLease func()
err := ra.Call(ctx, func(ctx context.Context) error {
if opts.Wait != nil {
cached, err := opts.Wait(ctx)
if err != nil {
return err
}
wasCached = cached
if cached {
// Don't try to acquire a lease.
return nil
}
}
// Classify the wait for lease time as "wait time".
var err error
releaseLease, err = throttlerFromContext(ctx).AcquireLease(ctx, map[WellKnown]string{WkAction: ev.data.Name})
return err
})
if err != nil {
return ra.Done(err)
}
// Only record a Starting event if we had to wait.
if (opts.Wait != nil || releaseLease != nil) && ra.span != nil && ra.span.IsRecording() {
ra.span.AddEvent("starting", trace.WithAttributes(attribute.Bool("cached", wasCached)))
ra.Data.SpanID = ra.span.SpanContext().SpanID().String()
}
if wasCached {
ra.Data.Arguments = append(ra.Data.Arguments, ActionArgument{Name: "cached", Msg: true})
return ra.Done(nil)
}
if releaseLease != nil {
defer releaseLease()
}
// Our data model implies that the caller always owns data; and sinks should perform copies.
ra.Data.Started = time.Now()
ra.markStarted(ctx)
return ra.Done(ra.Call(ctx, opts.Run))
}
func (ev *ActionEvent) Run(ctx context.Context, f func(context.Context) error) error {
return ev.RunWithOpts(ctx, RunOpts{Run: f})
}
func Return0(ctx context.Context, ev *ActionEvent, f func(context.Context) error) error {
return ev.RunWithOpts(ctx, RunOpts{Run: func(ctx context.Context) error {
return f(ctx)
}})
}
func Return[V any](ctx context.Context, ev *ActionEvent, f func(context.Context) (V, error)) (V, error) {
var ret V
err := ev.RunWithOpts(ctx, RunOpts{Run: func(ctx context.Context) error {
var err error
ret, err = f(ctx)
return err
}})
return ret, err
}
func (ev *ActionEvent) Log(ctx context.Context) {
sink := SinkFrom(ctx)
if sink == nil {
return
}
ev.initMissing()
if ev.data.Started.IsZero() {
ev.data.Started = ev.data.Created
}
ev.data.State = ActionInstant
sink.Instant(&ev.data)
}
func makeProto(data *EventData, at *EventAttachments) *protocol.Task {
p := &protocol.Task{
Id: data.ActionID.String(),
Name: data.Name,
HumanReadableLabel: data.HumanReadable,
CreatedTs: data.Created.UnixNano(),
Scope: data.Scope.PackageNamesAsString(),
State: string(data.State),
}
if !data.Started.IsZero() {
p.StartedTs = data.Started.UnixNano()
}
if !data.HasPrivateData {
for _, arg := range data.Arguments {
taskArg := &protocol.Task_Argument{
Name: arg.Name,
}
// The stored value is serialized in a best-effort way.
if be, err := json.Marshal(arg.Msg); err == nil {
taskArg.Msg = string(be)
}
p.Argument = append(p.Argument, taskArg)
}
}
if data.State == ActionDone {
p.CompletedTs = data.Completed.UnixNano()
if data.Err != nil {
p.ErrorMessage = data.Err.Error()
}
}
if at != nil {
at.mu.Lock()
for _, name := range at.insertionOrder {
p.Output = append(p.Output, &protocol.Task_Output{
Id: at.buffers[name.computed].id,
Name: at.buffers[name.computed].name,
ContentType: at.buffers[name.computed].contentType,
})
}
at.mu.Unlock()
}
return p
}
func MakeStoreProto(data *EventData, at *EventAttachments) *storage.StoredTask {
p := &storage.StoredTask{
Id: data.ActionID.String(),
ParentId: data.ParentID.String(),
AnchorId: data.AnchorID.String(),
SpanId: data.SpanID,
Name: data.Name,
Category: data.Category,
HumanReadableLabel: data.HumanReadable,
CreatedTs: data.Created.UnixNano(),
Scope: data.Scope.PackageNamesAsString(),
LogLevel: int32(data.Level),
}
if data.State == ActionDone {
p.CompletedTs = data.Completed.UnixNano()
p.RelStartedTs = data.Started.UnixNano() - data.Created.UnixNano()
p.RelCompletedTs = data.Completed.UnixNano() - data.Created.UnixNano()
if data.Err != nil {
st, _ := status.FromError(data.Err)
p.ErrorCode = int32(st.Code())
p.ErrorMessage = st.Message()
p.ErrorDetails = st.Proto().Details
if errors.Is(data.Err, context.Canceled) {
p.ErrorCode = int32(statuscodes.Canceled)
}
}
}
for _, x := range data.Arguments {
p.Argument = append(p.Argument, &storage.StoredTask_Value{
Key: x.Name,
JsonValue: serialize(x.Msg, data.HasPrivateData),
})
}
if at != nil {
at.mu.Lock()
if at.ResultData.Items != nil {
for _, x := range at.Items {
if x.Name == "cached" && x.Msg == true {
p.Cached = true
} else {
p.Result = append(p.Result, &storage.StoredTask_Value{
Key: x.Name,
JsonValue: serialize(x.Msg, data.HasPrivateData),
})
}
}
}
if !data.HasPrivateData {
for _, name := range at.insertionOrder {
p.Output = append(p.Output, &storage.StoredTask_Output{
Id: at.buffers[name.computed].id,
Name: at.buffers[name.computed].name,
ContentType: at.buffers[name.computed].contentType,
})
}
}
at.mu.Unlock()
}
return p
}
func serialize(msg interface{}, hasPrivateData bool) string {
if hasPrivateData {
return "$redacted"
}
serialized, err := json.MarshalIndent(msg, "", " ")
if err != nil {
return "{\"error\": \"failed to serialize\"}"
}
return string(serialized)
}
func (af *RunningAction) ID() ActionID { return af.Data.ActionID }
func (af *RunningAction) Proto() *protocol.Task { return makeProto(&af.Data, af.attachments) }
func (af *RunningAction) Attachments() *EventAttachments { return af.attachments }
func EventDataFromProto(cat string, in *protocol.Task) EventData {
data := EventData{
ActionID: ActionID(in.Id),
Name: in.Name,
HumanReadable: in.HumanReadableLabel,
Created: time.Unix(0, in.CreatedTs),
State: ActionState(in.State),
Category: cat,
}
scope := schema.PackageList{}
for _, s := range in.Scope {
scope.Add(schema.PackageName(s))
}
data.Scope = scope
if in.StartedTs > 0 {
data.Started = time.Unix(0, in.StartedTs)
}
for _, arg := range in.Argument {
newArg := ActionArgument{
Name: arg.Name,
}
if arg.Msg != "" {
var msg json.Token
if err := json.Unmarshal([]byte(arg.Msg), &msg); err == nil {
newArg.Msg = msg
}
}
data.Arguments = append(data.Arguments, newArg)
}
if in.CompletedTs > 0 {
data.Completed = time.Unix(0, in.CompletedTs)
}
if in.ErrorMessage != "" {
data.Err = fmt.Errorf(in.ErrorMessage)
}
return data
}
func ActionFromProto(ctx context.Context, cat string, in *protocol.Task) *RunningAction {
sink := SinkFrom(ctx)
if sink == nil {
panic("compute: action sink required in the context")
}
data := EventDataFromProto(cat, in)
parentId := parentID(ctx)
if parentId != nil {
data.ParentID = *parentId
}
return &RunningAction{
sink: sink,
Data: data,
attachments: &EventAttachments{
actionID: data.ActionID,
sink: sink,
},
}
}
func startSpan(ctx context.Context, data EventData) trace.Span {
name := data.Name
if data.Category != "" {
name = data.Category + "::" + name
}
_, span := otel.Tracer("fn").Start(ctx, name)
if span.IsRecording() {
span.SetAttributes(attribute.String("actionID", data.ActionID.String()))
if data.AnchorID != "" {
span.SetAttributes(attribute.String("anchorID", data.AnchorID.String()))
}
for _, arg := range data.Arguments {
// The stored value is serialized in a best-effort way.
be, _ := json.MarshalIndent(arg.Msg, "", " ")
span.SetAttributes(attribute.String("arg."+arg.Name, string(be)))
}
if data.Scope.Len() > 0 {
span.SetAttributes(attribute.StringSlice("scope", data.Scope.PackageNamesAsString()))
}
}
return span
}
func endSpan(span trace.Span, r ResultData, completed time.Time) {
for _, arg := range r.Items {
// The stored value is serialized in a best-effort way.
be, _ := json.MarshalIndent(arg.Msg, "", " ")
span.SetAttributes(attribute.String("result."+arg.Name, string(be)))
}
// XXX we should pass along the completed timeline, but we're sometimes seeing arbitrary values
// into the future.
// span.End(trace.WithTimestamp(completed))
span.End()
}
func (af *RunningAction) markStarted(ctx context.Context) {
if af.Data.Started.IsZero() {
af.Data.Started = af.Data.Created
}
af.Data.State = ActionRunning
af.sink.Started(af)
af.span = startSpan(ctx, af.Data)
runningActionsSink.Sink().Started(af)
}
func (af *RunningAction) CustomDone(t time.Time, err error) bool {
if af != nil && af.Data.State != ActionDone {
if af.onDone != nil {
// Call onDone first, so it's execution time is accounted for to the action time.
af.onDone(af.Proto())
}
if af.Data.Completed.IsZero() {
af.Data.Completed = t
}
af.Data.State = ActionDone
af.Data.Err = err
if af.attachments != nil {
af.attachments.seal()
}
if af.span != nil {
if err != nil {
af.span.SetStatus(codes.Error, err.Error())
}
endSpan(af.span, af.attachments.ResultData, af.Data.Completed)
}
af.sink.Done(af)
runningActionsSink.Sink().Done(af)
if ActionStorer != nil {
ActionStorer(af)
}
return true
}
return false
}
func (af *RunningAction) Call(ctx context.Context, f func(context.Context) error) error {
if af != nil {
ctx = context.WithValue(ctx, _actionKey, af)
if af.span != nil {
return f(trace.ContextWithSpan(ctx, af.span))
}
}
return f(ctx)
}
func (af *RunningAction) Done(err error) error {
// XXX serialize additional error data.
if err != nil {
err = wrapErrorWithAction(err, af.ID())
}
af.CustomDone(time.Now(), err)
return err
}
type OutputName struct{ name, contentType, computed string }
func Output(name string, contentType string) OutputName {
if contentType == "" {
contentType = "application/octet-stream"
}
return OutputName{name, contentType, name + "[" + contentType + "]"}
}
func WithSink(ctx context.Context, sink ActionSink) context.Context {
return context.WithValue(ctx, _sinkKey, sink)
}
func SinkFrom(ctx context.Context) ActionSink {
sink := ctx.Value(_sinkKey)
if sink == nil {
return nil
}
return sink.(ActionSink)
}
func Attachments(ctx context.Context) *EventAttachments {
v := ctx.Value(_actionKey)
if v == nil {
return nil
}
return v.(*RunningAction).Attachments()
}
func NameOf(ev *ActionEvent) (string, string) {
return ev.data.Name, ev.data.HumanReadable
}