You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by jl...@apache.org on 2024/02/02 08:46:38 UTC

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

This is an automated email from the ASF dual-hosted git repository.

jleroux pushed a commit to branch release18.12
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git

commit c910e413bae57f815afb43ea1c35869d0a345fbf
Author: Jacques Le Roux <ja...@les7arts.com>
AuthorDate: Tue Jan 30 16:36:05 2024 +0100

    Improved: Don't need to show files names in UI messages (OFBIZ-12884)
    
    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
---
 .../org/apache/ofbiz/minilang/MiniLangRuntimeException.java  |  2 +-
 .../main/java/org/apache/ofbiz/minilang/SimpleMethod.java    | 12 +++---------
 .../java/org/apache/ofbiz/minilang/ValidationException.java  |  2 +-
 .../java/org/apache/ofbiz/minilang/method/envops/Break.java  |  2 +-
 .../org/apache/ofbiz/minilang/method/envops/Continue.java    |  2 +-
 5 files changed, 7 insertions(+), 13 deletions(-)

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
index b4b2e7568e..326be72549 100644
--- 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 class MiniLangRuntimeException extends MiniLangException {
         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
index c0cfd15202..a7b3673681 100644
--- 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 @@ import org.w3c.dom.Element;
  * (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 final class SimpleMethod extends MiniLangElement {
             }
             // 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 final class SimpleMethod extends MiniLangElement {
     }
 
     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
index ede60d4658..5772e1f388 100644
--- 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 class ValidationException extends MiniLangException {
     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
index 7262215e9c..8d3cad5a5e 100644
--- 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 class Break extends MethodOperation {
         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
index 32834b0bda..fe7eed1d8c 100644
--- 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 class Continue extends MethodOperation {
         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();
         }