Use `classpathFromResources` in recipes generated for Refaster rules by JohannisK · Pull Request #139 · openrewrite/rewrite-templating

JohannisK · 2025-05-02T11:45:38Z

What's changed?

Changed implementation in TemplateCode when generating refaster recipes to use classPathFromResource

What's your motivation?

Ensures Refaster template based recipes are able to match and use external types when running outside of build plugins.

JohannisK · 2025-05-02T11:47:16Z

src/main/java/org/openrewrite/java/template/internal/TemplateCode.java

-                builder.append("\n    .javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))");
+                // builder.append("\n    .javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))");
+                builder.append("\n    .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, ");
+                builder.append(jarNames.stream().map(jarName -> '"' + jarName + '"').collect(joining(", ")));


jarNames is constructed from ClasspathJarNameDetector. Do we need to check if the resulting list is correct and complete, including dependencies from type tables?

JohannisK · 2025-05-02T11:48:19Z

src/test/resources/refaster/EscapesRecipes.java

                    if ((matcher = JavaTemplate
                            .builder("String.format(\"\\\"%s\\\"\", com.sun.tools.javac.util.Convert.quote(#{value:any(java.lang.String)}))")
-                            .javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))
+                            .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "tools"))


How do we "know" that tools is in fact on the classpath or in a type table?
How do we handle situations where the names listed do not match the class path/typetables?

JohannisK · 2025-05-02T12:05:22Z

There are several tests for TemplateProcessor that fail, because the ExecutionContext is not available there.

src/main/java/org/openrewrite/java/template/internal/TemplateCode.java

