CHANGELOG.md

CHANGELOG

[4.0.5] — 2022-02-10

• [Fixed][iOS] Remove obsolete __has_include("RCTEventEmitter.h") code which was breaking Expo apps.

[4.0.4] — 2021-10-22

• [Fixed] EventEmitter warning about addListener / removeListeners
• [Changed] Re-generate /example app with react-native init. Complete re-factor to use React Hooks.

[4.0.3] — 2021-06-30

• [Changed][Android] Allow multiple calls to .configure to allow re-configuring the fetch task. Existing task will be cancelled and a new periodic fetch task re-scheduled according to new config.
• [Changed][Android] Ignore initial fetch task fired immediately.
• [Changed][Android] android:exported="false" on BootReceiver to resolve reported security analysis.

[4.0.2] — 2021-04-02

• [Fixed] Typescript definition for interface HeadlessEvent was missing timeout: boolean attribute. Thanks @mikehardy.

[4.0.1] — 2021-02-18

• [Fixed][Android] Fix java.lang.NullPointerException: Attempt to invoke virtual method 'java.lang.String com.transistorsoft.tsbackgroundfetch.BGTask.getTaskId()' on a null object reference
• [Fixed][iOS] Mistake implementing timeout callback for TSBackgroundFetch addListener. Provided old signature.

[4.0.0] — 2021-02-12

• [Added][iOS] Implement two new iOS options for BackgroundFetch.scheduleTask:

  • bool requiresNetworkConnectivity
  • bool requiresCharging (previously Android-only).

• [Changed][iOS] Migrate TSBackgroundFetch.framework to new .xcframework for MacCatalyst support with new Apple silcon.

⚠️ Breaking Change: Requires cocoapods >= 1.10+.

iOS' new .xcframework requires cocoapods >= 1.10+:

$ pod --version
// if < 1.10.0
$ sudo gem install cocoapods

• [Added] task-timeout callback. BackgroundFetch.configure now accepts the 3rd callback argument as onTimeout callback. This callback will be executed when the operating system has signalled your background-time is about to expire. You must stop what your task is doing and execute BackgroundFetch.finish(taskId) immediately.

let status = await BackgroundFetch.configure({  // <-- NEW:  returns Promise
  minimumFetchInterval: 15
}, async (taskId) => {  // <-- task callback.
  console.log("[BackgroundFetch] taskId:", taskId);
  BackgroundFetch.finish(taskId);
}, async (taskId) => {  // <-- NEW:  task-timeout callback.
  // This task has exceeded its allowed running-time.
  // You must stop what you're doing immediately finish(taskId)
  //
  console.log("[BackgroundFetch] TIMEOUT taskId", taskId);
  BackgroundFetch.finish(taskId);
});

⚠️ [Android] Breaking Change For Android Headless-task

• Headless task event-object now includes a new attribute event.timeout when the OS signals your allowed background-time is about to expire. You must immediately finish what you're doing and call BackgroundFetch.finish(taskId) immediately.

let myBackgroundFetchHeadlessTask = async (event) => {
  let taskId = event.taskId;
  let isTimeout = event.timeout;  // <-- NEW:  true if this task has timed-out.
  if (isTimeout) {
    // This task has exceeded its allowed running-time.
    // You must stop what you're doing immediately BackgroundFetch.finish(taskId)
    console.log("[BackgroundFetch] Headless TIMEOUT", taskId);
    BackgroundFetch.finish(taskId);
    return;
  }
  console.log("[BackgroundFetch] Headless task:", taskId);
  BackgroundFetch.finish(taskId);
}
BackgroundFetch.registerHeadlessTask(myBackgroundFetchHeadlessTask);

• [Changed] API for BackgroundGeolocation.configure now returns a Promise<BackgroundFetchStatus>

⚠️ Breaking Change: arguments to BackgroundFetch.configure

OLD: When BackgroundFetch failed to start (eg: user disabled "Background Fetch" permission in your app settings), the 3rd argument failureCallback would fire with the current BackgroundFetchStatus.

BackgroundFetch.configure(options, eventCallback, failureCallback);

NEW: The current BackgroundFetchStatus is now returned as a Promise when calling .configure(). The 3rd argument is now timeoutCallback, executed when OS has signalled your allowed background time is about to expire:

// BackgroundFetch event handler.
const onEvent = async (taskId) => {  // <-- task callback.
  console.log('[BackgroundFetch] task: ', taskId);
  // Do your background work...
  BackgroundFetch.finish(taskId);
}

