Add more events to ParsingEventListener

openrewrite · Aug 10, 2023 · 8158227 · 8158227
1 parent b065a6e
commit 8158227
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 10 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/text/PlainTextParser.java b/rewrite-core/src/main/java/org/openrewrite/text/PlainTextParser.java
@@ -62,27 +62,28 @@ public static PlainText convert(SourceFile sourceFile) {
     public Stream<SourceFile> parseInputs(Iterable<Input> sources, @Nullable Path relativeTo,
                                           ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
-        return StreamSupport.stream(sources.spliterator(), false).map(source -> {
-            Path path = source.getRelativePath(relativeTo);
+        return StreamSupport.stream(sources.spliterator(), false).map(input -> {
+            Path path = input.getRelativePath(relativeTo);
+            parsingListener.startedParsing(input);
             try {
-                EncodingDetectingInputStream is = source.getSource(ctx);
+                EncodingDetectingInputStream is = input.getSource(ctx);
                 String sourceStr = is.readFully();
                 PlainText plainText = new PlainText(
                         randomId(),
                         path,
                         Markers.EMPTY,
                         is.getCharset().name(),
                         is.isCharsetBomMarked(),
-                        source.getFileAttributes(),
+                        input.getFileAttributes(),
                         null,
                         sourceStr,
                         null
                 );
-                parsingListener.parsed(source, plainText);
+                parsingListener.parsed(input, plainText);
                 return plainText;
             } catch (Throwable t) {
                 ctx.getOnError().accept(t);
-                return ParseError.build(this, source, relativeTo, ctx, t);
+                return ParseError.build(this, input, relativeTo, ctx, t);
             }
         });
     }

diff --git a/rewrite-core/src/main/java/org/openrewrite/tree/ParsingEventListener.java b/rewrite-core/src/main/java/org/openrewrite/tree/ParsingEventListener.java
@@ -19,7 +19,20 @@
 import org.openrewrite.SourceFile;
 
 public interface ParsingEventListener {
-    ParsingEventListener NOOP = (input, sourceFile) -> {};
+    ParsingEventListener NOOP = new ParsingEventListener() {
+    };
 
-    void parsed(Parser.Input input, SourceFile sourceFile);
+    /**
+     * Parsers may call this one or more times before parsing begins on any one source file
+     * to indicate to listeners preparatory steps that are about to be taken.
+     * @param stateMessage The message to the listener.
+     */
+    default void intermediateMessage(String stateMessage) {
+    }
+
+    default void startedParsing(Parser.Input input) {
+    }
+
+    default void parsed(Parser.Input input, SourceFile sourceFile) {
+    }
 }
diff --git a/rewrite-groovy/src/main/java/org/openrewrite/groovy/GroovyParser.java b/rewrite-groovy/src/main/java/org/openrewrite/groovy/GroovyParser.java
@@ -127,6 +127,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sources, @Nullable Path re
                                 errorCollector
                         );
 
+                        pctx.getParsingListener().startedParsing(input);
                         CompilationUnit compUnit = new CompilationUnit(configuration, null, classLoader, classLoader);
                         compUnit.addSource(unit);
                         compUnit.compile(Phases.CANONICALIZATION);

diff --git a/rewrite-hcl/src/main/java/org/openrewrite/hcl/HclParser.java b/rewrite-hcl/src/main/java/org/openrewrite/hcl/HclParser.java
@@ -48,6 +48,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Pat
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles).map(input -> {
             try {
+                parsingListener.startedParsing(input);
                 EncodingDetectingInputStream is = input.getSource(ctx);
                 String sourceStr = is.readFully();
 

diff --git a/rewrite-java-11/src/main/java/org/openrewrite/java/isolated/ReloadableJava11Parser.java b/rewrite-java-11/src/main/java/org/openrewrite/java/isolated/ReloadableJava11Parser.java
@@ -152,9 +152,10 @@ public static Builder builder() {
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         LinkedHashMap<Input, JCTree.JCCompilationUnit> cus = parseInputsToCompilerAst(sourceFiles, ctx);
-
+        parsingListener.intermediateMessage("Compiling Java source files");
         return cus.entrySet().stream().map(cuByPath -> {
             Input input = cuByPath.getKey();
+            parsingListener.startedParsing(input);
             try {
                 ReloadableJava11ParserVisitor parser = new ReloadableJava11ParserVisitor(
                         input.getRelativePath(relativeTo),

diff --git a/rewrite-java-17/src/main/java/org/openrewrite/java/isolated/ReloadableJava17Parser.java b/rewrite-java-17/src/main/java/org/openrewrite/java/isolated/ReloadableJava17Parser.java
@@ -148,9 +148,11 @@ public static Builder builder() {
     @Override
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
+        parsingListener.intermediateMessage("Compiling Java source files");
         LinkedHashMap<Input, JCTree.JCCompilationUnit> cus = parseInputsToCompilerAst(sourceFiles, ctx);
         return cus.entrySet().stream().map(cuByPath -> {
             Input input = cuByPath.getKey();
+            parsingListener.startedParsing(input);
             try {
                 ReloadableJava17ParserVisitor parser = new ReloadableJava17ParserVisitor(
                         input.getRelativePath(relativeTo),

diff --git a/rewrite-java-8/src/main/java/org/openrewrite/java/ReloadableJava8Parser.java b/rewrite-java-8/src/main/java/org/openrewrite/java/ReloadableJava8Parser.java
@@ -138,7 +138,7 @@ public void close() {
     @Override
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
-
+        parsingListener.intermediateMessage("Compiling Java source files");
         if (classpath != null) { // override classpath
             if (context.get(JavaFileManager.class) != pfm) {
                 throw new IllegalStateException("JavaFileManager has been forked unexpectedly");
@@ -180,6 +180,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Pat
 
         return cus.entrySet().stream().map(cuByPath -> {
             Input input = cuByPath.getKey();
+            parsingListener.startedParsing(input);
             try {
                 ReloadableJava8ParserVisitor parser = new ReloadableJava8ParserVisitor(
                         input.getRelativePath(relativeTo),

diff --git a/rewrite-json/src/main/java/org/openrewrite/json/JsonParser.java b/rewrite-json/src/main/java/org/openrewrite/json/JsonParser.java
@@ -37,6 +37,7 @@ public class JsonParser implements Parser {
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles).map(input -> {
+            parsingListener.startedParsing(input);
             try (InputStream sourceStream = input.getSource(ctx)) {
                 JSON5Parser parser = new JSON5Parser(new CommonTokenStream(new JSON5Lexer(
                         CharStreams.fromStream(sourceStream))));

diff --git a/rewrite-maven/src/main/java/org/openrewrite/maven/MavenParser.java b/rewrite-maven/src/main/java/org/openrewrite/maven/MavenParser.java
@@ -26,6 +26,7 @@
 import org.openrewrite.maven.tree.Pom;
 import org.openrewrite.maven.tree.ResolvedPom;
 import org.openrewrite.tree.ParseError;
+import org.openrewrite.tree.ParsingExecutionContextView;
 import org.openrewrite.xml.XmlParser;
 import org.openrewrite.xml.tree.Xml;
 
@@ -94,6 +95,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sources, @Nullable Path re
             }
         }
 
+        ParsingExecutionContextView.view(ctx).getParsingListener().intermediateMessage("Resolving Maven dependencies");
         MavenPomDownloader downloader = new MavenPomDownloader(projectPomsByPath, ctx);
 
         MavenExecutionContextView mavenCtx = MavenExecutionContextView.view(ctx);

diff --git a/rewrite-properties/src/main/java/org/openrewrite/properties/PropertiesParser.java b/rewrite-properties/src/main/java/org/openrewrite/properties/PropertiesParser.java
@@ -42,6 +42,7 @@ public Stream<SourceFile> parse(@Language("properties") String... sources) {
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles).map(input -> {
+            parsingListener.startedParsing(input);
             Path path = input.getRelativePath(relativeTo);
             try (EncodingDetectingInputStream is = input.getSource(ctx)) {
                 Properties.File file = parseFromInput(path, is)

diff --git a/rewrite-protobuf/src/main/java/org/openrewrite/protobuf/ProtoParser.java b/rewrite-protobuf/src/main/java/org/openrewrite/protobuf/ProtoParser.java
@@ -39,6 +39,7 @@ public class ProtoParser implements Parser {
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles).map(input -> {
+                    parsingListener.startedParsing(input);
                     Path path = input.getRelativePath(relativeTo);
                     try {
                         EncodingDetectingInputStream is = input.getSource(ctx);

diff --git a/rewrite-xml/src/main/java/org/openrewrite/xml/XmlParser.java b/rewrite-xml/src/main/java/org/openrewrite/xml/XmlParser.java
@@ -37,6 +37,7 @@ public class XmlParser implements Parser {
     public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Path relativeTo, ExecutionContext ctx) {
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles).map(input -> {
+            parsingListener.startedParsing(input);
             Path path = input.getRelativePath(relativeTo);
             try (EncodingDetectingInputStream is = input.getSource(ctx)) {
                 String sourceStr = is.readFully();

diff --git a/rewrite-yaml/src/main/java/org/openrewrite/yaml/YamlParser.java b/rewrite-yaml/src/main/java/org/openrewrite/yaml/YamlParser.java
@@ -61,6 +61,7 @@ public Stream<SourceFile> parseInputs(Iterable<Input> sourceFiles, @Nullable Pat
         ParsingEventListener parsingListener = ParsingExecutionContextView.view(ctx).getParsingListener();
         return acceptedInputs(sourceFiles)
                 .map(input -> {
+                    parsingListener.startedParsing(input);
                     Path path = input.getRelativePath(relativeTo);
                     try (EncodingDetectingInputStream is = input.getSource(ctx)) {
                         Yaml.Documents yaml = parseFromInput(path, is);