forked from aws/aws-sdk-go
/
eventstream.go
1214 lines (1061 loc) · 33.7 KB
/
eventstream.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
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
997
998
999
1000
// +build codegen
package api
import (
"bytes"
"fmt"
"io"
"os"
"strings"
"text/template"
)
// EventStreamAPI provides details about the event stream async API and
// associated EventStream shapes.
type EventStreamAPI struct {
API *API
Name string
Operation *Operation
Shape *Shape
Inbound *EventStream
Outbound *EventStream
}
// EventStream represents a single eventstream group (input/output) and the
// modeled events that are known for the stream.
type EventStream struct {
Name string
RefName string
Shape *Shape
Events []*Event
Exceptions []*Event
}
// Event is a single EventStream event that can be sent or received in an
// EventStream.
type Event struct {
Name string
Shape *Shape
For *EventStream
}
// ShapeDoc returns the docstring for the EventStream API.
func (esAPI *EventStreamAPI) ShapeDoc() string {
tmpl := template.Must(template.New("eventStreamShapeDoc").Parse(`
{{- $.Name }} provides handling of EventStreams for
the {{ $.Operation.ExportedName }} API.
{{- if $.Inbound }}
Use this type to receive {{ $.Inbound.Name }} events. The events
can be read from the Events channel member.
The events that can be received are:
{{ range $_, $event := $.Inbound.Events }}
* {{ $event.Shape.ShapeName }}
{{- end }}
{{- end }}
{{- if $.Outbound }}
Use this type to send {{ $.Outbound.Name }} events. The events
can be sent with the Send method.
The events that can be sent are:
{{ range $_, $event := $.Outbound.Events -}}
* {{ $event.Shape.ShapeName }}
{{- end }}
{{- end }}`))
var w bytes.Buffer
if err := tmpl.Execute(&w, esAPI); err != nil {
panic(fmt.Sprintf("failed to generate eventstream shape template for %v, %v", esAPI.Name, err))
}
return commentify(w.String())
}
func hasEventStream(topShape *Shape) bool {
for _, ref := range topShape.MemberRefs {
if ref.Shape.IsEventStream {
return true
}
}
return false
}
func eventStreamAPIShapeRefDoc(refName string) string {
return commentify(fmt.Sprintf("Use %s to use the API's stream.", refName))
}
func (a *API) setupEventStreams() error {
const eventStreamMemberName = "EventStream"
for opName, op := range a.Operations {
outbound := setupEventStream(op.InputRef.Shape)
inbound := setupEventStream(op.OutputRef.Shape)
if outbound == nil && inbound == nil {
continue
}
if outbound != nil {
err := fmt.Errorf("Outbound stream support not implemented, %s, %s",
outbound.Name, outbound.Shape.ShapeName)
if a.IgnoreUnsupportedAPIs {
fmt.Fprintf(os.Stderr, "removing operation, %s, %v\n", opName, err)
delete(a.Operations, opName)
continue
}
return UnsupportedAPIModelError{
Err: err,
}
}
switch a.Metadata.Protocol {
case `rest-json`, `rest-xml`, `json`:
default:
return UnsupportedAPIModelError{
Err: fmt.Errorf("EventStream not supported for protocol %v",
a.Metadata.Protocol),
}
}
op.EventStreamAPI = &EventStreamAPI{
API: a,
Name: op.ExportedName + eventStreamMemberName,
Operation: op,
Outbound: outbound,
Inbound: inbound,
}
streamShape := &Shape{
API: a,
ShapeName: op.EventStreamAPI.Name,
Documentation: op.EventStreamAPI.ShapeDoc(),
Type: "structure",
EventStreamAPI: op.EventStreamAPI,
IsEventStream: true,
MemberRefs: map[string]*ShapeRef{
"Inbound": &ShapeRef{
ShapeName: inbound.Shape.ShapeName,
Shape: inbound.Shape,
},
},
}
// persist reference to the original inbound shape so its event types
// can be walked during generation.
inbound.Shape.refs = append(inbound.Shape.refs, streamShape.MemberRefs["Inbound"])
streamShapeRef := &ShapeRef{
API: a,
ShapeName: streamShape.ShapeName,
Shape: streamShape,
Documentation: eventStreamAPIShapeRefDoc(inbound.RefName),
}
streamShape.refs = []*ShapeRef{streamShapeRef}
op.EventStreamAPI.Shape = streamShape
op.OutputRef.Shape.MemberRefs[inbound.RefName] = streamShapeRef
op.OutputRef.Shape.EventStreamsMemberName = inbound.RefName
if s, ok := a.Shapes[streamShape.ShapeName]; ok {
s.Rename(streamShape.ShapeName + "Data")
}
a.Shapes[streamShape.ShapeName] = streamShape
a.HasEventStream = true
}
return nil
}
func setupEventStream(topShape *Shape) *EventStream {
var eventStream *EventStream
for refName, ref := range topShape.MemberRefs {
if !ref.Shape.IsEventStream {
continue
}
if eventStream != nil {
// Only on event stream member within an Input/Output shape is valid.
panic(fmt.Sprintf("multiple shape ref eventstreams, %s, prev: %s",
refName, eventStream.Name))
}
eventStream = &EventStream{
Name: ref.Shape.ShapeName,
RefName: refName,
Shape: ref.Shape,
}
if topShape.API.Metadata.Protocol == "json" {
topShape.EventFor = append(topShape.EventFor, eventStream)
}
for _, eventRefName := range ref.Shape.MemberNames() {
eventRef := ref.Shape.MemberRefs[eventRefName]
if !(eventRef.Shape.IsEvent || eventRef.Shape.Exception) {
panic(fmt.Sprintf("unexpected non-event member reference %s.%s",
ref.Shape.ShapeName, eventRefName))
}
updateEventPayloadRef(eventRef.Shape)
eventRef.Shape.EventFor = append(eventRef.Shape.EventFor, eventStream)
// Exceptions and events are two different lists to allow the SDK
// to easly generate code with the two handled differently.
event := &Event{
Name: eventRefName,
Shape: eventRef.Shape,
For: eventStream,
}
if eventRef.Shape.Exception {
eventStream.Exceptions = append(eventStream.Exceptions, event)
} else {
eventStream.Events = append(eventStream.Events, event)
}
}
// Remove the event stream member and shape as they will be added
// elsewhere.
ref.Shape.removeRef(ref)
delete(topShape.MemberRefs, refName)
delete(topShape.API.Shapes, ref.Shape.ShapeName)
}
return eventStream
}
func updateEventPayloadRef(parent *Shape) {
refName := parent.PayloadRefName()
if len(refName) == 0 {
return
}
payloadRef := parent.MemberRefs[refName]
if payloadRef.Shape.Type == "blob" {
return
}
if len(payloadRef.LocationName) != 0 {
return
}
payloadRef.LocationName = refName
}
func renderEventStreamAPIShape(w io.Writer, s *Shape) error {
// Imports needed by the EventStream APIs.
s.API.AddImport("fmt")
s.API.AddImport("bytes")
s.API.AddImport("io")
s.API.AddImport("sync")
s.API.AddImport("sync/atomic")
s.API.AddSDKImport("aws")
s.API.AddSDKImport("aws/awserr")
s.API.AddSDKImport("private/protocol/eventstream")
s.API.AddSDKImport("private/protocol/eventstream/eventstreamapi")
return eventStreamAPIShapeTmpl.Execute(w, s)
}
// Template for an EventStream API Shape that will provide read/writing events
// across the EventStream. This is a special shape that's only public members
// are the Events channel and a Close and Err method.
//
// Executed in the context of a Shape.
var eventStreamAPIShapeTmpl = func() *template.Template {
t := template.Must(
template.New("eventStreamAPIShapeTmpl").
Funcs(template.FuncMap{}).
Parse(eventStreamAPITmplDef),
)
template.Must(
t.AddParseTree(
"eventStreamAPIReaderTmpl", eventStreamAPIReaderTmpl.Tree),
)
return t
}()
const eventStreamAPITmplDef = `
{{ $.Documentation }}
type {{ $.ShapeName }} struct {
{{- if $.EventStreamAPI.Inbound }}
// Reader is the EventStream reader for the {{ $.EventStreamAPI.Inbound.Name }}
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Reader.
//
// Must not be nil.
Reader {{ $.ShapeName }}Reader
{{ end -}}
{{- if $.EventStreamAPI.Outbound }}
// Writer is the EventStream reader for the {{ $.EventStreamAPI.Inbound.Name }}
// events. This value is automatically set by the SDK when the API call is made
// Use this member when unit testing your code with the SDK to mock out the
// EventStream Writer.
//
// Must not be nil.
Writer *{{ $.ShapeName }}Writer
{{ end -}}
// StreamCloser is the io.Closer for the EventStream connection. For HTTP
// EventStream this is the response Body. The stream will be closed when
// the Close method of the EventStream is called.
StreamCloser io.Closer
}
// Close closes the EventStream. This will also cause the Events channel to be
// closed. You can use the closing of the Events channel to terminate your
// application's read from the API's EventStream.
{{- if $.EventStreamAPI.Inbound }}
//
// Will close the underlying EventStream reader. For EventStream over HTTP
// connection this will also close the HTTP connection.
{{ end -}}
//
// Close must be called when done using the EventStream API. Not calling Close
// may result in resource leaks.
func (es *{{ $.ShapeName }}) Close() (err error) {
{{- if $.EventStreamAPI.Inbound }}
es.Reader.Close()
{{ end -}}
{{- if $.EventStreamAPI.Outbound }}
es.Writer.Close()
{{ end -}}
es.StreamCloser.Close()
return es.Err()
}
// Err returns any error that occurred while reading EventStream Events from
// the service API's response. Returns nil if there were no errors.
func (es *{{ $.ShapeName }}) Err() error {
{{- if $.EventStreamAPI.Outbound }}
if err := es.Writer.Err(); err != nil {
return err
}
{{ end -}}
{{- if $.EventStreamAPI.Inbound }}
if err := es.Reader.Err(); err != nil {
return err
}
{{ end -}}
return nil
}
{{ if $.EventStreamAPI.Inbound }}
// Events returns a channel to read EventStream Events from the
// {{ $.EventStreamAPI.Operation.ExportedName }} API.
//
// These events are:
// {{ range $_, $event := $.EventStreamAPI.Inbound.Events }}
// * {{ $event.Shape.ShapeName }}
{{- end }}
func (es *{{ $.ShapeName }}) Events() <-chan {{ $.EventStreamAPI.Inbound.Name }}Event {
return es.Reader.Events()
}
{{ template "eventStreamAPIReaderTmpl" $ }}
{{ end }}
{{ if $.EventStreamAPI.Outbound }}
// TODO writer helper method.
{{ end }}
`
var eventStreamAPIReaderTmpl = template.Must(template.New("eventStreamAPIReaderTmpl").
Funcs(template.FuncMap{}).
Parse(`
// {{ $.EventStreamAPI.Inbound.Name }}Event groups together all EventStream
// events read from the {{ $.EventStreamAPI.Operation.ExportedName }} API.
//
// These events are:
// {{ range $_, $event := $.EventStreamAPI.Inbound.Events }}
// * {{ $event.Shape.ShapeName }}
{{- end }}
type {{ $.EventStreamAPI.Inbound.Name }}Event interface {
event{{ $.EventStreamAPI.Inbound.Name }}()
}
// {{ $.ShapeName }}Reader provides the interface for reading EventStream
// Events from the {{ $.EventStreamAPI.Operation.ExportedName }} API. The
// default implementation for this interface will be {{ $.ShapeName }}.
//
// The reader's Close method must allow multiple concurrent calls.
//
// These events are:
// {{ range $_, $event := $.EventStreamAPI.Inbound.Events }}
// * {{ $event.Shape.ShapeName }}
{{- end }}
type {{ $.ShapeName }}Reader interface {
// Returns a channel of events as they are read from the event stream.
Events() <-chan {{ $.EventStreamAPI.Inbound.Name }}Event
// Close will close the underlying event stream reader. For event stream over
// HTTP this will also close the HTTP connection.
Close() error
// Returns any error that has occurred while reading from the event stream.
Err() error
}
type read{{ $.ShapeName }} struct {
eventReader *eventstreamapi.EventReader
stream chan {{ $.EventStreamAPI.Inbound.Name }}Event
errVal atomic.Value
done chan struct{}
closeOnce sync.Once
{{ if eq $.API.Metadata.Protocol "json" -}}
initResp eventstreamapi.Unmarshaler
{{ end -}}
}
func newRead{{ $.ShapeName }}(
reader io.ReadCloser,
unmarshalers request.HandlerList,
logger aws.Logger,
logLevel aws.LogLevelType,
{{ if eq $.API.Metadata.Protocol "json" -}}
initResp eventstreamapi.Unmarshaler,
{{ end -}}
) *read{{ $.ShapeName }} {
r := &read{{ $.ShapeName }}{
stream: make(chan {{ $.EventStreamAPI.Inbound.Name }}Event),
done: make(chan struct{}),
{{ if eq $.API.Metadata.Protocol "json" -}}
initResp: initResp,
{{ end -}}
}
r.eventReader = eventstreamapi.NewEventReader(
reader,
protocol.HandlerPayloadUnmarshal{
Unmarshalers: unmarshalers,
},
r.unmarshalerForEventType,
)
r.eventReader.UseLogger(logger, logLevel)
return r
}
// Close will close the underlying event stream reader. For EventStream over
// HTTP this will also close the HTTP connection.
func (r *read{{ $.ShapeName }}) Close() error {
r.closeOnce.Do(r.safeClose)
return r.Err()
}
func (r *read{{ $.ShapeName }}) safeClose() {
close(r.done)
err := r.eventReader.Close()
if err != nil {
r.errVal.Store(err)
}
}
func (r *read{{ $.ShapeName }}) Err() error {
if v := r.errVal.Load(); v != nil {
return v.(error)
}
return nil
}
func (r *read{{ $.ShapeName }}) Events() <-chan {{ $.EventStreamAPI.Inbound.Name }}Event {
return r.stream
}
func (r *read{{ $.ShapeName }}) readEventStream() {
defer close(r.stream)
for {
event, err := r.eventReader.ReadEvent()
if err != nil {
if err == io.EOF {
return
}
select {
case <-r.done:
// If closed already ignore the error
return
default:
}
r.errVal.Store(err)
return
}
select {
case r.stream <- event.({{ $.EventStreamAPI.Inbound.Name }}Event):
case <-r.done:
return
}
}
}
func (r *read{{ $.ShapeName }}) unmarshalerForEventType(
eventType string,
) (eventstreamapi.Unmarshaler, error) {
switch eventType {
{{- if eq $.API.Metadata.Protocol "json" }}
case "initial-response":
return r.initResp, nil
{{ end -}}
{{- range $_, $event := $.EventStreamAPI.Inbound.Events }}
case {{ printf "%q" $event.Name }}:
return &{{ $event.Shape.ShapeName }}{}, nil
{{ end -}}
{{- range $_, $event := $.EventStreamAPI.Inbound.Exceptions }}
case {{ printf "%q" $event.Name }}:
return &{{ $event.Shape.ShapeName }}{}, nil
{{ end -}}
default:
return nil, awserr.New(
request.ErrCodeSerialization,
fmt.Sprintf("unknown event type name, %s, for {{ $.ShapeName }}", eventType),
nil,
)
}
}
`))
// Template for the EventStream API Output shape that contains the EventStream
// member.
//
// Executed in the context of a Shape.
var eventStreamAPILoopMethodTmpl = template.Must(
template.New("eventStreamAPILoopMethodTmpl").Parse(`
func (s *{{ $.ShapeName }}) runEventStreamLoop(r *request.Request) {
if r.Error != nil {
return
}
{{- $esMemberRef := index $.MemberRefs $.EventStreamsMemberName }}
{{- if $esMemberRef.Shape.EventStreamAPI.Inbound }}
reader := newRead{{ $esMemberRef.ShapeName }}(
r.HTTPResponse.Body,
r.Handlers.UnmarshalStream,
r.Config.Logger,
r.Config.LogLevel.Value(),
{{ if eq $.API.Metadata.Protocol "json" -}}
s,
{{ end -}}
)
go reader.readEventStream()
eventStream := &{{ $esMemberRef.ShapeName }} {
StreamCloser: r.HTTPResponse.Body,
Reader: reader,
}
{{ end -}}
s.{{ $.EventStreamsMemberName }} = eventStream
}
{{ if eq $.API.Metadata.Protocol "json" -}}
func (s *{{ $.ShapeName }}) unmarshalInitialResponse(r *request.Request) {
// Wait for the initial response event, which must be the first event to be
// received from the API.
select {
case event, ok := <-s.{{ $.EventStreamsMemberName }}.Events():
if !ok {
return
}
es := s.{{ $.EventStreamsMemberName }}
v, ok := event.(*{{ $.ShapeName }})
if !ok || v == nil {
r.Error = awserr.New(
request.ErrCodeSerialization,
fmt.Sprintf("invalid event, %T, expect *SubscribeToShardOutput, %v", event, v),
nil,
)
return
}
*s = *v
s.{{ $.EventStreamsMemberName }} = es
}
}
{{ end -}}
`))
// EventStreamHeaderTypeMap provides the mapping of a EventStream Header's
// Value type to the shape reference's member type.
type EventStreamHeaderTypeMap struct {
Header string
Member string
}
var eventStreamEventShapeTmplFuncs = template.FuncMap{
"EventStreamHeaderTypeMap": func(ref *ShapeRef) EventStreamHeaderTypeMap {
switch ref.Shape.Type {
case "boolean":
return EventStreamHeaderTypeMap{Header: "bool", Member: "bool"}
case "byte":
return EventStreamHeaderTypeMap{Header: "int8", Member: "int64"}
case "short":
return EventStreamHeaderTypeMap{Header: "int16", Member: "int64"}
case "integer":
return EventStreamHeaderTypeMap{Header: "int32", Member: "int64"}
case "long":
return EventStreamHeaderTypeMap{Header: "int64", Member: "int64"}
case "timestamp":
return EventStreamHeaderTypeMap{Header: "time.Time", Member: "time.Time"}
case "blob":
return EventStreamHeaderTypeMap{Header: "[]byte", Member: "[]byte"}
case "string":
return EventStreamHeaderTypeMap{Header: "string", Member: "string"}
// TODO case "uuid" what is modeled type
default:
panic("unsupported EventStream header type, " + ref.Shape.Type)
}
},
"HasNonBlobPayloadMembers": eventHasNonBlobPayloadMembers,
}
// Returns if the event has any members which are not the event's blob payload,
// nor a header.
func eventHasNonBlobPayloadMembers(s *Shape) bool {
num := len(s.MemberRefs)
for _, ref := range s.MemberRefs {
if ref.IsEventHeader || (ref.IsEventPayload && (ref.Shape.Type == "blob" || ref.Shape.Type == "string")) {
num--
}
}
return num > 0
}
// Template for an EventStream Event shape. This is a normal API shape that is
// decorated as an EventStream Event.
//
// Executed in the context of a Shape.
var eventStreamEventShapeTmpl = template.Must(template.New("eventStreamEventShapeTmpl").
Funcs(eventStreamEventShapeTmplFuncs).Parse(`
{{ range $_, $eventstream := $.EventFor }}
// The {{ $.ShapeName }} is and event in the {{ $eventstream.Name }} group of events.
func (s *{{ $.ShapeName }}) event{{ $eventstream.Name }}() {}
{{ end }}
// UnmarshalEvent unmarshals the EventStream Message into the {{ $.ShapeName }} value.
// This method is only used internally within the SDK's EventStream handling.
func (s *{{ $.ShapeName }}) UnmarshalEvent(
payloadUnmarshaler protocol.PayloadUnmarshaler,
msg eventstream.Message,
) error {
{{- range $memName, $memRef := $.MemberRefs }}
{{- if $memRef.IsEventHeader }}
if hv := msg.Headers.Get("{{ $memName }}"); hv != nil {
{{ $types := EventStreamHeaderTypeMap $memRef -}}
v := hv.Get().({{ $types.Header }})
{{- if ne $types.Header $types.Member }}
m := {{ $types.Member }}(v)
s.{{ $memName }} = {{ if $memRef.UseIndirection }}&{{ end }}m
{{- else }}
s.{{ $memName }} = {{ if $memRef.UseIndirection }}&{{ end }}v
{{- end }}
}
{{- else if (and ($memRef.IsEventPayload) (eq $memRef.Shape.Type "blob")) }}
s.{{ $memName }} = make([]byte, len(msg.Payload))
copy(s.{{ $memName }}, msg.Payload)
{{- else if (and ($memRef.IsEventPayload) (eq $memRef.Shape.Type "string")) }}
s.{{ $memName }} = aws.String(string(msg.Payload))
{{- end }}
{{- end }}
{{- if HasNonBlobPayloadMembers $ }}
if err := payloadUnmarshaler.UnmarshalPayload(
bytes.NewReader(msg.Payload), s,
); err != nil {
return err
}
{{- end }}
return nil
}
`))
var eventStreamExceptionEventShapeTmpl = template.Must(
template.New("eventStreamExceptionEventShapeTmpl").Parse(`
// Code returns the exception type name.
func (s {{ $.ShapeName }}) Code() string {
{{- if $.ErrorInfo.Code }}
return "{{ $.ErrorInfo.Code }}"
{{- else }}
return "{{ $.ShapeName }}"
{{ end -}}
}
// Message returns the exception's message.
func (s {{ $.ShapeName }}) Message() string {
{{- if index $.MemberRefs "Message_" }}
return *s.Message_
{{- else }}
return ""
{{ end -}}
}
// OrigErr always returns nil, satisfies awserr.Error interface.
func (s {{ $.ShapeName }}) OrigErr() error {
return nil
}
func (s {{ $.ShapeName }}) Error() string {
return fmt.Sprintf("%s: %s", s.Code(), s.Message())
}
`))
// APIEventStreamTestGoCode generates Go code for EventStream operation tests.
func (a *API) APIEventStreamTestGoCode() string {
var buf bytes.Buffer
a.resetImports()
a.AddImport("bytes")
a.AddImport("io/ioutil")
a.AddImport("net/http")
a.AddImport("reflect")
a.AddImport("testing")
a.AddImport("time")
a.AddSDKImport("aws")
a.AddSDKImport("aws/corehandlers")
a.AddSDKImport("aws/request")
a.AddSDKImport("aws/awserr")
a.AddSDKImport("awstesting/unit")
a.AddSDKImport("private/protocol")
a.AddSDKImport("private/protocol/", a.ProtocolPackage())
a.AddSDKImport("private/protocol/eventstream")
a.AddSDKImport("private/protocol/eventstream/eventstreamapi")
a.AddSDKImport("private/protocol/eventstream/eventstreamtest")
unused := `
var _ time.Time
var _ awserr.Error
`
if err := eventStreamTestTmpl.Execute(&buf, a); err != nil {
panic(err)
}
return a.importsGoCode() + unused + strings.TrimSpace(buf.String())
}
func valueForType(s *Shape, visited []string) string {
for _, v := range visited {
if v == s.ShapeName {
return "nil"
}
}
visited = append(visited, s.ShapeName)
switch s.Type {
case "blob":
return `[]byte("blob value goes here")`
case "string":
return `aws.String("string value goes here")`
case "boolean":
return `aws.Bool(true)`
case "byte":
return `aws.Int64(1)`
case "short":
return `aws.Int64(12)`
case "integer":
return `aws.Int64(123)`
case "long":
return `aws.Int64(1234)`
case "float":
return `aws.Float64(123.4)`
case "double":
return `aws.Float64(123.45)`
case "timestamp":
return `aws.Time(time.Unix(1396594860, 0).UTC())`
case "structure":
w := bytes.NewBuffer(nil)
fmt.Fprintf(w, "&%s{\n", s.ShapeName)
for _, refName := range s.MemberNames() {
fmt.Fprintf(w, "%s: %s,\n", refName, valueForType(s.MemberRefs[refName].Shape, visited))
}
fmt.Fprintf(w, "}")
return w.String()
case "list":
w := bytes.NewBuffer(nil)
fmt.Fprintf(w, "%s{\n", s.GoType())
for i := 0; i < 3; i++ {
fmt.Fprintf(w, "%s,\n", valueForType(s.MemberRef.Shape, visited))
}
fmt.Fprintf(w, "}")
return w.String()
case "map":
w := bytes.NewBuffer(nil)
fmt.Fprintf(w, "%s{\n", s.GoType())
for _, k := range []string{"a", "b", "c"} {
fmt.Fprintf(w, "%q: %s,\n", k, valueForType(s.ValueRef.Shape, visited))
}
fmt.Fprintf(w, "}")
return w.String()
default:
panic(fmt.Sprintf("valueForType does not support %s, %s", s.ShapeName, s.Type))
}
}
func setEventHeaderValueForType(s *Shape, memVar string) string {
switch s.Type {
case "blob":
return fmt.Sprintf("eventstream.BytesValue(%s)", memVar)
case "string":
return fmt.Sprintf("eventstream.StringValue(*%s)", memVar)
case "boolean":
return fmt.Sprintf("eventstream.BoolValue(*%s)", memVar)
case "byte":
return fmt.Sprintf("eventstream.Int8Value(int8(*%s))", memVar)
case "short":
return fmt.Sprintf("eventstream.Int16Value(int16(*%s))", memVar)
case "integer":
return fmt.Sprintf("eventstream.Int32Value(int32(*%s))", memVar)
case "long":
return fmt.Sprintf("eventstream.Int64Value(*%s)", memVar)
case "float":
return fmt.Sprintf("eventstream.Float32Value(float32(*%s))", memVar)
case "double":
return fmt.Sprintf("eventstream.Float64Value(*%s)", memVar)
case "timestamp":
return fmt.Sprintf("eventstream.TimestampValue(*%s)", memVar)
default:
panic(fmt.Sprintf("value type %s not supported for event headers, %s", s.Type, s.ShapeName))
}
}
func templateMap(args ...interface{}) map[string]interface{} {
if len(args)%2 != 0 {
panic(fmt.Sprintf("invalid map call, non-even args %v", args))
}
m := map[string]interface{}{}
for i := 0; i < len(args); i += 2 {
k, ok := args[i].(string)
if !ok {
panic(fmt.Sprintf("invalid map call, arg is not string, %T, %v", args[i], args[i]))
}
m[k] = args[i+1]
}
return m
}
var eventStreamTestTmpl = template.Must(
template.New("eventStreamTestTmpl").Funcs(template.FuncMap{
"ValueForType": valueForType,
"HasNonBlobPayloadMembers": eventHasNonBlobPayloadMembers,
"SetEventHeaderValueForType": setEventHeaderValueForType,
"Map": templateMap,
"OptionalAddInt": func(do bool, a, b int) int {
if !do {
return a
}
return a + b
},
"HasNonEventStreamMember": func(s *Shape) bool {
for _, ref := range s.MemberRefs {
if !ref.Shape.IsEventStream {
return true
}
}
return false
},
}).Parse(`
{{ range $opName, $op := $.Operations }}
{{ if $op.EventStreamAPI }}
{{ if $op.EventStreamAPI.Inbound }}
{{ template "event stream inbound tests" $op.EventStreamAPI }}
{{ end }}
{{ end }}
{{ end }}
type loopReader struct {
source *bytes.Reader
}
func (c *loopReader) Read(p []byte) (int, error) {
if c.source.Len() == 0 {
c.source.Seek(0, 0)
}
return c.source.Read(p)
}
{{ define "event stream inbound tests" }}
{{- $esMemberName := $.Operation.OutputRef.Shape.EventStreamsMemberName }}
func Test{{ $.Operation.ExportedName }}_Read(t *testing.T) {
expectEvents, eventMsgs := mock{{ $.Operation.ExportedName }}ReadEvents()
sess, cleanupFn, err := eventstreamtest.SetupEventStreamSession(t,
eventstreamtest.ServeEventStream{
T: t,
Events: eventMsgs,
},
true,
)
if err != nil {
t.Fatalf("expect no error, %v", err)
}
defer cleanupFn()
svc := New(sess)
resp, err := svc.{{ $.Operation.ExportedName }}(nil)
if err != nil {
t.Fatalf("expect no error got, %v", err)
}
defer resp.{{ $esMemberName }}.Close()
{{- if eq $.Operation.API.Metadata.Protocol "json" }}
{{- if HasNonEventStreamMember $.Operation.OutputRef.Shape }}
expectResp := expectEvents[0].(*{{ $.Operation.OutputRef.Shape.ShapeName }})
{{- range $name, $ref := $.Operation.OutputRef.Shape.MemberRefs }}
{{- if not $ref.Shape.IsEventStream }}
if e, a := expectResp.{{ $name }}, resp.{{ $name }}; !reflect.DeepEqual(e,a) {
t.Errorf("expect %v, got %v", e, a)
}
{{- end }}
{{- end }}
{{- end }}
// Trim off response output type pseudo event so only event messages remain.
expectEvents = expectEvents[1:]
{{ end }}
var i int
for event := range resp.{{ $esMemberName }}.Events() {
if event == nil {
t.Errorf("%d, expect event, got nil", i)
}
if e, a := expectEvents[i], event; !reflect.DeepEqual(e, a) {
t.Errorf("%d, expect %T %v, got %T %v", i, e, e, a, a)
}
i++
}
if err := resp.{{ $esMemberName }}.Err(); err != nil {
t.Errorf("expect no error, %v", err)
}
}
func Test{{ $.Operation.ExportedName }}_ReadClose(t *testing.T) {
_, eventMsgs := mock{{ $.Operation.ExportedName }}ReadEvents()
sess, cleanupFn, err := eventstreamtest.SetupEventStreamSession(t,
eventstreamtest.ServeEventStream{
T: t,
Events: eventMsgs,
},
true,
)
if err != nil {
t.Fatalf("expect no error, %v", err)
}
defer cleanupFn()
svc := New(sess)
resp, err := svc.{{ $.Operation.ExportedName }}(nil)
if err != nil {
t.Fatalf("expect no error got, %v", err)
}
// Assert calling Err before close does not close the stream.
resp.{{ $esMemberName }}.Err()
select {
case _, ok := <-resp.{{ $esMemberName }}.Events():
if !ok {
t.Fatalf("expect stream not to be closed, but was")
}
default:
}
resp.{{ $esMemberName }}.Close()
<-resp.{{ $esMemberName }}.Events()
if err := resp.{{ $esMemberName }}.Err(); err != nil {
t.Errorf("expect no error, %v", err)
}
}
func Benchmark{{ $.Operation.ExportedName }}_Read(b *testing.B) {
_, eventMsgs := mock{{ $.Operation.ExportedName }}ReadEvents()
var buf bytes.Buffer
encoder := eventstream.NewEncoder(&buf)
for _, msg := range eventMsgs {
if err := encoder.Encode(msg); err != nil {