diff --git c/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java i/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java index a9a22d2..58f1dea 100644 --- c/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java +++ i/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java @@ -68,12 +68,9 @@ public class TemplateCode { jarNames.addAll(ClasspathJarNameDetector.classpathFor(parameter, ImportDetector.imports(parameter))); } if (!jarNames.isEmpty()) { - // It might be preferable to enumerate exactly the needed dependencies rather than the full classpath - // But this is expedient - // See #86 - // String classpath = jarNames.stream().map(jarName -> '"' + jarName + '"').sorted().collect(joining(", ")); - // builder.append("\n .javaParser(JavaParser.fromJavaVersion().classpath(").append(classpath).append("))"); - builder.append("\n .javaParser(JavaParser.fromJavaVersion().classpath(JavaParser.runtimeClasspath()))"); + builder.append("\n .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "); + builder.append(jarNames.stream().map(jarName -> '"' + jarName + '"').collect(joining(", "))); + builder.append("))\n "); } return builder.toString(); } catch (IOException e) {

@OverRide

diff --git c/src/main/java/org/openrewrite/java/template/internal/ClasspathJarNameDetector.java i/src/main/java/org/openrewrite/java/template/internal/ClasspathJarNameDetector.java index ab59a8a..8a4b126 100644 --- c/src/main/java/org/openrewrite/java/template/internal/ClasspathJarNameDetector.java +++ i/src/main/java/org/openrewrite/java/template/internal/ClasspathJarNameDetector.java @@ -19,6 +19,7 @@ import com.sun.tools.javac.code.Symbol; import com.sun.tools.javac.tree.JCTree; import com.sun.tools.javac.tree.JCTree.JCFieldAccess; import com.sun.tools.javac.tree.TreeScanner; +import org.jspecify.annotations.Nullable; import javax.tools.JavaFileObject; import java.util.LinkedHashSet; @@ -38,7 +39,7 @@ public class ClasspathJarNameDetector { public static Set<String> classpathFor(JCTree input, List<Symbol> imports) { Set<String> jarNames = new LinkedHashSet<String>() { @OverRide - public boolean add(String s) { + public boolean add(@nullable String s) { return s != null && super.add(s); } }; @@ -64,7 +65,7 @@ public class ClasspathJarNameDetector { } - private static String jarNameFor(Symbol anImport) { + private static @nullable String jarNameFor(Symbol anImport) { Symbol.ClassSymbol enclClass = anImport instanceof Symbol.ClassSymbol ? (Symbol.ClassSymbol) anImport : anImport.enclClass(); while (enclClass.enclClass() != null && enclClass.enclClass() != enclClass) { enclClass = enclClass.enclClass(); diff --git c/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java i/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java index 58f1dea..337a65a 100644 --- c/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java +++ i/src/main/java/org/openrewrite/java/template/internal/TemplateCode.java @@ -68,9 +68,11 @@ public class TemplateCode { jarNames.addAll(ClasspathJarNameDetector.classpathFor(parameter, ImportDetector.imports(parameter))); } if (!jarNames.isEmpty()) { - builder.append("\n .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, "); - builder.append(jarNames.stream().map(jarName -> '"' + jarName + '"').collect(joining(", "))); - builder.append("))\n "); + String joinedJarNames = jarNames.stream().collect(joining(", ", "\"", "\"")); + builder.append("\n .javaParser(JavaParser.fromJavaVersion().classpathFromResources(ctx, ") + .append(joinedJarNames) + .append("))\n "); + } return builder.toString(); } catch (IOException e) {

src/main/java/org/openrewrite/java/template/processor/TemplateDescriptor.java

knutwannheden · 2025-08-15T06:17:39Z

If I understand this PR correctly, then it just assumes that whatever dependencies are referenced via types in the Refaster template are also present in the jars / type tables of the recipe artifact's resources. I think this seems reasonable.

We should however also make an effort to check that any of the types which are directly referenced by the referenced classes are also loaded. So if we for example reference a class A extends B {} then we need to make sure that we both load the jars for A and B. Otherwise the template compilation will almost certainly fail.

…untimeclasspath-in-remaster-templates

src/main/java/org/openrewrite/java/template/processor/TemplateProcessor.java

timtebeek · 2025-08-15T10:39:46Z

src/main/java/org/openrewrite/java/template/processor/TemplateProcessor.java

+                if (numberOfArguments < 3 || 4 < numberOfArguments) {
+                    return;
+                }
+                boolean classpathFromResources = numberOfArguments == 4;


From the usage site of Semantics you can pass in an initial ExecutionContext where possible to determine if classpathFromResources should be used. This is preferable over a annotation processor option here, as not all usage sites have access to an ExecutionContext, as seen here:
https://github.com/openrewrite/rewrite-apache/blob/df33d276534aaaea4c2f2f93ad681954084e09b2/src/main/java/org/openrewrite/apache/commons/lang/IsNotEmptyToJdk.java#L74-L77

It's also not necessary to pass in an ExecutionContext for every type of use, as seen here for the standard JDK class:
https://github.com/openrewrite/rewrite-migrate-java/blob/6b98403236ad24c7d949750cd1c7af5fb94eebd8/src/main/java/org/openrewrite/java/migrate/UseJavaUtilBase64.java#L126-L127

timtebeek · 2025-08-15T10:40:40Z

src/test/resources/template/LoggerRecipeFromResources.java

+        JavaTemplate.Builder logger = Semantics.expression(ctx, this, "logger", (String s) -> LoggerFactory.getLogger(s));
+        JavaTemplate.Builder info = Semantics.statement(ctx, this, "info", (Logger l, String s) -> l.info(s));


This shows intended use when you do want to pass in an ExecutionContext.

…untimeclasspath-in-remaster-templates

moderne-meeseeks bot added this to OpenRewrite May 2, 2025

github-project-automation bot moved this to In Progress in OpenRewrite May 2, 2025

JohannisK commented May 2, 2025

View reviewed changes

timtebeek changed the title ~~Added implementation for classpathFromResource in refasten templates~~ Added implementation for classpathFromResource in Refaster templates May 2, 2025

timtebeek marked this pull request as draft May 2, 2025 17:19

timtebeek reviewed May 4, 2025

View reviewed changes

src/main/java/org/openrewrite/java/template/internal/TemplateCode.java Outdated Show resolved Hide resolved

timtebeek added bug Something isn't working enhancement New feature or request labels Jun 14, 2025

JohannisK and others added 3 commits August 14, 2025 23:02

Update expectations

fc56e32

timtebeek force-pushed the 1136-use-classpathfromresources-instead-of-runtimeclasspath-in-remaster-templates branch from 643ef43 to fc56e32 Compare August 14, 2025 21:08

Do not use classpathFromResources for TemplateProcessor just yet

b44be87

timtebeek self-assigned this Aug 14, 2025

timtebeek requested a review from knutwannheden August 14, 2025 21:21

timtebeek moved this from In Progress to Ready to Review in OpenRewrite Aug 14, 2025

timtebeek marked this pull request as ready for review August 14, 2025 21:21

timtebeek changed the title ~~Added implementation for classpathFromResource in Refaster templates~~ Use classpathFromResource in Refaster templates Aug 14, 2025

timtebeek changed the title ~~Use classpathFromResource in Refaster templates~~ Use classpathFromResources in recipes generated for Refaster rules Aug 14, 2025

timtebeek reviewed Aug 15, 2025

View reviewed changes

src/main/java/org/openrewrite/java/template/processor/TemplateDescriptor.java Outdated Show resolved Hide resolved

timtebeek added 4 commits August 15, 2025 11:40

Merge branch 'main' into 1136-use-classpathfromresources-instead-of-r…

026d86d

…untimeclasspath-in-remaster-templates

Update expectations for NoGuavaRefasterRecipes.java

979e22c

Add an option to generate classpathFromResources

06e4ab1

Adapt Semantics, PatternBuilder and TemplateProcessor

9d7ca4d

github-actions bot reviewed Aug 15, 2025

View reviewed changes

src/main/java/org/openrewrite/java/template/processor/TemplateProcessor.java Outdated Show resolved Hide resolved

timtebeek added 2 commits August 15, 2025 12:13

Apply formatter

013c36d

Determine classpathFromResources from first argument

979aedc

timtebeek reviewed Aug 15, 2025

View reviewed changes

timtebeek added 2 commits August 15, 2025 13:56

Correctly concatenate more than one jar name

ff581ba

Merge branch 'main' into 1136-use-classpathfromresources-instead-of-r…

515e80f

…untimeclasspath-in-remaster-templates

knutwannheden approved these changes Aug 15, 2025

View reviewed changes

timtebeek merged commit 3c21be2 into main Aug 15, 2025
2 checks passed

timtebeek deleted the 1136-use-classpathfromresources-instead-of-runtimeclasspath-in-remaster-templates branch August 15, 2025 13:47

github-project-automation bot moved this from Ready to Review to Done in OpenRewrite Aug 15, 2025

timtebeek mentioned this pull request Aug 15, 2025

Use classpath from resources for Refaster openrewrite/rewrite-apache#97

Merged

timtebeek mentioned this pull request Oct 13, 2025

Generate OpenRewrite recipes with JavaParser.Builder#classpathFromResources PicnicSupermarket/error-prone-support#1918

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use `classpathFromResources` in recipes generated for Refaster rules#139

Use `classpathFromResources` in recipes generated for Refaster rules#139
timtebeek merged 12 commits intomainfrom
1136-use-classpathfromresources-instead-of-runtimeclasspath-in-remaster-templates

JohannisK commented May 2, 2025 •

edited by timtebeek

Loading

Uh oh!

JohannisK May 2, 2025

Uh oh!

JohannisK May 2, 2025

Uh oh!

JohannisK commented May 2, 2025

Uh oh!

Uh oh!

Uh oh!

knutwannheden commented Aug 15, 2025

Uh oh!

Uh oh!

timtebeek Aug 15, 2025

Uh oh!

timtebeek Aug 15, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		JavaTemplate.Builder logger = Semantics.expression(ctx, this, "logger", (String s) -> LoggerFactory.getLogger(s));
		JavaTemplate.Builder info = Semantics.statement(ctx, this, "info", (Logger l, String s) -> l.info(s));

Conversation

JohannisK commented May 2, 2025 • edited by timtebeek Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's changed?

What's your motivation?

Uh oh!

JohannisK May 2, 2025

Choose a reason for hiding this comment

Uh oh!

JohannisK May 2, 2025

Choose a reason for hiding this comment

Uh oh!

JohannisK commented May 2, 2025

Uh oh!

Uh oh!

Uh oh!

knutwannheden commented Aug 15, 2025

Uh oh!

Uh oh!

timtebeek Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

timtebeek Aug 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JohannisK commented May 2, 2025 •

edited by timtebeek

Loading