library/com.gabrielfeo.develocity.api/Config/CacheConfig

CacheConfig

data class CacheConfig(val cacheEnabled: Boolean = env["DEVELOCITY_API_CACHE_ENABLED"].toBoolean(), val cacheDir: File = env["DEVELOCITY_API_CACHE_DIR"]?.let(::File) ?: run { val userHome = checkNotNull(systemProperties.userHome) { ERROR_NULL_USER_HOME } File(userHome, ".develocity-api-kotlin-cache") }, val maxCacheSize: Long = env["DEVELOCITY_API_MAX_CACHE_SIZE"]?.toLong() ?: 1_000_000_000L, val longTermCacheUrlPattern: Regex = env["DEVELOCITY_API_LONG_TERM_CACHE_URL_PATTERN"]?.toRegex() ?: Regex( """ .*/api/builds/[\d\w]+/(?:gradle|maven)-(?:attributes|build-cache-performance) """.trimIndent() ), val longTermCacheMaxAge: Long = env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong() ?: 365.days.inWholeSeconds, val shortTermCacheUrlPattern: Regex = env["DEVELOCITY_API_SHORT_TERM_CACHE_URL_PATTERN"]?.toRegex() ?: """.*/builds(?:\?.*|\Z)""".toRegex(), val shortTermCacheMaxAge: Long = env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong() ?: 1.days.inWholeSeconds)(source)

HTTP cache is off by default, but can speed up requests significantly. The Develocity API disallows HTTP caching, but this library forcefully enables it by overwriting cache-related headers in API responses. Enable with cacheEnabled.

Responses can be:

cached short-term: default max-age of 1 day
/api/builds
cached long-term: default max-age of 1 year
/api/builds/{id}/gradle-attributes
/api/builds/{id}/maven-attributes
/api/builds/{id}/gradle-build-cache-performance
/api/builds/{id}/maven-build-cache-performance
not cached
all other paths

Whether a response is cached short-term, long-term or not cached at all depends on whether it was matched by shortTermCacheUrlPattern or longTermCacheUrlPattern.

Whenever Develocity is upgraded, cache should be cleared.

Caveats

While not encouraged by the API, caching shouldn't have any major downsides other than a time gap for certain queries, or having to reset cache when Develocity is upgraded.

Time gap

/api/builds responses always change as new builds are uploaded. Caching this path short-term (default 1 day) means new builds uploaded after the cached response won't be included in the query until the cache is invalidated 24h later. If that's a problem, caching can be disabled for this /api/builds by changing shortTermCacheUrlPattern.

Develocity upgrades

When Develocity is upgraded, any API response can change. New data might be available in API endpoints such as /api/build/{id}/gradle-attributes. Thus, whenever the Develocity version itself is upgraded, cache should be cleared.

Constructors

CacheConfig

constructor(cacheEnabled: Boolean = env["DEVELOCITY_API_CACHE_ENABLED"].toBoolean(), cacheDir: File = env["DEVELOCITY_API_CACHE_DIR"]?.let(::File) ?: run { val userHome = checkNotNull(systemProperties.userHome) { ERROR_NULL_USER_HOME } File(userHome, ".develocity-api-kotlin-cache") }, maxCacheSize: Long = env["DEVELOCITY_API_MAX_CACHE_SIZE"]?.toLong() ?: 1_000_000_000L, longTermCacheUrlPattern: Regex = env["DEVELOCITY_API_LONG_TERM_CACHE_URL_PATTERN"]?.toRegex() ?: Regex( """ .*/api/builds/[\d\w]+/(?:gradle|maven)-(?:attributes|build-cache-performance) """.trimIndent() ), longTermCacheMaxAge: Long = env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong() ?: 365.days.inWholeSeconds, shortTermCacheUrlPattern: Regex = env["DEVELOCITY_API_SHORT_TERM_CACHE_URL_PATTERN"]?.toRegex() ?: """.*/builds(?:\?.*|\Z)""".toRegex(), shortTermCacheMaxAge: Long = env["DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE"]?.toLong() ?: 1.days.inWholeSeconds)

Properties

cacheDir

val cacheDir: File

HTTP cache location. By default, uses environment variable DEVELOCITY_API_CACHE_DIR or creates a ~/.develocity-api-kotlin-cache directory.

cacheEnabled

val cacheEnabled: Boolean

Whether caching is enabled. By default, uses environment variable DEVELOCITY_API_CACHE_ENABLED or false.

longTermCacheMaxAge

val longTermCacheMaxAge: Long

Max age in seconds for URLs to be cached long-term (matched by longTermCacheUrlPattern). By default, uses environment variable DEVELOCITY_API_LONG_TERM_CACHE_MAX_AGE or 1 year.

longTermCacheUrlPattern

val longTermCacheUrlPattern: Regex

Regex pattern to match API URLs that are OK to store long-term in the HTTP cache, up to longTermCacheMaxAge (1y by default, max value). By default, uses environment variable DEVELOCITY_API_LONG_TERM_CACHE_URL_PATTERN or a pattern matching:

maxCacheSize

val maxCacheSize: Long

Max size of the HTTP cache. By default, uses environment variable DEVELOCITY_API_MAX_CACHE_SIZE or ~1 GB.

shortTermCacheMaxAge

val shortTermCacheMaxAge: Long

Max age in seconds for URLs to be cached short-term (matched by shortTermCacheUrlPattern). By default, uses environment variable DEVELOCITY_API_SHORT_TERM_CACHE_MAX_AGE or 1 day.

shortTermCacheUrlPattern

val shortTermCacheUrlPattern: Regex

Regex pattern to match API URLs that are OK to store short-term in the HTTP cache, up to shortTermCacheMaxAge (1d by default). By default, uses environment variable DEVELOCITY_API_SHORT_TERM_CACHE_URL_PATTERN or a pattern matching: