-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
streaming_pull_test.go
467 lines (434 loc) · 13 KB
/
streaming_pull_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
// 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
// TODO(jba): test keepalive
// TODO(jba): test that expired messages are not kept alive
// TODO(jba): test that when all messages expire, Stop returns.
import (
"context"
"io"
"strconv"
"sync"
"sync/atomic"
"testing"
"time"
"cloud.google.com/go/internal/testutil"
tspb "github.com/golang/protobuf/ptypes/timestamp"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"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 (
timestamp = &tspb.Timestamp{}
testMessages = []*pb.ReceivedMessage{
{AckId: "0", Message: &pb.PubsubMessage{Data: []byte{1}, PublishTime: timestamp}},
{AckId: "1", Message: &pb.PubsubMessage{Data: []byte{2}, PublishTime: timestamp}},
{AckId: "2", Message: &pb.PubsubMessage{Data: []byte{3}, PublishTime: timestamp}},
}
)
func TestStreamingPullBasic(t *testing.T) {
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages)
testStreamingPullIteration(t, client, server, testMessages)
}
func TestStreamingPullMultipleFetches(t *testing.T) {
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages[:1])
server.addStreamingPullMessages(testMessages[1:])
testStreamingPullIteration(t, client, server, testMessages)
}
func testStreamingPullIteration(t *testing.T, client *Client, server *mockServer, msgs []*pb.ReceivedMessage) {
sub := client.Subscription("S")
gotMsgs, err := pullN(context.Background(), sub, len(msgs), func(_ context.Context, m *Message) {
id, err := strconv.Atoi(msgAckID(m))
if err != nil {
panic(err)
}
// ack evens, nack odds
if id%2 == 0 {
m.Ack()
} else {
m.Nack()
}
})
if c := status.Convert(err); err != nil && c.Code() != codes.Canceled {
t.Fatalf("Pull: %v", err)
}
gotMap := map[string]*Message{}
for _, m := range gotMsgs {
gotMap[msgAckID(m)] = m
}
for i, msg := range msgs {
want, err := toMessage(msg, time.Time{}, nil)
if err != nil {
t.Fatal(err)
}
wantAckh, _ := msgAckHandler(want)
wantAckh.calledDone = true
got := gotMap[wantAckh.ackID]
if got == nil {
t.Errorf("%d: no message for ackID %q", i, wantAckh.ackID)
continue
}
if !testutil.Equal(got, want, cmp.AllowUnexported(Message{}, psAckHandler{}), cmpopts.IgnoreTypes(time.Time{}, func(string, bool, time.Time) {})) {
t.Errorf("%d: got\n%#v\nwant\n%#v", i, got, want)
}
}
server.wait()
for i := 0; i < len(msgs); i++ {
id := msgs[i].AckId
if i%2 == 0 {
if !server.Acked[id] {
t.Errorf("msg %q should have been acked but wasn't", id)
}
} else {
if dl, ok := server.Deadlines[id]; !ok || dl != 0 {
t.Errorf("msg %q should have been nacked but wasn't", id)
}
}
}
}
func TestStreamingPullError(t *testing.T) {
// If an RPC to the service returns a non-retryable error, Pull should
// return after all callbacks return, without waiting for messages to be
// acked.
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages[:1])
server.addStreamingPullError(status.Errorf(codes.Unknown, ""))
sub := client.Subscription("S")
// Use only one goroutine, since the fake server is configured to
// return only one error.
sub.ReceiveSettings.NumGoroutines = 1
callbackDone := make(chan struct{})
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
err := sub.Receive(ctx, func(ctx context.Context, m *Message) {
defer close(callbackDone)
<-ctx.Done()
})
select {
case <-callbackDone:
default:
t.Fatal("Receive returned but callback was not done")
}
if want := codes.Unknown; status.Code(err) != want {
t.Fatalf("got <%v>, want code %v", err, want)
}
}
func TestStreamingPullCancel(t *testing.T) {
// If Receive's context is canceled, it should return after all callbacks
// return and all messages have been acked.
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages)
sub := client.Subscription("S")
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
var n int32
err := sub.Receive(ctx, func(ctx2 context.Context, m *Message) {
atomic.AddInt32(&n, 1)
defer atomic.AddInt32(&n, -1)
cancel()
m.Ack()
})
if got := atomic.LoadInt32(&n); got != 0 {
t.Fatalf("Receive returned with %d callbacks still running", got)
}
if err != nil {
t.Fatalf("Receive got <%v>, want nil", err)
}
}
func TestStreamingPullRetry(t *testing.T) {
// Check that we retry on io.EOF or Unavailable.
t.Parallel()
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages[:1])
server.addStreamingPullError(io.EOF)
server.addStreamingPullError(io.EOF)
server.addStreamingPullMessages(testMessages[1:2])
server.addStreamingPullError(status.Errorf(codes.Unavailable, ""))
server.addStreamingPullError(status.Errorf(codes.Unavailable, ""))
server.addStreamingPullMessages(testMessages[2:])
testStreamingPullIteration(t, client, server, testMessages)
}
func TestStreamingPullOneActive(t *testing.T) {
// Only one call to Pull can be active at a time.
client, srv := newMock(t)
defer client.Close()
defer srv.srv.Close()
srv.addStreamingPullMessages(testMessages[:1])
sub := client.Subscription("S")
ctx, cancel := context.WithCancel(context.Background())
err := sub.Receive(ctx, func(ctx context.Context, m *Message) {
m.Ack()
err := sub.Receive(ctx, func(context.Context, *Message) {})
if err != errReceiveInProgress {
t.Errorf("got <%v>, want <%v>", err, errReceiveInProgress)
}
cancel()
})
if err != nil {
t.Fatalf("got <%v>, want nil", err)
}
}
func TestStreamingPullConcurrent(t *testing.T) {
newMsg := func(i int) *pb.ReceivedMessage {
return &pb.ReceivedMessage{
AckId: strconv.Itoa(i),
Message: &pb.PubsubMessage{Data: []byte{byte(i)}, PublishTime: timestamp},
}
}
// Multiple goroutines should be able to read from the same iterator.
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
// Add a lot of messages, a few at a time, to make sure both threads get a chance.
nMessages := 100
for i := 0; i < nMessages; i += 2 {
server.addStreamingPullMessages([]*pb.ReceivedMessage{newMsg(i), newMsg(i + 1)})
}
sub := client.Subscription("S")
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
gotMsgs, err := pullN(ctx, sub, nMessages, func(ctx context.Context, m *Message) {
m.Ack()
})
if c := status.Convert(err); err != nil && c.Code() != codes.Canceled {
t.Fatalf("Pull: %v", err)
}
seen := map[string]bool{}
for _, gm := range gotMsgs {
if seen[msgAckID(gm)] {
t.Fatalf("duplicate ID %q", msgAckID(gm))
}
seen[msgAckID(gm)] = true
}
if len(seen) != nMessages {
t.Fatalf("got %d messages, want %d", len(seen), nMessages)
}
}
func TestStreamingPullFlowControl(t *testing.T) {
// Callback invocations should not occur if flow control limits are exceeded.
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages)
sub := client.Subscription("S")
sub.ReceiveSettings.MaxOutstandingMessages = 2
ctx, cancel := context.WithCancel(context.Background())
activec := make(chan int)
waitc := make(chan int)
errc := make(chan error)
go func() {
errc <- sub.Receive(ctx, func(_ context.Context, m *Message) {
activec <- 1
<-waitc
m.Ack()
})
}()
// Here, two callbacks are active. Receive should be blocked in the flow
// control acquire method on the third message.
for i := 0; i < 2; i++ {
select {
case <-activec:
case <-time.After(time.Second):
t.Fatalf("timed out waiting for message %d", i+1)
}
}
select {
case <-activec:
t.Fatal("third callback in progress")
case <-time.After(100 * time.Millisecond):
}
cancel()
// Receive still has not returned, because both callbacks are still blocked on waitc.
select {
case err := <-errc:
t.Fatalf("Receive returned early with error %v", err)
case <-time.After(100 * time.Millisecond):
}
// Let both callbacks proceed.
waitc <- 1
waitc <- 1
// The third callback will never run, because acquire returned a non-nil
// error, causing Receive to return. So now Receive should end.
if err := <-errc; err != nil {
t.Fatalf("got %v from Receive, want nil", err)
}
}
func TestStreamingPull_ClosedClient(t *testing.T) {
ctx := context.Background()
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages)
sub := client.Subscription("S")
sub.ReceiveSettings.MaxOutstandingBytes = 1
recvFinished := make(chan error)
go func() {
err := sub.Receive(ctx, func(_ context.Context, m *Message) {
m.Ack()
})
recvFinished <- err
}()
// wait for receives to happen
time.Sleep(100 * time.Millisecond)
if err := client.Close(); err != nil {
t.Fatalf("Got error while closing client: %v", err)
}
// wait for things to close
time.Sleep(100 * time.Millisecond)
select {
case recvErr := <-recvFinished:
s, ok := status.FromError(recvErr)
if !ok {
t.Fatalf("Expected a gRPC failure, got %v", recvErr)
}
if s.Code() != codes.Canceled {
t.Fatalf("Expected canceled, got %v", s.Code())
}
case <-time.After(time.Second):
t.Fatal("Receive should have exited immediately after the client was closed, but it did not")
}
}
func TestStreamingPull_RetriesAfterUnavailable(t *testing.T) {
ctx := context.Background()
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
unavail := status.Error(codes.Unavailable, "There is no connection available")
server.addStreamingPullMessages(testMessages)
server.addStreamingPullError(unavail)
server.addAckResponse(unavail)
server.addModAckResponse(unavail)
server.addStreamingPullMessages(testMessages)
server.addStreamingPullError(unavail)
sub := client.Subscription("S")
sub.ReceiveSettings.MaxOutstandingBytes = 1
recvErr := make(chan error, 1)
recvdMsgs := make(chan *Message, len(testMessages)*2)
go func() {
recvErr <- sub.Receive(ctx, func(_ context.Context, m *Message) {
m.Ack()
recvdMsgs <- m
})
}()
// wait for receive to happen
var n int
for {
select {
case <-time.After(10 * time.Second):
t.Fatalf("timed out waiting for all message to arrive. got %d messages total", n)
case err := <-recvErr:
t.Fatal(err)
case <-recvdMsgs:
n++
if n == len(testMessages)*2 {
return
}
}
}
}
func TestStreamingPull_ReconnectsAfterServerDies(t *testing.T) {
ctx := context.Background()
client, server := newMock(t)
defer server.srv.Close()
defer client.Close()
server.addStreamingPullMessages(testMessages)
sub := client.Subscription("S")
sub.ReceiveSettings.MaxOutstandingBytes = 1
recvErr := make(chan error, 1)
recvdMsgs := make(chan interface{}, len(testMessages)*2)
go func() {
recvErr <- sub.Receive(ctx, func(_ context.Context, m *Message) {
m.Ack()
recvdMsgs <- struct{}{}
})
}()
// wait for receive to happen
var n int
for {
select {
case <-time.After(5 * time.Second):
t.Fatalf("timed out waiting for all message to arrive. got %d messages total", n)
case err := <-recvErr:
t.Fatal(err)
case <-recvdMsgs:
n++
if n == len(testMessages) {
// Restart the server
server.srv.Close()
server2, err := newMockServer(server.srv.Port)
if err != nil {
t.Fatal(err)
}
defer server2.srv.Close()
server2.addStreamingPullMessages(testMessages)
}
if n == len(testMessages)*2 {
return
}
}
}
}
func newMock(t *testing.T) (*Client, *mockServer) {
srv, err := newMockServer(0)
if err != nil {
t.Fatal(err)
}
conn, err := grpc.Dial(srv.Addr, grpc.WithInsecure())
if err != nil {
t.Fatal(err)
}
opts := withGRPCHeadersAssertion(t, option.WithGRPCConn(conn))
client, err := NewClient(context.Background(), "P", opts...)
if err != nil {
t.Fatal(err)
}
return client, srv
}
// pullN calls sub.Receive until at least n messages are received.
func pullN(ctx context.Context, sub *Subscription, n int, f func(context.Context, *Message)) ([]*Message, error) {
var (
mu sync.Mutex
msgs []*Message
)
cctx, cancel := context.WithCancel(ctx)
err := sub.Receive(cctx, func(ctx context.Context, m *Message) {
mu.Lock()
msgs = append(msgs, m)
nSeen := len(msgs)
mu.Unlock()
f(ctx, m)
if nSeen >= n {
cancel()
}
})
if err != nil {
return msgs, err
}
return msgs, nil
}