feat: [SDK-4728] support disabling OneSignal location module

README.md

@@ -31,6 +31,24 @@ If you run into any challenges or have concerns, please contact our support team
 
 See the [Setup Guide](https://documentation.onesignal.com/docs/react-native-sdk-setup) for setup instructions.
 
+#### Disable Location Module
+
+By default, `react-native-onesignal` includes OneSignal's native location module so `OneSignal.Location` works without extra setup. If your app does not use location features, you can exclude the native location module from iOS and Android builds.
+
+In your iOS `Podfile`, set this before React Native installs native modules:
+
+```ruby
+$OneSignalDisableLocation = true
+```
+
+In your Android `gradle.properties`, set:
+
+```properties
+OneSignal_disableLocation=true
+```
+
+When disabled, `OneSignal.Location.requestPermission()` and `OneSignal.Location.setShared()` no-op on native builds without the location module, and `OneSignal.Location.isShared()` resolves `false`.
+
 #### Change Log
 
 See this repository's [release tags](https://github.com/OneSignal/react-native-onesignal/releases) for a complete change log of every released version.

android/build.gradle

@@ -5,6 +5,18 @@ def safeExtGet(prop, fallback) {
     rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
 }
 
+def safePropGet(prop, fallback) {
+    if (rootProject.ext.has(prop)) {
+        return rootProject.ext.get(prop)
+    }
+
+    def value = rootProject.findProperty(prop)
+    return value != null ? value : fallback
+}
+
+def oneSignalVersion = '5.9.3'
+def oneSignalDisableLocation = safePropGet('OneSignal_disableLocation', false).toString().toBoolean()
+
 android {
     namespace "com.onesignal.rnonesignalandroid"
     compileSdkVersion safeExtGet('compileSdkVersion', 34)
@@ -33,8 +45,20 @@ dependencies {
     // Exclude OkHttp from OneSignal's transitive deps: the otel module pulls in OkHttp 5.x
     // (via opentelemetry-exporter-sender-okhttp) which is binary-incompatible with React Native's
     // networking stack (okhttp3.internal.Util removed in 5.x). React Native already provides OkHttp 4.x.
-    api('com.onesignal:OneSignal:5.9.3') {
-        exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+    if (oneSignalDisableLocation) {
+        api("com.onesignal:core:${oneSignalVersion}") {
+            exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+        }
+        api("com.onesignal:notifications:${oneSignalVersion}") {
+            exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+        }
+        api("com.onesignal:in-app-messages:${oneSignalVersion}") {
+            exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+        }
+    } else {
+        api("com.onesignal:OneSignal:${oneSignalVersion}") {
+            exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+        }
     }
 
     testImplementation 'junit:junit:4.12'

android/src/main/java/com/onesignal/rnonesignalandroid/RNOneSignal.java

@@ -79,6 +79,8 @@ public class RNOneSignal extends NativeOneSignalSpec
                 LifecycleEventListener,
                 INotificationLifecycleListener {
     public static final String NAME = "OneSignal";
+    private static final String LOCATION_MODULE_NOT_AVAILABLE =
+            "OneSignal location module is not available. Add the location dependency to use OneSignal.Location.";
 
     private boolean oneSignalInitDone;
     private boolean hasSetPermissionObserver = false;
@@ -166,6 +168,10 @@ private void logJSONException(String eventName, JSONException exception) {
         Logging.error("Failed to serialize payload for " + eventName, exception);
     }
 
+    private void logLocationModuleNotAvailable(Exception exception) {
+        Logging.error(LOCATION_MODULE_NOT_AVAILABLE, exception);
+    }
+
     private void removeObservers() {
         if (!oneSignalInitDone) {
             Logging.debug("OneSignal React-Native SDK not initialized yet. Could not remove observers.", null);
@@ -322,17 +328,30 @@ public void clearTriggers() {
 
     @Override
     public void requestLocationPermission() {
-        OneSignal.getLocation().requestPermission(Continue.none());
+        try {
+            OneSignal.getLocation().requestPermission(Continue.none());
+        } catch (Exception e) {
+            logLocationModuleNotAvailable(e);
+        }
     }
 
     @Override
     public void isLocationShared(Promise promise) {
-        promise.resolve(OneSignal.getLocation().isShared());
+        try {
+            promise.resolve(OneSignal.getLocation().isShared());
+        } catch (Exception e) {
+            logLocationModuleNotAvailable(e);
+            promise.resolve(false);
+        }
     }
 
     @Override
     public void setLocationShared(boolean shared) {
-        OneSignal.getLocation().setShared(shared);
+        try {
+            OneSignal.getLocation().setShared(shared);
+        } catch (Exception e) {
+            logLocationModuleNotAvailable(e);
+        }
     }
 
     @Override

examples/demo-no-location/.env.example

@@ -0,0 +1 @@
+ONESIGNAL_APP_ID=your-onesignal-app-id

examples/demo-no-location/.gitignore

@@ -0,0 +1,79 @@
+# Environment
+.env
+.rn-demo-env.stamp
+
+# OSX
+#
+.DS_Store
+
+# Xcode
+#
+build/
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata
+*.xccheckout
+*.moved-aside
+DerivedData
+*.hmap
+*.ipa
+*.xcuserstate
+**/.xcode.env.local
+
+# Android/IntelliJ
+#
+build/
+.idea
+.gradle
+local.properties
+*.iml
+*.hprof
+.cxx/
+*.keystore
+!debug.keystore
+.kotlin/
+
+# node.js
+#
+node_modules/
+npm-debug.log
+yarn-error.log
+
+# fastlane
+#
+# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
+# screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/
+
+**/fastlane/report.xml
+**/fastlane/Preview.html
+**/fastlane/screenshots
+**/fastlane/test_output
+
+# Bundle artifact
+*.jsbundle
+
+# Ruby / CocoaPods
+**/Pods/
+/vendor/bundle/
+
+# Temporary files created by Metro to check the health of the file watcher
+.metro-health-check*
+
+# testing
+/coverage
+
+# Yarn
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

examples/demo-no-location/.watchmanconfig

@@ -0,0 +1 @@
+{}