Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata #7015

anuchandy · 2025-04-16T17:59:22Z

The PR introduces structural changes to the ClientMethodMapper - focusing on immutability, separation of concerns and consistency.

The ClientMethodMapper now avoids passing mutable builders, reducing potential for dev errors and improving clarity by eliminating the need to save and restore builder states.
Separate functions were created to handle different types of client method creation (paging, LRO, simple). These functions use immutable inputs, except for the methods array they update, and follow a common pattern for easier understanding.
JavaSettings::PollingDetails has been replaced with PollingSettings, which includes updated JavaDoc and improved readability.
New types have been added to consolidate metadata processing for pageable operations (PagingMetadata) and long-running operations (PollingMetadata). PollingMetadata processes PollingSettings and TypeSpec LRO-Metadata and exposes an immutable MethodPollingDetails view on demand. Similarly, PagingMetadata processes TypeSpec paging information and presents an immutable MethodPagingDetails.
The properties in PollingSettings, PollingMetadata, and MethodPollingDetails have been renamed to use consistent names.
Added JavaDoc to ClientMethodsReturnDescription properties.

github-actions · 2025-04-16T18:01:59Z

No changes needing a change description found.

azure-sdk · 2025-04-16T18:17:30Z

You can try these changes here

🛝 Playground	🌐 Website	🛝 VSCode Extension

anuchandy

This pull request may need to wait for @srnagar pull request if it is expected to be ready soon. Alternatively, the new structure of ClientMethodMapper could be beneficial in terms of simplfying the ClientCoreClientMethodMapper in his pr (if it is in initial scope). I'll let Srikanta decide which option works best based on his plan for that PR.

...c/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java

...e/src/main/java/com/microsoft/typespec/http/client/generator/core/mapper/PagingMetadata.java

...a/com/microsoft/typespec/http/client/generator/core/model/clientmodel/MethodPageDetails.java

.../java/com/microsoft/typespec/http/client/generator/mgmt/mapper/FluentClientMethodMapper.java

...java/com/microsoft/typespec/http/client/generator/core/extension/plugin/PollingSettings.java

...in/java/com/microsoft/typespec/http/client/generator/core/extension/plugin/JavaSettings.java

...c/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java

…tadata for pagable oepration

…ngDetails's

…thod creator functions

…ds(..) and use it

…o a seperate function

…ther similar methods)

…work to extract fluent out of common client-method-mapper

…g pattern as ClientMethodMapper, naming consistency for all create-client-methods functions

…-client-method functions

…ncClientMethods, JavaDoc, var-names)

