Merge branch '0.10.1' into 0.11.0

Author: wkh237

.github/ISSUE_TEMPLATE

@@ -1,4 +1,4 @@
-Hi ! Thank you for reporting an issue, but we would like to remind you, we have a trouble shooting page in our wiki. You may want to take a look on that page :p 
+Hi ! Thank you for reporting an issue, but we would like to remind you, we have a trouble shooting page in our wiki. You may want to take a look on that page or find issues tagged "trouble shooting" :p 
 
 * please provide the version of installed library and RN project.
 * a sample code snippet/repository is very helpful to spotting the problem.

.github/PULL_REQUEST_TEMPLATE

@@ -1,5 +1,5 @@
 Thank you for making a pull request ! Just a gentle reminder :)
 
-1. If the PR is offering a feature please make the request to our "Feature Branch" 0.10.0
-2. Bug fix request to "Bug Fix Branch" 0.10.0
+1. If the PR is offering a feature please make the request to our "Feature Branch" 0.11.0
+2. Bug fix request to "Bug Fix Branch" 0.10.1
 3. Correct README.md can directly to master

CONTRIBUTORS.md

@@ -1,14 +1,20 @@
 Andreas Amsenius <[email protected]>
+Arthur Ouaki <[email protected]>
+Binur Konarbai <[email protected]>
+Chris Sloey <[email protected]>
 Corentin Smith <[email protected]>
 Dmitry Petukhov <[email protected]>
 Erik Smartt <[email protected]>
 Evgeniy Baraniuk <[email protected]>
+Frank van der Hoek <[email protected]>
 Juan B. Rodriguez <[email protected]>
 Kaishley <[email protected]>
 Mike Monteith <[email protected]>
 Nguyen Cao Nhat Linh <[email protected]>
 Tim Suchanek <[email protected]>
 follower <[email protected]>
 francisco-sanchez-molina <[email protected]>
+hhravn <[email protected]>
 kejinliang <[email protected]>
+pedramsaleh <[email protected]>
 smartt <[email protected]>

README.md

@@ -4,14 +4,17 @@
 
 A project committed to make file acess and data transfer easier, efficient for React Native developers.
 
-> The npm package is inside `src` folder, if you're going to install using github repository do not point to here directly
+> If you're going to use github repo as npm dependency please use the [archive repository](https://github.com/wkh237/react-native-fetch-blob-package/releases/tag/v0.9.6).
+
+> If you're using this library as Firebase Storage solution, please upgrade to 0.9.6 since XMLHttpRequest polyfill has way better compatibility than previous versions.
 
 ## Features
 - Transfer data directly from/to storage without BASE64 bridging
 - File API supports normal files, Asset files, and CameraRoll files
 - Native-to-native file manipulation API, reduce JS bridging performance loss
 - File stream support for dealing with large file
 - Blob, File, XMLHttpRequest polyfills that make browser-based library available in RN (experimental)
