Skip to content

Register accumulators for nested ScanningRecipes in OR preconditions #6701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sambsnyd merged 3 commits into from
Feb 9, 2026
Merged

Register accumulators for nested ScanningRecipes in OR preconditions #6701

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b88f7a8
Add failing tests for nested ScanningRecipes in OR preconditions
Jenson3210 Feb 9, 2026
2499adb
Register accumulators for nested ScanningRecipes in OR preconditions
Jenson3210 Feb 9, 2026
f5c8ebb
Use @Issue annotations instead of comments in tests
Jenson3210 Feb 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 23 additions & 9 deletions rewrite-core/src/main/java/org/openrewrite/config/DeclarativeRecipe.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,33 +169,47 @@ private void initializeDeclarativeRecipe(DeclarativeRecipe declarativeRecipe, St
public Accumulator getInitialValue(ExecutionContext ctx) {
Accumulator acc = new Accumulator();
for (Recipe precondition : preconditions) {
if (precondition instanceof ScanningRecipe && isScanningRequired(precondition)) {
acc.recipeToAccumulator.put(precondition, ((ScanningRecipe<?>) precondition).getInitialValue(ctx));
}
registerNestedScanningRecipes(precondition, acc, ctx);
}
accumulator = acc;
return acc;
}

private void registerNestedScanningRecipes(Recipe recipe, Accumulator acc, ExecutionContext ctx) {
if (recipe instanceof ScanningRecipe && isScanningRequired(recipe)) {
acc.recipeToAccumulator.put(recipe, ((ScanningRecipe<?>) recipe).getInitialValue(ctx));
}
for (Recipe nested : recipe.getRecipeList()) {
registerNestedScanningRecipes(nested, acc, ctx);
}
}

@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) {
if (precondition instanceof ScanningRecipe && isScanningRequired(precondition)) {
ScanningRecipe preconditionRecipe = (ScanningRecipe) precondition;
Object preconditionAcc = acc.recipeToAccumulator.get(precondition);
preconditionRecipe.getScanner(preconditionAcc)
.visit(tree, ctx);
}
scanNestedScanningRecipes(precondition, acc, tree, ctx);
}
return tree;
}
};
}

@SuppressWarnings({"rawtypes", "unchecked"})
private void scanNestedScanningRecipes(Recipe recipe, Accumulator acc, @Nullable Tree tree, ExecutionContext ctx) {
if (recipe instanceof ScanningRecipe && isScanningRequired(recipe)) {
ScanningRecipe scanningRecipe = (ScanningRecipe) recipe;
Object recipeAcc = acc.recipeToAccumulator.get(recipe);
scanningRecipe.getScanner(recipeAcc).visit(tree, ctx);
}
for (Recipe nested : recipe.getRecipeList()) {
scanNestedScanningRecipes(nested, acc, tree, ctx);
}
}

public static class Accumulator {
Map<Recipe, Object> recipeToAccumulator = new HashMap<>();
}
Expand Down
182 changes: 182 additions & 0 deletions rewrite-core/src/test/java/org/openrewrite/config/DeclarativeRecipeTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,6 +485,188 @@ void mutuallyRecursiveRecipesDetectedAsCycle() {
.hasMessageContaining("RecipeB");
}

@Issue("https://github.com/openrewrite/rewrite/issues/6698")
@Test
void nestedScanningRecipeInOrPrecondition() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.AddJacksonAnnotations
description: Test.
preconditions:
- org.sample.ProjectUsesJackson
recipeList:
- org.openrewrite.text.ChangeText:
toText: changed
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.ProjectUsesJackson
description: OR precondition - matches if ANY condition is true
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/jackson-config.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/jackson.properties"
""",
"org.sample.AddJacksonAnnotations"
),
// jackson-config.json triggers the precondition, so all files get changed
text("config", "changed", spec -> spec.path("jackson-config.json")),
text("original", "changed")
);
}

@Issue("https://github.com/openrewrite/rewrite/issues/6698")
@Test
void nestedScanningRecipeInOrPreconditionNotMet() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.AddJacksonAnnotations
description: Test.
preconditions:
- org.sample.ProjectUsesJackson
recipeList:
- org.openrewrite.text.ChangeText:
toText: changed
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.ProjectUsesJackson
description: OR precondition - matches if ANY condition is true
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/jackson-config.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/jackson.properties"
""",
"org.sample.AddJacksonAnnotations"
),
text("config", spec -> spec.path("some-other-file.txt")),
text("original")
);
}

@Issue("https://github.com/openrewrite/rewrite/issues/6698")
@Test
void sameScanningRecipeWithDifferentParametersInOrPrecondition() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.MultiFileCheck
description: Test.
preconditions:
- org.sample.HasAnyConfigFile
recipeList:
- org.openrewrite.text.ChangeText:
toText: changed
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.HasAnyConfigFile
description: OR precondition with same recipe type but different params
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/config-a.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/config-b.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/config-c.json"
""",
"org.sample.MultiFileCheck"
),
// Only config-b.json exists, so should still match due to OR logic
// When matched, all files are changed
text("config b", "changed", spec -> spec.path("config-b.json")),
text("original", "changed")
);
}

@Issue("https://github.com/openrewrite/rewrite/issues/6698")
@Test
void deeplyNestedOrPreconditionsWithScanningRecipe() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.TopLevel
description: Test.
preconditions:
- org.sample.MiddleLevel
recipeList:
- org.openrewrite.text.ChangeText:
toText: changed
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.MiddleLevel
description: Middle level precondition
recipeList:
- org.sample.BottomLevel
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/middle.json"
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.BottomLevel
description: Bottom level with scanning recipes
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/bottom-a.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/bottom-b.json"
""",
"org.sample.TopLevel"
),
// Only bottom-b.json exists, which should match through the nested OR chain
// When matched, all files are changed
text("bottom b config", "changed", spec -> spec.path("bottom-b.json")),
text("original", "changed")
);
}

@Issue("https://github.com/openrewrite/rewrite/issues/6698")
@Test
void multipleNestedOrPreconditionsWithSameScanningRecipe() {
rewriteRun(
spec -> spec.recipeFromYaml(
"""
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.TopLevel
description: Test.
preconditions:
- org.sample.BranchA
- org.sample.BranchB
recipeList:
- org.openrewrite.text.ChangeText:
toText: changed
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.BranchA
description: First branch
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/branch-a-1.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/shared.json"
---
type: specs.openrewrite.org/v1beta/recipe
name: org.sample.BranchB
description: Second branch
recipeList:
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/branch-b-1.json"
- org.openrewrite.search.RepositoryContainsFile:
filePattern: "**/shared.json"
""",
"org.sample.TopLevel"
),
// shared.json exists, which should satisfy both branches (AND of two ORs)
// When matched, all files are changed
text("shared config", "changed", spec -> spec.path("shared.json")),
text("original", "changed")
);
}

@Test
void deeperCyclicReferencesDetectedAsCycle() {
// Test that deeper cyclic references (A -> B -> C -> A) are detected as a cycle
Expand Down
⚡