-
Notifications
You must be signed in to change notification settings - Fork 467
/
natsstreaming.go
350 lines (303 loc) · 10.7 KB
/
natsstreaming.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
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/*
Copyright 2021 The Dapr 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 natsstreaming implements NATS Streaming pubsub component
*/
package natsstreaming
import (
"context"
"errors"
"fmt"
"math/rand"
"strconv"
"time"
nats "github.com/nats-io/nats.go"
stan "github.com/nats-io/stan.go"
"github.com/nats-io/stan.go/pb"
"github.com/dapr/components-contrib/pubsub"
"github.com/dapr/kit/logger"
"github.com/dapr/kit/retry"
)
// compulsory options.
const (
natsURL = "natsURL"
natsStreamingClusterID = "natsStreamingClusterID"
)
// subscription options (optional).
const (
durableSubscriptionName = "durableSubscriptionName"
startAtSequence = "startAtSequence"
startWithLastReceived = "startWithLastReceived"
deliverAll = "deliverAll"
deliverNew = "deliverNew"
startAtTimeDelta = "startAtTimeDelta"
startAtTime = "startAtTime"
startAtTimeFormat = "startAtTimeFormat"
ackWaitTime = "ackWaitTime"
maxInFlight = "maxInFlight"
)
// valid values for subscription options.
const (
subscriptionTypeQueueGroup = "queue"
subscriptionTypeTopic = "topic"
startWithLastReceivedTrue = "true"
deliverAllTrue = "true"
deliverNewTrue = "true"
)
const (
consumerID = "consumerID" // passed in by Dapr runtime
subscriptionType = "subscriptionType"
)
type natsStreamingPubSub struct {
metadata metadata
natStreamingConn stan.Conn
logger logger.Logger
backOffConfig retry.Config
}
// NewNATSStreamingPubSub returns a new NATS Streaming pub-sub implementation.
func NewNATSStreamingPubSub(logger logger.Logger) pubsub.PubSub {
return &natsStreamingPubSub{logger: logger}
}
func parseNATSStreamingMetadata(meta pubsub.Metadata) (metadata, error) {
m := metadata{}
if val, ok := meta.Properties[natsURL]; ok && val != "" {
m.natsURL = val
} else {
return m, errors.New("nats-streaming error: missing nats URL")
}
if val, ok := meta.Properties[natsStreamingClusterID]; ok && val != "" {
m.natsStreamingClusterID = val
} else {
return m, errors.New("nats-streaming error: missing nats streaming cluster ID")
}
if val, ok := meta.Properties[subscriptionType]; ok {
if val == subscriptionTypeTopic || val == subscriptionTypeQueueGroup {
m.subscriptionType = val
} else {
return m, errors.New("nats-streaming error: valid value for subscriptionType is topic or queue")
}
}
if val, ok := meta.Properties[consumerID]; ok && val != "" {
m.natsQueueGroupName = val
} else {
return m, errors.New("nats-streaming error: missing queue group name")
}
if val, ok := meta.Properties[durableSubscriptionName]; ok && val != "" {
m.durableSubscriptionName = val
}
if val, ok := meta.Properties[ackWaitTime]; ok && val != "" {
dur, err := time.ParseDuration(meta.Properties[ackWaitTime])
if err != nil {
return m, fmt.Errorf("nats-streaming error %s ", err)
}
m.ackWaitTime = dur
}
if val, ok := meta.Properties[maxInFlight]; ok && val != "" {
max, err := strconv.ParseUint(meta.Properties[maxInFlight], 10, 64)
if err != nil {
return m, fmt.Errorf("nats-streaming error in parsemetadata for maxInFlight: %s ", err)
}
if max < 1 {
return m, errors.New("nats-streaming error: maxInFlight should be equal to or more than 1")
}
m.maxInFlight = max
}
//nolint:nestif
// subscription options - only one can be used
if val, ok := meta.Properties[startAtSequence]; ok && val != "" {
// nats streaming accepts a uint64 as sequence
seq, err := strconv.ParseUint(meta.Properties[startAtSequence], 10, 64)
if err != nil {
return m, fmt.Errorf("nats-streaming error %s ", err)
}
if seq < 1 {
return m, errors.New("nats-streaming error: startAtSequence should be equal to or more than 1")
}
m.startAtSequence = seq
} else if val, ok := meta.Properties[startWithLastReceived]; ok {
// only valid value is true
if val == startWithLastReceivedTrue {
m.startWithLastReceived = val
} else {
return m, errors.New("nats-streaming error: valid value for startWithLastReceived is true")
}
} else if val, ok := meta.Properties[deliverAll]; ok {
// only valid value is true
if val == deliverAllTrue {
m.deliverAll = val
} else {
return m, errors.New("nats-streaming error: valid value for deliverAll is true")
}
} else if val, ok := meta.Properties[deliverNew]; ok {
// only valid value is true
if val == deliverNewTrue {
m.deliverNew = val
} else {
return m, errors.New("nats-streaming error: valid value for deliverNew is true")
}
} else if val, ok := meta.Properties[startAtTimeDelta]; ok && val != "" {
dur, err := time.ParseDuration(meta.Properties[startAtTimeDelta])
if err != nil {
return m, fmt.Errorf("nats-streaming error %s ", err)
}
m.startAtTimeDelta = dur
} else if val, ok := meta.Properties[startAtTime]; ok && val != "" {
m.startAtTime = val
if val, ok := meta.Properties[startAtTimeFormat]; ok && val != "" {
m.startAtTimeFormat = val
} else {
return m, errors.New("nats-streaming error: missing value for startAtTimeFormat")
}
}
c, err := pubsub.Concurrency(meta.Properties)
if err != nil {
return m, fmt.Errorf("nats-streaming error: can't parse %s: %s", pubsub.ConcurrencyKey, err)
}
m.concurrencyMode = c
return m, nil
}
func (n *natsStreamingPubSub) Init(metadata pubsub.Metadata) error {
m, err := parseNATSStreamingMetadata(metadata)
if err != nil {
return err
}
n.metadata = m
clientID := genRandomString(20)
opts := []nats.Option{nats.Name(clientID)}
natsConn, err := nats.Connect(m.natsURL, opts...)
if err != nil {
return fmt.Errorf("nats-streaming: error connecting to nats server at %s: %s", m.natsURL, err)
}
natStreamingConn, err := stan.Connect(m.natsStreamingClusterID, clientID, stan.NatsConn(natsConn))
if err != nil {
return fmt.Errorf("nats-streaming: error connecting to nats streaming server %s: %s", m.natsStreamingClusterID, err)
}
n.logger.Debugf("connected to natsstreaming at %s", m.natsURL)
// Default retry configuration is used if no
// backOff properties are set.
if err := retry.DecodeConfigWithPrefix(
&n.backOffConfig,
metadata.Properties,
"backOff"); err != nil {
return err
}
n.natStreamingConn = natStreamingConn
return nil
}
func (n *natsStreamingPubSub) Publish(req *pubsub.PublishRequest) error {
err := n.natStreamingConn.Publish(req.Topic, req.Data)
if err != nil {
return fmt.Errorf("nats-streaming: error from publish: %s", err)
}
return nil
}
func (n *natsStreamingPubSub) Subscribe(ctx context.Context, req pubsub.SubscribeRequest, handler pubsub.Handler) error {
natStreamingsubscriptionOptions, err := n.subscriptionOptions()
if err != nil {
return fmt.Errorf("nats-streaming: error getting subscription options %s", err)
}
natsMsgHandler := func(natsMsg *stan.Msg) {
msg := pubsub.NewMessage{
Topic: req.Topic,
Data: natsMsg.Data,
}
n.logger.Debugf("Processing NATS Streaming message %s/%d", natsMsg.Subject, natsMsg.Sequence)
f := func() {
herr := handler(ctx, &msg)
if herr == nil {
natsMsg.Ack()
}
}
switch n.metadata.concurrencyMode {
case pubsub.Single:
f()
case pubsub.Parallel:
go f()
}
}
var subscription stan.Subscription
if n.metadata.subscriptionType == subscriptionTypeTopic {
subscription, err = n.natStreamingConn.Subscribe(req.Topic, natsMsgHandler, natStreamingsubscriptionOptions...)
} else if n.metadata.subscriptionType == subscriptionTypeQueueGroup {
subscription, err = n.natStreamingConn.QueueSubscribe(req.Topic, n.metadata.natsQueueGroupName, natsMsgHandler, natStreamingsubscriptionOptions...)
}
if err != nil {
return fmt.Errorf("nats-streaming: subscribe error %s", err)
}
go func() {
<-ctx.Done()
err := subscription.Unsubscribe()
if err != nil {
n.logger.Warnf("nats-streaming: error while unsubscribing from topic %s: %v", req.Topic, err)
}
}()
if n.metadata.subscriptionType == subscriptionTypeTopic {
n.logger.Debugf("nats-streaming: subscribed to subject %s", req.Topic)
} else if n.metadata.subscriptionType == subscriptionTypeQueueGroup {
n.logger.Debugf("nats-streaming: subscribed to subject %s with queue group %s", req.Topic, n.metadata.natsQueueGroupName)
}
return nil
}
func (n *natsStreamingPubSub) subscriptionOptions() ([]stan.SubscriptionOption, error) {
var options []stan.SubscriptionOption
if n.metadata.durableSubscriptionName != "" {
options = append(options, stan.DurableName(n.metadata.durableSubscriptionName))
}
switch {
case n.metadata.deliverNew == deliverNewTrue:
options = append(options, stan.StartAt(pb.StartPosition_NewOnly))
case n.metadata.startAtSequence >= 1: // messages index start from 1, this is a valid check
options = append(options, stan.StartAtSequence(n.metadata.startAtSequence))
case n.metadata.startWithLastReceived == startWithLastReceivedTrue:
options = append(options, stan.StartWithLastReceived())
case n.metadata.deliverAll == deliverAllTrue:
options = append(options, stan.DeliverAllAvailable())
case n.metadata.startAtTimeDelta > (1 * time.Nanosecond): // as long as its a valid time.Duration
options = append(options, stan.StartAtTimeDelta(n.metadata.startAtTimeDelta))
case n.metadata.startAtTime != "":
if n.metadata.startAtTimeFormat != "" {
startTime, err := time.Parse(n.metadata.startAtTimeFormat, n.metadata.startAtTime)
if err != nil {
return nil, err
}
options = append(options, stan.StartAtTime(startTime))
}
}
// default is auto ACK. switching to manual ACK since processing errors need to be handled
options = append(options, stan.SetManualAckMode())
// check if set the ack options.
if n.metadata.ackWaitTime > (1 * time.Nanosecond) {
options = append(options, stan.AckWait(n.metadata.ackWaitTime))
}
if n.metadata.maxInFlight >= 1 {
options = append(options, stan.MaxInflight(int(n.metadata.maxInFlight)))
}
return options, nil
}
const inputs = "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890"
// generates a random string of length 20.
func genRandomString(n int) string {
b := make([]byte, n)
s := rand.NewSource(int64(time.Now().Nanosecond()))
for i := range b {
b[i] = inputs[s.Int63()%int64(len(inputs))]
}
clientID := string(b)
return clientID
}
func (n *natsStreamingPubSub) Close() error {
return n.natStreamingConn.Close()
}
func (n *natsStreamingPubSub) Features() []pubsub.Feature {
return nil
}