Merge pull request #593 from namehillsoftware/feature/experimental-ktor-http-client

[Feature] Experimental Ktor HTTP client

Author: davidvedvick

gradle/libs.versions.toml

@@ -15,19 +15,20 @@ handoff = "0.30.1"
 jodaTime = "2.14.0"
 jsoup = "1.21.2"
 junit = "4.13.2"
-junitJupiterApi = "6.0.0"
+junitJupiterApi = "6.0.1"
 junitKtx = "1.3.0"
 kotlinxCoroutinesRx3 = "1.10.2"
 kotlin = "2.2.21"
+ktorVersion = "3.3.1"
 lazyJ = "0.11.0"
 lifecycle = "2.9.4"
 logbackAndroid = "3.0.0"
-markdownRenderer = "0.37.0"
+markdownRenderer = "0.38.1"
 material = "1.13.0"
 media = "1.7.1"
 media3 = "1.8.0"
 mockk = "1.14.6"
-okhttp = "5.2.1"
+okhttp = "5.3.0"
 okio = "3.16.2"
 paletteKtx = "1.0.0"
 preferenceKtx = "1.2.1"
@@ -79,6 +80,8 @@ junit-vintage-engine = { module = "org.junit.vintage:junit-vintage-engine" }
 junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher" }
 kotlinx-coroutines-rx3 = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-rx3", version.ref = "kotlinxCoroutinesRx3" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinxCoroutinesRx3" }
+ktor-core = { module = "io.ktor:ktor-client-core", version.ref = "ktorVersion" }
+ktor-client = { module = "io.ktor:ktor-client-cio", version.ref = "ktorVersion" }
 lazy-j = { module = "com.namehillsoftware:lazy-j", version.ref = "lazyJ" }
 logback-android = { module = "com.github.tony19:logback-android", version.ref = "logbackAndroid" }
 material = { module = "com.google.android.material:material", version.ref = "material" }

projectBlueWater/build.gradle

