🔇 Reduce Noise in Logs

When codemodder encounters a text file with a character encoding that it
does not support, then it fails to read that file and emits an error
level log with a stack trace. This can be very noisy.

Instead, we should emit a warn level log with no stack trace when this
occurs. warn feels right for a couple of reasons:

* this error does not prevent codemodder from completing its analysis;
  rather, codemodder adds the failed file to its "failed files" list in
  its CodeTF report.
* there will always be cases for which we have no recourse for this
  problem.

Also, we need to include the file path in the warning message.

/close #work

Author: gilday

framework/codemodder-base/src/main/java/io/codemodder/DefaultCodemodExecutor.java

@@ -9,6 +9,7 @@
 import io.codemodder.javaparser.JavaParserCodemodRunner;
 import io.codemodder.javaparser.JavaParserFacade;
 import java.io.IOException;
+import java.nio.charset.MalformedInputException;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.*;
@@ -130,7 +131,14 @@ public CodeTFResult execute(final List<Path> filePaths) {
                 }
               }
 
-              String beforeFileContents = fileCache.get(filePath);
+              final String beforeFileContents;
+              try {
+                beforeFileContents = fileCache.get(filePath);
+              } catch (final MalformedInputException e) {
+                log.warn("file uses unsupported character encoding: {}", filePath);
+                unscannableFiles.add(filePath);
+                return;
+              }
 
               Collection<DependencyGAV> deps =
                   projectProviders.stream()
@@ -163,7 +171,7 @@ public CodeTFResult execute(final List<Path> filePaths) {
 
             } catch (Exception e) {
               unscannableFiles.add(filePath);
-              log.error("Problem scanning file", e);
+              log.error("Problem scanning file {}", filePath, e);
             }
           });
     }

framework/codemodder-base/src/main/java/io/codemodder/javaparser/DefaultJavaParserFacade.java

@@ -8,8 +8,6 @@
 import java.nio.file.Path;
 import java.util.Objects;
 import javax.inject.Provider;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 final class DefaultJavaParserFacade implements JavaParserFacade {
 
@@ -31,14 +29,11 @@ public CompilationUnit parseJavaFile(final Path file) throws IOException {
 
     final ParseResult<CompilationUnit> result = parser.parse(file);
     if (!result.isSuccessful()) {
-      logger.error(
-          "Error while parsing file {} encountered problems: {}", file, result.getProblems());
-      throw new RuntimeException("can't parse file");
+      throw new RuntimeException(
+          "Error while parsing file " + file + " encountered problems: " + result.getProblems());
     }
     CompilationUnit cu = result.getResult().orElseThrow();
     LexicalPreservingPrinter.setup(cu);
     return cu;
   }
-
-  private static final Logger logger = LoggerFactory.getLogger(DefaultJavaParserFacade.class);
 }

framework/codemodder-base/src/test/java/io/codemodder/javaparser/DefaultJavaParserFacadeTest.java

@@ -54,7 +54,7 @@ void it_works_on_good_code() throws IOException {
   @Test
   void it_fails_loudly_if_cant_parse() throws IOException {
     Files.writeString(javaFile, "bad code");
-    assertThrows(RuntimeException.class, () -> parser.parseJavaFile(javaFile));
+    assertThrows(JavaParseException.class, () -> parser.parseJavaFile(javaFile));
   }
 
   @Test