Paginated methods returning publisher or iterable implement logic in … #4046

cenedhryn · 2023-05-26T20:56:39Z

…interface instead of throwing unsupported exception

Motivation and Context

For paginated API operations, the service client interfaces contain a version that returns a publisher (async) or iterable (sync). The default implementation of all methods at interface level throws an unsupported exception and is overridden by any implementing client. However, because these operation versions do not truly execute backend calls, they are difficult to handle when you have a delegating client that can intercept API calls. This PR moves the logic of creating a publisher/iterable from the default (base) client to the interface, and removes these paginating method versions from the implementing clients. The refactoring enables delegating clients to provide an instance of themselves to the publisher/iterable constructor, which closes the intercepting loop for delegating clients.

Modifications

Moves the applyPaginatorUserAgent method to a separate class that is referenced by each publisher/iterable
Moves the instance creation of a new publisher/iterable to the sync/async interfaces
Removes any paginator methods that return publisher/iterable from implementing classes.
Refactors the operation logic in client codegen to increase the similarity and therefore the understanding of the code between sync/async and interface/class/abstract class implementations.

…interface instead of throwing unsupported exception

zoewangg · 2023-05-30T20:10:24Z

...rc/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java

+     *      target="_top">AWS API Documentation</a>
+     */
+    default PaginatedOperationWithResultKeyResponse paginatedOperationWithResultKey() throws AwsServiceException,
+                                                                                             SdkClientException, JsonException {


It's odd that we have throws xxx in the signature...

hm, lm check where that came from

It's there in the current code

https://github.com/aws/aws-sdk-java-v2/blob/master/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-json-client-interface.java#L410-L413

Yeah, we should probably remove it, but it's not a blocker since it's not part of this change.

zoewangg · 2023-05-30T20:13:37Z

...gen/src/test/resources/software/amazon/awssdk/codegen/poet/common/test-user-agent-class.java

+import software.amazon.awssdk.core.util.VersionInfo;
+import software.amazon.awssdk.services.json.model.JsonRequest;
+
+@Generated("software.amazon.awssdk:codegen")


@SdkInternal?

+1 forgot that

* Adding a generic method invokeOperation for abstract delegating clien… (#3996) Adding a generic method invokeOperation for abstract delegating client to allow overriding behavior changes for all operations * Add endpointProvider in ClientConfig and RequestOverrideConfig. Also add crossRegionBucketAccess in S3Configuration (#3978) * Add endpointProvider in ClientConfig and RequestOverrideConfig. Also add crossRegionBucketAccess in S3Configuration * updated review comments 1 * updated review comments 2 * Adds S3CrossRegion clients and codegen for retrieving bucket name (#4008) * Adds S3CrossRegion clients and codegen for retrieving bucket name * Removes codegen of bucket parameter since getValueForField() is better * Add back overloads * Adds cross region client logic for decorating endpoint provider (#4026) * Adds cross region client logic for decorating endpoint provider * Paginated methods returning publisher or iterable implement logic in … (#4046) * Paginated methods returning publisher or iterable implement logic in interface instead of throwing unsupported exception * Added internal annotation to class * Wraps s3 client in cross regional client when enabled (#4080) * Wraps s3 client in cross regional client when enabled * Adds composer interface * Add User Agent Api name for Cross region API calls (#4105) * Add User Agent Api name for Cross region API calls * Added test case for default client not to have user agent related to cross region * S3CrossRegion Sync and Async Clients Redirect implementation (#4089) * S3CrossRegionSyncClient Redirect implementation * Added implementation for Async client Decorator * Updated older Cross region test cases * Added paramterized test * Async Exception checged to completableException * Updated test cases and changes the Exception handling when HeadBucket Call fails * Handled Anna-karin's comments * Removed async execution of HeadBucket and attached it to the completableFuture of main request * Handled Zoe's comments * Added test case when Redirected after the Region is cached * Changed region constant to Region Type in Tests * Cross region support for CRT Client (#4129) * Cross region support for CRT Client * removing common class * handled review comments * Integration test cases for Cross region Async and Sync Clients (#4128) * Integration test cases for Cross region Sync and Sync Clients * Renamed files as Integration test * Handled CR comments to take care of retries thus captureInterceptor is removed * rebased and added CRT in Integ test * removed sout from integ * Attach crossRegionAccessEnabled as CustomClientParams to a client Builder, also mention of Composers are renamed as decorators (#4151) * Attach crossRegionAccessEnabled as CustomClientParams to a client Builder, also mention of Composers are renamed as decorators * Removed from S3Configurations * Move the optional parameter in getter --------- Co-authored-by: Anna-Karin Salander <[email protected]>

Paginated methods returning publisher or iterable implement logic in …

e8dbec7

…interface instead of throwing unsupported exception

cenedhryn requested a review from a team as a code owner May 26, 2023 20:56

zoewangg reviewed May 30, 2023

View reviewed changes

Added internal annotation to class

7ed08d6

zoewangg approved these changes Jun 1, 2023

View reviewed changes

cenedhryn merged commit a87b09a into cross_region_bucket_access/project_branch Jun 1, 2023

cenedhryn deleted the salande/cross-region-paginators branch August 15, 2023 15:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Paginated methods returning publisher or iterable implement logic in … #4046

Paginated methods returning publisher or iterable implement logic in … #4046

Uh oh!

cenedhryn commented May 26, 2023 •

edited

Loading

Uh oh!

zoewangg May 30, 2023

Uh oh!

cenedhryn Jun 1, 2023

Uh oh!

cenedhryn Jun 1, 2023

Uh oh!

zoewangg Jun 1, 2023

Uh oh!

zoewangg May 30, 2023

Uh oh!

cenedhryn Jun 1, 2023

Uh oh!

Uh oh!

Paginated methods returning publisher or iterable implement logic in … #4046

Paginated methods returning publisher or iterable implement logic in … #4046

Uh oh!

Conversation

cenedhryn commented May 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Modifications

Uh oh!

zoewangg May 30, 2023

Choose a reason for hiding this comment

Uh oh!

cenedhryn Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

cenedhryn Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

zoewangg Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

zoewangg May 30, 2023

Choose a reason for hiding this comment

Uh oh!

cenedhryn Jun 1, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cenedhryn commented May 26, 2023 •

edited

Loading