gapic-generator-java icon indicating copy to clipboard operation
gapic-generator-java copied to clipboard

Generator incorrectly sets the composeTransport sample's region tag

Open lqiu96 opened this issue 2 years ago • 3 comments

Context: The SyncCreateSetCredentialsProvider sample already exists: https://github.com/googleapis/google-cloud-java/blob/56c9a8a29c1d04baed958cc028918eea5995aa17/java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider.java

and it properly showcases setting the credentials. The SyncCreateSetCredentialsProvider1 sample should be named something that reflects that it is using httpjson.

This generator's logic seems to set the wrong region tag name: https://github.com/googleapis/gapic-generator-java/blob/8ef747b244c9bed128252cb6913d954ae7270251/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/samplecode/ServiceClientHeaderSampleComposer.java#L345

The logic may have been mistakenly copied over. This is creating samples with SyncCreateSetCredentialsProvider1 as the filename instead of something like ComposeTranport or UseHttpJsonTransport.

https://github.com/googleapis/google-cloud-java/blob/56c9a8a29c1d04baed958cc028918eea5995aa17/java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider1.java#L23

lqiu96 avatar Jan 25 '23 00:01 lqiu96

@lqiu96 Is the screenshot below capturing the incorrectness you found?

image

suztomo avatar Apr 05 '23 14:04 suztomo

I'll update the title/body to reflect the entire scope for more clarity.

Thanks for the screenshot! The screenshot shows the invalid region tag. The other issue is that the file name/ class is set incorrectly (which I'm fairly certain is due to the region tag name).

Context: The SyncCreateSetCredentialsProvider sample already exists: https://github.com/googleapis/google-cloud-java/blob/56c9a8a29c1d04baed958cc028918eea5995aa17/java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider.java

and it properly tests setting the credentials. The SyncCreateSetCredentialsProvider1 sample should be named something that reflects that it is using httpjson.

lqiu96 avatar Apr 05 '23 14:04 lqiu96

As of today, the generated sample still has the name SyncCreateSetCredentialsProvider1:

suztomo@suztomo2:~/google-cloud-java$ grep -ir SyncCreateSetCredentialsProvider java-tpu
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2alpha1/tpu/create/SyncCreateSetCredentialsProvider.java:public class SyncCreateSetCredentialsProvider {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2alpha1/tpu/create/SyncCreateSetCredentialsProvider.java:    syncCreateSetCredentialsProvider();
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2alpha1/tpu/create/SyncCreateSetCredentialsProvider.java:  public static void syncCreateSetCredentialsProvider() throws Exception {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v1/tpu/create/SyncCreateSetCredentialsProvider.java:public class SyncCreateSetCredentialsProvider {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v1/tpu/create/SyncCreateSetCredentialsProvider.java:    syncCreateSetCredentialsProvider();
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v1/tpu/create/SyncCreateSetCredentialsProvider.java:  public static void syncCreateSetCredentialsProvider() throws Exception {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider.java:public class SyncCreateSetCredentialsProvider {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider.java:    syncCreateSetCredentialsProvider();
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider.java:  public static void syncCreateSetCredentialsProvider() throws Exception {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider1.java:public class SyncCreateSetCredentialsProvider1 {
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider1.java:    syncCreateSetCredentialsProvider1();
java-tpu/samples/snippets/generated/com/google/cloud/tpu/v2/tpu/create/SyncCreateSetCredentialsProvider1.java:  public static void syncCreateSetCredentialsProvider1() throws Exception {

suztomo avatar Apr 11 '24 15:04 suztomo