@kesha-antonov/react-native-background-downloader 4.7.0 → 5.0.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 (79) hide show
  1. package/README.md +85 -37
  2. package/android/build.gradle +5 -1
  3. package/android/consumer-rules.pro +14 -0
  4. package/android/src/main/AndroidManifest.xml +18 -1
  5. package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +5 -567
  6. package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +4 -58
  7. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadConstants.kt +6 -1
  8. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadEventEmitter.kt +1 -1
  9. package/android/src/main/java/com/{eko → kesha_antonov}/DownloadResult.kt +1 -1
  10. package/android/src/main/java/com/{eko → kesha_antonov}/Downloader.kt +14 -7
  11. package/android/src/main/java/com/{eko → kesha_antonov}/ProgressReporter.kt +1 -1
  12. package/android/src/main/java/com/{eko → kesha_antonov}/PromiseExtensions.kt +1 -1
  13. package/android/src/main/java/com/{eko → kesha_antonov}/RNBGDTaskConfig.kt +1 -1
  14. package/android/src/main/java/com/kesha_antonov/RNBGDUploadTaskConfig.kt +57 -0
  15. package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModuleImpl.kt +103 -63
  16. package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderPackage.kt +1 -1
  17. package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloadService.kt +11 -9
  18. package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloader.kt +36 -15
  19. package/android/src/main/java/com/kesha_antonov/UIDTDownloadJobService.kt +590 -0
  20. package/android/src/main/java/com/{eko → kesha_antonov}/UnmeteredNetworkGate.kt +136 -19
  21. package/android/src/main/java/com/{eko → kesha_antonov}/UploadEventEmitter.kt +27 -2
  22. package/android/src/main/java/com/{eko → kesha_antonov}/Uploader.kt +189 -19
  23. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBegin.kt +4 -4
  24. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBeginState.kt +1 -1
  25. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgress.kt +5 -5
  26. package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgressState.kt +1 -1
  27. package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/BeginCallback.kt +1 -1
  28. package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/ProgressCallback.kt +1 -1
  29. package/android/src/main/java/com/kesha_antonov/uidt/CancelDownloadReceiver.kt +68 -0
  30. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/RNBGDFileProvider.kt +1 -1
  31. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobIds.kt +9 -4
  32. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobManager.kt +6 -6
  33. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobState.kt +7 -5
  34. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIds.kt +1 -1
  35. package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationManager.kt +18 -10
  36. package/android/src/main/java/com/{eko → kesha_antonov}/utils/FileUtils.kt +1 -1
  37. package/android/src/main/java/com/{eko → kesha_antonov}/utils/HeaderUtils.kt +11 -2
  38. package/android/src/main/java/com/{eko → kesha_antonov}/utils/NetworkRequestUtils.kt +1 -1
  39. package/android/src/main/java/com/kesha_antonov/utils/NotificationUtils.kt +24 -0
  40. package/android/src/main/java/com/{eko → kesha_antonov}/utils/ProgressUtils.kt +1 -1
  41. package/android/src/main/java/com/{eko → kesha_antonov}/utils/ReadableConverters.kt +1 -1
  42. package/android/src/main/java/com/{eko → kesha_antonov}/utils/RedirectResolver.kt +32 -4
  43. package/android/src/main/java/com/{eko → kesha_antonov}/utils/StorageManager.kt +5 -5
  44. package/android/src/main/java/com/{eko → kesha_antonov}/utils/TempFileUtils.kt +2 -2
  45. package/android/src/newarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
  46. package/android/src/oldarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
  47. package/android/src/test/java/com/kesha_antonov/DownloadCompleteReceiverTest.kt +57 -0
  48. package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderRecoveryTest.kt +2 -2
  49. package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderResumeTest.kt +3 -3
  50. package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderConcurrencyTest.kt +1 -1
  51. package/android/src/test/java/com/kesha_antonov/ResumableDownloaderRedirectTest.kt +77 -0
  52. package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderStallTest.kt +1 -1
  53. package/android/src/test/java/com/kesha_antonov/UnmeteredNetworkGateTest.kt +248 -0
  54. package/android/src/test/java/com/kesha_antonov/UploadPartRangesTest.kt +33 -0
  55. package/android/src/test/java/com/{eko → kesha_antonov}/UploaderMultipartTest.kt +11 -2
  56. package/android/src/test/java/com/kesha_antonov/UploaderPartsTest.kt +222 -0
  57. package/android/src/test/java/com/kesha_antonov/UploaderResponseTest.kt +26 -0
  58. package/android/src/test/java/com/{eko → kesha_antonov}/handlers/OnBeginTest.kt +2 -2
  59. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/CancelDownloadReceiverTest.kt +25 -2
  60. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobIdsTest.kt +13 -2
  61. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobManagerTest.kt +1 -1
  62. package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIdsTest.kt +1 -1
  63. package/android/src/test/java/com/kesha_antonov/utils/RedirectResolverTest.kt +133 -0
  64. package/bin/react-native-background-downloader.js +197 -0
  65. package/ios/RNBGDUploadTaskConfig.h +26 -0
  66. package/ios/RNBGDUploadTaskConfig.mm +69 -3
  67. package/ios/RNBackgroundDownloader.mm +587 -47
  68. package/lib/NativeRNBackgroundDownloader.d.ts +15 -0
  69. package/lib/UploadTask.d.ts +5 -1
  70. package/lib/UploadTask.js +22 -4
  71. package/lib/index.js +57 -27
  72. package/lib/types.d.ts +33 -2
  73. package/package.json +5 -2
  74. package/src/NativeRNBackgroundDownloader.ts +23 -0
  75. package/src/UploadTask.ts +23 -1
  76. package/src/index.ts +60 -27
  77. package/src/types.ts +42 -2
  78. package/android/src/main/java/com/eko/RNBGDUploadTaskConfig.kt +0 -22
  79. package/android/src/test/java/com/eko/utils/RedirectResolverTest.kt +0 -67
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
- url: string
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: string
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
  }
