Add maximumCachedObjectLength to limit the cached entry size

Author: vlsi

README.md

@@ -47,6 +47,7 @@ The AWS S3 build cache implementation has a few configuration options:
 | `region` | The AWS region the S3 bucket is located in. | yes | |
 | `bucket` | The name of the AWS S3 bucket where cache objects should be stored. | yes | |
 | `path` | The path under which all cache objects should be stored. | no | |
+| `maximumCachedObjectLength` | Maximum object size that can be stored and retrieved from the cache | no | 50'000'000 |
 | `reducedRedundancy` | Whether or not to use [reduced redundancy](https://aws.amazon.com/s3/reduced-redundancy/). | no | true |
 | `endpoint` | Alternative S3 compatible endpoint | no | |
 | `headers` | A map with HTTP headers to be added to each request (nulls are ignored). e.g. `[ 'x-header-name': 'header-value' ]` | no | |
@@ -61,9 +62,9 @@ The `buildCache` configuration block might look like this:
 
 ```
  apply plugin: 'ch.myniva.s3-build-cache'
- 
+
  ext.isCiServer = System.getenv().containsKey("CI")
- 
+
  buildCache {
      local {
          enabled = !isCiServer
@@ -74,7 +75,6 @@ The `buildCache` configuration block might look like this:
          push = isCiServer
      }
  }
-
 ```
 
 More details about configuring the Gradle build cache can be found in the

src/main/kotlin/ch/myniva/gradle/caching/s3/AwsS3BuildCache.kt

@@ -21,6 +21,7 @@ open class AwsS3BuildCache : AbstractBuildCache() {
     var region: String? = null
     var bucket: String? = null
     var path: String? = null
+    var maximumCachedObjectLength: Long = 50 * 1024 * 1024
     var isReducedRedundancy = true
     var endpoint: String? = null
     var headers: Map<String?, String?>? = null

src/main/kotlin/ch/myniva/gradle/caching/s3/internal/AwsS3BuildCacheService.kt

@@ -30,7 +30,8 @@ class AwsS3BuildCacheService internal constructor(
     private val s3: AmazonS3,
     private val bucketName: String,
     private val path: String?,
-    private val reducedRedundancy: Boolean
+    private val reducedRedundancy: Boolean,
+    private val maximumCachedObjectLength: Long
 ) : BuildCacheService {
     companion object {
         private const val BUILD_CACHE_CONTENT_TYPE = "application/vnd.gradle.build-cache-artifact"
@@ -49,6 +50,16 @@ class AwsS3BuildCacheService internal constructor(
         val bucketPath = key.getBucketPath()
         try {
             s3.getObject(bucketName, bucketPath).use { s3Object ->
+                if (s3Object.objectMetadata.contentLength > maximumCachedObjectLength) {
+                    logger.info(
+                        "Cache item '{}' '{}' in S3 bucket size is {}, and it exceeds maximumCachedObjectLength {}. Will skip the retrieval",
+                        key.displayName,
+                        bucketPath,
+                        s3Object.objectMetadata.contentLength,
+                        maximumCachedObjectLength
+                    )
+                    return false
+                }
                 reader.readFrom(s3Object.objectContent)
             }
             return true
@@ -76,6 +87,17 @@ class AwsS3BuildCacheService internal constructor(
 
     override fun store(key: BuildCacheKey, writer: BuildCacheEntryWriter) {
         val bucketPath = key.getBucketPath()
+        val itemSize = writer.size
+        if (itemSize > maximumCachedObjectLength) {
+            logger.info(
+                "Cache item '{}' '{}' in S3 bucket size is {}, and it exceeds maximumCachedObjectLength {}. Will skip caching it.",
+                key.displayName,
+                bucketPath,
+                itemSize,
+                maximumCachedObjectLength
+            )
+            return
+        }
         logger.info("Start storing cache entry '{}' in S3 bucket", bucketPath)
         val meta = ObjectMetadata().apply {
             contentType = BUILD_CACHE_CONTENT_TYPE

src/main/kotlin/ch/myniva/gradle/caching/s3/internal/AwsS3BuildCacheServiceFactory.kt

@@ -50,7 +50,8 @@ class AwsS3BuildCacheServiceFactory : BuildCacheServiceFactory<AwsS3BuildCache>
             createS3Client(config),
             config.bucket!!,
             config.path,
-            config.isReducedRedundancy
+            config.isReducedRedundancy,
+            config.maximumCachedObjectLength
         )
     }