Skip to content

OAK-12017: Add path information to CommitFailedException in EditorDiff #2635

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

Open
cschneider wants to merge 1 commit into
base: trunk
Choose a base branch
from
+40 −12
Open

OAK-12017: Add path information to CommitFailedException in EditorDiff #2635

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 40 additions & 12 deletions oak-store-spi/src/main/java/org/apache/jackrabbit/oak/spi/commit/EditorDiff.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@

import org.apache.jackrabbit.oak.api.CommitFailedException;
import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.commons.PathUtils;
import org.apache.jackrabbit.oak.spi.state.NodeState;
import org.apache.jackrabbit.oak.spi.state.NodeStateDiff;
import org.jetbrains.annotations.NotNull;
Expand All @@ -47,20 +48,21 @@ public static CommitFailedException process(
try {
editor.enter(before, after);

EditorDiff diff = new EditorDiff(editor);
EditorDiff diff = new EditorDiff(editor, "/");
if (!after.compareAgainstBaseState(before, diff)) {
return diff.exception;
}

editor.leave(before, after);
} catch (CommitFailedException e) {
return e;
return enhanceExceptionWithPath(e, "/");
}
}
return null;
}

private final Editor editor;
private final String path;

/**
* Checked exceptions don't compose. So we need to hack around.
Expand All @@ -69,8 +71,9 @@ public static CommitFailedException process(
*/
private CommitFailedException exception;

private EditorDiff(Editor editor) {
private EditorDiff(Editor editor, String path) {
this.editor = editor;
this.path = path;
}

//-------------------------------------------------< NodeStateDiff >--
Expand All @@ -81,7 +84,7 @@ public boolean propertyAdded(PropertyState after) {
editor.propertyAdded(after);
return true;
} catch (CommitFailedException e) {
exception = e;
exception = enhanceExceptionWithPath(e, path);
return false;
}
}
Expand All @@ -92,7 +95,7 @@ public boolean propertyChanged(PropertyState before, PropertyState after) {
editor.propertyChanged(before, after);
return true;
} catch (CommitFailedException e) {
exception = e;
exception = enhanceExceptionWithPath(e, path);
return false;
}
}
Expand All @@ -103,7 +106,7 @@ public boolean propertyDeleted(PropertyState before) {
editor.propertyDeleted(before);
return true;
} catch (CommitFailedException e) {
exception = e;
exception = enhanceExceptionWithPath(e, path);
return false;
}
}
Expand All @@ -120,7 +123,8 @@ public boolean childNodeAdded(String name, NodeState after) {
if (childEditor != null) {
childEditor.enter(before, after);

EditorDiff diff = new EditorDiff(childEditor);
String childPath = PathUtils.concat(path, name);
EditorDiff diff = new EditorDiff(childEditor, childPath);
if (!after.compareAgainstBaseState(before, diff)) {
exception = diff.exception;
return false;
Expand All @@ -130,7 +134,8 @@ public boolean childNodeAdded(String name, NodeState after) {
}
return true;
} catch (CommitFailedException e) {
exception = e;
String childPath = PathUtils.concat(path, name);
exception = enhanceExceptionWithPath(e, childPath);
return false;
}
}
Expand All @@ -143,7 +148,8 @@ public boolean childNodeChanged(
if (childEditor != null) {
childEditor.enter(before, after);

EditorDiff diff = new EditorDiff(childEditor);
String childPath = PathUtils.concat(path, name);
EditorDiff diff = new EditorDiff(childEditor, childPath);
if (!after.compareAgainstBaseState(before, diff)) {
exception = diff.exception;
return false;
Expand All @@ -153,7 +159,8 @@ public boolean childNodeChanged(
}
return true;
} catch (CommitFailedException e) {
exception = e;
String childPath = PathUtils.concat(path, name);
exception = enhanceExceptionWithPath(e, childPath);
return false;
}
}
Expand All @@ -166,7 +173,8 @@ public boolean childNodeDeleted(String name, NodeState before) {
if (childEditor != null) {
childEditor.enter(before, after);

EditorDiff diff = new EditorDiff(childEditor);
String childPath = PathUtils.concat(path, name);
EditorDiff diff = new EditorDiff(childEditor, childPath);
if (!after.compareAgainstBaseState(before, diff)) {
exception = diff.exception;
return false;
Expand All @@ -176,9 +184,29 @@ public boolean childNodeDeleted(String name, NodeState before) {
}
return true;
} catch (CommitFailedException e) {
exception = e;
String childPath = PathUtils.concat(path, name);
exception = enhanceExceptionWithPath(e, childPath);
return false;
}
}

/**
* Enhances a CommitFailedException with path information if it doesn't already contain it.
* @param e the original exception
* @param path the path where the exception occurred
* @return the enhanced exception (or the original if it already contains path info)
*/
private static CommitFailedException enhanceExceptionWithPath(
CommitFailedException e, String path) {
String message = e.getMessage();
// Check if path is already in the message to avoid duplication
if (message != null && message.contains("(path: ")) {
return e;
}
// Create a new exception with the path information
String enhancedMessage = message + " (path: " + path + ")";
return new CommitFailedException(e.getSource(), e.getType(), e.getCode(),
enhancedMessage, e.getCause());
}

}
Loading