Merge remote-tracking branch 'origin/main'

Author: MBoegers

build.gradle.kts

@@ -1,3 +1,5 @@
+import java.util.Calendar
+
 plugins {
     id("org.openrewrite.build.root") version "latest.release"
     id("org.openrewrite.build.java-base") version "latest.release"
@@ -23,6 +25,29 @@ allprojects {
     description = "Eliminate tech-debt. Automatically."
 }
 
+subprojects {
+    tasks.withType<JavaExec>().configureEach {
+        if (name == "generateAntlrSources") {
+            doLast {
+                val idx = args?.indexOf("-o") ?: return@doLast
+                if (idx < 0 || idx + 1 >= args!!.size) return@doLast
+                val rootPrefix = rootProject.projectDir.absolutePath + "/"
+                val year = Calendar.getInstance().get(Calendar.YEAR)
+                val licenseHeader = "/*\n" + rootProject.file("gradle/licenseHeader.txt")
+                    .readText().trim()
+                    .replace("\${year}", year.toString())
+                    .lines()
+                    .joinToString("\n") { " * $it".trimEnd() } + "\n */\n"
+                project.file(args!![idx + 1]).walk().filter { it.extension == "java" }.forEach { file ->
+                    file.writeText(licenseHeader + file.readLines().joinToString("\n") { line ->
+                        line.trimEnd().replace("// Generated from $rootPrefix", "// Generated from ")
+                    } + "\n")
+                }
+            }
+        }
+    }
+}
+
 // Use this task locally between different dependency check runs to have updated analysis:
 // OSSINDEX_PASSWORD=... OSSINDEX_USERNAME=... gradle cleanReports dCAg --no-parallel
 tasks.register<Delete>("cleanReports") {

gradle/wrapper/gradle-wrapper.properties

@@ -1,8 +1,8 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionSha256Sum=0d585f69da091fc5b2beced877feab55a3064d43b8a1d46aeb07996b0915e0e0
+distributionSha256Sum=b266d5ff6b90eada6dc3b20cb090e3731302e553a27c5d3e4df1f0d76beaff06

rewrite-core/build.gradle.kts

@@ -46,5 +46,5 @@ tasks.withType<Javadoc> {
     //   symbol:   method onConstructor_()
     //   location: @interface AllArgsConstructor
     // 1 error
-    exclude("**/RpcObjectData.java")
+    exclude("**/RpcObjectData.java", "**/RecipeDescriptor.java")
 }

rewrite-core/src/main/java/org/openrewrite/Checksum.java

@@ -25,6 +25,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.UncheckedIOException;
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
@@ -83,6 +84,10 @@ public static Checksum fromUri(HttpSender httpSender, URI uri, String algorithm)
                 .withMethod(HttpSender.Method.GET)
                 .build();
         try (HttpSender.Response response = httpSender.send(request)) {
+            if (!response.isSuccessful()) {
+                throw new UncheckedIOException(new IOException(
+                        "Failed to download checksum from " + uri + ": HTTP " + response.getCode()));
+            }
             String hexString = new String(response.getBodyAsBytes(), StandardCharsets.UTF_8);
             return Checksum.fromHex(algorithm, hexString);
         }

rewrite-core/src/main/java/org/openrewrite/LargeSourceSet.java

@@ -99,4 +99,17 @@ default void afterCycle(boolean lastCycle) {
      */
     @Nullable
     SourceFile getBefore(Path sourcePath);
+
+    /**
+     * Called when a recipe's {@code generate()} produces a file whose path collides with
+     * an existing source file or with another generated file. The generated file is silently
+     * dropped. Implementations may override this to detect the collision (e.g. the test
+     * framework raises an assertion failure).
+     *
+     * @param sourcePath    The colliding source path.
+     * @param existingFile  {@code true} if the collision is with an existing source file,
+     *                      {@code false} if it's with another generated file.
+     */
+    default void onGenerateCollision(Path sourcePath, boolean existingFile) {
+    }
 }

rewrite-core/src/main/java/org/openrewrite/Recipe.java

@@ -203,8 +203,6 @@ public String getInstanceNameSuffix() {
      * A set of strings used for categorizing related recipes. For example
      * "testing", "junit", "spring". Any individual tag should consist of a
      * single word, all lowercase.
-     *
-     * @return The tags.
      */
     @Getter
     final Set<String> tags = emptySet();
@@ -225,11 +223,21 @@ public final RecipeDescriptor getDescriptor() {
 
     protected RecipeDescriptor createRecipeDescriptor() {
         List<OptionDescriptor> options = getOptionDescriptors();
-        ArrayList<RecipeDescriptor> recipeList1 = new ArrayList<>();
-        for (Recipe next : getRecipeList()) {
-            recipeList1.add(next.getDescriptor());
+        List<RecipeDescriptor> preconditionDescriptors = emptyList();
+        if (this instanceof RecipePreconditions) {
+            RecipePreconditions recipeWithPreconditions = (RecipePreconditions) this;
+            List<Recipe> preconditions = recipeWithPreconditions.getPreconditions();
+            preconditionDescriptors = new ArrayList<>(preconditions.size());
+            for (Recipe precondition : preconditions) {
+                preconditionDescriptors.add(precondition.getDescriptor());
+            }
+        }
+
+        List<Recipe> recipeList = getRecipeList();
+        List<RecipeDescriptor> recipeDescriptors = new ArrayList<>(recipeList.size());
+        for (Recipe next : recipeList) {
+            recipeDescriptors.add(next.getDescriptor());
         }
-        recipeList1.trimToSize();
 
         URI recipeSource;
         try {
@@ -239,7 +247,7 @@ protected RecipeDescriptor createRecipeDescriptor() {
         }
 
         return new RecipeDescriptor(getName(), getDisplayName(), getInstanceName(), getDescription(), getTags(),
-                getEstimatedEffortPerOccurrence(), options, recipeList1, getDataTableDescriptors(),
+                getEstimatedEffortPerOccurrence(), options, preconditionDescriptors, recipeDescriptors, getDataTableDescriptors(),
                 getMaintainers(), getContributors(), getExamples(), recipeSource);
     }
 

rewrite-core/src/main/java/org/openrewrite/Singleton.java

@@ -81,12 +81,8 @@ public class Singleton extends Recipe {
             "The easiest way is to use Lombok's `@Value` annotation on your recipe class, which automatically " +
             "generates correct `equals()` and `hashCode()` implementations based on all fields.";
 
-    @Nullable Integer recipeIndex;
-
     public boolean isSingleton(ExecutionContext ctx) {
-        if (recipeIndex == null) {
-            recipeIndex = ctx.getCycleDetails().getRecipePosition();
-        }
+        Integer recipeIndex = ctx.computeMessageIfAbsent(getClass().getName() + "@" + Integer.toHexString(System.identityHashCode(this)), key -> ctx.getCycleDetails().getRecipePosition());
         return recipeIndex == ctx.getCycleDetails().getRecipePosition();
     }
 

rewrite-core/src/main/java/org/openrewrite/config/DeclarativeRecipe.java

@@ -32,7 +32,7 @@
 import static org.openrewrite.Validated.invalid;
 
 @RequiredArgsConstructor
-public class DeclarativeRecipe extends ScanningRecipe<DeclarativeRecipe.Accumulator> {
+public class DeclarativeRecipe extends ScanningRecipe<DeclarativeRecipe.Accumulator> implements RecipePreconditions {
     @Getter
     private final String name;
 
@@ -161,17 +161,16 @@ private void initializeDeclarativeRecipe(DeclarativeRecipe declarativeRecipe, St
         }
     }
 
-    @SuppressWarnings("NotNullFieldNotInitialized")
     @JsonIgnore
-    private transient Accumulator accumulator;
+    private transient ThreadLocal<Accumulator> accumulator = new ThreadLocal<>();
 
     @Override
     public Accumulator getInitialValue(ExecutionContext ctx) {
         Accumulator acc = new Accumulator();
         for (Recipe precondition : preconditions) {
             registerNestedScanningRecipes(precondition, acc, ctx);
         }
-        accumulator = acc;
+        accumulator.set(acc);
         return acc;
     }
 
@@ -187,7 +186,6 @@ private void registerNestedScanningRecipes(Recipe recipe, Accumulator acc, Execu
     @Override
     public TreeVisitor<?, ExecutionContext> getScanner(Accumulator acc) {
         return new TreeVisitor<Tree, ExecutionContext>() {
-            @SuppressWarnings({"rawtypes", "unchecked"})
             @Override
             public @Nullable Tree visit(@Nullable Tree tree, ExecutionContext ctx) {
                 for (Recipe precondition : preconditions) {
@@ -251,7 +249,7 @@ public boolean isAcceptable(SourceFile sourceFile, ExecutionContext ctx) {
 
     @EqualsAndHashCode(callSuper = false)
     @Value
-    static class BellwetherDecoratedRecipe extends Recipe implements DelegatingRecipe {
+    static class BellwetherDecoratedRecipe extends Recipe implements DelegatingRecipe, RecipePreconditions {
 
         DeclarativeRecipe.PreconditionBellwether bellwether;
         Recipe delegate;
@@ -350,11 +348,19 @@ public Validated<Object> validate(ExecutionContext ctx) {
         public Collection<Validated<Object>> validateAll(ExecutionContext ctx, Collection<Validated<Object>> acc) {
             return delegate.validateAll(ctx, acc);
         }
+
+        @Override
+        public List<Recipe> getPreconditions() {
+            if (delegate instanceof RecipePreconditions) {
+                return ((RecipePreconditions) delegate).getPreconditions();
+            }
+            return emptyList();
+        }
     }
 
     @Value
     @EqualsAndHashCode(callSuper = false)
-    static class BellwetherDecoratedScanningRecipe<T> extends ScanningRecipe<T> implements DelegatingRecipe {
+    static class BellwetherDecoratedScanningRecipe<T> extends ScanningRecipe<T> implements DelegatingRecipe, RecipePreconditions {
 
         DeclarativeRecipe.PreconditionBellwether bellwether;
         ScanningRecipe<T> delegate;
@@ -468,6 +474,14 @@ public Validated<Object> validate(ExecutionContext ctx) {
         public Collection<Validated<Object>> validateAll(ExecutionContext ctx, Collection<Validated<Object>> acc) {
             return delegate.validateAll(ctx, acc);
         }
+
+        @Override
+        public List<Recipe> getPreconditions() {
+            if (delegate instanceof RecipePreconditions) {
+                return ((RecipePreconditions) delegate).getPreconditions();
+            }
+            return emptyList();
+        }
     }
 
     @Override
@@ -494,7 +508,8 @@ private TreeVisitor<?, ExecutionContext> orVisitors(Recipe recipe) {
             //noinspection rawtypes
             ScanningRecipe scanning = (ScanningRecipe) recipe;
             //noinspection unchecked
-            conditions.add(scanning.getVisitor(accumulator.recipeToAccumulator.get(scanning)));
+            Accumulator acc = accumulator.get();
+            conditions.add(scanning.getVisitor(acc != null ? acc.recipeToAccumulator.get(scanning) : null));
         } else {
             conditions.add(recipe.getVisitor());
         }
@@ -587,15 +602,31 @@ private static class LazyLoadedRecipe extends Recipe {
         String description = "Recipe that is loaded lazily.";
     }
 
+    @Override
+    public void onComplete(ExecutionContext ctx) {
+        accumulator.remove();
+    }
+
+    @Override
+    public DeclarativeRecipe clone() {
+        DeclarativeRecipe cloned = (DeclarativeRecipe) super.clone();
+        cloned.accumulator = new ThreadLocal<>();
+        return cloned;
+    }
+
     @Override
     protected RecipeDescriptor createRecipeDescriptor() {
-        List<RecipeDescriptor> recipeList = new ArrayList<>();
-        for (Recipe childRecipe : getRecipeList()) {
-            recipeList.add(childRecipe.getDescriptor());
+        List<RecipeDescriptor> preconditionDescriptors = new ArrayList<>();
+        for (Recipe childRecipe : preconditions) {
+            preconditionDescriptors.add(childRecipe.getDescriptor());
+        }
+        List<RecipeDescriptor> recipeDescriptors = new ArrayList<>();
+        for (Recipe childRecipe : recipeList) {
+            recipeDescriptors.add(childRecipe.getDescriptor());
         }
         return new RecipeDescriptor(getName(), getDisplayName(), getInstanceName(), getDescription() != null ? getDescription() : "",
                 getTags(), getEstimatedEffortPerOccurrence(),
-                emptyList(), recipeList, getDataTableDescriptors(), getMaintainers(), getContributors(),
+                emptyList(), preconditionDescriptors, recipeDescriptors, getDataTableDescriptors(), getMaintainers(), getContributors(),
                 getExamples(), source);
     }
 

rewrite-core/src/main/java/org/openrewrite/config/RecipeDescriptor.java

@@ -15,6 +15,8 @@
  */
 package org.openrewrite.config;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
 import lombok.Value;
 import lombok.With;
@@ -36,6 +38,7 @@
 
 @Value
 @EqualsAndHashCode(onlyExplicitlyIncluded = true)
+@AllArgsConstructor(onConstructor = @__(@JsonCreator))
 public class RecipeDescriptor {
     @EqualsAndHashCode.Include
     String name;
@@ -57,6 +60,9 @@ public class RecipeDescriptor {
     @EqualsAndHashCode.Include
     List<OptionDescriptor> options;
 
+    @With
+    List<RecipeDescriptor> preconditions;
+
     @With
     List<RecipeDescriptor> recipeList;
 
@@ -73,6 +79,16 @@ public class RecipeDescriptor {
     @Deprecated
     URI source;
 
+    @Deprecated
+    public RecipeDescriptor(String name, String displayName, String instanceName, String description,
+                            Set<String> tags, @Nullable Duration estimatedEffortPerOccurrence,
+                            List<OptionDescriptor> options, List<RecipeDescriptor> recipeList,
+                            List<DataTableDescriptor> dataTables, List<Maintainer> maintainers,
+                            List<Contributor> contributors, List<RecipeExample> examples, URI source) {
+        this(name, displayName, instanceName, description, tags, estimatedEffortPerOccurrence,
+                options, emptyList(), recipeList, dataTables, maintainers, contributors, examples, source);
+    }
+
     /**
      * @param env Provides a source of category descriptors to build category names from more
      *            than just the name segments.

rewrite-core/src/main/java/org/openrewrite/config/RecipePreconditions.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright 2026 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.config;
+
+import org.openrewrite.Recipe;
+
+import java.util.List;
+
+/**
+ * Indicates that a recipe exposes a list of recipes used as preconditions.
+ * This is purely informational and not taken into consideration by recipe execution.
+ * Imperative recipes interact with preconditions as implementation details of their visitor(s).
+ * There is no reason for an imperative recipe to implement this, it will not affect the behavior of the recipe in any way.
+ */
+public interface RecipePreconditions {
+    List<Recipe> getPreconditions();
+}