@@ -1,22 +0,0 @@
1
- package com.eko
2
-
3
- /**
4
- * Configuration class for upload tasks.
5
- * Stores all necessary info for an upload and its state.
6
- */
7
- data class RNBGDUploadTaskConfig(
8
- val id: String,
9
- val url: String,
10
- val source: String,
11
- val metadata: String = "{}",
12
- val method: String = "POST",
13
- val headers: Map<String, String>? = null,
14
- val fieldName: String? = null,
15
- val mimeType: String? = null,
16
- val parameters: Map<String, String>? = null,
17
- var reportedBegin: Boolean = false,
18
- var bytesUploaded: Long = 0,
19
- var bytesTotal: Long = 0,
20
- var state: Int = DownloadConstants.TASK_RUNNING,
21
- var errorCode: Int = 0
22
- )
@@ -1,67 +0,0 @@
1
- package com.eko.utils
2
-
3
- import okhttp3.mockwebserver.Dispatcher
4
- import okhttp3.mockwebserver.MockResponse
5
- import okhttp3.mockwebserver.MockWebServer
6
- import okhttp3.mockwebserver.RecordedRequest
7
- import org.junit.After
8
- import org.junit.Assert.assertEquals
9
- import org.junit.Before
10
- import org.junit.Test
11
- import org.junit.runner.RunWith
12
- import org.robolectric.RobolectricTestRunner
13
- import org.robolectric.annotation.Config
14
-
15
- /**
16
- * A Location header may be relative. It has to be resolved against the URL that
17
- * answered with it, keeping that URL's scheme, host, port and directory.
18
- */
19
- @RunWith(RobolectricTestRunner::class)
20
- @Config(sdk = [34])
21
- class RedirectResolverTest {
22
-
23
- private lateinit var server: MockWebServer
24
- private val redirects = mutableMapOf<String, String>()
25
-
26
- @Before
27
- fun startServer() {
28
- server = MockWebServer()
29
- server.dispatcher = object : Dispatcher() {
30
- override fun dispatch(request: RecordedRequest): MockResponse {
31
- val location = redirects[request.path]
32
- ?: return MockResponse().setResponseCode(200)
33
- return MockResponse().setResponseCode(302).setHeader("Location", location)
34
- }
35
- }
36
- server.start()
37
- }
38
-
39
- @After
40
- fun stopServer() {
41
- server.shutdown()
42
- }
43
-
44
- private fun resolve(path: String) = RedirectResolver.resolve(server.url(path).toString(), 5, null)
45
-
46
- @Test
47
- fun `a relative location keeps the port and directory`() {
48
- redirects["/files/start"] = "next/file.zip"
49
-
50
- assertEquals(server.url("/files/next/file.zip").toString(), resolve("/files/start"))
51
- }
52
-
53
- @Test
54
- fun `an absolute path keeps the port`() {
55
- redirects["/files/start"] = "/other/file.zip"
56
-
57
- assertEquals(server.url("/other/file.zip").toString(), resolve("/files/start"))
58
- }
59
-
60
- @Test
61
- fun `a chain of relative redirects resolves each step against the previous one`() {
62
- redirects["/a/start"] = "../b/step"
63
- redirects["/b/step"] = "final.zip"
64
-
65
- assertEquals(server.url("/b/final.zip").toString(), resolve("/a/start"))
66
- }
67
- }