Skip to content

http-client-java, bug fix on paged response #8078

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 4 commits into from
Aug 1, 2025
Merged

http-client-java, bug fix on paged response #8078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a90448
test case for the bug
weidongxu-microsoft Aug 1, 2025
4ef87a0
do not use Response class, if the method is pageable
weidongxu-microsoft Aug 1, 2025
e89fd88
fix inconsistent npm package ref
weidongxu-microsoft Aug 1, 2025
70f48b3
regen
weidongxu-microsoft Aug 1, 2025
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
4 changes: 2 additions & 2 deletions packages/http-client-java/generator/http-client-generator-clientcore-test/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
"@typespec/streams": "0.72.1",
"@azure-tools/typespec-azure-core": "0.58.0",
"@azure-tools/typespec-client-generator-core": "0.58.0",
"@azure-tools/typespec-azure-resource-manager": "0.58.0",
"@azure-tools/typespec-autorest": "0.58.0"
"@azure-tools/typespec-azure-resource-manager": "0.58.1",
"@azure-tools/typespec-autorest": "0.58.1"
},
"private": true
}
3 changes: 2 additions & 1 deletion ...core/src/main/java/com/microsoft/typespec/http/client/generator/core/util/SchemaUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,9 +178,10 @@ public static String getDiscriminatorSerializedName(ObjectSchema compositeType)
* @return whether response of the operation contains headers
*/
public static boolean responseContainsHeaderSchemas(Operation operation, JavaSettings settings) {
if (operation.isLro() && (settings.isFluent() || settings.isDataPlaneClient())) {
if ((operation.isLro() || operation.isPageable()) && (settings.isFluent() || settings.isDataPlaneClient())) {
// Response headers will be omitted, as LRO method has return type as SyncPoller or PollerFlux, not
// Response.
// Same for pageable methods, as they return PagedFlux or PagedIterable. And PagedResponse contains headers.
return false;
}
return operation.hasHeaderSchemaResponse();
Expand Down
6 changes: 3 additions & 3 deletions ...test/src/main/java/tsptest/armresourceprovider/fluent/ChildResourcesInterfacesClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ SyncPoller<PollResult<Void>, Void> beginDelete(String resourceGroupName, String
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedFlux}.
* @return paged collection of ChildResource items as paginated response with {@link PagedFlux}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedFlux<ChildResourceInner> listByTopLevelArmResourceAsync(String resourceGroupName,
Expand All @@ -388,7 +388,7 @@ PagedFlux<ChildResourceInner> listByTopLevelArmResourceAsync(String resourceGrou
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resourceGroupName,
Expand All @@ -403,7 +403,7 @@ PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resourceGroup
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resourceGroupName,
Expand Down
22 changes: 11 additions & 11 deletions ...n/java/tsptest/armresourceprovider/implementation/ChildResourcesInterfacesClientImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -996,8 +996,8 @@ public void delete(String resourceGroupName, String topLevelArmResourceName, Str
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse} on successful completion
* of {@link Mono}.
* @return paged collection of ChildResource items along with {@link PagedResponse} on successful completion of
* {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private Mono<PagedResponse<ChildResourceInner>> listByTopLevelArmResourceSinglePageAsync(String resourceGroupName,
Expand Down Expand Up @@ -1036,7 +1036,7 @@ private Mono<PagedResponse<ChildResourceInner>> listByTopLevelArmResourceSingleP
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedFlux}.
* @return paged collection of ChildResource items as paginated response with {@link PagedFlux}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
public PagedFlux<ChildResourceInner> listByTopLevelArmResourceAsync(String resourceGroupName,
Expand All @@ -1054,7 +1054,7 @@ public PagedFlux<ChildResourceInner> listByTopLevelArmResourceAsync(String resou
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse}.
* @return paged collection of ChildResource items along with {@link PagedResponse}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private PagedResponse<ChildResourceInner> listByTopLevelArmResourceSinglePage(String resourceGroupName,
Expand Down Expand Up @@ -1094,7 +1094,7 @@ private PagedResponse<ChildResourceInner> listByTopLevelArmResourceSinglePage(St
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse}.
* @return paged collection of ChildResource items along with {@link PagedResponse}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private PagedResponse<ChildResourceInner> listByTopLevelArmResourceSinglePage(String resourceGroupName,
Expand Down Expand Up @@ -1133,7 +1133,7 @@ private PagedResponse<ChildResourceInner> listByTopLevelArmResourceSinglePage(St
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
public PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resourceGroupName,
Expand All @@ -1152,7 +1152,7 @@ public PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resour
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
@ServiceMethod(returns = ReturnType.COLLECTION)
public PagedIterable<ChildResourceInner> listByTopLevelArmResource(String resourceGroupName,
Expand Down Expand Up @@ -1405,8 +1405,8 @@ public void actionWithoutBody(String resourceGroupName, String topLevelArmResour
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse} on successful completion
* of {@link Mono}.
* @return paged collection of ChildResource items along with {@link PagedResponse} on successful completion of
* {@link Mono}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private Mono<PagedResponse<ChildResourceInner>> listByTopLevelArmResourceNextSinglePageAsync(String nextLink) {
Expand All @@ -1433,7 +1433,7 @@ private Mono<PagedResponse<ChildResourceInner>> listByTopLevelArmResourceNextSin
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse}.
* @return paged collection of ChildResource items along with {@link PagedResponse}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private PagedResponse<ChildResourceInner> listByTopLevelArmResourceNextSinglePage(String nextLink) {
Expand Down Expand Up @@ -1461,7 +1461,7 @@ private PagedResponse<ChildResourceInner> listByTopLevelArmResourceNextSinglePag
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation along with {@link PagedResponse}.
* @return paged collection of ChildResource items along with {@link PagedResponse}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
private PagedResponse<ChildResourceInner> listByTopLevelArmResourceNextSinglePage(String nextLink,
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/tsptest/armresourceprovider/implementation/models/ChildResourceListResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
import tsptest.armresourceprovider.fluent.models.ChildResourceInner;

/**
* The response of a ChildResource list operation.
* Paged collection of ChildResource items.
*/
@Immutable
public final class ChildResourceListResult implements JsonSerializable<ChildResourceListResult> {
Expand Down
4 changes: 2 additions & 2 deletions ...rator-test/src/main/java/tsptest/armresourceprovider/models/ChildResourcesInterfaces.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Response<ChildResource> getWithResponse(String resourceGroupName, String topLeve
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
PagedIterable<ChildResource> listByTopLevelArmResource(String resourceGroupName, String topLevelArmResourceName);

Expand All @@ -86,7 +86,7 @@ Response<ChildResource> getWithResponse(String resourceGroupName, String topLeve
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the response of a ChildResource list operation as paginated response with {@link PagedIterable}.
* @return paged collection of ChildResource items as paginated response with {@link PagedIterable}.
*/
PagedIterable<ChildResource> listByTopLevelArmResource(String resourceGroupName, String topLevelArmResourceName,
Context context);
Expand Down
2 changes: 1 addition & 1 deletion ...rces/META-INF/azure-resourcemanager-armresourceprovider-generated_apiview_properties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
"tsptest.armresourceprovider.fluent.models.TopLevelArmResourceUpdateProperties": "Azure.ResourceManager.Foundations.ResourceUpdateModelProperties",
"tsptest.armresourceprovider.implementation.ArmClientBuilder": "TspTest.ArmResourceProvider",
"tsptest.armresourceprovider.implementation.models.ChildExtensionResourceListResult": "Azure.ResourceManager.ResourceListResult",
"tsptest.armresourceprovider.implementation.models.ChildResourceListResult": "Azure.ResourceManager.ResourceListResult",
"tsptest.armresourceprovider.implementation.models.ChildResourceListResult": "TspTest.ArmResourceProvider.ChildResourceListResult",
"tsptest.armresourceprovider.implementation.models.OperationListResult": "Azure.ResourceManager.CommonTypes.OperationListResult",
"tsptest.armresourceprovider.implementation.models.ResourceListResult": "Azure.ResourceManager.ResourceListResult",
"tsptest.armresourceprovider.models.ActionType": "Azure.ResourceManager.CommonTypes.ActionType",
Expand Down
2 changes: 1 addition & 1 deletion ...main/resources/META-INF/azure-resourcemanager-armresourceprovider-generated_metadata.json
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion packages/http-client-java/generator/http-client-generator-test/tsp/arm.tsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,11 +264,18 @@ model NginxConfigurationRequest {
rootFile?: string;
}

model ChildResourceListResult is Azure.Core.Page<ChildResource>;

//----------------------- Paths -----------------------
@armResourceOperations
interface ChildResourcesInterface
extends ResourceInstanceOperations<ChildResource, ChildResourceProperties> {
listByTopLevelArmResource is ArmResourceListByParent<ChildResource>;
listByTopLevelArmResource is ArmResourceListByParent<
ChildResource,
Response = ArmResponse<ChildResourceListResult & {
@header("ETag") eTag: string;
}>
>;
actionWithoutBody is ArmResourceActionAsync<ChildResource, void, void>;
}

Expand Down
2 changes: 1 addition & 1 deletion packages/http-client-java/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/http-client-java/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"generator/http-client-generator/target/classes/PerfAutomation.jfc"
],
"peerDependencies": {
"@azure-tools/typespec-autorest": ">=0.58.0 <1.0.0",
"@azure-tools/typespec-autorest": ">=0.58.1 <1.0.0",
"@azure-tools/typespec-azure-core": ">=0.58.0 <1.0.0",
"@azure-tools/typespec-client-generator-core": ">=0.58.0 <1.0.0",
"@typespec/compiler": "^1.2.1",
Expand Down
Loading