blob: 45d052c443501ce727af363b632e00c80c1fb6b6 [file] [log] [blame]
Herbie Ong7b828bc2019-02-08 19:56:24 -08001// Copyright 2019 The Go Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style
3// license that can be found in the LICENSE file.
4
Damien Neil5c5b5312019-05-14 12:44:37 -07005package protojson
Herbie Ong7b828bc2019-02-08 19:56:24 -08006
7import (
8 "encoding/base64"
Herbie Ong0b0f4032019-03-18 19:06:15 -07009 "fmt"
Herbie Ong7b828bc2019-02-08 19:56:24 -080010 "sort"
11
Damien Neile89e6242019-05-13 23:55:40 -070012 "google.golang.org/protobuf/internal/encoding/json"
13 "google.golang.org/protobuf/internal/errors"
14 "google.golang.org/protobuf/internal/pragma"
15 "google.golang.org/protobuf/proto"
16 pref "google.golang.org/protobuf/reflect/protoreflect"
17 "google.golang.org/protobuf/reflect/protoregistry"
Herbie Ong7b828bc2019-02-08 19:56:24 -080018)
19
20// Marshal writes the given proto.Message in JSON format using default options.
21func Marshal(m proto.Message) ([]byte, error) {
22 return MarshalOptions{}.Marshal(m)
23}
24
25// MarshalOptions is a configurable JSON format marshaler.
26type MarshalOptions struct {
27 pragma.NoUnkeyedLiterals
28
Herbie Ong329be5b2019-03-27 14:47:59 -070029 // AllowPartial allows messages that have missing required fields to marshal
30 // without returning an error. If AllowPartial is false (the default),
31 // Marshal will return error if there are any missing required fields.
32 AllowPartial bool
33
Herbie Ong0b0f4032019-03-18 19:06:15 -070034 // If Indent is a non-empty string, it causes entries for an Array or Object
35 // to be preceded by the indent and trailed by a newline. Indent can only be
36 // composed of space or tab characters.
37 Indent string
38
Joe Tsai1c283042019-05-14 14:28:19 -070039 // Resolver is used for looking up types when expanding google.protobuf.Any
40 // messages. If nil, this defaults to using protoregistry.GlobalTypes.
41 Resolver interface {
42 protoregistry.MessageTypeResolver
43 }
Herbie Ong822de2d2019-03-27 13:16:23 -070044
45 encoder *json.Encoder
Herbie Ong7b828bc2019-02-08 19:56:24 -080046}
47
Herbie Ong0b0f4032019-03-18 19:06:15 -070048// Marshal marshals the given proto.Message in the JSON format using options in
49// MarshalOptions.
Herbie Ong7b828bc2019-02-08 19:56:24 -080050func (o MarshalOptions) Marshal(m proto.Message) ([]byte, error) {
Herbie Ong822de2d2019-03-27 13:16:23 -070051 var err error
52 o.encoder, err = json.NewEncoder(o.Indent)
Herbie Ong87608a72019-03-06 14:32:24 -080053 if err != nil {
54 return nil, err
55 }
Herbie Ong822de2d2019-03-27 13:16:23 -070056 if o.Resolver == nil {
57 o.Resolver = protoregistry.GlobalTypes
58 }
Herbie Ong87608a72019-03-06 14:32:24 -080059
60 var nerr errors.NonFatal
Herbie Ong822de2d2019-03-27 13:16:23 -070061 err = o.marshalMessage(m.ProtoReflect())
Herbie Ong7b828bc2019-02-08 19:56:24 -080062 if !nerr.Merge(err) {
63 return nil, err
64 }
Damien Neil4686e232019-04-05 13:31:40 -070065 if !o.AllowPartial {
66 nerr.Merge(proto.IsInitialized(m))
67 }
Herbie Ong822de2d2019-03-27 13:16:23 -070068 return o.encoder.Bytes(), nerr.E
Herbie Ong87608a72019-03-06 14:32:24 -080069}
70
71// marshalMessage marshals the given protoreflect.Message.
Herbie Ong822de2d2019-03-27 13:16:23 -070072func (o MarshalOptions) marshalMessage(m pref.Message) error {
Herbie Ong0b0f4032019-03-18 19:06:15 -070073 var nerr errors.NonFatal
74
Joe Tsai0fc49f82019-05-01 12:29:25 -070075 if isCustomType(m.Descriptor().FullName()) {
Herbie Ong822de2d2019-03-27 13:16:23 -070076 return o.marshalCustomType(m)
Herbie Ong0b0f4032019-03-18 19:06:15 -070077 }
78
Herbie Ong822de2d2019-03-27 13:16:23 -070079 o.encoder.StartObject()
80 defer o.encoder.EndObject()
81 if err := o.marshalFields(m); !nerr.Merge(err) {
Herbie Ong0b0f4032019-03-18 19:06:15 -070082 return err
83 }
Herbie Ong87608a72019-03-06 14:32:24 -080084
Herbie Ong0b0f4032019-03-18 19:06:15 -070085 return nerr.E
86}
87
88// marshalFields marshals the fields in the given protoreflect.Message.
Herbie Ong822de2d2019-03-27 13:16:23 -070089func (o MarshalOptions) marshalFields(m pref.Message) error {
Herbie Ong87608a72019-03-06 14:32:24 -080090 var nerr errors.NonFatal
Herbie Ong87608a72019-03-06 14:32:24 -080091
Herbie Ongf83d5bb2019-03-14 00:01:27 -070092 // Marshal out known fields.
Joe Tsai378c1322019-04-25 23:48:08 -070093 fieldDescs := m.Descriptor().Fields()
Herbie Ong87608a72019-03-06 14:32:24 -080094 for i := 0; i < fieldDescs.Len(); i++ {
Herbie Ong7b828bc2019-02-08 19:56:24 -080095 fd := fieldDescs.Get(i)
Joe Tsai378c1322019-04-25 23:48:08 -070096 if !m.Has(fd) {
Herbie Ong7b828bc2019-02-08 19:56:24 -080097 continue
98 }
99
Herbie Ong87608a72019-03-06 14:32:24 -0800100 name := fd.JSONName()
Joe Tsai378c1322019-04-25 23:48:08 -0700101 val := m.Get(fd)
Herbie Ong822de2d2019-03-27 13:16:23 -0700102 if err := o.encoder.WriteName(name); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800103 return err
104 }
Herbie Ong822de2d2019-03-27 13:16:23 -0700105 if err := o.marshalValue(val, fd); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800106 return err
Herbie Ong7b828bc2019-02-08 19:56:24 -0800107 }
108 }
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700109
110 // Marshal out extensions.
Joe Tsai378c1322019-04-25 23:48:08 -0700111 if err := o.marshalExtensions(m); !nerr.Merge(err) {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700112 return err
113 }
Herbie Ong87608a72019-03-06 14:32:24 -0800114 return nerr.E
Herbie Ong7b828bc2019-02-08 19:56:24 -0800115}
116
Herbie Ong87608a72019-03-06 14:32:24 -0800117// marshalValue marshals the given protoreflect.Value.
Herbie Ong822de2d2019-03-27 13:16:23 -0700118func (o MarshalOptions) marshalValue(val pref.Value, fd pref.FieldDescriptor) error {
Joe Tsaiac31a352019-05-13 14:32:56 -0700119 switch {
120 case fd.IsList():
121 return o.marshalList(val.List(), fd)
122 case fd.IsMap():
123 return o.marshalMap(val.Map(), fd)
124 default:
125 return o.marshalSingular(val, fd)
Herbie Ong7b828bc2019-02-08 19:56:24 -0800126 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800127}
128
Herbie Ong87608a72019-03-06 14:32:24 -0800129// marshalSingular marshals the given non-repeated field value. This includes
130// all scalar types, enums, messages, and groups.
Herbie Ong822de2d2019-03-27 13:16:23 -0700131func (o MarshalOptions) marshalSingular(val pref.Value, fd pref.FieldDescriptor) error {
Herbie Ong87608a72019-03-06 14:32:24 -0800132 var nerr errors.NonFatal
133 switch kind := fd.Kind(); kind {
134 case pref.BoolKind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700135 o.encoder.WriteBool(val.Bool())
Herbie Ong87608a72019-03-06 14:32:24 -0800136
137 case pref.StringKind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700138 if err := o.encoder.WriteString(val.String()); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800139 return err
140 }
141
142 case pref.Int32Kind, pref.Sint32Kind, pref.Sfixed32Kind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700143 o.encoder.WriteInt(val.Int())
Herbie Ong87608a72019-03-06 14:32:24 -0800144
145 case pref.Uint32Kind, pref.Fixed32Kind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700146 o.encoder.WriteUint(val.Uint())
Herbie Ong7b828bc2019-02-08 19:56:24 -0800147
148 case pref.Int64Kind, pref.Sint64Kind, pref.Uint64Kind,
149 pref.Sfixed64Kind, pref.Fixed64Kind:
Herbie Ong87608a72019-03-06 14:32:24 -0800150 // 64-bit integers are written out as JSON string.
Herbie Ong822de2d2019-03-27 13:16:23 -0700151 o.encoder.WriteString(val.String())
Herbie Ong7b828bc2019-02-08 19:56:24 -0800152
Herbie Ong87608a72019-03-06 14:32:24 -0800153 case pref.FloatKind:
154 // Encoder.WriteFloat handles the special numbers NaN and infinites.
Herbie Ong822de2d2019-03-27 13:16:23 -0700155 o.encoder.WriteFloat(val.Float(), 32)
Herbie Ong87608a72019-03-06 14:32:24 -0800156
157 case pref.DoubleKind:
158 // Encoder.WriteFloat handles the special numbers NaN and infinites.
Herbie Ong822de2d2019-03-27 13:16:23 -0700159 o.encoder.WriteFloat(val.Float(), 64)
Herbie Ong7b828bc2019-02-08 19:56:24 -0800160
161 case pref.BytesKind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700162 err := o.encoder.WriteString(base64.StdEncoding.EncodeToString(val.Bytes()))
Herbie Ong87608a72019-03-06 14:32:24 -0800163 if !nerr.Merge(err) {
164 return err
165 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800166
167 case pref.EnumKind:
Joe Tsaid24bc722019-04-15 23:39:09 -0700168 if fd.Enum().FullName() == "google.protobuf.NullValue" {
Herbie Ong822de2d2019-03-27 13:16:23 -0700169 o.encoder.WriteNull()
Joe Tsaid24bc722019-04-15 23:39:09 -0700170 } else if desc := fd.Enum().Values().ByNumber(val.Enum()); desc != nil {
Herbie Ong822de2d2019-03-27 13:16:23 -0700171 err := o.encoder.WriteString(string(desc.Name()))
Herbie Ong87608a72019-03-06 14:32:24 -0800172 if !nerr.Merge(err) {
173 return err
174 }
175 } else {
176 // Use numeric value if there is no enum value descriptor.
Joe Tsaid24bc722019-04-15 23:39:09 -0700177 o.encoder.WriteInt(int64(val.Enum()))
Herbie Ong7b828bc2019-02-08 19:56:24 -0800178 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800179
180 case pref.MessageKind, pref.GroupKind:
Herbie Ong822de2d2019-03-27 13:16:23 -0700181 if err := o.marshalMessage(val.Message()); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800182 return err
183 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800184
Herbie Ong87608a72019-03-06 14:32:24 -0800185 default:
Herbie Ong0b0f4032019-03-18 19:06:15 -0700186 panic(fmt.Sprintf("%v has unknown kind: %v", fd.FullName(), kind))
Herbie Ong87608a72019-03-06 14:32:24 -0800187 }
188 return nerr.E
Herbie Ong7b828bc2019-02-08 19:56:24 -0800189}
190
Herbie Ong87608a72019-03-06 14:32:24 -0800191// marshalList marshals the given protoreflect.List.
Herbie Ong822de2d2019-03-27 13:16:23 -0700192func (o MarshalOptions) marshalList(list pref.List, fd pref.FieldDescriptor) error {
193 o.encoder.StartArray()
194 defer o.encoder.EndArray()
Herbie Ong87608a72019-03-06 14:32:24 -0800195
Herbie Ong7b828bc2019-02-08 19:56:24 -0800196 var nerr errors.NonFatal
Herbie Ong87608a72019-03-06 14:32:24 -0800197 for i := 0; i < list.Len(); i++ {
Herbie Ong7b828bc2019-02-08 19:56:24 -0800198 item := list.Get(i)
Herbie Ong822de2d2019-03-27 13:16:23 -0700199 if err := o.marshalSingular(item, fd); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800200 return err
Herbie Ong7b828bc2019-02-08 19:56:24 -0800201 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800202 }
Herbie Ong87608a72019-03-06 14:32:24 -0800203 return nerr.E
Herbie Ong7b828bc2019-02-08 19:56:24 -0800204}
205
206type mapEntry struct {
207 key pref.MapKey
208 value pref.Value
209}
210
Herbie Ong87608a72019-03-06 14:32:24 -0800211// marshalMap marshals given protoreflect.Map.
Herbie Ong822de2d2019-03-27 13:16:23 -0700212func (o MarshalOptions) marshalMap(mmap pref.Map, fd pref.FieldDescriptor) error {
213 o.encoder.StartObject()
214 defer o.encoder.EndObject()
Herbie Ong87608a72019-03-06 14:32:24 -0800215
Herbie Ong7b828bc2019-02-08 19:56:24 -0800216 // Get a sorted list based on keyType first.
217 entries := make([]mapEntry, 0, mmap.Len())
218 mmap.Range(func(key pref.MapKey, val pref.Value) bool {
219 entries = append(entries, mapEntry{key: key, value: val})
220 return true
221 })
Joe Tsaiac31a352019-05-13 14:32:56 -0700222 sortMap(fd.MapKey().Kind(), entries)
Herbie Ong7b828bc2019-02-08 19:56:24 -0800223
Herbie Ong87608a72019-03-06 14:32:24 -0800224 // Write out sorted list.
Herbie Ong7b828bc2019-02-08 19:56:24 -0800225 var nerr errors.NonFatal
Herbie Ong7b828bc2019-02-08 19:56:24 -0800226 for _, entry := range entries {
Herbie Ong822de2d2019-03-27 13:16:23 -0700227 if err := o.encoder.WriteName(entry.key.String()); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800228 return err
Herbie Ong7b828bc2019-02-08 19:56:24 -0800229 }
Joe Tsaiac31a352019-05-13 14:32:56 -0700230 if err := o.marshalSingular(entry.value, fd.MapValue()); !nerr.Merge(err) {
Herbie Ong87608a72019-03-06 14:32:24 -0800231 return err
232 }
Herbie Ong7b828bc2019-02-08 19:56:24 -0800233 }
Herbie Ong87608a72019-03-06 14:32:24 -0800234 return nerr.E
Herbie Ong7b828bc2019-02-08 19:56:24 -0800235}
236
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700237// sortMap orders list based on value of key field for deterministic ordering.
Herbie Ong7b828bc2019-02-08 19:56:24 -0800238func sortMap(keyKind pref.Kind, values []mapEntry) {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700239 sort.Slice(values, func(i, j int) bool {
240 switch keyKind {
241 case pref.Int32Kind, pref.Sint32Kind, pref.Sfixed32Kind,
242 pref.Int64Kind, pref.Sint64Kind, pref.Sfixed64Kind:
Herbie Ong7b828bc2019-02-08 19:56:24 -0800243 return values[i].key.Int() < values[j].key.Int()
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700244
245 case pref.Uint32Kind, pref.Fixed32Kind,
246 pref.Uint64Kind, pref.Fixed64Kind:
Herbie Ong7b828bc2019-02-08 19:56:24 -0800247 return values[i].key.Uint() < values[j].key.Uint()
248 }
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700249 return values[i].key.String() < values[j].key.String()
250 })
251}
252
253// marshalExtensions marshals extension fields.
Joe Tsai378c1322019-04-25 23:48:08 -0700254func (o MarshalOptions) marshalExtensions(m pref.Message) error {
255 type entry struct {
256 key string
257 value pref.Value
258 desc pref.FieldDescriptor
Herbie Ong7b828bc2019-02-08 19:56:24 -0800259 }
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700260
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700261 // Get a sorted list based on field key first.
Joe Tsai378c1322019-04-25 23:48:08 -0700262 var entries []entry
263 m.Range(func(fd pref.FieldDescriptor, v pref.Value) bool {
264 if !fd.IsExtension() {
265 return true
266 }
267 xt := fd.(pref.ExtensionType)
268
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700269 // If extended type is a MessageSet, set field name to be the message type name.
Joe Tsai378c1322019-04-25 23:48:08 -0700270 name := xt.Descriptor().FullName()
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700271 if isMessageSetExtension(xt) {
Joe Tsai0fc49f82019-05-01 12:29:25 -0700272 name = xt.Descriptor().Message().FullName()
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700273 }
274
Joe Tsai378c1322019-04-25 23:48:08 -0700275 // Use [name] format for JSON field name.
276 entries = append(entries, entry{
277 key: string(name),
278 value: v,
279 desc: fd,
280 })
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700281 return true
282 })
283
284 // Sort extensions lexicographically.
285 sort.Slice(entries, func(i, j int) bool {
286 return entries[i].key < entries[j].key
287 })
288
289 // Write out sorted list.
290 var nerr errors.NonFatal
291 for _, entry := range entries {
292 // JSON field name is the proto field name enclosed in [], similar to
293 // textproto. This is consistent with Go v1 lib. C++ lib v3.7.0 does not
294 // marshal out extension fields.
Herbie Ong822de2d2019-03-27 13:16:23 -0700295 if err := o.encoder.WriteName("[" + entry.key + "]"); !nerr.Merge(err) {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700296 return err
297 }
Joe Tsai378c1322019-04-25 23:48:08 -0700298 if err := o.marshalValue(entry.value, entry.desc); !nerr.Merge(err) {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700299 return err
300 }
301 }
302 return nerr.E
303}
304
305// isMessageSetExtension reports whether extension extends a message set.
306func isMessageSetExtension(xt pref.ExtensionType) bool {
Joe Tsai0fc49f82019-05-01 12:29:25 -0700307 xd := xt.Descriptor()
308 if xd.Name() != "message_set_extension" {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700309 return false
310 }
Joe Tsai0fc49f82019-05-01 12:29:25 -0700311 md := xd.Message()
Joe Tsaid24bc722019-04-15 23:39:09 -0700312 if md == nil {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700313 return false
314 }
Joe Tsai0fc49f82019-05-01 12:29:25 -0700315 if xd.FullName().Parent() != md.FullName() {
Herbie Ongf83d5bb2019-03-14 00:01:27 -0700316 return false
317 }
Joe Tsaiac31a352019-05-13 14:32:56 -0700318 xmd, ok := xd.ContainingMessage().(interface{ IsMessageSet() bool })
Joe Tsaid24bc722019-04-15 23:39:09 -0700319 return ok && xmd.IsMessageSet()
Herbie Ong7b828bc2019-02-08 19:56:24 -0800320}