-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
iterator_test.go
539 lines (469 loc) · 16.6 KB
/
iterator_test.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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
// Copyright 2017 Google LLC
//
// 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 pubsub
import (
"bytes"
"context"
"errors"
"fmt"
"reflect"
"sync"
"sync/atomic"
"testing"
"time"
"cloud.google.com/go/internal/testutil"
"cloud.google.com/go/pubsub/pstest"
"google.golang.org/api/option"
pb "google.golang.org/genproto/googleapis/pubsub/v1"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
)
var (
projName = "some-project"
topicName = "some-topic"
fullyQualifiedTopicName = fmt.Sprintf("projects/%s/topics/%s", projName, topicName)
)
func TestSplitRequestIDs(t *testing.T) {
t.Parallel()
ids := []string{"aaaa", "bbbb", "cccc", "dddd", "eeee"}
for _, test := range []struct {
ids []string
splitIndex int
}{
{[]string{}, 0},
{ids, 2},
{ids[:2], 2},
} {
got1, got2 := splitRequestIDs(test.ids, 15)
want1, want2 := test.ids[:test.splitIndex], test.ids[test.splitIndex:]
if !testutil.Equal(got1, want1) {
t.Errorf("%v, 1: got %v, want %v", test, got1, want1)
}
if !testutil.Equal(got2, want2) {
t.Errorf("%v, 2: got %v, want %v", test, got2, want2)
}
}
}
func TestCalcFieldSize(t *testing.T) {
t.Parallel()
// Create a mock ack request to test.
req := &pb.AcknowledgeRequest{
Subscription: "sub",
AckIds: []string{"aaa", "bbb", "ccc", "ddd", "eee"},
}
size := calcFieldSizeString(req.Subscription) + calcFieldSizeString(req.AckIds...)
// Proto encoding is calculated from 1 tag byte and 1 size byte for each string.
want := (1 + 1) + len(req.Subscription) + // subscription field: 1 tag byte + 1 size byte
5*(1+1+3) // ackID size: 5 * [1 (tag byte) + 1 (size byte) + 3 (length of ackID)]
if size != want {
t.Errorf("pubsub: calculated ack req size of %d bytes, want %d", size, want)
}
req.Subscription = string(bytes.Repeat([]byte{'A'}, 300))
size = calcFieldSizeString(req.Subscription) + calcFieldSizeString(req.AckIds...)
// With a longer subscription name, we use an extra size byte.
want = (1 + 2) + len(req.Subscription) + // subscription field: 1 tag byte + 2 size bytes
5*(1+1+3) // ackID size: 5 * [1 (tag byte) + 1 (size byte) + 3 (length of ackID)]
if size != want {
t.Errorf("pubsub: calculated ack req size of %d bytes, want %d", size, want)
}
// Create a mock modack request to test.
modAckReq := &pb.ModifyAckDeadlineRequest{
Subscription: "sub",
AckIds: []string{"aaa", "bbb", "ccc", "ddd", "eee"},
AckDeadlineSeconds: 300,
}
size = calcFieldSizeString(modAckReq.Subscription) +
calcFieldSizeString(modAckReq.AckIds...) +
calcFieldSizeInt(int(modAckReq.AckDeadlineSeconds))
want = (1 + 1) + len(modAckReq.Subscription) + // subscription field: 1 tag byte + 1 size byte
5*(1+1+3) + // ackID size: 5 * [1 (tag byte) + 1 (size byte) + 3 (length of ackID)]
(1 + 2) // ackDeadline: 1 tag byte + 2 size bytes
if size != want {
t.Errorf("pubsub: calculated modAck req size of %d bytes, want %d", size, want)
}
}
func TestMaxExtensionPeriod(t *testing.T) {
srv := pstest.NewServer()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
srv.Publish(fullyQualifiedTopicName, []byte("creating a topic"), nil)
_, client, err := initConn(ctx, srv.Addr)
if err != nil {
t.Fatal(err)
}
want := 15 * time.Second
iter := newMessageIterator(client.subc, fullyQualifiedTopicName, &pullOptions{
maxExtensionPeriod: want,
})
// Add a datapoint that's greater than maxExtensionPeriod.
receiveTime := time.Now().Add(time.Duration(-20) * time.Second)
iter.ackTimeDist.Record(int(time.Since(receiveTime) / time.Second))
if got := iter.ackDeadline(); got != want {
t.Fatalf("deadline got = %v, want %v", got, want)
}
}
func TestAckDistribution(t *testing.T) {
if testing.Short() {
t.SkipNow()
}
t.Skip("broken")
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
minDurationPerLeaseExtension = 1 * time.Second
pstest.SetMinAckDeadline(minDurationPerLeaseExtension)
srv := pstest.NewServer()
defer srv.Close()
defer pstest.ResetMinAckDeadline()
// Create the topic via a Publish. It's convenient to do it here as opposed to client.CreateTopic because the client
// has not been established yet, and also because we want to create the topic once whereas the client is established
// below twice.
srv.Publish(fullyQualifiedTopicName, []byte("creating a topic"), nil)
queuedMsgs := make(chan int32, 1024)
go continuouslySend(ctx, srv, queuedMsgs)
for _, testcase := range []struct {
initialProcessSecs int32
finalProcessSecs int32
}{
{initialProcessSecs: 3, finalProcessSecs: 5}, // Process time goes up
{initialProcessSecs: 5, finalProcessSecs: 3}, // Process time goes down
} {
t.Logf("Testing %d -> %d", testcase.initialProcessSecs, testcase.finalProcessSecs)
// processTimeSecs is used by the sender to coordinate with the receiver how long the receiver should
// pretend to process for. e.g. if we test 3s -> 5s, processTimeSecs will start at 3, causing receiver
// to process messages received for 3s while sender sends the first batch. Then, as sender begins to
// send the next batch, sender will swap processTimeSeconds to 5s and begin sending, and receiver will
// process each message for 5s. In this way we simulate a client whose time-to-ack (process time) changes.
processTimeSecs := testcase.initialProcessSecs
s, client, err := initConn(ctx, srv.Addr)
if err != nil {
t.Fatal(err)
}
// recvdWg increments for each message sent, and decrements for each message received.
recvdWg := &sync.WaitGroup{}
go startReceiving(ctx, t, s, recvdWg, &processTimeSecs)
startSending(t, queuedMsgs, &processTimeSecs, testcase.initialProcessSecs, testcase.finalProcessSecs, recvdWg)
recvdWg.Wait()
time.Sleep(100 * time.Millisecond) // Wait a bit more for resources to clean up
err = client.Close()
if err != nil {
t.Fatal(err)
}
modacks := modacksByTime(srv.Messages())
u := modackDeadlines(modacks)
initialDL := int32(minDurationPerLeaseExtension / time.Second)
if !setsAreEqual(u, []int32{initialDL, testcase.initialProcessSecs, testcase.finalProcessSecs}) {
t.Fatalf("Expected modack deadlines to contain (exactly, and only) %ds, %ds, %ds. Instead, got %v",
initialDL, testcase.initialProcessSecs, testcase.finalProcessSecs, toSet(u))
}
}
}
// modacksByTime buckets modacks by time.
func modacksByTime(msgs []*pstest.Message) map[time.Time][]pstest.Modack {
modacks := map[time.Time][]pstest.Modack{}
for _, msg := range msgs {
for _, m := range msg.Modacks {
modacks[m.ReceivedAt] = append(modacks[m.ReceivedAt], m)
}
}
return modacks
}
// setsAreEqual reports whether a and b contain the same values, ignoring duplicates.
func setsAreEqual(haystack, needles []int32) bool {
hMap := map[int32]bool{}
nMap := map[int32]bool{}
for _, n := range needles {
nMap[n] = true
}
for _, n := range haystack {
hMap[n] = true
}
return reflect.DeepEqual(nMap, hMap)
}
// startReceiving pretends to be a client. It calls s.Receive and acks messages after some random delay. It also
// looks out for dupes - any message that arrives twice will cause a failure.
func startReceiving(ctx context.Context, t *testing.T, s *Subscription, recvdWg *sync.WaitGroup, processTimeSecs *int32) {
t.Log("Receiving..")
var recvdMu sync.Mutex
recvd := map[string]bool{}
err := s.Receive(ctx, func(ctx context.Context, msg *Message) {
msgData := string(msg.Data)
recvdMu.Lock()
_, ok := recvd[msgData]
if ok {
recvdMu.Unlock()
t.Fatalf("already saw \"%s\"\n", msgData)
return
}
recvd[msgData] = true
recvdMu.Unlock()
select {
case <-ctx.Done():
msg.Nack()
recvdWg.Done()
case <-time.After(time.Duration(atomic.LoadInt32(processTimeSecs)) * time.Second):
msg.Ack()
recvdWg.Done()
}
})
if err != nil {
if status.Code(err) != codes.Canceled {
t.Error(err)
}
}
}
// startSending sends four batches of messages broken up by minDeadline, initialProcessSecs, and finalProcessSecs.
func startSending(t *testing.T, queuedMsgs chan int32, processTimeSecs *int32, initialProcessSecs int32, finalProcessSecs int32, recvdWg *sync.WaitGroup) {
var msg int32
// We must send this block to force the receiver to send its initially-configured modack time. The time that
// gets sent should be ignorant of the distribution, since there haven't been enough (any, actually) messages
// to create a distribution yet.
t.Log("minAckDeadlineSecsSending an initial message")
recvdWg.Add(1)
msg++
queuedMsgs <- msg
<-time.After(minDurationPerLeaseExtension)
t.Logf("Sending some messages to update distribution to %d. This new distribution will be used "+
"when the next batch of messages go out.", initialProcessSecs)
for i := 0; i < 10; i++ {
recvdWg.Add(1)
msg++
queuedMsgs <- msg
}
atomic.SwapInt32(processTimeSecs, finalProcessSecs)
<-time.After(time.Duration(initialProcessSecs) * time.Second)
t.Logf("Sending many messages to update distribution to %d. This new distribution will be used "+
"when the next batch of messages go out.", finalProcessSecs)
for i := 0; i < 100; i++ {
recvdWg.Add(1)
msg++
queuedMsgs <- msg // Send many messages to drastically change distribution
}
<-time.After(time.Duration(finalProcessSecs) * time.Second)
t.Logf("Last message going out, whose deadline should be %d.", finalProcessSecs)
recvdWg.Add(1)
msg++
queuedMsgs <- msg
}
// continuouslySend continuously sends messages that exist on the queuedMsgs chan.
func continuouslySend(ctx context.Context, srv *pstest.Server, queuedMsgs chan int32) {
for {
select {
case <-ctx.Done():
return
case m := <-queuedMsgs:
srv.Publish(fullyQualifiedTopicName, []byte(fmt.Sprintf("message %d", m)), nil)
}
}
}
func toSet(arr []int32) []int32 {
var s []int32
m := map[int32]bool{}
for _, v := range arr {
_, ok := m[v]
if !ok {
s = append(s, v)
m[v] = true
}
}
return s
}
func initConn(ctx context.Context, addr string) (*Subscription, *Client, error) {
conn, err := grpc.Dial(addr, grpc.WithInsecure())
if err != nil {
return nil, nil, err
}
e := testutil.DefaultHeadersEnforcer()
opts := append(e.CallOptions(), option.WithGRPCConn(conn))
client, err := NewClient(ctx, projName, opts...)
if err != nil {
return nil, nil, err
}
topic := client.Topic(topicName)
s, err := client.CreateSubscription(ctx, fmt.Sprintf("sub-%d", time.Now().UnixNano()), SubscriptionConfig{Topic: topic})
if err != nil {
return nil, nil, err
}
exists, err := s.Exists(ctx)
if !exists {
return nil, nil, errors.New("Subscription does not exist")
}
if err != nil {
return nil, nil, err
}
return s, client, nil
}
// modackDeadlines takes a map of time => Modack, gathers all the Modack.AckDeadlines,
// and returns them as a slice
func modackDeadlines(m map[time.Time][]pstest.Modack) []int32 {
var u []int32
for _, vv := range m {
for _, v := range vv {
u = append(u, v.AckDeadline)
}
}
return u
}
func TestIterator_ModifyAckContextDeadline(t *testing.T) {
// Test that all context deadline exceeded errors in ModAckDeadline
// are not propagated to the client.
opts := []pstest.ServerReactorOption{
pstest.WithErrorInjection("ModifyAckDeadline", codes.Unknown, "context deadline exceeded"),
}
srv := pstest.NewServer(opts...)
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
srv.Publish(fullyQualifiedTopicName, []byte("creating a topic"), nil)
s, client, err := initConn(ctx, srv.Addr)
if err != nil {
t.Fatal(err)
}
srv.Publish(fullyQualifiedTopicName, []byte("some-message"), nil)
cctx, cancel := context.WithTimeout(ctx, time.Duration(5*time.Second))
defer cancel()
err = s.Receive(cctx, func(ctx context.Context, m *Message) {
m.Ack()
})
if err != nil {
t.Fatalf("Got error in Receive: %v", err)
}
err = client.Close()
if err != nil {
t.Fatal(err)
}
}
func TestIterator_SynchronousPullCancel(t *testing.T) {
srv := pstest.NewServer()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
srv.Publish(fullyQualifiedTopicName, []byte("creating a topic"), nil)
_, client, err := initConn(ctx, srv.Addr)
if err != nil {
t.Fatal(err)
}
iter := newMessageIterator(client.subc, fullyQualifiedTopicName, &pullOptions{})
// Cancelling the iterator and pulling should not result in any errors.
iter.cancel()
if _, err := iter.pullMessages(100); err != nil {
t.Fatalf("Got error in pullMessages: %v", err)
}
}
func TestIterator_BoundedDuration(t *testing.T) {
// Use exported fields for time.Duration fields so they
// print nicely. Otherwise, they will print as integers.
//
// AckDeadline is bounded by min/max ack deadline, which are
// 10 seconds and 600 seconds respectively. This is
// true for the real distribution data points as well.
testCases := []struct {
desc string
AckDeadline time.Duration
MinDuration time.Duration
MaxDuration time.Duration
exactlyOnce bool
Want time.Duration
}{
{
desc: "AckDeadline should be updated to the min duration",
AckDeadline: time.Duration(10 * time.Second),
MinDuration: time.Duration(15 * time.Second),
MaxDuration: time.Duration(10 * time.Minute),
exactlyOnce: false,
Want: time.Duration(15 * time.Second),
},
{
desc: "AckDeadline should be updated to 1 minute when using exactly once",
AckDeadline: time.Duration(10 * time.Second),
MinDuration: 0,
MaxDuration: time.Duration(10 * time.Minute),
exactlyOnce: true,
Want: time.Duration(1 * time.Minute),
},
{
desc: "AckDeadline should not be updated here, even though exactly once is enabled",
AckDeadline: time.Duration(10 * time.Second),
MinDuration: time.Duration(15 * time.Second),
MaxDuration: time.Duration(10 * time.Minute),
exactlyOnce: true,
Want: time.Duration(15 * time.Second),
},
{
desc: "AckDeadline should not be updated here",
AckDeadline: time.Duration(10 * time.Minute),
MinDuration: time.Duration(15 * time.Second),
MaxDuration: time.Duration(10 * time.Minute),
exactlyOnce: true,
Want: time.Duration(10 * time.Minute),
},
{
desc: "AckDeadline should not be updated when neither durations are set",
AckDeadline: time.Duration(5 * time.Minute),
MinDuration: 0,
MaxDuration: 0,
exactlyOnce: false,
Want: time.Duration(5 * time.Minute),
},
{
desc: "AckDeadline should should not be updated here since it is within both boundaries",
AckDeadline: time.Duration(5 * time.Minute),
MinDuration: time.Duration(1 * time.Minute),
MaxDuration: time.Duration(7 * time.Minute),
exactlyOnce: false,
Want: time.Duration(5 * time.Minute),
},
}
for _, tc := range testCases {
t.Run(tc.desc, func(t *testing.T) {
got := boundedDuration(tc.AckDeadline, tc.MinDuration, tc.MaxDuration, tc.exactlyOnce)
if got != tc.Want {
t.Errorf("boundedDuration mismatch:\n%+v\ngot: %v, want: %v", tc, got, tc.Want)
}
})
}
}
func TestAddToDistribution(t *testing.T) {
srv := pstest.NewServer()
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
srv.Publish(fullyQualifiedTopicName, []byte("creating a topic"), nil)
_, client, err := initConn(ctx, srv.Addr)
if err != nil {
t.Fatal(err)
}
iter := newMessageIterator(client.subc, fullyQualifiedTopicName, &pullOptions{})
// Start with a datapoint that's too small that should be bounded to 10s.
receiveTime := time.Now().Add(time.Duration(-1) * time.Second)
iter.addToDistribution(receiveTime)
deadline := iter.ackTimeDist.Percentile(.99)
want := 10
if deadline != want {
t.Errorf("99th percentile ack distribution got: %v, want %v", deadline, want)
}
// The next datapoint should not be bounded.
receiveTime = time.Now().Add(time.Duration(-300) * time.Second)
iter.addToDistribution(receiveTime)
deadline = iter.ackTimeDist.Percentile(.99)
want = 300
if deadline != want {
t.Errorf("99th percentile ack distribution got: %v, want %v", deadline, want)
}
// Lastly, add a datapoint that should be bounded to 600s
receiveTime = time.Now().Add(time.Duration(-1000) * time.Second)
iter.addToDistribution(receiveTime)
deadline = iter.ackTimeDist.Percentile(.99)
want = 600
if deadline != want {
t.Errorf("99th percentile ack distribution got: %v, want %v", deadline, want)
}
}