@kesha-antonov/react-native-background-downloader 4.8.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.
- package/README.md +10 -5
- package/android/build.gradle +5 -1
- package/android/consumer-rules.pro +14 -0
- package/android/src/main/AndroidManifest.xml +18 -1
- package/android/src/main/java/com/eko/UIDTDownloadJobService.kt +5 -567
- package/android/src/main/java/com/eko/uidt/CancelDownloadReceiver.kt +4 -58
- package/android/src/main/java/com/{eko → kesha_antonov}/DownloadConstants.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/DownloadEventEmitter.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/DownloadResult.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/Downloader.kt +2 -2
- package/android/src/main/java/com/{eko → kesha_antonov}/ProgressReporter.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/PromiseExtensions.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/RNBGDTaskConfig.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/RNBGDUploadTaskConfig.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModuleImpl.kt +9 -9
- package/android/src/main/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderPackage.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloadService.kt +11 -9
- package/android/src/main/java/com/{eko → kesha_antonov}/ResumableDownloader.kt +2 -2
- package/android/src/main/java/com/kesha_antonov/UIDTDownloadJobService.kt +590 -0
- package/android/src/main/java/com/{eko → kesha_antonov}/UnmeteredNetworkGate.kt +2 -2
- package/android/src/main/java/com/{eko → kesha_antonov}/UploadEventEmitter.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/Uploader.kt +2 -2
- package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBegin.kt +4 -4
- package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnBeginState.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgress.kt +4 -4
- package/android/src/main/java/com/{eko → kesha_antonov}/handlers/OnProgressState.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/BeginCallback.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/interfaces/ProgressCallback.kt +1 -1
- package/android/src/main/java/com/kesha_antonov/uidt/CancelDownloadReceiver.kt +68 -0
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/RNBGDFileProvider.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobIds.kt +9 -4
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobManager.kt +6 -6
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTJobState.kt +7 -5
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIds.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationManager.kt +18 -10
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/FileUtils.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/HeaderUtils.kt +2 -2
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/NetworkRequestUtils.kt +1 -1
- package/android/src/main/java/com/kesha_antonov/utils/NotificationUtils.kt +24 -0
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/ProgressUtils.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/ReadableConverters.kt +1 -1
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/RedirectResolver.kt +3 -3
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/StorageManager.kt +5 -5
- package/android/src/main/java/com/{eko → kesha_antonov}/utils/TempFileUtils.kt +2 -2
- package/android/src/newarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
- package/android/src/oldarch/java/com/{eko → kesha_antonov}/RNBackgroundDownloaderModule.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/DownloadCompleteReceiverTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderRecoveryTest.kt +2 -2
- package/android/src/test/java/com/{eko → kesha_antonov}/DownloaderResumeTest.kt +3 -3
- package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderConcurrencyTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderRedirectTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/ResumableDownloaderStallTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/UnmeteredNetworkGateTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/UploadPartRangesTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/UploaderMultipartTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/UploaderPartsTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/UploaderResponseTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/handlers/OnBeginTest.kt +2 -2
- package/android/src/test/java/com/{eko → kesha_antonov}/uidt/CancelDownloadReceiverTest.kt +25 -2
- package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobIdsTest.kt +13 -2
- package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTJobManagerTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/uidt/UIDTNotificationIdsTest.kt +1 -1
- package/android/src/test/java/com/{eko → kesha_antonov}/utils/RedirectResolverTest.kt +1 -1
- package/bin/react-native-background-downloader.js +197 -0
- package/ios/RNBackgroundDownloader.mm +25 -5
- package/package.json +5 -2
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
'use strict'
|
|
3
|
+
|
|
4
|
+
// Command line helper for @kesha-antonov/react-native-background-downloader.
|
|
5
|
+
//
|
|
6
|
+
// npx react-native-background-downloader migrate-package [dir] [--write]
|
|
7
|
+
//
|
|
8
|
+
// Finds references to the library's old Android package (com.eko) in an app
|
|
9
|
+
// and, with --write, changes them to com.kesha_antonov. Only the library's own
|
|
10
|
+
// class and package names are changed; anything else under com.eko is listed
|
|
11
|
+
// for review, since an app can have its own com.eko package.
|
|
12
|
+
|
|
13
|
+
const fs = require('fs')
|
|
14
|
+
const path = require('path')
|
|
15
|
+
|
|
16
|
+
const OLD_PACKAGE = 'com.eko'
|
|
17
|
+
const NEW_PACKAGE = 'com.kesha_antonov'
|
|
18
|
+
|
|
19
|
+
// Classes and subpackages of the library, as they appear after "com.eko."
|
|
20
|
+
const LIBRARY_NAMES = [
|
|
21
|
+
'RNBackgroundDownloaderPackage',
|
|
22
|
+
'RNBackgroundDownloaderModule',
|
|
23
|
+
'RNBackgroundDownloaderModuleImpl',
|
|
24
|
+
'RNBGDTaskConfig',
|
|
25
|
+
'RNBGDUploadTaskConfig',
|
|
26
|
+
'UploadPartResult',
|
|
27
|
+
'DownloadConstants',
|
|
28
|
+
'ResumableDownloadService',
|
|
29
|
+
'UIDTDownloadJobService',
|
|
30
|
+
'uidt',
|
|
31
|
+
'utils',
|
|
32
|
+
'handlers',
|
|
33
|
+
'interfaces',
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
const LIBRARY_REFERENCE = new RegExp(
|
|
37
|
+
`\\bcom\\.eko\\.(${LIBRARY_NAMES.join('|')})\\b`,
|
|
38
|
+
'g'
|
|
39
|
+
)
|
|
40
|
+
const ANY_REFERENCE = /\bcom\.eko\b/
|
|
41
|
+
|
|
42
|
+
const SCANNED_EXTENSIONS = new Set([
|
|
43
|
+
'.java',
|
|
44
|
+
'.kt',
|
|
45
|
+
'.pro',
|
|
46
|
+
'.gradle',
|
|
47
|
+
'.kts',
|
|
48
|
+
'.xml',
|
|
49
|
+
])
|
|
50
|
+
// Expo apps keep extra ProGuard rules in the app config (expo-build-properties)
|
|
51
|
+
const SCANNED_FILE_NAMES = new Set([
|
|
52
|
+
'app.json',
|
|
53
|
+
'app.config.js',
|
|
54
|
+
'app.config.ts',
|
|
55
|
+
'app.config.mjs',
|
|
56
|
+
'app.config.cjs',
|
|
57
|
+
])
|
|
58
|
+
const SKIPPED_DIRS = new Set([
|
|
59
|
+
'node_modules',
|
|
60
|
+
'.git',
|
|
61
|
+
'build',
|
|
62
|
+
'.gradle',
|
|
63
|
+
'.cxx',
|
|
64
|
+
'Pods',
|
|
65
|
+
'ios',
|
|
66
|
+
])
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Rewrite the library's com.eko references in one file's text.
|
|
70
|
+
* Returns the new text, the changed lines and the com.eko lines left as they are.
|
|
71
|
+
*/
|
|
72
|
+
function migrateText (text) {
|
|
73
|
+
const changed = []
|
|
74
|
+
const unresolved = []
|
|
75
|
+
const lines = text.split('\n')
|
|
76
|
+
const newLines = lines.map((line, index) => {
|
|
77
|
+
const newLine = line.replace(
|
|
78
|
+
LIBRARY_REFERENCE,
|
|
79
|
+
(_match, name) => `${NEW_PACKAGE}.${name}`
|
|
80
|
+
)
|
|
81
|
+
if (newLine !== line)
|
|
82
|
+
changed.push({ line: index + 1, before: line, after: newLine })
|
|
83
|
+
if (ANY_REFERENCE.test(newLine))
|
|
84
|
+
unresolved.push({ line: index + 1, text: newLine })
|
|
85
|
+
return newLine
|
|
86
|
+
})
|
|
87
|
+
return { text: newLines.join('\n'), changed, unresolved }
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
function shouldScan (fileName) {
|
|
91
|
+
return (
|
|
92
|
+
SCANNED_FILE_NAMES.has(fileName) ||
|
|
93
|
+
SCANNED_EXTENSIONS.has(path.extname(fileName))
|
|
94
|
+
)
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
function listFiles (dir) {
|
|
98
|
+
const files = []
|
|
99
|
+
for (const entry of fs.readdirSync(dir, { withFileTypes: true }))
|
|
100
|
+
if (entry.isDirectory()) {
|
|
101
|
+
if (!SKIPPED_DIRS.has(entry.name))
|
|
102
|
+
files.push(...listFiles(path.join(dir, entry.name)))
|
|
103
|
+
} else if (entry.isFile() && shouldScan(entry.name)) {
|
|
104
|
+
files.push(path.join(dir, entry.name))
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
return files
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* Find (and with write: true, fix) com.eko references under dir.
|
|
112
|
+
*/
|
|
113
|
+
function migratePackage (dir, { write = false } = {}) {
|
|
114
|
+
const results = []
|
|
115
|
+
for (const file of listFiles(dir)) {
|
|
116
|
+
const text = fs.readFileSync(file, 'utf8')
|
|
117
|
+
if (!text.includes(OLD_PACKAGE)) continue
|
|
118
|
+
const result = migrateText(text)
|
|
119
|
+
if (result.changed.length === 0 && result.unresolved.length === 0) continue
|
|
120
|
+
if (write && result.changed.length > 0)
|
|
121
|
+
fs.writeFileSync(file, result.text)
|
|
122
|
+
results.push({
|
|
123
|
+
file: path.relative(dir, file),
|
|
124
|
+
changed: result.changed,
|
|
125
|
+
unresolved: result.unresolved,
|
|
126
|
+
})
|
|
127
|
+
}
|
|
128
|
+
return results
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
function printUsage () {
|
|
132
|
+
console.log(`Usage: react-native-background-downloader migrate-package [dir] [--write]
|
|
133
|
+
|
|
134
|
+
Finds references to the old Android package com.eko in your app (Java, Kotlin,
|
|
135
|
+
Gradle, ProGuard and manifest files, and the Expo app config) and changes them
|
|
136
|
+
to com.kesha_antonov.
|
|
137
|
+
|
|
138
|
+
dir app root to scan, the current directory by default
|
|
139
|
+
--write change the files; without it nothing is written`)
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function main (args) {
|
|
143
|
+
const [command, ...rest] = args
|
|
144
|
+
if (command !== 'migrate-package') {
|
|
145
|
+
printUsage()
|
|
146
|
+
return command === undefined || command === '--help' || command === '-h'
|
|
147
|
+
? 0
|
|
148
|
+
: 1
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
const write = rest.includes('--write')
|
|
152
|
+
const dir = path.resolve(rest.find((arg) => !arg.startsWith('--')) || '.')
|
|
153
|
+
if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
|
|
154
|
+
console.error(`Not a directory: ${dir}`)
|
|
155
|
+
return 1
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
const results = migratePackage(dir, { write })
|
|
159
|
+
if (results.length === 0) {
|
|
160
|
+
console.log(`No references to ${OLD_PACKAGE} found in ${dir}.`)
|
|
161
|
+
return 0
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
let changeCount = 0
|
|
165
|
+
let unresolvedCount = 0
|
|
166
|
+
for (const { file, changed, unresolved } of results) {
|
|
167
|
+
console.log(`\n${file}`)
|
|
168
|
+
for (const change of changed) {
|
|
169
|
+
console.log(` ${change.line}: ${change.before.trim()}`)
|
|
170
|
+
console.log(` ${' '.repeat(String(change.line).length)} ${change.after.trim()}`)
|
|
171
|
+
}
|
|
172
|
+
for (const line of unresolved)
|
|
173
|
+
console.log(` ${line.line}: ${line.text.trim()} (check by hand)`)
|
|
174
|
+
changeCount += changed.length
|
|
175
|
+
unresolvedCount += unresolved.length
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
console.log('')
|
|
179
|
+
if (changeCount > 0)
|
|
180
|
+
console.log(
|
|
181
|
+
write
|
|
182
|
+
? `Changed ${changeCount} line(s).`
|
|
183
|
+
: `${changeCount} line(s) to change. Run again with --write to apply.`
|
|
184
|
+
)
|
|
185
|
+
|
|
186
|
+
if (unresolvedCount > 0)
|
|
187
|
+
console.log(
|
|
188
|
+
`${unresolvedCount} line(s) mention ${OLD_PACKAGE} but not a class of this library; check them by hand.`
|
|
189
|
+
)
|
|
190
|
+
|
|
191
|
+
return 0
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
module.exports = { migrateText, migratePackage, main }
|
|
195
|
+
|
|
196
|
+
if (require.main === module)
|
|
197
|
+
process.exitCode = main(process.argv.slice(2))
|
|
@@ -10,17 +10,21 @@
|
|
|
10
10
|
#import <ReactCommon/TurboModule.h>
|
|
11
11
|
#endif
|
|
12
12
|
|
|
13
|
-
#define ID_TO_CONFIG_MAP_KEY @"com.
|
|
14
|
-
#define ID_TO_UPLOAD_CONFIG_MAP_KEY @"com.
|
|
13
|
+
#define ID_TO_CONFIG_MAP_KEY @"com.kesha_antonov.bgdownloadidmap"
|
|
14
|
+
#define ID_TO_UPLOAD_CONFIG_MAP_KEY @"com.kesha_antonov.bguploadidmap"
|
|
15
15
|
// Finished uploads kept until JS has their response, by upload id
|
|
16
|
-
#define FINISHED_UPLOADS_KEY @"com.
|
|
16
|
+
#define FINISHED_UPLOADS_KEY @"com.kesha_antonov.bguploadfinished"
|
|
17
17
|
#define PROGRESS_INTERVAL_KEY @"progressInterval"
|
|
18
18
|
#define PROGRESS_MIN_BYTES_KEY @"progressMinBytes"
|
|
19
19
|
#define MAX_PARALLEL_DOWNLOADS_KEY @"maxParallelDownloads"
|
|
20
20
|
// Persisted map of downloads whose finished file could not be moved to its destination
|
|
21
21
|
// yet because the device was locked (Data Protection). The move is retried when protected
|
|
22
22
|
// data becomes available / on next launch. See issue #101.
|
|
23
|
-
#define PENDING_MOVES_MAP_KEY @"com.
|
|
23
|
+
#define PENDING_MOVES_MAP_KEY @"com.kesha_antonov.bgdpendingmoves"
|
|
24
|
+
// Keys used before the move to com.kesha_antonov; moved to the new keys on launch
|
|
25
|
+
// so downloads and uploads running across the update are not forgotten
|
|
26
|
+
#define LEGACY_KEY_PREFIX @"com.eko."
|
|
27
|
+
#define KEY_PREFIX @"com.kesha_antonov."
|
|
24
28
|
|
|
25
29
|
// Session configuration constants
|
|
26
30
|
static const NSInteger kMaxConnectionsPerHost = 4;
|
|
@@ -209,7 +213,7 @@ RCT_EXPORT_MODULE();
|
|
|
209
213
|
|
|
210
214
|
- (dispatch_queue_t)methodQueue
|
|
211
215
|
{
|
|
212
|
-
return dispatch_queue_create("com.
|
|
216
|
+
return dispatch_queue_create("com.kesha_antonov.backgrounddownloader", DISPATCH_QUEUE_SERIAL);
|
|
213
217
|
}
|
|
214
218
|
|
|
215
219
|
#ifndef RCT_NEW_ARCH_ENABLED
|
|
@@ -339,6 +343,7 @@ static const int kMaxEventRetries = 50; // 50 retries * 100ms = 5 seconds max w
|
|
|
339
343
|
if (self) {
|
|
340
344
|
[MMKV initializeMMKV:nil];
|
|
341
345
|
mmkv = [MMKV mmkvWithID:@"RNBackgroundDownloader"];
|
|
346
|
+
[self migrateLegacyKeys];
|
|
342
347
|
|
|
343
348
|
NSString *bundleIdentifier = [[NSBundle mainBundle] bundleIdentifier];
|
|
344
349
|
NSString *sessionIdentifier = [bundleIdentifier stringByAppendingString:@".backgrounddownloadtask"];
|
|
@@ -431,6 +436,21 @@ static const int kMaxEventRetries = 50; // 50 retries * 100ms = 5 seconds max w
|
|
|
431
436
|
|
|
432
437
|
// The session isn't invalidated here or on reload: that would cancel every transfer. The
|
|
433
438
|
// next module instance takes it over (see -lazyRegisterSession).
|
|
439
|
+
// Move stored state from the com.eko.* keys to the com.kesha_antonov.* ones. A key that
|
|
440
|
+
// already has a value under its new name keeps it; the old key is removed either way.
|
|
441
|
+
- (void)migrateLegacyKeys {
|
|
442
|
+
NSArray<NSString *> *keys = @[ID_TO_CONFIG_MAP_KEY, ID_TO_UPLOAD_CONFIG_MAP_KEY, FINISHED_UPLOADS_KEY, PENDING_MOVES_MAP_KEY];
|
|
443
|
+
for (NSString *key in keys) {
|
|
444
|
+
NSString *legacyKey = [LEGACY_KEY_PREFIX stringByAppendingString:[key substringFromIndex:[KEY_PREFIX length]]];
|
|
445
|
+
if (![mmkv containsKey:legacyKey]) continue;
|
|
446
|
+
if (![mmkv containsKey:key]) {
|
|
447
|
+
NSData *data = [mmkv getDataForKey:legacyKey];
|
|
448
|
+
if (data != nil) [mmkv setData:data forKey:key];
|
|
449
|
+
}
|
|
450
|
+
[mmkv removeValueForKey:legacyKey];
|
|
451
|
+
}
|
|
452
|
+
}
|
|
453
|
+
|
|
434
454
|
- (void)dealloc {
|
|
435
455
|
DLog(nil, @"[RNBackgroundDownloader] - [dealloc]");
|
|
436
456
|
[self unregisterBridgeListener];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@kesha-antonov/react-native-background-downloader",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0",
|
|
4
4
|
"description": "Background file downloads and uploads for React Native and Expo. Large files keep transferring on iOS and Android while your app is in the background or terminated. Pause/resume, progress events, TurboModules, TypeScript.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react-native",
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
"name": "Kesha Antonov, Elad Gil"
|
|
49
49
|
}
|
|
50
50
|
],
|
|
51
|
+
"bin": "bin/react-native-background-downloader.js",
|
|
51
52
|
"main": "lib/index.js",
|
|
52
53
|
"react-native": "src/index.ts",
|
|
53
54
|
"types": "lib/index.d.ts",
|
|
@@ -59,7 +60,7 @@
|
|
|
59
60
|
"type": "modules",
|
|
60
61
|
"jsSrcsDir": "src",
|
|
61
62
|
"android": {
|
|
62
|
-
"javaPackageName": "com.
|
|
63
|
+
"javaPackageName": "com.kesha_antonov"
|
|
63
64
|
}
|
|
64
65
|
},
|
|
65
66
|
"files": [
|
|
@@ -73,6 +74,8 @@
|
|
|
73
74
|
"ios/",
|
|
74
75
|
"!ios/Tests/",
|
|
75
76
|
"android/build.gradle",
|
|
77
|
+
"android/consumer-rules.pro",
|
|
78
|
+
"bin/",
|
|
76
79
|
"android/src/",
|
|
77
80
|
"plugin/build/"
|
|
78
81
|
],
|