forked from yarpc/yarpc-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
protobuf.go
197 lines (173 loc) · 6.48 KB
/
protobuf.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package protobuf
import (
"context"
"reflect"
"strings"
"github.com/gogo/protobuf/proto"
"go.uber.org/yarpc"
"go.uber.org/yarpc/api/transport"
"go.uber.org/yarpc/pkg/procedure"
"go.uber.org/yarpc/yarpcerrors"
)
const (
// Encoding is the name of this encoding.
Encoding transport.Encoding = "proto"
// JSONEncoding is the name of the JSON encoding.
//
// Protobuf handlers are able to handle both Encoding and JSONEncoding encodings.
JSONEncoding transport.Encoding = "json"
)
// UseJSON says to use the json encoding for client/server communication.
var UseJSON ClientOption = useJSON{}
// ***all below functions should only be called by generated code***
// BuildProceduresParams contains the parameters for BuildProcedures.
type BuildProceduresParams struct {
ServiceName string
UnaryHandlerParams []BuildProceduresUnaryHandlerParams
OnewayHandlerParams []BuildProceduresOnewayHandlerParams
}
// BuildProceduresUnaryHandlerParams contains the parameters for a UnaryHandler for BuildProcedures.
type BuildProceduresUnaryHandlerParams struct {
MethodName string
Handler transport.UnaryHandler
}
// BuildProceduresOnewayHandlerParams contains the parameters for a OnewayHandler for BuildProcedures.
type BuildProceduresOnewayHandlerParams struct {
MethodName string
Handler transport.OnewayHandler
}
// BuildProcedures builds the transport.Procedures.
func BuildProcedures(params BuildProceduresParams) []transport.Procedure {
procedures := make([]transport.Procedure, 0, 2*(len(params.UnaryHandlerParams)+len(params.OnewayHandlerParams)))
for _, unaryHandlerParams := range params.UnaryHandlerParams {
procedures = append(
procedures,
transport.Procedure{
Name: procedure.ToName(params.ServiceName, unaryHandlerParams.MethodName),
HandlerSpec: transport.NewUnaryHandlerSpec(unaryHandlerParams.Handler),
Encoding: Encoding,
},
transport.Procedure{
Name: procedure.ToName(params.ServiceName, unaryHandlerParams.MethodName),
HandlerSpec: transport.NewUnaryHandlerSpec(unaryHandlerParams.Handler),
Encoding: JSONEncoding,
},
)
}
for _, onewayHandlerParams := range params.OnewayHandlerParams {
procedures = append(
procedures,
transport.Procedure{
Name: procedure.ToName(params.ServiceName, onewayHandlerParams.MethodName),
HandlerSpec: transport.NewOnewayHandlerSpec(onewayHandlerParams.Handler),
Encoding: Encoding,
},
transport.Procedure{
Name: procedure.ToName(params.ServiceName, onewayHandlerParams.MethodName),
HandlerSpec: transport.NewOnewayHandlerSpec(onewayHandlerParams.Handler),
Encoding: JSONEncoding,
},
)
}
return procedures
}
// Client is a protobuf client.
type Client interface {
Call(
ctx context.Context,
requestMethodName string,
request proto.Message,
newResponse func() proto.Message,
options ...yarpc.CallOption,
) (proto.Message, error)
CallOneway(
ctx context.Context,
requestMethodName string,
request proto.Message,
options ...yarpc.CallOption,
) (transport.Ack, error)
}
// ClientOption is an option for a new Client.
type ClientOption interface {
apply(*client)
}
// ClientParams contains the parameters for creating a new Client.
type ClientParams struct {
ServiceName string
ClientConfig transport.ClientConfig
Options []ClientOption
}
// NewClient creates a new client.
func NewClient(params ClientParams) Client {
return newClient(params.ServiceName, params.ClientConfig, params.Options...)
}
// UnaryHandlerParams contains the parameters for creating a new UnaryHandler.
type UnaryHandlerParams struct {
Handle func(context.Context, proto.Message) (proto.Message, error)
NewRequest func() proto.Message
}
// NewUnaryHandler returns a new UnaryHandler.
func NewUnaryHandler(params UnaryHandlerParams) transport.UnaryHandler {
return newUnaryHandler(params.Handle, params.NewRequest)
}
// OnewayHandlerParams contains the parameters for creating a new OnewayHandler.
type OnewayHandlerParams struct {
Handle func(context.Context, proto.Message) error
NewRequest func() proto.Message
}
// NewOnewayHandler returns a new OnewayHandler.
func NewOnewayHandler(params OnewayHandlerParams) transport.OnewayHandler {
return newOnewayHandler(params.Handle, params.NewRequest)
}
// ClientBuilderOptions returns ClientOptions that yarpc.InjectClients should use for a
// specific client given information about the field into which the client is being injected.
func ClientBuilderOptions(_ transport.ClientConfig, structField reflect.StructField) []ClientOption {
var opts []ClientOption
for _, opt := range uniqueLowercaseStrings(strings.Split(structField.Tag.Get("proto"), ",")) {
switch opt {
case "json":
opts = append(opts, UseJSON)
}
}
return opts
}
// CastError returns an error saying that generated code could not properly cast a proto.Message to it's expected type.
func CastError(expectedType proto.Message, actualType proto.Message) error {
return yarpcerrors.Newf(yarpcerrors.CodeInternal, "expected proto.Message to have type %T but had type %T", expectedType, actualType)
}
type useJSON struct{}
func (useJSON) apply(client *client) {
client.encoding = JSONEncoding
}
func uniqueLowercaseStrings(s []string) []string {
m := make(map[string]bool, len(s))
for _, e := range s {
if e != "" {
m[strings.ToLower(e)] = true
}
}
c := make([]string, 0, len(m))
for key := range m {
c = append(c, key)
}
return c
}