/
client.go
865 lines (779 loc) · 26.9 KB
/
client.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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
package grpcreflect
import (
"bytes"
"context"
"fmt"
"io"
"reflect"
"runtime"
"sync"
"sync/atomic"
"time"
"github.com/golang/protobuf/proto"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
refv1 "google.golang.org/grpc/reflection/grpc_reflection_v1"
refv1alpha "google.golang.org/grpc/reflection/grpc_reflection_v1alpha"
"google.golang.org/grpc/status"
"google.golang.org/protobuf/types/descriptorpb"
"github.com/jhump/protoreflect/desc"
"github.com/jhump/protoreflect/internal"
)
// If we try the v1 reflection API and get back "not implemented", we'll wait
// this long before trying v1 again. This allows a long-lived client to
// dynamically switch from v1alpha to v1 if the underlying server is updated
// to support it. But it also prevents every stream request from always trying
// v1 first: if we try it and see it fail, we shouldn't continually retry it
// if we expect it will fail again.
const durationBetweenV1Attempts = time.Hour
// elementNotFoundError is the error returned by reflective operations where the
// server does not recognize a given file name, symbol name, or extension.
type elementNotFoundError struct {
name string
kind elementKind
symType symbolType // only used when kind == elementKindSymbol
tag int32 // only used when kind == elementKindExtension
// only errors with a kind of elementKindFile will have a cause, which means
// the named file count not be resolved because of a dependency that could
// not be found where cause describes the missing dependency
cause *elementNotFoundError
}
type elementKind int
const (
elementKindSymbol elementKind = iota
elementKindFile
elementKindExtension
)
type symbolType string
const (
symbolTypeService = "Service"
symbolTypeMessage = "Message"
symbolTypeEnum = "Enum"
symbolTypeUnknown = "Symbol"
)
func symbolNotFound(symbol string, symType symbolType, cause *elementNotFoundError) error {
if cause != nil && cause.kind == elementKindSymbol && cause.name == symbol {
// no need to wrap
if symType != symbolTypeUnknown && cause.symType == symbolTypeUnknown {
// We previously didn't know symbol type but now do?
// Create a new error that has the right symbol type.
return &elementNotFoundError{name: symbol, symType: symType, kind: elementKindSymbol}
}
return cause
}
return &elementNotFoundError{name: symbol, symType: symType, kind: elementKindSymbol, cause: cause}
}
func extensionNotFound(extendee string, tag int32, cause *elementNotFoundError) error {
if cause != nil && cause.kind == elementKindExtension && cause.name == extendee && cause.tag == tag {
// no need to wrap
return cause
}
return &elementNotFoundError{name: extendee, tag: tag, kind: elementKindExtension, cause: cause}
}
func fileNotFound(file string, cause *elementNotFoundError) error {
if cause != nil && cause.kind == elementKindFile && cause.name == file {
// no need to wrap
return cause
}
return &elementNotFoundError{name: file, kind: elementKindFile, cause: cause}
}
func (e *elementNotFoundError) Error() string {
first := true
var b bytes.Buffer
for ; e != nil; e = e.cause {
if first {
first = false
} else {
_, _ = fmt.Fprint(&b, "\ncaused by: ")
}
switch e.kind {
case elementKindSymbol:
_, _ = fmt.Fprintf(&b, "%s not found: %s", e.symType, e.name)
case elementKindExtension:
_, _ = fmt.Fprintf(&b, "Extension not found: tag %d for %s", e.tag, e.name)
default:
_, _ = fmt.Fprintf(&b, "File not found: %s", e.name)
}
}
return b.String()
}
// IsElementNotFoundError determines if the given error indicates that a file
// name, symbol name, or extension field was could not be found by the server.
func IsElementNotFoundError(err error) bool {
_, ok := err.(*elementNotFoundError)
return ok
}
// ProtocolError is an error returned when the server sends a response of the
// wrong type.
type ProtocolError struct {
missingType reflect.Type
}
func (p ProtocolError) Error() string {
return fmt.Sprintf("Protocol error: response was missing %v", p.missingType)
}
type extDesc struct {
extendedMessageName string
extensionNumber int32
}
// Client is a client connection to a server for performing reflection calls
// and resolving remote symbols.
type Client struct {
ctx context.Context
now func() time.Time
stubV1 refv1.ServerReflectionClient
stubV1Alpha refv1alpha.ServerReflectionClient
allowMissing atomic.Bool
connMu sync.Mutex
cancel context.CancelFunc
stream refv1alpha.ServerReflection_ServerReflectionInfoClient
useV1Alpha bool
lastTriedV1 time.Time
cacheMu sync.RWMutex
protosByName map[string]*descriptorpb.FileDescriptorProto
filesByName map[string]*desc.FileDescriptor
filesBySymbol map[string]*desc.FileDescriptor
filesByExtension map[extDesc]*desc.FileDescriptor
}
// NewClient creates a new Client with the given root context and using the
// given RPC stub for talking to the server.
//
// Deprecated: Use NewClientV1Alpha if you are intentionally pinning the
// v1alpha version of the reflection service. Otherwise, use NewClientAuto
// instead.
func NewClient(ctx context.Context, stub refv1alpha.ServerReflectionClient) *Client {
return NewClientV1Alpha(ctx, stub)
}
// NewClientV1Alpha creates a new Client using the v1alpha version of reflection
// with the given root context and using the given RPC stub for talking to the
// server.
func NewClientV1Alpha(ctx context.Context, stub refv1alpha.ServerReflectionClient) *Client {
return newClient(ctx, nil, stub)
}
func newClient(ctx context.Context, stubv1 refv1.ServerReflectionClient, stubv1alpha refv1alpha.ServerReflectionClient) *Client {
cr := &Client{
ctx: ctx,
now: time.Now,
stubV1: stubv1,
stubV1Alpha: stubv1alpha,
protosByName: map[string]*descriptorpb.FileDescriptorProto{},
filesByName: map[string]*desc.FileDescriptor{},
filesBySymbol: map[string]*desc.FileDescriptor{},
filesByExtension: map[extDesc]*desc.FileDescriptor{},
}
// don't leak a grpc stream
runtime.SetFinalizer(cr, (*Client).Reset)
return cr
}
// NewClientAuto creates a new Client that will use either v1 or v1alpha version
// of reflection (based on what the server supports) with the given root context
// and using the given client connection.
//
// It will first the v1 version of the reflection service. If it gets back an
// "Unimplemented" error, it will fall back to using the v1alpha version. It
// will remember which version the server supports for any subsequent operations
// that need to re-invoke the streaming RPC. But, if it's a very long-lived
// client, it will periodically retry the v1 version (in case the server is
// updated to support it also). The period for these retries is every hour.
func NewClientAuto(ctx context.Context, cc grpc.ClientConnInterface) *Client {
stubv1 := refv1.NewServerReflectionClient(cc)
stubv1alpha := refv1alpha.NewServerReflectionClient(cc)
return newClient(ctx, stubv1, stubv1alpha)
}
// AllowMissingFileDescriptors configures the client to allow missing files
// when building descriptors when possible. Missing files are often fatal
// errors, but with this option they can sometimes be worked around. Building
// a schema can only succeed with some files missing if the files in question
// only provide custom options and/or other unused types.
func (cr *Client) AllowMissingFileDescriptors() {
cr.allowMissing.Store(true)
}
// TODO: We should also have a NewClientV1. However that should not refer to internal
// generated code. So it will have to wait until the grpc-go team fixes this issue:
// https://github.com/grpc/grpc-go/issues/5684
// FileByFilename asks the server for a file descriptor for the proto file with
// the given name.
func (cr *Client) FileByFilename(filename string) (*desc.FileDescriptor, error) {
// hit the cache first
cr.cacheMu.RLock()
if fd, ok := cr.filesByName[filename]; ok {
cr.cacheMu.RUnlock()
return fd, nil
}
fdp, ok := cr.protosByName[filename]
cr.cacheMu.RUnlock()
// not there? see if we've downloaded the proto
if ok {
return cr.descriptorFromProto(fdp)
}
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_FileByFilename{
FileByFilename: filename,
},
}
accept := func(fd *desc.FileDescriptor) bool {
return fd.GetName() == filename
}
fd, err := cr.getAndCacheFileDescriptors(req, filename, "", accept)
if isNotFound(err) {
// file not found? see if we can look up via alternate name
if alternate, ok := internal.StdFileAliases[filename]; ok {
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_FileByFilename{
FileByFilename: alternate,
},
}
fd, err = cr.getAndCacheFileDescriptors(req, alternate, filename, accept)
if isNotFound(err) {
err = fileNotFound(filename, nil)
}
} else {
err = fileNotFound(filename, nil)
}
} else if e, ok := err.(*elementNotFoundError); ok {
err = fileNotFound(filename, e)
}
return fd, err
}
// FileContainingSymbol asks the server for a file descriptor for the proto file
// that declares the given fully-qualified symbol.
func (cr *Client) FileContainingSymbol(symbol string) (*desc.FileDescriptor, error) {
// hit the cache first
cr.cacheMu.RLock()
fd, ok := cr.filesBySymbol[symbol]
cr.cacheMu.RUnlock()
if ok {
return fd, nil
}
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_FileContainingSymbol{
FileContainingSymbol: symbol,
},
}
accept := func(fd *desc.FileDescriptor) bool {
return fd.FindSymbol(symbol) != nil
}
fd, err := cr.getAndCacheFileDescriptors(req, "", "", accept)
if isNotFound(err) {
err = symbolNotFound(symbol, symbolTypeUnknown, nil)
} else if e, ok := err.(*elementNotFoundError); ok {
err = symbolNotFound(symbol, symbolTypeUnknown, e)
}
return fd, err
}
// FileContainingExtension asks the server for a file descriptor for the proto
// file that declares an extension with the given number for the given
// fully-qualified message name.
func (cr *Client) FileContainingExtension(extendedMessageName string, extensionNumber int32) (*desc.FileDescriptor, error) {
// hit the cache first
cr.cacheMu.RLock()
fd, ok := cr.filesByExtension[extDesc{extendedMessageName, extensionNumber}]
cr.cacheMu.RUnlock()
if ok {
return fd, nil
}
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_FileContainingExtension{
FileContainingExtension: &refv1alpha.ExtensionRequest{
ContainingType: extendedMessageName,
ExtensionNumber: extensionNumber,
},
},
}
accept := func(fd *desc.FileDescriptor) bool {
return fd.FindExtension(extendedMessageName, extensionNumber) != nil
}
fd, err := cr.getAndCacheFileDescriptors(req, "", "", accept)
if isNotFound(err) {
err = extensionNotFound(extendedMessageName, extensionNumber, nil)
} else if e, ok := err.(*elementNotFoundError); ok {
err = extensionNotFound(extendedMessageName, extensionNumber, e)
}
return fd, err
}
func (cr *Client) getAndCacheFileDescriptors(req *refv1alpha.ServerReflectionRequest, expectedName, alias string, accept func(*desc.FileDescriptor) bool) (*desc.FileDescriptor, error) {
resp, err := cr.send(req)
if err != nil {
return nil, err
}
fdResp := resp.GetFileDescriptorResponse()
if fdResp == nil {
return nil, &ProtocolError{reflect.TypeOf(fdResp).Elem()}
}
// Response can contain the result file descriptor, but also its transitive
// deps. Furthermore, protocol states that subsequent requests do not need
// to send transitive deps that have been sent in prior responses. So we
// need to cache all file descriptors and then return the first one (which
// should be the answer). If we're looking for a file by name, we can be
// smarter and make sure to grab one by name instead of just grabbing the
// first one.
var fds []*descriptorpb.FileDescriptorProto
for _, fdBytes := range fdResp.FileDescriptorProto {
fd := &descriptorpb.FileDescriptorProto{}
if err = proto.Unmarshal(fdBytes, fd); err != nil {
return nil, err
}
if expectedName != "" && alias != "" && expectedName != alias && fd.GetName() == expectedName {
// we found a file was aliased, so we need to update the proto to reflect that
fd.Name = proto.String(alias)
}
cr.cacheMu.Lock()
// store in cache of raw descriptor protos, but don't overwrite existing protos
if existingFd, ok := cr.protosByName[fd.GetName()]; ok {
fd = existingFd
} else {
cr.protosByName[fd.GetName()] = fd
}
cr.cacheMu.Unlock()
fds = append(fds, fd)
}
// find the right result from the files returned
for _, fd := range fds {
result, err := cr.descriptorFromProto(fd)
if err != nil {
return nil, err
}
if accept(result) {
return result, nil
}
}
return nil, status.Errorf(codes.NotFound, "response does not include expected file")
}
func (cr *Client) descriptorFromProto(fd *descriptorpb.FileDescriptorProto) (*desc.FileDescriptor, error) {
allowMissing := cr.allowMissing.Load()
deps := make([]*desc.FileDescriptor, 0, len(fd.GetDependency()))
var deferredErr error
var missingDeps []int
for i, depName := range fd.GetDependency() {
if dep, err := cr.FileByFilename(depName); err != nil {
if _, ok := err.(*elementNotFoundError); !ok || !allowMissing {
return nil, err
}
// We'll ignore for now to see if the file is really necessary.
// (If it only supplies custom options, we can get by without it.)
if deferredErr == nil {
deferredErr = err
}
missingDeps = append(missingDeps, i)
} else {
deps = append(deps, dep)
}
}
if len(missingDeps) > 0 {
fd = fileWithoutDeps(fd, missingDeps)
}
d, err := desc.CreateFileDescriptor(fd, deps...)
if err != nil {
if deferredErr != nil {
// assume the issue is the missing dep
return nil, deferredErr
}
return nil, err
}
d = cr.cacheFile(d)
return d, nil
}
func (cr *Client) cacheFile(fd *desc.FileDescriptor) *desc.FileDescriptor {
cr.cacheMu.Lock()
defer cr.cacheMu.Unlock()
// cache file descriptor by name, but don't overwrite existing entry
// (existing entry could come from concurrent caller)
if existingFd, ok := cr.filesByName[fd.GetName()]; ok {
return existingFd
}
cr.filesByName[fd.GetName()] = fd
// also cache by symbols and extensions
for _, m := range fd.GetMessageTypes() {
cr.cacheMessageLocked(fd, m)
}
for _, e := range fd.GetEnumTypes() {
cr.filesBySymbol[e.GetFullyQualifiedName()] = fd
for _, v := range e.GetValues() {
cr.filesBySymbol[v.GetFullyQualifiedName()] = fd
}
}
for _, e := range fd.GetExtensions() {
cr.filesBySymbol[e.GetFullyQualifiedName()] = fd
cr.filesByExtension[extDesc{e.GetOwner().GetFullyQualifiedName(), e.GetNumber()}] = fd
}
for _, s := range fd.GetServices() {
cr.filesBySymbol[s.GetFullyQualifiedName()] = fd
for _, m := range s.GetMethods() {
cr.filesBySymbol[m.GetFullyQualifiedName()] = fd
}
}
return fd
}
func (cr *Client) cacheMessageLocked(fd *desc.FileDescriptor, md *desc.MessageDescriptor) {
cr.filesBySymbol[md.GetFullyQualifiedName()] = fd
for _, f := range md.GetFields() {
cr.filesBySymbol[f.GetFullyQualifiedName()] = fd
}
for _, o := range md.GetOneOfs() {
cr.filesBySymbol[o.GetFullyQualifiedName()] = fd
}
for _, e := range md.GetNestedEnumTypes() {
cr.filesBySymbol[e.GetFullyQualifiedName()] = fd
for _, v := range e.GetValues() {
cr.filesBySymbol[v.GetFullyQualifiedName()] = fd
}
}
for _, e := range md.GetNestedExtensions() {
cr.filesBySymbol[e.GetFullyQualifiedName()] = fd
cr.filesByExtension[extDesc{e.GetOwner().GetFullyQualifiedName(), e.GetNumber()}] = fd
}
for _, m := range md.GetNestedMessageTypes() {
cr.cacheMessageLocked(fd, m) // recurse
}
}
// AllExtensionNumbersForType asks the server for all known extension numbers
// for the given fully-qualified message name.
func (cr *Client) AllExtensionNumbersForType(extendedMessageName string) ([]int32, error) {
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_AllExtensionNumbersOfType{
AllExtensionNumbersOfType: extendedMessageName,
},
}
resp, err := cr.send(req)
if err != nil {
if isNotFound(err) {
return nil, symbolNotFound(extendedMessageName, symbolTypeMessage, nil)
}
return nil, err
}
extResp := resp.GetAllExtensionNumbersResponse()
if extResp == nil {
return nil, &ProtocolError{reflect.TypeOf(extResp).Elem()}
}
return extResp.ExtensionNumber, nil
}
// ListServices asks the server for the fully-qualified names of all exposed
// services.
func (cr *Client) ListServices() ([]string, error) {
req := &refv1alpha.ServerReflectionRequest{
MessageRequest: &refv1alpha.ServerReflectionRequest_ListServices{
// proto doesn't indicate any purpose for this value and server impl
// doesn't actually use it...
ListServices: "*",
},
}
resp, err := cr.send(req)
if err != nil {
return nil, err
}
listResp := resp.GetListServicesResponse()
if listResp == nil {
return nil, &ProtocolError{reflect.TypeOf(listResp).Elem()}
}
serviceNames := make([]string, len(listResp.Service))
for i, s := range listResp.Service {
serviceNames[i] = s.Name
}
return serviceNames, nil
}
func (cr *Client) send(req *refv1alpha.ServerReflectionRequest) (*refv1alpha.ServerReflectionResponse, error) {
// we allow one immediate retry, in case we have a stale stream
// (e.g. closed by server)
resp, err := cr.doSend(req)
if err != nil {
return nil, err
}
// convert error response messages into errors
errResp := resp.GetErrorResponse()
if errResp != nil {
return nil, status.Errorf(codes.Code(errResp.ErrorCode), "%s", errResp.ErrorMessage)
}
return resp, nil
}
func isNotFound(err error) bool {
if err == nil {
return false
}
s, ok := status.FromError(err)
return ok && s.Code() == codes.NotFound
}
func (cr *Client) doSend(req *refv1alpha.ServerReflectionRequest) (*refv1alpha.ServerReflectionResponse, error) {
// TODO: Streams are thread-safe, so we shouldn't need to lock. But without locking, we'll need more machinery
// (goroutines and channels) to ensure that responses are correctly correlated with their requests and thus
// delivered in correct oder.
cr.connMu.Lock()
defer cr.connMu.Unlock()
return cr.doSendLocked(0, nil, req)
}
func (cr *Client) doSendLocked(attemptCount int, prevErr error, req *refv1alpha.ServerReflectionRequest) (*refv1alpha.ServerReflectionResponse, error) {
if attemptCount >= 3 && prevErr != nil {
return nil, prevErr
}
if (status.Code(prevErr) == codes.Unimplemented ||
status.Code(prevErr) == codes.Unavailable) &&
cr.useV1() {
// If v1 is unimplemented, fallback to v1alpha.
// We also fallback on unavailable because some servers have been
// observed to close the connection/cancel the stream, w/out sending
// back status or headers, when the service name is not known. When
// this happens, the RPC status code is unavailable.
// See https://github.com/fullstorydev/grpcurl/issues/434
cr.useV1Alpha = true
cr.lastTriedV1 = cr.now()
}
attemptCount++
if err := cr.initStreamLocked(); err != nil {
return nil, err
}
if err := cr.stream.Send(req); err != nil {
if err == io.EOF {
// if send returns EOF, must call Recv to get real underlying error
_, err = cr.stream.Recv()
}
cr.resetLocked()
return cr.doSendLocked(attemptCount, err, req)
}
resp, err := cr.stream.Recv()
if err != nil {
cr.resetLocked()
return cr.doSendLocked(attemptCount, err, req)
}
return resp, nil
}
func (cr *Client) initStreamLocked() error {
if cr.stream != nil {
return nil
}
var newCtx context.Context
newCtx, cr.cancel = context.WithCancel(cr.ctx)
if cr.useV1Alpha == true && cr.now().Sub(cr.lastTriedV1) > durationBetweenV1Attempts {
// we're due for periodic retry of v1
cr.useV1Alpha = false
}
if cr.useV1() {
// try the v1 API
streamv1, err := cr.stubV1.ServerReflectionInfo(newCtx)
if err == nil {
cr.stream = adaptStreamFromV1{streamv1}
return nil
}
if status.Code(err) != codes.Unimplemented {
return err
}
// oh well, fall through below to try v1alpha and update state
// so we skip straight to v1alpha next time
cr.useV1Alpha = true
cr.lastTriedV1 = cr.now()
}
var err error
cr.stream, err = cr.stubV1Alpha.ServerReflectionInfo(newCtx)
return err
}
func (cr *Client) useV1() bool {
return !cr.useV1Alpha && cr.stubV1 != nil
}
// Reset ensures that any active stream with the server is closed, releasing any
// resources.
func (cr *Client) Reset() {
cr.connMu.Lock()
defer cr.connMu.Unlock()
cr.resetLocked()
}
func (cr *Client) resetLocked() {
if cr.stream != nil {
cr.stream.CloseSend()
for {
// drain the stream, this covers io.EOF too
if _, err := cr.stream.Recv(); err != nil {
break
}
}
cr.stream = nil
}
if cr.cancel != nil {
cr.cancel()
cr.cancel = nil
}
}
// ResolveService asks the server to resolve the given fully-qualified service
// name into a service descriptor.
func (cr *Client) ResolveService(serviceName string) (*desc.ServiceDescriptor, error) {
file, err := cr.FileContainingSymbol(serviceName)
if err != nil {
return nil, setSymbolType(err, serviceName, symbolTypeService)
}
d := file.FindSymbol(serviceName)
if d == nil {
return nil, symbolNotFound(serviceName, symbolTypeService, nil)
}
if s, ok := d.(*desc.ServiceDescriptor); ok {
return s, nil
} else {
return nil, symbolNotFound(serviceName, symbolTypeService, nil)
}
}
// ResolveMessage asks the server to resolve the given fully-qualified message
// name into a message descriptor.
func (cr *Client) ResolveMessage(messageName string) (*desc.MessageDescriptor, error) {
file, err := cr.FileContainingSymbol(messageName)
if err != nil {
return nil, setSymbolType(err, messageName, symbolTypeMessage)
}
d := file.FindSymbol(messageName)
if d == nil {
return nil, symbolNotFound(messageName, symbolTypeMessage, nil)
}
if s, ok := d.(*desc.MessageDescriptor); ok {
return s, nil
} else {
return nil, symbolNotFound(messageName, symbolTypeMessage, nil)
}
}
// ResolveEnum asks the server to resolve the given fully-qualified enum name
// into an enum descriptor.
func (cr *Client) ResolveEnum(enumName string) (*desc.EnumDescriptor, error) {
file, err := cr.FileContainingSymbol(enumName)
if err != nil {
return nil, setSymbolType(err, enumName, symbolTypeEnum)
}
d := file.FindSymbol(enumName)
if d == nil {
return nil, symbolNotFound(enumName, symbolTypeEnum, nil)
}
if s, ok := d.(*desc.EnumDescriptor); ok {
return s, nil
} else {
return nil, symbolNotFound(enumName, symbolTypeEnum, nil)
}
}
func setSymbolType(err error, name string, symType symbolType) error {
if e, ok := err.(*elementNotFoundError); ok {
if e.kind == elementKindSymbol && e.name == name && e.symType == symbolTypeUnknown {
e.symType = symType
}
}
return err
}
// ResolveEnumValues asks the server to resolve the given fully-qualified enum
// name into a map of names to numbers that represents the enum's values.
func (cr *Client) ResolveEnumValues(enumName string) (map[string]int32, error) {
enumDesc, err := cr.ResolveEnum(enumName)
if err != nil {
return nil, err
}
vals := map[string]int32{}
for _, valDesc := range enumDesc.GetValues() {
vals[valDesc.GetName()] = valDesc.GetNumber()
}
return vals, nil
}
// ResolveExtension asks the server to resolve the given extension number and
// fully-qualified message name into a field descriptor.
func (cr *Client) ResolveExtension(extendedType string, extensionNumber int32) (*desc.FieldDescriptor, error) {
file, err := cr.FileContainingExtension(extendedType, extensionNumber)
if err != nil {
return nil, err
}
d := findExtension(extendedType, extensionNumber, fileDescriptorExtensions{file})
if d == nil {
return nil, extensionNotFound(extendedType, extensionNumber, nil)
} else {
return d, nil
}
}
func fileWithoutDeps(fd *descriptorpb.FileDescriptorProto, missingDeps []int) *descriptorpb.FileDescriptorProto {
// We need to rebuild the file without the missing deps.
fd = proto.Clone(fd).(*descriptorpb.FileDescriptorProto)
newNumDeps := len(fd.GetDependency()) - len(missingDeps)
newDeps := make([]string, 0, newNumDeps)
remapped := make(map[int]int, newNumDeps)
missingIdx := 0
for i, dep := range fd.GetDependency() {
if missingIdx < len(missingDeps) {
if i == missingDeps[missingIdx] {
// This dep was missing. Skip it.
missingIdx++
continue
}
}
remapped[i] = len(newDeps)
newDeps = append(newDeps, dep)
}
// Also rebuild public and weak import slices.
newPublic := make([]int32, 0, len(fd.GetPublicDependency()))
for _, idx := range fd.GetPublicDependency() {
newIdx, ok := remapped[int(idx)]
if ok {
newPublic = append(newPublic, int32(newIdx))
}
}
newWeak := make([]int32, 0, len(fd.GetWeakDependency()))
for _, idx := range fd.GetWeakDependency() {
newIdx, ok := remapped[int(idx)]
if ok {
newWeak = append(newWeak, int32(newIdx))
}
}
fd.Dependency = newDeps
fd.PublicDependency = newPublic
fd.WeakDependency = newWeak
return fd
}
func findExtension(extendedType string, extensionNumber int32, scope extensionScope) *desc.FieldDescriptor {
// search extensions in this scope
for _, ext := range scope.extensions() {
if ext.GetNumber() == extensionNumber && ext.GetOwner().GetFullyQualifiedName() == extendedType {
return ext
}
}
// if not found, search nested scopes
for _, nested := range scope.nestedScopes() {
ext := findExtension(extendedType, extensionNumber, nested)
if ext != nil {
return ext
}
}
return nil
}
type extensionScope interface {
extensions() []*desc.FieldDescriptor
nestedScopes() []extensionScope
}
// fileDescriptorExtensions implements extensionHolder interface on top of
// FileDescriptorProto
type fileDescriptorExtensions struct {
proto *desc.FileDescriptor
}
func (fde fileDescriptorExtensions) extensions() []*desc.FieldDescriptor {
return fde.proto.GetExtensions()
}
func (fde fileDescriptorExtensions) nestedScopes() []extensionScope {
scopes := make([]extensionScope, len(fde.proto.GetMessageTypes()))
for i, m := range fde.proto.GetMessageTypes() {
scopes[i] = msgDescriptorExtensions{m}
}
return scopes
}
// msgDescriptorExtensions implements extensionHolder interface on top of
// DescriptorProto
type msgDescriptorExtensions struct {
proto *desc.MessageDescriptor
}
func (mde msgDescriptorExtensions) extensions() []*desc.FieldDescriptor {
return mde.proto.GetNestedExtensions()
}
func (mde msgDescriptorExtensions) nestedScopes() []extensionScope {
scopes := make([]extensionScope, len(mde.proto.GetNestedMessageTypes()))
for i, m := range mde.proto.GetNestedMessageTypes() {
scopes[i] = msgDescriptorExtensions{m}
}
return scopes
}
type adaptStreamFromV1 struct {
refv1.ServerReflection_ServerReflectionInfoClient
}
func (a adaptStreamFromV1) Send(request *refv1alpha.ServerReflectionRequest) error {
v1req := toV1Request(request)
return a.ServerReflection_ServerReflectionInfoClient.Send(v1req)
}
func (a adaptStreamFromV1) Recv() (*refv1alpha.ServerReflectionResponse, error) {
v1resp, err := a.ServerReflection_ServerReflectionInfoClient.Recv()
if err != nil {
return nil, err
}
return toV1AlphaResponse(v1resp), nil
}