+- JSON stream supported base on [Oboe.js@jimhigson](https://github.com/jimhigson/oboe.js/)
 
 ## TOC
 * [About](#user-content-about)
@@ -34,7 +37,7 @@ A project committed to make file acess and data transfer easier, efficient for R
 * [Web API Polyfills](#user-content-web-api-polyfills)
 * [Performance Tips](#user-content-performance-tips)
 * [API References](https://github.com/wkh237/react-native-fetch-blob/wiki/Fetch-API)
-* [Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/wiki/Trouble-Shooting)
+* [Caveats](#user-content-caveats)
 * [Development](#user-content-development)
 
 ## About
@@ -55,8 +58,8 @@ npm install --save react-native-fetch-blob
 Or if using CocoaPods, add the pod to your `Podfile`, for example:
 
 ```
-pod 'react-native-fetch-blob,
-    :path => '../node_modules/react-native-fetch-blob
+pod 'react-native-fetch-blob',
+    :path => '../node_modules/react-native-fetch-blob'
 ```
 
 **Automatically Link Native Modules**
@@ -403,7 +406,7 @@ In `version >= 0.4.2` it is possible to know the upload/download progress. After
     })
 ```
 
-In `0.9.6`, you can specify an optional first argument which contains `count` and `interval` to limit progress event frequency (this will be done in native context in order to reduce RCT bridge overhead). Notice that `count` argument will not work if the server does not provide response content length.
+In `0.9.6`, you can specify an object as first argument which contains `count` and `interval`, to the frequency of progress event (this will be done in native context in order to reduce RCT bridge overhead). Notice that `count` argument will not work if the server does not provide response content length.
 
 
 ```js
@@ -429,7 +432,7 @@ In `0.9.6`, you can specify an optional first argument which contains `count` an
 
 ### Cancel Request
 
-After `0.7.0` it is possible to cancel a HTTP request. When the request cancel, it will definately throws an promise rejection, be sure to catch it.
+After `0.7.0` it is possible to cancel an HTTP request. When the request is cancelled, it will throw a promise rejection, be sure to catch it.
 
 ```js
 let task = RNFetchBlob.fetch('GET', 'http://example.com/file/1')
@@ -735,7 +738,7 @@ Here's a [sample app](https://github.com/wkh237/rn-firebase-storage-upload-sampl
 
 ## Performance Tips
 
-**Read Stream Event Overhead**
+**Read Stream and Progress Event Overhead**
 
 When reading data via `fs.readStream` the process seems blocking JS thread when file is large, it's because the default buffer size is quite small (4kb) which result in large amount of events triggered in JS thread, try to increase the buffer size (for example 100kb = 102400) and set a larger interval (which is introduced in 0.9.4 default value is 10ms) to limit the frequency.
 
@@ -757,6 +760,16 @@ If you're going to concatenate files, you don't have to read the data to JS cont
 
 <img src="img/performance_f2f.png" style="width : 100%"/>
 
+## Caveats
+
+* This library does not urlencode unicode characters in URL automatically, see [#146](https://github.com/wkh237/react-native-fetch-blob/issues/146).
+* When a `Blob` is created from existing file, the file **WILL BE REMOVE** if you `close` the blob.
+* If you replaced `window.XMLHttpRequest` for some reason (e.g. make Firebase SDK work), it will also effect how official `fetch` works (basically it should work just fine).
+* When file stream and upload/download progress event slow down your app, consider upgrade to `0.9.6+`, use [additional arguments](https://github.com/wkh237/react-native-fetch-blob/wiki/Fetch-API#fetchprogressconfig-eventlistenerpromisernfetchblobresponse) to limit its frequency.
+* When passing a file path to the library, remove `file://` prefix.
+
+when you got problem, have a look at [Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/wiki/Trouble-Shooting) or [issues labeled Trouble Shooting](https://github.com/wkh237/react-native-fetch-blob/issues?utf8=✓&q=label%3A%22trouble%20shooting%22%20), there'd be some helpful information.
+
 ## Changes
 
 See [release notes](https://github.com/wkh237/react-native-fetch-blob/releases)

img/action-menu.png

@@ -1,12 +1,12 @@
 {
   "name": "react-native-fetch-blob-dev-env",
   "description": "RNFB development environment, not dist package",
-  "version": "0.10.0-dev",
+  "version": "0.10.1-dev",
   "private": true,
   "scripts": {
     "start": "node node_modules/react-native/local-cli/cli.js start",
     "update-info": "sh scripts/contributors.sh",
-    "test": "sh test.sh"
+    "test": "sh ./scrips/test.sh"
   },
   "devDependencies": {
     "body-parser": "^1.15.0",
@@ -17,19 +17,25 @@
   },
   "contributors": [
     "Andreas Amsenius <[email protected]>",
+    "Arthur Ouaki <[email protected]>",
+    "Binur Konarbai <[email protected]>",
+    "Chris Sloey <[email protected]>",
     "Corentin Smith <[email protected]>",
     "Dmitry Petukhov <[email protected]>",
     "Erik Smartt <[email protected]>",
     "Evgeniy Baraniuk <[email protected]>",
+    "Frank van der Hoek <[email protected]>",
     "Juan B. Rodriguez <[email protected]>",
     "Kaishley <[email protected]>",
     "Mike Monteith <[email protected]>",
     "Nguyen Cao Nhat Linh <[email protected]>",
     "Tim Suchanek <[email protected]>",
     "follower <[email protected]>",
     "francisco-sanchez-molina <[email protected]>",
+    "hhravn <[email protected]>",
     "kejinliang <[email protected]>",
+    "pedramsaleh <[email protected]>",
     "smartt <[email protected]>",
     ""
   ]
-}
+}

package.json

@@ -196,7 +196,7 @@ private File createMultipartBodyCache() throws IOException {
             // form begin
             String header = "--" + boundary + "\r\n";
             if (field.filename != null) {
-                header += "Content-Disposition: form-data; name=" + name + "; filename=" + field.filename + "\r\n";
+                header += "Content-Disposition: form-data; name=\"" + name + "\"; filename=\"" + field.filename + "\"\r\n";
                 header += "Content-Type: " + field.mime + "\r\n\r\n";
                 os.write(header.getBytes());
                 // file field header end
@@ -235,7 +235,7 @@ private File createMultipartBodyCache() throws IOException {
             }
             // data field
             else {
-                header += "Content-Disposition: form-data; name=" + name + "\r\n";
+                header += "Content-Disposition: form-data; name=\"" + name + "\"\r\n";
                 header += "Content-Type: " + field.mime + "\r\n\r\n";
                 os.write(header.getBytes());
                 byte[] fieldData = field.data.getBytes();

src/android/src/main/java/com/RNFetchBlob/RNFetchBlobBody.java

@@ -513,7 +513,7 @@ private void done(Response resp) {
                 }
                 break;
         }
-        if(!resp.isSuccessful())
+//        if(!resp.isSuccessful())
             resp.body().close();
         releaseTaskResource();
     }

src/android/src/main/java/com/RNFetchBlob/RNFetchBlobReq.java

@@ -46,6 +46,12 @@ public RNFetchBlobFileResp(ReactApplicationContext ctx, String taskId, ResponseB
             path = path.replace("?append=true", "");
             mPath = path;
             File f = new File(path);
+
+            File parent = f.getParentFile();
+            if(!parent.exists() && !parent.mkdirs()){
+                throw new IllegalStateException("Couldn't create dir: " + parent);
+            }
+
             if(f.exists() == false)
                 f.createNewFile();
             ofStream = new FileOutputStream(new File(path), appendToExistingFile);

src/android/src/main/java/com/RNFetchBlob/Response/RNFetchBlobFileResp.java

@@ -29,14 +29,6 @@
                      body:(NSString *)body
                onComplete:(void(^)(NSURLRequest * req, long bodyLength))onComplete;
 
-+(void) buildEncodedRequest:(NSDictionary *)options
-                      taskId:(NSString *)taskId
-                      method:(NSString *)method
-                         url:(NSString *)url
-                     headers:(NSDictionary *)headers
-                        form:(NSString *)body
-                  onComplete:(void(^)(__weak NSURLRequest * req, long bodyLength))onComplete;
-
 +(NSString *) getHeaderIgnoreCases:(NSString *)field fromHeaders:(NSMutableArray *) headers;