Merge pull request #35 from momentohq/add-list-caches

chore: add list caches API
momentohq · Jan 9, 2024 · ee37c98 · ee37c98
2 parents 4de03e8 + 75c382e
commit ee37c98
Show file tree

Hide file tree

Showing 8 changed files with 135 additions and 0 deletions.
diff --git a/src/androidInstrumentedTest/kotlin/software/momento/kotlin/sdk/CacheClientControlTest.kt b/src/androidInstrumentedTest/kotlin/software/momento/kotlin/sdk/CacheClientControlTest.kt
@@ -7,6 +7,7 @@ import org.junit.runner.RunWith
 import software.momento.kotlin.sdk.exceptions.NotFoundException
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 import java.util.*
 import kotlin.test.Test
 
@@ -44,4 +45,24 @@ class CacheClientControlTest: BaseAndroidTestClass() {
             assert((deleteResponse as CacheDeleteResponse.Error).cause is NotFoundException)
         }
     }
+
+    @Test
+    fun listCacheHappyPath() = runTest  {
+        val cacheName = "kotlin-android-create-delete-${UUID.randomUUID()}"
+        var createResponse = cacheClient.createCache(cacheName)
+        assert(createResponse is CacheCreateResponse.Success)
+
+        try {
+            var listCachesResponse = cacheClient.listCaches()
+            assert(listCachesResponse is CacheListResponse.Success)
+
+            val caches = (listCachesResponse as CacheListResponse.Success).caches
+            val cacheNames = caches.map { it.name }
+            assert(cacheNames.contains(cacheName))
+
+        } finally {
+            var deleteResponse = cacheClient.deleteCache(cacheName)
+            assert(deleteResponse is CacheDeleteResponse.Success)
+        }
+    }
 }
diff --git a/src/androidMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.android.kt b/src/androidMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.android.kt
@@ -2,13 +2,17 @@ package software.momento.kotlin.sdk.internal
 
 import grpc.control_client._CreateCacheRequest
 import grpc.control_client._DeleteCacheRequest
+import grpc.control_client._ListCachesRequest
+import io.grpc.Metadata
 import software.momento.kotlin.sdk.auth.CredentialProvider
 import software.momento.kotlin.sdk.config.Configuration
 import software.momento.kotlin.sdk.exceptions.CacheServiceExceptionMapper
 import software.momento.kotlin.sdk.exceptions.MomentoErrorCode
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
 import software.momento.kotlin.sdk.internal.utils.ValidationUtils
+import software.momento.kotlin.sdk.responses.cache.control.CacheInfo
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 
 internal actual class InternalControlClient actual constructor(
     credentialProvider: CredentialProvider,
@@ -72,6 +76,29 @@ internal actual class InternalControlClient actual constructor(
         })
     }
 
+    internal actual suspend fun listCaches(): CacheListResponse {
+        return runCatching {}.fold(onSuccess = {
+            sendListCaches()
+        }, onFailure = { e ->
+            CacheListResponse.Error(CacheServiceExceptionMapper.convert(e))
+        })
+    }
+
+    private suspend fun sendListCaches(): CacheListResponse {
+        val request = _ListCachesRequest.newBuilder().setNextToken("").build()
+        val metadata = Metadata()
+
+        return runCatching {
+            this.stubsManager.stub.listCaches(request, metadata)
+        }.fold(onSuccess = { listCacheResponse ->
+            CacheListResponse.Success(
+                listCacheResponse.cacheList.map { CacheInfo(it.cacheName) }
+            )
+        }, onFailure = { e ->
+            CacheListResponse.Error(CacheServiceExceptionMapper.convert(e, metadata))
+        })
+    }
+
     override fun close() {
         stubsManager.close()
     }

