Exclude javax.inject and CouchbaseAnnotationProcessor to exit gracefu…

…lly without. (#1934) CouchbaseAnnotationProcessor will provide a warning and skip generation if javax.inject is not present.
spring-projects · Apr 11, 2024 · db81e7a · db81e7a
1 parent 7251e1c
commit db81e7a
Show file tree

Hide file tree

Showing 5 changed files with 98 additions and 32 deletions.
diff --git a/pom.xml b/pom.xml
@@ -23,8 +23,6 @@
         <springdata.commons>3.1.11-SNAPSHOT</springdata.commons>
         <java-module-name>spring.data.couchbase</java-module-name>
         <hibernate.validator>7.0.1.Final</hibernate.validator>
-        <apt>1.1.3</apt>
-        <querydsl>5.0.0</querydsl>
         <couchbase.encryption>3.1.0</couchbase.encryption>
         <jodatime>2.10.13</jodatime>
         <jackson-joda>2.13.4</jackson-joda>
@@ -50,6 +48,19 @@
             <artifactId>querydsl-apt</artifactId>
             <version>${querydsl}</version>
             <classifier>jakarta</classifier>
+            <exclusions>
+                <exclusion>
+                    <groupId>javax.inject</groupId>
+                    <artifactId>javax.inject</artifactId>
+                </exclusion>
+            </exclusions>
+        </dependency>
+
+        <dependency>
+            <groupId>javax.inject</groupId>
+            <artifactId>javax.inject</artifactId>
+            <version>1</version>
+            <scope>test</scope>
         </dependency>
 
         <dependency>
@@ -248,6 +259,33 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <proc>none</proc>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>test-annotation-processing</id>
+                        <phase>generate-test-sources</phase>
+                        <goals>
+                            <goal>testCompile</goal>
+                        </goals>
+                        <configuration>
+                            <proc>only</proc>
+                            <annotationProcessors>
+                                <annotationProcessor>org.springframework.data.couchbase.repository.support.CouchbaseAnnotationProcessor</annotationProcessor>
+                            </annotationProcessors>
+                            <generatedTestSourcesDirectory>target/generated-test-sources</generatedTestSourcesDirectory>
+                            <compilerArgs>
+                                <arg>-Aquerydsl.logInfo=true</arg>
+                            </compilerArgs>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-surefire-plugin</artifactId>
@@ -291,30 +329,7 @@
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
             </plugin>
-            <plugin>
-                <groupId>com.mysema.maven</groupId>
-                <artifactId>apt-maven-plugin</artifactId>
-                <version>${apt}</version>
-                <dependencies>
-                    <dependency>
-                        <groupId>com.querydsl</groupId>
-                        <artifactId>querydsl-apt</artifactId>
-                        <version>${querydsl}</version>
-                    </dependency>
-                </dependencies>
-                <executions>
-                    <execution>
-                        <phase>generate-test-sources</phase>
-                        <goals>
-                            <goal>test-process</goal>
-                        </goals>
-                        <configuration>
-                            <outputDirectory>target/generated-test-sources</outputDirectory>
-                            <processor>org.springframework.data.couchbase.repository.support.CouchbaseAnnotationProcessor</processor>
-                        </configuration>
-                    </execution>
-                </executions>
-            </plugin>
+
         </plugins>
     </build>
 

diff --git a/...a/org/springframework/data/couchbase/repository/support/CouchbaseAnnotationProcessor.java b/...a/org/springframework/data/couchbase/repository/support/CouchbaseAnnotationProcessor.java
@@ -15,16 +15,19 @@
  */
 package org.springframework.data.couchbase.repository.support;
 
+import static com.querydsl.apt.APTOptions.QUERYDSL_LOG_INFO;
+
 import java.util.Collections;
+import java.util.Set;
 
 import javax.annotation.processing.RoundEnvironment;
 import javax.annotation.processing.SupportedAnnotationTypes;
 import javax.annotation.processing.SupportedSourceVersion;
 import javax.lang.model.SourceVersion;
+import javax.lang.model.element.TypeElement;
 import javax.tools.Diagnostic;
 
 import org.springframework.data.couchbase.core.mapping.Document;
-import org.springframework.lang.Nullable;
 
 import com.querydsl.apt.AbstractQuerydslProcessor;
 import com.querydsl.apt.Configuration;
@@ -49,9 +52,9 @@ public class CouchbaseAnnotationProcessor extends AbstractQuerydslProcessor {
 	 * @see com.querydsl.apt.AbstractQuerydslProcessor#createConfiguration(javax.annotation.processing.RoundEnvironment)
 	 */
 	@Override
-	protected Configuration createConfiguration(@Nullable RoundEnvironment roundEnv) {
+	protected Configuration createConfiguration(/*@Nullable */RoundEnvironment roundEnv) {
 
-		processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Running " + getClass().getSimpleName());
+		processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, "Running override createConfiguration() " + getClass().getSimpleName());
 
 		DefaultConfiguration configuration = new DefaultConfiguration(processingEnv, roundEnv, Collections.emptySet(),
 				QueryEntities.class, Document.class, QuerySupertype.class, QueryEmbeddable.class, QueryEmbedded.class,
@@ -60,4 +63,52 @@ protected Configuration createConfiguration(@Nullable RoundEnvironment roundEnv)
 
 		return configuration;
 	}
+
+  @Override
+	public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
+		setLogInfo();
+		logInfo("Running override process() " + getClass().getSimpleName() +" isOver: "+roundEnv.processingOver() +" annotations: "+annotations.size());
+
+		if (roundEnv.processingOver() || annotations.size() == 0) {
+			return ALLOW_OTHER_PROCESSORS_TO_CLAIM_ANNOTATIONS;
+		}
+
+		if (roundEnv.getRootElements() == null || roundEnv.getRootElements().isEmpty()) {
+			logInfo("No sources to process");
+			return ALLOW_OTHER_PROCESSORS_TO_CLAIM_ANNOTATIONS;
+		}
+
+    Configuration conf = createConfiguration(roundEnv);
+		try {
+			conf.getTypeMappings();
+		} catch (NoClassDefFoundError cnfe ){
+			logWarn( cnfe +" add a dependency on javax.inject:javax.inject to create querydsl classes");
+			return ALLOW_OTHER_PROCESSORS_TO_CLAIM_ANNOTATIONS;
+		}
+		return super.process(annotations, roundEnv);
+
+	}
+
+	private boolean shouldLogInfo;
+
+	private void setLogInfo() {
+		boolean hasProperty = processingEnv.getOptions().containsKey(QUERYDSL_LOG_INFO);
+		if (hasProperty) {
+			String val = processingEnv.getOptions().get(QUERYDSL_LOG_INFO);
+			shouldLogInfo = Boolean.parseBoolean(val);
+		}
+	}
+
+	private void logInfo(String message) {
+		if (shouldLogInfo) {
+			System.out.println("[NOTE] "+message); // maven compiler swallows messages to messager
+			processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, message);
+		}
+	}
+
+	private void logWarn(String message) {
+			System.err.println("[WARNING] "+message); // maven compiler swallows messages to messager
+			processingEnv.getMessager().printMessage(Diagnostic.Kind.WARNING, message);
+	}
 }
