-
Notifications
You must be signed in to change notification settings - Fork 143
Expand file tree
/
Copy pathinterceptor_ext_test.go
More file actions
996 lines (911 loc) · 35.3 KB
/
interceptor_ext_test.go
File metadata and controls
996 lines (911 loc) · 35.3 KB
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
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
// Copyright 2021-2026 The Connect 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 connect_test
import (
"context"
"errors"
"fmt"
"io"
"net/http"
"sync/atomic"
"testing"
connect "connectrpc.com/connect"
"connectrpc.com/connect/internal/assert"
pingv1 "connectrpc.com/connect/internal/gen/connect/ping/v1"
"connectrpc.com/connect/internal/gen/generics/connect/ping/v1/pingv1connect"
pingv1connectsimple "connectrpc.com/connect/internal/gen/simple/connect/ping/v1/pingv1connect"
"connectrpc.com/connect/internal/memhttp"
"connectrpc.com/connect/internal/memhttp/memhttptest"
)
const expectedContextErrorMessage = "creating a new context in an interceptor is prohibited"
func TestNewClientContextInInterceptor(t *testing.T) {
t.Parallel()
t.Run("simple_api", func(t *testing.T) {
t.Parallel()
mux := http.NewServeMux()
mux.Handle(
pingv1connectsimple.NewPingServiceHandler(
pingServerSimple{},
),
)
server := memhttptest.NewServer(t, mux)
t.Run("first_interceptor", func(t *testing.T) {
t.Parallel()
// Because we're creating a new context in the first interceptor, only the first interceptor should fire
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connectsimple.PingServiceClient {
opts := connect.WithInterceptors(
&contextInterceptor{client: true, count: counter1, createNewContext: true},
&contextInterceptor{client: true, count: counter2},
)
return pingv1connectsimple.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), &pingv1.PingRequest{Number: 10})
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), &pingv1.CountUpRequest{Number: 10})
assert.Nil(t, stream)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
// With client-streaming and the simple API, the initial call fails. This differs from
// the generics API which requires a call to stream.Send first to receive an error.
stream, err := client.Sum(t.Context())
assert.NotNil(t, err)
assert.Nil(t, stream)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
// With bidi-streaming and the simple API, the initial call fails. This differs from
// the generics API which requires a call to stream.Send first to receive an error.
stream, err := client.CumSum(t.Context())
assert.NotNil(t, err)
assert.Nil(t, stream)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
})
t.Run("subsequent_interceptor", func(t *testing.T) {
t.Parallel()
// Because we're creating a new context in the last interceptor, all interceptors should fire
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connectsimple.PingServiceClient {
opts := connect.WithInterceptors(
&contextInterceptor{client: true, count: counter1},
&contextInterceptor{client: true, count: counter2, createNewContext: true},
)
return pingv1connectsimple.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), &pingv1.PingRequest{Number: 10})
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), &pingv1.CountUpRequest{Number: 10})
assert.Nil(t, stream)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
// With client-streaming and the simple API, the initial call fails. This differs from
// the generics API which requires a call to stream.Send first to receive an error.
stream, err := client.Sum(t.Context())
assert.NotNil(t, err)
assert.Nil(t, stream)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
// With bidi-streaming and the simple API, the initial call fails. This differs from
// the generics API which requires a call to stream.Send first to receive an error.
stream, err := client.CumSum(t.Context())
assert.NotNil(t, err)
assert.Nil(t, stream)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
})
t.Run("sidequest_succeeds", func(t *testing.T) {
t.Parallel()
// These tests create a new context but it is used to issue a separate/new request and not reused in the
// interceptor chain. So, all interceptors should fire and no errors should be returned.
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connectsimple.PingServiceClient {
opts := connect.WithInterceptors(
newSideQuestInterceptor(t, counter1, server),
newSideQuestInterceptor(t, counter2, server),
)
return pingv1connectsimple.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), &pingv1.PingRequest{Number: 10})
assert.NotNil(t, resp)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), &pingv1.CountUpRequest{Number: 10})
assert.NotNil(t, stream)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
assert.Nil(t, stream.Close())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.Sum(t.Context())
assert.NotNil(t, stream)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
resp, err := stream.CloseAndReceive()
assert.Nil(t, err)
assert.NotNil(t, resp)
})
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CumSum(t.Context())
assert.Nil(t, err)
assert.NotNil(t, stream)
assert.Nil(t, stream.CloseRequest())
assert.Nil(t, stream.CloseResponse())
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
})
})
t.Run("generics_api", func(t *testing.T) {
t.Parallel()
mux := http.NewServeMux()
mux.Handle(
pingv1connectsimple.NewPingServiceHandler(
pingServerSimple{},
),
)
server := memhttptest.NewServer(t, mux)
t.Run("first_interceptor", func(t *testing.T) {
t.Parallel()
// Because we're creating a new context in the first interceptor, only the first interceptor should fire
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connect.PingServiceClient {
opts := connect.WithInterceptors(
&contextInterceptor{client: true, count: counter1, createNewContext: true},
&contextInterceptor{client: true, count: counter2},
)
return pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{Number: 10}))
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), connect.NewRequest(&pingv1.CountUpRequest{Number: 10}))
assert.Nil(t, stream)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.Sum(t.Context())
assert.NotNil(t, stream)
// With client-streaming and the generics API, a call to stream.Send is required to receive an error.
err := stream.Send(&pingv1.SumRequest{Number: int64(1)})
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
// We should receive the same error when we try to close the stream
resp, err := stream.CloseAndReceive()
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
//nolint:dupl // the test logic for bidi w/r/t generic and simple api looks the same, but it's subtly different
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.CumSum(t.Context())
assert.NotNil(t, stream)
// With bidi-streaming and the generics API, a call to stream.Send is required to receive an error.
err := stream.Send(&pingv1.CumSumRequest{Number: 1})
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
// We should receive the same error when we try to close the send and receive parts of the stream
err = stream.CloseRequest()
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
err = stream.CloseResponse()
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(0), clientCounter2.Load())
})
})
t.Run("subsequent_interceptor", func(t *testing.T) {
t.Parallel()
// Because we're creating a new context in the last interceptor, all interceptors should fire
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connect.PingServiceClient {
opts := connect.WithInterceptors(
&contextInterceptor{client: true, count: counter1},
&contextInterceptor{client: true, count: counter2, createNewContext: true},
)
return pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{Number: 10}))
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), connect.NewRequest(&pingv1.CountUpRequest{Number: 10}))
assert.Nil(t, stream)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.Sum(t.Context())
assert.NotNil(t, stream)
// With client-streaming and the generics API, a call to stream.Send is required to receive an error.
err := stream.Send(&pingv1.SumRequest{Number: int64(1)})
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
// We should receive the same error when we try to close the stream
resp, err := stream.CloseAndReceive()
assert.Nil(t, resp)
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
//nolint:dupl // the test logic for bidi w/r/t generic and simple api looks the same, but it's subtly different
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.CumSum(t.Context())
assert.NotNil(t, stream)
// With bidi-streaming and the generics API, a call to stream.Send is required to receive an error.
err := stream.Send(&pingv1.CumSumRequest{Number: 1})
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
// We should receive the same error when we try to close the send and receive parts of the stream
err = stream.CloseRequest()
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
err = stream.CloseResponse()
assert.NotNil(t, err)
assert.Equal(t, err.Error(), expectedContextErrorMessage)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
})
t.Run("sidequest_succeeds", func(t *testing.T) {
t.Parallel()
// These tests create a new context but it is used to issue a separate/new request and not reused in the
// interceptor chain. So, all interceptors should fire and no errors should be returned.
createClient := func(counter1 *atomic.Int32, counter2 *atomic.Int32) pingv1connect.PingServiceClient {
opts := connect.WithInterceptors(
newSideQuestInterceptor(t, counter1, server),
newSideQuestInterceptor(t, counter2, server),
)
return pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
opts,
)
}
t.Run("unary", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
resp, err := client.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{Number: 10}))
assert.NotNil(t, resp)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("server_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream, err := client.CountUp(t.Context(), connect.NewRequest(&pingv1.CountUpRequest{Number: 10}))
assert.NotNil(t, stream)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
assert.Nil(t, stream.Close())
})
t.Run("client_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.Sum(t.Context())
assert.NotNil(t, stream)
err := stream.Send(&pingv1.SumRequest{Number: int64(1)})
assert.Nil(t, err)
resp, err := stream.CloseAndReceive()
assert.NotNil(t, resp)
assert.Nil(t, err)
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
t.Run("bidi_stream", func(t *testing.T) {
t.Parallel()
var clientCounter1, clientCounter2 atomic.Int32
client := createClient(&clientCounter1, &clientCounter2)
stream := client.CumSum(t.Context())
assert.NotNil(t, stream)
// The initial send should succeed
err := stream.Send(&pingv1.CumSumRequest{Number: 1})
assert.Nil(t, err)
// We should be able to successfully close the send part of the stream
assert.Nil(t, stream.CloseRequest())
// All receives should succeed
for {
msg, err := stream.Receive()
if errors.Is(err, io.EOF) {
break
}
assert.NotNil(t, msg)
assert.Nil(t, err)
}
// We should be able to successfully close the receive part of the stream
assert.Nil(t, stream.CloseResponse())
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
})
})
})
}
func TestOnionOrderingEndToEnd(t *testing.T) {
t.Parallel()
// Helper function: returns a function that asserts that there's some value
// set for header "expect", and adds a value for header "add".
newInspector := func(expect, add string) func(connect.Spec, http.Header) {
return func(spec connect.Spec, header http.Header) {
if expect != "" {
assert.NotZero(
t,
header.Get(expect),
assert.Sprintf(
"%s (IsClient %v): header %q missing: %v",
spec.Procedure,
spec.IsClient,
expect,
header,
),
)
}
header.Set(add, "v")
}
}
// Helper function: asserts that there's a value present for header keys
// "one", "two", "three", and "four".
assertAllPresent := func(spec connect.Spec, header http.Header) {
for _, key := range []string{"one", "two", "three", "four"} {
assert.NotZero(
t,
header.Get(key),
assert.Sprintf(
"%s (IsClient %v): checking all headers, %q missing: %v",
spec.Procedure,
spec.IsClient,
key,
header,
),
)
}
}
var clientCounter1, clientCounter2, clientCounter3, handlerCounter1, handlerCounter2, handlerCounter3 atomic.Int32
// The client and handler interceptor onions are the meat of the test. The
// order of interceptor execution must be the same for unary and streaming
// procedures.
//
// Requests should fall through the client onion from top to bottom, traverse
// the network, and then fall through the handler onion from top to bottom.
// Responses should climb up the handler onion, traverse the network, and
// then climb up the client onion.
//
// The request and response sides of this onion are numbered to make the
// intended order clear.
clientOnion := connect.WithInterceptors(
newHeaderInterceptor(
&clientCounter1,
// 1 (start). request: should see protocol-related headers
func(_ connect.Spec, h http.Header) {
assert.NotZero(t, h.Get("Content-Type"))
},
// 12 (end). response: check "one"-"four"
assertAllPresent,
),
newHeaderInterceptor(
&clientCounter2,
newInspector("", "one"), // 2. request: add header "one"
newInspector("three", "four"), // 11. response: check "three", add "four"
),
newHeaderInterceptor(
&clientCounter3,
newInspector("one", "two"), // 3. request: check "one", add "two"
newInspector("two", "three"), // 10. response: check "two", add "three"
),
)
handlerOnion := connect.WithInterceptors(
newHeaderInterceptor(
&handlerCounter1,
newInspector("two", "three"), // 4. request: check "two", add "three"
newInspector("one", "two"), // 9. response: check "one", add "two"
),
newHeaderInterceptor(
&handlerCounter2,
newInspector("three", "four"), // 5. request: check "three", add "four"
newInspector("", "one"), // 8. response: add "one"
),
newHeaderInterceptor(
&handlerCounter3,
assertAllPresent, // 6. request: check "one"-"four"
nil, // 7. response: no-op
),
)
mux := http.NewServeMux()
mux.Handle(
pingv1connect.NewPingServiceHandler(
pingServer{},
handlerOnion,
),
)
server := memhttptest.NewServer(t, mux)
client := pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
clientOnion,
)
_, err := client.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{Number: 10}))
assert.Nil(t, err)
// make sure the interceptors were actually invoked
assert.Equal(t, int32(1), clientCounter1.Load())
assert.Equal(t, int32(1), clientCounter2.Load())
assert.Equal(t, int32(1), clientCounter3.Load())
assert.Equal(t, int32(1), handlerCounter1.Load())
assert.Equal(t, int32(1), handlerCounter2.Load())
assert.Equal(t, int32(1), handlerCounter3.Load())
responses, err := client.CountUp(t.Context(), connect.NewRequest(&pingv1.CountUpRequest{Number: 10}))
assert.Nil(t, err)
var sum int64
for responses.Receive() {
sum += responses.Msg().GetNumber()
}
assert.Equal(t, sum, 55)
assert.Nil(t, responses.Close())
// make sure the interceptors were invoked again
assert.Equal(t, int32(2), clientCounter1.Load())
assert.Equal(t, int32(2), clientCounter2.Load())
assert.Equal(t, int32(2), clientCounter3.Load())
assert.Equal(t, int32(2), handlerCounter1.Load())
assert.Equal(t, int32(2), handlerCounter2.Load())
assert.Equal(t, int32(2), handlerCounter3.Load())
}
func TestEmptyUnaryInterceptorFunc(t *testing.T) {
t.Parallel()
mux := http.NewServeMux()
interceptor := connect.UnaryInterceptorFunc(func(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, request connect.AnyRequest) (connect.AnyResponse, error) {
return next(ctx, request)
}
})
mux.Handle(pingv1connect.NewPingServiceHandler(pingServer{}, connect.WithInterceptors(interceptor)))
server := memhttptest.NewServer(t, mux)
connectClient := pingv1connect.NewPingServiceClient(server.Client(), server.URL(), connect.WithInterceptors(interceptor))
_, err := connectClient.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{}))
assert.Nil(t, err)
sumStream := connectClient.Sum(t.Context())
assert.Nil(t, sumStream.Send(&pingv1.SumRequest{Number: 1}))
resp, err := sumStream.CloseAndReceive()
assert.Nil(t, err)
assert.NotNil(t, resp)
countUpStream, err := connectClient.CountUp(t.Context(), connect.NewRequest(&pingv1.CountUpRequest{}))
assert.Nil(t, err)
for countUpStream.Receive() {
assert.NotNil(t, countUpStream.Msg())
}
assert.Nil(t, countUpStream.Close())
}
func TestInterceptorFuncAccessingHTTPMethod(t *testing.T) {
t.Parallel()
clientChecker := &httpMethodChecker{client: true}
handlerChecker := &httpMethodChecker{}
mux := http.NewServeMux()
mux.Handle(
pingv1connect.NewPingServiceHandler(
pingServer{},
connect.WithInterceptors(handlerChecker),
),
)
server := memhttptest.NewServer(t, mux)
client := pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
connect.WithInterceptors(clientChecker),
)
pingReq := connect.NewRequest(&pingv1.PingRequest{Number: 10})
assert.Equal(t, "", pingReq.HTTPMethod())
_, err := client.Ping(t.Context(), pingReq)
assert.Nil(t, err)
assert.Equal(t, http.MethodPost, pingReq.HTTPMethod())
// make sure interceptor was invoked
assert.Equal(t, int32(1), clientChecker.count.Load())
assert.Equal(t, int32(1), handlerChecker.count.Load())
countUpReq := connect.NewRequest(&pingv1.CountUpRequest{Number: 10})
assert.Equal(t, "", countUpReq.HTTPMethod())
responses, err := client.CountUp(t.Context(), countUpReq)
assert.Nil(t, err)
var sum int64
for responses.Receive() {
sum += responses.Msg().GetNumber()
}
assert.Equal(t, sum, 55)
assert.Nil(t, responses.Close())
assert.Equal(t, http.MethodPost, countUpReq.HTTPMethod())
// make sure interceptor was invoked again
assert.Equal(t, int32(2), clientChecker.count.Load())
assert.Equal(t, int32(2), handlerChecker.count.Load())
}
func TestHandlerErrorResponseNilInInterceptor(t *testing.T) {
t.Parallel()
handlerErr := connect.NewError(connect.CodeInternal, errors.New("handler error"))
var interceptorSawNilResponse bool
checkNilInterceptor := connect.UnaryInterceptorFunc(
func(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
res, err := next(ctx, req)
// res must be nil when err is non-nil; a typed nil stored in an
// interface would make this check incorrectly report non-nil.
interceptorSawNilResponse = res == nil
return res, err
}
},
)
mux := http.NewServeMux()
mux.Handle(pingv1connect.NewPingServiceHandler(
&pluggablePingServer{
ping: func(_ context.Context, _ *connect.Request[pingv1.PingRequest]) (*connect.Response[pingv1.PingResponse], error) {
return nil, handlerErr
},
},
connect.WithInterceptors(checkNilInterceptor),
))
server := memhttptest.NewServer(t, mux)
client := pingv1connect.NewPingServiceClient(server.Client(), server.URL())
_, err := client.Ping(t.Context(), connect.NewRequest(&pingv1.PingRequest{}))
assert.NotNil(t, err)
assert.True(t, interceptorSawNilResponse)
}
// headerInterceptor makes it easier to write interceptors that inspect or
// mutate HTTP headers. It applies the same logic to unary and streaming
// procedures, wrapping the send or receive side of the stream as appropriate.
//
// It's useful as a testing harness to make sure that we're chaining
// interceptors in the correct order.
type headerInterceptor struct {
counter *atomic.Int32
inspectRequestHeader func(connect.Spec, http.Header)
inspectResponseHeader func(connect.Spec, http.Header)
}
// newHeaderInterceptor constructs a headerInterceptor. Nil function pointers
// are treated as no-ops.
func newHeaderInterceptor(
counter *atomic.Int32,
inspectRequestHeader func(connect.Spec, http.Header),
inspectResponseHeader func(connect.Spec, http.Header),
) *headerInterceptor {
interceptor := headerInterceptor{
counter: counter,
inspectRequestHeader: inspectRequestHeader,
inspectResponseHeader: inspectResponseHeader,
}
if interceptor.inspectRequestHeader == nil {
interceptor.inspectRequestHeader = func(_ connect.Spec, _ http.Header) {}
}
if interceptor.inspectResponseHeader == nil {
interceptor.inspectResponseHeader = func(_ connect.Spec, _ http.Header) {}
}
return &interceptor
}
func (h *headerInterceptor) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
h.counter.Add(1)
h.inspectRequestHeader(req.Spec(), req.Header())
res, err := next(ctx, req)
if err != nil {
return nil, err
}
h.inspectResponseHeader(req.Spec(), res.Header())
return res, nil
}
}
func (h *headerInterceptor) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc {
return func(ctx context.Context, spec connect.Spec) connect.StreamingClientConn {
h.counter.Add(1)
return &headerInspectingClientConn{
StreamingClientConn: next(ctx, spec),
inspectRequestHeader: h.inspectRequestHeader,
inspectResponseHeader: h.inspectResponseHeader,
}
}
}
func (h *headerInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc {
return func(ctx context.Context, conn connect.StreamingHandlerConn) error {
h.counter.Add(1)
h.inspectRequestHeader(conn.Spec(), conn.RequestHeader())
return next(ctx, &headerInspectingHandlerConn{
StreamingHandlerConn: conn,
inspectResponseHeader: h.inspectResponseHeader,
})
}
}
type headerInspectingHandlerConn struct {
connect.StreamingHandlerConn
inspectedResponse bool
inspectResponseHeader func(connect.Spec, http.Header)
}
func (hc *headerInspectingHandlerConn) Send(msg any) error {
if !hc.inspectedResponse {
hc.inspectResponseHeader(hc.Spec(), hc.ResponseHeader())
hc.inspectedResponse = true
}
return hc.StreamingHandlerConn.Send(msg)
}
type headerInspectingClientConn struct {
connect.StreamingClientConn
inspectedRequest bool
inspectRequestHeader func(connect.Spec, http.Header)
inspectedResponse bool
inspectResponseHeader func(connect.Spec, http.Header)
}
func (cc *headerInspectingClientConn) Send(msg any) error {
if !cc.inspectedRequest {
cc.inspectRequestHeader(cc.Spec(), cc.RequestHeader())
cc.inspectedRequest = true
}
return cc.StreamingClientConn.Send(msg)
}
func (cc *headerInspectingClientConn) Receive(msg any) error {
err := cc.StreamingClientConn.Receive(msg)
if !cc.inspectedResponse {
cc.inspectResponseHeader(cc.Spec(), cc.ResponseHeader())
cc.inspectedResponse = true
}
return err
}
type httpMethodChecker struct {
client bool
count atomic.Int32
}
func (h *httpMethodChecker) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
h.count.Add(1)
if h.client {
// should be blank until after we make request
if req.HTTPMethod() != "" {
return nil, fmt.Errorf("expected blank HTTP method but instead got %q", req.HTTPMethod())
}
} else {
// server interceptors see method from the start
// NB: In theory, the method could also be GET, not just POST. But for the
// configuration under test, it will always be POST.
if req.HTTPMethod() != http.MethodPost {
return nil, fmt.Errorf("expected HTTP method %s but instead got %q", http.MethodPost, req.HTTPMethod())
}
}
resp, err := next(ctx, req)
// NB: In theory, the method could also be GET, not just POST. But for the
// configuration under test, it will always be POST.
if req.HTTPMethod() != http.MethodPost {
return nil, fmt.Errorf("expected HTTP method %s but instead got %q", http.MethodPost, req.HTTPMethod())
}
return resp, err
}
}
func (h *httpMethodChecker) WrapStreamingClient(clientFunc connect.StreamingClientFunc) connect.StreamingClientFunc {
return func(ctx context.Context, spec connect.Spec) connect.StreamingClientConn {
// method not exposed to streaming interceptor, but that's okay because it's always POST for streams
h.count.Add(1)
return clientFunc(ctx, spec)
}
}
func (h *httpMethodChecker) WrapStreamingHandler(handlerFunc connect.StreamingHandlerFunc) connect.StreamingHandlerFunc {
return func(ctx context.Context, conn connect.StreamingHandlerConn) error {
// method not exposed to streaming interceptor, but that's okay because it's always POST for streams
h.count.Add(1)
return handlerFunc(ctx, conn)
}
}
type contextInterceptor struct {
client bool
count *atomic.Int32
// Whether the interceptor should attempt to create a new context (which will cause next() to return an error)
createNewContext bool
}
func (h *contextInterceptor) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
h.count.Add(1)
if h.createNewContext {
// This will cause next to return an error
ctx, _ = connect.NewClientContext(ctx)
}
return next(ctx, req)
}
}
func (h *contextInterceptor) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc {
return func(ctx context.Context, spec connect.Spec) connect.StreamingClientConn {
h.count.Add(1)
if h.createNewContext {
// This will cause next to return an error
ctx, _ = connect.NewClientContext(ctx)
}
return next(ctx, spec)
}
}
func (h *contextInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc {
return func(ctx context.Context, conn connect.StreamingHandlerConn) error {
h.count.Add(1)
return next(ctx, conn)
}
}
type sideQuestInterceptor struct {
count *atomic.Int32
client pingv1connect.PingServiceClient
t *testing.T
}
func newSideQuestInterceptor( //nolint:thelper
t *testing.T,
counter *atomic.Int32,
server *memhttp.Server,
) *sideQuestInterceptor {
client := pingv1connect.NewPingServiceClient(
server.Client(),
server.URL(),
)
return &sideQuestInterceptor{t: t, client: client, count: counter}
}
func (h *sideQuestInterceptor) WrapUnary(next connect.UnaryFunc) connect.UnaryFunc {
return func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
h.count.Add(1)
num := int64(42)
// Create a new client context for the side quest Ping. This should succeed because we aren't
// sending this on through the interceptor chain and reusing this context
newCtx, _ := connect.NewClientContext(ctx)
resp, err := h.client.Ping(newCtx, connect.NewRequest(&pingv1.PingRequest{Number: num}))
assert.Nil(h.t, err)
assert.Equal(h.t, resp.Msg.Number, num)
return next(ctx, req)
}
}
func (h *sideQuestInterceptor) WrapStreamingClient(next connect.StreamingClientFunc) connect.StreamingClientFunc {
return func(ctx context.Context, spec connect.Spec) connect.StreamingClientConn {
h.count.Add(1)
// Create a new context for the side quest CountUp. This should succeed because we aren't
// sending this on through the interceptor chain and reusing this context
newCtx, _ := connect.NewClientContext(ctx)
responses, err := h.client.CountUp(newCtx, connect.NewRequest(&pingv1.CountUpRequest{Number: 3}))
assert.Nil(h.t, err)
var sum int64
for responses.Receive() {
sum += responses.Msg().GetNumber()
}
assert.Equal(h.t, sum, 6)
assert.Nil(h.t, responses.Close())
return next(ctx, spec)
}
}
func (h *sideQuestInterceptor) WrapStreamingHandler(next connect.StreamingHandlerFunc) connect.StreamingHandlerFunc {
return func(ctx context.Context, conn connect.StreamingHandlerConn) error {
return next(ctx, conn)
}
}