…g parameter should-hide-check (#7337) This PR has the following changes - 1. Taking advantages of refactoring done in [#7015](#7015) for `ClientMethodMapper` there by deleting the additional code we no longer needed. 2. Centralizing the derivation and lookup of paging parameters to `PagingMetadata` and `MethodPageDetails `. 3. Removing relaxed paging parameter lookup instead using common strict lookup in all places (azure, client-core etc..). The AutoRest CI run is [green](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4878954&view=results) with this PR's last commit [80bf3a9].

…g parameter should-hide-check (microsoft#7337) This PR has the following changes - 1. Taking advantages of refactoring done in [microsoft#7015](microsoft#7015) for `ClientMethodMapper` there by deleting the additional code we no longer needed. 2. Centralizing the derivation and lookup of paging parameters to `PagingMetadata` and `MethodPageDetails `. 3. Removing relaxed paging parameter lookup instead using common strict lookup in all places (azure, client-core etc..). The AutoRest CI run is [green](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4878954&view=results) with this PR's last commit [80bf3a9].

microsoft-github-policy-service bot added the emitter:client:java label Apr 16, 2025

anuchandy force-pushed the immutable-client-method branch 15 times, most recently from 8ad1ea7 to 79c3e7f Compare April 25, 2025 06:35

anuchandy force-pushed the immutable-client-method branch from c33c769 to 8019291 Compare April 27, 2025 19:44

anuchandy self-assigned this Apr 28, 2025

anuchandy changed the title ~~[wip] enable newBuilder for the ClientMethod~~ Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata Apr 28, 2025

anuchandy marked this pull request as ready for review April 28, 2025 02:01

anuchandy requested review from srnagar, weidongxu-microsoft, haolingdong-msft and XiaofeiCao as code owners April 28, 2025 02:01

anuchandy commented Apr 28, 2025

View reviewed changes

...java/com/microsoft/typespec/http/client/generator/core/extension/plugin/PollingSettings.java Show resolved Hide resolved

XiaofeiCao reviewed Apr 28, 2025

View reviewed changes

...in/java/com/microsoft/typespec/http/client/generator/core/extension/plugin/JavaSettings.java Outdated Show resolved Hide resolved

XiaofeiCao reviewed Apr 28, 2025

View reviewed changes

...c/main/java/com/microsoft/typespec/http/client/generator/core/mapper/ClientMethodMapper.java Outdated Show resolved Hide resolved

anuchandy added 19 commits May 7, 2025 12:09

Introducing PollingMetadata class LRO operations (similar to PagingMe…

5165f88

…tadata for pagable oepration

ensure PollingSettings property names are consistent with MethodPolli…

4bed082

…ngDetails's

additional javadoc for PollingMetadata

5736c92

attempt lro condition simplification

f0eafd4

initial attempt to use PollingMetadata

4cd34c3

polishing use of PollingMetadata

4409806

Adding updated lro generated code since the method ordering changed

906665e

Define CreateClientMethodArgs to pass immutable args across client me…

fe3b555

…thod creator functions

move lro-with-response logic to new method createLroWithResponseMetho…

8d836fc

…ds(..) and use it

simplifying createLroWithResponseMethods by moving fluent specifics t…

edcf923

…o a seperate function

simplifying createLroWithResponseMethods to take isSync param (like o…

4c87f1f

…ther similar methods)

java doc, naming consistency

f708998

make lro fluent conditional flow more explicit (will help when we do …

0fca39b

…work to extract fluent out of common client-method-mapper

Ensure FluentClientMethodMapper method creation follow the same codin…

39f44ef

…g pattern as ClientMethodMapper, naming consistency for all create-client-methods functions

consolidate javaDoc setters, aligin paramaters ordering across create…

580ee6a

…-client-method functions

Updating based on first round of code review discussion

c0b1d87

consistent code pattern for method visibility

92a5b38

incorporating review feedback (simplify createFluentLroWithResponseSy…

6a4281e

…ncClientMethods, JavaDoc, var-names)

rebase with upstream/merging corev2 changes

afc912c

anuchandy force-pushed the immutable-client-method branch from fd97b9c to afc912c Compare May 7, 2025 19:28

XiaofeiCao approved these changes May 8, 2025

View reviewed changes

weidongxu-microsoft approved these changes May 8, 2025

View reviewed changes

anuchandy added this pull request to the merge queue May 9, 2025

Merged via the queue into microsoft:main with commit 64258fd May 9, 2025
24 checks passed

anuchandy deleted the immutable-client-method branch May 9, 2025 20:36

srnagar mentioned this pull request May 12, 2025

Update clientcore pageable APIs and enable tests #7304

Merged

anuchandy mentioned this pull request May 13, 2025

Using the ClientMethodMapper extension points and hardening the paging parameter should-hide-check #7337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata #7015

Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata #7015

Uh oh!

anuchandy commented Apr 16, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

azure-sdk commented Apr 16, 2025 •

edited

Loading

Uh oh!

anuchandy left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata #7015

Refactor ClientMethod to Support Immutable Builders and Enhance Polling & Paging Metadata #7015

Uh oh!

Conversation

anuchandy commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Apr 16, 2025

Uh oh!

azure-sdk commented Apr 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

anuchandy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anuchandy commented Apr 16, 2025 •

edited

Loading

azure-sdk commented Apr 16, 2025 •

edited

Loading

anuchandy left a comment •

edited

Loading