Skip to content

feat(storage): add progress stall timeout for S3 uploads #3306

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

Open
burak-initialcode wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat(storage): add progress stall timeout for S3 uploads #3306

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
05f6185
feat(storage): add progress stall timeout for S3 uploads
burak-pensa Apr 27, 2026
c2ae0e3
test(storage): add integration tests for progress stall timeout uploads
burak-pensa Apr 27, 2026
789d865
test(storage): increase unit test coverage for progress stall timeout
burak-pensa May 11, 2026
98a75d5
fix(storage): use plugin default progress stall timeout on upload resume
burak-pensa May 19, 2026
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
11 changes: 11 additions & 0 deletions aws-storage-s3/api/aws-storage-s3.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,13 +81,16 @@ public final class com/amplifyframework/storage/s3/configuration/AWSS3StoragePlu
public static final field Companion Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration$Companion;
public synthetic fun <init> (Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration$Builder;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun getAWSS3PluginPrefixResolver (Lcom/amplifyframework/auth/AuthCredentialsProvider;)Lcom/amplifyframework/storage/s3/configuration/AWSS3PluginPrefixResolver;
public final fun getProgressStallTimeout ()Lcom/amplifyframework/storage/ProgressStallTimeout;
}

public final class com/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration$Builder {
public fun <init> ()V
public final fun build ()Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;
public final fun getAwsS3PluginPrefixResolver ()Lcom/amplifyframework/storage/s3/configuration/AWSS3PluginPrefixResolver;
public final fun getProgressStallTimeout ()Lcom/amplifyframework/storage/ProgressStallTimeout;
public final fun setAwsS3PluginPrefixResolver (Lcom/amplifyframework/storage/s3/configuration/AWSS3PluginPrefixResolver;)V
public final fun setProgressStallTimeout (Lcom/amplifyframework/storage/ProgressStallTimeout;)V
}

