-
Notifications
You must be signed in to change notification settings - Fork 119
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.
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
feat(storage): Gen2 Storage Download/Upload #2741
Merged
tylerjroach
merged 46 commits into
feat/gen2-storage
from
tjroach/gen2-storage-download-upload
Apr 4, 2024
Merged
Changes from all commits
Commits
Show all changes
46 commits
Select commit
Hold shift + click to select a range
2817b4e
Add deprecation to StorageOptions
tylerjroach 127198d
Add new StoragePath methods and deprecate old
tylerjroach e1346e5
Deprecate StorageAccessLevel
tylerjroach b5c8246
Deprecate S3 Prefix Resolver
tylerjroach 819c1b8
Update Upload Result Types
tylerjroach bbfcf5c
Rename .java to .kt
tylerjroach 77b69a5
Update storage item with path
tylerjroach ac52808
Update results
tylerjroach ee805e7
download implementation
tylerjroach 6c556f6
lint cleanup
tylerjroach 99cbd5b
lint cleanup
tylerjroach 16d5380
lint cleanup
tylerjroach 54550df
update storage path
tylerjroach 6e03c2e
StoragePath Kotlin Facade APIs
tylerjroach 337bf4f
StoragePath Rx Facade APIs
tylerjroach 9c38f16
StoragePath Rx Facade APIs
tylerjroach babbf5a
lint
tylerjroach 1ee4029
Storage path updates
tylerjroach 1dfde82
updates after api review
tylerjroach f8ba29f
add contract tests
tylerjroach fb1336c
rx contract tests
tylerjroach 2e911bc
Merge branch 'main' into tjroach/gen2-storage-contract
tylerjroach ac387c8
lint
tylerjroach b48dbb3
cleanup and remove download implementation for follow up PR
tylerjroach 3ca63f7
deprecation on entire object is enough
tylerjroach 886ec72
fix issues causing building failures
tylerjroach 3b122ec
Add StoragePathValidationException
tylerjroach 86cc7fe
cleanup
tylerjroach 10f6c97
binary dump
tylerjroach b07a4a9
lint
tylerjroach 6757e71
lint
tylerjroach acd582e
lint
tylerjroach 733c9ae
lint
tylerjroach 7f39908
adding download and upload functionality to gen2
tylerjroach eef1b4e
storage path changes
tylerjroach 7d17677
storage path changes
tylerjroach a2887b5
lint
tylerjroach 344299d
accidental change
tylerjroach 4a0c92c
fix test
tylerjroach 46089d4
input stream support
tylerjroach bfbd92f
code cleanup
tylerjroach 76b7a1f
PR comments
tylerjroach 6ee7199
PR comments
tylerjroach 9a3d0e2
Merge branch 'feat/gen2-storage' into tjroach/gen2-storage-download-u…
tylerjroach 21ad0de
merge cleanup
tylerjroach 373d7b5
remove unnecessary change
tylerjroach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
271 changes: 271 additions & 0 deletions
271
...e-s3/src/androidTest/java/com/amplifyframework/storage/s3/AWSS3StoragePathDownloadTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,271 @@ | ||
| /* | ||
| * Copyright 2021 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 com.amplifyframework.storage.s3 | ||
|
|
||
| import android.content.Context | ||
| import androidx.test.core.app.ApplicationProvider | ||
| import com.amplifyframework.auth.AuthPlugin | ||
| import com.amplifyframework.auth.cognito.AWSCognitoAuthPlugin | ||
| import com.amplifyframework.core.Amplify | ||
| import com.amplifyframework.core.async.Cancelable | ||
| 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.StorageCategory | ||
| import com.amplifyframework.storage.StorageChannelEventName | ||
| import com.amplifyframework.storage.StoragePath | ||
| import com.amplifyframework.storage.TransferState | ||
| import com.amplifyframework.storage.TransferState.Companion.getState | ||
| import com.amplifyframework.storage.operation.StorageDownloadFileOperation | ||
| import com.amplifyframework.storage.options.StorageDownloadFileOptions | ||
| import com.amplifyframework.storage.options.StorageUploadFileOptions | ||
| import com.amplifyframework.storage.s3.options.AWSS3StorageDownloadFileOptions | ||
| import com.amplifyframework.storage.s3.test.R | ||
| import com.amplifyframework.storage.s3.util.WorkmanagerTestUtils.initializeWorkmanagerTestUtil | ||
| import com.amplifyframework.testutils.FileAssert | ||
| import com.amplifyframework.testutils.random.RandomTempFile | ||
| import com.amplifyframework.testutils.sync.SynchronousAuth | ||
| import com.amplifyframework.testutils.sync.SynchronousStorage | ||
| import java.io.File | ||
| import java.util.concurrent.CountDownLatch | ||
| import java.util.concurrent.TimeUnit | ||
| import java.util.concurrent.atomic.AtomicReference | ||
| import org.junit.After | ||
| import org.junit.Assert.assertNull | ||
| import org.junit.Assert.assertTrue | ||
| import org.junit.BeforeClass | ||
| import org.junit.Test | ||
|
|
||
| /** | ||
| * Instrumentation test for operational work on download. | ||
| */ | ||
| class AWSS3StoragePathDownloadTest { | ||
| // Create a file to download to | ||
| private val downloadFile: File = RandomTempFile() | ||
| private val options = StorageDownloadFileOptions.defaultInstance() | ||
| // Create a set to remember all the subscriptions | ||
| private val subscriptions = mutableSetOf<SubscriptionToken>() | ||
|
|
||
| companion object { | ||
| private val EXTENDED_TIMEOUT_MS = TimeUnit.SECONDS.toMillis(60) | ||
| private const val LARGE_FILE_SIZE = 10 * 1024 * 1024L // 10 MB | ||
| private const val SMALL_FILE_SIZE = 100L | ||
| private val LARGE_FILE_NAME = "large-${System.currentTimeMillis()}" | ||
| private val LARGE_FILE_PATH = StoragePath.fromString("public/$LARGE_FILE_NAME") | ||
| private val SMALL_FILE_NAME = "small-${System.currentTimeMillis()}" | ||
| private val SMALL_FILE_PATH = StoragePath.fromString("public/$SMALL_FILE_NAME") | ||
|
|
||
| lateinit var storageCategory: StorageCategory | ||
| lateinit var synchronousStorage: SynchronousStorage | ||
| lateinit var largeFile: File | ||
| lateinit var smallFile: File | ||
|
|
||
| /** | ||
| * Initialize mobile client and configure the storage. | ||
| * Upload the test files ahead of time. | ||
| */ | ||
| @JvmStatic | ||
| @BeforeClass | ||
| fun setUpOnce() { | ||
| val context = ApplicationProvider.getApplicationContext<Context>() | ||
| initializeWorkmanagerTestUtil(context) | ||
| SynchronousAuth.delegatingToCognito(context, AWSCognitoAuthPlugin() as AuthPlugin<*>) | ||
|
|
||
| // Get a handle to storage | ||
| storageCategory = TestStorageCategory.create(context, R.raw.amplifyconfiguration) | ||
| synchronousStorage = SynchronousStorage.delegatingTo(storageCategory) | ||
|
|
||
| val uploadOptions = StorageUploadFileOptions.defaultInstance() | ||
|
|
||
| // Upload large test file | ||
| largeFile = RandomTempFile(LARGE_FILE_NAME, LARGE_FILE_SIZE) | ||
| synchronousStorage.uploadFile(LARGE_FILE_PATH, largeFile, uploadOptions, EXTENDED_TIMEOUT_MS) | ||
|
|
||
| // Upload small test file | ||
| smallFile = RandomTempFile(SMALL_FILE_NAME, SMALL_FILE_SIZE) | ||
| synchronousStorage.uploadFile(SMALL_FILE_PATH, smallFile, uploadOptions) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Unsubscribe from everything after each test. | ||
| */ | ||
| @After | ||
| fun tearDown() { | ||
| // Unsubscribe from everything | ||
| for (token in subscriptions) { | ||
| Amplify.Hub.unsubscribe(token) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun testDownloadSmallFile() { | ||
| synchronousStorage.downloadFile(SMALL_FILE_PATH, downloadFile, options) | ||
| FileAssert.assertEquals(smallFile, downloadFile) | ||
| } | ||
|
|
||
| @Test | ||
| fun testDownloadLargeFile() { | ||
| synchronousStorage.downloadFile( | ||
| LARGE_FILE_PATH, | ||
| downloadFile, | ||
| options, | ||
| EXTENDED_TIMEOUT_MS | ||
| ) | ||
| FileAssert.assertEquals(largeFile, downloadFile) | ||
| } | ||
|
|
||
| @Test | ||
| fun testDownloadFileIsCancelable() { | ||
| val canceled = CountDownLatch(1) | ||
| val opContainer = AtomicReference<Cancelable>() | ||
| val errorContainer = AtomicReference<Throwable>() | ||
|
|
||
| // Listen to Hub events for cancel | ||
| val cancelToken = Amplify.Hub.subscribe(HubChannel.STORAGE) { hubEvent: HubEvent<*> -> | ||
| if (StorageChannelEventName.DOWNLOAD_STATE.toString() == hubEvent.name) { | ||
| val state = getState(hubEvent.data as String) | ||
| if (TransferState.CANCELED == state) { | ||
| canceled.countDown() | ||
| } | ||
| } | ||
| } | ||
| subscriptions.add(cancelToken) | ||
|
|
||
| // Begin downloading a large file | ||
| val op = storageCategory.downloadFile( | ||
| LARGE_FILE_PATH, | ||
| downloadFile, | ||
| options, | ||
| { | ||
| if (it.currentBytes > 0 && canceled.count > 0) { | ||
| opContainer.get().cancel() | ||
| } | ||
| }, | ||
| { errorContainer.set(RuntimeException("Download completed without canceling.")) }, | ||
| { newValue -> errorContainer.set(newValue) } | ||
| ) | ||
| opContainer.set(op) | ||
|
|
||
| // Assert that the required conditions have been met | ||
| assertTrue(canceled.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS)) | ||
| assertNull(errorContainer.get()) | ||
| } | ||
|
|
||
| @Test | ||
| fun testDownloadFileIsResumable() { | ||
| val completed = CountDownLatch(1) | ||
| val resumed = CountDownLatch(1) | ||
| val opContainer = AtomicReference<Resumable>() | ||
| val errorContainer = AtomicReference<Throwable>() | ||
|
|
||
| // Listen to Hub events to resume when operation has been paused | ||
| val resumeToken = Amplify.Hub.subscribe(HubChannel.STORAGE) { hubEvent: HubEvent<*> -> | ||
| if (StorageChannelEventName.DOWNLOAD_STATE.toString() == hubEvent.name) { | ||
| val state = getState(hubEvent.data as String) | ||
| if (TransferState.PAUSED == state) { | ||
| opContainer.get().resume() | ||
| resumed.countDown() | ||
| } | ||
| } | ||
| } | ||
| subscriptions.add(resumeToken) | ||
|
|
||
| // Begin downloading a large file | ||
| val op = storageCategory.downloadFile( | ||
| LARGE_FILE_PATH, | ||
| downloadFile, | ||
| options, | ||
| { | ||
| if (it.currentBytes > 0 && resumed.count > 0) { | ||
| opContainer.get().pause() | ||
| } | ||
| }, | ||
| { completed.countDown() }, | ||
| { errorContainer.set(it) } | ||
| ) | ||
| opContainer.set(op) | ||
|
|
||
| // Assert that all the required conditions have been met | ||
| assertTrue(resumed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS)) | ||
| assertTrue(completed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS)) | ||
| assertNull(errorContainer.get()) | ||
| FileAssert.assertEquals(largeFile, downloadFile) | ||
| } | ||
|
|
||
| @Test | ||
| fun testGetTransferOnPause() { | ||
| val completed = CountDownLatch(1) | ||
| val resumed = CountDownLatch(1) | ||
| val opContainer = AtomicReference<StorageDownloadFileOperation<*>>() | ||
| val transferId = AtomicReference<String>() | ||
| val errorContainer = AtomicReference<Throwable>() | ||
| // Listen to Hub events to resume when operation has been paused | ||
| val resumeToken = Amplify.Hub.subscribe(HubChannel.STORAGE) { hubEvent: HubEvent<*> -> | ||
| if (StorageChannelEventName.DOWNLOAD_STATE.toString() == hubEvent.name) { | ||
| val state = getState(hubEvent.data as String) | ||
| if (TransferState.PAUSED == state) { | ||
| opContainer.get().clearAllListeners() | ||
| storageCategory.getTransfer( | ||
| transferId.get(), | ||
| { | ||
| val getOp = it as StorageDownloadFileOperation<*> | ||
| getOp.resume() | ||
| resumed.countDown() | ||
| getOp.setOnSuccess { completed.countDown() } | ||
| }, | ||
| { errorContainer.set(it) } | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| subscriptions.add(resumeToken) | ||
|
|
||
| // Begin downloading a large file | ||
| val op = storageCategory.downloadFile( | ||
| LARGE_FILE_PATH, | ||
| downloadFile, | ||
| options, | ||
| { | ||
| if (it.currentBytes > 0 && resumed.count > 0) { | ||
| opContainer.get().pause() | ||
| } | ||
| }, | ||
| { }, | ||
| { errorContainer.set(it) } | ||
| ) | ||
|
|
||
| opContainer.set(op) | ||
| transferId.set(op.transferId) | ||
|
|
||
| // Assert that all the required conditions have been met | ||
| assertTrue(resumed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS)) | ||
| assertTrue(completed.await(EXTENDED_TIMEOUT_MS, TimeUnit.MILLISECONDS)) | ||
| assertNull(errorContainer.get()) | ||
| FileAssert.assertEquals(largeFile, downloadFile) | ||
| } | ||
|
|
||
| @Test | ||
| fun testDownloadLargeFileWithAccelerationEnabled() { | ||
| val awsS3Options = AWSS3StorageDownloadFileOptions.builder().setUseAccelerateEndpoint(true).build() | ||
| synchronousStorage.downloadFile( | ||
| LARGE_FILE_PATH, | ||
| downloadFile, | ||
| awsS3Options, | ||
| EXTENDED_TIMEOUT_MS | ||
| ) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to go through and check all my licenses. This one is a copy/paste issue, but I believe my auto license header was disabled and not applied to some of the new files. Will make a note.