Specify http cache per platform (#1072)

* Specify http cache per platform * Match top level naming * Add missing trailing comma before closing bracket * Include okio dependency * Fix dependency target --------- Co-authored-by: Ashley Davies <[email protected]>
ashdavies · Jul 17, 2024 · 06cc41f · 06cc41f
1 parent 834a9f6
commit 06cc41f
Show file tree

Hide file tree

Showing 22 changed files with 154 additions and 107 deletions.
diff --git a/after-party/src/commonMain/kotlin/io/ashdavies/events/GetEventsCallable.kt b/after-party/src/commonMain/kotlin/io/ashdavies/events/GetEventsCallable.kt
@@ -1,7 +1,6 @@
 package io.ashdavies.events
 
 import io.ashdavies.http.UnaryCallable
-import io.ashdavies.http.defaultHttpClient
 import io.ktor.client.HttpClient
 import io.ktor.client.call.body
 import io.ktor.client.plugins.ClientRequestException
@@ -23,7 +22,7 @@ internal data class GetEventsRequest(
 internal typealias GetEventsResponse = List<ApiEvent>
 
 internal class GetEventsCallable(
-    httpClient: HttpClient = defaultHttpClient(),
+    httpClient: HttpClient,
 ) : UnaryCallable<GetEventsRequest, GetEventsResponse> {
 
     private val httpClient = httpClient.config {

diff --git a/after-party/src/commonMain/kotlin/io/ashdavies/gallery/HttpClient.kt b/after-party/src/commonMain/kotlin/io/ashdavies/gallery/HttpClient.kt
@@ -18,7 +18,7 @@ private val HttpRequestData.path: String
 private val Headers.contentLength: String
     get() = requireNotNull(get(HttpHeaders.ContentLength))
 
-internal fun inMemoryHttpClientEngine(initialValue: List<String>): HttpClientEngine {
+internal fun inMemoryHttpClientEngine(initialValue: List<String> = emptyList()): HttpClientEngine {
     val values = initialValue.toMutableList()
 
     return MockEngine { request ->

diff --git a/after-party/src/commonMain/kotlin/io/ashdavies/gallery/SyncManager.kt b/after-party/src/commonMain/kotlin/io/ashdavies/gallery/SyncManager.kt
@@ -1,6 +1,6 @@
 package io.ashdavies.gallery
 
-import io.ashdavies.http.defaultHttpClient
+import io.ashdavies.http.DefaultHttpConfiguration
 import io.ktor.client.HttpClient
 import io.ktor.client.call.body
 import io.ktor.client.request.get
@@ -28,7 +28,7 @@ internal enum class SyncState {
 }
 
 internal fun SyncManager(
-    client: HttpClient = defaultHttpClient(inMemoryHttpClientEngine(emptyList())),
+    client: HttpClient = HttpClient(inMemoryHttpClientEngine(), DefaultHttpConfiguration),
     reader: File.() -> ByteReadChannel = File::readChannel,
 ): SyncManager = object : SyncManager {
 

diff --git a/after-party/src/commonTest/kotlin/io/ashdavies/gallery/SyncManagerTest.kt b/after-party/src/commonTest/kotlin/io/ashdavies/gallery/SyncManagerTest.kt
@@ -1,8 +1,9 @@
 package io.ashdavies.gallery
 
 import app.cash.turbine.test
-import io.ashdavies.http.defaultHttpClient
+import io.ashdavies.http.DefaultHttpConfiguration
 import io.ashdavies.util.randomUuid
+import io.ktor.client.HttpClient
 import io.ktor.utils.io.ByteReadChannel
 import kotlinx.coroutines.test.runTest
 import kotlin.test.Test
@@ -15,7 +16,10 @@ internal class SyncManagerTest {
     @Test
     fun `should request initial value`() = runTest {
         val manager = SyncManager(
-            client = defaultHttpClient(inMemoryHttpClientEngine(listOf(RandomImage))),
+            client = HttpClient(
+                engine = inMemoryHttpClientEngine(listOf(RandomImage)),
+                block = DefaultHttpConfiguration,
+            ),
             reader = { ByteReadChannel.Empty },
         )
 
@@ -27,7 +31,10 @@ internal class SyncManagerTest {
     @Test
     fun `should sync image on invocation`() = runTest {
         val manager = SyncManager(
-            client = defaultHttpClient(inMemoryHttpClientEngine(emptyList())),
+            client = HttpClient(
+                engine = inMemoryHttpClientEngine(emptyList()),
+                block = DefaultHttpConfiguration,
+            ),
             reader = { ByteReadChannel.Empty },
         )
 
@@ -44,7 +51,10 @@ internal class SyncManagerTest {
     @Test
     fun `should put synced image without content`() = runTest {
         val manager = SyncManager(
-            client = defaultHttpClient(inMemoryHttpClientEngine(listOf(RandomImage))),
+            client = HttpClient(
+                engine = inMemoryHttpClientEngine(listOf(RandomImage)),
+                block = DefaultHttpConfiguration,
+            ),
             reader = { ByteReadChannel.Empty },
         )
 
@@ -61,7 +71,10 @@ internal class SyncManagerTest {
     @Test
     fun `should include content length header`() = runTest {
         val manager = SyncManager(
-            client = defaultHttpClient(inMemoryHttpClientEngine(emptyList())),
+            client = HttpClient(
+                engine = inMemoryHttpClientEngine(emptyList()),
+                block = DefaultHttpConfiguration,
+            ),
             reader = { ByteReadChannel.Empty },
         )
 

diff --git a/...check/app-check-client/src/androidMain/kotlin/io/ashdavies/check/AppCheckToken.android.kt b/...check/app-check-client/src/androidMain/kotlin/io/ashdavies/check/AppCheckToken.android.kt
@@ -1,7 +1,6 @@
 package io.ashdavies.check
 
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.produceState
@@ -12,7 +11,7 @@ import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderF
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.app
 import io.ashdavies.http.AppCheckToken
-import io.ashdavies.http.LocalHttpClient
+import io.ashdavies.http.ProvideHttpClient
 import io.ktor.client.HttpClient
 import io.ktor.client.plugins.DefaultRequest
 import io.ktor.client.request.header
@@ -32,8 +31,8 @@ public actual fun ProvideAppCheckToken(client: HttpClient, content: @Composable
         appCheck.installAppCheckProviderFactory(factory)
     }
 
-    CompositionLocalProvider(
-        LocalHttpClient provides client.config {
+    ProvideHttpClient(
+        config = {
             install(DefaultRequest) {
                 header(HttpHeaders.AppCheckToken, token?.token)
             }

diff --git a/app-launcher/android/build.gradle.kts b/app-launcher/android/build.gradle.kts
@@ -52,6 +52,7 @@ kotlin {
             implementation(libs.ktor.client.core)
             implementation(libs.slack.circuit.foundation)
             implementation(libs.slack.circuit.overlay)
+            implementation(libs.squareup.okio)
         }
 
         val androidInstrumentedTest by getting {

diff --git a/app-launcher/android/src/androidMain/kotlin/io/ashdavies/playground/LauncherActivity.kt b/app-launcher/android/src/androidMain/kotlin/io/ashdavies/playground/LauncherActivity.kt
@@ -8,7 +8,6 @@ import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
 import androidx.compose.runtime.Composable
-import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.remember
 import androidx.compose.ui.platform.LocalContext
 import com.slack.circuit.foundation.CircuitCompositionLocals
@@ -17,22 +16,29 @@ import com.slack.circuit.foundation.rememberCircuitNavigator
 import com.slack.circuit.overlay.ContentWithOverlays
 import io.ashdavies.content.enableStrictMode
 import io.ashdavies.content.isDebuggable
-import io.ashdavies.http.LocalHttpClient
+import io.ashdavies.http.ProvideHttpClient
+import io.ashdavies.http.publicStorage
+import io.ashdavies.io.resolveCacheDir
 import io.ktor.client.plugins.DefaultRequest
+import io.ktor.client.plugins.cache.HttpCache
 import io.ktor.client.request.header
 import java.security.MessageDigest
 import java.util.Locale
 
 @Composable
 private fun LauncherApp(context: Context = LocalContext.current, extra: (String) -> String?) {
-    CompositionLocalProvider(
-        LocalHttpClient provides LocalHttpClient.current.config {
+    ProvideHttpClient(
+        config = {
             install(DefaultRequest) {
                 header("X-Android-Cert", getSignature(context.packageManager, context.packageName))
                 header("X-Android-Package", context.packageName)
                 header("X-API-Key", BuildConfig.ANDROID_API_KEY)
                 header("User-Agent", Build.PRODUCT)
             }
+
+            install(HttpCache) {
+                publicStorage(context.resolveCacheDir())
+            }
         },
     ) {
         CircuitCompositionLocals(remember { Circuit(context) }) {

diff --git a/app-launcher/common/src/commonMain/kotlin/io/ashdavies/playground/LauncherContent.kt b/app-launcher/common/src/commonMain/kotlin/io/ashdavies/playground/LauncherContent.kt
@@ -12,10 +12,10 @@ import io.ashdavies.check.ProvideAppCheckToken
 import io.ashdavies.common.PlaygroundDatabase
 import io.ashdavies.content.PlatformContext
 import io.ashdavies.dominion.Card
+import io.ashdavies.io.resolveCacheDir
 import io.ashdavies.material.dynamicColorScheme
 import io.ashdavies.sql.ProvideTransacter
 import io.ashdavies.sql.rememberTransacter
-import okio.Path
 
 private const val IMAGE_CACHE_PATH = "image_cache"
 
@@ -61,7 +61,3 @@ public fun LauncherContent(context: PlatformContext, content: @Composable () ->
         }
     }
 }
-
-internal expect fun PlatformContext.resolveCacheDir(
-    relative: String,
-): Path
diff --git a/app-launcher/desktop/src/commonMain/kotlin/io/ashdavies/playground/LauncherMain.kt b/app-launcher/desktop/src/commonMain/kotlin/io/ashdavies/playground/LauncherMain.kt
@@ -1,6 +1,5 @@
 package io.ashdavies.playground
 
-import androidx.compose.runtime.CompositionLocalProvider
 import androidx.compose.runtime.remember
 import androidx.compose.ui.unit.DpSize
 import androidx.compose.ui.unit.dp
@@ -13,7 +12,7 @@ import com.slack.circuit.foundation.CircuitCompositionLocals
 import com.slack.circuit.foundation.NavigableCircuitContent
 import com.slack.circuit.foundation.rememberCircuitNavigator
 import io.ashdavies.content.PlatformContext
-import io.ashdavies.http.LocalHttpClient
+import io.ashdavies.http.ProvideHttpClient
 import io.ktor.client.plugins.DefaultRequest
 import io.ktor.client.request.header
 
@@ -30,8 +29,8 @@ private class LauncherCommand : CliktCommand() {
             val circuit = remember { Circuit(PlatformContext.Default) }
 
             CircuitCompositionLocals(circuit) {
-                CompositionLocalProvider(
-                    LocalHttpClient provides LocalHttpClient.current.config {
+                ProvideHttpClient(
+                    config = {
                         install(DefaultRequest) {
                             header("User-Agent", System.getProperty("os.name"))
                             header("X-API-Key", BuildConfig.BROWSER_API_KEY)

diff --git a/cloud-run/build.gradle.kts b/cloud-run/build.gradle.kts
@@ -68,6 +68,7 @@ kotlin {
             implementation(projects.eventsAggregator)
             implementation(projects.httpClient)
             implementation(projects.httpCommon)
+            implementation(projects.platformSupport)
 
             implementation(libs.google.firebase.admin)
             implementation(libs.kotlinx.datetime)
@@ -82,6 +83,7 @@ kotlin {
             implementation(libs.ktor.server.core)
             implementation(libs.ktor.server.default.headers)
             implementation(libs.ktor.server.host.common)
+            implementation(libs.squareup.okio)
         }
 
         commonTest.dependencies {

diff --git a/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/GoogleApiException.kt b/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/GoogleApiException.kt
@@ -0,0 +1,16 @@
+package io.ashdavies.cloud
+
+import kotlinx.serialization.Serializable
+
+@Serializable
+internal data class GoogleApiException(
+    val error: Error,
+) : Exception(error.message) {
+
+    @Serializable
+    data class Error(
+        val code: Int,
+        val message: String,
+        val status: String,
+    )
+}
diff --git a/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/Main.kt b/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/Main.kt
@@ -1,7 +1,13 @@
 package io.ashdavies.cloud
 
-import io.ashdavies.http.defaultHttpClient
+import io.ashdavies.content.PlatformContext
+import io.ashdavies.http.DefaultHttpConfiguration
+import io.ashdavies.http.publicStorage
+import io.ashdavies.http.throwClientRequestExceptionAs
+import io.ashdavies.io.resolveCacheDir
 import io.ktor.client.HttpClient
+import io.ktor.client.plugins.HttpCallValidator
+import io.ktor.client.plugins.cache.HttpCache
 import io.ktor.http.HttpHeaders
 import io.ktor.serialization.Configuration
 import io.ktor.serialization.kotlinx.json.json
@@ -28,7 +34,21 @@ public fun main() {
     server.start(wait = true)
 }
 
-internal fun Application.main(client: HttpClient = defaultHttpClient { installCallValidator() }) {
+internal fun Application.main() {
+    val client = HttpClient {
+        DefaultHttpConfiguration()
+
+        install(HttpCache) {
+            publicStorage(PlatformContext.Default.resolveCacheDir())
+        }
+
+        install(HttpCallValidator) {
+            throwClientRequestExceptionAs<GoogleApiException>()
+        }
+
+        expectSuccess = true
+    }
+
     install(DefaultHeaders, DefaultHeadersConfig::headers)
     install(Compression, CompressionConfig::default)
     install(ContentNegotiation, Configuration::json)

diff --git a/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/Validator.kt b/cloud-run/src/commonMain/kotlin/io/ashdavies/cloud/Validator.kt
diff --git a/http-client/build.gradle.kts b/http-client/build.gradle.kts
@@ -6,6 +6,7 @@ plugins {
 kotlin {
     sourceSets.commonMain.dependencies {
         implementation(projects.httpCommon)
+        implementation(projects.platformSupport)
 
         implementation(compose.runtime)
 

diff --git a/http-client/src/commonMain/kotlin/io/ashdavies/http/CallValidator.kt b/http-client/src/commonMain/kotlin/io/ashdavies/http/CallValidator.kt
@@ -0,0 +1,11 @@
+package io.ashdavies.http
+
+import io.ktor.client.call.body
+import io.ktor.client.plugins.ClientRequestException
+import io.ktor.client.plugins.HttpCallValidator
+
+public inline fun <reified T : Exception> HttpCallValidator.Config.throwClientRequestExceptionAs() {
+    handleResponseExceptionWithRequest { exception, _ ->
+        if (exception is ClientRequestException) throw exception.response.body<T>()
+    }
+}
diff --git a/http-client/src/commonMain/kotlin/io/ashdavies/http/HttpCache.kt b/http-client/src/commonMain/kotlin/io/ashdavies/http/HttpCache.kt
@@ -0,0 +1,9 @@
+package io.ashdavies.http
+
+import io.ktor.client.plugins.cache.HttpCache
+import io.ktor.client.plugins.cache.storage.FileStorage
+import okio.Path
+
+public fun HttpCache.Config.publicStorage(path: Path) {
+    publicStorage(FileStorage(path.toFile()))
+}