Skip to content

Commit 68b33c2

Browse files
alicejlialicejli
authored
fix: update regionTag to use service name (#1047)
* updating unit files and tests * update integration tests * refactor ClassNames
1 parent f36c226 commit 68b33c2

File tree

874 files changed

+1815
-1761
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

874 files changed

+1815
-1761
lines changed

‎src/main/java/com/google/api/generator/gapic/composer/samplecode/ServiceClientCallableMethodSampleComposer.java

+13-7
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@
4242
import com.google.api.generator.engine.ast.VariableExpr;
4343
import com.google.api.generator.engine.ast.WhileStatement;
4444
import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
45+
import com.google.api.generator.gapic.composer.utils.ClassNames;
4546
import com.google.api.generator.gapic.model.Field;
4647
import com.google.api.generator.gapic.model.Message;
4748
import com.google.api.generator.gapic.model.Method;
@@ -124,7 +125,8 @@ private static Sample composeUnaryOrLroCallableSample(
124125

125126
RegionTag regionTag =
126127
RegionTag.builder()
127-
.setServiceName(clientVarExpr.variable().identifier().name())
128+
.setServiceName(
129+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
128130
.setRpcName(method.name())
129131
.setIsAsynchronous(true)
130132
.build();
@@ -278,7 +280,8 @@ private static Sample composePagedCallableSample(
278280

279281
RegionTag regionTag =
280282
RegionTag.builder()
281-
.setServiceName(clientVarExpr.variable().identifier().name())
283+
.setServiceName(
284+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
282285
.setRpcName(method.name())
283286
.setOverloadDisambiguation("Paged")
284287
.setIsAsynchronous(true)
@@ -394,7 +397,7 @@ public static Sample composeLroCallableMethod(
394397

395398
RegionTag regionTag =
396399
RegionTag.builder()
397-
.setServiceName(clientType.reference().name())
400+
.setServiceName(ClassNames.getPureServiceName(clientType.reference().name()))
398401
.setRpcName(method.name())
399402
.setIsAsynchronous(true)
400403
.setOverloadDisambiguation("LRO")
@@ -531,7 +534,7 @@ public static Sample composePagedCallableMethod(
531534

532535
RegionTag regionTag =
533536
RegionTag.builder()
534-
.setServiceName(clientType.reference().name())
537+
.setServiceName(ClassNames.getPureServiceName(clientType.reference().name()))
535538
.setRpcName(method.name())
536539
.setIsAsynchronous(true)
537540
.build();
@@ -717,7 +720,8 @@ private static Sample composeStreamServerSample(
717720

718721
RegionTag regionTag =
719722
RegionTag.builder()
720-
.setServiceName(clientVarExpr.variable().identifier().name())
723+
.setServiceName(
724+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
721725
.setRpcName(method.name())
722726
.setIsAsynchronous(true)
723727
.build();
@@ -796,7 +800,8 @@ private static Sample composeStreamBidiSample(
796800

797801
RegionTag regionTag =
798802
RegionTag.builder()
799-
.setServiceName(clientVarExpr.variable().identifier().name())
803+
.setServiceName(
804+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
800805
.setRpcName(method.name())
801806
.setIsAsynchronous(true)
802807
.build();
@@ -928,7 +933,8 @@ private static Sample composeStreamClientSample(
928933

929934
RegionTag regionTag =
930935
RegionTag.builder()
931-
.setServiceName(clientVarExpr.variable().identifier().name())
936+
.setServiceName(
937+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
932938
.setRpcName(method.name())
933939
.setIsAsynchronous(true)
934940
.build();

‎src/main/java/com/google/api/generator/gapic/composer/samplecode/ServiceClientHeaderSampleComposer.java

+4-3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import com.google.api.generator.engine.ast.Variable;
2828
import com.google.api.generator.engine.ast.VariableExpr;
2929
import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
30+
import com.google.api.generator.gapic.composer.utils.ClassNames;
3031
import com.google.api.generator.gapic.model.HttpBindings;
3132
import com.google.api.generator.gapic.model.Message;
3233
import com.google.api.generator.gapic.model.Method;
@@ -206,7 +207,7 @@ public static Sample composeSetCredentialsSample(TypeNode clientType, TypeNode s
206207
ExprStatement.withExpr(initSettingsVarExpr), ExprStatement.withExpr(initClientVarExpr));
207208
RegionTag regionTag =
208209
RegionTag.builder()
209-
.setServiceName(clientName)
210+
.setServiceName(ClassNames.getPureServiceName(clientName))
210211
.setRpcName(rpcName)
211212
.setOverloadDisambiguation("setCredentialsProvider")
212213
.build();
@@ -273,7 +274,7 @@ public static Sample composeSetEndpointSample(TypeNode clientType, TypeNode sett
273274
.build();
274275
RegionTag regionTag =
275276
RegionTag.builder()
276-
.setServiceName(clientName)
277+
.setServiceName(ClassNames.getPureServiceName(clientName))
277278
.setRpcName(rpcName)
278279
.setOverloadDisambiguation("setEndpoint")
279280
.build();
@@ -346,7 +347,7 @@ public static Sample composeTransportSample(
346347
ExprStatement.withExpr(initSettingsVarExpr), ExprStatement.withExpr(initClientVarExpr));
347348
RegionTag regionTag =
348349
RegionTag.builder()
349-
.setServiceName(clientName)
350+
.setServiceName(ClassNames.getPureServiceName(clientName))
350351
.setRpcName(rpcName)
351352
.setOverloadDisambiguation("setCredentialsProvider")
352353
.build();

‎src/main/java/com/google/api/generator/gapic/composer/samplecode/ServiceClientMethodSampleComposer.java

+9-4
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import com.google.api.generator.engine.ast.Variable;
2828
import com.google.api.generator.engine.ast.VariableExpr;
2929
import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
30+
import com.google.api.generator.gapic.composer.utils.ClassNames;
3031
import com.google.api.generator.gapic.model.Field;
3132
import com.google.api.generator.gapic.model.Message;
3233
import com.google.api.generator.gapic.model.Method;
@@ -57,7 +58,8 @@ public static Sample composeEmptyServiceSample(TypeNode clientType) {
5758

5859
RegionTag regionTag =
5960
RegionTag.builder()
60-
.setServiceName(clientVarExpr.variable().identifier().name())
61+
.setServiceName(
62+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
6163
.setRpcName("emtpy")
6264
.build();
6365

@@ -169,7 +171,8 @@ static Sample composeSample(
169171

170172
RegionTag regionTag =
171173
RegionTag.builder()
172-
.setServiceName(clientVarExpr.variable().identifier().name())
174+
.setServiceName(
175+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
173176
.setRpcName(method.name())
174177
.setOverloadDisambiguation(
175178
SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))
@@ -243,7 +246,8 @@ static Sample composePagedSample(
243246

244247
RegionTag regionTag =
245248
RegionTag.builder()
246-
.setServiceName(clientVarExpr.variable().identifier().name())
249+
.setServiceName(
250+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
247251
.setRpcName(method.name())
248252
.setOverloadDisambiguation(
249253
SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))
@@ -293,7 +297,8 @@ static Sample composeLroSample(
293297
}
294298
RegionTag regionTag =
295299
RegionTag.builder()
296-
.setServiceName(clientVarExpr.variable().identifier().name())
300+
.setServiceName(
301+
ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
297302
.setRpcName(method.name())
298303
.setOverloadDisambiguation(
299304
SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))

‎src/main/java/com/google/api/generator/gapic/composer/utils/ClassNames.java

+11-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
package com.google.api.generator.gapic.composer.utils;
1616

1717
import com.google.api.generator.gapic.model.Service;
18+
import com.google.common.base.Splitter;
19+
import com.google.common.collect.Iterables;
1820
import java.util.Arrays;
1921
import java.util.List;
2022
import java.util.stream.Collectors;
@@ -24,7 +26,8 @@ public class ClassNames {
2426
// Using constants since many of these class names are used often.
2527
private static final String MOCK_SERVICE_CLASS_NAME_PATTERN = "Mock%s";
2628
private static final String MOCK_SERVICE_IMPL_CLASS_NAME_PATTERN = "Mock%sImpl";
27-
private static final String SERVICE_CLIENT_CLASS_NAME_PATTERN = "%sClient";
29+
private static final String CLIENT_SUFFIX = "Client";
30+
private static final String SERVICE_CLIENT_CLASS_NAME_PATTERN = "%s" + CLIENT_SUFFIX;
2831
private static final String SERVICE_CLIENT_TEST_CLASS_NAME_PATTERN = "%sClientTest";
2932
private static final String SERVICE_CLIENT_TRANSPORT_TEST_CLASS_NAME_PATTERN = "%sClient%sTest";
3033
private static final String SERVICE_SETTINGS_CLASS_NAME_PATTERN = "%sSettings";
@@ -120,4 +123,11 @@ private static String monolithBackwardsCompatibleName(String rawServiceName) {
120123
? rawServiceName.replace("IAM", "Iam")
121124
: rawServiceName;
122125
}
126+
127+
// For region tags, the service name should not include `Client` in the name
128+
public static String getPureServiceName(String serviceClassName) {
129+
return String.format(
130+
"%s",
131+
Iterables.getFirst(Splitter.on(CLIENT_SUFFIX).split(serviceClassName), serviceClassName));
132+
}
123133
}

‎src/main/java/com/google/api/generator/gapic/model/RegionTag.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,8 @@ public String generate() {
138138
if (!apiVersion().isEmpty()) {
139139
rt = rt + apiVersion() + "_";
140140
}
141-
rt = rt + "generated_" + serviceName() + "_" + rpcName();
141+
rt = rt.toLowerCase() + "generated_" + serviceName() + "_" + rpcName();
142+
// TODO: @alicejli overloadDisambiguation will need to be updated to match other languages
142143
if (!overloadDisambiguation().isEmpty()) {
143144
rt = rt + "_" + overloadDisambiguation();
144145
}
@@ -148,7 +149,7 @@ public String generate() {
148149
rt = rt + "_sync";
149150
}
150151

151-
return rt.toLowerCase();
152+
return rt;
152153
}
153154

154155
public static CommentStatement generateTag(

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/AsyncGetBook.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_getbook_async]
19+
// [START goldensample_generated_Bookshop_GetBook_async]
2020
import com.google.api.core.ApiFuture;
2121
import com.google.bookshop.v1beta1.Book;
2222
import com.google.bookshop.v1beta1.BookshopClient;
@@ -48,4 +48,4 @@ public class AsyncGetBook {
4848
}
4949
}
5050
}
51-
// [END goldensample_generated_bookshopclient_getbook_async]
51+
// [END goldensample_generated_Bookshop_GetBook_async]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetCredentialsProvider.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_create_setcredentialsprovider_sync]
19+
// [START goldensample_generated_Bookshop_Create_SetCredentialsProvider_sync]
2020
import com.google.api.gax.core.FixedCredentialsProvider;
2121
import com.google.bookshop.v1beta1.BookshopClient;
2222
import com.google.bookshop.v1beta1.BookshopSettings;
@@ -41,4 +41,4 @@ public class SyncCreateSetCredentialsProvider {
4141
BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
4242
}
4343
}
44-
// [END goldensample_generated_bookshopclient_create_setcredentialsprovider_sync]
44+
// [END goldensample_generated_Bookshop_Create_SetCredentialsProvider_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetEndpoint.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_create_setendpoint_sync]
19+
// [START goldensample_generated_Bookshop_Create_SetEndpoint_sync]
2020
import com.google.bookshop.v1beta1.BookshopClient;
2121
import com.google.bookshop.v1beta1.BookshopSettings;
2222
import com.google.bookshop.v1beta1.myEndpoint;
@@ -38,4 +38,4 @@ public class SyncCreateSetEndpoint {
3838
BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
3939
}
4040
}
41-
// [END goldensample_generated_bookshopclient_create_setendpoint_sync]
41+
// [END goldensample_generated_Bookshop_Create_SetEndpoint_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBook.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_getbook_sync]
19+
// [START goldensample_generated_Bookshop_GetBook_sync]
2020
import com.google.bookshop.v1beta1.Book;
2121
import com.google.bookshop.v1beta1.BookshopClient;
2222
import com.google.bookshop.v1beta1.GetBookRequest;
@@ -45,4 +45,4 @@ public class SyncGetBook {
4545
}
4646
}
4747
}
48-
// [END goldensample_generated_bookshopclient_getbook_sync]
48+
// [END goldensample_generated_Bookshop_GetBook_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookIntListbook.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_getbook_intlistbook_sync]
19+
// [START goldensample_generated_Bookshop_GetBook_IntListbook_sync]
2020
import com.google.bookshop.v1beta1.Book;
2121
import com.google.bookshop.v1beta1.BookshopClient;
2222
import java.util.ArrayList;
@@ -41,4 +41,4 @@ public class SyncGetBookIntListbook {
4141
}
4242
}
4343
}
44-
// [END goldensample_generated_bookshopclient_getbook_intlistbook_sync]
44+
// [END goldensample_generated_Bookshop_GetBook_IntListbook_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookStringListbook.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.bookshop.v1beta1.samples;
1818

19-
// [START goldensample_generated_bookshopclient_getbook_stringlistbook_sync]
19+
// [START goldensample_generated_Bookshop_GetBook_StringListbook_sync]
2020
import com.google.bookshop.v1beta1.Book;
2121
import com.google.bookshop.v1beta1.BookshopClient;
2222
import java.util.ArrayList;
@@ -41,4 +41,4 @@ public class SyncGetBookStringListbook {
4141
}
4242
}
4343
}
44-
// [END goldensample_generated_bookshopclient_getbook_stringlistbook_sync]
44+
// [END goldensample_generated_Bookshop_GetBook_StringListbook_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncFastFibonacci.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_fastfibonacci_async]
19+
// [START goldensample_generated_DeprecatedService_FastFibonacci_async]
2020
import com.google.api.core.ApiFuture;
2121
import com.google.protobuf.Empty;
2222
import com.google.testdata.v1.DeprecatedServiceClient;
@@ -42,4 +42,4 @@ public class AsyncFastFibonacci {
4242
}
4343
}
4444
}
45-
// [END goldensample_generated_deprecatedserviceclient_fastfibonacci_async]
45+
// [END goldensample_generated_DeprecatedService_FastFibonacci_async]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncSlowFibonacci.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_slowfibonacci_async]
19+
// [START goldensample_generated_DeprecatedService_SlowFibonacci_async]
2020
import com.google.api.core.ApiFuture;
2121
import com.google.protobuf.Empty;
2222
import com.google.testdata.v1.DeprecatedServiceClient;
@@ -42,4 +42,4 @@ public class AsyncSlowFibonacci {
4242
}
4343
}
4444
}
45-
// [END goldensample_generated_deprecatedserviceclient_slowfibonacci_async]
45+
// [END goldensample_generated_DeprecatedService_SlowFibonacci_async]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetCredentialsProvider.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_create_setcredentialsprovider_sync]
19+
// [START goldensample_generated_DeprecatedService_Create_SetCredentialsProvider_sync]
2020
import com.google.api.gax.core.FixedCredentialsProvider;
2121
import com.google.testdata.v1.DeprecatedServiceClient;
2222
import com.google.testdata.v1.DeprecatedServiceSettings;
@@ -42,4 +42,4 @@ public class SyncCreateSetCredentialsProvider {
4242
DeprecatedServiceClient.create(deprecatedServiceSettings);
4343
}
4444
}
45-
// [END goldensample_generated_deprecatedserviceclient_create_setcredentialsprovider_sync]
45+
// [END goldensample_generated_DeprecatedService_Create_SetCredentialsProvider_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetEndpoint.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_create_setendpoint_sync]
19+
// [START goldensample_generated_DeprecatedService_Create_SetEndpoint_sync]
2020
import com.google.testdata.v1.DeprecatedServiceClient;
2121
import com.google.testdata.v1.DeprecatedServiceSettings;
2222
import com.google.testdata.v1.myEndpoint;
@@ -39,4 +39,4 @@ public class SyncCreateSetEndpoint {
3939
DeprecatedServiceClient.create(deprecatedServiceSettings);
4040
}
4141
}
42-
// [END goldensample_generated_deprecatedserviceclient_create_setendpoint_sync]
42+
// [END goldensample_generated_DeprecatedService_Create_SetEndpoint_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncFastFibonacci.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_fastfibonacci_sync]
19+
// [START goldensample_generated_DeprecatedService_FastFibonacci_sync]
2020
import com.google.protobuf.Empty;
2121
import com.google.testdata.v1.DeprecatedServiceClient;
2222
import com.google.testdata.v1.FibonacciRequest;
@@ -39,4 +39,4 @@ public class SyncFastFibonacci {
3939
}
4040
}
4141
}
42-
// [END goldensample_generated_deprecatedserviceclient_fastfibonacci_sync]
42+
// [END goldensample_generated_DeprecatedService_FastFibonacci_sync]

‎src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncSlowFibonacci.golden

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
package com.google.testdata.v1.samples;
1818

19-
// [START goldensample_generated_deprecatedserviceclient_slowfibonacci_sync]
19+
// [START goldensample_generated_DeprecatedService_SlowFibonacci_sync]
2020
import com.google.protobuf.Empty;
2121
import com.google.testdata.v1.DeprecatedServiceClient;
2222
import com.google.testdata.v1.FibonacciRequest;
@@ -39,4 +39,4 @@ public class SyncSlowFibonacci {
3939
}
4040
}
4141
}
42-
// [END goldensample_generated_deprecatedserviceclient_slowfibonacci_sync]
42+
// [END goldensample_generated_DeprecatedService_SlowFibonacci_sync]

0 commit comments

Comments
 (0)