Add some support for StorageMetadata. #502

szakarias · 2018-04-19T18:50:46Z

Add StorageMetadata class, getMetadata method on StorageReference, and optional metadata when uploading a file.

mravn-google

LGTM

mravn-google · 2018-04-19T19:02:58Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

+            new OnSuccessListener<StorageMetadata>() {
+              @Override
+              public void onSuccess(StorageMetadata storageMetadata) {
+                HashMap<String, Object> map = new HashMap();


Map<String, Object> map = new HashMap<>();

It is idiomatic Java to "code against interfaces", where a suitable one exists, like Map or List. This means all variables and parameters are given the interface type.

You get a compiler warning by leaving out the diamond operator <>. Unfortunately, the class-level annotation @SuppressWarnings("unchecked") suppresses all the help the compiler might provide. I suggest moving that annotation to the innermost level possible; it can be applied to individual methods or (better) to declarations of local variables.

Maybe you'll find that you don't need it at all.

mravn-google · 2018-04-19T19:11:56Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

+        .addOnFailureListener(
+            new OnFailureListener() {
+              @Override
+              public void onFailure(@NonNull Exception e) {


If we are to use @NonNull, we should do it consistently. I'd vote for not using nullability annotations at all, because they are not present in the Flutter APIs.

It should to have the annotation since it is overriding a @nonnull parameter. Will add it where it's missing.

mravn-google · 2018-04-19T19:15:31Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

-    Map<String, String> arguments = (Map<String, String>) call.arguments;
-    String filename = arguments.get("filename");
-    String path = arguments.get("path");
+    Map<String, Object> arguments = (Map<String, Object>) call.arguments;


Casting call.arguments leads to unnecessary fights with the type checker. Just do

String filename = call.argument("filename"); String path = call.argument("path"); Map<String, Object> metadata = call.argument("metadata");

mravn-google · 2018-04-19T19:16:43Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

    File file = new File(filename);
    StorageReference ref = firebaseStorage.getReference().child(path);
-    UploadTask uploadTask = ref.putFile(Uri.fromFile(file));
+    UploadTask uploadTask;
+    if (metadata != null) {


[nit] I'd invert this condition to avoid negatives where possible.

mravn-google · 2018-04-19T19:17:24Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

@@ -120,6 +166,16 @@ public void onFailure(Exception e) {
        });
  }

+  private StorageMetadata buildMetadataFromMap(HashMap<String, Object> metadataMap) {


The parameter should be a Map, not a HashMap. I'd rename it map.

mravn-google · 2018-04-19T19:28:50Z

packages/firebase_storage/lib/firebase_storage.dart

@@ -29,9 +29,9 @@ class StorageReference {
  }

  /// Asynchronously uploads a file to the currently specified StorageReference, without additional metadata.


The dart doc should be updated.

mravn-google · 2018-04-19T19:30:22Z

packages/firebase_storage/lib/firebase_storage.dart

+       updatedTimeMillis = null,
+       md5Hash = null;
+
+  StorageMetadata._fromMap(Map<String, dynamic> map)


The argument needs to be Map<dynamic, dynamic> because that is what you get on the channel.

mravn-google · 2018-04-19T19:39:18Z

packages/firebase_storage/lib/firebase_storage.dart

+      'contentDisposition': contentDisposition,
+      'contentLanguage': contentLanguage,
+      'contentType': contentType,
+      'contentEncoding': contentEncoding,


We ignore most of this information on the platform side. I find it a bit misleading to package up all of it here. Is toMap used by anyone except StorageUploadTask? If not, then perhaps it can be renamed toUploadMap or the responsibility for populating a Map with upload metadata can moved to StorageUploadTask.

mravn-google · 2018-04-19T19:42:51Z

...storage/android/src/main/java/io/flutter/plugins/firebase/storage/FirebaseStoragePlugin.java

+    builder.setContentType((String) metadataMap.get("contentType"));
+    return builder.build();
+  }
+
  private void getData(MethodCall call, final Result result) {
    Map<String, Object> arguments = (Map<String, Object>) call.arguments;


Same here.

Integer maxSize = call.argument("maxSize"); String path = call.argument("path");

mravn-google · 2018-04-19T19:44:22Z

packages/firebase_storage/example/lib/main.dart

@@ -42,7 +42,9 @@ class _MyHomePageState extends State<MyHomePage> {
    final String rand = "${new Random().nextInt(10000)}";
    final StorageReference ref =
        FirebaseStorage.instance.ref().child("foo$rand.txt");
-    final StorageUploadTask uploadTask = ref.put(file);
+    final StorageUploadTask uploadTask = ref.put(
+        file, new StorageMetadata(contentLanguage: "en"));


Could be a const constructor?

mravn-google · 2018-04-19T19:52:29Z

packages/firebase_storage/lib/firebase_storage.dart

+  /// The time the [StorageReference] was created.
+  final num creationTimeMillis;
+
+  /// The time the [StorageReference] was last updated.


... in milliseconds since the epoch.
Should be an int. Same for the other time stamp.

mravn-google · 2018-04-19T19:53:51Z

packages/firebase_storage/lib/firebase_storage.dart

+
+  /// The content type of the [StorageReference].
+  String contentType;
+


Would be awesome to provide an example of each of these five settable pieces of metadata.

mravn-google

LGTM

mravn-google · 2018-04-20T10:34:38Z

packages/firebase_storage/lib/firebase_storage.dart

        'filename': file.absolute.path,
        'path': path,
+        'metadata': metadata != null ? buildMetadataUploadMap(metadata) : null,


[nit] metadata == null ? null : buildMetadataUploadMap(metadata)

mravn-google · 2018-04-20T10:35:26Z

packages/firebase_storage/lib/firebase_storage.dart

      },
    );
    _completer
        .complete(new UploadTaskSnapshot(downloadUrl: Uri.parse(downloadUrl)));
  }
+
+  Map<String, dynamic> buildMetadataUploadMap(StorageMetadata metadata) {


Make private?

szakarias requested a review from mravn-google April 19, 2018 18:50

googlebot added the cla: yes label Apr 19, 2018

szakarias force-pushed the FBStorageMetadata branch from 1fd763a to 14c3634 Compare April 19, 2018 18:56

mravn-google approved these changes Apr 19, 2018

View reviewed changes

mravn-google reviewed Apr 19, 2018

View reviewed changes

mravn-google assigned szakarias Apr 19, 2018

Add some support for StorageMetadata.

4635ddb

szakarias force-pushed the FBStorageMetadata branch 2 times, most recently from 8d88921 to cca9f76 Compare April 20, 2018 08:31

comments

7dda62a

szakarias force-pushed the FBStorageMetadata branch 2 times, most recently from 69a2fa3 to 5994ed6 Compare April 20, 2018 09:40

formatting

51cf620

szakarias force-pushed the FBStorageMetadata branch from 5994ed6 to 51cf620 Compare April 20, 2018 09:43

mravn-google approved these changes Apr 20, 2018

View reviewed changes

comments

fa2bf03

szakarias merged commit 6b5a6c3 into flutter:master Apr 20, 2018

slightfoot pushed a commit to slightfoot/plugins that referenced this pull request Jun 5, 2018

Add some support for StorageMetadata. (flutter#502)

e9969f5

julianscheel pushed a commit to jusst-engineering/plugins that referenced this pull request Mar 11, 2020

Add some support for StorageMetadata. (flutter#502)

0a3b9af

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add some support for StorageMetadata. #502

Add some support for StorageMetadata. #502

szakarias commented Apr 19, 2018

mravn-google left a comment

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

szakarias Apr 20, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018 •

edited

Loading

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google Apr 19, 2018

mravn-google left a comment

mravn-google Apr 20, 2018

mravn-google Apr 20, 2018

		@@ -29,9 +29,9 @@ class StorageReference {
		}

		/// Asynchronously uploads a file to the currently specified StorageReference, without additional metadata.


		/// The content type of the [StorageReference].
		String contentType;

Add some support for StorageMetadata. #502

Add some support for StorageMetadata. #502

Conversation

szakarias commented Apr 19, 2018

mravn-google left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mravn-google Apr 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mravn-google left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mravn-google Apr 19, 2018 •

edited

Loading