Don't include diff in exception in Result (#4997)

* Don't include diff in exception in `Result` In order to allow clients of OpenRewrite to decide whether to include (or not) the diff text when a source file changed but no changes were reported, extract the logic to a new `Exception`, `UnknownSourceFileChangeException`, passing in the `SourceFile` and diff. * Add explicit constructor that calls super --------- Co-authored-by: Tim te Beek <[email protected]>
openrewrite · Feb 7, 2025 · 332c700 · 332c700
1 parent d7933f9
commit 332c700
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 6 deletions.
diff --git a/rewrite-core/src/main/java/org/openrewrite/Result.java b/rewrite-core/src/main/java/org/openrewrite/Result.java
@@ -76,12 +76,9 @@ public Result(@Nullable SourceFile before, @Nullable SourceFile after, Collectio
     public Result(@Nullable SourceFile before, SourceFile after) {
         this(before, after, after.getMarkers()
                 .findFirst(RecipesThatMadeChanges.class)
-                .orElseThrow(() -> new IllegalStateException(
-                        String.format(
-                                "Source file changed but no recipe " +
-                                "reported making a change. %s",
-                                explainWhatChanged(before, after)
-                        )
+                .orElseThrow(() -> new UnknownSourceFileChangeException(
+                        after,
+                        explainWhatChanged(before, after)
                 ))
                 .getRecipes());
     }

diff --git a/rewrite-core/src/main/java/org/openrewrite/UnknownSourceFileChangeException.java b/rewrite-core/src/main/java/org/openrewrite/UnknownSourceFileChangeException.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2025 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;
+
+import lombok.EqualsAndHashCode;
+import lombok.Value;
+
+@Value
+@EqualsAndHashCode(callSuper = false)
+public class UnknownSourceFileChangeException extends RecipeException {
+    SourceFile sourceFile;
+    String diff;
+
+    public UnknownSourceFileChangeException(SourceFile sourceFile, String diff) {
+        super("Source file changed but no recipe reported making a change.");
+        this.sourceFile = sourceFile;
+        this.diff = diff;
+    }
+}