-
Notifications
You must be signed in to change notification settings - Fork 566
/
pipeline_state_driver.go
302 lines (276 loc) · 10.7 KB
/
pipeline_state_driver.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
package server
import (
"context"
"fmt"
"time"
"github.com/pachyderm/pachyderm/v2/src/auth"
"github.com/pachyderm/pachyderm/v2/src/internal/backoff"
"github.com/pachyderm/pachyderm/v2/src/internal/client"
"github.com/pachyderm/pachyderm/v2/src/internal/collection"
"github.com/pachyderm/pachyderm/v2/src/internal/errors"
"github.com/pachyderm/pachyderm/v2/src/internal/log"
"github.com/pachyderm/pachyderm/v2/src/internal/pachsql"
"github.com/pachyderm/pachyderm/v2/src/internal/ppsdb"
"github.com/pachyderm/pachyderm/v2/src/internal/ppsutil"
"github.com/pachyderm/pachyderm/v2/src/internal/tracing"
txnenv "github.com/pachyderm/pachyderm/v2/src/internal/transactionenv"
"github.com/pachyderm/pachyderm/v2/src/internal/uuid"
"github.com/pachyderm/pachyderm/v2/src/internal/watch"
"github.com/pachyderm/pachyderm/v2/src/pfs"
"github.com/pachyderm/pachyderm/v2/src/pps"
pfsserver "github.com/pachyderm/pachyderm/v2/src/server/pfs"
"github.com/pachyderm/pachyderm/v2/src/server/pfs/pretty"
"go.uber.org/zap"
"google.golang.org/grpc/metadata"
"google.golang.org/protobuf/proto"
)
type PipelineStateDriver interface {
// returns PipelineInfo corresponding to the latest pipeline state, a context loaded with the pipeline's auth info, and error
// NOTE: returns nil, nil, nil if the step is found to be a delete operation
FetchState(ctx context.Context, pipeline *pps.Pipeline) (*pps.PipelineInfo, context.Context, error)
// setPipelineState set's pc's state in the collection to 'state'. This will trigger a
// collection watch event and cause step() to eventually run again.
SetState(ctx context.Context, specCommit *pfs.Commit, state pps.PipelineState, reason string) error
// TransitionState is similar to SetState, except that it checks whether pipelineInfo @ specCommit
// is in one of the 'from' states
TransitionState(ctx context.Context, specCommit *pfs.Commit, from []pps.PipelineState, to pps.PipelineState, reason string) error
// wraps a Watcher on the pipelines collection
Watch(ctx context.Context) (<-chan *watch.Event, func(), error)
// list all PipelineInfos
ListPipelineInfo(ctx context.Context, f func(*pps.PipelineInfo) error) error
GetPipelineInfo(ctx context.Context, pipeline *pps.Pipeline, version int) (*pps.PipelineInfo, error)
}
type stateDriver struct {
db *pachsql.DB
pipelines collection.PostgresCollection
txEnv *txnenv.TransactionEnv
pfsApi pfsserver.APIServer
}
func newPipelineStateDriver(
db *pachsql.DB,
pipelines collection.PostgresCollection,
txEnv *txnenv.TransactionEnv,
pfsApi pfsserver.APIServer) PipelineStateDriver {
return &stateDriver{
db: db,
pipelines: pipelines,
txEnv: txEnv,
pfsApi: pfsApi,
}
}
// takes pc.ctx
func (sd *stateDriver) FetchState(ctx context.Context, pipeline *pps.Pipeline) (*pps.PipelineInfo, context.Context, error) {
// query pipelineInfo
var pi *pps.PipelineInfo
var err error
if pi, err = sd.tryLoadLatestPipelineInfo(ctx, pipeline); err != nil && collection.IsErrNotFound(err) {
// if the pipeline info is not found, interpret the operation as a delete
return nil, nil, nil
} else if err != nil {
return nil, nil, err
}
tracing.TagAnySpan(ctx,
"current-state", pi.State.String(),
"spec-commit", pretty.CompactPrintCommitSafe(pi.SpecCommit))
// add pipeline auth
// the pipelineController's context is authorized as pps master, but we want to switch to the pipeline itself
// first clear the cached WhoAmI result from the context
md := metadata.New(map[string]string{auth.ContextTokenKey: pi.AuthToken})
return pi, metadata.NewOutgoingContext(ctx, md), nil
}
func (sd *stateDriver) SetState(ctx context.Context, specCommit *pfs.Commit, state pps.PipelineState, reason string) error {
if err := setPipelineState(ctx, sd.db, sd.pipelines, specCommit, state, reason); err != nil {
// don't bother failing if we can't set the state
return stepError{
error: errors.Wrapf(err, "could not set pipeline state to %v"+
"(you may need to restart pachd to un-stick the pipeline)", state),
retry: true,
}
}
return nil
}
func (sd *stateDriver) TransitionState(ctx context.Context, specCommit *pfs.Commit, from []pps.PipelineState, to pps.PipelineState, reason string) (retErr error) {
span, ctx := tracing.AddSpanToAnyExisting(ctx,
"/pps.Master/TransitionPipelineState",
"project", specCommit.Repo.Project.GetName(),
"pipeline", specCommit.Repo.Name,
"from-state", from,
"to-state", to)
defer func() {
tracing.TagAnySpan(span, "err", retErr)
tracing.FinishAnySpan(span)
}()
return ppsutil.SetPipelineState(ctx, sd.db, sd.pipelines,
specCommit, from, to, reason)
}
func (sd *stateDriver) Watch(ctx context.Context) (<-chan *watch.Event, func(), error) {
pipelineWatcher, err := sd.pipelines.ReadOnly(ctx).Watch()
if err != nil {
return nil, nil, errors.EnsureStack(err)
}
return pipelineWatcher.Watch(), pipelineWatcher.Close, nil
}
func (sd *stateDriver) ListPipelineInfo(ctx context.Context, f func(*pps.PipelineInfo) error) error {
return ppsutil.ListPipelineInfo(ctx, sd.pipelines, nil, 0, f)
}
func (sd *stateDriver) GetPipelineInfo(ctx context.Context, pipeline *pps.Pipeline, version int) (*pps.PipelineInfo, error) {
var pipelineInfo pps.PipelineInfo
if err := sd.pipelines.ReadOnly(ctx).GetUniqueByIndex(
ppsdb.PipelinesVersionIndex,
ppsdb.VersionKey(pipeline, uint64(version)),
&pipelineInfo); err != nil {
return nil, errors.Wrapf(err, "couldn't retrieve pipeline information")
}
return &pipelineInfo, nil
}
func (sd *stateDriver) tryLoadLatestPipelineInfo(ctx context.Context, pipeline *pps.Pipeline) (*pps.PipelineInfo, error) {
pi := &pps.PipelineInfo{}
errCnt := 0
err := backoff.RetryNotify(func() error {
return sd.loadLatestPipelineInfo(ctx, pipeline, pi)
}, backoff.NewExponentialBackOff(), func(err error, d time.Duration) error {
errCnt++
// Don't put the pipeline in a failing state if we're in the middle
// of activating auth, retry in a bit
if (auth.IsErrNotAuthorized(err) || auth.IsErrNotSignedIn(err)) && errCnt <= maxErrCount {
log.Info(ctx, "could not retrieve pipelineInfo; retrying", zap.Error(err), zap.Duration("retryAfter", d), zap.Int("nErr", errCnt), zap.Int("maxErr", maxErrCount))
return nil
}
return stepError{
error: errors.Wrapf(err, "could not load pipelineInfo for pipeline %q", pipeline),
retry: false,
}
})
return pi, err
}
func (sd *stateDriver) loadLatestPipelineInfo(ctx context.Context, pipeline *pps.Pipeline, message *pps.PipelineInfo) error {
specCommit, err := ppsutil.FindPipelineSpecCommit(ctx, sd.pfsApi, *sd.txEnv, pipeline)
if err != nil {
return errors.Wrapf(err, "could not find spec commit for pipeline %q", pipeline)
}
if err := sd.pipelines.ReadOnly(ctx).Get(specCommit, message); err != nil {
return errors.Wrapf(err, "could not retrieve pipeline info for %q", pipeline)
}
return nil
}
type mockStateDriver struct {
pipelines map[pipelineKey]string // maps pipeline names to their latest spec commit IDs
specCommits map[string]*pps.PipelineInfo // maps spec commit IDs to their pipeline Infos
states map[pipelineKey][]pps.PipelineState // tracks all of the
eChan chan *watch.Event
closeEChan chan struct{} // supports closing eChan
}
func newMockStateDriver() *mockStateDriver {
d := &mockStateDriver{}
d.reset()
d.eChan = make(chan *watch.Event, 1)
d.closeEChan = make(chan struct{}, 1)
return d
}
func (d *mockStateDriver) SetState(ctx context.Context, specCommit *pfs.Commit, state pps.PipelineState, reason string) error {
if pi, ok := d.specCommits[specCommit.Id]; ok {
pi = proto.Clone(pi).(*pps.PipelineInfo)
pi.State = state
d.specCommits[specCommit.Id] = pi
d.states[toKey(pi.Pipeline)] = append(d.states[toKey(pi.Pipeline)], state)
d.pushWatchEvent(pi, watch.EventPut)
return nil
}
return errors.New("pipeline does not exist")
}
func (d *mockStateDriver) TransitionState(ctx context.Context, specCommit *pfs.Commit, from []pps.PipelineState, to pps.PipelineState, reason string) (retErr error) {
fromContains := func(ps pps.PipelineState) bool {
for _, v := range from {
if v == ps {
return true
}
}
return false
}
if pi, ok := d.specCommits[specCommit.Id]; ok {
if fromContains(pi.State) {
return d.SetState(ctx, specCommit, to, reason)
}
return ppsutil.PipelineTransitionError{
Pipeline: pi.Pipeline,
Expected: from,
Target: to,
Current: pi.State,
}
}
return errors.New("pipeline does not exist")
}
func (d *mockStateDriver) FetchState(ctx context.Context, pipeline *pps.Pipeline) (*pps.PipelineInfo, context.Context, error) {
if spec, ok := d.pipelines[toKey(pipeline)]; ok {
if pi, ok := d.specCommits[spec]; ok {
return pi, ctx, nil
}
}
return nil, nil, nil
}
func (d *mockStateDriver) Watch(ctx context.Context) (<-chan *watch.Event, func(), error) {
go func() {
defer close(d.eChan)
select {
case <-ctx.Done():
d.eChan <- &watch.Event{Type: watch.EventError, Err: context.Cause(ctx)}
return
case <-d.closeEChan:
return
}
}()
return d.eChan, func() {
select {
case d.closeEChan <- struct{}{}:
default:
}
}, nil
}
func (d *mockStateDriver) ListPipelineInfo(ctx context.Context, f func(*pps.PipelineInfo) error) error {
for _, spec := range d.pipelines {
if pi, ok := d.specCommits[spec]; ok {
if err := f(pi); err != nil {
return err
}
}
}
return nil
}
func (d *mockStateDriver) GetPipelineInfo(ctx context.Context, pipeline *pps.Pipeline, version int) (*pps.PipelineInfo, error) {
if spec, ok := d.pipelines[toKey(pipeline)]; ok {
if pi, ok := d.specCommits[spec]; ok {
return pi, nil
}
}
return nil, errors.New("not found")
}
func (d *mockStateDriver) upsertPipeline(pi *pps.PipelineInfo) *pfs.Commit {
mockSpecCommit := client.NewCommit(pi.Pipeline.Project.GetName(), pi.Pipeline.Name, "master", uuid.NewWithoutDashes())
pi.SpecCommit = mockSpecCommit
d.pipelines[toKey(pi.Pipeline)] = pi.SpecCommit.Id
d.specCommits[mockSpecCommit.Id] = pi
if ss, ok := d.states[toKey(pi.Pipeline)]; ok {
d.states[toKey(pi.Pipeline)] = append(ss, pi.State)
} else {
d.states[toKey(pi.Pipeline)] = []pps.PipelineState{pi.State}
}
d.pushWatchEvent(pi, watch.EventPut)
return mockSpecCommit
}
func (d *mockStateDriver) pushWatchEvent(pi *pps.PipelineInfo, et watch.EventType) {
d.eChan <- &watch.Event{
Key: []byte(fmt.Sprintf("%s@%s", pi.Pipeline, pi.SpecCommit.Id)),
Type: et,
}
}
func (d *mockStateDriver) cancelWatch() {
d.closeEChan <- struct{}{}
}
func (d *mockStateDriver) reset() {
d.pipelines = make(map[pipelineKey]string)
d.specCommits = make(map[string]*pps.PipelineInfo)
d.states = make(map[pipelineKey][]pps.PipelineState)
}
func (d *mockStateDriver) currentPipelineInfo(key pipelineKey) *pps.PipelineInfo {
return d.specCommits[d.pipelines[key]]
}