@@ -208,6 +208,8 @@ dependencies {
 	implementation libs.joda.time
 	implementation libs.commons.io
 	implementation libs.slf4j.api
+	implementation libs.ktor.client
+	implementation libs.ktor.core
 	implementation libs.logback.android
 	implementation libs.handoff
 	implementation libs.rxjava

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/ApplicationDependencies.kt

@@ -15,7 +15,7 @@ import com.lasthopesoftware.bluewater.client.connection.MediaCenterConnectionDet
 import com.lasthopesoftware.bluewater.client.connection.SubsonicConnectionDetails
 import com.lasthopesoftware.bluewater.client.connection.libraries.ProvideLibraryConnections
 import com.lasthopesoftware.bluewater.client.connection.libraries.ProvideProgressingLibraryConnections
-import com.lasthopesoftware.bluewater.client.connection.okhttp.OkHttpFactory
+import com.lasthopesoftware.bluewater.client.connection.requests.ProvideHttpPromiseClients
 import com.lasthopesoftware.bluewater.client.connection.requests.ProvideHttpPromiseServerClients
 import com.lasthopesoftware.bluewater.client.connection.session.ManageConnectionSessions
 import com.lasthopesoftware.bluewater.client.connection.settings.LookupConnectionSettings
@@ -64,7 +64,7 @@ interface ApplicationDependencies {
 	val audioFileCache: DiskFileCache
 	val connectionSettingsLookup: LookupConnectionSettings
     val audioCacheStreamSupplier: DiskFileCacheStreamSupplier
-	val okHttpClients: OkHttpFactory
+	val httpClients: ProvideHttpPromiseClients
 	val libraryNameLookup: LibraryNameLookup
 	val exceptionAnnouncer: AnnounceExceptions
 	val mediaCenterHttpClients: ProvideHttpPromiseServerClients<MediaCenterConnectionDetails>

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/ApplicationDependenciesContainer.kt

@@ -26,12 +26,16 @@ import com.lasthopesoftware.bluewater.client.browsing.library.settings.access.Ca
 import com.lasthopesoftware.bluewater.client.browsing.library.settings.access.LibrarySettingsAccess
 import com.lasthopesoftware.bluewater.client.browsing.library.settings.access.StoreLibrarySettings
 import com.lasthopesoftware.bluewater.client.connection.PacketSender
+import com.lasthopesoftware.bluewater.client.connection.http.ApplicationSettingsHttpClient
+import com.lasthopesoftware.bluewater.client.connection.http.ApplicationSettingsMediaCenterClient
+import com.lasthopesoftware.bluewater.client.connection.http.ApplicationSettingsSubsonicClient
+import com.lasthopesoftware.bluewater.client.connection.http.KtorFactory
+import com.lasthopesoftware.bluewater.client.connection.http.OkHttpFactory
 import com.lasthopesoftware.bluewater.client.connection.libraries.LibraryConnectionProvider
 import com.lasthopesoftware.bluewater.client.connection.libraries.ProvideProgressingLibraryConnections
 import com.lasthopesoftware.bluewater.client.connection.live.LiveServerConnectionProvider
 import com.lasthopesoftware.bluewater.client.connection.lookup.ServerInfoXmlRequest
 import com.lasthopesoftware.bluewater.client.connection.lookup.ServerLookup
-import com.lasthopesoftware.bluewater.client.connection.okhttp.OkHttpFactory
 import com.lasthopesoftware.bluewater.client.connection.session.ConnectionSessionManager
 import com.lasthopesoftware.bluewater.client.connection.session.PromisedConnectionsRepository
 import com.lasthopesoftware.bluewater.client.connection.settings.ConnectionSettingsLookup
@@ -66,6 +70,7 @@ import com.lasthopesoftware.resources.strings.Base64Encoder
 import com.lasthopesoftware.resources.strings.JsonEncoderDecoder
 import com.lasthopesoftware.resources.strings.StringResources
 
+@OptIn(UnstableApi::class)
 object ApplicationDependenciesContainer {
 
 	private val connectionsRepository by lazy { PromisedConnectionsRepository() }
@@ -74,7 +79,6 @@ object ApplicationDependenciesContainer {
 
 	@SuppressLint("StaticFieldLeak")
 	@Volatile
-	@OptIn(UnstableApi::class)
 	private var attachedDependencies: AttachedDependencies? = null
 
 	val Context.applicationDependencies: ApplicationDependencies
@@ -108,24 +112,45 @@ object ApplicationDependenciesContainer {
 
 		private val audioCacheFilesProvider by lazy { CachedFilesProvider(context, AudioCacheConfiguration) }
 
-		override val okHttpClients by lazy { OkHttpFactory(context) }
+		private val okHttpClients by lazy { OkHttpFactory(context) }
+		private val ktorClients by lazy { KtorFactory(context) }
 
-		override val mediaCenterHttpClients by lazy { okHttpClients.MediaCenterHttpPromiseServerClient() }
+		override val httpClients by lazy {
+			ApplicationSettingsHttpClient(
+				applicationFeatureConfiguration,
+				okHttpClients,
+				ktorClients
+			)
+		}
+
+		override val mediaCenterHttpClients by lazy {
+			ApplicationSettingsMediaCenterClient(
+				applicationFeatureConfiguration,
+				okHttpClients.MediaCenterClient(),
+				ktorClients.MediaCenterClient()
+			)
+		}
 
 		override val mediaCenterDataFactories by lazy {
 			ServerHttpDataSourceProvider(
 				mediaCenterHttpClients,
-				mediaCenterHttpClients,
+				okHttpClients.MediaCenterClient(),
 				applicationFeatureConfiguration
 			)
 		}
 
-		override val subsonicHttpClients by lazy { okHttpClients.SubsonicHttpPromiseServerClient() }
+		override val subsonicHttpClients by lazy {
+			ApplicationSettingsSubsonicClient(
+				applicationFeatureConfiguration,
+				okHttpClients.SubsonicClient(),
+				ktorClients.SubsonicClient()
+			)
+		}
 
 		override val subsonicDataFactories by lazy {
 			ServerHttpDataSourceProvider(
 				subsonicHttpClients,
-				subsonicHttpClients,
+				okHttpClients.SubsonicClient(),
 				applicationFeatureConfiguration
 			)
 		}
@@ -232,7 +257,7 @@ object ApplicationDependenciesContainer {
 		override val connectionSessions by lazy {
 			val serverLookup = ServerLookup(
 				connectionSettingsLookup,
-				ServerInfoXmlRequest(connectionSettingsLookup, okHttpClients),
+				ServerInfoXmlRequest(connectionSettingsLookup, httpClients),
 			)
 
 			val activeNetwork = ActiveNetworkFinder(context)

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/client/HandheldApplication.kt

@@ -81,7 +81,6 @@ import com.lasthopesoftware.promises.extensions.toPromise
 import com.namehillsoftware.handoff.promises.Promise
 import dev.olshevski.navigation.reimagined.NavHost
 import dev.olshevski.navigation.reimagined.rememberNavController
-import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.async
 import org.slf4j.LoggerFactory
 
@@ -90,7 +89,6 @@ private val logger by lazy { LoggerFactory.getLogger("HandheldApplication") }
 private val bottomAppBarHeight = Dimensions.appBarHeight
 private val bottomSheetElevation = 16.dp
 
-@OptIn(ExperimentalCoroutinesApi::class)
 @Composable
 private fun BrowserLibraryDestination.Navigate(
 	browserViewDependencies: ScopedViewModelDependencies,

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/client/access/RemoteLibraryAccess.kt

@@ -7,8 +7,8 @@ import com.lasthopesoftware.bluewater.client.browsing.items.ItemId
 import com.lasthopesoftware.bluewater.client.browsing.items.KeyedIdentifier
 import com.lasthopesoftware.bluewater.client.browsing.items.playlists.PlaylistId
 import com.lasthopesoftware.bluewater.client.servers.version.SemanticVersion
+import com.lasthopesoftware.resources.io.PromisingReadableStream
 import com.namehillsoftware.handoff.promises.Promise
-import java.io.InputStream
 
 interface RemoteLibraryAccess {
 	fun promiseFileProperties(serviceFile: ServiceFile): Promise<LookupFileProperties>
@@ -25,7 +25,7 @@ interface RemoteLibraryAccess {
 	fun promiseIsReadOnly(): Promise<Boolean>
 	fun promiseServerVersion(): Promise<SemanticVersion?>
 	fun promiseRevision(): Promise<Long?>
-	fun promiseFile(serviceFile: ServiceFile): Promise<InputStream>
+	fun promiseFile(serviceFile: ServiceFile): Promise<PromisingReadableStream>
 	fun promisePlaystatsUpdate(serviceFile: ServiceFile): Promise<*>
 	fun promiseFiles(): Promise<List<ServiceFile>>
 	fun promiseFiles(query: String): Promise<List<ServiceFile>>

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/client/browsing/files/cached/DiskFileCache.kt

@@ -7,7 +7,7 @@ import com.lasthopesoftware.bluewater.client.browsing.files.cached.configuration
 import com.lasthopesoftware.bluewater.client.browsing.files.cached.disk.ProvideDiskCacheDirectory
 import com.lasthopesoftware.bluewater.client.browsing.files.cached.persistence.UpdateDiskFileAccessTime
 import com.lasthopesoftware.bluewater.client.browsing.files.cached.repository.CachedFile
-import com.lasthopesoftware.bluewater.client.browsing.files.cached.stream.CacheOutputStream
+import com.lasthopesoftware.bluewater.client.browsing.files.cached.stream.CacheWritableStream
 import com.lasthopesoftware.bluewater.client.browsing.files.cached.stream.supplier.SupplyCacheStreams
 import com.lasthopesoftware.bluewater.client.browsing.library.repository.LibraryId
 import com.lasthopesoftware.bluewater.repository.RepositoryAccessHelper
@@ -47,12 +47,12 @@ class DiskFileCache(
 		return putPromise
 	}
 
-	private fun writeCachedFileWithRetries(libraryId: LibraryId, uniqueKey: String, cachedFileOutputStream: CacheOutputStream, fileData: ByteArray): Promise<CachedFile?> {
+	private fun writeCachedFileWithRetries(libraryId: LibraryId, uniqueKey: String, cachedFileOutputStream: CacheWritableStream, fileData: ByteArray): Promise<CachedFile?> {
 		return cachedFileOutputStream
 			.promiseWrite(fileData, 0, fileData.size)
-			.eventually { obj -> obj.flush() }
+			.eventually { cachedFileOutputStream.promiseFlush() }
 			.eventually(
-				{ fos -> fos.commitToCache() },
+				{ cachedFileOutputStream.commitToCache() },
 				{ e ->
 				logger.error("Unable to write to file!", e)
 

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/client/browsing/files/cached/stream/CacheOutputStream.kt

@@ -0,0 +1,9 @@
+package com.lasthopesoftware.bluewater.client.browsing.files.cached.stream
+
+import com.lasthopesoftware.bluewater.client.browsing.files.cached.repository.CachedFile
+import com.lasthopesoftware.resources.io.PromisingWritableStream
+import com.namehillsoftware.handoff.promises.Promise
+
+interface CacheWritableStream : PromisingWritableStream {
+	fun commitToCache(): Promise<CachedFile?>
+}

projectBlueWater/src/main/java/com/lasthopesoftware/bluewater/client/browsing/files/cached/stream/CacheWritableStream.kt

@@ -7,17 +7,15 @@ import com.lasthopesoftware.promises.extensions.guaranteedUnitResponse
 import com.lasthopesoftware.promises.extensions.preparePromise
 import com.lasthopesoftware.resources.executors.ThreadPools
 import com.namehillsoftware.handoff.promises.Promise
-import okio.BufferedSource
-import okio.sink
 import java.io.File
 import java.io.FileOutputStream
 
-class CachedFileOutputStream(
+class CachedFileWritableStream(
 	private val libraryId: LibraryId,
     private val uniqueKey: String,
     private val file: File,
     private val diskFileCachePersistence: IDiskFileCachePersistence
-) : CacheOutputStream {
+) : CacheWritableStream {
 
 	@Volatile
 	private var isClosed = false
@@ -28,26 +26,18 @@ class CachedFileOutputStream(
         buffer: ByteArray,
         offset: Int,
         length: Int
-    ): Promise<CacheOutputStream> {
+    ): Promise<Int> {
         return ThreadPools.io.preparePromise {
-			if (!isClosed)
-            	lazyFileOutputStream.value.write(buffer, offset, length)
-            this
+			if (!isClosed) {
+				lazyFileOutputStream.value.write(buffer, offset, length)
+				length
+			} else 0
         }
     }
 
-    override fun promiseTransfer(bufferedSource: BufferedSource): Promise<CacheOutputStream> {
-        return ThreadPools.io.preparePromise {
-			if (!isClosed)
-            	bufferedSource.readAll(lazyFileOutputStream.value.sink())
-            this
-        }
-    }
-
-    override fun flush(): Promise<CacheOutputStream> {
+	override fun promiseFlush(): Promise<Unit> {
         return ThreadPools.io.preparePromise {
             if (!isClosed && lazyFileOutputStream.isInitialized()) lazyFileOutputStream.value.flush()
-            this
         }
     }
 
@@ -56,7 +46,7 @@ class CachedFileOutputStream(
 		else Promise.empty()
 
 	override fun promiseClose(): Promise<Unit> {
-		return flush().must { _ ->
+		return promiseFlush().must { _ ->
 			isClosed = true
 			if (lazyFileOutputStream.isInitialized()) lazyFileOutputStream.value.close()
 		}.guaranteedUnitResponse()