fix(andorid): implement turbomodule for location manager so events works (#3789)

Author: mfazekas

android/src/main/java/com/rnmapbox/rnmbx/RNMBXPackage.kt

@@ -184,7 +184,7 @@ class RNMBXPackage : TurboReactPackage() {
                 false,  // needsEagerInit
                 true,  // hasConstants
                 false,  // isCxxModule
-                false // isTurboModule
+                isTurboModule // isTurboModule
             )
             moduleInfos[RNMBXOfflineModule.REACT_CLASS] = ReactModuleInfo(
                 RNMBXOfflineModule.REACT_CLASS,

android/src/main/java/com/rnmapbox/rnmbx/modules/RNMBXLocationModule.kt

@@ -3,6 +3,7 @@ package com.rnmapbox.rnmbx.modules
 import com.facebook.react.bridge.*
 import com.rnmapbox.rnmbx.location.LocationManager
 import com.facebook.react.module.annotations.ReactModule
+import com.rnmapbox.rnmbx.NativeRNMBXLocationModuleSpec
 import com.rnmapbox.rnmbx.location.LocationManager.OnUserLocationChange
 import com.rnmapbox.rnmbx.events.LocationEvent
 import com.rnmapbox.rnmbx.events.EventEmitter
@@ -16,7 +17,7 @@ data class LocationEventThrottle(var waitBetweenEvents: Double? = null, var last
 
 @ReactModule(name = RNMBXLocationModule.REACT_CLASS)
 class RNMBXLocationModule(reactContext: ReactApplicationContext) :
-    ReactContextBaseJavaModule(reactContext) {
+    NativeRNMBXLocationModuleSpec(reactContext) {
     private var isEnabled = false
     private var mMinDisplacement = 0f
     private val locationManager: LocationManager? = getInstance(reactContext)
@@ -57,8 +58,12 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
             mLastLocation = location
             if (changed && (location != null) && shouldSendLocationEvent()) {
                 val locationEvent = LocationEvent(location)
+
+                emitOnLocationUpdate(locationEvent.toJSON())
+                /*
                 val emitter = EventEmitter.getModuleEmitter(reactApplicationContext)
                 emitter?.emit(LOCATION_UPDATE, locationEvent.payload)
+                */
             }
         }
     }
@@ -72,15 +77,16 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
     }
 
     @ReactMethod
-    fun start(minDisplacement: Float) {
+    override fun start(minDisplacement: Double) {
         isEnabled = true
-        mMinDisplacement = minDisplacement
+        mMinDisplacement = minDisplacement.toFloat()
         locationManager?.startCounted()
         startLocationManager()
     }
 
     @ReactMethod
-    fun setMinDisplacement(minDisplacement: Float) {
+    override fun setMinDisplacement(value: Double) {
+        val minDisplacement = value.toFloat()
         if (mMinDisplacement == minDisplacement) return
         mMinDisplacement = minDisplacement
         if (isEnabled) {
@@ -91,17 +97,17 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
     }
 
     @ReactMethod
-    fun setRequestsAlwaysUse(requestsAlwaysUse: Boolean) {
+    override fun setRequestsAlwaysUse(requestsAlwaysUse: Boolean) {
         // IOS only. Ignored on Android.
     }
 
     @ReactMethod
-    fun stop() {
+    override fun stop() {
         stopLocationManager()
     }
 
     @ReactMethod
-    fun getLastKnownLocation(promise: Promise) {
+    override fun getLastKnownLocation(promise: Promise) {
         locationManager!!.getLastKnownLocation(
             object : LocationEngineCallback {
                 override fun onSuccess(result: LocationEngineResult) {
@@ -121,6 +127,10 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
         )
     }
 
+    override fun simulateHeading(changesPerSecond: Double, increment: Double) {
+        // ios only
+    }
+
     @ReactMethod
     fun addListener(eventName: String?) {
         // Required for rn built in EventEmitter Calls.
@@ -150,10 +160,11 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
 
     // region Location event throttle
     @ReactMethod
-    fun setLocationEventThrottle(throttleValue: Double) {
+    override fun setLocationEventThrottle(throttleValue: Double) {
         if (throttleValue > 0) {
             locationEventThrottle.waitBetweenEvents = throttleValue;
         } else {
+
             locationEventThrottle.waitBetweenEvents = null
         }
     }
@@ -183,4 +194,4 @@ class RNMBXLocationModule(reactContext: ReactApplicationContext) :
         const val REACT_CLASS = "RNMBXLocationModule"
         const val LOCATION_UPDATE = "MapboxUserLocationUpdate"
     }
-}
+}

android/src/main/old-arch/com/rnmapbox/rnmbx/NativeRNMBXLocationModuleSpec.java

@@ -0,0 +1,68 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateModuleJavaSpec.js
+ *
+ * @nolint
+ */
+
+package com.rnmapbox.rnmbx;
+
+import com.facebook.proguard.annotations.DoNotStrip;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReactModuleWithSpec;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.turbomodule.core.interfaces.TurboModule;
+import javax.annotation.Nonnull;
+
+public abstract class NativeRNMBXLocationModuleSpec extends ReactContextBaseJavaModule implements ReactModuleWithSpec, TurboModule {
+  public static final String NAME = "RNMBXLocationModule";
+
+  public NativeRNMBXLocationModuleSpec(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @Override
+  public @Nonnull String getName() {
+    return NAME;
+  }
+
+  protected final void emitOnLocationUpdate(ReadableMap value) {
+    mEventEmitterCallback.invoke("onLocationUpdate", value);
+  }
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void start(double minDisplacement);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void stop();
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setRequestsAlwaysUse(boolean requestsAlwaysUse);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setMinDisplacement(double minDisplacement);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void getLastKnownLocation(Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void simulateHeading(double changesPerSecond, double increment);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void setLocationEventThrottle(double throttle);
+}

src/modules/location/locationManager.ts

@@ -5,13 +5,18 @@ import {
   NativeEventSubscription,
   EmitterSubscription,
   type AppStateStatus,
-} from 'react-native';
+  Platform,
+  EventSubscription,
+} from 'react-native'
 
-const MapboxGL = NativeModules.RNMBXModule;
-const MapboxGLLocationManager = NativeModules.RNMBXLocationModule;
+import NativeRNMBXLocationModule from '../../specs/NativeRNMBXLocationModule'
+
+const MapboxGL = NativeModules.RNMBXModule
+const MapboxGLLocationManager: typeof NativeRNMBXLocationModule = Platform.select({ios: NativeModules.RNMBXLocationModule, android:  NativeRNMBXLocationModule})
 
 export const LocationModuleEventEmitter = new NativeEventEmitter(
-  MapboxGLLocationManager,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  MapboxGLLocationManager as any,
 );
 
 /**
@@ -74,7 +79,7 @@ export class LocationManager {
   _lastKnownLocation: Location | null;
   _isListening: boolean;
   _requestsAlwaysUse: boolean;
-  subscription: EmitterSubscription | null;
+  subscription: EmitterSubscription | EventSubscription | null;
   _appStateListener: NativeEventSubscription;
   _minDisplacement?: number;
 
@@ -167,10 +172,16 @@ export class LocationManager {
     if (!this._isListening) {
       MapboxGLLocationManager.start(validDisplacement);
 
-      this.subscription = LocationModuleEventEmitter.addListener(
-        MapboxGL.LocationCallbackName.Update,
-        this._onUpdate,
-      );
+      if (Platform.OS === 'ios') {
+        this.subscription = LocationModuleEventEmitter.addListener(
+          MapboxGL.LocationCallbackName.Update,
+          this._onUpdate,
+        );
+      } else {
+        this.subscription = MapboxGLLocationManager.onLocationUpdate((location) => {
+          this._onUpdate(location.payload);
+        });
+      }
 
       this._isListening = true;
     }

src/specs/NativeRNMBXLocationModule.ts

@@ -0,0 +1,32 @@
+import { TurboModule, TurboModuleRegistry} from "react-native";
+import type { EventEmitter } from 'react-native/Libraries/Types/CodegenTypes';
+
+type LocationEvent = {
+  type: string //"userlocationdupdated"
+  payload: {
+    coords: {
+      latitude: number
+      longitude: number
+      altitude: number
+      accuracy: number
+      speed: number
+      heading: number
+    }
+    timestamp: number
+  }
+}
+
+export interface Spec extends TurboModule {
+  start(minDisplacement: number): void
+  stop(): void
+  setRequestsAlwaysUse(requestsAlwaysUse: boolean): void
+  setMinDisplacement(minDisplacement: number): void
+  getLastKnownLocation(): Promise<LocationEvent['payload']>
+  simulateHeading(changesPerSecond: number, increment: number): void
+  setLocationEventThrottle(throttle: number): void
+
+  readonly onLocationUpdate: EventEmitter<LocationEvent>
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('RNMBXLocationModule');
+