Merge branch 'master' into bugfix/MOB-6575-Android-crash-on-press-push-notification

evantk91 · web-flow · commit 7a2049c3eb3b · 2025-01-23T09:07:38.000-07:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,28 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.5.10]
+
+### Added
+- Added `mobileFrameworkInfo` configuration option to `IterableConfig` to identify the mobile framework (Flutter, React Native, or Native) being used with the SDK.
+- Support for push notifications with text input. Pending intent is now mutable when buttons are of text input type.
+
+## [3.5.9]
+
+### Fixed
+- Fixed notification tracking bug that prevents SDK from receiving push notifications when system notification settings are turned off.
+
+## [3.5.8]
+
+### Fixed
+- Fixed logic issue where notifications were being disabled even when auto push registration was turned off
+
+## [3.5.7]
+
+### Added
+- Support for JSON-only in-app messages, JSON-only messages are now handled by the `onNewInApp` handler and consumed after retrieval
+- Enhanced notification state tracking to align with system notification permissions changes
+
 ## [3.5.6]
 
 #### Fixed
diff --git a/iterableapi-ui/build.gradle b/iterableapi-ui/build.gradle
@@ -51,7 +51,7 @@ dependencies {
 
 ext {
     libraryName = 'iterableapi-ui'
-    libraryVersion = '3.5.6'
+    libraryVersion = '3.5.10'
 }
 
 if (hasProperty("mavenPublishEnabled")) {
diff --git a/iterableapi/build.gradle b/iterableapi/build.gradle
@@ -19,7 +19,7 @@ android {
         minSdkVersion 16
         targetSdkVersion 31
 
-        buildConfigField "String", "ITERABLE_SDK_VERSION", "\"3.5.6\""
+        buildConfigField "String", "ITERABLE_SDK_VERSION", "\"3.5.10\""
 
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
@@ -85,7 +85,7 @@ dependencies {
 
 ext {
     libraryName = 'iterableapi'
-    libraryVersion = '3.5.6'
+    libraryVersion = '3.5.10'
 }
 
 if (hasProperty("mavenPublishEnabled")) {
@@ -119,4 +119,4 @@ afterEvaluate {
     javadoc.classpath += files(android.libraryVariants.collect { variant -> variant.javaCompile.classpath.files })
     javadoc.classpath += files(android.libraryVariants.collect { variant -> "build/generated/source/r/${variant.flavorName}/${variant.buildType.name}" })
     javadoc.classpath += files(android.libraryVariants.collect { variant -> "build/generated/source/buildConfig/${variant.flavorName}/${variant.buildType.name}" })
-}
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableAPIMobileFrameworkInfo.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableAPIMobileFrameworkInfo.java
@@ -0,0 +1,24 @@
+package com.iterable.iterableapi;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class IterableAPIMobileFrameworkInfo {
+    @NonNull private final IterableAPIMobileFrameworkType frameworkType;
+    @Nullable private final String iterableSdkVersion;
+
+    public IterableAPIMobileFrameworkInfo(@NonNull IterableAPIMobileFrameworkType frameworkType, @Nullable String iterableSdkVersion) {
+        this.frameworkType = frameworkType;
+        this.iterableSdkVersion = iterableSdkVersion;
+    }
+
+    @NonNull
+    public IterableAPIMobileFrameworkType getFrameworkType() {
+        return frameworkType;
+    }
+
+    @Nullable
+    public String getIterableSdkVersion() {
+        return iterableSdkVersion;
+    }
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableAPIMobileFrameworkType.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableAPIMobileFrameworkType.java
@@ -0,0 +1,17 @@
+package com.iterable.iterableapi;
+
+public enum IterableAPIMobileFrameworkType {
+    FLUTTER("flutter"),
+    REACT_NATIVE("reactnative"),
+    NATIVE("native");
+
+    private final String value;
+
+    IterableAPIMobileFrameworkType(String value) {
+        this.value = value;
+    }
+
+    public String getValue() {
+        return value;
+    }
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableApi.java
@@ -410,12 +410,8 @@ private void onForeground() {
         boolean isNotificationEnabled = sharedPref.getBoolean(IterableConstants.SHARED_PREFS_DEVICE_NOTIFICATIONS_ENABLED, false);
 
         if (sharedInstance.isInitialized()) {
-            if (hasStoredPermission && (isNotificationEnabled != systemNotificationEnabled)) {
-                if (!systemNotificationEnabled) {
-                    sharedInstance.disablePush();
-                } else {
-                    sharedInstance.registerForPush();
-                }
+            if (sharedInstance.config.autoPushRegistration && hasStoredPermission && (isNotificationEnabled != systemNotificationEnabled)) {
+                sharedInstance.registerForPush();
             }
 
             SharedPreferences.Editor editor = sharedPref.edit();
@@ -645,7 +641,7 @@ public static void initialize(@NonNull Context context, @NonNull String apiKey,
             try {
                 JSONObject dataFields = new JSONObject();
                 JSONObject deviceDetails = new JSONObject();
-                DeviceInfoUtils.populateDeviceDetails(deviceDetails, context, sharedInstance.getDeviceId());
+                DeviceInfoUtils.populateDeviceDetails(deviceDetails, context, sharedInstance.getDeviceId(), null);
                 dataFields.put(IterableConstants.KEY_FIRETV, deviceDetails);
                 sharedInstance.apiClient.updateUser(dataFields, false);
             } catch (JSONException e) {
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableApiClient.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableApiClient.java
@@ -556,7 +556,21 @@ protected void registerDeviceToken(@Nullable String email, @Nullable String user
 
             dataFields.put(IterableConstants.FIREBASE_TOKEN_TYPE, IterableConstants.MESSAGING_PLATFORM_FIREBASE);
             dataFields.put(IterableConstants.FIREBASE_COMPATIBLE, true);
-            DeviceInfoUtils.populateDeviceDetails(dataFields, context, authProvider.getDeviceId());
+
+            IterableAPIMobileFrameworkInfo frameworkInfo = IterableApi.sharedInstance.config.mobileFrameworkInfo;
+            if (frameworkInfo == null) {
+                IterableAPIMobileFrameworkType detectedFramework = IterableMobileFrameworkDetector.detectFramework(context);
+                String sdkVersion = detectedFramework == IterableAPIMobileFrameworkType.NATIVE
+                    ? IterableConstants.ITBL_KEY_SDK_VERSION_NUMBER
+                    : null;
+
+                frameworkInfo = new IterableAPIMobileFrameworkInfo(
+                    detectedFramework,
+                    sdkVersion
+                );
+            }
+
+            DeviceInfoUtils.populateDeviceDetails(dataFields, context, authProvider.getDeviceId(), frameworkInfo);
             dataFields.put(IterableConstants.DEVICE_NOTIFICATIONS_ENABLED, NotificationManagerCompat.from(context).areNotificationsEnabled());
 
             JSONObject device = new JSONObject();
@@ -684,4 +698,4 @@ void onLogout() {
         getRequestProcessor().onLogout(authProvider.getContext());
         authProvider.resetAuth();
     }
-}
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableConfig.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableConfig.java
@@ -1,6 +1,7 @@
 package com.iterable.iterableapi;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 import android.util.Log;
 
 /**
@@ -86,6 +87,7 @@ public class IterableConfig {
      * By default, the SDK will save in-apps to disk.
      */
     final boolean useInMemoryStorageForInApps;
+
     /**
      * Allows for fetching embedded messages.
      */
@@ -97,6 +99,12 @@ public class IterableConfig {
      */
     final IterableDecryptionFailureHandler decryptionFailureHandler;
 
+    /**
+     * Mobile framework information for the app
+     */
+    @Nullable
+    final IterableAPIMobileFrameworkInfo mobileFrameworkInfo;
+
     private IterableConfig(Builder builder) {
         pushIntegrationName = builder.pushIntegrationName;
         urlHandler = builder.urlHandler;
@@ -114,6 +122,7 @@ private IterableConfig(Builder builder) {
         useInMemoryStorageForInApps = builder.useInMemoryStorageForInApps;
         enableEmbeddedMessaging = builder.enableEmbeddedMessaging;
         decryptionFailureHandler = builder.decryptionFailureHandler;
+        mobileFrameworkInfo = builder.mobileFrameworkInfo;
     }
 
     public static class Builder {
@@ -133,6 +142,7 @@ public static class Builder {
         private boolean useInMemoryStorageForInApps = false;
         private boolean enableEmbeddedMessaging = false;
         private IterableDecryptionFailureHandler decryptionFailureHandler;
+        private IterableAPIMobileFrameworkInfo mobileFrameworkInfo;
 
         public Builder() {}
 
@@ -304,6 +314,16 @@ public Builder setDecryptionFailureHandler(@NonNull IterableDecryptionFailureHan
             return this;
         }
 
+        /**
+         * Set mobile framework information for the app
+         * @param mobileFrameworkInfo Mobile framework information
+         */
+        @NonNull
+        public Builder setMobileFrameworkInfo(@NonNull IterableAPIMobileFrameworkInfo mobileFrameworkInfo) {
+            this.mobileFrameworkInfo = mobileFrameworkInfo;
+            return this;
+        }
+
         @NonNull
         public IterableConfig build() {
             return new IterableConfig(this);
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java
@@ -144,6 +144,8 @@ public final class IterableConstants {
     public static final String DEVICE_APP_BUILD            = "appBuild";
     public static final String DEVICE_NOTIFICATIONS_ENABLED = "notificationsEnabled";
     public static final String DEVICE_ITERABLE_SDK_VERSION = "iterableSdkVersion";
+    public static final String DEVICE_MOBILE_FRAMEWORK_INFO = "mobileFrameworkInfo";
+    public static final String DEVICE_FRAMEWORK_TYPE       = "frameworkType";
 
     public static final String INSTANCE_ID_CLASS        = "com.google.android.gms.iid.InstanceID";
     public static final String ICON_FOLDER_IDENTIFIER   = "drawable";
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableMobileFrameworkDetector.kt b/iterableapi/src/main/java/com/iterable/iterableapi/IterableMobileFrameworkDetector.kt
@@ -0,0 +1,120 @@
+package com.iterable.iterableapi
+
+import android.content.Context
+import android.content.pm.PackageManager
+
+object IterableMobileFrameworkDetector {
+    private const val TAG = "FrameworkDetector"
+    private lateinit var context: Context
+
+    @Volatile
+    private var cachedFrameworkType: IterableAPIMobileFrameworkType? = null
+
+    private var hasClass: (String) -> Boolean = { className ->
+        try {
+            Class.forName(className)
+            true
+        } catch (e: ClassNotFoundException) {
+            false
+        }
+    }
+
+    fun initialize(context: Context) {
+        if (context.applicationContext != null) {
+            this.context = context.applicationContext
+        } else {
+            this.context = context
+        }
+        if (cachedFrameworkType == null) {
+            cachedFrameworkType = detectFrameworkInternal(context)
+        }
+    }
+
+    @JvmStatic
+    fun detectFramework(context: Context): IterableAPIMobileFrameworkType {
+        return cachedFrameworkType ?: synchronized(this) {
+            cachedFrameworkType ?: detectFrameworkInternal(context).also { 
+                cachedFrameworkType = it 
+            }
+        }
+    }
+
+    fun frameworkType(): IterableAPIMobileFrameworkType {
+        return cachedFrameworkType ?: detectFramework(context)
+    }
+
+    private fun detectFrameworkInternal(context: Context): IterableAPIMobileFrameworkType {
+        val hasFlutter = hasFrameworkClasses(FrameworkClasses.flutter)
+        val hasReactNative = hasFrameworkClasses(FrameworkClasses.reactNative)
+
+        return when {
+            hasFlutter && hasReactNative -> {
+                IterableLogger.d(TAG, "Both Flutter and React Native frameworks detected. This is unexpected.")
+                when {
+                    context.packageName.endsWith(".flutter") -> IterableAPIMobileFrameworkType.FLUTTER
+                    hasManifestMetadata(context, ManifestMetadata.flutter) -> IterableAPIMobileFrameworkType.FLUTTER
+                    hasManifestMetadata(context, ManifestMetadata.reactNative) -> IterableAPIMobileFrameworkType.REACT_NATIVE
+                    else -> IterableAPIMobileFrameworkType.REACT_NATIVE
+                }
+            }
+            hasFlutter -> IterableAPIMobileFrameworkType.FLUTTER
+            hasReactNative -> IterableAPIMobileFrameworkType.REACT_NATIVE
+            else -> {
+                when {
+                    hasManifestMetadata(context, ManifestMetadata.flutter) -> IterableAPIMobileFrameworkType.FLUTTER
+                    hasManifestMetadata(context, ManifestMetadata.reactNative) -> IterableAPIMobileFrameworkType.REACT_NATIVE
+                    else -> IterableAPIMobileFrameworkType.NATIVE
+                }
+            }
+        }
+    }
+
+    private object FrameworkClasses {
+        val flutter = listOf(
+            "io.flutter.embedding.engine.FlutterEngine",
+            "io.flutter.plugin.common.MethodChannel",
+            "io.flutter.embedding.android.FlutterActivity",
+            "io.flutter.embedding.android.FlutterFragment"
+        )
+
+        val reactNative = listOf(
+            "com.facebook.react.ReactRootView",
+            "com.facebook.react.bridge.ReactApplicationContext",
+            "com.facebook.react.ReactActivity",
+            "com.facebook.react.ReactApplication",
+            "com.facebook.react.bridge.ReactContext"
+        )
+    }
+
+    private object ManifestMetadata {
+        val flutter = listOf(
+            "flutterEmbedding",
+            "io.flutter.embedding.android.NormalTheme",
+            "io.flutter.embedding.android.SplashScreenDrawable"
+        )
+        
+        val reactNative = listOf(
+            "react_native_version",
+            "expo.modules.updates.ENABLED",
+            "com.facebook.react.selected.ReactActivity"
+        )
+    }
+
+    private fun hasFrameworkClasses(classNames: List<String>): Boolean {
+        return classNames.any { hasClass(it) }
+    }
+
+    private fun hasManifestMetadata(context: Context, metadataKeys: List<String>): Boolean {
+        return try {
+            val packageInfo = context.packageManager.getPackageInfo(
+                context.packageName,
+                PackageManager.GET_META_DATA
+            )
+            val metadata = packageInfo.applicationInfo.metaData
+            metadataKeys.any { key -> metadata?.containsKey(key) == true }
+        } catch (e: Exception) {
+            IterableLogger.e(TAG, "Error checking manifest metadata: ${e.message}")
+            false
+        }
+    }
+}
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationBuilder.java b/iterableapi/src/main/java/com/iterable/iterableapi/IterableNotificationBuilder.java
@@ -129,17 +129,21 @@ private PendingIntent getPendingIntent(Context context, IterableNotificationData
         buttonIntent.putExtra(IterableConstants.ITERABLE_DATA_ACTION_IDENTIFIER, button.identifier);
         buttonIntent.putExtra(IterableConstants.ACTION_IDENTIFIER, button.identifier);
 
+        int pendingIntentFlag = button.buttonType.equals(IterableNotificationData.Button.BUTTON_TYPE_TEXT_INPUT) ?
+                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_MUTABLE :
+                PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE;
+
         if (button.openApp) {
             IterableLogger.d(TAG, "Go through TrampolineActivity");
             buttonIntent.setClass(context, IterableTrampolineActivity.class);
             buttonIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_CLEAR_TASK);
             pendingButtonIntent = PendingIntent.getActivity(context, buttonIntent.hashCode(),
-                    buttonIntent, PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE);
+                    buttonIntent, pendingIntentFlag);
         } else {
             IterableLogger.d(TAG, "Go through IterablePushActionReceiver");
             buttonIntent.setClass(context, IterablePushActionReceiver.class);
             pendingButtonIntent = PendingIntent.getBroadcast(context, buttonIntent.hashCode(),
-                    buttonIntent, PendingIntent.FLAG_UPDATE_CURRENT | PendingIntent.FLAG_IMMUTABLE);
+                    buttonIntent, pendingIntentFlag);
         }
 
         return pendingButtonIntent;
diff --git a/iterableapi/src/main/java/com/iterable/iterableapi/util/DeviceInfoUtils.java b/iterableapi/src/main/java/com/iterable/iterableapi/util/DeviceInfoUtils.java
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableApiTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableApiTest.java
diff --git a/iterableapi/src/test/java/com/iterable/iterableapi/IterableNotificationTest.java b/iterableapi/src/test/java/com/iterable/iterableapi/IterableNotificationTest.java
diff --git a/sample-apps/inbox-customization/app/build.gradle b/sample-apps/inbox-customization/app/build.gradle
diff --git a/sample-apps/inbox-customization/build.gradle b/sample-apps/inbox-customization/build.gradle

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ dependencies {`
`51`	`51`
`52`	`52`	`ext {`
`53`	`53`	`libraryName = 'iterableapi-ui'`
`54`		`- libraryVersion = '3.5.6'`
	`54`	`+ libraryVersion = '3.5.10'`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`if (hasProperty("mavenPublishEnabled")) {`