Create ProgressUpdater class to expose methods to invoke listeners to update request status

core/sdk-core/src/main/java/software/amazon/awssdk/core/RequestOverrideConfiguration.java

@@ -70,7 +70,7 @@ protected RequestOverrideConfiguration(Builder<?> builder) {
         this.endpointProvider = builder.endpointProvider();
         this.compressionConfiguration = builder.compressionConfiguration();
         this.plugins = Collections.unmodifiableList(new ArrayList<>(builder.plugins()));
-        this.progressListeners = Collections.unmodifiableList(new ArrayList<>());
+        this.progressListeners = Collections.unmodifiableList(new ArrayList<>(builder.progressListeners()));
     }
 
     /**

core/sdk-core/src/main/java/software/amazon/awssdk/core/http/ExecutionContext.java

@@ -15,11 +15,13 @@
 
 package software.amazon.awssdk.core.http;
 
+import java.util.Optional;
 import software.amazon.awssdk.annotations.NotThreadSafe;
 import software.amazon.awssdk.annotations.SdkProtectedApi;
 import software.amazon.awssdk.core.interceptor.ExecutionAttributes;
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptorChain;
 import software.amazon.awssdk.core.interceptor.InterceptorContext;
+import software.amazon.awssdk.core.internal.progress.listener.ProgressUpdater;
 import software.amazon.awssdk.core.signer.Signer;
 import software.amazon.awssdk.metrics.MetricCollector;
 import software.amazon.awssdk.utils.builder.CopyableBuilder;
@@ -36,13 +38,15 @@ public final class ExecutionContext implements ToCopyableBuilder<ExecutionContex
     private final ExecutionInterceptorChain interceptorChain;
     private final ExecutionAttributes executionAttributes;
     private final MetricCollector metricCollector;
+    private final ProgressUpdater progressUpdater;
 
     private ExecutionContext(final Builder builder) {
         this.signer = builder.signer;
         this.interceptorContext = builder.interceptorContext;
         this.interceptorChain = builder.interceptorChain;
         this.executionAttributes = builder.executionAttributes;
         this.metricCollector = builder.metricCollector;
+        this.progressUpdater = builder.progressUpdater;
     }
 
     public static ExecutionContext.Builder builder() {
@@ -76,6 +80,10 @@ public MetricCollector metricCollector() {
         return metricCollector;
     }
 
+    public Optional<ProgressUpdater> progressUpdater() {
+        return progressUpdater != null ? Optional.of(progressUpdater) : Optional.empty();
+    }
+
     @Override
     public Builder toBuilder() {
         return new Builder(this);
@@ -87,6 +95,7 @@ public static class Builder implements CopyableBuilder<Builder, ExecutionContext
         private ExecutionAttributes executionAttributes;
         private Signer signer;
         private MetricCollector metricCollector;
+        private ProgressUpdater progressUpdater;
 
         private Builder() {
         }
@@ -97,6 +106,7 @@ private Builder(ExecutionContext executionContext) {
             this.interceptorChain = executionContext.interceptorChain;
             this.executionAttributes = executionContext.executionAttributes;
             this.metricCollector = executionContext.metricCollector;
+            this.progressUpdater = executionContext.progressUpdater;
         }
 
         public Builder interceptorContext(InterceptorContext interceptorContext) {
@@ -124,6 +134,11 @@ public Builder metricCollector(MetricCollector metricCollector) {
             return this;
         }
 
+        public Builder progressUpdater(ProgressUpdater progressUpdater) {
+            this.progressUpdater = progressUpdater;
+            return this;
+        }
+
         @Override
         public ExecutionContext build() {
             return new ExecutionContext(this);

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/progress/ProgressListenerFailedContext.java

@@ -22,6 +22,7 @@
 import software.amazon.awssdk.core.progress.listener.ProgressListener;
 import software.amazon.awssdk.core.progress.snapshot.ProgressSnapshot;
 import software.amazon.awssdk.http.SdkHttpRequest;
+import software.amazon.awssdk.http.SdkHttpResponse;
 import software.amazon.awssdk.utils.ToString;
 import software.amazon.awssdk.utils.Validate;
 import software.amazon.awssdk.utils.builder.CopyableBuilder;
@@ -91,6 +92,16 @@ public String toString() {
                        .build();
     }
 
+    @Override
+    public SdkHttpResponse httpResponse() {
+        return progressListenerContext.httpResponse();
+    }
+
+    @Override
+    public ProgressSnapshot downloadProgressSnapshot() {
+        return progressListenerContext.downloadProgressSnapshot();
+    }
+
     public static final class Builder implements CopyableBuilder<Builder, ProgressListenerFailedContext> {
         private ProgressListenerContext progressListenerContext;
         private Throwable exception;

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/progress/listener/DefaultSdkRequestProgress.java → core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/progress/listener/DefaultSdkExchangeProgress.java

@@ -21,24 +21,24 @@
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
 import software.amazon.awssdk.core.internal.progress.snapshot.DefaultProgressSnapshot;
-import software.amazon.awssdk.core.progress.listener.SdkRequestProgress;
+import software.amazon.awssdk.core.progress.listener.SdkExchangeProgress;
 import software.amazon.awssdk.core.progress.snapshot.ProgressSnapshot;
 
 /**
- * An SDK-internal implementation of {@link SdkRequestProgress}. This implementation acts as a thin wrapper around {@link
+ * An SDK-internal implementation of {@link SdkExchangeProgress}. This implementation acts as a thin wrapper around {@link
  * AtomicReference}, where calls to get the latest {@link #progressSnapshot()} simply return the latest reference, while {@link
  * ProgressUpdater} is responsible for continuously updating the latest reference.
  *
- * @see SdkRequestProgress
+ * @see SdkExchangeProgress
  */
 @Mutable
 @ThreadSafe
 @SdkInternalApi
