react-native-brouter 0.0.1

package/android/src/main/java/com/jhotadhari/reactnative/brouter/BRouterClient.java

@@ -0,0 +1,205 @@
+package com.jhotadhari.reactnative.brouter;
+
+import android.content.Context;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import btools.routingapp.IBRouterService;
+
+/**
+ * Manages the bind lifecycle to the external BRouter Android app's AIDL service.
+ *
+ * <p>This replaces the previous {@code BRouterConnector} singleton with an
+ * instance-based design — each {@link BRouterModule} owns one client, keyed
+ * to its {@code ReactContext}, so connection timeouts and lifecycle are
+ * scoped correctly.
+ *
+ * <p>The bind-and-poll pattern is derived from OsmAnd's
+ * {@code BRouterServiceConnection} usage (the polling loop is necessary
+ * because the external service process needs time to start after the bind
+ * intent is sent).
+ */
+public class BRouterClient {
+
+	private final Context ctx;
+	private final int connectTimeoutMs;
+
+	@Nullable
+	private BRouterServiceConnection connection;
+
+	/**
+	 * The error code from the most recent failed {@link #connect()} call,
+	 * or {@code null} if the last connection attempt succeeded.
+	 */
+	@Nullable
+	private String lastError;
+
+	/**
+	 * @param ctx              Android context used to bind the BRouter service.
+	 * @param connectTimeoutMs maximum time (ms) to wait for the service process
+	 *                         to start. Default 1000.
+	 */
+	public BRouterClient( @NonNull Context ctx, int connectTimeoutMs ) {
+		this.ctx = ctx.getApplicationContext();
+		this.connectTimeoutMs = connectTimeoutMs;
+	}
+
+	/**
+	 * Bind to the BRouter service and wait for it to become available.
+	 *
+	 * <p>Safe to call multiple times — if already connected this is a no-op.
+	 *
+	 * <p>The early-return / connection-creation path is synchronized, but the
+	 * polling loop runs outside the monitor so that a main-thread
+	 * {@link #disconnect()} (via {@code invalidate()}) is not blocked.
+	 *
+	 * @return the AIDL service interface, or {@code null} if the connection
+	 *         could not be established.  Call {@link #getLastError()} for
+	 *         the specific failure code.
+	 */
+	@Nullable
+	public IBRouterService connect() {
+		BRouterServiceConnection localConn;
+
+		synchronized ( this ) {
+			if ( connection != null ) {
+				IBRouterService svc = connection.getBRouterService();
+				if ( svc != null && svc.asBinder().isBinderAlive() ) {
+					lastError = null;
+					return svc;
+				}
+				// Binder died — reconnect below
+				disconnect();
+			}
+
+			connection = BRouterServiceConnection.connect( ctx );
+			if ( connection == null ) {
+				lastError = BRouterError.SERVICE_NOT_INSTALLED;
+				return null;
+			}
+			localConn = connection;
+		}
+
+		// Poll until the service process starts, or timeout.
+		// Pattern copied from OsmAnd — the service process needs time to start
+		// after the bind intent fires, and there is no callback for "process ready".
+		// Polling runs OUTSIDE the synchronized block so that a main-thread
+		// invalidate() -> disconnect() can proceed without blocking.
+		int i = 0;
+		try {
+			while ( localConn.getBRouterService() == null && i * 100 < connectTimeoutMs ) {
+				Thread.sleep( 100 );
+				i += 1;
+			}
+		} catch ( InterruptedException e ) {
+			Thread.currentThread().interrupt();
+			lastError = BRouterError.CONNECTION_TIMEOUT;
+			disconnect();
+			return null;
+		} catch ( Exception e ) {
+			e.printStackTrace();
+			lastError = BRouterError.UNKNOWN;
+			disconnect();
+			return null;
+		}
+
+		if ( localConn.getBRouterService() == null ) {
+			lastError = BRouterError.CONNECTION_TIMEOUT;
+			disconnect();
+			return null;
+		}
+
+		lastError = null;
+		return localConn.getBRouterService();
+	}
+
+	/**
+	 * Return the error code from the most recent failed {@link #connect()}
+	 * call, or {@code null} if the last connection attempt succeeded.
+	 *
+	 * <p>Use this after {@link #connect()} returns {@code null} (or
+	 * {@link #getRoute} throws) to distinguish "app not installed" from a
+	 * transient connection timeout.
+	 */
+	@Nullable
+	public String getLastError() {
+		return lastError;
+	}
+
+	/**
+	 * Return the connection timeout in milliseconds.
+	 */
+	public int getConnectTimeoutMs() {
+		return connectTimeoutMs;
+	}
+
+	/**
+	 * Return the current service interface, reconnecting transparently if the
+	 * binder has died.
+	 *
+	 * <p>Copied pattern from OsmAnd's {@code getBRouterService()}.
+	 */
+	@Nullable
+	public synchronized IBRouterService getService() {
+		if ( connection == null ) {
+			return connect();
+		}
+		IBRouterService service = connection.getBRouterService();
+		if ( service == null ) {
+			return connect();
+		}
+		if ( ! service.asBinder().isBinderAlive() ) {
+			return connect();
+		}
+		lastError = null;
+		return service;
+	}
+
+	/**
+	 * Call the BRouter service with the given parameter bundle.
+	 *
+	 * @param params the Bundle produced by {@link ParamMapper#toBundle}.
+	 * @return the track result string, or {@code null} if routing failed.
+	 * @throws IllegalStateException if the service is unavailable (call
+	 *         {@link #getLastError()} for the specific error code).
+	 * @throws Exception if the AIDL call itself fails.
+	 */
+	@Nullable
+	public String getRoute( @NonNull android.os.Bundle params ) throws Exception {
+		IBRouterService service = getService();
+		if ( service == null ) {
+			String code = lastError != null ? lastError : BRouterError.SERVICE_UNAVAILABLE;
+			throw new IllegalStateException( code );
+		}
+		return service.getTrackFromParams( params );
+	}
+
+	/**
+	 * Whether the service is currently connected and alive.
+	 */
+	public synchronized boolean isConnected() {
+		if ( connection == null ) {
+			return false;
+		}
+		IBRouterService svc = connection.getBRouterService();
+		return svc != null && svc.asBinder().isBinderAlive();
+	}
+
+	/**
+	 * Unbind from the BRouter service and release resources.
+	 *
+	 * <p>Safe to call multiple times. After calling this, the next
+	 * {@link #connect()} will create a fresh binding.
+	 */
+	public synchronized void disconnect() {
+		if ( connection != null ) {
+			try {
+				connection.disconnect( ctx );
+			} catch ( Exception e ) {
+				// Best-effort cleanup — the context may already be gone.
+			}
+			connection = null;
+		}
+	}
+}

