Skip to content

Remove errorType from ServiceException args #133

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

Merged
merged 2 commits into from
Dec 12, 2018
Merged

Remove errorType from ServiceException args #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80b6168
Remove errorType from ServiceException args
pkoenig10 Sep 28, 2018
8f09bf5
Keep and deprecate getParameters
pkoenig10 Dec 7, 2018
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
2 changes: 1 addition & 1 deletion errors/src/main/java/com/palantir/conjure/java/api/errors/SerializableError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ public static SerializableError forException(ServiceException exception) {
.errorName(exception.getErrorType().name())
.errorInstanceId(exception.getErrorInstanceId());

for (Arg<?> arg : exception.getParameters()) {
for (Arg<?> arg : exception.getArgs()) {
builder.putParameters(arg.getName(), Objects.toString(arg.getValue()));
}

Expand Down
26 changes: 12 additions & 14 deletions errors/src/main/java/com/palantir/conjure/java/api/errors/ServiceException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
package com.palantir.conjure.java.api.errors;

import com.palantir.logsafe.Arg;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.SafeLoggable;
import java.util.ArrayList;
import java.util.Collections;
Expand All @@ -27,7 +26,6 @@

/** A {@link ServiceException} thrown in server-side code to indicate server-side {@link ErrorType error states}. */
public final class ServiceException extends RuntimeException implements SafeLoggable {
public static final String ERROR_TYPE_ARG_NAME = "errorType";
Copy link
Contributor

@dansanduleac dansanduleac Dec 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also an API break, but I don't think anyone should have relied on this so should be fine (and luckily test-utils didn't rely on it either)


private final ErrorType errorType;
private final List<Arg<?>> args; // unmodifiable
Expand All @@ -51,7 +49,7 @@ public ServiceException(ErrorType errorType, @Nullable Throwable cause, Arg<?>..

this.errorType = errorType;
// Note that instantiators cannot mutate List<> args since it comes through copyToList in all code paths.
this.args = collectArgs(errorType, args);
this.args = copyToUnmodifiableList(args);
this.safeMessage = renderSafeMessage(errorType, args);
this.noArgsMessage = renderNoArgsMessage(errorType);
}
Expand Down Expand Up @@ -84,12 +82,19 @@ public List<Arg<?>> getArgs() {
}

/**
* Get Args of this service exception excluding injected/generated Args like errorType.
* @return parameters passed to this ServiceException at construction time
* Deprecated.
*
* @deprecated use {@link #getArgs}.
*/
@Deprecated
public List<Arg<?>> getParameters() {
// errorType is always the first argument, so just slice it out
return args.subList(1, args.size());
return getArgs();
}

private static <T> List<T> copyToUnmodifiableList(T[] elements) {
List<T> list = new ArrayList<>(elements.length);
Collections.addAll(list, elements);
return Collections.unmodifiableList(list);
}

private static String renderSafeMessage(ErrorType errorType, Arg<?>... args) {
Expand Down Expand Up @@ -119,11 +124,4 @@ private static String renderSafeMessage(ErrorType errorType, Arg<?>... args) {
private static String renderNoArgsMessage(ErrorType errorType) {
return String.format("ServiceException: %s (%s)", errorType.code(), errorType.name());
}

private static List<Arg<?>> collectArgs(ErrorType errorType, Arg<?>... args) {
List<Arg<?>> argList = new ArrayList<>(args.length + 1);
argList.add(SafeArg.of(ERROR_TYPE_ARG_NAME, errorType));
Collections.addAll(argList, args);
return Collections.unmodifiableList(argList);
}
}
31 changes: 2 additions & 29 deletions errors/src/test/java/com/palantir/conjure/java/api/errors/ServiceExceptionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,16 @@

import static org.assertj.core.api.Assertions.assertThat;

import com.google.common.collect.ImmutableList;
import com.palantir.logsafe.Arg;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import java.util.List;
import java.util.UUID;
import org.junit.Test;

public final class ServiceExceptionTest {

private static final ErrorType ERROR = ErrorType.create(ErrorType.Code.CUSTOM_CLIENT, "Namespace:MyDesc");
private static final String ERROR_NAME = "Namespace:MyDesc";
private static final ErrorType ERROR = ErrorType.create(ErrorType.Code.CUSTOM_CLIENT, ERROR_NAME);
private static final String EXPECTED_ERROR_MSG = "ServiceException: CUSTOM_CLIENT (Namespace:MyDesc)";

@Test
Expand All @@ -41,32 +40,6 @@ public void testExceptionMessageContainsNoArgs_safeLogMessageContainsSafeArgsOnl

assertThat(ex.getLogMessage()).isEqualTo(EXPECTED_ERROR_MSG);
assertThat(ex.getMessage()).isEqualTo(EXPECTED_ERROR_MSG + ": {arg1=foo}");

List<Arg<?>> expectedArgs = ImmutableList.<Arg<?>>builder()
.add(SafeArg.of(ServiceException.ERROR_TYPE_ARG_NAME, ERROR))
.add(args)
.build();

assertThat(ex.getArgs()).isEqualTo(expectedArgs);
}

@Test
public void testExceptionMessageWithNameCollisionWithInjectedArgs() {
Arg<?>[] args = {
SafeArg.of(ServiceException.ERROR_TYPE_ARG_NAME, "foo"),
UnsafeArg.of("arg2", 2),
UnsafeArg.of("arg3", null)};
ServiceException ex = new ServiceException(ERROR, args);

assertThat(ex.getLogMessage()).isEqualTo(EXPECTED_ERROR_MSG);
assertThat(ex.getMessage()).isEqualTo(EXPECTED_ERROR_MSG + ": {errorType=foo}");

List<Arg<?>> expectedArgs = ImmutableList.<Arg<?>>builder()
.add(SafeArg.of(ServiceException.ERROR_TYPE_ARG_NAME, ERROR))
.add(args)
.build();

assertThat(ex.getArgs()).isEqualTo(expectedArgs);
}

@Test
Expand Down
1 change: 0 additions & 1 deletion test-utils/src/main/java/com/palantir/conjure/java/api/testing/ServiceExceptionAssert.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ public final ServiceExceptionAssert hasType(ErrorType type) {
public final ServiceExceptionAssert hasArgs(Arg<?>... args) {
isNotNull();

// fetch getParameters here to exclude any generated/injected args like 'errorType'
AssertableArgs actualArgs = new AssertableArgs(actual.getParameters());
AssertableArgs expectedArgs = new AssertableArgs(Arrays.asList(args));

Expand Down