react-native-background-geolocation 4.18.0 → 4.18.2

package/android/src/main/AndroidManifest.xml

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

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

@@ -1,27 +1,10 @@
 package com.transistorsoft.rnbackgroundgeolocation;
 
-import android.content.Context;
-import android.os.Handler;
-import android.os.Looper;
-
-import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
-import com.facebook.infer.annotation.Assertions;
-import com.facebook.react.ReactApplication;
-import com.facebook.react.ReactInstanceEventListener;
-import com.facebook.react.ReactInstanceManager;
-import com.facebook.react.ReactNativeHost;
-import com.facebook.react.bridge.ReactContext;
-import com.facebook.react.bridge.UiThreadUtil;
 import com.facebook.react.bridge.WritableMap;
 import com.facebook.react.bridge.WritableNativeMap;
-import com.facebook.react.jstasks.HeadlessJsTaskConfig;
-import com.facebook.react.jstasks.HeadlessJsTaskContext;
 
 import org.greenrobot.eventbus.Subscribe;
 
-import com.facebook.react.jstasks.HeadlessJsTaskEventListener;
 import com.transistorsoft.locationmanager.adapter.BackgroundGeolocation;
 import com.transistorsoft.locationmanager.event.FinishHeadlessTaskEvent;
 import com.transistorsoft.locationmanager.event.HeadlessEvent;
@@ -31,65 +14,18 @@ import org.greenrobot.eventbus.ThreadMode;
 import org.json.JSONException;
 import org.json.JSONObject;
 
