Skip to content

[2/3]Implement Paged Callable Method #608

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
summer-ji-eng merged 8 commits into from
Dec 22, 2020
Merged

[2/3]Implement Paged Callable Method #608

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
134e34c
Implemente LRO Operation Callable Method sample code
summer-ji-eng Dec 15, 2020
fd01194
Add todo comment
summer-ji-eng Dec 15, 2020
3a73ee2
Add unit test
summer-ji-eng Dec 17, 2020
6719f88
add comments
summer-ji-eng Dec 17, 2020
b7b7b2e
address the comments
summer-ji-eng Dec 18, 2020
4bc2548
Implement Paged Callable Method
summer-ji-eng Dec 17, 2020
943f746
Add unit tests
summer-ji-eng Dec 18, 2020
d0261b1
Merge branch 'samplecode-master' into paged_callable_method
summer-ji-eng Dec 21, 2020
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
30 changes: 18 additions & 12 deletions src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,8 @@ private static List<MethodDefinition> createServiceMethods(
createLroCallableMethod(service, method, types, messageTypes, resourceNames));
}
if (method.isPaged()) {
javaMethods.add(createPagedCallableMethod(service, method, types));
javaMethods.add(
createPagedCallableMethod(service, method, types, messageTypes, resourceNames));
}
javaMethods.add(createCallableMethod(service, method, types));
}
Expand Down Expand Up @@ -705,16 +706,13 @@ private static MethodDefinition createCallableMethod(
}

private static MethodDefinition createPagedCallableMethod(
Service service, Method method, Map<String, TypeNode> types) {
// TODO(summerji): Implement sample code for paged callable method and pass in actual map of
// Messages and ResourceNames
Service service,
Method method,
Map<String, TypeNode> types,
Map<String, Message> messageTypes,
Map<String, ResourceName> resourceNames) {
return createCallableMethod(
service,
method,
CallableMethodKind.PAGED,
types,
Collections.emptyMap(),
Collections.emptyMap());
service, method, CallableMethodKind.PAGED, types, messageTypes, resourceNames);
}

