Explicit log safety annotations in ServiceException (#1497)

Explicit log safety annotations in ServiceException

Author: ash211

errors/src/main/java/com/palantir/conjure/java/api/errors/ServiceException.java

@@ -17,7 +17,9 @@
 package com.palantir.conjure.java.api.errors;
 
 import com.palantir.logsafe.Arg;
+import com.palantir.logsafe.Safe;
 import com.palantir.logsafe.SafeLoggable;
+import com.palantir.logsafe.Unsafe;
 import java.util.List;
 import javax.annotation.Nullable;
 
@@ -27,8 +29,13 @@ public final class ServiceException extends RuntimeException implements SafeLogg
     private final ErrorType errorType;
     private final List<Arg<?>> args; // unmodifiable
 
+    @Safe
     private final String errorInstanceId;
+
+    @Unsafe
     private final String unsafeMessage;
+
+    @Safe
     private final String noArgsMessage;
 
     /**
@@ -58,16 +65,19 @@ public ErrorType getErrorType() {
     }
 
     /** A unique identifier for (this instance of) this error. */
+    @Safe
     public String getErrorInstanceId() {
         return errorInstanceId;
     }
 
+    @Unsafe
     @Override
     public String getMessage() {
         // Including all args here since any logger not configured with safe-logging will log this message.
         return unsafeMessage;
     }
 
+    @Safe
     @Override
     public String getLogMessage() {
         // Not returning safe args here since the safe-logging framework will log this message + args explicitly.

errors/src/main/java/com/palantir/conjure/java/api/errors/ServiceExceptionUtils.java

@@ -17,6 +17,8 @@
 package com.palantir.conjure.java.api.errors;
 
 import com.palantir.logsafe.Arg;
+import com.palantir.logsafe.Safe;
+import com.palantir.logsafe.Unsafe;
 import com.palantir.tritium.ids.UniqueIds;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -61,6 +63,7 @@ static <T> List<T> arrayToUnmodifiableList(T[] elements) {
      * @param args the arguments to be included in the message
      * @return a message string that includes the exception name, error type, and arguments
      */
+    @Unsafe
     static String renderUnsafeMessage(String exceptionName, ErrorType errorType, Arg<?>... args) {
         String message = renderNoArgsMessage(exceptionName, errorType);
 
@@ -94,6 +97,7 @@ static String renderUnsafeMessage(String exceptionName, ErrorType errorType, Arg
      * @param errorType the error type the exception represents
      * @return a message string
      */
+    @Safe
     static String renderNoArgsMessage(String exceptionName, ErrorType errorType) {
         return exceptionName + ": " + errorType.code() + " (" + errorType.name() + ")";
     }
@@ -104,6 +108,7 @@ static String renderNoArgsMessage(String exceptionName, ErrorType errorType) {
      * suppressed causes}.
      */
     // VisibleForTesting
+    @Safe
     static String generateErrorInstanceId(@Nullable Throwable cause) {
         return generateErrorInstanceId(cause, Collections.newSetFromMap(new IdentityHashMap<>()));
     }