Support graphql 22 (DataDog#7176)

peachisai · Jun 14, 2024 · 33a2dcd · 33a2dcd
1 parent 7939bfd
commit 33a2dcd
Show file tree

Hide file tree

Showing 31 changed files with 1,617 additions and 54 deletions.
diff --git a/dd-java-agent/instrumentation/graphql-java/build.gradle b/dd-java-agent/instrumentation/graphql-java/build.gradle
@@ -0,0 +1 @@
+apply from: "$rootDir/gradle/java.gradle"
diff --git a/...umentation/graphql-java-14.0/build.gradle → ...aphql-java/graphql-java-14.0/build.gradle b/...umentation/graphql-java-14.0/build.gradle → ...aphql-java/graphql-java-14.0/build.gradle
@@ -1,27 +1,25 @@
-
 muzzle {
   pass {
     group = "com.graphql-java"
     module = 'graphql-java'
-    versions = '[14.0,21)'
+    versions = '[14.0,20)'
+    assertInverse = true
+    skipVersions = ['230521-nf-execution', 'vTEST']
     // earlier versions are missing some classes and will require separate instrumentation
   }
-  fail {
-    group = "com.graphql-java"
-    module = 'graphql-java'
-    versions = '[1.2,14.0)'
-  }
 }
 
 apply from: "$rootDir/gradle/java.gradle"
 
 addTestSuiteForDir('latestDepTest', 'test')
+addTestSuiteExtendingForDir('latestDepForkedTest', 'latestDepTest', 'test')
 
 dependencies {
   compileOnly group: 'com.graphql-java', name: 'graphql-java', version: '14.0'
-  testImplementation group: 'com.graphql-java', name: 'graphql-java', version: '14.0'
+  implementation project(':dd-java-agent:instrumentation:graphql-java:graphql-java-common')
 
+  testImplementation group: 'com.graphql-java', name: 'graphql-java', version: '14.0'
   testImplementation project(':dd-java-agent:instrumentation:trace-annotation')
 
-  latestDepTestImplementation group: 'com.graphql-java', name: 'graphql-java', version: '[19+,21)'
+  latestDepTestImplementation group: 'com.graphql-java', name: 'graphql-java', version: '19.+'
 }
diff --git a/...ntation/graphql-java-14.0/gradle.lockfile → ...ql-java/graphql-java-14.0/gradle.lockfile b/...ntation/graphql-java-14.0/gradle.lockfile → ...ql-java/graphql-java-14.0/gradle.lockfile
diff --git a/...n/graphqljava/GraphQLInstrumentation.java → ...graphqljava14/GraphQLInstrumentation.java b/...n/graphqljava/GraphQLInstrumentation.java → ...graphqljava14/GraphQLInstrumentation.java
@@ -1,4 +1,4 @@
-package datadog.trace.instrumentation.graphqljava;
+package datadog.trace.instrumentation.graphqljava14;
 
 import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
 import static datadog.trace.instrumentation.graphqljava.GraphQLDecorator.DECORATE;
@@ -7,11 +7,15 @@
 import static datadog.trace.instrumentation.graphqljava.GraphQLDecorator.GRAPHQL_VALIDATION;
 
 import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import datadog.trace.instrumentation.graphqljava.ExecutionInstrumentationContext;
+import datadog.trace.instrumentation.graphqljava.InstrumentedDataFetcher;
+import datadog.trace.instrumentation.graphqljava.ParsingInstrumentationContext;
+import datadog.trace.instrumentation.graphqljava.State;
+import datadog.trace.instrumentation.graphqljava.ValidationInstrumentationContext;
 import graphql.ExecutionResult;
 import graphql.execution.instrumentation.ChainedInstrumentation;
 import graphql.execution.instrumentation.Instrumentation;
 import graphql.execution.instrumentation.InstrumentationContext;
-import graphql.execution.instrumentation.InstrumentationState;
 import graphql.execution.instrumentation.SimpleInstrumentation;
 import graphql.execution.instrumentation.SimpleInstrumentationContext;
 import graphql.execution.instrumentation.parameters.InstrumentationExecuteOperationParameters;
@@ -49,27 +53,6 @@ public static Instrumentation install(Instrumentation instrumentation) {
     return new ChainedInstrumentation(instrumentationList);
   }
 
-  public static final class State implements InstrumentationState {
-    private AgentSpan requestSpan;
-    private String query;
-
-    public AgentSpan getRequestSpan() {
-      return requestSpan;
-    }
-
-    public void setRequestSpan(AgentSpan requestSpan) {
-      this.requestSpan = requestSpan;
-    }
-
-    public String getQuery() {
-      return query;
-    }
-
-    public void setQuery(String query) {
-      this.query = query;
-    }
-  }
-
   @Override
   public State createState() {
     return new State();

diff --git a/...src/main/java/datadog/trace/instrumentation/graphqljava14/GraphQLJavaInstrumentation.java b/...src/main/java/datadog/trace/instrumentation/graphqljava14/GraphQLJavaInstrumentation.java
@@ -0,0 +1,78 @@
+package datadog.trace.instrumentation.graphqljava14;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.namedOneOf;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.not;
+import static net.bytebuddy.matcher.ElementMatchers.returns;
+
+import com.google.auto.service.AutoService;
+import datadog.trace.agent.tooling.Instrumenter;
+import datadog.trace.agent.tooling.InstrumenterModule;
+import graphql.execution.ValueUnboxer;
+import graphql.execution.instrumentation.Instrumentation;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumenterModule.class)
+public class GraphQLJavaInstrumentation extends InstrumenterModule.Tracing
+    implements Instrumenter.ForSingleType {
+
+  public GraphQLJavaInstrumentation() {
+    super("graphql-java");
+  }
+
+  @Override
+  public String instrumentedType() {
+    return "graphql.GraphQL";
+  }
+
+  @Override
+  public String[] helperClassNames() {
+    return new String[] {
+      "datadog.trace.instrumentation.graphqljava.GraphQLDecorator",
+      "datadog.trace.instrumentation.graphqljava.ParsingInstrumentationContext",
+      "datadog.trace.instrumentation.graphqljava.ExecutionInstrumentationContext",
+      "datadog.trace.instrumentation.graphqljava.ValidationInstrumentationContext",
+      "datadog.trace.instrumentation.graphqljava.State",
+      packageName + ".GraphQLInstrumentation",
+      "datadog.trace.instrumentation.graphqljava.GraphQLQuerySanitizer",
+      "datadog.trace.instrumentation.graphqljava.InstrumentedDataFetcher"
+    };
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    // introduced in 20.0
+    return not(hasClassNamed("graphql.execution.instrumentation.SimplePerformantInstrumentation"));
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod()
+            .and(
+                namedOneOf(
+                    "checkInstrumentationDefaultState" // 9.7+
+                    // https://github.com/graphql-java/graphql-java/commit/821241de8ee055d6d254a9d95ef5143f9e540826
+                    //                    "checkInstrumentation" // <9.7
+                    // https://github.com/graphql-java/graphql-java/commit/78a6e4eda1c13f47573adb879ae781cce794e96a
+                    ))
+            .and(returns(named("graphql.execution.instrumentation.Instrumentation"))),
+        this.getClass().getName() + "$AddInstrumentationAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class AddInstrumentationAdvice {
+    @Advice.OnMethodExit(suppress = Throwable.class)
+    public static void onExit(@Advice.Return(readOnly = false) Instrumentation instrumentation) {
+      instrumentation = GraphQLInstrumentation.install(instrumentation);
+    }
+
+    public static void muzzleCheck() {
+      // Class introduced in 15.0
+      ValueUnboxer value = ValueUnboxer.DEFAULT;
+    }
+  }
+}
diff --git a/...est/groovy/GraphQLInstallationTest.groovy → ...est/groovy/GraphQLInstallationTest.groovy b/...est/groovy/GraphQLInstallationTest.groovy → ...est/groovy/GraphQLInstallationTest.groovy
@@ -1,5 +1,5 @@
 import datadog.trace.agent.test.AgentTestRunner
-import datadog.trace.instrumentation.graphqljava.GraphQLInstrumentation
+import datadog.trace.instrumentation.graphqljava14.GraphQLInstrumentation
 import graphql.execution.instrumentation.ChainedInstrumentation
 import graphql.execution.instrumentation.SimpleInstrumentation
 

diff --git a/...t/groovy/GraphQLQuerySanitizerTest.groovy → ...t/groovy/GraphQLQuerySanitizerTest.groovy b/...t/groovy/GraphQLQuerySanitizerTest.groovy → ...t/groovy/GraphQLQuerySanitizerTest.groovy
diff --git a/...a-14.0/src/test/groovy/GraphQLTest.groovy → ...a-14.0/src/test/groovy/GraphQLTest.groovy b/...a-14.0/src/test/groovy/GraphQLTest.groovy → ...a-14.0/src/test/groovy/GraphQLTest.groovy
@@ -541,7 +541,7 @@ abstract class GraphQLTest extends VersionedNamingTestBase {
 }
 
 @Flaky
-class GraphQLV0ForkedTest extends GraphQLTest {
+class GraphQLV0Test extends GraphQLTest {
 
   @Override
   int version() {

diff --git a/...aphql-java-14.0/src/test/java/Author.java → ...aphql-java-14.0/src/test/java/Author.java b/...aphql-java-14.0/src/test/java/Author.java → ...aphql-java-14.0/src/test/java/Author.java
diff --git a/...graphql-java-14.0/src/test/java/Book.java → ...graphql-java-14.0/src/test/java/Book.java b/...graphql-java-14.0/src/test/java/Book.java → ...graphql-java-14.0/src/test/java/Book.java
diff --git a/...a-14.0/src/test/resources/schema.graphqls → ...a-14.0/src/test/resources/schema.graphqls b/...a-14.0/src/test/resources/schema.graphqls → ...a-14.0/src/test/resources/schema.graphqls
diff --git a/dd-java-agent/instrumentation/graphql-java/graphql-java-20.0/build.gradle b/dd-java-agent/instrumentation/graphql-java/graphql-java-20.0/build.gradle
@@ -0,0 +1,52 @@
+ext {
+  latestDepTestMinJavaVersionForTests = JavaVersion.VERSION_11
+  latestDepForkedTestMinJavaVersionForTests = JavaVersion.VERSION_11
+}
+// there are a lot of invalid version using dates (i.e. com.graphql-java-graphql-java-2018-06-04T04-23-07)
+// so we limit by chunks
+muzzle {
+  pass {
+    group = "com.graphql-java"
+    module = 'graphql-java'
+    versions = '[20.0, 21.0)'
+  }
+}
+muzzle {
+  pass {
+    group = "com.graphql-java"
+    module = 'graphql-java'
+    versions = '[21.0, 22.0)'
+    javaVersion = '11'
+  }
+}
+muzzle {
+  pass {
+    group = "com.graphql-java"
+    module = 'graphql-java'
+    versions = '[22.0, 23.0)'
+    javaVersion = '11'
+  }
+}
+
+apply from: "$rootDir/gradle/java.gradle"
+
+addTestSuiteForDir('latestDepTest', 'test')
+addTestSuiteExtendingForDir('latestDepForkedTest', 'latestDepTest', 'test')
+
+dependencies {
+  compileOnly group: 'com.graphql-java', name: 'graphql-java', version: '20.0'
+  implementation project(':dd-java-agent:instrumentation:graphql-java:graphql-java-common')
+
+  testImplementation group: 'com.graphql-java', name: 'graphql-java', version: '20.0'
+  // to test collisions with other instrumentation
+  testRuntimeOnly project(':dd-java-agent:instrumentation:graphql-java:graphql-java-14.0')
+  testImplementation project(':dd-java-agent:instrumentation:trace-annotation')
+
+  latestDepTestImplementation group: 'com.graphql-java', name: 'graphql-java', version: '20+,23)'
+
+  [compileLatestDepTestJava, compileLatestDepForkedTestGroovy].each {
+    it.configure {
+      setJavaVersion(it, 11)
+    }
+  }
+}