JAVA-2950: Remove reference to Reflection class from DependencyCheck (#1561)

absurdfarce · web-flow · commit 18aa11249b7e · 2021-07-09T16:52:22.000+02:00
Decoupled dependency definition from logic to check for presence of dependencies. This check logic has been moved to two discrete classes, one for regular lookups and one for Graal build-time lookups which has to be a bit more restrictive about what it can use.
diff --git a/changelog/README.md b/changelog/README.md
@@ -2,6 +2,10 @@
 
 <!-- Note: contrary to 3.x, insert new entries *first* in their section -->
 
+### 4.11.3 (in progress)
+
+- [bug] JAVA-2950: Remove reference to Reflection class from DependencyCheck
+
 ### 4.11.2
 
 - [bug] JAVA-2932: Make DefaultDriverConfigLoader.close() resilient to terminated executors
diff --git a/core/src/main/java/com/datastax/dse/driver/internal/core/type/codec/DseTypeCodecsRegistrar.java b/core/src/main/java/com/datastax/dse/driver/internal/core/type/codec/DseTypeCodecsRegistrar.java
@@ -15,9 +15,11 @@
  */
 package com.datastax.dse.driver.internal.core.type.codec;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.ESRI;
+
 import com.datastax.dse.driver.api.core.type.codec.DseTypeCodecs;
 import com.datastax.oss.driver.api.core.type.codec.registry.MutableCodecRegistry;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -27,7 +29,7 @@ public class DseTypeCodecsRegistrar {
 
   public static void registerDseCodecs(MutableCodecRegistry registry) {
     registry.register(DseTypeCodecs.DATE_RANGE);
-    if (DependencyCheck.ESRI.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(ESRI)) {
       registry.register(DseTypeCodecs.LINE_STRING, DseTypeCodecs.POINT, DseTypeCodecs.POLYGON);
     } else {
       LOG.debug("ESRI was not found on the classpath: geo codecs will not be available");
diff --git a/core/src/main/java/com/datastax/dse/driver/internal/core/type/codec/DseTypeCodecsRegistrarSubstitutions.java b/core/src/main/java/com/datastax/dse/driver/internal/core/type/codec/DseTypeCodecsRegistrarSubstitutions.java
@@ -15,9 +15,11 @@
  */
 package com.datastax.dse.driver.internal.core.type.codec;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.ESRI;
+
 import com.datastax.dse.driver.api.core.type.codec.DseTypeCodecs;
 import com.datastax.oss.driver.api.core.type.codec.registry.MutableCodecRegistry;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.GraalDependencyChecker;
 import com.oracle.svm.core.annotate.Substitute;
 import com.oracle.svm.core.annotate.TargetClass;
 import java.util.function.BooleanSupplier;
@@ -37,7 +39,7 @@ public static void registerDseCodecs(MutableCodecRegistry registry) {
   public static class EsriMissing implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return !DependencyCheck.ESRI.isPresent();
+      return !GraalDependencyChecker.isPresent(ESRI);
     }
   }
 }
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java b/core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java
@@ -15,6 +15,8 @@
  */
 package com.datastax.oss.driver.internal.core.context;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.JACKSON;
+
 import com.datastax.dse.driver.api.core.config.DseDriverOption;
 import com.datastax.dse.driver.internal.core.InsightsClientLifecycleListener;
 import com.datastax.dse.driver.internal.core.tracker.MultiplexingRequestTracker;
@@ -82,7 +84,7 @@
 import com.datastax.oss.driver.internal.core.tracker.NoopRequestTracker;
 import com.datastax.oss.driver.internal.core.tracker.RequestLogFormatter;
 import com.datastax.oss.driver.internal.core.type.codec.registry.DefaultCodecRegistry;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
 import com.datastax.oss.driver.internal.core.util.Reflection;
 import com.datastax.oss.driver.internal.core.util.concurrent.CycleDetector;
 import com.datastax.oss.driver.internal.core.util.concurrent.LazyReference;
@@ -655,7 +657,7 @@ protected Optional<AuthProvider> buildAuthProvider(AuthProvider authProviderFrom
   }
 
   protected List<LifecycleListener> buildLifecycleListeners() {
-    if (DependencyCheck.JACKSON.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(JACKSON)) {
       return Collections.singletonList(new InsightsClientLifecycleListener(this, initStackTrace));
     } else {
       if (config.getDefaultProfile().getBoolean(DseDriverOption.MONITOR_REPORTING_ENABLED)) {
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/metrics/DefaultMetricsFactory.java b/core/src/main/java/com/datastax/oss/driver/internal/core/metrics/DefaultMetricsFactory.java
@@ -15,10 +15,12 @@
  */
 package com.datastax.oss.driver.internal.core.metrics;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.DROPWIZARD;
+
 import com.datastax.oss.driver.api.core.context.DriverContext;
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.metrics.Metrics;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
 import java.util.Optional;
 import net.jcip.annotations.ThreadSafe;
 import org.slf4j.Logger;
@@ -33,7 +35,7 @@ public class DefaultMetricsFactory implements MetricsFactory {
 
   @SuppressWarnings("unused")
   public DefaultMetricsFactory(DriverContext context) {
-    if (DependencyCheck.DROPWIZARD.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(DROPWIZARD)) {
       this.delegate = new DropwizardMetricsFactory(context);
     } else {
       this.delegate = new NoopMetricsFactory(context);
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/metrics/DefaultMetricsFactorySubstitutions.java b/core/src/main/java/com/datastax/oss/driver/internal/core/metrics/DefaultMetricsFactorySubstitutions.java
@@ -15,8 +15,10 @@
  */
 package com.datastax.oss.driver.internal.core.metrics;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.DROPWIZARD;
+
 import com.datastax.oss.driver.api.core.context.DriverContext;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.GraalDependencyChecker;
 import com.oracle.svm.core.annotate.Alias;
 import com.oracle.svm.core.annotate.Delete;
 import com.oracle.svm.core.annotate.Substitute;
@@ -49,7 +51,7 @@ public static final class DeleteDropwizardMetricsFactory {}
   public static class DropwizardMissing implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return !DependencyCheck.DROPWIZARD.isPresent();
+      return !GraalDependencyChecker.isPresent(DROPWIZARD);
     }
   }
 }
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/CompressorSubstitutions.java b/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/CompressorSubstitutions.java
@@ -15,9 +15,11 @@
  */
 package com.datastax.oss.driver.internal.core.protocol;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.LZ4;
+
 import com.datastax.oss.driver.api.core.config.DefaultDriverOption;
 import com.datastax.oss.driver.api.core.context.DriverContext;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.GraalDependencyChecker;
 import com.datastax.oss.protocol.internal.Compressor;
 import com.oracle.svm.core.annotate.Delete;
 import com.oracle.svm.core.annotate.Substitute;
@@ -91,7 +93,7 @@ public static final class DeleteSnappyCompressor {}
   public static class Lz4Present implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return DependencyCheck.LZ4.isPresent();
+      return GraalDependencyChecker.isPresent(LZ4);
     }
   }
 
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/Lz4Compressor.java b/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/Lz4Compressor.java
@@ -15,8 +15,10 @@
  */
 package com.datastax.oss.driver.internal.core.protocol;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.LZ4;
+
 import com.datastax.oss.driver.api.core.context.DriverContext;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
 import com.datastax.oss.driver.shaded.guava.common.annotations.VisibleForTesting;
 import io.netty.buffer.ByteBuf;
 import java.nio.ByteBuffer;
@@ -41,7 +43,7 @@ public Lz4Compressor(DriverContext context) {
 
   @VisibleForTesting
   Lz4Compressor(String sessionName) {
-    if (DependencyCheck.LZ4.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(LZ4)) {
       LZ4Factory lz4Factory = LZ4Factory.fastestInstance();
       LOG.info("[{}] Using {}", sessionName, lz4Factory.toString());
       this.compressor = lz4Factory.fastCompressor();
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/SnappyCompressor.java b/core/src/main/java/com/datastax/oss/driver/internal/core/protocol/SnappyCompressor.java
@@ -16,7 +16,8 @@
 package com.datastax.oss.driver.internal.core.protocol;
 
 import com.datastax.oss.driver.api.core.context.DriverContext;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
+import com.datastax.oss.driver.internal.core.util.Dependency;
 import io.netty.buffer.ByteBuf;
 import java.io.IOException;
 import java.nio.ByteBuffer;
@@ -34,7 +35,7 @@
 public class SnappyCompressor extends ByteBufCompressor {
 
   public SnappyCompressor(@SuppressWarnings("unused") DriverContext context) {
-    if (!DependencyCheck.SNAPPY.isPresent()) {
+    if (!DefaultDependencyChecker.isPresent(Dependency.SNAPPY)) {
       throw new IllegalStateException(
           "Could not find the Snappy library on the classpath "
               + "(the driver declares it as an optional dependency, "
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/session/BuiltInRequestProcessors.java b/core/src/main/java/com/datastax/oss/driver/internal/core/session/BuiltInRequestProcessors.java
@@ -15,6 +15,9 @@
  */
 package com.datastax.oss.driver.internal.core.session;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.REACTIVE_STREAMS;
+import static com.datastax.oss.driver.internal.core.util.Dependency.TINKERPOP;
+
 import com.datastax.dse.driver.internal.core.cql.continuous.ContinuousCqlRequestAsyncProcessor;
 import com.datastax.dse.driver.internal.core.cql.continuous.ContinuousCqlRequestSyncProcessor;
 import com.datastax.dse.driver.internal.core.cql.continuous.reactive.ContinuousCqlRequestReactiveProcessor;
@@ -28,7 +31,7 @@
 import com.datastax.oss.driver.internal.core.cql.CqlPrepareSyncProcessor;
 import com.datastax.oss.driver.internal.core.cql.CqlRequestAsyncProcessor;
 import com.datastax.oss.driver.internal.core.cql.CqlRequestSyncProcessor;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.DefaultDependencyChecker;
 import java.util.ArrayList;
 import java.util.List;
 import org.slf4j.Logger;
@@ -41,18 +44,19 @@ public class BuiltInRequestProcessors {
   public static List<RequestProcessor<?, ?>> createDefaultProcessors(DefaultDriverContext context) {
     List<RequestProcessor<?, ?>> processors = new ArrayList<>();
     addBasicProcessors(processors);
-    if (DependencyCheck.TINKERPOP.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(TINKERPOP)) {
       addGraphProcessors(context, processors);
     } else {
       LOG.debug("Tinkerpop was not found on the classpath: graph extensions will not be available");
     }
-    if (DependencyCheck.REACTIVE_STREAMS.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(REACTIVE_STREAMS)) {
       addReactiveProcessors(processors);
     } else {
       LOG.debug(
           "Reactive Streams was not found on the classpath: reactive extensions will not be available");
     }
-    if (DependencyCheck.REACTIVE_STREAMS.isPresent() && DependencyCheck.TINKERPOP.isPresent()) {
+    if (DefaultDependencyChecker.isPresent(REACTIVE_STREAMS)
+        && DefaultDependencyChecker.isPresent(TINKERPOP)) {
       addGraphReactiveProcessors(context, processors);
     }
     return processors;
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/session/BuiltInRequestProcessorsSubstitutions.java b/core/src/main/java/com/datastax/oss/driver/internal/core/session/BuiltInRequestProcessorsSubstitutions.java
@@ -15,8 +15,11 @@
  */
 package com.datastax.oss.driver.internal.core.session;
 
+import static com.datastax.oss.driver.internal.core.util.Dependency.REACTIVE_STREAMS;
+import static com.datastax.oss.driver.internal.core.util.Dependency.TINKERPOP;
+
 import com.datastax.oss.driver.internal.core.context.DefaultDriverContext;
-import com.datastax.oss.driver.internal.core.util.DependencyCheck;
+import com.datastax.oss.driver.internal.core.util.GraalDependencyChecker;
 import com.oracle.svm.core.annotate.Substitute;
 import com.oracle.svm.core.annotate.TargetClass;
 import java.util.ArrayList;
@@ -67,22 +70,24 @@ public static final class BuiltInRequestProcessorsGraphPresentReactiveMissing {
   public static class GraphMissingReactiveMissing implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return !DependencyCheck.TINKERPOP.isPresent()
-          && !DependencyCheck.REACTIVE_STREAMS.isPresent();
+      return !GraalDependencyChecker.isPresent(TINKERPOP)
+          && !GraalDependencyChecker.isPresent(REACTIVE_STREAMS);
     }
   }
 
   public static class GraphMissingReactivePresent implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return !DependencyCheck.TINKERPOP.isPresent() && DependencyCheck.REACTIVE_STREAMS.isPresent();
+      return !GraalDependencyChecker.isPresent(TINKERPOP)
+          && GraalDependencyChecker.isPresent(REACTIVE_STREAMS);
     }
   }
 
   public static class GraphPresentReactiveMissing implements BooleanSupplier {
     @Override
     public boolean getAsBoolean() {
-      return DependencyCheck.TINKERPOP.isPresent() && !DependencyCheck.REACTIVE_STREAMS.isPresent();
+      return GraalDependencyChecker.isPresent(TINKERPOP)
+          && !GraalDependencyChecker.isPresent(REACTIVE_STREAMS);
     }
   }
 }
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/util/DefaultDependencyChecker.java b/core/src/main/java/com/datastax/oss/driver/internal/core/util/DefaultDependencyChecker.java
@@ -0,0 +1,59 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.internal.core.util;
+
+import java.util.concurrent.ConcurrentHashMap;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * A checker for the presence of various {@link Dependency} instances at runtime. Predicate tests
+ * for Graal substitutions should NOT use this class; see {@link GraalDependencyChecker} for more
+ * information.
+ */
+public class DefaultDependencyChecker {
+
+  private static final Logger LOG = LoggerFactory.getLogger(DefaultDependencyChecker.class);
+
+  private static ConcurrentHashMap<Dependency, Boolean> CACHE = new ConcurrentHashMap<>();
+
+  /**
+   * Return true iff we can find all classes for the dependency on the classpath, false otherwise
+   *
+   * @param dependency the dependency to search for
+   * @return true if the dependency is available, false otherwise
+   */
+  public static boolean isPresent(Dependency dependency) {
+    try {
+      return CACHE.computeIfAbsent(
+          dependency,
+          (dep) -> {
+            for (String classNameToTest : dependency.classes()) {
+              // Always use the driver class loader, assuming that the driver classes and
+              // the dependency classes are either being loaded by the same class loader,
+              // or – as in OSGi deployments – by two distinct, but compatible class loaders.
+              if (Reflection.loadClass(null, classNameToTest) == null) {
+                return false;
+              }
+            }
+            return true;
+          });
+    } catch (Exception e) {
+      LOG.warn("Unexpected exception when checking for dependency " + dependency, e);
+      return false;
+    }
+  }
+}
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/util/Dependency.java b/core/src/main/java/com/datastax/oss/driver/internal/core/util/Dependency.java
@@ -0,0 +1,60 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.internal.core.util;
+
+import com.datastax.oss.driver.shaded.guava.common.collect.ImmutableList;
+
+/**
+ * A set of driver optional dependencies and a common mechanism to test the presence of such
+ * dependencies on the application's classpath.
+ *
+ * <p>We use the given fully-qualified names of classes to test the presence of the whole dependency
+ * on the classpath, including its transitive dependencies if applicable. This assumes that if these
+ * classes are present, then the entire library is present and functional, and vice versa.
+ *
+ * <p>Note: some of the libraries declared here may be shaded; in these cases the shade plugin will
+ * replace the package names listed above with names starting with {@code
+ * com.datastax.oss.driver.shaded.*}, but the presence check would still work as expected.
+ */
+public enum Dependency {
+  SNAPPY("org.xerial.snappy.Snappy"),
+  LZ4("net.jpountz.lz4.LZ4Compressor"),
+  ESRI("com.esri.core.geometry.ogc.OGCGeometry"),
+  TINKERPOP(
+      // gremlin-core
+      "org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal",
+      // tinkergraph-gremlin
+      "org.apache.tinkerpop.gremlin.tinkergraph.structure.TinkerIoRegistryV3d0"),
+  REACTIVE_STREAMS("org.reactivestreams.Publisher"),
+  JACKSON(
+      // jackson-core
+      "com.fasterxml.jackson.core.JsonParser",
+      // jackson-databind
+      "com.fasterxml.jackson.databind.ObjectMapper"),
+  DROPWIZARD("com.codahale.metrics.MetricRegistry"),
+  ;
+
+  @SuppressWarnings("ImmutableEnumChecker")
+  private final ImmutableList<String> clzs;
+
+  Dependency(String... classNames) {
+    clzs = ImmutableList.copyOf(classNames);
+  }
+
+  public Iterable<String> classes() {
+    return this.clzs;
+  }
+}
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/util/DependencyCheck.java b/core/src/main/java/com/datastax/oss/driver/internal/core/util/DependencyCheck.java
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/util/GraalDependencyChecker.java b/core/src/main/java/com/datastax/oss/driver/internal/core/util/GraalDependencyChecker.java

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,10 @@`
`15`	`15`	`*/`
`16`	`16`	`package com.datastax.oss.driver.internal.core.metrics;`
`17`	`17`
	`18`	`+import static com.datastax.oss.driver.internal.core.util.Dependency.DROPWIZARD;`
	`19`	`+`
`18`	`20`	`import com.datastax.oss.driver.api.core.context.DriverContext;`
`19`		`-import com.datastax.oss.driver.internal.core.util.DependencyCheck;`
	`21`	`+import com.datastax.oss.driver.internal.core.util.GraalDependencyChecker;`
`20`	`22`	`import com.oracle.svm.core.annotate.Alias;`
`21`	`23`	`import com.oracle.svm.core.annotate.Delete;`
`22`	`24`	`import com.oracle.svm.core.annotate.Substitute;`
`@@ -49,7 +51,7 @@ public static final class DeleteDropwizardMetricsFactory {}`
`49`	`51`	`public static class DropwizardMissing implements BooleanSupplier {`
`50`	`52`	`@Override`
`51`	`53`	`public boolean getAsBoolean() {`
`52`		`- return !DependencyCheck.DROPWIZARD.isPresent();`
	`54`	`+ return !GraalDependencyChecker.isPresent(DROPWIZARD);`
`53`	`55`	`}`
`54`	`56`	`}`
`55`	`57`	`}`