Skip to content

Commit 4a4edef

Browse files
committed
feat(storage): hide operation APIs that don't take any effect on upload
1 parent 047e5f0 commit 4a4edef

File tree

7 files changed

+15
-29
lines changed

7 files changed

+15
-29
lines changed

packages/amplify_core/lib/src/types/storage/base/storage_controllable_operation.dart

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,7 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15-
abstract class StorageControllableOperation {
16-
/// {@template amplify_core.storage.controllable_operation.cancel}
17-
/// Cancels the operation.
18-
///
19-
/// A cancelled operation cannot be resumed.
20-
/// {@endtemplate}
21-
Future<void> cancel();
22-
15+
abstract class StorageResumableOperation {
2316
/// {@template amplify_core.storage.controllable_operation.pause}
2417
/// Pauses the operation that is in progress.
2518
/// {@endtemplate}
@@ -30,3 +23,12 @@ abstract class StorageControllableOperation {
3023
/// {@endtemplate}
3124
Future<void> resume();
3225
}
26+
27+
abstract class StorageCancelableOperation {
28+
/// {@template amplify_core.storage.controllable_operation.cancel}
29+
/// Cancels the operation.
30+
///
31+
/// A cancelled operation cannot be resumed.
32+
/// {@endtemplate}
33+
Future<void> cancel();
34+
}

packages/amplify_core/lib/src/types/storage/download_data_operation.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ abstract class StorageDownloadDataOperation<
2424
extends StorageOperation<Request, Result>
2525
// TODO(HuiSF): re-enable controllable APIs when SmithyOperation.cancel
2626
// can cancel underlying http request.
27-
/* implements StorageControllableOperation */ {
27+
/* implements StorageResumableOperation, StorageCancelableOperation */ {
2828
/// {@macro amplify_core.storage.download_data_operation}
2929
StorageDownloadDataOperation({
3030
required super.request,

packages/amplify_core/lib/src/types/storage/download_file_operation.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ abstract class StorageDownloadFileOperation<
2424
extends StorageOperation<Request, Result>
2525
// TODO(HuiSF): re-enable controllable APIs when SmithyOperation.cancel
2626
// can cancel underlying http request.
27-
/* implements StorageControllableOperation */ {
27+
/* implements StorageResumableOperation, StorageCancelableOperation */ {
2828
/// {@macro amplify_core.storage.download_file_operation}
2929
StorageDownloadFileOperation({
3030
required super.request,

packages/amplify_core/lib/src/types/storage/upload_data_operation.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ abstract class StorageUploadDataOperation<
2323
Request extends StorageUploadDataRequest,
2424
Result extends StorageUploadDataResult>
2525
extends StorageOperation<Request, Result>
26-
implements StorageControllableOperation {
26+
implements StorageCancelableOperation {
2727
/// {@macro amplify_core.storage.upload_data_operation}
2828
StorageUploadDataOperation({
2929
required super.request,

packages/amplify_core/lib/src/types/storage/upload_file_operation.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ abstract class StorageUploadFileOperation<
2323
Request extends StorageUploadFileRequest,
2424
Result extends StorageUploadFileResult>
2525
extends StorageOperation<Request, Result>
26-
implements StorageControllableOperation {
26+
implements StorageResumableOperation, StorageCancelableOperation {
2727
/// {@macro amplify_core.storage.upload_file_operation}
2828
StorageUploadFileOperation({
2929
required super.request,

packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,8 +331,6 @@ class AmplifyStorageS3Dart extends StoragePluginInterface<
331331
result: uploadTask.result.then(
332332
(uploadedItem) => S3UploadDataResult(uploadedItem: uploadedItem),
333333
),
334-
resume: uploadTask.resume,
335-
pause: uploadTask.pause,
336334
cancel: uploadTask.cancel,
337335
);
338336
}

packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_data_operation.dart

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,11 @@ class S3UploadDataOperation extends StorageUploadDataOperation<
2424
S3UploadDataOperation({
2525
required super.request,
2626
required super.result,
27-
required Future<void> Function() resume,
28-
required Future<void> Function() pause,
2927
required Future<void> Function() cancel,
30-
}) : _resume = resume,
31-
_pause = pause,
32-
_cancel = cancel;
28+
}) : _cancel = cancel;
3329

34-
final Future<void> Function() _resume;
35-
final Future<void> Function() _pause;
3630
final Future<void> Function() _cancel;
3731

38-
/// Resume takes no effect for a [S3UploadDataOperation].
39-
@override
40-
Future<void> resume() => _resume();
41-
42-
/// Pause takes no effect for a [S3UploadDataOperation] .
43-
@override
44-
Future<void> pause() => _pause();
45-
4632
@override
4733
Future<void> cancel() => _cancel();
4834
}

0 commit comments

Comments
 (0)