expo-background-task 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -10,8 +10,22 @@
 
 ### 💡 Others
 
-## 0.1.0 — 2025-01-27
+## 0.1.2 — 2025-02-14
 
-### 🎉 New features
+_This version does not introduce any user-facing changes._
+
+## 0.1.1 — 2025-01-31
+
+### 💡 Others
+
+- [Android] Started using expo modules gradle plugin. ([#34431](https://github.com/expo/expo/pull/34431) by [@chrfalch](https://github.com/chrfalch))
+
+## 0.0.1 — 2025-01-21
+
+### 💡 Others
+
+- Update README description
+
+## 0.0.0 — 2025-01-21
 
-- Added expo-background-task package ([#33438](https://github.com/expo/expo/pull/33438) by [@chrfalch](https://github.com/chrfalch))
+> > > > > > > 1362a71283d ([background-task][gradle] - start use new expo modules gradle plugin (#34431))### 🎉 New features- Added expo-background-task package ([#33438](https://github.com/expo/expo/pull/33438) by [@chrfalch](https://github.com/chrfalch))

package/android/build.gradle

@@ -1,14 +1,26 @@
 apply plugin: 'com.android.library'
 
-group = 'host.exp.exponent'
-version = '0.1.0'
+def useLegacyExpoModulesCorePlugin = {
+  def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
+  apply from: expoModulesCorePlugin
+  applyKotlinExpoModulesCorePlugin()
+  useCoreDependencies()
+  useDefaultAndroidSdkVersions()
+  useExpoPublishing()
+}
+
+try {
+  apply plugin: 'expo-module-gradle-plugin'
+} catch (e) {
+  if (!e instanceof UnknownPluginException) {
+    throw e
+  }
 
-def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
-apply from: expoModulesCorePlugin
-applyKotlinExpoModulesCorePlugin()
-useCoreDependencies()
-useDefaultAndroidSdkVersions()
-useExpoPublishing()
+  useLegacyExpoModulesCorePlugin()
+}
+
+group = 'host.exp.exponent'
+version = '0.1.2'
 
 dependencies {
   implementation 'androidx.work:work-runtime-ktx:2.9.1'
@@ -19,6 +31,6 @@ android {
   namespace "expo.modules.backgroundtask"
   defaultConfig {
     versionCode 23
-    versionName "0.1.0"
+    versionName "0.1.2"
   }
 }

package/android/src/main/java/expo/modules/backgroundtask/BackgroundTaskModule.kt

@@ -50,7 +50,7 @@ class BackgroundTaskModule : Module() {
       appContext.reactContext?.let {
         runBlocking {
           val appScopeKey = it.packageName
-          BackgroundTaskScheduler.startWorker(it, appScopeKey)
+          BackgroundTaskScheduler.scheduleWorker(it, appScopeKey)
         }
       } ?: throw MissingContextException()
     }

package/android/src/main/java/expo/modules/backgroundtask/BackgroundTaskScheduler.kt

@@ -6,7 +6,9 @@ import android.util.Log
 import androidx.work.Constraints
 import androidx.work.Data
 import androidx.work.ExistingPeriodicWorkPolicy
+import androidx.work.ExistingWorkPolicy
 import androidx.work.NetworkType
+import androidx.work.OneTimeWorkRequestBuilder
 import androidx.work.Operation
 import androidx.work.PeriodicWorkRequestBuilder
 import androidx.work.WorkInfo
@@ -55,14 +57,16 @@ object BackgroundTaskScheduler {
   /**
    * Schedules the worker task to run. The worker should run periodically.
    */
-  suspend fun startWorker(context: Context, appScopeKey: String): Boolean {
+  suspend fun scheduleWorker(context: Context, appScopeKey: String, cancelExisting: Boolean = true): Boolean {
     if (numberOfRegisteredTasksOfThisType == 0) {
       Log.d(TAG, "Will not enqueue worker. No registered tasks to run.")
       return false
     }
 
     // Stop the current worker (if any)
-    stopWorker(context)
+    if (cancelExisting) {
+      stopWorker(context)
+    }
 
     Log.d(TAG, "Enqueuing worker with identifier $WORKER_IDENTIFIER")
 
@@ -75,37 +79,65 @@ object BackgroundTaskScheduler {
       .setRequiredNetworkType(NetworkType.CONNECTED)
       .build()
 
-    // Create the work request
-    val builder = PeriodicWorkRequestBuilder<BackgroundTaskWork>(
-      repeatIntervalTimeUnit = TimeUnit.MINUTES,
-      repeatInterval = intervalMinutes
-    )
-      .setInputData(data)
-      .setConstraints(constraints)
+    // Get Work manager
+    val workManager = WorkManager.getInstance(context)
 
+    // We have two different paths here, since on Android 14-15 we need to use a periodic request
+    // builder since the OneTimeWorkRequest doesn't support setting initial delay (which is how we
+    // control executing a task periodically - we spawn a One-time work request when backgrounding,
+    // and when this is done we spawn a new one. This makes it a lot easier to debug since we can
+    // use adb to spawn jobs whenever we want)
+    // The following is the path we have to follow on  Android.O and later:
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+      // Create the work request
+      val builder = OneTimeWorkRequestBuilder<BackgroundTaskWork>()
+        .setInputData(data)
+        .setConstraints(constraints)
+
       // Add minimum interval here as well so that the work doesn't start immediately
       builder.setInitialDelay(Duration.ofMinutes(intervalMinutes))
-    }
-
-    // Create work request
-    val workRequest = builder.build()
 
-    // Get Work manager
-    val workManager = WorkManager.getInstance(context)
-
-    // Enqueue the work
-    return try {
-      workManager.enqueueUniquePeriodicWork(
-        WORKER_IDENTIFIER,
-        ExistingPeriodicWorkPolicy.CANCEL_AND_REENQUEUE,
-        workRequest
-      ).await()
-
-      true
-    } catch (e: Exception) {
-      Log.e(TAG, "Worker failed to start with error " + e.message)
-      false
+      // Create work request
+      val workRequest = builder.build()
+
+      // Enqueue the work
+      return try {
+        workManager.enqueueUniqueWork(
+          WORKER_IDENTIFIER,
+          // This is where we decide if we should cancel or replace the task - cancelling is done
+          // when spawning the first task, while appending is when we spawn from a running task
+          // to set up the next periodic run of the task
+          if (cancelExisting) ExistingWorkPolicy.REPLACE else ExistingWorkPolicy.APPEND,
+          workRequest
+        ).await()
+
+        true
+      } catch (e: Exception) {
+        Log.e(TAG, "Worker failed to start with error " + e.message)
+        false
+      }
+    } else {
+      val builder = PeriodicWorkRequestBuilder<BackgroundTaskWork>(
+        repeatIntervalTimeUnit = TimeUnit.MINUTES,
+        repeatInterval = intervalMinutes
+      )
+
+      // Create work request
+      val workRequest = builder.build()
+
+      // Enqueue the work
+      return try {
+        workManager.enqueueUniquePeriodicWork(
+          WORKER_IDENTIFIER,
+          ExistingPeriodicWorkPolicy.CANCEL_AND_REENQUEUE,
+          workRequest
+        ).await()
+
+        true
+      } catch (e: Exception) {
+        Log.e(TAG, "Worker failed to start with error " + e.message)
+        false
+      }
     }
   }
 
@@ -152,7 +184,7 @@ object BackgroundTaskScheduler {
     val consumers = taskService.getTaskConsumers(appScopeKey)
     Log.d(TAG, "runTasks: number of consumers ${consumers.size}")
 
-    if (consumers.size == 0) {
+    if (consumers.isEmpty()) {
       return false
     }
 

package/android/src/main/java/expo/modules/backgroundtask/BackgroundTaskWork.kt

@@ -1,6 +1,7 @@
 package expo.modules.backgroundtask
 
 import android.content.Context
+import android.os.Build
 import android.util.Log
 import androidx.work.CoroutineWorker
 import androidx.work.Data
@@ -21,7 +22,15 @@ class BackgroundTaskWork(context: Context, params: WorkerParameters) : Coroutine
     val appScopeKey = inputData.getString("appScopeKey") ?: throw MissingAppScopeKey()
 
     try {
+      // Run tasks async using the task service. This call will return when the task has finished
+      // ie. When JS task executor has notified the task manager that it is done.
       BackgroundTaskScheduler.runTasks(applicationContext, appScopeKey)
+      // If we are on a newer Android version we're using a One time request and need to spawn new
+      // requests for each run (and also ask to not try to cancel the work, since we're already
+      // finishing the work item when this function returns.
+      if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+        BackgroundTaskScheduler.scheduleWorker(applicationContext, appScopeKey, false)
+      }
     } catch (e: Exception) {
       // Wrap exception in Data:
       val outputData = Data.Builder()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expo-background-task",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Expo universal module for BackgroundTask API",
   "main": "build/BackgroundTask.js",
   "types": "build/BackgroundTask.d.ts",
@@ -35,10 +35,10 @@
     "expo-task-manager": "~12.0.5"
   },
   "devDependencies": {
-    "expo-module-scripts": "^4.0.0"
+    "expo-module-scripts": "^4.0.4"
   },
   "peerDependencies": {
     "expo": "*"
   },
-  "gitHead": "3fd37fd31fd818d833e85c4723b1578010da6967"
+  "gitHead": "7080126694798ca950d5dc3ef33483a17fa401bb"
 }