From 7df1e4630c65b92ab8681a7798cacd8bbbe305cb Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 11 Mar 2024 18:24:37 -0400 Subject: [PATCH 01/46] chore: add `StoragePath` --- .../lib/src/types/storage/storage_path.dart | 46 +++++++++++++++++++ .../lib/src/types/storage/storage_types.dart | 1 + 2 files changed, 47 insertions(+) create mode 100644 packages/amplify_core/lib/src/types/storage/storage_path.dart diff --git a/packages/amplify_core/lib/src/types/storage/storage_path.dart b/packages/amplify_core/lib/src/types/storage/storage_path.dart new file mode 100644 index 0000000000..4cfff3af65 --- /dev/null +++ b/packages/amplify_core/lib/src/types/storage/storage_path.dart @@ -0,0 +1,46 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'dart:async'; + +import 'package:meta/meta.dart'; + +abstract class StoragePath { + factory StoragePath.fromString(String path) { + return StoragePathFromString(path); + } + + factory StoragePath.withIdentityId( + String Function(String id) builder, + ) { + return StoragePathWithIdentityId(builder); + } + + @internal + FutureOr resolvePath({String? id}); +} + +@internal +class StoragePathFromString implements StoragePath { + const StoragePathFromString(this._path); + final String _path; + @override + FutureOr resolvePath({ + String? id, + }) { + return _path; + } +} + +@internal +class StoragePathWithIdentityId implements StoragePath { + const StoragePathWithIdentityId(this._pathBuilder); + final String Function(String identityId) _pathBuilder; + @override + FutureOr resolvePath({ + String? id, + }) async { + assert(id != null, 'id must be defined for StoragePathWithIdentityId'); + return _pathBuilder(id!); + } +} diff --git a/packages/amplify_core/lib/src/types/storage/storage_types.dart b/packages/amplify_core/lib/src/types/storage/storage_types.dart index efab18581c..053a5ee9cc 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_types.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_types.dart @@ -50,6 +50,7 @@ export 'remove_options.dart'; export 'remove_request.dart'; export 'remove_result.dart'; export 'storage_item.dart'; +export 'storage_path.dart'; export 'transfer_progress.dart'; export 'upload_data_operation.dart'; export 'upload_data_options.dart'; From a69e1f958dc891fa8c3b87ad035b7096ca256b19 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 11 Mar 2024 18:25:17 -0400 Subject: [PATCH 02/46] chore: add `S3PathResolver` --- .../src/path_resolver/s3_path_resolver.dart | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart new file mode 100644 index 0000000000..b65fb61335 --- /dev/null +++ b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart @@ -0,0 +1,41 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'package:amplify_core/amplify_core.dart'; +import 'package:meta/meta.dart'; + +/// {@template amplify_storage_s3_dart.path_resolver} +/// Defines the interface of a S3 path resolver. +/// {@endtemplate} +@internal +class S3PathResolver { + /// {@macro amplify_storage_s3_dart.path_resolver} + const S3PathResolver({ + required TokenIdentityAmplifyAuthProvider identityProvider, + }) : _identityProvider = identityProvider; + + final TokenIdentityAmplifyAuthProvider _identityProvider; + + /// Get the identityProvider + @visibleForTesting + TokenAmplifyAuthProvider get identityProvider => _identityProvider; + + /// Resolve the full path. + Future resolvePath({ + required StoragePath path, + }) async { + switch (path) { + // ignore: invalid_use_of_internal_member + case final StoragePathFromString p: + return p.resolvePath(); + // ignore: invalid_use_of_internal_member + case final StoragePathWithIdentityId p: + final id = await _identityProvider.getIdentityId(); + return p.resolvePath(id: id); + default: + throw UnknownException( + 'Unhandled StoragePath type: ${path.runtimeType}', + ); + } + } +} From d9a44f93bb5ddfe7a8fa6efa6547fe14789ad280 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 11 Mar 2024 18:27:37 -0400 Subject: [PATCH 03/46] chore: update `getUrl` and `getProperties` API --- .../category/amplify_storage_category.dart | 10 ++- .../amplify_storage_plugin_interface.dart | 6 +- .../base/storage_operation_options.dart | 3 +- .../types/storage/get_properties_request.dart | 7 ++- .../src/types/storage/get_url_options.dart | 2 +- .../src/types/storage/get_url_request.dart | 7 ++- .../lib/src/amplify_storage_s3_dart_impl.dart | 17 ++++- .../service/storage_s3_service_impl.dart | 62 ++++++++++++++++--- 8 files changed, 93 insertions(+), 21 deletions(-) diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index 448e1dc1ed..366ac8d846 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -58,13 +58,16 @@ class StorageCategory extends AmplifyCategory { /// was uploaded. /// {@endtemplate} StorageGetPropertiesOperation getProperties({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, StorageGetPropertiesOptions? options, }) { + assert(key != null || path != null, 'key or path must be defined.'); return identifyCall( StorageCategoryMethod.getProperties, () => defaultPlugin.getProperties( key: key, + path: path, options: options, ), ); @@ -78,13 +81,16 @@ class StorageCategory extends AmplifyCategory { /// `https`. /// {@endtemplate} StorageGetUrlOperation getUrl({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, StorageGetUrlOptions? options, }) { + assert(key != null || path != null, 'key or path must be defined.'); return identifyCall( StorageCategoryMethod.getUrl, () => defaultPlugin.getUrl( key: key, + path: path, options: options, ), ); diff --git a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart index d863a37106..1a35c674da 100644 --- a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart +++ b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart @@ -24,7 +24,8 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.get_properties} StorageGetPropertiesOperation getProperties({ - required String key, + @Deprecated('Use `path` instead') String? key, + StoragePath? path, StorageGetPropertiesOptions? options, }) { throw UnimplementedError('getProperties() has not been implemented.'); @@ -32,7 +33,8 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.get_url} StorageGetUrlOperation getUrl({ - required String key, + @Deprecated('Use `path` instead') String? key, + StoragePath? path, StorageGetUrlOptions? options, }) { throw UnimplementedError('getUrl() has not been implemented.'); diff --git a/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart b/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart index 14d87654ae..9fddbec007 100644 --- a/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart +++ b/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart @@ -5,8 +5,9 @@ import 'package:amplify_core/src/types/storage/access_level.dart'; abstract class StorageOperationOptions { const StorageOperationOptions({ - this.accessLevel, + @Deprecated('Use `path` instead') this.accessLevel, }); + @Deprecated('Use `path` instead') final StorageAccessLevel? accessLevel; } diff --git a/packages/amplify_core/lib/src/types/storage/get_properties_request.dart b/packages/amplify_core/lib/src/types/storage/get_properties_request.dart index 2583ef55a6..2b00d8fcb2 100644 --- a/packages/amplify_core/lib/src/types/storage/get_properties_request.dart +++ b/packages/amplify_core/lib/src/types/storage/get_properties_request.dart @@ -9,12 +9,15 @@ import 'package:amplify_core/amplify_core.dart'; class StorageGetPropertiesRequest { /// {@macro amplify_core.storage.get_properties_request} const StorageGetPropertiesRequest({ - required this.key, + this.key, + this.path, this.options, }); /// Key of the object to get properties for. - final String key; + final String? key; + + final StoragePath? path; /// Configurable options of the [StorageGetPropertiesRequest]. final StorageGetPropertiesOptions? options; diff --git a/packages/amplify_core/lib/src/types/storage/get_url_options.dart b/packages/amplify_core/lib/src/types/storage/get_url_options.dart index f7163d6c55..9f0dfb9659 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_options.dart @@ -14,7 +14,7 @@ class StorageGetUrlOptions extends StorageOperationOptions AWSDebuggable { /// {@macro amplify_core.storage.get_url_options} const StorageGetUrlOptions({ - super.accessLevel, + @Deprecated('Use `path` to create the full file path') super.accessLevel, this.pluginOptions, }); diff --git a/packages/amplify_core/lib/src/types/storage/get_url_request.dart b/packages/amplify_core/lib/src/types/storage/get_url_request.dart index 785239ab01..65c54fb717 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_request.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_request.dart @@ -9,12 +9,15 @@ import 'package:amplify_core/amplify_core.dart'; class StorageGetUrlRequest { /// {@macro amplify_core.storage.get_url_request} const StorageGetUrlRequest({ - required this.key, + this.key, + this.path, this.options, }); /// Key of the object to get url for. - final String key; + final String? key; + + final StoragePath? path; /// Configurable options of the [StorageGetUrlRequest]. final StorageGetUrlOptions? options; diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index 9e63131c8e..a1b49431ae 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -8,6 +8,7 @@ import 'package:amplify_core/amplify_core.dart'; import 'package:amplify_db_common_dart/amplify_db_common_dart.dart' as db_common; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; import 'package:amplify_storage_s3_dart/src/platform_impl/download_file/download_file.dart' as download_file_impl; import 'package:amplify_storage_s3_dart/src/prefix_resolver/storage_access_level_aware_prefix_resolver.dart'; @@ -58,6 +59,8 @@ class AmplifyStorageS3Dart extends StoragePluginInterface S3PrefixResolver? _prefixResolver; + late S3PathResolver _pathResolver; + /// Gets prefix resolver for testing @visibleForTesting S3PrefixResolver? get prefixResolver => _prefixResolver; @@ -96,6 +99,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface identityProvider: identityProvider, ); + _pathResolver = S3PathResolver( + identityProvider: identityProvider, + ); + final credentialsProvider = authProviderRepo .getAuthProvider(APIAuthorizationType.iam.authProviderToken); @@ -117,6 +124,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface s3PluginConfig: s3PluginConfig, delimiter: _delimiter, prefixResolver: _prefixResolver!, + pathResolver: _pathResolver, logger: logger, dependencyManager: dependencies, ), @@ -161,7 +169,8 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3GetPropertiesOperation getProperties({ - required String key, + String? key, + StoragePath? path, StorageGetPropertiesOptions? options, }) { final s3PluginOptions = reifyPluginOptions( @@ -181,6 +190,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface ), result: storageS3Service.getProperties( key: key, + path: path, options: s3Options, ), ); @@ -188,7 +198,8 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3GetUrlOperation getUrl({ - required String key, + String? key, + StoragePath? path, StorageGetUrlOptions? options, }) { final s3PluginOptions = reifyPluginOptions( @@ -204,10 +215,12 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3GetUrlOperation( request: StorageGetUrlRequest( key: key, + path: path, options: options, ), result: storageS3Service.getUrl( key: key, + path: path, options: s3Options, ), ); diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index 926d20d0e9..9484006e96 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -8,6 +8,7 @@ import 'package:amplify_core/amplify_core.dart' hide PaginatedResult; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/exception/s3_storage_exception.dart' as s3_exception; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; import 'package:amplify_storage_s3_dart/src/sdk/s3.dart' as s3; import 'package:amplify_storage_s3_dart/src/sdk/src/s3/common/endpoint_resolver.dart' as endpoint_resolver; @@ -32,6 +33,7 @@ class StorageS3Service { factory StorageS3Service({ required S3PluginConfig s3PluginConfig, required S3PrefixResolver prefixResolver, + required S3PathResolver pathResolver, required AWSIamAmplifyAuthProvider credentialsProvider, required AWSLogger logger, required DependencyManager dependencyManager, @@ -57,6 +59,7 @@ class StorageS3Service { s3PluginConfig: s3PluginConfig, s3ClientConfig: s3ClientConfig, prefixResolver: prefixResolver, + pathResolver: pathResolver, credentialsProvider: credentialsProvider, logger: logger, dependencyManager: dependencyManager, @@ -68,6 +71,7 @@ class StorageS3Service { required S3PluginConfig s3PluginConfig, required smithy_aws.S3ClientConfig s3ClientConfig, required S3PrefixResolver prefixResolver, + required S3PathResolver pathResolver, required AWSIamAmplifyAuthProvider credentialsProvider, required AWSLogger logger, required DependencyManager dependencyManager, @@ -85,6 +89,7 @@ class StorageS3Service { ..supportedProtocols = SupportedProtocols.http1, ), _prefixResolver = prefixResolver, + _pathResolver = pathResolver, _logger = logger, // dependencyManager.get() => sigv4.AWSSigV4Signer is used for unit tests _awsSigV4Signer = dependencyManager.get() ?? @@ -102,6 +107,7 @@ class StorageS3Service { final smithy_aws.S3ClientConfig _defaultS3ClientConfig; final s3.S3Client _defaultS3Client; final S3PrefixResolver _prefixResolver; + final S3PathResolver _pathResolver; final AWSLogger _logger; final sigv4.AWSSigV4Signer _awsSigV4Signer; final DependencyManager _dependencyManager; @@ -205,30 +211,33 @@ class StorageS3Service { /// /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} Future getProperties({ - required String key, + String? key, + StoragePath? path, required StorageGetPropertiesOptions options, }) async { + assert(key != null || path != null, '"key" or "path" must be provided'); final s3PluginOptions = options.pluginOptions as S3GetPropertiesPluginOptions? ?? const S3GetPropertiesPluginOptions(); - final resolvedPrefix = await getResolvedPrefix( + final fullPath = await getResolvedPath( + pathResolver: _pathResolver, prefixResolver: _prefixResolver, logger: _logger, + path: path, + key: key, accessLevel: options.accessLevel ?? _s3PluginConfig.defaultAccessLevel, identityId: s3PluginOptions.targetIdentityId, ); - final keyToGetProperties = '$resolvedPrefix$key'; - return S3GetPropertiesResult( storageItem: S3Item.fromHeadObjectOutput( await headObject( s3client: _defaultS3Client, bucket: _s3PluginConfig.bucket, - key: keyToGetProperties, + key: fullPath, ), - key: key, + key: key ?? fullPath.split('/').last, ), ); } @@ -239,7 +248,8 @@ class StorageS3Service { /// /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} Future getUrl({ - required String key, + String? key, + StoragePath? path, required StorageGetUrlOptions options, }) async { final s3PluginOptions = options.pluginOptions as S3GetUrlPluginOptions? ?? @@ -265,18 +275,22 @@ class StorageS3Service { S3GetPropertiesPluginOptions.forIdentity(targetIdentityId), ); await getProperties( + path: path, key: key, options: getPropertiesOptions, ); } - final resolvedPrefix = await getResolvedPrefix( + final fullPath = await getResolvedPath( + pathResolver: _pathResolver, prefixResolver: _prefixResolver, logger: _logger, + path: path, + key: key, accessLevel: options.accessLevel ?? _s3PluginConfig.defaultAccessLevel, identityId: s3PluginOptions.targetIdentityId, ); - var keyToGetUrl = '$resolvedPrefix$key'; + var keyToGetUrl = fullPath; if (!keyToGetUrl.startsWith('/')) { keyToGetUrl = '/$keyToGetUrl'; } @@ -373,6 +387,7 @@ class StorageS3Service { defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, key: key, options: options, + pathResolver: _pathResolver, prefixResolver: _prefixResolver, logger: _logger, onProgress: onProgress, @@ -413,6 +428,7 @@ class StorageS3Service { defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, key: key, options: uploadDataOptions, + pathResolver: _pathResolver, prefixResolver: _prefixResolver, logger: _logger, onProgress: onProgress, @@ -724,6 +740,34 @@ class StorageS3Service { } } + /// Resolve a client object key to a "full" object key with proper prefix. + /// + /// This API is only used internally. + @internal + static Future getResolvedPath({ + required S3PathResolver pathResolver, + required S3PrefixResolver prefixResolver, + required AWSLogger logger, + StoragePath? path, + String? key, + required StorageAccessLevel accessLevel, + String? identityId, + }) async { + final String fullPath; + if (path != null) { + fullPath = await pathResolver.resolvePath(path: path); + } else { + final resolvedPrefix = await getResolvedPrefix( + prefixResolver: prefixResolver, + logger: logger, + accessLevel: accessLevel, + identityId: identityId, + ); + fullPath = '$resolvedPrefix$key'; + } + return fullPath; + } + /// Creates and sends a [s3.HeadObjectRequest] to S3 service, and then /// returns a [s3.HeadObjectOutput]. /// From 075824d36e8dc21551661b3f309d683224dffb57 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 11 Mar 2024 18:28:05 -0400 Subject: [PATCH 04/46] chore: update S3UploadTask --- .../service/task/s3_upload_task.dart | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart index 63cba5a0b4..b73be0ad1d 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart @@ -8,6 +8,7 @@ import 'package:amplify_core/amplify_core.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/exception/s3_storage_exception.dart' as s3_exception; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; import 'package:amplify_storage_s3_dart/src/sdk/s3.dart' as s3; import 'package:amplify_storage_s3_dart/src/storage_s3_service/service/task/part_size_util.dart' as part_size_util; @@ -49,6 +50,7 @@ class S3UploadTask { required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, required S3PrefixResolver prefixResolver, + required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, required String key, @@ -60,6 +62,7 @@ class S3UploadTask { required transfer.TransferDatabase transferDatabase, }) : _s3Client = s3Client, _defaultS3ClientConfig = defaultS3ClientConfig, + _pathResolver = pathResolver, _prefixResolver = prefixResolver, _bucket = bucket, _defaultAccessLevel = defaultAccessLevel, @@ -84,6 +87,7 @@ class S3UploadTask { required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, required S3PrefixResolver prefixResolver, + required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, required String key, @@ -94,6 +98,7 @@ class S3UploadTask { }) : this._( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, + pathResolver: pathResolver, prefixResolver: prefixResolver, bucket: bucket, defaultAccessLevel: defaultAccessLevel, @@ -113,6 +118,7 @@ class S3UploadTask { required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, required S3PrefixResolver prefixResolver, + required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, required String key, @@ -124,6 +130,7 @@ class S3UploadTask { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: prefixResolver, + pathResolver: pathResolver, bucket: bucket, defaultAccessLevel: defaultAccessLevel, key: key, @@ -142,6 +149,7 @@ class S3UploadTask { final s3.S3Client _s3Client; final smithy_aws.S3ClientConfig _defaultS3ClientConfig; final S3PrefixResolver _prefixResolver; + final S3PathResolver _pathResolver; final String _bucket; final StorageAccessLevel _defaultAccessLevel; final String _key; @@ -314,13 +322,13 @@ class S3UploadTask { } Future _setResolvedKey() async { - final resolvedPrefix = await StorageS3Service.getResolvedPrefix( + _resolvedKey = await StorageS3Service.getResolvedPath( + pathResolver: _pathResolver, prefixResolver: _prefixResolver, logger: _logger, accessLevel: _options.accessLevel ?? _defaultAccessLevel, + key: _key, ); - - _resolvedKey = '$resolvedPrefix$_key'; } Future _startPutObject(S3DataPayload body) async { From e7f3dbeb25e1443b3018cf4a3631d29845d4bbea Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Tue, 12 Mar 2024 13:41:28 -0400 Subject: [PATCH 05/46] chore: fix tests --- .../src/path_resolver/s3_path_resolver.dart | 4 --- .../storage_s3_service_test.dart | 5 +++ .../task/s3_upload_task_test.dart | 31 +++++++++++++++++++ .../test/test_utils/test_path_resolver.dart | 12 +++++++ 4 files changed, 48 insertions(+), 4 deletions(-) create mode 100644 packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart index b65fb61335..f1d8f96024 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart @@ -16,10 +16,6 @@ class S3PathResolver { final TokenIdentityAmplifyAuthProvider _identityProvider; - /// Get the identityProvider - @visibleForTesting - TokenAmplifyAuthProvider get identityProvider => _identityProvider; - /// Resolve the full path. Future resolvePath({ required StoragePath path, diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart index e40236a7f4..a206c21d71 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart @@ -15,6 +15,7 @@ import 'package:test/test.dart'; import '../test_utils/custom_matchers.dart'; import '../test_utils/mocks.dart'; +import '../test_utils/test_path_resolver.dart'; import '../test_utils/test_token_provider.dart'; const testDelimiter = '#'; @@ -41,6 +42,7 @@ void main() { S3PluginConfig(bucket: testBucket, region: testRegion); final testPrefixResolver = TestPrefixResolver(); + final pathResolver = TestPathResolver(); late DependencyManager dependencyManager; late S3Client s3Client; late StorageS3Service storageS3Service; @@ -57,6 +59,7 @@ void main() { storageS3Service = StorageS3Service( s3PluginConfig: s3PluginConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, credentialsProvider: TestIamAuthProvider(), logger: logger, dependencyManager: dependencyManager, @@ -70,6 +73,7 @@ void main() { region: 'us-west-2', ), prefixResolver: testPrefixResolver, + pathResolver: pathResolver, credentialsProvider: TestIamAuthProvider(), logger: logger, dependencyManager: dependencyManager, @@ -868,6 +872,7 @@ void main() { pathStyleStorageS3Service = StorageS3Service( s3PluginConfig: pathStyleS3PluginConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, credentialsProvider: TestIamAuthProvider(), logger: MockAWSLogger(), dependencyManager: dependencyManager, diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart index 2d87e7b9f9..7ff50b6805 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart @@ -20,6 +20,7 @@ import 'package:test/test.dart'; import '../../test_utils/io_mocks.dart'; import '../../test_utils/mocks.dart'; import '../../test_utils/test_custom_prefix_resolver.dart'; +import '../../test_utils/test_path_resolver.dart'; void main() { group('S3UploadTask', () { @@ -29,6 +30,7 @@ void main() { const testBucket = 'fake-bucket'; const defaultS3ClientConfig = smithy_aws.S3ClientConfig(); final testPrefixResolver = TestCustomPrefixResolver(); + final pathResolver = TestPathResolver(); const testUploadDataOptions = StorageUploadDataOptions( accessLevel: StorageAccessLevel.private, ); @@ -117,6 +119,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -180,6 +183,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -231,6 +235,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -302,6 +307,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -337,6 +343,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: prefixResolverThrowsException, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -369,6 +376,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -407,6 +415,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -453,6 +462,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -506,6 +516,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -570,6 +581,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -627,6 +639,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -682,6 +695,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -822,6 +836,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1012,6 +1027,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1105,6 +1121,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1207,6 +1224,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1245,6 +1263,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1278,6 +1297,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1308,6 +1328,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1353,6 +1374,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1399,6 +1421,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1443,6 +1466,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1525,6 +1549,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1618,6 +1643,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1712,6 +1738,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1783,6 +1810,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1940,6 +1968,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -1999,6 +2028,7 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: testKey, @@ -2064,6 +2094,7 @@ void main() { defaultS3ClientConfig: const smithy_aws.S3ClientConfig(usePathStyle: true), prefixResolver: testPrefixResolver, + pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, key: 'fake-key', diff --git a/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart new file mode 100644 index 0000000000..b6dde40c24 --- /dev/null +++ b/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart @@ -0,0 +1,12 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'package:amplify_core/amplify_core.dart'; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; + +class TestPathResolver implements S3PathResolver { + @override + Future resolvePath({required StoragePath path}) async { + return '/mock/path'; + } +} From 76654850c88a90bf883203eb32b5f7ae84ee368a Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Tue, 12 Mar 2024 14:43:12 -0400 Subject: [PATCH 06/46] chore: validate storage path --- .../types/exception/amplify_exception.dart | 1 + .../storage/path_validation_exception.dart | 19 ++++++++++++++++ .../src/path_resolver/s3_path_resolver.dart | 22 +++++++++++-------- 3 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart diff --git a/packages/amplify_core/lib/src/types/exception/amplify_exception.dart b/packages/amplify_core/lib/src/types/exception/amplify_exception.dart index 666facb221..fa5a7ea65a 100644 --- a/packages/amplify_core/lib/src/types/exception/amplify_exception.dart +++ b/packages/amplify_core/lib/src/types/exception/amplify_exception.dart @@ -24,6 +24,7 @@ part 'storage/http_status_exception.dart'; part 'storage/key_not_found_exception.dart'; part 'storage/local_file_not_found_exception.dart'; part 'storage/operation_canceled_exception.dart'; +part 'storage/path_validation_exception.dart'; part 'storage/storage_exception.dart'; part 'unknown_exception.dart'; diff --git a/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart b/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart new file mode 100644 index 0000000000..0f65cee1ff --- /dev/null +++ b/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart @@ -0,0 +1,19 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +part of '../amplify_exception.dart'; + +/// {@template amplify_core.storage.path_validation_exception} +/// Exception thrown when the service request receives access denied error. +/// {@endtemplate} +class StoragePathValidationException extends StorageException { + /// {@macro amplify_core.storage.path_validation_exception} + const StoragePathValidationException( + super.message, { + super.recoverySuggestion, + super.underlyingException, + }); + + @override + String get runtimeTypeName => 'StoragePathValidationException'; +} diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart index f1d8f96024..810d77711e 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart @@ -20,18 +20,22 @@ class S3PathResolver { Future resolvePath({ required StoragePath path, }) async { - switch (path) { + final resolvedPath = await switch (path) { // ignore: invalid_use_of_internal_member - case final StoragePathFromString p: - return p.resolvePath(); + final StoragePathFromString p => p.resolvePath(), // ignore: invalid_use_of_internal_member - case final StoragePathWithIdentityId p: - final id = await _identityProvider.getIdentityId(); - return p.resolvePath(id: id); - default: - throw UnknownException( + final StoragePathWithIdentityId p => + p.resolvePath(id: await _identityProvider.getIdentityId()), + _ => throw UnknownException( 'Unhandled StoragePath type: ${path.runtimeType}', - ); + ) + }; + if (!resolvedPath.startsWith('/')) { + throw const StoragePathValidationException( + 'StoragePath must start with a leading "/"', + recoverySuggestion: 'Update the provided path to include a leading "/"', + ); } + return resolvedPath; } } From 669f1e55f99cc261b0d0d540ad75dab6b355f04e Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Tue, 12 Mar 2024 14:43:37 -0400 Subject: [PATCH 07/46] chore: add tests for S3PathResolver --- .../path_resolver/path_resolver_test.dart | 58 +++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100644 packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart diff --git a/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart b/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart new file mode 100644 index 0000000000..62419557a1 --- /dev/null +++ b/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart @@ -0,0 +1,58 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'package:amplify_core/amplify_core.dart'; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; +import 'package:test/test.dart'; + +class MockTokenIdentityAmplifyAuthProvider + implements TokenIdentityAmplifyAuthProvider { + @override + Future authorizeRequest( + AWSBaseHttpRequest request, { + covariant AuthProviderOptions? options, + }) { + throw UnimplementedError(); + } + + @override + Future getIdentityId() async { + return 'mock-id'; + } + + @override + Future getLatestAuthToken() => throw UnimplementedError(); +} + +void main() { + group('S3PathResolver', () { + final pathResolver = S3PathResolver( + identityProvider: MockTokenIdentityAmplifyAuthProvider(), + ); + + test('should resolve static strings', () async { + final path = StoragePath.fromString('/foo/bar/picture.png'); + expect( + await pathResolver.resolvePath(path: path), + '/foo/bar/picture.png', + ); + }); + + test('should resolve path with identity Id', () async { + final path = StoragePath.withIdentityId((id) => '/foo/$id/picture.png'); + expect( + await pathResolver.resolvePath(path: path), + '/foo/mock-id/picture.png', + ); + }); + + test('should throw if the path does not start with a leading "/"', + () async { + final path = StoragePath.fromString('foo/bar/picture.png'); + expect( + () => pathResolver.resolvePath(path: path), + throwsA(isA()), + ); + }); + }); +} From 2ede7fac88b522886e61edf3c1e5c96b2b32f7c6 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Wed, 13 Mar 2024 10:23:20 -0700 Subject: [PATCH 08/46] feat: Gen 2 Upload APIs (#4542) * feat: add path parameter and made key optional Co-Authored-By: Jordan Nelson <20613561+Jordan-Nelson@users.noreply.github.com> * chore: added/modified unit tests and added a missing deprecation tag Co-Authored-By: Jordan Nelson <20613561+Jordan-Nelson@users.noreply.github.com> * chore: added extra assert statement to make sure users don't put in both path and key into upload method Co-Authored-By: Jordan Nelson <20613561+Jordan-Nelson@users.noreply.github.com> * chore: add ignore statements to ignore key deprecated warnings * chore: add ignore statements for deprecated members --------- Co-authored-by: Jordan Nelson <20613561+Jordan-Nelson@users.noreply.github.com> --- packages/amplify_core/lib/amplify_core.dart | 22 +- .../category/amplify_storage_category.dart | 14 +- .../amplify_storage_plugin_interface.dart | 6 +- .../types/storage/download_data_options.dart | 2 + .../types/storage/download_file_options.dart | 2 + .../types/storage/get_properties_options.dart | 2 + .../src/types/storage/get_url_options.dart | 2 + .../lib/src/types/storage/list_options.dart | 2 + .../types/storage/remove_many_options.dart | 2 + .../lib/src/types/storage/remove_options.dart | 2 + .../lib/src/types/storage/storage_item.dart | 2 + .../types/storage/upload_data_options.dart | 2 + .../types/storage/upload_data_request.dart | 4 +- .../types/storage/upload_file_options.dart | 2 + .../lib/src/amplify_storage_s3_dart_impl.dart | 14 +- .../lib/src/model/s3_item.dart | 8 + .../service/storage_s3_service_impl.dart | 18 +- .../service/task/s3_download_task.dart | 2 +- .../service/task/s3_upload_task.dart | 28 +- .../task/s3_upload_task_test.dart | 482 ++++++++++++++++-- .../test/test_utils/test_path_resolver.dart | 4 +- 21 files changed, 543 insertions(+), 79 deletions(-) diff --git a/packages/amplify_core/lib/amplify_core.dart b/packages/amplify_core/lib/amplify_core.dart index 4add5a25ab..7d281991cc 100644 --- a/packages/amplify_core/lib/amplify_core.dart +++ b/packages/amplify_core/lib/amplify_core.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: invalid_export_of_internal_element + library amplify_core; import 'package:amplify_core/src/amplify_class.dart'; @@ -11,11 +13,9 @@ export 'package:aws_signature_v4/aws_signature_v4.dart' show AWSCredentials, ServiceConfiguration; export 'src/amplify_class.dart'; - /// Categories export 'src/category/amplify_auth_category.dart'; export 'src/category/amplify_categories.dart'; - /// Config export 'src/config/amplify_config.dart'; export 'src/config/amplify_plugin_config.dart' hide UnknownPluginConfigFactory; @@ -26,19 +26,15 @@ export 'src/config/auth/auth_config.dart'; export 'src/config/config_map.dart'; export 'src/config/notifications/notifications_config.dart'; export 'src/config/storage/storage_config.dart'; - /// HTTP export 'src/http/amplify_http_client.dart'; export 'src/http/amplify_user_agent.dart'; - /// Hub export 'src/hub/amplify_hub.dart'; export 'src/hub/hub_channel.dart'; export 'src/hub/hub_event.dart'; - /// Logger export 'src/logger/amplify_logger.dart'; - /// Plugin export 'src/plugin/amplify_analytics_plugin_interface.dart'; export 'src/plugin/amplify_api_plugin_interface.dart'; @@ -48,7 +44,6 @@ export 'src/plugin/amplify_plugin_interface.dart'; export 'src/plugin/amplify_plugin_key.dart'; export 'src/plugin/amplify_push_notifications_plugin_interface.dart'; export 'src/plugin/amplify_storage_plugin_interface.dart'; - /// State Machine export 'src/state_machine/amplify_dependency_manager.dart'; export 'src/state_machine/dependency_manager.dart'; @@ -58,25 +53,18 @@ export 'src/state_machine/state.dart'; export 'src/state_machine/state_machine.dart'; export 'src/state_machine/token.dart'; export 'src/state_machine/transition.dart'; - /// Analytics export 'src/types/analytics/analytics_types.dart'; - /// API export 'src/types/api/api_types.dart'; - /// App path provider export 'src/types/app_path_provider/app_path_provider.dart'; - /// Auth export 'src/types/auth/auth_types.dart'; - /// Auth providers export 'src/types/common/amplify_auth_provider.dart'; - /// Datastore export 'src/types/datastore/datastore_types.dart' hide DateTimeParse; - /// Exceptions export 'src/types/exception/amplify_already_configured_exception.dart'; export 'src/types/exception/amplify_exception.dart'; @@ -86,7 +74,6 @@ export 'src/types/exception/error/amplify_error.dart'; export 'src/types/exception/error/configuration_error.dart'; export 'src/types/exception/error/plugin_error.dart'; export 'src/types/exception/url_launcher_exception.dart'; - /// Model-based types used in datastore and API export 'src/types/models/auth_rule.dart'; export 'src/types/models/model.dart'; @@ -98,24 +85,19 @@ export 'src/types/models/model_index.dart'; export 'src/types/models/model_provider.dart'; export 'src/types/models/model_schema.dart'; export 'src/types/models/model_schema_definition.dart'; - /// Notifications export 'src/types/notifications/notification_types.dart'; - /// Query export 'src/types/query/query_exception.dart'; export 'src/types/query/query_field.dart'; export 'src/types/query/query_model_identifier.dart'; - /// Storage export 'src/types/storage/storage_types.dart'; - /// Temporal export 'src/types/temporal/temporal_date.dart'; export 'src/types/temporal/temporal_datetime.dart'; export 'src/types/temporal/temporal_time.dart'; export 'src/types/temporal/temporal_timestamp.dart'; - /// Util export 'src/util/parsers.dart'; export 'src/util/serializable.dart'; diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index 366ac8d846..ef3dd07928 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + part of 'amplify_categories.dart'; /// {@template amplify_core.amplify_storage_category} @@ -63,6 +65,7 @@ class StorageCategory extends AmplifyCategory { StorageGetPropertiesOptions? options, }) { assert(key != null || path != null, 'key or path must be defined.'); + assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.getProperties, () => defaultPlugin.getProperties( @@ -86,6 +89,7 @@ class StorageCategory extends AmplifyCategory { StorageGetUrlOptions? options, }) { assert(key != null || path != null, 'key or path must be defined.'); + assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.getUrl, () => defaultPlugin.getUrl( @@ -150,14 +154,18 @@ class StorageCategory extends AmplifyCategory { /// {@endtemplate} StorageUploadDataOperation uploadData({ required StorageDataPayload data, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, void Function(StorageTransferProgress)? onProgress, StorageUploadDataOptions? options, }) { + assert(key != null || path != null, 'key or path must be defined.'); + assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.uploadData, () => defaultPlugin.uploadData( key: key, + path: path, data: data, onProgress: onProgress, options: options, @@ -175,7 +183,8 @@ class StorageCategory extends AmplifyCategory { /// {@endtemplate} StorageUploadFileOperation uploadFile({ required AWSFile localFile, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, void Function(StorageTransferProgress)? onProgress, StorageUploadFileOptions? options, }) { @@ -183,6 +192,7 @@ class StorageCategory extends AmplifyCategory { StorageCategoryMethod.uploadFile, () => defaultPlugin.uploadFile( key: key, + path: path, localFile: localFile, onProgress: onProgress, options: options, diff --git a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart index 1a35c674da..c44e1fbbb5 100644 --- a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart +++ b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart @@ -61,7 +61,8 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.upload_data} StorageUploadDataOperation uploadData({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required StorageDataPayload data, void Function(StorageTransferProgress)? onProgress, StorageUploadDataOptions? options, @@ -71,7 +72,8 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.upload_file} StorageUploadFileOperation uploadFile({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required AWSFile localFile, void Function(StorageTransferProgress)? onProgress, StorageUploadFileOptions? options, diff --git a/packages/amplify_core/lib/src/types/storage/download_data_options.dart b/packages/amplify_core/lib/src/types/storage/download_data_options.dart index 59e35e964f..b872994a99 100644 --- a/packages/amplify_core/lib/src/types/storage/download_data_options.dart +++ b/packages/amplify_core/lib/src/types/storage/download_data_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/download_file_options.dart b/packages/amplify_core/lib/src/types/storage/download_file_options.dart index 7153e701df..4ac55acbf8 100644 --- a/packages/amplify_core/lib/src/types/storage/download_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/download_file_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/get_properties_options.dart b/packages/amplify_core/lib/src/types/storage/get_properties_options.dart index 325c3f0d20..7b9c3c8aae 100644 --- a/packages/amplify_core/lib/src/types/storage/get_properties_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_properties_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/get_url_options.dart b/packages/amplify_core/lib/src/types/storage/get_url_options.dart index 9f0dfb9659..68818c6903 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/list_options.dart b/packages/amplify_core/lib/src/types/storage/list_options.dart index 82b29851a4..cf0998d3a9 100644 --- a/packages/amplify_core/lib/src/types/storage/list_options.dart +++ b/packages/amplify_core/lib/src/types/storage/list_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/remove_many_options.dart b/packages/amplify_core/lib/src/types/storage/remove_many_options.dart index 02944ef13a..2f05ed0cc7 100644 --- a/packages/amplify_core/lib/src/types/storage/remove_many_options.dart +++ b/packages/amplify_core/lib/src/types/storage/remove_many_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/remove_options.dart b/packages/amplify_core/lib/src/types/storage/remove_options.dart index 2cf3b53f16..35fd190e7a 100644 --- a/packages/amplify_core/lib/src/types/storage/remove_options.dart +++ b/packages/amplify_core/lib/src/types/storage/remove_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/storage_item.dart b/packages/amplify_core/lib/src/types/storage/storage_item.dart index 9fa9aef80c..0f780e8576 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_item.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_item.dart @@ -10,6 +10,7 @@ class StorageItem { /// {@macro amplify_core.storage.storage_item} const StorageItem({ required this.key, + this.path = '', this.size, this.lastModified, this.eTag, @@ -17,6 +18,7 @@ class StorageItem { }); final String key; + final String path; final int? size; final DateTime? lastModified; final String? eTag; diff --git a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart index be3e502131..58f96e5c9b 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/upload_data_request.dart b/packages/amplify_core/lib/src/types/storage/upload_data_request.dart index b21b9501cf..b15287f713 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_data_request.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_data_request.dart @@ -10,12 +10,12 @@ class StorageUploadDataRequest { /// {@macro amplify_core.storage.upload_data_request} const StorageUploadDataRequest({ required this.data, - required this.key, + @Deprecated('Use StorageUploadDataResult.uploadedItem.path instead') required this.key, this.options, }); /// The key of the object upload to. - final String key; + @Deprecated('Use StorageUploadDataResult.uploadedItem.path instead') final String key; /// The data payload to upload. final StorageDataPayload data; diff --git a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart index e8718f2ab4..7e91eeb7e5 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index a1b49431ae..f3184b7b65 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use, deprecated_member_use_from_same_package + import 'dart:async'; import 'dart:typed_data'; @@ -296,7 +298,8 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3UploadDataOperation uploadData({ required StorageDataPayload data, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, void Function(S3TransferProgress)? onProgress, StorageUploadDataOptions? options, }) { @@ -313,6 +316,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface final uploadTask = storageS3Service.uploadData( key: key, + path: path, dataPayload: data, options: s3Options, onProgress: onProgress, @@ -321,7 +325,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3UploadDataOperation( request: StorageUploadDataRequest( data: data, - key: key, + key: key ?? '', options: options, ), result: uploadTask.result.then( @@ -334,7 +338,8 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3UploadFileOperation uploadFile({ required AWSFile localFile, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, void Function(S3TransferProgress)? onProgress, StorageUploadFileOptions? options, }) { @@ -351,6 +356,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface final uploadTask = storageS3Service.uploadFile( key: key, + path: path, localFile: localFile, options: s3Options, onProgress: onProgress, @@ -359,7 +365,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3UploadFileOperation( request: StorageUploadFileRequest( localFile: localFile, - key: key, + key: key ?? '', options: options, ), result: uploadTask.result.then( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart index c0238cf6dc..aa14a26126 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart @@ -20,6 +20,7 @@ class S3Item extends StorageItem /// {@macro storage.amplify_storage_s3.storage_s3_item} S3Item({ required super.key, + super.path, super.size, super.lastModified, super.eTag, @@ -34,6 +35,7 @@ class S3Item extends StorageItem ? storageItem : S3Item( key: storageItem.key, + path: storageItem.path, size: storageItem.size, lastModified: storageItem.lastModified, eTag: storageItem.eTag, @@ -68,6 +70,7 @@ class S3Item extends StorageItem return S3Item( key: keyDroppedPrefix, + path: key, size: object.size?.toInt(), lastModified: object.lastModified, eTag: object.eTag, @@ -80,9 +83,11 @@ class S3Item extends StorageItem factory S3Item.fromHeadObjectOutput( s3.HeadObjectOutput headObjectOutput, { required String key, + required String path, }) { return S3Item( key: key, + path: path, lastModified: headObjectOutput.lastModified, eTag: headObjectOutput.eTag, metadata: headObjectOutput.metadata?.toMap() ?? const {}, @@ -98,9 +103,11 @@ class S3Item extends StorageItem factory S3Item.fromGetObjectOutput( s3.GetObjectOutput getObjectOutput, { required String key, + required String path, }) { return S3Item( key: key, + path: path, lastModified: getObjectOutput.lastModified, eTag: getObjectOutput.eTag, metadata: getObjectOutput.metadata?.toMap() ?? const {}, @@ -128,6 +135,7 @@ class S3Item extends StorageItem @override List get props => [ key, + path, size, lastModified, eTag, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index 9484006e96..184e612664 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use + import 'dart:async'; import 'dart:math'; @@ -237,7 +239,8 @@ class StorageS3Service { bucket: _s3PluginConfig.bucket, key: fullPath, ), - key: key ?? fullPath.split('/').last, + key: key ?? fullPath, + path: fullPath, ), ); } @@ -372,7 +375,8 @@ class StorageS3Service { /// a [S3UploadTask], to start the upload process, then returns the /// [S3UploadTask]. S3UploadTask uploadData({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required S3DataPayload dataPayload, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, @@ -386,6 +390,7 @@ class StorageS3Service { bucket: _s3PluginConfig.bucket, defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, key: key, + path: path, options: options, pathResolver: _pathResolver, prefixResolver: _prefixResolver, @@ -403,7 +408,8 @@ class StorageS3Service { /// a [S3UploadTask], to start the upload process, then returns the /// [S3UploadTask]. S3UploadTask uploadFile({ - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required AWSFile localFile, required StorageUploadFileOptions options, void Function(S3TransferProgress)? onProgress, @@ -427,6 +433,7 @@ class StorageS3Service { bucket: _s3PluginConfig.bucket, defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, key: key, + path: path, options: uploadDataOptions, pathResolver: _pathResolver, prefixResolver: _prefixResolver, @@ -504,8 +511,9 @@ class StorageS3Service { key: destinationKey, ), key: destination.storageItem.key, + path: destination.storageItem.path, ) - : S3Item(key: destination.storageItem.key), + : S3Item(key: destination.storageItem.key, path: destination.storageItem.path), ); } @@ -606,7 +614,7 @@ class StorageS3Service { ); return S3RemoveResult( - removedItem: S3Item(key: key), + removedItem: S3Item(key: key, path: key), ); } diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart index cb16ea5468..2f2b2d7e4a 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart @@ -176,7 +176,7 @@ class S3DownloadTask { _totalBytes = remoteSize; _listenToBytesSteam(getObjectOutput.body); _downloadedS3Item = - S3Item.fromGetObjectOutput(getObjectOutput, key: _key); + S3Item.fromGetObjectOutput(getObjectOutput, key: _key, path: _resolvedKey); } on Exception catch (error, stackTrace) { await _completeDownloadWithError(error, stackTrace); } diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart index b73be0ad1d..23a1168729 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use, deprecated_member_use_from_same_package + import 'dart:async'; import 'dart:math'; @@ -53,7 +55,8 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required StorageUploadDataOptions options, S3DataPayload? dataPayload, AWSFile? localFile, @@ -67,6 +70,7 @@ class S3UploadTask { _bucket = bucket, _defaultAccessLevel = defaultAccessLevel, _key = key, + _path = path, _options = options, _dataPayload = dataPayload, _localFile = localFile, @@ -90,7 +94,8 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - required String key, + @Deprecated('use `path` instead.') String? key, + StoragePath? path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, required AWSLogger logger, @@ -103,6 +108,7 @@ class S3UploadTask { bucket: bucket, defaultAccessLevel: defaultAccessLevel, key: key, + path: path, dataPayload: dataPayload, options: options, onProgress: onProgress, @@ -121,7 +127,8 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - required String key, + @Deprecated('use `path` instead.') String? key, + final StoragePath? path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, required AWSLogger logger, @@ -134,6 +141,7 @@ class S3UploadTask { bucket: bucket, defaultAccessLevel: defaultAccessLevel, key: key, + path: path, localFile: localFile, options: options, onProgress: onProgress, @@ -152,7 +160,8 @@ class S3UploadTask { final S3PathResolver _pathResolver; final String _bucket; final StorageAccessLevel _defaultAccessLevel; - final String _key; + final String? _key; + final StoragePath? _path; final StorageUploadDataOptions _options; final void Function(S3TransferProgress)? _onProgress; final AWSLogger _logger; @@ -328,6 +337,7 @@ class S3UploadTask { logger: _logger, accessLevel: _options.accessLevel ?? _defaultAccessLevel, key: _key, + path: _path, ); } @@ -367,9 +377,10 @@ class S3UploadTask { bucket: _bucket, key: _resolvedKey, ), - key: _key, + key: _key ?? _resolvedKey, + path: _resolvedKey, ) - : S3Item(key: _key), + : S3Item(key: _key ?? _resolvedKey, path: _resolvedKey), ); _state = StorageTransferState.success; @@ -476,9 +487,10 @@ class S3UploadTask { bucket: _bucket, key: _resolvedKey, ), - key: _key, + key: _key ?? _resolvedKey, + path: _resolvedKey, ) - : S3Item(key: _key), + : S3Item(key: _key ?? _resolvedKey, path: _resolvedKey), ); _state = StorageTransferState.success; _emitTransferProgress(); diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart index 7ff50b6805..2cde0e4792 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart @@ -1,6 +1,8 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +// ignore_for_file: deprecated_member_use_from_same_package + import 'dart:async'; import 'dart:typed_data'; @@ -93,7 +95,7 @@ void main() { group('Uploading S3DataPayload', () { final testDataPayload = S3DataPayload.string('Upload me please!'); final testDataPayloadBytes = S3DataPayload.bytes([101, 102]); - const testKey = 'object-upload-to'; + const testPath = '/object-upload-to'; test( 'should invoke S3Client.putObject API with expected parameters and default access level', @@ -113,6 +115,10 @@ void main() { s3ClientConfig: any(named: 's3ClientConfig'), ), ).thenAnswer((_) => smithyOperation); + + final resolvedPath = '${await testPrefixResolver.resolvePrefix( + accessLevel: testDefaultAccessLevel, + )}$testPath'; final uploadDataTask = S3UploadTask.fromDataPayload( testDataPayload, @@ -122,7 +128,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + key: testPath, options: const StorageUploadDataOptions(), logger: logger, transferDatabase: transferDatabase, @@ -132,7 +138,8 @@ void main() { final result = await uploadDataTask.result; - expect(result.key, testKey); + expect(result.key, testPath); + expect(result.path, resolvedPath); final capturedRequest = verify( () => s3Client.putObject( @@ -146,9 +153,64 @@ void main() { expect(request.bucket, testBucket); expect( request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testDefaultAccessLevel, - )}$testKey', + resolvedPath, + ); + expect(request.body, testDataPayload); + }); + + test( + 'should invoke S3Client.putObject API with expected parameters and default access level with path', + () async { + final testPutObjectOutput = s3.PutObjectOutput(); + final smithyOperation = MockSmithyOperation(); + + when( + () => smithyOperation.result, + ).thenAnswer((_) async => testPutObjectOutput); + when(() => smithyOperation.requestProgress) + .thenAnswer((_) => Stream.value(1)); + + when( + () => s3Client.putObject( + any(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).thenAnswer((_) => smithyOperation); + + final uploadDataTask = S3UploadTask.fromDataPayload( + testDataPayload, + s3Client: s3Client, + defaultS3ClientConfig: defaultS3ClientConfig, + prefixResolver: testPrefixResolver, + pathResolver: pathResolver, + bucket: testBucket, + defaultAccessLevel: testDefaultAccessLevel, + path: StoragePath.fromString(testPath), + options: const StorageUploadDataOptions(), + logger: logger, + transferDatabase: transferDatabase, + ); + + unawaited(uploadDataTask.start()); + + final result = await uploadDataTask.result; + + expect(result.key, TestPathResolver.path); + expect(result.path, TestPathResolver.path); + + final capturedRequest = verify( + () => s3Client.putObject( + captureAny(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).captured.last; + + expect(capturedRequest is s3.PutObjectRequest, isTrue); + final request = capturedRequest as s3.PutObjectRequest; + expect(request.bucket, testBucket); + expect( + request.key, + TestPathResolver.path, ); expect(request.body, testDataPayload); }); @@ -157,7 +219,6 @@ void main() { 'should invoke S3Client.putObject API with correct useAcceleration parameters', () async { const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3UploadDataPluginOptions( useAccelerateEndpoint: true, ), @@ -186,7 +247,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -238,7 +299,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -310,7 +371,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + key: testPath, options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -330,7 +391,73 @@ void main() { request.key, '${await testPrefixResolver.resolvePrefix( accessLevel: testUploadDataOptions.accessLevel!, - )}$testKey', + )}$testPath', + ); + }); + + test( + 'should invoke S3Client.headObject API with correct parameters when getProperties is set to true in the options with path', + () async { + const testUploadDataOptions = StorageUploadDataOptions( + accessLevel: StorageAccessLevel.private, + pluginOptions: S3UploadDataPluginOptions( + getProperties: true, + ), + ); + final testPutObjectOutput = s3.PutObjectOutput(); + final putSmithyOperation = MockSmithyOperation(); + final testHeadObjectOutput = s3.HeadObjectOutput(); + final headSmithyOperation = MockSmithyOperation(); + + when( + () => putSmithyOperation.result, + ).thenAnswer((_) async => testPutObjectOutput); + when( + () => putSmithyOperation.requestProgress, + ).thenAnswer((_) => Stream.value(1)); + + when( + () => headSmithyOperation.result, + ).thenAnswer((_) async => testHeadObjectOutput); + + when( + () => s3Client.putObject( + any(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).thenAnswer((_) => putSmithyOperation); + + when( + () => s3Client.headObject(any()), + ).thenAnswer((_) => headSmithyOperation); + + final uploadDataTask = S3UploadTask.fromDataPayload( + testDataPayload, + s3Client: s3Client, + defaultS3ClientConfig: defaultS3ClientConfig, + prefixResolver: testPrefixResolver, + pathResolver: pathResolver, + bucket: testBucket, + defaultAccessLevel: testDefaultAccessLevel, + path: StoragePath.fromString(testPath), + options: testUploadDataOptions, + logger: logger, + transferDatabase: transferDatabase, + ); + + unawaited(uploadDataTask.start()); + await uploadDataTask.result; + + final capturedRequest = verify( + () => s3Client.headObject(captureAny()), + ).captured.last; + + expect(capturedRequest is s3.HeadObjectRequest, isTrue); + final request = capturedRequest as s3.HeadObjectRequest; + expect(request.bucket, testBucket); + expect( + request.key, + TestPathResolver.path, ); }); @@ -346,7 +473,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + key: testPath, options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -379,7 +506,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -418,7 +545,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -465,7 +592,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -551,6 +678,63 @@ void main() { expect(await request.body.toList(), equals([testBytes])); }); + test('should invoke S3Client.putObject with expected parameters with path', + () async { + final testPutObjectOutput = s3.PutObjectOutput(); + final smithyOperation = MockSmithyOperation(); + + when( + () => smithyOperation.result, + ).thenAnswer((_) async => testPutObjectOutput); + when(() => smithyOperation.requestProgress) + .thenAnswer((_) => Stream.value(1)); + + when( + () => s3Client.putObject( + any(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).thenAnswer((_) => smithyOperation); + + final uploadDataTask = S3UploadTask.fromAWSFile( + testLocalFile, + s3Client: s3Client, + defaultS3ClientConfig: defaultS3ClientConfig, + prefixResolver: testPrefixResolver, + pathResolver: pathResolver, + bucket: testBucket, + defaultAccessLevel: testDefaultAccessLevel, + path: StoragePath.fromString(testKey), + options: testUploadDataOptions, + logger: logger, + transferDatabase: transferDatabase, + ); + + unawaited(uploadDataTask.start()); + + final result = await uploadDataTask.result; + + expect(result.key, TestPathResolver.path); + expect(result.path, TestPathResolver.path); + + final capturedRequest = verify( + () => s3Client.putObject( + captureAny(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).captured.last; + + expect(capturedRequest is s3.PutObjectRequest, isTrue); + final request = capturedRequest as s3.PutObjectRequest; + expect(request.bucket, testBucket); + expect( + request.key, + TestPathResolver.path, + ); + expect(request.contentType, await testLocalFile.contentType); + expect(await request.body.toList(), equals([testBytes])); + }); + test( 'should invoke S3Client.putObject with correct useAcceleration parameter', () async { @@ -584,7 +768,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -642,7 +826,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -698,7 +882,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -962,6 +1146,235 @@ void main() { ); }); + test( + 'should invoke corresponding S3Client APIs with in a happy path to complete the upload with path', + () async { + final receivedState = []; + void onProgress(S3TransferProgress progress) { + receivedState.add(progress.state); + } + + const testUploadDataOptions = StorageUploadDataOptions( + accessLevel: StorageAccessLevel.protected, + metadata: {'filename': 'png.png'}, + pluginOptions: S3UploadDataPluginOptions( + getProperties: true, + ), + ); + const testMultipartUploadId = 'awesome-upload'; + + final testCreateMultipartUploadOutput = s3.CreateMultipartUploadOutput( + uploadId: testMultipartUploadId, + ); + final createMultipartUploadSmithyOperation = + MockSmithyOperation(); + + when( + () => createMultipartUploadSmithyOperation.result, + ).thenAnswer((_) async => testCreateMultipartUploadOutput); + + when( + () => s3Client.createMultipartUpload(any()), + ).thenAnswer((_) => createMultipartUploadSmithyOperation); + + when( + () => transferDatabase.insertTransferRecord(any()), + ).thenAnswer((_) async => '1'); + + final testUploadPartOutput1 = s3.UploadPartOutput(eTag: 'eTag-part-1'); + final testUploadPartOutput2 = s3.UploadPartOutput(eTag: 'eTag-part-2'); + final testUploadPartOutput3 = s3.UploadPartOutput(eTag: 'eTag-part-3'); + final uploadPartSmithyOperation1 = + MockSmithyOperation(); + final uploadPartSmithyOperation2 = + MockSmithyOperation(); + final uploadPartSmithyOperation3 = + MockSmithyOperation(); + + when( + () => uploadPartSmithyOperation1.result, + ).thenAnswer((_) async => testUploadPartOutput1); + when( + () => uploadPartSmithyOperation2.result, + ).thenAnswer((_) async => testUploadPartOutput2); + when( + () => uploadPartSmithyOperation3.result, + ).thenAnswer((_) async => testUploadPartOutput3); + + when( + () => s3Client.uploadPart( + any(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + ).thenAnswer((invocation) { + final request = + invocation.positionalArguments.first as s3.UploadPartRequest; + + switch (request.partNumber) { + case 1: + return uploadPartSmithyOperation1; + case 2: + return uploadPartSmithyOperation2; + case 3: + return uploadPartSmithyOperation3; + } + + throw Exception('this is not going to happen in this test setup'); + }); + + final testCompleteMultipartUploadOutput = + s3.CompleteMultipartUploadOutput(); + final completeMultipartUploadSmithyOperation = + MockSmithyOperation(); + + when( + () => completeMultipartUploadSmithyOperation.result, + ).thenAnswer((_) async => testCompleteMultipartUploadOutput); + + when( + () => s3Client.completeMultipartUpload(any()), + ).thenAnswer((_) => completeMultipartUploadSmithyOperation); + + when( + () => transferDatabase.deleteTransferRecords(any()), + ).thenAnswer((_) async => 1); + + final testHeadObjectOutput = s3.HeadObjectOutput(); + final headSmithyOperation = MockSmithyOperation(); + + when( + () => headSmithyOperation.result, + ).thenAnswer((_) async => testHeadObjectOutput); + + when( + () => s3Client.headObject(any()), + ).thenAnswer((_) => headSmithyOperation); + + final uploadTask = S3UploadTask.fromAWSFile( + testLocalFile, + s3Client: s3Client, + defaultS3ClientConfig: defaultS3ClientConfig, + prefixResolver: testPrefixResolver, + pathResolver: pathResolver, + bucket: testBucket, + defaultAccessLevel: testDefaultAccessLevel, + path: StoragePath.fromString(testKey), + options: testUploadDataOptions, + logger: logger, + transferDatabase: transferDatabase, + onProgress: onProgress, + ); + + unawaited(uploadTask.start()); + + await uploadTask.result; + + // verify generated CreateMultipartUploadRequest + final capturedCreateMultipartUploadRequest = verify( + () => s3Client.createMultipartUpload( + captureAny(), + ), + ).captured.last; + expect( + capturedCreateMultipartUploadRequest, + isA(), + ); + final createMultipartUploadRequest = + capturedCreateMultipartUploadRequest + as s3.CreateMultipartUploadRequest; + expect(createMultipartUploadRequest.bucket, testBucket); + expect( + createMultipartUploadRequest.contentType, + await testLocalFile.contentType, + ); + expect( + createMultipartUploadRequest.key, + TestPathResolver.path, + ); + expect( + capturedCreateMultipartUploadRequest.metadata?['filename'], + testUploadDataOptions.metadata['filename'], + ); + final capturedTransferDBInsertParam = verify( + () => transferDatabase.insertTransferRecord( + captureAny(), + ), + ).captured.last; + expect( + capturedTransferDBInsertParam, + isA().having( + (o) => o.uploadId, + 'uploadId', + testMultipartUploadId, + ), + ); + + // verify uploadPart calls + final uploadPartVerification = verify( + () => s3Client.uploadPart( + captureAny(), + s3ClientConfig: any(named: 's3ClientConfig'), + ), + )..called(3); // 11MB file creates 3 upload part requests + final capturedUploadPartRequests = uploadPartVerification.captured; + final partNumbers = []; + final bytes = BytesBuilder(); + + await Future.forEach(capturedUploadPartRequests, + (capturedRequest) async { + expect(capturedRequest, isA()); + final request = capturedRequest as s3.UploadPartRequest; + expect(request.bucket, testBucket); + expect( + request.key, + TestPathResolver.path, + ); + partNumbers.add(request.partNumber!); + bytes.add( + await request.body.toList().then( + (collectedBytes) => + collectedBytes.expand((bytes) => bytes).toList(), + ), + ); + }); + expect(bytes.takeBytes(), equals(testBytes)); + expect(partNumbers, equals([1, 2, 3])); + expect( + receivedState, + List.generate(4, (_) => StorageTransferState.inProgress) + ..add(StorageTransferState.success), + ); // upload start + 3 parts + + // verify the CompleteMultipartUpload request + final capturedCompleteMultipartUploadRequest = verify( + () => s3Client.completeMultipartUpload( + captureAny(), + ), + ).captured.last; + expect( + capturedCompleteMultipartUploadRequest, + isA(), + ); + final completeMultipartUploadRequest = + capturedCompleteMultipartUploadRequest + as s3.CompleteMultipartUploadRequest; + expect(completeMultipartUploadRequest.bucket, testBucket); + expect( + completeMultipartUploadRequest.key, + TestPathResolver.path, + ); + + final capturedTransferDBDeleteParam = verify( + () => transferDatabase.deleteTransferRecords( + captureAny(), + ), + ).captured.last; + expect( + capturedTransferDBDeleteParam, + testMultipartUploadId, + ); + }); + test( 'should invoke S3Client uploadPart API with correct useAcceleration parameter', () async { @@ -1030,7 +1443,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1124,7 +1537,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1227,7 +1640,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1266,7 +1679,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1300,7 +1713,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1331,7 +1744,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1377,7 +1790,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: const StorageUploadDataOptions( accessLevel: StorageAccessLevel.guest, ), @@ -1424,7 +1837,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1469,7 +1882,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1552,7 +1965,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1646,7 +2059,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: const StorageUploadDataOptions( accessLevel: StorageAccessLevel.guest, ), @@ -1741,7 +2154,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1813,7 +2226,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1971,7 +2384,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2031,7 +2444,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2087,6 +2500,7 @@ void main() { }); group('path style URL', () { + const testKey = 'object-upload-to'; test('throw exception when attempt to use accelerate endpoint', () { final uploadTask = S3UploadTask.fromAWSFile( AWSFile.fromPath('fake/file.jpg'), @@ -2097,7 +2511,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: 'fake-key', + path: StoragePath.fromString(testKey), options: const StorageUploadDataOptions( pluginOptions: S3UploadDataPluginOptions( useAccelerateEndpoint: true, diff --git a/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart index b6dde40c24..ab66f3bf7a 100644 --- a/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart +++ b/packages/storage/amplify_storage_s3_dart/test/test_utils/test_path_resolver.dart @@ -7,6 +7,8 @@ import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart' class TestPathResolver implements S3PathResolver { @override Future resolvePath({required StoragePath path}) async { - return '/mock/path'; + return TestPathResolver.path; } + + static String path = '/mock/path'; } From 174d65f8d34637e5a07443a70bee303b735c57a7 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Wed, 13 Mar 2024 13:25:17 -0400 Subject: [PATCH 09/46] chore: refactor StoragePath (#4544) --- .../lib/src/types/storage/storage_path.dart | 72 ++++++++++--------- .../storage_path_with_identity_id.dart | 20 ++++++ .../src/path_resolver/s3_path_resolver.dart | 14 ++-- .../path_resolver/path_resolver_test.dart | 4 +- 4 files changed, 65 insertions(+), 45 deletions(-) create mode 100644 packages/amplify_core/lib/src/types/storage/storage_path_with_identity_id.dart diff --git a/packages/amplify_core/lib/src/types/storage/storage_path.dart b/packages/amplify_core/lib/src/types/storage/storage_path.dart index 4cfff3af65..21182fc6ce 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_path.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_path.dart @@ -1,46 +1,48 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -import 'dart:async'; - +import 'package:amplify_core/src/types/storage/storage_path_with_identity_id.dart'; import 'package:meta/meta.dart'; -abstract class StoragePath { - factory StoragePath.fromString(String path) { - return StoragePathFromString(path); - } +/// And Object that represents the full remote path of a storage item. +/// +/// ### Examples +/// #### Static Path +/// {@macro amplify_core.storage.storage_path.from_string.example} - factory StoragePath.withIdentityId( - String Function(String id) builder, - ) { - return StoragePathWithIdentityId(builder); - } +/// +/// #### Dynamic Path with the current user's IdentityId +/// {@macro amplify_core.storage.storage_path.with_identity_id.example} - @internal - FutureOr resolvePath({String? id}); -} +class StoragePath { + /// Creates a [StoragePath] from a static string. + /// + /// To create a [StoragePath] with the current user's identity Id, see + /// [StoragePath.withIdentityId] + /// + /// ### Example + /// {@template amplify_core.storage.storage_path.from_string.example} + /// ``` + /// const p = StoragePath.fromString('/path/to/object.png'); + /// ``` + /// {@endtemplate} + const StoragePath.fromString(String path) : _path = path; + + /// {@macro amplify_core.storage.storage_path_with_identity_id} + /// + /// ### Example + /// {@template amplify_core.storage.storage_path.with_identity_id.example} + /// ``` + /// const p = StoragePath.withIdentityId((String identityId) => '/users/$identityId/object.png'); + /// ``` + /// {@endtemplate} + factory StoragePath.withIdentityId( + String Function(String identityId) pathBuilder, + ) => + StoragePathWithIdentityId(pathBuilder); -@internal -class StoragePathFromString implements StoragePath { - const StoragePathFromString(this._path); final String _path; - @override - FutureOr resolvePath({ - String? id, - }) { - return _path; - } -} -@internal -class StoragePathWithIdentityId implements StoragePath { - const StoragePathWithIdentityId(this._pathBuilder); - final String Function(String identityId) _pathBuilder; - @override - FutureOr resolvePath({ - String? id, - }) async { - assert(id != null, 'id must be defined for StoragePathWithIdentityId'); - return _pathBuilder(id!); - } + @internal + String resolvePath({String? identityId}) => _path; } diff --git a/packages/amplify_core/lib/src/types/storage/storage_path_with_identity_id.dart b/packages/amplify_core/lib/src/types/storage/storage_path_with_identity_id.dart new file mode 100644 index 0000000000..af172578ba --- /dev/null +++ b/packages/amplify_core/lib/src/types/storage/storage_path_with_identity_id.dart @@ -0,0 +1,20 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'package:amplify_core/amplify_core.dart'; + +/// {@template amplify_core.storage.storage_path_with_identity_id} +/// Creates a [StoragePath] with the current user's identityId. +/// {@endtemplate} +class StoragePathWithIdentityId implements StoragePath { + /// {@macro amplify_core.storage.storage_path_with_identity_id} + const StoragePathWithIdentityId(this._pathBuilder); + final String Function(String identityId) _pathBuilder; + @override + String resolvePath({ + String? identityId, + }) { + assert(identityId != null, 'identityId must be defined.'); + return _pathBuilder(identityId!); + } +} diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart index 810d77711e..6c68436b93 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart @@ -2,6 +2,8 @@ // SPDX-License-Identifier: Apache-2.0 import 'package:amplify_core/amplify_core.dart'; +// ignore: implementation_imports +import 'package:amplify_core/src/types/storage/storage_path_with_identity_id.dart'; import 'package:meta/meta.dart'; /// {@template amplify_storage_s3_dart.path_resolver} @@ -20,15 +22,11 @@ class S3PathResolver { Future resolvePath({ required StoragePath path, }) async { - final resolvedPath = await switch (path) { - // ignore: invalid_use_of_internal_member - final StoragePathFromString p => p.resolvePath(), - // ignore: invalid_use_of_internal_member + final resolvedPath = switch (path) { final StoragePathWithIdentityId p => - p.resolvePath(id: await _identityProvider.getIdentityId()), - _ => throw UnknownException( - 'Unhandled StoragePath type: ${path.runtimeType}', - ) + p.resolvePath(identityId: await _identityProvider.getIdentityId()), + // ignore: invalid_use_of_internal_member + _ => path.resolvePath() }; if (!resolvedPath.startsWith('/')) { throw const StoragePathValidationException( diff --git a/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart b/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart index 62419557a1..4874a36dfd 100644 --- a/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/path_resolver/path_resolver_test.dart @@ -31,7 +31,7 @@ void main() { ); test('should resolve static strings', () async { - final path = StoragePath.fromString('/foo/bar/picture.png'); + const path = StoragePath.fromString('/foo/bar/picture.png'); expect( await pathResolver.resolvePath(path: path), '/foo/bar/picture.png', @@ -48,7 +48,7 @@ void main() { test('should throw if the path does not start with a leading "/"', () async { - final path = StoragePath.fromString('foo/bar/picture.png'); + const path = StoragePath.fromString('foo/bar/picture.png'); expect( () => pathResolver.resolvePath(path: path), throwsA(isA()), From b238ea67e0583ad912c93dd9ed063fccdf7d5117 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Wed, 13 Mar 2024 14:44:59 -0400 Subject: [PATCH 10/46] chore: remove `key` from public APIs --- .../category/amplify_storage_category.dart | 26 +- .../amplify_storage_plugin_interface.dart | 12 +- .../types/storage/base/storage_operation.dart | 3 + .../types/storage/get_properties_request.dart | 8 +- .../src/types/storage/get_url_options.dart | 1 - .../src/types/storage/get_url_request.dart | 4 - .../lib/src/types/storage/storage_item.dart | 6 +- .../types/storage/upload_data_options.dart | 4 +- .../types/storage/upload_data_request.dart | 4 - .../types/storage/upload_file_options.dart | 4 +- .../types/storage/upload_file_request.dart | 4 - .../integration_test/use_case_test.dart | 17 +- .../amplify_storage_s3/example/lib/main.dart | 25 +- .../example/bin/example.dart | 25 +- .../lib/src/amplify_storage_s3_dart_impl.dart | 24 +- .../lib/src/model/s3_get_url_options.dart | 23 - .../lib/src/model/s3_item.dart | 9 +- .../lib/src/model/s3_upload_data_options.dart | 1 - .../lib/src/model/s3_upload_file_options.dart | 1 - .../download_file/download_file_html.dart | 8 +- .../service/storage_s3_service_impl.dart | 68 +-- .../service/task/s3_upload_task.dart | 30 +- .../test/amplify_storage_s3_dart_test.dart | 73 +-- .../download_file_html_test.dart | 20 +- .../storage_s3_service_test.dart | 61 +- .../task/s3_upload_task_test.dart | 522 ++---------------- 26 files changed, 179 insertions(+), 804 deletions(-) diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index ef3dd07928..a673c27b83 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -52,7 +52,7 @@ class StorageCategory extends AmplifyCategory { } /// {@template amplify_core.amplify_storage_category.get_properties} - /// Retrieves properties of the object specified by [key] with optional + /// Retrieves properties of the object specified by [path] with optional /// [StorageGetPropertiesOptions]. And returns a /// [StorageGetPropertiesOperation]. /// @@ -60,16 +60,12 @@ class StorageCategory extends AmplifyCategory { /// was uploaded. /// {@endtemplate} StorageGetPropertiesOperation getProperties({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, StorageGetPropertiesOptions? options, }) { - assert(key != null || path != null, 'key or path must be defined.'); - assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.getProperties, () => defaultPlugin.getProperties( - key: key, path: path, options: options, ), @@ -77,23 +73,19 @@ class StorageCategory extends AmplifyCategory { } /// {@template amplify_core.amplify_storage_category.get_url} - /// Generates a downloadable url for the object specified by [key] with + /// Generates a downloadable url for the object specified by [path] with /// [StorageGetUrlOptions], and returns a [StorageGetUrlOperation]. /// /// The url is presigned by the aws_signature_v4, and is enforced with scheme /// `https`. /// {@endtemplate} StorageGetUrlOperation getUrl({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, StorageGetUrlOptions? options, }) { - assert(key != null || path != null, 'key or path must be defined.'); - assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.getUrl, () => defaultPlugin.getUrl( - key: key, path: path, options: options, ), @@ -154,17 +146,13 @@ class StorageCategory extends AmplifyCategory { /// {@endtemplate} StorageUploadDataOperation uploadData({ required StorageDataPayload data, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, void Function(StorageTransferProgress)? onProgress, StorageUploadDataOptions? options, }) { - assert(key != null || path != null, 'key or path must be defined.'); - assert(key != null && path != null, 'only key OR path must be defined, not both.'); return identifyCall( StorageCategoryMethod.uploadData, () => defaultPlugin.uploadData( - key: key, path: path, data: data, onProgress: onProgress, @@ -183,15 +171,13 @@ class StorageCategory extends AmplifyCategory { /// {@endtemplate} StorageUploadFileOperation uploadFile({ required AWSFile localFile, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, void Function(StorageTransferProgress)? onProgress, StorageUploadFileOptions? options, }) { return identifyCall( StorageCategoryMethod.uploadFile, () => defaultPlugin.uploadFile( - key: key, path: path, localFile: localFile, onProgress: onProgress, diff --git a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart index c44e1fbbb5..69167c457c 100644 --- a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart +++ b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart @@ -24,8 +24,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.get_properties} StorageGetPropertiesOperation getProperties({ - @Deprecated('Use `path` instead') String? key, - StoragePath? path, + required StoragePath path, StorageGetPropertiesOptions? options, }) { throw UnimplementedError('getProperties() has not been implemented.'); @@ -33,8 +32,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.get_url} StorageGetUrlOperation getUrl({ - @Deprecated('Use `path` instead') String? key, - StoragePath? path, + required StoragePath path, StorageGetUrlOptions? options, }) { throw UnimplementedError('getUrl() has not been implemented.'); @@ -61,8 +59,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.upload_data} StorageUploadDataOperation uploadData({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required StorageDataPayload data, void Function(StorageTransferProgress)? onProgress, StorageUploadDataOptions? options, @@ -72,8 +69,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.upload_file} StorageUploadFileOperation uploadFile({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required AWSFile localFile, void Function(StorageTransferProgress)? onProgress, StorageUploadFileOptions? options, diff --git a/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart b/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart index a52f9e3f0a..6bef0394ea 100644 --- a/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart +++ b/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart @@ -2,6 +2,7 @@ // SPDX-License-Identifier: Apache-2.0 import 'package:amplify_core/amplify_core.dart'; +import 'package:meta/meta.dart'; abstract class StorageOperation { StorageOperation({ @@ -9,6 +10,8 @@ abstract class StorageOperation { required this.result, }) : operationId = uuid(); + // TODO[Jordan-Nelson]: determine if this should be private. + @internal final Request request; final String operationId; final Future result; diff --git a/packages/amplify_core/lib/src/types/storage/get_properties_request.dart b/packages/amplify_core/lib/src/types/storage/get_properties_request.dart index 2b00d8fcb2..26f6226bda 100644 --- a/packages/amplify_core/lib/src/types/storage/get_properties_request.dart +++ b/packages/amplify_core/lib/src/types/storage/get_properties_request.dart @@ -9,15 +9,11 @@ import 'package:amplify_core/amplify_core.dart'; class StorageGetPropertiesRequest { /// {@macro amplify_core.storage.get_properties_request} const StorageGetPropertiesRequest({ - this.key, - this.path, + required this.path, this.options, }); - /// Key of the object to get properties for. - final String? key; - - final StoragePath? path; + final StoragePath path; /// Configurable options of the [StorageGetPropertiesRequest]. final StorageGetPropertiesOptions? options; diff --git a/packages/amplify_core/lib/src/types/storage/get_url_options.dart b/packages/amplify_core/lib/src/types/storage/get_url_options.dart index 68818c6903..a077edbd34 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_options.dart @@ -16,7 +16,6 @@ class StorageGetUrlOptions extends StorageOperationOptions AWSDebuggable { /// {@macro amplify_core.storage.get_url_options} const StorageGetUrlOptions({ - @Deprecated('Use `path` to create the full file path') super.accessLevel, this.pluginOptions, }); diff --git a/packages/amplify_core/lib/src/types/storage/get_url_request.dart b/packages/amplify_core/lib/src/types/storage/get_url_request.dart index 65c54fb717..15ee4b5bb3 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_request.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_request.dart @@ -9,14 +9,10 @@ import 'package:amplify_core/amplify_core.dart'; class StorageGetUrlRequest { /// {@macro amplify_core.storage.get_url_request} const StorageGetUrlRequest({ - this.key, this.path, this.options, }); - /// Key of the object to get url for. - final String? key; - final StoragePath? path; /// Configurable options of the [StorageGetUrlRequest]. diff --git a/packages/amplify_core/lib/src/types/storage/storage_item.dart b/packages/amplify_core/lib/src/types/storage/storage_item.dart index 0f780e8576..debf30a115 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_item.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_item.dart @@ -9,7 +9,8 @@ import 'package:amplify_core/src/types/storage/access_level.dart'; class StorageItem { /// {@macro amplify_core.storage.storage_item} const StorageItem({ - required this.key, + this.key, + // TODO[Jordan-Nelson]: make required this.path = '', this.size, this.lastModified, @@ -17,7 +18,8 @@ class StorageItem { this.metadata = const {}, }); - final String key; + // TODO[Jordan-Nelson]: Remove key + final String? key; final String path; final int? size; final DateTime? lastModified; diff --git a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart index 58f96e5c9b..5513658959 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart @@ -16,7 +16,6 @@ class StorageUploadDataOptions extends StorageOperationOptions AWSDebuggable { /// {@macro amplify_core.storage.upload_data_options} const StorageUploadDataOptions({ - super.accessLevel, this.metadata = const {}, this.pluginOptions, }); @@ -28,14 +27,13 @@ class StorageUploadDataOptions extends StorageOperationOptions final StorageUploadDataPluginOptions? pluginOptions; @override - List get props => [accessLevel, metadata, pluginOptions]; + List get props => [metadata, pluginOptions]; @override String get runtimeTypeName => 'StorageUploadDataOptions'; @override Map toJson() => { - 'accessLevel': accessLevel?.name, 'metadata': metadata, 'pluginOptions': pluginOptions?.toJson(), }; diff --git a/packages/amplify_core/lib/src/types/storage/upload_data_request.dart b/packages/amplify_core/lib/src/types/storage/upload_data_request.dart index b15287f713..59a2c734ac 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_data_request.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_data_request.dart @@ -10,13 +10,9 @@ class StorageUploadDataRequest { /// {@macro amplify_core.storage.upload_data_request} const StorageUploadDataRequest({ required this.data, - @Deprecated('Use StorageUploadDataResult.uploadedItem.path instead') required this.key, this.options, }); - /// The key of the object upload to. - @Deprecated('Use StorageUploadDataResult.uploadedItem.path instead') final String key; - /// The data payload to upload. final StorageDataPayload data; diff --git a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart index 7e91eeb7e5..7faea55de0 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart @@ -16,7 +16,6 @@ class StorageUploadFileOptions extends StorageOperationOptions AWSDebuggable { /// {@macro amplify_core.storage.upload_file_options} const StorageUploadFileOptions({ - super.accessLevel, this.metadata = const {}, this.pluginOptions, }); @@ -28,14 +27,13 @@ class StorageUploadFileOptions extends StorageOperationOptions final StorageUploadFilePluginOptions? pluginOptions; @override - List get props => [accessLevel, metadata, pluginOptions]; + List get props => [metadata, pluginOptions]; @override String get runtimeTypeName => 'StorageUploadFileOptions'; @override Map toJson() => { - 'accessLevel': accessLevel?.name, 'metadata': metadata, 'pluginOptions': pluginOptions?.toJson(), }; diff --git a/packages/amplify_core/lib/src/types/storage/upload_file_request.dart b/packages/amplify_core/lib/src/types/storage/upload_file_request.dart index 110fa32321..84df8752d9 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_file_request.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_file_request.dart @@ -10,13 +10,9 @@ class StorageUploadFileRequest { /// {@macro amplify_core.storage.upload_file_request} const StorageUploadFileRequest({ required this.localFile, - required this.key, this.options, }); - /// The key of the object upload to. - final String key; - /// The local file to upload. final AWSFile localFile; diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index f0f268ff6c..09d8b47135 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -156,9 +156,8 @@ void main() { testBytes, contentType: testContentType, ), - key: testObjectKey1, + path: StoragePath.fromString('/public/$testObjectKey1'), options: const StorageUploadDataOptions( - accessLevel: StorageAccessLevel.guest, metadata: { 'filename': testObjectFileName1, }, @@ -206,9 +205,8 @@ void main() { final result = await s3Plugin .uploadData( data: S3DataPayload.dataUrl(testDataUrl), - key: testObjectKey2, + path: StoragePath.fromString('/protected/$testObjectKey2'), options: const StorageUploadDataOptions( - accessLevel: StorageAccessLevel.protected, metadata: { 'filename': testObjectFileName2, }, @@ -244,9 +242,8 @@ void main() { final result = await s3Plugin .uploadFile( localFile: AWSFile.fromData(testLargeFileBytes), - key: testObjectKey3, + path: StoragePath.fromString('/private/$testObjectKey3'), options: const StorageUploadFileOptions( - accessLevel: StorageAccessLevel.private, metadata: { 'filename': testObjectFileName3, }, @@ -279,9 +276,8 @@ void main() { 'generate downloadable url with access level private for the' ' currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.getUrl( - key: testObjectKey3, + path: StoragePath.fromString('/private/$testObjectKey3'), options: const StorageGetUrlOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, expiresIn: Duration(minutes: 5), @@ -296,9 +292,10 @@ void main() { 'should throw generating downloadable url of a non-existent object', (WidgetTester tester) async { final result = Amplify.Storage.getUrl( - key: 'random/non-existent/object.png', + path: const StoragePath.fromString( + 'random/non-existent/object.png', + ), options: const StorageGetUrlOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, expiresIn: Duration(minutes: 5), diff --git a/packages/storage/amplify_storage_s3/example/lib/main.dart b/packages/storage/amplify_storage_s3/example/lib/main.dart index 270f5dd4f1..94bae65d3d 100644 --- a/packages/storage/amplify_storage_s3/example/lib/main.dart +++ b/packages/storage/amplify_storage_s3/example/lib/main.dart @@ -148,7 +148,7 @@ class _HomeScreenState extends State { platformFile.readStream!, size: platformFile.size, ), - key: platformFile.name, + path: StoragePath.fromString('/public/${platformFile.name}'), onProgress: (p) => _logger.debug('Uploading: ${p.transferredBytes}/${p.totalBytes}'), ).result; @@ -229,15 +229,13 @@ class _HomeScreenState extends State { // get the url of a file in the S3 bucket Future getUrl({ - required String key, - required StorageAccessLevel accessLevel, + required String path, }) async { try { final result = await Amplify.Storage.getUrl( - key: key, - options: StorageGetUrlOptions( - accessLevel: accessLevel, - pluginOptions: const S3GetUrlPluginOptions( + path: StoragePath.fromString(path), + options: const StorageGetUrlOptions( + pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, expiresIn: Duration(minutes: 1), ), @@ -270,17 +268,14 @@ class _HomeScreenState extends State { final item = list[index]; return ListTile( onTap: () { - getUrl( - key: item.key, - accessLevel: StorageAccessLevel.guest, - ); + getUrl(path: item.path); }, - title: Text(item.key), + title: Text(item.path), trailing: IconButton( icon: const Icon(Icons.delete), onPressed: () { removeFile( - key: item.key, + key: item.path, accessLevel: StorageAccessLevel.guest, ); }, @@ -290,8 +285,8 @@ class _HomeScreenState extends State { icon: const Icon(Icons.download), onPressed: () { zIsWeb - ? downloadFileWeb(item.key) - : downloadFileMobile(item.key); + ? downloadFileWeb(item.path) + : downloadFileMobile(item.path); }, ), ); diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart index c4529a1a65..c949181bdf 100644 --- a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart +++ b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart @@ -155,7 +155,7 @@ Future getPropertiesOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final getPropertiesOperation = s3Plugin.getProperties( - key: key, + path: StoragePath.fromString(key), options: StorageGetPropertiesOptions( accessLevel: accessLevel, ), @@ -173,16 +173,13 @@ Future getPropertiesOperation() async { Future getUrlOperation() async { final key = prompt('Enter the object key to get url for: '); - final accessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the object: ', - ); + final useAccelerateEndpoint = promptUseAcceleration(); final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final getUrlOperation = s3Plugin.getUrl( - key: key, + path: StoragePath.fromString(key), options: StorageGetUrlOptions( - accessLevel: accessLevel, pluginOptions: S3GetUrlPluginOptions( expiresIn: const Duration( minutes: 10, @@ -292,17 +289,13 @@ Future downloadFileOperation() async { Future uploadDataUrlOperation() async { final dataUrl = prompt('Enter the data url to upload: '); final key = prompt('Enter the object key to upload the data url to: '); - final accessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the object to upload: ', - ); final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final uploadDataOperation = s3Plugin.uploadData( data: S3DataPayload.dataUrl(dataUrl), - key: key, - options: StorageUploadDataOptions( - accessLevel: accessLevel, - pluginOptions: const S3UploadDataPluginOptions( + path: StoragePath.fromString(key), + options: const StorageUploadDataOptions( + pluginOptions: S3UploadDataPluginOptions( getProperties: true, ), ), @@ -327,9 +320,6 @@ Future uploadDataUrlOperation() async { Future uploadFileOperation() async { final filePath = prompt('Enter the path of the file to be uploaded: '); final key = prompt('Enter the object key to upload the file to: '); - final accessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the object to upload: ', - ); final nameTag = prompt('Enter value of the name tag for this file: '); final file = AWSFile.fromPath(filePath); @@ -344,10 +334,9 @@ Future uploadFileOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final uploadFileOperation = s3Plugin.uploadFile( localFile: file, - key: key, + path: StoragePath.fromString(key), onProgress: onTransferProgress, options: StorageUploadFileOptions( - accessLevel: accessLevel, metadata: { 'nameTag': nameTag, }, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index f3184b7b65..12dcd31726 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -171,8 +171,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3GetPropertiesOperation getProperties({ - String? key, - StoragePath? path, + required StoragePath path, StorageGetPropertiesOptions? options, }) { final s3PluginOptions = reifyPluginOptions( @@ -187,11 +186,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3GetPropertiesOperation( request: StorageGetPropertiesRequest( - key: key, + path: path, options: options, ), result: storageS3Service.getProperties( - key: key, path: path, options: s3Options, ), @@ -200,8 +198,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3GetUrlOperation getUrl({ - String? key, - StoragePath? path, + required StoragePath path, StorageGetUrlOptions? options, }) { final s3PluginOptions = reifyPluginOptions( @@ -210,18 +207,15 @@ class AmplifyStorageS3Dart extends StoragePluginInterface ); final s3Options = StorageGetUrlOptions( - accessLevel: options?.accessLevel, pluginOptions: s3PluginOptions, ); return S3GetUrlOperation( request: StorageGetUrlRequest( - key: key, path: path, options: options, ), result: storageS3Service.getUrl( - key: key, path: path, options: s3Options, ), @@ -298,8 +292,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3UploadDataOperation uploadData({ required StorageDataPayload data, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, void Function(S3TransferProgress)? onProgress, StorageUploadDataOptions? options, }) { @@ -309,13 +302,11 @@ class AmplifyStorageS3Dart extends StoragePluginInterface ); final s3Options = StorageUploadDataOptions( - accessLevel: options?.accessLevel, metadata: options?.metadata ?? const {}, pluginOptions: s3PluginOptions, ); final uploadTask = storageS3Service.uploadData( - key: key, path: path, dataPayload: data, options: s3Options, @@ -325,7 +316,6 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3UploadDataOperation( request: StorageUploadDataRequest( data: data, - key: key ?? '', options: options, ), result: uploadTask.result.then( @@ -338,8 +328,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3UploadFileOperation uploadFile({ required AWSFile localFile, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, void Function(S3TransferProgress)? onProgress, StorageUploadFileOptions? options, }) { @@ -349,13 +338,11 @@ class AmplifyStorageS3Dart extends StoragePluginInterface ); final s3Options = StorageUploadFileOptions( - accessLevel: options?.accessLevel, metadata: options?.metadata ?? const {}, pluginOptions: s3PluginOptions, ); final uploadTask = storageS3Service.uploadFile( - key: key, path: path, localFile: localFile, options: s3Options, @@ -365,7 +352,6 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3UploadFileOperation( request: StorageUploadFileRequest( localFile: localFile, - key: key ?? '', options: options, ), result: uploadTask.result.then( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart index 8e70c6ef49..3ca351ccd5 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart @@ -16,12 +16,10 @@ class S3GetUrlOptions extends StorageGetUrlOptions { 'use StorageGetUrlOptions(pluginOptions: S3GetUrlPluginOptions(...)) instead.', ) const S3GetUrlOptions({ - StorageAccessLevel accessLevel = StorageAccessLevel.guest, Duration expiresIn = const Duration(minutes: 15), bool validateObjectExistence = false, bool useAccelerateEndpoint = false, }) : this._( - accessLevel: accessLevel, expiresIn: expiresIn, validateObjectExistence: validateObjectExistence, useAccelerateEndpoint: useAccelerateEndpoint, @@ -30,33 +28,12 @@ class S3GetUrlOptions extends StorageGetUrlOptions { 'use StorageGetUrlOptions(pluginOptions: S3GetUrlPluginOptions(...)) instead.', ) const S3GetUrlOptions._({ - super.accessLevel = StorageAccessLevel.guest, this.expiresIn = const Duration(minutes: 15), this.validateObjectExistence = false, this.targetIdentityId, this.useAccelerateEndpoint = false, }); - /// {@macro storage.amplify_storage_s3.get_url_options} - /// - /// Use this when calling `getUrl` on an object that belongs to other user - /// (identified by [targetIdentityId]) rather than the currently signed user. - @Deprecated( - 'use StorageGetUrlOptions(pluginOptions: S3GetUrlPluginOptions.forIdentity(...)) instead.', - ) - const S3GetUrlOptions.forIdentity( - String targetIdentityId, { - Duration expiresIn = const Duration(minutes: 15), - bool validateObjectExistence = false, - bool useAccelerateEndpoint = false, - }) : this._( - accessLevel: StorageAccessLevel.protected, - expiresIn: expiresIn, - validateObjectExistence: validateObjectExistence, - targetIdentityId: targetIdentityId, - useAccelerateEndpoint: useAccelerateEndpoint, - ); - /// Specifies the period of time that the generated url expires in. final Duration expiresIn; diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart index aa14a26126..e1c3c33cd5 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart @@ -19,7 +19,8 @@ class S3Item extends StorageItem AWSDebuggable { /// {@macro storage.amplify_storage_s3.storage_s3_item} S3Item({ - required super.key, + super.key, + // TODO[Jordan-Nelson]: make required super.path, super.size, super.lastModified, @@ -82,7 +83,8 @@ class S3Item extends StorageItem @internal factory S3Item.fromHeadObjectOutput( s3.HeadObjectOutput headObjectOutput, { - required String key, + // TODO: remove + String? key, required String path, }) { return S3Item( @@ -102,7 +104,8 @@ class S3Item extends StorageItem @internal factory S3Item.fromGetObjectOutput( s3.GetObjectOutput getObjectOutput, { - required String key, + // TODO: remove + String? key, required String path, }) { return S3Item( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_data_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_data_options.dart index a6befc2751..7b56db9f54 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_data_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_data_options.dart @@ -16,7 +16,6 @@ class S3UploadDataOptions extends StorageUploadDataOptions { 'use StorageUploadDataOptions(pluginOptions: S3UploadDataPluginOptions(...)) instead.', ) const S3UploadDataOptions({ - super.accessLevel = StorageAccessLevel.guest, this.getProperties = false, super.metadata, this.useAccelerateEndpoint = false, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_file_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_file_options.dart index 3d79c24de2..b7f919ab01 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_file_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_upload_file_options.dart @@ -16,7 +16,6 @@ class S3UploadFileOptions extends StorageUploadFileOptions { 'use StorageUploadFileOptions(pluginOptions: S3UploadFilePluginOptions(...)) instead.', ) const S3UploadFileOptions({ - super.accessLevel = StorageAccessLevel.guest, this.getProperties = false, super.metadata, this.useAccelerateEndpoint = false, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart index f6e64dd076..16ada683b0 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart @@ -56,7 +56,8 @@ Future _downloadFromUrl({ // Exception thrown from the getProperties will be thrown as download // operation. final downloadedItem = (await storageS3Service.getProperties( - key: key, + // TODO[Jordan-Nelson]: update to use path from customer + path: StoragePath.fromString(key), options: targetIdentityId == null ? StorageGetPropertiesOptions( accessLevel: options.accessLevel, @@ -73,16 +74,15 @@ Future _downloadFromUrl({ // We are not setting validateObjectExistence to true here as we are not // able to directly get the result of underlying HeadObject result. final url = (await storageS3Service.getUrl( - key: key, + // TODO[Jordan-Nelson]: update to use path from customer + path: StoragePath.fromString(key), options: targetIdentityId == null ? StorageGetUrlOptions( - accessLevel: options.accessLevel, pluginOptions: S3GetUrlPluginOptions( useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, ), ) : StorageGetUrlOptions( - accessLevel: options.accessLevel, pluginOptions: S3GetUrlPluginOptions.forIdentity( targetIdentityId, useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index 184e612664..b208261cd4 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -213,24 +213,10 @@ class StorageS3Service { /// /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} Future getProperties({ - String? key, - StoragePath? path, + required StoragePath path, required StorageGetPropertiesOptions options, }) async { - assert(key != null || path != null, '"key" or "path" must be provided'); - final s3PluginOptions = - options.pluginOptions as S3GetPropertiesPluginOptions? ?? - const S3GetPropertiesPluginOptions(); - - final fullPath = await getResolvedPath( - pathResolver: _pathResolver, - prefixResolver: _prefixResolver, - logger: _logger, - path: path, - key: key, - accessLevel: options.accessLevel ?? _s3PluginConfig.defaultAccessLevel, - identityId: s3PluginOptions.targetIdentityId, - ); + final fullPath = await _pathResolver.resolvePath(path: path); return S3GetPropertiesResult( storageItem: S3Item.fromHeadObjectOutput( @@ -239,7 +225,6 @@ class StorageS3Service { bucket: _s3PluginConfig.bucket, key: fullPath, ), - key: key ?? fullPath, path: fullPath, ), ); @@ -251,8 +236,7 @@ class StorageS3Service { /// /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} Future getUrl({ - String? key, - StoragePath? path, + required StoragePath path, required StorageGetUrlOptions options, }) async { final s3PluginOptions = options.pluginOptions as S3GetUrlPluginOptions? ?? @@ -279,20 +263,11 @@ class StorageS3Service { ); await getProperties( path: path, - key: key, options: getPropertiesOptions, ); } - final fullPath = await getResolvedPath( - pathResolver: _pathResolver, - prefixResolver: _prefixResolver, - logger: _logger, - path: path, - key: key, - accessLevel: options.accessLevel ?? _s3PluginConfig.defaultAccessLevel, - identityId: s3PluginOptions.targetIdentityId, - ); + final fullPath = await _pathResolver.resolvePath(path: path); var keyToGetUrl = fullPath; if (!keyToGetUrl.startsWith('/')) { keyToGetUrl = '/$keyToGetUrl'; @@ -375,8 +350,7 @@ class StorageS3Service { /// a [S3UploadTask], to start the upload process, then returns the /// [S3UploadTask]. S3UploadTask uploadData({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required S3DataPayload dataPayload, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, @@ -389,7 +363,6 @@ class StorageS3Service { defaultS3ClientConfig: _defaultS3ClientConfig, bucket: _s3PluginConfig.bucket, defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, - key: key, path: path, options: options, pathResolver: _pathResolver, @@ -408,8 +381,7 @@ class StorageS3Service { /// a [S3UploadTask], to start the upload process, then returns the /// [S3UploadTask]. S3UploadTask uploadFile({ - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required AWSFile localFile, required StorageUploadFileOptions options, void Function(S3TransferProgress)? onProgress, @@ -420,7 +392,6 @@ class StorageS3Service { options.pluginOptions as S3UploadFilePluginOptions? ?? const S3UploadFilePluginOptions(); final uploadDataOptions = StorageUploadDataOptions( - accessLevel: options.accessLevel, metadata: options.metadata, pluginOptions: S3UploadDataPluginOptions( getProperties: s3PluginOptions.getProperties, @@ -432,7 +403,6 @@ class StorageS3Service { defaultS3ClientConfig: _defaultS3ClientConfig, bucket: _s3PluginConfig.bucket, defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, - key: key, path: path, options: uploadDataOptions, pathResolver: _pathResolver, @@ -513,7 +483,10 @@ class StorageS3Service { key: destination.storageItem.key, path: destination.storageItem.path, ) - : S3Item(key: destination.storageItem.key, path: destination.storageItem.path), + : S3Item( + key: destination.storageItem.key, + path: destination.storageItem.path, + ), ); } @@ -754,26 +727,9 @@ class StorageS3Service { @internal static Future getResolvedPath({ required S3PathResolver pathResolver, - required S3PrefixResolver prefixResolver, - required AWSLogger logger, - StoragePath? path, - String? key, - required StorageAccessLevel accessLevel, - String? identityId, + required StoragePath path, }) async { - final String fullPath; - if (path != null) { - fullPath = await pathResolver.resolvePath(path: path); - } else { - final resolvedPrefix = await getResolvedPrefix( - prefixResolver: prefixResolver, - logger: logger, - accessLevel: accessLevel, - identityId: identityId, - ); - fullPath = '$resolvedPrefix$key'; - } - return fullPath; + return pathResolver.resolvePath(path: path); } /// Creates and sends a [s3.HeadObjectRequest] to S3 service, and then diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart index 23a1168729..8b1acf4753 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart @@ -55,8 +55,7 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required StorageUploadDataOptions options, S3DataPayload? dataPayload, AWSFile? localFile, @@ -69,7 +68,6 @@ class S3UploadTask { _prefixResolver = prefixResolver, _bucket = bucket, _defaultAccessLevel = defaultAccessLevel, - _key = key, _path = path, _options = options, _dataPayload = dataPayload, @@ -94,8 +92,7 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - @Deprecated('use `path` instead.') String? key, - StoragePath? path, + required StoragePath path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, required AWSLogger logger, @@ -107,7 +104,6 @@ class S3UploadTask { prefixResolver: prefixResolver, bucket: bucket, defaultAccessLevel: defaultAccessLevel, - key: key, path: path, dataPayload: dataPayload, options: options, @@ -127,8 +123,7 @@ class S3UploadTask { required S3PathResolver pathResolver, required String bucket, required StorageAccessLevel defaultAccessLevel, - @Deprecated('use `path` instead.') String? key, - final StoragePath? path, + required StoragePath path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, required AWSLogger logger, @@ -140,7 +135,6 @@ class S3UploadTask { pathResolver: pathResolver, bucket: bucket, defaultAccessLevel: defaultAccessLevel, - key: key, path: path, localFile: localFile, options: options, @@ -160,8 +154,7 @@ class S3UploadTask { final S3PathResolver _pathResolver; final String _bucket; final StorageAccessLevel _defaultAccessLevel; - final String? _key; - final StoragePath? _path; + final StoragePath _path; final StorageUploadDataOptions _options; final void Function(S3TransferProgress)? _onProgress; final AWSLogger _logger; @@ -331,14 +324,7 @@ class S3UploadTask { } Future _setResolvedKey() async { - _resolvedKey = await StorageS3Service.getResolvedPath( - pathResolver: _pathResolver, - prefixResolver: _prefixResolver, - logger: _logger, - accessLevel: _options.accessLevel ?? _defaultAccessLevel, - key: _key, - path: _path, - ); + _resolvedKey = await _pathResolver.resolvePath(path: _path); } Future _startPutObject(S3DataPayload body) async { @@ -377,10 +363,9 @@ class S3UploadTask { bucket: _bucket, key: _resolvedKey, ), - key: _key ?? _resolvedKey, path: _resolvedKey, ) - : S3Item(key: _key ?? _resolvedKey, path: _resolvedKey), + : S3Item(path: _resolvedKey), ); _state = StorageTransferState.success; @@ -487,10 +472,9 @@ class S3UploadTask { bucket: _bucket, key: _resolvedKey, ), - key: _key ?? _resolvedKey, path: _resolvedKey, ) - : S3Item(key: _key ?? _resolvedKey, path: _resolvedKey), + : S3Item(path: _resolvedKey), ); _state = StorageTransferState.success; _emitTransferProgress(); diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index af7c26e7a3..68db8b5a3b 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -12,6 +12,8 @@ import 'test_utils/mocks.dart'; import 'test_utils/test_custom_prefix_resolver.dart'; import 'test_utils/test_token_provider.dart'; +const testPath = StoragePath.fromString('/some/path.txt'); + void main() { const testDefaultStorageAccessLevel = StorageAccessLevel.guest; const testAccessLevelProtected = StorageAccessLevel.protected; @@ -257,7 +259,7 @@ void main() { when( () => storageS3Service.getProperties( - key: testKey, + path: testPath, options: defaultOptions, ), ).thenAnswer( @@ -265,11 +267,11 @@ void main() { ); final getPropertiesOperation = - storageS3Plugin.getProperties(key: testKey); + storageS3Plugin.getProperties(path: testPath); final capturedOptions = verify( () => storageS3Service.getProperties( - key: testKey, + path: testPath, options: captureAny( named: 'options', ), @@ -299,7 +301,7 @@ void main() { when( () => storageS3Service.getProperties( - key: testKey, + path: testPath, options: testOptions, ), ).thenAnswer( @@ -307,13 +309,13 @@ void main() { ); final getPropertiesOperation = storageS3Plugin.getProperties( - key: testKey, + path: testPath, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.getProperties( - key: testKey, + path: testPath, options: captureAny( named: 'options', ), @@ -354,18 +356,20 @@ void main() { when( () => storageS3Service.getUrl( - key: testKey, + path: testPath, options: defaultOptions, ), ).thenAnswer( (_) async => testResult, ); - final getUrlOperation = storageS3Plugin.getUrl(key: testKey); + final getUrlOperation = storageS3Plugin.getUrl( + path: testPath, + ); final capturedOptions = verify( () => storageS3Service.getUrl( - key: testKey, + path: testPath, options: captureAny( named: 'options', ), @@ -386,7 +390,6 @@ void main() { test('should forward options to StorageS3Service.getUrl() API', () async { const testOptions = StorageGetUrlOptions( - accessLevel: testAccessLevelProtected, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, expiresIn: Duration(minutes: 10), @@ -396,7 +399,7 @@ void main() { when( () => storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ), ).thenAnswer( @@ -404,13 +407,13 @@ void main() { ); final getUrlOperation = storageS3Plugin.getUrl( - key: testKey, + path: testPath, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.getUrl( - key: testKey, + path: testPath, options: captureAny( named: 'options', ), @@ -587,7 +590,7 @@ void main() { when( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: any(named: 'dataPayload'), options: defaultOptions, onProgress: any(named: 'onProgress'), @@ -598,12 +601,14 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); - final uploadDataOperation = - storageS3Plugin.uploadData(data: testData, key: testKey); + final uploadDataOperation = storageS3Plugin.uploadData( + data: testData, + path: testPath, + ); final capturedParams = verify( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: captureAny(named: 'dataPayload'), options: captureAny( named: 'options', @@ -636,7 +641,6 @@ void main() { test('should forward options to StorageS3Service.uploadData API', () async { const testOptions = StorageUploadDataOptions( - accessLevel: testAccessLevelProtected, pluginOptions: S3UploadDataPluginOptions( getProperties: true, useAccelerateEndpoint: true, @@ -645,7 +649,7 @@ void main() { when( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: any(named: 'dataPayload'), options: testOptions, ), @@ -654,12 +658,12 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); uploadDataOperation = storageS3Plugin.uploadData( data: testData, - key: testKey, + path: testPath, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: any(named: 'dataPayload'), options: captureAny( named: 'options', @@ -679,13 +683,12 @@ void main() { 'filename': '123', }; const testOptions = StorageUploadDataOptions( - accessLevel: testAccessLevelProtected, metadata: testMetadata, ); when( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: any(named: 'dataPayload'), options: any(named: 'options'), ), @@ -694,12 +697,12 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); uploadDataOperation = storageS3Plugin.uploadData( data: testData, - key: testKey, + path: testPath, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.uploadData( - key: testKey, + path: testPath, dataPayload: any(named: 'dataPayload'), options: captureAny( named: 'options', @@ -760,7 +763,7 @@ void main() { when( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: any(named: 'localFile'), options: defaultOptions, onProgress: any(named: 'onProgress'), @@ -772,13 +775,13 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); uploadFileOperation = storageS3Plugin.uploadFile( - key: testKey, + path: testPath, localFile: testLocalFile, ); final capturedParams = verify( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: captureAny(named: 'localFile'), options: captureAny( named: 'options', @@ -809,7 +812,6 @@ void main() { test('should forward options to StorageS3Service.uploadFile API', () async { const testOptions = StorageUploadFileOptions( - accessLevel: testAccessLevelProtected, pluginOptions: S3UploadFilePluginOptions( getProperties: true, useAccelerateEndpoint: true, @@ -818,7 +820,7 @@ void main() { when( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: any(named: 'localFile'), options: testOptions, ), @@ -827,14 +829,14 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); uploadFileOperation = storageS3Plugin.uploadFile( - key: testKey, + path: testPath, localFile: testLocalFile, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: any(named: 'localFile'), options: captureAny( named: 'options', @@ -854,13 +856,12 @@ void main() { 'filename': '123', }; const testOptions = StorageUploadFileOptions( - accessLevel: testAccessLevelProtected, metadata: testMetadata, ); when( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: any(named: 'localFile'), options: any(named: 'options'), ), @@ -869,14 +870,14 @@ void main() { when(() => testS3UploadTask.result).thenAnswer((_) async => testItem); uploadFileOperation = storageS3Plugin.uploadFile( - key: testKey, + path: testPath, localFile: testLocalFile, options: testOptions, ); final capturedOptions = verify( () => storageS3Service.uploadFile( - key: testKey, + path: testPath, localFile: any(named: 'localFile'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index 6b65c851f4..5a625d33d1 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -27,7 +27,9 @@ class DummyPathProvider implements AppPathProvider { } void main() { - group('downloadFile() html implementation', () { + group('downloadFile() html implementation', + // TODO: remove skip + skip: true, () { late StorageS3Service storageS3Service; const testKey = 'upload-key.text'; const testS3pluginConfig = S3PluginConfig( @@ -59,9 +61,7 @@ void main() { storageS3Service = MockStorageS3Service(); registerFallbackValue( - StorageGetUrlOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - ), + const StorageGetUrlOptions(), ); registerFallbackValue( @@ -72,14 +72,16 @@ void main() { when( () => storageS3Service.getProperties( - key: testKey, + // TODO[Jordan-Nelson]: update + path: const StoragePath.fromString('key'), options: any(named: 'options'), ), ).thenAnswer((_) async => testGetPropertiesResult); when( () => storageS3Service.getUrl( - key: testKey, + // TODO[Jordan-Nelson]: update + path: const StoragePath.fromString('key'), options: any(named: 'options'), ), ).thenAnswer((_) async => testGetUrlResult); @@ -106,7 +108,8 @@ void main() { final capturedGetPropertiesOptions = verify( () => storageS3Service.getProperties( - key: testKey, + // TODO[Jordan-Nelson]: update + path: const StoragePath.fromString('key'), options: captureAny( named: 'options', ), @@ -131,7 +134,8 @@ void main() { final capturedUrlOptions = verify( () => storageS3Service.getUrl( - key: testKey, + // TODO[Jordan-Nelson]: update + path: const StoragePath.fromString('key'), options: captureAny( named: 'options', ), diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart index a206c21d71..b6e9db18e6 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart @@ -19,6 +19,7 @@ import '../test_utils/test_path_resolver.dart'; import '../test_utils/test_token_provider.dart'; const testDelimiter = '#'; +const testPath = StoragePath.fromString('/some/path.txt'); class TestPrefixResolver implements S3PrefixResolver { @override @@ -455,7 +456,7 @@ void main() { ).thenAnswer((_) => smithyOperation); getPropertiesResult = await storageS3Service.getProperties( - key: testKey, + path: testPath, options: testOptions, ); @@ -468,12 +469,7 @@ void main() { final request = capturedRequest as HeadObjectRequest; expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: s3PluginConfig.defaultAccessLevel, - )}$testKey', - ); + expect(request.key, TestPathResolver.path); }); test('should invoke S3Client.headObject with expected parameters', @@ -502,7 +498,7 @@ void main() { ).thenAnswer((_) => smithyOperation); getPropertiesResult = await storageS3Service.getProperties( - key: testKey, + path: testPath, options: testOptions, ); @@ -515,18 +511,11 @@ void main() { final request = capturedRequest as HeadObjectRequest; expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testOptions.accessLevel!, - identityId: testTargetIdentityId, - )}$testKey', - ); + expect(request.key, TestPathResolver.path); }); test('should return correct S3GetProperties result', () async { final storageItem = getPropertiesResult.storageItem; - expect(storageItem.key, testKey); expect(storageItem.metadata, testMetadata); expect(storageItem.eTag, testETag); expect(storageItem.size, testSize); @@ -549,7 +538,7 @@ void main() { expect( storageS3Service.getProperties( - key: 'a key', + path: const StoragePath.fromString('/a key'), options: testOptions, ), throwsA(isA()), @@ -569,7 +558,7 @@ void main() { expect( storageS3Service.getProperties( - key: 'a key', + path: const StoragePath.fromString('/a key'), options: testOptions, ), throwsA(isA()), @@ -626,7 +615,7 @@ void main() { ).thenAnswer((_) async => testUrl); getUrlResult = await storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ); final capturedParams = verify( @@ -645,12 +634,7 @@ void main() { final requestParam = capturedParams.first as AWSHttpRequest; expect( requestParam.uri.toString(), - endsWith( - Uri.encodeComponent('${await testPrefixResolver.resolvePrefix( - accessLevel: s3PluginConfig.defaultAccessLevel, - identityId: testTargetIdentityId, - )}$testKey'), - ), + endsWith(TestPathResolver.path), ); expect(capturedParams[2] is S3ServiceConfiguration, isTrue); @@ -685,7 +669,7 @@ void main() { ).thenAnswer((_) async => testUrl); getUrlResult = await storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ); final capturedSignerScope1 = verify( @@ -702,7 +686,7 @@ void main() { expect(capturedSignerScope1, isA()); getUrlResult = await storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ); final capturedSignerScope2 = verify( @@ -725,7 +709,6 @@ void main() { 'should invoke s3Client.headObject when validateObjectExistence option is set to true', () async { const testOptions = StorageGetUrlOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, ), @@ -743,7 +726,7 @@ void main() { await expectLater( storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ), throwsA(isA()), @@ -757,9 +740,7 @@ void main() { expect( capturedRequest.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testOptions.accessLevel!, - )}$testKey', + TestPathResolver.path, ); }); @@ -768,7 +749,6 @@ void main() { ' set to true and specified targetIdentityId', () async { const testTargetIdentityId = 'some-else-id'; const testOptions = StorageGetUrlOptions( - accessLevel: StorageAccessLevel.guest, pluginOptions: S3GetUrlPluginOptions.forIdentity( testTargetIdentityId, validateObjectExistence: true, @@ -787,7 +767,7 @@ void main() { await expectLater( storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ), throwsA(isA()), @@ -801,10 +781,7 @@ void main() { expect( capturedRequest.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testOptions.accessLevel!, - identityId: testTargetIdentityId, - )}$testKey', + TestPathResolver.path, ); }); @@ -825,7 +802,7 @@ void main() { ).thenAnswer((_) async => testUrl); await storageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ); @@ -894,7 +871,7 @@ void main() { ).thenAnswer((_) async => pathStyleURL); getUrlResult = await pathStyleStorageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ); @@ -920,7 +897,7 @@ void main() { .having( (o) => o.path, 'path', - '/bucket.name.has.dots.com/public#some-object', + '/bucket.name.has.dots.com${TestPathResolver.path}', ), ); }, @@ -937,7 +914,7 @@ void main() { expect( pathStyleStorageS3Service.getUrl( - key: testKey, + path: testPath, options: testOptions, ), throwsA( diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart index 2cde0e4792..9fac13e13f 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart @@ -33,9 +33,7 @@ void main() { const defaultS3ClientConfig = smithy_aws.S3ClientConfig(); final testPrefixResolver = TestCustomPrefixResolver(); final pathResolver = TestPathResolver(); - const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, - ); + const testUploadDataOptions = StorageUploadDataOptions(); const testDefaultAccessLevel = StorageAccessLevel.guest; setUpAll(() { @@ -115,10 +113,6 @@ void main() { s3ClientConfig: any(named: 's3ClientConfig'), ), ).thenAnswer((_) => smithyOperation); - - final resolvedPath = '${await testPrefixResolver.resolvePrefix( - accessLevel: testDefaultAccessLevel, - )}$testPath'; final uploadDataTask = S3UploadTask.fromDataPayload( testDataPayload, @@ -128,7 +122,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testPath, + path: const StoragePath.fromString(testPath), options: const StorageUploadDataOptions(), logger: logger, transferDatabase: transferDatabase, @@ -138,64 +132,6 @@ void main() { final result = await uploadDataTask.result; - expect(result.key, testPath); - expect(result.path, resolvedPath); - - final capturedRequest = verify( - () => s3Client.putObject( - captureAny(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).captured.last; - - expect(capturedRequest is s3.PutObjectRequest, isTrue); - final request = capturedRequest as s3.PutObjectRequest; - expect(request.bucket, testBucket); - expect( - request.key, - resolvedPath, - ); - expect(request.body, testDataPayload); - }); - - test( - 'should invoke S3Client.putObject API with expected parameters and default access level with path', - () async { - final testPutObjectOutput = s3.PutObjectOutput(); - final smithyOperation = MockSmithyOperation(); - - when( - () => smithyOperation.result, - ).thenAnswer((_) async => testPutObjectOutput); - when(() => smithyOperation.requestProgress) - .thenAnswer((_) => Stream.value(1)); - - when( - () => s3Client.putObject( - any(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).thenAnswer((_) => smithyOperation); - - final uploadDataTask = S3UploadTask.fromDataPayload( - testDataPayload, - s3Client: s3Client, - defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, - pathResolver: pathResolver, - bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), - options: const StorageUploadDataOptions(), - logger: logger, - transferDatabase: transferDatabase, - ); - - unawaited(uploadDataTask.start()); - - final result = await uploadDataTask.result; - - expect(result.key, TestPathResolver.path); expect(result.path, TestPathResolver.path); final capturedRequest = verify( @@ -247,7 +183,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -299,7 +235,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -331,7 +267,6 @@ void main() { 'should invoke S3Client.headObject API with correct parameters when getProperties is set to true in the options', () async { const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3UploadDataPluginOptions( getProperties: true, ), @@ -371,75 +306,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testPath, - options: testUploadDataOptions, - logger: logger, - transferDatabase: transferDatabase, - ); - - unawaited(uploadDataTask.start()); - await uploadDataTask.result; - - final capturedRequest = verify( - () => s3Client.headObject(captureAny()), - ).captured.last; - - expect(capturedRequest is s3.HeadObjectRequest, isTrue); - final request = capturedRequest as s3.HeadObjectRequest; - expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testUploadDataOptions.accessLevel!, - )}$testPath', - ); - }); - - test( - 'should invoke S3Client.headObject API with correct parameters when getProperties is set to true in the options with path', - () async { - const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, - pluginOptions: S3UploadDataPluginOptions( - getProperties: true, - ), - ); - final testPutObjectOutput = s3.PutObjectOutput(); - final putSmithyOperation = MockSmithyOperation(); - final testHeadObjectOutput = s3.HeadObjectOutput(); - final headSmithyOperation = MockSmithyOperation(); - - when( - () => putSmithyOperation.result, - ).thenAnswer((_) async => testPutObjectOutput); - when( - () => putSmithyOperation.requestProgress, - ).thenAnswer((_) => Stream.value(1)); - - when( - () => headSmithyOperation.result, - ).thenAnswer((_) async => testHeadObjectOutput); - - when( - () => s3Client.putObject( - any(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).thenAnswer((_) => putSmithyOperation); - - when( - () => s3Client.headObject(any()), - ).thenAnswer((_) => headSmithyOperation); - - final uploadDataTask = S3UploadTask.fromDataPayload( - testDataPayload, - s3Client: s3Client, - defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, - pathResolver: pathResolver, - bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -461,28 +328,6 @@ void main() { ); }); - test('should throw StorageException when prefix resolving fails', () { - final prefixResolverThrowsException = - TestCustomPrefixResolverThrowsException(); - - final uploadDataTask = S3UploadTask.fromDataPayload( - testDataPayload, - s3Client: s3Client, - defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: prefixResolverThrowsException, - pathResolver: pathResolver, - bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testPath, - options: testUploadDataOptions, - logger: logger, - transferDatabase: transferDatabase, - ); - - unawaited(uploadDataTask.start()); - expect(uploadDataTask.result, throwsA(isA())); - }); - test( 'should throw StorageAccessDeniedException when S3Client.putObject' ' returned UnknownSmithyHttpException with status code 403', () { @@ -506,7 +351,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -523,9 +368,7 @@ void main() { test( 'should throw NetworkException when S3Client.putObject' ' returned AWSHttpException', () { - const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, - ); + const testUploadDataOptions = StorageUploadDataOptions(); final testException = AWSHttpException( AWSHttpRequest(method: AWSHttpMethod.put, uri: Uri()), ); @@ -545,7 +388,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -592,7 +435,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testPath), + path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -646,7 +489,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -656,65 +499,6 @@ void main() { final result = await uploadDataTask.result; - expect(result.key, testKey); - - final capturedRequest = verify( - () => s3Client.putObject( - captureAny(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).captured.last; - - expect(capturedRequest is s3.PutObjectRequest, isTrue); - final request = capturedRequest as s3.PutObjectRequest; - expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testUploadDataOptions.accessLevel!, - )}$testKey', - ); - expect(request.contentType, await testLocalFile.contentType); - expect(await request.body.toList(), equals([testBytes])); - }); - - test('should invoke S3Client.putObject with expected parameters with path', - () async { - final testPutObjectOutput = s3.PutObjectOutput(); - final smithyOperation = MockSmithyOperation(); - - when( - () => smithyOperation.result, - ).thenAnswer((_) async => testPutObjectOutput); - when(() => smithyOperation.requestProgress) - .thenAnswer((_) => Stream.value(1)); - - when( - () => s3Client.putObject( - any(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).thenAnswer((_) => smithyOperation); - - final uploadDataTask = S3UploadTask.fromAWSFile( - testLocalFile, - s3Client: s3Client, - defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, - pathResolver: pathResolver, - bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), - options: testUploadDataOptions, - logger: logger, - transferDatabase: transferDatabase, - ); - - unawaited(uploadDataTask.start()); - - final result = await uploadDataTask.result; - - expect(result.key, TestPathResolver.path); expect(result.path, TestPathResolver.path); final capturedRequest = verify( @@ -739,7 +523,6 @@ void main() { 'should invoke S3Client.putObject with correct useAcceleration parameter', () async { const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3UploadDataPluginOptions( useAccelerateEndpoint: true, ), @@ -768,7 +551,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -826,7 +609,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -882,7 +665,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -920,7 +703,6 @@ void main() { } const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.protected, metadata: {'filename': 'png.png'}, pluginOptions: S3UploadDataPluginOptions( getProperties: true, @@ -1023,242 +805,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - key: testKey, - options: testUploadDataOptions, - logger: logger, - transferDatabase: transferDatabase, - onProgress: onProgress, - ); - - unawaited(uploadTask.start()); - - await uploadTask.result; - - // verify generated CreateMultipartUploadRequest - final capturedCreateMultipartUploadRequest = verify( - () => s3Client.createMultipartUpload( - captureAny(), - ), - ).captured.last; - expect( - capturedCreateMultipartUploadRequest, - isA(), - ); - final createMultipartUploadRequest = - capturedCreateMultipartUploadRequest - as s3.CreateMultipartUploadRequest; - expect(createMultipartUploadRequest.bucket, testBucket); - expect( - createMultipartUploadRequest.contentType, - await testLocalFile.contentType, - ); - expect( - createMultipartUploadRequest.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testUploadDataOptions.accessLevel!, - )}$testKey', - ); - expect( - capturedCreateMultipartUploadRequest.metadata?['filename'], - testUploadDataOptions.metadata['filename'], - ); - final capturedTransferDBInsertParam = verify( - () => transferDatabase.insertTransferRecord( - captureAny(), - ), - ).captured.last; - expect( - capturedTransferDBInsertParam, - isA().having( - (o) => o.uploadId, - 'uploadId', - testMultipartUploadId, - ), - ); - - // verify uploadPart calls - final uploadPartVerification = verify( - () => s3Client.uploadPart( - captureAny(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - )..called(3); // 11MB file creates 3 upload part requests - final capturedUploadPartRequests = uploadPartVerification.captured; - final partNumbers = []; - final bytes = BytesBuilder(); - - await Future.forEach(capturedUploadPartRequests, - (capturedRequest) async { - expect(capturedRequest, isA()); - final request = capturedRequest as s3.UploadPartRequest; - expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testUploadDataOptions.accessLevel!, - )}$testKey', - ); - partNumbers.add(request.partNumber!); - bytes.add( - await request.body.toList().then( - (collectedBytes) => - collectedBytes.expand((bytes) => bytes).toList(), - ), - ); - }); - expect(bytes.takeBytes(), equals(testBytes)); - expect(partNumbers, equals([1, 2, 3])); - expect( - receivedState, - List.generate(4, (_) => StorageTransferState.inProgress) - ..add(StorageTransferState.success), - ); // upload start + 3 parts - - // verify the CompleteMultipartUpload request - final capturedCompleteMultipartUploadRequest = verify( - () => s3Client.completeMultipartUpload( - captureAny(), - ), - ).captured.last; - expect( - capturedCompleteMultipartUploadRequest, - isA(), - ); - final completeMultipartUploadRequest = - capturedCompleteMultipartUploadRequest - as s3.CompleteMultipartUploadRequest; - expect(completeMultipartUploadRequest.bucket, testBucket); - expect( - completeMultipartUploadRequest.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testUploadDataOptions.accessLevel!, - )}$testKey', - ); - - final capturedTransferDBDeleteParam = verify( - () => transferDatabase.deleteTransferRecords( - captureAny(), - ), - ).captured.last; - expect( - capturedTransferDBDeleteParam, - testMultipartUploadId, - ); - }); - - test( - 'should invoke corresponding S3Client APIs with in a happy path to complete the upload with path', - () async { - final receivedState = []; - void onProgress(S3TransferProgress progress) { - receivedState.add(progress.state); - } - - const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.protected, - metadata: {'filename': 'png.png'}, - pluginOptions: S3UploadDataPluginOptions( - getProperties: true, - ), - ); - const testMultipartUploadId = 'awesome-upload'; - - final testCreateMultipartUploadOutput = s3.CreateMultipartUploadOutput( - uploadId: testMultipartUploadId, - ); - final createMultipartUploadSmithyOperation = - MockSmithyOperation(); - - when( - () => createMultipartUploadSmithyOperation.result, - ).thenAnswer((_) async => testCreateMultipartUploadOutput); - - when( - () => s3Client.createMultipartUpload(any()), - ).thenAnswer((_) => createMultipartUploadSmithyOperation); - - when( - () => transferDatabase.insertTransferRecord(any()), - ).thenAnswer((_) async => '1'); - - final testUploadPartOutput1 = s3.UploadPartOutput(eTag: 'eTag-part-1'); - final testUploadPartOutput2 = s3.UploadPartOutput(eTag: 'eTag-part-2'); - final testUploadPartOutput3 = s3.UploadPartOutput(eTag: 'eTag-part-3'); - final uploadPartSmithyOperation1 = - MockSmithyOperation(); - final uploadPartSmithyOperation2 = - MockSmithyOperation(); - final uploadPartSmithyOperation3 = - MockSmithyOperation(); - - when( - () => uploadPartSmithyOperation1.result, - ).thenAnswer((_) async => testUploadPartOutput1); - when( - () => uploadPartSmithyOperation2.result, - ).thenAnswer((_) async => testUploadPartOutput2); - when( - () => uploadPartSmithyOperation3.result, - ).thenAnswer((_) async => testUploadPartOutput3); - - when( - () => s3Client.uploadPart( - any(), - s3ClientConfig: any(named: 's3ClientConfig'), - ), - ).thenAnswer((invocation) { - final request = - invocation.positionalArguments.first as s3.UploadPartRequest; - - switch (request.partNumber) { - case 1: - return uploadPartSmithyOperation1; - case 2: - return uploadPartSmithyOperation2; - case 3: - return uploadPartSmithyOperation3; - } - - throw Exception('this is not going to happen in this test setup'); - }); - - final testCompleteMultipartUploadOutput = - s3.CompleteMultipartUploadOutput(); - final completeMultipartUploadSmithyOperation = - MockSmithyOperation(); - - when( - () => completeMultipartUploadSmithyOperation.result, - ).thenAnswer((_) async => testCompleteMultipartUploadOutput); - - when( - () => s3Client.completeMultipartUpload(any()), - ).thenAnswer((_) => completeMultipartUploadSmithyOperation); - - when( - () => transferDatabase.deleteTransferRecords(any()), - ).thenAnswer((_) async => 1); - - final testHeadObjectOutput = s3.HeadObjectOutput(); - final headSmithyOperation = MockSmithyOperation(); - - when( - () => headSmithyOperation.result, - ).thenAnswer((_) async => testHeadObjectOutput); - - when( - () => s3Client.headObject(any()), - ).thenAnswer((_) => headSmithyOperation); - - final uploadTask = S3UploadTask.fromAWSFile( - testLocalFile, - s3Client: s3Client, - defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, - pathResolver: pathResolver, - bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1379,7 +926,6 @@ void main() { 'should invoke S3Client uploadPart API with correct useAcceleration parameter', () async { const testUploadDataOptions = StorageUploadDataOptions( - accessLevel: StorageAccessLevel.protected, pluginOptions: S3UploadDataPluginOptions( useAccelerateEndpoint: true, ), @@ -1443,7 +989,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1537,7 +1083,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1640,7 +1186,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1679,7 +1225,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1713,7 +1259,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1744,7 +1290,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1790,10 +1336,8 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), - options: const StorageUploadDataOptions( - accessLevel: StorageAccessLevel.guest, - ), + path: const StoragePath.fromString(testKey), + options: const StorageUploadDataOptions(), logger: logger, transferDatabase: transferDatabase, onProgress: (progress) { @@ -1837,7 +1381,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1882,7 +1426,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -1965,7 +1509,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2059,10 +1603,8 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), - options: const StorageUploadDataOptions( - accessLevel: StorageAccessLevel.guest, - ), + path: const StoragePath.fromString(testKey), + options: const StorageUploadDataOptions(), logger: logger, transferDatabase: transferDatabase, onProgress: (progress) { @@ -2154,7 +1696,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2226,7 +1768,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2384,7 +1926,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2444,7 +1986,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, transferDatabase: transferDatabase, @@ -2511,7 +2053,7 @@ void main() { pathResolver: pathResolver, bucket: testBucket, defaultAccessLevel: testDefaultAccessLevel, - path: StoragePath.fromString(testKey), + path: const StoragePath.fromString(testKey), options: const StorageUploadDataOptions( pluginOptions: S3UploadDataPluginOptions( useAccelerateEndpoint: true, From 3bf3669a2dbb36673cc1927e4fa0ecb310eeafbe Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Thu, 14 Mar 2024 08:02:32 -0700 Subject: [PATCH 11/46] chore: update tests to adjust for using path --- .../content_type_infer_html.dart | 3 +- .../content_type_infer_io.dart | 3 +- .../get_url_special_characters_test.dart | 4 +- .../transfer_acceleration.dart | 28 +++--- .../integration_test/use_case_test.dart | 90 ++++++++++--------- 5 files changed, 65 insertions(+), 63 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_html.dart b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_html.dart index 19857efdd4..4c646ee5fc 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_html.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_html.dart @@ -54,9 +54,8 @@ void testContentTypeInferTest({ final result = await s3Plugin .uploadFile( localFile: file, - key: testUploadKeys[index], + path: StoragePath.fromString('/private/${testUploadKeys[index]}'), options: const StorageUploadFileOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3UploadFilePluginOptions( getProperties: true, ), diff --git a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart index 13ae33562f..613bef3c76 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart @@ -51,9 +51,8 @@ void testContentTypeInferTest({ final result = await s3Plugin .uploadFile( localFile: file, - key: testUploadKeys[index], + path: StoragePath.fromString('/private/${testUploadKeys[index]}'), options: const StorageUploadFileOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3UploadFilePluginOptions( getProperties: true, ), diff --git a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart index 4acf149a10..22e1846941 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart @@ -41,10 +41,10 @@ void main() { final key = 'Test - ${DateTime.now()}'; await Amplify.Storage.uploadData( data: S3DataPayload.bytes('hello'.codeUnits), - key: key, + path: StoragePath.fromString('public/$key'), ).result; - final getUrlResult = await Amplify.Storage.getUrl(key: key).result; + final getUrlResult = await Amplify.Storage.getUrl(path: StoragePath.fromString('/public/$key')).result; final uri = getUrlResult.url; final client = AWSHttpClient() diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index dff163d947..c549b46191 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -29,11 +29,10 @@ void testTransferAcceleration({ final dataPayload = entry.value; final operation = Amplify.Storage.uploadData( data: dataPayload.uploadSource, - key: dataPayload.targetKey, - options: StorageUploadDataOptions( - accessLevel: dataPayload.targetAccessLevel, + path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + options: const StorageUploadDataOptions( pluginOptions: - const S3UploadDataPluginOptions(useAccelerateEndpoint: true), + S3UploadDataPluginOptions(useAccelerateEndpoint: true), ), ); @@ -50,10 +49,9 @@ void testTransferAcceleration({ test('S3DataPayload ${entry.key}', () async { final dataPayload = entry.value; final result = await Amplify.Storage.getUrl( - key: dataPayload.targetKey, - options: StorageGetUrlOptions( - accessLevel: dataPayload.targetAccessLevel, - pluginOptions: const S3GetUrlPluginOptions( + path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + options: const StorageGetUrlOptions( + pluginOptions: S3GetUrlPluginOptions( expiresIn: Duration(minutes: 5), useAccelerateEndpoint: true, ), @@ -103,10 +101,9 @@ void testTransferAcceleration({ final awsFile = entry.value; final operation = Amplify.Storage.uploadFile( localFile: awsFile.uploadSource, - key: awsFile.targetKey, - options: StorageUploadFileOptions( - accessLevel: awsFile.targetAccessLevel, - pluginOptions: const S3UploadFilePluginOptions( + path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + options: const StorageUploadFileOptions( + pluginOptions: S3UploadFilePluginOptions( useAccelerateEndpoint: true, ), ), @@ -127,10 +124,9 @@ void testTransferAcceleration({ () async { final awsFile = entry.value; final result = await Amplify.Storage.getUrl( - key: awsFile.targetKey, - options: StorageGetUrlOptions( - accessLevel: awsFile.targetAccessLevel, - pluginOptions: const S3GetUrlPluginOptions( + path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + options: const StorageGetUrlOptions( + pluginOptions: S3GetUrlPluginOptions( expiresIn: Duration(minutes: 5), useAccelerateEndpoint: true, ), diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 09d8b47135..11cac56aaa 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -90,6 +90,12 @@ void main() { await Amplify.addPlugins([authPlugin, storagePlugin]); await Amplify.configure(amplifyEnvironments[entry.key]!); + try { + await Amplify.Auth.signOut(); + } on Exception { + // do nothing + } + await Amplify.Auth.signUp( username: username1, password: password, @@ -205,7 +211,7 @@ void main() { final result = await s3Plugin .uploadData( data: S3DataPayload.dataUrl(testDataUrl), - path: StoragePath.fromString('/protected/$testObjectKey2'), + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), options: const StorageUploadDataOptions( metadata: { 'filename': testObjectFileName2, @@ -242,7 +248,7 @@ void main() { final result = await s3Plugin .uploadFile( localFile: AWSFile.fromData(testLargeFileBytes), - path: StoragePath.fromString('/private/$testObjectKey3'), + path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageUploadFileOptions( metadata: { 'filename': testObjectFileName3, @@ -276,7 +282,7 @@ void main() { 'generate downloadable url with access level private for the' ' currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.getUrl( - path: StoragePath.fromString('/private/$testObjectKey3'), + path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, @@ -293,7 +299,7 @@ void main() { (WidgetTester tester) async { final result = Amplify.Storage.getUrl( path: const StoragePath.fromString( - 'random/non-existent/object.png', + '/random/non-existent/object.png', ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( @@ -307,6 +313,7 @@ void main() { }); testWidgets( + skip: true, 'download object as bytes data in memory with access level private' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( @@ -324,6 +331,7 @@ void main() { }); testWidgets( + skip: true, 'download a range of bytes of an object with access level private' ' for the currently signed in user', (WidgetTester tester) async { const start = 5 * 1024; @@ -351,6 +359,7 @@ void main() { }); testWidgets( + skip: true, 'download file with access level private for the currently signed in user', (WidgetTester tester) async { final s3Plugin = @@ -380,10 +389,12 @@ void main() { }, // Web download relies on getUrl which has been covered in the getUrl // integration test run. - skip: zIsWeb, + // TODO(khatruong2009): Re-enable this test after download apis completed. + // skip: zIsWeb, ); testWidgets( + skip: true, 'copy object with access level private for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.copy( @@ -407,6 +418,7 @@ void main() { }); testWidgets( + skip: true, 'move object with access level private for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.move( @@ -453,7 +465,9 @@ void main() { expect(result.removedItem.key, testObject3CopyMoveKey); }); - group('content type infer', () { + group( + skip: true, + 'content type infer', () { testContentTypeInferTest( smallFileBytes: testBytes, largeFileBytes: testLargeFileBytes, @@ -461,7 +475,9 @@ void main() { }); if (shouldTestTransferAcceleration) { - group('transfer acceleration', () { + group( + skip: true, + 'transfer acceleration', () { testTransferAcceleration( dataPayloads: [ TestTransferAccelerationConfig( @@ -503,10 +519,9 @@ void main() { testBytes, contentType: testContentType, ), - key: objectKey, + path: StoragePath.fromString('/public/$objectKey'), options: StorageUploadDataOptions( metadata: testMetadata, - accessLevel: StorageAccessLevel.guest, pluginOptions: const S3UploadDataPluginOptions( getProperties: true, ), @@ -552,7 +567,7 @@ void main() { testWidgets('get properties of object with access level guest', (WidgetTester tester) async { final result = - await Amplify.Storage.getProperties(key: testObjectKey1).result; + await Amplify.Storage.getProperties(path: StoragePath.fromString('/public/$testObjectKey1')).result; expect(result.storageItem.eTag, object1Etag); }); @@ -561,12 +576,7 @@ void main() { 'get properties of object with access level protected and a target identity id', (WidgetTester tester) async { final result = await Amplify.Storage.getProperties( - key: testObjectKey2, - options: StorageGetPropertiesOptions( - accessLevel: StorageAccessLevel.protected, - pluginOptions: - S3GetPropertiesPluginOptions.forIdentity(user1IdentityId), - ), + path: StoragePath.fromString('/protected/$user1IdentityId/$testObjectKey2'), ).result; expect(result.storageItem.eTag, object2Etag); @@ -577,10 +587,7 @@ void main() { ' private for the currently signed user throws exception', (WidgetTester tester) async { final operation = Amplify.Storage.getProperties( - key: testObjectKey3, - options: const StorageGetPropertiesOptions( - accessLevel: StorageAccessLevel.private, - ), + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), ); await expectLater( @@ -592,9 +599,8 @@ void main() { testWidgets('get url of object with access level guest', (WidgetTester tester) async { final operation = Amplify.Storage.getUrl( - key: testObjectKey1, + path: StoragePath.fromString('/public/$testObjectKey1'), options: const StorageGetUrlOptions( - accessLevel: StorageAccessLevel.guest, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, ), @@ -608,13 +614,9 @@ void main() { 'get url of object with access level protected and a target identity id', (WidgetTester tester) async { final operation = Amplify.Storage.getUrl( - key: testObjectKey2, - options: StorageGetUrlOptions( - accessLevel: StorageAccessLevel.protected, - pluginOptions: S3GetUrlPluginOptions.forIdentity( - user1IdentityId, - validateObjectExistence: true, - ), + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), + options: const StorageGetUrlOptions( + pluginOptions: S3GetUrlPluginOptions(), ), ); @@ -626,9 +628,8 @@ void main() { ' private for the currently signed user throws exception', (WidgetTester tester) async { final operation = Amplify.Storage.getUrl( - key: testObjectKey3, + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageGetUrlOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, ), @@ -642,6 +643,7 @@ void main() { }); testWidgets( + skip: true, 'download data of object with access level protected and a target' ' identity id for the currently signed user', (WidgetTester tester) async { @@ -660,6 +662,7 @@ void main() { }); testWidgets( + skip: true, 'download data of object (belongs to other user) with access level' ' private for the currently signed user', (WidgetTester tester) async { @@ -680,6 +683,7 @@ void main() { }); testWidgets( + skip: true, 'move object with access level guest for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.move( @@ -702,6 +706,7 @@ void main() { }); testWidgets( + skip: true, 'copy object (belongs to other user) with access level protected' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.copy( @@ -723,7 +728,9 @@ void main() { expect(result.copiedItem.eTag, isNotEmpty); }); - testWidgets('list respects pageSize', (WidgetTester tester) async { + testWidgets( + skip: true, + 'list respects pageSize', (WidgetTester tester) async { const filesToUpload = 2; const filesToList = 1; const accessLevel = StorageAccessLevel.private; @@ -738,9 +745,8 @@ void main() { testBytes, contentType: 'text/plain', ), - key: fileKey, + path: StoragePath.fromString('/private/$fileKey'), options: StorageUploadDataOptions( - accessLevel: accessLevel, metadata: { 'filename': fileNameTemp, }, @@ -766,7 +772,7 @@ void main() { ).result; }); - testWidgets('list uses nextToken for pagination', + testWidgets(skip: true, 'list uses nextToken for pagination', (WidgetTester tester) async { const filesToUpload = 2; const filesToList = 1; @@ -783,9 +789,8 @@ void main() { testBytes, contentType: 'text/plain', ), - key: fileKey, + path: StoragePath.fromString('/private/$fileKey'), options: StorageUploadDataOptions( - accessLevel: accessLevel, metadata: { 'filename': fileNameTemp, }, @@ -819,6 +824,7 @@ void main() { }); testWidgets( + skip: true, 'remove many objects belongs to the currently signed user', (WidgetTester tester) async { final listedObjects = await Amplify.Storage.list( @@ -829,7 +835,7 @@ void main() { expect(listedObjects.items, hasLength(2)); final result = await Amplify.Storage.removeMany( - keys: listedObjects.items.map((item) => item.key).toList(), + keys: listedObjects.items.map((item) => item.path).toList(), options: const StorageRemoveManyOptions( accessLevel: StorageAccessLevel.private, ), @@ -857,7 +863,7 @@ void main() { await Amplify.Auth.signOut(); }); - testWidgets('move object with access level protected as object owner', + testWidgets(skip: true, 'move object with access level protected as object owner', (WidgetTester tester) async { final result = await Amplify.Storage.move( source: S3ItemWithAccessLevel.forIdentity( @@ -876,7 +882,9 @@ void main() { expect(result.movedItem.eTag, isNotEmpty); }); - testWidgets('remove many objects belongs to the currently signed user', + testWidgets( + skip: true, + 'remove many objects belongs to the currently signed user', (WidgetTester tester) async { final listedObjects = await Amplify.Storage.list( options: const StorageListOptions( @@ -886,7 +894,7 @@ void main() { expect(listedObjects.items, hasLength(2)); final result = await Amplify.Storage.removeMany( - keys: listedObjects.items.map((item) => item.key).toList(), + keys: listedObjects.items.map((item) => item.path).toList(), options: const StorageRemoveManyOptions( accessLevel: StorageAccessLevel.private, ), From a30ec9ded674d7650c231442f7d8df88482a34a0 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:25:39 -0400 Subject: [PATCH 12/46] chore: fix lint issues --- .../category/amplify_storage_category.dart | 4 +- .../types/storage/base/storage_operation.dart | 2 +- .../base/storage_operation_options.dart | 3 +- .../lib/src/types/storage/storage_item.dart | 4 +- .../get_url_special_characters_test.dart | 4 +- .../transfer_acceleration.dart | 16 +++-- .../integration_test/use_case_test.dart | 54 ++++++++++------- .../lib/src/amplify_storage_s3_dart_impl.dart | 2 - .../lib/src/model/s3_get_url_options.dart | 6 -- .../lib/src/model/s3_item.dart | 6 +- .../download_file/download_file_html.dart | 4 +- .../service/storage_s3_service_impl.dart | 6 -- .../service/task/s3_download_task.dart | 7 ++- .../service/task/s3_upload_task.dart | 16 ----- .../test/amplify_storage_s3_dart_test.dart | 1 - .../download_file_html_test.dart | 10 ++-- .../storage_s3_service_test.dart | 2 - .../task/s3_upload_task_test.dart | 59 ------------------- 18 files changed, 69 insertions(+), 137 deletions(-) diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index a673c27b83..b4f807e127 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -139,7 +139,7 @@ class StorageCategory extends AmplifyCategory { /// {@template amplify_core.amplify_storage_category.upload_data} /// Uploads [data] as a [StorageDataPayload] with optional - /// [onProgress] and [StorageUploadDataOptions] to object specified by [key], + /// [onProgress] and [StorageUploadDataOptions] to object specified by [path], /// and returns a [StorageUploadDataOperation]. /// /// See [StorageDataPayload] for supported data formats. @@ -163,7 +163,7 @@ class StorageCategory extends AmplifyCategory { /// {@template amplify_core.amplify_storage_category.upload_file} /// Uploads data from [localFile] with optional [onProgress] and - /// [StorageUploadFileOptions] to object specified by [key], and returns a + /// [StorageUploadFileOptions] to object specified by [path], and returns a /// [StorageUploadFileOperation]. /// /// [AWSFile] provides various adapters to read file content from file diff --git a/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart b/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart index 6bef0394ea..62ff079816 100644 --- a/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart +++ b/packages/amplify_core/lib/src/types/storage/base/storage_operation.dart @@ -10,7 +10,7 @@ abstract class StorageOperation { required this.result, }) : operationId = uuid(); - // TODO[Jordan-Nelson]: determine if this should be private. + // TODO(Jordan-Nelson): determine if this should be private. @internal final Request request; final String operationId; diff --git a/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart b/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart index 9fddbec007..14d87654ae 100644 --- a/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart +++ b/packages/amplify_core/lib/src/types/storage/base/storage_operation_options.dart @@ -5,9 +5,8 @@ import 'package:amplify_core/src/types/storage/access_level.dart'; abstract class StorageOperationOptions { const StorageOperationOptions({ - @Deprecated('Use `path` instead') this.accessLevel, + this.accessLevel, }); - @Deprecated('Use `path` instead') final StorageAccessLevel? accessLevel; } diff --git a/packages/amplify_core/lib/src/types/storage/storage_item.dart b/packages/amplify_core/lib/src/types/storage/storage_item.dart index debf30a115..b2d71351fb 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_item.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_item.dart @@ -10,7 +10,7 @@ class StorageItem { /// {@macro amplify_core.storage.storage_item} const StorageItem({ this.key, - // TODO[Jordan-Nelson]: make required + // TODO(Jordan-Nelson): make required this.path = '', this.size, this.lastModified, @@ -18,7 +18,7 @@ class StorageItem { this.metadata = const {}, }); - // TODO[Jordan-Nelson]: Remove key + // TODO(Jordan-Nelson): Remove key final String? key; final String path; final int? size; diff --git a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart index 22e1846941..a52e3ad964 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart @@ -44,7 +44,9 @@ void main() { path: StoragePath.fromString('public/$key'), ).result; - final getUrlResult = await Amplify.Storage.getUrl(path: StoragePath.fromString('/public/$key')).result; + final getUrlResult = await Amplify.Storage.getUrl( + path: StoragePath.fromString('/public/$key'), + ).result; final uri = getUrlResult.url; final client = AWSHttpClient() diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index c549b46191..144c9dbacf 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -29,7 +29,9 @@ void testTransferAcceleration({ final dataPayload = entry.value; final operation = Amplify.Storage.uploadData( data: dataPayload.uploadSource, - path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + path: StoragePath.fromString( + '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}', + ), options: const StorageUploadDataOptions( pluginOptions: S3UploadDataPluginOptions(useAccelerateEndpoint: true), @@ -49,7 +51,9 @@ void testTransferAcceleration({ test('S3DataPayload ${entry.key}', () async { final dataPayload = entry.value; final result = await Amplify.Storage.getUrl( - path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + path: StoragePath.fromString( + '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}', + ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( expiresIn: Duration(minutes: 5), @@ -101,7 +105,9 @@ void testTransferAcceleration({ final awsFile = entry.value; final operation = Amplify.Storage.uploadFile( localFile: awsFile.uploadSource, - path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + path: StoragePath.fromString( + '${awsFile.targetAccessLevel}/${awsFile.targetKey}', + ), options: const StorageUploadFileOptions( pluginOptions: S3UploadFilePluginOptions( useAccelerateEndpoint: true, @@ -124,7 +130,9 @@ void testTransferAcceleration({ () async { final awsFile = entry.value; final result = await Amplify.Storage.getUrl( - path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + path: StoragePath.fromString( + '${awsFile.targetAccessLevel}/${awsFile.targetKey}', + ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( expiresIn: Duration(minutes: 5), diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 11cac56aaa..5c155b5113 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -211,7 +211,9 @@ void main() { final result = await s3Plugin .uploadData( data: S3DataPayload.dataUrl(testDataUrl), - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testObjectKey2', + ), options: const StorageUploadDataOptions( metadata: { 'filename': testObjectFileName2, @@ -248,7 +250,9 @@ void main() { final result = await s3Plugin .uploadFile( localFile: AWSFile.fromData(testLargeFileBytes), - path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: const StorageUploadFileOptions( metadata: { 'filename': testObjectFileName3, @@ -282,7 +286,9 @@ void main() { 'generate downloadable url with access level private for the' ' currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.getUrl( - path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, @@ -465,9 +471,7 @@ void main() { expect(result.removedItem.key, testObject3CopyMoveKey); }); - group( - skip: true, - 'content type infer', () { + group(skip: true, 'content type infer', () { testContentTypeInferTest( smallFileBytes: testBytes, largeFileBytes: testLargeFileBytes, @@ -475,9 +479,7 @@ void main() { }); if (shouldTestTransferAcceleration) { - group( - skip: true, - 'transfer acceleration', () { + group(skip: true, 'transfer acceleration', () { testTransferAcceleration( dataPayloads: [ TestTransferAccelerationConfig( @@ -566,8 +568,9 @@ void main() { testWidgets('get properties of object with access level guest', (WidgetTester tester) async { - final result = - await Amplify.Storage.getProperties(path: StoragePath.fromString('/public/$testObjectKey1')).result; + final result = await Amplify.Storage.getProperties( + path: StoragePath.fromString('/public/$testObjectKey1'), + ).result; expect(result.storageItem.eTag, object1Etag); }); @@ -576,7 +579,9 @@ void main() { 'get properties of object with access level protected and a target identity id', (WidgetTester tester) async { final result = await Amplify.Storage.getProperties( - path: StoragePath.fromString('/protected/$user1IdentityId/$testObjectKey2'), + path: StoragePath.fromString( + '/protected/$user1IdentityId/$testObjectKey2', + ), ).result; expect(result.storageItem.eTag, object2Etag); @@ -587,7 +592,9 @@ void main() { ' private for the currently signed user throws exception', (WidgetTester tester) async { final operation = Amplify.Storage.getProperties( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3', + ), ); await expectLater( @@ -614,7 +621,9 @@ void main() { 'get url of object with access level protected and a target identity id', (WidgetTester tester) async { final operation = Amplify.Storage.getUrl( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testObjectKey2', + ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions(), ), @@ -628,7 +637,9 @@ void main() { ' private for the currently signed user throws exception', (WidgetTester tester) async { final operation = Amplify.Storage.getUrl( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( validateObjectExistence: true, @@ -728,9 +739,8 @@ void main() { expect(result.copiedItem.eTag, isNotEmpty); }); - testWidgets( - skip: true, - 'list respects pageSize', (WidgetTester tester) async { + testWidgets(skip: true, 'list respects pageSize', + (WidgetTester tester) async { const filesToUpload = 2; const filesToList = 1; const accessLevel = StorageAccessLevel.private; @@ -863,7 +873,9 @@ void main() { await Amplify.Auth.signOut(); }); - testWidgets(skip: true, 'move object with access level protected as object owner', + testWidgets( + skip: true, + 'move object with access level protected as object owner', (WidgetTester tester) async { final result = await Amplify.Storage.move( source: S3ItemWithAccessLevel.forIdentity( @@ -883,8 +895,8 @@ void main() { }); testWidgets( - skip: true, - 'remove many objects belongs to the currently signed user', + skip: true, + 'remove many objects belongs to the currently signed user', (WidgetTester tester) async { final listedObjects = await Amplify.Storage.list( options: const StorageListOptions( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index 12dcd31726..3ccd4f43e4 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use, deprecated_member_use_from_same_package - import 'dart:async'; import 'dart:typed_data'; diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart index 3ca351ccd5..421ce22d82 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_get_url_options.dart @@ -30,7 +30,6 @@ class S3GetUrlOptions extends StorageGetUrlOptions { const S3GetUrlOptions._({ this.expiresIn = const Duration(minutes: 15), this.validateObjectExistence = false, - this.targetIdentityId, this.useAccelerateEndpoint = false, }); @@ -41,11 +40,6 @@ class S3GetUrlOptions extends StorageGetUrlOptions { /// a presigned url. final bool validateObjectExistence; - /// The identity ID of another user who uploaded the object. - /// - /// This can be set by using [S3GetUrlOptions.forIdentity]. - final String? targetIdentityId; - /// {@macro storage.amplify_storage_s3.transfer_acceleration} final bool useAccelerateEndpoint; } diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart index e1c3c33cd5..e9977cdcce 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.dart @@ -20,7 +20,7 @@ class S3Item extends StorageItem /// {@macro storage.amplify_storage_s3.storage_s3_item} S3Item({ super.key, - // TODO[Jordan-Nelson]: make required + // TODO(Jordan-Nelson): make required super.path, super.size, super.lastModified, @@ -83,7 +83,7 @@ class S3Item extends StorageItem @internal factory S3Item.fromHeadObjectOutput( s3.HeadObjectOutput headObjectOutput, { - // TODO: remove + // TODO(Jordan-Nelson): remove key String? key, required String path, }) { @@ -104,7 +104,7 @@ class S3Item extends StorageItem @internal factory S3Item.fromGetObjectOutput( s3.GetObjectOutput getObjectOutput, { - // TODO: remove + // TODO(Jordan-Nelson): remove key String? key, required String path, }) { diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart index 16ada683b0..93cbed3d6d 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart @@ -56,7 +56,7 @@ Future _downloadFromUrl({ // Exception thrown from the getProperties will be thrown as download // operation. final downloadedItem = (await storageS3Service.getProperties( - // TODO[Jordan-Nelson]: update to use path from customer + // TODO(Jordan-Nelson): update to use path from customer path: StoragePath.fromString(key), options: targetIdentityId == null ? StorageGetPropertiesOptions( @@ -74,7 +74,7 @@ Future _downloadFromUrl({ // We are not setting validateObjectExistence to true here as we are not // able to directly get the result of underlying HeadObject result. final url = (await storageS3Service.getUrl( - // TODO[Jordan-Nelson]: update to use path from customer + // TODO(Jordan-Nelson): update to use path from customer path: StoragePath.fromString(key), options: targetIdentityId == null ? StorageGetUrlOptions( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index b208261cd4..a1986e6fd8 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use - import 'dart:async'; import 'dart:math'; @@ -362,11 +360,9 @@ class StorageS3Service { s3Client: _defaultS3Client, defaultS3ClientConfig: _defaultS3ClientConfig, bucket: _s3PluginConfig.bucket, - defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, path: path, options: options, pathResolver: _pathResolver, - prefixResolver: _prefixResolver, logger: _logger, onProgress: onProgress, transferDatabase: _transferDatabase, @@ -402,11 +398,9 @@ class StorageS3Service { s3Client: _defaultS3Client, defaultS3ClientConfig: _defaultS3ClientConfig, bucket: _s3PluginConfig.bucket, - defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, path: path, options: uploadDataOptions, pathResolver: _pathResolver, - prefixResolver: _prefixResolver, logger: _logger, onProgress: onProgress, transferDatabase: _transferDatabase, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart index 2f2b2d7e4a..20553a3e61 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart @@ -175,8 +175,11 @@ class S3DownloadTask { _totalBytes = remoteSize; _listenToBytesSteam(getObjectOutput.body); - _downloadedS3Item = - S3Item.fromGetObjectOutput(getObjectOutput, key: _key, path: _resolvedKey); + _downloadedS3Item = S3Item.fromGetObjectOutput( + getObjectOutput, + key: _key, + path: _resolvedKey, + ); } on Exception catch (error, stackTrace) { await _completeDownloadWithError(error, stackTrace); } diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart index 8b1acf4753..13681cedc8 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_upload_task.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use, deprecated_member_use_from_same_package - import 'dart:async'; import 'dart:math'; @@ -51,10 +49,8 @@ class S3UploadTask { S3UploadTask._({ required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, - required S3PrefixResolver prefixResolver, required S3PathResolver pathResolver, required String bucket, - required StorageAccessLevel defaultAccessLevel, required StoragePath path, required StorageUploadDataOptions options, S3DataPayload? dataPayload, @@ -65,9 +61,7 @@ class S3UploadTask { }) : _s3Client = s3Client, _defaultS3ClientConfig = defaultS3ClientConfig, _pathResolver = pathResolver, - _prefixResolver = prefixResolver, _bucket = bucket, - _defaultAccessLevel = defaultAccessLevel, _path = path, _options = options, _dataPayload = dataPayload, @@ -88,10 +82,8 @@ class S3UploadTask { S3DataPayload dataPayload, { required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, - required S3PrefixResolver prefixResolver, required S3PathResolver pathResolver, required String bucket, - required StorageAccessLevel defaultAccessLevel, required StoragePath path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, @@ -101,9 +93,7 @@ class S3UploadTask { s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, pathResolver: pathResolver, - prefixResolver: prefixResolver, bucket: bucket, - defaultAccessLevel: defaultAccessLevel, path: path, dataPayload: dataPayload, options: options, @@ -119,10 +109,8 @@ class S3UploadTask { AWSFile localFile, { required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, - required S3PrefixResolver prefixResolver, required S3PathResolver pathResolver, required String bucket, - required StorageAccessLevel defaultAccessLevel, required StoragePath path, required StorageUploadDataOptions options, void Function(S3TransferProgress)? onProgress, @@ -131,10 +119,8 @@ class S3UploadTask { }) : this._( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: prefixResolver, pathResolver: pathResolver, bucket: bucket, - defaultAccessLevel: defaultAccessLevel, path: path, localFile: localFile, options: options, @@ -150,10 +136,8 @@ class S3UploadTask { final s3.S3Client _s3Client; final smithy_aws.S3ClientConfig _defaultS3ClientConfig; - final S3PrefixResolver _prefixResolver; final S3PathResolver _pathResolver; final String _bucket; - final StorageAccessLevel _defaultAccessLevel; final StoragePath _path; final StorageUploadDataOptions _options; final void Function(S3TransferProgress)? _onProgress; diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 68db8b5a3b..4031d5ad02 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -333,7 +333,6 @@ void main() { }); group('getUrl() API', () { - const testKey = 'some-object-key'; final testResult = S3GetUrlResult( url: Uri( host: 's3.amazon.aws', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index 5a625d33d1..7306a658fc 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -28,7 +28,7 @@ class DummyPathProvider implements AppPathProvider { void main() { group('downloadFile() html implementation', - // TODO: remove skip + // TODO(Jordan-Nelson): remove skip skip: true, () { late StorageS3Service storageS3Service; const testKey = 'upload-key.text'; @@ -72,7 +72,7 @@ void main() { when( () => storageS3Service.getProperties( - // TODO[Jordan-Nelson]: update + // TODO(Jordan-Nelson): update path: const StoragePath.fromString('key'), options: any(named: 'options'), ), @@ -80,7 +80,7 @@ void main() { when( () => storageS3Service.getUrl( - // TODO[Jordan-Nelson]: update + // TODO(Jordan-Nelson): update path: const StoragePath.fromString('key'), options: any(named: 'options'), ), @@ -108,7 +108,7 @@ void main() { final capturedGetPropertiesOptions = verify( () => storageS3Service.getProperties( - // TODO[Jordan-Nelson]: update + // TODO(Jordan-Nelson): update path: const StoragePath.fromString('key'), options: captureAny( named: 'options', @@ -134,7 +134,7 @@ void main() { final capturedUrlOptions = verify( () => storageS3Service.getUrl( - // TODO[Jordan-Nelson]: update + // TODO(Jordan-Nelson): update path: const StoragePath.fromString('key'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart index b6e9db18e6..6d8f1164ae 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart @@ -417,7 +417,6 @@ void main() { group('getProperties() API', () { late S3GetPropertiesResult getPropertiesResult; - const testKey = 'some-object'; const testMetadata = { 'filename': 'hello.jpg', 'uploader': '123', @@ -569,7 +568,6 @@ void main() { group('getUrl() API', () { late S3GetUrlResult getUrlResult; const testExpiresIn = Duration(days: 1); - const testKey = 'some-object'; final testUrl = Uri( host: 's3.amazon.aws', path: 'album/1.jpg', diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart index 9fac13e13f..c7a7c3d5f3 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart @@ -21,7 +21,6 @@ import 'package:test/test.dart'; import '../../test_utils/io_mocks.dart'; import '../../test_utils/mocks.dart'; -import '../../test_utils/test_custom_prefix_resolver.dart'; import '../../test_utils/test_path_resolver.dart'; void main() { @@ -31,10 +30,8 @@ void main() { late transfer.TransferDatabase transferDatabase; const testBucket = 'fake-bucket'; const defaultS3ClientConfig = smithy_aws.S3ClientConfig(); - final testPrefixResolver = TestCustomPrefixResolver(); final pathResolver = TestPathResolver(); const testUploadDataOptions = StorageUploadDataOptions(); - const testDefaultAccessLevel = StorageAccessLevel.guest; setUpAll(() { s3Client = MockS3Client(); @@ -118,10 +115,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: const StorageUploadDataOptions(), logger: logger, @@ -179,10 +174,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -231,10 +224,8 @@ void main() { testDataPayloadBytes, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -302,10 +293,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -347,10 +336,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -384,10 +371,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -431,10 +416,8 @@ void main() { testDataPayload, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testPath), options: testUploadDataOptions, logger: logger, @@ -485,10 +468,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -547,10 +528,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -605,10 +584,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -661,10 +638,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -801,10 +776,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -985,10 +958,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1079,10 +1050,8 @@ void main() { testLocalFileWithoutContentType, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1182,10 +1151,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1221,10 +1188,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1255,10 +1220,8 @@ void main() { testBadFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1286,10 +1249,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1332,10 +1293,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: const StorageUploadDataOptions(), logger: logger, @@ -1377,10 +1336,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1422,10 +1379,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1505,10 +1460,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1599,10 +1552,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: const StorageUploadDataOptions(), logger: logger, @@ -1692,10 +1643,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1764,10 +1713,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1922,10 +1869,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -1982,10 +1927,8 @@ void main() { testLocalFile, s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: testUploadDataOptions, logger: logger, @@ -2049,10 +1992,8 @@ void main() { s3Client: s3Client, defaultS3ClientConfig: const smithy_aws.S3ClientConfig(usePathStyle: true), - prefixResolver: testPrefixResolver, pathResolver: pathResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, path: const StoragePath.fromString(testKey), options: const StorageUploadDataOptions( pluginOptions: S3UploadDataPluginOptions( From 9f9e40bbd3be360287921e00a0fee661041d01a2 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:33:27 -0400 Subject: [PATCH 13/46] chore: fix formatting --- .../content_type_infer/content_type_infer_io.dart | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart index 613bef3c76..cd8c294c6a 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/content_type_infer/content_type_infer_io.dart @@ -51,7 +51,9 @@ void testContentTypeInferTest({ final result = await s3Plugin .uploadFile( localFile: file, - path: StoragePath.fromString('/private/${testUploadKeys[index]}'), + path: StoragePath.fromString( + '/private/${testUploadKeys[index]}', + ), options: const StorageUploadFileOptions( pluginOptions: S3UploadFilePluginOptions( getProperties: true, From b03df43e37589e81530098874350ee82d8aec46e Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:47:37 -0400 Subject: [PATCH 14/46] chore: fix test --- .../example/integration_test/use_case_test.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 5c155b5113..0eb59b8ef1 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -305,7 +305,7 @@ void main() { (WidgetTester tester) async { final result = Amplify.Storage.getUrl( path: const StoragePath.fromString( - '/random/non-existent/object.png', + '/public/random/non-existent/object.png', ), options: const StorageGetUrlOptions( pluginOptions: S3GetUrlPluginOptions( From 8ef34be051071eafce62080ffc52e9f6960446fe Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:49:31 -0400 Subject: [PATCH 15/46] chore: remove lint ignored --- packages/amplify_core/lib/amplify_core.dart | 22 +++++++++++++++++-- .../category/amplify_storage_category.dart | 2 -- .../types/storage/download_data_options.dart | 2 -- .../types/storage/download_file_options.dart | 2 -- .../types/storage/get_properties_options.dart | 2 -- .../src/types/storage/get_url_options.dart | 2 -- .../lib/src/types/storage/list_options.dart | 2 -- .../types/storage/remove_many_options.dart | 2 -- .../lib/src/types/storage/remove_options.dart | 2 -- .../types/storage/upload_data_options.dart | 2 -- .../types/storage/upload_file_options.dart | 2 -- .../task/s3_upload_task_test.dart | 2 -- 12 files changed, 20 insertions(+), 24 deletions(-) diff --git a/packages/amplify_core/lib/amplify_core.dart b/packages/amplify_core/lib/amplify_core.dart index 7d281991cc..4add5a25ab 100644 --- a/packages/amplify_core/lib/amplify_core.dart +++ b/packages/amplify_core/lib/amplify_core.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: invalid_export_of_internal_element - library amplify_core; import 'package:amplify_core/src/amplify_class.dart'; @@ -13,9 +11,11 @@ export 'package:aws_signature_v4/aws_signature_v4.dart' show AWSCredentials, ServiceConfiguration; export 'src/amplify_class.dart'; + /// Categories export 'src/category/amplify_auth_category.dart'; export 'src/category/amplify_categories.dart'; + /// Config export 'src/config/amplify_config.dart'; export 'src/config/amplify_plugin_config.dart' hide UnknownPluginConfigFactory; @@ -26,15 +26,19 @@ export 'src/config/auth/auth_config.dart'; export 'src/config/config_map.dart'; export 'src/config/notifications/notifications_config.dart'; export 'src/config/storage/storage_config.dart'; + /// HTTP export 'src/http/amplify_http_client.dart'; export 'src/http/amplify_user_agent.dart'; + /// Hub export 'src/hub/amplify_hub.dart'; export 'src/hub/hub_channel.dart'; export 'src/hub/hub_event.dart'; + /// Logger export 'src/logger/amplify_logger.dart'; + /// Plugin export 'src/plugin/amplify_analytics_plugin_interface.dart'; export 'src/plugin/amplify_api_plugin_interface.dart'; @@ -44,6 +48,7 @@ export 'src/plugin/amplify_plugin_interface.dart'; export 'src/plugin/amplify_plugin_key.dart'; export 'src/plugin/amplify_push_notifications_plugin_interface.dart'; export 'src/plugin/amplify_storage_plugin_interface.dart'; + /// State Machine export 'src/state_machine/amplify_dependency_manager.dart'; export 'src/state_machine/dependency_manager.dart'; @@ -53,18 +58,25 @@ export 'src/state_machine/state.dart'; export 'src/state_machine/state_machine.dart'; export 'src/state_machine/token.dart'; export 'src/state_machine/transition.dart'; + /// Analytics export 'src/types/analytics/analytics_types.dart'; + /// API export 'src/types/api/api_types.dart'; + /// App path provider export 'src/types/app_path_provider/app_path_provider.dart'; + /// Auth export 'src/types/auth/auth_types.dart'; + /// Auth providers export 'src/types/common/amplify_auth_provider.dart'; + /// Datastore export 'src/types/datastore/datastore_types.dart' hide DateTimeParse; + /// Exceptions export 'src/types/exception/amplify_already_configured_exception.dart'; export 'src/types/exception/amplify_exception.dart'; @@ -74,6 +86,7 @@ export 'src/types/exception/error/amplify_error.dart'; export 'src/types/exception/error/configuration_error.dart'; export 'src/types/exception/error/plugin_error.dart'; export 'src/types/exception/url_launcher_exception.dart'; + /// Model-based types used in datastore and API export 'src/types/models/auth_rule.dart'; export 'src/types/models/model.dart'; @@ -85,19 +98,24 @@ export 'src/types/models/model_index.dart'; export 'src/types/models/model_provider.dart'; export 'src/types/models/model_schema.dart'; export 'src/types/models/model_schema_definition.dart'; + /// Notifications export 'src/types/notifications/notification_types.dart'; + /// Query export 'src/types/query/query_exception.dart'; export 'src/types/query/query_field.dart'; export 'src/types/query/query_model_identifier.dart'; + /// Storage export 'src/types/storage/storage_types.dart'; + /// Temporal export 'src/types/temporal/temporal_date.dart'; export 'src/types/temporal/temporal_datetime.dart'; export 'src/types/temporal/temporal_time.dart'; export 'src/types/temporal/temporal_timestamp.dart'; + /// Util export 'src/util/parsers.dart'; export 'src/util/serializable.dart'; diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index b4f807e127..e889b70554 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - part of 'amplify_categories.dart'; /// {@template amplify_core.amplify_storage_category} diff --git a/packages/amplify_core/lib/src/types/storage/download_data_options.dart b/packages/amplify_core/lib/src/types/storage/download_data_options.dart index b872994a99..59e35e964f 100644 --- a/packages/amplify_core/lib/src/types/storage/download_data_options.dart +++ b/packages/amplify_core/lib/src/types/storage/download_data_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/download_file_options.dart b/packages/amplify_core/lib/src/types/storage/download_file_options.dart index 4ac55acbf8..7153e701df 100644 --- a/packages/amplify_core/lib/src/types/storage/download_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/download_file_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/get_properties_options.dart b/packages/amplify_core/lib/src/types/storage/get_properties_options.dart index 7b9c3c8aae..325c3f0d20 100644 --- a/packages/amplify_core/lib/src/types/storage/get_properties_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_properties_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/get_url_options.dart b/packages/amplify_core/lib/src/types/storage/get_url_options.dart index a077edbd34..592786e937 100644 --- a/packages/amplify_core/lib/src/types/storage/get_url_options.dart +++ b/packages/amplify_core/lib/src/types/storage/get_url_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/list_options.dart b/packages/amplify_core/lib/src/types/storage/list_options.dart index cf0998d3a9..82b29851a4 100644 --- a/packages/amplify_core/lib/src/types/storage/list_options.dart +++ b/packages/amplify_core/lib/src/types/storage/list_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/remove_many_options.dart b/packages/amplify_core/lib/src/types/storage/remove_many_options.dart index 2f05ed0cc7..02944ef13a 100644 --- a/packages/amplify_core/lib/src/types/storage/remove_many_options.dart +++ b/packages/amplify_core/lib/src/types/storage/remove_many_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/remove_options.dart b/packages/amplify_core/lib/src/types/storage/remove_options.dart index 35fd190e7a..2cf3b53f16 100644 --- a/packages/amplify_core/lib/src/types/storage/remove_options.dart +++ b/packages/amplify_core/lib/src/types/storage/remove_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart index 5513658959..dab3e60e80 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_data_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_data_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart index 7faea55de0..a13c1f04b7 100644 --- a/packages/amplify_core/lib/src/types/storage/upload_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/upload_file_options.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'package:amplify_core/src/types/storage/base/storage_operation_options.dart'; import 'package:aws_common/aws_common.dart'; diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart index c7a7c3d5f3..72effa2d94 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_upload_task_test.dart @@ -1,8 +1,6 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// ignore_for_file: deprecated_member_use_from_same_package - import 'dart:async'; import 'dart:typed_data'; From 408df98d47bc1c5ba94c2ffc687efa56f2bdbcdc Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:54:19 -0400 Subject: [PATCH 16/46] chore: update comment --- .../src/types/exception/storage/path_validation_exception.dart | 2 +- packages/amplify_core/lib/src/types/storage/storage_path.dart | 1 - .../lib/src/path_resolver/s3_path_resolver.dart | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart b/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart index 0f65cee1ff..8f5b23aaca 100644 --- a/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart +++ b/packages/amplify_core/lib/src/types/exception/storage/path_validation_exception.dart @@ -4,7 +4,7 @@ part of '../amplify_exception.dart'; /// {@template amplify_core.storage.path_validation_exception} -/// Exception thrown when the service request receives access denied error. +/// Exception thrown when the [StoragePath] is invalid. /// {@endtemplate} class StoragePathValidationException extends StorageException { /// {@macro amplify_core.storage.path_validation_exception} diff --git a/packages/amplify_core/lib/src/types/storage/storage_path.dart b/packages/amplify_core/lib/src/types/storage/storage_path.dart index 21182fc6ce..ef292bbdd2 100644 --- a/packages/amplify_core/lib/src/types/storage/storage_path.dart +++ b/packages/amplify_core/lib/src/types/storage/storage_path.dart @@ -13,7 +13,6 @@ import 'package:meta/meta.dart'; /// /// #### Dynamic Path with the current user's IdentityId /// {@macro amplify_core.storage.storage_path.with_identity_id.example} - class StoragePath { /// Creates a [StoragePath] from a static string. /// diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart index 6c68436b93..2b50a4fe98 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/path_resolver/s3_path_resolver.dart @@ -7,7 +7,7 @@ import 'package:amplify_core/src/types/storage/storage_path_with_identity_id.dar import 'package:meta/meta.dart'; /// {@template amplify_storage_s3_dart.path_resolver} -/// Defines the interface of a S3 path resolver. +/// A class which resolves the full path of the S3 Object. /// {@endtemplate} @internal class S3PathResolver { From 3155206cd9d14989009453631431b320ce627818 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 14:54:34 -0400 Subject: [PATCH 17/46] chore: remove unused method --- .../service/storage_s3_service_impl.dart | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index a1986e6fd8..53661b8aef 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -715,17 +715,6 @@ class StorageS3Service { } } - /// Resolve a client object key to a "full" object key with proper prefix. - /// - /// This API is only used internally. - @internal - static Future getResolvedPath({ - required S3PathResolver pathResolver, - required StoragePath path, - }) async { - return pathResolver.resolvePath(path: path); - } - /// Creates and sends a [s3.HeadObjectRequest] to S3 service, and then /// returns a [s3.HeadObjectOutput]. /// From c3d40aad5ebc63193cfab8896f9934dffeffc22c Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:38:15 -0700 Subject: [PATCH 18/46] chore: update download apis to use path --- .../category/amplify_storage_category.dart | 12 +-- .../amplify_storage_plugin_interface.dart | 4 +- .../types/storage/download_data_request.dart | 6 +- .../types/storage/download_file_request.dart | 6 +- .../transfer_acceleration.dart | 10 +- .../integration_test/use_case_test.dart | 23 ++--- .../amplify_storage_s3/example/lib/main.dart | 4 +- .../example/bin/example.dart | 6 +- .../lib/src/amplify_storage_s3_dart_impl.dart | 12 +-- .../download_file/download_file_html.dart | 3 +- .../download_file/download_file_io.dart | 13 +-- .../download_file/download_file_stub.dart | 2 +- .../service/storage_s3_service_impl.dart | 8 +- .../service/task/s3_download_task.dart | 39 +++----- .../storage/amplify_storage_s3_dart/test.txt | 1 + .../test/amplify_storage_s3_dart_test.dart | 13 ++- .../download_file_html_test.dart | 10 +- .../platform_impl/download_file_io_test.dart | 52 +++++----- .../storage_s3_service_test.dart | 2 - .../task/s3_download_task_test.dart | 95 ++++++------------- .../test/test_utils/mocks.dart | 25 ++++- 21 files changed, 148 insertions(+), 198 deletions(-) create mode 100644 packages/storage/amplify_storage_s3_dart/test.txt diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index a673c27b83..40b70e52d6 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -93,7 +93,7 @@ class StorageCategory extends AmplifyCategory { } /// {@template amplify_core.amplify_storage_category.download_data} - /// Downloads bytes of object specified by [key] into memory with optional + /// Downloads bytes of object specified by [path] into memory with optional /// [onProgress] and [StorageDownloadDataOptions], and returns a /// [StorageDownloadDataOperation]. /// @@ -101,14 +101,14 @@ class StorageCategory extends AmplifyCategory { /// memory leaks. /// {@endtemplate} StorageDownloadDataOperation downloadData({ - required String key, + required StoragePath path, void Function(StorageTransferProgress)? onProgress, StorageDownloadDataOptions? options, }) { return identifyCall( StorageCategoryMethod.downloadData, () => defaultPlugin.downloadData( - key: key, + path: path, onProgress: onProgress, options: options, ), @@ -116,12 +116,12 @@ class StorageCategory extends AmplifyCategory { } /// {@template amplify_core.amplify_storage_category.download_file} - /// Downloads the object specified by [key] to [localFile] with optional + /// Downloads the object specified by [path] to [localFile] with optional /// [onProgress] and [StorageDownloadFileOptions], and returns a /// [StorageDownloadFileOperation]. /// {@endtemplate} StorageDownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, void Function(StorageTransferProgress)? onProgress, StorageDownloadFileOptions? options, @@ -129,7 +129,7 @@ class StorageCategory extends AmplifyCategory { return identifyCall( StorageCategoryMethod.downloadFile, () => defaultPlugin.downloadFile( - key: key, + path: path, localFile: localFile, onProgress: onProgress, options: options, diff --git a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart index 69167c457c..ce99a027c6 100644 --- a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart +++ b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart @@ -40,7 +40,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.download_data} StorageDownloadDataOperation downloadData({ - required String key, + required StoragePath path, void Function(StorageTransferProgress)? onProgress, StorageDownloadDataOptions? options, }) { @@ -49,7 +49,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.download_file} StorageDownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, void Function(StorageTransferProgress)? onProgress, StorageDownloadFileOptions? options, diff --git a/packages/amplify_core/lib/src/types/storage/download_data_request.dart b/packages/amplify_core/lib/src/types/storage/download_data_request.dart index 3f5bcb9525..5a2ca3c730 100644 --- a/packages/amplify_core/lib/src/types/storage/download_data_request.dart +++ b/packages/amplify_core/lib/src/types/storage/download_data_request.dart @@ -9,12 +9,12 @@ import 'package:amplify_core/amplify_core.dart'; class StorageDownloadDataRequest { /// {@macro amplify_core.storage.download_data_request} const StorageDownloadDataRequest({ - required this.key, + required this.path, this.options, }); - /// Key of the object to download. - final String key; + /// Path of the object to download. + final StoragePath path; /// Configurable options of the [StorageDownloadDataRequest]. final StorageDownloadDataOptions? options; diff --git a/packages/amplify_core/lib/src/types/storage/download_file_request.dart b/packages/amplify_core/lib/src/types/storage/download_file_request.dart index 55cd835b13..c2457e02c5 100644 --- a/packages/amplify_core/lib/src/types/storage/download_file_request.dart +++ b/packages/amplify_core/lib/src/types/storage/download_file_request.dart @@ -9,13 +9,13 @@ import 'package:amplify_core/amplify_core.dart'; class StorageDownloadFileRequest { /// {@macro amplify_core.storage.download_file_request} const StorageDownloadFileRequest({ - required this.key, + required this.path, required this.localFile, this.options, }); - /// Key of the object to download. - final String key; + /// Path of the object to download. + final StoragePath path; /// Reference to the local file that download the object to. final AWSFile localFile; diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index c549b46191..e432165cc5 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -68,10 +68,9 @@ void testTransferAcceleration({ test('S3DataPayload ${entry.key}', () async { final dataPayload = entry.value; final result = await Amplify.Storage.downloadData( - key: dataPayload.targetKey, - options: StorageDownloadDataOptions( - accessLevel: dataPayload.targetAccessLevel, - pluginOptions: const S3DownloadDataPluginOptions( + path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + options: const StorageDownloadDataOptions( + pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, ), ), @@ -148,9 +147,8 @@ void testTransferAcceleration({ const end = 5 * 1024 + 12; final awsFile = entry.value; final result = await Amplify.Storage.downloadData( - key: awsFile.targetKey, + path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), options: StorageDownloadDataOptions( - accessLevel: awsFile.targetAccessLevel, pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, bytesRange: S3DataBytesRange(start: start, end: end), diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 11cac56aaa..64f903a9d3 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -313,13 +313,12 @@ void main() { }); testWidgets( - skip: true, + // skip: true, 'download object as bytes data in memory with access level private' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( - key: testObjectKey3, + path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( getProperties: true, ), @@ -331,13 +330,13 @@ void main() { }); testWidgets( - skip: true, + // skip: true, 'download a range of bytes of an object with access level private' ' for the currently signed in user', (WidgetTester tester) async { const start = 5 * 1024; const end = 5 * 1024 + 12; final result = await Amplify.Storage.downloadData( - key: testObjectKey3, + path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), options: StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( @@ -359,7 +358,7 @@ void main() { }); testWidgets( - skip: true, + // skip: true, 'download file with access level private for the currently signed in user', (WidgetTester tester) async { final s3Plugin = @@ -370,10 +369,9 @@ void main() { final result = await s3Plugin .downloadFile( - key: testObjectKey3, + path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), localFile: localFile, options: const StorageDownloadFileOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadFilePluginOptions( getProperties: true, ), @@ -643,14 +641,13 @@ void main() { }); testWidgets( - skip: true, + // skip: true, 'download data of object with access level protected and a target' ' identity id for the currently signed user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( - key: testObjectKey2, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), options: StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.protected, pluginOptions: S3DownloadDataPluginOptions.forIdentity( user1IdentityId, getProperties: true, @@ -662,12 +659,12 @@ void main() { }); testWidgets( - skip: true, + // skip: true, 'download data of object (belongs to other user) with access level' ' private for the currently signed user', (WidgetTester tester) async { final operation = Amplify.Storage.downloadData( - key: testObjectKey3, + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( diff --git a/packages/storage/amplify_storage_s3/example/lib/main.dart b/packages/storage/amplify_storage_s3/example/lib/main.dart index 94bae65d3d..2329e81f58 100644 --- a/packages/storage/amplify_storage_s3/example/lib/main.dart +++ b/packages/storage/amplify_storage_s3/example/lib/main.dart @@ -181,7 +181,7 @@ class _HomeScreenState extends State { final filepath = '${documentsDir.path}/$key'; try { await Amplify.Storage.downloadFile( - key: key, + path: StoragePath.fromString(key), localFile: AWSFile.fromPath(filepath), onProgress: (p0) => _logger .debug('Progress: ${(p0.transferredBytes / p0.totalBytes) * 100}%'), @@ -196,7 +196,7 @@ class _HomeScreenState extends State { Future downloadFileWeb(String key) async { try { await Amplify.Storage.downloadFile( - key: key, + path: StoragePath.fromString(key), localFile: AWSFile.fromPath(key), onProgress: (p0) => _logger .debug('Progress: ${(p0.transferredBytes / p0.totalBytes) * 100}%'), diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart index c949181bdf..12e1ed3c3d 100644 --- a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart +++ b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart @@ -210,7 +210,8 @@ Future downloadDataOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final downloadDataOperation = s3Plugin.downloadData( - key: key, + // key: key, + path: StoragePath.fromString(key), options: StorageDownloadDataOptions( accessLevel: accessLevel, pluginOptions: const S3DownloadDataPluginOptions( @@ -254,7 +255,8 @@ Future downloadFileOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final downloadFileOperation = s3Plugin.downloadFile( - key: key, + // key: key, + path: StoragePath.fromString(key), localFile: localFile, options: StorageDownloadFileOptions( accessLevel: accessLevel, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index 12dcd31726..e169f5c244 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -224,7 +224,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3DownloadDataOperation downloadData({ - required String key, + required StoragePath path, StorageDownloadDataOptions? options, void Function(S3TransferProgress)? onProgress, }) { @@ -234,13 +234,12 @@ class AmplifyStorageS3Dart extends StoragePluginInterface ); final s3Options = StorageDownloadDataOptions( - accessLevel: options?.accessLevel, pluginOptions: s3PluginOptions, ); final bytes = BytesBuilder(); final downloadTask = storageS3Service.downloadData( - key: key, + path: path, options: s3Options, onProgress: onProgress, onData: bytes.add, @@ -248,7 +247,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3DownloadDataOperation( request: StorageDownloadDataRequest( - key: key, + path: path, options: options, ), result: downloadTask.result.then( @@ -265,7 +264,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3DownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, void Function(S3TransferProgress)? onProgress, StorageDownloadFileOptions? options, @@ -275,11 +274,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface defaultPluginOptions: const S3DownloadFilePluginOptions(), ); options = StorageDownloadFileOptions( - accessLevel: options?.accessLevel, pluginOptions: s3PluginOptions, ); return download_file_impl.downloadFile( - key: key, + path: path, localFile: localFile, options: options, s3pluginConfig: s3pluginConfig, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart index 16ada683b0..39ad33be18 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart @@ -20,7 +20,8 @@ S3DownloadFileOperation downloadFile({ return S3DownloadFileOperation( request: StorageDownloadFileRequest( - key: key, + // TODO[khatruong2009]: update to use path from customer + path: StoragePath.fromString(key), localFile: localFile, options: options, ), diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart index 52e9a1e501..cb5dfcc0a4 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart @@ -7,12 +7,11 @@ import 'package:amplify_core/amplify_core.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; import 'package:meta/meta.dart'; -import 'package:path/path.dart' as path; /// The io implementation of `downloadFile` API. @internal S3DownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, required StorageDownloadFileOptions options, required S3PluginConfig s3pluginConfig, @@ -27,7 +26,6 @@ S3DownloadFileOperation downloadFile({ final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions; final targetIdentityId = s3PluginOptions.targetIdentityId; final downloadDataOptions = StorageDownloadDataOptions( - accessLevel: options.accessLevel, pluginOptions: targetIdentityId == null ? S3DownloadDataPluginOptions( getProperties: s3PluginOptions.getProperties, @@ -41,17 +39,14 @@ S3DownloadFileOperation downloadFile({ ); final downloadDataTask = storageS3Service.downloadData( - key: key, + path: path, options: downloadDataOptions, // Ensure destination file is writable. Exception thrown in the check // will be forwarded to the Future, downloadDataTask.result below preStart: () async { destinationPath = await _ensureDestinationWritable(localFile); tempFile = File( - path.join( - await appPathProvider.getTemporaryPath(), - 'amplify_storage_s3_temp_${uuid()}', - ), + uuid(), ); sink = tempFile.openWrite(mode: FileMode.append); }, @@ -78,7 +73,7 @@ S3DownloadFileOperation downloadFile({ return S3DownloadFileOperation( request: StorageDownloadFileRequest( - key: key, + path: path, localFile: localFile, options: options, ), diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart index 81fd034fd1..94eb03c0e9 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart @@ -7,7 +7,7 @@ import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_servic /// Interface of the platform implementation of the `downloadFile` API. S3DownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, required StorageDownloadFileOptions options, required S3PluginConfig s3pluginConfig, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index b208261cd4..30c852b366 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -317,7 +317,7 @@ class StorageS3Service { /// /// {@macro amplify_storage_s3_dart.download_task.on_done} S3DownloadTask downloadData({ - required String key, + required StoragePath path, required StorageDownloadDataOptions options, FutureOr Function()? preStart, void Function(S3TransferProgress)? onProgress, @@ -329,11 +329,9 @@ class StorageS3Service { s3Client: _defaultS3Client, defaultS3ClientConfig: _defaultS3ClientConfig, bucket: _s3PluginConfig.bucket, - defaultAccessLevel: _s3PluginConfig.defaultAccessLevel, - key: key, + path: path, options: options, - prefixResolver: _prefixResolver, - logger: _logger, + pathResolver: _pathResolver, onProgress: onProgress, onData: onData, preStart: preStart, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart index 2f2b2d7e4a..6a2160b3ce 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/task/s3_download_task.dart @@ -7,8 +7,8 @@ import 'package:amplify_core/amplify_core.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/exception/s3_storage_exception.dart' as s3_exception; +import 'package:amplify_storage_s3_dart/src/path_resolver/s3_path_resolver.dart'; import 'package:amplify_storage_s3_dart/src/sdk/s3.dart' as s3; -import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; import 'package:meta/meta.dart'; import 'package:smithy/smithy.dart' as smithy; import 'package:smithy_aws/smithy_aws.dart' as smithy_aws; @@ -50,31 +50,26 @@ class S3DownloadTask { S3DownloadTask({ required s3.S3Client s3Client, required smithy_aws.S3ClientConfig defaultS3ClientConfig, - required S3PrefixResolver prefixResolver, - required StorageAccessLevel defaultAccessLevel, + required S3PathResolver pathResolver, required String bucket, - required String key, + required StoragePath path, required StorageDownloadDataOptions options, FutureOr Function()? preStart, void Function(S3TransferProgress)? onProgress, void Function(List)? onData, FutureOr Function()? onDone, FutureOr Function()? onError, - required AWSLogger logger, }) : _downloadCompleter = Completer(), _s3Client = s3Client, _defaultS3ClientConfig = defaultS3ClientConfig, - _prefixResolver = prefixResolver, + _pathResolver = pathResolver, _bucket = bucket, - _defaultAccessLevel = defaultAccessLevel, - _key = key, - _downloadDataOptions = options, + _path = path, _preStart = preStart, _onProgress = onProgress, _onData = onData, _onDone = onDone, _onError = onError, - _logger = logger, _downloadedBytesSize = 0, _s3PluginOptions = options.pluginOptions as S3DownloadDataPluginOptions? ?? @@ -85,17 +80,14 @@ class S3DownloadTask { final s3.S3Client _s3Client; final smithy_aws.S3ClientConfig _defaultS3ClientConfig; - final S3PrefixResolver _prefixResolver; + final S3PathResolver _pathResolver; final String _bucket; - final StorageAccessLevel _defaultAccessLevel; - final String _key; - final StorageDownloadDataOptions _downloadDataOptions; + final StoragePath _path; final FutureOr Function()? _preStart; final void Function(S3TransferProgress)? _onProgress; final void Function(List bytes)? _onData; final FutureOr Function()? _onDone; final FutureOr Function()? _onError; - final AWSLogger _logger; final S3DownloadDataPluginOptions _s3PluginOptions; int _downloadedBytesSize; @@ -110,7 +102,7 @@ class S3DownloadTask { Completer? _pauseCompleter; late StorageTransferState _state; - late final String _resolvedKey; + late final String _resolvedPath; late final S3Item _downloadedS3Item; // Total bytes that need to be downloaded, this field is set when the @@ -145,19 +137,12 @@ class S3DownloadTask { return; } - final resolvedPrefix = await StorageS3Service.getResolvedPrefix( - prefixResolver: _prefixResolver, - logger: _logger, - accessLevel: _downloadDataOptions.accessLevel ?? _defaultAccessLevel, - identityId: _s3PluginOptions.targetIdentityId, - ); - - _resolvedKey = '$resolvedPrefix$_key'; + _resolvedPath = await _pathResolver.resolvePath(path: _path); try { final getObjectOutput = await _getObject( bucket: _bucket, - key: _resolvedKey, + key: _resolvedPath, bytesRange: _s3PluginOptions.bytesRange, ); @@ -176,7 +161,7 @@ class S3DownloadTask { _totalBytes = remoteSize; _listenToBytesSteam(getObjectOutput.body); _downloadedS3Item = - S3Item.fromGetObjectOutput(getObjectOutput, key: _key, path: _resolvedKey); + S3Item.fromGetObjectOutput(getObjectOutput, path: _resolvedPath); } on Exception catch (error, stackTrace) { await _completeDownloadWithError(error, stackTrace); } @@ -227,7 +212,7 @@ class S3DownloadTask { try { final getObjectOutput = await _getObject( bucket: _bucket, - key: _resolvedKey, + key: _resolvedPath, bytesRange: bytesRangeToDownload, ); _listenToBytesSteam(getObjectOutput.body); diff --git a/packages/storage/amplify_storage_s3_dart/test.txt b/packages/storage/amplify_storage_s3_dart/test.txt new file mode 100644 index 0000000000..7621d40cf6 --- /dev/null +++ b/packages/storage/amplify_storage_s3_dart/test.txt @@ -0,0 +1 @@ +你好世界！ \ No newline at end of file diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 68db8b5a3b..e268666c96 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -463,7 +463,7 @@ void main() { when( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: defaultOptions, preStart: any(named: 'preStart'), onProgress: any(named: 'onProgress'), @@ -475,12 +475,12 @@ void main() { when(() => testS3DownloadTask.result).thenAnswer((_) async => testItem); downloadDataOperation = storageS3Plugin.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), ); final capturedOptions = verify( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: captureAny( named: 'options', ), @@ -504,7 +504,6 @@ void main() { test('should forward options to StorageS3Service.downloadData API', () async { const testOptions = StorageDownloadDataOptions( - accessLevel: testAccessLevelProtected, pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, getProperties: true, @@ -513,7 +512,7 @@ void main() { when( () => storageS3Service.downloadData( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), options: any(named: 'options'), onData: any(named: 'onData'), ), @@ -522,13 +521,13 @@ void main() { when(() => testS3DownloadTask.result).thenAnswer((_) async => testItem); downloadDataOperation = storageS3Plugin.downloadData( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), options: testOptions, ); final capturedOptions = verify( () => storageS3Service.downloadData( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), onData: any(named: 'onData'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index 5a625d33d1..2f35853287 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -92,12 +92,11 @@ void main() { () async { const testTargetIdentity = 'someone-else'; final operation = downloadFile( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromPath('file_name.jpg'), - options: StorageDownloadFileOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, + options: const StorageDownloadFileOptions( pluginOptions: - const S3DownloadFilePluginOptions.forIdentity(testTargetIdentity), + S3DownloadFilePluginOptions.forIdentity(testTargetIdentity), ), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, @@ -163,13 +162,12 @@ void main() { 'download result should include metadata when options.getProperties is set to true', () async { const options = StorageDownloadFileOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadFilePluginOptions( getProperties: true, ), ); final result = await downloadFile( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), localFile: AWSFile.fromPath('download.jpg'), options: options, s3pluginConfig: testS3pluginConfig, diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart index 978ecc620b..5aa92554f8 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart @@ -43,14 +43,12 @@ void main() { storageS3Service = MockStorageS3Service(); downloadTask = MockS3DownloadTask(); registerFallbackValue( - const StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.guest, - ), + const StorageDownloadDataOptions(), ); when( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: any(named: 'options'), preStart: any(named: 'preStart'), onProgress: any(named: 'onProgress'), @@ -68,13 +66,12 @@ void main() { test('should invoke StorageS3Service.downloadData with expected parameters', () async { const options = StorageDownloadFileOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadFilePluginOptions( getProperties: true, ), ); final downloadFileOperation = downloadFile( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), localFile: AWSFile.fromPath(testDestinationPath), options: options, s3pluginConfig: testS3pluginConfig, @@ -87,7 +84,7 @@ void main() { final captureParams = verify( () => storageS3Service.downloadData( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), options: captureAny( named: 'options', ), @@ -156,14 +153,14 @@ void main() { }); test( + skip: true, 'should correctly create S3DownloadDataOptions with default storage access level', () { downloadFile( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromPath('path'), - options: StorageDownloadFileOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - pluginOptions: const S3DownloadFilePluginOptions(), + options: const StorageDownloadFileOptions( + pluginOptions: S3DownloadFilePluginOptions(), ), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, @@ -175,7 +172,7 @@ void main() { final capturedOptions = verify( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: captureAny( named: 'options', ), @@ -198,15 +195,15 @@ void main() { }); test( + skip: true, 'should correctly create S3DownloadDataOptions with correct targetIdentityId', () { const testTargetIdentity = 'someone-else'; const testAccessLevel = StorageAccessLevel.protected; downloadFile( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), localFile: AWSFile.fromPath('path'), options: const StorageDownloadFileOptions( - accessLevel: testAccessLevel, pluginOptions: S3DownloadFilePluginOptions.forIdentity( testTargetIdentity, ), @@ -221,7 +218,7 @@ void main() { final capturedOptions = verify( () => storageS3Service.downloadData( - key: testKey, + path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), options: captureAny( named: 'options', ), @@ -265,11 +262,10 @@ void main() { 'when destination path is null is throws StorageLocalFileNotFoundException', () { downloadFile( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromData([101]), - options: StorageDownloadFileOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - pluginOptions: const S3DownloadFilePluginOptions(), + options: const StorageDownloadFileOptions( + pluginOptions: S3DownloadFilePluginOptions(), ), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, @@ -281,7 +277,7 @@ void main() { final capturedPreStart = verify( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: any(named: 'options'), preStart: captureAny Function()?>(named: 'preStart'), onProgress: any(named: 'onProgress'), @@ -298,11 +294,10 @@ void main() { 'when destination path is a directory instead of a file it throws StorageLocalFileNotFoundException', () { downloadFile( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromPath(Directory.systemTemp.path), - options: StorageDownloadFileOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - pluginOptions: const S3DownloadFilePluginOptions(), + options: const StorageDownloadFileOptions( + pluginOptions: S3DownloadFilePluginOptions(), ), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, @@ -314,7 +309,7 @@ void main() { final capturedPreStart = verify( () => storageS3Service.downloadData( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), options: any(named: 'options'), preStart: captureAny Function()?>(named: 'preStart'), onProgress: any(named: 'onProgress'), @@ -337,11 +332,10 @@ void main() { when(downloadTask.cancel).thenAnswer((_) async {}); final downloadFileOperation = downloadFile( - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromPath('path'), - options: StorageDownloadFileOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - pluginOptions: const S3DownloadFilePluginOptions(), + options: const StorageDownloadFileOptions( + pluginOptions: S3DownloadFilePluginOptions(), ), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart index b6e9db18e6..6d8f1164ae 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart @@ -417,7 +417,6 @@ void main() { group('getProperties() API', () { late S3GetPropertiesResult getPropertiesResult; - const testKey = 'some-object'; const testMetadata = { 'filename': 'hello.jpg', 'uploader': '123', @@ -569,7 +568,6 @@ void main() { group('getUrl() API', () { late S3GetUrlResult getUrlResult; const testExpiresIn = Duration(days: 1); - const testKey = 'some-object'; final testUrl = Uri( host: 's3.amazon.aws', path: 'album/1.jpg', diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_download_task_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_download_task_test.dart index c1fa8b60f1..2d5ca4095c 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_download_task_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/task/s3_download_task_test.dart @@ -15,24 +15,20 @@ import 'package:test/test.dart'; import '../../test_utils/helper_types.dart'; import '../../test_utils/mocks.dart'; -import '../storage_s3_service_test.dart'; +import '../../test_utils/test_path_resolver.dart'; void main() { group('S3DownloadTask', () { const testBucket = 'bucket1'; - const testDefaultAccessLevel = StorageAccessLevel.guest; const testKey = 'some-object'; const defaultTestOptions = StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, ); - final testPrefixResolver = TestPrefixResolver(); const defaultS3ClientConfig = S3ClientConfig(); late S3Client s3Client; - late AWSLogger logger; setUpAll(() { s3Client = MockS3Client(); - logger = MockAWSLogger(); registerFallbackValue( GetObjectRequest( @@ -63,12 +59,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString(testKey), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, preStart: testPreStart, ); @@ -102,12 +96,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString(testKey), + pathResolver: TestPathResolver(), options: const StorageDownloadDataOptions(), - logger: logger, onProgress: (progress) { finalState = progress.state; }, @@ -128,9 +120,7 @@ void main() { expect(request.bucket, testBucket); expect( request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testDefaultAccessLevel, - )}$testKey', + TestPathResolver.path, ); expect(request.checksumMode, ChecksumMode.enabled); @@ -169,12 +159,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString(testKey), + pathResolver: TestPathResolver(), options: testOptions, - logger: logger, ); await downloadTask.start(); @@ -219,12 +207,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString(testKey), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onError: () { onErrorHasBeenCalled = true; }, @@ -245,16 +231,14 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: const S3ClientConfig(usePathStyle: true), - prefixResolver: testPrefixResolver, bucket: 'bucket.name.has.dots.com', - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, ), ), - logger: logger, ); unawaited(downloadTask.start()); @@ -296,12 +280,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onProgress: (progress) { receivedState.add(progress.state); }, @@ -343,12 +325,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onProgress: (progress) { receivedState.add(progress.state); }, @@ -414,12 +394,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onProgress: (progress) { receivedState.add(progress.state); }, @@ -487,12 +465,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, ); unawaited(downloadTask.start()); @@ -506,12 +482,10 @@ void main() { downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, ); }); @@ -559,12 +533,10 @@ void main() { downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, ); }); @@ -614,12 +586,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onProgress: (progress) { finalState = progress.state; }, @@ -658,12 +628,10 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - prefixResolver: testPrefixResolver, bucket: testBucket, - defaultAccessLevel: testDefaultAccessLevel, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: defaultTestOptions, - logger: logger, onDone: () async { onDoneHasBeenCalled = true; throw testOnDoneException; @@ -726,17 +694,14 @@ void main() { final downloadTask = S3DownloadTask( s3Client: s3Client, defaultS3ClientConfig: defaultS3ClientConfig, - defaultAccessLevel: testDefaultAccessLevel, - prefixResolver: testPrefixResolver, bucket: testBucket, - key: testKey, + path: const StoragePath.fromString('/public/$testKey'), + pathResolver: TestPathResolver(), options: StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.guest, pluginOptions: S3DownloadDataPluginOptions( getProperties: item.getPropertiesValue, ), ), - logger: logger, ); unawaited(downloadTask.start()); diff --git a/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart b/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart index 1136704cde..6f7d7d9af7 100644 --- a/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart +++ b/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart @@ -1,7 +1,10 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +import 'dart:async'; + import 'package:amplify_core/amplify_core.dart'; +import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/sdk/s3.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/transfer/transfer.dart'; @@ -9,7 +12,20 @@ import 'package:aws_signature_v4/aws_signature_v4.dart'; import 'package:mocktail/mocktail.dart'; import 'package:smithy/smithy.dart'; -class MockStorageS3Service extends Mock implements StorageS3Service {} +class MockStorageS3Service extends Mock implements StorageS3Service { + @override + S3DownloadTask downloadData({ + required StoragePath path, + required StorageDownloadDataOptions options, + FutureOr Function()? preStart, + void Function(S3TransferProgress)? onProgress, + void Function(List)? onData, + FutureOr Function()? onDone, + FutureOr Function()? onError, + }) { + return MockS3DownloadTask(); + } +} class MockS3Client extends Mock implements S3Client {} @@ -20,7 +36,12 @@ class MockAWSLogger extends Mock implements AWSLogger { class MockAWSSigV4Signer extends Mock implements AWSSigV4Signer {} -class MockS3DownloadTask extends Mock implements S3DownloadTask {} +class MockS3DownloadTask extends Mock implements S3DownloadTask { + @override + Future get result async => MockS3Item(); +} + +class MockS3Item extends Mock implements S3Item {} class MockS3UploadTask extends Mock implements S3UploadTask {} From de1d2e208e387d5892d6f3583f23e98167e88b70 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Fri, 15 Mar 2024 17:41:25 -0400 Subject: [PATCH 19/46] chore: skip tests other than main --- .../example/integration_test/use_case_test.dart | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 0eb59b8ef1..6902ac5ed9 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -67,7 +67,10 @@ void main() { const testObjectFileName3 = 'user1Private.large'; for (final entry in amplifyEnvironments.entries) { - group('[Environment ${entry.key}]', () { + group( + // TODO(Jordan-Nelson): enable dots-in-name, remove custom-prefix + skip: entry.key != 'main', + '[Environment ${entry.key}]', () { S3PrefixResolver? prefixResolver; late String user1IdentityId; late String object1Etag; From 28d88190de5984632b7ca75027fb96efcbdda8e4 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:17:38 -0700 Subject: [PATCH 20/46] chore: run dart format on both files that are receiving analyze warnings --- .../transfer_acceleration.dart | 6 ++++-- .../example/integration_test/use_case_test.dart | 15 ++++++++++----- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index da842b7768..c525431c7b 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -72,7 +72,8 @@ void testTransferAcceleration({ test('S3DataPayload ${entry.key}', () async { final dataPayload = entry.value; final result = await Amplify.Storage.downloadData( - path: StoragePath.fromString('/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + path: StoragePath.fromString( + '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, @@ -155,7 +156,8 @@ void testTransferAcceleration({ const end = 5 * 1024 + 12; final awsFile = entry.value; final result = await Amplify.Storage.downloadData( - path: StoragePath.fromString('${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + path: StoragePath.fromString( + '${awsFile.targetAccessLevel}/${awsFile.targetKey}'), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 469456547f..72a6b57042 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -323,7 +323,8 @@ void main() { 'download object as bytes data in memory with access level private' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( - path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( getProperties: true, @@ -342,7 +343,8 @@ void main() { const start = 5 * 1024; const end = 5 * 1024 + 12; final result = await Amplify.Storage.downloadData( - path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3'), options: StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( @@ -375,7 +377,8 @@ void main() { final result = await s3Plugin .downloadFile( - path: StoragePath.withIdentityId( (identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3'), localFile: localFile, options: const StorageDownloadFileOptions( pluginOptions: S3DownloadFilePluginOptions( @@ -657,7 +660,8 @@ void main() { ' identity id for the currently signed user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testObjectKey2'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testObjectKey2'), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions.forIdentity( user1IdentityId, @@ -675,7 +679,8 @@ void main() { ' private for the currently signed user', (WidgetTester tester) async { final operation = Amplify.Storage.downloadData( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testObjectKey3'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3'), options: const StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( From aed1e310fcd0460515e8a2ad7f48d5ad76231b90 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:40:21 -0700 Subject: [PATCH 21/46] chore: used dart fix to add trailing commas --- .../transfer_acceleration/transfer_acceleration.dart | 4 ++-- .../example/integration_test/use_case_test.dart | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index c525431c7b..82da13525d 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -73,7 +73,7 @@ void testTransferAcceleration({ final dataPayload = entry.value; final result = await Amplify.Storage.downloadData( path: StoragePath.fromString( - '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}'), + '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}',), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, @@ -157,7 +157,7 @@ void testTransferAcceleration({ final awsFile = entry.value; final result = await Amplify.Storage.downloadData( path: StoragePath.fromString( - '${awsFile.targetAccessLevel}/${awsFile.targetKey}'), + '${awsFile.targetAccessLevel}/${awsFile.targetKey}',), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 72a6b57042..9f5ea1b3da 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -324,7 +324,7 @@ void main() { ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3'), + (identityId) => '/private/$identityId/$testObjectKey3',), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( getProperties: true, @@ -344,7 +344,7 @@ void main() { const end = 5 * 1024 + 12; final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3'), + (identityId) => '/private/$identityId/$testObjectKey3',), options: StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( @@ -378,7 +378,7 @@ void main() { final result = await s3Plugin .downloadFile( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3'), + (identityId) => '/private/$identityId/$testObjectKey3',), localFile: localFile, options: const StorageDownloadFileOptions( pluginOptions: S3DownloadFilePluginOptions( @@ -661,7 +661,7 @@ void main() { (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testObjectKey2'), + (identityId) => '/protected/$identityId/$testObjectKey2',), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions.forIdentity( user1IdentityId, @@ -680,7 +680,7 @@ void main() { (WidgetTester tester) async { final operation = Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3'), + (identityId) => '/private/$identityId/$testObjectKey3',), options: const StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( From 7207fd19fa3d8ed11e5a5ae79dcf633aa91ad846 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:50:47 -0700 Subject: [PATCH 22/46] chore: fixed formatting --- .../transfer_acceleration/transfer_acceleration.dart | 6 ++++-- .../download_file/download_file_html.dart | 2 +- .../test/amplify_storage_s3_dart_test.dart | 9 ++++++--- .../test/platform_impl/download_file_html_test.dart | 3 ++- .../test/platform_impl/download_file_io_test.dart | 12 ++++++++---- 5 files changed, 21 insertions(+), 11 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart index 82da13525d..c4817ba313 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/transfer_acceleration/transfer_acceleration.dart @@ -73,7 +73,8 @@ void testTransferAcceleration({ final dataPayload = entry.value; final result = await Amplify.Storage.downloadData( path: StoragePath.fromString( - '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}',), + '/${dataPayload.targetAccessLevel}/${dataPayload.targetKey}', + ), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, @@ -157,7 +158,8 @@ void testTransferAcceleration({ final awsFile = entry.value; final result = await Amplify.Storage.downloadData( path: StoragePath.fromString( - '${awsFile.targetAccessLevel}/${awsFile.targetKey}',), + '${awsFile.targetAccessLevel}/${awsFile.targetKey}', + ), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( useAccelerateEndpoint: true, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart index 5126dc0127..2632207195 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart @@ -20,7 +20,7 @@ S3DownloadFileOperation downloadFile({ return S3DownloadFileOperation( request: StorageDownloadFileRequest( - // TODO[khatruong2009]: update to use path from customer + // TODO(khatruong2009): update to use path from customer path: StoragePath.fromString(key), localFile: localFile, options: options, diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 87aec96399..26487210d0 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -511,7 +511,8 @@ void main() { when( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testKey',), options: any(named: 'options'), onData: any(named: 'onData'), ), @@ -520,13 +521,15 @@ void main() { when(() => testS3DownloadTask.result).thenAnswer((_) async => testItem); downloadDataOperation = storageS3Plugin.downloadData( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testKey',), options: testOptions, ); final capturedOptions = verify( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testKey',), onData: any(named: 'onData'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index 843dc653f8..daa1579c59 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -167,7 +167,8 @@ void main() { ), ); final result = await downloadFile( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testKey',), localFile: AWSFile.fromPath('download.jpg'), options: options, s3pluginConfig: testS3pluginConfig, diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart index 5aa92554f8..cf0d0c13cf 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart @@ -71,7 +71,8 @@ void main() { ), ); final downloadFileOperation = downloadFile( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testKey',), localFile: AWSFile.fromPath(testDestinationPath), options: options, s3pluginConfig: testS3pluginConfig, @@ -84,7 +85,8 @@ void main() { final captureParams = verify( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId((identityId) => '/private/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testKey',), options: captureAny( named: 'options', ), @@ -201,7 +203,8 @@ void main() { const testTargetIdentity = 'someone-else'; const testAccessLevel = StorageAccessLevel.protected; downloadFile( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testKey',), localFile: AWSFile.fromPath('path'), options: const StorageDownloadFileOptions( pluginOptions: S3DownloadFilePluginOptions.forIdentity( @@ -218,7 +221,8 @@ void main() { final capturedOptions = verify( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId((identityId) => '/protected/$identityId/$testKey'), + path: StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/$testKey',), options: captureAny( named: 'options', ), From 5961b72ce1c47974e24be01558a50018d0e58939 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 16:02:57 -0700 Subject: [PATCH 23/46] chore: run format on test files --- .../test/amplify_storage_s3_dart_test.dart | 9 ++++++--- .../test/platform_impl/download_file_html_test.dart | 3 ++- .../test/platform_impl/download_file_io_test.dart | 12 ++++++++---- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 26487210d0..1aae149da3 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -512,7 +512,8 @@ void main() { when( () => storageS3Service.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey',), + (identityId) => '/protected/$identityId/$testKey', + ), options: any(named: 'options'), onData: any(named: 'onData'), ), @@ -522,14 +523,16 @@ void main() { downloadDataOperation = storageS3Plugin.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey',), + (identityId) => '/protected/$identityId/$testKey', + ), options: testOptions, ); final capturedOptions = verify( () => storageS3Service.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey',), + (identityId) => '/protected/$identityId/$testKey', + ), onData: any(named: 'onData'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index daa1579c59..cfb3a2d7c2 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -168,7 +168,8 @@ void main() { ); final result = await downloadFile( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testKey',), + (identityId) => '/private/$identityId/$testKey', + ), localFile: AWSFile.fromPath('download.jpg'), options: options, s3pluginConfig: testS3pluginConfig, diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart index cf0d0c13cf..61afda43bd 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart @@ -72,7 +72,8 @@ void main() { ); final downloadFileOperation = downloadFile( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testKey',), + (identityId) => '/private/$identityId/$testKey', + ), localFile: AWSFile.fromPath(testDestinationPath), options: options, s3pluginConfig: testS3pluginConfig, @@ -86,7 +87,8 @@ void main() { final captureParams = verify( () => storageS3Service.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testKey',), + (identityId) => '/private/$identityId/$testKey', + ), options: captureAny( named: 'options', ), @@ -204,7 +206,8 @@ void main() { const testAccessLevel = StorageAccessLevel.protected; downloadFile( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey',), + (identityId) => '/protected/$identityId/$testKey', + ), localFile: AWSFile.fromPath('path'), options: const StorageDownloadFileOptions( pluginOptions: S3DownloadFilePluginOptions.forIdentity( @@ -222,7 +225,8 @@ void main() { final capturedOptions = verify( () => storageS3Service.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey',), + (identityId) => '/protected/$identityId/$testKey', + ), options: captureAny( named: 'options', ), From c1da20cb0c63ff2a36a40c78ec11271f72f788e6 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 16:15:32 -0700 Subject: [PATCH 24/46] chore: fix formatting in integration tests --- .../example/integration_test/use_case_test.dart | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 9f5ea1b3da..aca9c03f04 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -324,7 +324,8 @@ void main() { ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3',), + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( getProperties: true, @@ -344,7 +345,8 @@ void main() { const end = 5 * 1024 + 12; final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3',), + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( @@ -378,7 +380,8 @@ void main() { final result = await s3Plugin .downloadFile( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3',), + (identityId) => '/private/$identityId/$testObjectKey3', + ), localFile: localFile, options: const StorageDownloadFileOptions( pluginOptions: S3DownloadFilePluginOptions( @@ -661,7 +664,8 @@ void main() { (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testObjectKey2',), + (identityId) => '/protected/$identityId/$testObjectKey2', + ), options: StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions.forIdentity( user1IdentityId, @@ -680,7 +684,8 @@ void main() { (WidgetTester tester) async { final operation = Amplify.Storage.downloadData( path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testObjectKey3',), + (identityId) => '/private/$identityId/$testObjectKey3', + ), options: const StorageDownloadDataOptions( accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( From c98a08a7c884c2f90dd43e1aac781961b1f5763d Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 18 Mar 2024 13:49:21 -0400 Subject: [PATCH 25/46] chore: update generated code --- .../amplify_storage_s3_dart/lib/src/model/s3_item.g.dart | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.g.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.g.dart index db2c8a9479..5a4c48b825 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.g.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_item.g.dart @@ -7,7 +7,8 @@ part of 's3_item.dart'; // ************************************************************************** S3Item _$S3ItemFromJson(Map json) => S3Item( - key: json['key'] as String, + key: json['key'] as String?, + path: json['path'] as String? ?? '', size: json['size'] as int?, lastModified: json['lastModified'] == null ? null @@ -22,9 +23,7 @@ S3Item _$S3ItemFromJson(Map json) => S3Item( ); Map _$S3ItemToJson(S3Item instance) { - final val = { - 'key': instance.key, - }; + final val = {}; void writeNotNull(String key, dynamic value) { if (value != null) { @@ -32,6 +31,8 @@ Map _$S3ItemToJson(S3Item instance) { } } + writeNotNull('key', instance.key); + val['path'] = instance.path; writeNotNull('size', instance.size); writeNotNull('lastModified', instance.lastModified?.toIso8601String()); writeNotNull('eTag', instance.eTag); From 8722ad899be1f126101bef212071d3e8e794a9e4 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 18 Mar 2024 13:49:30 -0400 Subject: [PATCH 26/46] chore: add leading `/` --- .../issues/get_url_special_characters_test.dart | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart index a52e3ad964..430b0bc3b1 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/issues/get_url_special_characters_test.dart @@ -41,7 +41,7 @@ void main() { final key = 'Test - ${DateTime.now()}'; await Amplify.Storage.uploadData( data: S3DataPayload.bytes('hello'.codeUnits), - path: StoragePath.fromString('public/$key'), + path: StoragePath.fromString('/public/$key'), ).result; final getUrlResult = await Amplify.Storage.getUrl( From 31cbaeae6f25adf2a958a932f956a470920b0325 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Mon, 18 Mar 2024 13:53:25 -0700 Subject: [PATCH 27/46] chore: remove access level from e2e test --- .../example/integration_test/use_case_test.dart | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index a753cdee7b..8f23680d6e 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -351,7 +351,6 @@ void main() { (identityId) => '/private/$identityId/$testObjectKey3', ), options: StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( getProperties: true, bytesRange: S3DataBytesRange( @@ -690,7 +689,6 @@ void main() { (identityId) => '/private/$identityId/$testObjectKey3', ), options: const StorageDownloadDataOptions( - accessLevel: StorageAccessLevel.private, pluginOptions: S3DownloadDataPluginOptions( getProperties: true, ), From 6c615e39afcafd4016381e9513c31985a7e1d913 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 11 Mar 2024 12:18:37 -0700 Subject: [PATCH 28/46] fix(auth): device metadata migration (#4503) * merge main * chore: added a bracket and removed new keywords * chore: changed signature of deleteLegacyDeviceSecrets and regenerated pigeons. Changed legacysecrethandler.kt file to .txt to "comment" it out * chore: run dart format on generated file * chore: migrateLegacyDeviceSecrets now gets called before deleteLegacyCredentials. Cognito_device_secrets return type fixed * chore: add delete and fetch methods to the cognito swift file * fix: various issues with implementation * chore: fix lint issues * test: update test to include mfa and token refresh * chore: use coroutines, add plugin * chore: remove generate code in iOS * chore: fetch asf deviceId from shared prefs directly * chore: update error name * chore: remove native auth plugin * chore: remove old legacy handler * chore: remove check for null device metadata * chore: flatten nested if statements * chore: remove unused type --------- Co-authored-by: Kha Truong <64438356+khatruong2009@users.noreply.github.com> --- .../android/build.gradle | 5 +- .../AmplifyNativeLegacyWrapperPlugin.kt | 81 +++++---- .../LegacyNativePluginPigeon.java | 172 ------------------ .../pigeons/LegacyNativePluginPigeon.kt | 139 ++++++++++++++ .../example/android/app/build.gradle | 2 +- .../example/android/build.gradle | 2 +- .../ios/Flutter/AppFrameworkInfo.plist | 2 +- .../ios/Runner.xcodeproj/project.pbxproj | 9 +- .../xcshareddata/xcschemes/Runner.xcscheme | 2 +- .../AmplifyNativeLegacyWrapperPlugin.swift | 11 ++ .../Pigeons/AmplifyNativeLegacyPlugin.swift | 18 +- .../lib/amplify_native_legacy_plugin.g.dart | 24 ++- .../lib/amplify_native_legacy_wrapper.dart | 5 + .../pigeons/messages.dart | 12 +- .../AmplifyAuthCognitoPlugin.kt | 72 +++++++- .../pigeons/NativeAuthPluginBindingsPigeon.kt | 86 ++++++++- .../Classes/AmplifyAuthCognitoPlugin.swift | 8 + .../darwin/Classes/pigeons/messages.g.swift | 81 ++++++++- .../version_upgrade_test.dart | 20 +- .../ios/Flutter/AppFrameworkInfo.plist | 2 +- .../legacy_credential_provider_android.dart | 36 +++- .../legacy_credential_provider_impl.dart | 24 +++ .../legacy_credential_provider_ios.dart | 66 ++++++- .../legacy_device_details_extension.dart | 23 +++ .../credentials/legacy_ios_cognito_keys.dart | 63 +++++++ .../lib/src/native_auth_plugin.g.dart | 95 +++++++++- .../pigeons/native_auth_plugin.dart | 21 +++ .../legacy_credential_provider.dart | 37 ++++ .../lib/src/model/cognito_device_secrets.dart | 13 ++ .../credential_store_state_machine.dart | 106 ++++++++--- .../mock_legacy_credential_provider.dart | 16 ++ 31 files changed, 987 insertions(+), 266 deletions(-) delete mode 100644 packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/LegacyNativePluginPigeon.java create mode 100644 packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/pigeons/LegacyNativePluginPigeon.kt create mode 100644 packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_device_details_extension.dart diff --git a/packages/amplify_native_legacy_wrapper/android/build.gradle b/packages/amplify_native_legacy_wrapper/android/build.gradle index a343112a22..bded54fcad 100644 --- a/packages/amplify_native_legacy_wrapper/android/build.gradle +++ b/packages/amplify_native_legacy_wrapper/android/build.gradle @@ -47,6 +47,7 @@ android { namespace 'com.amazonaws.amplify.amplify_native_legacy_wrapper' } dependencies { - implementation 'com.amazonaws:aws-android-sdk-mobile-client:2.73.0' - implementation 'com.amazonaws:aws-android-sdk-cognitoauth:2.73.0' + implementation 'com.amplifyframework:core:1.38.6' + implementation 'com.amplifyframework:core-kotlin:0.22.8' + implementation 'com.amplifyframework:aws-auth-cognito:1.38.6' } diff --git a/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/AmplifyNativeLegacyWrapperPlugin.kt b/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/AmplifyNativeLegacyWrapperPlugin.kt index f08d3f6778..e3f28ad69a 100644 --- a/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/AmplifyNativeLegacyWrapperPlugin.kt +++ b/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/AmplifyNativeLegacyWrapperPlugin.kt @@ -4,66 +4,75 @@ package com.amazonaws.amplify.amplify_native_legacy_wrapper import android.content.Context -import com.amazonaws.mobile.client.AWSMobileClient -import com.amazonaws.mobile.client.Callback -import com.amazonaws.mobile.config.AWSConfiguration +import com.amazonaws.amplify.amplify_native_legacy_wrapper.pigeons.LegacyNativePlugin +import com.amplifyframework.AmplifyException +import com.amplifyframework.auth.AuthException +import com.amplifyframework.auth.cognito.AWSCognitoAuthPlugin +import com.amplifyframework.kotlin.core.Amplify +import com.amplifyframework.core.AmplifyConfiguration import io.flutter.embedding.engine.plugins.FlutterPlugin import kotlinx.coroutines.runBlocking import org.json.JSONObject /** AmplifyNativeLegacyWrapperPlugin */ -class AmplifyNativeLegacyWrapperPlugin: FlutterPlugin, LegacyNativePluginPigeon.LegacyNativePlugin { +class AmplifyNativeLegacyWrapperPlugin: FlutterPlugin, LegacyNativePlugin { private lateinit var context: Context - private val awsMobileClient = AWSMobileClient.getInstance() override fun onAttachedToEngine(flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) { context = flutterPluginBinding.applicationContext - LegacyNativePluginPigeon.LegacyNativePlugin.setup(flutterPluginBinding.binaryMessenger, this) + LegacyNativePlugin.setUp(flutterPluginBinding.binaryMessenger, this) } override fun onDetachedFromEngine(binding: FlutterPlugin.FlutterPluginBinding) { - LegacyNativePluginPigeon.LegacyNativePlugin.setup(binding.binaryMessenger, null) + LegacyNativePlugin.setUp(binding.binaryMessenger, null) } - override fun configure(config: String, result: LegacyNativePluginPigeon.Result) { - val mobileClientConfig = JSONObject(config).getJSONObject("auth").getJSONObject("plugins").getJSONObject("awsCognitoAuthPlugin") - awsMobileClient.initialize( - context, - AWSConfiguration(mobileClientConfig), - ResultCallback(result) - ) - } - - override fun signOut(result: LegacyNativePluginPigeon.Result) { - awsMobileClient.signOut(null, ResultCallback(result)) + override fun configure(config: String, callback: (Result) -> Unit) { + try { + val configuration = AmplifyConfiguration.builder(JSONObject(config)) + .devMenuEnabled(false) + .build() + Amplify.addPlugin(AWSCognitoAuthPlugin()) + Amplify.configure(configuration, context) + callback(Result.success(Unit)) + } catch (e: AmplifyException) { + callback(Result.failure(e)) + } } - override fun signIn( - username: String, - password: String, - result: LegacyNativePluginPigeon.Result - ) { + override fun signIn(username: String, password: String, callback: (Result) -> Unit) { runBlocking { - awsMobileClient.signIn( - username, - password, - HashMap(), - ResultCallback(result) - ) + try { + Amplify.Auth.signIn(username, password) + callback(Result.success(Unit)) + } catch (error: AuthException) { + callback(Result.failure(error)) + } } } -} - -class ResultCallback(private val result: LegacyNativePluginPigeon.Result) : Callback { - override fun onResult(res: T) { - this.result.success(null) + override fun signOut(callback: (Result) -> Unit) { + runBlocking { + try { + Amplify.Auth.signOut() + callback(Result.success(Unit)) + } catch (error: AuthException) { + callback(Result.failure(error)) + } + } } - override fun onError(e: Exception) { - this.result.error(e) + override fun rememberDevice(callback: (Result) -> Unit) { + runBlocking { + try { + Amplify.Auth.rememberDevice() + callback(Result.success(Unit)) + } catch (error: AuthException) { + callback(Result.failure(error)) + } + } } } diff --git a/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/LegacyNativePluginPigeon.java b/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/LegacyNativePluginPigeon.java deleted file mode 100644 index 96c2f20684..0000000000 --- a/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/LegacyNativePluginPigeon.java +++ /dev/null @@ -1,172 +0,0 @@ -// -// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. -// SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. -// See also: https://pub.dev/packages/pigeon - -package com.amazonaws.amplify.amplify_native_legacy_wrapper; - -import android.util.Log; -import androidx.annotation.NonNull; -import androidx.annotation.Nullable; -import io.flutter.plugin.common.BasicMessageChannel; -import io.flutter.plugin.common.BinaryMessenger; -import io.flutter.plugin.common.MessageCodec; -import io.flutter.plugin.common.StandardMessageCodec; -import java.io.ByteArrayOutputStream; -import java.nio.ByteBuffer; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** Generated class from Pigeon. */ -@SuppressWarnings({"unused", "unchecked", "CodeBlock2Expr", "RedundantSuppression", "serial"}) -public class LegacyNativePluginPigeon { - - /** Error class for passing custom error details to Flutter via a thrown PlatformException. */ - public static class FlutterError extends RuntimeException { - - /** The error code. */ - public final String code; - - /** The error details. Must be a datatype supported by the api codec. */ - public final Object details; - - public FlutterError(@NonNull String code, @Nullable String message, @Nullable Object details) - { - super(message); - this.code = code; - this.details = details; - } - } - - @NonNull - protected static ArrayList wrapError(@NonNull Throwable exception) { - ArrayList errorList = new ArrayList(3); - if (exception instanceof FlutterError) { - FlutterError error = (FlutterError) exception; - errorList.add(error.code); - errorList.add(error.getMessage()); - errorList.add(error.details); - } else { - errorList.add(exception.toString()); - errorList.add(exception.getClass().getSimpleName()); - errorList.add( - "Cause: " + exception.getCause() + ", Stacktrace: " + Log.getStackTraceString(exception)); - } - return errorList; - } - - public interface Result { - @SuppressWarnings("UnknownNullness") - void success(T result); - - void error(@NonNull Throwable error); - } - /** Generated interface from Pigeon that represents a handler of messages from Flutter. */ - public interface LegacyNativePlugin { - - void configure(@NonNull String config, @NonNull Result result); - - void signOut(@NonNull Result result); - - void signIn(@NonNull String username, @NonNull String password, @NonNull Result result); - - /** The codec used by LegacyNativePlugin. */ - static @NonNull MessageCodec getCodec() { - return new StandardMessageCodec(); - } - /**Sets up an instance of `LegacyNativePlugin` to handle messages through the `binaryMessenger`. */ - static void setup(@NonNull BinaryMessenger binaryMessenger, @Nullable LegacyNativePlugin api) { - { - BasicMessageChannel channel = - new BasicMessageChannel<>( - binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.configure", getCodec()); - if (api != null) { - channel.setMessageHandler( - (message, reply) -> { - ArrayList wrapped = new ArrayList(); - ArrayList args = (ArrayList) message; - String configArg = (String) args.get(0); - Result resultCallback = - new Result() { - public void success(Void result) { - wrapped.add(0, null); - reply.reply(wrapped); - } - - public void error(Throwable error) { - ArrayList wrappedError = wrapError(error); - reply.reply(wrappedError); - } - }; - - api.configure(configArg, resultCallback); - }); - } else { - channel.setMessageHandler(null); - } - } - { - BasicMessageChannel channel = - new BasicMessageChannel<>( - binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.signOut", getCodec()); - if (api != null) { - channel.setMessageHandler( - (message, reply) -> { - ArrayList wrapped = new ArrayList(); - Result resultCallback = - new Result() { - public void success(Void result) { - wrapped.add(0, null); - reply.reply(wrapped); - } - - public void error(Throwable error) { - ArrayList wrappedError = wrapError(error); - reply.reply(wrappedError); - } - }; - - api.signOut(resultCallback); - }); - } else { - channel.setMessageHandler(null); - } - } - { - BasicMessageChannel channel = - new BasicMessageChannel<>( - binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.signIn", getCodec()); - if (api != null) { - channel.setMessageHandler( - (message, reply) -> { - ArrayList wrapped = new ArrayList(); - ArrayList args = (ArrayList) message; - String usernameArg = (String) args.get(0); - String passwordArg = (String) args.get(1); - Result resultCallback = - new Result() { - public void success(Void result) { - wrapped.add(0, null); - reply.reply(wrapped); - } - - public void error(Throwable error) { - ArrayList wrappedError = wrapError(error); - reply.reply(wrappedError); - } - }; - - api.signIn(usernameArg, passwordArg, resultCallback); - }); - } else { - channel.setMessageHandler(null); - } - } - } - } -} diff --git a/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/pigeons/LegacyNativePluginPigeon.kt b/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/pigeons/LegacyNativePluginPigeon.kt new file mode 100644 index 0000000000..f6035accd1 --- /dev/null +++ b/packages/amplify_native_legacy_wrapper/android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/pigeons/LegacyNativePluginPigeon.kt @@ -0,0 +1,139 @@ +// +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 +// Autogenerated from Pigeon (v11.0.1), do not edit directly. +// See also: https://pub.dev/packages/pigeon + +package com.amazonaws.amplify.amplify_native_legacy_wrapper.pigeons + +import android.util.Log +import io.flutter.plugin.common.BasicMessageChannel +import io.flutter.plugin.common.BinaryMessenger +import io.flutter.plugin.common.MessageCodec +import io.flutter.plugin.common.StandardMessageCodec +import java.io.ByteArrayOutputStream +import java.nio.ByteBuffer + +private fun wrapResult(result: Any?): List { + return listOf(result) +} + +private fun wrapError(exception: Throwable): List { + if (exception is FlutterError) { + return listOf( + exception.code, + exception.message, + exception.details + ) + } else { + return listOf( + exception.javaClass.simpleName, + exception.toString(), + "Cause: " + exception.cause + ", Stacktrace: " + Log.getStackTraceString(exception) + ) + } +} + +/** + * Error class for passing custom error details to Flutter via a thrown PlatformException. + * @property code The error code. + * @property message The error message. + * @property details The error details. Must be a datatype supported by the api codec. + */ +class FlutterError ( + val code: String, + override val message: String? = null, + val details: Any? = null +) : Throwable() + +/** Generated interface from Pigeon that represents a handler of messages from Flutter. */ +interface LegacyNativePlugin { + fun configure(config: String, callback: (Result) -> Unit) + fun signOut(callback: (Result) -> Unit) + fun signIn(username: String, password: String, callback: (Result) -> Unit) + fun rememberDevice(callback: (Result) -> Unit) + + companion object { + /** The codec used by LegacyNativePlugin. */ + val codec: MessageCodec by lazy { + StandardMessageCodec() + } + /** Sets up an instance of `LegacyNativePlugin` to handle messages through the `binaryMessenger`. */ + @Suppress("UNCHECKED_CAST") + fun setUp(binaryMessenger: BinaryMessenger, api: LegacyNativePlugin?) { + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.configure", codec) + if (api != null) { + channel.setMessageHandler { message, reply -> + val args = message as List + val configArg = args[0] as String + api.configure(configArg) { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + reply.reply(wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.signOut", codec) + if (api != null) { + channel.setMessageHandler { _, reply -> + api.signOut() { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + reply.reply(wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.signIn", codec) + if (api != null) { + channel.setMessageHandler { message, reply -> + val args = message as List + val usernameArg = args[0] as String + val passwordArg = args[1] as String + api.signIn(usernameArg, passwordArg) { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + reply.reply(wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.rememberDevice", codec) + if (api != null) { + channel.setMessageHandler { _, reply -> + api.rememberDevice() { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + reply.reply(wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } + } + } +} diff --git a/packages/amplify_native_legacy_wrapper/example/android/app/build.gradle b/packages/amplify_native_legacy_wrapper/example/android/app/build.gradle index 435d79d2db..c65642eac2 100644 --- a/packages/amplify_native_legacy_wrapper/example/android/app/build.gradle +++ b/packages/amplify_native_legacy_wrapper/example/android/app/build.gradle @@ -48,7 +48,7 @@ android { applicationId "com.amazonaws.amplify.amplify_native_legacy_wrapper_example" // You can update the following values to match your application needs. // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration. - minSdkVersion flutter.minSdkVersion + minSdkVersion 24 targetSdkVersion flutter.targetSdkVersion versionCode flutterVersionCode.toInteger() versionName flutterVersionName diff --git a/packages/amplify_native_legacy_wrapper/example/android/build.gradle b/packages/amplify_native_legacy_wrapper/example/android/build.gradle index cadf1cf06c..ce647a433b 100644 --- a/packages/amplify_native_legacy_wrapper/example/android/build.gradle +++ b/packages/amplify_native_legacy_wrapper/example/android/build.gradle @@ -26,6 +26,6 @@ subprojects { project.evaluationDependsOn(':app') } -task clean(type: Delete) { +tasks.register("clean", Delete) { delete rootProject.buildDir } diff --git a/packages/amplify_native_legacy_wrapper/example/ios/Flutter/AppFrameworkInfo.plist b/packages/amplify_native_legacy_wrapper/example/ios/Flutter/AppFrameworkInfo.plist index 9625e105df..7c56964006 100644 --- a/packages/amplify_native_legacy_wrapper/example/ios/Flutter/AppFrameworkInfo.plist +++ b/packages/amplify_native_legacy_wrapper/example/ios/Flutter/AppFrameworkInfo.plist @@ -21,6 +21,6 @@ CFBundleVersion 1.0 MinimumOSVersion - 11.0 + 12.0 diff --git a/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/project.pbxproj b/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/project.pbxproj index d685f2faf5..18a0b41c96 100644 --- a/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/project.pbxproj +++ b/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/project.pbxproj @@ -156,7 +156,7 @@ 97C146E61CF9000F007C117D /* Project object */ = { isa = PBXProject; attributes = { - LastUpgradeCheck = 1300; + LastUpgradeCheck = 1430; ORGANIZATIONNAME = ""; TargetAttributes = { 97C146ED1CF9000F007C117D = { @@ -227,6 +227,7 @@ files = ( ); inputPaths = ( + "${TARGET_BUILD_DIR}/${INFOPLIST_PATH}", ); name = "Thin Binary"; outputPaths = ( @@ -342,7 +343,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; SUPPORTED_PLATFORMS = iphoneos; @@ -420,7 +421,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = YES; ONLY_ACTIVE_ARCH = YES; SDKROOT = iphoneos; @@ -469,7 +470,7 @@ GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_VARIABLE = YES; - IPHONEOS_DEPLOYMENT_TARGET = 11.0; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; MTL_ENABLE_DEBUG_INFO = NO; SDKROOT = iphoneos; SUPPORTED_PLATFORMS = iphoneos; diff --git a/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme b/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme index c87d15a335..a6b826db27 100644 --- a/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme +++ b/packages/amplify_native_legacy_wrapper/example/ios/Runner.xcodeproj/xcshareddata/xcschemes/Runner.xcscheme @@ -1,6 +1,6 @@ ) -> Void) { + _ = authPlugin.rememberDevice(options: nil) { response in + switch response { + case .success(_): + return completion(.success(())) + case .failure(let error): + return completion(.failure("Failed to remember device: \(error)")) + } + } + } + } extension String: Error {} diff --git a/packages/amplify_native_legacy_wrapper/ios/Classes/Pigeons/AmplifyNativeLegacyPlugin.swift b/packages/amplify_native_legacy_wrapper/ios/Classes/Pigeons/AmplifyNativeLegacyPlugin.swift index bbca6c2663..dd47b3f22d 100644 --- a/packages/amplify_native_legacy_wrapper/ios/Classes/Pigeons/AmplifyNativeLegacyPlugin.swift +++ b/packages/amplify_native_legacy_wrapper/ios/Classes/Pigeons/AmplifyNativeLegacyPlugin.swift @@ -1,7 +1,7 @@ // // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. +// Autogenerated from Pigeon (v11.0.1), do not edit directly. // See also: https://pub.dev/packages/pigeon import Foundation @@ -46,6 +46,7 @@ protocol LegacyNativePlugin { func configure(config: String, completion: @escaping (Result) -> Void) func signOut(completion: @escaping (Result) -> Void) func signIn(username: String, password: String, completion: @escaping (Result) -> Void) + func rememberDevice(completion: @escaping (Result) -> Void) } /// Generated setup class from Pigeon to handle messages through the `binaryMessenger`. @@ -103,5 +104,20 @@ class LegacyNativePluginSetup { } else { signInChannel.setMessageHandler(nil) } + let rememberDeviceChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.rememberDevice", binaryMessenger: binaryMessenger) + if let api = api { + rememberDeviceChannel.setMessageHandler { _, reply in + api.rememberDevice() { result in + switch result { + case .success: + reply(wrapResult(nil)) + case .failure(let error): + reply(wrapError(error)) + } + } + } + } else { + rememberDeviceChannel.setMessageHandler(nil) + } } } diff --git a/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_plugin.g.dart b/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_plugin.g.dart index 2d3c5e5ca0..06dce1ea3c 100644 --- a/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_plugin.g.dart +++ b/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_plugin.g.dart @@ -1,7 +1,7 @@ // // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. +// Autogenerated from Pigeon (v11.0.1), do not edit directly. // See also: https://pub.dev/packages/pigeon // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import @@ -88,4 +88,26 @@ class LegacyNativePlugin { return; } } + + Future rememberDevice() async { + final BasicMessageChannel channel = BasicMessageChannel( + 'dev.flutter.pigeon.amplify_native_legacy_wrapper.LegacyNativePlugin.rememberDevice', + codec, + binaryMessenger: _binaryMessenger); + final List? replyList = await channel.send(null) as List?; + if (replyList == null) { + throw PlatformException( + code: 'channel-error', + message: 'Unable to establish connection on channel.', + ); + } else if (replyList.length > 1) { + throw PlatformException( + code: replyList[0]! as String, + message: replyList[1] as String?, + details: replyList[2], + ); + } else { + return; + } + } } diff --git a/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_wrapper.dart b/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_wrapper.dart index 882b74da17..38bacdd158 100644 --- a/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_wrapper.dart +++ b/packages/amplify_native_legacy_wrapper/lib/amplify_native_legacy_wrapper.dart @@ -25,4 +25,9 @@ class AmplifyNativeLegacyWrapper implements LegacyNativePlugin { Future signOut() { return _plugin.signOut(); } + + @override + Future rememberDevice() { + return _plugin.rememberDevice(); + } } diff --git a/packages/amplify_native_legacy_wrapper/pigeons/messages.dart b/packages/amplify_native_legacy_wrapper/pigeons/messages.dart index 361343cdbd..d4c9d42942 100644 --- a/packages/amplify_native_legacy_wrapper/pigeons/messages.dart +++ b/packages/amplify_native_legacy_wrapper/pigeons/messages.dart @@ -6,12 +6,11 @@ copyrightHeader: '../../tool/license.txt', dartOut: './lib/amplify_native_legacy_plugin.g.dart', swiftOut: './ios/Classes/Pigeons/AmplifyNativeLegacyPlugin.swift', - javaOptions: JavaOptions( - className: 'LegacyNativePluginPigeon', - package: 'com.amazonaws.amplify.amplify_native_legacy_wrapper', + kotlinOptions: KotlinOptions( + package: 'com.amazonaws.amplify.amplify_native_legacy_wrapper.pigeons', ), - javaOut: - './android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/LegacyNativePluginPigeon.java', + kotlinOut: + './android/src/main/kotlin/com/amazonaws/amplify/amplify_native_legacy_wrapper/pigeons/LegacyNativePluginPigeon.kt', ), ) @@ -29,4 +28,7 @@ abstract class LegacyNativePlugin { @async void signIn(String username, String password); + + @async + void rememberDevice(); } diff --git a/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPlugin.kt b/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPlugin.kt index 1cb2cfe6cf..65161f9b43 100644 --- a/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPlugin.kt +++ b/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/AmplifyAuthCognitoPlugin.kt @@ -6,6 +6,7 @@ package com.amazonaws.amplify.amplify_auth_cognito import android.app.Activity import android.content.Context import android.content.Intent +import android.content.SharedPreferences import android.content.pm.PackageManager import android.content.pm.PackageManager.MATCH_ALL import android.content.pm.PackageManager.MATCH_DEFAULT_ONLY @@ -103,6 +104,13 @@ open class AmplifyAuthCognitoPlugin : ) } + /** + ASF Device Secrets Storage. + */ + private val asfDeviceSecretsStore: SharedPreferences by lazy { + applicationContext!!.getSharedPreferences("AWS.Cognito.ContextData", Context.MODE_PRIVATE) + } + override fun onAttachedToEngine(binding: FlutterPlugin.FlutterPluginBinding) { Log.d(TAG, "onAttachedToEngine") applicationContext = binding.applicationContext @@ -241,7 +249,7 @@ open class AmplifyAuthCognitoPlugin : * - https://github.com/aws-amplify/aws-sdk-android/blob/main/aws-android-sdk-cognitoauth/src/main/java/com/amazonaws/mobileconnectors/cognitoauth/util/ClientConstants.java */ override fun getLegacyCredentials(identityPoolId: String?, appClientId: String?, callback: (Result) -> Unit) { - val data = LegacyCredentialStoreData.builder() + val data = LegacyCredentialStoreDataBuilder() if (appClientId != null) { val lastAuthUser = legacyUserPoolStore["CognitoIdentityProvider.$appClientId.LastAuthUser"] @@ -273,6 +281,52 @@ open class AmplifyAuthCognitoPlugin : callback(Result.success(data.build())) } + /** + * Get Legacy Device Secrets + */ + override fun fetchLegacyDeviceSecrets( + username: String, + userPoolId: String, + callback: (Result) -> Unit + ) { + val data = LegacyDeviceDetailsBuilder() + + val newLegacyDeviceSecretsStore = LegacyKeyValueStore( + applicationContext!!, + "CognitoIdentityProviderDeviceCache.$userPoolId.$username" + ) + + val deviceKey = newLegacyDeviceSecretsStore["DeviceKey"] + val deviceSecret = newLegacyDeviceSecretsStore["DeviceSecret"] + val deviceGroup = newLegacyDeviceSecretsStore["DeviceGroupKey"] + + data.apply { + this.deviceKey = deviceKey + this.deviceSecret = deviceSecret + this.deviceGroupKey = deviceGroup + } + + val asfDeviceId = asfDeviceSecretsStore.getString("CognitoDeviceId", null) + data.apply { + this.asfDeviceId = asfDeviceId + } + + callback(Result.success(data.build())) + } + + /** + * Delete Legacy Device Secrets + */ + override fun deleteLegacyDeviceSecrets(username: String, userPoolId: String, callback: (Result) -> Unit) { + val legacyDeviceSecretsStore = LegacyKeyValueStore( + applicationContext!!, + "CognitoIdentityProviderDeviceCache.$userPoolId.$username" + ) + legacyDeviceSecretsStore.clear() + asfDeviceSecretsStore.edit().clear().apply() + callback(Result.success(Unit)) + } + /** * Clears the legacy credentials set by the Android SDK */ @@ -572,3 +626,19 @@ class LegacyCredentialStoreDataBuilder( idToken, ) } + +fun LegacyDeviceDetailsSecret.Companion.builder() = LegacyDeviceDetailsBuilder() + +class LegacyDeviceDetailsBuilder( + var deviceKey: String? = null, + var deviceGroupKey: String? = null, + var deviceSecret: String? = null, + var asfDeviceId: String? = null, +) { + fun build(): LegacyDeviceDetailsSecret = LegacyDeviceDetailsSecret( + deviceKey, + deviceGroupKey, + deviceSecret, + asfDeviceId, + ) +} diff --git a/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/pigeons/NativeAuthPluginBindingsPigeon.kt b/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/pigeons/NativeAuthPluginBindingsPigeon.kt index f76163165a..adb9547218 100644 --- a/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/pigeons/NativeAuthPluginBindingsPigeon.kt +++ b/packages/auth/amplify_auth_cognito/android/src/main/kotlin/com/amazonaws/amplify/amplify_auth_cognito/pigeons/NativeAuthPluginBindingsPigeon.kt @@ -1,7 +1,7 @@ // // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. +// Autogenerated from Pigeon (v11.0.1), do not edit directly. // See also: https://pub.dev/packages/pigeon package com.amazonaws.amplify.amplify_auth_cognito @@ -129,6 +129,34 @@ data class LegacyCredentialStoreData ( } } +/** Generated class from Pigeon that represents data sent in messages. */ +data class LegacyDeviceDetailsSecret ( + val deviceKey: String? = null, + val deviceGroupKey: String? = null, + val devicePassword: String? = null, + val asfDeviceId: String? = null + +) { + companion object { + @Suppress("UNCHECKED_CAST") + fun fromList(list: List): LegacyDeviceDetailsSecret { + val deviceKey = list[0] as String? + val deviceGroupKey = list[1] as String? + val devicePassword = list[2] as String? + val asfDeviceId = list[3] as String? + return LegacyDeviceDetailsSecret(deviceKey, deviceGroupKey, devicePassword, asfDeviceId) + } + } + fun toList(): List { + return listOf( + deviceKey, + deviceGroupKey, + devicePassword, + asfDeviceId, + ) + } +} + /** Generated class from Pigeon that represents Flutter messages that can be called from Kotlin. */ @Suppress("UNCHECKED_CAST") class NativeAuthPlugin(private val binaryMessenger: BinaryMessenger) { @@ -160,6 +188,11 @@ private object NativeAuthBridgeCodec : StandardMessageCodec() { } } 129.toByte() -> { + return (readValue(buffer) as? List)?.let { + LegacyDeviceDetailsSecret.fromList(it) + } + } + 130.toByte() -> { return (readValue(buffer) as? List)?.let { NativeUserContextData.fromList(it) } @@ -173,10 +206,14 @@ private object NativeAuthBridgeCodec : StandardMessageCodec() { stream.write(128) writeValue(stream, value.toList()) } - is NativeUserContextData -> { + is LegacyDeviceDetailsSecret -> { stream.write(129) writeValue(stream, value.toList()) } + is NativeUserContextData -> { + stream.write(130) + writeValue(stream, value.toList()) + } else -> super.writeValue(stream, value) } } @@ -205,6 +242,10 @@ interface NativeAuthBridge { fun getLegacyCredentials(identityPoolId: String?, appClientId: String?, callback: (Result) -> Unit) /** Clears the legacy credential store data. */ fun clearLegacyCredentials(callback: (Result) -> Unit) + /** Fetch legacy device secrets stored by native SDKs. */ + fun fetchLegacyDeviceSecrets(username: String, userPoolId: String, callback: (Result) -> Unit) + /** Clears the legacy device secrets. */ + fun deleteLegacyDeviceSecrets(username: String, userPoolId: String, callback: (Result) -> Unit) companion object { /** The codec used by NativeAuthBridge. */ @@ -345,6 +386,47 @@ interface NativeAuthBridge { channel.setMessageHandler(null) } } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.fetchLegacyDeviceSecrets", codec) + if (api != null) { + channel.setMessageHandler { message, reply -> + val args = message as List + val usernameArg = args[0] as String + val userPoolIdArg = args[1] as String + api.fetchLegacyDeviceSecrets(usernameArg, userPoolIdArg) { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + val data = result.getOrNull() + reply.reply(wrapResult(data)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } + run { + val channel = BasicMessageChannel(binaryMessenger, "dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.deleteLegacyDeviceSecrets", codec) + if (api != null) { + channel.setMessageHandler { message, reply -> + val args = message as List + val usernameArg = args[0] as String + val userPoolIdArg = args[1] as String + api.deleteLegacyDeviceSecrets(usernameArg, userPoolIdArg) { result: Result -> + val error = result.exceptionOrNull() + if (error != null) { + reply.reply(wrapError(error)) + } else { + reply.reply(wrapResult(null)) + } + } + } + } else { + channel.setMessageHandler(null) + } + } } } } diff --git a/packages/auth/amplify_auth_cognito/darwin/Classes/AmplifyAuthCognitoPlugin.swift b/packages/auth/amplify_auth_cognito/darwin/Classes/AmplifyAuthCognitoPlugin.swift index 6b174cd4d0..55212f6c96 100644 --- a/packages/auth/amplify_auth_cognito/darwin/Classes/AmplifyAuthCognitoPlugin.swift +++ b/packages/auth/amplify_auth_cognito/darwin/Classes/AmplifyAuthCognitoPlugin.swift @@ -171,5 +171,13 @@ public class AmplifyAuthCognitoPlugin: NSObject, FlutterPlugin, NativeAuthBridge func clearLegacyCredentials(completion: @escaping (Result) -> Void) { preconditionFailure("clearing legacy credentials via method channel is not supported in iOS/macOS") } + + func fetchLegacyDeviceSecrets(username: String, userPoolId: String, completion: @escaping (Result) -> Void) { + preconditionFailure("fetching legacy credentials via method channel is not supported in iOS/macOS") + } + + func deleteLegacyDeviceSecrets(username: String, userPoolId: String, completion: @escaping (Result) -> Void) { + preconditionFailure("clearing legacy credentials via method channel is not supported in iOS/macOS") + } } diff --git a/packages/auth/amplify_auth_cognito/darwin/Classes/pigeons/messages.g.swift b/packages/auth/amplify_auth_cognito/darwin/Classes/pigeons/messages.g.swift index 0ce21750f6..a029d4fe45 100644 --- a/packages/auth/amplify_auth_cognito/darwin/Classes/pigeons/messages.g.swift +++ b/packages/auth/amplify_auth_cognito/darwin/Classes/pigeons/messages.g.swift @@ -1,7 +1,7 @@ // // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. +// Autogenerated from Pigeon (v11.0.1), do not edit directly. // See also: https://pub.dev/packages/pigeon import Foundation @@ -137,6 +137,36 @@ struct LegacyCredentialStoreData { } } +/// Generated class from Pigeon that represents data sent in messages. +struct LegacyDeviceDetailsSecret { + var deviceKey: String? = nil + var deviceGroupKey: String? = nil + var devicePassword: String? = nil + var asfDeviceId: String? = nil + + static func fromList(_ list: [Any?]) -> LegacyDeviceDetailsSecret? { + let deviceKey: String? = nilOrValue(list[0]) + let deviceGroupKey: String? = nilOrValue(list[1]) + let devicePassword: String? = nilOrValue(list[2]) + let asfDeviceId: String? = nilOrValue(list[3]) + + return LegacyDeviceDetailsSecret( + deviceKey: deviceKey, + deviceGroupKey: deviceGroupKey, + devicePassword: devicePassword, + asfDeviceId: asfDeviceId + ) + } + func toList() -> [Any?] { + return [ + deviceKey, + deviceGroupKey, + devicePassword, + asfDeviceId, + ] + } +} + /// Generated class from Pigeon that represents Flutter messages that can be called from Swift. class NativeAuthPlugin { private let binaryMessenger: FlutterBinaryMessenger @@ -159,6 +189,8 @@ private class NativeAuthBridgeCodecReader: FlutterStandardReader { case 128: return LegacyCredentialStoreData.fromList(self.readValue() as! [Any?]) case 129: + return LegacyDeviceDetailsSecret.fromList(self.readValue() as! [Any?]) + case 130: return NativeUserContextData.fromList(self.readValue() as! [Any?]) default: return super.readValue(ofType: type) @@ -171,9 +203,12 @@ private class NativeAuthBridgeCodecWriter: FlutterStandardWriter { if let value = value as? LegacyCredentialStoreData { super.writeByte(128) super.writeValue(value.toList()) - } else if let value = value as? NativeUserContextData { + } else if let value = value as? LegacyDeviceDetailsSecret { super.writeByte(129) super.writeValue(value.toList()) + } else if let value = value as? NativeUserContextData { + super.writeByte(130) + super.writeValue(value.toList()) } else { super.writeValue(value) } @@ -213,6 +248,10 @@ protocol NativeAuthBridge { func getLegacyCredentials(identityPoolId: String?, appClientId: String?, completion: @escaping (Result) -> Void) /// Clears the legacy credential store data. func clearLegacyCredentials(completion: @escaping (Result) -> Void) + /// Fetch legacy device secrets stored by native SDKs. + func fetchLegacyDeviceSecrets(username: String, userPoolId: String, completion: @escaping (Result) -> Void) + /// Clears the legacy device secrets. + func deleteLegacyDeviceSecrets(username: String, userPoolId: String, completion: @escaping (Result) -> Void) } /// Generated setup class from Pigeon to handle messages through the `binaryMessenger`. @@ -343,5 +382,43 @@ class NativeAuthBridgeSetup { } else { clearLegacyCredentialsChannel.setMessageHandler(nil) } + /// Fetch legacy device secrets stored by native SDKs. + let fetchLegacyDeviceSecretsChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.fetchLegacyDeviceSecrets", binaryMessenger: binaryMessenger, codec: codec) + if let api = api { + fetchLegacyDeviceSecretsChannel.setMessageHandler { message, reply in + let args = message as! [Any?] + let usernameArg = args[0] as! String + let userPoolIdArg = args[1] as! String + api.fetchLegacyDeviceSecrets(username: usernameArg, userPoolId: userPoolIdArg) { result in + switch result { + case .success(let res): + reply(wrapResult(res)) + case .failure(let error): + reply(wrapError(error)) + } + } + } + } else { + fetchLegacyDeviceSecretsChannel.setMessageHandler(nil) + } + /// Clears the legacy device secrets. + let deleteLegacyDeviceSecretsChannel = FlutterBasicMessageChannel(name: "dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.deleteLegacyDeviceSecrets", binaryMessenger: binaryMessenger, codec: codec) + if let api = api { + deleteLegacyDeviceSecretsChannel.setMessageHandler { message, reply in + let args = message as! [Any?] + let usernameArg = args[0] as! String + let userPoolIdArg = args[1] as! String + api.deleteLegacyDeviceSecrets(username: usernameArg, userPoolId: userPoolIdArg) { result in + switch result { + case .success: + reply(wrapResult(nil)) + case .failure(let error): + reply(wrapError(error)) + } + } + } + } else { + deleteLegacyDeviceSecretsChannel.setMessageHandler(nil) + } } } diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/version_upgrade_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/version_upgrade_test.dart index 7c1bb4a89f..579039c829 100644 --- a/packages/auth/amplify_auth_cognito/example/integration_test/version_upgrade_test.dart +++ b/packages/auth/amplify_auth_cognito/example/integration_test/version_upgrade_test.dart @@ -15,7 +15,7 @@ import 'package:flutter_test/flutter_test.dart'; import 'test_runner.dart'; import 'utils/validation_utils.dart'; -final usernameConfig = amplifyEnvironments['sign-in-with-username']!; +final config = amplifyEnvironments['device-tracking-always']!; AmplifyAuthCognito get plugin => Amplify.Auth.getPlugin(AmplifyAuthCognito.pluginKey); @@ -35,8 +35,8 @@ void main() { setUp(() async { // configure Amplify and legacy plugin, and ensure no users are signed in. - await configureAmplify(usernameConfig); - await legacyPlugin.configure(usernameConfig); + await configureAmplify(config); + await legacyPlugin.configure(config); await tryAsync(Amplify.Auth.signOut); await tryAsync(legacyPlugin.signOut); @@ -46,7 +46,7 @@ void main() { cognitoUsername = await createUser(username, password); }); - asyncTest('sign in with username', (_) async { + asyncTest('sign in with username with mfa', (_) async { // assert no user is signed in. final session1 = await plugin.fetchAuthSession(); expect(session1.isSignedIn, isFalse); @@ -54,8 +54,10 @@ void main() { // sign a user in with the legacy plugin. await legacyPlugin.signIn(username, password); + await legacyPlugin.rememberDevice(); + // reconfigure Amplify to trigger credential migration. - await configureAmplify(usernameConfig); + await configureAmplify(config); // assert a user is signed in and tokens have been migrated. final session2 = await plugin.fetchAuthSession(); @@ -68,6 +70,14 @@ void main() { isTrue, ); + // confirm tokens can be refreshed + final session3 = await plugin.fetchAuthSession( + options: const FetchAuthSessionOptions( + forceRefresh: true, + ), + ); + expect(session3.isSignedIn, isTrue); + final currentUser = await plugin.getCurrentUser(); expect(currentUser.username, cognitoUsername); expect(isValidUserSub(currentUser.userId), isTrue); diff --git a/packages/auth/amplify_auth_cognito/example/ios/Flutter/AppFrameworkInfo.plist b/packages/auth/amplify_auth_cognito/example/ios/Flutter/AppFrameworkInfo.plist index 9625e105df..7c56964006 100644 --- a/packages/auth/amplify_auth_cognito/example/ios/Flutter/AppFrameworkInfo.plist +++ b/packages/auth/amplify_auth_cognito/example/ios/Flutter/AppFrameworkInfo.plist @@ -21,6 +21,6 @@ CFBundleVersion 1.0 MinimumOSVersion - 11.0 + 12.0 diff --git a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_android.dart b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_android.dart index 101164b5b4..1698d6cf69 100644 --- a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_android.dart +++ b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_android.dart @@ -4,7 +4,9 @@ // ignore_for_file: implementation_imports, invalid_use_of_internal_member import 'package:amplify_auth_cognito/src/credentials/legacy_credential_store_data_extension.dart'; -import 'package:amplify_auth_cognito/src/native_auth_plugin.g.dart'; +import 'package:amplify_auth_cognito/src/credentials/legacy_device_details_extension.dart'; +import 'package:amplify_auth_cognito/src/native_auth_plugin.g.dart' + as auth_cognito; import 'package:amplify_auth_cognito_dart/src/credentials/legacy_credential_provider.dart'; import 'package:amplify_auth_cognito_dart/src/state/cognito_state_machine.dart'; import 'package:amplify_auth_cognito_dart/src/state/state.dart'; @@ -28,7 +30,7 @@ class LegacyCredentialProviderAndroid implements LegacyCredentialProvider { CognitoIdentityCredentialsProvider? identityPoolConfig, CognitoOAuthConfig? hostedUiConfig, }) async { - final bridge = _stateMachine.expect(); + final bridge = _stateMachine.expect(); final legacyCredentials = await bridge.getLegacyCredentials( identityPoolConfig?.poolId, userPoolConfig?.appClientId, @@ -42,7 +44,35 @@ class LegacyCredentialProviderAndroid implements LegacyCredentialProvider { CognitoIdentityCredentialsProvider? identityPoolConfig, CognitoOAuthConfig? hostedUiConfig, }) { - final bridge = _stateMachine.expect(); + final bridge = _stateMachine.expect(); return bridge.clearLegacyCredentials(); } + + @override + Future fetchLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (userPoolConfig == null) return null; + final bridge = _stateMachine.expect(); + final device = await bridge.fetchLegacyDeviceSecrets( + username, + userPoolConfig.poolId, + ); + return device?.toLegacyDeviceDetails(); + } + + @override + Future deleteLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (userPoolConfig != null) { + final bridge = _stateMachine.expect(); + return bridge.deleteLegacyDeviceSecrets( + username, + userPoolConfig.poolId, + ); + } + } } diff --git a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_impl.dart b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_impl.dart index 3421989ce2..ca86dc5b96 100644 --- a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_impl.dart +++ b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_impl.dart @@ -61,4 +61,28 @@ class LegacyCredentialProviderImpl implements LegacyCredentialProvider { hostedUiConfig: hostedUiConfig, ); } + + @override + Future fetchLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (_instance == null) return null; + return _instance!.fetchLegacyDeviceSecrets( + username: username, + userPoolConfig: userPoolConfig, + ); + } + + @override + Future deleteLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (_instance == null) return; + return _instance!.deleteLegacyDeviceSecrets( + username: username, + userPoolConfig: userPoolConfig, + ); + } } diff --git a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_ios.dart b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_ios.dart index df9497d9a0..41b27782a0 100644 --- a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_ios.dart +++ b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_credential_provider_ios.dart @@ -5,7 +5,8 @@ import 'dart:async'; import 'package:amplify_auth_cognito/src/credentials/legacy_ios_cognito_keys.dart'; import 'package:amplify_auth_cognito/src/credentials/secure_storage_extension.dart'; -import 'package:amplify_auth_cognito/src/native_auth_plugin.g.dart'; +import 'package:amplify_auth_cognito/src/native_auth_plugin.g.dart' + as auth_cognito; import 'package:amplify_auth_cognito_dart/amplify_auth_cognito_dart.dart'; // ignore: implementation_imports import 'package:amplify_auth_cognito_dart/src/credentials/legacy_credential_provider.dart'; @@ -160,12 +161,73 @@ class LegacyCredentialProviderIOS implements LegacyCredentialProvider { } } + @override + Future fetchLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (userPoolConfig == null) return null; + final userPoolStorage = await _getUserPoolStorage(); + final cognitoUserKeys = LegacyCognitoUserKeys(userPoolConfig); + final currentUserId = await userPoolStorage.read( + key: cognitoUserKeys[LegacyCognitoKey.currentUser], + ); + if (currentUserId == null) return null; + final keys = LegacyDeviceSecretKeys( + currentUserId, + userPoolConfig, + ); + final deviceKey = await userPoolStorage.read( + key: keys[LegacyDeviceSecretKey.id], + ); + final devicePassword = await userPoolStorage.read( + key: keys[LegacyDeviceSecretKey.secret], + ); + final deviceGroupKey = await userPoolStorage.read( + key: keys[LegacyDeviceSecretKey.group], + ); + + final asfKeys = LegacyAsfDeviceKeys(currentUserId, userPoolConfig); + final asfDeviceId = await userPoolStorage.read( + key: asfKeys[LegacyAsfDeviceKey.id], + ); + + return LegacyDeviceDetails( + deviceKey: deviceKey, + deviceGroupKey: deviceGroupKey, + devicePassword: devicePassword, + asfDeviceId: asfDeviceId, + ); + } + + @override + Future deleteLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + if (userPoolConfig == null) return; + final userPoolStorage = await _getUserPoolStorage(); + final cognitoUserKeys = LegacyCognitoUserKeys(userPoolConfig); + final currentUserId = await userPoolStorage.read( + key: cognitoUserKeys[LegacyCognitoKey.currentUser], + ); + if (currentUserId == null) return; + final keys = LegacyDeviceSecretKeys(currentUserId, userPoolConfig); + final asfKeys = LegacyAsfDeviceKeys(currentUserId, userPoolConfig); + await userPoolStorage.deleteMany([ + keys[LegacyDeviceSecretKey.id], + keys[LegacyDeviceSecretKey.secret], + keys[LegacyDeviceSecretKey.group], + asfKeys[LegacyAsfDeviceKey.id], + ]); + } + final _bundleIdMemoizer = AsyncMemoizer(); /// Gets the bundle ID. FutureOr _getBundleId() { return _bundleIdMemoizer.runOnce(() { - final bridge = _stateMachine.expect(); + final bridge = _stateMachine.expect(); return bridge.getBundleId(); }); } diff --git a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_device_details_extension.dart b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_device_details_extension.dart new file mode 100644 index 0000000000..3fc9b34e56 --- /dev/null +++ b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_device_details_extension.dart @@ -0,0 +1,23 @@ +// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. +// SPDX-License-Identifier: Apache-2.0 + +import 'package:amplify_auth_cognito/src/native_auth_plugin.g.dart'; +// ignore: implementation_imports +import 'package:amplify_auth_cognito_dart/src/credentials/legacy_credential_provider.dart'; + +/// {@template amplify_auth_cognito.legacy_device_details_extension} +/// Extensions to convert legacy device details secret stored by +/// the legacy Android SDK to legacy device details. +/// {@endtemplate} + +extension LegacyDeviceDetailsX on LegacyDeviceDetailsSecret { + /// {@macro amplify_auth_cognito.legacy_device_details} + LegacyDeviceDetails? toLegacyDeviceDetails() { + return LegacyDeviceDetails( + deviceKey: deviceKey, + deviceGroupKey: deviceGroupKey, + devicePassword: devicePassword, + asfDeviceId: asfDeviceId, + ); + } +} diff --git a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_ios_cognito_keys.dart b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_ios_cognito_keys.dart index ab69acba81..a7f74a832d 100644 --- a/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_ios_cognito_keys.dart +++ b/packages/auth/amplify_auth_cognito/lib/src/credentials/legacy_ios_cognito_keys.dart @@ -53,6 +53,24 @@ enum LegacyCognitoIdentityPoolKey { identityId, } +/// Discrete keys stored for Legacy Device Secrets on iOS. +enum LegacyDeviceSecretKey { + /// The device key. + id, + + /// The device password. + secret, + + /// The device group key. + group, +} + +/// Discrete keys stored for Legacy ASF on iOS. +enum LegacyAsfDeviceKey { + /// The advanced security feature (ASF) device identifier. + id; +} + /// {@template amplify_auth_cognito.legacy_cognito_identity_pool_keys} /// Enumerates and iterates over the keys stored in secure storage by /// legacy Cognito Identity Pool operations. @@ -112,6 +130,51 @@ class LegacyCognitoUserPoolKeys String get prefix => '${config.appClientId}.$currentUserId'; } +/// {@template amplify_auth_cognito.cognito_user_pool_keys} +/// Enumerates and iterates over the keys stored in secure storage for +/// Device Secrets. +/// {@endtemplate} +class LegacyDeviceSecretKeys + extends LegacyIOSCognitoKeys { + /// {@macro amplify_auth_cognito.cognito_user_pool_keys} + const LegacyDeviceSecretKeys(this.currentUserId, this.config); + + /// The Cognito identity pool configuration, used to determine the key + /// prefixes. + final CognitoUserPoolConfig config; + + /// The current user ID, used to determine the key prefixes. + final String currentUserId; + + @override + List get _values => LegacyDeviceSecretKey.values; + + @override + String get prefix => '${config.poolId}.$currentUserId.device'; +} + +/// {@template amplify_auth_cognito.cognito_user_pool_keys} +/// Enumerates and iterates over the keys stored in secure storage for +/// ASF Device Secrets. +/// {@endtemplate} +class LegacyAsfDeviceKeys extends LegacyIOSCognitoKeys { + /// {@macro amplify_auth_cognito.cognito_user_pool_keys} + const LegacyAsfDeviceKeys(this.currentUserId, this.config); + + /// The Cognito identity pool configuration, used to determine the key + /// prefixes. + final CognitoUserPoolConfig config; + + /// The current user ID, used to determine the key prefixes. + final String currentUserId; + + @override + List get _values => LegacyAsfDeviceKey.values; + + @override + String get prefix => '${config.poolId}.$currentUserId.asf.device'; +} + /// {@template amplify_auth_cognito.cognito_keys} /// Iterable secure storage keys. /// {@endtemplate} diff --git a/packages/auth/amplify_auth_cognito/lib/src/native_auth_plugin.g.dart b/packages/auth/amplify_auth_cognito/lib/src/native_auth_plugin.g.dart index 6565384954..0cde16746c 100644 --- a/packages/auth/amplify_auth_cognito/lib/src/native_auth_plugin.g.dart +++ b/packages/auth/amplify_auth_cognito/lib/src/native_auth_plugin.g.dart @@ -1,7 +1,7 @@ // // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -// Autogenerated from Pigeon (v11.0.0), do not edit directly. +// Autogenerated from Pigeon (v11.0.1), do not edit directly. // See also: https://pub.dev/packages/pigeon // ignore_for_file: public_member_api_docs, non_constant_identifier_names, avoid_as, unused_import, unnecessary_parenthesis, prefer_null_aware_operators, omit_local_variable_types, unused_shown_name, unnecessary_import @@ -128,6 +128,42 @@ class LegacyCredentialStoreData { } } +class LegacyDeviceDetailsSecret { + LegacyDeviceDetailsSecret({ + this.deviceKey, + this.deviceGroupKey, + this.devicePassword, + this.asfDeviceId, + }); + + String? deviceKey; + + String? deviceGroupKey; + + String? devicePassword; + + String? asfDeviceId; + + Object encode() { + return [ + deviceKey, + deviceGroupKey, + devicePassword, + asfDeviceId, + ]; + } + + static LegacyDeviceDetailsSecret decode(Object result) { + result as List; + return LegacyDeviceDetailsSecret( + deviceKey: result[0] as String?, + deviceGroupKey: result[1] as String?, + devicePassword: result[2] as String?, + asfDeviceId: result[3] as String?, + ); + } +} + abstract class NativeAuthPlugin { static const MessageCodec codec = StandardMessageCodec(); @@ -168,9 +204,12 @@ class _NativeAuthBridgeCodec extends StandardMessageCodec { if (value is LegacyCredentialStoreData) { buffer.putUint8(128); writeValue(buffer, value.encode()); - } else if (value is NativeUserContextData) { + } else if (value is LegacyDeviceDetailsSecret) { buffer.putUint8(129); writeValue(buffer, value.encode()); + } else if (value is NativeUserContextData) { + buffer.putUint8(130); + writeValue(buffer, value.encode()); } else { super.writeValue(buffer, value); } @@ -182,6 +221,8 @@ class _NativeAuthBridgeCodec extends StandardMessageCodec { case 128: return LegacyCredentialStoreData.decode(readValue(buffer)!); case 129: + return LegacyDeviceDetailsSecret.decode(readValue(buffer)!); + case 130: return NativeUserContextData.decode(readValue(buffer)!); default: return super.readValueOfType(type, buffer); @@ -404,4 +445,54 @@ class NativeAuthBridge { return; } } + + /// Fetch legacy device secrets stored by native SDKs. + Future fetchLegacyDeviceSecrets( + String arg_username, String arg_userPoolId) async { + final BasicMessageChannel channel = BasicMessageChannel( + 'dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.fetchLegacyDeviceSecrets', + codec, + binaryMessenger: _binaryMessenger); + final List? replyList = await channel + .send([arg_username, arg_userPoolId]) as List?; + if (replyList == null) { + throw PlatformException( + code: 'channel-error', + message: 'Unable to establish connection on channel.', + ); + } else if (replyList.length > 1) { + throw PlatformException( + code: replyList[0]! as String, + message: replyList[1] as String?, + details: replyList[2], + ); + } else { + return (replyList[0] as LegacyDeviceDetailsSecret?); + } + } + + /// Clears the legacy device secrets. + Future deleteLegacyDeviceSecrets( + String arg_username, String arg_userPoolId) async { + final BasicMessageChannel channel = BasicMessageChannel( + 'dev.flutter.pigeon.amplify_auth_cognito.NativeAuthBridge.deleteLegacyDeviceSecrets', + codec, + binaryMessenger: _binaryMessenger); + final List? replyList = await channel + .send([arg_username, arg_userPoolId]) as List?; + if (replyList == null) { + throw PlatformException( + code: 'channel-error', + message: 'Unable to establish connection on channel.', + ); + } else if (replyList.length > 1) { + throw PlatformException( + code: replyList[0]! as String, + message: replyList[1] as String?, + details: replyList[2], + ); + } else { + return; + } + } } diff --git a/packages/auth/amplify_auth_cognito/pigeons/native_auth_plugin.dart b/packages/auth/amplify_auth_cognito/pigeons/native_auth_plugin.dart index 732e599505..97904c58f7 100644 --- a/packages/auth/amplify_auth_cognito/pigeons/native_auth_plugin.dart +++ b/packages/auth/amplify_auth_cognito/pigeons/native_auth_plugin.dart @@ -69,6 +69,20 @@ abstract class NativeAuthBridge { /// Clears the legacy credential store data. @async void clearLegacyCredentials(); + + /// Fetch legacy device secrets stored by native SDKs. + @async + LegacyDeviceDetailsSecret? fetchLegacyDeviceSecrets( + String username, + String userPoolId, + ); + + /// Clears the legacy device secrets. + @async + void deleteLegacyDeviceSecrets( + String username, + String userPoolId, + ); } class NativeUserContextData { @@ -93,3 +107,10 @@ class LegacyCredentialStoreData { String? refreshToken; String? idToken; } + +class LegacyDeviceDetailsSecret { + String? deviceKey; + String? deviceGroupKey; + String? devicePassword; + String? asfDeviceId; +} diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/credentials/legacy_credential_provider.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/credentials/legacy_credential_provider.dart index b01e4bcbaa..cfb262e1bf 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/credentials/legacy_credential_provider.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/credentials/legacy_credential_provider.dart @@ -18,10 +18,47 @@ abstract interface class LegacyCredentialProvider { CognitoOAuthConfig? hostedUiConfig, }); + /// Fetches legacy device secrets if they are present. + Future fetchLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }); + /// Deletes legacy credentials if they are present. Future deleteLegacyCredentials({ CognitoUserPoolConfig? userPoolConfig, CognitoIdentityCredentialsProvider? identityPoolConfig, CognitoOAuthConfig? hostedUiConfig, }); + + /// Deletes legacy device secrets if they are present. + Future deleteLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }); +} + +/// {@template amplify_auth_cognito_dart.legacy_device_details} +/// The legacy device details. +/// {@endtemplate} +class LegacyDeviceDetails { + /// {@macro amplify_auth_cognito_dart.legacy_device_details} + const LegacyDeviceDetails({ + required this.deviceKey, + required this.deviceGroupKey, + required this.devicePassword, + required this.asfDeviceId, + }); + + /// The device key/ID. + final String? deviceKey; + + /// The device group key. + final String? deviceGroupKey; + + /// The device password. + final String? devicePassword; + + /// The asf device ID. + final String? asfDeviceId; } diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/model/cognito_device_secrets.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/model/cognito_device_secrets.dart index 0ad52e8aac..d12eafa6b6 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/model/cognito_device_secrets.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/model/cognito_device_secrets.dart @@ -1,6 +1,7 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +import 'package:amplify_auth_cognito_dart/src/credentials/legacy_credential_provider.dart'; import 'package:amplify_auth_cognito_dart/src/sdk/cognito_identity_provider.dart'; import 'package:built_value/built_value.dart'; import 'package:built_value/serializer.dart'; @@ -18,6 +19,18 @@ abstract class CognitoDeviceSecrets factory CognitoDeviceSecrets([ void Function(CognitoDeviceSecretsBuilder) updates, ]) = _$CognitoDeviceSecrets; + + /// Creates a [CognitoDeviceSecrets] from a [LegacyDeviceDetails]. + factory CognitoDeviceSecrets.fromLegacyDeviceDetails( + LegacyDeviceDetails details, + ) { + return CognitoDeviceSecrets((b) { + b + ..deviceKey = details.deviceKey + ..deviceGroupKey = details.deviceGroupKey + ..devicePassword = details.devicePassword; + }); + } CognitoDeviceSecrets._(); @BuiltValueHook(finalizeBuilder: true) diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/credential_store_state_machine.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/credential_store_state_machine.dart index 4ca8fd74f8..630c1a361f 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/credential_store_state_machine.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/credential_store_state_machine.dart @@ -7,9 +7,11 @@ import 'dart:convert'; import 'package:amplify_auth_cognito_dart/amplify_auth_cognito_dart.dart'; import 'package:amplify_auth_cognito_dart/src/credentials/cognito_keys.dart'; import 'package:amplify_auth_cognito_dart/src/credentials/credential_store_keys.dart'; +import 'package:amplify_auth_cognito_dart/src/credentials/device_metadata_repository.dart'; import 'package:amplify_auth_cognito_dart/src/credentials/legacy_credential_provider.dart'; import 'package:amplify_auth_cognito_dart/src/credentials/secure_storage_extension.dart'; import 'package:amplify_auth_cognito_dart/src/model/auth_configuration.dart'; +import 'package:amplify_auth_cognito_dart/src/model/cognito_device_secrets.dart'; import 'package:amplify_auth_cognito_dart/src/model/session/cognito_sign_in_details.dart'; import 'package:amplify_auth_cognito_dart/src/sdk/cognito_identity_provider.dart'; import 'package:amplify_auth_cognito_dart/src/state/cognito_state_machine.dart'; @@ -45,6 +47,8 @@ final class CredentialStoreStateMachine SecureStorageInterface get _secureStorage => getOrCreate(); + DeviceMetadataRepository get _deviceRepository => getOrCreate(); + @override Future resolve(CredentialStoreEvent event) async { switch (event) { @@ -310,42 +314,98 @@ final class CredentialStoreStateMachine await _secureStorage.deleteMany(deletions); } + /// Migrates legacy credential store data, include AWS Credentials, User Pool + /// tokens, Device Info, and ASF Device ID. Future _migrateLegacyCredentialStore() async { final version = await getVersion(); if (version != CredentialStoreVersion.none) { return; } - emit(const CredentialStoreState.migratingLegacyStore()); - final legacyCredentialProvider = get(); - if (legacyCredentialProvider != null) { - final authConfig = expect(); + final credentialData = await _migrateLegacyCredentials(); + final username = credentialData?.userPoolTokens?.username; + if (username != null) { + await _migrateDeviceSecrets(username); + } + await _deleteLegacyCredentials(); + await _updateVersion(CredentialStoreVersion.v1); + } + + /// Migrates AWS Credentials and User Pool tokens. + Future _migrateLegacyCredentials() async { + final provider = get(); + final authConfig = expect(); + if (provider == null) return null; + CredentialStoreData? legacyData; + try { + legacyData = await provider.fetchLegacyCredentials( + userPoolConfig: authConfig.userPoolConfig, + identityPoolConfig: authConfig.identityPoolConfig, + hostedUiConfig: authConfig.hostedUiConfig, + ); + if (legacyData != null) { + await _storeCredentials(legacyData); + } + } on Object catch (e, s) { + logger.error('Error migrating legacy credentials', e, s); + } + return legacyData; + } + + /// Migrates legacy device secrets. + Future _migrateDeviceSecrets(String username) async { + final credentialProvider = get(); + final authConfig = expect(); + final userPoolKeys = CognitoUserPoolKeys(authConfig.userPoolConfig!); + if (credentialProvider == null) return; + try { + final legacySecrets = await credentialProvider.fetchLegacyDeviceSecrets( + username: username, + userPoolConfig: authConfig.userPoolConfig, + ); + if (legacySecrets != null) { + final secrets = CognitoDeviceSecrets.fromLegacyDeviceDetails( + legacySecrets, + ); + await _deviceRepository.put(username, secrets); + } + + // Migrate Asf Device ID + final asfDeviceId = legacySecrets?.asfDeviceId; + if (asfDeviceId != null) { + await _secureStorage.write( + key: userPoolKeys[CognitoUserPoolKey.asfDeviceId], + value: asfDeviceId, + ); + } + } on Object catch (e, s) { + logger.error('Error migrating legacy device secrets', e, s); + } finally { try { - final legacyData = - await legacyCredentialProvider.fetchLegacyCredentials( + await credentialProvider.deleteLegacyDeviceSecrets( + username: username, userPoolConfig: authConfig.userPoolConfig, - identityPoolConfig: authConfig.identityPoolConfig, - hostedUiConfig: authConfig.hostedUiConfig, ); - if (legacyData != null) { - await _storeCredentials(legacyData); - } } on Object catch (e, s) { - logger.error('Error migrating legacy credentials', e, s); - } finally { - try { - await legacyCredentialProvider.deleteLegacyCredentials( - userPoolConfig: authConfig.userPoolConfig, - identityPoolConfig: authConfig.identityPoolConfig, - hostedUiConfig: authConfig.hostedUiConfig, - ); - } on Object catch (e, s) { - logger.error('Error clearing legacy credentials', e, s); - } + logger.error('Error clearing legacy device secrets', e, s); } } + } - await _updateVersion(CredentialStoreVersion.v1); + /// Deletes legacy credentials. + Future _deleteLegacyCredentials() async { + final provider = get(); + final authConfig = expect(); + if (provider == null) return; + try { + await provider.deleteLegacyCredentials( + userPoolConfig: authConfig.userPoolConfig, + identityPoolConfig: authConfig.identityPoolConfig, + hostedUiConfig: authConfig.hostedUiConfig, + ); + } on Object catch (e, s) { + logger.error('Error clearing legacy credentials', e, s); + } } /// State machine callback for the [CredentialStoreLoadCredentialStore] event. diff --git a/packages/auth/amplify_auth_cognito_test/lib/common/mock_legacy_credential_provider.dart b/packages/auth/amplify_auth_cognito_test/lib/common/mock_legacy_credential_provider.dart index 65401e9f18..4212215ecc 100644 --- a/packages/auth/amplify_auth_cognito_test/lib/common/mock_legacy_credential_provider.dart +++ b/packages/auth/amplify_auth_cognito_test/lib/common/mock_legacy_credential_provider.dart @@ -30,4 +30,20 @@ class MockLegacyCredentialProvider implements LegacyCredentialProvider { }) async { return data; } + + @override + Future fetchLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + return null; + } + + @override + Future deleteLegacyDeviceSecrets({ + required String username, + CognitoUserPoolConfig? userPoolConfig, + }) async { + return; + } } From 255855f8b61ac50fcba3604c05b4e87f74f59c3b Mon Sep 17 00:00:00 2001 From: Elijah Quartey Date: Wed, 13 Mar 2024 09:05:15 -0500 Subject: [PATCH 29/46] fix(auth): Allow retries with verifyTotpSetup() (#4532) --- .../mfa_totp_optional_test.dart | 49 +++++++++++++++ .../lib/src/auth_plugin_impl.dart | 2 +- .../machines/totp_setup_state_machine.dart | 60 ++++++++++++++----- 3 files changed, 96 insertions(+), 15 deletions(-) diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart index 5c7e1ba29d..8a07eae6bb 100644 --- a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart +++ b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart @@ -93,6 +93,55 @@ void main() { 'w/ device name', (_) => runTest(friendlyDeviceName: friendlyDeviceName), ); + + asyncTest('verifyTotpSetup allows retries', (_) async { + final username = generateUsername(); + final password = generatePassword(); + + await adminCreateUser( + username, + password, + verifyAttributes: true, + autoConfirm: true, + ); + + final signInRes = await Amplify.Auth.signIn( + username: username, + password: password, + ); + + check( + because: 'TOTP is optional', + signInRes.nextStep.signInStep, + ).equals(AuthSignInStep.done); + + final totpSetupResult = await Amplify.Auth.setUpTotp(); + + await Amplify.Auth.verifyTotpSetup( + '555555', + ); + + check( + await cognitoPlugin.fetchMfaPreference(), + because: 'TOTP should not be enabled', + ).equals( + const UserMfaPreference( + enabled: {}, + preferred: null, + ), + ); + + await Amplify.Auth.verifyTotpSetup( + await generateTotpCode(totpSetupResult.sharedSecret), + ); + + check(await cognitoPlugin.fetchMfaPreference()).equals( + const UserMfaPreference( + enabled: {MfaType.totp}, + preferred: MfaType.totp, + ), + ); + }); }); }); }); diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart index 31017b8768..f246ac0451 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart @@ -932,7 +932,7 @@ class AmplifyAuthCognitoDart extends AuthPluginInterface defaultPluginOptions: const CognitoVerifyTotpSetupPluginOptions(), ); final machine = _stateMachine.getOrCreate(TotpSetupStateMachine.type); - await machine.dispatchAndComplete( + await machine.dispatchAndComplete( TotpSetupEvent.verify( code: totpCode, friendlyDeviceName: pluginOptions.friendlyDeviceName, diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart index 31df3b3492..ceaa794744 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart @@ -2,8 +2,10 @@ // SPDX-License-Identifier: Apache-2.0 import 'package:amplify_auth_cognito_dart/src/jwt/src/cognito.dart'; -import 'package:amplify_auth_cognito_dart/src/sdk/cognito_identity_provider.dart'; +import 'package:amplify_auth_cognito_dart/src/sdk/cognito_identity_provider.dart' + hide EnableSoftwareTokenMfaException; import 'package:amplify_auth_cognito_dart/src/sdk/sdk_bridge.dart'; +import 'package:amplify_auth_cognito_dart/src/sdk/sdk_exception.dart'; import 'package:amplify_auth_cognito_dart/src/state/cognito_state_machine.dart'; import 'package:amplify_auth_cognito_dart/src/state/state.dart'; import 'package:amplify_core/amplify_core.dart'; @@ -48,6 +50,7 @@ final class TotpSetupStateMachine CognitoIdentityProviderClient get _cognitoIdp => expect(); String? _session; + TotpSetupDetails? _details; Future _onInitiate(TotpSetupInitiate event) async { final tokens = await manager.getUserPoolTokens(); @@ -59,12 +62,13 @@ final class TotpSetupStateMachine ) .result; _session = response.session; + _details = TotpSetupDetails( + username: CognitoIdToken(tokens.idToken).username, + sharedSecret: response.secretCode!, + ); emit( TotpSetupState.requiresVerification( - TotpSetupDetails( - username: CognitoIdToken(tokens.idToken).username, - sharedSecret: response.secretCode!, - ), + _details!, ), ); } @@ -72,16 +76,44 @@ final class TotpSetupStateMachine Future _onVerify(TotpSetupVerify event) async { final tokens = await manager.getUserPoolTokens(); final accessToken = tokens.accessToken.raw; - await _cognitoIdp - .verifySoftwareToken( - VerifySoftwareTokenRequest( - accessToken: accessToken, - session: _session, - userCode: event.code, - friendlyDeviceName: event.friendlyDeviceName, + try { + await _cognitoIdp + .verifySoftwareToken( + VerifySoftwareTokenRequest( + accessToken: accessToken, + session: _session, + userCode: event.code, + friendlyDeviceName: event.friendlyDeviceName, + ), + ) + .result; + } on Exception catch (e, st) { + // Handle mismatch code exception that may occur during TOTP verification. + // See: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html#API_VerifySoftwareToken_Errors + if (e is EnableSoftwareTokenMfaException) { + assert( + _details != null, + 'TotpSetupDetails should not be null. Please report this issue.', + ); + logger.verbose( + 'Failed to verify TOTP code. Retrying...', + e, + ); + emit( + TotpSetupState.requiresVerification( + _details!, ), - ) - .result; + ); + return; + } + logger.error( + 'Failed to verify TOTP code. Please try again.', + e, + st, + ); + emit(TotpSetupState.failure(e, st)); + } + try { await _cognitoIdp.setMfaSettings( accessToken: accessToken, From bd4bfe242c684b1b8e1cd301e990a76958553415 Mon Sep 17 00:00:00 2001 From: Elijah Quartey Date: Thu, 14 Mar 2024 10:24:51 -0500 Subject: [PATCH 30/46] chore(version): cherry pick Bump version (#4545) --- packages/auth/amplify_auth_cognito/CHANGELOG.md | 6 ++++++ packages/auth/amplify_auth_cognito/pubspec.yaml | 4 ++-- packages/auth/amplify_auth_cognito_dart/CHANGELOG.md | 6 ++++++ packages/auth/amplify_auth_cognito_dart/pubspec.yaml | 2 +- 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/packages/auth/amplify_auth_cognito/CHANGELOG.md b/packages/auth/amplify_auth_cognito/CHANGELOG.md index dcaa1236a2..09aa11a00e 100644 --- a/packages/auth/amplify_auth_cognito/CHANGELOG.md +++ b/packages/auth/amplify_auth_cognito/CHANGELOG.md @@ -1,3 +1,9 @@ +## 1.7.1 + +### Fixes +- fix(auth): Allow retries with verifyTotpSetup() ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) +- fix(auth): device metadata migration ([#4503](https://github.com/aws-amplify/amplify-flutter/pull/4503)) + ## 1.7.0 - Minor bug fixes and improvements diff --git a/packages/auth/amplify_auth_cognito/pubspec.yaml b/packages/auth/amplify_auth_cognito/pubspec.yaml index c15079c639..ca41f5581c 100644 --- a/packages/auth/amplify_auth_cognito/pubspec.yaml +++ b/packages/auth/amplify_auth_cognito/pubspec.yaml @@ -1,6 +1,6 @@ name: amplify_auth_cognito description: The Amplify Flutter Auth category plugin using the AWS Cognito provider. -version: 1.7.0 +version: 1.7.1 homepage: https://docs.amplify.aws/lib/q/platform/flutter/ repository: https://github.com/aws-amplify/amplify-flutter/tree/main/packages/auth/amplify_auth_cognito issue_tracker: https://github.com/aws-amplify/amplify-flutter/issues @@ -21,7 +21,7 @@ platforms: dependencies: amplify_analytics_pinpoint: ">=1.7.0 <1.8.0" amplify_analytics_pinpoint_dart: ">=0.3.6 <0.4.0" - amplify_auth_cognito_dart: ">=0.10.10 <0.11.0" + amplify_auth_cognito_dart: ">=0.10.11 <0.11.0" amplify_core: ">=1.7.0 <1.8.0" amplify_flutter: ">=1.7.0 <1.8.0" amplify_secure_storage: ">=0.4.1 <0.5.0" diff --git a/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md b/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md index e81348b40e..59fd7f72f1 100644 --- a/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md +++ b/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.10.11 + +### Fixes +- fix(auth): Allow retries with verifyTotpSetup() ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) +- fix(auth): device metadata migration ([#4503](https://github.com/aws-amplify/amplify-flutter/pull/4503)) + ## 0.10.10 - Minor bug fixes and improvements diff --git a/packages/auth/amplify_auth_cognito_dart/pubspec.yaml b/packages/auth/amplify_auth_cognito_dart/pubspec.yaml index 1507e55c9f..8a4418fea2 100644 --- a/packages/auth/amplify_auth_cognito_dart/pubspec.yaml +++ b/packages/auth/amplify_auth_cognito_dart/pubspec.yaml @@ -1,6 +1,6 @@ name: amplify_auth_cognito_dart description: A Dart-only implementation of the Amplify Auth plugin for Cognito. -version: 0.10.10 +version: 0.10.11 homepage: https://docs.amplify.aws/lib/q/platform/flutter/ repository: https://github.com/aws-amplify/amplify-flutter/tree/next/packages/auth/amplify_auth_cognito_dart issue_tracker: https://github.com/aws-amplify/amplify-flutter/issues From 941b19289878f87045cdb5294997d5c33054f202 Mon Sep 17 00:00:00 2001 From: Elijah Quartey Date: Fri, 15 Mar 2024 13:57:22 -0500 Subject: [PATCH 31/46] fix(auth): verifyTotp throw EnableSoftwareTokenMfaException (#4558) --- .../mfa_totp_optional_test.dart | 23 ++++++++++++++----- .../lib/src/auth_plugin_impl.dart | 14 ++++++++++- .../machines/totp_setup_state_machine.dart | 16 +++++-------- 3 files changed, 36 insertions(+), 17 deletions(-) diff --git a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart index 8a07eae6bb..44cfe0d4ca 100644 --- a/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart +++ b/packages/auth/amplify_auth_cognito/example/integration_test/mfa_totp_optional_test.dart @@ -1,6 +1,7 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 +import 'package:amplify_auth_cognito_dart/amplify_auth_cognito_dart.dart'; import 'package:amplify_auth_integration_test/amplify_auth_integration_test.dart'; import 'package:amplify_flutter/amplify_flutter.dart'; import 'package:amplify_integration_test/amplify_integration_test.dart'; @@ -117,9 +118,15 @@ void main() { final totpSetupResult = await Amplify.Auth.setUpTotp(); - await Amplify.Auth.verifyTotpSetup( - '555555', - ); + try { + await Amplify.Auth.verifyTotpSetup('555555'); + fail('Expected to fail'); + } on AuthException catch (e) { + check( + e, + because: 'Invalid TOTP code should fail verification', + ).isA(); + } check( await cognitoPlugin.fetchMfaPreference(), @@ -131,9 +138,13 @@ void main() { ), ); - await Amplify.Auth.verifyTotpSetup( - await generateTotpCode(totpSetupResult.sharedSecret), - ); + try { + await Amplify.Auth.verifyTotpSetup( + await generateTotpCode(totpSetupResult.sharedSecret), + ); + } on Exception catch (e) { + fail('Expected to succeed, but got $e'); + } check(await cognitoPlugin.fetchMfaPreference()).equals( const UserMfaPreference( diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart index f246ac0451..a68e5e4f5e 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/auth_plugin_impl.dart @@ -932,12 +932,24 @@ class AmplifyAuthCognitoDart extends AuthPluginInterface defaultPluginOptions: const CognitoVerifyTotpSetupPluginOptions(), ); final machine = _stateMachine.getOrCreate(TotpSetupStateMachine.type); - await machine.dispatchAndComplete( + final state = await machine.dispatchAndComplete( TotpSetupEvent.verify( code: totpCode, friendlyDeviceName: pluginOptions.friendlyDeviceName, ), ); + + switch (state) { + case TotpSetupRequiresVerification _: + // TODO(equartey): Change to `CodeMismatchException` in next major version as breaking change + throw const EnableSoftwareTokenMfaException( + 'The code provided was incorrect, try again', + ); + case TotpSetupFailure(:final exception, :final stackTrace): + Error.throwWithStackTrace(exception, stackTrace); + default: + return; + } } @override diff --git a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart index ceaa794744..3454d0f085 100644 --- a/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart +++ b/packages/auth/amplify_auth_cognito_dart/lib/src/state/machines/totp_setup_state_machine.dart @@ -3,7 +3,7 @@ import 'package:amplify_auth_cognito_dart/src/jwt/src/cognito.dart'; import 'package:amplify_auth_cognito_dart/src/sdk/cognito_identity_provider.dart' - hide EnableSoftwareTokenMfaException; + hide EnableSoftwareTokenMfaException, CodeMismatchException; import 'package:amplify_auth_cognito_dart/src/sdk/sdk_bridge.dart'; import 'package:amplify_auth_cognito_dart/src/sdk/sdk_exception.dart'; import 'package:amplify_auth_cognito_dart/src/state/cognito_state_machine.dart'; @@ -76,6 +76,7 @@ final class TotpSetupStateMachine Future _onVerify(TotpSetupVerify event) async { final tokens = await manager.getUserPoolTokens(); final accessToken = tokens.accessToken.raw; + try { await _cognitoIdp .verifySoftwareToken( @@ -87,16 +88,16 @@ final class TotpSetupStateMachine ), ) .result; - } on Exception catch (e, st) { + } on Exception catch (e) { // Handle mismatch code exception that may occur during TOTP verification. // See: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerifySoftwareToken.html#API_VerifySoftwareToken_Errors - if (e is EnableSoftwareTokenMfaException) { + if (e is EnableSoftwareTokenMfaException || e is CodeMismatchException) { assert( _details != null, 'TotpSetupDetails should not be null. Please report this issue.', ); logger.verbose( - 'Failed to verify TOTP code. Retrying...', + 'Failed to verify TOTP code. Allowing retry...', e, ); emit( @@ -106,12 +107,7 @@ final class TotpSetupStateMachine ); return; } - logger.error( - 'Failed to verify TOTP code. Please try again.', - e, - st, - ); - emit(TotpSetupState.failure(e, st)); + rethrow; } try { From 188a256e2b8e49c0f001f2a001920fa9ee269fbb Mon Sep 17 00:00:00 2001 From: Elijah Quartey Date: Mon, 18 Mar 2024 08:49:34 -0500 Subject: [PATCH 32/46] chore(version): cherry pick Bump version (#4560) --- packages/auth/amplify_auth_cognito/CHANGELOG.md | 7 ++++++- packages/auth/amplify_auth_cognito/pubspec.yaml | 4 ++-- packages/auth/amplify_auth_cognito_dart/CHANGELOG.md | 7 ++++++- packages/auth/amplify_auth_cognito_dart/pubspec.yaml | 2 +- 4 files changed, 15 insertions(+), 5 deletions(-) diff --git a/packages/auth/amplify_auth_cognito/CHANGELOG.md b/packages/auth/amplify_auth_cognito/CHANGELOG.md index 09aa11a00e..4bb9404205 100644 --- a/packages/auth/amplify_auth_cognito/CHANGELOG.md +++ b/packages/auth/amplify_auth_cognito/CHANGELOG.md @@ -1,8 +1,13 @@ -## 1.7.1 +## 1.7.2 ### Fixes - fix(auth): Allow retries with verifyTotpSetup() ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) - fix(auth): device metadata migration ([#4503](https://github.com/aws-amplify/amplify-flutter/pull/4503)) +- fix(auth): verifyTotp throw EnableSoftwareTokenMfaException ([#4558](https://github.com/aws-amplify/amplify-flutter/pull/4558)) + +## 1.7.1 + +- This version was retracted to avoid a breaking change introduced in ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) ## 1.7.0 diff --git a/packages/auth/amplify_auth_cognito/pubspec.yaml b/packages/auth/amplify_auth_cognito/pubspec.yaml index ca41f5581c..b5be4e3835 100644 --- a/packages/auth/amplify_auth_cognito/pubspec.yaml +++ b/packages/auth/amplify_auth_cognito/pubspec.yaml @@ -1,6 +1,6 @@ name: amplify_auth_cognito description: The Amplify Flutter Auth category plugin using the AWS Cognito provider. -version: 1.7.1 +version: 1.7.2 homepage: https://docs.amplify.aws/lib/q/platform/flutter/ repository: https://github.com/aws-amplify/amplify-flutter/tree/main/packages/auth/amplify_auth_cognito issue_tracker: https://github.com/aws-amplify/amplify-flutter/issues @@ -21,7 +21,7 @@ platforms: dependencies: amplify_analytics_pinpoint: ">=1.7.0 <1.8.0" amplify_analytics_pinpoint_dart: ">=0.3.6 <0.4.0" - amplify_auth_cognito_dart: ">=0.10.11 <0.11.0" + amplify_auth_cognito_dart: ">=0.10.12 <0.11.0" amplify_core: ">=1.7.0 <1.8.0" amplify_flutter: ">=1.7.0 <1.8.0" amplify_secure_storage: ">=0.4.1 <0.5.0" diff --git a/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md b/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md index 59fd7f72f1..66a0153cd8 100644 --- a/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md +++ b/packages/auth/amplify_auth_cognito_dart/CHANGELOG.md @@ -1,8 +1,13 @@ -## 0.10.11 +## 0.10.12 ### Fixes - fix(auth): Allow retries with verifyTotpSetup() ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) - fix(auth): device metadata migration ([#4503](https://github.com/aws-amplify/amplify-flutter/pull/4503)) +- fix(auth): verifyTotp throw EnableSoftwareTokenMfaException ([#4558](https://github.com/aws-amplify/amplify-flutter/pull/4558)) + +## 0.10.11 + +- This version was retracted to avoid a breaking change introduced in ([#4532](https://github.com/aws-amplify/amplify-flutter/pull/4532)) ## 0.10.10 diff --git a/packages/auth/amplify_auth_cognito_dart/pubspec.yaml b/packages/auth/amplify_auth_cognito_dart/pubspec.yaml index 8a4418fea2..12faac3ac2 100644 --- a/packages/auth/amplify_auth_cognito_dart/pubspec.yaml +++ b/packages/auth/amplify_auth_cognito_dart/pubspec.yaml @@ -1,6 +1,6 @@ name: amplify_auth_cognito_dart description: A Dart-only implementation of the Amplify Auth plugin for Cognito. -version: 0.10.11 +version: 0.10.12 homepage: https://docs.amplify.aws/lib/q/platform/flutter/ repository: https://github.com/aws-amplify/amplify-flutter/tree/next/packages/auth/amplify_auth_cognito_dart issue_tracker: https://github.com/aws-amplify/amplify-flutter/issues From eabcd532225f00691a8836a463dcdbe6a37d4feb Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Tue, 19 Mar 2024 08:45:45 -0400 Subject: [PATCH 33/46] chore: Update BUG-REPORT.yaml (#4568) --- .github/ISSUE_TEMPLATE/BUG-REPORT.yaml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml index 529d792d43..683261d128 100644 --- a/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml +++ b/.github/ISSUE_TEMPLATE/BUG-REPORT.yaml @@ -47,7 +47,7 @@ body: 3. Scroll down to '....' 4. See error validations: - required: false + required: true - type: textarea id: screenshots attributes: @@ -79,7 +79,7 @@ body: attributes: label: "Flutter Version" description: "Please share which version of Flutter you're using (found using `flutter --version`)." - placeholder: "3.3.10" + placeholder: "3.19.3" validations: required: true - type: input @@ -87,7 +87,7 @@ body: attributes: label: Amplify Flutter Version description: "The version of the Amplify Flutter libraries you're currently using." - placeholder: "0.6.10" + placeholder: "1.7.0" validations: required: true - type: dropdown @@ -99,6 +99,7 @@ body: options: - Amplify CLI - Amplify CLI + Custom Pipeline + - AWS CDK - Custom Pipeline validations: required: true From fdce4a299b8f474cd47e18107d4cad5b9c6737c5 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Thu, 21 Mar 2024 12:03:08 -0400 Subject: [PATCH 34/46] fix: correct `package_info_plus` version constraint (#4583) chore: fix version constraint --- packages/analytics/amplify_analytics_pinpoint/pubspec.yaml | 2 +- packages/authenticator/amplify_authenticator/pubspec.yaml | 2 +- pubspec.yaml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/analytics/amplify_analytics_pinpoint/pubspec.yaml b/packages/analytics/amplify_analytics_pinpoint/pubspec.yaml index eaa236fb1c..994d6f65d5 100644 --- a/packages/analytics/amplify_analytics_pinpoint/pubspec.yaml +++ b/packages/analytics/amplify_analytics_pinpoint/pubspec.yaml @@ -28,7 +28,7 @@ dependencies: flutter: sdk: flutter meta: ^1.7.0 - package_info_plus: ">=4.0.1 <=6.0.0" + package_info_plus: ">=4.0.1 <6.0.0" path_provider: ^2.0.0 dev_dependencies: diff --git a/packages/authenticator/amplify_authenticator/pubspec.yaml b/packages/authenticator/amplify_authenticator/pubspec.yaml index a71fe1877c..daa80862e3 100644 --- a/packages/authenticator/amplify_authenticator/pubspec.yaml +++ b/packages/authenticator/amplify_authenticator/pubspec.yaml @@ -23,7 +23,7 @@ dependencies: intl: ">=0.18.0 <1.0.0" meta: ^1.7.0 # TODO(equartey): Remove this once we have our own method of getting the app name - package_info_plus: ">=4.0.1 <=6.0.0" + package_info_plus: ">=4.0.1 <6.0.0" qr_flutter: 4.1.0 smithy: ">=0.6.2 <0.7.0" stream_transform: ^2.0.0 diff --git a/pubspec.yaml b/pubspec.yaml index cf7d6409dc..f528bc7065 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -37,7 +37,7 @@ dependencies: json_serializable: 6.7.1 mime: ^1.0.0 oauth2: ^2.0.2 - package_info_plus: ">=4.0.1 <=6.0.0" + package_info_plus: ">=4.0.1 <6.0.0" pigeon: ^11.0.0 sqlite3: ^2.0.0 source_gen: ^1.3.2 From da10ddabeef6cabc64d5e7548695083b493d49a5 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Thu, 21 Mar 2024 10:23:37 -0400 Subject: [PATCH 35/46] feat(storage): copy and move APIs (#4569) * chore: update copy api * chore: update integ tests for copy * chore: removed unused code * chore: add back test --- .../category/amplify_storage_category.dart | 29 +- .../amplify_storage_plugin_interface.dart | 13 +- .../lib/src/types/storage/copy_request.dart | 4 +- .../integration_test/use_case_test.dart | 101 +------ .../example/bin/example.dart | 62 +--- .../lib/src/amplify_storage_s3_dart_impl.dart | 47 +-- .../service/storage_s3_service_impl.dart | 108 +------ .../test/amplify_storage_s3_dart_test.dart | 153 +--------- .../storage_s3_service_test.dart | 279 +----------------- 9 files changed, 49 insertions(+), 747 deletions(-) diff --git a/packages/amplify_core/lib/src/category/amplify_storage_category.dart b/packages/amplify_core/lib/src/category/amplify_storage_category.dart index 3bd3789151..cfc6683b0b 100644 --- a/packages/amplify_core/lib/src/category/amplify_storage_category.dart +++ b/packages/amplify_core/lib/src/category/amplify_storage_category.dart @@ -194,8 +194,8 @@ class StorageCategory extends AmplifyCategory { /// corresponding [StorageAccessLevel]. /// {@endtemplate} StorageCopyOperation copy({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, + required StoragePath source, + required StoragePath destination, StorageCopyOptions? options, }) { return identifyCall( @@ -208,31 +208,6 @@ class StorageCategory extends AmplifyCategory { ); } - /// {@template amplify_core.amplify_storage_category.move} - /// Moves [source] to [destination] with optional [StorageMoveOptions], - /// and returns a [StorageMoveOperation]. - /// - /// This API performs two consecutive S3 service calls: - /// 1. copy the source object to destination objection - /// 2. delete the source object - /// - /// {@macro amplify_core.amplify_storage_category.copy_source} - /// {@endtemplate} - StorageMoveOperation move({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, - StorageMoveOptions? options, - }) { - return identifyCall( - StorageCategoryMethod.move, - () => defaultPlugin.move( - source: source, - destination: destination, - options: options, - ), - ); - } - /// {@template amplify_core.amplify_storage_category.remove} /// Removes an object specified by [key] with optional [StorageRemoveOptions], /// and returns a [StorageRemoveOperation]. diff --git a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart index ce99a027c6..c845baf526 100644 --- a/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart +++ b/packages/amplify_core/lib/src/plugin/amplify_storage_plugin_interface.dart @@ -79,22 +79,13 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface { /// {@macro amplify_core.amplify_storage_category.copy} StorageCopyOperation copy({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, + required StoragePath source, + required StoragePath destination, StorageCopyOptions? options, }) { throw UnimplementedError('copy() has not been implemented.'); } - /// {@macro amplify_core.amplify_storage_category.move} - StorageMoveOperation move({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, - StorageMoveOptions? options, - }) { - throw UnimplementedError('move() has not been implemented.'); - } - /// {@macro amplify_core.amplify_storage_category.remove} StorageRemoveOperation remove({ required String key, diff --git a/packages/amplify_core/lib/src/types/storage/copy_request.dart b/packages/amplify_core/lib/src/types/storage/copy_request.dart index d7bc04cee8..0bfddaa1bd 100644 --- a/packages/amplify_core/lib/src/types/storage/copy_request.dart +++ b/packages/amplify_core/lib/src/types/storage/copy_request.dart @@ -15,10 +15,10 @@ class StorageCopyRequest { }); /// Copy source. - final StorageItemWithAccessLevel source; + final StoragePath source; /// Copy destination. - final StorageItemWithAccessLevel destination; + final StoragePath destination; /// Configurable options of the [StorageCopyRequest]. final StorageCopyOptions? options; diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 8f23680d6e..2f869081c3 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -56,9 +56,7 @@ void main() { testLargeFileBytes[0] = 101; testLargeFileBytes[5 * 1024] = 102; final testObjectKey1 = 'user1-guest-object-${uuid()}'; - final testObject1MoveKey = 'user1-guest-object-move-${uuid()}'; final testObjectKey2 = 'user1-protected-object-${uuid()}'; - final testObject2MoveKey = 'user1-protected-object-move-${uuid()}'; final testObjectKey3 = 'user1-private-object-${uuid()}'; final testObject3CopyKey = 'user1-private-object-copy-${uuid()}'; final testObject3CopyMoveKey = 'user1-private-object-copy-move-${uuid()}'; @@ -410,13 +408,11 @@ void main() { 'copy object with access level private for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.copy( - source: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObjectKey3), - accessLevel: StorageAccessLevel.private, + source: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey3', ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject3CopyKey), - accessLevel: StorageAccessLevel.private, + destination: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObject3CopyKey', ), options: const StorageCopyOptions( pluginOptions: S3CopyPluginOptions( @@ -429,41 +425,6 @@ void main() { expect(result.copiedItem.eTag, isNotEmpty); }); - testWidgets( - skip: true, - 'move object with access level private for the currently signed in user', - (WidgetTester tester) async { - final result = await Amplify.Storage.move( - source: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject3CopyKey), - accessLevel: StorageAccessLevel.private, - ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject3CopyMoveKey), - accessLevel: StorageAccessLevel.private, - ), - options: const StorageMoveOptions( - pluginOptions: S3MovePluginOptions(getProperties: true), - ), - ).result; - - expect(result.movedItem.key, testObject3CopyMoveKey); - expect(result.movedItem.eTag, isNotEmpty); - - final listedObjects = await Amplify.Storage.list( - options: const StorageListOptions( - accessLevel: StorageAccessLevel.private, - ), - ).result; - - expect( - listedObjects.items.map((item) => item.key), - isNot( - contains(testObject3CopyKey), - ), - ); - }); - testWidgets( 'delete object with access level private for the currently signed in user', (WidgetTester tester) async { @@ -701,41 +662,16 @@ void main() { ); }); - testWidgets( - skip: true, - 'move object with access level guest for the currently signed in user', - (WidgetTester tester) async { - final result = await Amplify.Storage.move( - source: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObjectKey1), - accessLevel: StorageAccessLevel.guest, - ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject1MoveKey), - accessLevel: StorageAccessLevel.private, - ), - options: const StorageMoveOptions( - pluginOptions: S3MovePluginOptions( - getProperties: true, - ), - ), - ).result; - - expect(result.movedItem.eTag, isNotEmpty); - }); - testWidgets( skip: true, 'copy object (belongs to other user) with access level protected' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.copy( - source: S3ItemWithAccessLevel.forIdentity( - user1IdentityId, - storageItem: S3Item(key: testObjectKey2), + source: StoragePath.fromString( + '/protected/$user1IdentityId/$testObjectKey2', ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject2MoveKey), - accessLevel: StorageAccessLevel.private, + destination: StoragePath.withIdentityId( + (identityId) => '/private/$identityId/$testObjectKey2', ), options: const StorageCopyOptions( pluginOptions: S3CopyPluginOptions( @@ -881,27 +817,6 @@ void main() { await Amplify.Auth.signOut(); }); - testWidgets( - skip: true, - 'move object with access level protected as object owner', - (WidgetTester tester) async { - final result = await Amplify.Storage.move( - source: S3ItemWithAccessLevel.forIdentity( - user1IdentityId, - storageItem: S3Item(key: testObjectKey2), - ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: testObject2MoveKey), - accessLevel: StorageAccessLevel.private, - ), - options: const StorageMoveOptions( - pluginOptions: S3MovePluginOptions(getProperties: true), - ), - ).result; - - expect(result.movedItem.eTag, isNotEmpty); - }); - testWidgets( skip: true, 'remove many objects belongs to the currently signed user', diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart index 12e1ed3c3d..e0d2013dd7 100644 --- a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart +++ b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart @@ -41,8 +41,7 @@ Future main() async { 3. getUrl 4. download data 5. download file 6. upload data url 7. upload file 8. copy - 9. move 10. remove - 0. exit + 9. remove 0. exit '''); final operationNum = int.tryParse(operation); @@ -64,8 +63,6 @@ Future main() async { case 8: await copyOperation(); case 9: - await moveOperation(); - case 10: await removeOperation(); case null: break; @@ -371,24 +368,12 @@ Future uploadFileOperation() async { Future copyOperation() async { final sourceKey = prompt('Enter the key of the source object: '); - final sourceStorageAccessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the source object: ', - ); final destinationKey = prompt('Enter the key of the destination object: '); - final destinationStorageAccessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the destination object: ', - ); final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final copyOperation = s3Plugin.copy( - source: S3ItemWithAccessLevel( - storageItem: S3Item(key: sourceKey), - accessLevel: sourceStorageAccessLevel, - ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: destinationKey), - accessLevel: destinationStorageAccessLevel, - ), + source: StoragePath.fromString(sourceKey), + destination: StoragePath.fromString(destinationKey), options: const StorageCopyOptions( pluginOptions: S3CopyPluginOptions(getProperties: true), ), @@ -410,47 +395,6 @@ Future copyOperation() async { } } -Future moveOperation() async { - final sourceKey = prompt('Enter the key of the source object: '); - final sourceStorageAccessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the source object: ', - ); - final destinationKey = prompt('Enter the key of the destination object: '); - final destinationStorageAccessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the destination object: ', - ); - - final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); - final moveOperation = s3Plugin.move( - source: S3ItemWithAccessLevel( - storageItem: S3Item(key: sourceKey), - accessLevel: sourceStorageAccessLevel, - ), - destination: S3ItemWithAccessLevel( - storageItem: S3Item(key: destinationKey), - accessLevel: destinationStorageAccessLevel, - ), - options: const StorageMoveOptions( - pluginOptions: S3MovePluginOptions(getProperties: true), - ), - ); - - try { - final result = await moveOperation.result; - stdout - ..writeln('Copied object: ') - ..writeln('key: ${result.movedItem.key}') - ..writeln('size: ${result.movedItem.size}') - ..writeln('lastModified: ${result.movedItem.lastModified}') - ..writeln('eTag: ${result.movedItem.eTag}') - ..writeln('metadata: ${result.movedItem.metadata}'); - } on Exception catch (error) { - stderr - ..writeln('Something went wrong...') - ..writeln(error); - } -} - Future removeOperation() async { final key = prompt('Enter the object key to remove: '); final accessLevel = promptStorageAccessLevel( diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart index 118954df8c..8759030944 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/amplify_storage_s3_dart_impl.dart @@ -361,13 +361,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface @override S3CopyOperation copy({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, + required StoragePath source, + required StoragePath destination, StorageCopyOptions? options, }) { - final s3Source = S3ItemWithAccessLevel.from(source); - final s3Destination = S3ItemWithAccessLevel.from(destination); - final s3PluginOptions = reifyPluginOptions( pluginOptions: options?.pluginOptions, defaultPluginOptions: const S3CopyPluginOptions(), @@ -379,45 +376,13 @@ class AmplifyStorageS3Dart extends StoragePluginInterface return S3CopyOperation( request: StorageCopyRequest( - source: s3Source, - destination: s3Destination, + source: source, + destination: destination, options: options, ), result: storageS3Service.copy( - source: s3Source, - destination: s3Destination, - options: s3Options, - ), - ); - } - - @override - S3MoveOperation move({ - required StorageItemWithAccessLevel source, - required StorageItemWithAccessLevel destination, - StorageMoveOptions? options, - }) { - final s3PluginOptions = reifyPluginOptions( - pluginOptions: options?.pluginOptions, - defaultPluginOptions: const S3MovePluginOptions(), - ); - - final s3Options = StorageMoveOptions( - pluginOptions: s3PluginOptions, - ); - - final s3Source = S3ItemWithAccessLevel.from(source); - final s3Destination = S3ItemWithAccessLevel.from(destination); - - return S3MoveOperation( - request: StorageMoveRequest( - source: s3Source, - destination: s3Destination, - options: options, - ), - result: storageS3Service.move( - source: s3Source, - destination: s3Destination, + source: source, + destination: destination, options: s3Options, ), ); diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart index ca27ac97c1..016e69d891 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart @@ -422,36 +422,21 @@ class StorageS3Service { /// /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} Future copy({ - required S3ItemWithAccessLevel source, - required S3ItemWithAccessLevel destination, + required StoragePath source, + required StoragePath destination, required StorageCopyOptions options, }) async { final s3PluginOptions = options.pluginOptions as S3CopyPluginOptions? ?? const S3CopyPluginOptions(); - final resolvedPrefixes = await Future.wait([ - getResolvedPrefix( - prefixResolver: _prefixResolver, - logger: _logger, - accessLevel: source.accessLevel, - identityId: source.targetIdentityId, - ), - getResolvedPrefix( - prefixResolver: _prefixResolver, - logger: _logger, - accessLevel: destination.accessLevel, - identityId: destination.targetIdentityId, - ), - ]); - final sourceKey = '${resolvedPrefixes[0]}${source.storageItem.key}'; - final destinationKey = - '${resolvedPrefixes[1]}${destination.storageItem.key}'; + final sourcePath = await _pathResolver.resolvePath(path: source); + final destinationPath = await _pathResolver.resolvePath(path: destination); final copyRequest = s3.CopyObjectRequest.build((builder) { builder ..bucket = _s3PluginConfig.bucket - ..copySource = '${_s3PluginConfig.bucket}/$sourceKey' - ..key = destinationKey + ..copySource = '${_s3PluginConfig.bucket}$sourcePath' + ..key = destinationPath ..metadataDirective = s3.MetadataDirective.copy; }); @@ -470,91 +455,16 @@ class StorageS3Service { await headObject( s3client: _defaultS3Client, bucket: _s3PluginConfig.bucket, - key: destinationKey, + key: destinationPath, ), - key: destination.storageItem.key, - path: destination.storageItem.path, + path: sourcePath, ) : S3Item( - key: destination.storageItem.key, - path: destination.storageItem.path, + path: destinationPath, ), ); } - /// Takes in input from [AmplifyStorageS3Dart.move] API to compose a - /// [s3.CopyObjectRequest] and send to S3 service to copy `source` to - /// `destination`, followed by a [s3.DeleteObjectRequest] to delete the - /// `source`, then returns a [S3MoveResult] based on the `key` of - /// `destination`. - /// - /// When [S3CopyPluginOptions.getProperties] is set to `true`, when both - /// [s3.CopyObjectRequest] and [s3.DeleteObjectRequest] succeed, the API - /// creates a [s3.HeadObjectRequest] with the `key` of the `destination`, - /// and sends to S3 Service, then returns a [S3CopyResult] based on - /// the [s3.HeadObjectOutput] returned by [s3.S3Client.headObject] API. - /// - /// {@macro storage.s3_service.throw_exception_unknown_smithy_exception} - Future move({ - required S3ItemWithAccessLevel source, - required S3ItemWithAccessLevel destination, - required StorageMoveOptions options, - }) async { - final s3PluginOptions = options.pluginOptions as S3MovePluginOptions? ?? - const S3MovePluginOptions(); - - late S3CopyResult copyResult; - - try { - copyResult = await copy( - source: source, - destination: destination, - options: StorageCopyOptions( - pluginOptions: options.pluginOptions != null - ? S3CopyPluginOptions( - getProperties: s3PluginOptions.getProperties, - ) - : const S3CopyPluginOptions(), - ), - ); - } on StorageException catch (error) { - // Normally copy should not fail during moving, if it fails it's a - // "unknown" failure wrapping the underlying exception. - throw UnknownException( - 'Copying the source object failed during the move operation.', - recoverySuggestion: 'Review the underlying exception.', - underlyingException: error, - ); - } - - final resolvedSourcePrefix = await getResolvedPrefix( - prefixResolver: _prefixResolver, - logger: _logger, - accessLevel: source.accessLevel, - identityId: source.targetIdentityId, - ); - - final keyToRemove = '$resolvedSourcePrefix${source.storageItem.key}'; - - try { - await _deleteObject( - s3client: _defaultS3Client, - bucket: _s3PluginConfig.bucket, - key: keyToRemove, - ); - } on StorageException catch (error) { - // Normally delete should not fail during moving, if it fails it's a - // "unknown" failure wrapping the underlying exception. - throw UnknownException( - 'Deleting the source object failed during the move operation.', - recoverySuggestion: 'Review the underlying exception.', - underlyingException: error, - ); - } - - return S3MoveResult(movedItem: copyResult.copiedItem); - } - /// Takes in input from [AmplifyStorageS3Dart.remove] API to compose a /// [s3.DeleteObjectRequest] and send to S3 service, then returns a /// [S3RemoveResult] based on the `key` to be removed. diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 1aae149da3..fb54c13336 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -10,6 +10,7 @@ import 'package:test/test.dart'; import 'test_utils/mocks.dart'; import 'test_utils/test_custom_prefix_resolver.dart'; +import 'test_utils/test_path_resolver.dart'; import 'test_utils/test_token_provider.dart'; const testPath = StoragePath.fromString('/some/path.txt'); @@ -917,26 +918,19 @@ void main() { }); group('copy() API', () { - const sourceKey = 'source-key'; - const destinationKey = 'destination-key'; - - const testSource = StorageItemWithAccessLevel( - storageItem: StorageItem(key: sourceKey), - accessLevel: StorageAccessLevel.guest, - ); - const testDestination = StorageItemWithAccessLevel( - storageItem: StorageItem(key: destinationKey), - accessLevel: StorageAccessLevel.protected, + const testSource = StoragePath.fromString('/public/source-key'); + final testDestination = StoragePath.withIdentityId( + (identityId) => '/protected/$identityId/destination-key', ); - final testResult = S3CopyResult(copiedItem: S3Item(key: destinationKey)); + final testResult = S3CopyResult( + copiedItem: S3Item(path: TestPathResolver.path), + ); setUpAll(() { registerFallbackValue(const StorageCopyOptions()); registerFallbackValue( - S3ItemWithAccessLevel( - storageItem: S3Item(key: 'some-key'), - ), + const StoragePath.fromString('/public/source-key'), ); }); @@ -961,9 +955,8 @@ void main() { final captured = verify( () => storageS3Service.copy( - source: captureAny(named: 'source'), - destination: - captureAny(named: 'destination'), + source: captureAny(named: 'source'), + destination: captureAny(named: 'destination'), options: captureAny( named: 'options', ), @@ -973,34 +966,8 @@ void main() { final capturedDestination = captured[1]; final capturedOptions = captured[2]; - expect( - capturedSource, - isA() - .having( - (i) => i.accessLevel, - 'accessLevel', - testSource.accessLevel, - ) - .having( - (i) => i.storageItem.key, - 'key', - testSource.storageItem.key, - ), - ); - expect( - capturedDestination, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - testDestination.accessLevel, - ) - .having( - (i) => i.storageItem.key, - 'key', - testDestination.storageItem.key, - ), - ); + expect(capturedSource, testSource); + expect(capturedDestination, testDestination); expect( capturedOptions, @@ -1022,102 +989,6 @@ void main() { }); }); - group('move() API', () { - const sourceKey = 'source-key'; - const destinationKey = 'destination-key'; - - const testSource = StorageItemWithAccessLevel( - storageItem: StorageItem(key: sourceKey), - accessLevel: StorageAccessLevel.guest, - ); - - const testDestination = StorageItemWithAccessLevel( - storageItem: StorageItem(key: destinationKey), - accessLevel: StorageAccessLevel.protected, - ); - - final testResult = S3MoveResult(movedItem: S3Item(key: destinationKey)); - - setUpAll(() { - registerFallbackValue(const StorageMoveOptions()); - registerFallbackValue( - S3ItemWithAccessLevel( - storageItem: S3Item(key: 'some-key'), - ), - ); - }); - - test( - 'should forward options with default getProperties value to StorageS3Service.move() API', - () async { - when( - () => storageS3Service.move( - source: any(named: 'source'), - destination: any(named: 'destination'), - options: any(named: 'options'), - ), - ).thenAnswer((_) async => testResult); - - final moveOperation = storageS3Plugin.move( - source: testSource, - destination: testDestination, - ); - - final captured = verify( - () => storageS3Service.move( - source: captureAny(named: 'source'), - destination: - captureAny(named: 'destination'), - options: captureAny( - named: 'options', - ), - ), - ).captured; - final capturedSource = captured[0]; - final capturedDestination = captured[1]; - final capturedOptions = captured[2]; - expect( - capturedSource, - isA() - .having( - (i) => i.accessLevel, - 'accessLevel', - testSource.accessLevel, - ) - .having( - (i) => i.storageItem.key, - 'key', - testSource.storageItem.key, - ), - ); - expect( - capturedDestination, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - testDestination.accessLevel, - ) - .having( - (i) => i.storageItem.key, - 'key', - testDestination.storageItem.key, - ), - ); - expect( - capturedOptions, - isA().having( - (o) => (o.pluginOptions! as S3MovePluginOptions).getProperties, - 'getProperties', - false, - ), - ); - - final result = await moveOperation.result; - expect(result, testResult); - }); - }); - group('remove() API', () { const testKey = 'object-to-remove'; final testResult = S3RemoveResult( diff --git a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart index 6d8f1164ae..547ed4ed16 100644 --- a/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart @@ -930,11 +930,8 @@ void main() { group('copy() API', () { late S3CopyResult copyResult; - final testSourceItem = S3Item(key: 'source'); - final testDestinationItem = S3Item(key: 'destination'); - final testSource = S3ItemWithAccessLevel(storageItem: testSourceItem); - final testDestination = - S3ItemWithAccessLevel(storageItem: testDestinationItem); + const testSource = StoragePath.fromString('/public/source'); + const testDestination = StoragePath.fromString('/public/destination'); setUpAll(() { registerFallbackValue( @@ -980,16 +977,11 @@ void main() { final request = capturedRequest as CopyObjectRequest; expect(request.bucket, testBucket); - expect( - request.copySource, - '$testBucket/${await testPrefixResolver.resolvePrefix( - accessLevel: testSource.accessLevel, - )}${testSourceItem.key}', - ); + expect(request.copySource, testBucket + TestPathResolver.path); }); test('should return correct S3CopyResult', () { - expect(copyResult.copiedItem.key, testDestination.storageItem.key); + expect(copyResult.copiedItem.path, TestPathResolver.path); }); test( @@ -1081,268 +1073,7 @@ void main() { final request = headObjectRequest as HeadObjectRequest; expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testDestination.accessLevel, - )}${testDestinationItem.key}', - ); - }); - }); - - group('move() API', () { - late S3MoveResult moveResult; - final testSourceItem = S3Item(key: 'source'); - final testDestinationItem = S3Item(key: 'destination'); - final testSource = S3ItemWithAccessLevel(storageItem: testSourceItem); - final testDestination = - S3ItemWithAccessLevel(storageItem: testDestinationItem); - - setUpAll(() { - registerFallbackValue( - CopyObjectRequest( - bucket: 'fake bucket', - copySource: 'dummy source', - key: 'imposing destination', - ), - ); - registerFallbackValue( - DeleteObjectRequest( - bucket: 'fake bucket', - key: 'dummy key', - ), - ); - registerFallbackValue( - HeadObjectRequest( - bucket: 'fake bucket', - key: 'dummy key', - ), - ); - }); - - test( - 'should invoke S3Client.copyObject and S3Client.deleteObject with expected parameters', - () async { - const testOptions = StorageMoveOptions(); - final testCopyObjectOutput = CopyObjectOutput(); - final testDeleteObjectOutput = DeleteObjectOutput(); - final copySmithyOperation = MockSmithyOperation(); - final deleteSmithyOperation = MockSmithyOperation(); - when( - () => copySmithyOperation.result, - ).thenAnswer((_) async => testCopyObjectOutput); - - when( - () => deleteSmithyOperation.result, - ).thenAnswer((_) async => testDeleteObjectOutput); - - when( - () => s3Client.copyObject(any()), - ).thenAnswer((_) => copySmithyOperation); - - when( - () => s3Client.deleteObject(any()), - ).thenAnswer((_) => deleteSmithyOperation); - - moveResult = await storageS3Service.move( - source: testSource, - destination: testDestination, - options: testOptions, - ); - - final capturedCopyRequest = verify( - () => s3Client.copyObject(captureAny()), - ).captured.last; - - final capturedDeleteRequest = verify( - () => s3Client.deleteObject(captureAny()), - ).captured.last; - - expect(capturedCopyRequest is CopyObjectRequest, isTrue); - final copyRequest = capturedCopyRequest as CopyObjectRequest; - - expect(capturedDeleteRequest is DeleteObjectRequest, isTrue); - final deleteRequest = capturedDeleteRequest as DeleteObjectRequest; - - expect(copyRequest.bucket, testBucket); - expect( - copyRequest.copySource, - '$testBucket/${await testPrefixResolver.resolvePrefix( - accessLevel: testSource.accessLevel, - )}${testSourceItem.key}', - ); - - expect(deleteRequest.bucket, testBucket); - expect( - deleteRequest.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testSource.accessLevel, - )}${testSourceItem.key}', - ); - }); - - test('should return correct S3CopyResult', () { - expect(moveResult.movedItem.key, testDestination.storageItem.key); - }); - - test( - 'should throw StorageAccessDeniedException when UnknownSmithyHttpException' - ' with status code 403 returned from service while copying the source', - () async { - const testOptions = StorageMoveOptions(); - const testUnknownException = UnknownSmithyHttpException( - statusCode: 403, - body: 'Access denied.', - ); - - when( - () => s3Client.copyObject( - any(), - ), - ).thenThrow(testUnknownException); - - expect( - storageS3Service.move( - source: testSource, - destination: testDestination, - options: testOptions, - ), - throwsA( - isA().having( - (o) => o.underlyingException, - 'underlyingException', - isA(), - ), - ), - ); - }); - - test('should handle AWSHttpException and throw NetworkException', - () async { - const testOptions = StorageMoveOptions(); - final testException = AWSHttpException( - AWSHttpRequest(method: AWSHttpMethod.put, uri: Uri()), - ); - - when( - () => s3Client.copyObject(any()), - ).thenThrow(testException); - - expect( - storageS3Service.move( - source: testSource, - destination: testDestination, - options: testOptions, - ), - throwsA( - isA().having( - (o) => o.underlyingException, - 'underlyingException', - isA(), - ), - ), - ); - }); - - test( - 'should throw StorageHttpStatusException when UnknownSmithyHttpException' - ' with status code 500 returned from service while deleting the source', - () async { - const testOptions = StorageMoveOptions(); - const testUnknownException = UnknownSmithyHttpException( - statusCode: 500, - body: 'Internal error', - ); - final testCopyObjectOutput = CopyObjectOutput(); - final smithyOperation = MockSmithyOperation(); - - when( - () => smithyOperation.result, - ).thenAnswer((_) async => testCopyObjectOutput); - - when( - () => s3Client.copyObject(any()), - ).thenAnswer((_) => smithyOperation); - - when( - () => s3Client.deleteObject( - any(), - ), - ).thenThrow(testUnknownException); - - expect( - storageS3Service.move( - source: testSource, - destination: testDestination, - options: testOptions, - ), - throwsA( - isA().having( - (o) => o.underlyingException, - 'underlyingException', - isA(), - ), - ), - ); - }); - - test( - 'should invoke S3Client.headObject with correct parameters when' - ' getProperties option is set to true', () async { - const testOptions = StorageMoveOptions( - pluginOptions: S3MovePluginOptions(getProperties: true), - ); - final testCopyObjectOutput = CopyObjectOutput(); - final testDeleteObjectOutput = DeleteObjectOutput(); - final testHeadObjectOutput = HeadObjectOutput(); - final copySmithyOperation = MockSmithyOperation(); - final deleteSmithyOperation = MockSmithyOperation(); - final headSmithyOperation = MockSmithyOperation(); - - when( - () => copySmithyOperation.result, - ).thenAnswer((_) async => testCopyObjectOutput); - - when( - () => deleteSmithyOperation.result, - ).thenAnswer((_) async => testDeleteObjectOutput); - - when( - () => headSmithyOperation.result, - ).thenAnswer((_) async => testHeadObjectOutput); - - when( - () => s3Client.copyObject(any()), - ).thenAnswer((_) => copySmithyOperation); - - when( - () => s3Client.deleteObject(any()), - ).thenAnswer((_) => deleteSmithyOperation); - - when( - () => s3Client.headObject(any()), - ).thenAnswer((_) => headSmithyOperation); - - await storageS3Service.move( - source: testSource, - destination: testDestination, - options: testOptions, - ); - - final headObjectRequest = verify( - () => s3Client.headObject(captureAny()), - ).captured.last; - - expect(headObjectRequest is HeadObjectRequest, isTrue); - final request = headObjectRequest as HeadObjectRequest; - - expect(request.bucket, testBucket); - expect( - request.key, - '${await testPrefixResolver.resolvePrefix( - accessLevel: testDestination.accessLevel, - )}${testDestinationItem.key}', - ); + expect(request.key, TestPathResolver.path); }); }); From e54c54990d563b1ec068a9867a921890646a431c Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 15 Mar 2024 14:38:15 -0700 Subject: [PATCH 36/46] chore: update download apis to use path --- .../example/integration_test/use_case_test.dart | 4 ++++ .../test/amplify_storage_s3_dart_test.dart | 2 ++ 2 files changed, 6 insertions(+) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 2f869081c3..78ee1284d5 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -320,6 +320,7 @@ void main() { }); testWidgets( + // skip: true, // skip: true, 'download object as bytes data in memory with access level private' ' for the currently signed in user', (WidgetTester tester) async { @@ -339,6 +340,7 @@ void main() { }); testWidgets( + // skip: true, // skip: true, 'download a range of bytes of an object with access level private' ' for the currently signed in user', (WidgetTester tester) async { @@ -368,6 +370,7 @@ void main() { }); testWidgets( + // skip: true, // skip: true, 'download file with access level private for the currently signed in user', (WidgetTester tester) async { @@ -621,6 +624,7 @@ void main() { }); testWidgets( + // skip: true, // skip: true, 'download data of object with access level protected and a target' ' identity id for the currently signed user', diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index fb54c13336..1ac6a15151 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -463,6 +463,7 @@ void main() { when( () => storageS3Service.downloadData( + path: const StoragePath.fromString('/public/$testKey'), path: const StoragePath.fromString('/public/$testKey'), options: defaultOptions, preStart: any(named: 'preStart'), @@ -476,6 +477,7 @@ void main() { downloadDataOperation = storageS3Plugin.downloadData( path: const StoragePath.fromString('/public/$testKey'), + path: const StoragePath.fromString('/public/$testKey'), ); final capturedOptions = verify( From 304da8c042c848fe31555cd0d736e06845e1e41f Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 22 Mar 2024 14:36:55 -0700 Subject: [PATCH 37/46] chore: remove duplicate code from rebase --- .../test/amplify_storage_s3_dart_test.dart | 2 -- 1 file changed, 2 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index 1ac6a15151..fb54c13336 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -463,7 +463,6 @@ void main() { when( () => storageS3Service.downloadData( - path: const StoragePath.fromString('/public/$testKey'), path: const StoragePath.fromString('/public/$testKey'), options: defaultOptions, preStart: any(named: 'preStart'), @@ -477,7 +476,6 @@ void main() { downloadDataOperation = storageS3Plugin.downloadData( path: const StoragePath.fromString('/public/$testKey'), - path: const StoragePath.fromString('/public/$testKey'), ); final capturedOptions = verify( From 761c4948e810a45c2ed32517d014a38048b2932c Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 22 Mar 2024 15:20:25 -0700 Subject: [PATCH 38/46] chore: removed random text file --- packages/storage/amplify_storage_s3_dart/test.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 packages/storage/amplify_storage_s3_dart/test.txt diff --git a/packages/storage/amplify_storage_s3_dart/test.txt b/packages/storage/amplify_storage_s3_dart/test.txt deleted file mode 100644 index 7621d40cf6..0000000000 --- a/packages/storage/amplify_storage_s3_dart/test.txt +++ /dev/null @@ -1 +0,0 @@ -你好世界！ \ No newline at end of file From df3fe462db087dea21d4e76f98928e7011a54f13 Mon Sep 17 00:00:00 2001 From: Kha Truong <64438356+khatruong2009@users.noreply.github.com> Date: Fri, 22 Mar 2024 15:36:46 -0700 Subject: [PATCH 39/46] chore: remove commented code --- .../example/integration_test/use_case_test.dart | 5 ----- .../storage/amplify_storage_s3_dart/example/bin/example.dart | 2 -- 2 files changed, 7 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 2f869081c3..69331113d7 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -320,7 +320,6 @@ void main() { }); testWidgets( - // skip: true, 'download object as bytes data in memory with access level private' ' for the currently signed in user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( @@ -339,7 +338,6 @@ void main() { }); testWidgets( - // skip: true, 'download a range of bytes of an object with access level private' ' for the currently signed in user', (WidgetTester tester) async { const start = 5 * 1024; @@ -368,7 +366,6 @@ void main() { }); testWidgets( - // skip: true, 'download file with access level private for the currently signed in user', (WidgetTester tester) async { final s3Plugin = @@ -621,7 +618,6 @@ void main() { }); testWidgets( - // skip: true, 'download data of object with access level protected and a target' ' identity id for the currently signed user', (WidgetTester tester) async { @@ -641,7 +637,6 @@ void main() { }); testWidgets( - // skip: true, 'download data of object (belongs to other user) with access level' ' private for the currently signed user', (WidgetTester tester) async { diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart index e0d2013dd7..693c9412c2 100644 --- a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart +++ b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart @@ -207,7 +207,6 @@ Future downloadDataOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final downloadDataOperation = s3Plugin.downloadData( - // key: key, path: StoragePath.fromString(key), options: StorageDownloadDataOptions( accessLevel: accessLevel, @@ -252,7 +251,6 @@ Future downloadFileOperation() async { final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey); final downloadFileOperation = s3Plugin.downloadFile( - // key: key, path: StoragePath.fromString(key), localFile: localFile, options: StorageDownloadFileOptions( From a5c93a496b18b2d1a238dea9eee1b2b9cd5772c3 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Sun, 24 Mar 2024 15:02:26 -0400 Subject: [PATCH 40/46] chore: fix failing tests --- .../test/amplify_storage_s3_dart_test.dart | 15 ++++++----- .../platform_impl/download_file_io_test.dart | 27 ++++++++++++------- .../test/test_utils/mocks.dart | 25 ++--------------- 3 files changed, 28 insertions(+), 39 deletions(-) diff --git a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart index fb54c13336..912d126526 100644 --- a/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart @@ -2,6 +2,7 @@ // SPDX-License-Identifier: Apache-2.0 import 'package:amplify_core/amplify_core.dart'; +import 'package:amplify_core/src/types/storage/storage_path_with_identity_id.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/prefix_resolver/storage_access_level_aware_prefix_resolver.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; @@ -452,6 +453,12 @@ void main() { registerFallbackValue( const StorageDownloadDataOptions(), ); + registerFallbackValue(const StoragePath.fromString('/public/$testKey')); + registerFallbackValue( + StoragePathWithIdentityId( + (identityId) => '/private/$identityId/$testKey', + ), + ); }); test( @@ -512,9 +519,7 @@ void main() { when( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey', - ), + path: any(named: 'path'), options: any(named: 'options'), onData: any(named: 'onData'), ), @@ -531,9 +536,7 @@ void main() { final capturedOptions = verify( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey', - ), + path: any(named: 'path'), onData: any(named: 'onData'), options: captureAny( named: 'options', diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart index 61afda43bd..401ff48f81 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart @@ -8,6 +8,7 @@ import 'dart:convert'; import 'dart:io'; import 'package:amplify_core/amplify_core.dart'; +import 'package:amplify_core/src/types/storage/storage_path_with_identity_id.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/platform_impl/download_file/download_file.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; @@ -45,10 +46,16 @@ void main() { registerFallbackValue( const StorageDownloadDataOptions(), ); + registerFallbackValue(const StoragePath.fromString('/public/$testKey')); + registerFallbackValue( + StoragePathWithIdentityId( + (identityId) => '/private/$identityId/$testKey', + ), + ); when( () => storageS3Service.downloadData( - path: const StoragePath.fromString('/public/$testKey'), + path: any(named: 'path'), options: any(named: 'options'), preStart: any(named: 'preStart'), onProgress: any(named: 'onProgress'), @@ -86,9 +93,7 @@ void main() { final captureParams = verify( () => storageS3Service.downloadData( - path: StoragePath.withIdentityId( - (identityId) => '/private/$identityId/$testKey', - ), + path: captureAny(named: 'path'), options: captureAny( named: 'options', ), @@ -102,8 +107,10 @@ void main() { ), ).captured; + final capturedOptions = captureParams[1]; + expect( - captureParams[0], + capturedOptions, isA() .having( (o) => o.accessLevel, @@ -118,14 +125,14 @@ void main() { ), ); - expect(captureParams[1] is Function, true); - preStart = captureParams[1] as FutureOr Function(); expect(captureParams[2] is Function, true); - onProgress = captureParams[2] as void Function(S3TransferProgress); + preStart = captureParams[2] as FutureOr Function(); expect(captureParams[3] is Function, true); - onData = captureParams[3] as void Function(List); + onProgress = captureParams[3] as void Function(S3TransferProgress); expect(captureParams[4] is Function, true); - onDone = captureParams[4] as FutureOr Function(); + onData = captureParams[4] as void Function(List); + expect(captureParams[5] is Function, true); + onDone = captureParams[5] as FutureOr Function(); final result = await downloadFileOperation.result; expect(result.downloadedItem, testItem); diff --git a/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart b/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart index 6f7d7d9af7..1136704cde 100644 --- a/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart +++ b/packages/storage/amplify_storage_s3_dart/test/test_utils/mocks.dart @@ -1,10 +1,7 @@ // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 -import 'dart:async'; - import 'package:amplify_core/amplify_core.dart'; -import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/sdk/s3.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/transfer/transfer.dart'; @@ -12,20 +9,7 @@ import 'package:aws_signature_v4/aws_signature_v4.dart'; import 'package:mocktail/mocktail.dart'; import 'package:smithy/smithy.dart'; -class MockStorageS3Service extends Mock implements StorageS3Service { - @override - S3DownloadTask downloadData({ - required StoragePath path, - required StorageDownloadDataOptions options, - FutureOr Function()? preStart, - void Function(S3TransferProgress)? onProgress, - void Function(List)? onData, - FutureOr Function()? onDone, - FutureOr Function()? onError, - }) { - return MockS3DownloadTask(); - } -} +class MockStorageS3Service extends Mock implements StorageS3Service {} class MockS3Client extends Mock implements S3Client {} @@ -36,12 +20,7 @@ class MockAWSLogger extends Mock implements AWSLogger { class MockAWSSigV4Signer extends Mock implements AWSSigV4Signer {} -class MockS3DownloadTask extends Mock implements S3DownloadTask { - @override - Future get result async => MockS3Item(); -} - -class MockS3Item extends Mock implements S3Item {} +class MockS3DownloadTask extends Mock implements S3DownloadTask {} class MockS3UploadTask extends Mock implements S3UploadTask {} From 90f873a79926de4f5537f66c0904e9b0a7eac608 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Sun, 24 Mar 2024 15:42:09 -0400 Subject: [PATCH 41/46] chore: update options, tests --- .../types/storage/download_file_options.dart | 4 +- .../example/bin/example.dart | 4 - .../src/model/s3_download_file_options.dart | 4 - .../s3_download_file_plugin_options.dart | 22 --- .../download_file/download_file_html.dart | 48 +++---- .../download_file/download_file_io.dart | 15 +-- .../download_file_html_test.dart | 65 ++------- .../platform_impl/download_file_io_test.dart | 127 +----------------- 8 files changed, 38 insertions(+), 251 deletions(-) diff --git a/packages/amplify_core/lib/src/types/storage/download_file_options.dart b/packages/amplify_core/lib/src/types/storage/download_file_options.dart index 7153e701df..bb131f4e53 100644 --- a/packages/amplify_core/lib/src/types/storage/download_file_options.dart +++ b/packages/amplify_core/lib/src/types/storage/download_file_options.dart @@ -14,7 +14,6 @@ class StorageDownloadFileOptions extends StorageOperationOptions AWSDebuggable { /// {@macro amplify_core.storage.download_file_options} const StorageDownloadFileOptions({ - super.accessLevel, this.pluginOptions, }); @@ -22,14 +21,13 @@ class StorageDownloadFileOptions extends StorageOperationOptions final StorageDownloadFilePluginOptions? pluginOptions; @override - List get props => [accessLevel, pluginOptions]; + List get props => [pluginOptions]; @override String get runtimeTypeName => 'StorageDownloadFileOptions'; @override Map toJson() => { - 'accessLevel': accessLevel?.name, 'pluginOptions': pluginOptions?.toJson(), }; } diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart index 693c9412c2..ca18ef86f8 100644 --- a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart +++ b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart @@ -239,9 +239,6 @@ Future downloadDataOperation() async { Future downloadFileOperation() async { final key = prompt('Enter the key of the object to download: '); - final accessLevel = promptStorageAccessLevel( - 'Choose the storage access level associated with the object: ', - ); final destinationPath = prompt( 'Enter the destination file path (ensure the file path is writable): ', ); @@ -254,7 +251,6 @@ Future downloadFileOperation() async { path: StoragePath.fromString(key), localFile: localFile, options: StorageDownloadFileOptions( - accessLevel: accessLevel, pluginOptions: S3DownloadFilePluginOptions( getProperties: true, useAccelerateEndpoint: useAccelerateEndpoint, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart index 8cc40ca3be..6ac2a103db 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart @@ -15,11 +15,9 @@ class S3DownloadFileOptions extends StorageDownloadFileOptions { 'use StorageDownloadFileOptions(pluginOptions:S3DownloadFilePluginOptions(...)) instead.', ) const S3DownloadFileOptions({ - StorageAccessLevel accessLevel = StorageAccessLevel.guest, bool getProperties = false, bool useAccelerateEndpoint = false, }) : this._( - accessLevel: accessLevel, getProperties: getProperties, useAccelerateEndpoint: useAccelerateEndpoint, ); @@ -28,7 +26,6 @@ class S3DownloadFileOptions extends StorageDownloadFileOptions { 'use StorageDownloadFileOptions(pluginOptions:S3DownloadFilePluginOptions(...)) instead.', ) const S3DownloadFileOptions._({ - super.accessLevel = StorageAccessLevel.guest, this.getProperties = false, this.targetIdentityId, this.useAccelerateEndpoint = false, @@ -47,7 +44,6 @@ class S3DownloadFileOptions extends StorageDownloadFileOptions { bool getProperties = false, bool useAccelerateEndpoint = false, }) : this._( - accessLevel: StorageAccessLevel.protected, targetIdentityId: targetIdentityId, getProperties: getProperties, useAccelerateEndpoint: useAccelerateEndpoint, diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_plugin_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_plugin_options.dart index fad767b307..43d159d297 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_plugin_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_plugin_options.dart @@ -21,34 +21,13 @@ class S3DownloadFilePluginOptions extends StorageDownloadFilePluginOptions { const S3DownloadFilePluginOptions._({ this.getProperties = false, - this.targetIdentityId, this.useAccelerateEndpoint = false, }); - /// {@macro storage.amplify_storage_s3.download_file_plugin_options} - /// - /// Use this when calling `downloadFile` on an object that belongs to other - /// user (identified by [targetIdentityId]) rather than the currently signed - /// user. - const S3DownloadFilePluginOptions.forIdentity( - String targetIdentityId, { - bool getProperties = false, - bool useAccelerateEndpoint = false, - }) : this._( - targetIdentityId: targetIdentityId, - getProperties: getProperties, - useAccelerateEndpoint: useAccelerateEndpoint, - ); - /// {@macro storage.amplify_storage_s3.download_file_plugin_options} factory S3DownloadFilePluginOptions.fromJson(Map json) => _$S3DownloadFilePluginOptionsFromJson(json); - /// The identity ID of the user who uploaded the object. - /// - /// This can be set by using [S3DownloadFilePluginOptions.forIdentity]. - final String? targetIdentityId; - /// Whether to retrieve properties for the downloaded object using the /// `getProperties` API. final bool getProperties; @@ -60,7 +39,6 @@ class S3DownloadFilePluginOptions extends StorageDownloadFilePluginOptions { List get props => [ getProperties, useAccelerateEndpoint, - targetIdentityId, ]; @override diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart index 2632207195..7c3801c82b 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart @@ -8,7 +8,7 @@ import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_servic /// The html implementation of `downloadFile` API. S3DownloadFileOperation downloadFile({ - required String key, + required StoragePath path, required AWSFile localFile, required StorageDownloadFileOptions options, required S3PluginConfig s3pluginConfig, @@ -20,13 +20,12 @@ S3DownloadFileOperation downloadFile({ return S3DownloadFileOperation( request: StorageDownloadFileRequest( - // TODO(khatruong2009): update to use path from customer - path: StoragePath.fromString(key), + path: path, localFile: localFile, options: options, ), result: _downloadFromUrl( - key: key, + path: path, localFile: localFile, options: options, s3pluginConfig: s3pluginConfig, @@ -41,14 +40,13 @@ S3DownloadFileOperation downloadFile({ } Future _downloadFromUrl({ - required String key, + required StoragePath path, required AWSFile localFile, required StorageDownloadFileOptions options, required S3PluginConfig s3pluginConfig, required StorageS3Service storageS3Service, }) async { - final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions; - final targetIdentityId = s3PluginOptions.targetIdentityId; + final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions?; // Calling the `getProperties` by default to verify the existence of the object // before downloading from the presigned URL, as the 404 or 403 should be // handled by the plugin but not be thrown to an end user in browser. @@ -57,17 +55,8 @@ Future _downloadFromUrl({ // Exception thrown from the getProperties will be thrown as download // operation. final downloadedItem = (await storageS3Service.getProperties( - // TODO(Jordan-Nelson): update to use path from customer - path: StoragePath.fromString(key), - options: targetIdentityId == null - ? StorageGetPropertiesOptions( - accessLevel: options.accessLevel, - ) - : StorageGetPropertiesOptions( - accessLevel: options.accessLevel, - pluginOptions: - S3GetPropertiesPluginOptions.forIdentity(targetIdentityId), - ), + path: path, + options: const StorageGetPropertiesOptions(), )) .storageItem; @@ -75,20 +64,14 @@ Future _downloadFromUrl({ // We are not setting validateObjectExistence to true here as we are not // able to directly get the result of underlying HeadObject result. final url = (await storageS3Service.getUrl( - // TODO(Jordan-Nelson): update to use path from customer - path: StoragePath.fromString(key), - options: targetIdentityId == null - ? StorageGetUrlOptions( - pluginOptions: S3GetUrlPluginOptions( + path: path, + options: StorageGetUrlOptions( + pluginOptions: s3PluginOptions == null + ? null + : S3GetUrlPluginOptions( useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, ), - ) - : StorageGetUrlOptions( - pluginOptions: S3GetUrlPluginOptions.forIdentity( - targetIdentityId, - useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, - ), - ), + ), )) .url; @@ -101,8 +84,9 @@ Future _downloadFromUrl({ ); return S3DownloadFileResult( - downloadedItem: - s3PluginOptions.getProperties ? downloadedItem : S3Item(key: key), + downloadedItem: s3PluginOptions != null && s3PluginOptions.getProperties + ? downloadedItem + : S3Item(key: downloadedItem.key), localFile: localFile, ); } diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart index cb5dfcc0a4..95853fb72f 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart @@ -24,18 +24,11 @@ S3DownloadFileOperation downloadFile({ late final File tempFile; final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions; - final targetIdentityId = s3PluginOptions.targetIdentityId; final downloadDataOptions = StorageDownloadDataOptions( - pluginOptions: targetIdentityId == null - ? S3DownloadDataPluginOptions( - getProperties: s3PluginOptions.getProperties, - useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, - ) - : S3DownloadDataPluginOptions.forIdentity( - targetIdentityId, - getProperties: s3PluginOptions.getProperties, - useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, - ), + pluginOptions: S3DownloadDataPluginOptions( + getProperties: s3PluginOptions.getProperties, + useAccelerateEndpoint: s3PluginOptions.useAccelerateEndpoint, + ), ); final downloadDataTask = storageS3Service.downloadData( diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart index cfb3a2d7c2..7acc2ab210 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_html_test.dart @@ -27,9 +27,7 @@ class DummyPathProvider implements AppPathProvider { } void main() { - group('downloadFile() html implementation', - // TODO(Jordan-Nelson): remove skip - skip: true, () { + group('downloadFile() html implementation', () { late StorageS3Service storageS3Service; const testKey = 'upload-key.text'; const testS3pluginConfig = S3PluginConfig( @@ -65,23 +63,21 @@ void main() { ); registerFallbackValue( - StorageGetPropertiesOptions( - accessLevel: testS3pluginConfig.defaultAccessLevel, - ), + const StorageGetPropertiesOptions(), ); + registerFallbackValue(const StoragePath.fromString(testKey)); + when( () => storageS3Service.getProperties( - // TODO(Jordan-Nelson): update - path: const StoragePath.fromString('key'), + path: any(named: 'path'), options: any(named: 'options'), ), ).thenAnswer((_) async => testGetPropertiesResult); when( () => storageS3Service.getUrl( - // TODO(Jordan-Nelson): update - path: const StoragePath.fromString('key'), + path: any(named: 'path'), options: any(named: 'options'), ), ).thenAnswer((_) async => testGetUrlResult); @@ -90,72 +86,33 @@ void main() { test( 'should invoke StorageS3Service.getUrl with converted S3DownloadFilePluginOptions', () async { - const testTargetIdentity = 'someone-else'; final operation = downloadFile( path: const StoragePath.fromString('/public/$testKey'), localFile: AWSFile.fromPath('file_name.jpg'), - options: const StorageDownloadFileOptions( - pluginOptions: - S3DownloadFilePluginOptions.forIdentity(testTargetIdentity), - ), + options: const StorageDownloadFileOptions(), s3pluginConfig: testS3pluginConfig, storageS3Service: storageS3Service, appPathProvider: const DummyPathProvider(), ); await operation.result; - - final capturedGetPropertiesOptions = verify( + verify( () => storageS3Service.getProperties( - // TODO(Jordan-Nelson): update - path: const StoragePath.fromString('key'), + path: any(named: 'path'), options: captureAny( named: 'options', ), ), ).captured.last; - expect( - capturedGetPropertiesOptions, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - testS3pluginConfig.defaultAccessLevel, - ) - .having( - (o) => (o.pluginOptions! as S3GetPropertiesPluginOptions) - .targetIdentityId, - 'targetIdentityId', - testTargetIdentity, - ), - ); - - final capturedUrlOptions = verify( + verify( () => storageS3Service.getUrl( - // TODO(Jordan-Nelson): update - path: const StoragePath.fromString('key'), + path: any(named: 'path'), options: captureAny( named: 'options', ), ), ).captured.last; - - expect( - capturedUrlOptions, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - testS3pluginConfig.defaultAccessLevel, - ) - .having( - (o) => - (o.pluginOptions! as S3GetUrlPluginOptions).targetIdentityId, - 'targetIdentityId', - testTargetIdentity, - ), - ); }); test( diff --git a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart index 401ff48f81..90e9db235b 100644 --- a/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart +++ b/packages/storage/amplify_storage_s3_dart/test/platform_impl/download_file_io_test.dart @@ -111,18 +111,12 @@ void main() { expect( capturedOptions, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - options.accessLevel, - ) - .having( - (o) => (o.pluginOptions! as S3DownloadDataPluginOptions) - .getProperties, - 'getProperties', - isTrue, - ), + isA().having( + (o) => + (o.pluginOptions! as S3DownloadDataPluginOptions).getProperties, + 'getProperties', + isTrue, + ), ); expect(captureParams[2] is Function, true); @@ -163,115 +157,6 @@ void main() { await downloadedFile.delete(); }); - test( - skip: true, - 'should correctly create S3DownloadDataOptions with default storage access level', - () { - downloadFile( - path: const StoragePath.fromString('/public/$testKey'), - localFile: AWSFile.fromPath('path'), - options: const StorageDownloadFileOptions( - pluginOptions: S3DownloadFilePluginOptions(), - ), - s3pluginConfig: testS3pluginConfig, - storageS3Service: storageS3Service, - appPathProvider: appPathProvider, - onProgress: (progress) { - expectedProgress = progress; - }, - ); - - final capturedOptions = verify( - () => storageS3Service.downloadData( - path: const StoragePath.fromString('/public/$testKey'), - options: captureAny( - named: 'options', - ), - preStart: any(named: 'preStart'), - onProgress: any(named: 'onProgress'), - onData: any(named: 'onData'), - onDone: any(named: 'onDone'), - onError: any(named: 'onError'), - ), - ).captured.last; - - expect( - capturedOptions, - isA().having( - (o) => o.accessLevel, - 'accessLevel', - testS3pluginConfig.defaultAccessLevel, - ), - ); - }); - - test( - skip: true, - 'should correctly create S3DownloadDataOptions with correct targetIdentityId', - () { - const testTargetIdentity = 'someone-else'; - const testAccessLevel = StorageAccessLevel.protected; - downloadFile( - path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey', - ), - localFile: AWSFile.fromPath('path'), - options: const StorageDownloadFileOptions( - pluginOptions: S3DownloadFilePluginOptions.forIdentity( - testTargetIdentity, - ), - ), - s3pluginConfig: testS3pluginConfig, - storageS3Service: storageS3Service, - appPathProvider: appPathProvider, - onProgress: (progress) { - expectedProgress = progress; - }, - ); - - final capturedOptions = verify( - () => storageS3Service.downloadData( - path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testKey', - ), - options: captureAny( - named: 'options', - ), - preStart: any(named: 'preStart'), - onProgress: any(named: 'onProgress'), - onData: any(named: 'onData'), - onDone: any(named: 'onDone'), - onError: any(named: 'onError'), - ), - ).captured.last; - - expect( - capturedOptions, - isA() - .having( - (o) => o.accessLevel, - 'accessLevel', - testAccessLevel, - ) - .having( - (o) => (o.pluginOptions! as S3DownloadDataPluginOptions) - .targetIdentityId, - 'targetIdentityId', - testTargetIdentity, - ), - ); - - expect( - capturedOptions, - isA().having( - (o) => (o.pluginOptions! as S3DownloadDataPluginOptions) - .targetIdentityId, - 'targetIdentityId', - testTargetIdentity, - ), - ); - }); - group('preStart callback should throw exceptions', () { test( 'when destination path is null is throws StorageLocalFileNotFoundException', From 250df23761ed245cbf6f3ece87f037a12e3ea7f1 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Sun, 24 Mar 2024 16:17:44 -0400 Subject: [PATCH 42/46] chore: update options classes --- .../integration_test/use_case_test.dart | 5 ++-- .../src/model/s3_download_data_options.dart | 27 ------------------- .../s3_download_data_plugin_options.dart | 24 ----------------- .../src/model/s3_download_file_options.dart | 24 ----------------- 4 files changed, 2 insertions(+), 78 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 69331113d7..4dd60290c4 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -625,9 +625,8 @@ void main() { path: StoragePath.withIdentityId( (identityId) => '/protected/$identityId/$testObjectKey2', ), - options: StorageDownloadDataOptions( - pluginOptions: S3DownloadDataPluginOptions.forIdentity( - user1IdentityId, + options: const StorageDownloadDataOptions( + pluginOptions: S3DownloadDataPluginOptions( getProperties: true, ), ), diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_options.dart index 87e99bb7fc..291d12afca 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_options.dart @@ -33,39 +33,12 @@ class S3DownloadDataOptions extends StorageDownloadDataOptions { super.accessLevel = StorageAccessLevel.guest, this.getProperties = false, this.bytesRange, - this.targetIdentityId, this.useAccelerateEndpoint = false, }); - /// {@macro storage.amplify_storage_s3.download_data_options} - /// - /// Use this when calling `downloadData` on an object that belongs to another - /// user (identified by [targetIdentityId]) rather than the currently - /// signed-in user. - @Deprecated( - 'use StorageDownloadDataOptions(pluginOptions:S3DownloadDataPluginOptions(...)) instead.', - ) - const S3DownloadDataOptions.forIdentity( - String targetIdentityId, { - bool getProperties = false, - S3DataBytesRange? bytesRange, - bool useAccelerateEndpoint = false, - }) : this._( - accessLevel: StorageAccessLevel.protected, - targetIdentityId: targetIdentityId, - getProperties: getProperties, - bytesRange: bytesRange, - useAccelerateEndpoint: useAccelerateEndpoint, - ); - /// The byte range to download from the object. final S3DataBytesRange? bytesRange; - /// The identity ID of another user who uploaded the object. - /// - /// This can be set by using [S3DownloadDataOptions.forIdentity]. - final String? targetIdentityId; - /// Whether to retrieve properties for the downloaded object using the /// `getProperties` API. final bool getProperties; diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_plugin_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_plugin_options.dart index 526ebdb757..d86a188b36 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_plugin_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_data_plugin_options.dart @@ -25,27 +25,9 @@ class S3DownloadDataPluginOptions extends StorageDownloadDataPluginOptions { const S3DownloadDataPluginOptions._({ this.getProperties = false, this.bytesRange, - this.targetIdentityId, this.useAccelerateEndpoint = false, }); - /// {@macro storage.amplify_storage_s3.download_data_plugin_options} - /// - /// Use this when calling `downloadData` on an object that belongs to another - /// user (identified by [targetIdentityId]) rather than the currently - /// signed-in user. - const S3DownloadDataPluginOptions.forIdentity( - String targetIdentityId, { - bool getProperties = false, - S3DataBytesRange? bytesRange, - bool useAccelerateEndpoint = false, - }) : this._( - targetIdentityId: targetIdentityId, - getProperties: getProperties, - bytesRange: bytesRange, - useAccelerateEndpoint: useAccelerateEndpoint, - ); - /// {@macro storage.amplify_storage_s3.download_data_plugin_options} factory S3DownloadDataPluginOptions.fromJson(Map json) => _$S3DownloadDataPluginOptionsFromJson(json); @@ -53,11 +35,6 @@ class S3DownloadDataPluginOptions extends StorageDownloadDataPluginOptions { /// The byte range to download from the object. final S3DataBytesRange? bytesRange; - /// The identity ID of another user who uploaded the object. - /// - /// This can be set by using [S3DownloadDataPluginOptions.forIdentity]. - final String? targetIdentityId; - /// Whether to retrieve properties for the downloaded object using the /// `getProperties` API. final bool getProperties; @@ -73,7 +50,6 @@ class S3DownloadDataPluginOptions extends StorageDownloadDataPluginOptions { getProperties, useAccelerateEndpoint, bytesRange, - targetIdentityId, ]; @override diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart index 6ac2a103db..c151fd1ae3 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/model/s3_download_file_options.dart @@ -27,33 +27,9 @@ class S3DownloadFileOptions extends StorageDownloadFileOptions { ) const S3DownloadFileOptions._({ this.getProperties = false, - this.targetIdentityId, this.useAccelerateEndpoint = false, }); - /// {@macro storage.amplify_storage_s3.download_data_options} - /// - /// Use this when calling `downloadFile` on an object that belongs to other - /// user (identified by [targetIdentityId]) rather than the currently signed - /// user. - @Deprecated( - 'use StorageDownloadFileOptions(pluginOptions:S3DownloadFilePluginOptions.forIdentity(...)) instead.', - ) - const S3DownloadFileOptions.forIdentity( - String targetIdentityId, { - bool getProperties = false, - bool useAccelerateEndpoint = false, - }) : this._( - targetIdentityId: targetIdentityId, - getProperties: getProperties, - useAccelerateEndpoint: useAccelerateEndpoint, - ); - - /// The identity ID of the user who uploaded the object. - /// - /// This can be set by using [S3DownloadFileOptions.forIdentity]. - final String? targetIdentityId; - /// Whether to retrieve properties for the downloaded object using the /// `getProperties` API. final bool getProperties; From eb8eafa5a8f209392ec4ce9e4aa3ee9d3f26791b Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 25 Mar 2024 09:10:59 -0400 Subject: [PATCH 43/46] chore: add back temp dir --- .../src/platform_impl/download_file/download_file_io.dart | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart index 95853fb72f..246cf8a3ae 100644 --- a/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart +++ b/packages/storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart @@ -7,6 +7,7 @@ import 'package:amplify_core/amplify_core.dart'; import 'package:amplify_storage_s3_dart/amplify_storage_s3_dart.dart'; import 'package:amplify_storage_s3_dart/src/storage_s3_service/storage_s3_service.dart'; import 'package:meta/meta.dart'; +import 'package:path/path.dart' as p; /// The io implementation of `downloadFile` API. @internal @@ -39,7 +40,10 @@ S3DownloadFileOperation downloadFile({ preStart: () async { destinationPath = await _ensureDestinationWritable(localFile); tempFile = File( - uuid(), + p.join( + await appPathProvider.getTemporaryPath(), + 'amplify_storage_s3_temp_${uuid()}', + ), ); sink = tempFile.openWrite(mode: FileMode.append); }, From 69c1881358f62c83f85baca5a1ecce547afe1303 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 25 Mar 2024 10:54:50 -0400 Subject: [PATCH 44/46] chore: fix integ test --- .../example/integration_test/use_case_test.dart | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 4dd60290c4..5085f36f7b 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -622,8 +622,8 @@ void main() { ' identity id for the currently signed user', (WidgetTester tester) async { final result = await Amplify.Storage.downloadData( - path: StoragePath.withIdentityId( - (identityId) => '/protected/$identityId/$testObjectKey2', + path: StoragePath.fromString( + '/protected/$user1IdentityId/$testObjectKey2', ), options: const StorageDownloadDataOptions( pluginOptions: S3DownloadDataPluginOptions( From 0d300f26f4064dc598bb388f27f676e32cabb284 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 25 Mar 2024 12:42:34 -0400 Subject: [PATCH 45/46] chore: add skip back to io specific test --- .../example/integration_test/use_case_test.dart | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index 5085f36f7b..c3907006da 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -396,8 +396,7 @@ void main() { }, // Web download relies on getUrl which has been covered in the getUrl // integration test run. - // TODO(khatruong2009): Re-enable this test after download apis completed. - // skip: zIsWeb, + skip: zIsWeb, ); testWidgets( From 49ff753835ad19f349ece42e9c3d461a8c6c3bc0 Mon Sep 17 00:00:00 2001 From: Jordan Nelson Date: Mon, 25 Mar 2024 16:08:25 -0400 Subject: [PATCH 46/46] chore: skip test set up in configs other than main --- .../example/integration_test/use_case_test.dart | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart index c3907006da..44870608cc 100644 --- a/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart +++ b/packages/storage/amplify_storage_s3/example/integration_test/use_case_test.dart @@ -64,11 +64,10 @@ void main() { const testObjectFileName2 = 'user1Protected.jpg'; const testObjectFileName3 = 'user1Private.large'; - for (final entry in amplifyEnvironments.entries) { - group( - // TODO(Jordan-Nelson): enable dots-in-name, remove custom-prefix - skip: entry.key != 'main', - '[Environment ${entry.key}]', () { + // TODO(Jordan-Nelson): enable dots-in-name, remove custom-prefix + for (final entry in amplifyEnvironments.entries + .where((element) => element.key == 'main')) { + group('[Environment ${entry.key}]', () { S3PrefixResolver? prefixResolver; late String user1IdentityId; late String object1Etag;