-import java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.concurrent.atomic.AtomicInteger;
-
 /**
  * The BackgroundGeolocation SDK creates a single instance of this class (via reflection upon Config.headlessJobService)
  * The SDK delivers events to this instance by dropping them onto EventBus (see @Subscribe).  Because this instance is subscribed
  * into EventBus, it's protected from GC.
  *
- * Because there's only one instance of this class, we have to be mindful that we can possibly receive events rapidly,
- * so we store them in a Queue (#mTaskQueue).
- *
- * We also have to be mindful that it's a heavy operation to do the initial launch the ReactNative Host, so several events
- * might build up in the queue before the Host is finally launched, when we drain the queue (see #drainTaskQueue).
- *
- * For finally sending events to the client, we wrap the RN HeadlessJsTaskConfig with our own TaskConfig class.  This class
- * adds our own auto-incremented "taskId" field to maintain a mapping between our taskId and RN's.  See #invokeStartTask.
- * This class appends our custom taskId into the the event params sent to Javascript, for the following purpose:
- *
- * ```javascript
- * const BackgroundGeolocationHeadlessTask = async (event) => {
- *   console.log('[HeadlessTask] taskId: ', event.taskId);  // <-- here's our custom taskId.
- *
- *   await doWork();  // <-- perform some arbitrarily long process (eg: http request).
- *
- *   BackgroundGeolocation.finishHeadlessTask(event.taskId);  // <-- $$$ Here's the money $$$
- * }
- * ```
- *
- * See "Here's the $money" above: We want to signal back to this native HeadlessTask instance , that our JS task is now complete.
- * This is a pretty easy task to do via EventBus -- Just create a new instance of FinishHeadlessTaskEvent(params.taskId);
- *
- * The code then looks up a TaskConfig from mEventQueue using the given event.taskId.
- *
- * All this extra fussing with taking care to finish our RN HeadlessTasks seems to be more important with RN's "new architecture", where before,
- * RN seemed to automatically complete its tasks seemingly when the Javascript function stopped executing.  This is why it was always so
- * important to await one's Promises and do all the work before the the last line of the function executed.
- *
- * Now, the Javascript must explicitly call back to the native side to say "I'M DONE" -- BackgroundGeolocation.finishHeadlessTask(taskId)
- *
  * Created by chris on 2018-01-23.
  */
 
 public class HeadlessTask {
-    private static String HEADLESS_TASK_NAME = "BackgroundGeolocation";
+    private static final String HEADLESS_TASK_NAME = "BackgroundGeolocation";
     // Hard-coded time-limit for headless-tasks is 60000 @todo configurable?
-    private static final int TASK_TIMEOUT = 60000;
-    private static final AtomicInteger sLastTaskId = new AtomicInteger(0);
-
-    synchronized static int getNextTaskId() {
-        return sLastTaskId.incrementAndGet();
-    }
-
-    private final List<TaskConfig> mTaskQueue = new ArrayList<>();
-    private final AtomicBoolean mIsReactContextInitialized = new AtomicBoolean(false);
-    private final AtomicBoolean mIsInitializingReactContext = new AtomicBoolean(false);
-    private final AtomicBoolean mIsHeadlessJsTaskListenerRegistered = new AtomicBoolean(false);
+    private static final int TASK_TIMEOUT = 60000 * 2;
 
     /**
      * EventBus receiver for a HeadlessTask HeadlessEvent
@@ -153,14 +89,28 @@ public class HeadlessTask {
                 clientEvent.putNull("params");
                 clientEvent.putString("error", e.getMessage());
                 TSLog.logger.error(TSLog.error(e.getMessage()), e);
-                e.printStackTrace();
             }
         }
 
         try {
-            startTask(event.getContext(), new TaskConfig(clientEvent));
-        } catch (AssertionError e) {
-            TSLog.logger.warn(TSLog.warn("Failed invoke HeadlessTask " + name + ".  Task ignored." + e.getMessage()));
+            HeadlessTaskManager.getInstance().startTask(event.getContext(), new HeadlessTaskManager.Task.Builder()
+                    .setName(HEADLESS_TASK_NAME)
+                    .setParams(clientEvent)
+                    .setTimeout(TASK_TIMEOUT)
+                    .setOnInvokeCallback((reactContext, task) -> {
+                        //TSLog.logger.debug("*** onInvoke: " + task.getId());
+                    })
+                    .setOnFinishCallback(taskId -> {
+                        //TSLog.logger.debug("*** onFinish: " + taskId);
+                    })
+                    .setOnErrorCallback((task, e) -> {
+                        TSLog.logger.warn("⚠\uFE0F  HeadlessTaskError: " + e.getMessage() + ": " + task.toString());
+                    })
+                    .build()
+            );
+        } catch (Exception e) {
+            TSLog.logger.warn(TSLog.warn("Failed invoke HeadlessTask " + name + ".  Task ignored:  " + e.getMessage()));
+            e.printStackTrace();
         }
     }
 
@@ -171,239 +121,10 @@ public class HeadlessTask {
      */
     @Subscribe(threadMode = ThreadMode.MAIN)
     public void onFinishHeadlessTask(FinishHeadlessTaskEvent event) {
-        if (!mIsReactContextInitialized.get()) {
-            TSLog.logger.warn(TSLog.warn("BackgroundGeolocation.finishHeadlessTask:" + event.getTaskId() + " found no ReactContext"));
-            return;
-        }
-        ReactContext reactContext = getReactContext(event.getContext());
-        if (reactContext != null) {
-            int taskId = event.getTaskId();
-
-            synchronized (mTaskQueue) {
-                // Locate the TaskConfig instance by our local taskId.
-                TaskConfig taskConfig = null;
-                for (TaskConfig config : mTaskQueue) {
-                    if (config.getTaskId() == taskId) {
-                        taskConfig = config;
-                        break;
-                    }
-                }
-                if (taskConfig != null) {
-                    HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
-                    // Tell RN we're done using the mapped getReactTaskId().
-                    headlessJsTaskContext.finishTask(taskConfig.getReactTaskId());
-                } else {
-                    TSLog.logger.warn(TSLog.warn("Failed to find task: " + taskId));
-                }
-            }
-        } else {
-            TSLog.logger.warn(TSLog.warn("Failed to finishHeadlessTask: " + event.getTaskId() + " -- HeadlessTask onFinishHeadlessTask failed to find a ReactContext.  This is unexpected"));
-        }
-    }
-
-    /**
-     * Start a task. This method handles starting a new React instance if required.
-     *
-     * Has to be called on the UI thread.
-     *
-     * @param taskConfig describes what task to start and the parameters to pass to it
-     */
-    private void startTask(Context context, final TaskConfig taskConfig) throws AssertionError {
-        UiThreadUtil.assertOnUiThread();
-
-        // push this HeadlessEvent onto the taskQueue, to be drained once the React context is finished initializing,
-        // or executed immediately if Context exists currently.
-        synchronized (mTaskQueue) {
-            mTaskQueue.add(taskConfig);
-        }
-
-        if (!mIsReactContextInitialized.get()) {
-            createReactContextAndScheduleTask(context);
-        } else {
-            invokeStartTask(getReactContext(context), taskConfig);
-        }
-    }
-
-    synchronized private void invokeStartTask(ReactContext reactContext, final TaskConfig taskConfig) {
-        final HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
         try {
-            if (mIsHeadlessJsTaskListenerRegistered.compareAndSet(false, true)) {
-                // Register the RN HeadlessJSTaskEventListener just once.
-                // This inline-listener is handy here as a closure around the HeadlessJsTaskContext.
-                // Otherwise, we'd have to store this Context to an instance var.
-                // The only purpose of this listener is to clear events from the queue.  The RN task is assumed to have had its .stopTask(taskId) method called, which is why this event has fired.
-                // WARNING:  this listener seems to receive events from ANY OTHER plugin's Headless events.
-                // TODO we might use a LifeCycle event-listener here to remove the listener when the app is launched to foreground.
-                headlessJsTaskContext.addTaskEventListener(new HeadlessJsTaskEventListener() {
-                    @Override public void onHeadlessJsTaskStart(int taskId) {}
-                    @Override public void onHeadlessJsTaskFinish(int taskId) {
-                        synchronized (mTaskQueue) {
-                            if (mTaskQueue.isEmpty()) {
-                                // Nothing in queue?  This events cannot be for us.
-                                return;
-                            }
-                            // Query our queue for this event...
-                            TaskConfig taskConfig = null;
-                            for (TaskConfig config : mTaskQueue) {
-                                if (config.getReactTaskId() == taskId) {
-                                    taskConfig = config;
-                                    break;
-                                }
-                            }
-                            if (taskConfig != null) {
-                                // Clear it from the Queue.
-                                TSLog.logger.debug("taskId: " + taskConfig.getTaskId());
-                                mTaskQueue.remove(taskConfig);
-                            } else {
-                                TSLog.logger.warn(TSLog.warn("Failed to find taskId: " + taskId));
-                            }
-                        }
-                    }
-                });
-            }
-            // Finally:  the actual launch of the RN headless-task!
-            int taskId = headlessJsTaskContext.startTask(taskConfig.getTaskConfig());
-            // Provide the RN taskId to our private TaskConfig instance, mapping the RN taskId to our TaskConfig's internal taskId.
-            taskConfig.setReactTaskId(taskId);
-            TSLog.logger.debug("taskId: " + taskId);
-        } catch (IllegalStateException e) {
-            TSLog.logger.error(TSLog.error(e.getMessage()), e);
-        }
-    }
-
-    protected ReactNativeHost getReactNativeHost(Context context) {
-        return ((ReactApplication) context.getApplicationContext()).getReactNativeHost();
-    }
-
-    /**
-     * Get the {ReactHost} used by this app. ure and returns null if not.
-     */
-    private @Nullable Object getReactHost(Context context) {
-        context = context.getApplicationContext();
-        try {
-            Method getReactHost = context.getClass().getMethod("getReactHost");
-            return getReactHost.invoke(context);
-        } catch (Exception e) {
-            return null;
-        }
-    }
-
-    private ReactContext getReactContext(Context context) {
-        if (isBridglessArchitectureEnabled()) {
-            Object reactHost = getReactHost(context);
-            Assertions.assertNotNull(reactHost, "getReactHost() is null in New Architecture");
-            try {
-                Method getCurrentReactContext = reactHost.getClass().getMethod("getCurrentReactContext");
-                return (ReactContext) getCurrentReactContext.invoke(reactHost);
-            } catch (Exception e) {
-                TSLog.logger.error(TSLog.error("[HeadlessTask] Reflection error getCurrentReactContext: " + e.getMessage()), e);
-            }
-        }
-        final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
-        return reactInstanceManager.getCurrentReactContext();
-    }
-
-    private void createReactContextAndScheduleTask(Context context) {
-
-        // ReactContext could have already been initialized by another plugin (eg: background-fetch).
-        // If we get a non-null ReactContext here, we're good to go!
-        ReactContext reactContext = getReactContext(context);
-        if (reactContext != null && !mIsInitializingReactContext.get()) {
-            mIsReactContextInitialized.set(true);
-            drainTaskQueue(reactContext);
-            return;
-        }
-        if (mIsInitializingReactContext.compareAndSet(false, true)) {
-            TSLog.logger.debug("initialize ReactContext");
-            final Object reactHost = getReactHost(context);
-            if (isBridglessArchitectureEnabled()) { // NEW arch
-                ReactInstanceEventListener callback = new ReactInstanceEventListener() {
-                    @Override
-                    public void onReactContextInitialized(@NonNull ReactContext reactContext) {
-                        mIsReactContextInitialized.set(true);
-                        drainTaskQueue(reactContext);
-                        try {
-                            Method removeReactInstanceEventListener = reactHost.getClass().getMethod("removeReactInstanceEventListener", ReactInstanceEventListener.class);
-                            removeReactInstanceEventListener.invoke(reactHost, this);
-                        } catch (Exception e) {
-                            TSLog.logger.error(TSLog.error("HeadlessTask reflection error A: " + e), e);
-                        }
-                    }
-                };
-                try {
-                    Method addReactInstanceEventListener = reactHost.getClass().getMethod("addReactInstanceEventListener", ReactInstanceEventListener.class);
-                    addReactInstanceEventListener.invoke(reactHost, callback);
-                    Method startReactHost = reactHost.getClass().getMethod("start");
-                    startReactHost.invoke(reactHost);
-                } catch (Exception e) {
-                    TSLog.logger.error(TSLog.error("HeadlessTask reflection error ReactHost start: " + e.getMessage()), e);
-                }
-            } else { // OLD arch
-                final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
-                reactInstanceManager.addReactInstanceEventListener(new ReactInstanceEventListener() {
-                    @Override
-                    public void onReactContextInitialized(@NonNull ReactContext reactContext) {
-                        mIsReactContextInitialized.set(true);
-                        drainTaskQueue(reactContext);
-                        reactInstanceManager.removeReactInstanceEventListener(this);
-                    }
-                });
-                reactInstanceManager.createReactContextInBackground();
-            }
-        }
-    }
-
-    /**
-     * Invokes HeadlessEvents queued while waiting for the ReactContext to initialize.
-     * @param reactContext
-     */
-    private void drainTaskQueue(final ReactContext reactContext) {
-        new Handler(Looper.getMainLooper()).postDelayed(() -> {
-            synchronized (mTaskQueue) {
-                for (TaskConfig taskConfig : mTaskQueue) {
-                    invokeStartTask(reactContext, taskConfig);
-                }
-            }
-        }, 500);
-    }
-
-    /**
-     * Return true if this app is running with RN's bridgeless architecture.
-     * Cheers to @mikehardy for this idea.
-     * @return
-     */
-    private boolean isBridglessArchitectureEnabled() {
-        try {
-            Class<?> entryPoint = Class.forName("com.facebook.react.defaults.DefaultNewArchitectureEntryPoint");
-            Method bridgelessEnabled = entryPoint.getMethod("getBridgelessEnabled");
-            Object result = bridgelessEnabled.invoke(null);
-            return (result == Boolean.TRUE);
+            HeadlessTaskManager.getInstance().finishTask(event.getContext(), event.getTaskId());
         } catch (Exception e) {
-            return false;
-        }
-    }
-
-    /**
-     * Wrapper for a client event.  Inserts our custom taskId into the RN ClientEvent params.
-     */
-    private static class TaskConfig {
-        private final int mTaskId;
-        private int mReactTaskId;
-        private final WritableMap mParams;
-        public TaskConfig(WritableMap params) {
-            mTaskId = getNextTaskId();
-            // Insert our custom taskId for users to call BackgroundGeolocation.finishHeadlessTask(taskId) with.
-            params.putInt("taskId", mTaskId);
-            mParams = params;
-        }
-        public void setReactTaskId(int taskId) {
-            mReactTaskId = taskId;
-        }
-        public int getTaskId() { return mTaskId; }
-        public int getReactTaskId() { return mReactTaskId; }
-
-        public HeadlessJsTaskConfig getTaskConfig() {
-            return new HeadlessJsTaskConfig(HEADLESS_TASK_NAME, mParams, TASK_TIMEOUT);
+            TSLog.logger.warn(TSLog.warn(e.getMessage()));
         }
     }
 }

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

