@kesha-antonov/react-native-background-downloader 4.6.4 → 4.7.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.
Files changed (38) hide show
  1. package/README.md +27 -5
  2. package/android/src/main/java/com/eko/DownloadConstants.kt +13 -2
  3. package/android/src/main/java/com/eko/DownloadResult.kt +3 -1
  4. package/android/src/main/java/com/eko/Downloader.kt +25 -4
  5. package/android/src/main/java/com/eko/ProgressReporter.kt +14 -35
  6. package/android/src/main/java/com/eko/RNBackgroundDownloaderModuleImpl.kt +162 -76
  7. package/android/src/main/java/com/eko/ResumableDownloadService.kt +2 -1
  8. package/android/src/main/java/com/eko/ResumableDownloader.kt +75 -3
  9. package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +34 -8
  10. package/android/src/main/java/com/eko/Uploader.kt +15 -11
  11. package/android/src/main/java/com/eko/handlers/OnBegin.kt +6 -1
  12. package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +3 -1
  13. package/android/src/main/java/com/eko/uidt/UIDTJobManager.kt +18 -2
  14. package/android/src/main/java/com/eko/utils/RedirectResolver.kt +5 -13
  15. package/android/src/main/java/com/eko/utils/StorageManager.kt +5 -0
  16. package/android/src/test/java/com/eko/DownloaderRecoveryTest.kt +78 -0
  17. package/android/src/test/java/com/eko/DownloaderResumeTest.kt +97 -0
  18. package/android/src/test/java/com/eko/ResumableDownloaderStallTest.kt +145 -0
  19. package/android/src/test/java/com/eko/UploaderMultipartTest.kt +84 -0
  20. package/android/src/test/java/com/eko/handlers/OnBeginTest.kt +51 -0
  21. package/android/src/test/java/com/eko/uidt/CancelDownloadReceiverTest.kt +84 -0
  22. package/android/src/test/java/com/eko/utils/RedirectResolverTest.kt +67 -0
  23. package/ios/RNBGDTaskConfig.h +2 -0
  24. package/ios/RNBGDTaskConfig.mm +6 -0
  25. package/ios/RNBackgroundDownloader.mm +640 -90
  26. package/lib/DownloadTask.d.ts +2 -0
  27. package/lib/DownloadTask.js +17 -1
  28. package/lib/UploadTask.d.ts +2 -0
  29. package/lib/UploadTask.js +17 -1
  30. package/lib/index.d.ts +1 -1
  31. package/lib/index.js +50 -36
  32. package/package.json +14 -11
  33. package/plugin/build/index.d.ts +1 -0
  34. package/plugin/build/index.js +18 -10
  35. package/react-native-background-downloader.podspec +8 -0
  36. package/src/DownloadTask.ts +18 -1
  37. package/src/UploadTask.ts +18 -1
  38. package/src/index.ts +73 -41
