Merge pull request #886 from CleverTap/develop

Release Huawei 1.5.1

Author: Anush-Shand

CHANGELOG.md

@@ -1,4 +1,7 @@
 ## CHANGE LOG.
+### September 29, 2025
+* [CleverTap Huawei Push SDK v1.5.1](docs/CTHUAWEIPUSHCHANGELOG.md)
+
 ### September 11, 2025
 * [CleverTap Android SDK v7.5.2](docs/CTCORECHANGELOG.md)
 

clevertap-hms/src/main/java/com/clevertap/android/hms/HmsSdkHandler.java

@@ -7,7 +7,9 @@
 
 import android.content.Context;
 import android.text.TextUtils;
+
 import com.clevertap.android.sdk.CleverTapInstanceConfig;
+import com.huawei.agconnect.AGConnectInstance;
 import com.huawei.agconnect.AGConnectOptions;
 import com.huawei.agconnect.AGConnectOptionsBuilder;
 import com.huawei.hms.aaid.HmsInstanceId;
@@ -21,34 +23,60 @@
 class HmsSdkHandler implements IHmsSdkHandler {
 
     private final Context context;
-
     private final CleverTapInstanceConfig mConfig;
-
-    private final AGConnectOptions options ;
+    private volatile AGConnectOptions options;
 
     HmsSdkHandler(final Context context, final CleverTapInstanceConfig config) {
         this.context = context.getApplicationContext();
-        mConfig = config;
-        options = new AGConnectOptionsBuilder().build(context);
+        this.mConfig = config;
     }
 
     @TestOnly
-    HmsSdkHandler(final Context context, final CleverTapInstanceConfig config,final AGConnectOptions op) {
+    HmsSdkHandler(final Context context, final CleverTapInstanceConfig config, final AGConnectOptions op) {
         this.context = context.getApplicationContext();
         mConfig = config;
         options = op;
     }
 
+    private synchronized void initializeOptions() {
+        if (options != null) {
+            return;
+        }
+        try {
+            // Try existing AGConnect instance first
+            AGConnectInstance instance = AGConnectInstance.getInstance();
+            if (instance != null && instance.getOptions() != null) {
+                options = instance.getOptions();
+                return;
+            }
+        } catch (Exception e) {
+            mConfig.log(LOG_TAG, HMS_LOG_TAG + "Failed to initialize AGConnect options: " + e.getMessage());
+        }
+
+        // Fallback to building new options
+        try {
+            options = new AGConnectOptionsBuilder().build(context);
+        } catch (Exception e) {
+            mConfig.log(LOG_TAG, HMS_LOG_TAG + "Failed to build new AGConnect options: " + e.getMessage());
+        }
+    }
 
     @Override
     public String appId() {
-        String appId = null;
+        if (options == null) {
+            initializeOptions();
+        }
+
+        if (options == null) {
+            return null;
+        }
+
         try {
-            appId = options.getString(APP_ID_KEY);
+            return options.getString(APP_ID_KEY);
         } catch (Throwable t) {
-            mConfig.log(LOG_TAG, HMS_LOG_TAG + "HMS availability check failed.");
+            mConfig.log(LOG_TAG, HMS_LOG_TAG + "Failed to get HMS app ID: " + t.getMessage());
+            return null;
         }
-        return appId;
     }
 
     @Override

clevertap-hms/src/test/java/com/clevertap/android/hms/HmsHandlerTest.kt

@@ -1,21 +1,30 @@
 package com.clevertap.android.hms
 
+import com.clevertap.android.hms.HmsConstants.APP_ID_KEY
+import com.clevertap.android.hms.HmsConstants.HCM_SCOPE
 import com.clevertap.android.shared.test.BaseTestCase
 import com.clevertap.android.shared.test.TestApplication
+import com.huawei.agconnect.AGConnectInstance
 import com.huawei.agconnect.AGConnectOptions
 import com.huawei.agconnect.AGConnectOptionsBuilder
 import com.huawei.hms.aaid.HmsInstanceId
 import com.huawei.hms.api.HuaweiApiAvailability
 import io.mockk.every
 import io.mockk.mockk
+import io.mockk.mockkConstructor
 import io.mockk.mockkStatic
 import io.mockk.spyk
+import io.mockk.verify
 import org.junit.Assert
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.annotation.Config
+import kotlin.test.assertEquals
+import kotlin.test.assertFalse
+import kotlin.test.assertNull
+import kotlin.test.assertTrue
 
 @RunWith(RobolectricTestRunner::class)
 @Config(sdk = [28], application = TestApplication::class)
@@ -38,27 +47,27 @@ class HmsHandlerTest : BaseTestCase() {
 
     @Test
     fun testAppId_Invalid() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } throws RuntimeException("Something went wrong")
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } throws RuntimeException("Something went wrong")
         val appId = sdkHandler.appId()
         Assert.assertNull(appId)
     }
 
     @Test
     fun testAppId_Valid() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
         val appId = sdkHandler.appId()
         Assert.assertNotNull(appId)
     }
 
     @Test
     fun testIsAvailable_Returns_False() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } throws RuntimeException("Something Went Wrong")
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } throws RuntimeException("Something Went Wrong")
         Assert.assertFalse(sdkHandler.isAvailable)
     }
 
     @Test
     fun testIsAvailable_Returns_True() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
         Assert.assertTrue(sdkHandler.isAvailable)
     }
 
