Disable matcher cache for running muzzle

open-telemetry · Mar 17, 2023 · 153b713 · 153b713
1 parent bb929f5
commit 153b713
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git a/...ugins/src/main/kotlin/io/opentelemetry/javaagent/muzzle/matcher/MuzzleGradlePluginUtil.kt b/...ugins/src/main/kotlin/io/opentelemetry/javaagent/muzzle/matcher/MuzzleGradlePluginUtil.kt
@@ -57,9 +57,6 @@ class MuzzleGradlePluginUtil {
 
       val matcherClass = agentClassLoader.loadClass("io.opentelemetry.javaagent.tooling.muzzle.ClassLoaderMatcher")
 
-      // We cannot reference Mismatch class directly here, because we are loaded from a different
-      // class loader.
-
       // We cannot reference Mismatch class directly here, because we are loaded from a different
       // class loader.
       val allMismatches = matcherClass

diff --git a/.../java/io/opentelemetry/javaagent/extension/matcher/ClassLoaderHasClassesNamedMatcher.java b/.../java/io/opentelemetry/javaagent/extension/matcher/ClassLoaderHasClassesNamedMatcher.java
@@ -15,6 +15,9 @@
 import net.bytebuddy.matcher.ElementMatcher;
 
 class ClassLoaderHasClassesNamedMatcher extends ElementMatcher.Junction.AbstractBase<ClassLoader> {
+  // caching is disabled for build time muzzle checks
+  // this field is set via reflection from ClassLoaderMatcher
+  static boolean useCache = true;
   private static final AtomicInteger counter = new AtomicInteger();
 
   private final String[] resources;
@@ -25,7 +28,9 @@ class ClassLoaderHasClassesNamedMatcher extends ElementMatcher.Junction.Abstract
     for (int i = 0; i < resources.length; i++) {
       resources[i] = resources[i].replace(".", "/") + ".class";
     }
-    Manager.INSTANCE.add(this);
+    if (useCache) {
+      Manager.INSTANCE.add(this);
+    }
   }
 
   @Override
@@ -34,7 +39,11 @@ public boolean matches(ClassLoader cl) {
       // Can't match the bootstrap class loader.
       return false;
     }
-    return Manager.INSTANCE.match(this, cl);
+    if (useCache) {
+      return Manager.INSTANCE.match(this, cl);
+    } else {
+      return hasResources(cl, resources);
+    }
   }
 
   private static boolean hasResources(ClassLoader cl, String... resources) {

diff --git a/muzzle/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/ClassLoaderMatcher.java b/muzzle/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/ClassLoaderMatcher.java
@@ -7,6 +7,7 @@
 
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.tooling.HelperInjector;
+import java.lang.reflect.Field;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -32,6 +33,8 @@ public class ClassLoaderMatcher {
    */
   public static Map<String, List<Mismatch>> matchesAll(
       ClassLoader classLoader, boolean injectHelpers, Set<String> excludedInstrumentationNames) {
+    disableMatcherCache();
+
     Map<String, List<Mismatch>> result = new HashMap<>();
     ServiceLoader.load(InstrumentationModule.class, ClassLoaderMatcher.class.getClassLoader())
         .forEach(
@@ -101,5 +104,19 @@ private static List<Mismatch> checkHelperInjection(
     return mismatches;
   }
 
+  private static void disableMatcherCache() {
+    try {
+      Class<?> matcherClass =
+          Class.forName(
+              "io.opentelemetry.javaagent.extension.matcher.ClassLoaderHasClassesNamedMatcher");
+      Field field = matcherClass.getDeclaredField("useCache");
+      field.setAccessible(true);
+      field.setBoolean(null, false);
+    } catch (Exception exception) {
+      throw new IllegalStateException(
+          "Failed to disable cache for ClassLoaderHasClassesNamedMatcher", exception);
+    }
+  }
+
   private ClassLoaderMatcher() {}
 }