package/src/UploadTask.ts CHANGED
@@ -48,6 +48,10 @@ export class UploadTask {
48
48
  doneHandler?: UploadDoneHandler
49
49
  errorHandler?: UploadErrorHandler
50
50
 
51
+ // begin fires once per task. Android sends it again for each new transfer (a resume in
52
+ // a new job, a reschedule by the system), which isn't a new beginning for the app.
53
+ private hasBegun = false
54
+
51
55
  constructor (taskParams: UploadTaskInfo | UploadTaskInfoNative, originalTask?: UploadTaskType) {
52
56
  this.id = taskParams.id
53
57
 
@@ -59,6 +63,9 @@ export class UploadTask {
59
63
 
60
64
  this.metadata = this.tryParseJson(taskParams.metadata) ?? {}
61
65
 
66
+ // A restored task that already has data has begun; so has one this replaces
67
+ this.hasBegun = (originalTask instanceof UploadTask && originalTask.hasBegun) || this.bytesUploaded > 0
68
+
62
69
  if (originalTask) {
63
70
  this.beginHandler = originalTask.beginHandler
64
71
  this.progressHandler = originalTask.progressHandler
@@ -103,13 +110,22 @@ export class UploadTask {
103
110
 
104
111
  // event listeners
105
112
 
113
+ // Native can still deliver begin or progress that was in flight when the app paused
114
+ // or stopped the upload, or when it ended. Those must not run handlers or change state.
115
+ private isInactive (): boolean {
116
+ return this.state === 'PAUSED' || this.state === 'STOPPED' || this.state === 'DONE' || this.state === 'FAILED'
117
+ }
118
+
106
119
  onBegin (params: UploadBeginHandlerParams) {
120
+ if (this.isInactive() || this.hasBegun) return
121
+ this.hasBegun = true
107
122
  this.state = 'UPLOADING'
108
123
  this.bytesTotal = params.expectedBytes
109
124
  this.beginHandler?.(params)
110
125
  }
111
126
 
112
127
  onProgress (params: UploadProgressHandlerParams) {
128
+ if (this.isInactive()) return
113
129
  this.bytesUploaded = params.bytesUploaded
114
130
  this.bytesTotal = params.bytesTotal
115
131
  this.progressHandler?.(params)
@@ -124,6 +140,7 @@ export class UploadTask {
124
140
 
125
141
  onError (params: UploadErrorHandlerParams) {
126
142
  this.state = 'FAILED'
143
+ this.errorCode = params.errorCode
127
144
  this.errorHandler?.(params)
128
145
  }
129
146
 
@@ -186,7 +203,7 @@ export class UploadTask {
186
203
  method: this.uploadParams.method ?? 'POST',
187
204
  headers: this.headersToUnsafeObject(this.uploadParams.headers),
188
205
  isAllowedOverRoaming: this.uploadParams.isAllowedOverRoaming ?? false,
189
- isAllowedOverMetered: this.uploadParams.isAllowedOverMetered ?? false,
206
+ isAllowedOverMetered: this.uploadParams.isAllowedOverMetered ?? config.allowsCellularAccess,
190
207
  })
191
208
  }
192
209
 
package/src/index.ts CHANGED
@@ -1,8 +1,8 @@
1
- import { NativeModules, Platform, TurboModuleRegistry, NativeEventEmitter, NativeModule } from 'react-native'
1
+ import { NativeModules, Platform, TurboModuleRegistry, NativeEventEmitter } from 'react-native'
2
2
  import { DownloadTask } from './DownloadTask'
3
3
  import { UploadTask } from './UploadTask'
4
4
  import { Config, DownloadParams, Headers, Metadata, TaskInfo, TaskInfoNative, UploadParams, UploadTaskInfo, UploadTaskInfoNative } from './types'
5
- import { config, DEFAULT_PROGRESS_INTERVAL, DEFAULT_PROGRESS_MIN_BYTES, DEFAULT_NOTIFICATION_TEXTS } from './config'
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'
@@ -153,7 +167,7 @@ function initializeEventListeners () {
153
167
 
154
168
  if (isIOSNewArchitecture && turboModule) {
155
169
  // iOS new architecture: use EventEmitter from TurboModule spec
156
- turboModule.onDownloadBegin((data: DownloadBeginEvent) => {
170
+ eventSubscriptions.push(turboModule.onDownloadBegin((data: DownloadBeginEvent) => {
157
171
  const { id, ...rest } = data
158
172
  log('downloadBegin', id, rest)
159
173
  const task = tasksMap.get(id)
@@ -162,9 +176,9 @@ function initializeEventListeners () {
162
176
  return
163
177
  }
164
178
  task.onBegin(rest)
165
- })
179
+ }))
166
180
 
167
- turboModule.onDownloadProgress((events: DownloadProgressEvent[]) => {
181
+ eventSubscriptions.push(turboModule.onDownloadProgress((events: DownloadProgressEvent[]) => {
168
182
  log('downloadProgress', events)
169
183
  for (const event of events) {
170
184
  const { id, ...rest } = event
@@ -172,9 +186,9 @@ function initializeEventListeners () {
172
186
  if (task)
173
187
  task.onProgress(rest)
174
188
  }
175
- })
189
+ }))
176
190
 
177
- turboModule.onDownloadComplete((data: DownloadCompleteEvent) => {
191
+ eventSubscriptions.push(turboModule.onDownloadComplete((data: DownloadCompleteEvent) => {
178
192
  const { id, ...rest } = data
179
193
  log('downloadComplete', id, rest)
180
194
  const task = tasksMap.get(id)
@@ -183,9 +197,9 @@ function initializeEventListeners () {
183
197
  else
184
198
  task.onDone(rest)
185
199
  tasksMap.delete(id)
186
- })
200
+ }))
187
201
 
188
- turboModule.onDownloadFailed((data: DownloadFailedEvent) => {
202
+ eventSubscriptions.push(turboModule.onDownloadFailed((data: DownloadFailedEvent) => {
189
203
  const { id, ...rest } = data
190
204
  log('downloadFailed', id, rest)
191
205
  const task = tasksMap.get(id)
@@ -194,11 +208,11 @@ function initializeEventListeners () {
194
208
  else
195
209
  task.onError(rest)
196
210
  tasksMap.delete(id)
197
- })
211
+ }))
198
212
 
199
213
  // Upload events for new architecture (optional - may not exist in all versions)
200
214
  if (typeof turboModule.onUploadBegin === 'function') {
201
- turboModule.onUploadBegin?.((data: UploadBeginEvent) => {
215
+ eventSubscriptions.push(turboModule.onUploadBegin!((data: UploadBeginEvent) => {
202
216
  const { id, ...rest } = data
203
217
  log('uploadBegin', id, rest)
204
218
  const task = uploadTasksMap.get(id)
@@ -207,9 +221,9 @@ function initializeEventListeners () {
207
221
  return
208
222
  }
209
223
  task.onBegin(rest)
210
- })
224
+ }))
211
225
 
212
- turboModule.onUploadProgress?.((events: UploadProgressEvent[]) => {
226
+ eventSubscriptions.push(turboModule.onUploadProgress!((events: UploadProgressEvent[]) => {
213
227
  log('uploadProgress', events)
214
228
  for (const event of events) {
215
229
  const { id, ...rest } = event
@@ -217,9 +231,9 @@ function initializeEventListeners () {
217
231
  if (task)
218
232
  task.onProgress(rest)
219
233
  }
220
- })
234
+ }))
221
235
 
222
- turboModule.onUploadComplete?.((data: UploadCompleteEvent) => {
236
+ eventSubscriptions.push(turboModule.onUploadComplete!((data: UploadCompleteEvent) => {
223
237
  const { id, ...rest } = data
224
238
  log('uploadComplete', id, rest)
225
239
  const task = uploadTasksMap.get(id)
@@ -228,9 +242,9 @@ function initializeEventListeners () {
228
242
  else
229
243
  task.onDone(rest)
230
244
  uploadTasksMap.delete(id)
231
- })
245
+ }))
232
246
 
233
- turboModule.onUploadFailed?.((data: UploadFailedEvent) => {
247
+ eventSubscriptions.push(turboModule.onUploadFailed!((data: UploadFailedEvent) => {
234
248
  const { id, ...rest } = data
235
249
  log('uploadFailed', id, rest)
236
250
  const task = uploadTasksMap.get(id)
@@ -239,14 +253,14 @@ function initializeEventListeners () {
239
253
  else
240
254
  task.onError(rest)
241
255
  uploadTasksMap.delete(id)
242
- })
256
+ }))
243
257
  }
244
258
  } else {
245
259
  // Old architecture: use NativeEventEmitter with the native module
246
260
  // RCTEventEmitter on native side requires NativeEventEmitter on JS side
247
261
  // RNBackgroundDownloader is guaranteed to be non-null here since initializeEventListeners
248
262
  // is only called after ensureNativeModuleInitialized() succeeds
249
- const eventEmitter = new NativeEventEmitter(RNBackgroundDownloader!)
263
+ const eventEmitter: EventEmitterWithPayloads = new NativeEventEmitter(RNBackgroundDownloader!)
250
264
 
251
265
  eventSubscriptions.push(
252
266
  eventEmitter.addListener('downloadBegin', (data: DownloadBeginEvent) => {
@@ -363,11 +377,12 @@ function initializeEventListeners () {
363
377
  // Event listeners are now initialized lazily when ensureNativeModuleInitialized() is called
364
378
  // This ensures the bridge is ready before any native module access
365
379
 
380
+ // Only the options passed are changed; the rest keep their current values
366
381
  export function setConfig ({
367
- headers = {},
368
- progressInterval = DEFAULT_PROGRESS_INTERVAL,
369
- progressMinBytes = DEFAULT_PROGRESS_MIN_BYTES,
370
- isLogsEnabled = false,
382
+ headers,
383
+ progressInterval,
384
+ progressMinBytes,
385
+ isLogsEnabled,
371
386
  logCallback,
372
387
  maxParallelDownloads,
373
388
  allowsCellularAccess,
@@ -377,20 +392,23 @@ export function setConfig ({
377
392
  notificationsGrouping,
378
393
  iosDataProtection,
379
394
  }: Config) {
380
- config.headers = headers
395
+ if (headers !== undefined)
396
+ config.headers = headers
381
397
 
382
398
  if (iosDataProtection !== undefined)
383
399
  config.iosDataProtection = iosDataProtection
384
400
 
385
- if (progressInterval >= MIN_PROGRESS_INTERVAL)
386
- config.progressInterval = progressInterval
387
- else
388
- console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= ${MIN_PROGRESS_INTERVAL}. You passed ${progressInterval}`)
401
+ if (progressInterval !== undefined)
402
+ if (progressInterval >= MIN_PROGRESS_INTERVAL)
403
+ config.progressInterval = progressInterval
404
+ else
405
+ console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= ${MIN_PROGRESS_INTERVAL}. You passed ${progressInterval}`)
389
406
 
390
- if (progressMinBytes >= 0)
391
- config.progressMinBytes = progressMinBytes
392
- else
393
- console.warn(`[RNBackgroundDownloader] progressMinBytes must be a number >= 0. You passed ${progressMinBytes}`)
407
+ if (progressMinBytes !== undefined)
408
+ if (progressMinBytes >= 0)
409
+ config.progressMinBytes = progressMinBytes
410
+ else
411
+ console.warn(`[RNBackgroundDownloader] progressMinBytes must be a number >= 0. You passed ${progressMinBytes}`)
394
412
 
395
413
  if (maxParallelDownloads !== undefined)
396
414
  if (maxParallelDownloads >= 1)
@@ -423,8 +441,10 @@ export function setConfig ({
423
441
  },
424
442
  }
425
443
 
426
- config.isLogsEnabled = isLogsEnabled
427
- config.logCallback = logCallback
444
+ if (isLogsEnabled !== undefined)
445
+ config.isLogsEnabled = isLogsEnabled
446
+ if (logCallback !== undefined)
447
+ config.logCallback = logCallback
428
448
 
429
449
  // Notify native side about configuration changes
430
450
  try {
@@ -441,7 +461,7 @@ export function setConfig ({
441
461
  texts: Record<string, string>
442
462
  }) => void
443
463
  }
444
- if (nativeModule.setLogsEnabled)
464
+ if (nativeModule.setLogsEnabled && isLogsEnabled !== undefined)
445
465
  nativeModule.setLogsEnabled(isLogsEnabled)
446
466
  // Only call native methods if config was successfully updated
447
467
  if (nativeModule.setMaxParallelDownloads && maxParallelDownloads !== undefined && maxParallelDownloads >= 1)
@@ -498,7 +518,8 @@ export const getExistingDownloadTasks = async (): Promise<DownloadTask[]> => {
498
518
  if (taskInfo.errorCode === -999) {
499
519
  task.state = 'PAUSED'
500
520
  } else {
501
- task.stop()
521
+ // Not awaited: the task is dropped either way, so a failed stop isn't actionable
522
+ task.stop().catch(() => {})
502
523
  return undefined
503
524
  }
504
525
  break
@@ -533,8 +554,12 @@ export const completeHandler = (jobId: string) => {
533
554
 
534
555
  export function createDownloadTask ({
535
556
  isAllowedOverRoaming = true,
536
- isAllowedOverMetered = true,
557
+ // Follows setConfig({ allowsCellularAccess }) unless the task sets its own
558
+ isAllowedOverMetered = config.allowsCellularAccess,
537
559
  metadata,
560
+ groupId,
561
+ groupName,
562
+ notificationTitle,
538
563
  ...rest
539
564
  }: TaskInfo & DownloadParams) {
540
565
  // Ensure native module and event listeners are initialized before creating tasks
@@ -547,9 +572,14 @@ export function createDownloadTask ({
547
572
 
548
573
  rest.destination = rest.destination.replace('file://', '')
549
574
 
575
+ // Native reads the notification fields from metadata only
576
+ const notificationFields = Object.fromEntries(
577
+ Object.entries({ groupId, groupName, notificationTitle }).filter(([, value]) => value !== undefined)
578
+ )
579
+
550
580
  const task = new DownloadTask({
551
581
  id: rest.id,
552
- metadata,
582
+ metadata: Object.keys(notificationFields).length > 0 ? { ...metadata, ...notificationFields } : metadata,
553
583
  })
554
584
 
555
585
  task.setDownloadParams({
@@ -603,7 +633,8 @@ export const getExistingUploadTasks = async (): Promise<UploadTask[]> => {
603
633
  if (taskInfo.errorCode === -999) {
604
634
  task.state = 'PAUSED'
605
635
  } else {
606
- task.stop()
636
+ // Not awaited: the task is dropped either way, so a failed stop isn't actionable
637
+ task.stop().catch(() => {})
607
638
  return undefined
608
639
  }
609
640
  break
@@ -628,7 +659,8 @@ export const getExistingUploadTasks = async (): Promise<UploadTask[]> => {
628
659
 
629
660
  export function createUploadTask ({
630
661
  isAllowedOverRoaming = true,
631
- isAllowedOverMetered = true,
662
+ // Follows setConfig({ allowsCellularAccess }) unless the task sets its own
663
+ isAllowedOverMetered = config.allowsCellularAccess,
632
664
  metadata,
633
665
  ...rest
634
666
  }: UploadTaskInfo & UploadParams) {