Merge pull request #3985 from graphql-java/enforce-jspecify-and-no-other-nullability-libs

dondonz · web-flow · commit 27a71b2d3a48 · 2025-05-27T18:05:50.000+10:00
Add ArchUnit rule to ban javax &amp; JetBrains nullability annotations
diff --git a/build.gradle b/build.gradle
@@ -176,7 +176,7 @@ shadowJar {
     bnd('''
 -exportcontents: graphql.*
 -removeheaders: Private-Package
-Import-Package: !android.os.*,!com.google.*,!org.checkerframework.*,!javax.annotation.*,!graphql.com.google.*,!org.antlr.*,!graphql.org.antlr.*,!sun.misc.*,org.jspecify.annotations;resolution:=optional,*
+Import-Package: !android.os.*,!com.google.*,!org.checkerframework.*,!graphql.com.google.*,!org.antlr.*,!graphql.org.antlr.*,!sun.misc.*,org.jspecify.annotations;resolution:=optional,*
 ''')
 }
 
diff --git a/src/test/groovy/graphql/NullabilityAnnotationUsageTest.groovy b/src/test/groovy/graphql/NullabilityAnnotationUsageTest.groovy
@@ -0,0 +1,40 @@
+package graphql
+
+import com.tngtech.archunit.core.domain.JavaClasses
+import com.tngtech.archunit.core.importer.ClassFileImporter
+import com.tngtech.archunit.core.importer.ImportOption
+import com.tngtech.archunit.lang.ArchRule
+import com.tngtech.archunit.lang.EvaluationResult
+import com.tngtech.archunit.lang.syntax.ArchRuleDefinition
+import spock.lang.Specification
+
+class NullabilityAnnotationUsageTest extends Specification {
+
+    private static final JavaClasses importedClasses = new ClassFileImporter()
+            .withImportOption(ImportOption.Predefined.DO_NOT_INCLUDE_TESTS)
+            .importPackages("graphql")
+
+    def "should only use JSpecify nullability annotations"() {
+        given:
+        ArchRule dependencyRule = ArchRuleDefinition.noClasses()
+                .should()
+                .dependOnClassesThat()
+                .resideInAnyPackage(
+                        "javax.annotation",
+                        "org.jetbrains.annotations"
+                )
+                .because("We are using JSpecify nullability annotations only. Please change to use JSpecify.")
+
+        when:
+        EvaluationResult result = dependencyRule.evaluate(importedClasses)
+
+        then:
+        if (result.hasViolation()) {
+            println "We are using JSpecify nullability annotations only. Please change the following to use JSpecify instead:"
+            result.getFailureReport().getDetails().each { violation ->
+                println "- ${violation}"
+            }
+        }
+        !result.hasViolation()
+    }
+} 

Original file line number	Diff line number	Diff line change
`@@ -176,7 +176,7 @@ shadowJar {`
`176`	`176`	`bnd('''`
`177`	`177`	`-exportcontents: graphql.*`
`178`	`178`	`-removeheaders: Private-Package`
`179`		`-Import-Package: !android.os.,!com.google.,!org.checkerframework.,!javax.annotation.,!graphql.com.google.,!org.antlr.,!graphql.org.antlr.,!sun.misc.,org.jspecify.annotations;resolution:=optional,*`
	`179`	`+Import-Package: !android.os.,!com.google.,!org.checkerframework.,!graphql.com.google.,!org.antlr.,!graphql.org.antlr.,!sun.misc.,org.jspecify.annotations;resolution:=optional,`
`180`	`180`	`''')`
`181`	`181`	`}`
`182`	`182`