107 Disable constant and enum parsing if Tree not available (#109)

* Disable annotation processing by default

Author: cuzfrog

annotation/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>online.sharedtype</groupId>
         <artifactId>sharedtype-parent</artifactId>
-        <version>0.10.0-SNAPSHOT</version>
+        <version>0.9.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

doc/Usage.md

@@ -22,8 +22,9 @@ Add sharedtype dependency, the annotation `@SharedType` is only used at compile
 Add Maven properties:
 ```xml
 <properties>
-    <sharedtype.compilerArg /> <!-- Placeholder -->
-    <sharedtype.version>0.2.0</sharedtype.version>
+    <compilerArg /> <!-- Placeholder -->
+    <sharedtype.version>0.10.0</sharedtype.version>
+    <sharedtype.enabled>false</sharedtype.enabled> <!-- Disable by default so not to participate in every compilation -->
 </properties>
 ```
 Setup annotation processing:
@@ -41,7 +42,9 @@ Setup annotation processing:
         </annotationProcessorPaths>
         <showWarnings>true</showWarnings> <!-- Show annotation processing info log -->
         <compilerArgs>
-            <arg>${sharedtype.compilerArg}</arg> <!-- supplied as a property from cmd -->
+            <!-- supplied as properties from cmd -->
+            <arg>${compilerArg}</arg>
+            <arg>-Asharedtype.enabled=${sharedtype.enabled}</arg>
         </compilerArgs>
     </configuration>
 </plugin>
@@ -57,7 +60,7 @@ record User(String name, int age, String email) {}
 ```
 
 Execute annotation processing:
-* maven: `./mvnw clean compile "-Dsharedtype.compilerArg=-proc:only"`
+* maven: `./mvnw compile -DcompilerArg=-proc:only -Dsharedtype.enabled=true`
 
 By default, below code will be generated:
 ```typescript

it/java17/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>online.sharedtype</groupId>
         <artifactId>sharedtype-it-parent</artifactId>
-        <version>0.10.0-SNAPSHOT</version>
+        <version>0.9.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

it/java8/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>online.sharedtype</groupId>
         <artifactId>sharedtype-it-parent</artifactId>
-        <version>0.10.0-SNAPSHOT</version>
+        <version>0.9.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

it/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>online.sharedtype</groupId>
         <artifactId>sharedtype-parent</artifactId>
-        <version>0.10.0-SNAPSHOT</version>
+        <version>0.9.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 
@@ -13,7 +13,7 @@
     <packaging>pom</packaging>
 
     <properties>
-        <sharedtype.compilerArg />
+        <compilerArg />
         <sharedtype.propsFile>it/sharedtype.properties</sharedtype.propsFile>
         <compileClasses/>
     </properties>
@@ -100,8 +100,9 @@
                     </annotationProcessorPaths>
                     <showWarnings>true</showWarnings>
                     <compilerArgs>
-                        <arg>${sharedtype.compilerArg}</arg> <!-- supplied from cmd "-Dsharedtype.compilerArg=-proc:only" -->
+                        <arg>${compilerArg}</arg> <!-- supplied from cmd "-Dsharedtype.compilerArg=-proc:only" -->
                         <arg>-Asharedtype.propsFile=${sharedtype.propsFile}</arg>
+                        <arg>-Asharedtype.enabled=true</arg>
                     </compilerArgs>
                     <includes>${compileClasses}</includes>
                 </configuration>

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>online.sharedtype</groupId>
     <artifactId>sharedtype-parent</artifactId>
-    <version>0.10.0-SNAPSHOT</version>
+    <version>0.9.1-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>SharedType Parent</name>

processor/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>online.sharedtype</groupId>
         <artifactId>sharedtype-parent</artifactId>
-        <version>0.10.0-SNAPSHOT</version>
+        <version>0.9.1-SNAPSHOT</version>
         <relativePath>../pom.xml</relativePath>
     </parent>
 

processor/src/main/java/online/sharedtype/processor/AnnotationProcessorImpl.java

@@ -34,12 +34,13 @@
  * @author Cause Chung
  */
 @SupportedAnnotationTypes("online.sharedtype.SharedType")
-@SupportedOptions({"sharedtype.propsFile"})
+@SupportedOptions({"sharedtype.propsFile", "sharedtype.enabled"})
 @AutoService(Processor.class)
 public final class AnnotationProcessorImpl extends AbstractProcessor {
     private static final String PROPS_FILE_OPTION_NAME = "sharedtype.propsFile";
     private static final String DEFAULT_USER_PROPS_FILE = "sharedtype.properties";
     private static final boolean ANNOTATION_CONSUMED = true;
+    private boolean enabled;
     Context ctx;
     TypeDefParser parser;
     TypeResolver resolver;
@@ -54,15 +55,18 @@ public SourceVersion getSupportedSourceVersion() {
     public synchronized void init(ProcessingEnvironment processingEnv) {
         super.init(processingEnv);
         String configFile = processingEnv.getOptions().getOrDefault(PROPS_FILE_OPTION_NAME, DEFAULT_USER_PROPS_FILE);
-        ctx = new Context(processingEnv, PropsFactory.loadProps(Paths.get(configFile)));
-        parser = TypeDefParser.create(ctx);
-        resolver = TypeResolver.create(ctx, parser);
-        writer = TypeWriter.create(ctx);
+        enabled = isEnabled(processingEnv);
+        if (enabled) {
+            ctx = new Context(processingEnv, PropsFactory.loadProps(Paths.get(configFile)));
+            parser = TypeDefParser.create(ctx);
+            resolver = TypeResolver.create(ctx, parser);
+            writer = TypeWriter.create(ctx);
+        }
     }
 
     @Override
     public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
-        if (annotations.isEmpty()) {
+        if (!enabled || annotations.isEmpty()) {
             return ANNOTATION_CONSUMED;
         }
         if (annotations.size() > 1) {
@@ -97,4 +101,9 @@ void doProcess(Set<? extends Element> elements) {
             throw new SharedTypeException("Failed to write,", e);
         }
     }
+
+    private static boolean isEnabled(ProcessingEnvironment processingEnv) {
+        String enabledExpr = processingEnv.getOptions().getOrDefault("sharedtype.enabled", "false");
+        return enabledExpr.equalsIgnoreCase("true") || enabledExpr.equalsIgnoreCase("yes");
+    }
 }

processor/src/main/java/online/sharedtype/processor/context/Context.java

@@ -48,7 +48,8 @@ public Context(ProcessingEnvironment processingEnv, Props props) {
         try {
             trees = Trees.instance(processingEnv);
         } catch (IllegalArgumentException e) {
-            error("The provided processingEnv '%s' does not support Tree API.", processingEnv);
+            warn("The provided processingEnv '%s' (%s) does not support Tree API, some features may not work. Error message: %s",
+                processingEnv, processingEnv.getClass(), e.getMessage());
         }
         this.trees = trees;
     }

processor/src/main/java/online/sharedtype/processor/parser/ConstantTypeDefParser.java

@@ -42,6 +42,10 @@ public List<TypeDef> parse(TypeElement typeElement) {
         if (!SUPPORTED_ELEMENT_KIND.contains(typeElement.getKind().name())) {
             return Collections.emptyList();
         }
+        if (ctx.getTrees() == null) {
+            ctx.info("Skip parsing constants for type %s, because tree is not available.", typeElement);
+            return Collections.emptyList();
+        }
 
         String qualifiedName = typeElement.getQualifiedName().toString();
         List<TypeDef> cachedDefs = ctx.getTypeStore().getTypeDefs(qualifiedName);