Merge pull request #719 from avaje/feature/log-format

Change generator logError to use format over string concatenation
avaje · Oct 31, 2024 · cd757ec · cd757ec
2 parents 1b897aa + 7d6e2ec
commit cd757ec
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 26 deletions.
diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/AllScopes.java b/inject-generator/src/main/java/io/avaje/inject/generator/AllScopes.java
@@ -69,7 +69,7 @@ void readModules(List<String> customScopeModules) {
           final String customScopeType = injectModule.customScopeType();
           final TypeElement scopeType = typeElement(customScopeType);
           if (scopeType == null) {
-            logError(module, "customScopeType [" + customScopeType + "] is invalid? on " + module);
+            logError(module, "customScopeType [%s] is invalid? on %s", customScopeType, module);
           } else {
             final ScopeInfo scopeInfo = addScopeAnnotation(scopeType);
             scopeInfo.readModuleMetaData(module);

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/EventPublisherWriter.java b/inject-generator/src/main/java/io/avaje/inject/generator/EventPublisherWriter.java
@@ -105,7 +105,7 @@ void write() {
       writer.append(MessageFormat.format(TEMPLATE, packageName, imports(), name, className, shortType, typeString, qualifier));
       writer.close();
     } catch (Exception e) {
-      logError("Failed to write EventPublisher class " + e);
+      logError("Failed to write EventPublisher class %s", e);
     }
   }
 

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/ExternalProvider.java b/inject-generator/src/main/java/io/avaje/inject/generator/ExternalProvider.java
@@ -77,7 +77,7 @@ static void registerModuleProvidedTypes(Set<String> providedTypes) {
     }
     for (final var module : modules) {
       final var name = module.getClass().getTypeName();
-      APContext.logNote("Detected Module: " + name);
+      APContext.logNote("Detected Module: %s", name);
       final var provides = new TreeSet<String>();
       for (final var provide : module.provides()) {
         provides.add(provide.getTypeName());
@@ -109,7 +109,7 @@ static void registerModuleProvidedTypes(Set<String> providedTypes) {
   static void registerPluginProvidedTypes(ScopeInfo defaultScope) {
     avajePlugins.forEach((k, v) -> {
       if (APContext.typeElement(k) != null) {
-        APContext.logNote("Loaded Plugin: " + k);
+        APContext.logNote("Loaded Plugin: %s", k);
         v.forEach(defaultScope::pluginProvided);
       }
     });
@@ -128,7 +128,7 @@ static void registerPluginProvidedTypes(ScopeInfo defaultScope) {
       if (avajePlugins.containsKey(name)) {
         continue;
       }
-      APContext.logNote("Loaded Plugin: " + plugin.getClass().getTypeName());
+      APContext.logNote("Loaded Plugin: %s", plugin.getClass().getTypeName());
       for (final var provide : plugin.provides()) {
         defaultScope.pluginProvided(provide.getTypeName());
       }

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/InjectProcessor.java b/inject-generator/src/main/java/io/avaje/inject/generator/InjectProcessor.java
@@ -172,7 +172,7 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         try {
           new SimpleOrderWriter(order, defaultScope).write();
         } catch (IOException e) {
-          logError("FilerException trying to write wiring order class " + e.getMessage());
+          logError("FilerException trying to write wiring order class %s", e.getMessage());
         }
       }
       ProcessingContext.writeSPIServicesFile();

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/MetaDataOrdering.java b/inject-generator/src/main/java/io/avaje/inject/generator/MetaDataOrdering.java
@@ -148,7 +148,7 @@ private void checkMissingDependencies(MetaData metaData) {
     for (Dependency dependency : metaData.dependsOn()) {
       if (providers.get(dependency.name()) == null && !scopeInfo.providedByOtherScope(dependency.name())) {
         TypeElement element = elementMaybe(metaData.type());
-        logError(element, "No dependency provided for " + dependency + " on " + metaData.type());
+        logError(element, "No dependency provided for %s on %s", dependency, metaData.type());
         missingDependencyTypes.add(dependency.name());
       }
     }
@@ -164,7 +164,7 @@ private void warnOnDependencies() {
         .collect(toList());
       logError("Dependencies %s are not provided - there are no @Singleton, @Component, @Factory/@Bean that currently provide this type. If this is an external dependency consider specifying via @External", missingMessage);
     } else if (!queue.isEmpty()) {
-      logWarn("There are " + queue.size() + " beans with unsatisfied dependencies (assuming external dependencies)");
+      logWarn("There are %s beans with unsatisfied dependencies (assuming external dependencies)", queue.size());
       for (MetaData m : queue) {
         logWarn("Unsatisfied dependencies on %s dependsOn %s", m, m.dependsOn());
       }

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/MethodReader.java b/inject-generator/src/main/java/io/avaje/inject/generator/MethodReader.java
@@ -209,16 +209,16 @@ void builderBuildBean(Append writer) {
 
   void builderAddBeanProvider(Append writer) {
     if (isVoid) {
-      APContext.logError("Error - void @Prototype method ?", element);
+      APContext.logError(element,"Error - void @Prototype method ?");
       return;
     }
     if (optionalType) {
-      APContext.logError("Error - Optional type with @Prototype method is not supported", element);
+      APContext.logError(element, "Error - Optional type with @Prototype method is not supported");
       return;
     }
 
     if (multiRegister) {
-      APContext.logError("Error - List<Provider<>> type with @Prototype method is not supported", element);
+      APContext.logError(element,"Error - List<Provider<>> type with @Prototype method is not supported");
       return;
     }
 

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/ProcessingContext.java b/inject-generator/src/main/java/io/avaje/inject/generator/ProcessingContext.java
@@ -96,7 +96,7 @@ private static List<String> loadMetaInf(String fullName) {
     } catch (final FilerException e) {
       logNote("FilerException reading services file");
     } catch (final Exception e) {
-      logWarn("Error reading services file: " + e.getMessage());
+      logWarn("Error reading services file: %s", e.getMessage());
     }
     return Collections.emptyList();
   }
@@ -224,7 +224,7 @@ static void writeSPIServicesFile() {
         writer.close();
       }
     } catch (IOException e) {
-      logError("Failed to write services file " + e.getMessage());
+      logError("Failed to write services file %s", e.getMessage());
     }
   }
 

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/ScopeInfo.java b/inject-generator/src/main/java/io/avaje/inject/generator/ScopeInfo.java
@@ -189,11 +189,9 @@ void writeBeanHelpers() {
           beanReader.setWrittenToFile();
         }
       } catch (FilerException e) {
-        logWarn("FilerException to write $DI class " + beanReader.beanType() + " " + e.getMessage());
-
+        logWarn("FilerException to write $DI class %s %s", beanReader.beanType(), e.getMessage());
       } catch (IOException e) {
-        e.printStackTrace();
-        logError(beanReader.beanType(), "Failed to write $DI class");
+        logError(beanReader.beanType(), "Failed to write $DI class %s", e);
       }
     }
   }
@@ -213,7 +211,7 @@ private void initialiseModule() {
             "using @InjectModule(name), or changing the top level package used by the default scope";
           throw new IllegalStateException(msg);
         }
-        logError("Failed to create module filer " + e.getMessage());
+        logError("Failed to create module filer %s", e.getMessage());
       }
     }
   }