private static MethodDefinition createCallableMethod(
Expand Down Expand Up @@ -766,8 +764,7 @@ private static MethodDefinition createCallableMethod(
.build();

Optional<String> sampleCode = Optional.empty();
// TODO (summerji): Implement sample code for CallableMethodKind.PAGED and
// CallableMethodKind.REGULAR
// TODO (summerji): Implement sample code for CallableMethodKind.REGULAR
if (callableMethodKind.equals(CallableMethodKind.LRO)) {
sampleCode =
Optional.of(
Expand All @@ -777,6 +774,15 @@ private static MethodDefinition createCallableMethod(
resourceNames,
messageTypes));
}
if (callableMethodKind.equals(CallableMethodKind.PAGED)) {
sampleCode =
Optional.of(
ServiceClientSampleCodeComposer.composePagedCallableMethodHeaderSampleCode(
method,
types.get(ClassNames.getServiceClientClassName(service)),
resourceNames,
messageTypes));
}

return MethodDefinition.builder()
.setHeaderCommentStatements(
Expand Down
116 changes: 116 additions & 0 deletions src/main/java/com/google/api/generator/gapic/composer/ServiceClientSampleCodeComposer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

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

import com.google.api.core.ApiFuture;
import com.google.api.gax.core.FixedCredentialsProvider;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.generator.engine.ast.AssignmentExpr;
Expand Down Expand Up @@ -398,6 +399,121 @@ public static String composeLroCallableMethodHeaderSampleCode(
.build());
}

public static String composePagedCallableMethodHeaderSampleCode(
Method method,
TypeNode clientType,
Map<String, ResourceName> resourceNames,
Map<String, Message> messageTypes) {
VariableExpr clientVarExpr =
VariableExpr.withVariable(
Variable.builder()
.setName(JavaStyle.toLowerCamelCase(clientType.reference().name()))
.setType(clientType)
.build());
// Assign method's request variable with the default value.
VariableExpr requestVarExpr =
VariableExpr.withVariable(
Variable.builder().setName("request").setType(method.inputType()).build());
Message requestMessage = messageTypes.get(method.inputType().reference().simpleName());
Preconditions.checkNotNull(requestMessage);
Expr requestBuilderExpr =
DefaultValueComposer.createSimpleMessageBuilderExpr(
requestMessage, resourceNames, messageTypes);
AssignmentExpr requestAssignmentExpr =
AssignmentExpr.builder()
.setVariableExpr(requestVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(requestBuilderExpr)
.build();

List<Expr> bodyExprs = new ArrayList<>();
bodyExprs.add(requestAssignmentExpr);

// Find the repeated field.
Message methodOutputMessage = messageTypes.get(method.outputType().reference().simpleName());
Field repeatedPagedResultsField = methodOutputMessage.findAndUnwrapFirstRepeatedField();
Preconditions.checkNotNull(
repeatedPagedResultsField,
String.format(
"No repeated field found on message %s for method %s",
methodOutputMessage.name(), method.name()));
TypeNode repeatedResponseType = repeatedPagedResultsField.type();

// Create ApiFuture Variable Expression with assign value by invoking client paged callable
// method.
// e.g. ApiFuture<ListExclusionsPagedResponse> future =
// configServiceV2Client.listExclusionsPagedCallable().futureCall(request);
TypeNode apiFutureType =
TypeNode.withReference(
ConcreteReference.builder()
.setClazz(ApiFuture.class)
.setGenerics(repeatedResponseType.reference())
.build());
VariableExpr apiFutureVarExpr =
VariableExpr.withVariable(
Variable.builder().setName("future").setType(apiFutureType).build());
MethodInvocationExpr pagedCallableFutureMethodExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(clientVarExpr)
.setMethodName(
String.format("%sPagedCallable", JavaStyle.toLowerCamelCase(method.name())))
.build();
pagedCallableFutureMethodExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(pagedCallableFutureMethodExpr)
.setMethodName("futureCall")
.setArguments(requestVarExpr)
.setReturnType(apiFutureType)
.build();
AssignmentExpr apiFutureAssignmentExpr =
AssignmentExpr.builder()
.setVariableExpr(apiFutureVarExpr.toBuilder().setIsDecl(true).build())
.setValueExpr(pagedCallableFutureMethodExpr)
.build();
bodyExprs.add(apiFutureAssignmentExpr);

List<Statement> bodyStatements =
bodyExprs.stream().map(e -> ExprStatement.withExpr(e)).collect(Collectors.toList());
bodyExprs.clear();

// Add line comment
bodyStatements.add(CommentStatement.withComment(LineComment.withComment("Do something.")));

// For-loop on repeated response element
// e.g. for (ListExclusionsResponse element : future.get().iterateAll()) {
// // doThingsWith(element);
// }
VariableExpr repeatedResponseVarExpr =
VariableExpr.withVariable(
Variable.builder().setName("element").setType(repeatedResponseType).build());
MethodInvocationExpr futureGetIterateAllMethodExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(apiFutureVarExpr)
.setMethodName("get")
.build();
futureGetIterateAllMethodExpr =
MethodInvocationExpr.builder()
.setExprReferenceExpr(futureGetIterateAllMethodExpr)
.setMethodName("iterateAll")
.setReturnType(repeatedResponseType)
.build();
CommentStatement lineCommentStatement =
CommentStatement.withComment(LineComment.withComment("doThingsWith(element);"));
ForStatement repeatedResponseForStatement =
ForStatement.builder()
.setLocalVariableExpr(repeatedResponseVarExpr.toBuilder().setIsDecl(true).build())
.setCollectionExpr(futureGetIterateAllMethodExpr)
.setBody(Arrays.asList(lineCommentStatement))
.build();
bodyStatements.add(repeatedResponseForStatement);

return SampleCodeWriter.write(
TryCatchStatement.builder()
.setTryResourceExpr(assignClientVariableWithCreateMethodExpr(clientVarExpr))
.setTryBody(bodyStatements)
.setIsSampleCode(true)
.build());
}

private static List<Statement> composeUnaryRpcMethodSampleCodeBodyStatements(
Method method,
VariableExpr clientVarExpr,
Expand Down
176 changes: 176 additions & 0 deletions ...est/java/com/google/api/generator/gapic/composer/ServiceClientSampleCodeComposerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1505,4 +1505,180 @@ public void validComposeLroCallableMethodHeaderSampleCode_withReturnVoid() {
"}");
assertEquals(results, expected);
}

// ================================Paged Callable Method Sample Code ====================//
@Test
public void validComposePagedCallableMethodHeaderSampleCode() {
FileDescriptor echoFileDescriptor = EchoOuterClass.getDescriptor();
Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
TypeNode clientType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoClient")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode inputType =
TypeNode.withReference(
VaporReference.builder()
.setName("PagedExpandRequest")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode outputType =
TypeNode.withReference(
VaporReference.builder()
.setName("PagedExpandResponse")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
Method method =
Method.builder()
.setName("PagedExpand")
.setInputType(inputType)
.setOutputType(outputType)
.setIsPaged(true)
.build();
String results =
ServiceClientSampleCodeComposer.composePagedCallableMethodHeaderSampleCode(
method, clientType, resourceNames, messageTypes);
String expected =
LineFormatter.lines(
"try (EchoClient echoClient = EchoClient.create()) {\n",
" PagedExpandRequest request =\n",
" PagedExpandRequest.newBuilder()\n",
" .setContent(\"content951530617\")\n",
" .setPageSize(883849137)\n",
" .setPageToken(\"pageToken873572522\")\n",
" .build();\n",
" ApiFuture<EchoResponse> future = echoClient.pagedExpandPagedCallable().futureCall(request);\n",
" // Do something.\n",
" for (EchoResponse element : future.get().iterateAll()) {\n",
" // doThingsWith(element);\n",
" }\n",
"}");
assertEquals(results, expected);
}

@Test
public void invalidComposePagedCallableMethodHeaderSampleCode_inputTypeNotExistInMessage() {
FileDescriptor echoFileDescriptor = EchoOuterClass.getDescriptor();
Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
TypeNode clientType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoClient")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode inputType =
TypeNode.withReference(
VaporReference.builder()
.setName("NotExistRequest")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode outputType =
TypeNode.withReference(
VaporReference.builder()
.setName("PagedExpandResponse")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
Method method =
Method.builder()
.setName("PagedExpand")
.setInputType(inputType)
.setOutputType(outputType)
.setIsPaged(true)
.build();
assertThrows(
NullPointerException.class,
() ->
ServiceClientSampleCodeComposer.composePagedCallableMethodHeaderSampleCode(
method, clientType, resourceNames, messageTypes));
}

@Test
public void invalidComposePagedCallableMethodHeaderSampleCode_noExistMethodResponse() {
FileDescriptor echoFileDescriptor = EchoOuterClass.getDescriptor();
Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
TypeNode clientType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoClient")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode inputType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoRequest")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode outputType =
TypeNode.withReference(
VaporReference.builder()
.setName("NoExistResponse")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
Method method =
Method.builder()
.setName("PagedExpand")
.setInputType(inputType)
.setOutputType(outputType)
.setIsPaged(true)
.build();
assertThrows(
NullPointerException.class,
() ->
ServiceClientSampleCodeComposer.composePagedCallableMethodHeaderSampleCode(
method, clientType, resourceNames, messageTypes));
}

@Test
public void invalidComposePagedCallableMethodHeaderSampleCode_noRepeatedResponse() {
FileDescriptor echoFileDescriptor = EchoOuterClass.getDescriptor();
Map<String, ResourceName> resourceNames = Parser.parseResourceNames(echoFileDescriptor);
Map<String, Message> messageTypes = Parser.parseMessages(echoFileDescriptor);
TypeNode clientType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoClient")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode inputType =
TypeNode.withReference(
VaporReference.builder()
.setName("EchoRequest")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
TypeNode outputType =
TypeNode.withReference(
VaporReference.builder()
.setName("NoRepeatedResponse")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build());
Method method =
Method.builder()
.setName("PagedExpand")
.setInputType(inputType)
.setOutputType(outputType)
.setIsPaged(true)
.build();
Field responseField = Field.builder().setName("response").setType(TypeNode.STRING).build();
Message noRepeatedResponseMessage =
Message.builder()
.setName("NoRepeatedResponse")
.setType(
TypeNode.withReference(
VaporReference.builder()
.setName("NoRepeatedResponse")
.setPakkage(SHOWCASE_PACKAGE_NAME)
.build()))
.setFields(Arrays.asList(responseField))
.build();
messageTypes.put("NoRepeatedResponse", noRepeatedResponseMessage);
assertThrows(
NullPointerException.class,
() ->
ServiceClientSampleCodeComposer.composePagedCallableMethodHeaderSampleCode(
method, clientType, resourceNames, messageTypes));
}
}
Loading