@kesha-antonov/react-native-background-downloader

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.

Why?

On iOS, if you want to download big files no matter the state of your app, wether it's in the background or terminated by the OS, you have to use a system API called NSURLSession.

This API handles your downloads separately from your app and only keeps it informed using delegates (Read: Downloading Files in the Background).

On Android we are using similar process with DownloadManager

The real challenge of using this method is making sure the app's UI is always up-to-date with the downloads that are happening in another process because your app might startup from scratch while the downloads are still running.

@kesha-antonov/react-native-background-downloader gives you an easy API to both downloading large files and re-attaching to those downloads once your app launches again.

Getting started

yarn add @kesha-antonov/react-native-background-downloader

npm i @kesha-antonov/react-native-background-downloader

Then:

cd ios && pod install

Mostly automatic installation

Any React Native version >= 0.60 supports autolinking so nothing should be done.

For anything < 0.60 run the following link command

$ react-native link @kesha-antonov/react-native-background-downloader

Manual installation

iOS

In XCode, in the project navigator, right click Libraries ➜ Add Files to [your project's name]
Go to node_modules ➜ @kesha-antonov/react-native-background-downloader and add RNBackgroundDownloader.xcodeproj
In XCode, in the project navigator, select your project. Add libRNBackgroundDownloader.a to your project's Build Phases ➜ Link Binary With Libraries
Run your project (Cmd+R)

Android

Open up android/app/src/main/java/[...]/MainActivity.java

Add import com.eko.RNBackgroundDownloaderPackage; to the imports at the top of the file
Add new RNBackgroundDownloaderPackage() to the list returned by the getPackages() method

Append the following lines to android/settings.gradle:

include ':react-native-background-downloader'
project(':react-native-background-downloader').projectDir = new File(rootProject.projectDir,   '../node_modules/@kesha-antonov/react-native-background-downloader/android')

Insert the following lines inside the dependencies block in android/app/build.gradle:
```
  compile project(':react-native-background-downloader')
```

iOS - Extra Mandatory Step

In your AppDelegate.m add the following code:

...
#import <RNBackgroundDownloader.h>

...

- (void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)(void))completionHandler
{
  [RNBackgroundDownloader setCompletionHandlerWithIdentifier:identifier completionHandler:completionHandler];
}

...

Failing to add this code will result in canceled background downloads. If Xcode complains that RNBackgroundDownloader.h is missing, you might have forgotten to pod install first.

Usage

Downloading a file

import { Platform } from 'react-native'
import { download, completeHandler, directories } from '@kesha-antonov/react-native-background-downloader'

const jobId = 'file123'

let task = download({
  id: jobId,
  url: 'https://link-to-very.large/file.zip',
  destination: `${directories.documents}/file.zip`,
  metadata: {}
}).begin(({ expectedBytes, headers }) => {
  console.log(`Going to download ${expectedBytes} bytes!`)
}).progress(({ bytesDownloaded, bytesTotal }) => {
  console.log(`Downloaded: ${bytesDownloaded / bytesTotal * 100}%`)
}).done(({ bytesDownloaded, bytesTotal }) => {
  console.log('Download is done!', { bytesDownloaded, bytesTotal })

  // PROCESS YOUR STUFF

  // FINISH DOWNLOAD JOB
  completeHandler(jobId)
}).error(({ error, errorCode }) => {
  console.log('Download canceled due to error: ', { error, errorCode });
})

// Pause the task (iOS only)
task.pause()

// Resume after pause (iOS only)
task.resume()

// Cancel the task
task.stop()

Re-Attaching to background downloads

