Skip to content

Commit dc7eb83

Browse files
zhumin8zhumin8
authored
refactor(internal/librarian/java): renames to standardize gRPC-related identifiers (#5180)
Renames variables, functions, and struct fields to follow Go style, "gRPC" for unexported and "GRPC" for exported. Ref https://google.github.io/styleguide/go/decisions.html#initialisms.
1 parent ecf64db commit dc7eb83

9 files changed

Lines changed: 54 additions & 54 deletions

File tree

‎internal/librarian/java/generate.go‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ func generateAPI(ctx context.Context, cfg *config.Config, api *config.API, libra
110110
includeSamples: !javaAPI.NoSamples,
111111
}
112112
gapicDir := p.gapicDir()
113-
grpcDir := p.grpcDir()
113+
gRPCDir := p.gRPCDir()
114114
protoDir := p.protoDir()
115-
for _, dir := range []string{gapicDir, grpcDir, protoDir} {
115+
for _, dir := range []string{gapicDir, gRPCDir, protoDir} {
116116
if err := os.MkdirAll(dir, 0755); err != nil {
117117
return fmt.Errorf("failed to create directory %q: %w", dir, err)
118118
}
@@ -139,8 +139,8 @@ func generateAPI(ctx context.Context, cfg *config.Config, api *config.API, libra
139139
// 2. Generate gRPC service stubs (skipped if transport is rest).
140140
transport := apiCfg.Transport(config.LanguageJava)
141141
if transport != "rest" {
142-
if err := runProtoc(ctx, grpcProtocArgs(apiProtos, googleapisDir, grpcDir)); err != nil {
143-
return fmt.Errorf("failed to generate grpc: %w", err)
142+
if err := runProtoc(ctx, gRPCProtocArgs(apiProtos, googleapisDir, gRPCDir)); err != nil {
143+
return fmt.Errorf("failed to generate gRPC module: %w", err)
144144
}
145145
}
146146
// 3. Generate GAPIC library.
@@ -180,9 +180,9 @@ func protoProtocArgs(apiProtos []string, googleapisDir, protoDir string) []strin
180180
return args
181181
}
182182

183-
func grpcProtocArgs(apiProtos []string, googleapisDir, grpcDir string) []string {
183+
func gRPCProtocArgs(apiProtos []string, googleapisDir, gRPCDir string) []string {
184184
args := baseProtocArgs(googleapisDir)
185-
args = append(args, fmt.Sprintf("--java_grpc_out=%s", grpcDir))
185+
args = append(args, fmt.Sprintf("--java_grpc_out=%s", gRPCDir))
186186
args = append(args, apiProtos...)
187187
return args
188188
}
@@ -220,13 +220,13 @@ func resolveGAPICOptions(cfg *config.Config, library *config.Library, api *confi
220220
gapicOpts = append(gapicOpts, gapicOpt("gapic-config", filepath.Join(googleapisDir, gapicConfig)))
221221
}
222222

223-
grpcServiceConfig, err := serviceconfig.FindGRPCServiceConfig(googleapisDir, api.Path)
223+
gRPCServiceConfig, err := serviceconfig.FindGRPCServiceConfig(googleapisDir, api.Path)
224224
if err != nil {
225-
return nil, fmt.Errorf("failed to find grpc service config: %w", err)
225+
return nil, fmt.Errorf("failed to find gRPC service config: %w", err)
226226
}
227-
if grpcServiceConfig != "" {
227+
if gRPCServiceConfig != "" {
228228
// grpc-service-config specifies the retry and timeout settings for the gRPC client.
229-
gapicOpts = append(gapicOpts, gapicOpt("grpc-service-config", filepath.Join(googleapisDir, grpcServiceConfig)))
229+
gapicOpts = append(gapicOpts, gapicOpt("grpc-service-config", filepath.Join(googleapisDir, gRPCServiceConfig)))
230230
}
231231

232232
// transport specifies whether to generate gRPC, REST, or both types of clients.

‎internal/librarian/java/generate_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,12 +192,12 @@ func TestProtoProtocArgs(t *testing.T) {
192192
}
193193
}
194194

195-
func TestGrpcProtocArgs(t *testing.T) {
195+
func TestGRPCProtocArgs(t *testing.T) {
196196
apiProtos := []string{
197197
filepath.Join(googleapisDir, "google/cloud/secretmanager/v1/resources.proto"),
198198
filepath.Join(googleapisDir, "google/cloud/secretmanager/v1/service.proto"),
199199
}
200-
got := grpcProtocArgs(apiProtos, googleapisDir, "grpc-out")
200+
got := gRPCProtocArgs(apiProtos, googleapisDir, "grpc-out")
201201
want := []string{
202202
"--experimental_allow_proto3_optional",
203203
"-I=" + googleapisDir,

‎internal/librarian/java/maven_coordinate_test.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ func TestDeriveAPICoords(t *testing.T) {
172172
lc libCoord
173173
version string
174174
wantProto coordinate
175-
wantGrpc coordinate
175+
wantGRPC coordinate
176176
}{
177177
{
178178
name: "standard cloud mapping",
@@ -189,7 +189,7 @@ func TestDeriveAPICoords(t *testing.T) {
189189
ArtifactID: "proto-google-cloud-secretmanager-v1",
190190
Version: "1.2.3",
191191
},
192-
wantGrpc: coordinate{
192+
wantGRPC: coordinate{
193193
GroupID: "com.google.api.grpc",
194194
ArtifactID: "grpc-google-cloud-secretmanager-v1",
195195
Version: "1.2.3",
@@ -210,7 +210,7 @@ func TestDeriveAPICoords(t *testing.T) {
210210
ArtifactID: "proto-google-maps-places-v1",
211211
Version: "1.2.3",
212212
},
213-
wantGrpc: coordinate{
213+
wantGRPC: coordinate{
214214
GroupID: "com.google.maps.api.grpc",
215215
ArtifactID: "grpc-google-maps-places-v1",
216216
Version: "1.2.3",
@@ -222,8 +222,8 @@ func TestDeriveAPICoords(t *testing.T) {
222222
if diff := cmp.Diff(test.wantProto, got.proto, cmp.AllowUnexported(coordinate{})); diff != "" {
223223
t.Errorf("proto mismatch (-want +got):\n%s", diff)
224224
}
225-
if diff := cmp.Diff(test.wantGrpc, got.grpc, cmp.AllowUnexported(coordinate{})); diff != "" {
226-
t.Errorf("grpc mismatch (-want +got):\n%s", diff)
225+
if diff := cmp.Diff(test.wantGRPC, got.grpc, cmp.AllowUnexported(coordinate{})); diff != "" {
226+
t.Errorf("gRPC mismatch (-want +got):\n%s", diff)
227227
}
228228
})
229229
}

‎internal/librarian/java/pom.go‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -27,26 +27,26 @@ import (
2727

2828
const (
2929
protoPomTemplateName = "module_proto_pom.xml.tmpl"
30-
grpcPomTemplateName = "module_grpc_pom.xml.tmpl"
30+
gRPCPomTemplateName = "module_grpc_pom.xml.tmpl"
3131
clientPomTemplateName = "module_client_pom.xml.tmpl"
3232
parentPomTemplateName = "module_parent_pom.xml.tmpl"
3333
bomPomTemplateName = "module_bom_pom.xml.tmpl"
3434
// Template markers for client pom.xml.
3535
managedProtoStartMarker = "<!-- {x-generated-proto-dependencies-start} -->"
3636
managedProtoEndMarker = "<!-- {x-generated-proto-dependencies-end} -->"
37-
managedGrpcStartMarker = "<!-- {x-generated-grpc-dependencies-start} -->"
38-
managedGrpcEndMarker = "<!-- {x-generated-grpc-dependencies-end} -->"
37+
managedGRPCStartMarker = "<!-- {x-generated-grpc-dependencies-start} -->"
38+
managedGRPCEndMarker = "<!-- {x-generated-grpc-dependencies-end} -->"
3939
// Template markers for BOM and parent pom.xml.
4040
managedDependenciesStartMarker = "<!-- {x-generated-dependencies-start} -->"
4141
managedDependenciesEndMarker = "<!-- {x-generated-dependencies-end} -->"
4242
managedModulesStartMarker = "<!-- {x-generated-modules-start} -->"
4343
managedModulesEndMarker = "<!-- {x-generated-modules-end} -->"
4444
)
4545

46-
// grpcProtoPomData holds the data for rendering POM templates.
47-
type grpcProtoPomData struct {
46+
// gRPCProtoPomData holds the data for rendering POM templates.
47+
type gRPCProtoPomData struct {
4848
Proto coordinate
49-
Grpc coordinate
49+
GRPC coordinate
5050
Parent coordinate
5151
Version string
5252
MainArtifactID string
@@ -60,7 +60,7 @@ type clientPomData struct {
6060
Description string
6161
Parent coordinate
6262
ProtoModules []coordinate
63-
GrpcModules []coordinate
63+
GRPCModules []coordinate
6464
}
6565

6666
// bomParentPomData holds the data for rendering the BOM and Parent library POM template.
@@ -125,7 +125,7 @@ func updateClientPom(pomPath string, data clientPomData) error {
125125
if updated, err = updateManagedBlock(updated, "managed_proto_dependencies", managedProtoStartMarker, managedProtoEndMarker, data); err != nil {
126126
return err
127127
}
128-
if updated, err = updateManagedBlock(updated, "managed_grpc_dependencies", managedGrpcStartMarker, managedGrpcEndMarker, data); err != nil {
128+
if updated, err = updateManagedBlock(updated, "managed_grpc_dependencies", managedGRPCStartMarker, managedGRPCEndMarker, data); err != nil {
129129
return err
130130
}
131131
// compare to avoid unnecessary I/O
@@ -231,7 +231,7 @@ func collectModules(library *config.Library, libraryDir, monorepoVersion string,
231231
libCoord := deriveLibCoord(library)
232232

233233
protoModules := make([]coordinate, 0, len(library.APIs))
234-
grpcModules := make([]coordinate, 0, len(library.APIs))
234+
gRPCModules := make([]coordinate, 0, len(library.APIs))
235235
for _, api := range library.APIs {
236236
version := serviceconfig.ExtractVersion(api.Path)
237237
if version == "" {
@@ -241,9 +241,9 @@ func collectModules(library *config.Library, libraryDir, monorepoVersion string,
241241
apiCoord := deriveAPICoord(libCoord, version)
242242

243243
transport := transports[api.Path]
244-
data := grpcProtoPomData{
244+
data := gRPCProtoPomData{
245245
Proto: apiCoord.proto,
246-
Grpc: apiCoord.grpc,
246+
GRPC: apiCoord.grpc,
247247
Parent: libCoord.parent,
248248
MainArtifactID: libCoord.gapic.ArtifactID,
249249
Version: library.Version,
@@ -266,19 +266,19 @@ func collectModules(library *config.Library, libraryDir, monorepoVersion string,
266266

267267
// gRPC module
268268
if transport == serviceconfig.GRPC || transport == serviceconfig.GRPCRest {
269-
grpcDir := filepath.Join(libraryDir, apiCoord.grpc.ArtifactID)
270-
isGrpcMissing, err := isPomMissing(grpcDir)
269+
gRPCDir := filepath.Join(libraryDir, apiCoord.grpc.ArtifactID)
270+
isGRPCMissing, err := isPomMissing(gRPCDir)
271271
if err != nil {
272272
return nil, err
273273
}
274274
modules = append(modules, javaModule{
275275
artifactID: apiCoord.grpc.ArtifactID,
276-
dir: grpcDir,
277-
isMissing: isGrpcMissing,
276+
dir: gRPCDir,
277+
isMissing: isGRPCMissing,
278278
templateData: data,
279-
template: grpcPomTemplateName,
279+
template: gRPCPomTemplateName,
280280
})
281-
grpcModules = append(grpcModules, data.Grpc)
281+
gRPCModules = append(gRPCModules, data.GRPC)
282282
}
283283
}
284284

@@ -299,13 +299,13 @@ func collectModules(library *config.Library, libraryDir, monorepoVersion string,
299299
Description: metadata.APIDescription,
300300
Parent: libCoord.parent,
301301
ProtoModules: protoModules,
302-
GrpcModules: grpcModules,
302+
GRPCModules: gRPCModules,
303303
},
304304
template: clientPomTemplateName,
305305
})
306306

307307
allModules := []coordinate{libCoord.gapic}
308-
allModules = append(allModules, grpcModules...)
308+
allModules = append(allModules, gRPCModules...)
309309
allModules = append(allModules, protoModules...)
310310

311311
// BOM module

‎internal/librarian/java/pom_test.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,10 @@ func TestSyncPoms_Golden(t *testing.T) {
4747
tmpDir := t.TempDir()
4848
// Pre-create the directories that generatePomsIfMissing expects to exist.
4949
protoArtifactID := "proto-google-cloud-secretmanager-v1"
50-
grpcArtifactID := "grpc-google-cloud-secretmanager-v1"
50+
gRPCArtifactID := "grpc-google-cloud-secretmanager-v1"
5151
gapicArtifactID := "google-cloud-secretmanager"
5252
bomArtifactID := "google-cloud-secretmanager-bom"
53-
for _, artifact := range []string{protoArtifactID, grpcArtifactID, gapicArtifactID, bomArtifactID} {
53+
for _, artifact := range []string{protoArtifactID, gRPCArtifactID, gapicArtifactID, bomArtifactID} {
5454
if err := os.MkdirAll(filepath.Join(tmpDir, artifact), 0755); err != nil {
5555
t.Fatal(err)
5656
}
@@ -62,7 +62,7 @@ func TestSyncPoms_Golden(t *testing.T) {
6262
if err := syncPoms(library, tmpDir, "1.2.3", metadata, transports); err != nil {
6363
t.Fatal(err)
6464
}
65-
artifacts := []string{protoArtifactID, grpcArtifactID, gapicArtifactID, "google-cloud-secretmanager-bom", "google-cloud-secretmanager-parent"}
65+
artifacts := []string{protoArtifactID, gRPCArtifactID, gapicArtifactID, "google-cloud-secretmanager-bom", "google-cloud-secretmanager-parent"}
6666
for _, artifact := range artifacts {
6767
dir := artifact
6868
if artifact == "google-cloud-secretmanager-parent" {
@@ -98,10 +98,10 @@ func TestSyncPoms_Update(t *testing.T) {
9898

9999
// Setup directory structure for all modules.
100100
protoArtifactID := "proto-google-cloud-secretmanager-v1"
101-
grpcArtifactID := "grpc-google-cloud-secretmanager-v1"
101+
gRPCArtifactID := "grpc-google-cloud-secretmanager-v1"
102102
gapicArtifactID := "google-cloud-secretmanager"
103103
bomArtifactID := "google-cloud-secretmanager-bom"
104-
for _, artifact := range []string{protoArtifactID, grpcArtifactID, gapicArtifactID, bomArtifactID} {
104+
for _, artifact := range []string{protoArtifactID, gRPCArtifactID, gapicArtifactID, bomArtifactID} {
105105
if err := os.MkdirAll(filepath.Join(tmpDir, artifact), 0755); err != nil {
106106
t.Fatal(err)
107107
}
@@ -116,7 +116,7 @@ func TestSyncPoms_Update(t *testing.T) {
116116
relPath: filepath.Join(gapicArtifactID, "pom.xml"),
117117
markers: []struct{ start, end string }{
118118
{managedProtoStartMarker, managedProtoEndMarker},
119-
{managedGrpcStartMarker, managedGrpcEndMarker},
119+
{managedGRPCStartMarker, managedGRPCEndMarker},
120120
},
121121
},
122122
{

‎internal/librarian/java/postprocess.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,15 @@ type postProcessParams struct {
4444
}
4545

4646
func (p postProcessParams) gapicDir() string { return filepath.Join(p.outDir, p.version, "gapic") }
47-
func (p postProcessParams) grpcDir() string { return filepath.Join(p.outDir, p.version, "grpc") }
47+
func (p postProcessParams) gRPCDir() string { return filepath.Join(p.outDir, p.version, "grpc") }
4848
func (p postProcessParams) protoDir() string { return filepath.Join(p.outDir, p.version, "proto") }
4949
func (p postProcessParams) coords() apiCoord {
5050
return deriveAPICoord(deriveLibCoord(p.library), p.version)
5151
}
5252

5353
func postProcessAPI(ctx context.Context, p postProcessParams) error {
5454
gapicDir := p.gapicDir()
55-
grpcDir := p.grpcDir()
55+
gRPCDir := p.gRPCDir()
5656
protoDir := p.protoDir()
5757
// Unzip the temp-codegen.srcjar into temporary version/ directory.
5858
srcjarPath := filepath.Join(gapicDir, "temp-codegen.srcjar")
@@ -61,7 +61,7 @@ func postProcessAPI(ctx context.Context, p postProcessParams) error {
6161
return fmt.Errorf("failed to unzip %s: %w", srcjarPath, err)
6262
}
6363
}
64-
for _, dir := range []string{grpcDir, protoDir} {
64+
for _, dir := range []string{gRPCDir, protoDir} {
6565
if err := addMissingHeaders(dir); err != nil {
6666
return fmt.Errorf("failed to fix headers in %s: %w", dir, err)
6767
}
@@ -188,7 +188,7 @@ func restructureModules(p postProcessParams, destRoot string) error {
188188
description: "proto source",
189189
},
190190
{
191-
src: p.grpcDir(),
191+
src: p.gRPCDir(),
192192
dest: filepath.Join(destRoot, coords.grpc.ArtifactID, "src", "main", "java"),
193193
description: "grpc source",
194194
},

‎internal/librarian/java/postprocess_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ func TestPostProcessAPI(t *testing.T) {
3434
libraryName := "secretmanager"
3535
version := "v1"
3636
gapicDir := filepath.Join(outdir, version, "gapic")
37-
grpcDir := filepath.Join(outdir, version, "grpc")
37+
gRPCDir := filepath.Join(outdir, version, "grpc")
3838
protoDir := filepath.Join(outdir, version, "proto")
3939
if err := os.MkdirAll(filepath.Join(gapicDir, "src", "main", "java"), 0755); err != nil {
4040
t.Fatal(err)
4141
}
42-
if err := os.MkdirAll(grpcDir, 0755); err != nil {
42+
if err := os.MkdirAll(gRPCDir, 0755); err != nil {
4343
t.Fatal(err)
4444
}
4545
for _, artifact := range []string{"google-cloud-secretmanager", "proto-google-cloud-secretmanager-v1", "grpc-google-cloud-secretmanager-v1", "google-cloud-secretmanager-bom"} {
@@ -48,7 +48,7 @@ func TestPostProcessAPI(t *testing.T) {
4848
}
4949
}
5050
content := "package com.google.cloud.secretmanager.v1;"
51-
grpcFile := filepath.Join(grpcDir, "GrpcFile.java")
51+
grpcFile := filepath.Join(gRPCDir, "GRPCFile.java")
5252
if err := os.WriteFile(grpcFile, []byte(content), 0644); err != nil {
5353
t.Fatal(err)
5454
}

‎internal/librarian/java/template/module_client_pom.xml.tmpl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
{{- end }}
118118
{{- end }}
119119
{{- define "managed_grpc_dependencies" }}
120-
{{- range .GrpcModules }}
120+
{{- range .GRPCModules }}
121121
<dependency>
122122
<groupId>{{ .GroupID }}</groupId>
123123
<artifactId>{{ .ArtifactID }}</artifactId>

‎internal/librarian/java/template/module_grpc_pom.xml.tmpl‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
33
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
44
<modelVersion>4.0.0</modelVersion>
5-
<groupId>{{.Grpc.GroupID}}</groupId>
6-
<artifactId>{{.Grpc.ArtifactID}}</artifactId>
7-
<version>{{.Version}}</version><!-- {x-version-update:{{.Grpc.ArtifactID}}:current} -->
8-
<name>{{.Grpc.ArtifactID}}</name>
5+
<groupId>{{.GRPC.GroupID}}</groupId>
6+
<artifactId>{{.GRPC.ArtifactID}}</artifactId>
7+
<version>{{.Version}}</version><!-- {x-version-update:{{.GRPC.ArtifactID}}:current} -->
8+
<name>{{.GRPC.ArtifactID}}</name>
99
<description>GRPC library for {{.MainArtifactID}}</description>
1010
<parent>
1111
<groupId>{{.Parent.GroupID}}</groupId>

0 commit comments

Comments
 (0)