@@ -93,8 +102,8 @@ class HmsHandlerTest : BaseTestCase() {
 
     @Test
     fun testNewToken_Exception() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
-        every { instance.getToken(HmsTestConstants.HMS_APP_ID, HmsConstants.HCM_SCOPE) } throws
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
+        every { instance.getToken(HmsTestConstants.HMS_APP_ID, HCM_SCOPE) } throws
                 RuntimeException("Something went wrong")
         mockkStatic(HmsInstanceId::class) {
             every { HmsInstanceId.getInstance(application) } returns instance
@@ -103,20 +112,201 @@ class HmsHandlerTest : BaseTestCase() {
             }
     }
 
+    // Add these test cases to your existing HmsHandlerTest.kt file
+
+    @Test
+    fun `appId should initialize options when options is null and return app id from existing AGConnect instance`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+        val mockInstance = mockk<AGConnectInstance>()
+
+        mockkStatic(AGConnectInstance::class)
+        every { AGConnectInstance.getInstance() } returns mockInstance
+        every { mockInstance.options } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "test-app-id"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.appId()
+
+        // Assert
+        assertEquals("test-app-id", result)
+        verify { AGConnectInstance.getInstance() }
+        verify { mockInstance.options }
+    }
+
+    @Test
+    fun `appId should fallback to AGConnectOptionsBuilder when existing instance is null`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+
+        mockkStatic(AGConnectInstance::class)
+        mockkConstructor(AGConnectOptionsBuilder::class)
+
+        every { AGConnectInstance.getInstance() } returns null
+        every { anyConstructed<AGConnectOptionsBuilder>().build(application) } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "fallback-app-id"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.appId()
+
+        // Assert
+        assertEquals("fallback-app-id", result)
+        verify { AGConnectInstance.getInstance() }
+        verify { anyConstructed<AGConnectOptionsBuilder>().build(application) }
+    }
+
+    @Test
+    fun `appId should fallback to AGConnectOptionsBuilder when existing instance options is null`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+        val mockInstance = mockk<AGConnectInstance>()
+
+        mockkStatic(AGConnectInstance::class)
+        mockkConstructor(AGConnectOptionsBuilder::class)
+
+        every { AGConnectInstance.getInstance() } returns mockInstance
+        every { mockInstance.options } returns null
+        every { anyConstructed<AGConnectOptionsBuilder>().build(application) } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "builder-app-id"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.appId()
+
+        // Assert
+        assertEquals("builder-app-id", result)
+        verify { AGConnectInstance.getInstance() }
+        verify { mockInstance.options }
+        verify { anyConstructed<AGConnectOptionsBuilder>().build(application) }
+    }
+
+    @Test
+    fun `appId should handle exception during AGConnect instance retrieval and fallback to builder`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+
+        mockkStatic(AGConnectInstance::class)
+        mockkConstructor(AGConnectOptionsBuilder::class)
+
+        every { AGConnectInstance.getInstance() } throws RuntimeException("AGConnect not initialized")
+        every { anyConstructed<AGConnectOptionsBuilder>().build(application) } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "exception-recovery-app-id"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.appId()
+
+        // Assert
+        assertEquals("exception-recovery-app-id", result)
+    }
+
+    @Test
+    fun `appId should handle exception during AGConnectOptionsBuilder`() {
+        // Arrange
+        mockkStatic(AGConnectInstance::class)
+        mockkConstructor(AGConnectOptionsBuilder::class)
+
+        every { AGConnectInstance.getInstance() } returns null
+        every { anyConstructed<AGConnectOptionsBuilder>().build(application) } throws RuntimeException("Build failed")
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.appId()
+
+        // Assert
+        assertNull(result)
+    }
+
+    @Test
+    fun `isAvailable should trigger options initialization and return true when app id exists`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+        val mockInstance = mockk<AGConnectInstance>()
+
+        mockkStatic(AGConnectInstance::class)
+        every { AGConnectInstance.getInstance() } returns mockInstance
+        every { mockInstance.options } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "test-app-id"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.isAvailable()
+
+        // Assert
+        assertTrue(result)
+        verify { AGConnectInstance.getInstance() } // Confirms initialization was triggered
+    }
+
+    @Test
+    fun `isAvailable should trigger options initialization and return false when app id is empty`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+        val mockInstance = mockk<AGConnectInstance>()
+
+        mockkStatic(AGConnectInstance::class)
+        every { AGConnectInstance.getInstance() } returns mockInstance
+        every { mockInstance.options } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns ""
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.isAvailable()
+
+        // Assert
+        assertFalse(result)
+        verify { AGConnectInstance.getInstance() } // Confirms initialization was triggered
+    }
+
+    @Test
+    fun `onNewToken should trigger options initialization and use app id for token retrieval`() {
+        // Arrange
+        val mockOptions = mockk<AGConnectOptions>()
+        val mockInstance = mockk<AGConnectInstance>()
+        val mockHmsInstanceId = mockk<HmsInstanceId>()
+
+        mockkStatic(AGConnectInstance::class)
+        mockkStatic(HmsInstanceId::class)
+
+        every { AGConnectInstance.getInstance() } returns mockInstance
+        every { mockInstance.options } returns mockOptions
+        every { mockOptions.getString(APP_ID_KEY) } returns "token-app-id"
+        every { HmsInstanceId.getInstance(application) } returns mockHmsInstanceId
+        every { mockHmsInstanceId.getToken("token-app-id", HCM_SCOPE) } returns "test-token"
+
+        val handler = HmsSdkHandler(application, cleverTapInstanceConfig)
+
+        // Act
+        val result = handler.onNewToken()
+
+        // Assert
+        assertEquals("test-token", result)
+        verify { AGConnectInstance.getInstance() } // Confirms initialization was triggered
+        verify { mockHmsInstanceId.getToken("token-app-id", HCM_SCOPE) }
+    }
+
     @Test
     fun testNewToken_Invalid_AppId() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } returns null
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } returns null
         val token = sdkHandler.onNewToken()
         Assert.assertNull(token)
     }
 
     @Test
     fun testNewToken_Success() {
-        every { agConnectOptionsSpy.getString(HmsConstants.APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
+        every { agConnectOptionsSpy.getString(APP_ID_KEY) } returns HmsTestConstants.HMS_APP_ID
         every {
             instance.getToken(
                 HmsTestConstants.HMS_APP_ID,
-                HmsConstants.HCM_SCOPE
+                HCM_SCOPE
             )
         } returns HmsTestConstants.HMS_TOKEN
         mockkStatic(HmsInstanceId::class) {

docs/CTHUAWEIPUSH.md

@@ -52,7 +52,7 @@ allprojects {
 * Add the following to your app’s `build.gradle` file
 
 ```groovy
-implementation "com.clevertap.android:clevertap-hms-sdk:1.5.0"
+implementation "com.clevertap.android:clevertap-hms-sdk:1.5.1"
 implementation "com.huawei.hms:push:6.11.0.300"
 
 //At the bottom of the file add this

docs/CTHUAWEIPUSHCHANGELOG.md

@@ -1,5 +1,8 @@
 ## CleverTap Huawei Push SDK CHANGE LOG
 
+### Version 1.5.1 (September 26, 2025)
+* Adds support for custom initialization of `AGConnect` using `agconnect-services.json` from the assets folder.
+
 ### Version 1.5.0 (March 11, 2025)
 
 #### Breaking API Changes

gradle/libs.versions.toml

@@ -48,7 +48,7 @@ installreferrer = "2.2"
 clevertap_android_sdk = "7.5.2"
 clevertap_rendermax_sdk = "1.0.3"
 clevertap_geofence_sdk = "1.4.0"
-clevertap_hms_sdk = "1.5.0"
+clevertap_hms_sdk = "1.5.1"
 clevertap_push_templates_sdk = "2.1.0"
 
 # Glide