Allow configuring cacheable URLs from env

Author: gabrielfeo

src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/Api.kt

@@ -1,3 +1,5 @@
+@file:Suppress("unused")
+
 package com.gabrielfeo.gradle.enterprise.api
 
 import com.gabrielfeo.gradle.enterprise.api.internal.*
@@ -40,17 +42,19 @@ fun shutdown() {
 }
 
 /**
- * List of patterns matching API URLs that are OK to store in the HTTP cache. Matches by default:
+ * Regex pattern to match API URLs that are OK to store in the HTTP cache. Matches by default:
  * - {host}/api/builds/{id}/gradle-attributes
  * - {host}/api/builds/{id}/maven-attributes
  *
- * By default, the Gradle Enterprise disallows HTTP caching via response headers. This library
+ * By default, the Gradle Enterprise API disallows HTTP caching via response headers. This library
  * removes such headers to forcefully allow caching, if the path is matched by any of these
  * patterns.
+ *
+ * Use `|` to define multiple patterns in one, e.g. `.*gradle-attributes|.*test-distribution`.
  */
-val cacheablePaths: MutableList<Regex> = mutableListOf(
-    """.*/api/builds/[\d\w]+/(?:gradle|maven)-attributes""".toRegex(),
-)
+val cacheableUrlPattern: Regex = System.getenv("GRADLE_ENTERPRISE_API_CACHEABLE_URL_PATTERN")
+    ?.toRegex()
+    ?: """.*/api/builds/[\d\w]+/(?:gradle|maven)-attributes""".toRegex()
 
 /**
  * Maximum amount of concurrent requests allowed. Further requests will be queued. By default,

src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/OkHttpClient.kt

@@ -2,7 +2,7 @@ package com.gabrielfeo.gradle.enterprise.api.internal
 
 import com.gabrielfeo.gradle.enterprise.api.accessToken
 import com.gabrielfeo.gradle.enterprise.api.auth.HttpBearerAuth
-import com.gabrielfeo.gradle.enterprise.api.cacheablePaths
+import com.gabrielfeo.gradle.enterprise.api.cacheableUrlPattern
 import com.gabrielfeo.gradle.enterprise.api.internal.caching.CacheEnforcingInterceptor
 import com.gabrielfeo.gradle.enterprise.api.internal.caching.CacheHitLoggingInterceptor
 import com.gabrielfeo.gradle.enterprise.api.internal.caching.cache
@@ -14,7 +14,7 @@ val okHttpClient: OkHttpClient by lazy {
         .cache(cache)
         .addInterceptor(HttpBearerAuth("bearer", accessToken()))
         .addInterceptor(CacheHitLoggingInterceptor())
-        .addNetworkInterceptor(CacheEnforcingInterceptor(cacheablePaths))
+        .addNetworkInterceptor(CacheEnforcingInterceptor(cacheableUrlPattern))
         .build()
         .apply {
             dispatcher.maxRequests = maxConcurrentRequests

src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/internal/caching/CacheEnforcingInterceptor.kt

@@ -6,7 +6,7 @@ import okhttp3.Response
 import kotlin.time.Duration.Companion.days
 
 internal class CacheEnforcingInterceptor(
-    private val cacheablePaths: List<Regex>,
+    private val cacheableUrlPattern: Regex,
 ) : Interceptor {
 
     private val maxAge = 365.days.inWholeMilliseconds
@@ -25,5 +25,5 @@ internal class CacheEnforcingInterceptor(
     }
 
     private fun isCacheable(request: Request) =
-        cacheablePaths.any { it.matches(request.url.toString()) }
+        cacheableUrlPattern.matches(request.url.toString())
 }