Move empty API key handling to core SDK

Author: marandaneto

posthog-android/src/main/java/com/posthog/android/PostHogAndroid.kt

@@ -48,11 +48,6 @@ public class PostHogAndroid private constructor() {
             config: T,
         ) {
             synchronized(lock) {
-                if (config.apiKey.isEmpty()) {
-                    PostHog.setup(config)
-                    return
-                }
-
                 setAndroidConfig(context.appContext(), config)
 
                 PostHog.setup(config)
@@ -75,10 +70,6 @@ public class PostHogAndroid private constructor() {
             context: Context,
             config: T,
         ): PostHogInterface {
-            if (config.apiKey.isEmpty()) {
-                return PostHog.with(config)
-            }
-
             setAndroidConfig(context.appContext(), config)
             return PostHog.with(config)
         }

posthog-android/src/main/java/com/posthog/android/PostHogAndroidConfig.kt

@@ -16,7 +16,7 @@ import com.posthog.internal.PostHogQueue
 public open class PostHogAndroidConfig
     @JvmOverloads
     constructor(
-        apiKey: String?,
+        apiKey: String,
         host: String = DEFAULT_HOST,
         public var captureApplicationLifecycleEvents: Boolean = true,
         public var captureDeepLinks: Boolean = true,

posthog-android/src/test/java/com/posthog/android/PostHogAndroidConfigJavaTest.java

@@ -6,9 +6,9 @@
 
 public class PostHogAndroidConfigJavaTest {
     @Test
-    public void nullApiKeyFromJavaDefaultsToEmptyString() {
-        PostHogAndroidConfig config = new PostHogAndroidConfig(null);
+    public void apiKeyFromJavaIsTrimmed() {
+        PostHogAndroidConfig config = new PostHogAndroidConfig(" \n" + UtilsKt.API_KEY + "\t ");
 
-        assertEquals("", config.getApiKey());
+        assertEquals(UtilsKt.API_KEY, config.getApiKey());
     }
 }

posthog-android/src/test/java/com/posthog/android/PostHogAndroidConfigTest.kt

@@ -13,10 +13,10 @@ internal class PostHogAndroidConfigTest {
     }
 
     @Test
-    fun `defaults null api key to empty string`() {
-        val config = PostHogAndroidConfig(null)
+    fun `trims whitespace-sensitive config values`() {
+        val config = PostHogAndroidConfig(" \n$API_KEY\t ")
 
-        assertEquals("", config.apiKey)
+        assertEquals(API_KEY, config.apiKey)
     }
 
     @Test

posthog-android/src/test/java/com/posthog/android/PostHogAndroidTest.kt

@@ -10,6 +10,7 @@ import com.posthog.android.internal.PostHogAndroidNetworkStatus
 import com.posthog.android.internal.PostHogAppInstallIntegration
 import com.posthog.android.internal.PostHogLifecycleObserverIntegration
 import com.posthog.android.internal.PostHogSharedPreferences
+import com.posthog.internal.PostHogLogger
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
 import org.junit.runner.RunWith
@@ -40,23 +41,18 @@ internal class PostHogAndroidTest {
     }
 
     @Test
-    fun `setup no-ops for null api key`() {
-        val config = PostHogAndroidConfig(null)
-
-        PostHogAndroid.setup(context, config)
-
-        assertNull(config.cachePreferences)
-        assertTrue(config.integrations.isEmpty())
-    }
-
-    @Test
-    fun `setup no-ops for empty trimmed api key`() {
+    fun `setup configures Android then core disables SDK for empty trimmed api key`() {
         val config = PostHogAndroidConfig(" \n\t ")
+        val logger = TestLogger()
+        config.logger = logger
+
+        mockContextAppStart(context, tmpDir)
 
         PostHogAndroid.setup(context, config)
 
-        assertNull(config.cachePreferences)
-        assertTrue(config.integrations.isEmpty())
+        assertTrue(config.cachePreferences is PostHogSharedPreferences)
+        assertTrue(config.integrations.isNotEmpty())
+        assertTrue(logger.messages.any { it.contains("PostHog SDK is disabled because the API key is required") })
     }
 
     @Test
@@ -237,4 +233,14 @@ internal class PostHogAndroidTest {
 
         postHog.close()
     }
+
+    private class TestLogger : PostHogLogger {
+        val messages = mutableListOf<String>()
+
+        override fun log(message: String) {
+            messages.add(message)
+        }
+
+        override fun isEnabled(): Boolean = true
+    }
 }

posthog/src/main/java/com/posthog/PostHog.kt

@@ -100,7 +100,7 @@ public class PostHog private constructor(
                     if (config.logger is PostHogNoOpLogger) PostHogPrintLogger(config) else config.logger
 
                 if (config.apiKey.isEmpty()) {
-                    config.logger.log("apiKey is empty after trimming whitespace; check your project API key")
+                    config.logger.log("PostHog SDK is disabled because the API key is required and was empty after trimming whitespace.")
                     return
                 }
 

posthog/src/main/java/com/posthog/PostHogConfig.kt

@@ -31,7 +31,7 @@ public open class PostHogConfig(
     /**
      * The PostHog API Key
      */
-    apiKey: String?,
+    apiKey: String,
     /**
      * The PostHog Host
      * Defaults to https://us.i.posthog.com
@@ -328,7 +328,7 @@ public open class PostHogConfig(
     /**
      * The PostHog API Key
      */
-    public val apiKey: String = apiKey?.trim().orEmpty()
+    public val apiKey: String = apiKey.trim()
 
     /**
      * The PostHog Host

posthog/src/main/java/com/posthog/PostHogStateless.kt

@@ -54,7 +54,7 @@ public open class PostHogStateless protected constructor(
                     if (config.logger is PostHogNoOpLogger) PostHogPrintLogger(config) else config.logger
 
                 if (config.apiKey.isEmpty()) {
-                    config.logger.log("apiKey is empty after trimming whitespace; check your project API key")
+                    config.logger.log("PostHog SDK is disabled because the API key is required and was empty after trimming whitespace.")
                     return
                 }
 

posthog/src/test/java/com/posthog/PostHogConfigTest.kt

@@ -23,13 +23,6 @@ internal class PostHogConfigTest {
         assertEquals("https://eu.i.posthog.com/", config.host)
     }
 
-    @Test
-    fun `defaults null api key to empty string`() {
-        val config = PostHogConfig(null, "https://api.posthog.com")
-
-        assertEquals("", config.apiKey)
-    }
-
     @Test
     fun `defaults a blank host after trimming whitespace`() {
         val config = PostHogConfig(API_KEY, " \n\t ")

posthog/src/test/java/com/posthog/PostHogStatelessTest.kt

@@ -245,7 +245,7 @@ internal class PostHogStatelessTest {
         sut.setup(config)
 
         assertFalse(sut.isEnabledPublic())
-        assertTrue(mockLogger.messages.any { it.contains("apiKey is empty after trimming whitespace") })
+        assertTrue(mockLogger.messages.any { it.contains("PostHog SDK is disabled because the API key is required") })
     }
 
     @Test