@kesha-antonov/react-native-background-downloader 4.6.4 → 4.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +95 -30
- package/android/src/main/java/com/eko/DownloadConstants.kt +18 -2
- package/android/src/main/java/com/eko/DownloadResult.kt +3 -1
- package/android/src/main/java/com/eko/Downloader.kt +37 -9
- package/android/src/main/java/com/eko/ProgressReporter.kt +14 -35
- package/android/src/main/java/com/eko/RNBGDUploadTaskConfig.kt +36 -1
- package/android/src/main/java/com/eko/RNBackgroundDownloaderModuleImpl.kt +243 -117
- package/android/src/main/java/com/eko/ResumableDownloadService.kt +2 -1
- package/android/src/main/java/com/eko/ResumableDownloader.kt +109 -16
- package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +34 -8
- package/android/src/main/java/com/eko/UnmeteredNetworkGate.kt +134 -17
- package/android/src/main/java/com/eko/UploadEventEmitter.kt +26 -1
- package/android/src/main/java/com/eko/Uploader.kt +202 -28
- package/android/src/main/java/com/eko/handlers/OnBegin.kt +6 -1
- package/android/src/main/java/com/eko/handlers/OnProgress.kt +1 -1
- package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +3 -1
- package/android/src/main/java/com/eko/uidt/UIDTJobManager.kt +18 -2
- package/android/src/main/java/com/eko/utils/HeaderUtils.kt +9 -0
- package/android/src/main/java/com/eko/utils/RedirectResolver.kt +32 -12
- package/android/src/main/java/com/eko/utils/StorageManager.kt +5 -0
- package/android/src/test/java/com/eko/DownloadCompleteReceiverTest.kt +57 -0
- package/android/src/test/java/com/eko/DownloaderRecoveryTest.kt +78 -0
- package/android/src/test/java/com/eko/DownloaderResumeTest.kt +97 -0
- package/android/src/test/java/com/eko/ResumableDownloaderRedirectTest.kt +77 -0
- package/android/src/test/java/com/eko/ResumableDownloaderStallTest.kt +145 -0
- package/android/src/test/java/com/eko/UnmeteredNetworkGateTest.kt +248 -0
- package/android/src/test/java/com/eko/UploadPartRangesTest.kt +33 -0
- package/android/src/test/java/com/eko/UploaderMultipartTest.kt +93 -0
- package/android/src/test/java/com/eko/UploaderPartsTest.kt +222 -0
- package/android/src/test/java/com/eko/UploaderResponseTest.kt +26 -0
- package/android/src/test/java/com/eko/handlers/OnBeginTest.kt +51 -0
- package/android/src/test/java/com/eko/uidt/CancelDownloadReceiverTest.kt +84 -0
- package/android/src/test/java/com/eko/utils/RedirectResolverTest.kt +133 -0
- package/ios/RNBGDTaskConfig.h +2 -0
- package/ios/RNBGDTaskConfig.mm +6 -0
- package/ios/RNBGDUploadTaskConfig.h +26 -0
- package/ios/RNBGDUploadTaskConfig.mm +69 -3
- package/ios/RNBackgroundDownloader.mm +1203 -133
- package/lib/DownloadTask.d.ts +2 -0
- package/lib/DownloadTask.js +17 -1
- package/lib/NativeRNBackgroundDownloader.d.ts +15 -0
- package/lib/UploadTask.d.ts +7 -1
- package/lib/UploadTask.js +38 -4
- package/lib/index.d.ts +1 -1
- package/lib/index.js +105 -61
- package/lib/types.d.ts +33 -2
- package/package.json +14 -11
- package/plugin/build/index.d.ts +1 -0
- package/plugin/build/index.js +18 -10
- package/react-native-background-downloader.podspec +8 -0
- package/src/DownloadTask.ts +18 -1
- package/src/NativeRNBackgroundDownloader.ts +23 -0
- package/src/UploadTask.ts +41 -2
- package/src/index.ts +131 -66
- package/src/types.ts +42 -2
package/src/index.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { NativeModules, Platform, TurboModuleRegistry, NativeEventEmitter
|
|
1
|
+
import { NativeModules, Platform, TurboModuleRegistry, NativeEventEmitter } from 'react-native'
|
|
2
2
|
import { DownloadTask } from './DownloadTask'
|
|
3
3
|
import { UploadTask } from './UploadTask'
|
|
4
|
-
import { Config, DownloadParams, Headers, Metadata, TaskInfo, TaskInfoNative, UploadParams, UploadTaskInfo, UploadTaskInfoNative } from './types'
|
|
5
|
-
import { config,
|
|
4
|
+
import { Config, DownloadParams, Headers, Metadata, TaskInfo, TaskInfoNative, UploadParams, UploadPartResult, UploadTaskInfo, UploadTaskInfoNative } from './types'
|
|
5
|
+
import { config, DEFAULT_NOTIFICATION_TEXTS } from './config'
|
|
6
6
|
import { log } from './logger'
|
|
7
7
|
import { getNotificationTextsForNative } from './notifications'
|
|
8
8
|
import { tasksMap, uploadTasksMap } from './tasks'
|
|
@@ -16,6 +16,20 @@ type RNBackgroundDownloaderModule = Spec & {
|
|
|
16
16
|
documents: string
|
|
17
17
|
}
|
|
18
18
|
|
|
19
|
+
// What NativeEventEmitter needs from a native module. React Native 0.88's strict
|
|
20
|
+
// TypeScript API no longer exports the NativeModule type
|
|
21
|
+
type NativeModule = {
|
|
22
|
+
addListener: (eventType: string) => void
|
|
23
|
+
removeListeners: (count: number) => void
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
// The emitter's listener types differ between React Native versions, so the
|
|
27
|
+
// payload types are named in each handler instead
|
|
28
|
+
type EventEmitterWithPayloads = {
|
|
29
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
30
|
+
addListener: (eventType: string, listener: (data: any) => void) => { remove: () => void }
|
|
31
|
+
}
|
|
32
|
+
|
|
19
33
|
// Lazy initialization state
|
|
20
34
|
let RNBackgroundDownloader: (RNBackgroundDownloaderModule & NativeModule) | null = null
|
|
21
35
|
let turboModule: Spec | null = null
|
|
@@ -32,7 +46,7 @@ function ensureNativeModuleInitialized (): RNBackgroundDownloaderModule & Native
|
|
|
32
46
|
return RNBackgroundDownloader
|
|
33
47
|
|
|
34
48
|
// Try TurboModules first
|
|
35
|
-
turboModule = TurboModuleRegistry.get<Spec>('RNBackgroundDownloader')
|
|
49
|
+
turboModule = TurboModuleRegistry.get<Spec>('RNBackgroundDownloader') ?? null
|
|
36
50
|
// Check if iOS new architecture event emitters are available
|
|
37
51
|
// On Android, we always use NativeEventEmitter because Android uses RCTDeviceEventEmitter
|
|
38
52
|
isIOSNewArchitecture = Platform.OS === 'ios' && turboModule != null && typeof turboModule.onDownloadBegin === 'function'
|
|
@@ -112,10 +126,47 @@ interface UploadCompleteEvent {
|
|
|
112
126
|
id: string
|
|
113
127
|
responseCode: number
|
|
114
128
|
responseBody: string
|
|
129
|
+
responseHeaders?: Record<string, string>
|
|
130
|
+
parts?: UploadPartResult[]
|
|
115
131
|
bytesUploaded: number
|
|
116
132
|
bytesTotal: number
|
|
117
133
|
}
|
|
118
134
|
|
|
135
|
+
// Apps forward logs to remote services: log response header names and the body
|
|
136
|
+
// size, not values that can carry cookies or tokens
|
|
137
|
+
function loggableBegin ({ headers, ...rest }: Omit<DownloadBeginEvent, 'id'>) {
|
|
138
|
+
return { ...rest, headers: Object.keys(headers ?? {}) }
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
function loggableUploadComplete ({ responseBody, responseHeaders, parts, ...rest }: Omit<UploadCompleteEvent, 'id'>) {
|
|
142
|
+
return {
|
|
143
|
+
...rest,
|
|
144
|
+
responseBodyLength: responseBody?.length ?? 0,
|
|
145
|
+
responseHeaders: Object.keys(responseHeaders ?? {}),
|
|
146
|
+
parts: parts?.length,
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
function handleUploadComplete (data: UploadCompleteEvent) {
|
|
151
|
+
const { id, responseHeaders, ...rest } = data
|
|
152
|
+
log('uploadComplete', id, loggableUploadComplete(data))
|
|
153
|
+
const task = uploadTasksMap.get(id)
|
|
154
|
+
if (!task) {
|
|
155
|
+
// Nobody received it: after a relaunch, iOS can deliver a finished upload
|
|
156
|
+
// before the app has called getExistingUploadTasks. Native keeps the
|
|
157
|
+
// response, so that call still returns it as DONE.
|
|
158
|
+
log('uploadComplete: task not found in uploadTasksMap', id)
|
|
159
|
+
return
|
|
160
|
+
}
|
|
161
|
+
// iOS keeps a finished upload's response until JS has it, so an upload that
|
|
162
|
+
// finishes while the app isn't listening still reaches getExistingUploadTasks.
|
|
163
|
+
// This one was delivered: let native drop it. Sent before the handlers run, so it
|
|
164
|
+
// can't race an upload the done handler starts with the same id.
|
|
165
|
+
ensureNativeModuleInitialized().stopUploadTask?.(id)?.catch(() => {})
|
|
166
|
+
task.onDone({ ...rest, responseHeaders: responseHeaders ?? {} })
|
|
167
|
+
uploadTasksMap.delete(id)
|
|
168
|
+
}
|
|
169
|
+
|
|
119
170
|
interface UploadFailedEvent {
|
|
120
171
|
id: string
|
|
121
172
|
error: string
|
|
@@ -153,18 +204,18 @@ function initializeEventListeners () {
|
|
|
153
204
|
|
|
154
205
|
if (isIOSNewArchitecture && turboModule) {
|
|
155
206
|
// iOS new architecture: use EventEmitter from TurboModule spec
|
|
156
|
-
turboModule.onDownloadBegin((data: DownloadBeginEvent) => {
|
|
207
|
+
eventSubscriptions.push(turboModule.onDownloadBegin((data: DownloadBeginEvent) => {
|
|
157
208
|
const { id, ...rest } = data
|
|
158
|
-
log('downloadBegin', id, rest)
|
|
209
|
+
log('downloadBegin', id, loggableBegin(rest))
|
|
159
210
|
const task = tasksMap.get(id)
|
|
160
211
|
if (!task) {
|
|
161
212
|
log('downloadBegin: task not found in tasksMap', id)
|
|
162
213
|
return
|
|
163
214
|
}
|
|
164
215
|
task.onBegin(rest)
|
|
165
|
-
})
|
|
216
|
+
}))
|
|
166
217
|
|
|
167
|
-
turboModule.onDownloadProgress((events: DownloadProgressEvent[]) => {
|
|
218
|
+
eventSubscriptions.push(turboModule.onDownloadProgress((events: DownloadProgressEvent[]) => {
|
|
168
219
|
log('downloadProgress', events)
|
|
169
220
|
for (const event of events) {
|
|
170
221
|
const { id, ...rest } = event
|
|
@@ -172,9 +223,9 @@ function initializeEventListeners () {
|
|
|
172
223
|
if (task)
|
|
173
224
|
task.onProgress(rest)
|
|
174
225
|
}
|
|
175
|
-
})
|
|
226
|
+
}))
|
|
176
227
|
|
|
177
|
-
turboModule.onDownloadComplete((data: DownloadCompleteEvent) => {
|
|
228
|
+
eventSubscriptions.push(turboModule.onDownloadComplete((data: DownloadCompleteEvent) => {
|
|
178
229
|
const { id, ...rest } = data
|
|
179
230
|
log('downloadComplete', id, rest)
|
|
180
231
|
const task = tasksMap.get(id)
|
|
@@ -183,9 +234,9 @@ function initializeEventListeners () {
|
|
|
183
234
|
else
|
|
184
235
|
task.onDone(rest)
|
|
185
236
|
tasksMap.delete(id)
|
|
186
|
-
})
|
|
237
|
+
}))
|
|
187
238
|
|
|
188
|
-
turboModule.onDownloadFailed((data: DownloadFailedEvent) => {
|
|
239
|
+
eventSubscriptions.push(turboModule.onDownloadFailed((data: DownloadFailedEvent) => {
|
|
189
240
|
const { id, ...rest } = data
|
|
190
241
|
log('downloadFailed', id, rest)
|
|
191
242
|
const task = tasksMap.get(id)
|
|
@@ -194,11 +245,11 @@ function initializeEventListeners () {
|
|
|
194
245
|
else
|
|
195
246
|
task.onError(rest)
|
|
196
247
|
tasksMap.delete(id)
|
|
197
|
-
})
|
|
248
|
+
}))
|
|
198
249
|
|
|
199
250
|
// Upload events for new architecture (optional - may not exist in all versions)
|
|
200
251
|
if (typeof turboModule.onUploadBegin === 'function') {
|
|
201
|
-
turboModule.onUploadBegin
|
|
252
|
+
eventSubscriptions.push(turboModule.onUploadBegin!((data: UploadBeginEvent) => {
|
|
202
253
|
const { id, ...rest } = data
|
|
203
254
|
log('uploadBegin', id, rest)
|
|
204
255
|
const task = uploadTasksMap.get(id)
|
|
@@ -207,9 +258,9 @@ function initializeEventListeners () {
|
|
|
207
258
|
return
|
|
208
259
|
}
|
|
209
260
|
task.onBegin(rest)
|
|
210
|
-
})
|
|
261
|
+
}))
|
|
211
262
|
|
|
212
|
-
turboModule.onUploadProgress
|
|
263
|
+
eventSubscriptions.push(turboModule.onUploadProgress!((events: UploadProgressEvent[]) => {
|
|
213
264
|
log('uploadProgress', events)
|
|
214
265
|
for (const event of events) {
|
|
215
266
|
const { id, ...rest } = event
|
|
@@ -217,20 +268,11 @@ function initializeEventListeners () {
|
|
|
217
268
|
if (task)
|
|
218
269
|
task.onProgress(rest)
|
|
219
270
|
}
|
|
220
|
-
})
|
|
271
|
+
}))
|
|
221
272
|
|
|
222
|
-
turboModule.onUploadComplete
|
|
223
|
-
const { id, ...rest } = data
|
|
224
|
-
log('uploadComplete', id, rest)
|
|
225
|
-
const task = uploadTasksMap.get(id)
|
|
226
|
-
if (!task)
|
|
227
|
-
log('uploadComplete: task not found in uploadTasksMap', id)
|
|
228
|
-
else
|
|
229
|
-
task.onDone(rest)
|
|
230
|
-
uploadTasksMap.delete(id)
|
|
231
|
-
})
|
|
273
|
+
eventSubscriptions.push(turboModule.onUploadComplete!(handleUploadComplete))
|
|
232
274
|
|
|
233
|
-
turboModule.onUploadFailed
|
|
275
|
+
eventSubscriptions.push(turboModule.onUploadFailed!((data: UploadFailedEvent) => {
|
|
234
276
|
const { id, ...rest } = data
|
|
235
277
|
log('uploadFailed', id, rest)
|
|
236
278
|
const task = uploadTasksMap.get(id)
|
|
@@ -239,19 +281,19 @@ function initializeEventListeners () {
|
|
|
239
281
|
else
|
|
240
282
|
task.onError(rest)
|
|
241
283
|
uploadTasksMap.delete(id)
|
|
242
|
-
})
|
|
284
|
+
}))
|
|
243
285
|
}
|
|
244
286
|
} else {
|
|
245
287
|
// Old architecture: use NativeEventEmitter with the native module
|
|
246
288
|
// RCTEventEmitter on native side requires NativeEventEmitter on JS side
|
|
247
289
|
// RNBackgroundDownloader is guaranteed to be non-null here since initializeEventListeners
|
|
248
290
|
// is only called after ensureNativeModuleInitialized() succeeds
|
|
249
|
-
const eventEmitter = new NativeEventEmitter(RNBackgroundDownloader!)
|
|
291
|
+
const eventEmitter: EventEmitterWithPayloads = new NativeEventEmitter(RNBackgroundDownloader!)
|
|
250
292
|
|
|
251
293
|
eventSubscriptions.push(
|
|
252
294
|
eventEmitter.addListener('downloadBegin', (data: DownloadBeginEvent) => {
|
|
253
295
|
const { id, ...rest } = data
|
|
254
|
-
log('downloadBegin', id, rest)
|
|
296
|
+
log('downloadBegin', id, loggableBegin(rest))
|
|
255
297
|
const task = tasksMap.get(id)
|
|
256
298
|
if (!task) {
|
|
257
299
|
log('downloadBegin: task not found in tasksMap', id)
|
|
@@ -326,16 +368,7 @@ function initializeEventListeners () {
|
|
|
326
368
|
)
|
|
327
369
|
|
|
328
370
|
eventSubscriptions.push(
|
|
329
|
-
eventEmitter.addListener('uploadComplete',
|
|
330
|
-
const { id, ...rest } = data
|
|
331
|
-
log('uploadComplete', id, rest)
|
|
332
|
-
const task = uploadTasksMap.get(id)
|
|
333
|
-
if (!task)
|
|
334
|
-
log('uploadComplete: task not found in uploadTasksMap', id)
|
|
335
|
-
else
|
|
336
|
-
task.onDone(rest)
|
|
337
|
-
uploadTasksMap.delete(id)
|
|
338
|
-
})
|
|
371
|
+
eventEmitter.addListener('uploadComplete', handleUploadComplete)
|
|
339
372
|
)
|
|
340
373
|
|
|
341
374
|
eventSubscriptions.push(
|
|
@@ -363,11 +396,12 @@ function initializeEventListeners () {
|
|
|
363
396
|
// Event listeners are now initialized lazily when ensureNativeModuleInitialized() is called
|
|
364
397
|
// This ensures the bridge is ready before any native module access
|
|
365
398
|
|
|
399
|
+
// Only the options passed are changed; the rest keep their current values
|
|
366
400
|
export function setConfig ({
|
|
367
|
-
headers
|
|
368
|
-
progressInterval
|
|
369
|
-
progressMinBytes
|
|
370
|
-
isLogsEnabled
|
|
401
|
+
headers,
|
|
402
|
+
progressInterval,
|
|
403
|
+
progressMinBytes,
|
|
404
|
+
isLogsEnabled,
|
|
371
405
|
logCallback,
|
|
372
406
|
maxParallelDownloads,
|
|
373
407
|
allowsCellularAccess,
|
|
@@ -377,20 +411,23 @@ export function setConfig ({
|
|
|
377
411
|
notificationsGrouping,
|
|
378
412
|
iosDataProtection,
|
|
379
413
|
}: Config) {
|
|
380
|
-
|
|
414
|
+
if (headers !== undefined)
|
|
415
|
+
config.headers = headers
|
|
381
416
|
|
|
382
417
|
if (iosDataProtection !== undefined)
|
|
383
418
|
config.iosDataProtection = iosDataProtection
|
|
384
419
|
|
|
385
|
-
if (progressInterval
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
420
|
+
if (progressInterval !== undefined)
|
|
421
|
+
if (progressInterval >= MIN_PROGRESS_INTERVAL)
|
|
422
|
+
config.progressInterval = progressInterval
|
|
423
|
+
else
|
|
424
|
+
console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= ${MIN_PROGRESS_INTERVAL}. You passed ${progressInterval}`)
|
|
389
425
|
|
|
390
|
-
if (progressMinBytes
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
426
|
+
if (progressMinBytes !== undefined)
|
|
427
|
+
if (progressMinBytes >= 0)
|
|
428
|
+
config.progressMinBytes = progressMinBytes
|
|
429
|
+
else
|
|
430
|
+
console.warn(`[RNBackgroundDownloader] progressMinBytes must be a number >= 0. You passed ${progressMinBytes}`)
|
|
394
431
|
|
|
395
432
|
if (maxParallelDownloads !== undefined)
|
|
396
433
|
if (maxParallelDownloads >= 1)
|
|
@@ -423,8 +460,10 @@ export function setConfig ({
|
|
|
423
460
|
},
|
|
424
461
|
}
|
|
425
462
|
|
|
426
|
-
|
|
427
|
-
|
|
463
|
+
if (isLogsEnabled !== undefined)
|
|
464
|
+
config.isLogsEnabled = isLogsEnabled
|
|
465
|
+
if (logCallback !== undefined)
|
|
466
|
+
config.logCallback = logCallback
|
|
428
467
|
|
|
429
468
|
// Notify native side about configuration changes
|
|
430
469
|
try {
|
|
@@ -441,7 +480,7 @@ export function setConfig ({
|
|
|
441
480
|
texts: Record<string, string>
|
|
442
481
|
}) => void
|
|
443
482
|
}
|
|
444
|
-
if (nativeModule.setLogsEnabled)
|
|
483
|
+
if (nativeModule.setLogsEnabled && isLogsEnabled !== undefined)
|
|
445
484
|
nativeModule.setLogsEnabled(isLogsEnabled)
|
|
446
485
|
// Only call native methods if config was successfully updated
|
|
447
486
|
if (nativeModule.setMaxParallelDownloads && maxParallelDownloads !== undefined && maxParallelDownloads >= 1)
|
|
@@ -498,7 +537,8 @@ export const getExistingDownloadTasks = async (): Promise<DownloadTask[]> => {
|
|
|
498
537
|
if (taskInfo.errorCode === -999) {
|
|
499
538
|
task.state = 'PAUSED'
|
|
500
539
|
} else {
|
|
501
|
-
task
|
|
540
|
+
// Not awaited: the task is dropped either way, so a failed stop isn't actionable
|
|
541
|
+
task.stop().catch(() => {})
|
|
502
542
|
return undefined
|
|
503
543
|
}
|
|
504
544
|
break
|
|
@@ -533,8 +573,12 @@ export const completeHandler = (jobId: string) => {
|
|
|
533
573
|
|
|
534
574
|
export function createDownloadTask ({
|
|
535
575
|
isAllowedOverRoaming = true,
|
|
536
|
-
|
|
576
|
+
// Follows setConfig({ allowsCellularAccess }) unless the task sets its own
|
|
577
|
+
isAllowedOverMetered = config.allowsCellularAccess,
|
|
537
578
|
metadata,
|
|
579
|
+
groupId,
|
|
580
|
+
groupName,
|
|
581
|
+
notificationTitle,
|
|
538
582
|
...rest
|
|
539
583
|
}: TaskInfo & DownloadParams) {
|
|
540
584
|
// Ensure native module and event listeners are initialized before creating tasks
|
|
@@ -547,9 +591,14 @@ export function createDownloadTask ({
|
|
|
547
591
|
|
|
548
592
|
rest.destination = rest.destination.replace('file://', '')
|
|
549
593
|
|
|
594
|
+
// Native reads the notification fields from metadata only
|
|
595
|
+
const notificationFields = Object.fromEntries(
|
|
596
|
+
Object.entries({ groupId, groupName, notificationTitle }).filter(([, value]) => value !== undefined)
|
|
597
|
+
)
|
|
598
|
+
|
|
550
599
|
const task = new DownloadTask({
|
|
551
600
|
id: rest.id,
|
|
552
|
-
metadata,
|
|
601
|
+
metadata: Object.keys(notificationFields).length > 0 ? { ...metadata, ...notificationFields } : metadata,
|
|
553
602
|
})
|
|
554
603
|
|
|
555
604
|
task.setDownloadParams({
|
|
@@ -603,17 +652,22 @@ export const getExistingUploadTasks = async (): Promise<UploadTask[]> => {
|
|
|
603
652
|
if (taskInfo.errorCode === -999) {
|
|
604
653
|
task.state = 'PAUSED'
|
|
605
654
|
} else {
|
|
606
|
-
task
|
|
655
|
+
// Not awaited: the task is dropped either way, so a failed stop isn't actionable
|
|
656
|
+
task.stop().catch(() => {})
|
|
607
657
|
return undefined
|
|
608
658
|
}
|
|
609
659
|
break
|
|
610
660
|
}
|
|
611
661
|
case nativeModule.TaskCompleted: {
|
|
612
|
-
if (taskInfo.bytesUploaded === taskInfo.bytesTotal)
|
|
662
|
+
if (taskInfo.bytesUploaded === taskInfo.bytesTotal) {
|
|
613
663
|
task.state = 'DONE'
|
|
614
|
-
|
|
664
|
+
// Finished while the app wasn't listening: the task carries the response
|
|
665
|
+
// now, so native can drop its copy
|
|
666
|
+
nativeModule.stopUploadTask?.(task.id)?.catch(() => {})
|
|
667
|
+
} else {
|
|
615
668
|
// IOS completed the upload but it was not done.
|
|
616
669
|
return undefined
|
|
670
|
+
}
|
|
617
671
|
}
|
|
618
672
|
}
|
|
619
673
|
|
|
@@ -628,15 +682,26 @@ export const getExistingUploadTasks = async (): Promise<UploadTask[]> => {
|
|
|
628
682
|
|
|
629
683
|
export function createUploadTask ({
|
|
630
684
|
isAllowedOverRoaming = true,
|
|
631
|
-
|
|
685
|
+
// Follows setConfig({ allowsCellularAccess }) unless the task sets its own
|
|
686
|
+
isAllowedOverMetered = config.allowsCellularAccess,
|
|
632
687
|
metadata,
|
|
633
688
|
...rest
|
|
634
689
|
}: UploadTaskInfo & UploadParams) {
|
|
635
690
|
// Ensure native module and event listeners are initialized before creating tasks
|
|
636
691
|
ensureNativeModuleInitialized()
|
|
637
692
|
|
|
638
|
-
if (
|
|
639
|
-
|
|
693
|
+
if (rest.partUrls !== undefined) {
|
|
694
|
+
if (!Array.isArray(rest.partUrls) || rest.partUrls.length === 0 ||
|
|
695
|
+
rest.partUrls.some(url => typeof url !== 'string' || url.length === 0))
|
|
696
|
+
throw new Error('[RNBackgroundDownloader] partUrls must be a non-empty array of URLs')
|
|
697
|
+
if (rest.fieldName !== undefined || rest.parameters !== undefined)
|
|
698
|
+
throw new Error('[RNBackgroundDownloader] partUrls sends each part as the raw body; it can\'t be combined with fieldName or parameters')
|
|
699
|
+
if (rest.partSize !== undefined && !(Number.isInteger(rest.partSize) && rest.partSize > 0))
|
|
700
|
+
throw new Error('[RNBackgroundDownloader] partSize must be a positive whole number of bytes')
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
if (!rest.id || !(rest.url || rest.partUrls) || !rest.source)
|
|
704
|
+
throw new Error('[RNBackgroundDownloader] id, url (or partUrls) and source are required')
|
|
640
705
|
|
|
641
706
|
rest.headers = { ...config.headers, ...rest.headers }
|
|
642
707
|
|
package/src/types.ts
CHANGED
|
@@ -238,9 +238,24 @@ export type UploadProgressHandlerParams = {
|
|
|
238
238
|
|
|
239
239
|
export type UploadProgressHandler = (params: UploadProgressHandlerParams) => void
|
|
240
240
|
|
|
241
|
+
export type UploadPartResult = {
|
|
242
|
+
// 1-based, matching the position in partUrls and S3's part numbers
|
|
243
|
+
partNumber: number
|
|
244
|
+
responseCode: number
|
|
245
|
+
responseBody: string
|
|
246
|
+
// Lowercased header names, e.g. responseHeaders.etag
|
|
247
|
+
responseHeaders: Record<string, string>
|
|
248
|
+
bytes: number
|
|
249
|
+
}
|
|
250
|
+
|
|
241
251
|
export type UploadDoneHandlerParams = {
|
|
252
|
+
// For an upload with partUrls: the last part's response
|
|
242
253
|
responseCode: number
|
|
243
254
|
responseBody: string
|
|
255
|
+
// Lowercased header names, e.g. responseHeaders.etag
|
|
256
|
+
responseHeaders: Record<string, string>
|
|
257
|
+
// Set for an upload with partUrls, in part order
|
|
258
|
+
parts?: UploadPartResult[]
|
|
244
259
|
bytesUploaded: number
|
|
245
260
|
bytesTotal: number
|
|
246
261
|
}
|
|
@@ -270,6 +285,10 @@ export interface UploadTaskInfoNative {
|
|
|
270
285
|
bytesTotal: number
|
|
271
286
|
errorCode: number
|
|
272
287
|
state: number
|
|
288
|
+
responseCode?: number | null
|
|
289
|
+
responseBody?: string | null
|
|
290
|
+
responseHeaders?: Record<string, string> | null
|
|
291
|
+
parts?: UploadPartResult[] | null
|
|
273
292
|
}
|
|
274
293
|
|
|
275
294
|
export interface UploadTaskInfo {
|
|
@@ -278,13 +297,27 @@ export interface UploadTaskInfo {
|
|
|
278
297
|
}
|
|
279
298
|
|
|
280
299
|
export type UploadParams = {
|
|
281
|
-
|
|
300
|
+
// Not needed with partUrls
|
|
301
|
+
url?: string
|
|
282
302
|
source: string
|
|
303
|
+
// Defaults to POST, or PUT with partUrls
|
|
283
304
|
method?: 'POST' | 'PUT' | 'PATCH'
|
|
284
305
|
headers?: Headers
|
|
285
306
|
fieldName?: string
|
|
286
307
|
mimeType?: string
|
|
287
308
|
parameters?: Record<string, string>
|
|
309
|
+
/**
|
|
310
|
+
* Upload `source` in parts, one URL per part (e.g. S3 multipart upload with a
|
|
311
|
+
* presigned UploadPart URL each). Part `i` is sent as the raw body to `partUrls[i]`;
|
|
312
|
+
* can't be combined with `fieldName` or `parameters`.
|
|
313
|
+
*/
|
|
314
|
+
partUrls?: string[]
|
|
315
|
+
/**
|
|
316
|
+
* Bytes per part, the last part taking what's left. Defaults to
|
|
317
|
+
* `Math.ceil(fileSize / partUrls.length)`. The upload fails if the parts don't
|
|
318
|
+
* cover the file exactly.
|
|
319
|
+
*/
|
|
320
|
+
partSize?: number
|
|
288
321
|
isAllowedOverRoaming?: boolean
|
|
289
322
|
isAllowedOverMetered?: boolean
|
|
290
323
|
}
|
|
@@ -297,6 +330,11 @@ export interface UploadTask {
|
|
|
297
330
|
bytesUploaded: number
|
|
298
331
|
bytesTotal: number
|
|
299
332
|
uploadParams?: UploadParams
|
|
333
|
+
// Set once the upload is done (also on a finished task from getExistingUploadTasks)
|
|
334
|
+
responseCode?: number
|
|
335
|
+
responseBody?: string
|
|
336
|
+
responseHeaders?: Record<string, string>
|
|
337
|
+
parts?: UploadPartResult[]
|
|
300
338
|
|
|
301
339
|
begin: (handler: UploadBeginHandler) => UploadTask
|
|
302
340
|
progress: (handler: UploadProgressHandler) => UploadTask
|
|
@@ -321,7 +359,7 @@ export type getExistingUploadTasks = () => Promise<UploadTask[]>
|
|
|
321
359
|
|
|
322
360
|
export interface UploadOption {
|
|
323
361
|
id: string
|
|
324
|
-
url
|
|
362
|
+
url?: string
|
|
325
363
|
source: string
|
|
326
364
|
method?: 'POST' | 'PUT' | 'PATCH'
|
|
327
365
|
headers?: Headers | undefined
|
|
@@ -329,6 +367,8 @@ export interface UploadOption {
|
|
|
329
367
|
fieldName?: string
|
|
330
368
|
mimeType?: string
|
|
331
369
|
parameters?: Record<string, string>
|
|
370
|
+
partUrls?: string[]
|
|
371
|
+
partSize?: number
|
|
332
372
|
isAllowedOverRoaming?: boolean
|
|
333
373
|
isAllowedOverMetered?: boolean
|
|
334
374
|
}
|