Skip to content

Add. hint message for missing Annotation Param's value #2874

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.

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion core/src/main/java/feign/Contract.java
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,12 @@ public Default() {
name = annotationName;
}
checkState(
emptyToNull(name) != null, "Param annotation was empty on param %s.", paramIndex);
emptyToNull(name) != null,
"Param annotation was empty on param %s.\nHint: %s",
paramIndex,
"Prefer using @Param(value=\"name\"), or compile your code with the -parameters flag.\n"
+ "If the value is missing, Feign attempts to retrieve the parameter name from bytecode, "
+ "which only works if the class was compiled with the -parameters flag.");
nameParam(data, name, paramIndex);
final Class<? extends Param.Expander> expander = paramAnnotation.expander();
if (expander != Param.ToStringExpander.class) {
Expand Down
42 changes: 42 additions & 0 deletions core/src/test/java/feign/DefaultContractTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.net.URI;
import java.time.Clock;
import java.time.Instant;
Expand All @@ -37,6 +39,7 @@
import java.util.Map;
import java.util.SortedMap;
import org.assertj.core.api.Fail;
import org.junit.jupiter.api.Assumptions;
import org.junit.jupiter.api.Test;

/**
Expand Down Expand Up @@ -901,4 +904,43 @@ public Instant instant() {
return Instant.ofEpochMilli(millis);
}
}

interface NoValueParamsInterface {
@RequestLine("GET /getSomething?id={id}")
String getSomething(@Param String id);
}

@Test
void errorMessageOnMissingParamNames() {
Assumptions.assumeTrue(
!isCompiledWithParameters(NoValueParamsInterface.class), "Skip if -parameters is enabled");

Throwable exception =
assertThrows(
IllegalStateException.class,
() -> contract.parseAndValidateMetadata(NoValueParamsInterface.class));

assertThat(exception.getMessage())
.contains("Param annotation was empty on param 0")
.contains("Hint");
}

/**
* Checks whether the given class was compiled with the `-parameters` compiler flag. If parameter
* names are preserved (i.e., not default like arg0, arg1...), we assume it was.
*
* @param clazz the class to inspect
* @return true if `-parameters` was likely used, false otherwise
*/
private static boolean isCompiledWithParameters(Class<?> clazz) {
for (Method method : clazz.getDeclaredMethods()) {
for (Parameter parameter : method.getParameters()) {
String paramName = parameter.getName();
if (!paramName.matches("arg\\d+")) {
return true;
}
}
}
return false;
}
}