Allow adding a cache listener

mizosoft · Dec 22, 2024 · 0344165 · 0344165
1 parent 6f279fb
commit 0344165
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 9 deletions.
diff --git a/methanol-kotlin/src/main/kotlin/com/github/mizosoft/methanol/kotlin/Cache.kt b/methanol-kotlin/src/main/kotlin/com/github/mizosoft/methanol/kotlin/Cache.kt
@@ -39,6 +39,8 @@ interface CacheSpec {
 
   fun executor(executor: Executor)
 
+  fun listener(listener: CacheListener)
+
   fun synchronizeWrites(synchronizeWrites: Boolean = true)
 }
 
@@ -56,6 +58,10 @@ private class CacheFactorySpec(private val builder: HttpCache.Builder = Cache.ne
     builder.cacheOn(storageExtension)
   }
 
+  override fun listener(listener: CacheListener) {
+    builder.listener(listener)
+  }
+
   override fun executor(executor: Executor) {
     builder.executor(executor)
   }
@@ -84,6 +90,8 @@ private class CacheChainFactorySpec(private val caches: MutableList<Cache> = Arr
 
 typealias Cache = HttpCache
 
+typealias CacheListener = HttpCache.Listener
+
 /** A series of caches invoked sequentially during an HTTP call. */
 typealias CacheChain = List<Cache>
 

diff --git a/methanol-kotlin/src/main/kotlin/com/github/mizosoft/methanol/kotlin/Response.kt b/methanol-kotlin/src/main/kotlin/com/github/mizosoft/methanol/kotlin/Response.kt
@@ -34,7 +34,7 @@ suspend inline fun <reified T> ResponsePayload.to(): T {
 }
 
 /** Converts this payload to [T] using the given body handler. */
-suspend fun <T> ResponsePayload.with(bodyHandler: BodyHandler<T>): T {
+suspend fun <T> ResponsePayload.getWith(bodyHandler: BodyHandler<T>): T {
   return handleWithAsync(bodyHandler).await()
 }
 

diff --git a/methanol/src/main/java/com/github/mizosoft/methanol/HttpCache.java b/methanol/src/main/java/com/github/mizosoft/methanol/HttpCache.java
@@ -1062,7 +1062,7 @@ public static final class Builder {
     /** Specifies that HTTP responses are to be cached on memory with the given size bound. */
     @CanIgnoreReturnValue
     public Builder cacheOnMemory(long maxSize) {
-      return cacheOn(StorageExtension.memory(maxSize));
+      return cacheOn(StorageExtension.inMemory(maxSize));
     }
 
     /**
@@ -1071,15 +1071,16 @@ public Builder cacheOnMemory(long maxSize) {
      */
     @CanIgnoreReturnValue
     public Builder cacheOnDisk(Path directory, long maxSize) {
-      return cacheOn(StorageExtension.disk(directory, maxSize));
+      return cacheOn(StorageExtension.onDisk(directory, maxSize));
     }
 
+    /** Specifies that HTTP responses are to be persisted on the given storage extension. */
     @CanIgnoreReturnValue
     public Builder cacheOn(StorageExtension storageExtension) {
       requireNonNull(storageExtension);
       requireArgument(
           storageExtension instanceof InternalStorageExtension,
-          "unrecognized StorageExtension: %s",
+          "Unrecognized StorageExtension: %s",
           storageExtension);
       this.storageExtension = (InternalStorageExtension) storageExtension;
       return this;
@@ -1129,7 +1130,7 @@ Builder clock(Clock clock) {
 
     private InternalStorageExtension storageExtension() {
       var storeExtension = this.storageExtension;
-      requireState(storeExtension != null, "a storage backend must be specified");
+      requireState(storeExtension != null, "A storage backend must be specified");
       return storeExtension;
     }
 

diff --git a/methanol/src/main/java/com/github/mizosoft/methanol/StorageExtension.java b/methanol/src/main/java/com/github/mizosoft/methanol/StorageExtension.java
@@ -34,12 +34,20 @@
 
 /** An extension that provides a storage backend for an {@link HttpCache}. */
 public interface StorageExtension {
-  static StorageExtension memory(long maxSize) {
-    requireArgument(maxSize > 0, "non-positive maxSize: %d", maxSize);
+
+  /** Returns a {@code StorageExtension} for saving data in memory, not exceeding the given size. */
+  static StorageExtension inMemory(long maxSize) {
+    requireArgument(maxSize > 0, "Non-positive maxSize: %d", maxSize);
     return (InternalStorageExtension) (executor, appVersion) -> new MemoryStore(maxSize);
   }
 
-  static StorageExtension disk(Path directory, long maxSize) {
+  /**
+   * Returns a {@code StorageExtension} for saving data on disk under the given directory, not
+   * exceeding the given size.
+   *
+   * @throws IllegalArgumentException if {@code maxSize} is not positive
+   */
+  static StorageExtension onDisk(Path directory, long maxSize) {
     requireNonNull(directory);
     requireArgument(maxSize > 0, "Non-positive maxSize: %d", maxSize);
     return (InternalStorageExtension)

diff --git a/methanol/src/main/java/com/github/mizosoft/methanol/internal/cache/CacheInterceptor.java b/methanol/src/main/java/com/github/mizosoft/methanol/internal/cache/CacheInterceptor.java
@@ -210,9 +210,9 @@ private boolean isCacheable(HttpRequest request, TrackedResponse<?> response) {
 
     Set<String> varyFields;
     try {
-      // Don't crash because of server's ill-formed Vary.
       varyFields = CacheResponseMetadata.varyFields(response.headers());
     } catch (IllegalArgumentException e) {
+      // Don't crash because of server's ill-formed Vary.
       logger.log(Level.WARNING, "Invalid response Vary", e);
       return false;
     }