Latest updates from private repo, including refactored Android service architecture

Author: christocracy

CHANGELOG.md

@@ -1,5 +1,49 @@
 # Change Log
 
+## [3.0.0-beta.1] - 2019-02-27
+- [Changed] Major refactor of Android Service architecture.  The SDK no longer requires a foreground-service active at all times.  The foreground-service (and cooresponding persistent notification) will only be active while the SDK is in the *moving* state.  No breaking dart api changes.
+- [Changed] Improved Android debug notifications.
+
+- [Added] Added new Config options `persistMode` for specifying exactly which events get persisted: location | geofence | all | none.
+- [Added] Experimental Android-only Config option `speedJumpFilter (default 300 meters/second)` for detecting location anomalies.  The plugin will measure the distance and apparent speed of the current location relative to last location.  If the apparent speed is > `speedJumpFilter`, the location will be ignored.  Some users, particularly in Australia, curiously, have had locations suddenly jump hundreds of kilometers away, into the ocean.
+- [Changed] iOS and Android will not perform odometer updates when the calculated distance is less than the average accuracy of the current and previous location.  This is to prevent small odometer changes when the device is lingering around the same position.
+- [Fixed] Added Android gradle dependency `appcompat-v7`
+- [Fixed] Minor change to Android `HeadlessTask` to fix possible issue with `Looper`.
+
+- [Added] New `DeviceSettings` API for redirecting user to Android Settings screens, including vendor-specific screens (eg: Huawei, OnePlus, Xiaomi, etc).  This is an attempt to help direct the user to appropriate device-settings screens for poor Android vendors as detailed in the site [Don't kill my app](https://dontkillmyapp.com/).
+- [Added] `schedule` can now be configured to optionally execute geofences-only mode (ie: `#startGeofences`) per schedule entry.  See `schedule` docs.
+- [Changed] Update Gradle config to use `implementation` instead of deprecated `compile`
+- **[BREAKING]** Change Gradle `ext` configuration property `googlePlayServicesVersion` -> `googlePlayServicesLocationVersion`.  Now that Google has decoupled all their libraries, `play-services:location` now has its own version, independant of all other libs.
+
+`android/build.gradle`:
+```diff
+buildscript {
+    ext {
+        buildToolsVersion = "28.0.3"
+        minSdkVersion = 16
+        compileSdkVersion = 28
+        targetSdkVersion = 27
+        supportLibVersion = "28.0.0"
+-       googlePlayServicesVersion = "16.0.0"
++       googlePlayServicesLocationVersion = "16.0.0"
+    }
+}
+```
+
+- [Changed] Android Service: Return `START_STICKY` instead of `START_REDELIVER_INTENT`.
+- [Changed] Android: `setShowBadge(false)` on Android `NotificationChannel`.  Some users reporting that Android shows a badge-count on app icon when service is started / stopped.
+
+- [Fixed] Android `extras` provided to `watchPosition` were not being appended to location data.
+
+- [Fixed] Android NPE in `watchPosition`
+- [Added] Added method `getProviderState` for querying current state of location-services.
+- [Added] Added method `requestPermission` for manually requesting location-permission (`#start`, `#getCurrentPosition`, `#watchPosition` etc, will already automatically request permission.
+
+- [Changed] Upgrade Android logger dependency to latest version (`logback`).
+- [Fixed] Prevent Android foreground-service from auto-starting when location permission is revoked via Settings screen.
+- [Fixed] NPE in Android HTTP Service when manual sync is called.  Probably a threading issue with multiple sync operations executed simultaneously.
+
+
 ## [2.14.2] 2018-11-20
 - [Added] Android SDK 28 requires new permission to use foreground-service.
 - [Fixed] Do not calculate odometer with geofence events.  Android geofence event's location timestamp does not correspond with the actual time the geofence fires since Android is performing some heuristics in the background to ensure the potential geofence event is not a false positive.  The actual geofence event can fire some minutes in the future (ie: the location timestamp will be some minutues in the past).  Using geofence location in odometer calculations will corrupt the odometer value.

README.md

@@ -13,7 +13,7 @@ The plugin's [Philosophy of Operation](../../wiki/Philosophy-of-Operation) is to
 
 - When the device is detected be **stationary**, the plugin will automatically turn off location-services to conserve energy.
 
-Also available for [Cordova](https://github.com/transistorsoft/cordova-background-geolocation-lt), [NativeScript](https://github.com/transistorsoft/nativescript-background-geolocation-lt) and pure native apps.
+Also available for [Flutter](https://github.com/transistorsoft/flutter_background_geolocation), [Cordova](https://github.com/transistorsoft/cordova-background-geolocation-lt), [NativeScript](https://github.com/transistorsoft/nativescript-background-geolocation-lt) and pure native apps.
 
 ----------------------------------------------------------------------------
 
@@ -42,6 +42,13 @@ The **[Android module](http://www.transistorsoft.com/shop/products/react-native-
 
 ## :large_blue_diamond: Installing the Plugin
 
+### With `yarn`
+
+```bash
+yarn add react-native-background-geolocation
+```
+
+### With `npm`
 ```
 $ npm install react-native-background-geolocation --save
 ```
@@ -57,15 +64,6 @@ $ npm install react-native-background-geolocation --save
 * [`react-native link` Setup](help/INSTALL-ANDROID-RNPM.md)
 * [Manual Setup](help/INSTALL-ANDROID.md)
 
-#### :information_source: Solving Android Gradle Conflicts.
-
-Once of the most common build-issues with Android apps are gradle conflicts between modules specifying different versions of:
-- `compileSdkVersion`
-- `buildToolsVersion`
-- Google `play-services` / `firebase` version.
-- Google support libraries (ie `appcompat-v4`, `appcompat-v7`)
-
-For more information, see the Wiki [Solving Android Gradle Conflicts](../../wiki/Solving-Android-Gradle-Conflicts)
 
 ## :large_blue_diamond: Configure your license
 
@@ -119,7 +117,7 @@ import BackgroundGeolocation, {
   MotionChangeEvent,
   ProviderChangeEvent,
   ConnectivityChangeEvent
-} from "react-native-background-geolocation-android";
+} from "react-native-background-geolocation";
 
 ```
 

android/build.gradle

@@ -1,47 +1,53 @@
 apply plugin: 'com.android.library'
 
-def DEFAULT_COMPILE_SDK_VERSION     = 27
-def DEFAULT_BUILD_TOOLS_VERSION     = "27.0.3"
-def DEFAULT_TARGET_SDK_VERSION      = 27
-def DEFAULT_PLAY_SERVICES_VERSION   = "16.0.0"
+// Android dependencies
+def DEFAULT_COMPILE_SDK_VERSION                     = 28
+def DEFAULT_BUILD_TOOLS_VERSION                     = "28.0.3"
+def DEFAULT_TARGET_SDK_VERSION                      = 27
+def DEFAULT_SUPPORT_LIB_VERSION                     = "28.0.0"
+
+// Plugin dependencies
+def DEFAULT_GOOGLE_PLAY_SERVICES_LOCATION_VERSION   = "16.0.0"
+def DEFAULT_OK_HTTP_VERSION                         = "3.12.1"
+def DEFAULT_ANDROID_PERMISSIONS_VERSION             = "0.1.7"
+def DEFAULT_EVENTBUS_VERSION                        = "3.0.0"
+
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
 
 android {
-    compileSdkVersion rootProject.hasProperty('compileSdkVersion') ? rootProject.compileSdkVersion : DEFAULT_COMPILE_SDK_VERSION
-    buildToolsVersion rootProject.hasProperty('buildToolsVersion') ? rootProject.buildToolsVersion : DEFAULT_BUILD_TOOLS_VERSION
+    compileSdkVersion safeExtGet('compileSdkVersion', DEFAULT_COMPILE_SDK_VERSION)
+    buildToolsVersion safeExtGet('buildToolsVersion', DEFAULT_BUILD_TOOLS_VERSION)
 
     defaultConfig {
         minSdkVersion 16
-        targetSdkVersion rootProject.hasProperty('targetSdkVersion') ? rootProject.targetSdkVersion : DEFAULT_TARGET_SDK_VERSION
+        targetSdkVersion safeExtGet('targetSdkVersion', DEFAULT_TARGET_SDK_VERSION)
         versionCode 1
         versionName "1.0"
     }
 }
 
 repositories{
-    jcenter()
     maven {
         url './libs'
     }
-    maven {
-        url 'https://maven.google.com'
-    }
 }
 
 dependencies {
-    // Check for application-defined play-services version
-    def playServicesVersion = DEFAULT_PLAY_SERVICES_VERSION
-    if (rootProject.hasProperty('playServicesVersion')) {
-        playServicesVersion = rootProject.playServicesVersion
-    } else if (rootProject.hasProperty('googlePlayServicesVersion')) {
-        playServicesVersion = rootProject.googlePlayServicesVersion
-    }
-    compile 'com.facebook.react:react-native:+'
-    compile "com.google.android.gms:play-services-location:$playServicesVersion"
-    compile 'org.greenrobot:eventbus:3.0.0'
-    compile 'com.squareup.okhttp3:okhttp:3.10.0'
-    compile(group: 'com.transistorsoft', name:'tslocationmanager', version: '+')
-    compile 'org.slf4j:slf4j-api:1.7.21'
-    compile 'com.github.tony19:logback-android:1.1.1-9'
-    // android-permissions
-    compile 'com.intentfilter:android-permissions:0.1.6'
+    def supportLibVersion = safeExtGet('supportLibVersion', DEFAULT_SUPPORT_LIB_VERSION)
+    def playServicesLocationVersion = safeExtGet('googlePlayServicesLocationVersion', DEFAULT_GOOGLE_PLAY_SERVICES_LOCATION_VERSION)
+    def okHttpVersion = safeExtGet('okHttpVersion', DEFAULT_OK_HTTP_VERSION)
+    def androidPermissionsVersion = safeExtGet('androidPermissionsVersion', DEFAULT_ANDROID_PERMISSIONS_VERSION)
+    def eventBusVersion = safeExtGet('eventBusVersion', DEFAULT_EVENTBUS_VERSION)
+
+    compileOnly 'com.facebook.react:react-native:+'
+    implementation "com.android.support:appcompat-v7:$supportLibVersion"
+    implementation "com.google.android.gms:play-services-location:$playServicesLocationVersion"
+    implementation "org.greenrobot:eventbus:$eventBusVersion"
+    implementation "com.squareup.okhttp3:okhttp:$okHttpVersion"
+    implementation(group: 'com.transistorsoft', name:'tslocationmanager', version: '+')
+    implementation 'org.slf4j:slf4j-api:1.7.25'
+    implementation 'com.github.tony19:logback-android:1.3.0-2'
+    implementation "com.intentfilter:android-permissions:$androidPermissionsVersion"
 }

android/libs/com/transistorsoft/tslocationmanager/2.14.4/tslocationmanager-2.14.4.aar

@@ -0,0 +1 @@
+5554d19be6e53de92164fa38b1f107c1

android/libs/com/transistorsoft/tslocationmanager/2.14.4/tslocationmanager-2.14.4.aar.md5

@@ -0,0 +1 @@
+1d140525edd12b61985f7544167284ca179fff73

android/libs/com/transistorsoft/tslocationmanager/2.14.4/tslocationmanager-2.14.4.aar.sha1

@@ -4,6 +4,6 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
-  <version>2.14.4</version>
+  <version>3.0.0</version>
   <packaging>aar</packaging>
 </project>

android/libs/com/transistorsoft/tslocationmanager/2.14.4/tslocationmanager-2.14.4.pom.md5

@@ -0,0 +1 @@
+0118ce926df6a96c0ea8960becb9f846

android/libs/com/transistorsoft/tslocationmanager/2.14.4/tslocationmanager-2.14.4.pom.sha1

@@ -0,0 +1 @@
+13c34b6c1a6166f978ee0903f9fa36807a93b8f9

android/libs/com/transistorsoft/tslocationmanager/3.0.0/tslocationmanager-3.0.0.aar

@@ -3,10 +3,10 @@
   <groupId>com.transistorsoft</groupId>
   <artifactId>tslocationmanager</artifactId>
   <versioning>
-    <release>2.14.4</release>
+    <release>3.0.0</release>
     <versions>
-      <version>2.14.4</version>
+      <version>3.0.0</version>
     </versions>
-    <lastUpdated>20181120172613</lastUpdated>
+    <lastUpdated>20190227224055</lastUpdated>
   </versioning>
 </metadata>

android/libs/com/transistorsoft/tslocationmanager/3.0.0/tslocationmanager-3.0.0.aar.md5

@@ -2,6 +2,7 @@
 
 import android.content.Context;
 import android.os.Handler;
+import android.os.Looper;
 
 import com.facebook.react.ReactApplication;
 import com.facebook.react.ReactInstanceManager;
@@ -34,7 +35,6 @@ public class HeadlessTask {
     private static String HEADLESS_TASK_NAME = "BackgroundGeolocation";
     // Hard-coded time-limit for headless-tasks is 30000 @todo configurable?
     private static int TASK_TIMEOUT = 30000;
-    private static Handler mHandler = new Handler();
 
     private final List<Integer> mTasks = new ArrayList<>();
 
@@ -89,7 +89,7 @@ public void onHeadlessEvent(HeadlessEvent event) {
                 e.printStackTrace();
             }
         }
-        
+
         HeadlessJsTaskConfig config = new HeadlessJsTaskConfig(HEADLESS_TASK_NAME, clientEvent, TASK_TIMEOUT);
         try {
             startTask(event.getContext(), config);
@@ -116,7 +116,7 @@ private void startTask(Context context, final HeadlessJsTaskConfig taskConfig) t
             reactInstanceManager.addReactInstanceEventListener(new ReactInstanceManager.ReactInstanceEventListener() {
                 @Override public void onReactContextInitialized(final ReactContext reactContext) {
                     // Hack to fix unknown problem executing asynchronous BackgroundTask when ReactContext is created *first time*.  Fixed by adding short delay before #invokeStartTask
-                    mHandler.postDelayed(new Runnable() {
+                    new Handler(Looper.getMainLooper()).postDelayed(new Runnable() {
                         @Override
                         public void run() {
                             invoke(reactContext, taskConfig);

android/libs/com/transistorsoft/tslocationmanager/3.0.0/tslocationmanager-3.0.0.aar.sha1

@@ -2,9 +2,11 @@
 
 import android.Manifest;
 import android.app.Activity;
+import android.content.Context;
 import android.content.Intent;
 import android.telecom.Call;
 import android.util.Log;
+import android.os.Build;
 
 import com.facebook.react.bridge.ActivityEventListener;
 import com.facebook.react.bridge.Callback;
@@ -15,6 +17,7 @@
 import com.facebook.react.bridge.ReadableArray;
 import com.facebook.react.bridge.ReadableMap;
 import com.facebook.react.bridge.ReadableMapKeySetIterator;
+import com.facebook.react.bridge.ReadableNativeMap;
 import com.facebook.react.bridge.ReadableType;
 import com.facebook.react.bridge.WritableArray;
 import com.facebook.react.bridge.WritableMap;
@@ -43,9 +46,12 @@
 import com.transistorsoft.locationmanager.location.TSCurrentPositionRequest;
 import com.transistorsoft.locationmanager.location.TSLocation;
 import com.transistorsoft.locationmanager.location.TSWatchPositionRequest;
+import com.transistorsoft.locationmanager.scheduler.TSScheduleManager;
 import com.transistorsoft.locationmanager.scheduler.ScheduleEvent;
+import com.transistorsoft.locationmanager.event.TerminateEvent;
 import com.transistorsoft.locationmanager.util.Sensors;
 import com.transistorsoft.locationmanager.logger.TSLog;
+import com.transistorsoft.locationmanager.device.DeviceSettingsRequest;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -281,7 +287,11 @@ public void onHostResume() {
     }
     @Override
     public void onHostPause() {
-
+        Context context = getReactApplicationContext();
+        TSConfig config = TSConfig.getInstance(context);
+        if (config.getEnabled() && config.getEnableHeadless() && !config.getStopOnTerminate()) {
+            TSScheduleManager.getInstance(context).oneShot(TerminateEvent.ACTION, 10000);
+        }
     }
     @Override
     public void onHostDestroy() {
@@ -687,7 +697,7 @@ public void finish(Integer taskId) {
     }
 
     @ReactMethod
-    public void playSound( int soundId) {
+    public void playSound(String soundId) {
         getAdapter().startTone(soundId);
     }
 
@@ -737,6 +747,57 @@ public void isPowerSaveMode(Callback success, Callback error) {
         success.invoke(getAdapter().isPowerSaveMode());
     }
 
+    @ReactMethod
+    public void isIgnoringBatteryOptimizations(Callback success, Callback failure) {
+        boolean isIgnoring = getAdapter().isIgnoringBatteryOptimizations();
+        success.invoke(isIgnoring);
+    }
+
+    @ReactMethod
+    public void requestSettings(ReadableMap args, Callback success, Callback failure) throws JSONException {
+        String action = args.getString("action");
+        DeviceSettingsRequest request = getAdapter().requestSettings(action);
+
+        if (request != null) {
+            success.invoke(jsonToMap(request.toJson()));
+        } else {
+            failure.invoke("Failed to find " + action + " screen for device " + Build.MANUFACTURER + " " + Build.MODEL + "@" + Build.VERSION.RELEASE);
+        }
+    }
+
+    @ReactMethod
+    public void showSettings(ReadableMap args, Callback success, Callback failure) {
+        String action = args.getString("action");
+        boolean didShow = getAdapter().showSettings(action);
+        if (didShow) {
+            success.invoke();
+        } else {
+            failure.invoke("Failed to find " + action + " screen for device " + Build.MANUFACTURER + " " + Build.MODEL + "@" + Build.VERSION.RELEASE);
+        }
+    }
+
+    @ReactMethod
+    public void getProviderState(Callback success, Callback error) {
+        try {
+            success.invoke(jsonToMap(getAdapter().getProviderState().toJson()));
+        } catch (JSONException e) {
+            error.invoke(e.getMessage());
+        }
+    }
+
+    @ReactMethod
+    public void requestPermission(final Callback success, final Callback error) {
+        getAdapter().requestPermission(new TSRequestPermissionCallback() {
+            @Override public void onSuccess(int status) {
+                success.invoke(status);
+            }
+            @Override public void onFailure(int status) {
+                error.invoke(status);
+            }
+        });
+    }
+
+
     @ReactMethod
     public void addEventListener(String event) {
         if (!events.contains(event)) {
@@ -955,15 +1016,6 @@ public static JSONArray arrayToJson(ReadableArray readableArray) throws JSONExce
         return jsonArray;
     }
 
-    // TODO placehold for implementing Android M permissions request.  Just return true for now.
-    private Boolean hasPermission(String permission) {
-        return true;
-    }
-    // TODO placehold for implementing Android M permissions request.  Just return true for now.
-    private void requestPermissions(int requestCode, String[] action) {
-
-    }
-
     private void initializeLocationManager() {
         Activity activity = getCurrentActivity();
         if (activity == null) {