[jacodb-storage, jacodb-core] Move pluggable caches to jacodb-storage (#304)

Saloed · web-flow · commit 6db1ff5a98e1 · 2025-02-11T00:11:45.000+03:00
Pluggable caches API moved to the jacodb-storage-api module, implementations
are in the jacodb-storage module. The jacodb-storage module has compileOnly
dependencies on the libraries providing caches. So to use caches without
dependency on the jacodb-core module, one should define particular
dependency of the caching library, Guava or Xodus.
diff --git a/jacodb-api-jvm/src/main/kotlin/org/jacodb/api/jvm/Settings.kt b/jacodb-api-jvm/src/main/kotlin/org/jacodb/api/jvm/Settings.kt
@@ -18,6 +18,7 @@ package org.jacodb.api.jvm
 
 import kotlinx.collections.immutable.persistentListOf
 import kotlinx.collections.immutable.toPersistentList
+import org.jacodb.api.caches.ValueStoreType
 import java.io.File
 import java.time.Duration
 
@@ -186,8 +187,6 @@ data class JcCacheSegmentSettings(
     val expiration: Duration = Duration.ofMinutes(1)
 )
 
-enum class ValueStoreType { WEAK, SOFT, STRONG }
-
 class JcCacheSettings {
     var cacheSpiId: String? = null
     var classes: JcCacheSegmentSettings = JcCacheSegmentSettings()
diff --git a/jacodb-api-storage/src/main/kotlin/org/jacodb/api/caches/PluggableCacheProvider.kt b/jacodb-api-storage/src/main/kotlin/org/jacodb/api/caches/PluggableCacheProvider.kt
@@ -14,7 +14,7 @@
  *  limitations under the License.
  */
 
-package org.jacodb.impl.caches
+package org.jacodb.api.caches
 
 import org.jacodb.api.spi.CommonSPI
 import org.jacodb.api.spi.SPILoader
diff --git a/jacodb-api-storage/src/main/kotlin/org/jacodb/api/caches/PluggableCaches.kt b/jacodb-api-storage/src/main/kotlin/org/jacodb/api/caches/PluggableCaches.kt
@@ -14,11 +14,12 @@
  *  limitations under the License.
  */
 
-package org.jacodb.impl.caches
+package org.jacodb.api.caches
 
-import org.jacodb.api.jvm.ValueStoreType
 import java.time.Duration
 
+enum class ValueStoreType { WEAK, SOFT, STRONG }
+
 class PluggableCacheException(message: String) : RuntimeException(message)
 
 interface PluggableCache<K : Any, V : Any> {
diff --git a/jacodb-benchmarks/src/test/kotlin/org/jacodb/testing/performance/caches/PluggableCacheBenchmarks.kt b/jacodb-benchmarks/src/test/kotlin/org/jacodb/testing/performance/caches/PluggableCacheBenchmarks.kt
@@ -17,8 +17,8 @@
 package org.jacodb.testing.performance.caches
 
 import kotlinx.benchmark.Blackhole
-import org.jacodb.api.jvm.ValueStoreType
-import org.jacodb.impl.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCache
+import org.jacodb.api.caches.ValueStoreType
 import org.jacodb.impl.caches.xodus.XODUS_CACHE_PROVIDER_ID
 import org.openjdk.jmh.annotations.Benchmark
 import org.openjdk.jmh.annotations.BenchmarkMode
diff --git a/jacodb-core/src/main/kotlin/org/jacodb/impl/features/classpaths/ClasspathCache.kt b/jacodb-core/src/main/kotlin/org/jacodb/impl/features/classpaths/ClasspathCache.kt
@@ -17,6 +17,9 @@
 package org.jacodb.impl.features.classpaths
 
 import mu.KLogging
+import org.jacodb.api.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCacheProvider
+import org.jacodb.api.caches.PluggableCacheStats
 import org.jacodb.api.jvm.JcCacheSegmentSettings
 import org.jacodb.api.jvm.JcCacheSettings
 import org.jacodb.api.jvm.JcClassType
@@ -35,9 +38,6 @@ import org.jacodb.api.jvm.cfg.JcInst
 import org.jacodb.api.jvm.cfg.JcInstList
 import org.jacodb.api.jvm.cfg.JcRawInst
 import org.jacodb.api.jvm.ext.JAVA_OBJECT
-import org.jacodb.impl.caches.PluggableCache
-import org.jacodb.impl.caches.PluggableCacheProvider
-import org.jacodb.impl.caches.PluggableCacheStats
 import org.jacodb.impl.caches.xodus.XODUS_CACHE_PROVIDER_ID
 import org.jacodb.impl.features.classpaths.AbstractJcInstResult.JcFlowGraphResultImpl
 import org.jacodb.impl.features.classpaths.AbstractJcInstResult.JcInstListResultImpl
diff --git a/jacodb-core/src/main/kotlin/org/jacodb/impl/storage/AbstractJcDbPersistence.kt b/jacodb-core/src/main/kotlin/org/jacodb/impl/storage/AbstractJcDbPersistence.kt
@@ -16,12 +16,12 @@
 
 package org.jacodb.impl.storage
 
+import org.jacodb.api.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCacheProvider
 import org.jacodb.api.jvm.JcByteCodeLocation
 import org.jacodb.api.jvm.JcDatabasePersistence
 import org.jacodb.api.jvm.RegisteredLocation
 import org.jacodb.api.storage.ers.getEntityOrNull
-import org.jacodb.impl.caches.PluggableCache
-import org.jacodb.impl.caches.PluggableCacheProvider
 import org.jacodb.impl.caches.xodus.XODUS_CACHE_PROVIDER_ID
 import org.jacodb.impl.fs.JavaRuntime
 import org.jacodb.impl.fs.asByteCodeLocation
@@ -73,7 +73,7 @@ abstract class AbstractJcDbPersistence(
                 ).mapNotNull {
                     try {
                         File(it.path).asByteCodeLocation(javaRuntime.version, isRuntime = it.runtime)
-                    } catch (e: Exception) {
+                    } catch (_: Exception) {
                         null
                     }
                 }.flatten().distinct()
@@ -131,7 +131,7 @@ abstract class AbstractJcDbPersistence(
     override fun close() {
         try {
             symbolInterner.close()
-        } catch (e: Exception) {
+        } catch (_: Exception) {
             // ignore
         }
     }
diff --git a/jacodb-core/src/testFixtures/kotlin/org/jacodb/testing/caches/PluggableCacheTest.kt b/jacodb-core/src/testFixtures/kotlin/org/jacodb/testing/caches/PluggableCacheTest.kt
@@ -16,7 +16,7 @@
 
 package org.jacodb.testing.caches
 
-import org.jacodb.impl.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCache
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
diff --git a/jacodb-storage/build.gradle.kts b/jacodb-storage/build.gradle.kts
@@ -4,7 +4,8 @@ dependencies {
     compileOnly(Libs.xodusEnvironment)
     compileOnly(Libs.lmdb_java)
     compileOnly(Libs.rocks_db)
-
+    compileOnly(Libs.guava)
+    compileOnly(Libs.xodusUtils)
 
     testImplementation(Libs.xodusEnvironment)
     testImplementation(Libs.lmdb_java)
diff --git a/jacodb-storage/src/main/kotlin/org/jacodb/impl/caches/guava/GuavaCaches.kt b/jacodb-storage/src/main/kotlin/org/jacodb/impl/caches/guava/GuavaCaches.kt
@@ -18,12 +18,11 @@ package org.jacodb.impl.caches.guava
 
 import com.google.common.cache.Cache
 import com.google.common.cache.CacheBuilder
-import org.jacodb.api.jvm.ValueStoreType
-import org.jacodb.impl.caches.PluggableCache
-import org.jacodb.impl.caches.PluggableCacheBuilder
-import org.jacodb.impl.caches.PluggableCacheProvider
-import org.jacodb.impl.caches.PluggableCacheStats
-import java.time.Duration
+import org.jacodb.api.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCacheBuilder
+import org.jacodb.api.caches.PluggableCacheProvider
+import org.jacodb.api.caches.PluggableCacheStats
+import org.jacodb.api.caches.ValueStoreType
 
 const val GUAVA_CACHE_PROVIDER_ID = "org.jacodb.impl.caches.guava.GuavaCacheProvider"
 
@@ -42,7 +41,7 @@ private class GuavaCacheBuilder<K : Any, V : Any> : PluggableCacheBuilder<K, V>(
                 .maximumSize(maximumSize.toLong())
                 .apply {
                     expirationDuration.let {
-                        if (it != Duration.ZERO) {
+                        if (it != java.time.Duration.ZERO) {
                             expireAfterAccess(it)
                         }
                     }
diff --git a/jacodb-storage/src/main/kotlin/org/jacodb/impl/caches/xodus/XodusCaches.kt b/jacodb-storage/src/main/kotlin/org/jacodb/impl/caches/xodus/XodusCaches.kt
@@ -19,12 +19,12 @@ package org.jacodb.impl.caches.xodus
 import jetbrains.exodus.core.dataStructures.ConcurrentObjectCache
 import jetbrains.exodus.core.dataStructures.ObjectCacheBase
 import jetbrains.exodus.core.dataStructures.SoftConcurrentObjectCache
-import org.jacodb.api.jvm.ValueStoreType
-import org.jacodb.impl.caches.PluggableCache
-import org.jacodb.impl.caches.PluggableCacheBuilder
-import org.jacodb.impl.caches.PluggableCacheException
-import org.jacodb.impl.caches.PluggableCacheProvider
-import org.jacodb.impl.caches.PluggableCacheStats
+import org.jacodb.api.caches.PluggableCache
+import org.jacodb.api.caches.PluggableCacheBuilder
+import org.jacodb.api.caches.PluggableCacheException
+import org.jacodb.api.caches.PluggableCacheProvider
+import org.jacodb.api.caches.PluggableCacheStats
+import org.jacodb.api.caches.ValueStoreType
 
 const val XODUS_CACHE_PROVIDER_ID = "org.jacodb.impl.caches.xodus.XodusCacheProvider"
 
@@ -51,7 +51,7 @@ private class XodusCacheBuilder<K : Any, V : Any> : PluggableCacheBuilder<K, V>(
 }
 
 /**
- * Generally, Xodus' [ObjectCacheBase] is not synchronized, but [XodusCacheBuilder] creates
+ * Generally, Xodus' [jetbrains.exodus.core.dataStructures.ObjectCacheBase] is not synchronized, but [XodusCacheBuilder] creates
  * its "concurrent" implementations which do not require synchronization. If this ever changes,
  * [XodusCache] should be synchronized.
  */
diff --git a/jacodb-storage/src/main/resources/META-INF/services/org.jacodb.api.caches.PluggableCacheProvider b/jacodb-storage/src/main/resources/META-INF/services/org.jacodb.api.caches.PluggableCacheProvider
