FIRStorageUploadTask: fail on invalid file URL #2458

maksymmalyhin · 2019-02-28T15:17:28Z

Partial fix for issue #2350.

Fail early with an informative error in case of an invalid file URL.

Another part of the fix has to be done in GTMSessionUploadFetcher (following issue)

bstpierr · 2019-02-28T15:24:15Z

It looks like the style linter needs to be run.

You might need to overwrite the Google version of clang-format.

maksymmalyhin · 2019-02-28T15:48:14Z

@bstpierr Thank you, I'll do that. Probably, I'll add the linter to my git hooks to avoid such errors in future.

ryanwilson

Please fix the linting error and wait for a review from @schmidt-sebastian, otherwise LGTM.

ryanwilson · 2019-02-28T15:47:34Z

Firebase/Storage/FIRStorageUploadTask.m

+  if (![_fileURL checkResourceIsReachableAndReturnError:&fileReachabilityError]) {
+    if (outError != NULL) {
+      NSString *description =
+        [NSString stringWithFormat:@"File at URL: %@ is not reachable", _fileURL.absoluteString];


Nit: punctuation at the end of the string.

ryanwilson · 2019-02-28T15:52:07Z

Firebase/Storage/FIRStorageUploadTask.m

+      NSString *description =
+        [NSString stringWithFormat:@"File at URL: %@ is not reachable", _fileURL.absoluteString];
+      *outError = [NSError errorWithDomain:FIRStorageErrorDomain
+                                      code:FIRStorageErrorCodeUnknown


I think this is fine for now, but we probably want to add a case to the to the FIRStorageErrorCode enum.

That will require an API review (I can go over the process with you) so we won't be able to do it this release.

I may create an issue for that so we don't forget about it.

Once this is approved by the Storage team and lands, that's a great idea.

Created - #2459

Just throwing this out there: Did you consider FIRStorageErrorCodeObjectNotFound? It's used today when a file doesn't exist on the backend, which isn't all that different from a locally missing file.

My concern with FIRStorageErrorCodeObjectNotFound is following: a typical file upload operation involves a remote object reference and a file URL, so if we have a single error code for both it may be confusing for users.

ryanwilson · 2019-02-28T15:54:20Z

Example/Storage/Tests/Unit/FIRStorageReferenceTests.m

@@ -162,4 +162,28 @@ - (void)testCopy {
  XCTAssertNotEqual(ref, copiedRef);
 }

+- (void)test_GivenReferenceWithPath_WhenPutNonExistingFile_ThenCompletionIsCalledWithError {


Although I do think this is a better naming format, it doesn't match the naming for the rest of the file. Maybe something like testReferenceWithNonExistentFileFailsWithCompletion would match better?

yeah, sounds good, I'll correct this.

schmidt-sebastian

One question about the location of the existence check, but otherwise looks good!

schmidt-sebastian · 2019-03-02T00:50:13Z

Firebase/Storage/FIRStorageUploadTask.m

@@ -72,6 +72,13 @@ - (void)dealloc {
 - (void)enqueue {
  __weak FIRStorageUploadTask *weakSelf = self;

+  NSError *contentValidationError;


Should this be move to the dispatchAsync block below to execute close to the actual upload?

yeah, that makes sense

schmidt-sebastian · 2019-03-02T00:53:10Z

Firebase/Storage/FIRStorageUploadTask.m

+      NSString *description =
+        [NSString stringWithFormat:@"File at URL: %@ is not reachable", _fileURL.absoluteString];
+      *outError = [NSError errorWithDomain:FIRStorageErrorDomain
+                                      code:FIRStorageErrorCodeUnknown


Just throwing this out there: Did you consider FIRStorageErrorCodeObjectNotFound? It's used today when a file doesn't exist on the backend, which isn't all that different from a locally missing file.

schmidt-sebastian · 2019-03-04T07:10:49Z

Thanks for your contribution @maksymmalyhin!

maksymmalyhin · 2019-03-04T14:22:08Z

@schmidt-sebastian I'm happy to help!

LinusU · 2019-04-17T14:35:36Z

Firebase/Storage/FIRStorageUploadTask.m

+      *outError = [NSError errorWithDomain:FIRStorageErrorDomain
+                                      code:FIRStorageErrorCodeUnknown
+                                  userInfo:@{
+                                    NSUnderlyingErrorKey : fileReachabilityError,


I'm trying to upload an mp4 file from Flutter with firebase_storage (got the file from image_picker, seems to work fine with jpeg from image_picker) and I'm hitting an app crash here.

fileReachabilityError is nil and thus I'm getting an NSInvalidException since you cannot add nil values to an NSDitctionary.

For some reason _fileURL is nil, which makes [_fileURL checkResourceIsReachableAndReturnError:&fileReachabilityError] return just nil, which triggers the if (!...) branch.

Sorry for not providing too much info, I'm still in the process of tracking it down but thought it would be good to see if anyone had any ideas ☺️

ping @maksymmalyhin

edit: the problem is that both _uploadData and _fileURL is null, because it was created with a nil data from Flutter

edit2: the problem is that image_picker returns a File object with a path like /file:///foo/bar/baz.mp4...

@LinusU Thank you for the report. That's a good case. Yeah, this part of code definitely does not expect _fileURL to be nil. We will fix it.

In the meanwhile, would you be able to post a comment about it to #2350 or create a separate ticket, so it is not lost.

As a workaround you should check the fileURL != nil before passing it to the putFile method.

I've submitted flutter/plugins#1504 and flutter/plugins#1505 to fix this in Flutter, but would be great to see a fix here as well ☺️

I'll ~~put a comment in the issue you linked~~ open a new issue about it here as well!

edit: here we go 👉 #2852

@LinusU thanks!

maksymmalyhin added 4 commits February 27, 2019 18:31

FIRStorageUploadTask: validate data and fileURL before upload (#2350)

bd55a09

FIRStorageReferenceTests: Verify a specific error (#2350)

ef986b9

Code cleanup. More informative error.

0f11535

FIRStorageReference: error message, test fix (#2350)

92bca47

maksymmalyhin requested review from paulb777, bstpierr, ryanwilson and asciimike February 28, 2019 15:17

googlebot added the cla: yes label Feb 28, 2019

ryanwilson requested review from schmidt-sebastian and removed request for asciimike February 28, 2019 15:54

ryanwilson reviewed Feb 28, 2019

View reviewed changes

maksymmalyhin added 3 commits February 28, 2019 10:57

Run ./scripts/style.sh

fc70bdb

#2350: Punctuation

5009de3

FIRStorageReferenceTests: naming (#2350)

6a731ae

maksymmalyhin mentioned this pull request Feb 28, 2019

FIRStorageErrorCode - create a specific case(s) for file validation errors #2459

Closed

maksymmalyhin added 3 commits February 28, 2019 11:43

Run ./scripts/style.sh

c335c43

Tests fixed (#2350)

3dbf22c

FIRStorageReferenceTests fixed for Mac OS (#2350)

1155787

schmidt-sebastian reviewed Mar 2, 2019

View reviewed changes

maksymmalyhin added 2 commits March 3, 2019 15:13

Merge branch 'master' into mm-2350-putFileCompletion

6c4ee95

FIRStorageUploadTask: validate content just before uploading (#2350)

d376ee1

schmidt-sebastian approved these changes Mar 4, 2019

View reviewed changes

schmidt-sebastian merged commit 4dfebfc into master Mar 4, 2019

maksymmalyhin deleted the mm-2350-putFileCompletion branch March 4, 2019 14:22

maksymmalyhin self-assigned this Mar 15, 2019

LinusU reviewed Apr 17, 2019

View reviewed changes

LinusU mentioned this pull request Apr 17, 2019

isContentToUploadValid throws NSException when data is nil #2852

Closed

firebase locked and limited conversation to collaborators Oct 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FIRStorageUploadTask: fail on invalid file URL #2458

FIRStorageUploadTask: fail on invalid file URL #2458

maksymmalyhin commented Feb 28, 2019

bstpierr commented Feb 28, 2019

maksymmalyhin commented Feb 28, 2019 •

edited

Loading

ryanwilson left a comment

ryanwilson Feb 28, 2019

ryanwilson Feb 28, 2019

maksymmalyhin Feb 28, 2019

ryanwilson Feb 28, 2019

maksymmalyhin Feb 28, 2019

schmidt-sebastian Mar 2, 2019

maksymmalyhin Mar 3, 2019

ryanwilson Feb 28, 2019

maksymmalyhin Feb 28, 2019

schmidt-sebastian left a comment

schmidt-sebastian Mar 2, 2019

maksymmalyhin Mar 3, 2019

schmidt-sebastian Mar 2, 2019

schmidt-sebastian commented Mar 4, 2019

maksymmalyhin commented Mar 4, 2019

LinusU Apr 17, 2019 •

edited

Loading

maksymmalyhin Apr 17, 2019

LinusU Apr 17, 2019 •

edited

Loading

maksymmalyhin Apr 17, 2019

FIRStorageUploadTask: fail on invalid file URL #2458

FIRStorageUploadTask: fail on invalid file URL #2458

Conversation

maksymmalyhin commented Feb 28, 2019

bstpierr commented Feb 28, 2019

maksymmalyhin commented Feb 28, 2019 • edited Loading

ryanwilson 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

schmidt-sebastian 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

schmidt-sebastian commented Mar 4, 2019

maksymmalyhin commented Mar 4, 2019

LinusU Apr 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LinusU Apr 17, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maksymmalyhin commented Feb 28, 2019 •

edited

Loading

LinusU Apr 17, 2019 •

edited

Loading

LinusU Apr 17, 2019 •

edited

Loading