| 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311 |
5x
5x
5x
5x
5x
5x
5x
5x
5x
5x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
28x
5x
28x
28x
1x
1x
27x
27x
27x
3x
27x
14x
3x
14x
14x
14x
14x
14x
14x
14x
15x
15x
15x
15x
14x
14x
13x
13x
1x
1x
1x
1x
1x
28x
28x
5x
51x
5x
1x
1x
1x
1x
1x
5x
14x
14x
14x
14x
14x
5x
5x
15x
15x
15x
5x
5x
28x
2x
5x
28x
28x
5x
28x
28x
28x
28x
28x
28x
| /**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview Defines methods used to actually send HTTP requests from
* abstract representations.
*/
import firebase from '@firebase/app';
import * as array from './array';
import * as backoff from './backoff';
import * as errorsExports from './error';
import { FirebaseStorageError } from './error';
import { errors } from './error';
import * as object from './object';
import * as promiseimpl from './promise_external';
import { RequestInfo } from './requestinfo';
import * as type from './type';
import * as UrlUtils from './url';
import * as XhrIoExports from './xhrio';
import { Headers, XhrIo } from './xhrio';
import { XhrIoPool } from './xhriopool';
/**
* @template T
*/
export interface Request<T> {
getPromise(): Promise<T>;
/**
* Cancels the request. IMPORTANT: the promise may still be resolved with an
* appropriate value (if the request is finished before you call this method,
* but the promise has not yet been resolved), so don't just assume it will be
* rejected if you call this function.
* @param appDelete True if the cancelation came from the app being deleted.
*/
cancel(appDelete?: boolean): void;
}
/**
* @struct
* @template T
*/
class NetworkRequest<T> implements Request<T> {
private url_: string;
private method_: string;
private headers_: Headers;
private body_: string | Blob | Uint8Array | null;
private successCodes_: number[];
private additionalRetryCodes_: number[];
private pendingXhr_: XhrIo | null = null;
private backoffId_: backoff.id | null = null;
private resolve_: Function | null = null;
private reject_: Function | null = null;
private canceled_: boolean = false;
private appDelete_: boolean = false;
private callback_: (p1: XhrIo, p2: string) => T;
private errorCallback_:
| ((p1: XhrIo, p2: FirebaseStorageError) => FirebaseStorageError)
| null;
private progressCallback_: ((p1: number, p2: number) => void) | null;
private timeout_: number;
private pool_: XhrIoPool;
promise_: Promise<T>;
constructor(
url: string,
method: string,
headers: Headers,
body: string | Blob | Uint8Array | null,
successCodes: number[],
additionalRetryCodes: number[],
callback: (p1: XhrIo, p2: string) => T,
errorCallback:
| ((p1: XhrIo, p2: FirebaseStorageError) => FirebaseStorageError)
| null,
timeout: number,
progressCallback: ((p1: number, p2: number) => void) | null,
pool: XhrIoPool
) {
this.url_ = url;
this.method_ = method;
this.headers_ = headers;
this.body_ = body;
this.successCodes_ = successCodes.slice();
this.additionalRetryCodes_ = additionalRetryCodes.slice();
this.callback_ = callback;
this.errorCallback_ = errorCallback;
this.progressCallback_ = progressCallback;
this.timeout_ = timeout;
this.pool_ = pool;
let self = this;
this.promise_ = promiseimpl.make(function(resolve, reject) {
self.resolve_ = resolve;
self.reject_ = reject;
self.start_();
});
}
/**
* Actually starts the retry loop.
*/
private start_() {
let self = this;
function doTheRequest(
backoffCallback: (p1: boolean, ...p2: any[]) => void,
canceled: boolean
) {
if (canceled) {
backoffCallback(false, new RequestEndStatus(false, null, true));
return;
}
let xhr = self.pool_.createXhrIo();
self.pendingXhr_ = xhr;
function progressListener(progressEvent: ProgressEvent) {
let loaded = progressEvent.loaded;
let total = progressEvent.lengthComputable ? progressEvent.total : -1;
if (self.progressCallback_ !== null) {
self.progressCallback_(loaded, total);
}
}
if (self.progressCallback_ !== null) {
xhr.addUploadProgressListener(progressListener);
}
xhr
.send(self.url_, self.method_, self.body_, self.headers_)
.then(function(xhr: XhrIo) {
if (self.progressCallback_ !== null) {
xhr.removeUploadProgressListener(progressListener);
}
self.pendingXhr_ = null;
xhr = xhr as XhrIo;
let hitServer =
xhr.getErrorCode() === XhrIoExports.ErrorCode.NO_ERROR;
let status = xhr.getStatus();
Iif (!hitServer || self.isRetryStatusCode_(status)) {
let wasCanceled =
xhr.getErrorCode() === XhrIoExports.ErrorCode.ABORT;
backoffCallback(
false,
new RequestEndStatus(false, null, wasCanceled)
);
return;
}
let successCode = array.contains(self.successCodes_, status);
backoffCallback(true, new RequestEndStatus(successCode, xhr));
});
}
/**
* @param requestWentThrough True if the request eventually went
* through, false if it hit the retry limit or was canceled.
*/
function backoffDone(
requestWentThrough: boolean,
status: RequestEndStatus
) {
let resolve = self.resolve_ as Function;
let reject = self.reject_ as Function;
let xhr = status.xhr as XhrIo;
if (status.wasSuccessCode) {
try {
let result = self.callback_(xhr, xhr.getResponseText());
Eif (type.isJustDef(result)) {
resolve(result);
} else {
resolve();
}
} catch (e) {
reject(e);
}
} else {
Iif (xhr !== null) {
let err = errorsExports.unknown();
err.setServerResponseProp(xhr.getResponseText());
if (self.errorCallback_) {
reject(self.errorCallback_(xhr, err));
} else {
reject(err);
}
} else {
Eif (status.canceled) {
let err = self.appDelete_
? errorsExports.appDeleted()
: errorsExports.canceled();
reject(err);
} else {
let err = errorsExports.retryLimitExceeded();
reject(err);
}
}
}
}
Iif (this.canceled_) {
backoffDone(false, new RequestEndStatus(false, null, true));
} else {
this.backoffId_ = backoff.start(doTheRequest, backoffDone, this.timeout_);
}
}
/** @inheritDoc */
getPromise() {
return this.promise_;
}
/** @inheritDoc */
cancel(appDelete?: boolean) {
this.canceled_ = true;
this.appDelete_ = appDelete || false;
Eif (this.backoffId_ !== null) {
backoff.stop(this.backoffId_);
}
Iif (this.pendingXhr_ !== null) {
this.pendingXhr_.abort();
}
}
private isRetryStatusCode_(status: number): boolean {
// The codes for which to retry came from this page:
// https://cloud.google.com/storage/docs/exponential-backoff
let isFiveHundredCode = status >= 500 && status < 600;
let extraRetryCodes = [
// Request Timeout: web server didn't receive full request in time.
408,
// Too Many Requests: you're getting rate-limited, basically.
429
];
let isExtraRetryCode = array.contains(extraRetryCodes, status);
let isRequestSpecificRetryCode = array.contains(
this.additionalRetryCodes_,
status
);
return isFiveHundredCode || isExtraRetryCode || isRequestSpecificRetryCode;
}
}
/**
* A collection of information about the result of a network request.
* @param opt_canceled Defaults to false.
* @struct
*/
export class RequestEndStatus {
/**
* True if the request was canceled.
*/
canceled: boolean;
constructor(
public wasSuccessCode: boolean,
public xhr: XhrIo | null,
opt_canceled?: boolean
) {
this.canceled = !!opt_canceled;
}
}
export function addAuthHeader_(headers: Headers, authToken: string | null) {
if (authToken !== null && authToken.length > 0) {
headers['Authorization'] = 'Firebase ' + authToken;
}
}
export function addVersionHeader_(headers: Headers) {
let number =
typeof firebase !== 'undefined' ? firebase.SDK_VERSION : 'AppManager';
headers['X-Firebase-Storage-Version'] = 'webjs/' + number;
}
/**
* @template T
*/
export function makeRequest<T>(
requestInfo: RequestInfo<T>,
authToken: string | null,
pool: XhrIoPool
): Request<T> {
let queryPart = UrlUtils.makeQueryString(requestInfo.urlParams);
let url = requestInfo.url + queryPart;
let headers = object.clone<Headers>(requestInfo.headers);
addAuthHeader_(headers, authToken);
addVersionHeader_(headers);
return new NetworkRequest<T>(
url,
requestInfo.method,
headers,
requestInfo.body,
requestInfo.successCodes,
requestInfo.additionalRetryCodes,
requestInfo.handler,
requestInfo.errorHandler,
requestInfo.timeout,
requestInfo.progressCallback,
pool
);
}
|