-
Notifications
You must be signed in to change notification settings - Fork 9
/
inputs.go
277 lines (227 loc) · 7.45 KB
/
inputs.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
// 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 compute
import (
"context"
"crypto/sha256"
"fmt"
"io"
"reflect"
"sort"
"strings"
"google.golang.org/protobuf/proto"
"namespacelabs.dev/foundation/internal/fnerrors"
"namespacelabs.dev/foundation/internal/versions"
"namespacelabs.dev/foundation/schema"
)
type In struct {
ins []keyValue
marshallers []keyMarshal
cacheable bool
named UntypedComputable // Set by Named(). If set, short-circuits node computation and waits for this input.
}
func Inputs() *In { return &In{cacheable: true} }
type keyValue struct {
Name string
Value interface{}
Undetermined bool
}
type keyMarshal struct {
Name string
Marshal func(context.Context, io.Writer) error
}
func (in *In) Computable(key string, c UntypedComputable) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: c})
return in
}
func (in *In) Str(key string, str string) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: str})
return in
}
func (in *In) StrMap(key string, m map[string]string) *In {
var kvs []keyValue
for k, v := range m {
kvs = append(kvs, keyValue{Name: k, Value: v})
}
// Make it stable
sort.Slice(kvs, func(i, j int) bool { return strings.Compare(kvs[i].Name, kvs[j].Name) < 0 })
return in.JSON(key, kvs)
}
func (in *In) Stringer(key string, str fmt.Stringer) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: str.String()})
return in
}
func (in *In) Strs(key string, strs []string) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: strs})
return in
}
func (in *In) JSON(key string, json interface{}) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: json})
return in
}
func (in *In) Proto(key string, msg proto.Message) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: msg})
return in
}
func (in *In) Bool(key string, v bool) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: v})
return in
}
// An unusable input (marking the corresponding Computable having non-computable inputs).
// We accept a variable to help with code search; but it is otherwise unused.
func (in *In) Indigestible(key string, value interface{}) *In {
in.ins = append(in.ins, keyValue{Name: key, Value: value, Undetermined: true})
return in
}
func (in *In) Marshal(key string, marshaller func(context.Context, io.Writer) error) *In {
in.marshallers = append(in.marshallers, keyMarshal{key, marshaller})
return in
}
func (in *In) NonCacheable() *In {
in.cacheable = false
return in
}
func (in *In) Digest(key string, d Digestible) *In {
in.marshallers = append(in.marshallers, keyMarshal{key, func(ctx context.Context, w io.Writer) error {
digest, err := d.ComputeDigest(ctx)
if err != nil {
return err
}
_, err = fmt.Fprint(w, digest.String())
return err
}})
return in
}
type keyDigest struct {
Name string
Digest string
IsSet bool // If not set, the input was not deterministic. It will have to be then set via Finalize().
}
type computedInputs struct {
serial int64 // A type-provided digest function version. Bump it with `Inputs().Version()` if the cache function changes.
pkgPath string
typeName string
digests []keyDigest
computable map[string]UntypedComputable
nonDeterministic bool // Even waiting for dependencies won't really lead to a deterministic digest.
Digest schema.Digest // Only set if all inputs are known recursively over all dependencies.
PostComputeDigest schema.Digest // Only set after `Finalize`, and if all values were resolved.
}
func (c *computedInputs) Finalize(resolved map[string]ResultWithTimestamp[any]) error {
if c.nonDeterministic {
return nil
}
var computedInputs []keyDigest
for _, kv := range c.digests {
if !kv.IsSet {
v, has := resolved[kv.Name]
if !has {
return fnerrors.InternalError("%s: computed value is missing", kv.Name)
}
if !v.Digest.IsSet() || v.NonDeterministic {
// No output digest possible.
return nil
}
computedInputs = append(computedInputs, keyDigest{Name: kv.Name, Digest: v.Digest.String(), IsSet: true})
} else {
computedInputs = append(computedInputs, kv)
}
}
var err error
c.PostComputeDigest, err = digestWithInputs(c.pkgPath, c.typeName, c.serial, computedInputs)
return err
}
func digestWithInputs(pkgPath, typeName string, serial int64, inputs []keyDigest) (schema.Digest, error) {
h := sha256.New()
if _, err := fmt.Fprintf(h, "$V:%d\nPkgPath:%s\nType:%s\nVersion:%d\nInputs{\n", versions.Builtin().CacheVersion, pkgPath, typeName, serial); err != nil {
return schema.Digest{}, err
}
for _, kv := range inputs {
if _, err := fmt.Fprintf(h, "%s:%s\n", kv.Name, kv.Digest); err != nil {
return schema.Digest{}, err
}
}
if _, err := fmt.Fprint(h, "}\n"); err != nil {
return schema.Digest{}, err
}
return schema.FromHash("sha256", h), nil
}
func (in *In) computeDigest(ctx context.Context, c UntypedComputable, processComputable bool) (*computedInputs, error) {
typ := reflect.TypeOf(c)
res := &computedInputs{
pkgPath: typ.PkgPath(),
typeName: typ.String(),
}
if processComputable {
res.computable = map[string]UntypedComputable{}
}
unsetCount := 0
for _, kv := range in.ins {
depc, isComputable := kv.Value.(UntypedComputable)
if processComputable && isComputable {
res.computable[kv.Name] = depc
}
if kv.Undetermined {
res.nonDeterministic = true
continue
}
if !isComputable {
if d, err := schema.DigestOf(kv.Value); err != nil {
return nil, fnerrors.InternalError("%s: failed to compute digest: %w", kv.Name, err)
} else {
res.digests = append(res.digests, keyDigest{Name: kv.Name, Digest: d.String(), IsSet: true})
}
continue
}
if res.nonDeterministic {
continue // No point computing more digests.
}
opts := depc.prepareCompute(depc)
// If the dependency can't be loaded from cache, don't bother even checking if it has
// a computed input digest.
if !opts.CanCache() {
res.digests = append(res.digests, keyDigest{Name: kv.Name})
unsetCount++
continue
}
// XXX check for cycles.
computed, err := depc.Inputs().computeDigest(ctx, depc, false)
if err != nil {
return nil, fnerrors.InternalError("%s: failed with: %w", kv.Name, err)
}
kv := keyDigest{Name: kv.Name}
// The dependency's input digest could not be fully calculated because one of
// the inputs is not available, i.e. it needs to be computed.
if computed.Digest.IsSet() {
kv.Digest = computed.Digest.String()
kv.IsSet = true
} else {
unsetCount++
}
// We serialize a digest of the inputs rather than the inputs themselves as we have
// logic in digest.With() that aims for determinism.
res.digests = append(res.digests, kv)
}
if res.nonDeterministic {
return res, nil
}
for _, m := range in.marshallers {
h := sha256.New()
if err := m.Marshal(ctx, h); err != nil {
return nil, fnerrors.InternalError("%s: marshaller failed with: %w", m.Name, err)
}
res.digests = append(res.digests, keyDigest{Name: m.Name, Digest: schema.FromHash("sha256", h).String(), IsSet: true})
}
sort.Slice(res.digests, func(i, j int) bool {
return strings.Compare(res.digests[i].Name, res.digests[j].Name) < 0
})
if unsetCount == 0 {
var err error
res.Digest, err = digestWithInputs(typ.PkgPath(), typ.String(), res.serial, res.digests)
if err != nil {
return nil, err
}
}
return res, nil
}