Drop instrumentation-api-caching module and move weak cache implementation to instrumentation-api

conventions/src/main/kotlin/otel.errorprone-conventions.gradle.kts

@@ -19,7 +19,7 @@ tasks {
  disableWarningsInGeneratedCode.set(true)
  allDisabledChecksAsWarnings.set(true)
 
- excludedPaths.set(".*/build/generated/.*")
+ excludedPaths.set(".*/build/generated/.*|.*/concurrentlinkedhashmap/.*",)
 
  if (System.getenv("CI") == null) {
  disable("SystemOut")

conventions/src/main/kotlin/otel.javaagent-bootstrap.gradle.kts

@@ -12,8 +12,4 @@ dependencies {
  compileOnly("io.opentelemetry:opentelemetry-api")
  compileOnly(project(":instrumentation-api"))
  compileOnly(project(":javaagent-instrumentation-api"))
-
- // this only exists to make Intellij happy since it doesn't (currently at least) understand our
- // inclusion of this artifact inside of :instrumentation-api
- compileOnly(project(":instrumentation-api-caching"))
 }

conventions/src/main/kotlin/otel.javaagent-instrumentation.gradle.kts

@@ -7,10 +7,4 @@ plugins {
 
 extra["mavenGroupId"] = "io.opentelemetry.javaagent.instrumentation"
 
-base.archivesName.set(projectDir.parentFile.name)
-
-dependencies {
- // this only exists to make Intellij happy since it doesn't (currently at least) understand our
- // inclusion of this artifact inside of :instrumentation-api
- compileOnly(project(":instrumentation-api-caching"))
-}
+base.archivesName.set(projectDir.parentFile.name)

conventions/src/main/kotlin/otel.library-instrumentation.gradle.kts

@@ -8,10 +8,4 @@ plugins {
 
 extra["mavenGroupId"] = "io.opentelemetry.instrumentation"
 
-base.archivesName.set(projectDir.parentFile.name)
-
-dependencies {
- // this only exists to make Intellij happy since it doesn't (currently at least) understand our
- // inclusion of this artifact inside of :instrumentation-api
- compileOnly(project(":instrumentation-api-caching"))
-}
+base.archivesName.set(projectDir.parentFile.name)

instrumentation-api-annotation-support/build.gradle.kts

@@ -10,11 +10,6 @@ group = "io.opentelemetry.instrumentation"
 dependencies {
  implementation(project(":instrumentation-api"))
 
- // this only exists to make Intellij happy since it doesn't (currently at least) understand our
- // inclusion of this artifact inside of :instrumentation-api
- compileOnly(project(":instrumentation-api-caching"))
- testCompileOnly(project(":instrumentation-api-caching"))
-
  api("io.opentelemetry:opentelemetry-api")
  api("io.opentelemetry:opentelemetry-semconv")
 

instrumentation-api-annotation-support/src/main/java/io/opentelemetry/instrumentation/api/annotation/support/MethodCache.java

@@ -5,7 +5,7 @@
 
 package io.opentelemetry.instrumentation.api.annotation.support;
 
-import io.opentelemetry.instrumentation.api.caching.Cache;
+import io.opentelemetry.instrumentation.api.cache.Cache;
 import java.lang.reflect.Method;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;

instrumentation-api-annotation-support/src/main/java/io/opentelemetry/instrumentation/api/annotation/support/MethodSpanAttributesExtractor.java

@@ -6,7 +6,7 @@
 package io.opentelemetry.instrumentation.api.annotation.support;
 
 import io.opentelemetry.api.common.AttributesBuilder;
-import io.opentelemetry.instrumentation.api.caching.Cache;
+import io.opentelemetry.instrumentation.api.cache.Cache;
 import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
 import io.opentelemetry.instrumentation.api.tracer.AttributeSetter;
 import java.lang.reflect.Method;

instrumentation-api-annotation-support/src/test/groovy/io/opentelemetry/instrumentation/api/annotation/support/MethodSpanAttributesExtractorTest.groovy

@@ -6,7 +6,7 @@
 package io.opentelemetry.instrumentation.api.annotation.support
 
 import io.opentelemetry.api.common.AttributesBuilder
-import io.opentelemetry.instrumentation.api.caching.Cache
+import io.opentelemetry.instrumentation.api.cache.Cache
 import spock.lang.Specification
 
 import java.lang.reflect.Method

instrumentation-api-annotation-support/src/test/java/io/opentelemetry/instrumentation/api/annotation/support/MethodCacheTest.java

@@ -11,7 +11,7 @@
 import static org.mockito.Mockito.verifyNoMoreInteractions;
 import static org.mockito.Mockito.when;
 
-import io.opentelemetry.instrumentation.api.caching.Cache;
+import io.opentelemetry.instrumentation.api.cache.Cache;
 import java.lang.reflect.Method;
 import java.util.function.Function;
 import org.junit.jupiter.api.Test;

instrumentation-api-caching/src/main/java/io/opentelemetry/instrumentation/api/caching/Cache.java

@@ -9,7 +9,7 @@
 import javax.annotation.Nullable;
 
 /** A cache from keys to values. */
-public interface Cache<K, V> {
+interface Cache<K, V> {
 
  /** Returns a new {@link CacheBuilder} to configure a {@link Cache}. */
  static CacheBuilder builder() {

instrumentation-api/build.gradle.kts

@@ -14,27 +14,22 @@ sourceSets {
  // set to generate into. By default it would be the src/main directory itself.
  srcDir("$buildDir/generated/sources/jflex")
  }
-
- val cachingShadedDeps = project(":instrumentation-api-caching")
- output.dir(cachingShadedDeps.file("build/extracted/shadow"), "builtBy" to ":instrumentation-api-caching:extractShadowJar")
  }
 }
 
 group = "io.opentelemetry.instrumentation"
 
 dependencies {
- compileOnly(project(":instrumentation-api-caching"))
-
  api("io.opentelemetry:opentelemetry-api")
  api("io.opentelemetry:opentelemetry-semconv")
 
  implementation("io.opentelemetry:opentelemetry-api-metrics")
  implementation("org.slf4j:slf4j-api")
+ implementation("com.blogspot.mydailyjava:weak-lock-free")
 
  compileOnly("com.google.auto.value:auto-value-annotations")
  annotationProcessor("com.google.auto.value:auto-value")
 
- testCompileOnly(project(":instrumentation-api-caching"))
  testImplementation(project(":testing-common"))
  testImplementation("org.mockito:mockito-core")
  testImplementation("org.mockito:mockito-junit-jupiter")

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/cache/BoundedCache.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.api.cache;
+
+import java.util.concurrent.ConcurrentMap;
+import java.util.function.Function;
+import javax.annotation.Nullable;
+
+final class BoundedCache<K, V> implements Cache<K, V> {
+
+ private final ConcurrentMap<K, V> delegate;
+
+ BoundedCache(ConcurrentMap<K, V> delegate) {
+ this.delegate = delegate;
+ }
+
+ @Override
+ public V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction) {
+ return delegate.computeIfAbsent(key, mappingFunction);
+ }
+
+ @Nullable
+ @Override
+ public V get(K key) {
+ return delegate.get(key);
+ }
+
+ @Override
+ public void put(K key, V value) {
+ delegate.put(key, value);
+ }
+
+ @Override
+ public void remove(K key) {
+ delegate.remove(key);
+ }
+
+ // Visible for tests
+ int size() {
+ return delegate.size();
+ }
+}

instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/cache/Cache.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.api.cache;
+
+import io.opentelemetry.instrumentation.api.cache.concurrentlinkedhashmap.ConcurrentLinkedHashMap;
+import java.util.function.Function;
+import javax.annotation.Nullable;
+
+/**
+ * A cache from keys to values.
+ *
+ * <p>Keys are always referenced weakly and are compared using identity comparison, not {@link
+ * Object#equals(Object)}.
+ */
+public interface Cache<K, V> {
+
+ /**
+ * Returns new unbounded cache
+ *
+ * <p>Keys are referenced weakly and compared using identity comparison, not {@link
+ * Object#equals(Object)}.
+ */
+ static <K, V> Cache<K, V> weak() {
+ return new WeakLockFreeCache<>();
+ }
+
+ /**
+ * Returns new bounded cache.
+ *
+ * <p>Both keys and values are strongly referenced.
+ */
+ static <K, V> Cache<K, V> bounded(int capacity) {
+ ConcurrentLinkedHashMap<K, V> map =
+ new ConcurrentLinkedHashMap.Builder<K, V>().maximumWeightedCapacity(capacity).build();
+ return new BoundedCache<>(map);
+ }
+
+ /**
+ * Returns the cached value associated with the provided {@code key}. If no value is cached yet,
+ * computes the value using {@code mappingFunction}, stores the result, and returns it.
+ */
+ V computeIfAbsent(K key, Function<? super K, ? extends V> mappingFunction);
+
+ /**
+ * Returns the cached value associated with the provided {@code key} if present, or {@code null}
+ * otherwise.
+ */
+ @Nullable
+ V get(K key);
+
+ /** Puts the {@code value} into the cache for the {@code key}. */
+ void put(K key, V value);
+
+ /** Removes a value for {@code key} if present. */
+ void remove(K key);
+}

instrumentation-api-caching/src/main/java/io/opentelemetry/instrumentation/api/caching/WeakLockFreeCache.java → instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/cache/WeakLockFreeCache.java

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.api.caching;
+package io.opentelemetry.instrumentation.api.cache;
 
 import com.blogspot.mydailyjava.weaklockfree.WeakConcurrentMap;
 import java.util.function.Function;