Skip to content

support pagination with 1st page LRO #652

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
weidongxu-microsoft merged 2 commits into from
Jul 13, 2020
Merged

support pagination with 1st page LRO #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9da8b2
support pagination with 1st page LRO
weidongxu-microsoft Jul 10, 2020
fadf469
fix bug
weidongxu-microsoft Jul 10, 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
17 changes: 8 additions & 9 deletions fluent-tests/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,6 @@
<artifactId>fluent-tests</artifactId>
<version>1.0.0-SNAPSHOT</version>

<repositories>
<repository>
<id>azuresdkmaven</id>
<url>https://azuresdkmaven.blob.core.windows.net/snapshot/m2</url>
</repository>
</repositories>

<profiles>
<profile>
<id>local</id>
Expand Down Expand Up @@ -64,13 +57,13 @@
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-management</artifactId>
<version>1.0.0-beta.8-SNAPSHOT</version>
<version>1.0.0-beta.2</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-http-netty</artifactId>
<version>1.5.1</version>
<version>1.5.2</version>
<scope>test</scope>
</dependency>
<dependency>
Expand All @@ -85,6 +78,12 @@
<version>5.6.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.7.30</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion ...ests/src/main/java/com/azure/resourcemanager/resources/fluentcore/AzureServiceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public <T, U> PollerFlux<PollResult<T>, U> getLroResultAsync(Mono<Response<Flux<
httpPipeline,
pollResultType,
finalResultType,
Duration.ofSeconds(30),
Duration.ofSeconds(3),
lroInit);
}