// NEW:  Timeout callback is executed when your Task has exceeded its allowed running-time.
// You must stop what you're doing immediately BackgorundFetch.finish(taskId)
const onTimeout = async (taskId) => {
  console.warn('[BackgroundFetch] TIMEOUT task: ', taskId);
  BackgroundFetch.finish(taskId);
}

// Initialize BackgroundFetch only once when component mounts.
let status = await BackgroundFetch.configure({minimumFetchInterval: 15}, onEvent, onTimeout);

console.log('[BackgroundFetch] configure status: ', status);

[3.1.0] — 2020-06-12

• [Fixed][Android] com.android.tools.build:gradle:4.0.0 no longer allows "direct local aar dependencies". The Android Setup now requires a custom maven url to be added to your app's root android/build.gradle:

allprojects {
    repositories {
        mavenLocal()
        maven {
            // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
            url("$rootDir/../node_modules/react-native/android")
        }
        maven {
            // Android JSC is installed from npm
            url("$rootDir/../node_modules/jsc-android/dist")
        }
+       maven {
+           // react-native-background-fetch
+           url("${project(':react-native-background-fetch').projectDir}/libs")
+       }

    }
}

[3.0.6] — 2020-05-27

• [Fixed] Android check wakeLock.isHeld() before executing wakeLock.release().

[3.0.5] — 2020-05-13

• [Fixed] Remove an unnecessary reference to androidx to allow the plugin to work with non-androidX for those using RN <=0.59.
• [Added] Update Android Setup with new required proguard-rules.pro for those building release with minifyEnabled true. Fixes #261.

1. Edit android/app/proguard-rules.pro.
2. Add the following rule:

# [react-native-background-fetch]
-keep class com.transistorsoft.rnbackgroundfetch.HeadlessTask { *; }

[3.0.4] — 2020-03-24

• [Fixed] [iOS] Fixed bug calling start after executing stop.

[3.0.3] — 2020-02-21

• [Fixed] [Android] stopOnTerminate: false not cancelling scheduled job / Alarm when fired task fired after terminate.

[3.0.2] — 2020-02-20

• [Android] Fix Android NPE on hasTaskId when launched first time after upgrading to v3

[3.0.1] — 2020-02-20

• [iOS] It's no longer necessary to registerAppRefreshTask and registerBGProcessingTask in AppDelegate.m The SDK now reads the App .plist and automatically registers those tasks found in "Permitted background task scheduler identifiers", offering one simple setup method didFinishLaunching: Make the following change to your AppDelegate.m:

#import <TSBackgroundFetch/TSBackgroundFetch.h>

@implementation AppDelegate

(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
   .
   .
   .
   // [react-native-background-fetch Setup] -- One easy step now:
+  [[TSBackgroundFetch sharedInstance] didFinishLaunching];

-  TSBackgroundFetch *fetch = [TSBackgroundFetch sharedInstance];
-  // [REQUIRED] Register for usual periodic background refresh events here:
-  [fetch registerAppRefreshTask];

-  // [OPTIONAL] IF you've registered custom "Background Processing Task(s)" in your Info.plist above,
-  // for use with #scheduleTask method, register each of those taskId(s) here as well.
-  [fetch registerBGProcessingTask:@"com.foo.customtask"];

   return YES;
}

[3.0.0] — 2020-02-17

• [Fixed] Android - Incorrect event signature for method stop (not receiving success, failure callbacks)

• [Fixed] iOS - Missing native implementation for method scheduleTask.

• [Changed] Bumped 2.8.0 to 3.0.0 to better flag this version for breaking changes.

• [Added] [Android] New option forceAlarmManager for bypassing JobScheduler mechanism in favour of AlarmManager for more precise scheduling task execution.

• [Changed] Migrate iOS deprecated "background-fetch" API to new BGTaskScheduler. See new required steps in iOS Setup.

• [Added] Added new BackgroundFetch.scheduleTask method for scheduling custom "onehot" and periodic tasks in addition to the default fetch-task.

BackgroundFetch.configure({
  minimumFetchInterval: 15,
  stopOnTerminate: false
}, (taskId) => {  // <-- [NEW] taskId provided to Callback
  console.log("[BackgroundFetch] taskId: ", taskId);
  switch(taskId) {
    case 'foo':
      // Handle scheduleTask 'foo'
      break;
    default:
      // Handle default fetch event.
      break;
  }
  BackgroundFetch.finish(taskId);  // <-- [NEW] Provided taskId to #finish method.
});

// This event will end up in Callback provided to #configure above.
BackgroundFetch.scheduleTask({
  taskId: 'foo',  //<-- required
  delay: 60000,
  periodic: false
});

Breaking Changes