package/android/src/main/java/com/jhotadhari/reactnative/brouter/BRouterError.java

@@ -0,0 +1,38 @@
+package com.jhotadhari.reactnative.brouter;
+
+/**
+ * Structured error codes for the BRouter native module.
+ *
+ * <p>Each error code maps to a distinct failure scenario so that JS consumers
+ * can react programmatically (e.g. prompt the user to install BRouter vs.
+ * retry a transient connection failure).
+ *
+ * <p>Errors are passed to JS via {@code promise.reject(code, message)}.
+ */
+public final class BRouterError {
+
+	/** The BRouter Android app is not installed on the device. */
+	public static final String SERVICE_NOT_INSTALLED = "SERVICE_NOT_INSTALLED";
+
+	/** Bound to the BRouter process but could not obtain the AIDL interface. */
+	public static final String SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE";
+
+	/** The BRouter service process did not start within the connect timeout. */
+	public static final String CONNECTION_TIMEOUT = "CONNECTION_TIMEOUT";
+
+	/** The routing calculation exceeded {@code maxRunningTime}. */
+	public static final String ROUTING_TIMEOUT = "ROUTING_TIMEOUT";
+
+	/** The request parameters are invalid (e.g. fewer than 2 waypoints). */
+	public static final String INVALID_PARAMS = "INVALID_PARAMS";
+
+	/** BRouter could not find a route between the given waypoints. */
+	public static final String ROUTING_FAILED = "ROUTING_FAILED";
+
+	/** An unexpected error occurred. See the message for details. */
+	public static final String UNKNOWN = "UNKNOWN";
+
+	private BRouterError() {
+		// static constants only
+	}
+}

package/android/src/main/java/com/jhotadhari/reactnative/brouter/BRouterModule.java