-public class DefaultSdkRequestProgress implements SdkRequestProgress {
+public class DefaultSdkExchangeProgress implements SdkExchangeProgress {
 
     private final AtomicReference<ProgressSnapshot> snapshot;
 
-    public DefaultSdkRequestProgress(ProgressSnapshot snapshot) {
+    public DefaultSdkExchangeProgress(ProgressSnapshot snapshot) {
         this.snapshot = new AtomicReference<>(snapshot);
     }
 

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/progress/listener/LoggingProgressListener.java

@@ -0,0 +1,122 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License").
+ * You may not use this file except in compliance with the License.
+ * A copy of the License is located at
+ *
+ *  http://aws.amazon.com/apache2.0
+ *
+ * or in the "license" file accompanying this file. This file is distributed
+ * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ * express or implied. See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+package software.amazon.awssdk.core.internal.progress.listener;
+
+import static software.amazon.awssdk.utils.StringUtils.repeat;
+
+import java.math.BigDecimal;
+import java.math.RoundingMode;
+import java.util.concurrent.atomic.AtomicInteger;
+import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.core.progress.listener.ProgressListener;
+import software.amazon.awssdk.utils.Logger;
+
+/**
+ * An implementation of {@link ProgressListener} that logs a progress bar at the {@code INFO} level for upload operations. This
+ * implementation effectively limits the frequency of updates by limiting logging to events of progress advancement. By default,
+ * the progress bar has {@value #DEFAULT_MAX_TICKS} ticks, meaning an update is logged for every 5% progression, at most.
+ */
+@SdkPublicApi
+public final class LoggingProgressListener implements ProgressListener {
+    private static final Logger log = Logger.loggerFor(LoggingProgressListener.class);
+    private static final int DEFAULT_MAX_TICKS = 20;
+    private final ProgressBar progressBar;
+
+    private LoggingProgressListener(int maxTicks) {
+        progressBar = new ProgressBar(maxTicks);
+    }
+
+    /**
+     * Create an instance of {@link LoggingProgressListener} with a custom {@code maxTicks} value.
+     *
+     * @param maxTicks the number of ticks in the logged progress bar
+     */
+    public static LoggingProgressListener create(int maxTicks) {
+        return new LoggingProgressListener(maxTicks);
+    }
+
+    /**
+     * Create an instance of {@link LoggingProgressListener} with the default configuration.
+     */
+    public static LoggingProgressListener create() {
+        return new LoggingProgressListener(DEFAULT_MAX_TICKS);
+    }
+
+
+    @Override
+    public void requestPrepared(Context.RequestPrepared context) {
+        log.info(() -> "Request Prepared...");
+        context.uploadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void requestHeaderSent(Context.RequestHeaderSent context) {
+        context.uploadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void requestBytesSent(Context.RequestBytesSent context) {
+        context.uploadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void responseHeaderReceived(Context.ResponseHeaderReceived context) {
+        log.info(() -> "Upload Successful! Starting Download...");
+        context.downloadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void responseBytesReceived(Context.ResponseBytesReceived context) {
+        context.downloadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void executionSuccess(Context.ExecutionSuccess context) {
+        log.info(() -> "Execution Successful!");
+        context.downloadProgressSnapshot().ratioTransferred().ifPresent(progressBar::update);
+    }
+
+    @Override
+    public void executionFailure(Context.ExecutionFailure context) {
+        log.warn(() -> "Execution Failed!", context.exception());
+    }
+
+    private static class ProgressBar {
+        private final int maxTicks;
+        private final AtomicInteger prevTicks = new AtomicInteger(-1);
+
+        private ProgressBar(int maxTicks) {
+            this.maxTicks = maxTicks;
+        }
+
+        void update(double ratio) {
+            int ticks = (int) Math.floor(ratio * maxTicks);
+            if (prevTicks.getAndSet(ticks) != ticks) {
+                log.info(() -> String.format("|%s%s| %s",
+                                             repeat("=", ticks),
+                                             repeat(" ", maxTicks - ticks),
+                                             round(ratio * 100, 1) + "%"));
+            }
+        }
+
+        private static double round(double value, int places) {
+            BigDecimal bd = BigDecimal.valueOf(value);
+            bd = bd.setScale(places, RoundingMode.FLOOR);
+            return bd.doubleValue();
+        }
+    }
+
+}

core/sdk-core/src/main/java/software/amazon/awssdk/core/internal/progress/listener/ProgressListenerInvoker.java

@@ -78,12 +78,12 @@ public void responseBytesReceived(Context.ResponseBytesReceived context) {
     }
 
     @Override
-    public void attemptFailure(Context.AttemptFailure context) {
+    public void attemptFailure(Context.ExecutionFailure context) {
         forEach(listener -> listener.attemptFailure(context));
     }
 
     @Override
-    public void attemptFailureResponseBytesReceived(Context.AttemptFailureResponseBytesReceived context) {
+    public void attemptFailureResponseBytesReceived(Context.ExecutionFailure context) {
         forEach(listener -> listener.attemptFailureResponseBytesReceived(context));
     }