@@ -244,9 +242,9 @@ void writeModule() {
       factoryWriter.write(type());
       moduleWritten = true;
     } catch (FilerException e) {
-      logWarn("FilerException trying to write factory " + e.getMessage());
+      logWarn("FilerException trying to write factory %s", e.getMessage());
     } catch (IOException e) {
-      logError("Failed to write factory " + e.getMessage());
+      logError("Failed to write factory %s", e.getMessage());
     }
   }
 
@@ -296,7 +294,7 @@ private void updateMeta(MetaData metaData, BeanReader beanReader) {
    */
   private void readBeanMeta(TypeElement typeElement, boolean factory, boolean importedComponent) {
     if (typeElement.getKind() == ElementKind.ANNOTATION_TYPE) {
-      logNote("skipping annotation type " + typeElement);
+      logNote("skipping annotation type %s", typeElement);
       return;
     }
     var reader = new BeanReader(typeElement, factory, importedComponent).read();
@@ -313,7 +311,7 @@ void readBuildMethodDependencyMeta(Element element) {
       // read a build method - DependencyMeta
       DependencyMetaPrism meta = DependencyMetaPrism.getInstanceOn(element);
       if (meta == null) {
-        logError("Missing @DependencyMeta on method " + simpleName);
+        logError("Missing @DependencyMeta on method %s", simpleName);
       } else {
         final MetaData metaData = new MetaData(meta);
         this.metaData.put(metaData.key(), metaData);
@@ -325,7 +323,7 @@ void read(TypeElement element, boolean factory, boolean importedComponent) {
     if (readBeans.add(element.toString())) {
       readBeanMeta(element, factory, importedComponent);
     } else {
-      logNote("skipping already processed bean " + element);
+      logNote("skipping already processed bean %s", element);
     }
   }
 

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/SimpleModuleWriter.java b/inject-generator/src/main/java/io/avaje/inject/generator/SimpleModuleWriter.java
@@ -91,7 +91,7 @@ private void writeServicesFile(ScopeInfo.Type scopeType) {
         writer.close();
       }
     } catch (IOException e) {
-      logError("Failed to write services file " + e.getMessage());
+      logError("Failed to write services file %s", e.getMessage());
     }
   }
 

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/TypeAnnotationReader.java b/inject-generator/src/main/java/io/avaje/inject/generator/TypeAnnotationReader.java
@@ -39,7 +39,7 @@ void process() {
           .replace("\"", "\\\"");
 
       } else if (annType.indexOf('.') == -1) {
-        logWarn("skip when no package on annotation " + annType);
+        logWarn("skip when no package on annotation %s", annType);
       }
     }
   }

diff --git a/inject-generator/src/main/java/io/avaje/inject/generator/TypeExtendsReader.java b/inject-generator/src/main/java/io/avaje/inject/generator/TypeExtendsReader.java
@@ -240,7 +240,7 @@ private void readInterfacesOf(TypeMirror anInterface) {
     } else if (!Util.notJavaLang(rawType)) {
       // return
     } else if (rawType.indexOf('.') == -1) {
-      logWarn("skip when no package on interface " + rawType);
+      logWarn("skip when no package on interface %s", rawType);
     } else {
       if (qualifierName == null) {
         final String mainType = rawUType.mainType();