@@ -0,0 +1,135 @@
+package com.jhotadhari.reactnative.brouter;
+
+import android.os.Bundle;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.module.annotations.ReactModule;
+
+import btools.routingapp.IBRouterService;
+
+@ReactModule(name = BRouterModule.NAME)
+public class BRouterModule extends NativeBRouterSpec {
+
+	public static final String NAME = "BRouter";
+
+	private static final int DEFAULT_CONNECT_TIMEOUT_MS = 1000;
+
+	@Nullable
+	BRouterClient client;
+
+	public BRouterModule( ReactApplicationContext reactContext ) {
+		super( reactContext );
+	}
+
+	@NonNull
+	@Override
+	public String getName() {
+		return NAME;
+	}
+
+	/**
+	 * Return the BRouter client, creating it lazily if necessary.
+	 *
+	 * <p>Synchronized so two concurrent {@code getRoute()} calls cannot
+	 * race and create duplicate clients (each with its own active
+	 * {@code ServiceConnection} binding).
+	 *
+	 * <p>If the client already exists and the caller passes a different
+	 * {@code connectTimeout}, the old client is disconnected and a fresh
+	 * one is created — per-request timeouts are supported rather than
+	 * being locked to the first call's value.
+	 */
+	@NonNull
+	synchronized BRouterClient getClient( @NonNull ReadableMap params ) {
+		int timeout = params.hasKey( "connectTimeout" )
+			? params.getInt( "connectTimeout" )
+			: DEFAULT_CONNECT_TIMEOUT_MS;
+
+		if ( client != null ) {
+			if ( client.getConnectTimeoutMs() != timeout ) {
+				client.disconnect();
+				client = null;
+			}
+		}
+
+		if ( client == null ) {
+			client = new BRouterClient( getReactApplicationContext(), timeout );
+		}
+		return client;
+	}
+
+	@Override
+	@ReactMethod
+	public void getRoute( @NonNull ReadableMap params, @NonNull Promise promise ) {
+		android.util.Log.d( "BRouterModule", "getRoute keys: " + params.toHashMap().keySet() );
+		try {
+			// Validate waypoints
+			if ( ! params.hasKey( "lonlats" ) || ! params.hasKey( "lats" ) || ! params.hasKey( "lons" ) ) {
+				promise.reject(
+					BRouterError.INVALID_PARAMS,
+					"At least 2 waypoints are required"
+				);
+				return;
+			}
+
+			// Build the AIDL Bundle
+			Bundle brouterParams = ParamMapper.toBundle( params );
+
+			// Use client.getRoute() which handles transparent reconnect
+			// on binder death — the raw service reference is never exposed.
+			BRouterClient brouterClient = getClient( params );
+			String track = brouterClient.getRoute( brouterParams );
+
+			if ( track == null ) {
+				promise.reject(
+					BRouterError.ROUTING_FAILED,
+					"No route found between the given waypoints"
+				);
+				return;
+			}
+
+			promise.resolve( track );
+		} catch ( Exception e ) {
+			e.printStackTrace();
+
+			// Map known error codes from BRouterClient.getLastError()
+			String code = BRouterError.UNKNOWN;
+			String message = e.toString();
+
+			if ( e instanceof IllegalStateException ) {
+				String detail = e.getMessage();
+				if ( detail != null ) {
+					// BRouterClient.getRoute() passes the error code as the
+					// exception message when the service is unavailable.
+					if ( detail.equals( BRouterError.SERVICE_NOT_INSTALLED )
+						|| detail.equals( BRouterError.CONNECTION_TIMEOUT )
+						|| detail.equals( BRouterError.SERVICE_UNAVAILABLE ) ) {
+						code = detail;
+						message = detail.equals( BRouterError.SERVICE_NOT_INSTALLED )
+							? "The BRouter app is not installed on this device"
+							: detail.equals( BRouterError.CONNECTION_TIMEOUT )
+								? "Timed out waiting for the BRouter service to start"
+								: "BRouter service is not available";
+					}
+				}
+			}
+
+			promise.reject( code, message );
+		}
+	}
+
+	@Override
+	public void invalidate() {
+		if ( client != null ) {
+			client.disconnect();
+			client = null;
+		}
+		super.invalidate();
+	}
+}

package/android/src/main/java/com/jhotadhari/reactnative/brouter/BRouterPackage.kt

