-
Notifications
You must be signed in to change notification settings - Fork 0
/
submit.go
194 lines (171 loc) · 6.39 KB
/
submit.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
// Copyright 2020 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package internal
import (
"context"
"sync/atomic"
"time"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
"go.chromium.org/luci/common/clock"
"go.chromium.org/luci/common/errors"
"go.chromium.org/luci/common/logging"
"go.chromium.org/luci/common/retry/transient"
"go.chromium.org/luci/common/sync/parallel"
"go.chromium.org/luci/server/tq/internal/db"
"go.chromium.org/luci/server/tq/internal/metrics"
"go.chromium.org/luci/server/tq/internal/reminder"
)
// ErrStaleReminder is returned by ProcessReminderPostTxn.
var ErrStaleReminder = errors.New("the reminder is stale already")
// TxnPath indicates a code path a task can take.
type TxnPath string
const (
TxnPathNone TxnPath = "none" // not a transactional task
TxnPathHappy TxnPath = "happy" // the reminder was processed right after txn landed
TxnPathSweep TxnPath = "sweep" // the reminder was processed during a sweep
)
// Submitter is used by the dispatcher and the sweeper to submit tasks.
type Submitter interface {
// Submit submits a task, returning a gRPC status.
Submit(ctx context.Context, payload *reminder.Payload) error
}
// Submit submits the prepared request through the given submitter.
//
// Recognizes AlreadyExists as success. Annotates retriable errors with
// transient.Tag.
func Submit(ctx context.Context, s Submitter, payload *reminder.Payload, path TxnPath) error {
// Each individual RPC should be pretty quick. Also Cloud Tasks client bugs
// out if the context has a large deadline.
ctx, cancel := context.WithTimeout(ctx, time.Second*20)
defer cancel()
start := clock.Now(ctx)
err := s.Submit(ctx, payload)
code := status.Code(err)
dur := clock.Now(ctx).Sub(start)
metrics.SubmitCount.Add(ctx, 1, payload.TaskClass, string(path), code.String())
metrics.SubmitDurationMS.Add(ctx, float64(dur.Milliseconds()), payload.TaskClass, string(path), code.String())
switch code {
case codes.OK, codes.AlreadyExists:
return nil
case codes.Internal,
codes.Unknown,
codes.Unavailable,
codes.DeadlineExceeded,
codes.Canceled:
return transient.Tag.Apply(err)
default:
return err
}
}
// SubmitFromReminder submits the request and deletes the reminder on success
// or a fatal error.
//
// Mutates `r` by deserializing the payload, if necessary.
func SubmitFromReminder(ctx context.Context, s Submitter, db db.DB, r *reminder.Reminder, t TxnPath) error {
payload, err := r.Payload()
if err == nil {
err = Submit(ctx, s, payload, t)
}
// Task class for metrics is unknown if we failed to deserialize the payload.
taskClass := "unknown"
if payload != nil && payload.TaskClass != "" {
taskClass = payload.TaskClass
}
// Delete the reminder if the task was successfully enqueued or it is
// a non-retriable failure.
if !transient.Tag.In(err) {
if rerr := db.DeleteReminder(ctx, r); rerr != nil {
if err == nil {
err = rerr
}
} else {
metrics.RemindersDeleted.Add(ctx, 1, taskClass, string(t), db.Kind())
if payload != nil && !payload.Created.IsZero() {
lat := clock.Now(ctx).Sub(payload.Created)
metrics.RemindersLatencyMS.Add(ctx, float64(lat.Milliseconds()), taskClass, string(t), db.Kind())
}
}
}
return err
}
// SubmitBatch process a batch of reminders by submitting corresponding
// tasks and deleting reminders.
//
// Reminders batch will be modified to fetch Reminders' payloads. RAM usage is
// equivalent to O(total payload size of each Reminder in batch).
//
// Logs errors inside. Returns the total number of successfully processed
// reminders.
func SubmitBatch(ctx context.Context, sub Submitter, db db.DB, batch []*reminder.Reminder) (int, error) {
payloaded, err := db.FetchReminderRawPayloads(ctx, batch)
switch missing := len(batch) - len(payloaded); {
case missing < 0:
panic(errors.Reason("%s.FetchReminderRawPayloads returned %d but asked for %d Reminders",
db.Kind(), len(payloaded), len(batch)).Err())
case err != nil:
logging.Warningf(ctx, "Failed to fetch %d/%d Reminders: %s", missing, len(batch), err)
// Continue processing whatever was fetched anyway.
case missing > 0:
logging.Warningf(ctx, "%d stale Reminders were unexpectedly deleted by something else. "+
"If this persists, check for a misconfiguration of the sweeping or the happy path timeout",
missing)
}
var success int32
// Note: this can be optimized further by batching deletion of Reminders,
// but the current version was good enough in load tests already.
merr := parallel.WorkPool(16, func(work chan<- func() error) {
for _, r := range payloaded {
r := r
work <- func() error {
err := SubmitFromReminder(ctx, sub, db, r, TxnPathSweep)
if err != nil {
logging.Errorf(ctx, "Failed to process reminder %q: %s", r.ID, err)
} else {
atomic.AddInt32(&success, 1)
}
return err
}
}
})
count := int(atomic.LoadInt32(&success))
switch {
case err == nil:
return count, merr
case merr == nil:
return count, err
default:
e := merr.(errors.MultiError)
return count, append(e, err)
}
}
// ProcessReminderPostTxn is called right after the transaction that saves the
// reminder.
//
// If the reminder is fresh enough, it means the sweeper hasn't picked it
// up yet and we can submit the task right now. This is the "happy" path. If
// the reminder is sufficiently old, or if SubmitFromReminder fails, we'll let
// the sweeper try to submit the task. It is the "sweep" path.
//
// Returns ErrStaleReminder if the reminder is stale and should be handled by
// the sweeper.
func ProcessReminderPostTxn(ctx context.Context, s Submitter, db db.DB, r *reminder.Reminder) error {
payload := r.MustHavePayload()
if clock.Now(ctx).After(r.FreshUntil) {
metrics.RemindersCreated.Add(ctx, 1, payload.TaskClass, "stale", db.Kind())
return ErrStaleReminder
}
metrics.RemindersCreated.Add(ctx, 1, payload.TaskClass, "fresh", db.Kind())
return SubmitFromReminder(ctx, s, db, r, TxnPathHappy)
}