Voice instructions caching using ResourceLoader. (#5790)

* Voice instructions caching using ResourceLoader.
- Updated libnavui-voice to load audio data using libnavui-util ResourceLoader

* Addressing PR comments.
- updated LICENSE file
- updated generate-license.py script to inject okhttp license

- reverted changes to examples/build.gradle and libnavui-voice/build.gradle

- patched DefaultResourceLoader to fail fast when device is offline and request requires internet connection
- added missing retrieveVoiceFile failure tests

* Addressing PR feedback. Propagating VoiceInstructionsParser error as IllegalStateException.

Author: tomaszrybakiewicz

CHANGELOG.md

@@ -6,6 +6,7 @@ Mapbox welcomes participation and contributions from everyone.
 #### Features
 
 #### Bug fixes and improvements
+- Updated `MapboxSpeechApi` to use persistent cache to decrease the bandwidth consumption. [#5790](https://github.com/mapbox/mapbox-navigation-android/pull/5790)
 
 ## Mapbox Navigation SDK 2.6.0-rc.1 - June 23, 2022
 ### Changelog

LICENSE.md

@@ -12,9 +12,20 @@ Mapbox Navigation for Android version 2.0 (“Mapbox Navigation Android SDK“)
 For the full license terms, please see the Mapbox Terms of Service at https://www.mapbox.com/legal/tos/
 
 ---------------------------------------
-URL: [Gradle License Plugin](https://github.com/jaredsburrows/gradle-license-plugin)  
+Mapbox Navigation uses portions of the Gradle License Plugin.
+URL: [https://github.com/jaredsburrows/gradle-license-plugin](https://github.com/jaredsburrows/gradle-license-plugin)
 License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
 
+===========================================================================
+
+Mapbox Navigation uses portions of the okhttp (Square’s meticulous HTTP client for Java and Kotlin.).
+URL: [https://square.github.io/okhttp/](https://square.github.io/okhttp/)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+
+
 #### Hybrid Router SDK module
 Mapbox Navigation uses portions of the Android Support Library Annotations (The Support Library is a static library that you can add to your Android application in order to use APIs that are either not available for older platform versions or utility APIs that aren't a part of the framework APIs.).
 URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
@@ -3610,6 +3621,22 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens
 
 ===========================================================================
 
+Mapbox Navigation uses portions of the auto-value-gson-runtime.
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+Mapbox Navigation uses portions of the autotransient (A transient annotation for AutoValue extensions.).
+URL: [https://github.com/ZacSweers/AutoTransient/](https://github.com/ZacSweers/AutoTransient/)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+Mapbox Navigation uses portions of the Converter: Gson.
+License: [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
 Mapbox Navigation uses portions of the Core Kotlin Extensions (Kotlin extensions for 'core' artifact).
 URL: [https://developer.android.com/jetpack/androidx/releases/core#1.6.0](https://developer.android.com/jetpack/androidx/releases/core#1.6.0)
 License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
@@ -3622,6 +3649,11 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens
 
 ===========================================================================
 
+Mapbox Navigation uses portions of the Gson.
+License: [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
 Mapbox Navigation uses portions of the IntelliJ IDEA Annotations (A set of annotations used for code inspection support and code documentation.).
 URL: [http://www.jetbrains.org](http://www.jetbrains.org)
 License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
@@ -3676,12 +3708,41 @@ License: [The Apache Software License, Version 2.0](http://www.apache.org/licens
 
 ===========================================================================
 
+Mapbox Navigation uses portions of the Mapbox Java SDK.
+URL: [https://github.com/mapbox/mapbox-java](https://github.com/mapbox/mapbox-java)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
 Mapbox Navigation uses portions of the Material Components for Android (Material Components for Android is a static library that you can add to your Android application in order to use APIs that provide implementations of the Material Design specification. Compatible on devices running API 14 or later.).
 URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
 License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
 
 ===========================================================================
 
+Mapbox Navigation uses portions of the okhttp (Square’s meticulous HTTP client for Java and Kotlin.).
+URL: [https://square.github.io/okhttp/](https://square.github.io/okhttp/)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+Mapbox Navigation uses portions of the okhttp-logging-interceptor (Square’s meticulous HTTP client for Java and Kotlin.).
+URL: [https://square.github.io/okhttp/](https://square.github.io/okhttp/)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+Mapbox Navigation uses portions of the Okio (A modern I/O API for Java).
+URL: [https://github.com/square/okio/](https://github.com/square/okio/)
+License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
+Mapbox Navigation uses portions of the Retrofit.
+License: [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
+
+===========================================================================
+
 Mapbox Navigation uses portions of the VersionedParcelable (Provides a stable but relatively compact binary serialization format that can be passed across processes or persisted safely.).
 URL: [http://developer.android.com/tools/extras/support-library.html](http://developer.android.com/tools/extras/support-library.html)
 License: [The Apache Software License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)

libnavui-dropin/build.gradle

@@ -49,6 +49,9 @@ dependencies {
     api project(":libnavui-tripprogress")
     api project(":libnavui-voice")
     implementation project(":libnavui-app")
+
+    api dependenciesList.mapboxSdkServices
+
     implementation project(":libnavui-resources")
     implementation project(":libnavui-util")
 

libnavui-util/src/main/java/com/mapbox/navigation/ui/utils/internal/resource/DefaultResourceLoader.kt

@@ -1,9 +1,13 @@
 package com.mapbox.navigation.ui.utils.internal.resource
 
 import com.mapbox.bindgen.Expected
+import com.mapbox.bindgen.ExpectedFactory.createError
 import com.mapbox.common.Cancelable
+import com.mapbox.common.NetworkRestriction
+import com.mapbox.common.ReachabilityInterface
 import com.mapbox.common.ResourceDescription
 import com.mapbox.common.ResourceLoadError
+import com.mapbox.common.ResourceLoadErrorType
 import com.mapbox.common.ResourceLoadOptions
 import com.mapbox.common.ResourceLoadProgress
 import com.mapbox.common.ResourceLoadProgressCallback
@@ -25,7 +29,8 @@ import java.util.concurrent.atomic.AtomicLong
  * abort load operation.
  */
 internal class DefaultResourceLoader(
-    private val tileStore: TileStore
+    private val tileStore: TileStore,
+    private val reachability: ReachabilityInterface
 ) : ResourceLoader() {
 
     private val nextRequestId = AtomicLong(0L)
@@ -43,20 +48,33 @@ internal class DefaultResourceLoader(
     ): Long {
         val requestId = nextRequestId.incrementAndGet()
         val callbackAdapter = CallbackAdapter(request, callback, observers)
+        val requiresNetwork = request.networkRestriction != NetworkRestriction.DISALLOW_ALL
 
         callbackAdapter.notifyOnStart(request)
-        cancelableMap[requestId] = tileStore.loadResource(
-            /* description */ request.toResourceDescription(),
-            /* options */ request.toResourceLoadOptions("DefaultResourceLoader-$requestId"),
-            /* progressCallback */ callbackAdapter
-        ) {
-            cancelableMap.remove(requestId)
-            callbackAdapter.run(it)
+        // Since the TileStore (commonSDK 21.3.1) will defer any requests that require internet connection,
+        // we must verify network requirement here and fail fast if the network is not available.
+        if (requiresNetwork && !reachability.isReachable) {
+            callbackAdapter.run(createError(connectionError()))
+        } else {
+            cancelableMap[requestId] = tileStore.loadResource(
+                /* description */ request.toResourceDescription(),
+                /* options */ request.toResourceLoadOptions("DefaultResourceLoader-$requestId"),
+                /* progressCallback */ callbackAdapter
+            ) {
+                cancelableMap.remove(requestId)
+                callbackAdapter.run(it)
+            }
         }
 
         return requestId
     }
 
+    private fun connectionError() = ResourceLoadError(
+        ResourceLoadErrorType.UNSATISFIED,
+        "No internet connection",
+        0L
+    )
+
     override fun cancel(requestId: Long) {
         cancelableMap.remove(requestId)?.cancel()
     }

libnavui-util/src/main/java/com/mapbox/navigation/ui/utils/internal/resource/ResourceLoaderFactory.kt

@@ -1,5 +1,6 @@
 package com.mapbox.navigation.ui.utils.internal.resource
 
+import com.mapbox.common.ReachabilityFactory
 import com.mapbox.common.TileStore
 
 /**
@@ -8,7 +9,10 @@ import com.mapbox.common.TileStore
 object ResourceLoaderFactory {
 
     private val sharedLoader: DefaultResourceLoader by lazy {
-        DefaultResourceLoader(TileStore.create())
+        DefaultResourceLoader(
+            TileStore.create(),
+            ReachabilityFactory.reachability(null)
+        )
     }
 
     /**

libnavui-util/src/test/java/com/mapbox/navigation/ui/utils/internal/resource/DefaultResourceLoaderTest.kt

@@ -4,6 +4,7 @@ import com.mapbox.bindgen.Expected
 import com.mapbox.bindgen.ExpectedFactory
 import com.mapbox.common.Cancelable
 import com.mapbox.common.NetworkRestriction
+import com.mapbox.common.ReachabilityInterface
 import com.mapbox.common.ResourceData
 import com.mapbox.common.ResourceDescription
 import com.mapbox.common.ResourceLoadError
@@ -23,19 +24,24 @@ import io.mockk.spyk
 import io.mockk.verify
 import io.mockk.verifyOrder
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertTrue
 import org.junit.Before
 import org.junit.Test
 import java.util.Date
 
 class DefaultResourceLoaderTest {
 
     private lateinit var mockTileStore: TileStore
+    private lateinit var mockReachability: ReachabilityInterface
     private lateinit var sut: ResourceLoader
 
     @Before
     fun setUp() {
         mockTileStore = mockk<StubTileStore>(relaxed = true)
-        sut = DefaultResourceLoader(mockTileStore)
+        mockReachability = mockk(relaxed = true) {
+            every { isReachable } returns true
+        }
+        sut = DefaultResourceLoader(mockTileStore, mockReachability)
     }
 
     @Test
@@ -99,6 +105,31 @@ class DefaultResourceLoaderTest {
         }
     }
 
+    @Test
+    fun `load - should fail fast if request requires network and network is not reachable`() {
+        val callback = mockk<ResourceLoadCallback>(relaxed = true)
+        val loadRequest = ResourceLoadRequest("http://example.com/some-resource")
+        every { mockReachability.isReachable } returns false
+        sut.load(loadRequest, callback)
+
+        val errorCapture = slot<Expected<ResourceLoadError, ResourceLoadResult>>()
+        verifyOrder {
+            callback.onStart(loadRequest)
+            callback.onFinish(loadRequest, capture(errorCapture))
+        }
+        assertTrue(errorCapture.captured.isError)
+    }
+
+    @Test
+    fun `load - should NOT call TileStore if request requires network and network is not reachable`() {
+        val callback = mockk<ResourceLoadCallback>(relaxed = true)
+        val loadRequest = ResourceLoadRequest("http://example.com/some-resource")
+        every { mockReachability.isReachable } returns false
+        sut.load(loadRequest, callback)
+
+        verify(exactly = 0) { mockTileStore.loadResource(any(), any(), any(), any()) }
+    }
+
     @Test
     fun `cancel - should call Cancelable`() {
         val loadRequest = ResourceLoadRequest(