diff --git a/src/commonMain/kotlin/software/momento/kotlin/sdk/CacheClient.kt b/src/commonMain/kotlin/software/momento/kotlin/sdk/CacheClient.kt
@@ -9,6 +9,7 @@ import software.momento.kotlin.sdk.responses.cache.GetResponse
 import software.momento.kotlin.sdk.responses.cache.SetResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 import kotlin.time.Duration
 
 /**
@@ -51,6 +52,15 @@ public class CacheClient(
         return controlClient.deleteCache(cacheName)
     }
 
+    /**
+     * Asynchronously lists all the caches in the account.
+     *
+     * @return The result of the cache list: [CacheListResponse.Success] or [CacheListResponse.Error].
+     */
+    public suspend fun listCaches(): CacheListResponse {
+        return controlClient.listCaches()
+    }
+
     /**
      * Asynchronously sets the value in cache with a given Time To Live (TTL) seconds.
      *

diff --git a/src/commonMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.kt b/src/commonMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.kt
@@ -4,11 +4,14 @@ import software.momento.kotlin.sdk.auth.CredentialProvider
 import software.momento.kotlin.sdk.config.Configuration
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 
 internal expect class InternalControlClient(credentialProvider: CredentialProvider, configuration: Configuration) :
     InternalClient {
 
     internal suspend fun createCache(cacheName: String): CacheCreateResponse
 
     internal suspend fun deleteCache(cacheName: String): CacheDeleteResponse
+
+    internal suspend fun listCaches(): CacheListResponse
 }
diff --git a/src/commonMain/kotlin/software/momento/kotlin/sdk/responses/cache/control/CacheInfo.kt b/src/commonMain/kotlin/software/momento/kotlin/sdk/responses/cache/control/CacheInfo.kt
@@ -0,0 +1,6 @@
+package software.momento.kotlin.sdk.responses.cache.control
+
+/** Information about a cache.
+ *  @param name the cache name
+ * */
+public data class CacheInfo(public val name: String)
diff --git a/...ommonMain/kotlin/software/momento/kotlin/sdk/responses/cache/control/CacheListResponse.kt b/...ommonMain/kotlin/software/momento/kotlin/sdk/responses/cache/control/CacheListResponse.kt
@@ -0,0 +1,18 @@
+package software.momento.kotlin.sdk.responses.cache.control
+
+import software.momento.kotlin.sdk.exceptions.SdkException
+
+/** Response for a list caches operation. */
+public sealed interface CacheListResponse {
+
+    /** A successful list caches operation. Contains the discovered caches.  */
+    public data class Success(val caches: List<CacheInfo>) : CacheListResponse
+
+    /**
+     * A failed list caches operation. The response itself is an exception, so it can be directly
+     * thrown, or the cause of the error can be retrieved with [.getCause]. The message is a
+     * copy of the message of the cause.
+     */
+    public class Error(cause: SdkException) : SdkException(cause), CacheListResponse
+
+}
diff --git a/src/jvmMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.jvm.kt b/src/jvmMain/kotlin/software/momento/kotlin/sdk/internal/InternalControlClient.jvm.kt
@@ -2,13 +2,17 @@ package software.momento.kotlin.sdk.internal
 
 import grpc.control_client._CreateCacheRequest
 import grpc.control_client._DeleteCacheRequest
+import grpc.control_client._ListCachesRequest
+import io.grpc.Metadata
 import software.momento.kotlin.sdk.auth.CredentialProvider
 import software.momento.kotlin.sdk.config.Configuration
 import software.momento.kotlin.sdk.exceptions.CacheServiceExceptionMapper
 import software.momento.kotlin.sdk.exceptions.MomentoErrorCode
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
 import software.momento.kotlin.sdk.internal.utils.ValidationUtils
+import software.momento.kotlin.sdk.responses.cache.control.CacheInfo
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 
 internal actual class InternalControlClient actual constructor(
     credentialProvider: CredentialProvider, configuration: Configuration
@@ -56,6 +60,29 @@ internal actual class InternalControlClient actual constructor(
         })
     }
 
+    internal actual suspend fun listCaches(): CacheListResponse {
+        return runCatching {}.fold(onSuccess = {
+            sendListCaches()
+        }, onFailure = { e ->
+            CacheListResponse.Error(CacheServiceExceptionMapper.convert(e))
+        })
+    }
+
+    private suspend fun sendListCaches(): CacheListResponse {
+        val request = _ListCachesRequest.newBuilder().setNextToken("").build()
+        val metadata = Metadata()
+
+        return runCatching {
+            this.stubsManager.stub.listCaches(request, metadata)
+        }.fold(onSuccess = { listCacheResponse ->
+            CacheListResponse.Success(
+                listCacheResponse.cacheList.map { CacheInfo(it.cacheName) }
+            )
+        }, onFailure = { e ->
+            CacheListResponse.Error(CacheServiceExceptionMapper.convert(e, metadata))
+        })
+    }
+
     private suspend fun sendDeleteCache(
         cacheName: String
     ): CacheDeleteResponse {

diff --git a/src/jvmTest/kotlin/software/momento/kotlin/sdk/CacheClientControlTest.kt b/src/jvmTest/kotlin/software/momento/kotlin/sdk/CacheClientControlTest.kt
@@ -4,8 +4,11 @@ import kotlinx.coroutines.test.runTest
 import software.momento.kotlin.sdk.exceptions.NotFoundException
 import software.momento.kotlin.sdk.responses.cache.control.CacheCreateResponse
 import software.momento.kotlin.sdk.responses.cache.control.CacheDeleteResponse
+import software.momento.kotlin.sdk.responses.cache.control.CacheListResponse
 import java.util.*
 import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
 
 class CacheClientControlTest: BaseJvmTestClass() {
 
@@ -39,4 +42,24 @@ class CacheClientControlTest: BaseJvmTestClass() {
             assert((deleteResponse as CacheDeleteResponse.Error).cause is NotFoundException)
         }
     }
+
+    @Test
+    fun listCacheHappyPath() = runTest  {
+        val cacheName = "kotlin-jvm-create-delete-${UUID.randomUUID()}"
+        var createResponse = cacheClient.createCache(cacheName)
+        assert(createResponse is CacheCreateResponse.Success)
+
+        try {
+            var listCachesResponse = cacheClient.listCaches()
+            assert(listCachesResponse is CacheListResponse.Success)
+
+            val caches = (listCachesResponse as CacheListResponse.Success).caches
+            val cacheNames = caches.map { it.name }
+            assertTrue(cacheName in cacheNames, "$cacheName should be one of the cache names")
+
+        } finally {
+            var deleteResponse = cacheClient.deleteCache(cacheName)
+            assert(deleteResponse is CacheDeleteResponse.Success)
+        }
+    }
 }