forked from bufbuild/buf
/
invoker.go
442 lines (402 loc) · 12.7 KB
/
invoker.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
// Copyright 2020-2023 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package bufcurl
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/http/httptest"
"sync"
"github.com/bufbuild/buf/private/pkg/app"
"github.com/bufbuild/buf/private/pkg/app/appflag"
"github.com/bufbuild/buf/private/pkg/protoencoding"
"github.com/bufbuild/buf/private/pkg/verbose"
"github.com/bufbuild/connect-go"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/types/dynamicpb"
)
type deferredMessage struct {
data []byte
}
type protoCodec struct{}
func (p protoCodec) Name() string {
return "proto"
}
func (p protoCodec) Marshal(a any) ([]byte, error) {
protoMessage, ok := a.(proto.Message)
if !ok {
return nil, fmt.Errorf("cannot marshal: %T does not implement proto.Message", a)
}
return protoencoding.NewWireMarshaler().Marshal(protoMessage)
}
func (p protoCodec) Unmarshal(bytes []byte, a any) error {
if deferred, ok := a.(*deferredMessage); ok {
// must make a copy since Connect framework will re-use the byte slice
deferred.data = make([]byte, len(bytes))
copy(deferred.data, bytes)
return nil
}
protoMessage, ok := a.(proto.Message)
if !ok {
return fmt.Errorf("cannot unmarshal: %T does not implement proto.Message", a)
}
return protoencoding.NewWireUnmarshaler(nil).Unmarshal(bytes, protoMessage)
}
type invokeClient = connect.Client[dynamicpb.Message, deferredMessage]
type invoker struct {
md protoreflect.MethodDescriptor
res protoencoding.Resolver
emitDefaults bool
client *invokeClient
output io.Writer
errOutput io.Writer
printer verbose.Printer
}
// NewInvoker creates a new invoker for invoking the method described by the
// given descriptor. The given writer is used to write the output response(s)
// in JSON format. The given resolver is used to resolve Any messages and
// extensions that appear in the input or output. Other parameters are used
// to create a Connect client, for issuing the RPC.
func NewInvoker(container appflag.Container, md protoreflect.MethodDescriptor, res protoencoding.Resolver, emitDefaults bool, httpClient connect.HTTPClient, opts []connect.ClientOption, url string, out io.Writer) Invoker {
opts = append(opts, connect.WithCodec(protoCodec{}))
// TODO: could also provide custom compressor implementations that could give us
// optics into when request and response messages are compressed (which could be
// useful to include in verbose output).
return &invoker{
md: md,
res: res,
emitDefaults: emitDefaults,
output: out,
printer: container.VerbosePrinter(),
errOutput: container.Stderr(),
client: connect.NewClient[dynamicpb.Message, deferredMessage](httpClient, url, opts...),
}
}
func (inv *invoker) Invoke(ctx context.Context, dataSource string, data io.Reader, headers http.Header) error {
inv.printer.Printf("* Invoking RPC %s\n", inv.md.FullName())
// request's user-agent header(s) get overwritten by protocol, so we stash them in the
// context so that underlying transport can restore them
ctx = withUserAgent(ctx, headers)
switch {
case inv.md.IsStreamingServer() && inv.md.IsStreamingClient():
return inv.handleBidiStream(ctx, dataSource, data, headers)
case inv.md.IsStreamingServer():
return inv.handleServerStream(ctx, dataSource, data, headers)
case inv.md.IsStreamingClient():
return inv.handleClientStream(ctx, dataSource, data, headers)
default:
return inv.handleUnary(ctx, dataSource, data, headers)
}
}
func (inv *invoker) handleUnary(ctx context.Context, dataSource string, data io.Reader, headers http.Header) error {
provider := newMessageProvider(dataSource, data, inv.res)
msg := dynamicpb.NewMessage(inv.md.Input())
if err := provider.next(msg); err != nil {
return err
}
// make sure input does not contain a second message
dummy := dynamicpb.NewMessage(inv.md.Input())
if err := provider.next(dummy); err != io.EOF {
return fmt.Errorf("method %s is a unary RPC, but input contained more than one request message", inv.md.Name())
}
req := connect.NewRequest(msg)
for k, v := range headers {
req.Header()[k] = v
}
resp, err := inv.client.CallUnary(ctx, req)
if err != nil {
var connErr *connect.Error
if !errors.As(err, &connErr) {
return err
}
err := inv.handleErrorResponse(connErr)
return err
}
return inv.handleResponse(resp.Msg.data, nil)
}
func (inv *invoker) handleClientStream(ctx context.Context, dataSource string, data io.Reader, headers http.Header) (retErr error) {
provider := newStreamMessageProvider(dataSource, data, inv.res)
msg := dynamicpb.NewMessage(inv.md.Input())
stream := inv.client.CallClientStream(ctx)
for k, v := range headers {
stream.RequestHeader()[k] = v
}
defer func() {
if retErr != nil {
var connErr *connect.Error
if errors.As(retErr, &connErr) {
retErr = inv.handleErrorResponse(connErr)
}
}
}()
if err, isStreamError := inv.handleStreamRequest(provider, msg, stream); err != nil {
if isStreamError {
_, recvErr := stream.CloseAndReceive()
// stream.Send should return io.EOF on error, and caller is expected to call
// stream.Receive to get the actual RPC error.
if recvErr != nil {
return recvErr
}
}
return err
}
resp, err := stream.CloseAndReceive()
if err != nil {
return err
}
return inv.handleResponse(resp.Msg.data, nil)
}
func (inv *invoker) handleServerStream(ctx context.Context, dataSource string, data io.Reader, headers http.Header) (retErr error) {
provider := newMessageProvider(dataSource, data, inv.res)
msg := dynamicpb.NewMessage(inv.md.Input())
if err := provider.next(msg); err != nil {
return err
}
// make sure input does not contain a second message
dummy := dynamicpb.NewMessage(inv.md.Input())
if err := provider.next(dummy); err != io.EOF {
return fmt.Errorf("method %s is a unary RPC, but input contained more than one request message", inv.md.Name())
}
req := connect.NewRequest(msg)
for k, v := range headers {
req.Header()[k] = v
}
defer func() {
if retErr != nil {
var connErr *connect.Error
if errors.As(retErr, &connErr) {
retErr = inv.handleErrorResponse(connErr)
}
}
}()
stream, err := inv.client.CallServerStream(ctx, req)
if err != nil {
return err
}
return inv.handleStreamResponse(&serverStreamAdapter{stream: stream})
}
func (inv *invoker) handleBidiStream(ctx context.Context, dataSource string, data io.Reader, headers http.Header) (retErr error) {
ctx, cancel := context.WithCancel(ctx)
provider := newStreamMessageProvider(dataSource, data, inv.res)
msg := dynamicpb.NewMessage(inv.md.Input())
stream := inv.client.CallBidiStream(ctx)
for k, v := range headers {
stream.RequestHeader()[k] = v
}
defer func() {
if retErr != nil {
var connErr *connect.Error
if errors.As(retErr, &connErr) {
retErr = inv.handleErrorResponse(connErr)
}
}
}()
var recvErr error
var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
defer cancel()
if err := inv.handleStreamResponse(stream); err != nil {
recvErr = err
}
}()
defer func() {
wg.Wait()
if recvErr != nil {
// may just get io.EOF or cancel error when trying to write to closed
// request stream whereas actual error details will be seen on the read side
if retErr == nil || errors.Is(retErr, io.EOF) || isCancelled(retErr) {
retErr = recvErr
}
}
}()
shouldCancel := true
defer func() {
if shouldCancel {
cancel()
}
}()
err, isStreamError := inv.handleStreamRequest(provider, msg, stream)
shouldCancel = err != nil && !isStreamError
if err != nil {
return err
}
return stream.CloseRequest()
}
func isCancelled(err error) bool {
if errors.Is(err, context.Canceled) {
return true
}
var connErr *connect.Error
if errors.As(err, &connErr) {
return connErr.Code() == connect.CodeCanceled
}
return false
}
func (inv *invoker) handleResponse(data []byte, msg *dynamicpb.Message) error {
if msg == nil {
msg = dynamicpb.NewMessage(inv.md.Output())
}
if err := protoencoding.NewWireUnmarshaler(inv.res).Unmarshal(data, msg); err != nil {
return err
}
jsonMarshalerOptions := []protoencoding.JSONMarshalerOption{
protoencoding.JSONMarshalerWithIndent(),
}
if inv.emitDefaults {
jsonMarshalerOptions = append(
jsonMarshalerOptions,
protoencoding.JSONMarshalerWithEmitUnpopulated(),
)
}
outputBytes, err := protoencoding.NewJSONMarshaler(inv.res, jsonMarshalerOptions...).Marshal(msg)
if err != nil {
return err
}
_, err = fmt.Fprintf(inv.output, "%s\n", outputBytes)
return err
}
type clientStream interface {
Send(message *dynamicpb.Message) error
}
type serverStream interface {
Receive() (*deferredMessage, error)
CloseResponse() error
}
type serverStreamAdapter struct {
stream *connect.ServerStreamForClient[deferredMessage]
}
func (ssa *serverStreamAdapter) Receive() (*deferredMessage, error) {
if !ssa.stream.Receive() {
err := ssa.stream.Err()
if err == nil {
err = io.EOF
}
return nil, err
}
return ssa.stream.Msg(), nil
}
func (ssa *serverStreamAdapter) CloseResponse() error {
return ssa.stream.Close()
}
func (inv *invoker) handleStreamRequest(provider messageProvider, msg *dynamicpb.Message, stream clientStream) (error, bool) {
for {
if err := provider.next(msg); errors.Is(err, io.EOF) {
break
} else if err != nil {
return err, false
}
if err := stream.Send(msg); err != nil {
return err, true
}
}
return nil, false
}
func (inv *invoker) handleStreamResponse(stream serverStream) (retError error) {
defer func() {
err := stream.CloseResponse()
if err != nil && retError == nil {
retError = err
}
}()
msg := dynamicpb.NewMessage(inv.md.Output())
for {
responseMsg, err := stream.Receive()
if errors.Is(err, io.EOF) {
return nil
} else if err != nil {
return err
}
if err := inv.handleResponse(responseMsg.data, msg); err != nil {
return err
}
}
}
func (inv *invoker) handleErrorResponse(connErr *connect.Error) error {
// NB: This is a nasty hack: we create a fake request that looks
// like a unary Connect request, so that the ErrorWriter will
// print the error in the format we want, which is just the
// JSON representation of the Connect error. (We don't need
// an end-stream message representation or for the content
// to be put into response headers, which is what it may
// choose to do if it detects a different protocol in the
// request).
req := &http.Request{
Header: http.Header{},
}
req.Header.Add("content-type", "application/json")
w := connect.NewErrorWriter()
responseWriter := httptest.NewRecorder()
err := w.Write(responseWriter, req, connErr)
if err != nil {
return err
}
var prettyPrinted bytes.Buffer
if err := json.Indent(&prettyPrinted, responseWriter.Body.Bytes(), "", " "); err != nil {
return err
}
_, _ = inv.errOutput.Write(prettyPrinted.Bytes())
_, _ = inv.errOutput.Write([]byte("\n"))
return app.NewError(int(connErr.Code()*8), "")
}
func newStreamMessageProvider(dataSource string, data io.Reader, res protoencoding.Resolver) messageProvider {
if data == nil {
// if no data provided, treat as empty input
data = bytes.NewBuffer(nil)
}
return &streamMessageProvider{name: dataSource, dec: json.NewDecoder(data), res: res}
}
func newMessageProvider(dataSource string, data io.Reader, res protoencoding.Resolver) messageProvider {
if data == nil {
// if no data provider, treat as if single empty message
return &singleEmptyMessageProvider{}
} else {
return newStreamMessageProvider(dataSource, data, res)
}
}
type messageProvider interface {
next(proto.Message) error
}
type singleEmptyMessageProvider struct {
read bool
}
func (s *singleEmptyMessageProvider) next(_ proto.Message) error {
if !s.read {
s.read = true
return nil
}
return io.EOF
}
type streamMessageProvider struct {
name string
dec *json.Decoder
res protoencoding.Resolver
}
func (s *streamMessageProvider) next(msg proto.Message) error {
var jsonData json.RawMessage
if err := s.dec.Decode(&jsonData); err != nil {
if err == io.EOF {
return err
}
return fmt.Errorf("%s at offset %d: %w", s.name, s.dec.InputOffset(), err)
}
proto.Reset(msg)
return protoencoding.NewJSONUnmarshaler(s.res).Unmarshal(jsonData, msg)
}