8000 feat(SpringGen): adding extra annotations at the `SpringComposer` step for all Spring classes generated by zhumin8 · Pull Request #1062 · googleapis/sdk-platform-java · GitHub
[go: up one dir, main page]
Skip to content

feat(SpringGen): adding extra annotations at the SpringComposer step for all Spring classes generated #1062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 2, 2022
Merged

feat(SpringGen): adding extra annotations at the SpringComposer step for all Spring classes generated #1062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0aba139
adding @BetaApi to all Spring classes produced.
zhumin8 Oct 14, 2022
6520b15
move generated-by-gapic annotation to SpringComposer for each class p…
zhumin8 Oct 14, 2022
2e1dd08
Merge branch 'autoconfig-gen-draft2' into add-beta-annotation
zhumin8 Nov 1, 2022
fc25766
fix: merge mistake.
zhumin8 Nov 1, 2022
28ba3ea
add description to BetaApi as suggested.
zhumin8 Nov 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions src/main/java/com/google/api/generator/spring/composer/SpringAutoConfigClassComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import javax.annotation.Generated;

public class SpringAutoConfigClassComposer implements ClassComposer {
private static final String CLASS_NAME_PATTERN = "%sSpringAutoConfiguration";
Expand Down Expand Up @@ -224,7 +223,6 @@ private static MethodDefinition createConstructor(

private static List<AnnotationNode> createClassAnnotations(
Service service, Map<String, TypeNode> types) {
// @Generated("by gapic-generator-java")
// @AutoConfiguration
// @ConditionalOnClass(LanguageServiceClient.class)
// @ConditionalOnProperty(value =
Expand Down Expand Up @@ -295,10 +293,6 @@ private static List<AnnotationNode> createClassAnnotations(
.build();

return Arrays.asList(
AnnotationNode.builder()
.setType(STATIC_TYPES.get("Generated"))
.setDescription("by gapic-generator-java")
.build(),
configurationNode,
conditionalOnClassNode,
conditionalOnPropertyNode,
Expand Down Expand Up @@ -825,7 +819,6 @@ private static MethodDefinition createClientBeanMethod(
private static Map<String, TypeNode> createStaticTypes() {
List<Class> concreteClazzes =
Arrays.asList(
Generated.class,
RetrySettings.class,
RetrySettings.Builder
.class, // name will be just Builder. consider change of more than one builder here.
Expand Down
51 changes: 50 additions & 1 deletion src/main/java/com/google/api/generator/spring/composer/SpringComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,31 @@

package com.google.api.generator.spring.composer;

import com.google.api.core.BetaApi;
import com.google.api.generator.engine.ast.AnnotationNode;
import com.google.api.generator.engine.ast.ClassDefinition;
import com.google.api.generator.gapic.composer.comment.CommentComposer;
import com.google.api.generator.gapic.composer.store.TypeStore;
import com.google.api.generator.gapic.model.GapicClass;
import com.google.api.generator.gapic.model.GapicContext;
import com.google.api.generator.gapic.model.GapicPackageInfo;
import com.google.api.generator.gapic.model.Transport;
import com.google.common.collect.ImmutableList;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Generated;

public class SpringComposer {

private static final TypeStore FIXED_TYPESTORE = createStaticTypes();

public static List<GapicClass> composeServiceAutoConfigClasses(GapicContext context) {
List<GapicClass> clazzes = new ArrayList<>();
clazzes.addAll(generatePerServiceClasses(context));
return addApacheLicense(clazzes);
List<GapicClass> clazzesWithHeader = addApacheLicense(clazzes);
return addExtraClassAnnotations(clazzesWithHeader);
}

public static GapicPackageInfo composePackageInfo(GapicContext context) {
Expand Down Expand Up @@ -65,6 +75,40 @@ protected static List<GapicClass> addApacheLicense(List<GapicClass> gapicClassLi
.collect(Collectors.toList());
}

protected static List<GapicClass> addExtraClassAnnotations(List<GapicClass> gapicClassList) {
AnnotationNode generatedAnnotation =
AnnotationNode.builder()
.setType(FIXED_TYPESTORE.get("Generated"))
.setDescription("by gapic-generator-java")
.build();
AnnotationNode betaAnnotation =
AnnotationNode.builder()
.setType(FIXED_TYPESTORE.get("BetaApi"))
.setDescription("Autogenerated Spring autoconfiguration is not yet stable")
.build();
return gapicClassList.stream()
.map(
gapicClass -> {
ImmutableList<AnnotationNode> classAnnotations =
gapicClass.classDefinition().annotations();
ImmutableList<AnnotationNode> updatedAnnotations =
ImmutableList.<AnnotationNode>builder()
.add(generatedAnnotation)
.add(betaAnnotation)
.addAll(classAnnotations)
.build();
ClassDefinition classWithUpdatedAnnotations =
gapicClass
.classDefinition()
.toBuilder()
.setAnnotations(updatedAnnotations)
.build();

return GapicClass.create(gapicClass.kind(), classWithUpdatedAnnotations);
})
.collect(Collectors.toList());
}

private static GapicPackageInfo addApacheLicense(GapicPackageInfo gapicPackageInfo) {
return GapicPackageInfo.with(
gapicPackageInfo
Expand All @@ -73,4 +117,9 @@ private static GapicPackageInfo addApacheLicense(GapicPackageInfo gapicPackageIn
.setFileHeader(CommentComposer.APACHE_LICENSE_COMMENT)
.build());
}

private static TypeStore createStaticTypes() {
List<Class<?>> concreteClazzes = Arrays.asList(BetaApi.class, Generated.class);
return new TypeStore(concreteClazzes);
}
}
2 changes: 0 additions & 2 deletions .../java/com/google/api/generator/spring/composer/goldens/EchoSpringAutoConfiguration.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import com.google.cloud.spring.core.DefaultCredentialsProvider;
import com.google.showcase.v1beta1.EchoClient;
import com.google.showcase.v1beta1.EchoSettings;
import java.io.IOException;
import javax.annotation.Generated;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.boot.autoconfigure.AutoConfiguration;
Expand All @@ -20,7 +19,6 @@ import org.springframework.boot.context.properties.EnableConfigurationProperties
import org.springframework.context.annotation.Bean;
import org.threeten.bp.Duration;

@Generated("by gapic-generator-java")
@AutoConfiguration
@ConditionalOnClass(EchoClient.class)
@ConditionalOnProperty(
Expand Down
2 changes: 2 additions & 0 deletions ...a/com/google/api/generator/spring/composer/goldens/EchoSpringAutoConfigurationFull.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.google.showcase.v1beta1.spring;

import com.google.api.core.BetaApi;
import com.google.api.gax.core.CredentialsProvider;
import com.google.api.gax.core.ExecutorProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
Expand All @@ -37,6 +38,7 @@ import org.springframework.context.annotation.Bean;
import org.threeten.bp.Duration;

@Generated("by gapic-generator-java")
@BetaApi("Autogenerated Spring autoconfiguration is not yet stable")
@AutoConfiguration
@ConditionalOnClass(EchoClient.class)
@ConditionalOnProperty(
Expand Down
4 changes: 4 additions & 0 deletions ...est/java/com/google/api/generator/spring/composer/goldens/EchoSpringPropertiesFull.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,15 @@

package com.google.showcase.v1beta1.spring;

import com.google.api.core.BetaApi;
import com.google.cloud.spring.core.Credentials;
import com.google.cloud.spring.core.CredentialsSupplier;
import javax.annotation.Generated;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.threeten.bp.Duration;

@Generated("by gapic-generator-java")
@BetaApi("Autogenerated Spring autoconfiguration is not yet stable")
@ConfigurationProperties("com.google.showcase.v1beta1.spring.auto.echo")
public class EchoSpringProperties implements CredentialsSupplier {
@NestedConfigurationProperty
Expand Down
0