Merge pull request #103 from Iterable/chore/MOB-381-support-itbl-custom-actions

[MOB-381] Reserve iterable:// URLs for SDK-defined actions, route itbl:// to custom action handler for compatibility

Author: vbabenkoru

iterableapi/src/main/java/com/iterable/iterableapi/IterableConstants.java

@@ -178,6 +178,7 @@ public final class IterableConstants {
 
     // URL schemes
     public static final String URL_SCHEME_ITBL = "itbl://";
+    public static final String URL_SCHEME_ITERABLE = "iterable://";
     public static final String URL_SCHEME_ACTION = "action://";
 
     public static final String ITBL_KEY_SDK_VERSION = "SDKVersion";

iterableapi/src/main/java/com/iterable/iterableapi/IterableInAppManager.java

@@ -141,8 +141,13 @@ public void execute(Uri url) {
                         String actionName = urlString.replace(IterableConstants.URL_SCHEME_ACTION, "");
                         IterableActionRunner.executeAction(context, IterableAction.actionCustomAction(actionName), IterableActionSource.IN_APP);
                     } else if (urlString.startsWith(IterableConstants.URL_SCHEME_ITBL)) {
-                        // Handle itbl:// URLs
-                        handleIterableCustomAction(urlString.replace(IterableConstants.URL_SCHEME_ITBL, ""), message);
+                        // Handle itbl:// URLs, pass that to the custom action handler for compatibility
+                        String actionName = urlString.replace(IterableConstants.URL_SCHEME_ITBL, "");
+                        IterableActionRunner.executeAction(context, IterableAction.actionCustomAction(actionName), IterableActionSource.IN_APP);
+                    } else if (urlString.startsWith(IterableConstants.URL_SCHEME_ITERABLE)) {
+                        // Handle iterable:// URLs - reserved for actions defined by the SDK only
+                        String actionName = urlString.replace(IterableConstants.URL_SCHEME_ITERABLE, "");
+                        handleIterableCustomAction(actionName, message);
                     } else {
                         IterableActionRunner.executeAction(context, IterableAction.actionOpenUrl(urlString), IterableActionSource.IN_APP);
                     }

iterableapi/src/test/java/com/iterable/iterableapi/IterableInAppManagerTest.java

@@ -216,6 +216,16 @@ public IterableConfig.Builder run(IterableConfig.Builder builder) {
         assertEquals("actionName", actionCaptor.getValue().getType());
         assertEquals(IterableActionSource.IN_APP, contextCaptor.getValue().source);
 
+        // Verify that legacy itbl:// links are also routed to the custom action handler
+        reset(inAppDisplayerMock);
+        reset(customActionHandler);
+        inAppManager.showMessage(message);
+        verify(inAppDisplayerMock).showMessage(any(IterableInAppMessage.class), callbackCaptor.capture());
+        callbackCaptor.getValue().execute(Uri.parse("itbl://legacyCustomAction"));
+        verify(customActionHandler).handleIterableCustomAction(actionCaptor.capture(), contextCaptor.capture());
+        assertEquals("legacyCustomAction", actionCaptor.getValue().getType());
+        assertEquals(IterableActionSource.IN_APP, contextCaptor.getValue().source);
+
         reset(inAppDisplayerMock);
         inAppManager.showMessage(message);
         verify(inAppDisplayerMock).showMessage(any(IterableInAppMessage.class), callbackCaptor.capture());
@@ -224,6 +234,16 @@ public IterableConfig.Builder run(IterableConfig.Builder builder) {
         verify(urlHandler).handleIterableURL(urlCaptor.capture(), contextCaptor.capture());
         assertEquals("https://www.google.com", urlCaptor.getValue().toString());
         assertEquals(IterableActionSource.IN_APP, contextCaptor.getValue().source);
+
+        // Verify that iterable:// links are not routed to either custom action handler or url handler
+        reset(inAppDisplayerMock);
+        reset(customActionHandler);
+        reset(urlHandler);
+        inAppManager.showMessage(message);
+        verify(inAppDisplayerMock).showMessage(any(IterableInAppMessage.class), callbackCaptor.capture());
+        callbackCaptor.getValue().execute(Uri.parse("iterable://someInternalAction"));
+        verify(customActionHandler, never()).handleIterableCustomAction(any(IterableAction.class), any(IterableActionContext.class));
+        verify(urlHandler, never()).handleIterableURL(any(Uri.class), any(IterableActionContext.class));
     }
 
 }