rename s3PluginConfig to storageOutputs

aws-amplify · Jun 19, 2024 · e62a64a · e62a64a
1 parent 6639f78
commit e62a64a
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 50 deletions.
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
@@ -50,7 +50,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
 
   /// The [StorageOutputs] of the [AmplifyStorageS3Dart] plugin.
   @protected
-  late final StorageOutputs s3pluginConfig;
+  late final StorageOutputs storageOutputs;
 
   late S3PathResolver _pathResolver;
 
@@ -65,12 +65,10 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
     AmplifyOutputs? config,
     required AmplifyAuthProviderRepository authProviderRepo,
   }) async {
-    final s3PluginConfig = config?.storage;
-
-    if (s3PluginConfig == null) {
+    if (config?.storage == null) {
       throw ConfigurationError('No Storage S3 plugin config detected.');
     }
-    s3pluginConfig = s3PluginConfig;
+    storageOutputs = config!.storage!;
 
     final identityProvider = authProviderRepo
         .getAuthProvider(APIAuthorizationType.userPools.authProviderToken);
@@ -109,7 +107,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
       ..addInstance<StorageS3Service>(
         StorageS3Service(
           credentialsProvider: credentialsProvider,
-          s3PluginConfig: s3PluginConfig,
+          storageOutputs: storageOutputs,
           pathResolver: _pathResolver,
           logger: logger,
           dependencyManager: dependencies,
@@ -263,7 +261,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
       path: path,
       localFile: localFile,
       options: options,
-      s3pluginConfig: s3pluginConfig,
+      storageOutputs: storageOutputs,
       storageS3Service: storageS3Service,
       appPathProvider: _appPathProvider,
       onProgress: onProgress,

diff --git a/...orage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart b/...orage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_html.dart
@@ -13,7 +13,7 @@ S3DownloadFileOperation downloadFile({
   required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
-  required StorageOutputs s3pluginConfig,
+  required StorageOutputs storageOutputs,
   required StorageS3Service storageS3Service,
   required AppPathProvider appPathProvider,
   void Function(S3TransferProgress)? onProgress,
@@ -30,7 +30,7 @@ S3DownloadFileOperation downloadFile({
       path: path,
       localFile: localFile,
       options: options,
-      s3pluginConfig: s3pluginConfig,
+      storageOutputs: storageOutputs,
       storageS3Service: storageS3Service,
     ),
     // In Web the download process is managed by the browser so the operation
@@ -45,7 +45,7 @@ Future<S3DownloadFileResult> _downloadFromUrl({
   required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
-  required StorageOutputs s3pluginConfig,
+  required StorageOutputs storageOutputs,
   required StorageS3Service storageS3Service,
 }) async {
   final s3PluginOptions = options.pluginOptions as S3DownloadFilePluginOptions;

diff --git a/...storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart b/...storage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_io.dart
@@ -17,7 +17,7 @@ S3DownloadFileOperation downloadFile({
   required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
-  required StorageOutputs s3pluginConfig,
+  required StorageOutputs storageOutputs,
   required StorageS3Service storageS3Service,
   required AppPathProvider appPathProvider,
   void Function(S3TransferProgress)? onProgress,

diff --git a/...orage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart b/...orage/amplify_storage_s3_dart/lib/src/platform_impl/download_file/download_file_stub.dart
@@ -12,7 +12,7 @@ S3DownloadFileOperation downloadFile({
   required StoragePath path,
   required AWSFile localFile,
   required StorageDownloadFileOptions options,
-  required StorageOutputs s3pluginConfig,
+  required StorageOutputs storageOutputs,
   required StorageS3Service storageS3Service,
   required AppPathProvider appPathProvider,
   void Function(S3TransferProgress)? onProgress,

diff --git a/...e/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart b/...e/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart
@@ -33,13 +33,13 @@ const testDateTimeNowOverride = #_testDateTimeNowOverride;
 class StorageS3Service {
   /// {@macro amplify_storage_s3.storage_s3_service}
   factory StorageS3Service({
-    required StorageOutputs s3PluginConfig,
+    required StorageOutputs storageOutputs,
     required S3PathResolver pathResolver,
     required AWSIamAmplifyAuthProvider credentialsProvider,
     required AWSLogger logger,
     required DependencyManager dependencyManager,
   }) {
-    final usePathStyle = s3PluginConfig.bucketName.contains('.');
+    final usePathStyle = storageOutputs.bucketName.contains('.');
 
     if (usePathStyle) {
       logger.warn(
@@ -56,7 +56,7 @@ class StorageS3Service {
     );
 
     return StorageS3Service._(
-      s3PluginConfig: s3PluginConfig,
+      storageOutputs: storageOutputs,
       s3ClientConfig: s3ClientConfig,
       pathResolver: pathResolver,
       credentialsProvider: credentialsProvider,
@@ -66,18 +66,18 @@ class StorageS3Service {
   }
 
   StorageS3Service._({
-    required StorageOutputs s3PluginConfig,
+    required StorageOutputs storageOutputs,
     required smithy_aws.S3ClientConfig s3ClientConfig,
     required S3PathResolver pathResolver,
     required AWSIamAmplifyAuthProvider credentialsProvider,
     required AWSLogger logger,
     required DependencyManager dependencyManager,
-  })  : _s3PluginConfig = s3PluginConfig,
+  })  : _storageOutptus = storageOutputs,
         _defaultS3ClientConfig = s3ClientConfig,
         // dependencyManager.get() => S3Client is used for unit tests
         _defaultS3Client = dependencyManager.get() ??
             s3.S3Client(
-              region: s3PluginConfig.awsRegion,
+              region: storageOutputs.awsRegion,
               credentialsProvider: credentialsProvider,
               s3ClientConfig: s3ClientConfig,
               client: AmplifyHttpClient(dependencyManager)
@@ -96,7 +96,7 @@ class StorageS3Service {
   static final _defaultS3SignerConfiguration =
       sigv4.S3ServiceConfiguration(signPayload: false);
 
-  final StorageOutputs _s3PluginConfig;
+  final StorageOutputs _storageOutptus;
   final smithy_aws.S3ClientConfig _defaultS3ClientConfig;
   final s3.S3Client _defaultS3Client;
   final S3PathResolver _pathResolver;
@@ -106,7 +106,7 @@ class StorageS3Service {
   final DateTime _serviceStartingTime;
 
   sigv4.AWSCredentialScope get _signerScope => sigv4.AWSCredentialScope(
-        region: _s3PluginConfig.awsRegion,
+        region: _storageOutptus.awsRegion,
         service: AWSService.s3,
       );
 
@@ -134,7 +134,7 @@ class StorageS3Service {
     if (!s3PluginOptions.listAll) {
       final request = s3.ListObjectsV2Request.build((builder) {
         builder
-          ..bucket = _s3PluginConfig.bucketName
+          ..bucket = _storageOutptus.bucketName
           ..prefix = resolvedPath
           ..maxKeys = options.pageSize
           ..continuationToken = options.nextToken
@@ -161,7 +161,7 @@ class StorageS3Service {
     try {
       final request = s3.ListObjectsV2Request.build((builder) {
         builder
-          ..bucket = _s3PluginConfig.bucketName
+          ..bucket = _storageOutptus.bucketName
           ..prefix = resolvedPath
           ..delimiter = s3PluginOptions.excludeSubPaths
               ? s3PluginOptions.delimiter
@@ -207,7 +207,7 @@ class StorageS3Service {
       storageItem: S3Item.fromHeadObjectOutput(
         await headObject(
           s3client: _defaultS3Client,
-          bucket: _s3PluginConfig.bucketName,
+          bucket: _storageOutptus.bucketName,
           key: resolvedPath,
         ),
         path: resolvedPath,
@@ -244,14 +244,14 @@ class StorageS3Service {
 
     var resolvedPath = await _pathResolver.resolvePath(path: path);
     var host =
-        '${_s3PluginConfig.bucketName}.${_getS3EndpointHost(region: _s3PluginConfig.awsRegion)}';
+        '${_storageOutptus.bucketName}.${_getS3EndpointHost(region: _storageOutptus.awsRegion)}';
     if (_defaultS3ClientConfig.usePathStyle) {
-      host = host.replaceFirst('${_s3PluginConfig.bucketName}.', '');
-      resolvedPath = '${_s3PluginConfig.bucketName}/$resolvedPath';
+      host = host.replaceFirst('${_storageOutptus.bucketName}.', '');
+      resolvedPath = '${_storageOutptus.bucketName}/$resolvedPath';
     } else if (s3PluginOptions.useAccelerateEndpoint) {
       // https: //docs.aws.amazon.com/AmazonS3/latest/userguide/transfer-acceleration-getting-started.html
       host = host
-          .replaceFirst(RegExp('${_s3PluginConfig.awsRegion}\\.'), '')
+          .replaceFirst(RegExp('${_storageOutptus.awsRegion}\\.'), '')
           .replaceFirst(RegExp(r'\.s3\.'), '.s3-accelerate.');
     }
 
@@ -297,7 +297,7 @@ class StorageS3Service {
     final downloadDataTask = S3DownloadTask(
       s3Client: _defaultS3Client,
       defaultS3ClientConfig: _defaultS3ClientConfig,
-      bucket: _s3PluginConfig.bucketName,
+      bucket: _storageOutptus.bucketName,
       path: path,
       options: options,
       pathResolver: _pathResolver,
@@ -328,7 +328,7 @@ class StorageS3Service {
       dataPayload,
       s3Client: _defaultS3Client,
       defaultS3ClientConfig: _defaultS3ClientConfig,
-      bucket: _s3PluginConfig.bucketName,
+      bucket: _storageOutptus.bucketName,
       path: path,
       options: options,
       pathResolver: _pathResolver,
@@ -367,7 +367,7 @@ class StorageS3Service {
       localFile,
       s3Client: _defaultS3Client,
       defaultS3ClientConfig: _defaultS3ClientConfig,
-      bucket: _s3PluginConfig.bucketName,
+      bucket: _storageOutptus.bucketName,
       path: path,
       options: uploadDataOptions,
       pathResolver: _pathResolver,
@@ -407,8 +407,8 @@ class StorageS3Service {
 
     final copyRequest = s3.CopyObjectRequest.build((builder) {
       builder
-        ..bucket = _s3PluginConfig.bucketName
-        ..copySource = '${_s3PluginConfig.bucketName}/$sourcePath'
+        ..bucket = _storageOutptus.bucketName
+        ..copySource = '${_storageOutptus.bucketName}/$sourcePath'
         ..key = destinationPath
         ..metadataDirective = s3.MetadataDirective.copy;
     });
@@ -427,7 +427,7 @@ class StorageS3Service {
           ? S3Item.fromHeadObjectOutput(
               await headObject(
                 s3client: _defaultS3Client,
-                bucket: _s3PluginConfig.bucketName,
+                bucket: _storageOutptus.bucketName,
                 key: destinationPath,
               ),
               path: destinationPath,
@@ -451,7 +451,7 @@ class StorageS3Service {
 
     await _deleteObject(
       s3client: _defaultS3Client,
-      bucket: _s3PluginConfig.bucketName,
+      bucket: _storageOutptus.bucketName,
       key: resolvedPath,
     );
 
@@ -491,7 +491,7 @@ class StorageS3Service {
       );
       final request = s3.DeleteObjectsRequest.build((builder) {
         builder
-          ..bucket = _s3PluginConfig.bucketName
+          ..bucket = _storageOutptus.bucketName
           // force to use sha256 instead of md5
           ..checksumAlgorithm = s3.ChecksumAlgorithm.sha256
           ..delete = s3.Delete.build((builder) {
@@ -598,7 +598,7 @@ class StorageS3Service {
     for (final record in records) {
       final request = s3.AbortMultipartUploadRequest.build((builder) {
         builder
-          ..bucket = _s3PluginConfig.bucketName
+          ..bucket = _storageOutptus.bucketName
           ..key = record.objectKey
           ..uploadId = record.uploadId;
       });

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
@@ -31,7 +31,7 @@ void main() {
   group('downloadFile() html implementation', () {
     late StorageS3Service storageS3Service;
     const testKey = 'upload-key.text';
-    const testS3pluginConfig = StorageOutputs(
+    const testStorageOutputs = StorageOutputs(
       bucketName: 'fake-bucket',
       awsRegion: 'west-2',
     );
@@ -91,7 +91,7 @@ void main() {
         path: const StoragePath.fromString('public/$testKey'),
         localFile: AWSFile.fromPath('file_name.jpg'),
         options: const StorageDownloadFileOptions(),
-        s3pluginConfig: testS3pluginConfig,
+        storageOutputs: testStorageOutputs,
         storageS3Service: storageS3Service,
         appPathProvider: const DummyPathProvider(),
       );
@@ -130,7 +130,7 @@ void main() {
         ),
         localFile: AWSFile.fromPath('download.jpg'),
         options: options,
-        s3pluginConfig: testS3pluginConfig,
+        storageOutputs: testStorageOutputs,
         storageS3Service: storageS3Service,
         appPathProvider: const DummyPathProvider(),
       ).result;

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
@@ -30,7 +30,7 @@ void main() {
     late FutureOr<void> Function() onDone;
     const appPathProvider = S3DartAppPathProvider();
     final testDestinationPath = path.join(Directory.current.path, 'test.txt');
-    const testS3pluginConfig = StorageOutputs(
+    const testStorageOutputs = StorageOutputs(
       bucketName: 'fake-bucket',
       awsRegion: 'west-2',
     );
@@ -84,7 +84,7 @@ void main() {
         ),
         localFile: AWSFile.fromPath(testDestinationPath),
         options: options,
-        s3pluginConfig: testS3pluginConfig,
+        storageOutputs: testStorageOutputs,
         storageS3Service: storageS3Service,
         appPathProvider: appPathProvider,
         onProgress: (progress) {
@@ -168,7 +168,7 @@ void main() {
           options: const StorageDownloadFileOptions(
             pluginOptions: S3DownloadFilePluginOptions(),
           ),
-          s3pluginConfig: testS3pluginConfig,
+          storageOutputs: testStorageOutputs,
           storageS3Service: storageS3Service,
           appPathProvider: appPathProvider,
           onProgress: (progress) {
@@ -200,7 +200,7 @@ void main() {
           options: const StorageDownloadFileOptions(
             pluginOptions: S3DownloadFilePluginOptions(),
           ),
-          s3pluginConfig: testS3pluginConfig,
+          storageOutputs: testStorageOutputs,
           storageS3Service: storageS3Service,
           appPathProvider: appPathProvider,
           onProgress: (progress) {
@@ -238,7 +238,7 @@ void main() {
         options: const StorageDownloadFileOptions(
           pluginOptions: S3DownloadFilePluginOptions(),
         ),
-        s3pluginConfig: testS3pluginConfig,
+        storageOutputs: testStorageOutputs,
         storageS3Service: storageS3Service,
         appPathProvider: appPathProvider,
         onProgress: (progress) {

diff --git a/...ages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart b/...ages/storage/amplify_storage_s3_dart/test/storage_s3_service/storage_s3_service_test.dart
@@ -26,7 +26,7 @@ void main() {
   group('StorageS3Service', () {
     const testBucket = 'bucket1';
     const testRegion = 'west-2';
-    const s3PluginConfig =
+    const storageOutputs =
         StorageOutputs(bucketName: testBucket, awsRegion: testRegion);
 
     final pathResolver = TestPathResolver();
@@ -44,7 +44,7 @@ void main() {
         ..addInstance<S3Client>(s3Client)
         ..addInstance<AWSSigV4Signer>(awsSigV4Signer);
       storageS3Service = StorageS3Service(
-        s3PluginConfig: s3PluginConfig,
+        storageOutputs: storageOutputs,
         pathResolver: pathResolver,
         credentialsProvider: TestIamAuthProvider(),
         logger: logger,
@@ -54,7 +54,7 @@ void main() {
 
     test('log a warning when should use path style URLs', () {
       StorageS3Service(
-        s3PluginConfig: const StorageOutputs(
+        storageOutputs: const StorageOutputs(
           bucketName: 'bucket.name.has.dots.com',
           awsRegion: 'us-west-2',
         ),
@@ -771,7 +771,7 @@ void main() {
         late StorageS3Service pathStyleStorageS3Service;
         const pathStyleBucket = 'bucket.name.has.dots.com';
         const pathStyleRegion = 'west-2';
-        const pathStyleS3PluginConfig = StorageOutputs(
+        const pathStyleStorageOutputs = StorageOutputs(
           bucketName: pathStyleBucket,
           awsRegion: pathStyleRegion,
         );
@@ -787,7 +787,7 @@ void main() {
             ..addInstance<S3Client>(MockS3Client())
             ..addInstance<AWSSigV4Signer>(pathStyleAwsSigV4Signer);
           pathStyleStorageS3Service = StorageS3Service(
-            s3PluginConfig: pathStyleS3PluginConfig,
+            storageOutputs: pathStyleStorageOutputs,
             pathResolver: pathResolver,
             credentialsProvider: TestIamAuthProvider(),
             logger: MockAWSLogger(),
@@ -831,7 +831,7 @@ void main() {
                   .having(
                     (o) => o.host,
                     'host',
-                    's3.${pathStyleS3PluginConfig.awsRegion}.amazonaws.com',
+                    's3.${pathStyleStorageOutputs.awsRegion}.amazonaws.com',
                   )
                   .having(
                     (o) => o.path,