feat: update list API (#4600)

* feat: list API init commit * chore: removed / from beginning of paths * chore: fix formatting * chore: fix formatting and tests * chore: fix formatting in storage_s3_service_test.dart * chore: remove commented code and and / before paths * Apply suggestions from code review Co-authored-by: Jordan Nelson <[email protected]> * chore: remove accessLevel from StorageListOptions * chore: removed prefix formatter and fixed formatting * chore: removed unused field * chore: remove prefix resolver and fix classes * chore: change variable name Co-Authored-By: Jordan Nelson <[email protected]> * chore: fix formatting * chore: add deleted documentation back in * chore: fixed comment placement --------- Co-authored-by: Jordan Nelson <[email protected]> Co-authored-by: Jordan Nelson <[email protected]>
aws-amplify · Mar 27, 2024 · 36ba0ad · 36ba0ad
1 parent f284d55
commit 36ba0ad
Show file tree

Hide file tree

Showing 22 changed files with 87 additions and 254 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
@@ -37,7 +37,7 @@ class StorageCategory extends AmplifyCategory<StoragePluginInterface> {
   /// returns a [StorageListOperation].
   /// {@endtemplate}
   StorageListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     return identifyCall(

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
@@ -16,7 +16,7 @@ abstract class StoragePluginInterface extends AmplifyPluginInterface {
 
   /// {@macro amplify_core.amplify_storage_category.list}
   StorageListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     throw UnimplementedError('list() has not been implemented.');

diff --git a/packages/amplify_core/lib/src/types/storage/list_options.dart b/packages/amplify_core/lib/src/types/storage/list_options.dart
@@ -14,7 +14,6 @@ class StorageListOptions extends StorageOperationOptions
         AWSDebuggable {
   /// {@macro amplify_core.storage.list_options}
   const StorageListOptions({
-    super.accessLevel,
     this.pageSize = 1000,
     this.nextToken,
     this.pluginOptions,
@@ -30,14 +29,13 @@ class StorageListOptions extends StorageOperationOptions
   final StorageListPluginOptions? pluginOptions;
 
   @override
-  List<Object?> get props => [accessLevel, pageSize, nextToken, pluginOptions];
+  List<Object?> get props => [pageSize, nextToken, pluginOptions];
 
   @override
   String get runtimeTypeName => 'StorageListOptions';
 
   @override
   Map<String, Object?> toJson() => {
-        'accessLevel': accessLevel?.name,
         'pageSize': pageSize,
         'nextToken': nextToken,
         'pluginOptions': pluginOptions?.toJson(),

diff --git a/packages/amplify_core/lib/src/types/storage/list_request.dart b/packages/amplify_core/lib/src/types/storage/list_request.dart
@@ -9,12 +9,12 @@ import 'package:amplify_core/amplify_core.dart';
 class StorageListRequest {
   /// {@macro amplify_core.storage.list_request}
   const StorageListRequest({
-    this.path,
+    required this.path,
     this.options,
   });
 
   /// Path to list objects under.
-  final String? path;
+  final StoragePath path;
 
   /// Configurable options of the [StorageListRequest].
   final StorageListOptions? options;

diff --git a/packages/amplify_core/lib/src/types/storage/storage_item.dart b/packages/amplify_core/lib/src/types/storage/storage_item.dart
@@ -7,17 +7,13 @@
 class StorageItem {
   /// {@macro amplify_core.storage.storage_item}
   const StorageItem({
-    this.key,
-    // TODO(Jordan-Nelson): make required
-    this.path = '',
+    required this.path,
     this.size,
     this.lastModified,
     this.eTag,
     this.metadata = const <String, String>{},
   });
 
-  // TODO(Jordan-Nelson): Remove key
-  final String? key;
   final String path;
   final int? size;
   final DateTime? lastModified;

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
@@ -416,7 +416,7 @@ void main() {
             ),
           ).result;
 
-          expect(result.copiedItem.key, testObject3CopyKey);
+          expect(result.copiedItem.path, testObject3CopyKey);
           expect(result.copiedItem.eTag, isNotEmpty);
         });
 
@@ -683,7 +683,6 @@ void main() {
               (WidgetTester tester) async {
             const filesToUpload = 2;
             const filesToList = 1;
-            const accessLevel = StorageAccessLevel.private;
             final uploadedKeys = <String>[];
             // Upload some files to test.
             for (var i = filesToUpload; i > 0; i--) {
@@ -706,8 +705,10 @@ void main() {
 
             // Call list() and ensure length of result matches pageSize.
             final listResult = await Amplify.Storage.list(
+              path: StoragePath.withIdentityId(
+                (identityId) => 'private/$identityId/',
+              ),
               options: const StorageListOptions(
-                accessLevel: accessLevel,
                 pageSize: filesToList,
               ),
             ).result;
@@ -729,7 +730,6 @@ void main() {
               (WidgetTester tester) async {
             const filesToUpload = 2;
             const filesToList = 1;
-            const accessLevel = StorageAccessLevel.private;
             final keyPrefix = 'testObjectList${uuid()}';
             final uploadedKeys = <String>[];
             // Upload some files to test.
@@ -758,12 +758,13 @@ void main() {
             do {
               // Call list() until nextToken is null and ensure we paginated expected times.
               final listResult = await Amplify.Storage.list(
+                path: StoragePath.withIdentityId(
+                  (identityId) => 'private/$identityId/',
+                ),
                 options: StorageListOptions(
-                  accessLevel: accessLevel,
                   pageSize: filesToList,
                   nextToken: lastNextToken,
                 ),
-                path: keyPrefix,
               ).result;
               lastNextToken = listResult.nextToken;
               timesCalled++;

diff --git a/packages/storage/amplify_storage_s3/example/lib/main.dart b/packages/storage/amplify_storage_s3/example/lib/main.dart
@@ -161,8 +161,8 @@ class _HomeScreenState extends State<HomeScreen> {
   Future<void> _listAllPublicFiles() async {
     try {
       final result = await Amplify.Storage.list(
+        path: const StoragePath.fromString('public'),
         options: const StorageListOptions(
-          accessLevel: StorageAccessLevel.guest,
           pluginOptions: S3ListPluginOptions.listAll(),
         ),
       ).result;

diff --git a/packages/storage/amplify_storage_s3_dart/example/bin/example.dart b/packages/storage/amplify_storage_s3_dart/example/bin/example.dart
@@ -76,26 +76,21 @@ Future<void> main() async {
 
 Future<void> listOperation() async {
   final path = prompt('Enter a path to list objects for: ');
-  final accessLevel = promptStorageAccessLevel(
-    'Choose the storage access level associated with the path: ',
-  );
   final listAll = prompt('List with pagination? (Y/n): ').toLowerCase() == 'n';
 
   const pageSize = 5;
 
   // get plugin with plugin key to gain S3 specific interface
   final s3Plugin = Amplify.Storage.getPlugin(AmplifyStorageS3Dart.pluginKey);
   final options = listAll
-      ? StorageListOptions(
-          accessLevel: accessLevel,
-          pluginOptions: const S3ListPluginOptions.listAll(),
+      ? const StorageListOptions(
+          pluginOptions: S3ListPluginOptions.listAll(),
         )
-      : StorageListOptions(
-          accessLevel: accessLevel,
+      : const StorageListOptions(
           pageSize: pageSize,
         );
   final operation = s3Plugin.list(
-    path: path,
+    path: StoragePath.fromString(path),
     options: options,
   );
 
@@ -116,7 +111,7 @@ Future<void> listOperation() async {
     stdout.writeln('Listed ${result.items.length} objects.');
     stdout.writeln('Sub directories: ${result.metadata.subPaths}');
     result.items.asMap().forEach((index, item) {
-      stdout.writeln('$index. key: ${item.key} | size: ${item.size}');
+      stdout.writeln('$index. path: ${item.path} | size: ${item.size}');
     });
 
     if (!result.hasNextPage) {
@@ -133,9 +128,8 @@ Future<void> listOperation() async {
 
     result = await s3Plugin
         .list(
-          path: path,
+          path: StoragePath.fromString(path),
           options: StorageListOptions(
-            accessLevel: accessLevel,
             pageSize: pageSize,
             nextToken: result.nextToken,
           ),
@@ -155,7 +149,7 @@ Future<void> getPropertiesOperation() async {
 
   stdout
     ..writeln('Got properties: ')
-    ..writeln('key: ${result.storageItem.key}')
+    ..writeln('path: ${result.storageItem.path}')
     ..writeln('size: ${result.storageItem.size}')
     ..writeln('lastModified: ${result.storageItem.lastModified}')
     ..writeln('eTag: ${result.storageItem.eTag}')
@@ -289,7 +283,7 @@ Future<void> uploadDataUrlOperation() async {
     final result = await uploadDataOperation.result;
     stdout
       ..writeln('Uploaded data url: ')
-      ..writeln('key: ${result.uploadedItem.key}')
+      ..writeln('path: ${result.uploadedItem.path}')
       ..writeln('size: ${result.uploadedItem.size}')
       ..writeln('lastModified: ${result.uploadedItem.lastModified}')
       ..writeln('eTag: ${result.uploadedItem.eTag}');
@@ -367,7 +361,7 @@ Future<void> copyOperation() async {
     final result = await copyOperation.result;
     stdout
       ..writeln('Copied object: ')
-      ..writeln('key: ${result.copiedItem.key}')
+      ..writeln('path: ${result.copiedItem.path}')
       ..writeln('size: ${result.copiedItem.size}')
       ..writeln('lastModified: ${result.copiedItem.lastModified}')
       ..writeln('eTag: ${result.copiedItem.eTag}')
@@ -391,7 +385,7 @@ Future<void> removeOperation() async {
     final result = await removeOperation.result;
     stdout
       ..writeln('Remove completed.')
-      ..writeln('Removed object: ${result.removedItem.key}');
+      ..writeln('Removed object: ${result.removedItem.path}');
   } on Exception catch (error) {
     stderr
       ..writeln('Something went wrong...')

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
@@ -123,7 +123,6 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
           credentialsProvider: credentialsProvider,
           s3PluginConfig: s3PluginConfig,
           delimiter: _delimiter,
-          prefixResolver: _prefixResolver!,
           pathResolver: _pathResolver,
           logger: logger,
           dependencyManager: dependencies,
@@ -141,15 +140,14 @@ class AmplifyStorageS3Dart extends StoragePluginInterface
 
   @override
   S3ListOperation list({
-    String? path,
+    required StoragePath path,
     StorageListOptions? options,
   }) {
     final s3PluginOptions = reifyPluginOptions(
       pluginOptions: options?.pluginOptions,
       defaultPluginOptions: const S3ListPluginOptions(),
     );
     final s3Options = StorageListOptions(
-      accessLevel: options?.accessLevel,
       pluginOptions: s3PluginOptions,
       nextToken: options?.nextToken,
       pageSize: options?.pageSize ?? 1000,

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
@@ -19,9 +19,7 @@ class S3Item extends StorageItem
         AWSDebuggable {
   /// {@macro storage.amplify_storage_s3.storage_s3_item}
   S3Item({
-    super.key,
-    // TODO(Jordan-Nelson): make required
-    super.path,
+    required super.path,
     super.size,
     super.lastModified,
     super.eTag,
@@ -35,7 +33,6 @@ class S3Item extends StorageItem
     return storageItem is S3Item
         ? storageItem
         : S3Item(
-            key: storageItem.key,
             path: storageItem.path,
             size: storageItem.size,
             lastModified: storageItem.lastModified,
@@ -50,9 +47,8 @@ class S3Item extends StorageItem
   /// Creates a [S3Item] from [s3.S3Object] provided by S3 Client.
   @internal
   factory S3Item.fromS3Object(
-    s3.S3Object object, {
-    required String prefixToDrop,
-  }) {
+    s3.S3Object object,
+  ) {
     final key = object.key;
 
     // Sanity check, key property should never be null in a S3Object returned
@@ -64,13 +60,7 @@ class S3Item extends StorageItem
       );
     }
 
-    final keyDroppedPrefix = dropPrefixFromKey(
-      prefixToDrop: prefixToDrop,
-      key: key,
-    );
-
     return S3Item(
-      key: keyDroppedPrefix,
       path: key,
       size: object.size?.toInt(),
       lastModified: object.lastModified,
@@ -83,12 +73,9 @@ class S3Item extends StorageItem
   @internal
   factory S3Item.fromHeadObjectOutput(
     s3.HeadObjectOutput headObjectOutput, {
-    // TODO(Jordan-Nelson): remove key
-    String? key,
     required String path,
   }) {
     return S3Item(
-      key: key,
       path: path,
       lastModified: headObjectOutput.lastModified,
       eTag: headObjectOutput.eTag,
@@ -104,12 +91,9 @@ class S3Item extends StorageItem
   @internal
   factory S3Item.fromGetObjectOutput(
     s3.GetObjectOutput getObjectOutput, {
-    // TODO(Jordan-Nelson): remove key
-    String? key,
     required String path,
   }) {
     return S3Item(
-      key: key,
       path: path,
       lastModified: getObjectOutput.lastModified,
       eTag: getObjectOutput.eTag,
@@ -120,15 +104,6 @@ class S3Item extends StorageItem
     );
   }
 
-  /// Removes [prefixToDrop] from [key] string.
-  @internal
-  static String dropPrefixFromKey({
-    required String prefixToDrop,
-    required String key,
-  }) {
-    return key.replaceRange(0, prefixToDrop.length, '');
-  }
-
   /// Object `versionId`, may be available when S3 bucket versioning is enabled.
   final String? versionId;
 
@@ -137,7 +112,6 @@ class S3Item extends StorageItem
 
   @override
   List<Object?> get props => [
-        key,
         path,
         size,
         lastModified,

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