Merge branch 'release-4.18.1'

Author: christocracy

CHANGELOG.md

@@ -1,42 +1,11 @@
 # Change Log
 
-## Unreleased
+## 4.18.1 — 2024-12-07
 * [Android] Re-factor HeadlessTask.java.  Introduce HeadlessTaskManager class.
+* [Android] remove previous requirement in `4.18.1` to call `BackgroundGeolocation.finishHeadlessTask(taskId)`.
 
 ## 4.18.0 — 2024-12-02
 * [Android] implement support for new "Bridgeless Architecture"
-* [Android] Introduce new android-only method for signalling completion of your headless-tasks registered with `BackgroundGeolocation.registerHeadlessTask(bgGeoHeadlessTask)`.  This allows RN to quickly free-up resources when your task is complete, signalling good background behaviour with the OS.
-
-```typescript
-const bgGeoHeadlessTask = async (event) => {
-  const params     = event.params; // <-- our event-data from the BG Geo SDK.
-  const eventName  = event.name;
-  const taskId     = event.taskId; // <-- [NEW] very important!
-  
-  console.log('[BGGeoHeadlessTask] ', eventName, taskId, params);
-  await doWork();
-  
-  // [NEW] Signal completion of our RN HeadlessTask !!!
-  BackgroundGeolocation.finishHeadlessTask(event.taskId);
-}
-// Example "work" function where you might perform a long-running task (such as an HTTP request).
-// Uses a simple JS setTimeout timer to simulate work.
-const doWork = async () => {
-  return new Promise(async (resolve, reject) => {
-    // Start a BGGeo backgroundTask for performing long-running task (such as HTTP request)     
-    const bgTaskId = await BackgroundGeolocation.startBackgroundTask(); 
-    console.log('*** [doWork] START');
-    setTimeout(() => {
-      console.log('*** [doWork] FINISH');
-      // Signal completion of our bg-task.
-      BackgroundGeolocation.stopBackgroundTask(bgTaskId);
-      resolve();
-    }, 5000);
-  });
-}
-
-BackgroundGeolocation.registerHeadlessTask(bgGeoHeadlessTask);
-```
 
 ## 4.17.6 &mdash; 2024-11=12
 * [Android] Remove enforcement of minimum Geofence radius `150`

android/src/main/AndroidManifest.xml

@@ -1,6 +1,3 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.transistorsoft.rnbackgroundgeolocation">
-
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">    
     <application android:label="@string/app_name"></application>
-
 </manifest>

android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTask.java

@@ -109,7 +109,8 @@ public void onHeadlessEvent(HeadlessEvent event) {
                     .build()
             );
         } catch (Exception e) {
-            TSLog.logger.warn(TSLog.warn("Failed invoke HeadlessTask " + name + ".  Task ignored." + e.getMessage()));
+            TSLog.logger.warn(TSLog.warn("Failed invoke HeadlessTask " + name + ".  Task ignored:  " + e.getMessage()));
+            e.printStackTrace();
         }
     }
 

android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/HeadlessTaskManager.java

@@ -3,7 +3,6 @@
 import android.content.Context;
 import android.os.Handler;
 import android.os.Looper;
-import android.util.Log;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -19,6 +18,7 @@
 import com.facebook.react.jstasks.HeadlessJsTaskConfig;
 import com.facebook.react.jstasks.HeadlessJsTaskContext;
 import com.facebook.react.jstasks.HeadlessJsTaskEventListener;
+import com.transistorsoft.locationmanager.logger.TSLog;
 
 import java.lang.reflect.Method;
 
