private/protocol: adding generated marshalers (#110)

* adding generated marshalers

Regenerating services

Adding generated marshalers

adding docs to enum template

benchmarks

* regenerating services

Author: xibz

internal/awsutil/copy_test.go

@@ -15,13 +15,13 @@ import (
 func ExampleCopy() {
 	type Foo struct {
 		A int
-		B []*string
+		B []string
 	}
 
 	// Create the initial value
 	str1 := "hello"
 	str2 := "bye bye"
-	f1 := &Foo{A: 1, B: []*string{&str1, &str2}}
+	f1 := &Foo{A: 1, B: []string{str1, str2}}
 
 	// Do the copy
 	var f2 Foo
@@ -46,8 +46,8 @@ func TestCopy1(t *testing.T) {
 	}
 	type Foo struct {
 		A int
-		B []*string
-		C map[string]*int
+		B []string
+		C map[string]int
 		D *time.Time
 		E *Bar
 	}
@@ -62,10 +62,10 @@ func TestCopy1(t *testing.T) {
 	now := time.Now()
 	f1 := &Foo{
 		A: 1,
-		B: []*string{&str1, &str2},
-		C: map[string]*int{
-			"A": &int1,
-			"B": &int2,
+		B: []string{str1, str2},
+		C: map[string]int{
+			"A": int1,
+			"B": int2,
 		},
 		D: &now,
 		E: &Bar{
@@ -104,8 +104,8 @@ func TestCopy1(t *testing.T) {
 	str3 := "nothello"
 	int3 := 57
 	f2.A = 100
-	*f2.B[0] = str3
-	*f2.C["B"] = int3
+	f2.B[0] = str3
+	f2.C["B"] = int3
 	*f2.D = time.Now()
 	f2.E.a = &int3
 	*f2.E.B = int3
@@ -252,17 +252,17 @@ func TestCopyReader(t *testing.T) {
 func TestCopyDifferentStructs(t *testing.T) {
 	type SrcFoo struct {
 		A                int
-		B                []*string
-		C                map[string]*int
+		B                []string
+		C                map[string]int
 		SrcUnique        string
 		SameNameDiffType int
 		unexportedPtr    *int
 		ExportedPtr      *int
 	}
 	type DstFoo struct {
 		A                int
-		B                []*string
-		C                map[string]*int
+		B                []string
+		C                map[string]int
 		DstUnique        int
 		SameNameDiffType string
 		unexportedPtr    *int
@@ -276,10 +276,10 @@ func TestCopyDifferentStructs(t *testing.T) {
 	int2 := 2
 	f1 := &SrcFoo{
 		A: 1,
-		B: []*string{&str1, &str2},
-		C: map[string]*int{
-			"A": &int1,
-			"B": &int2,
+		B: []string{str1, str2},
+		C: map[string]int{
+			"A": int1,
+			"B": int2,
 		},
 		SrcUnique:        "unique",
 		SameNameDiffType: 1,
@@ -330,13 +330,13 @@ func TestCopyDifferentStructs(t *testing.T) {
 func ExampleCopyOf() {
 	type Foo struct {
 		A int
-		B []*string
+		B []string
 	}
 
 	// Create the initial value
 	str1 := "hello"
 	str2 := "bye bye"
-	f1 := &Foo{A: 1, B: []*string{&str1, &str2}}
+	f1 := &Foo{A: 1, B: []string{str1, str2}}
 
 	// Do the copy
 	v := awsutil.CopyOf(f1)

models/protocol_tests/generate.go

@@ -397,6 +397,7 @@ func generateTestSuite(filename string) string {
 
 	for i, suite := range suites {
 		svcPrefix := inout + "Service" + strconv.Itoa(i+1)
+		suite.API.EnableSelectGeneratedMarshalers()
 		suite.API.Metadata.ServiceAbbreviation = svcPrefix + "ProtocolTest"
 		suite.API.Operations = map[string]*api.Operation{}
 		for idx, c := range suite.Cases {

models/protocol_tests/input/ec2.json

@@ -222,6 +222,11 @@
             2.718,
             3.14
           ],
+          "ListIntegers": [
+            0,
+            1,
+            2
+          ],
           "ListIntegers": [
             0,
             1,

private/model/api/api.go

@@ -46,6 +46,10 @@ type API struct {
 	// Set to true to not generate struct field accessors
 	NoGenStructFieldAccessors bool
 
+	// Set to true to not generate (un)marshalers
+	NoGenMarshalers   bool
+	NoGenUnmarshalers bool
+
 	SvcClientImportPath string
 
 	initialized bool
@@ -311,6 +315,9 @@ func (a *API) APIGoCode() string {
 		a.imports["github.com/aws/aws-sdk-go-v2/private/protocol/"+a.ProtocolPackage()] = true
 		a.imports["github.com/aws/aws-sdk-go-v2/private/protocol"] = true
 	}
+	if !a.NoGenMarshalers || !a.NoGenUnmarshalers {
+		a.imports["github.com/aws/aws-sdk-go-v2/private/protocol"] = true
+	}
 
 	var buf bytes.Buffer
 	err := tplAPI.Execute(&buf, a)

private/model/api/customization_passes.go

@@ -27,6 +27,18 @@ var mergeServices = map[string]service{
 	},
 }
 
+func (a *API) EnableSelectGeneratedMarshalers() {
+	// Selectivily enable generated marshalers as available
+	a.NoGenMarshalers = true
+	a.NoGenUnmarshalers = true
+
+	// Enable generated marshalers
+	switch a.Metadata.Protocol {
+	case "rest-xml", "rest-json":
+		a.NoGenMarshalers = false
+	}
+}
+
 // customizationPasses Executes customization logic for the API by package name.
 func (a *API) customizationPasses() {
 	var svcCustomizations = map[string]func(*API){
@@ -42,6 +54,8 @@ func (a *API) customizationPasses() {
 	if fn := svcCustomizations[a.PackageName()]; fn != nil {
 		fn(a)
 	}
+
+	a.EnableSelectGeneratedMarshalers()
 }
 
 // s3Customizations customizes the API generation to replace values specific to S3.

private/model/api/passes.go

@@ -60,6 +60,15 @@ func (a *API) resolveReferences() {
 			o.ErrorRefs[i].Shape.IsError = true
 		}
 	}
+
+	for _, s := range a.Shapes {
+		switch s.Type {
+		case "list":
+			s.MemberRef.Shape.UsedInList = true
+		case "map":
+			s.ValueRef.Shape.UsedInMap = true
+		}
+	}
 }
 
 // A referenceResolver provides a way to resolve shape references to
@@ -189,6 +198,13 @@ func (a *API) renameExportable() {
 
 		for mName, member := range s.MemberRefs {
 			newName := a.ExportableName(mName)
+
+			// if no location name is set on the member ref, but is set on the shape,
+			// we will take that name and place it on the reference.
+			if member.LocationName == "" && member.Shape.LocationName != "" {
+				member.LocationName = member.Shape.LocationName
+			}
+
 			if newName != mName {
 				delete(s.MemberRefs, mName)
 				s.MemberRefs[newName] = member
@@ -216,6 +232,9 @@ func (a *API) renameExportable() {
 		for i, n := range s.Required {
 			s.Required[i] = a.ExportableName(n)
 		}
+
+		// remove location name
+		s.LocationName = ""
 	}
 
 	for _, s := range a.Shapes {

private/model/api/shape.go

@@ -78,6 +78,9 @@ type Shape struct {
 
 	OrigShapeName string `json:"-"`
 
+	UsedInMap  bool
+	UsedInList bool
+
 	// Defines if the shape is a placeholder and should not be used directly
 	Placeholder bool
 
@@ -192,6 +195,17 @@ func (s *Shape) GoStructValueType(name string, ref *ShapeRef) string {
 	return v
 }
 
+// IsRefPayload will return whether or a not the field name is a payload.
+func (s *Shape) IsRefPayload(name string) bool {
+	return s.Payload == name
+}
+
+// IsRefPayloadReader will whether or not the shape ref is a payload and that it is
+// a streaming reference.
+func (s *Shape) IsRefPayloadReader(name string, ref *ShapeRef) bool {
+	return (ref.Streaming || ref.Shape.Streaming) && s.IsRefPayload(name)
+}
+
 // GoStructType returns the type of a struct field based on the API
 // model definition.
 func (s *Shape) GoStructType(name string, ref *ShapeRef) string {
@@ -545,7 +559,9 @@ func (s *Shape) NestedShape() *Shape {
 }
 
 var structShapeTmpl = template.Must(template.New("StructShape").Funcs(template.FuncMap{
-	"GetCrosslinkURL": GetCrosslinkURL,
+	"GetCrosslinkURL":      GetCrosslinkURL,
+	"MarshalShapeGoCode":   MarshalShapeGoCode,
+	"UnmarshalShapeGoCode": UnmarshalShapeGoCode,
 }).Parse(`
 {{ .Docstring }}
 {{ if ne $.OrigShapeName "" -}}
@@ -630,9 +646,18 @@ func (s *{{ $builderShapeName }}) get{{ $name }}() (v {{ $context.GoStructValueT
 
 {{ end }}
 {{ end }}
+
+{{ if not $.API.NoGenMarshalers -}}
+{{ MarshalShapeGoCode $ }}
+{{- end }}
+{{ if not $.API.NoGenUnmarshalers -}}
+{{ UnmarshalShapeGoCode $ }}
+{{- end }}
 `))
 
-var enumShapeTmpl = template.Must(template.New("EnumShape").Parse(`
+var enumShapeTmpl = template.Must(template.New("EnumShape").Funcs(template.FuncMap{
+	"MarshalEnumGoCode": marshalEnumGoCode,
+}).Parse(`
 {{ .Docstring }}
 type {{ $.EnumType }} string
 
@@ -644,6 +669,8 @@ const (
 		{{ $name }} {{ $.EnumType }} = "{{ $elem }}"
 	{{ end -}}
 )
+
+{{ MarshalEnumGoCode $ }}
 `))
 
 // GoCode returns the rendered Go code for the Shape.