@kesha-antonov/react-native-background-downloader 4.5.6 → 4.5.9

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 (35) hide show
  1. package/README.md +5 -1
  2. package/android/src/main/java/com/eko/DownloadConstants.kt +7 -0
  3. package/android/src/main/java/com/eko/Downloader.kt +80 -111
  4. package/android/src/main/java/com/eko/PromiseExtensions.kt +36 -0
  5. package/android/src/main/java/com/eko/RNBGDTaskConfig.kt +4 -1
  6. package/android/src/main/java/com/eko/RNBackgroundDownloaderModuleImpl.kt +102 -144
  7. package/android/src/main/java/com/eko/ResumableDownloadService.kt +153 -37
  8. package/android/src/main/java/com/eko/ResumableDownloader.kt +66 -12
  9. package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +25 -4
  10. package/android/src/main/java/com/eko/UnmeteredNetworkGate.kt +366 -0
  11. package/android/src/main/java/com/eko/uidt/UIDTJobManager.kt +76 -14
  12. package/android/src/main/java/com/eko/uidt/UIDTJobState.kt +11 -0
  13. package/android/src/main/java/com/eko/utils/NetworkRequestUtils.kt +43 -0
  14. package/android/src/main/java/com/eko/utils/ReadableConverters.kt +55 -0
  15. package/android/src/main/java/com/eko/utils/RedirectResolver.kt +97 -0
  16. package/android/src/main/java/com/eko/utils/StorageManager.kt +45 -45
  17. package/android/src/newarch/java/com/eko/RNBackgroundDownloaderModule.kt +18 -70
  18. package/android/src/oldarch/java/com/eko/RNBackgroundDownloaderModule.kt +18 -70
  19. package/ios/RNBackgroundDownloader.mm +187 -91
  20. package/lib/DownloadTask.js +8 -7
  21. package/lib/UploadTask.js +11 -10
  22. package/lib/config.d.ts +1 -10
  23. package/lib/config.js +1 -44
  24. package/lib/index.js +34 -32
  25. package/lib/logger.d.ts +2 -0
  26. package/lib/logger.js +16 -0
  27. package/lib/notifications.d.ts +8 -0
  28. package/lib/notifications.js +34 -0
  29. package/package.json +7 -3
  30. package/src/DownloadTask.ts +2 -1
  31. package/src/UploadTask.ts +2 -1
  32. package/src/config.ts +4 -45
  33. package/src/index.ts +3 -1
  34. package/src/logger.ts +16 -0
  35. package/src/notifications.ts +31 -0
