2015-09-14 14:35:58 +00:00
|
|
|
/**
|
|
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* This source code is licensed under the BSD-style license found in the
|
|
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
|
|
*
|
|
|
|
* @providesModule RCTNetworking
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
* @flow
|
2015-09-14 14:35:58 +00:00
|
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
|
|
|
|
// Do not require the native RCTNetworking module directly! Use this wrapper module instead.
|
|
|
|
// It will add the necessary requestId, so that you don't have to generate it yourself.
|
2017-06-01 15:20:57 +00:00
|
|
|
const MissingNativeEventEmitterShim = require('MissingNativeEventEmitterShim');
|
2016-05-25 11:17:35 +00:00
|
|
|
const NativeEventEmitter = require('NativeEventEmitter');
|
|
|
|
const RCTNetworkingNative = require('NativeModules').Networking;
|
2017-01-21 02:40:28 +00:00
|
|
|
const convertRequestBody = require('convertRequestBody');
|
|
|
|
|
|
|
|
import type {RequestBody} from 'convertRequestBody';
|
2015-09-14 14:35:58 +00:00
|
|
|
|
2016-05-25 11:17:35 +00:00
|
|
|
type Header = [string, string];
|
|
|
|
|
2017-01-21 02:40:28 +00:00
|
|
|
// Convert FormData headers to arrays, which are easier to consume in
|
|
|
|
// native on Android.
|
2016-05-25 11:17:35 +00:00
|
|
|
function convertHeadersMapToArray(headers: Object): Array<Header> {
|
|
|
|
const headerArray = [];
|
|
|
|
for (const name in headers) {
|
|
|
|
headerArray.push([name, headers[name]]);
|
|
|
|
}
|
|
|
|
return headerArray;
|
|
|
|
}
|
|
|
|
|
|
|
|
let _requestId = 1;
|
2016-07-12 00:53:35 +00:00
|
|
|
function generateRequestId(): number {
|
2015-09-14 14:35:58 +00:00
|
|
|
return _requestId++;
|
2016-05-25 11:17:35 +00:00
|
|
|
}
|
2015-09-14 14:35:58 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This class is a wrapper around the native RCTNetworking module. It adds a necessary unique
|
|
|
|
* requestId to each network request that can be used to abort that request later on.
|
|
|
|
*/
|
2016-05-25 11:17:35 +00:00
|
|
|
class RCTNetworking extends NativeEventEmitter {
|
|
|
|
|
2017-06-01 15:20:57 +00:00
|
|
|
isAvailable: boolean = true;
|
|
|
|
|
2016-05-25 11:17:35 +00:00
|
|
|
constructor() {
|
|
|
|
super(RCTNetworkingNative);
|
|
|
|
}
|
2015-09-14 14:35:58 +00:00
|
|
|
|
2016-07-12 00:53:35 +00:00
|
|
|
sendRequest(
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
method: string,
|
2016-07-12 00:53:35 +00:00
|
|
|
trackingName: string,
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
url: string,
|
2016-07-12 00:53:35 +00:00
|
|
|
headers: Object,
|
2017-01-21 02:40:28 +00:00
|
|
|
data: RequestBody,
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
responseType: 'text' | 'base64',
|
2016-07-12 00:53:35 +00:00
|
|
|
incrementalUpdates: boolean,
|
|
|
|
timeout: number,
|
2017-04-11 05:32:38 +00:00
|
|
|
callback: (requestId: number) => any,
|
|
|
|
withCredentials: boolean
|
2016-07-12 00:53:35 +00:00
|
|
|
) {
|
2017-01-21 02:40:28 +00:00
|
|
|
const body = convertRequestBody(data);
|
|
|
|
if (body && body.formData) {
|
|
|
|
body.formData = body.formData.map((part) => ({
|
|
|
|
...part,
|
|
|
|
headers: convertHeadersMapToArray(part.headers),
|
|
|
|
}));
|
|
|
|
}
|
2016-05-25 11:17:35 +00:00
|
|
|
const requestId = generateRequestId();
|
2015-09-14 14:35:58 +00:00
|
|
|
RCTNetworkingNative.sendRequest(
|
|
|
|
method,
|
|
|
|
url,
|
|
|
|
requestId,
|
2016-05-25 11:17:35 +00:00
|
|
|
convertHeadersMapToArray(headers),
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
{...body, trackingName},
|
|
|
|
responseType,
|
2016-05-25 11:17:35 +00:00
|
|
|
incrementalUpdates,
|
2017-04-11 05:32:38 +00:00
|
|
|
timeout,
|
|
|
|
withCredentials
|
2016-05-25 11:17:35 +00:00
|
|
|
);
|
|
|
|
callback(requestId);
|
2015-09-14 14:35:58 +00:00
|
|
|
}
|
|
|
|
|
2016-07-12 00:53:35 +00:00
|
|
|
abortRequest(requestId: number) {
|
2015-09-14 14:35:58 +00:00
|
|
|
RCTNetworkingNative.abortRequest(requestId);
|
|
|
|
}
|
2015-11-23 10:16:51 +00:00
|
|
|
|
Add responseType as a concept to RCTNetworking, send binary data as base64
Summary:
In preparation for Blob support (wherein binary XHR and WebSocket responses can be retained as native data blobs on the native side and JS receives a web-like opaque Blob object), this change makes RCTNetworking aware of the responseType that JS requests. A `xhr.responseType` of `''` or `'text'` translates to a native response type of `'text'`. A `xhr.responseType` of `arraybuffer` translates to a native response type of `base64`, as we currently lack an API to transmit TypedArrays directly to JS. This is analogous to how the WebSocket module already works, and it's a lot more versatile and much less brittle than converting a JS *string* back to a TypedArray, which is what's currently going on.
Now that we don't always send text down to JS, JS consumers might still want to get progress updates about a binary download. This is what the `'progress'` event is designed for, so this change also implements that. This change also follows the XHR spec with regards to `xhr.response` and `xhr.responseText`:
- if the response type is `'text'`, `xhr.responseText` can be peeked at by the JS consumer. It will be updated periodically as the download progresses, so long as there's either an `onreadystatechange` or `onprogress` handler on the XHR.
- if the response type is not `'text'`, `xhr.responseText` can't be accessed and `xhr.response` remains `null` until the response is fully received. `'progress'` events containing response details (total bytes, downloaded so far) are dispatched if there's an `onprogress` handler.
Once Blobs are landed, `xhr.responseType` of `'blob'` will correspond to the same native response type, which will cause RCTNetworking to only send a blob ID down to JS, which can then create a `Blob` object from that for consumers.
Closes https://github.com/facebook/react-native/pull/8324
Reviewed By: javache
Differential Revision: D3508822
Pulled By: davidaurelio
fbshipit-source-id: 441b2d4d40265b6036559c3ccb9fa962999fa5df
2016-07-13 11:53:54 +00:00
|
|
|
clearCookies(callback: (result: boolean) => any) {
|
2015-11-23 10:16:51 +00:00
|
|
|
RCTNetworkingNative.clearCookies(callback);
|
|
|
|
}
|
2015-09-14 14:35:58 +00:00
|
|
|
}
|
|
|
|
|
2017-06-01 15:20:57 +00:00
|
|
|
if (__DEV__ && !RCTNetworkingNative) {
|
|
|
|
class MissingNativeRCTNetworkingShim extends MissingNativeEventEmitterShim {
|
|
|
|
constructor() {
|
2017-07-11 16:04:47 +00:00
|
|
|
super('RCTNetworking', 'Networking');
|
2017-06-01 15:20:57 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
sendRequest(...args: Array<any>) {
|
|
|
|
this.throwMissingNativeModule();
|
|
|
|
}
|
|
|
|
|
|
|
|
abortRequest(...args: Array<any>) {
|
|
|
|
this.throwMissingNativeModule();
|
|
|
|
}
|
|
|
|
|
|
|
|
clearCookies(...args: Array<any>) {
|
|
|
|
this.throwMissingNativeModule();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// This module depends on the native `RCTNetworkingNative` module. If you don't include it,
|
|
|
|
// `RCTNetworking.isAvailable` will return `false`, and any method calls will throw.
|
|
|
|
// We reassign the class variable to keep the autodoc generator happy.
|
|
|
|
RCTNetworking = new MissingNativeRCTNetworkingShim();
|
|
|
|
} else {
|
|
|
|
RCTNetworking = new RCTNetworking();
|
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = RCTNetworking;
|