-
Notifications
You must be signed in to change notification settings - Fork 75
/
csharp_namespace.go
159 lines (146 loc) · 5.49 KB
/
csharp_namespace.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
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You 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 bufimagemodify
import (
"context"
"strings"
)
import (
"go.uber.org/zap"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/descriptorpb"
)
import (
"github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufimage"
"github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule/bufmoduleref"
"github.com/apache/dubbo-kubernetes/pkg/bufman/pkg/stringutil"
)
// CsharpNamespaceID is the ID of the csharp_namespace modifier.
const CsharpNamespaceID = "CSHARP_NAMESPACE"
// csharpNamespacePath is the SourceCodeInfo path for the csharp_namespace option.
// https://github.com/protocolbuffers/protobuf/blob/61689226c0e3ec88287eaed66164614d9c4f2bf7/src/google/protobuf/descriptor.proto#L428
var csharpNamespacePath = []int32{8, 37}
func csharpNamespace(
logger *zap.Logger,
sweeper Sweeper,
except []bufmoduleref.ModuleIdentity,
moduleOverrides map[bufmoduleref.ModuleIdentity]string,
overrides map[string]string,
) Modifier {
// Convert the bufmoduleref.ModuleIdentity types into
// strings so that they're comparable.
exceptModuleIdentityStrings := make(map[string]struct{}, len(except))
for _, moduleIdentity := range except {
exceptModuleIdentityStrings[moduleIdentity.IdentityString()] = struct{}{}
}
overrideModuleIdentityStrings := make(map[string]string, len(moduleOverrides))
for moduleIdentity, csharpNamespace := range moduleOverrides {
overrideModuleIdentityStrings[moduleIdentity.IdentityString()] = csharpNamespace
}
return ModifierFunc(
func(ctx context.Context, image bufimage.Image) error {
seenModuleIdentityStrings := make(map[string]struct{}, len(overrideModuleIdentityStrings))
seenOverrideFiles := make(map[string]struct{}, len(overrides))
for _, imageFile := range image.Files() {
csharpNamespaceValue := csharpNamespaceValue(imageFile)
if moduleIdentity := imageFile.ModuleIdentity(); moduleIdentity != nil {
moduleIdentityString := moduleIdentity.IdentityString()
if moduleNamespaceOverride, ok := overrideModuleIdentityStrings[moduleIdentityString]; ok {
seenModuleIdentityStrings[moduleIdentityString] = struct{}{}
csharpNamespaceValue = moduleNamespaceOverride
}
}
if overrideValue, ok := overrides[imageFile.Path()]; ok {
csharpNamespaceValue = overrideValue
seenOverrideFiles[imageFile.Path()] = struct{}{}
}
if err := csharpNamespaceForFile(
ctx,
sweeper,
imageFile,
csharpNamespaceValue,
exceptModuleIdentityStrings,
); err != nil {
return err
}
}
for moduleIdentityString := range overrideModuleIdentityStrings {
if _, ok := seenModuleIdentityStrings[moduleIdentityString]; !ok {
logger.Sugar().Warnf("csharp_namespace_prefix override for %q was unused", moduleIdentityString)
}
}
for overrideFile := range overrides {
if _, ok := seenOverrideFiles[overrideFile]; !ok {
logger.Sugar().Warnf("%s override for %q was unused", CsharpNamespaceID, overrideFile)
}
}
return nil
},
)
}
func csharpNamespaceForFile(
ctx context.Context,
sweeper Sweeper,
imageFile bufimage.ImageFile,
csharpNamespaceValue string,
exceptModuleIdentityStrings map[string]struct{},
) error {
if shouldSkipCsharpNamespaceForFile(ctx, imageFile, csharpNamespaceValue, exceptModuleIdentityStrings) {
// This is a well-known type or we could not resolve a non-empty csharp_namespace
// value, so this is a no-op.
return nil
}
descriptor := imageFile.Proto()
if descriptor.Options == nil {
descriptor.Options = &descriptorpb.FileOptions{}
}
descriptor.Options.CsharpNamespace = proto.String(csharpNamespaceValue)
if sweeper != nil {
sweeper.mark(imageFile.Path(), csharpNamespacePath)
}
return nil
}
func shouldSkipCsharpNamespaceForFile(
ctx context.Context,
imageFile bufimage.ImageFile,
csharpNamespaceValue string,
exceptModuleIdentityStrings map[string]struct{},
) bool {
if isWellKnownType(ctx, imageFile) || csharpNamespaceValue == "" {
// This is a well-known type or we could not resolve a non-empty csharp_namespace
// value, so this is a no-op.
return true
}
if moduleIdentity := imageFile.ModuleIdentity(); moduleIdentity != nil {
if _, ok := exceptModuleIdentityStrings[moduleIdentity.IdentityString()]; ok {
return true
}
}
return false
}
// csharpNamespaceValue returns the csharp_namespace for the given ImageFile based on its
// package declaration. If the image file doesn't have a package declaration, an
// empty string is returned.
func csharpNamespaceValue(imageFile bufimage.ImageFile) string {
pkg := imageFile.Proto().GetPackage()
if pkg == "" {
return ""
}
packageParts := strings.Split(pkg, ".")
for i, part := range packageParts {
packageParts[i] = stringutil.ToPascalCase(part)
}
return strings.Join(packageParts, ".")
}