@@ -0,0 +1,460 @@
+package com.transistorsoft.rnbackgroundgeolocation;
+
+import android.content.Context;
+import android.os.Handler;
+import android.os.Looper;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import com.facebook.infer.annotation.Assertions;
+import com.facebook.react.ReactApplication;
+import com.facebook.react.ReactInstanceEventListener;
+import com.facebook.react.ReactInstanceManager;
+import com.facebook.react.ReactNativeHost;
+import com.facebook.react.bridge.ReactContext;
+import com.facebook.react.bridge.UiThreadUtil;
+import com.facebook.react.bridge.WritableMap;
+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;
+
+import java.util.Set;
+import java.util.concurrent.CopyOnWriteArraySet;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.concurrent.atomic.AtomicInteger;
+
+/**
+ * This is a general singleton for managing invoking RN headless-tasks.  This class could be copied and implemented in any plugin.
+ *
+ * RN headless-tasks have no mechanism for the Javascript to signal completion of their tasks:  you can either configure a timeout for
+ * your tasks (letting each task timeout) or provide no timeout at all, which will cause a memory leak in RN's HeadlessJsContext.java
+ * https://github.com/facebook/react-native/blob/bc0b5ca5df5d2cf12c791b0332ef2fb4e29d6d2d/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/jstasks/HeadlessJsTaskContext.java#L53-L55
+ *
+ * Without providing a timeout for your headless-tasks, those collections in HeadlessJsContext will continue grow and never be cleared.
+ *
+ * Because there's only one instance of this class, we have to be mindful that we can possibly receive events rapidly,
+ * so we store them in a Queue (#mTaskQueue).
+ *
+ * We also have to be mindful that it's a heavy operation to do the initial launch the ReactNative Host, so several events
+ * might build up in the queue before the Host is finally launched, when we drain the queue (see #drainTaskQueue).
+ *
+ * For finally sending events to the client, we wrap the RN HeadlessJsTaskConfig with our own TaskConfig class.  This class
+ * adds our own auto-incremented "taskId" field to maintain a mapping between our taskId and RN's.  See #invokeStartTask.
+ * This class appends our custom taskId into the the event params sent to Javascript, for the following purpose:
+ *
+ * ```javascript
+ * const BackgroundGeolocationHeadlessTask = async (event) => {
+ *   console.log('[HeadlessTask] taskId: ', event.taskId);  // <-- here's our custom taskId.
+ *
+ *   await doWork();  // <-- perform some arbitrarily long process (eg: http request).
+ *
+ *   BackgroundGeolocation.finishHeadlessTask(event.taskId);  // <-- $$$ Here's the money $$$
+ * }
+ * ```
+ *
+ * See "Here's the $money" above: We want to signal back to this native HeadlessTask instance , that our JS task is now complete.
+ * This is a pretty easy task to do via EventBus -- Just create a new instance of FinishHeadlessTaskEvent(params.taskId);
+ *
+ * The code then looks up a TaskConfig from mEventQueue using the given event.taskId.
+ *
+ * All this extra fussing with taking care to finish our RN HeadlessTasks seems to be more important with RN's "new architecture", where before,
+ * RN seemed to automatically complete its tasks seemingly when the Javascript function stopped executing.  This is why it was always so
+ * important to await one's Promises and do all the work before the the last line of the function executed.
+ *
+ * Now, the Javascript must explicitly call back to the native side to say "I'M DONE" -- BackgroundGeolocation.finishHeadlessTask(taskId)
+ */
+public class HeadlessTaskManager implements HeadlessJsTaskEventListener {
+    private static final String TAG = "TSLocationManager";
+
+    private static HeadlessTaskManager sInstance;
+    public static HeadlessTaskManager getInstance() {
+        if (sInstance == null) {
+            sInstance = getInstanceSynchronized();
+        }
+        return sInstance;
+    }
+
+    private static synchronized HeadlessTaskManager getInstanceSynchronized() {
+        if (sInstance == null) sInstance = new HeadlessTaskManager();
+        return sInstance;
+    }
+
+    private final Set<Task> mTaskQueue = new CopyOnWriteArraySet<>();
+    private final AtomicBoolean mIsReactContextInitialized = new AtomicBoolean(false);
+    private final AtomicBoolean mIsInitializingReactContext = new AtomicBoolean(false);
+    private final AtomicBoolean mIsHeadlessJsTaskListenerRegistered = new AtomicBoolean(false);
+
+    /**
+     * Start a task. This method handles starting a new React instance if required.
+     *
+     * Has to be called on the UI thread.
+     *
+     * @param context Application Context
+     * @param task The Task instance
+     */
+    public void startTask(Context context, Task task) throws AssertionError {
+        UiThreadUtil.assertOnUiThread();
+
+        addTask(task);
+
+        if (!mIsReactContextInitialized.get()) {
+            createReactContextAndScheduleTask(context);
+        } else {
+            boolean success = invokeStartTask(getReactContext(context), task);
+            if (!success) {
+                removeTask(task);
+            }
+        }
+    }
+
+    public void finishTask(Context context, int taskId) throws TaskNotFoundError, ContextError {
+        if (!mIsReactContextInitialized.get()) {
+            throw new ContextError(getClass().getName() + ".finishTask:  ReactContext not initialized");
+        }
+        ReactContext reactContext = getReactContext(context.getApplicationContext());
+        if (reactContext != null) {
+            Task task = findTask(taskId);
+            if (task != null) {
+                HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
+                if (headlessJsTaskContext.isTaskRunning(task.getReactTaskId())) {
+                    headlessJsTaskContext.finishTask(task.getReactTaskId());
+                }
+            } else {
+                throw new TaskNotFoundError(taskId);
+            }
+        } else {
+            throw new ContextError(getClass().getName() + ".finishTask ReactContext is null");
+        }
+    }
+
+    private boolean invokeStartTask(ReactContext reactContext, final Task task) {
+        final HeadlessJsTaskContext headlessJsTaskContext = HeadlessJsTaskContext.getInstance(reactContext);
+        if (mIsHeadlessJsTaskListenerRegistered.compareAndSet(false, true)) {
+            // Register the RN HeadlessJSTaskEventListener just once.
+            // TODO we might use a LifeCycle event-listener here to remove the listener when the app is launched to foreground.
+            headlessJsTaskContext.addTaskEventListener(this);
+        }
+        try {
+            return task.invoke(reactContext);
+        } catch (Exception e) {
+            task.onError(e);
+            return false;
+        }
+    }
+
+    @Override
+    public void onHeadlessJsTaskStart(int taskId) {}
+
+    // The only purpose of this listener is to clear events from the queue.  The RN task is assumed to have had its .stopTask(taskId) method called, which is why this event has fired.
+    // WARNING:  this listener seems to receive events from ANY OTHER plugin's Headless events.
+    @Override
+    public void onHeadlessJsTaskFinish(int taskId) {
+        Task task = findTaskByReactId(taskId);
+        if (task == null) {
+            return;
+        }
+        removeTask(task);
+        task.onFinish();
+
+        TSLog.logger.debug("[onHeadlessJsTaskFinish] taskId: " + taskId);
+    }
+
+    private ReactNativeHost getReactNativeHost(Context context) {
+        return ((ReactApplication) context.getApplicationContext()).getReactNativeHost();
+    }
+
+    /**
+     * Get the {ReactHost} used by this app. ure and returns null if not.
+     */
+    private @Nullable Object getReactHost(Context context) {
+        context = context.getApplicationContext();
+        try {
+            Method getReactHost = context.getClass().getMethod("getReactHost");
+            return getReactHost.invoke(context);
+        } catch (Exception e) {
+            return null;
+        }
+    }
+
+    private ReactContext getReactContext(Context context) {
+        if (isBridglessArchitectureEnabled()) {
+            Object reactHost = getReactHost(context);
+            Assertions.assertNotNull(reactHost, "getReactHost() is null in New Architecture");
+            try {
+                Method getCurrentReactContext = reactHost.getClass().getMethod("getCurrentReactContext");
+                return (ReactContext) getCurrentReactContext.invoke(reactHost);
+            } catch (Exception e) {
+                TSLog.logger.error(TSLog.error( "Reflection error getCurrentReactContext: " + e.getMessage()), e);
+            }
+        }
+        final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
+        return reactInstanceManager.getCurrentReactContext();
+    }
+
+    private void createReactContextAndScheduleTask(Context context) {
+        // ReactContext could have already been initialized by another plugin (eg: background-fetch).
+        // If we get a non-null ReactContext here, we're good to go!
+        ReactContext reactContext = getReactContext(context);
+        if (reactContext != null && !mIsInitializingReactContext.get()) {
+            mIsReactContextInitialized.set(true);
+            drainTaskQueue(reactContext);
+            return;
+        }
+        if (mIsInitializingReactContext.compareAndSet(false, true)) {
+            TSLog.logger.debug( "[createReactContextAndScheduleTask] initialize ReactContext");
+            final Object reactHost = getReactHost(context);
+            if (isBridglessArchitectureEnabled()) { // NEW arch
+                ReactInstanceEventListener callback = new ReactInstanceEventListener() {
+                    @Override
+                    public void onReactContextInitialized(@NonNull ReactContext reactContext) {
+                        mIsReactContextInitialized.set(true);
+                        drainTaskQueue(reactContext);
+                        try {
+                            Method removeReactInstanceEventListener = reactHost.getClass().getMethod("removeReactInstanceEventListener", ReactInstanceEventListener.class);
+                            removeReactInstanceEventListener.invoke(reactHost, this);
+                        } catch (Exception e) {
+                            TSLog.logger.error(TSLog.error("HeadlessTask reflection error removeReactInstanceEventListener: ") + e);
+                        }
+                    }
+                };
+                try {
+                    Method addReactInstanceEventListener = reactHost.getClass().getMethod("addReactInstanceEventListener", ReactInstanceEventListener.class);
+                    addReactInstanceEventListener.invoke(reactHost, callback);
+                    Method startReactHost = reactHost.getClass().getMethod("start");
+                    startReactHost.invoke(reactHost);
+                } catch (Exception e) {
+                    TSLog.logger.error(TSLog.error("HeadlessTask reflection error ReactHost start: " + e.getMessage()), e);
+                }
+            } else { // OLD arch
+                final ReactInstanceManager reactInstanceManager = getReactNativeHost(context).getReactInstanceManager();
+                reactInstanceManager.addReactInstanceEventListener(new ReactInstanceEventListener() {
+                    @Override
+                    public void onReactContextInitialized(@NonNull ReactContext reactContext) {
+                        mIsReactContextInitialized.set(true);
+                        drainTaskQueue(reactContext);
+                        reactInstanceManager.removeReactInstanceEventListener(this);
+                    }
+                });
+                reactInstanceManager.createReactContextInBackground();
+            }
+        }
+    }
+
+    /**
+     * Return true if this app is running with RN's bridgeless architecture.
+     * Cheers to @mikehardy for this idea.
+     * @return
+     */
+    private boolean isBridglessArchitectureEnabled() {
+        try {
+            Class<?> entryPoint = Class.forName("com.facebook.react.defaults.DefaultNewArchitectureEntryPoint");
+            Method bridgelessEnabled = entryPoint.getMethod("getBridgelessEnabled");
+            Object result = bridgelessEnabled.invoke(null);
+            return (result == Boolean.TRUE);
+        } catch (Exception e) {
+            return false;
+        }
+    }
+
+    /**
+     * Invokes HeadlessEvents queued while waiting for the ReactContext to initialize.
+     * @param reactContext
+     */
+    private void drainTaskQueue(final ReactContext reactContext) {
+        new Handler(Looper.getMainLooper()).postDelayed(() -> {
+            mTaskQueue.forEach((Task task) -> {
+                boolean success = invokeStartTask(reactContext, task);
+                if (!success) {
+                    removeTask(task);
+                }
+            });
+        }, 250);
+    }
+
+    // Find a task in the queue.
+    public Task findTask(int taskId) {
+        Task found = null;
+        // Locate the TaskConfig instance by our local taskId.
+        synchronized (mTaskQueue) {
+            for (Task task : mTaskQueue) {
+                if (task.getId() == taskId) {
+                    found = task;
+                    break;
+                }
+            }
+        }
+        return found;
+    }
+
+    private Task findTaskByReactId(int reactTaskId) {
+        Task found = null;
+        // Locate the TaskConfig instance by our local taskId.
+        synchronized (mTaskQueue) {
+            for (Task config : mTaskQueue) {
+                if (config.getReactTaskId() == reactTaskId) {
+                    found = config;
+                    break;
+                }
+            }
+        }
+        return found;
+    }
+    // Add a task to queue.
+    private void addTask(Task config) {
+        // push this HeadlessEvent onto the taskQueue, to be drained once the React context is finished initializing,
+        // or executed immediately if Context exists currently.
+        synchronized (mTaskQueue) {
+            mTaskQueue.add(config);
+        }
+    }
+
+    // Remove TaskConfig from queue.
+    private void removeTask(Task task) {
+        synchronized (mTaskQueue) {
+            mTaskQueue.remove(task);
+        }
+    }
+
+    // Any tasks in the queue?
+    private boolean hasTasks() {
+        synchronized (mTaskQueue) {
+            return !mTaskQueue.isEmpty();
+        }
+    }
+
+    /**
+     * Wrapper for a client event.  Inserts our custom taskId into the RN ClientEvent params.
+     */
+    public static class Task {
+        private static final AtomicInteger sLastTaskId = new AtomicInteger(0);
+        synchronized static int getNextTaskId() {
+            return sLastTaskId.incrementAndGet();
+        }
+
+        private final int mId;
+        private final String mTaskName;
+        private int mReactTaskId;
+        private final OnInvokeCallback mOnInvokeCallback;
+        private final OnFinishCallback mOnFinishCallback;
+        private final OnErrorCallback mOnErrorCallback;
+        private final int mTimeout;
+        private final WritableMap mParams;
+
+        Task(Builder builder) {
+            mTaskName = builder.name;
+            mId = getNextTaskId();
+            mOnInvokeCallback = builder.onInvokeCallback;
+            mOnFinishCallback = builder.onFinishCallback;
+            mOnErrorCallback = builder.onErrorCallback;
+            mTimeout = builder.timeout;
+            mParams = builder.params;
+            // 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.
+
+            mReactTaskId = headlessJsTaskContext.startTask(buildTaskConfig());
+            if (mOnInvokeCallback != null) {
+                mOnInvokeCallback.onInvoke(reactContext, this);
+            }
+            return true;
+        }
+
+        public int getId() {
+            return mId;
+        }
+
+        private int getReactTaskId() {
+            return mReactTaskId;
+        }
+
+        private HeadlessJsTaskConfig buildTaskConfig() {
+            return new HeadlessJsTaskConfig(mTaskName, mParams, mTimeout);
+        }
+
+        void onFinish() {
+            if (mOnFinishCallback != null) {
+                mOnFinishCallback.onFinish(mId);
+            }
+        }
+
+        void onError(Exception e) {
+            if (mOnErrorCallback != null) {
+                mOnErrorCallback.onError(this, e);
+            }
+        }
+
+        public String toString() {
+            return "[HeadlessTaskManager.Task name: " + mTaskName + " " + mParams + "]";
+        }
+
+        public static class Builder {
+            private static final int DEFAULT_TIMEOUT = 60000;
+
+            private String name;
+            private OnInvokeCallback onInvokeCallback;
+            private OnFinishCallback onFinishCallback;
+            private OnErrorCallback onErrorCallback;
+            private WritableMap params;
+            private int timeout = DEFAULT_TIMEOUT;
+
+            public Builder setName(String name) {
+                this.name = name;
+                return this;
+            }
+            public Builder setOnInvokeCallback(OnInvokeCallback callback) {
+                this.onInvokeCallback = callback;
+                return this;
+            }
+            public Builder setOnFinishCallback(OnFinishCallback callback) {
+                this.onFinishCallback = callback;
+                return this;
+            }
+            public Builder setOnErrorCallback(OnErrorCallback callback) {
+                this.onErrorCallback = callback;
+                return this;
+            }
+            public Builder setParams(WritableMap params) {
+                this.params = params;
+                return this;
+            }
+            public Builder setTimeout(int timeout) {
+                this.timeout = timeout;
+                return this;
+            }
+            public Task build() {
+                return new Task(this);
+            }
+        }
+    }
+
+    public static class TaskNotFoundError extends Exception {
+        public TaskNotFoundError(int taskId) {
+            super(HeadlessTaskManager.class.getName() + " failed to find task: " + taskId);
+        }
+    }
+
+    public static class ContextError extends Exception {
+        public ContextError(String message) {
+            super(message);
+        }
+    }
+
+    public interface OnInvokeCallback {
+        void onInvoke(ReactContext reactContext, Task task);
+    }
+    public interface OnFinishCallback {
+        void onFinish(int taskId);
+    }
+    public interface OnErrorCallback {
+        void onError(Task task, Exception e);
+    }
+}

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

