Skip to content
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.

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

feat: REGAPIC initial implementation #824

Merged
merged 9 commits into from Aug 26, 2021
2 changes: 1 addition & 1 deletion WORKSPACE
Expand Up @@ -32,7 +32,7 @@ jvm_maven_import_external(
# gapic-generator-java dependencies to match the order in googleapis repository,
# which in its turn, prioritizes actual generated clients runtime dependencies
# over the generator dependencies.
_gax_java_version = "1.65.1"
_gax_java_version = "2.2.0"

http_archive(
name = "com_google_api_gax_java",
Expand Down
4 changes: 2 additions & 2 deletions rules_java_gapic/resources/gradle/assembly.gradle.tmpl
Expand Up @@ -12,8 +12,8 @@ subprojects {
apply plugin: 'java'
apply plugin: 'maven'

sourceCompatibility = 1.7
targetCompatibility = 1.7
sourceCompatibility = 1.8
targetCompatibility = 1.8

test {
testLogging {
Expand Down
4 changes: 2 additions & 2 deletions rules_java_gapic/resources/gradle/client_grpc.gradle.tmpl
Expand Up @@ -9,8 +9,8 @@ apply plugin: 'java'
description = 'GAPIC library for {{name}}'
group = 'com.google.cloud'
version = (findProperty('version') == 'unspecified') ? '0.0.0-SNAPSHOT' : version
sourceCompatibility = 1.7
targetCompatibility = 1.7
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
mavenCentral()
Expand Down
4 changes: 2 additions & 2 deletions rules_java_gapic/resources/gradle/client_rest.gradle.tmpl
Expand Up @@ -9,8 +9,8 @@ apply plugin: 'java'
description = 'GAPIC library for {{name}}'
group = 'com.google.cloud'
version = (findProperty('version') == 'unspecified') ? '0.0.0-SNAPSHOT' : version
sourceCompatibility = 1.7
targetCompatibility = 1.7
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
mavenCentral()
Expand Down
4 changes: 2 additions & 2 deletions rules_java_gapic/resources/gradle/grpc.gradle.tmpl
Expand Up @@ -9,8 +9,8 @@ apply plugin: 'java'
description = 'GRPC library for {{name}}'
group = 'com.google.api.grpc'
version = (findProperty('version') == 'unspecified') ? '0.0.0-SNAPSHOT' : version
sourceCompatibility = 1.7
targetCompatibility = 1.7
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
mavenCentral()
Expand Down
4 changes: 2 additions & 2 deletions rules_java_gapic/resources/gradle/proto.gradle.tmpl
Expand Up @@ -9,8 +9,8 @@ apply plugin: 'java'
description = 'PROTO library for {{name}}'
group = 'com.google.api.grpc'
version = (findProperty('version') == 'unspecified') ? '0.0.0-SNAPSHOT' : version
sourceCompatibility = 1.7
targetCompatibility = 1.7
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
mavenCentral()
Expand Down
Expand Up @@ -17,14 +17,14 @@
import com.google.api.generator.engine.ast.ClassDefinition;
import com.google.api.generator.engine.ast.ScopeNode;
import com.google.api.generator.gapic.composer.comment.CommentComposer;
import com.google.api.generator.gapic.composer.common.ServiceClientClassComposer;
import com.google.api.generator.gapic.composer.common.ServiceStubClassComposer;
import com.google.api.generator.gapic.composer.grpc.GrpcServiceCallableFactoryClassComposer;
import com.google.api.generator.gapic.composer.grpc.GrpcServiceStubClassComposer;
import com.google.api.generator.gapic.composer.grpc.MockServiceClassComposer;
import com.google.api.generator.gapic.composer.grpc.MockServiceImplClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceClientClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceClientTestClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceSettingsClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceStubClassComposer;
import com.google.api.generator.gapic.composer.grpc.ServiceStubSettingsClassComposer;
import com.google.api.generator.gapic.composer.resourcename.ResourceNameHelperClassComposer;
import com.google.api.generator.gapic.composer.rest.HttpJsonServiceCallableFactoryClassComposer;
Expand Down Expand Up @@ -76,8 +76,10 @@ public static List<GapicClass> generateStubClasses(GapicContext context) {
.services()
.forEach(
s -> {
clazzes.add(ServiceStubClassComposer.instance().generate(context, s));
if (context.transport() == Transport.REST) {
clazzes.add(
com.google.api.generator.gapic.composer.rest.ServiceStubClassComposer.instance()
.generate(context, s));
clazzes.add(
com.google.api.generator.gapic.composer.rest.ServiceStubSettingsClassComposer
.instance()
Expand All @@ -86,6 +88,7 @@ public static List<GapicClass> generateStubClasses(GapicContext context) {
HttpJsonServiceCallableFactoryClassComposer.instance().generate(context, s));
clazzes.add(HttpJsonServiceStubClassComposer.instance().generate(context, s));
} else {
clazzes.add(ServiceStubClassComposer.instance().generate(context, s));
clazzes.add(ServiceStubSettingsClassComposer.instance().generate(context, s));
clazzes.add(
GrpcServiceCallableFactoryClassComposer.instance().generate(context, s));
Expand All @@ -101,13 +104,17 @@ public static List<GapicClass> generateClientSettingsClasses(GapicContext contex
.services()
.forEach(
s -> {
clazzes.add(ServiceClientClassComposer.instance().generate(context, s));
if (context.transport() == Transport.REST) {
clazzes.add(
com.google.api.generator.gapic.composer.rest.ServiceClientClassComposer
.instance()
.generate(context, s));
clazzes.add(
com.google.api.generator.gapic.composer.rest.ServiceSettingsClassComposer
.instance()
.generate(context, s));
} else {
clazzes.add(ServiceClientClassComposer.instance().generate(context, s));
clazzes.add(ServiceSettingsClassComposer.instance().generate(context, s));
}
});
Expand Down
Expand Up @@ -96,8 +96,7 @@
import java.util.stream.Collectors;
import javax.annotation.Generated;

public class ServiceClientClassComposer implements ClassComposer {
private static final ServiceClientClassComposer INSTANCE = new ServiceClientClassComposer();
public abstract class AbstractServiceClientClassComposer implements ClassComposer {
private static final String PAGED_RESPONSE_TYPE_NAME_PATTERN = "%sPagedResponse";
private static final String CALLABLE_NAME_PATTERN = "%sCallable";
private static final String PAGED_CALLABLE_NAME_PATTERN = "%sPagedCallable";
Expand All @@ -115,10 +114,14 @@ private enum CallableMethodKind {
PAGED,
}

private ServiceClientClassComposer() {}
private final TransportContext transportContext;

public static ServiceClientClassComposer instance() {
return INSTANCE;
protected AbstractServiceClientClassComposer(TransportContext transportContext) {
this.transportContext = transportContext;
}

protected TransportContext getTransportContext() {
return transportContext;
}

@Override
Expand Down Expand Up @@ -198,7 +201,7 @@ private static List<CommentStatement> createClassHeaderComments(
service, classMethodSampleCode, credentialsSampleCode, endpointSampleCode);
}

private static List<MethodDefinition> createClassMethods(
private List<MethodDefinition> createClassMethods(
Service service,
Map<String, Message> messageTypes,
TypeStore typeStore,
Expand All @@ -225,14 +228,14 @@ private static boolean hasLroMethods(Service service) {
return false;
}

private static List<Statement> createFieldDeclarations(
private List<Statement> createFieldDeclarations(
Service service, TypeStore typeStore, boolean hasLroClient) {
Map<String, TypeNode> fieldNameToTypes = new HashMap<>();
fieldNameToTypes.put(
"settings", typeStore.get(ClassNames.getServiceSettingsClassName(service)));
fieldNameToTypes.put("stub", typeStore.get(ClassNames.getServiceStubClassName(service)));
if (hasLroClient) {
fieldNameToTypes.put("operationsClient", typeStore.get("OperationsClient"));
fieldNameToTypes.put("operationsClient", getTransportContext().operationsClientType());
}

return fieldNameToTypes.entrySet().stream()
Expand Down Expand Up @@ -352,14 +355,14 @@ private static List<MethodDefinition> createStaticCreatorMethods(
return methods;
}

private static List<MethodDefinition> createConstructorMethods(
private List<MethodDefinition> createConstructorMethods(
Service service, TypeStore typeStore, boolean hasLroClient) {
List<MethodDefinition> methods = new ArrayList<>();
String thisClientName = ClassNames.getServiceClientClassName(service);
String settingsName = ClassNames.getServiceSettingsClassName(service);
TypeNode thisClassType = typeStore.get(thisClientName);
TypeNode stubSettingsType = typeStore.get(ClassNames.getServiceStubSettingsClassName(service));
TypeNode operationsClientType = typeStore.get("OperationsClient");
TypeNode operationsClientType = getTransportContext().operationsClientType();
TypeNode exceptionType = typeStore.get("IOException");

TypeNode settingsType = typeStore.get(settingsName);
Expand Down Expand Up @@ -476,15 +479,15 @@ private static List<MethodDefinition> createConstructorMethods(
return methods;
}

private static List<MethodDefinition> createGetterMethods(
private List<MethodDefinition> createGetterMethods(
Service service, TypeStore typeStore, boolean hasLroClient) {
Map<String, TypeNode> methodNameToTypes = new LinkedHashMap<>();
methodNameToTypes.put(
"getSettings", typeStore.get(ClassNames.getServiceSettingsClassName(service)));
methodNameToTypes.put("getStub", typeStore.get(ClassNames.getServiceStubClassName(service)));
String getOperationsClientMethodName = "getOperationsClient";
if (hasLroClient) {
methodNameToTypes.put(getOperationsClientMethodName, typeStore.get("OperationsClient"));
methodNameToTypes.put(getOperationsClientMethodName, getTransportContext().operationsClientType());
}
AnnotationNode betaStubAnnotation =
AnnotationNode.builder()
Expand Down Expand Up @@ -1681,8 +1684,6 @@ private static void createVaporTypes(Service service, TypeStore typeStore) {
ClassNames.getServiceClientClassName(service));
}

// LRO Gapic-generated types.
typeStore.put("com.google.longrunning", "OperationsClient");
// Pagination types.
typeStore.putAll(
service.pakkage(),
Expand Down
Expand Up @@ -470,7 +470,7 @@ private MethodDefinition createRpcTestMethod(
VariableExpr.withVariable(
Variable.builder().setType(methodArg.type()).setName(methodArgName).build());
argExprs.add(varExpr);
Expr valExpr = DefaultValueComposer.createDefaultValue(methodArg, resourceNames);
Expr valExpr = createDefaultValue(methodArg, resourceNames);
methodExprs.add(
AssignmentExpr.builder()
.setVariableExpr(varExpr.toBuilder().setIsDecl(true).build())
Expand Down Expand Up @@ -735,6 +735,9 @@ protected abstract List<Statement> createStreamingRpcExceptionTestStatements(
Map<String, ResourceName> resourceNames,
Map<String, Message> messageTypes);

protected abstract Expr createDefaultValue(
MethodArgument methodArg, Map<String, ResourceName> resourceNames);

protected List<Statement> createRpcExceptionTestStatements(
Method method,
List<MethodArgument> methodSignature,
Expand Down Expand Up @@ -766,7 +769,7 @@ protected List<Statement> createRpcExceptionTestStatements(
VariableExpr.withVariable(
Variable.builder().setType(methodArg.type()).setName(methodArgName).build());
argVarExprs.add(varExpr);
Expr valExpr = DefaultValueComposer.createDefaultValue(methodArg, resourceNames);
Expr valExpr = createDefaultValue(methodArg, resourceNames);
tryBodyExprs.add(
AssignmentExpr.builder()
.setVariableExpr(varExpr.toBuilder().setIsDecl(true).build())
Expand Down