IGNITE-24150 Ability to have different prefixes for exceptions

modules/api/src/main/java/org/apache/ignite/lang/ErrorGroup.java

@@ -17,46 +17,49 @@
 
 package org.apache.ignite.lang;
 
-import static java.util.regex.Pattern.DOTALL;
 import static org.apache.ignite.lang.ErrorGroups.errorGroupByCode;
 
 import java.util.HashSet;
 import java.util.Set;
 import java.util.UUID;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
-import org.jetbrains.annotations.Nullable;
 
 /**
  * This class represents a concept of error group. Error group defines a collection of errors that belong to a single semantic component.
  * Each group can be identified by a name and an integer number that both must be unique across all error groups.
  */
 public class ErrorGroup {
-    /** Additional prefix that is used in a human-readable format of ignite errors. */
-    public static final String ERR_PREFIX = "IGN-";
-
-    /** Error message pattern. */
-    private static final Pattern EXCEPTION_MESSAGE_PATTERN =
-            Pattern.compile("(.*)(IGN)-([A-Z]+)-(\\d+)\\s(TraceId:)([a-f0-9]{8}(?:-[a-f0-9]{4}){4}[a-f0-9]{8})(\\s?)(.*)", DOTALL);
-
     /** Group name. */
     private final String groupName;
 
     /** Group code. */
     private final short groupCode;
 
+    /** Additional prefix that is used in a human-readable format of error messages. */
+    private final String errorPrefix;
+
     /** Contains error codes for this error group. */
     private final Set<Short> codes = new HashSet<>();
 
     /**
      * Creates a new error group with the specified name and corresponding code.
      *
+     * @param errorPrefix Error prefix.
      * @param groupName Group name.
      * @param groupCode Group code.
      */
-    ErrorGroup(String groupName, short groupCode) {
+    ErrorGroup(String errorPrefix, String groupName, short groupCode) {
         this.groupName = groupName;
         this.groupCode = groupCode;
+        this.errorPrefix = errorPrefix;
+    }
+
+    /**
+     * Returns a error prefix of this group.
+     *
+     * @return Error prefix.
+     */
+    public String errorPrefix() {
+        return errorPrefix;
     }
 
     /**
@@ -113,74 +116,28 @@ public static short extractErrorCode(int code) {
      * @return New error message with predefined prefix.
      */
     public static String errorMessage(UUID traceId, int code, String message) {
-        return errorMessage(traceId, errorGroupByCode(code).name(), code, message);
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        return errorMessage(errorGroup.errorPrefix(), traceId, errorGroup.name(), code, message);
     }
 
     /**
      * Creates a new error message with predefined prefix.
      *
+     * @param errorPrefix Prefix for the error.
      * @param traceId Unique identifier of this exception.
      * @param groupName Group name.
      * @param code Full error code.
      * @param message Original message.
      * @return New error message with predefined prefix.
      */
-    public static String errorMessage(UUID traceId, String groupName, int code, String message) {
-        return ERR_PREFIX + groupName + '-' + Short.toUnsignedInt(extractErrorCode(code)) + " TraceId:" + traceId
+    static String errorMessage(String errorPrefix, UUID traceId, String groupName, int code, String message) {
+        return errorPrefix + "-" + groupName + '-' + Short.toUnsignedInt(extractErrorCode(code)) + " TraceId:" + traceId
                 + ((message != null && !message.isEmpty()) ? ' ' + message : "");
     }
 
-    /**
-     * Creates a new error message with predefined prefix.
-     *
-     * @param traceId Unique identifier of this exception.
-     * @param code Full error code.
-     * @param cause Cause.
-     * @return New error message with predefined prefix.
-     */
-    public static String errorMessageFromCause(UUID traceId, int code, Throwable cause) {
-        return errorMessageFromCause(traceId, errorGroupByCode(code).name(), code, cause);
-    }
-
-    /**
-     * Creates a new error message with predefined prefix.
-     *
-     * @param traceId Unique identifier of this exception.
-     * @param groupName Group name.
-     * @param code Full error code.
-     * @param cause Cause.
-     * @return New error message with predefined prefix.
-     */
-    public static String errorMessageFromCause(UUID traceId, String groupName, int code, Throwable cause) {
-        String c = (cause != null && cause.getMessage() != null) ? cause.getMessage() : null;
-
-        if (c != null) {
-            c = extractCauseMessage(c);
-        }
-
-        return errorMessage(traceId, groupName, code, c);
-    }
-
-    /**
-     * Returns a message extracted from the given {@code errorMessage} if this {@code errorMessage} matches
-     * {@link #EXCEPTION_MESSAGE_PATTERN}. If {@code errorMessage} does not match the pattern or {@code null} then returns the original
-     * {@code errorMessage}.
-     *
-     * @param errorMessage Message that is returned by {@link Throwable#getMessage()}
-     * @return Extracted message.
-     */
-    public static @Nullable String extractCauseMessage(String errorMessage) {
-        if (errorMessage == null) {
-            return null;
-        }
-
-        Matcher m = EXCEPTION_MESSAGE_PATTERN.matcher(errorMessage);
-        return (m.matches()) ? m.group(8) : errorMessage;
-    }
-
     /** {@inheritDoc} */
     @Override
     public String toString() {
-        return "ErrorGroup [name=" + name() + ", groupCode=" + groupCode() + ']';
+        return "ErrorGroup [errorPrefix=" + errorPrefix + ", name=" + name() + ", groupCode=" + groupCode() + ']';
     }
 }

modules/api/src/main/java/org/apache/ignite/lang/ErrorGroups.java

@@ -17,16 +17,33 @@
 
 package org.apache.ignite.lang;
 
+import static java.util.regex.Pattern.DOTALL;
+
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Locale;
 import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 import org.apache.ignite.error.code.annotations.ErrorCodeGroup;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Defines error groups and its errors.
  */
 @SuppressWarnings("PublicInnerClass")
 public class ErrorGroups {
+    /** Additional prefix that is used in a human-readable format of ignite errors. */
+    public static final String IGNITE_ERR_PREFIX = "IGN";
+    private static final String PLACEHOLDER = "${ERROR_PREFIX}";
+    private static final String EXCEPTION_MESSAGE_STRING_PATTERN =
+            "(.*)(" + PLACEHOLDER + ")-([A-Z]+)-(\\d+)\\s(TraceId:)([a-f0-9]{8}(?:-[a-f0-9]{4}){4}[a-f0-9]{8})(\\s?)(.*)";
+
+    /** Error message pattern. */
+    private static Pattern EXCEPTION_MESSAGE_PATTERN;
+
+    private static final HashSet<String> REGISTERED_ERROR_PREFIXES = new HashSet<>();
+
     /** List of all registered error groups. */
     private static final Map<Short, ErrorGroup> registeredGroups = new HashMap<>();
 
@@ -44,7 +61,7 @@ public static synchronized void initialize() {
     }
 
     /**
-     * Creates a new error group with the given {@code groupName} and {@code groupCode}.
+     * Creates a new error group with the given {@code groupName} and {@code groupCode} and default error prefix.
      *
      * @param groupName Group name to be created.
      * @param groupCode Group code to be created.
@@ -53,6 +70,20 @@ public static synchronized void initialize() {
      *         the given {@code groupName} is {@code null} or empty.
      */
     public static synchronized ErrorGroup registerGroup(String groupName, short groupCode) {
+        return registerGroup(IGNITE_ERR_PREFIX, groupName, groupCode);
+    }
+
+    /**
+     * Creates a new error group with the given {@code groupName} and {@code groupCode}.
+     *
+     * @param errorPrefix Error prefix which should be used for the created error group.
+     * @param groupName Group name to be created.
+     * @param groupCode Group code to be created.
+     * @return New error group.
+     * @throws IllegalArgumentException If the specified name or group code already registered. Also, this exception is thrown if
+     *         the given {@code groupName} is {@code null} or empty.
+     */
+    public static synchronized ErrorGroup registerGroup(String errorPrefix, String groupName, short groupCode) {
         if (groupName == null || groupName.isEmpty()) {
             throw new IllegalArgumentException("Group name is null or empty");
         }
@@ -73,13 +104,36 @@ public static synchronized ErrorGroup registerGroup(String groupName, short grou
             }
         }
 
-        ErrorGroup newGroup = new ErrorGroup(grpName, groupCode);
+        if (REGISTERED_ERROR_PREFIXES.add(errorPrefix)) {
+            String errorPrefixes = String.join("|", REGISTERED_ERROR_PREFIXES);
+            String pattern = EXCEPTION_MESSAGE_STRING_PATTERN.replace(PLACEHOLDER, errorPrefixes);
+            EXCEPTION_MESSAGE_PATTERN = Pattern.compile(pattern, DOTALL);
+        }
+
+        ErrorGroup newGroup = new ErrorGroup(errorPrefix, grpName, groupCode);
 
         registeredGroups.put(groupCode, newGroup);
 
         return newGroup;
     }
 
+    /**
+     * Returns a message extracted from the given {@code errorMessage} if this {@code errorMessage} matches
+     * {@link #EXCEPTION_MESSAGE_PATTERN}. If {@code errorMessage} does not match the pattern or {@code null} then returns the original
+     * {@code errorMessage}.
+     *
+     * @param errorMessage Message that is returned by {@link Throwable#getMessage()}
+     * @return Extracted message.
+     */
+    public static @Nullable String extractCauseMessage(String errorMessage) {
+        if (errorMessage == null) {
+            return null;
+        }
+
+        Matcher m = EXCEPTION_MESSAGE_PATTERN.matcher(errorMessage);
+        return (m.matches()) ? m.group(8) : errorMessage;
+    }
+
     /**
      * Returns group code extracted from the given full error code.
      *

modules/api/src/main/java/org/apache/ignite/lang/IgniteCheckedException.java

@@ -17,7 +17,6 @@
 
 package org.apache.ignite.lang;
 
-import static org.apache.ignite.lang.ErrorGroup.ERR_PREFIX;
 import static org.apache.ignite.lang.ErrorGroup.errorMessage;
 import static org.apache.ignite.lang.ErrorGroup.extractErrorCode;
 import static org.apache.ignite.lang.ErrorGroups.errorGroupByCode;
@@ -34,6 +33,9 @@ public class IgniteCheckedException extends Exception implements TraceableExcept
     /** Serial version UID. */
     private static final long serialVersionUID = 0L;
 
+    /** Prefix for error message. */
+    private final String errorPrefix;
+
     /** Name of the error group. */
     private final String groupName;
 
@@ -68,7 +70,9 @@ public IgniteCheckedException(int code) {
      */
     public IgniteCheckedException(UUID traceId, int code) {
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -93,7 +97,9 @@ public IgniteCheckedException(UUID traceId, int code, String message) {
         super(message);
 
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -118,7 +124,9 @@ public IgniteCheckedException(UUID traceId, int code, @Nullable Throwable cause)
         super((cause != null) ? cause.getLocalizedMessage() : null, cause);
 
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -145,7 +153,9 @@ public IgniteCheckedException(UUID traceId, int code, String message, @Nullable
         super(message, cause);
 
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -179,7 +189,7 @@ public int code() {
      * @return Full error code in a human-readable format.
      */
     public String codeAsString() {
-        return ERR_PREFIX + groupName() + '-' + errorCode();
+        return errorPrefix + "-" + groupName() + '-' + errorCode();
     }
 
     /**
@@ -218,6 +228,6 @@ public UUID traceId() {
     /** {@inheritDoc} */
     @Override
     public String toString() {
-        return getClass().getName() + ": " + errorMessage(traceId, groupName, code, getLocalizedMessage());
+        return getClass().getName() + ": " + errorMessage(errorPrefix, traceId, groupName, code, getLocalizedMessage());
     }
 }

modules/api/src/main/java/org/apache/ignite/lang/IgniteException.java

@@ -17,7 +17,6 @@
 
 package org.apache.ignite.lang;
 
-import static org.apache.ignite.lang.ErrorGroup.ERR_PREFIX;
 import static org.apache.ignite.lang.ErrorGroup.errorMessage;
 import static org.apache.ignite.lang.ErrorGroup.extractErrorCode;
 import static org.apache.ignite.lang.ErrorGroups.errorGroupByCode;
@@ -34,6 +33,9 @@ public class IgniteException extends RuntimeException implements TraceableExcept
     /** Serial version UID. */
     private static final long serialVersionUID = 0L;
 
+    /** Prefix for error message. */
+    private final String errorPrefix;
+
     /** Name of the error group. */
     private final String groupName;
 
@@ -73,7 +75,9 @@ public IgniteException(int code) {
      */
     public IgniteException(UUID traceId, int code) {
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -130,7 +134,9 @@ public IgniteException(UUID traceId, int code, @Nullable Throwable cause) {
         super((cause != null) ? cause.getLocalizedMessage() : null, cause);
 
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -178,7 +184,9 @@ public IgniteException(
         super(message, cause, enableSuppression, writableStackTrace);
 
         this.traceId = traceId;
-        this.groupName = errorGroupByCode(code).name();
+        ErrorGroup errorGroup = errorGroupByCode(code);
+        this.groupName = errorGroup.name();
+        this.errorPrefix = errorGroup.errorPrefix();
         this.code = code;
     }
 
@@ -211,7 +219,7 @@ public int code() {
      * @return Full error code in a human-readable format.
      */
     public String codeAsString() {
-        return ERR_PREFIX + groupName() + '-' + errorCode();
+        return errorPrefix + "-" + groupName() + '-' + errorCode();
     }
 
     /**
@@ -250,6 +258,6 @@ public UUID traceId() {
     /** {@inheritDoc} */
     @Override
     public String toString() {
-        return getClass().getName() + ": " + errorMessage(traceId, groupName, code, getLocalizedMessage());
+        return getClass().getName() + ": " + errorMessage(errorPrefix, traceId, groupName, code, getLocalizedMessage());
     }
 }