@@ -0,0 +1,33 @@
+package com.jhotadhari.reactnative.brouter
+
+import com.facebook.react.BaseReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.module.model.ReactModuleInfo
+import com.facebook.react.module.model.ReactModuleInfoProvider
+import java.util.HashMap
+
+class BRouterPackage : BaseReactPackage() {
+  override fun getModule(name: String, reactContext: ReactApplicationContext): NativeModule? {
+    return if (name == BRouterModule.NAME) {
+      BRouterModule(reactContext)
+    } else {
+      null
+    }
+  }
+
+  override fun getReactModuleInfoProvider(): ReactModuleInfoProvider {
+    return ReactModuleInfoProvider {
+      val moduleInfos: MutableMap<String, ReactModuleInfo> = HashMap()
+      moduleInfos[BRouterModule.NAME] = ReactModuleInfo(
+        BRouterModule.NAME,
+        BRouterModule.NAME,
+        false,  // canOverrideExistingModule
+        false,  // needsEagerInit
+        false,  // isCxxModule
+        true // isTurboModule
+      )
+      moduleInfos
+    }
+  }
+}

package/android/src/main/java/com/jhotadhari/reactnative/brouter/BRouterServiceConnection.java

@@ -0,0 +1,54 @@
+package com.jhotadhari.reactnative.brouter;
+
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.Intent;
+import android.content.ServiceConnection;
+import android.os.IBinder;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import btools.routingapp.IBRouterService;
+
+/**
+ * Copy of https://github.com/osmandapp/OsmAnd/blob/master/OsmAnd/src/btools/routingapp/BRouterServiceConnection.java
+ */
+public class BRouterServiceConnection implements ServiceConnection {
+
+	private volatile IBRouterService brouterService;
+
+	public void onServiceConnected(ComponentName className, IBinder boundService) {
+		brouterService = IBRouterService.Stub.asInterface(boundService);
+	}
+
+	public void onServiceDisconnected(ComponentName className) {
+		brouterService = null;
+	}
+
+	public void disconnect(@NonNull Context ctx) {
+		ctx.unbindService(this);
+	}
+
+	@Nullable
+	public IBRouterService getBRouterService() {
+		return brouterService;
+	}
+
+	@Nullable
+	public static BRouterServiceConnection connect( @NonNull Context ctx ) {
+		BRouterServiceConnection conn = new BRouterServiceConnection();
+		Intent intent = new Intent();
+		intent.setClassName("btools.routingapp", "btools.routingapp.BRouterService");
+		boolean hasBRouter = ctx.bindService(
+			intent,
+			conn,
+			Context.BIND_AUTO_CREATE
+		);
+		if ( ! hasBRouter ) {
+			conn = null;
+		}
+		return conn;
+	}
+}
+

package/android/src/main/java/com/jhotadhari/reactnative/brouter/ParamMapper.java

