fix: update regionTag to use service name (#1047)

* updating unit files and tests * update integration tests * refactor ClassNames
googleapis · Oct 24, 2022 · be2f0b9 · be2f0b9
1 parent 040e9bd
commit be2f0b9
Show file tree

Hide file tree

Showing 874 changed files with 1,815 additions and 1,761 deletions.
diff --git a/...le/api/generator/gapic/composer/samplecode/ServiceClientCallableMethodSampleComposer.java b/...le/api/generator/gapic/composer/samplecode/ServiceClientCallableMethodSampleComposer.java
@@ -42,6 +42,7 @@
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.engine.ast.WhileStatement;
 import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.Method;
@@ -124,7 +125,8 @@ private static Sample composeUnaryOrLroCallableSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .build();
@@ -278,7 +280,8 @@ private static Sample composePagedCallableSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setOverloadDisambiguation("Paged")
             .setIsAsynchronous(true)
@@ -394,7 +397,7 @@ public static Sample composeLroCallableMethod(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientType.reference().name())
+            .setServiceName(ClassNames.getPureServiceName(clientType.reference().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .setOverloadDisambiguation("LRO")
@@ -531,7 +534,7 @@ public static Sample composePagedCallableMethod(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientType.reference().name())
+            .setServiceName(ClassNames.getPureServiceName(clientType.reference().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .build();
@@ -717,7 +720,8 @@ private static Sample composeStreamServerSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .build();
@@ -796,7 +800,8 @@ private static Sample composeStreamBidiSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .build();
@@ -928,7 +933,8 @@ private static Sample composeStreamClientSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setIsAsynchronous(true)
             .build();

diff --git a/...com/google/api/generator/gapic/composer/samplecode/ServiceClientHeaderSampleComposer.java b/...com/google/api/generator/gapic/composer/samplecode/ServiceClientHeaderSampleComposer.java
@@ -27,6 +27,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.HttpBindings;
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.Method;
@@ -206,7 +207,7 @@ public static Sample composeSetCredentialsSample(TypeNode clientType, TypeNode s
             ExprStatement.withExpr(initSettingsVarExpr), ExprStatement.withExpr(initClientVarExpr));
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientName)
+            .setServiceName(ClassNames.getPureServiceName(clientName))
             .setRpcName(rpcName)
             .setOverloadDisambiguation("setCredentialsProvider")
             .build();
@@ -273,7 +274,7 @@ public static Sample composeSetEndpointSample(TypeNode clientType, TypeNode sett
             .build();
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientName)
+            .setServiceName(ClassNames.getPureServiceName(clientName))
             .setRpcName(rpcName)
             .setOverloadDisambiguation("setEndpoint")
             .build();
@@ -346,7 +347,7 @@ public static Sample composeTransportSample(
             ExprStatement.withExpr(initSettingsVarExpr), ExprStatement.withExpr(initClientVarExpr));
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientName)
+            .setServiceName(ClassNames.getPureServiceName(clientName))
             .setRpcName(rpcName)
             .setOverloadDisambiguation("setCredentialsProvider")
             .build();

diff --git a/...com/google/api/generator/gapic/composer/samplecode/ServiceClientMethodSampleComposer.java b/...com/google/api/generator/gapic/composer/samplecode/ServiceClientMethodSampleComposer.java
@@ -27,6 +27,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.composer.defaultvalue.DefaultValueComposer;
+import com.google.api.generator.gapic.composer.utils.ClassNames;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.Message;
 import com.google.api.generator.gapic.model.Method;
@@ -57,7 +58,8 @@ public static Sample composeEmptyServiceSample(TypeNode clientType) {
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName("emtpy")
             .build();
 
@@ -169,7 +171,8 @@ static Sample composeSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setOverloadDisambiguation(
                 SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))
@@ -243,7 +246,8 @@ static Sample composePagedSample(
 
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setOverloadDisambiguation(
                 SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))
@@ -293,7 +297,8 @@ static Sample composeLroSample(
     }
     RegionTag regionTag =
         RegionTag.builder()
-            .setServiceName(clientVarExpr.variable().identifier().name())
+            .setServiceName(
+                ClassNames.getPureServiceName(clientVarExpr.variable().identifier().name()))
             .setRpcName(method.name())
             .setOverloadDisambiguation(
                 SampleComposerUtil.createOverloadDisambiguation(rpcMethodArgVarExprs))

diff --git a/...enerator-java/src/main/java/com/google/api/generator/gapic/composer/utils/ClassNames.java b/...enerator-java/src/main/java/com/google/api/generator/gapic/composer/utils/ClassNames.java
@@ -15,6 +15,8 @@
 package com.google.api.generator.gapic.composer.utils;
 
 import com.google.api.generator.gapic.model.Service;
+import com.google.common.base.Splitter;
+import com.google.common.collect.Iterables;
 import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
@@ -24,7 +26,8 @@ public class ClassNames {
   // Using constants since many of these class names are used often.
   private static final String MOCK_SERVICE_CLASS_NAME_PATTERN = "Mock%s";
   private static final String MOCK_SERVICE_IMPL_CLASS_NAME_PATTERN = "Mock%sImpl";
-  private static final String SERVICE_CLIENT_CLASS_NAME_PATTERN = "%sClient";
+  private static final String CLIENT_SUFFIX = "Client";
+  private static final String SERVICE_CLIENT_CLASS_NAME_PATTERN = "%s" + CLIENT_SUFFIX;
   private static final String SERVICE_CLIENT_TEST_CLASS_NAME_PATTERN = "%sClientTest";
   private static final String SERVICE_CLIENT_TRANSPORT_TEST_CLASS_NAME_PATTERN = "%sClient%sTest";
   private static final String SERVICE_SETTINGS_CLASS_NAME_PATTERN = "%sSettings";
@@ -120,4 +123,11 @@ private static String monolithBackwardsCompatibleName(String rawServiceName) {
         ? rawServiceName.replace("IAM", "Iam")
         : rawServiceName;
   }
+
+  // For region tags, the service name should not include `Client` in the name
+  public static String getPureServiceName(String serviceClassName) {
+    return String.format(
+        "%s",
+        Iterables.getFirst(Splitter.on(CLIENT_SUFFIX).split(serviceClassName), serviceClassName));
+  }
 }
diff --git a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/model/RegionTag.java b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/model/RegionTag.java
@@ -138,7 +138,8 @@ public String generate() {
     if (!apiVersion().isEmpty()) {
       rt = rt + apiVersion() + "_";
     }
-    rt = rt + "generated_" + serviceName() + "_" + rpcName();
+    rt = rt.toLowerCase() + "generated_" + serviceName() + "_" + rpcName();
+    // TODO: @alicejli overloadDisambiguation will need to be updated to match other languages
     if (!overloadDisambiguation().isEmpty()) {
       rt = rt + "_" + overloadDisambiguation();
     }
@@ -148,7 +149,7 @@ public String generate() {
       rt = rt + "_sync";
     }
 
-    return rt.toLowerCase();
+    return rt;
   }
 
   public static CommentStatement generateTag(

diff --git a/...ogle/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/AsyncGetBook.golden b/...ogle/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/AsyncGetBook.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_getbook_async]
+// [START goldensample_generated_Bookshop_GetBook_async]
 import com.google.api.core.ApiFuture;
 import com.google.bookshop.v1beta1.Book;
 import com.google.bookshop.v1beta1.BookshopClient;
@@ -48,4 +48,4 @@ public class AsyncGetBook {
     }
   }
 }
-// [END goldensample_generated_bookshopclient_getbook_async]
+// [END goldensample_generated_Bookshop_GetBook_async]
diff --git a/...apic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetCredentialsProvider.golden b/...apic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetCredentialsProvider.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_create_setcredentialsprovider_sync]
+// [START goldensample_generated_Bookshop_Create_SetCredentialsProvider_sync]
 import com.google.api.gax.core.FixedCredentialsProvider;
 import com.google.bookshop.v1beta1.BookshopClient;
 import com.google.bookshop.v1beta1.BookshopSettings;
