Skip to content

Commit bb7c602

Browse files
authored
dynamodb/attributevalue: Add utility to (un)marshal Attribtue Values (#948)
Adds utilities for mapping Amazon DynamoDB API AttributeValue to and from Go types. * Adds conversion util for DynamoDB -> DynamoDBStreams AttributeValue. * Fixes #895 - Adds back marshaler/unmarshalers for attribute value to/from go types. * Fixes #929 - Adds generic support for `json.Number` like types that are aliases of `string`s. * Fixes #115 - Simplifies the rules of `null` vs skipped vs zero value for all types. * All nil pointers, map, slice members are serialized as NULL AttributeValue. * `omitempty` struct tag skips zero value of members with the struct tag. `omitemptyelem` skips elements of list/map that have zero value. * `nullempty` struct tag serializes zero value of members with the struct tag as NULL AttributeValue. `nullemptyelem` does same for elements of list/map that have zero value. * Empty and Nil Sets (NS, BS, SS) are serialized to null by default unless `NullEmptySets` EncoderOptions is set to false. True by default. Nil sets are always serialized as NULL, unless the`omitempty` struct tag is used. * Adds `nullempty` and `nullemptyelem` struct tags to direct if the encoder should marshal the member as a AttributeValue NULL if the member's value is the type's zero value, (e.g. "" for string, 0 for number, nil for pointer/map/slice, false for bool)
1 parent 4806b72 commit bb7c602

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+11648
-187
lines changed

Makefile

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ all: generate unit
4040
###################
4141
# Code Generation #
4242
###################
43-
generate: smithy-generate gen-config-asserts gen-repo-mod-replace gen-mod-dropreplace-smithy tidy-modules-. add-module-license-files gen-aws-ptrs
43+
generate: smithy-generate gen-config-asserts copy-attributevalue-feature gen-repo-mod-replace gen-mod-dropreplace-smithy tidy-modules-. add-module-license-files gen-aws-ptrs
4444

4545
smithy-generate:
4646
cd codegen && ./gradlew clean build -Plog-tests && ./gradlew clean
@@ -110,6 +110,24 @@ gen-endpoint-prefix.json:
110110
-m '/tmp/aws-sdk-go-model-sync/models/apis/*/*/api-2.json' \
111111
-o ${ENDPOINT_PREFIX_JSON}
112112

113+
copy-attributevalue-feature:
114+
cd ./feature/dynamodbstreams/attributevalue && \
115+
find . -name "*.go" | grep -v "doc.go" | xargs -I % rm % && \
116+
find ../../dynamodb/attributevalue -name "*.go" | grep -v "doc.go" | xargs -I % cp % . && \
117+
ls *.go | grep -v "convert.go" | grep -v "doc.go" | \
118+
xargs -I % sed -i.bk -E 's:github.com/aws/aws-sdk-go-v2/(service|feature)/dynamodb:github.com/aws/aws-sdk-go-v2/\1/dynamodbstreams:g' % && \
119+
ls *.go | grep -v "convert.go" | grep -v "doc.go" | \
120+
xargs -I % sed -i.bk 's:DynamoDB:DynamoDBStreams:g' % && \
121+
ls *.go | grep -v "doc.go" | \
122+
xargs -I % sed -i.bk 's:dynamodb\.:dynamodbstreams.:g' % && \
123+
sed -i.bk 's:streams\.:ddbtypes.:g' "convert.go" && \
124+
sed -i.bk 's:ddb\.:streams.:g' "convert.go" && \
125+
sed -i.bk 's:ddbtypes\.:ddb.:g' "convert.go" &&\
126+
sed -i.bk 's:Streams::g' "convert.go" && \
127+
rm -rf ./*.bk && \
128+
gofmt -w -s . && \
129+
go test .
130+
113131

114132
################
115133
# Unit Testing #

codegen/sdk-codegen/aws-models/dynamodb-streams.2012-08-10.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
}
4949
},
5050
"com.amazonaws.dynamodbstreams#AttributeValue": {
51-
"type": "structure",
51+
"type": "union",
5252
"members": {
5353
"SS": {
5454
"target": "com.amazonaws.dynamodbstreams#StringSetAttributeValue",

codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@
141141
}
142142
},
143143
"com.amazonaws.dynamodb#AttributeValue": {
144-
"type": "structure",
144+
"type": "union",
145145
"members": {
146146
"S": {
147147
"target": "com.amazonaws.dynamodb#StringAttributeValue",
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.
Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
package attributevalue
2+
3+
import (
4+
"fmt"
5+
6+
ddb "github.com/aws/aws-sdk-go-v2/service/dynamodb/types"
7+
streams "github.com/aws/aws-sdk-go-v2/service/dynamodbstreams/types"
8+
)
9+
10+
// FromDynamoDBStreamsMap converts a map of Amazon DynamoDB Streams
11+
// AttributeValues, and all nested members.
12+
func FromDynamoDBStreamsMap(from map[string]streams.AttributeValue) (to map[string]ddb.AttributeValue, err error) {
13+
to = make(map[string]ddb.AttributeValue, len(from))
14+
for field, value := range from {
15+
to[field], err = FromDynamoDBStreams(value)
16+
if err != nil {
17+
return nil, err
18+
}
19+
}
20+
21+
return to, nil
22+
}
23+
24+
// FromDynamoDBStreamsList converts a slice of Amazon DynamoDB Streams
25+
// AttributeValues, and all nested members.
26+
func FromDynamoDBStreamsList(from []streams.AttributeValue) (to []ddb.AttributeValue, err error) {
27+
to = make([]ddb.AttributeValue, len(from))
28+
for i := 0; i < len(from); i++ {
29+
to[i], err = FromDynamoDBStreams(from[i])
30+
if err != nil {
31+
return nil, err
32+
}
33+
}
34+
35+
return to, nil
36+
}
37+
38+
// FromDynamoDBStreams converts an Amazon DynamoDB Streams AttributeValue, and
39+
// all nested members.
40+
func FromDynamoDBStreams(from streams.AttributeValue) (ddb.AttributeValue, error) {
41+
switch tv := from.(type) {
42+
case *streams.AttributeValueMemberNULL:
43+
return &ddb.AttributeValueMemberNULL{Value: tv.Value}, nil
44+
45+
case *streams.AttributeValueMemberBOOL:
46+
return &ddb.AttributeValueMemberBOOL{Value: tv.Value}, nil
47+
48+
case *streams.AttributeValueMemberB:
49+
return &ddb.AttributeValueMemberB{Value: tv.Value}, nil
50+
51+
case *streams.AttributeValueMemberBS:
52+
bs := make([][]byte, len(tv.Value))
53+
for i := 0; i < len(tv.Value); i++ {
54+
bs[i] = append([]byte{}, tv.Value[i]...)
55+
}
56+
return &ddb.AttributeValueMemberBS{Value: bs}, nil
57+
58+
case *streams.AttributeValueMemberN:
59+
return &ddb.AttributeValueMemberN{Value: tv.Value}, nil
60+
61+
case *streams.AttributeValueMemberNS:
62+
return &ddb.AttributeValueMemberNS{Value: append([]string{}, tv.Value...)}, nil
63+
64+
case *streams.AttributeValueMemberS:
65+
return &ddb.AttributeValueMemberS{Value: tv.Value}, nil
66+
67+
case *streams.AttributeValueMemberSS:
68+
return &ddb.AttributeValueMemberSS{Value: append([]string{}, tv.Value...)}, nil
69+
70+
case *streams.AttributeValueMemberL:
71+
values, err := FromDynamoDBStreamsList(tv.Value)
72+
if err != nil {
73+
return nil, err
74+
}
75+
return &ddb.AttributeValueMemberL{Value: values}, nil
76+
77+
case *streams.AttributeValueMemberM:
78+
values, err := FromDynamoDBStreamsMap(tv.Value)
79+
if err != nil {
80+
return nil, err
81+
}
82+
return &ddb.AttributeValueMemberM{Value: values}, nil
83+
84+
default:
85+
return nil, fmt.Errorf("unknown AttributeValue union member, %T", from)
86+
}
87+
}

0 commit comments

Comments
 (0)