[ggj][codegen] feat: Add alpha/beta API detection and fix per-class a…

…nnotation (#633) * fix: fix dep ordering in Bazel dedupe rules * feat: Add alpha/beta API detection and fix per-class annotations * fix: update integration tests
googleapis · Jan 8, 2021 · c5a32cc · c5a32cc
1 parent 2085654
commit c5a32cc
Show file tree

Hide file tree

Showing 57 changed files with 404 additions and 265 deletions.
diff --git a/...java/com/google/api/generator/gapic/composer/GrpcServiceCallableFactoryClassComposer.java b/...java/com/google/api/generator/gapic/composer/GrpcServiceCallableFactoryClassComposer.java
@@ -14,6 +14,7 @@
 
 package com.google.api.generator.gapic.composer;
 
+import com.google.api.core.BetaApi;
 import com.google.api.gax.grpc.GrpcCallSettings;
 import com.google.api.gax.grpc.GrpcCallableFactory;
 import com.google.api.gax.grpc.GrpcStubCallableFactory;
@@ -40,6 +41,7 @@
 import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;
@@ -77,7 +79,7 @@ public GapicClass generate(Service service, Map<String, Message> ignore) {
             .setHeaderCommentStatements(
                 StubCommentComposer.createGrpcServiceCallableFactoryClassHeaderComments(
                     service.name()))
-            .setAnnotations(createClassAnnotations(typeStore))
+            .setAnnotations(createClassAnnotations(service.pakkage(), typeStore))
             .setImplementsTypes(createClassImplements(typeStore))
             .setName(className)
             .setMethods(createClassMethods(typeStore))
@@ -86,12 +88,17 @@ public GapicClass generate(Service service, Map<String, Message> ignore) {
     return GapicClass.create(kind, classDef);
   }
 
-  private static List<AnnotationNode> createClassAnnotations(TypeStore typeStore) {
-    return Arrays.asList(
+  private static List<AnnotationNode> createClassAnnotations(String pakkage, TypeStore typeStore) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(typeStore.get("Generated"))
-            .setDescription("by gapic-generator")
+            .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<TypeNode> createClassImplements(TypeStore typeStore) {
@@ -343,6 +350,7 @@ private static TypeStore createTypes(Service service) {
         Arrays.asList(
             // Gax-java classes.
             BatchingCallSettings.class,
+            BetaApi.class,
             BidiStreamingCallable.class,
             ClientContext.class,
             ClientStreamingCallable.class,

diff --git a/src/main/java/com/google/api/generator/gapic/composer/GrpcServiceStubClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/GrpcServiceStubClassComposer.java
@@ -14,6 +14,7 @@
 
 package com.google.api.generator.gapic.composer;
 
+import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.core.BackgroundResourceAggregation;
 import com.google.api.gax.grpc.GrpcCallSettings;
@@ -51,6 +52,7 @@
 import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;
@@ -161,7 +163,7 @@ public GapicClass generate(Service service, Map<String, Message> ignore) {
             .setPackageString(pakkage)
             .setHeaderCommentStatements(
                 StubCommentComposer.createGrpcServiceStubClassHeaderComments(service.name()))
-            .setAnnotations(createClassAnnotations())
+            .setAnnotations(createClassAnnotations(service.pakkage()))
             .setScope(ScopeNode.PUBLIC)
             .setName(className)
             .setExtendsType(typeStore.get(ClassNames.getServiceStubClassName(service)))
@@ -385,12 +387,17 @@ private static Map<String, VariableExpr> createCallableClassMembers(
     return callableClassMembers;
   }
 
-  private static List<AnnotationNode> createClassAnnotations() {
-    return Arrays.asList(
+  private static List<AnnotationNode> createClassAnnotations(String pakkage) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(FIXED_TYPESTORE.get("Generated"))
             .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<MethodDefinition> createClassMethods(
@@ -1024,6 +1031,7 @@ private static TypeStore createStaticTypes() {
         Arrays.asList(
             BackgroundResource.class,
             BackgroundResourceAggregation.class,
+            BetaApi.class,
             BidiStreamingCallable.class,
             ClientContext.class,
             ClientStreamingCallable.class,

diff --git a/src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java
@@ -58,6 +58,7 @@
 import com.google.api.generator.gapic.composer.samplecode.ServiceClientSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
@@ -128,7 +129,7 @@ public GapicClass generate(Service service, Map<String, Message> messageTypes) {
         ClassDefinition.builder()
             .setHeaderCommentStatements(createClassHeaderComments(service, typeStore))
             .setPackageString(pakkage)
-            .setAnnotations(createClassAnnotations(typeStore))
+            .setAnnotations(createClassAnnotations(pakkage, typeStore))
             .setScope(ScopeNode.PUBLIC)
             .setName(className)
             .setImplementsTypes(createClassImplements(typeStore))
@@ -139,13 +140,17 @@ public GapicClass generate(Service service, Map<String, Message> messageTypes) {
     return GapicClass.create(kind, classDef);
   }
 
-  private static List<AnnotationNode> createClassAnnotations(TypeStore typeStore) {
-    return Arrays.asList(
-        AnnotationNode.withType(typeStore.get("BetaApi")),
+  private static List<AnnotationNode> createClassAnnotations(String pakkage, TypeStore typeStore) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(typeStore.get("Generated"))
-            .setDescription("by gapic-generator")
+            .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<TypeNode> createClassImplements(TypeStore typeStore) {

diff --git a/src/main/java/com/google/api/generator/gapic/composer/ServiceSettingsClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/ServiceSettingsClassComposer.java
@@ -54,6 +54,7 @@
 import com.google.api.generator.gapic.composer.samplecode.SettingsSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;
@@ -104,7 +105,7 @@ public GapicClass generate(Service service, Map<String, Message> ignore) {
             .setPackageString(pakkage)
             .setHeaderCommentStatements(
                 createClassHeaderComments(service, typeStore.get(className)))
-            .setAnnotations(createClassAnnotations())
+            .setAnnotations(createClassAnnotations(service.pakkage()))
             .setScope(ScopeNode.PUBLIC)
             .setName(className)
             .setExtendsType(
@@ -147,12 +148,17 @@ private static List<CommentStatement> createClassHeaderComments(
         classType);
   }
 
-  private static List<AnnotationNode> createClassAnnotations() {
-    return Arrays.asList(
+  private static List<AnnotationNode> createClassAnnotations(String pakkage) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(FIXED_TYPESTORE.get("Generated"))
             .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<MethodDefinition> createClassMethods(Service service, TypeStore typeStore) {

diff --git a/src/main/java/com/google/api/generator/gapic/composer/ServiceStubClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/ServiceStubClassComposer.java
@@ -14,6 +14,7 @@
 
 package com.google.api.generator.gapic.composer;
 
+import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.rpc.BidiStreamingCallable;
 import com.google.api.gax.rpc.ClientStreamingCallable;
@@ -32,6 +33,7 @@
 import com.google.api.generator.gapic.composer.comment.StubCommentComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.GapicClass;
 import com.google.api.generator.gapic.model.GapicClass.Kind;
 import com.google.api.generator.gapic.model.Message;
@@ -69,7 +71,7 @@ public GapicClass generate(Service service, Map<String, Message> messageTypes) {
             .setPackageString(pakkage)
             .setHeaderCommentStatements(
                 StubCommentComposer.createServiceStubClassHeaderComments(service.name()))
-            .setAnnotations(createClassAnnotations(typeStore))
+            .setAnnotations(createClassAnnotations(service.pakkage(), typeStore))
             .setIsAbstract(true)
             .setImplementsTypes(createClassImplements(typeStore))
             .setName(className)
@@ -79,12 +81,17 @@ public GapicClass generate(Service service, Map<String, Message> messageTypes) {
     return GapicClass.create(kind, classDef);
   }
 
-  private static List<AnnotationNode> createClassAnnotations(TypeStore typeStore) {
-    return Arrays.asList(
+  private static List<AnnotationNode> createClassAnnotations(String pakkage, TypeStore typeStore) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(typeStore.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(typeStore.get("Generated"))
-            .setDescription("by gapic-generator")
+            .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<TypeNode> createClassImplements(TypeStore typeStore) {
@@ -215,6 +222,7 @@ private static TypeStore createTypes(Service service, Map<String, Message> messa
     List<Class> concreteClazzes =
         Arrays.asList(
             BackgroundResource.class,
+            BetaApi.class,
             BidiStreamingCallable.class,
             ClientStreamingCallable.class,
             Generated.class,

diff --git a/src/main/java/com/google/api/generator/gapic/composer/ServiceStubSettingsClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/ServiceStubSettingsClassComposer.java
@@ -85,6 +85,7 @@
 import com.google.api.generator.gapic.composer.samplecode.SettingsSampleCodeComposer;
 import com.google.api.generator.gapic.composer.store.TypeStore;
 import com.google.api.generator.gapic.composer.utils.ClassNames;
+import com.google.api.generator.gapic.composer.utils.PackageChecker;
 import com.google.api.generator.gapic.model.Field;
 import com.google.api.generator.gapic.model.GapicBatchingSettings;
 import com.google.api.generator.gapic.model.GapicClass;
@@ -175,7 +176,7 @@ public GapicClass generate(
             .setPackageString(pakkage)
             .setHeaderCommentStatements(
                 createClassHeaderComments(service, typeStore.get(className)))
-            .setAnnotations(createClassAnnotations())
+            .setAnnotations(createClassAnnotations(service.pakkage()))
             .setScope(ScopeNode.PUBLIC)
             .setName(className)
             .setExtendsType(createExtendsType(service, typeStore))
@@ -189,13 +190,17 @@ public GapicClass generate(
     return GapicClass.create(GapicClass.Kind.STUB, classDef);
   }
 
-  private static List<AnnotationNode> createClassAnnotations() {
-    return Arrays.asList(
-        AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")),
+  private static List<AnnotationNode> createClassAnnotations(String pakkage) {
+    List<AnnotationNode> annotations = new ArrayList<>();
+    if (!PackageChecker.isGaApi(pakkage)) {
+      annotations.add(AnnotationNode.withType(FIXED_TYPESTORE.get("BetaApi")));
+    }
+    annotations.add(
         AnnotationNode.builder()
             .setType(FIXED_TYPESTORE.get("Generated"))
             .setDescription("by gapic-generator-java")
             .build());
+    return annotations;
   }
 
   private static List<CommentStatement> createClassHeaderComments(

diff --git a/src/main/java/com/google/api/generator/gapic/composer/utils/BUILD.bazel b/src/main/java/com/google/api/generator/gapic/composer/utils/BUILD.bazel
@@ -14,5 +14,6 @@ java_library(
     ],
     deps = [
         "//src/main/java/com/google/api/generator/gapic/model",
+        "@com_google_guava_guava//jar",
     ],
 )
diff --git a/src/main/java/com/google/api/generator/gapic/composer/utils/PackageChecker.java b/src/main/java/com/google/api/generator/gapic/composer/utils/PackageChecker.java
@@ -0,0 +1,44 @@
+// Copyright 2021 Google LLC
+//
+// 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 com.google.api.generator.gapic.composer.utils;
+
+import com.google.common.base.Preconditions;
+import com.google.common.base.Strings;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class PackageChecker {
+  private PackageChecker() {}
+
+  /**
+   * Identifies whether a Java package is GA API. Assumes that the version appears in the last
+   * component of the package, e.g. com.google.cloud.dataproc.v1beta1.
+   */
+  public static boolean isGaApi(String pakkage) {
+    String[] packageComponents = pakkage.split("\\.");
+    Preconditions.checkState(
+        packageComponents.length > 0, "No subcomponents found in Java package %s", pakkage);
+    String versionComponent = packageComponents[packageComponents.length - 1];
+    Matcher matcher = Pattern.compile("^v[0-9]+").matcher(versionComponent);
+    Preconditions.checkState(
+        matcher.find(),
+        "No version component found in last subpackage %s of %s",
+        versionComponent,
+        pakkage);
+    String versionSubstr = versionComponent.replace(matcher.group(), "");
+    return Strings.isNullOrEmpty(versionSubstr)
+        || (!versionSubstr.contains("alpha") && !versionSubstr.contains("beta"));
+  }
+}
diff --git a/src/test/java/com/google/api/generator/gapic/composer/constants/BUILD.bazel b/src/test/java/com/google/api/generator/gapic/composer/constants/BUILD.bazel
@@ -1,5 +1,3 @@
-load("@rules_java//java:defs.bzl", "java_library")
-
 package(default_visibility = ["//visibility:public"])
 
 filegroup(

diff --git a/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoClient.golden b/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoClient.golden
@@ -80,7 +80,7 @@ import javax.annotation.Generated;
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
 @BetaApi
-@Generated("by gapic-generator")
+@Generated("by gapic-generator-java")
 public class EchoClient implements BackgroundResource {
   private final EchoSettings settings;
   private final EchoStub stub;

diff --git a/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoSettings.golden b/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoSettings.golden
@@ -55,6 +55,7 @@ import javax.annotation.Generated;
  * EchoSettings echoSettings = echoSettingsBuilder.build();
  * }</pre>
  */
+@BetaApi
 @Generated("by gapic-generator-java")
 public class EchoSettings extends ClientSettings<EchoSettings> {
 

diff --git a/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoStub.golden b/src/test/java/com/google/api/generator/gapic/composer/goldens/EchoStub.golden
@@ -3,6 +3,7 @@ package com.google.showcase.v1beta1.stub;
 import static com.google.showcase.v1beta1.EchoClient.PagedExpandPagedResponse;
 import static com.google.showcase.v1beta1.EchoClient.SimplePagedExpandPagedResponse;
 
+import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.rpc.BidiStreamingCallable;
 import com.google.api.gax.rpc.ClientStreamingCallable;
@@ -29,7 +30,8 @@ import javax.annotation.Generated;
  *
  * <p>This class is for advanced usage and reflects the underlying API directly.
  */
-@Generated("by gapic-generator")
+@BetaApi
+@Generated("by gapic-generator-java")
 public abstract class EchoStub implements BackgroundResource {
 
   public OperationsStub getOperationsStub() {

diff --git a/src/test/java/com/google/api/generator/gapic/composer/goldens/GrpcEchoCallableFactory.golden b/src/test/java/com/google/api/generator/gapic/composer/goldens/GrpcEchoCallableFactory.golden
@@ -1,5 +1,6 @@
 package com.google.showcase.v1beta1.stub;
 
+import com.google.api.core.BetaApi;
 import com.google.api.gax.grpc.GrpcCallSettings;
 import com.google.api.gax.grpc.GrpcCallableFactory;
 import com.google.api.gax.grpc.GrpcStubCallableFactory;
@@ -25,7 +26,8 @@ import javax.annotation.Generated;
  *
  * <p>This class is for advanced usage.
  */
-@Generated("by gapic-generator")
+@BetaApi
+@Generated("by gapic-generator-java")
 public class GrpcEchoCallableFactory implements GrpcStubCallableFactory {
 
   @Override