@@ -41,4 +41,4 @@ public class SyncCreateSetCredentialsProvider {
     BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
   }
 }
-// [END goldensample_generated_bookshopclient_create_setcredentialsprovider_sync]
+// [END goldensample_generated_Bookshop_Create_SetCredentialsProvider_sync]
diff --git a/...generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetEndpoint.golden b/...generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncCreateSetEndpoint.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_create_setendpoint_sync]
+// [START goldensample_generated_Bookshop_Create_SetEndpoint_sync]
 import com.google.bookshop.v1beta1.BookshopClient;
 import com.google.bookshop.v1beta1.BookshopSettings;
 import com.google.bookshop.v1beta1.myEndpoint;
@@ -38,4 +38,4 @@ public class SyncCreateSetEndpoint {
     BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
   }
 }
-// [END goldensample_generated_bookshopclient_create_setendpoint_sync]
+// [END goldensample_generated_Bookshop_Create_SetEndpoint_sync]
diff --git a/...oogle/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBook.golden b/...oogle/api/generator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBook.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_getbook_sync]
+// [START goldensample_generated_Bookshop_GetBook_sync]
 import com.google.bookshop.v1beta1.Book;
 import com.google.bookshop.v1beta1.BookshopClient;
 import com.google.bookshop.v1beta1.GetBookRequest;
@@ -45,4 +45,4 @@ public class SyncGetBook {
     }
   }
 }
-// [END goldensample_generated_bookshopclient_getbook_sync]
+// [END goldensample_generated_Bookshop_GetBook_sync]
diff --git a/...enerator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookIntListbook.golden b/...enerator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookIntListbook.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_getbook_intlistbook_sync]
+// [START goldensample_generated_Bookshop_GetBook_IntListbook_sync]
 import com.google.bookshop.v1beta1.Book;
 import com.google.bookshop.v1beta1.BookshopClient;
 import java.util.ArrayList;
@@ -41,4 +41,4 @@ public class SyncGetBookIntListbook {
     }
   }
 }