• With the introduction of ability to execute custom tasks via #scheduleTask, all tasks are executed in the Callback provided to #configure. As a result, this Callback is now provided an argument String taskId. This taskId must now be provided to the #finish method, so that the SDK knows which task is being #finished.

BackgroundFetch.configure({
  minimumFetchInterval: 15,
  stopOnTerminate: false
), (taskId) => {  // <-- [NEW] taskId provided to Callback
  console.log("[BackgroundFetch] taskId: ", taskId);
  BackgroundFetch.finish(taskId);  // <-- [NEW] Provided taskId to #finish method.
});

And with the Headless Task, as well:

let backgroundFetchHeadlessTask = async (event) => {  // <-- 1.  Headless task receives {}
  // Get taskId from event {}:
  let taskId = event.taskId;
  console.log("[BackgroundFetch] Headless event received: ", taskId);

  BackgroundFetch.finish(taskId);  // <-- 2.  #finish with taskId here as well.
}

BackgroundFetch.registerHeadlessTask(backgroundFetchHeadlessTask);

[2.7.1] — 2019-10-06

• [Fixed] Resolve StrictMode violations; typically from accessing SharedPreferences on main-thread.

[2.7.0] — 2019-08-16

• [Added] Auto-linking support for react-native >= 0.60. See the Auto-linking setup in the README for more information.

⚠️ If you have a previous version of react-native-background-fetch < 2.7.0 installed into react-native >= 0.60, you should first unlink your previous version as react-native link is no longer required.

$ react-native unlink react-native-background-fetch

[2.6.1] — 2019-07-04

• [Added] New react-native.config.js wanted by react-native > 0.60.0. https://github.com/react-native-community/cli/blob/master/docs/dependencies.md

[2.6.0] — 2019-05-30

• [Added] Added extra Android JobInfo constraints requiredNetworkType, requiresCharing, requiresBatteryNotLow, requiresStorageNotLow, requiresDeviceIdle.
• [Fixed] Merge PR transistor-background-fetch
• [Fixed] Merge PR transistor-background-fetch

[2.5.6] — 2019-05-09

• [Fixed] Monkey patch xcode npm module to ignore case in findPBXGroupKeyAndType. Some projects physical folder name might be "foo" but the XCode group-name might be "Foo".

[2.5.5] — 2019-05-09

• [Fixed] react-native link script failed for Expo apps. Failed to find projectGroup by name. Finds it by path or name now.

[2.5.4] — 2019-04-18

• [Fixed] Windows issue in new react-native link script for Android

[2.5.3] — 2019-04-15

• [Added] Added android implementation for react-native link script to automatically add the required maven url. No more extras steps required — simply: react-native link react-native-background-fetch.

[2.5.2] — 2019-04-10

• [Fixed] Fixed react-native link scripts to detect when installing into an app already configured for Cocoapods.

[2.5.1] — 2019-02-27

• [Changed] Remove unnecessary gradle directive buildToolsVersion.

[2.5.0] — 2019-02-07

• [Changed] Use updated gradle method implementation instead of deprecated compile.

[2.4.6] — 2019-01-11

• [Added] Android: Double check that app isn't in foreground before executing headless task (thanks to @macgregorT).

[2.4.5] — 2018-11-28

• [Fixed] Wrap Android HeadlessTask executor in try/catch to swallow errors if run while app is in foreground.

[2.4.4] — 2018-10-29

• [Fixed] react-native link scripts for Windows (PR #114)
• [Added] Typescript definitions.

[2.4.3] — 2018-05-23

• [Fixed] Fix link error when iOS and npm project name are diferent
• [Fixed] Clear event-listeners when #configure is called. When used with react-native-background-geolocation in "Headless Mode", this plugin could accumulate event-listeners with each reboot after terminate.
• [Added] Add convenience method BackgroundGeolocation#registerHeadlessTask, to be used instead of AppRegistry#registerHeadlessTask.

[2.4.2] — 2018-05-07

• [Added] Implement ability to provide UIBackgroundFetchResult to #finish rather than hard-coded UIBackgroundFetchResultNewData

[2.4.1] — 2018-03-18

• [Fixed] react-native link was broken for iOS due to unused aggregate target. Remove unused targets.

[2.4.0] — 2018-02-27

• [Changed] The Android library tsbackgroundfetch.aar has be composed as a Maven repository. The installation procedure has changed slightly now and flatDirs has been replaced with a maven url. See the corresponding installation docs for more information.
• [Changed] Android will check for application-wide configuration properties buildSdkVersion, buildToolsVersion, targetSdkVersion. See the Wiki "Solving Android Gradle Conflicts" for more information.

[2.3.0] — 2018-01-22

• [Added] Android implementation using JobScheduler / AlarmManager