-
Notifications
You must be signed in to change notification settings - Fork 100
/
types.go
138 lines (122 loc) · 4.55 KB
/
types.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
// 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"
"fmt"
"go.uber.org/yarpc"
"go.uber.org/yarpc/api/transport"
"go.uber.org/yarpc/internal/procedure"
"github.com/gogo/protobuf/proto"
)
const (
// Encoding is the name of this encoding.
Encoding transport.Encoding = "protobuf"
rawResponseHeaderKey = "yarpc-protobuf-raw-response"
)
// SetRawResponse will set rawResponseHeaderKey to "true".
//
// rawResponseHeaderKey is a header key attached to either a request or
// response that signals a UnaryHandler to not encode an application error
// inside a wirepb.Response object, instead marshalling the actual response.
//
// Note per the documentation on transport.Headers#With, the returned Header
// may not be the same as the input header, so the caller should always
// update the header with:
//
// header = protobuf.SetRawResponse(header)
func SetRawResponse(headers transport.Headers) transport.Headers {
return headers.With(rawResponseHeaderKey, "1")
}
// ***all below functions should only be called by generated code***
// BuildProcedures builds the transport.Procedures.
func BuildProcedures(
serviceName string,
methodNameToUnaryHandler map[string]transport.UnaryHandler,
methodNameToOnewayHandler map[string]transport.OnewayHandler,
) []transport.Procedure {
procedures := make([]transport.Procedure, 0, len(methodNameToUnaryHandler))
for methodName, unaryHandler := range methodNameToUnaryHandler {
procedures = append(
procedures,
transport.Procedure{
Name: procedure.ToName(serviceName, methodName),
HandlerSpec: transport.NewUnaryHandlerSpec(unaryHandler),
Encoding: Encoding,
},
)
}
for methodName, onewayHandler := range methodNameToOnewayHandler {
procedures = append(
procedures,
transport.Procedure{
Name: procedure.ToName(serviceName, methodName),
HandlerSpec: transport.NewOnewayHandlerSpec(onewayHandler),
Encoding: Encoding,
},
)
}
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)
}
// NewClient creates a new client.
func NewClient(serviceName string, clientConfig transport.ClientConfig) Client {
return newClient(serviceName, clientConfig)
}
// NewUnaryHandler returns a new UnaryHandler.
func NewUnaryHandler(
handle func(context.Context, proto.Message) (proto.Message, error),
newRequest func() proto.Message,
) transport.UnaryHandler {
return newUnaryHandler(handle, newRequest)
}
// NewOnewayHandler returns a new OnewayHandler.
func NewOnewayHandler(
handleOneway func(context.Context, proto.Message) error,
newRequest func() proto.Message,
) transport.OnewayHandler {
return newOnewayHandler(handleOneway, newRequest)
}
// 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 fmt.Errorf("expected proto.Message to have type %T but had type %T", expectedType, actualType)
}
func isRawResponse(headers transport.Headers) bool {
rawResponse, ok := headers.Get(rawResponseHeaderKey)
return ok && rawResponse == "1"
}
func getRawResponseHeaders() transport.Headers {
return SetRawResponse(transport.Headers{})
}