@@ -0,0 +1,174 @@
+package com.jhotadhari.reactnative.brouter;
+
+import android.os.Bundle;
+
+import com.facebook.react.bridge.ReadableArray;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.bridge.ReadableType;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+/**
+ * Converts a {@link ReadableMap} (serialized from the JS {@code RouteRequest})
+ * into an Android {@link Bundle} matching the key/type contract documented in
+ * {@code IBRouterService.aidl}.
+ *
+ * <p>Every key listed in the AIDL comment block is mapped here. This is the
+ * single place where JS-to-AIDL key name translation lives — adding a new
+ * param means adding one field to the JS type and one {@code putX} call here.
+ */
+public final class ParamMapper {
+
+	private ParamMapper() {
+		// static utility — no instances
+	}
+
+	/**
+	 * Convert the JS-serialized route request into a Bundle suitable for
+	 * {@code IBRouterService.getTrackFromParams(Bundle)}.
+	 */
+	@NonNull
+	public static Bundle toBundle( @NonNull ReadableMap params ) {
+		return toBundle( params, new Bundle() );
+	}
+
+	/**
+	 * Overload that writes into an existing Bundle (useful for testing
+	 * with a mocked Bundle).
+	 */
+	@NonNull
+	static Bundle toBundle( @NonNull ReadableMap params, @NonNull Bundle b ) {
+
+		// ── Waypoints ──────────────────────────────────────────────
+		// JS pre-serializes waypoints into lonlats, lats, lons, straight
+		putString( b, params, "lonlats" );
+		putDoubleArray( b, params, "lats" );
+		putDoubleArray( b, params, "lons" );
+		putString( b, params, "straight" );
+
+		// ── Profile ────────────────────────────────────────────────
+		putString( b, params, "profile" );
+		putString( b, params, "remoteProfile" );
+
+		// ── Vehicle / speed ────────────────────────────────────────
+		putString( b, params, "v" );
+		if ( params.hasKey( "fast" ) ) {
+			b.putInt( "fast", params.getInt( "fast" ) );
+		}
+
+		// ── Output format ──────────────────────────────────────────
+		putString( b, params, "trackFormat" );
+
+		// ── Alternative index ──────────────────────────────────────
+		if ( params.hasKey( "alternativeidx" ) ) {
+			b.putInt( "alternativeidx", params.getInt( "alternativeidx" ) );
+		}
+
+		// ── Export waypoints ───────────────────────────────────────
+		if ( params.hasKey( "exportWaypoints" ) ) {
+			b.putInt( "exportWaypoints", params.getInt( "exportWaypoints" ) );
+		}
+
+		// ── Turn instructions ──────────────────────────────────────
+		putString( b, params, "turnInstructionFormat" );
+		if ( params.hasKey( "timode" ) ) {
+			b.putInt( "timode", params.getInt( "timode" ) );
+		}
+
+		// ── Heading / direction ────────────────────────────────────
+		if ( params.hasKey( "heading" ) ) {
+			b.putDouble( "heading", params.getDouble( "heading" ) );
+		}
+		if ( params.hasKey( "direction" ) ) {
+			b.putDouble( "direction", params.getDouble( "direction" ) );
+		}
+
+		// ── Engine mode (elevation) ────────────────────────────────
+		if ( params.hasKey( "engineMode" ) ) {
+			b.putInt( "engineMode", params.getInt( "engineMode" ) );
+		}
+
+		// ── Timeout ────────────────────────────────────────────────
+		if ( params.hasKey( "maxRunningTime" ) ) {
+			b.putString( "maxRunningTime", String.valueOf( params.getInt( "maxRunningTime" ) ) );
+		}
+
+		// ── File output ────────────────────────────────────────────
+		putString( b, params, "pathToFileResult" );
+
+		// ── Compression ────────────────────────────────────────────
+		if ( params.hasKey( "acceptCompressedResult" ) ) {
+			b.putBoolean( "acceptCompressedResult", params.getBoolean( "acceptCompressedResult" ) );
+		}
+
+		// ── Extra params (profile setup key=value) ─────────────────
+		if ( params.hasKey( "extraParams" ) ) {
+			ReadableMap extra = params.getMap( "extraParams" );
+			if ( extra != null ) {
+				Bundle extraBundle = new Bundle();
+				com.facebook.react.bridge.ReadableMapKeySetIterator iterator =
+					extra.keySetIterator();
+				while ( iterator.hasNextKey() ) {
+					String key = iterator.nextKey();
+					ReadableType type = extra.getType( key );
+					if ( type == ReadableType.String ) {
+						extraBundle.putString( key, extra.getString( key ) );
+					} else if ( type == ReadableType.Number ) {
+						extraBundle.putDouble( key, extra.getDouble( key ) );
+					} else if ( type == ReadableType.Boolean ) {
+						extraBundle.putBoolean( key, extra.getBoolean( key ) );
+					}
+				}
+				b.putBundle( "extraParams", extraBundle );
+			}
+		}
+
+		// ── Nogo areas ─────────────────────────────────────────────
+		putString( b, params, "nogos" );
+		putDoubleArray( b, params, "nogoLats" );
+		putDoubleArray( b, params, "nogoLons" );
+		putDoubleArray( b, params, "nogoRadi" );
+
+		// ── Polylines / polygons ──────────────────────────────────
+		putString( b, params, "polylines" );
+		putString( b, params, "polygons" );
+
+		// ── POIs ──────────────────────────────────────────────────
+		putString( b, params, "pois" );
+
+		return b;
+	}
+
+	// ── Helpers ────────────────────────────────────────────────────
+
+	private static void putString(
+		@NonNull Bundle b,
+		@NonNull ReadableMap params,
+		@NonNull String key
+	) {
+		if ( params.hasKey( key ) ) {
+			String value = params.getString( key );
+			if ( value != null ) {
+				b.putString( key, value );
+			}
+		}
+	}
+
+	private static void putDoubleArray(
+		@NonNull Bundle b,
+		@NonNull ReadableMap params,
+		@NonNull String key
+	) {
+		if ( params.hasKey( key ) ) {
+			ReadableArray arr = params.getArray( key );
+			if ( arr != null && arr.size() > 0 ) {
+				double[] doubles = new double[ arr.size() ];
+				for ( int i = 0; i < arr.size(); i++ ) {
+					doubles[ i ] = arr.getDouble( i );
+				}
+				b.putDoubleArray( key, doubles );
+			}
+		}
+	}
+}