forked from flyteorg/flytepropeller
-
Notifications
You must be signed in to change notification settings - Fork 0
/
pre_post_execution.go
273 lines (239 loc) · 10.4 KB
/
pre_post_execution.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
package task
import (
"context"
"time"
"github.com/flyteorg/flyteplugins/go/tasks/pluginmachinery/ioutils"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/core"
"github.com/flyteorg/flyteplugins/go/tasks/pluginmachinery/catalog"
pluginCore "github.com/flyteorg/flyteplugins/go/tasks/pluginmachinery/core"
"github.com/flyteorg/flyteplugins/go/tasks/pluginmachinery/io"
"github.com/flyteorg/flytestdlib/logger"
"github.com/pkg/errors"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"github.com/flyteorg/flytepropeller/pkg/apis/flyteworkflow/v1alpha1"
errors2 "github.com/flyteorg/flytepropeller/pkg/controller/nodes/errors"
)
var (
cacheDisabled = catalog.NewStatus(core.CatalogCacheStatus_CACHE_DISABLED, nil)
cacheSkipped = catalog.NewStatus(core.CatalogCacheStatus_CACHE_SKIPPED, nil)
)
func (t *Handler) CheckCatalogCache(ctx context.Context, tr pluginCore.TaskReader, inputReader io.InputReader, outputWriter io.OutputWriter) (catalog.Entry, error) {
tk, err := tr.Read(ctx)
if err != nil {
logger.Errorf(ctx, "Failed to read TaskTemplate, error :%s", err.Error())
return catalog.Entry{}, err
}
if tk.Metadata.Discoverable {
logger.Infof(ctx, "Catalog CacheEnabled: Looking up catalog Cache.")
key := catalog.Key{
Identifier: *tk.Id,
CacheVersion: tk.Metadata.DiscoveryVersion,
TypedInterface: *tk.Interface,
InputReader: inputReader,
}
resp, err := t.catalog.Get(ctx, key)
if err != nil {
causeErr := errors.Cause(err)
if taskStatus, ok := status.FromError(causeErr); ok && taskStatus.Code() == codes.NotFound {
t.metrics.catalogMissCount.Inc(ctx)
logger.Infof(ctx, "Catalog CacheMiss: Artifact not found in Catalog. Executing Task.")
return catalog.NewCatalogEntry(nil, catalog.NewStatus(core.CatalogCacheStatus_CACHE_MISS, nil)), nil
}
t.metrics.catalogGetFailureCount.Inc(ctx)
logger.Errorf(ctx, "Catalog Failure: memoization check failed. err: %v", err.Error())
return catalog.Entry{}, errors.Wrapf(err, "Failed to check Catalog for previous results")
}
if resp.GetStatus().GetCacheStatus() != core.CatalogCacheStatus_CACHE_HIT {
logger.Errorf(ctx, "No CacheHIT and no Error received. Illegal state, Cache State: %s", resp.GetStatus().GetCacheStatus().String())
// TODO should this be an error?
return resp, nil
}
logger.Infof(ctx, "Catalog CacheHit: for task [%s/%s/%s/%s]", tk.Id.Project, tk.Id.Domain, tk.Id.Name, tk.Id.Version)
t.metrics.catalogHitCount.Inc(ctx)
if iface := tk.Interface; iface != nil && iface.Outputs != nil && len(iface.Outputs.Variables) > 0 {
if err := outputWriter.Put(ctx, resp.GetOutputs()); err != nil {
logger.Errorf(ctx, "failed to write data to Storage, err: %v", err.Error())
return catalog.Entry{}, errors.Wrapf(err, "failed to copy cached results for task.")
}
}
// SetCached.
return resp, nil
}
logger.Infof(ctx, "Catalog CacheDisabled: for Task [%s/%s/%s/%s]", tk.Id.Project, tk.Id.Domain, tk.Id.Name, tk.Id.Version)
return catalog.NewCatalogEntry(nil, cacheDisabled), nil
}
// GetOrExtendCatalogReservation attempts to acquire an artifact reservation if the task is
// cachable and cache serializable. If the reservation already exists for this owner, the
// reservation is extended.
func (t *Handler) GetOrExtendCatalogReservation(ctx context.Context, ownerID string, heartbeatInterval time.Duration, tr pluginCore.TaskReader, inputReader io.InputReader) (catalog.ReservationEntry, error) {
tk, err := tr.Read(ctx)
if err != nil {
logger.Errorf(ctx, "Failed to read TaskTemplate, error :%s", err.Error())
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_FAILURE), err
}
if tk.Metadata.Discoverable && tk.Metadata.CacheSerializable {
logger.Infof(ctx, "Catalog CacheSerializeEnabled: creating catalog reservation.")
key := catalog.Key{
Identifier: *tk.Id,
CacheVersion: tk.Metadata.DiscoveryVersion,
TypedInterface: *tk.Interface,
InputReader: inputReader,
}
reservation, err := t.catalog.GetOrExtendReservation(ctx, key, ownerID, heartbeatInterval)
if err != nil {
t.metrics.reservationGetFailureCount.Inc(ctx)
logger.Errorf(ctx, "Catalog Failure: reservation get or extend failed. err: %v", err.Error())
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_FAILURE), err
}
expiresAt := reservation.ExpiresAt.AsTime()
heartbeatInterval := reservation.HeartbeatInterval.AsDuration()
var status core.CatalogReservation_Status
if reservation.OwnerId == ownerID {
status = core.CatalogReservation_RESERVATION_ACQUIRED
} else {
status = core.CatalogReservation_RESERVATION_EXISTS
}
t.metrics.reservationGetSuccessCount.Inc(ctx)
return catalog.NewReservationEntry(expiresAt, heartbeatInterval, reservation.OwnerId, status), nil
}
logger.Infof(ctx, "Catalog CacheSerializeDisabled: for Task [%s/%s/%s/%s]", tk.Id.Project, tk.Id.Domain, tk.Id.Name, tk.Id.Version)
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_DISABLED), nil
}
func (t *Handler) ValidateOutputAndCacheAdd(ctx context.Context, nodeID v1alpha1.NodeID, i io.InputReader,
r io.OutputReader, outputCommitter io.OutputWriter, executionConfig v1alpha1.ExecutionConfig,
tr ioutils.SimpleTaskReader, m catalog.Metadata) (catalog.Status, *io.ExecutionError, error) {
tk, err := tr.Read(ctx)
if err != nil {
logger.Errorf(ctx, "Failed to read TaskTemplate, error :%s", err.Error())
return cacheDisabled, nil, err
}
iface := tk.Interface
outputsDeclared := iface != nil && iface.Outputs != nil && len(iface.Outputs.Variables) > 0
if r == nil {
if outputsDeclared {
// Whack! plugin did not return any outputs for this task
// Also When an error is observed, cache is automatically disabled
return cacheDisabled, &io.ExecutionError{
ExecutionError: &core.ExecutionError{
Code: "OutputsNotGenerated",
Message: "Output Reader was nil. Plugin/Platform problem.",
},
IsRecoverable: true,
}, nil
}
return cacheDisabled, nil, nil
}
// Reader exists, we can check for error, even if this task may not have any outputs declared
y, err := r.IsError(ctx)
if err != nil {
return cacheDisabled, nil, err
}
if y {
taskErr, err := r.ReadError(ctx)
if err != nil {
return cacheDisabled, nil, err
}
if taskErr.ExecutionError == nil {
taskErr.ExecutionError = &core.ExecutionError{Kind: core.ExecutionError_UNKNOWN, Code: "Unknown", Message: "Unknown"}
}
return cacheDisabled, &taskErr, nil
}
// Do this if we have outputs declared for the Handler interface!
if !outputsDeclared {
return cacheDisabled, nil, nil
}
ok, err := r.Exists(ctx)
if err != nil {
logger.Errorf(ctx, "Failed to check if the output file exists. Error: %s", err.Error())
return cacheDisabled, nil, err
}
if !ok {
// Does not exist
return cacheDisabled,
&io.ExecutionError{
ExecutionError: &core.ExecutionError{
Code: "OutputsNotFound",
Message: "Outputs not generated by task execution",
},
IsRecoverable: true,
}, nil
}
if !r.IsFile(ctx) {
// Read output and write to file
// No need to check for Execution Error here as we have done so above this block.
err = outputCommitter.Put(ctx, r)
if err != nil {
logger.Errorf(ctx, "Failed to commit output to remote location. Error: %v", err)
return cacheDisabled, nil, err
}
}
p, err := t.ResolvePlugin(ctx, tk.Type, executionConfig)
if err != nil {
return cacheDisabled, nil, errors2.Wrapf(errors2.UnsupportedTaskTypeError, nodeID, err, "unable to resolve plugin")
}
writeToCatalog := !p.GetProperties().DisableNodeLevelCaching
if !tk.Metadata.Discoverable || !writeToCatalog {
if !writeToCatalog {
logger.Infof(ctx, "Node level caching is disabled. Skipping catalog write.")
}
return cacheDisabled, nil, nil
}
cacheVersion := "0"
if tk.Metadata != nil {
cacheVersion = tk.Metadata.DiscoveryVersion
}
key := catalog.Key{
Identifier: *tk.Id,
CacheVersion: cacheVersion,
TypedInterface: *tk.Interface,
InputReader: i,
}
logger.Infof(ctx, "Catalog CacheEnabled. recording execution [%s/%s/%s/%s]", tk.Id.Project, tk.Id.Domain, tk.Id.Name, tk.Id.Version)
// ignores discovery write failures
var s catalog.Status
if executionConfig.OverwriteCache {
// Overwrite existing artifact (will create instead of no existing data was found)
s, err = t.catalog.Update(ctx, key, r, m)
} else {
// Explicitly create new artifact
s, err = t.catalog.Put(ctx, key, r, m)
}
if err != nil {
t.metrics.catalogPutFailureCount.Inc(ctx)
logger.Errorf(ctx, "Failed to write results to catalog for Task [%v]. Error: %v", tk.GetId(), err)
return catalog.NewStatus(core.CatalogCacheStatus_CACHE_PUT_FAILURE, s.GetMetadata()), nil, nil
}
t.metrics.catalogPutSuccessCount.Inc(ctx)
logger.Infof(ctx, "Successfully cached results to catalog - Task [%v]", tk.GetId())
return s, nil, nil
}
// ReleaseCatalogReservation attempts to release an artifact reservation if the task is cachable
// and cache serializable. If the reservation does not exist for this owner (e.x. it never existed
// or has been acquired by another owner) this call is still successful.
func (t *Handler) ReleaseCatalogReservation(ctx context.Context, ownerID string, tr pluginCore.TaskReader, inputReader io.InputReader) (catalog.ReservationEntry, error) {
tk, err := tr.Read(ctx)
if err != nil {
logger.Errorf(ctx, "Failed to read TaskTemplate, error :%s", err.Error())
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_FAILURE), err
}
if tk.Metadata.Discoverable && tk.Metadata.CacheSerializable {
logger.Infof(ctx, "Catalog CacheSerializeEnabled: releasing catalog reservation.")
key := catalog.Key{
Identifier: *tk.Id,
CacheVersion: tk.Metadata.DiscoveryVersion,
TypedInterface: *tk.Interface,
InputReader: inputReader,
}
err := t.catalog.ReleaseReservation(ctx, key, ownerID)
if err != nil {
t.metrics.reservationReleaseFailureCount.Inc(ctx)
logger.Errorf(ctx, "Catalog Failure: release reservation failed. err: %v", err.Error())
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_FAILURE), err
}
t.metrics.reservationReleaseSuccessCount.Inc(ctx)
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_RELEASED), nil
}
logger.Infof(ctx, "Catalog CacheSerializeDisabled: for Task [%s/%s/%s/%s]", tk.Id.Project, tk.Id.Domain, tk.Id.Name, tk.Id.Version)
return catalog.NewReservationEntryStatus(core.CatalogReservation_RESERVATION_DISABLED), nil
}