forked from uber/prototool
-
Notifications
You must be signed in to change notification settings - Fork 0
/
check_request_response_types_unique.go
64 lines (56 loc) · 2.37 KB
/
check_request_response_types_unique.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
// Copyright (c) 2018 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 lint
import (
"github.com/emicklei/proto"
"github.com/uber/prototool/internal/text"
)
var requestResponseTypesUniqueLinter = NewLinter(
"REQUEST_RESPONSE_TYPES_UNIQUE",
"Verifies that all request and response types are unique to each RPC.",
checkRequestResponseTypesUnique,
)
func checkRequestResponseTypesUnique(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
return runVisitor(&requestResponseTypesUniqueVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
}
type requestResponseTypesUniqueVisitor struct {
baseAddVisitor
seenTypes map[string]struct{}
}
func (v *requestResponseTypesUniqueVisitor) OnStart(*proto.Proto) error {
v.seenTypes = nil
return nil
}
func (v *requestResponseTypesUniqueVisitor) VisitService(service *proto.Service) {
for _, child := range service.Elements {
child.Accept(v)
}
}
func (v *requestResponseTypesUniqueVisitor) VisitRPC(rpc *proto.RPC) {
if v.seenTypes == nil {
v.seenTypes = make(map[string]struct{})
}
for _, s := range []string{rpc.RequestType, rpc.ReturnsType} {
if _, ok := v.seenTypes[s]; ok {
v.AddFailuref(rpc.Position, "Message %q is already used as a request or response type in an RPC and all request and response types must be unique.", s)
}
v.seenTypes[s] = struct{}{}
}
}