Improved: Don't need to show files names in UI messages (OFBIZ-12884)

JacquesLeRoux · JacquesLeRoux · commit c910e413bae5 · 2024-02-02T09:44:22.000+01:00
We don't need to show files paths in UI messages. It does not help users, rather
confuse them. Also in log, we give enough information, ie the file and
method used.

Also removes all useless "this." in SimpleMethod class

Conflicts handled by hand in SimpleMethod.java
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/MiniLangRuntimeException.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/MiniLangRuntimeException.java
@@ -41,7 +41,7 @@ public String getMessage() {
         StringBuilder sb = new StringBuilder(super.getMessage());
         if (this.element != null) {
             SimpleMethod method = this.element.getSimpleMethod();
-            sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());
+            sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());
             sb.append(", Element = <").append(this.element.getTagName()).append(">");
             sb.append(", Line ").append(this.element.getLineNumber());
         }
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/SimpleMethod.java
@@ -75,7 +75,7 @@
  * (see <a href="http://docs.oracle.com/javase/6/docs/api/java/util/ServiceLoader.html" target="_blank">ServiceLoader</a>)
  * </li>
  * </ul>
- * 
+ *
  * @see <a href="https://cwiki.apache.org/confluence/display/OFBIZ/Mini+Language+-+minilang+-+simple-method+-+Reference">Mini-language Reference</a>
  */
 public final class SimpleMethod extends MiniLangElement {
@@ -584,8 +584,7 @@ public String exec(MethodContext methodContext) throws MiniLangException {
             }
             // rollback here passing beganTransaction to either rollback, or set rollback only
             try {
-                TransactionUtil.rollback(beganTransaction, "Error in simple-method [" + getShortDescription() + "]: "
-                        + summaryErrorStringBuffer, null);
+                TransactionUtil.rollback(beganTransaction, summaryErrorStringBuffer.toString(), null);
             } catch (GenericTransactionException e) {
                 String errMsg = "Error trying to rollback transaction, could not process method: " + e.getMessage();
                 if (methodContext.isTraceOn()) {
@@ -723,14 +722,9 @@ public String getServiceSuccessMessageName() {
     }
 
     public String getShortDescription() {
-        if (fromLocation.contains("file:") && fromLocation.contains("Events.xml")) {
-            return  getFileName() + "#" + getMethodName();
-        } else {
-            return shortDescription + " [" + fromLocation + "#" + methodName + "]";
-        }
+        return shortDescription + " [" + getFileName() + "#" + methodName + "]";
     }
 
-
     @Override
     public SimpleMethod getSimpleMethod() {
         return this;
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/ValidationException.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/ValidationException.java
@@ -39,7 +39,7 @@ public ValidationException(String str, SimpleMethod method, Element element) {
     public String getMessage() {
         StringBuilder sb = new StringBuilder(super.getMessage());
         if (method != null) {
-            sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());
+            sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());
         }
         if (element != null) {
             sb.append(", Element = <").append(element.getTagName()).append(">");
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/envops/Break.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/envops/Break.java
@@ -56,7 +56,7 @@ public BreakElementException() {
         public String getMessage() {
             StringBuilder sb = new StringBuilder(super.getMessage());
             SimpleMethod method = getSimpleMethod();
-            sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());
+            sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());
             sb.append(", Element = <break>, Line ").append(getLineNumber());
             return sb.toString();
         }
diff --git a/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/envops/Continue.java b/framework/minilang/src/main/java/org/apache/ofbiz/minilang/method/envops/Continue.java
@@ -56,7 +56,7 @@ public ContinueElementException() {
         public String getMessage() {
             StringBuilder sb = new StringBuilder(super.getMessage());
             SimpleMethod method = getSimpleMethod();
-            sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());
+            sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());
             sb.append(", Element = <continue>, Line ").append(getLineNumber());
             return sb.toString();
         }

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public String getMessage() {`
`41`	`41`	`StringBuilder sb = new StringBuilder(super.getMessage());`
`42`	`42`	`if (this.element != null) {`
`43`	`43`	`SimpleMethod method = this.element.getSimpleMethod();`
`44`		`- sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());`
	`44`	`+ sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());`
`45`	`45`	`sb.append(", Element = <").append(this.element.getTagName()).append(">");`
`46`	`46`	`sb.append(", Line ").append(this.element.getLineNumber());`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public ValidationException(String str, SimpleMethod method, Element element) {`
`39`	`39`	`public String getMessage() {`
`40`	`40`	`StringBuilder sb = new StringBuilder(super.getMessage());`
`41`	`41`	`if (method != null) {`
`42`		`- sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());`
	`42`	`+ sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());`
`43`	`43`	`}`
`44`	`44`	`if (element != null) {`
`45`	`45`	`sb.append(", Element = <").append(element.getTagName()).append(">");`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public BreakElementException() {`
`56`	`56`	`public String getMessage() {`
`57`	`57`	`StringBuilder sb = new StringBuilder(super.getMessage());`
`58`	`58`	`SimpleMethod method = getSimpleMethod();`
`59`		`- sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());`
	`59`	`+ sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());`
`60`	`60`	`sb.append(", Element = <break>, Line ").append(getLineNumber());`
`61`	`61`	`return sb.toString();`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ public ContinueElementException() {`
`56`	`56`	`public String getMessage() {`
`57`	`57`	`StringBuilder sb = new StringBuilder(super.getMessage());`
`58`	`58`	`SimpleMethod method = getSimpleMethod();`
`59`		`- sb.append(" Method = ").append(method.getMethodName()).append(", File = ").append(method.getFromLocation());`
	`59`	`+ sb.append(", File#Method = ").append(method.getFileName()).append("#").append(method.getMethodName());`
`60`	`60`	`sb.append(", Element = <continue>, Line ").append(getLineNumber());`
`61`	`61`	`return sb.toString();`
`62`	`62`	`}`