allow the s3 list api to accept an optional bucket

Author: ekjotmultani

packages/amplify_core/lib/src/category/amplify_storage_category.dart

@@ -153,6 +153,7 @@ class StorageCategory extends AmplifyCategory<StoragePluginInterface> {
         data: data,
         onProgress: onProgress,
         options: options,
+        bucket: bucket,
       ),
     );
   }

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

@@ -1,7 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
-import 'package:aws_common/aws_common.dart';
+// 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.list_options}
 /// Configurable options for `Amplify.Storage.list`.
@@ -15,6 +18,7 @@ class StorageListOptions
   const StorageListOptions({
     this.pageSize = 1000,
     this.nextToken,
+    this.bucket,
     this.pluginOptions,
   });
 
@@ -26,9 +30,12 @@ class StorageListOptions
 
   /// {@macro amplify_core.storage.list_plugin_options}
   final StorageListPluginOptions? pluginOptions;
+  
+  /// an optional bucket to specify which bucket to return the list for
+  final StorageBucket? bucket;
 
   @override
-  List<Object?> get props => [pageSize, nextToken, pluginOptions];
+  List<Object?> get props => [pageSize, nextToken, pluginOptions, bucket];
 
   @override
   String get runtimeTypeName => 'StorageListOptions';
@@ -37,6 +44,7 @@ class StorageListOptions
   Map<String, Object?> toJson() => {
         'pageSize': pageSize,
         'nextToken': nextToken,
+        'bucket': bucket,
         'pluginOptions': pluginOptions?.toJson(),
       };
 }

packages/storage/amplify_storage_s3/example/integration_test/list_test.dart

@@ -20,32 +20,51 @@ void main() {
       '$uniquePrefix/file2.txt',
       '$uniquePrefix/subdir/file3.txt',
       '$uniquePrefix/subdir2#file4.txt',
+      '$uniquePrefix/file5.txt',
+      '$uniquePrefix/file6.txt',
+      '$uniquePrefix/subdir3/file7.txt',
+      '$uniquePrefix/subdir4#file8.txt',
     ];
     group('standard config', () {
       setUpAll(() async {
         await configure(amplifyEnvironments['main']!);
-
-        for (final path in uploadedPaths) {
+        for (var i = 0; i < 4; i++) {
           await Amplify.Storage.uploadData(
-            path: StoragePath.fromString(path),
+            path: StoragePath.fromString(uploadedPaths[i]),
             data: StorageDataPayload.bytes('test content'.codeUnits),
+            bucket: StorageBucket.fromOutputs('Storage Integ Test main bucket'),
+          ).result;
+        }
+        for (var i = 4; i < 8; i++) {
+          await Amplify.Storage.uploadData(
+            path: StoragePath.fromString(uploadedPaths[i]),
+            data: StorageDataPayload.bytes('test content'.codeUnits),
+            bucket: StorageBucket.fromOutputs('Storage Integ Test secondary bucket'),
           ).result;
         }
-
         for (final path in uploadedPaths) {
           addTearDownPath(StoragePath.fromString(path));
         }
       });
 
       group('list() without options', () {
         testWidgets('should list all files with unique prefix', (_) async {
-          final listResult = await Amplify.Storage.list(
+          final listResultMainBucket = await Amplify.Storage.list(
             path: StoragePath.fromString(uniquePrefix),
           ).result;
-
-          for (final uploadedPath in uploadedPaths) {
+          final listResultSecondaryBucket = await Amplify.Storage.list(
+            path: StoragePath.fromString(uniquePrefix),
+            options: StorageListOptions(bucket: StorageBucket.fromOutputs('Storage Integ Test secondary bucket')),
+          ).result;
+          for (var i = 0; i < 4; i++) {
+            expect(
+              listResultMainBucket.items.any((item) => item.path == uploadedPaths[i]),
+              isTrue,
+            );
+          }
+          for (var i = 4; i < 8; i++) {
             expect(
-              listResult.items.any((item) => item.path == uploadedPath),
+              listResultSecondaryBucket.items.any((item) => item.path == uploadedPaths[i]),
               isTrue,
             );
           }
@@ -101,6 +120,17 @@ void main() {
               ),
             ).result as S3ListResult;
 
+            final listResultSecondaryBucket = await Amplify.Storage.list(
+              path: StoragePath.fromString('$uniquePrefix/'),
+              options: StorageListOptions(
+                pluginOptions: const S3ListPluginOptions(
+                  excludeSubPaths: true,
+                  delimiter: '#',
+                ),
+                bucket: StorageBucket.fromOutputs('Storage Integ Test secondary bucket'),
+              ),
+            ).result as S3ListResult;
+            
             expect(listResult.items.length, 3);
             expect(listResult.items.first.path, contains('file1.txt'));
 
@@ -110,6 +140,16 @@ void main() {
               '$uniquePrefix/subdir2#',
             );
             expect(listResult.metadata.delimiter, '#');
+
+            expect(listResultSecondaryBucket.items.length, 3);
+            expect(listResultSecondaryBucket.items.first.path, contains('file5.txt'));
+
+            expect(listResultSecondaryBucket.metadata.subPaths.length, 1);
+            expect(
+              listResultSecondaryBucket.metadata.subPaths.first,
+              '$uniquePrefix/subdir4#',
+            );
+            expect(listResultSecondaryBucket.metadata.delimiter, '#');
           });
         });
 
@@ -123,6 +163,17 @@ void main() {
 
           expect(listResult.items.length, 2);
           expect(listResult.items.first.path, contains('file1.txt'));
+
+          final listResultSecondaryBucket = await Amplify.Storage.list(
+            path: StoragePath.fromString(uniquePrefix),
+            options: StorageListOptions(
+              pageSize: 2,
+              bucket: StorageBucket.fromOutputs('Storage Integ Test secondary bucket'),
+            ),
+          ).result;
+
+          expect(listResultSecondaryBucket.items.length, 2);
+          expect(listResultSecondaryBucket.items.first.path, contains('file5.txt'));
         });
 
         testWidgets('should list files with pagination', (_) async {
@@ -157,8 +208,19 @@ void main() {
             ),
           ).result;
 
-          expect(listResult.items.length, uploadedPaths.length);
+          expect(listResult.items.length, uploadedPaths.length~/2);
           expect(listResult.nextToken, isNull);
+
+          final listResultSecondaryBucket = await Amplify.Storage.list(
+            path: StoragePath.fromString(uniquePrefix),
+            options: StorageListOptions(
+              pluginOptions: const S3ListPluginOptions.listAll(),
+              bucket: StorageBucket.fromOutputs('Storage Integ Test secondary bucket'),
+            ),
+          ).result;
+
+          expect(listResultSecondaryBucket.items.length, uploadedPaths.length~/2);
+          expect(listResultSecondaryBucket.nextToken, isNull);
         });
       });
     });

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

