feat(#28): add navigate(destination)

Author: kkostov

lib/src/main/java/com/telemetrydeck/sdk/NavigationStatus.kt

@@ -5,4 +5,9 @@ interface NavigationStatus {
      * Apply the provided path as a visited destination.
      */
     fun applyDestination(path: String)
+
+    /**
+     * Returns the last destination path or an empty string if none has been provided.
+     */
+    fun getLastDestination(): String
 }

lib/src/main/java/com/telemetrydeck/sdk/NavigationStatusCache.kt

@@ -9,4 +9,8 @@ class MemoryNavigationStatus(private var previousNavigationPath: String? = null)
     override fun applyDestination(path: String) {
         previousNavigationPath = path
     }
+
+    override fun getLastDestination(): String {
+        return previousNavigationPath ?: ""
+    }
 }

lib/src/main/java/com/telemetrydeck/sdk/TelemetryManager.kt

@@ -20,7 +20,7 @@ class TelemetryManager(
 
     var cache: SignalCache? = null
     var logger: DebugLogger? = null
-    var navigationStatus: NavigationStatus = MemoryNavigationStatus()
+    private val navigationStatus: NavigationStatus = MemoryNavigationStatus()
 
     override fun newSession(sessionID: UUID) {
         this.configuration.sessionID = sessionID
@@ -59,6 +59,10 @@ class TelemetryManager(
         queue(SignalType.TelemetryDeckNavigationPathChanged, clientUser, payload)
     }
 
+    override fun navigate(destinationPath: String, clientUser: String?) {
+        navigate(navigationStatus.getLastDestination(), destinationPath, clientUser)
+    }
+
     override suspend fun send(
         signalType: String,
         clientUser: String?,
@@ -222,7 +226,11 @@ class TelemetryManager(
         }
 
         override fun navigate(sourcePath: String, destinationPath: String, clientUser: String?) {
-            getInstance()?.navigate(sourcePath, destinationPath, clientUser)
+            getInstance()?.navigate(sourcePath, destinationPath, clientUser = clientUser)
+        }
+
+        override fun navigate(destinationPath: String, clientUser: String?) {
+            getInstance()?.navigate(destinationPath, clientUser = clientUser)
         }
 
         override suspend fun send(

lib/src/main/java/com/telemetrydeck/sdk/TelemetryManagerSignals.kt

@@ -39,12 +39,19 @@ interface TelemetryManagerSignals {
     )
 
     /**
-     * Send a signal that represents a navigation event with a source and a destination
+     * Send a signal that represents a navigation event with a source and a destination.
      *
      * @see <a href="https://telemetrydeck.com/docs/articles/navigation-signals/">Navigation Signals</a>
      * */
     fun navigate(sourcePath: String, destinationPath: String, clientUser: String? = null)
 
+    /**
+     * Send a signal that represents a navigation event with a destination and a default source.
+     *
+     * @see <a href="https://telemetrydeck.com/docs/articles/navigation-signals/">Navigation Signals</a>
+     * */
+    fun navigate(destinationPath: String, clientUser: String? = null)
+
 
     /**
      * Send a signal immediately

lib/src/test/java/com/telemetrydeck/sdk/TelemetryManagerTest.kt

@@ -322,6 +322,75 @@ class TelemetryManagerTest {
             "6721870580401922549fe8fdb09a064dba5b8792fa018d3bd9ffa90fe37a0149"
         )
     }
+
+    @Test
+    fun telemetryManager_navigate_destination_no_previous_source() {
+        val config = TelemetryManagerConfiguration("32CB6574-6732-4238-879F-582FEBEB6536")
+        val manager = TelemetryManager.Builder().configuration(config).build(null)
+
+        manager.navigate("destination")
+
+        val queuedSignal = manager.cache?.empty()?.first()
+
+        Assert.assertNotNull(queuedSignal)
+
+        // validate the signal type
+        Assert.assertEquals(queuedSignal?.type, "TelemetryDeck.Navigation.pathChanged")
+
+        // validate the navigation status payload
+        // https://github.com/TelemetryDeck/KotlinSDK/issues/28
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.schemaVersion") },
+            "TelemetryDeck.Navigation.schemaVersion:1"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.identifier") },
+            "TelemetryDeck.Navigation.identifier: -> destination"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.sourcePath") },
+            "TelemetryDeck.Navigation.sourcePath:"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.destinationPath") },
+            "TelemetryDeck.Navigation.destinationPath:destination"
+        )
+    }
+
+    @Test
+    fun telemetryManager_navigate_destination_uses_previous_destination_as_source() {
+        val config = TelemetryManagerConfiguration("32CB6574-6732-4238-879F-582FEBEB6536")
+        val manager = TelemetryManager.Builder().configuration(config).build(null)
+
+        manager.navigate("destination1")
+        manager.navigate("destination2")
+
+        val queuedSignal = manager.cache?.empty()?.last()
+
+        Assert.assertNotNull(queuedSignal)
+
+        // validate the signal type
+        Assert.assertEquals(queuedSignal?.type, "TelemetryDeck.Navigation.pathChanged")
+
+        // validate the navigation status payload
+        // https://github.com/TelemetryDeck/KotlinSDK/issues/28
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.schemaVersion") },
+            "TelemetryDeck.Navigation.schemaVersion:1"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.identifier") },
+            "TelemetryDeck.Navigation.identifier:destination1 -> destination2"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.sourcePath") },
+            "TelemetryDeck.Navigation.sourcePath:destination1"
+        )
+        Assert.assertEquals(
+            queuedSignal?.payload?.single { it.startsWith("TelemetryDeck.Navigation.destinationPath") },
+            "TelemetryDeck.Navigation.destinationPath:destination2"
+        )
+    }
 }
 
 open class TestProvider : TelemetryProvider {