@kesha-antonov/react-native-background-downloader 3.0.0-beta.1 → 3.0.0

package/README.md

@@ -163,10 +163,12 @@ for (let task of lostTasks) {
 ### Using custom headers
 If you need to send custom headers with your download request, you can do in it 2 ways:
 
-1) Globally using `RNBackgroundDownloader.setHeaders()`:
+1) Globally using `RNBackgroundDownloader.setConfig()`:
 ```javascript
-RNBackgroundDownloader.setHeaders({
-  Authorization: 'Bearer 2we$@$@Ddd223'
+RNBackgroundDownloader.setConfig({
+  headers: {
+    Authorization: 'Bearer 2we$@$@Ddd223',
+  }
 })
 ```
 This way, all downloads with have the given headers.
@@ -190,7 +192,7 @@ let task = RNBackgroundDownloader.download({
   console.log('Download canceled due to error: ', error)
 })
 ```
-Headers given in the `download` function are **merged** with the ones given in `setHeaders`.
+Headers given in the `download` function are **merged** with the ones given in `setConfig({ headers: { ... } })`.
 
 ## API
 
@@ -210,7 +212,7 @@ An object containing options properties
 | `url`         | String |    ✅     |    All    | URL to file you want to download |
 | `destination` | String |    ✅     |    All    | Where to copy the file to once the download is done |
 | `metadata`    | Object |           |    All    | Data to be preserved on reboot. |
-| `headers`     | Object |           |    All    | Costume headers to add to the download request. These are merged with the headers given in the `setHeaders` function |
+| `headers`     | Object |           |    All    | Costume headers to add to the download request. These are merged with the headers given in the `setConfig({ headers: { ... } })` function |
 | `isAllowedOverRoaming` | Boolean   |          |  Android  | whether this download may proceed over a roaming connection. By default, roaming is allowed |
 | `isAllowedOverMetered` | Boolean   |          |  Android  | Whether this download may proceed over a metered network connection. By default, metered networks are allowed |
 
@@ -228,11 +230,13 @@ Recommended to run at the init stage of the app.
 
 `DownloadTask[]` - Array of tasks that were running in the background so you can re-attach callbacks to them
 
-### `setHeaders(headers)`
-
-Sets headers to use in all future downloads.
+### `setConfig({})`
 
-**headers** - Object
+| Name           | Type   | Info                                                                                                 |
+| -------------- | ------ | ---------------------------------------------------------------------------------------------------- |
+| `headers`     | Object | optional headers to use in all future downloads |
+| `progressInterval` | Number | Interval in which download progress sent from downloader. Number should be >= 250. It's in ms |
+| `isLogsEnabled`   | Boolean | Enables/disables logs in library |
 
 ### DownloadTask
 

package/android/src/main/java/com/eko/Downloader.java

@@ -51,7 +51,6 @@ public class Downloader {
     }
 
     public int cancelDownload(long downloadId) {
-        Log.d("RNBackgroundDownloader", "Downloader cancelDownload " + downloadId);
         return downloadManager.remove(downloadId);
     }
 

package/android/src/main/java/com/eko/OnProgress.java

@@ -38,7 +38,6 @@ public class OnProgress extends Thread {
 
   private void handleInterrupt() {
     try {
-      Log.d("RNBackgroundDownloader", "RNBD: OnProgress handleInterrupt. downloadId " + downloadId);
       if (cursor != null) {
         cursor.close();
       }
@@ -50,11 +49,8 @@ public class OnProgress extends Thread {
 
   @Override
   public void run() {
-    Log.d("RNBackgroundDownloader", "RNBD: OnProgress-1. downloadId " + downloadId);
     while (downloadId > 0) {
       try {
-        Log.d("RNBackgroundDownloader", "RNBD: OnProgress-2. downloadId " + downloadId + " destination " + config.destination);
-
         cursor = downloader.downloadManager.query(query);
 
         if (!cursor.moveToFirst()) {
@@ -67,13 +63,10 @@ public class OnProgress extends Thread {
         }
 
         if (status == DownloadManager.STATUS_PAUSED) {
-          Log.d("RNBackgroundDownloader", "RNBD: OnProgress-2.1. downloadId " + downloadId);
           Thread.sleep(5000);
         } else if (status == DownloadManager.STATUS_PENDING) {
-          Log.d("RNBackgroundDownloader", "RNBD: OnProgress-2.2. downloadId " + downloadId);
           Thread.sleep(1000);
         } else {
-          Log.d("RNBackgroundDownloader", "RNBD: OnProgress-2.3. downloadId " + downloadId);
           Thread.sleep(250);
         }
 
@@ -90,9 +83,6 @@ public class OnProgress extends Thread {
           lastBytesDownloaded = bytesDownloaded;
         }
 
-        Log.d("RNBackgroundDownloader", "RNBD: OnProgress-3. downloadId " + downloadId + " bytesDownloaded "
-            + bytesDownloaded + " bytesTotal " + bytesTotal);
-
         if (lastBytesDownloaded > 0 && bytesTotal > 0) {
           callback.onProgress(config.id, lastBytesDownloaded, bytesTotal);
         }
@@ -102,11 +92,11 @@ public class OnProgress extends Thread {
 
       try {
         if (cursor != null) {
-          Log.d("RNBackgroundDownloader", "RNBD: OnProgress-5. downloadId " + downloadId);
           cursor.close();
-          Log.d("RNBackgroundDownloader", "RNBD: OnProgress-6. downloadId " + downloadId);
         }
       } catch (Exception e) {
+        e.printStackTrace();
+        Log.e("RNBackgroundDownloader", "RNBD: OnProgress e: " + Log.getStackTraceString(e));
         return;
       }
     }

package/android/src/main/java/com/eko/RNBackgroundDownloaderModule.java

@@ -94,19 +94,15 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   BroadcastReceiver downloadReceiver = new BroadcastReceiver() {
     @Override
     public void onReceive(Context context, Intent intent) {
-      Log.d(getName(), "RNBD: onReceive-1");
       try {
         long downloadId = intent.getLongExtra(DownloadManager.EXTRA_DOWNLOAD_ID, -1);
-        Log.d(getName(), "RNBD: onReceive-2 " + downloadId);
 
         RNBGDTaskConfig config = downloadIdToConfig.get(downloadId);
 
         if (config != null) {
-          Log.d(getName(), "RNBD: onReceive-3");
           WritableMap downloadStatus = downloader.checkDownloadStatus(downloadId);
           int status = downloadStatus.getInt("status");
 
-          Log.d(getName(), "RNBD: onReceive: status - " + status);
 
           stopTrackingProgress(config.id);
 
@@ -115,11 +111,8 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
               case DownloadManager.STATUS_SUCCESSFUL: {
                 // MOVES FILE TO DESTINATION
                 String localUri = downloadStatus.getString("localUri");
-                Log.d(getName(), "RNBD: onReceive: localUri " + localUri + " destination " + config.destination);
                 File file = new File(localUri);
-                Log.d(getName(), "RNBD: onReceive: file exists " + file.exists());
                 File dest = new File(config.destination);
-                Log.d(getName(), "RNBD: onReceive: dest exists " + dest.exists());
                 Files.move(file.toPath(), dest.toPath(), StandardCopyOption.REPLACE_EXISTING);
 
                 WritableMap params = Arguments.createMap();
@@ -146,6 +139,7 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
           }
         }
       } catch (Exception e) {
+        e.printStackTrace();
         Log.e(getName(), "downloadReceiver: onReceive. " + Log.getStackTraceString(e));
       }
     }
@@ -236,8 +230,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void removeFromMaps(long downloadId) {
-    Log.d(getName(), "RNBD: removeFromMaps");
-
     synchronized (sharedLock) {
       RNBGDTaskConfig config = downloadIdToConfig.get(downloadId);
       if (config != null) {
@@ -251,8 +243,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void saveDownloadIdToConfigMap() {
-    Log.d(getName(), "RNBD: saveDownloadIdToConfigMap");
-
     synchronized (sharedLock) {
       File file = new File(this.getReactApplicationContext().getFilesDir(), getName() + "_downloadIdToConfig");
       try {
@@ -267,8 +257,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void loadDownloadIdToConfigMap() {
-    Log.d(getName(), "RNBD: loadDownloadIdToConfigMap");
-
     File file = new File(this.getReactApplicationContext().getFilesDir(), getName() + "_downloadIdToConfig");
     if (file.exists()) {
       try {
@@ -281,8 +269,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void saveConfigMap () {
-    Log.d(getName(), "RNBD: saveConfigMap");
-
     synchronized (sharedLock) {
       File file = new File(this.getReactApplicationContext().getFilesDir(), getName() + "_config");
       try {
@@ -300,8 +286,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void loadConfigMap () {
-    Log.d(getName(), "RNBD: loadConfigMap");
-
     File file = new File(this.getReactApplicationContext().getFilesDir(), getName() + "_config");
     if (file.exists()) {
       try {
@@ -312,7 +296,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
           String key = entry.getKey();
 
           Object valueObj = entry.getValue();
-          Log.d(getName(), "RNBD: loadConfigMap-1 " + " key " + key + " valueObj " + valueObj);
           String value = null;
           if (valueObj instanceof Long) {
             value = Long.toString((Long) valueObj);
@@ -354,8 +337,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
     boolean isAllowedOverRoaming = options.getBoolean("isAllowedOverRoaming");
     boolean isAllowedOverMetered = options.getBoolean("isAllowedOverMetered");
 
-    Log.d(getName(), "RNBD: download " + id + " " + url + " " + destination + " " + metadata + " " + progressInterval);
-
     if (id == null || url == null || destination == null) {
       Log.e(getName(), "id, url and destination must be set");
       return;
@@ -398,8 +379,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
       WritableMap downloadStatus = downloader.checkDownloadStatus(downloadId);
       int status = downloadStatus.getInt("status");
 
-      Log.d(getName(), "RNBD: download-1. status: " + status + " downloadId: " + downloadId);
-
       if (config.reportedBegin) {
         return;
       }
@@ -409,31 +388,24 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   }
 
   private void startReportingTasks(Long downloadId, RNBGDTaskConfig config) {
-    Log.d(getName(), "RNBD: startReportingTasks-1 downloadId " + downloadId + " config.id " + config.id);
     config.reportedBegin = true;
     downloadIdToConfig.put(downloadId, config);
     saveDownloadIdToConfigMap();
 
-    Log.d(getName(), "RNBD: startReportingTasks-2 downloadId: " + downloadId);
     // report begin & progress
     //
     // overlaped with thread to not block main thread
     new Thread(new Runnable() {
       public void run() {
         try {
-          Log.d(getName(), "RNBD: startReportingTasks-3 downloadId: " + downloadId);
-
           while (true) {
             WritableMap downloadStatus = downloader.checkDownloadStatus(downloadId);
             int status = downloadStatus.getInt("status");
 
-            Log.d(getName(), "RNBD: startReportingTasks-3.1 " + status + " downloadId: " + downloadId);
-
             if (status == DownloadManager.STATUS_RUNNING) {
               break;
             }
             if (status == DownloadManager.STATUS_FAILED || status == DownloadManager.STATUS_SUCCESSFUL) {
-              Log.d(getName(), "RNBD: startReportingTasks-3.2 " + status + " downloadId: " + downloadId);
               Thread.currentThread().interrupt();
             }
 
@@ -446,7 +418,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
           // wait for onBeginTh to finish
           onBeginTh.join();
 
-          Log.d(getName(), "RNBD: startReportingTasks-4 downloadId: " + downloadId);
           OnProgress onProgressTh = new OnProgress(
             config,
             downloadId,
@@ -454,12 +425,9 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
             new ProgressCallback() {
               @Override
               public void onProgress(String configId, int bytesDownloaded, int bytesTotal) {
-                Log.d(getName(), "RNBD: onProgress-1 " + configId + " " + bytesDownloaded + " " + bytesTotal);
-
                 double prevPercent = configIdToPercent.get(configId);
                 double percent = (double) bytesDownloaded / bytesTotal;
                 if (percent - prevPercent > 0.01) {
-                  Log.d(getName(), "RNBD: onProgress-2 " + configId + " " + bytesDownloaded + " " + bytesTotal);
                   WritableMap params = Arguments.createMap();
                   params.putString("id", configId);
                   params.putInt("bytesDownloaded", bytesDownloaded);
@@ -474,7 +442,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
                   now.getTime() - lastProgressReportedAt.getTime() > progressInterval &&
                   progressReports.size() > 0
                 ) {
-                  Log.d(getName(), "RNBD: onProgress-3 " + configId + " " + bytesDownloaded + " " + bytesTotal);
                   WritableArray reportsArray = Arguments.createArray();
                   for (Object report : progressReports.values()) {
                     reportsArray.pushMap((WritableMap) report);
@@ -488,20 +455,17 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
            );
           onProgressThreads.put(config.id, onProgressTh);
           onProgressTh.start();
-          Log.d(getName(), "RNBD: startReportingTasks-5 downloadId: " + downloadId);
         } catch (Exception e) {
-          Log.d(getName(), "RNBD: Runnable e: " + e.toString());
+          e.printStackTrace();
+          Log.e(getName(), "RNBD: Runnable e: " + Log.getStackTraceString(e));
         }
       }
     }).start();
-    Log.d(getName(), "RNBD: startReportingTasks-6 downloadId: " + downloadId);
   }
 
   // TODO: NOT WORKING WITH DownloadManager FOR NOW
   @ReactMethod
   public void pauseTask(String configId) {
-    Log.d(getName(), "RNBD: pauseTask " + configId);
-
     synchronized (sharedLock) {
       Long downloadId = configIdToDownloadId.get(configId);
       if (downloadId != null) {
@@ -513,8 +477,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
   // TODO: NOT WORKING WITH DownloadManager FOR NOW
   @ReactMethod
   public void resumeTask(String configId) {
-    Log.d(getName(), "RNBD: resumeTask " + configId);
-
     synchronized (sharedLock) {
       Long downloadId = configIdToDownloadId.get(configId);
       if (downloadId != null) {
@@ -525,11 +487,8 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
 
   @ReactMethod
   public void stopTask(String configId) {
-    Log.d(getName(), "RNBD: stopTask-1 " + configId);
-
     synchronized (sharedLock) {
       Long downloadId = configIdToDownloadId.get(configId);
-      Log.d(getName(), "RNBD: stopTask-2 " + configId + " downloadId " + downloadId);
       if (downloadId != null) {
         // DELETES CONFIG HERE SO receiver WILL NOT THROW ERROR DOWNLOAD_FAILED TO THE
         // USER
@@ -543,11 +502,8 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
 
   @ReactMethod
   public void completeHandler(String configId, final Promise promise) {
-    Log.d(getName(), "RNBD: completeHandler-1 " + configId);
-
     synchronized (sharedLock) {
       Long downloadId = configIdToDownloadId.get(configId);
-      Log.d(getName(), "RNBD: completeHandler-2 " + configId + " downloadId " + downloadId);
       if (downloadId != null) {
         removeFromMaps(downloadId);
         // REMOVES DOWNLOAD FROM DownloadManager SO IT WOULD NOT BE RETURNED IN checkForExistingDownloads
@@ -558,8 +514,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
 
   @ReactMethod
   public void checkForExistingDownloads(final Promise promise) {
-    Log.d(getName(), "RNBD: checkForExistingDownloads-1");
-
     WritableArray foundIds = Arguments.createArray();
 
     synchronized (sharedLock) {
@@ -573,7 +527,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
             Long downloadId = Long.parseLong(downloadStatus.getString("downloadId"));
 
             if (downloadIdToConfig.containsKey(downloadId)) {
-              Log.d(getName(), "RNBD: checkForExistingDownloads-2");
               RNBGDTaskConfig config = downloadIdToConfig.get(downloadId);
               WritableMap params = Arguments.createMap();
               params.putString("id", config.id);
@@ -596,7 +549,6 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
               // TOREMOVE
               // config.reportedBegin = true;
             } else {
-              Log.d(getName(), "RNBD: checkForExistingDownloads-3");
               downloader.cancelDownload(downloadId);
             }
           } while (cursor.moveToNext());
@@ -604,7 +556,8 @@ public class RNBackgroundDownloaderModule extends ReactContextBaseJavaModule {
 
         cursor.close();
       } catch (Exception e) {
-        Log.e(getName(), "Error in checkForExistingDownloads: " + e.getLocalizedMessage());
+        e.printStackTrace();
+        Log.e(getName(), "CheckForExistingDownloads e: " + Log.getStackTraceString(e));
       }
     }
 

package/index.ts

@@ -4,6 +4,7 @@ import DownloadTask from './lib/DownloadTask'
 const { RNBackgroundDownloader } = NativeModules
 const RNBackgroundDownloaderEmitter = new NativeEventEmitter(RNBackgroundDownloader)
 
+const MIN_PROGRESS_INTERVAL = 250
 const tasksMap = new Map()
 
 const config = {
@@ -24,11 +25,11 @@ RNBackgroundDownloaderEmitter.addListener('downloadBegin', ({ id, ...rest }) =>
 })
 
 RNBackgroundDownloaderEmitter.addListener('downloadProgress', events => {
-  // log('[RNBackgroundDownloader] downloadProgress-1', events, tasksMap)
+  log('[RNBackgroundDownloader] downloadProgress-1', events, tasksMap)
   for (const event of events) {
     const { id, ...rest } = event
     const task = tasksMap.get(id)
-    // log('[RNBackgroundDownloader] downloadProgress-2', id, task)
+    log('[RNBackgroundDownloader] downloadProgress-2', id, task)
     task?.onProgress(rest)
   }
 })
@@ -53,10 +54,10 @@ export function setConfig({ headers, progressInterval, isLogsEnabled }) {
   if (typeof headers === 'object') config.headers = headers
 
   if (progressInterval != null)
-    if (typeof progressInterval === 'number' && progressInterval >= 200)
+    if (typeof progressInterval === 'number' && progressInterval >= MIN_PROGRESS_INTERVAL)
       config.progressInterval = progressInterval
     else
-      console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= 200. You passed ${progressInterval}`)
+      console.warn(`[RNBackgroundDownloader] progressInterval must be a number >= ${MIN_PROGRESS_INTERVAL}. You passed ${progressInterval}`)
 
   if (typeof isLogsEnabled === 'boolean') config.isLogsEnabled = isLogsEnabled
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kesha-antonov/react-native-background-downloader",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0",
   "description": "A library for React-Native to help you download large files on iOS and Android both in the foreground and most importantly in the background.",
   "keywords": [
     "react-native",
@@ -55,21 +55,21 @@
     ]
   },
   "devDependencies": {
-    "@babel/core": "^7.23.6",
+    "@babel/core": "^7.23.7",
     "@babel/eslint-parser": "^7.23.3",
-    "@babel/preset-env": "^7.23.6",
+    "@babel/preset-env": "^7.23.7",
     "@babel/preset-typescript": "^7.23.3",
-    "@babel/runtime": "^7.23.6",
+    "@babel/runtime": "^7.23.7",
     "@react-native/babel-preset": "^0.74.0",
     "@react-native/eslint-config": "^0.74.0",
-    "@typescript-eslint/eslint-plugin": "^6.13.1",
-    "@typescript-eslint/parser": "^6.13.1",
+    "@typescript-eslint/eslint-plugin": "^6.17.0",
+    "@typescript-eslint/parser": "^6.17.0",
     "babel-jest": "^29.7.0",
     "eslint": "^8.56.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-config-standard-jsx": "^11.0.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^16.5.0",
+    "eslint-plugin-n": "^16.6.1",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.1.1",
     "eslint-plugin-react": "^7.33.2",
@@ -80,7 +80,7 @@
     "lint-staged": ">=15",
     "metro-react-native-babel-preset": "^0.77.0",
     "react": "18.2.0",
-    "react-native": "0.73.0",
+    "react-native": "0.73.1",
     "react-native-fs": "^2.20.0",
     "react-native-vector-icons": "^10.0.3",
     "react-test-renderer": "18.2.0",