This is the main selling point of this library (but it's free!).

What happens to your downloads after the OS stopped your app? Well, they are still running, we just need to re-attach to them.

Add this code to app's init stage, and you'll never lose a download again!

import RNBackgroundDownloader from '@kesha-antonov/react-native-background-downloader'

let lostTasks = await RNBackgroundDownloader.checkForExistingDownloads()
for (let task of lostTasks) {
  console.log(`Task ${task.id} was found!`)
  task.progress(({ bytesDownloaded, bytesTotal }) => {
    console.log(`Downloaded: ${bytesDownloaded / bytesTotal * 100}%`)
  }).done(({ bytesDownloaded, bytesTotal }) => {
    console.log('Download is done!', { bytesDownloaded, bytesTotal })
  }).error(({ error, errorCode }) => {
    console.log('Download canceled due to error: ', { error, errorCode })
  })
}

task.id is very important for re-attaching the download task with any UI component representing that task. This is why you need to make sure to give sensible IDs that you know what to do with, try to avoid using random IDs.

Using custom headers

If you need to send custom headers with your download request, you can do in it 2 ways:

Globally using RNBackgroundDownloader.setConfig():

RNBackgroundDownloader.setConfig({
  headers: {
    Authorization: 'Bearer 2we$@$@Ddd223',
  }
})

This way, all downloads with have the given headers.

Per download by passing a headers object in the options of RNBackgroundDownloader.download():

let task = RNBackgroundDownloader.download({
  id: 'file123',
  url: 'https://link-to-very.large/file.zip'
  destination: `${RNBackgroundDownloader.directories.documents}/file.zip`,
  headers: {
    Authorization: 'Bearer 2we$@$@Ddd223'
  }
}).begin(({ expectedBytes, headers }) => {
  console.log(`Going to download ${expectedBytes} bytes!`)
}).progress(({ bytesDownloaded, bytesTotal }) => {
  console.log(`Downloaded: ${bytesDownloaded / bytesTotal * 100}%`)
}).done(({ bytesDownloaded, bytesTotal }) => {
  console.log('Download is done!', { bytesDownloaded, bytesTotal })
}).error(({ error, errorCode }) => {
  console.log('Download canceled due to error: ', { error, errorCode })
})

Headers given in the download function are merged with the ones given in setConfig({ headers: { ... } }).

API

RNBackgroundDownloader

`download(options)`

Download a file to destination

options

An object containing options properties

Property	Type	Required	Platforms	Info
`id`	String	✅	All	A Unique ID to provide for this download. This ID will help to identify the download task when the app re-launches
`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 `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
`isNotificationVisible`	Boolean		Android	Whether to show a download notification or not

returns

DownloadTask - The download task to control and monitor this download

`checkForExistingDownloads()`

Checks for downloads that ran in background while you app was terminated. And also forces them to resume downloads.

Recommended to run at the init stage of the app.

returns

DownloadTask[] - Array of tasks that were running in the background so you can re-attach callbacks to them

`setConfig({})`

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

A class representing a download task created by RNBackgroundDownloader.download

`Members`

Name	Type	Info
`id`	String	The id you gave the task when calling `RNBackgroundDownloader.download`
`metadata`	Object	The metadata you gave the task when calling `RNBackgroundDownloader.download`
`bytesDownloaded`	Number	The number of bytes currently written by the task
`bytesTotal`	Number	The number bytes expected to be written by this task or more plainly, the file size being downloaded

`completeHandler(jobId)`

Finishes download job and informs OS that app can be closed in background if needed. After finishing download in background you have some time to process your JS logic and finish the job.

`ensureDownloadsAreRunning` (iOS only)

Pauses and resumes all downloads - this is fix for stuck downloads. Use it when your app loaded and is ready for handling downloads (all your logic loaded and ready to handle download callbacks).

Here's example of how you can use it:

When your app just loaded

Either stop all tasks:

const tasks = await checkForExistingDownloads()
for (const task of tasks)
  task.stop()

Or re-attach them:

const tasks = await checkForExistingDownloads()
for (const task of tasks) {
  task.pause()
  //
  // YOUR LOGIC OF RE-ATTACHING DOWLOADS TO YOUR STUFF
  // ...
  //
}

Prepare your app to handle downloads... (load your state etc.)
Add listener to handle when your app goes foreground (be sure to do it only after you stopped all tasks or re-attached them!)

function handleAppStateChange (appState) {
  if (appState !== 'active')
    return

  ensureDownloadsAreRunning()
}

const appStateChangeListener = AppState.addEventListener('change', handleAppStateChange)

Call ensureDownloadsAreRunning() after all was setup.

`Callback Methods`

Use these methods to stay updated on what's happening with the task.

All callback methods return the current instance of the DownloadTask for chaining.

Function	Callback Arguments	Info
`begin`	{ expectedBytes, headers }	Called when the first byte is received. 💡: this is good place to check if the device has enough storage space for this download
`progress`	{ bytesDownloaded, bytesTotal }	Called at max every 1.5s so you can update your progress bar accordingly
`done`	{ bytesDownloaded, bytesTotal }	Called when the download is done, the file is at the destination you've set
`error`	{ error, errorCode }	Called when the download stops due to an error

`pause()` (iOS only)

Pauses the download

`resume()` (iOS only)

Resumes a paused download

`stop()`

Stops the download for good and removes the file that was written so far

Constants

directories

`documents`

An absolute path to the app's documents directory. It is recommended that you use this path as the target of downloaded files.

Rules for proguard-rules.pro

In case of error java.lang.IllegalStateException: TypeToken must be created with a type argument: new TypeToken<...>() in Android release add this to proguard-rules.pro:

# Application classes that will be serialized/deserialized over Gson
-keep class com.yourapplicationname.model.api.** { *; }

# Gson uses generic type information stored in a class file when working with
# fields. Proguard removes such information by default, keep it.
-keepattributes Signature

# This is also needed for R8 in compat mode since multiple
# optimizations will remove the generic signature such as class
# merging and argument removal. See:
# https://r8.googlesource.com/r8/+/refs/heads/main/compatibility-faq.md#troubleshooting-gson-gson
-keep class com.google.gson.reflect.TypeToken { *; }
-keep class * extends com.google.gson.reflect.TypeToken

# Optional. For using GSON @Expose annotation
-keepattributes AnnotationDefault,RuntimeVisibleAnnotations

TODO

Write better examples - current kinda old and shallow
Write better API for downloads - current kinda boilerplate
Add more tests

Authors

Re-written & maintained by Kesha Antonov

Originally developed by Elad Gil of Eko

License

Apache 2

kesha-antonov/react-native-background-downloader