@@ -0,0 +1,97 @@
1
+ package com.eko.utils
2
+
3
+ import com.eko.DownloadConstants
4
+ import com.eko.RNBackgroundDownloaderModuleImpl
5
+ import com.facebook.react.bridge.ReadableMap
6
+ import java.net.HttpURLConnection
7
+ import java.net.URL
8
+
9
+ /**
10
+ * Follows HTTP 3xx redirects with HEAD requests to find the final download URL before
11
+ * handing it to DownloadManager (which does not expose the resolved URL). Stateless and
12
+ * self-contained - extracted from the module so the redirect logic is isolated and
13
+ * testable. Never throws: on any failure it returns the original URL unchanged.
14
+ */
15
+ object RedirectResolver {
16
+
17
+ private const val TAG = "RNBackgroundDownloader"
18
+
19
+ /**
20
+ * Resolve up to [maxRedirects] redirects starting from [originalUrl], applying
21
+ * [headers] to each probe. Returns the final URL, or [originalUrl] if resolution
22
+ * is disabled ([maxRedirects] <= 0) or fails.
23
+ */
24
+ fun resolve(originalUrl: String, maxRedirects: Int, headers: ReadableMap?): String {
25
+ if (maxRedirects <= 0) {
26
+ return originalUrl
27
+ }
28
+
29
+ try {
30
+ var currentUrl = originalUrl
31
+ var redirectCount = 0
32
+
33
+ while (redirectCount < maxRedirects) {
34
+ val url = URL(currentUrl)
35
+ val connection = url.openConnection() as HttpURLConnection
36
+
37
+ // Add headers to the redirect resolution request
38
+ HeaderUtils.applyToConnection(connection, headers)
39
+
40
+ // Add default headers for consistency with DownloadManager
41
+ HeaderUtils.applyDefaultHeaders(connection, headers)
42
+
43
+ connection.instanceFollowRedirects = false
44
+ connection.requestMethod = "HEAD" // Use HEAD to avoid downloading content
45
+ connection.connectTimeout = DownloadConstants.REDIRECT_TIMEOUT_MS
46
+ connection.readTimeout = DownloadConstants.REDIRECT_TIMEOUT_MS
47
+
48
+ val responseCode = connection.responseCode
49
+
50
+ if (responseCode in 300..399) {
51
+ // This is a redirect
52
+ val location = connection.getHeaderField("Location")
53
+ if (location == null) {
54
+ RNBackgroundDownloaderModuleImpl.logW(TAG, "Redirect response without Location header at: $currentUrl")
55
+ break
56
+ }
57
+
58
+ // Handle relative URLs
59
+ currentUrl = when {
60
+ location.startsWith("/") -> {
61
+ val baseUrl = URL(currentUrl)
62
+ "${baseUrl.protocol}://${baseUrl.host}$location"
63
+ }
64
+ !location.startsWith("http") -> {
65
+ val baseUrl = URL(currentUrl)
66
+ "${baseUrl.protocol}://${baseUrl.host}/$location"
67
+ }
68
+ else -> location
69
+ }
70
+
71
+ RNBackgroundDownloaderModuleImpl.logD(TAG, "Redirect ${redirectCount + 1}/$maxRedirects: $currentUrl -> $location")
72
+ redirectCount++
73
+ } else {
74
+ // Not a redirect, we've found the final URL
75
+ break
76
+ }
77
+
78
+ connection.disconnect()
79
+ }
80
+
81
+ if (redirectCount >= maxRedirects) {
82
+ RNBackgroundDownloaderModuleImpl.logW(
83
+ TAG,
84
+ "Reached maximum redirects ($maxRedirects) for URL: $originalUrl. Final URL: $currentUrl"
85
+ )
86
+ } else {
87
+ RNBackgroundDownloaderModuleImpl.logD(TAG, "Resolved URL after $redirectCount redirects: $currentUrl")
88
+ }
89
+
90
+ return currentUrl
91
+ } catch (e: Exception) {
92
+ RNBackgroundDownloaderModuleImpl.logE(TAG, "Failed to resolve redirects for URL: $originalUrl. Error: ${e.message}")
93
+ // Return original URL if redirect resolution fails
94
+ return originalUrl
95
+ }
96
+ }
97
+ }
@@ -188,6 +188,19 @@ class StorageManager(context: Context, private val name: String) {
188
188
  /**
189
189
  * Serializable data class for storing paused download information.
190
190
  * This is needed because Gson requires explicit serialization for complex types.
191
+ *
192
+ * PERSISTENCE MIGRATION INVARIANT — read before adding a field here.
193
+ * This DTO is written to MMKV/SharedPreferences by one app version and read back
194
+ * by the next, so it must stay forward/backward compatible with in-flight downloads
195
+ * across an app update. Every NEW field MUST:
196
+ * 1. be nullable (or have a default) so a record written by an older version -
197
+ * where the JSON key is simply absent - deserializes instead of failing; and
198
+ * 2. resolve its legacy meaning explicitly in [toInfo] with `?: <safe default>`,
199
+ * never relying on Gson's zero-value default (e.g. `false`/`0`), which is
200
+ * usually the wrong choice for an absent key.
201
+ * See `isAllowedOverMetered` below for the reference pattern, and keep the
202
+ * runtime<->DTO mapping in the single [toData]/[toInfo] pair so a field is added
203
+ * in exactly one place.
191
204
  */
192
205
  data class PausedDownloadInfoData(
193
206
  val configId: String,
@@ -196,7 +209,34 @@ class StorageManager(context: Context, private val name: String) {
196
209
  val headers: Map<String, String>,
197
210
  val bytesDownloaded: Long,
198
211
  val bytesTotal: Long,
199
- val metadata: String = "{}"
212
+ val metadata: String = "{}",
213
+ // Nullable so records persisted by older versions (key absent in JSON)
214
+ // load as null and fall back to true instead of Gson's default false.
215
+ val isAllowedOverMetered: Boolean? = null
216
+ )
217
+
218
+ // Single mapping pair between the runtime record and the persisted DTO so a
219
+ // new field is added in one place instead of once per save/load method
220
+ private fun Downloader.PausedDownloadInfo.toData() = PausedDownloadInfoData(
221
+ configId = configId,
222
+ url = url,
223
+ destination = destination,
224
+ headers = headers,
225
+ bytesDownloaded = bytesDownloaded,
226
+ bytesTotal = bytesTotal,
227
+ metadata = metadata,
228
+ isAllowedOverMetered = isAllowedOverMetered
229
+ )
230
+
231
+ private fun PausedDownloadInfoData.toInfo() = Downloader.PausedDownloadInfo(
232
+ configId = configId,
233
+ url = url,
234
+ destination = destination,
235
+ headers = headers,
236
+ bytesDownloaded = bytesDownloaded,
237
+ bytesTotal = bytesTotal,
238
+ metadata = metadata,
239
+ isAllowedOverMetered = isAllowedOverMetered ?: true
200
240
  )
201
241
 
202
242
  /**
@@ -206,17 +246,7 @@ class StorageManager(context: Context, private val name: String) {
206
246
  try {
207
247
  val gson = Gson()
208
248
  // Convert to serializable data class
209
- val mapCopy = pausedDownloads.mapValues { (_, info) ->
210
- PausedDownloadInfoData(
211
- configId = info.configId,
212
- url = info.url,
213
- destination = info.destination,
214
- headers = info.headers,
215
- bytesDownloaded = info.bytesDownloaded,
216
- bytesTotal = info.bytesTotal,
217
- metadata = info.metadata
218
- )
219
- }
249
+ val mapCopy = pausedDownloads.mapValues { (_, info) -> info.toData() }
220
250
  val str = gson.toJson(mapCopy)
221
251
 
222
252
  if (isMMKVAvailable && mmkv != null) {
@@ -248,17 +278,7 @@ class StorageManager(context: Context, private val name: String) {
248
278
  val mapType = object : TypeToken<Map<String, PausedDownloadInfoData>>() {}.type
249
279
  val dataMap: Map<String, PausedDownloadInfoData> = gson.fromJson(str, mapType)
250
280
  // Convert back to PausedDownloadInfo
251
- return dataMap.mapValues { (_, data) ->
252
- Downloader.PausedDownloadInfo(
253
- configId = data.configId,
254
- url = data.url,
255
- destination = data.destination,
256
- headers = data.headers,
257
- bytesDownloaded = data.bytesDownloaded,
258
- bytesTotal = data.bytesTotal,
259
- metadata = data.metadata
260
- )
261
- }.toMutableMap()
281
+ return dataMap.mapValues { (_, data) -> data.toInfo() }.toMutableMap()
262
282
  }
263
283
  } catch (e: Exception) {
264
284
  RNBackgroundDownloaderModuleImpl.logE(TAG, "Failed to load paused downloads: ${e.message}")
@@ -291,17 +311,7 @@ class StorageManager(context: Context, private val name: String) {
291
311
  fun saveActiveDownloads(activeDownloads: Map<String, Downloader.PausedDownloadInfo>) {
292
312
  try {
293
313
  val gson = Gson()
294
- val mapCopy = activeDownloads.mapValues { (_, info) ->
295
- PausedDownloadInfoData(
296
- configId = info.configId,
297
- url = info.url,
298
- destination = info.destination,
299
- headers = info.headers,
300
- bytesDownloaded = info.bytesDownloaded,
301
- bytesTotal = info.bytesTotal,
302
- metadata = info.metadata
303
- )
304
- }
314
+ val mapCopy = activeDownloads.mapValues { (_, info) -> info.toData() }
305
315
  val str = gson.toJson(mapCopy)
306
316
 
307
317
  if (isMMKVAvailable && mmkv != null) {
@@ -331,17 +341,7 @@ class StorageManager(context: Context, private val name: String) {
331
341
  val gson = Gson()
332
342
  val mapType = object : TypeToken<Map<String, PausedDownloadInfoData>>() {}.type
333
343
  val dataMap: Map<String, PausedDownloadInfoData> = gson.fromJson(str, mapType)
334
- return dataMap.mapValues { (_, data) ->
335
- Downloader.PausedDownloadInfo(
336
- configId = data.configId,
337
- url = data.url,
338
- destination = data.destination,
339
- headers = data.headers,
340
- bytesDownloaded = data.bytesDownloaded,
341
- bytesTotal = data.bytesTotal,
342
- metadata = data.metadata
343
- )
344
- }.toMutableMap()
344
+ return dataMap.mapValues { (_, data) -> data.toInfo() }.toMutableMap()
345
345
  }
346
346
  } catch (e: Exception) {
347
347
  RNBackgroundDownloaderModuleImpl.logE(TAG, "Failed to load active downloads: ${e.message}")
@@ -30,53 +30,24 @@ class RNBackgroundDownloaderModule(reactContext: ReactApplicationContext) :
30
30
  impl.download(options)
31
31
  }
32
32
 
33
- override fun pauseTask(id: String, promise: com.facebook.react.bridge.Promise) {
34
- try {
35
- impl.pauseTask(id)
36
- promise.resolve(null)
37
- } catch (e: Exception) {
38
- promise.reject("ERR_PAUSE_TASK", e.message, e)
39
- }
40
- }
33
+ override fun pauseTask(id: String, promise: com.facebook.react.bridge.Promise) =
34
+ promise.resolveCatching("ERR_PAUSE_TASK") { impl.pauseTask(id) }
41
35
 
42
- override fun resumeTask(id: String, promise: com.facebook.react.bridge.Promise) {
43
- try {
44
- impl.resumeTask(id)
45
- promise.resolve(null)
46
- } catch (e: Exception) {
47
- promise.reject("ERR_RESUME_TASK", e.message, e)
48
- }
49
- }
36
+ override fun resumeTask(id: String, promise: com.facebook.react.bridge.Promise) =
37
+ promise.resolveCatching("ERR_RESUME_TASK") { impl.resumeTask(id) }
50
38
 
51
- override fun stopTask(id: String, promise: com.facebook.react.bridge.Promise) {
52
- try {
53
- impl.stopTask(id)
54
- promise.resolve(null)
55
- } catch (e: Exception) {
56
- promise.reject("ERR_STOP_TASK", e.message, e)
57
- }
58
- }
39
+ override fun stopTask(id: String, promise: com.facebook.react.bridge.Promise) =
40
+ promise.resolveCatching("ERR_STOP_TASK") { impl.stopTask(id) }
59
41
 
60
42
  override fun updateTaskHeaders(id: String, headers: com.facebook.react.bridge.ReadableMap, promise: com.facebook.react.bridge.Promise) {
61
43
  impl.updateTaskHeaders(id, headers, promise)
62
44
  }
63
45
 
64
- override fun completeHandler(jobId: String, promise: com.facebook.react.bridge.Promise) {
65
- try {
66
- impl.completeHandler(jobId)
67
- promise.resolve(null)
68
- } catch (e: Exception) {
69
- promise.reject("ERR_COMPLETE_HANDLER", e.message, e)
70
- }
71
- }
46
+ override fun completeHandler(jobId: String, promise: com.facebook.react.bridge.Promise) =
47
+ promise.resolveCatching("ERR_COMPLETE_HANDLER") { impl.completeHandler(jobId) }
72
48
 
73
- override fun getExistingDownloadTasks(promise: com.facebook.react.bridge.Promise) {
74
- try {
75
- impl.getExistingDownloadTasks(promise)
76
- } catch (e: Exception) {
77
- promise.reject("ERR_GET_EXISTING_TASKS", e.message, e)
78
- }
79
- }
49
+ override fun getExistingDownloadTasks(promise: com.facebook.react.bridge.Promise) =
50
+ promise.rejectOnThrow("ERR_GET_EXISTING_TASKS") { impl.getExistingDownloadTasks(promise) }
80
51
 
81
52
  override fun setLogsEnabled(enabled: Boolean) {
82
53
  impl.setLogsEnabled(enabled)
@@ -112,38 +83,15 @@ class RNBackgroundDownloaderModule(reactContext: ReactApplicationContext) :
112
83
  impl.upload(options)
113
84
  }
114
85
 
115
- override fun pauseUploadTask(id: String, promise: com.facebook.react.bridge.Promise) {
116
- try {
117
- impl.pauseUploadTask(id)
118
- promise.resolve(null)
119
- } catch (e: Exception) {
120
- promise.reject("ERR_PAUSE_UPLOAD_TASK", e.message, e)
121
- }
122
- }
86
+ override fun pauseUploadTask(id: String, promise: com.facebook.react.bridge.Promise) =
87
+ promise.resolveCatching("ERR_PAUSE_UPLOAD_TASK") { impl.pauseUploadTask(id) }
123
88
 
124
- override fun resumeUploadTask(id: String, promise: com.facebook.react.bridge.Promise) {
125
- try {
126
- impl.resumeUploadTask(id)
127
- promise.resolve(null)
128
- } catch (e: Exception) {
129
- promise.reject("ERR_RESUME_UPLOAD_TASK", e.message, e)
130
- }
131
- }
89
+ override fun resumeUploadTask(id: String, promise: com.facebook.react.bridge.Promise) =
90
+ promise.resolveCatching("ERR_RESUME_UPLOAD_TASK") { impl.resumeUploadTask(id) }
132
91
 
133
- override fun stopUploadTask(id: String, promise: com.facebook.react.bridge.Promise) {
134
- try {
135
- impl.stopUploadTask(id)
136
- promise.resolve(null)
137
- } catch (e: Exception) {
138
- promise.reject("ERR_STOP_UPLOAD_TASK", e.message, e)
139
- }
140
- }
92
+ override fun stopUploadTask(id: String, promise: com.facebook.react.bridge.Promise) =
93
+ promise.resolveCatching("ERR_STOP_UPLOAD_TASK") { impl.stopUploadTask(id) }
141
94
 
142
- override fun getExistingUploadTasks(promise: com.facebook.react.bridge.Promise) {
143
- try {
144
- impl.getExistingUploadTasks(promise)
145
- } catch (e: Exception) {
146
- promise.reject("ERR_GET_EXISTING_UPLOAD_TASKS", e.message, e)
147
- }
148
- }
95
+ override fun getExistingUploadTasks(promise: com.facebook.react.bridge.Promise) =
96
+ promise.rejectOnThrow("ERR_GET_EXISTING_UPLOAD_TASKS") { impl.getExistingUploadTasks(promise) }
149
97
  }
@@ -33,34 +33,16 @@ class RNBackgroundDownloaderModule(reactContext: ReactApplicationContext) :
33
33
  }
34
34
 
35
35
  @ReactMethod
36
- fun pauseTask(id: String, promise: Promise) {
37
- try {
38
- impl.pauseTask(id)
39
- promise.resolve(null)
40
- } catch (e: Exception) {
41
- promise.reject("ERR_PAUSE_TASK", e.message, e)
42
- }
43
- }
36
+ fun pauseTask(id: String, promise: Promise) =
37
+ promise.resolveCatching("ERR_PAUSE_TASK") { impl.pauseTask(id) }
44
38
 
45
39
  @ReactMethod
46
- fun resumeTask(id: String, promise: Promise) {
47
- try {
48
- impl.resumeTask(id)
49
- promise.resolve(null)
50
- } catch (e: Exception) {
51
- promise.reject("ERR_RESUME_TASK", e.message, e)
52
- }
53
- }
40
+ fun resumeTask(id: String, promise: Promise) =
41
+ promise.resolveCatching("ERR_RESUME_TASK") { impl.resumeTask(id) }
54
42
 
55
43
  @ReactMethod
56
- fun stopTask(id: String, promise: Promise) {
57
- try {
58
- impl.stopTask(id)
59
- promise.resolve(null)
60
- } catch (e: Exception) {
61
- promise.reject("ERR_STOP_TASK", e.message, e)
62
- }
63
- }
44
+ fun stopTask(id: String, promise: Promise) =
45
+ promise.resolveCatching("ERR_STOP_TASK") { impl.stopTask(id) }
64
46
 
65
47
  @ReactMethod
66
48
  fun updateTaskHeaders(id: String, headers: ReadableMap, promise: Promise) {
@@ -68,23 +50,12 @@ class RNBackgroundDownloaderModule(reactContext: ReactApplicationContext) :
68
50
  }
69
51
 
70
52
  @ReactMethod
71
- fun completeHandler(jobId: String, promise: Promise) {
72
- try {
73
- impl.completeHandler(jobId)
74
- promise.resolve(null)
75
- } catch (e: Exception) {
76
- promise.reject("ERR_COMPLETE_HANDLER", e.message, e)
77
- }
78
- }
53
+ fun completeHandler(jobId: String, promise: Promise) =
54
+ promise.resolveCatching("ERR_COMPLETE_HANDLER") { impl.completeHandler(jobId) }
79
55
 
80
56
  @ReactMethod
81
- fun getExistingDownloadTasks(promise: Promise) {
82
- try {
83
- impl.getExistingDownloadTasks(promise)
84
- } catch (e: Exception) {
85
- promise.reject("ERR_GET_EXISTING_TASKS", e.message, e)
86
- }
87
- }
57
+ fun getExistingDownloadTasks(promise: Promise) =
58
+ promise.rejectOnThrow("ERR_GET_EXISTING_TASKS") { impl.getExistingDownloadTasks(promise) }
88
59
 
89
60
  @ReactMethod
90
61
  fun setLogsEnabled(enabled: Boolean) {
@@ -124,41 +95,18 @@ class RNBackgroundDownloaderModule(reactContext: ReactApplicationContext) :
124
95
  }
125
96
 
126
97
  @ReactMethod
127
- fun pauseUploadTask(id: String, promise: Promise) {
128
- try {
129
- impl.pauseUploadTask(id)
130
- promise.resolve(null)
131
- } catch (e: Exception) {
132
- promise.reject("ERR_PAUSE_UPLOAD_TASK", e.message, e)
133
- }
134
- }
98
+ fun pauseUploadTask(id: String, promise: Promise) =
99
+ promise.resolveCatching("ERR_PAUSE_UPLOAD_TASK") { impl.pauseUploadTask(id) }
135
100
 
136
101
  @ReactMethod
137
- fun resumeUploadTask(id: String, promise: Promise) {
138
- try {
139
- impl.resumeUploadTask(id)
140
- promise.resolve(null)
141
- } catch (e: Exception) {
142
- promise.reject("ERR_RESUME_UPLOAD_TASK", e.message, e)
143
- }
144
- }
102
+ fun resumeUploadTask(id: String, promise: Promise) =
103
+ promise.resolveCatching("ERR_RESUME_UPLOAD_TASK") { impl.resumeUploadTask(id) }
145
104
 
146
105
  @ReactMethod
147
- fun stopUploadTask(id: String, promise: Promise) {
148
- try {
149
- impl.stopUploadTask(id)
150
- promise.resolve(null)
151
- } catch (e: Exception) {
152
- promise.reject("ERR_STOP_UPLOAD_TASK", e.message, e)
153
- }
154
- }
106
+ fun stopUploadTask(id: String, promise: Promise) =
107
+ promise.resolveCatching("ERR_STOP_UPLOAD_TASK") { impl.stopUploadTask(id) }
155
108
 
156
109
  @ReactMethod
157
- fun getExistingUploadTasks(promise: Promise) {
158
- try {
159
- impl.getExistingUploadTasks(promise)
160
- } catch (e: Exception) {
161
- promise.reject("ERR_GET_EXISTING_UPLOAD_TASKS", e.message, e)
162
- }
163
- }
110
+ fun getExistingUploadTasks(promise: Promise) =
111
+ promise.rejectOnThrow("ERR_GET_EXISTING_UPLOAD_TASKS") { impl.getExistingUploadTasks(promise) }
164
112
  }