feat: improve error message on invalid site-key

hCaptcha · Jul 3, 2024 · 9853372 · 9853372
1 parent efd18b2
commit 9853372
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/sdk/src/main/java/com/hcaptcha/sdk/HCaptchaConfig.java b/sdk/src/main/java/com/hcaptcha/sdk/HCaptchaConfig.java
@@ -181,5 +181,15 @@ public HCaptchaConfigBuilder apiEndpoint(String url) { //NOSONAR
             this.jsSrc(url);
             return this;
         }
+
+        public HCaptchaConfigBuilder siteKey(@NonNull String siteKey) {
+            try {
+                java.util.UUID.fromString(siteKey);
+                this.siteKey = siteKey;
+            } catch (IllegalArgumentException e) {
+                throw new IllegalArgumentException("hCaptcha site-key must be a valid UUID", e);
+            }
+            return this;
+        }
     }
 }
diff --git a/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaConfigTest.java b/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaConfigTest.java
@@ -13,7 +13,7 @@
 
 public class HCaptchaConfigTest {
 
-    public static final String MOCK_SITE_KEY = "mocked-site-key";
+    public static final String MOCK_SITE_KEY = "00000000-0000-0000-0000-000000000000";
 
     @Test
     public void custom_locale() {
@@ -90,4 +90,8 @@ public void serialization() throws Exception {
                 deserializedObject.toBuilder().retryPredicate(null).build());
     }
 
+    @Test(expected = IllegalArgumentException.class)
+    public void invalid_site_key() {
+        HCaptchaConfig.builder().siteKey("invalid-uuid-site-key").build();
+    }
 }
diff --git a/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaJSInterfaceTest.java b/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaJSInterfaceTest.java
@@ -36,7 +36,7 @@ public class HCaptchaJSInterfaceTest {
     @Captor
     ArgumentCaptor<HCaptchaException> exceptionCaptor;
 
-    HCaptchaConfig testConfig = HCaptchaConfig.builder().siteKey("0000-1111-2222-3333").build();
+    HCaptchaConfig testConfig = HCaptchaConfig.builder().siteKey(HCaptchaConfigTest.MOCK_SITE_KEY).build();
 
     @Before
     public void init() {
@@ -48,7 +48,7 @@ public void init() {
 
     @Test
     public void full_config_serialization() throws JSONException {
-        final String siteKey = "0000-1111-2222-3333";
+        final String siteKey = HCaptchaConfigTest.MOCK_SITE_KEY;
         final String locale = "ro";
         final HCaptchaOrientation orientation = HCaptchaOrientation.PORTRAIT;
         final HCaptchaSize size = HCaptchaSize.NORMAL;
@@ -108,7 +108,7 @@ public void full_config_serialization() throws JSONException {
 
     @Test
     public void subset_config_serialization() throws JSONException {
-        final String siteKey = "0000-1111-2222-3333";
+        final String siteKey = HCaptchaConfigTest.MOCK_SITE_KEY;
         final String locale = "ro";
         final HCaptchaSize size = HCaptchaSize.NORMAL;
         final HCaptchaOrientation orientation = HCaptchaOrientation.LANDSCAPE;

diff --git a/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaTest.java b/sdk/src/test/java/com/hcaptcha/sdk/HCaptchaTest.java
@@ -37,6 +37,7 @@
 import org.mockito.junit.MockitoJUnitRunner;
 
 import java.util.Locale;
+import java.util.UUID;
 
 
 @RunWith(MockitoJUnitRunner.class)
@@ -201,7 +202,7 @@ public void test_setup_config() throws Exception {
     @Test
     public void test_verify_config_has_priority_over_setup_config() throws Exception {
         final HCaptchaConfig verifyConfig = HCaptchaConfig.builder()
-                .siteKey(HCaptchaConfigTest.MOCK_SITE_KEY + "-on-verify")
+                .siteKey(HCaptchaConfigTest.MOCK_SITE_KEY)
                 .size(HCaptchaSize.INVISIBLE)
                 .loading(false)
                 .build();
@@ -222,7 +223,7 @@ public void test_verify_config_has_priority_over_setup_config() throws Exception
 
     @Test
     public void test_verify_site_key_has_priority_over_setup_config() throws Exception {
-        final String siteKey = HCaptchaConfigTest.MOCK_SITE_KEY + "-on-verify";
+        final String siteKey = UUID.randomUUID().toString();
         HCaptcha.getClient(fragmentActivity)
                 .setup(config)
                 .verifyWithHCaptcha(siteKey);