[DO NOT REVIEW][Merged In #573][CloseSoon]Use resource name class to construct String Default value #577
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,208 @@ | ||
| // Copyright 2020 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; | ||
|
|
||
| import com.google.api.generator.engine.ast.AssignmentExpr; | ||
| import com.google.api.generator.engine.ast.ConcreteReference; | ||
| import com.google.api.generator.engine.ast.Expr; | ||
| import com.google.api.generator.engine.ast.ExprStatement; | ||
| import com.google.api.generator.engine.ast.MethodInvocationExpr; | ||
| import com.google.api.generator.engine.ast.TryCatchStatement; | ||
| import com.google.api.generator.engine.ast.TypeNode; | ||
| import com.google.api.generator.engine.ast.Variable; | ||
| import com.google.api.generator.engine.ast.VariableExpr; | ||
| import com.google.api.generator.gapic.model.Method; | ||
| import com.google.api.generator.gapic.model.MethodArgument; | ||
| import com.google.api.generator.gapic.model.ResourceName; | ||
| import com.google.api.generator.gapic.utils.JavaStyle; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| public class MethodSampleCodeHelperComposer { | ||
| private static String RESPONSE = "response"; | ||
|
|
||
| public static TryCatchStatement composeUnaryRpcMethodSampleCode( | ||
| Method method, | ||
| List<MethodArgument> arguments, | ||
| TypeNode clientType, | ||
| Map<String, ResourceName> resourceNames) { | ||
| VariableExpr clientVarExpr = createVariableExpr(getClientName(clientType), clientType); | ||
| // Assign each method arguments with its default value. | ||
| Map<String, VariableExpr> methodArgVarExprMap = createMethodArgumentsVariableExprs(arguments); | ||
| List<Expr> methodArgumentsAssignmentExpr = | ||
| assignMethodArgumentsWithDefaultValues(arguments, methodArgVarExprMap, resourceNames); | ||
| List<Expr> methodVarExprs = | ||
| createMethodArgVarExprs(arguments, methodArgVarExprMap, resourceNames); | ||
|
There was a problem hiding this comment. PTAL at my comments on splitting out the VarExprs in #573. |
||
| // Invoke current method based on return type. | ||
| // e.g. if return void, echoClient.echo(..); or, | ||
| // e.g. if return other type, EchoResponse response = echoClient.echo(...); | ||
| boolean returnsVoid = isProtoEmptyType(method.outputType()); | ||
| Expr responseExpr = null; | ||
| if (returnsVoid) { | ||
| responseExpr = | ||
| MethodInvocationExpr.builder() | ||
| .setExprReferenceExpr(clientVarExpr) | ||
| .setMethodName(JavaStyle.toLowerCamelCase(method.name())) | ||
| .setArguments(methodVarExprs) | ||
| .setReturnType(clientType) | ||
| .build(); | ||
| } else { | ||
| responseExpr = | ||
| createAssignExprForVariableWithClientMethod( | ||
| createVariableExpr(RESPONSE, method.outputType()), | ||
| clientVarExpr, | ||
| JavaStyle.toLowerCamelCase(method.name()), | ||
| methodVarExprs); | ||
| } | ||
|
|
||
| List<Expr> bodyExpr = new ArrayList<>(); | ||
| bodyExpr.addAll(methodArgumentsAssignmentExpr); | ||
| bodyExpr.add(responseExpr); | ||
|
|
||
| return TryCatchStatement.builder() | ||
| .setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientVarExpr)) | ||
| .setTryBody( | ||
| bodyExpr.stream().map(e -> ExprStatement.withExpr(e)).collect(Collectors.toList())) | ||
| .setIsSampleCode(true) | ||
| .build(); | ||
| } | ||
|
|
||
| // ==================================Helpers===================================================// | ||
|
|
||
| // Assign client variable expr with create client. | ||
| // e.g EchoClient echoClient = EchoClient.create() | ||
| private static AssignmentExpr assignClientVariableWithCreateMethodExpr( | ||
| VariableExpr clientVarExpr) { | ||
| return AssignmentExpr.builder() | ||
| .setVariableExpr(clientVarExpr.toBuilder().setIsDecl(true).build()) | ||
| .setValueExpr( | ||
| MethodInvocationExpr.builder() | ||
| .setStaticReferenceType(clientVarExpr.variable().type()) | ||
| .setReturnType(clientVarExpr.variable().type()) | ||
| .setMethodName("create") | ||
| .build()) | ||
| .build(); | ||
| } | ||
|
|
||
| // Create a Map where key is method's argument name, and value is its VariableExpr. | ||
| private static Map<String, VariableExpr> createMethodArgumentsVariableExprs( | ||
| List<MethodArgument> arguments) { | ||
| return arguments.stream() | ||
| .collect( | ||
| Collectors.toMap( | ||
| methodArg -> methodArg.name(), | ||
| methodArg -> | ||
| createVariableExpr( | ||
| JavaStyle.toLowerCamelCase(methodArg.name()), methodArg.type()))); | ||
| } | ||
|
|
||
| // Return a list of AssignmentExpr for method argument with its default value. | ||
| private static List<Expr> assignMethodArgumentsWithDefaultValues( | ||
| List<MethodArgument> arguments, | ||
| Map<String, VariableExpr> argVarExprs, | ||
| Map<String, ResourceName> resourceNames) { | ||
| List<ResourceName> resourceNameList = resourceNames.values().stream().collect(Collectors.toList()); | ||
| return arguments.stream() | ||
| .map( | ||
| arg -> { | ||
| Expr defaultValueExpr = | ||
| DefaultValueComposer.createDefaultValue(arg, resourceNames, false); | ||
| if (!arg.isResourceNameHelper() && arg.type().equals(TypeNode.STRING) && arg.field().hasResourceReference() && resourceNames.containsKey(arg.field().resourceReference().resourceTypeString())) { | ||
| ResourceName resourceName = | ||
| resourceNames.get(arg.field().resourceReference().resourceTypeString()); | ||
| defaultValueExpr = DefaultValueComposer.createDefaultValue(resourceName, resourceNameList, arg.field().name()); | ||
| } | ||
| VariableExpr argVarExpr = | ||
| (arg.field().hasResourceReference() && !arg.isResourceNameHelper()) | ||
| ? getMethodArgumentResourceReferenceVariableExpr(arg, defaultValueExpr) | ||
| : argVarExprs.get(arg.name()); | ||
| return createAssignmentExpr(argVarExpr, defaultValueExpr); | ||
| }) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| private static VariableExpr getMethodArgumentResourceReferenceVariableExpr( | ||
| MethodArgument methodArg, Expr defaultValueExpr) { | ||
| TypeNode resourceReferenceType = | ||
| methodArg.field().resourceReference().isChildType() | ||
| ? TypeNode.withReference( | ||
| ConcreteReference.withClazz(com.google.api.resourcenames.ResourceName.class)) | ||
| : defaultValueExpr.type(); | ||
| return createVariableExpr(JavaStyle.toLowerCamelCase(methodArg.name()), resourceReferenceType); | ||
| } | ||
|
|
||
| private static List<Expr> createMethodArgVarExprs( | ||
| List<MethodArgument> arguments, | ||
| Map<String, VariableExpr> methodArgVarExprMap, | ||
| Map<String, ResourceName> resourceNames) { | ||
| return arguments.stream() | ||
| .map( | ||
| arg -> { | ||
| if (!arg.isResourceNameHelper() | ||
| && arg.field().hasResourceReference() | ||
| && resourceNames.containsKey( | ||
| arg.field().resourceReference().resourceTypeString())) { | ||
| return MethodInvocationExpr.builder() | ||
| .setExprReferenceExpr(methodArgVarExprMap.get(arg.name())) | ||
| .setMethodName("toString") | ||
| .build(); | ||
| } | ||
| return methodArgVarExprMap.get(arg.name()); | ||
| }) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| private static Expr createAssignExprForVariableWithClientMethod( | ||
| VariableExpr variableExpr, | ||
| VariableExpr clientVarExpr, | ||
| String methodName, | ||
| List<Expr> argumentsVarExprs) { | ||
| MethodInvocationExpr clientMethodInvocationExpr = | ||
| MethodInvocationExpr.builder() | ||
| .setExprReferenceExpr(clientVarExpr) | ||
| .setMethodName(JavaStyle.toLowerCamelCase(methodName)) | ||
| .setArguments(argumentsVarExprs) | ||
| .setReturnType(variableExpr.variable().type()) | ||
| .build(); | ||
| return AssignmentExpr.builder() | ||
| .setVariableExpr(variableExpr.toBuilder().setIsDecl(true).build()) | ||
| .setValueExpr(clientMethodInvocationExpr) | ||
| .build(); | ||
| } | ||
|
|
||
| private static String getClientName(TypeNode clientType) { | ||
| return JavaStyle.toLowerCamelCase(clientType.reference().name()); | ||
| } | ||
|
|
||
| private static boolean isProtoEmptyType(TypeNode type) { | ||
| return type.reference().pakkage().equals("com.google.protobuf") | ||
| && type.reference().name().equals("Empty"); | ||
| } | ||
|
|
||
| private static AssignmentExpr createAssignmentExpr(VariableExpr variableExpr, Expr valueExpr) { | ||
| return AssignmentExpr.builder() | ||
| .setVariableExpr(variableExpr.toBuilder().setIsDecl(true).build()) | ||
| .setValueExpr(valueExpr) | ||
| .build(); | ||
| } | ||
|
|
||
| private static VariableExpr createVariableExpr(String variableName, TypeNode type) { | ||
| return VariableExpr.builder() | ||
| .setVariable(Variable.builder().setName(variableName).setType(type).build()) | ||
| .build(); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was the motivation for using the boxed type?