@@ -119,7 +119,10 @@ public void finishTask(Context context, int taskId) throws TaskNotFoundError, Co
         if (reactContext != null) {
             Task task = findTask(taskId);
             if (task != null) {
-                HeadlessJsTaskContext.getInstance(reactContext).finishTask(task.getReactTaskId());
+                HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
+                if (headlessJsTaskContext.isTaskRunning(task.getReactTaskId())) {
+                    headlessJsTaskContext.finishTask(task.getReactTaskId());
+                }
             } else {
                 throw new TaskNotFoundError(taskId);
             }
@@ -157,7 +160,7 @@ public void onHeadlessJsTaskFinish(int taskId) {
         removeTask(task);
         task.onFinish();
 
-        Log.d(TAG, "[onHeadlessJsTaskFinish] taskId: " + taskId);
+        TSLog.logger.debug("[onHeadlessJsTaskFinish] taskId: " + taskId);
     }
 
     private ReactNativeHost getReactNativeHost(Context context) {
@@ -185,7 +188,7 @@ private ReactContext getReactContext(Context context) {
                 Method getCurrentReactContext = reactHost.getClass().getMethod("getCurrentReactContext");
                 return (ReactContext) getCurrentReactContext.invoke(reactHost);
             } catch (Exception e) {
-                Log.e(TAG, "Reflection error getCurrentReactContext: " + e.getMessage());
+                TSLog.logger.error(TSLog.error( "Reflection error getCurrentReactContext: " + e.getMessage()), e);
             }
         }
         final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
@@ -202,7 +205,7 @@ private void createReactContextAndScheduleTask(Context context) {
             return;
         }
         if (mIsInitializingReactContext.compareAndSet(false, true)) {
-            Log.d(TAG, "[createReactContextAndScheduleTask] initialize ReactContext");
+            TSLog.logger.debug( "[createReactContextAndScheduleTask] initialize ReactContext");
             final Object reactHost = getReactHost(context);
             if (isBridglessArchitectureEnabled()) { // NEW arch
                 ReactInstanceEventListener callback = new ReactInstanceEventListener() {
@@ -214,7 +217,7 @@ public void onReactContextInitialized(@NonNull ReactContext reactContext) {
                             Method removeReactInstanceEventListener = reactHost.getClass().getMethod("removeReactInstanceEventListener", ReactInstanceEventListener.class);
                             removeReactInstanceEventListener.invoke(reactHost, this);
                         } catch (Exception e) {
-                            Log.e(TAG, "HeadlessTask reflection error removeReactInstanceEventListener: " + e);
+                            TSLog.logger.error(TSLog.error("HeadlessTask reflection error removeReactInstanceEventListener: ") + e);
                         }
                     }
                 };
@@ -224,7 +227,7 @@ public void onReactContextInitialized(@NonNull ReactContext reactContext) {
                     Method startReactHost = reactHost.getClass().getMethod("start");
                     startReactHost.invoke(reactHost);
                 } catch (Exception e) {
-                    Log.e(TAG, "HeadlessTask reflection error ReactHost start: " + e.getMessage());
+                    TSLog.logger.error(TSLog.error("HeadlessTask reflection error ReactHost start: " + e.getMessage()), e);
                 }
             } else { // OLD arch
                 final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
@@ -349,9 +352,11 @@ synchronized static int getNextTaskId() {
             mOnErrorCallback = builder.onErrorCallback;
             mTimeout = builder.timeout;
             mParams = builder.params;
-            mParams.putInt("taskId", mId);
+            // append our custom headless taskId.
+            mParams.putInt("_transistorHeadlessTaskId", mId);
         }
 
+
         boolean invoke(ReactContext reactContext) throws IllegalStateException {
             HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
             // Provide the RN taskId to our private TaskConfig instance, mapping the RN taskId to our TaskConfig's internal taskId.

android/src/main/java/com/transistorsoft/rnbackgroundgeolocation/RNBackgroundGeolocationModule.java

@@ -825,6 +825,12 @@ public void finish(int taskId, Callback success, Callback failure) {
         success.invoke(taskId);
     }
 
+    /**
+     * Called by user's registered HeadlessTask when they call BackgroundGeolocation.finishHeadlessTask(event.taskId)
+     * @param taskId
+     * @param success
+     * @param failure
+     */
     @ReactMethod
     public void finishHeadlessTask(int taskId, Callback success, Callback failure) {
         EventBus eventBus = EventBus.getDefault();