@@ -825,6 +825,12 @@ public class RNBackgroundGeolocationModule extends ReactContextBaseJavaModule im
         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();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-background-geolocation",
-  "version": "4.18.0",
+  "version": "4.18.2",
   "description": "The most sophisticated cross-platform background location-tracking & geofencing module with battery-conscious motion-detection intelligence",
   "scripts": {
     "build": "yarn run build:expo",

package/src/NativeModule.js

@@ -327,7 +327,7 @@ export default class NativeModule {
         reject('INVALID_TASK_ID: ' + taskId);
         return;
       }
-      let success = (taskId) => { resolve(taskId) }
+      let success = () => { resolve() }
       let failure = (error) =>  { reject(error) }
       RNBackgroundGeolocation.finishHeadlessTask(taskId, success, failure);
     });

package/src/declarations/BackgroundGeolocation.d.ts

@@ -6,6 +6,7 @@
 /// <reference path="interfaces/GeofenceEvent.d.ts" />
 /// <reference path="interfaces/GeofencesChangeEvent.d.ts" />
 /// <reference path="interfaces/HeartbeatEvent.d.ts" />
+/// <reference path="interfaces/HeadlessEvent.d.ts" />
 /// <reference path="interfaces/HttpEvent.d.ts" />
 /// <reference path="interfaces/Location.d.ts" />
 /// <reference path="interfaces/LocationAuthorizationAlert.d.ts" />