Expand Down
129 changes: 103 additions & 26 deletions fluentgen/src/main/java/com/azure/autorest/fluent/template/FluentClientMethodTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ public static FluentClientMethodTemplate getInstance() {
protected void generatePagedAsyncSinglePage(ClientMethod clientMethod, JavaType typeBlock, ProxyMethod restAPIMethod, JavaSettings settings) {
boolean addContextParameter = settings.getAddContextParameter() && !(settings.isContextClientMethodParameter() && contextInParameters(clientMethod));
boolean mergeContextParameter = settings.getAddContextParameter() && (settings.isContextClientMethodParameter() && contextInParameters(clientMethod));
boolean isLroPagination = GenericType.Mono(GenericType.Response(GenericType.FluxByteBuffer)).equals(restAPIMethod.getReturnType().getClientType());
String endOfLine = addContextParameter ? "" : ";";

typeBlock.annotation("ServiceMethod(returns = ReturnType.SINGLE)");
Expand All @@ -43,11 +44,35 @@ protected void generatePagedAsyncSinglePage(ClientMethod clientMethod, JavaType
function.line(String.format("context = %s.mergeContext(context);", clientMethod.getClientReference()));
}
if (addContextParameter) {
function.line(String.format("return FluxUtil.withContext(context -> %s)",
serviceMethodCall));
if (!isLroPagination) {
function.line(String.format("return FluxUtil.withContext(context -> %s)",
serviceMethodCall));
} else {
function.line("return FluxUtil.withContext(context -> {");
function.indent(() -> {
function.line(String.format("%s mono = %s.cache();",
clientMethod.getProxyMethod().getReturnType().toString(),
serviceMethodCall));

IType classType = clientMethod.getMethodPageDetails().getLroIntermediateType();
function.line(String.format("return Mono.zip(mono, %s.<%s, %s>getLroResultAsync(mono, %s.getHttpPipeline(), %s.class, %s.class).last().flatMap(%s::getLroFinalResultOrError));",
clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference()));
});
function.line("})");
}
} else {
function.line(String.format("return %s",
serviceMethodCall));
if (!isLroPagination) {
function.line(String.format("return %s",
serviceMethodCall));
} else {
function.line(String.format("%s mono = %s.cache();",
clientMethod.getProxyMethod().getReturnType().toString(),
serviceMethodCall));

IType classType = clientMethod.getMethodPageDetails().getLroIntermediateType();
function.line(String.format("return Mono.zip(mono, %s.<%s, %s>getLroResultAsync(mono, %s.getHttpPipeline(), %s.class, %s.class).last().flatMap(%s::getLroFinalResultOrError))",
clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference()));
}
}
function.indent(() -> {
if (addContextParameter) {
Expand All @@ -57,16 +82,30 @@ protected void generatePagedAsyncSinglePage(ClientMethod clientMethod, JavaType
function.line(".map(res -> new PagedResponseBase<>(");
}
function.indent(() -> {
function.line("res.getRequest(),");
function.line("res.getStatusCode(),");
function.line("res.getHeaders(),");
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getNextLinkName()));
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getDeserializedHeaders()))%s", endOfLine));
if (!isLroPagination) {
function.line("res.getRequest(),");
function.line("res.getStatusCode(),");
function.line("res.getHeaders(),");
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getNextLinkName()));
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getDeserializedHeaders()))%s", endOfLine));
} else {
function.line(String.format("null))%s", endOfLine));
}
} else {
function.line(String.format("null))%s", endOfLine));
function.line("res.getT1().getRequest(),");
function.line("res.getT1().getStatusCode(),");
function.line("res.getT1().getHeaders(),");
function.line("res.getT2().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("res.getT2().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getNextLinkName()));
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getT2().getDeserializedHeaders()))%s", endOfLine));
} else {
function.line(String.format("null))%s", endOfLine));
}
}
});
if (addContextParameter) {
Expand All @@ -84,11 +123,35 @@ protected void generatePagedAsyncSinglePage(ClientMethod clientMethod, JavaType
function.line(String.format("context = %s.mergeContext(context);", clientMethod.getClientReference()));
}
if (addContextParameter) {
function.line(String.format("return FluxUtil.withContext(context -> %s)",
serviceMethodCall));
if (!isLroPagination) {
function.line(String.format("return FluxUtil.withContext(context -> %s)",
serviceMethodCall));
} else {
function.line("return FluxUtil.withContext(context -> {");
function.indent(() -> {
function.line(String.format("%s mono = %s.cache();",
clientMethod.getProxyMethod().getReturnType().toString(),
serviceMethodCall));

IType classType = clientMethod.getMethodPageDetails().getLroIntermediateType();
function.line(String.format("return Mono.zip(mono, %s.<%s, %s>getLroResultAsync(mono, %s.getHttpPipeline(), %s.class, %s.class).last().flatMap(%s::getLroFinalResultOrError));",
clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference()));
});
function.line("})");
}
} else {
function.line(String.format("return %s",
serviceMethodCall));
if (!isLroPagination) {
function.line(String.format("return %s",
serviceMethodCall));
} else {
function.line(String.format("%s mono = %s.cache();",
clientMethod.getProxyMethod().getReturnType().toString(),
serviceMethodCall));

IType classType = clientMethod.getMethodPageDetails().getLroIntermediateType();
function.line(String.format("return Mono.zip(mono, %s.<%s, %s>getLroResultAsync(mono, %s.getHttpPipeline(), %s.class, %s.class).last().flatMap(%s::getLroFinalResultOrError))",
clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference(), classType.toString(), classType.toString(), clientMethod.getClientReference()));
}
}
function.indent(() -> {
if (addContextParameter) {
Expand All @@ -98,16 +161,30 @@ protected void generatePagedAsyncSinglePage(ClientMethod clientMethod, JavaType
function.line(".map(res -> new PagedResponseBase<>(");
}
function.indent(() -> {
function.line("res.getRequest(),");
function.line("res.getStatusCode(),");
function.line("res.getHeaders(),");
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("null,");
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getDeserializedHeaders()))%s", endOfLine));
if (!isLroPagination) {
function.line("res.getRequest(),");
function.line("res.getStatusCode(),");
function.line("res.getHeaders(),");
function.line("res.getValue().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("null,");
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getDeserializedHeaders()))%s", endOfLine));
} else {
function.line(String.format("null))%s", endOfLine));
}
} else {
function.line(String.format("null))%s", endOfLine));
function.line("res.getT1().getRequest(),");
function.line("res.getT1().getStatusCode(),");
function.line("res.getT1().getHeaders(),");
function.line("res.getT2().%s(),", CodeNamer.getModelNamer().modelPropertyGetterName(clientMethod.getMethodPageDetails().getItemName()));
function.line("null,");
IType responseType = ((GenericType) clientMethod.getProxyMethod().getReturnType()).getTypeArguments()[0];
if (responseType instanceof ClassType) {
function.line(String.format("res.getT2().getDeserializedHeaders()))%s", endOfLine));
} else {
function.line(String.format("null))%s", endOfLine));
}
}
});
if (addContextParameter) {
Expand Down
2 changes: 1 addition & 1 deletion fluentnamer/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-simple</artifactId>
<version>1.7.28</version>
<version>1.7.30</version>
</dependency>
</dependencies>

Expand Down
8 changes: 0 additions & 8 deletions fluentnamer/src/main/java/com/azure/autorest/fluent/transformer/FluentTransformer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ public FluentTransformer(FluentJavaSettings fluentJavaSettings) {
}

public CodeModel preTransform(CodeModel codeModel) {
codeModel = removePagingLRO(codeModel);
if (fluentJavaSettings.getNameForUngroupedOperations().isPresent()) {
codeModel = renameUngroupedOperationGroup(codeModel, fluentJavaSettings.getNameForUngroupedOperations().get());
}
Expand All @@ -52,13 +51,6 @@ public CodeModel postTransform(CodeModel codeModel) {
return codeModel;
}

public CodeModel removePagingLRO(CodeModel codeModel) {
codeModel.getOperationGroups().stream().flatMap(og -> og.getOperations().stream())
.filter(o -> hasLongRunningOperationExtension(o) && hasPaging(o))
.forEach(o -> o.getExtensions().setXmsPageable(null));
return codeModel;
}

public CodeModel renameUngroupedOperationGroup(CodeModel codeModel, String nameForUngroupOperations) {
codeModel.getOperationGroups().stream()
.filter(og -> Utils.getDefaultName(og) == null || Utils.getDefaultName(og).isEmpty())
Expand Down
8 changes: 7 additions & 1 deletion javagen/src/main/java/com/azure/autorest/mapper/ClientMethodMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,11 +185,17 @@ public List<ClientMethod> map(Operation operation) {
if (pageableItemName != null) {
boolean isNextMethod = operation.getExtensions().getXmsPageable().getNextOperation() == operation;

IType lroIntermediateType = null;
if (operation.getExtensions().isXmsLongRunningOperation() && !isNextMethod) {
lroIntermediateType = SchemaUtil.getOperationResponseType(operation);
}

MethodPageDetails details = new MethodPageDetails(
CodeNamer.getPropertyName(operation.getExtensions().getXmsPageable().getNextLinkName()),
pageableItemName,
(isNextMethod || operation.getExtensions().getXmsPageable().getNextOperation() == null) ? null : Mappers.getClientMethodMapper().map(operation.getExtensions().getXmsPageable().getNextOperation())
.stream().findFirst().get());
.stream().findFirst().get(),
lroIntermediateType);
builder.methodPageDetails(details);

if (!(!settings.getRequiredParameterClientMethods() && settings.isContextClientMethodParameter()
Expand Down
3 changes: 2 additions & 1 deletion javagen/src/main/java/com/azure/autorest/mapper/ProxyMethodMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ public Map<Request, ProxyMethod> map(Operation operation) {
IType responseBodyType = SchemaUtil.getOperationResponseType(operation);

IType returnType;
if (operation.getExtensions() != null && operation.getExtensions().isXmsLongRunningOperation() && settings.isFluent()) {
if (operation.getExtensions() != null && operation.getExtensions().isXmsLongRunningOperation() && settings.isFluent()
&& (operation.getExtensions().getXmsPageable() == null || !(operation.getExtensions().getXmsPageable().getNextOperation() == operation))) {
returnType = GenericType.Response(GenericType.FluxByteBuffer); // raw response for LRO
builder.returnType(GenericType.Mono(returnType));
} else if (operation.getResponses().stream().anyMatch(r -> Boolean.TRUE.equals(r.getBinary()))) {
Expand Down
13 changes: 11 additions & 2 deletions javagen/src/main/java/com/azure/autorest/model/clientmodel/MethodPageDetails.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,15 @@ public class MethodPageDetails {
private String itemName;
private ClientMethod nextMethod;

public MethodPageDetails(String nextLinkName, String itemName, ClientMethod nextMethod) {
// Proxy method return type is Flux<ByteBuffer>. Client method return type is PagedResponse<>.
// This intermediate type is the type of pagination response (the type with values and nextLink).
private IType lroIntermediateType;

public MethodPageDetails(String nextLinkName, String itemName, ClientMethod nextMethod, IType lroIntermediateType) {
this.nextLinkName = nextLinkName;
this.itemName = itemName;
this.nextMethod = nextMethod;
this.lroIntermediateType = lroIntermediateType;
}

public String getNextLinkName() {
Expand All @@ -29,10 +34,14 @@ public String getItemName() {
return itemName;
}

public final ClientMethod getNextMethod() {
public ClientMethod getNextMethod() {
return nextMethod;
}

public IType getLroIntermediateType() {
return lroIntermediateType;
}

public boolean nonNullNextLink() {
return nextLinkName != null && !nextLinkName.isEmpty();
}
Expand Down
2 changes: 1 addition & 1 deletion javagen/src/main/java/com/azure/autorest/template/ClientMethodTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ public final void write(ClientMethod clientMethod, JavaType typeBlock) {
typeBlock.publicMethod(clientMethod.getDeclaration(), function -> {
AddOptionalVariables(function, clientMethod, restAPIMethod.getParameters(), settings);
if (clientMethod.getReturnValue().getType() == ClassType.InputStream) {
function.line("Iterator<ByteBufferBackedInputStream> iterator = %s(%S).map(ByteBufferBackedInputStream::new).toStream().iterator();",
function.line("Iterator<ByteBufferBackedInputStream> iterator = %s(%s).map(ByteBufferBackedInputStream::new).toStream().iterator();",
Copy link
Member Author

@weidongxu-microsoft weidongxu-microsoft Jul 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unrelated bug fix

clientMethod.getSimpleAsyncMethodName(), clientMethod.getArgumentList());
function.anonymousClass("Enumeration<InputStream>", "enumeration", javaBlock -> {
javaBlock.annotation("Override");
Expand Down