Renaming call chain methods to spell out intent clearly (#246)

dchakrav-github · diwakar · web-flow · commit a00e957d1d54 · 2020-04-22T13:27:14.000-07:00
Co-authored-by: diwakar &lt;diwakar@amazon.com&gt;
diff --git a/src/main/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxy.java b/src/main/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxy.java
@@ -223,19 +223,20 @@ class CallContext<ClientT, ModelT, CallbackT extends StdCallbackContext>
         }
 
         @Override
-        public <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> translate(Function<ModelT, RequestT> maker) {
+        public <
+            RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> translateToServiceRequest(Function<ModelT, RequestT> maker) {
             return new Caller<RequestT, ClientT, ModelT, CallbackT>() {
 
                 @Override
-                public Caller<RequestT, ClientT, ModelT, CallbackT> backoff(Delay delay) {
+                public Caller<RequestT, ClientT, ModelT, CallbackT> backoffDelay(Delay delay) {
                     CallContext.this.delay = delay;
                     return this;
                 }
 
                 @Override
                 public <ResponseT>
                     Stabilizer<RequestT, ResponseT, ClientT, ModelT, CallbackT>
-                    call(BiFunction<RequestT, ProxyClient<ClientT>, ResponseT> caller) {
+                    makeServiceCall(BiFunction<RequestT, ProxyClient<ClientT>, ResponseT> caller) {
                     return new Stabilizer<RequestT, ResponseT, ClientT, ModelT, CallbackT>() {
 
                         private Callback<RequestT, ResponseT, ClientT, ModelT, CallbackT, Boolean> waitFor;
diff --git a/src/main/java/software/amazon/cloudformation/proxy/CallChain.java b/src/main/java/software/amazon/cloudformation/proxy/CallChain.java
@@ -31,8 +31,8 @@
  *
  * <ol>
  * <li>{@link CallChain#initiate(String, ProxyClient, Object, StdCallbackContext)}
- * <li>{@link RequestMaker#translate(Function)}
- * <li>{@link Caller#call(BiFunction)}
+ * <li>{@link RequestMaker#translateToServiceRequest(Function)}
+ * <li>{@link Caller#makeServiceCall(BiFunction)}
  * <li>{@link Completed#done(Function)}
  * </ol>
  *
@@ -144,7 +144,7 @@ interface Initiator<ClientT, ModelT, CallbackT extends StdCallbackContext> {
      */
     interface RequestMaker<ClientT, ModelT, CallbackT extends StdCallbackContext> {
         /**
-         * use {@link #translate(Function)}
+         * use {@link #translateToServiceRequest(Function)}
          *
          * Take a reference to the tranlater that take the resource model POJO as input
          * and provide a request object as needed to make the Service call.
@@ -155,7 +155,7 @@ interface RequestMaker<ClientT, ModelT, CallbackT extends StdCallbackContext> {
          */
         @Deprecated
         default <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> request(Function<ModelT, RequestT> maker) {
-            return translate(maker);
+            return translateToServiceRequest(maker);
         }
 
         /**
@@ -166,7 +166,7 @@ default <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> request(Function
          * @param <RequestT>, the web service request created
          * @return returns the next step, to actually call the service.
          */
-        <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> translate(Function<ModelT, RequestT> maker);
+        <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> translateToServiceRequest(Function<ModelT, RequestT> maker);
     }
 
     /**
@@ -181,16 +181,23 @@ default <RequestT> Caller<RequestT, ClientT, ModelT, CallbackT> request(Function
      *            responses
      */
     interface Caller<RequestT, ClientT, ModelT, CallbackT extends StdCallbackContext> {
+        @Deprecated
+        default <ResponseT>
+            Stabilizer<RequestT, ResponseT, ClientT, ModelT, CallbackT>
+            call(BiFunction<RequestT, ProxyClient<ClientT>, ResponseT> caller) {
+            return makeServiceCall(caller);
+        }
+
         <ResponseT>
             Stabilizer<RequestT, ResponseT, ClientT, ModelT, CallbackT>
-            call(BiFunction<RequestT, ProxyClient<ClientT>, ResponseT> caller);
+            makeServiceCall(BiFunction<RequestT, ProxyClient<ClientT>, ResponseT> caller);
 
         @Deprecated
         default Caller<RequestT, ClientT, ModelT, CallbackT> retry(Delay delay) {
-            return backoff(delay);
+            return backoffDelay(delay);
         }
 
-        Caller<RequestT, ClientT, ModelT, CallbackT> backoff(Delay delay);
+        Caller<RequestT, ClientT, ModelT, CallbackT> backoffDelay(Delay delay);
 
     }
 
@@ -214,18 +221,6 @@ default Caller<RequestT, ClientT, ModelT, CallbackT> retry(Delay delay) {
     @FunctionalInterface
     interface Callback<RequestT, ResponseT, ClientT, ModelT, CallbackT extends StdCallbackContext, ReturnT> {
         ReturnT invoke(RequestT request, ResponseT response, ProxyClient<ClientT> client, ModelT model, CallbackT context);
-
-        static <RequestT, ResponseT, ClientT, ModelT, CallbackT extends StdCallbackContext>
-            Callback<RequestT, ResponseT, ClientT, ModelT, CallbackT, ProgressEvent<ModelT, CallbackT>>
-            progress() {
-            return (r1, r2, c1, m1, c2) -> ProgressEvent.progress(m1, c2);
-        }
-
-        static <RequestT, ResponseT, ClientT, ModelT, CallbackT extends StdCallbackContext>
-            Callback<RequestT, ResponseT, ClientT, ModelT, CallbackT, ProgressEvent<ModelT, CallbackT>>
-            success() {
-            return (r1, r2, c1, m1, c2) -> ProgressEvent.success(m1, c2);
-        }
     }
 
     /**
diff --git a/src/main/java/software/amazon/cloudformation/proxy/package-info.java b/src/main/java/software/amazon/cloudformation/proxy/package-info.java
@@ -172,10 +172,9 @@
  * indicate successful completion.
  * {@link software.amazon.cloudformation.proxy.OperationStatus#IN_PROGRESS}
  * indicates that we can the proceed to next part of API calls to make for
- * resource configuration. E.g. for CloudWatchLogs LogGroup we first
- * create the LogGroup, then we update retention policy, associated KMS key and
- * finally delegate to Read Handler to return the complete state for the
- * resource
+ * resource configuration. E.g. for CloudWatchLogs LogGroup we first create the
+ * LogGroup, then we update retention policy, associated KMS key and finally
+ * delegate to Read Handler to return the complete state for the resource
  *
  * <pre>
  * <code>
@@ -194,11 +193,10 @@
  * error with
  * {@link software.amazon.cloudformation.proxy.OperationStatus#FAILED} status
  * and an appropriate error message
- * software.amazon.cloudformation.proxy.ProgressEvent#getMessage() E.g.
- * if associateKMSKey had an error to associate KMS key for CloudWatchLogs to
- * use, the chain would exit with FAILED stauts and appropriate exception
- * message. Both
- * {@link software.amazon.cloudformation.proxy.OperationStatus#SUCCESS} and
+ * software.amazon.cloudformation.proxy.ProgressEvent#getMessage() E.g. if
+ * associateKMSKey had an error to associate KMS key for CloudWatchLogs to use,
+ * the chain would exit with FAILED stauts and appropriate exception message.
+ * Both {@link software.amazon.cloudformation.proxy.OperationStatus#SUCCESS} and
  * {@link software.amazon.cloudformation.proxy.OperationStatus#FAILED} are pivot
  * points in the chain that will skip the remainder of the chain.</li>
  * </ol>
diff --git a/src/test/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxyTest.java b/src/test/java/software/amazon/cloudformation/proxy/AmazonWebServicesClientProxyTest.java
@@ -244,7 +244,8 @@ public void badRequest() {
         when(sdkHttpResponse.statusCode()).thenReturn(400);
         final ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRespository", proxy.newProxy(() -> null), model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, c) -> {
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, c) -> {
                     throw new BadRequestException(mock(AwsServiceException.Builder.class)) {
                         private static final long serialVersionUID = 1L;
 
@@ -273,7 +274,8 @@ public void notFound() {
         when(sdkHttpResponse.statusCode()).thenReturn(404);
         ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRespository", proxy.newProxy(() -> null), model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, c) -> {
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, c) -> {
                     throw new NotFoundException(mock(AwsServiceException.Builder.class)) {
                         private static final long serialVersionUID = 1L;
 
@@ -302,7 +304,8 @@ public void accessDenied() {
         when(sdkHttpResponse.statusCode()).thenReturn(401);
         ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRespository", proxy.newProxy(() -> null), model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, c) -> {
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, c) -> {
                     throw new AccessDenied(AwsServiceException.builder()) {
                         private static final long serialVersionUID = 1L;
 
@@ -354,8 +357,9 @@ public void throttleHandlingSuccess() {
 
         ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
-                .translate(m -> (requests[0] = new CreateRequest.Builder().repoName(m.getRepoName()).build()))
-                .backoff(Constant.of().delay(Duration.ofSeconds(1)).timeout(Duration.ofSeconds(3)).build()).call((r, c) -> {
+                .translateToServiceRequest(m -> (requests[0] = new CreateRequest.Builder().repoName(m.getRepoName()).build()))
+                .backoffDelay(Constant.of().delay(Duration.ofSeconds(1)).timeout(Duration.ofSeconds(3)).build())
+                .makeServiceCall((r, c) -> {
                     if (attempt[0]-- > 0) {
                         throw new ThrottleException(builder) {
                             private static final long serialVersionUID = 1L;
@@ -371,8 +375,10 @@ public AwsErrorDetails awsErrorDetails() {
                 })
                 .done((request, response, client1, model1, context1) -> proxy
                     .initiate("client:readRepository", client1, model1, context1)
-                    .translate(m -> (describeRequests[0] = new DescribeRequest.Builder().repoName(m.getRepoName()).build()))
-                    .call((r, c) -> (describeResponses[0] = c.injectCredentialsAndInvokeV2(r, c.client()::describeRepository)))
+                    .translateToServiceRequest(
+                        m -> (describeRequests[0] = new DescribeRequest.Builder().repoName(m.getRepoName()).build()))
+                    .makeServiceCall(
+                        (r, c) -> (describeResponses[0] = c.injectCredentialsAndInvokeV2(r, c.client()::describeRepository)))
                     .done(r -> {
                         Model resultModel = new Model();
                         resultModel.setRepoName(r.getRepoName());
@@ -421,8 +427,9 @@ public void throttledExceedRuntimeBailout() {
 
         final ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-                .backoff(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(10)).build()).call((r, c) -> {
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .backoffDelay(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(10)).build())
+                .makeServiceCall((r, c) -> {
                     throw new ThrottleException(AwsServiceException.builder()) {
                         private static final long serialVersionUID = 1L;
 
@@ -453,9 +460,9 @@ public void serviceCallWithStabilization() {
         ProxyClient<ServiceClient> svcClient = proxy.newProxy(() -> client);
         ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-                .backoff(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(15)).build())
-                .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .backoffDelay(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(15)).build())
+                .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
                 .stabilize((request, response, client1, model1, context1) -> attempt[0]-- > 0)
                 .retryErrorFilter((request, exception, client1, model1, context1) -> exception instanceof ThrottleException)
                 .done(ign -> ProgressEvent.success(model, context));
@@ -492,9 +499,9 @@ public AwsErrorDetails awsErrorDetails() {
 
         final ProgressEvent<Model,
             StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-                .backoff(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(10)).build())
-                .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .backoffDelay(Constant.of().delay(Duration.ofSeconds(5)).timeout(Duration.ofSeconds(10)).build())
+                .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
                 .retryErrorFilter((request, response, client1, model1, context1) -> response instanceof ThrottleException)
                 .done(ign -> ProgressEvent.success(model, context));
 
@@ -515,11 +522,13 @@ public void throwNotRetryableException() {
         StdCallbackContext context = new StdCallbackContext();
         ServiceClient client = mock(ServiceClient.class);
         ProxyClient<ServiceClient> svcClient = proxy.newProxy(() -> client);
-        ProgressEvent<Model, StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
-            .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, g) -> {
-                NonRetryableException e = NonRetryableException.builder().build();
-                throw e;
-            }).success();
+        ProgressEvent<Model,
+            StdCallbackContext> result = proxy.initiate("client:createRepository", svcClient, model, context)
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, g) -> {
+                    NonRetryableException e = NonRetryableException.builder().build();
+                    throw e;
+                }).success();
         assertThat(result.getStatus()).isEqualTo(OperationStatus.FAILED);
 
     }
@@ -539,7 +548,8 @@ public void throwOtherException() {
         ProxyClient<ServiceClient> svcClient = proxy.newProxy(() -> client);
         assertThrows(ResourceAlreadyExistsException.class,
             () -> proxy.initiate("client:createRepository", svcClient, model, context)
-                .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, g) -> {
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, g) -> {
                     throw new ResourceAlreadyExistsException(new RuntimeException("Fail"));
                 }).success());
     }
@@ -555,10 +565,12 @@ public void useInitiatorPattern() {
         ServiceClient client = mock(ServiceClient.class);
         final CallChain.Initiator<ServiceClient, Model, StdCallbackContext> invoker = proxy
             .newInitiator(() -> client, model, context).rebindModel(model).rebindCallback(context);
-        assertThrows(ResourceAlreadyExistsException.class, () -> invoker.initiate("client:createRepository")
-            .translate(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build()).call((r, g) -> {
-                throw new ResourceAlreadyExistsException(new RuntimeException("Fail"));
-            }).success());
+        assertThrows(ResourceAlreadyExistsException.class,
+            () -> invoker.initiate("client:createRepository")
+                .translateToServiceRequest(m -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, g) -> {
+                    throw new ResourceAlreadyExistsException(new RuntimeException("Fail"));
+                }).success());
     }
 
     @Test
diff --git a/src/test/java/software/amazon/cloudformation/proxy/End2EndCallChainTest.java b/src/test/java/software/amazon/cloudformation/proxy/End2EndCallChainTest.java
@@ -96,16 +96,16 @@ public void happyCase() {
 
         ProgressEvent<Model,
             StdCallbackContext> event = proxy.initiate("client:createRepository", client, model, context)
-                .translate((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-                .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+                .translateToServiceRequest((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+                .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
                 .done(r -> ProgressEvent.success(model, context));
 
         assertThat(event.getStatus()).isEqualTo(OperationStatus.SUCCESS);
 
         // replay, should get the same result.
         event = proxy.initiate("client:createRepository", client, model, context)
-            .translate((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-            .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+            .translateToServiceRequest((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+            .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
             .done(r -> ProgressEvent.success(model, context));
         //
         // Verify that we only got called. During replay we should have been skipped.
@@ -133,8 +133,8 @@ public AwsErrorDetails awsErrorDetails() {
         when(serviceClient.createRepository(any(CreateRequest.class))).thenThrow(exists);
         StdCallbackContext newContext = new StdCallbackContext();
         event = proxy.initiate("client:createRepository", client, model, newContext)
-            .translate((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
-            .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+            .translateToServiceRequest((m) -> new CreateRequest.Builder().repoName(m.getRepoName()).build())
+            .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
             .done(r -> ProgressEvent.success(model, context));
 
         assertThat(event.getStatus()).isEqualTo(OperationStatus.FAILED);
diff --git a/src/test/java/software/amazon/cloudformation/proxy/handler/CreateHandler.java b/src/test/java/software/amazon/cloudformation/proxy/handler/CreateHandler.java
@@ -42,12 +42,12 @@ public ProgressEvent<Model, StdCallbackContext> handleRequest(final AmazonWebSer
         final StdCallbackContext cxt = context == null ? new StdCallbackContext() : context;
 
         ProxyClient<ServiceClient> client = proxy.newProxy(() -> this.client);
-        return proxy.initiate("client:createRepository", client, model, cxt).translate((m) -> {
+        return proxy.initiate("client:createRepository", client, model, cxt).translateToServiceRequest((m) -> {
             CreateRequest.Builder builder = new CreateRequest.Builder();
             builder.repoName(m.getRepoName());
             return builder.build();
-        }).backoff(Constant.of().delay(Duration.ofSeconds(3)).timeout(Duration.ofSeconds(9)).build())
-            .call((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
+        }).backoffDelay(Constant.of().delay(Duration.ofSeconds(3)).timeout(Duration.ofSeconds(9)).build())
+            .makeServiceCall((r, c) -> c.injectCredentialsAndInvokeV2(r, c.client()::createRepository))
             .done((request1, response, client1, model1, context1) -> new ReadHandler(this.client).handleRequest(proxy, request,
                 cxt, loggerProxy));
 
diff --git a/src/test/java/software/amazon/cloudformation/proxy/handler/ReadHandler.java b/src/test/java/software/amazon/cloudformation/proxy/handler/ReadHandler.java