-// [END goldensample_generated_bookshopclient_getbook_intlistbook_sync]
+// [END goldensample_generated_Bookshop_GetBook_IntListbook_sync]
diff --git a/...rator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookStringListbook.golden b/...rator/gapic/composer/grpc/goldens/samples/bookshopclient/SyncGetBookStringListbook.golden
@@ -16,7 +16,7 @@
 
 package com.google.bookshop.v1beta1.samples;
 
-// [START goldensample_generated_bookshopclient_getbook_stringlistbook_sync]
+// [START goldensample_generated_Bookshop_GetBook_StringListbook_sync]
 import com.google.bookshop.v1beta1.Book;
 import com.google.bookshop.v1beta1.BookshopClient;
 import java.util.ArrayList;
@@ -41,4 +41,4 @@ public class SyncGetBookStringListbook {
     }
   }
 }
-// [END goldensample_generated_bookshopclient_getbook_stringlistbook_sync]
+// [END goldensample_generated_Bookshop_GetBook_StringListbook_sync]
diff --git a/...tor/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncFastFibonacci.golden b/...tor/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncFastFibonacci.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_fastfibonacci_async]
+// [START goldensample_generated_DeprecatedService_FastFibonacci_async]
 import com.google.api.core.ApiFuture;
 import com.google.protobuf.Empty;
 import com.google.testdata.v1.DeprecatedServiceClient;
@@ -42,4 +42,4 @@ public class AsyncFastFibonacci {
     }
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_fastfibonacci_async]
+// [END goldensample_generated_DeprecatedService_FastFibonacci_async]
diff --git a/...tor/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncSlowFibonacci.golden b/...tor/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/AsyncSlowFibonacci.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_slowfibonacci_async]
+// [START goldensample_generated_DeprecatedService_SlowFibonacci_async]
 import com.google.api.core.ApiFuture;
 import com.google.protobuf.Empty;
 import com.google.testdata.v1.DeprecatedServiceClient;
@@ -42,4 +42,4 @@ public class AsyncSlowFibonacci {
     }
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_slowfibonacci_async]
+// [END goldensample_generated_DeprecatedService_SlowFibonacci_async]
diff --git a/...oser/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetCredentialsProvider.golden b/...oser/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetCredentialsProvider.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_create_setcredentialsprovider_sync]
+// [START goldensample_generated_DeprecatedService_Create_SetCredentialsProvider_sync]
 import com.google.api.gax.core.FixedCredentialsProvider;
 import com.google.testdata.v1.DeprecatedServiceClient;
 import com.google.testdata.v1.DeprecatedServiceSettings;
@@ -42,4 +42,4 @@ public class SyncCreateSetCredentialsProvider {
         DeprecatedServiceClient.create(deprecatedServiceSettings);
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_create_setcredentialsprovider_sync]
+// [END goldensample_generated_DeprecatedService_Create_SetCredentialsProvider_sync]
diff --git a/.../gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetEndpoint.golden b/.../gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncCreateSetEndpoint.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_create_setendpoint_sync]
+// [START goldensample_generated_DeprecatedService_Create_SetEndpoint_sync]
 import com.google.testdata.v1.DeprecatedServiceClient;
 import com.google.testdata.v1.DeprecatedServiceSettings;
 import com.google.testdata.v1.myEndpoint;
@@ -39,4 +39,4 @@ public class SyncCreateSetEndpoint {
         DeprecatedServiceClient.create(deprecatedServiceSettings);
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_create_setendpoint_sync]
+// [END goldensample_generated_DeprecatedService_Create_SetEndpoint_sync]
diff --git a/...ator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncFastFibonacci.golden b/...ator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncFastFibonacci.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_fastfibonacci_sync]
+// [START goldensample_generated_DeprecatedService_FastFibonacci_sync]
 import com.google.protobuf.Empty;
 import com.google.testdata.v1.DeprecatedServiceClient;
 import com.google.testdata.v1.FibonacciRequest;
@@ -39,4 +39,4 @@ public class SyncFastFibonacci {
     }
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_fastfibonacci_sync]
+// [END goldensample_generated_DeprecatedService_FastFibonacci_sync]
diff --git a/...ator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncSlowFibonacci.golden b/...ator/gapic/composer/grpc/goldens/samples/deprecatedserviceclient/SyncSlowFibonacci.golden
@@ -16,7 +16,7 @@
 
 package com.google.testdata.v1.samples;
 
-// [START goldensample_generated_deprecatedserviceclient_slowfibonacci_sync]
+// [START goldensample_generated_DeprecatedService_SlowFibonacci_sync]
 import com.google.protobuf.Empty;
 import com.google.testdata.v1.DeprecatedServiceClient;
 import com.google.testdata.v1.FibonacciRequest;
@@ -39,4 +39,4 @@ public class SyncSlowFibonacci {
     }
   }
 }
-// [END goldensample_generated_deprecatedserviceclient_slowfibonacci_sync]
+// [END goldensample_generated_DeprecatedService_SlowFibonacci_sync]