@@ -676,7 +677,7 @@ declare module "react-native-background-geolocation" {
     * - You __must__ `registerHeadlessTask` in your application root file (eg: `index.js`).
     * 
     * ### ⚠️ Warning:
-    * - Your `function` __must__ be declared as `async`.
+    * - Your `function` __must__ be declared as `async`.  You must `await` all work within your task.  Your headless-task will automatically be terminated after executing the last line of your function.
     *
     * @example
     * ```typescript
@@ -685,7 +686,7 @@ declare module "react-native-background-geolocation" {
     *   console.log("[BackgroundGeolocation HeadlessTask] -", event.name, params);
     *
     *   switch (event.name) {
-    *     case "heartbeat":
+    *     case "terminate":
     *       // Use await for async tasks
     *       const location = await BackgroundGeolocation.getCurrentPosition({
     *         samples: 1,
@@ -694,8 +695,9 @@ declare module "react-native-background-geolocation" {
     *       console.log("[BackgroundGeolocation HeadlessTask] - getCurrentPosition:", location);
     *       break;
     *   }
-    *   // Signal completion of our RN HeadlessTask.
-    *   BackgroundGeolocation.finishHeadlessTask(taskId);
+    *   // You must await all work you do in your task.  
+    *   // Headless-tasks are automatically terminated after executing the last line of your function.
+    *   await doWork();
     * }
     *
     * BackgroundGeolocation.registerHeadlessTask(BackgroundGeolocationHeadlessTask);
@@ -740,11 +742,10 @@ declare module "react-native-background-geolocation" {
     * 
     * ### ℹ️ See also:
     * - 📘 [Android Headless Mode](github:wiki/Android-Headless-Mode).
-    * - [[BackgroundGeolocation.finishHeadlessTask]]
     * - [[Config.enableHeadless]]
     *
     */
-    static registerHeadlessTask(callback:(event:Object)=> Promise<void>): void;
+    static registerHeadlessTask(callback:(event:HeadlessEvent)=> Promise<void>): void;
 
     /**
     *
@@ -1077,51 +1078,8 @@ declare module "react-native-background-geolocation" {
     static finish(taskId: number, success?: Function, failure?: Function): Promise<number>;
 
     /**
+     * @private
      * __[Android-only]__ Signals completion of an Android headless-task (see [[Config.enableHeadless]])
-     * 
-     * @example
-     * ```typescript
-     * const bgGeoHeadlessTask = async (event) => {
-     *   // the name of this event (eg: "location", "motionchange", "http")
-     *   const eventName  = event.name; 
-     *   // our event-data from the BG Geo SDK.
-     *   const params     = event.params;
-     *   // IMPORTANT:  This task's ID
-     *   const taskId     = event.taskId;
-     *   
-     *   console.log('[BGGeoHeadlessTask] ', eventName, taskId, params);
-     *   
-     *   // Fake a long-running task (eg: HTTP request).
-     *   await doWork();
-     *   
-     *   // Signal completion of our RN HeadlessTask.
-     *   BackgroundGeolocation.finishHeadlessTask(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);
-     *   });
-     * }
-     * 
-     * // Register the HeadlessTask with RN.
-     * BackgroundGeolocation.registerHeadlessTask(bgGeoHeadlessTask);
-     * 
-     * ```
-     * ### ℹ️ See also:
-     * - 📘 [Android Headless Mode](github:wiki/Android-Headless-Mode).
-     * - [[BackgroundGeolocation.registerHeadlessTask]]
-     * - [[Config.enableHeadless]]
      */
     static finishHeadlessTask(taskId: number, success?: Function, failure?: Function): Promise<number>; 
 

package/src/declarations/interfaces/Config.d.ts

@@ -2259,7 +2259,6 @@ declare module "react-native-background-geolocation" {
     * ### ℹ️ See also:
     * - 📘 [Android Headless Mode](github:wiki/Android-Headless-Mode).
     * - [[BackgroundGeolocation.registerHeadlessTask]]
-    * - [[BackgroundGeolocation.finishHeadlessTask]]
     */
     enableHeadless?: boolean;
 

package/src/declarations/interfaces/HeadlessEvent.d.ts

@@ -0,0 +1,49 @@
+/// <reference path="../types.d.ts" />
+
+
+declare module "react-native-background-geolocation" {
+  /**
+   * This is the event-object provided to Android headless-tasks registered via [[BackgroundGeolocation.registerHeadlessTask]].
+   * 
+   * @example
+   * ```typescript
+   * const BackgroundGeolocationHeadlessTask = async (event) => {
+   *   const params = event.params;
+   *   console.log("[BackgroundGeolocation HeadlessTask] -", event.name, params);
+   *
+   *   switch (event.name) {
+   *     case "terminate":
+   *       // Use await for async tasks
+   *       const location = await BackgroundGeolocation.getCurrentPosition({
+   *         samples: 1,
+   *         persist: false
+   *       });
+   *       console.log("[BackgroundGeolocation HeadlessTask] - getCurrentPosition:", location);
+   *       break;
+   *   }
+   *   // You must await all work you do in your task.  
+   *   // Headless-tasks are automatically terminated after executing the last line of your function.
+   *   await doWork();
+   * }
+   *
+   * BackgroundGeolocation.registerHeadlessTask(BackgroundGeolocationHeadlessTask);
+   * ```   
+   * 
+   * ### ℹ️ See also:
+   * - 📘 [Android Headless Mode](github:wiki/Android-Headless-Mode).
+   * - [[BackgroundGeolocation.registerHeadlessTask]]
+   * - [[Config.enableHeadless]]
+   * 
+   */
+  interface HeadlessEvent {    
+    /**
+     * BackgroundGeolocation event name (eg: `location`, `motionchange`, `terminate`, `http`, etc).
+     */
+    name: Event;
+    /**
+     * General event params according to the context of the event name.
+     */
+    params: Map;
+  }
+}
+

package/src/declarations/types.d.ts

@@ -157,6 +157,8 @@ declare module "react-native-background-geolocation" {
 
 	type PersistMode = -1 | 0 | 1 | 2;
 
+	type Map = {[key: string]: string|null|number|boolean|Map|string[]|number[]|number[][]|boolean[]|Map[]};
+	
 	type Extras = {[key: string]: string|null|number|boolean|Extras|string[]|number[]|number[][]|boolean[]|Extras[]};
 
 	/**
@@ -185,4 +187,5 @@ declare module "react-native-background-geolocation" {
 	 * - See [[onActivityChange]] and [[Location.activity]].
 	 */
 	type MotionActivityType = "unknown" | "still" | "walking" | "on_foot" | "running" | "on_bicycle" | "in_vehicle";
+
 }

package/src/index.js

@@ -131,13 +131,6 @@ export default class BackgroundGeolocation {
     return _deviceSettingsInstance;
   }
 
-  /**
-  * Register HeadlessTask
-  */
-  static registerHeadlessTask(task) {
-    AppRegistry.registerHeadlessTask(TAG, () => task);
-  }
-
   /**
   * Core Plugin Control Methods
   */
@@ -380,7 +373,33 @@ export default class BackgroundGeolocation {
   static finish(taskId, success, failure) {
     this.stopBackgroundTask.apply(this, arguments);
   }
+
+  /**
+  * Register HeadlessTask
+  * Have to wrap execution to finish our own headless-task because there's an unknown issue with TurboModules in new arch
+  * where RN's HeadlessJsTaskSupport is null.  That module can automatically finish RN headless-tasks.
+  */
+  static registerHeadlessTask(taskProvider) {
+    AppRegistry.registerHeadlessTask(TAG, () => {
+      // return to RN's AppRegistry a Function that returns a Promise.
+      return (event) => {
+        return new Promise((resolve, reject) => {          
+          const taskId = event._transistorHeadlessTaskId;
+          delete(event._transistorHeadlessTaskId);
+          taskProvider(event).then(() => {
+            BackgroundGeolocation.finishHeadlessTask(taskId);
+            resolve();
+          }).catch(reason => {
+            BackgroundGeolocation.finishHeadlessTask(taskId);
+            reject(reason);
+          });  
+        });
+      }
+    });
+  }
+
   /**
+   * @private 
    * Signal completion of a react-native headless-task.  This helps RN free-up resources allocated to the headless-task execution.
    */
   static finishHeadlessTask(taskId, success, failure) {