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
|
package sqs
import (
"context"
"strconv"
"time"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/service/sqs"
"github.com/aws/aws-sdk-go-v2/service/sqs/types"
json "github.com/json-iterator/go"
"github.com/spiral/errors"
"github.com/spiral/roadrunner/v2/plugins/jobs/job"
"github.com/spiral/roadrunner/v2/utils"
)
const (
StringType string = "String"
NumberType string = "Number"
ApproximateReceiveCount string = "ApproximateReceiveCount"
)
var itemAttributes = []string{
job.RRJob,
job.RRDelay,
job.RRTimeout,
job.RRPriority,
}
type Item struct {
// Job contains pluginName of job broker (usually PHP class).
Job string `json:"job"`
// Ident is unique identifier of the job, should be provided from outside
Ident string `json:"id"`
// Payload is string data (usually JSON) passed to Job broker.
Payload string `json:"payload"`
// Headers with key-values pairs
Headers map[string][]string `json:"headers"`
// Options contains set of PipelineOptions specific to job execution. Can be empty.
Options *Options `json:"options,omitempty"`
}
// Options carry information about how to handle given job.
type Options struct {
// Priority is job priority, default - 10
// pointer to distinguish 0 as a priority and nil as priority not set
Priority int64 `json:"priority"`
// Pipeline manually specified pipeline.
Pipeline string `json:"pipeline,omitempty"`
// Delay defines time duration to delay execution for. Defaults to none.
Delay int64 `json:"delay,omitempty"`
// Reserve defines for how broker should wait until treating job are failed. Defaults to 30 min.
Timeout int64 `json:"timeout,omitempty"`
// Private ================
approxReceiveCount int64
queue *string
receiptHandler *string
client *sqs.Client
requeueCh chan *Item
}
// DelayDuration returns delay duration in a form of time.Duration.
func (o *Options) DelayDuration() time.Duration {
return time.Second * time.Duration(o.Delay)
}
// TimeoutDuration returns timeout duration in a form of time.Duration.
func (o *Options) TimeoutDuration() time.Duration {
if o.Timeout == 0 {
return 30 * time.Minute
}
return time.Second * time.Duration(o.Timeout)
}
func (i *Item) ID() string {
return i.Ident
}
func (i *Item) Priority() int64 {
return i.Options.Priority
}
// Body packs job payload into binary payload.
func (i *Item) Body() []byte {
return utils.AsBytes(i.Payload)
}
// Context packs job context (job, id) into binary payload.
// Not used in the sqs, MessageAttributes used instead
func (i *Item) Context() ([]byte, error) {
ctx, err := json.Marshal(
struct {
ID string `json:"id"`
Job string `json:"job"`
Headers map[string][]string `json:"headers"`
Timeout int64 `json:"timeout"`
Pipeline string `json:"pipeline"`
}{ID: i.Ident, Job: i.Job, Headers: i.Headers, Timeout: i.Options.Timeout, Pipeline: i.Options.Pipeline},
)
if err != nil {
return nil, err
}
return ctx, nil
}
func (i *Item) Ack() error {
_, err := i.Options.client.DeleteMessage(context.Background(), &sqs.DeleteMessageInput{
QueueUrl: i.Options.queue,
ReceiptHandle: i.Options.receiptHandler,
})
if err != nil {
return err
}
return nil
}
func (i *Item) Nack() error {
_, err := i.Options.client.DeleteMessage(context.Background(), &sqs.DeleteMessageInput{
QueueUrl: i.Options.queue,
ReceiptHandle: i.Options.receiptHandler,
})
if err != nil {
return err
}
return nil
}
func (i *Item) Requeue(delay int64) error {
// overwrite the delay
i.Options.Delay = delay
select {
case i.Options.requeueCh <- i:
return nil
default:
return errors.E("can't push to the requeue channel, channel either closed or full", "current size", len(i.Options.requeueCh))
}
}
func fromJob(job *job.Job) *Item {
return &Item{
Job: job.Job,
Ident: job.Ident,
Payload: job.Payload,
Headers: job.Headers,
Options: &Options{
Priority: job.Options.Priority,
Pipeline: job.Options.Pipeline,
Delay: job.Options.Delay,
Timeout: job.Options.Timeout,
},
}
}
func (i *Item) pack(queue *string) *sqs.SendMessageInput {
return &sqs.SendMessageInput{
MessageBody: aws.String(i.Payload),
QueueUrl: queue,
DelaySeconds: int32(i.Options.Delay),
MessageAttributes: map[string]types.MessageAttributeValue{
job.RRJob: {DataType: aws.String(StringType), BinaryValue: nil, BinaryListValues: nil, StringListValues: nil, StringValue: aws.String(i.Job)},
job.RRDelay: {DataType: aws.String(StringType), BinaryValue: nil, BinaryListValues: nil, StringListValues: nil, StringValue: aws.String(strconv.Itoa(int(i.Options.Delay)))},
job.RRTimeout: {DataType: aws.String(StringType), BinaryValue: nil, BinaryListValues: nil, StringListValues: nil, StringValue: aws.String(strconv.Itoa(int(i.Options.Timeout)))},
job.RRPriority: {DataType: aws.String(NumberType), BinaryValue: nil, BinaryListValues: nil, StringListValues: nil, StringValue: aws.String(strconv.Itoa(int(i.Options.Priority)))},
},
}
}
func (j *JobConsumer) unpack(msg *types.Message) (*Item, error) {
const op = errors.Op("sqs_unpack")
// reserved
if _, ok := msg.Attributes[ApproximateReceiveCount]; !ok {
return nil, errors.E(op, errors.Str("failed to unpack the ApproximateReceiveCount attribute"))
}
for i := 0; i < len(itemAttributes); i++ {
if _, ok := msg.MessageAttributes[itemAttributes[i]]; !ok {
return nil, errors.E(op, errors.Errorf("missing queue attribute: %s", itemAttributes[i]))
}
}
delay, err := strconv.Atoi(*msg.MessageAttributes[job.RRDelay].StringValue)
if err != nil {
return nil, errors.E(op, err)
}
to, err := strconv.Atoi(*msg.MessageAttributes[job.RRTimeout].StringValue)
if err != nil {
return nil, errors.E(op, err)
}
priority, err := strconv.Atoi(*msg.MessageAttributes[job.RRPriority].StringValue)
if err != nil {
return nil, errors.E(op, err)
}
recCount, err := strconv.Atoi(msg.Attributes[ApproximateReceiveCount])
if err != nil {
return nil, errors.E(op, err)
}
item := &Item{
Job: *msg.MessageAttributes[job.RRJob].StringValue,
Payload: *msg.Body,
Options: &Options{
Delay: int64(delay),
Timeout: int64(to),
Priority: int64(priority),
// private
approxReceiveCount: int64(recCount),
client: j.client,
queue: j.queue,
receiptHandler: msg.ReceiptHandle,
requeueCh: j.requeueCh,
},
}
return item, nil
}
|
