forked from bufbuild/buf
/
java_package.go
153 lines (142 loc) · 5.22 KB
/
java_package.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
// Copyright 2020-2024 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 bufimagemodify
import (
"context"
"fmt"
"github.com/alis-exchange/buf/private/bufpkg/bufimage"
"github.com/alis-exchange/buf/private/bufpkg/bufmodule/bufmoduleref"
"go.uber.org/zap"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/descriptorpb"
)
const (
// DefaultJavaPackagePrefix is the default java_package prefix used in the java_package modifier.
DefaultJavaPackagePrefix = "com"
// JavaPackageID is the ID of the java_package modifier.
JavaPackageID = "JAVA_PACKAGE"
)
// javaPackagePath is the SourceCodeInfo path for the java_package option.
// https://github.com/protocolbuffers/protobuf/blob/61689226c0e3ec88287eaed66164614d9c4f2bf7/src/google/protobuf/descriptor.proto#L348
var javaPackagePath = []int32{8, 1}
func javaPackage(
logger *zap.Logger,
sweeper Sweeper,
defaultPackagePrefix string,
except []bufmoduleref.ModuleIdentity,
moduleOverrides map[bufmoduleref.ModuleIdentity]string,
overrides map[string]string,
) (Modifier, error) {
if defaultPackagePrefix == "" {
return nil, fmt.Errorf("a non-empty package prefix is required")
}
// 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, javaPackagePrefix := range moduleOverrides {
overrideModuleIdentityStrings[moduleIdentity.IdentityString()] = javaPackagePrefix
}
seenModuleIdentityStrings := make(map[string]struct{}, len(overrideModuleIdentityStrings))
seenOverrideFiles := make(map[string]struct{}, len(overrides))
return ModifierFunc(
func(ctx context.Context, image bufimage.Image) error {
for _, imageFile := range image.Files() {
packagePrefix := defaultPackagePrefix
if moduleIdentity := imageFile.ModuleIdentity(); moduleIdentity != nil {
moduleIdentityString := moduleIdentity.IdentityString()
if modulePrefixOverride, ok := overrideModuleIdentityStrings[moduleIdentityString]; ok {
packagePrefix = modulePrefixOverride
seenModuleIdentityStrings[moduleIdentityString] = struct{}{}
}
}
javaPackageValue := javaPackageValue(imageFile, packagePrefix)
if overridePackagePrefix, ok := overrides[imageFile.Path()]; ok {
javaPackageValue = overridePackagePrefix
seenOverrideFiles[imageFile.Path()] = struct{}{}
}
if err := javaPackageForFile(
ctx,
sweeper,
imageFile,
javaPackageValue,
exceptModuleIdentityStrings,
); err != nil {
return err
}
}
for moduleIdentityString := range overrideModuleIdentityStrings {
if _, ok := seenModuleIdentityStrings[moduleIdentityString]; !ok {
logger.Sugar().Warnf("java_package_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", JavaPackageID, overrideFile)
}
}
return nil
},
), nil
}
func javaPackageForFile(
ctx context.Context,
sweeper Sweeper,
imageFile bufimage.ImageFile,
javaPackageValue string,
exceptModuleIdentityStrings map[string]struct{},
) error {
if shouldSkipJavaPackageForFile(ctx, imageFile, javaPackageValue, exceptModuleIdentityStrings) {
return nil
}
descriptor := imageFile.FileDescriptorProto()
if descriptor.Options == nil {
descriptor.Options = &descriptorpb.FileOptions{}
}
descriptor.Options.JavaPackage = proto.String(javaPackageValue)
if sweeper != nil {
sweeper.mark(imageFile.Path(), javaPackagePath)
}
return nil
}
func shouldSkipJavaPackageForFile(
ctx context.Context,
imageFile bufimage.ImageFile,
javaPackageValue string,
exceptModuleIdentityStrings map[string]struct{},
) bool {
if isWellKnownType(ctx, imageFile) || javaPackageValue == "" {
// This is a well-known type or we could not resolve a non-empty java_package
// 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
}
// javaPackageValue returns the java_package 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 javaPackageValue(imageFile bufimage.ImageFile, packagePrefix string) string {
if pkg := imageFile.FileDescriptorProto().GetPackage(); pkg != "" {
return packagePrefix + "." + pkg
}
return ""
}