+
diff --git a/...va/org/springframework/data/couchbase/core/CouchbaseTemplateKeyValueIntegrationTests.java b/...va/org/springframework/data/couchbase/core/CouchbaseTemplateKeyValueIntegrationTests.java
@@ -1329,7 +1329,7 @@ void sampleScan() {
 		MutationToken mt = couchbaseTemplate.getCouchbaseClientFactory().getDefaultCollection()
 			.upsert(id, JsonObject.create().put("id", id)).mutationToken().get();
     Stream<User> users = couchbaseTemplate.rangeScan(User.class).consistentWith(MutationState.from(mt))
-        /*.withSort(ScanSort.ASCENDING)*/.samplingScan(5l, null);
+        /*.withSort(ScanSort.ASCENDING)*/.samplingScan(5l, (Long)null);
     List<User> usersList = users.toList();
 		assertEquals(5, usersList.size(), "number in sample");
     for (User u : usersList) {

diff --git a/src/test/java/org/springframework/data/couchbase/core/query/QueryCriteriaTests.java b/src/test/java/org/springframework/data/couchbase/core/query/QueryCriteriaTests.java
@@ -90,7 +90,7 @@ void testNestedOrCriteria() {
 	@Test
 	void testNestedNotIn() {
 		QueryCriteria c = where(i("name")).is("Bubba").or(where(i("age")).gt(12).and(i("country")).is("Austria"))
-				.and(where(i("state")).notIn(new String[] { "Alabama", "Florida" }));
+				.and(where(i("state")).notIn( "Alabama", "Florida" ));
 		JsonArray parameters = JsonArray.create();
 		assertEquals("  (  (`name` = $1) or   (`age` > $2 and `country` = $3)) and   (not( (`state` in $4) ))",
 				c.export(new int[1], parameters, null));

diff --git a/src/test/java/org/springframework/data/couchbase/domain/BigAirlineRepository.java b/src/test/java/org/springframework/data/couchbase/domain/BigAirlineRepository.java
@@ -30,7 +30,7 @@
  */
 @Repository
 public interface BigAirlineRepository extends CouchbaseRepository<BigAirline, String>,
-		QuerydslPredicateExecutor<BigAirline>, DynamicProxyable<BigAirlineRepository> {
+		 DynamicProxyable<BigAirlineRepository> {
 
 	@Query("#{#n1ql.selectEntity} where #{#n1ql.filter} and (name = $1)")
 	List<Airline> getByName(@Param("airline_name") String airlineName);