@@ -124,7 +124,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
     });
   }
 
-  @override
+   @override
   S3ListOperation list({
     required StoragePath path,
     StorageListOptions? options,
@@ -136,6 +136,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
     final s3Options = StorageListOptions(
       pluginOptions: s3PluginOptions,
       nextToken: options?.nextToken,
+      bucket: options?.bucket,
       pageSize: options?.pageSize ?? 1000,
     );
 
@@ -151,6 +152,7 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
     );
   }
 
+
   @override
   S3GetPropertiesOperation getProperties({
     required StoragePath path,

packages/storage/amplify_storage_s3_dart/lib/src/storage_s3_service/service/storage_s3_service_impl.dart

@@ -125,11 +125,12 @@ class StorageS3Service {
         const S3ListPluginOptions();
 
     final resolvedPath = await _pathResolver.resolvePath(path: path);
+    final s3ClientInfo = options.bucket == null ? getS3ClientInfo() : getS3ClientInfo(storageBucket: options.bucket);
 
     if (!s3PluginOptions.listAll) {
       final request = s3.ListObjectsV2Request.build((builder) {
         builder
-          ..bucket = _storageOutputs.bucketName
+          ..bucket = s3ClientInfo.bucketName
           ..prefix = resolvedPath
           ..maxKeys = options.pageSize
           ..continuationToken = options.nextToken
@@ -140,7 +141,7 @@ class StorageS3Service {
 
       try {
         return S3ListResult.fromPaginatedResult(
-          await _defaultS3Client.listObjectsV2(request).result,
+          await s3ClientInfo.client.listObjectsV2(request).result,
         );
       } on smithy.UnknownSmithyHttpException catch (error) {
         // S3Client.headObject may return 403 error
@@ -156,14 +157,15 @@ class StorageS3Service {
     try {
       final request = s3.ListObjectsV2Request.build((builder) {
         builder
-          ..bucket = _storageOutputs.bucketName
+          // ignore: invalid_use_of_internal_member
+          ..bucket = options.bucket == null ? _storageOutputs.bucketName : options.bucket!.resolveBucketInfo(_storageOutputs).bucketName
           ..prefix = resolvedPath
           ..delimiter = s3PluginOptions.excludeSubPaths
               ? s3PluginOptions.delimiter
               : null;
       });
 
-      listResult = await _defaultS3Client.listObjectsV2(request).result;
+      listResult = await s3ClientInfo.client.listObjectsV2(request).result;
       recursiveResult = S3ListResult.fromPaginatedResult(
         listResult,
       );

packages/storage/amplify_storage_s3_dart/test/amplify_storage_s3_dart_test.dart

@@ -140,6 +140,7 @@ void main() {
         const testOptions = StorageListOptions(
           pluginOptions: S3ListPluginOptions(excludeSubPaths: true),
           nextToken: 'next-token-123',
+          bucket: StorageBucket.fromBucketInfo(BucketInfo(bucketName: 'unit-test-bucket', region: 'us-east-2')),
           pageSize: 2,
         );