public final class com/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration$Companion {
Expand Down Expand Up @@ -128,11 +131,13 @@ public final class com/amplifyframework/storage/s3/operation/AWSS3StorageRemoveO

public final class com/amplifyframework/storage/s3/operation/AWSS3StorageUploadFileOperation : com/amplifyframework/storage/operation/StorageUploadFileOperation {
public fun <init> (Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;J)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun cancel ()V
public fun getTransferState ()Lcom/amplifyframework/storage/TransferState;
public fun pause ()V
Expand All @@ -143,11 +148,13 @@ public final class com/amplifyframework/storage/s3/operation/AWSS3StorageUploadF

public final class com/amplifyframework/storage/s3/operation/AWSS3StorageUploadInputStreamOperation : com/amplifyframework/storage/operation/StorageUploadInputStreamOperation {
public fun <init> (Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;J)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun <init> (Ljava/lang/String;Lcom/amplifyframework/storage/s3/service/StorageService;Ljava/util/concurrent/ExecutorService;Lcom/amplifyframework/auth/AuthCredentialsProvider;Lcom/amplifyframework/storage/s3/configuration/AWSS3StoragePluginConfiguration;Lcom/amplifyframework/storage/s3/request/AWSS3StorageUploadRequest;Lcom/amplifyframework/storage/s3/transfer/TransferObserver;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;Lcom/amplifyframework/core/Consumer;)V
public fun cancel ()V
public fun getTransferState ()Lcom/amplifyframework/storage/TransferState;
public fun pause ()V
Expand Down Expand Up @@ -246,6 +253,7 @@ public final class com/amplifyframework/storage/s3/options/AWSS3StorageUploadFil
public static fun defaultInstance ()Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions;
public fun equals (Ljava/lang/Object;)Z
public static fun from (Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions$Builder;
public fun getProgressStallTimeout ()Lcom/amplifyframework/storage/ProgressStallTimeout;
public fun getServerSideEncryption ()Lcom/amplifyframework/storage/s3/ServerSideEncryption;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
Expand All @@ -256,6 +264,7 @@ public final class com/amplifyframework/storage/s3/options/AWSS3StorageUploadFil
public synthetic fun build ()Lcom/amplifyframework/storage/options/StorageOptions;
public synthetic fun build ()Lcom/amplifyframework/storage/options/StorageUploadFileOptions;
public fun build ()Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions;
public fun progressStallTimeout (Lcom/amplifyframework/storage/ProgressStallTimeout;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions$Builder;
public fun serverSideEncryption (Lcom/amplifyframework/storage/s3/ServerSideEncryption;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions$Builder;
public fun setUseAccelerateEndpoint (Z)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadFileOptions$Builder;
}
Expand All @@ -265,6 +274,7 @@ public final class com/amplifyframework/storage/s3/options/AWSS3StorageUploadInp
public static fun defaultInstance ()Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions;
public fun equals (Ljava/lang/Object;)Z
public static fun from (Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions$Builder;
public fun getProgressStallTimeout ()Lcom/amplifyframework/storage/ProgressStallTimeout;
public fun getServerSideEncryption ()Lcom/amplifyframework/storage/s3/ServerSideEncryption;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
Expand All @@ -275,6 +285,7 @@ public final class com/amplifyframework/storage/s3/options/AWSS3StorageUploadInp
public synthetic fun build ()Lcom/amplifyframework/storage/options/StorageOptions;
public synthetic fun build ()Lcom/amplifyframework/storage/options/StorageUploadInputStreamOptions;
public fun build ()Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions;
public fun progressStallTimeout (Lcom/amplifyframework/storage/ProgressStallTimeout;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions$Builder;
public fun serverSideEncryption (Lcom/amplifyframework/storage/s3/ServerSideEncryption;)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions$Builder;
public fun setUseAccelerateEndpoint (Z)Lcom/amplifyframework/storage/s3/options/AWSS3StorageUploadInputStreamOptions$Builder;
}
Expand Down
33 changes: 33 additions & 0 deletions ...age-s3/src/androidTest/java/com/amplifyframework/storage/s3/AWSS3StoragePathUploadTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import com.amplifyframework.core.async.Resumable
import com.amplifyframework.hub.HubChannel
import com.amplifyframework.hub.HubEvent
import com.amplifyframework.hub.SubscriptionToken
import com.amplifyframework.storage.ProgressStallTimeout
import com.amplifyframework.storage.StorageCategory
import com.amplifyframework.storage.StorageChannelEventName
import com.amplifyframework.storage.StorageException
Expand Down Expand Up @@ -363,6 +364,38 @@ class AWSS3StoragePathUploadTest : DeviceFarmTestBase() {
)
}

/**
* Given: A progress stall timeout configured on upload options
* When: A small file is uploaded over the network
* Then: The upload completes successfully (the stall timer must not break the happy path)
*/
@Test
fun testUploadSmallFileWithProgressStallTimeoutOptionCompletesSuccessfully() {
val uploadFile: File = RandomTempFile(SMALL_FILE_SIZE)
storagePath = StoragePath.fromString("public/${uploadFile.name}")
val options = AWSS3StorageUploadFileOptions.builder()
.progressStallTimeout(ProgressStallTimeout.Interval(120))
.build()

synchronousStorage.uploadFile(storagePath, uploadFile, options)
}

/**
* Given: A progress stall timeout configured on upload options for a multipart upload
* When: A file larger than the multipart threshold is uploaded
* Then: The upload completes successfully across all parts
*/
@Test
fun testUploadLargeFileWithProgressStallTimeoutOptionCompletesSuccessfully() {
val uploadFile: File = RandomTempFile(LARGE_FILE_SIZE)
storagePath = StoragePath.fromString("public/${uploadFile.name}")
val options = AWSS3StorageUploadFileOptions.builder()
.progressStallTimeout(ProgressStallTimeout.Interval(120))
.build()

synchronousStorage.uploadFile(storagePath, uploadFile, options, EXTENDED_TIMEOUT_MS)
}

@Test(expected = StorageException::class)
fun testUploadUnauthenticatedProtectedAccess() {
val uploadFile: File = RandomTempFile(SMALL_FILE_SIZE)
Expand Down
Loading
Loading