[fix] Apply correct header/streaming annotations to retrofit clients

conjure-java-core/src/main/java/com/palantir/conjure/java/services/Retrofit2ServiceGenerator.java

@@ -47,6 +47,7 @@
 import com.squareup.javapoet.MethodSpec;
 import com.squareup.javapoet.ParameterSpec;
 import com.squareup.javapoet.ParameterizedTypeName;
+import com.squareup.javapoet.TypeName;
 import com.squareup.javapoet.TypeSpec;
 import java.util.List;
 import java.util.Optional;
@@ -68,8 +69,7 @@ public final class Retrofit2ServiceGenerator implements ServiceGenerator {
     private static final ClassName CALL_TYPE = ClassName.get("retrofit2", "Call");
     private static final String AUTH_HEADER_NAME = "Authorization";
 
-    private static final String JSON_MEDIA_TYPE = MediaType.APPLICATION_JSON;
-    private static final String OCTET_STREAM_MEDIA_TYPE = MediaType.APPLICATION_OCTET_STREAM;
+    private static final ClassName BINARY_RETURN_TYPE = ClassName.get("okhttp3", "ResponseBody");
 
     private static final Logger log = LoggerFactory.getLogger(Retrofit2ServiceGenerator.class);
 
@@ -131,25 +131,23 @@ private MethodSpec generateServiceMethod(
             EndpointDefinition endpointDef,
             TypeMapper returnTypeMapper,
             TypeMapper methodTypeMapper) {
+        TypeName returnType = endpointDef.getReturns()
+                .map(returnTypeMapper::getClassName)
+                .orElse(ClassName.VOID);
+
         Set<ArgumentName> encodedPathArgs = extractEncodedPathArgs(endpointDef.getHttpPath());
         HttpPath endpointPathWithoutRegex = replaceEncodedPathArgs(endpointDef.getHttpPath());
         MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder(endpointDef.getEndpointName().get())
                 .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
                 .addAnnotation(AnnotationSpec.builder(httpMethodToClassName(endpointDef.getHttpMethod().get().name()))
                         .addMember("value", "$S", "." + endpointPathWithoutRegex)
+                        .build())
+                .addAnnotation(AnnotationSpec.builder(ClassName.get("retrofit2.http", "Headers"))
+                        .addMember("value", "$S", "hr-path-template: " + endpointPathWithoutRegex)
+                        .addMember("value", "$S", "Accept: " + getReturnMediaType(returnType))
                         .build());
 
-        AnnotationSpec.Builder headersBuilder = AnnotationSpec.builder(ClassName.get("retrofit2.http", "Headers"))
-                .addMember("value", "$S", "hr-path-template: " + endpointPathWithoutRegex);
-        endpointDef.getReturns().ifPresent(type -> {
-            String mediaType = type.accept(TypeVisitor.IS_BINARY)
-                    ? MediaType.APPLICATION_OCTET_STREAM
-                    : MediaType.APPLICATION_JSON;
-            headersBuilder.addMember("value", "$S", "Accept: " + mediaType);
-        });
-        methodBuilder.addAnnotation(headersBuilder.build());
-
-        if (endpointDef.getReturns().map(type -> type.accept(TypeVisitor.IS_BINARY)).orElse(false)) {
+        if (returnType.equals(BINARY_RETURN_TYPE)) {
             methodBuilder.addAnnotation(AnnotationSpec.builder(ClassName.get("retrofit2.http", "Streaming")).build());
         }
 
@@ -159,13 +157,7 @@ private MethodSpec generateServiceMethod(
         ServiceGenerator.getJavaDoc(endpointDef).ifPresent(
                 content -> methodBuilder.addJavadoc("$L", content));
 
-        if (endpointDef.getReturns().isPresent()) {
-            methodBuilder.returns(
-                    ParameterizedTypeName.get(getReturnType(),
-                            returnTypeMapper.getClassName(endpointDef.getReturns().get()).box()));
-        } else {
-            methodBuilder.returns(ParameterizedTypeName.get(getReturnType(), ClassName.get(Void.class)));
-        }
+        methodBuilder.returns(ParameterizedTypeName.get(getReturnType(), returnType.box()));
 
         getAuthParameter(endpointDef.getAuth()).ifPresent(methodBuilder::addParameter);
 
@@ -260,6 +252,12 @@ private Optional<ParameterSpec> getAuthParameter(Optional<AuthType> auth) {
         throw new IllegalStateException("Unrecognized auth type: " + auth.get());
     }
 
+    private static String getReturnMediaType(TypeName returnType) {
+        return returnType.equals(BINARY_RETURN_TYPE)
+                ? MediaType.APPLICATION_OCTET_STREAM
+                : MediaType.APPLICATION_JSON;
+    }
+
     private static Set<AnnotationSpec> createMarkers(TypeMapper typeMapper, List<Type> markers) {
         checkArgument(markers.stream().allMatch(type -> type.accept(TypeVisitor.IS_REFERENCE)),
                 "Markers must refer to reference types.");

conjure-java-core/src/test/resources/example-service.yml

@@ -122,6 +122,13 @@ services:
             type: binary
             param-type: body
 
+      uploadAliasedRawData:
+        http: POST /datasets/upload-raw-aliased
+        args:
+          input:
+            type: NestedAliasedBinary
+            param-type: body
+
       getBranches:
         http: GET /datasets/{datasetRid}/branches
         args:

conjure-java-core/src/test/resources/test/api/TestService.java.jersey

@@ -2,6 +2,7 @@ package com.palantir.another;
 
 import com.palantir.product.AliasedString;
 import com.palantir.product.CreateDatasetRequest;
+import com.palantir.product.NestedAliasedBinary;
 import com.palantir.product.datasets.BackingFileSystem;
 import com.palantir.product.datasets.Dataset;
 import com.palantir.redaction.Safe;
@@ -87,6 +88,12 @@ public interface TestService {
             @HeaderParam("Authorization") @NotNull AuthHeader authHeader,
             @NotNull InputStream input);
 
+    @POST
+    @Path("catalog/datasets/upload-raw-aliased")
+    void uploadAliasedRawData(
+            @HeaderParam("Authorization") @NotNull AuthHeader authHeader,
+            @NotNull NestedAliasedBinary input);
+
     @GET
     @Path("catalog/datasets/{datasetRid}/branches")
     Set<String> getBranches(

conjure-java-core/src/test/resources/test/api/TestService.java.jersey_require_not_null

@@ -2,6 +2,7 @@ package com.palantir.another;
 
 import com.palantir.product.AliasedString;
 import com.palantir.product.CreateDatasetRequest;
+import com.palantir.product.NestedAliasedBinary;
 import com.palantir.product.datasets.BackingFileSystem;
 import com.palantir.product.datasets.Dataset;
 import com.palantir.redaction.Safe;
@@ -87,6 +88,12 @@ public interface TestService {
             @HeaderParam("Authorization") @NotNull AuthHeader authHeader,
             @NotNull InputStream input);
 
+    @POST
+    @Path("catalog/datasets/upload-raw-aliased")
+    void uploadAliasedRawData(
+            @HeaderParam("Authorization") @NotNull AuthHeader authHeader,
+            @NotNull NestedAliasedBinary input);
+
     @GET
     @Path("catalog/datasets/{datasetRid}/branches")
     Set<String> getBranches(

conjure-java-core/src/test/resources/test/api/TestServiceRetrofit.java.retrofit

@@ -2,6 +2,7 @@ package com.palantir.another;
 
 import com.palantir.product.AliasedString;
 import com.palantir.product.CreateDatasetRequest;
+import com.palantir.product.NestedAliasedBinary;
 import com.palantir.product.datasets.BackingFileSystem;
 import com.palantir.product.datasets.Dataset;
 import com.palantir.ri.ResourceIdentifier;
@@ -66,8 +67,9 @@ public interface TestServiceRetrofit {
     @GET("./catalog/datasets/{datasetRid}/raw-aliased")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/raw-aliased",
-        "Accept: application/json"
+        "Accept: application/octet-stream"
     })
+    @Streaming
     Call<ResponseBody> getAliasedRawData(
             @Header("Authorization") AuthHeader authHeader,
             @Path("datasetRid") ResourceIdentifier datasetRid);
@@ -91,10 +93,15 @@ public interface TestServiceRetrofit {
             @Path("datasetRid") ResourceIdentifier datasetRid);
 
     @POST("./catalog/datasets/upload-raw")
-    @Headers("hr-path-template: /catalog/datasets/upload-raw")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw", "Accept: application/json"})
     Call<Void> uploadRawData(
             @Header("Authorization") AuthHeader authHeader, @Body RequestBody input);
 
+    @POST("./catalog/datasets/upload-raw-aliased")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw-aliased", "Accept: application/json"})
+    Call<Void> uploadAliasedRawData(
+            @Header("Authorization") AuthHeader authHeader, @Body NestedAliasedBinary input);
+
     @GET("./catalog/datasets/{datasetRid}/branches")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/branches",
@@ -150,7 +157,10 @@ public interface TestServiceRetrofit {
             @Query("optionalEnd") Optional<ResourceIdentifier> optionalEnd);
 
     @POST("./catalog/test-no-response-query-params")
-    @Headers("hr-path-template: /catalog/test-no-response-query-params")
+    @Headers({
+        "hr-path-template: /catalog/test-no-response-query-params",
+        "Accept: application/json"
+    })
     Call<Void> testNoResponseQueryParams(
             @Header("Authorization") AuthHeader authHeader,
             @Body String query,
@@ -178,7 +188,7 @@ public interface TestServiceRetrofit {
             @Header("Authorization") AuthHeader authHeader, @Body Optional<String> maybeString);
 
     @GET("./catalog/optional-integer-double")
-    @Headers("hr-path-template: /catalog/optional-integer-double")
+    @Headers({"hr-path-template: /catalog/optional-integer-double", "Accept: application/json"})
     Call<Void> testOptionalIntegerAndDouble(
             @Header("Authorization") AuthHeader authHeader,
             @Query("maybeInteger") OptionalInt maybeInteger,

conjure-java-core/src/test/resources/test/api/TestServiceRetrofit.java.retrofit_completable_future

@@ -2,6 +2,7 @@ package com.palantir.another;
 
 import com.palantir.product.AliasedString;
 import com.palantir.product.CreateDatasetRequest;
+import com.palantir.product.NestedAliasedBinary;
 import com.palantir.product.datasets.BackingFileSystem;
 import com.palantir.product.datasets.Dataset;
 import com.palantir.ri.ResourceIdentifier;
@@ -66,8 +67,9 @@ public interface TestServiceRetrofit {
     @GET("./catalog/datasets/{datasetRid}/raw-aliased")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/raw-aliased",
-        "Accept: application/json"
+        "Accept: application/octet-stream"
     })
+    @Streaming
     CompletableFuture<ResponseBody> getAliasedRawData(
             @Header("Authorization") AuthHeader authHeader,
             @Path("datasetRid") ResourceIdentifier datasetRid);
@@ -91,10 +93,15 @@ public interface TestServiceRetrofit {
             @Path("datasetRid") ResourceIdentifier datasetRid);
 
     @POST("./catalog/datasets/upload-raw")
-    @Headers("hr-path-template: /catalog/datasets/upload-raw")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw", "Accept: application/json"})
     CompletableFuture<Void> uploadRawData(
             @Header("Authorization") AuthHeader authHeader, @Body RequestBody input);
 
+    @POST("./catalog/datasets/upload-raw-aliased")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw-aliased", "Accept: application/json"})
+    CompletableFuture<Void> uploadAliasedRawData(
+            @Header("Authorization") AuthHeader authHeader, @Body NestedAliasedBinary input);
+
     @GET("./catalog/datasets/{datasetRid}/branches")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/branches",
@@ -150,7 +157,10 @@ public interface TestServiceRetrofit {
             @Query("optionalEnd") Optional<ResourceIdentifier> optionalEnd);
 
     @POST("./catalog/test-no-response-query-params")
-    @Headers("hr-path-template: /catalog/test-no-response-query-params")
+    @Headers({
+        "hr-path-template: /catalog/test-no-response-query-params",
+        "Accept: application/json"
+    })
     CompletableFuture<Void> testNoResponseQueryParams(
             @Header("Authorization") AuthHeader authHeader,
             @Body String query,
@@ -178,7 +188,7 @@ public interface TestServiceRetrofit {
             @Header("Authorization") AuthHeader authHeader, @Body Optional<String> maybeString);
 
     @GET("./catalog/optional-integer-double")
-    @Headers("hr-path-template: /catalog/optional-integer-double")
+    @Headers({"hr-path-template: /catalog/optional-integer-double", "Accept: application/json"})
     CompletableFuture<Void> testOptionalIntegerAndDouble(
             @Header("Authorization") AuthHeader authHeader,
             @Query("maybeInteger") OptionalInt maybeInteger,

conjure-java-core/src/test/resources/test/api/TestServiceRetrofit.java.retrofit_listenable_future

@@ -3,6 +3,7 @@ package com.palantir.another;
 import com.google.common.util.concurrent.ListenableFuture;
 import com.palantir.product.AliasedString;
 import com.palantir.product.CreateDatasetRequest;
+import com.palantir.product.NestedAliasedBinary;
 import com.palantir.product.datasets.BackingFileSystem;
 import com.palantir.product.datasets.Dataset;
 import com.palantir.ri.ResourceIdentifier;
@@ -66,8 +67,9 @@ public interface TestServiceRetrofit {
     @GET("./catalog/datasets/{datasetRid}/raw-aliased")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/raw-aliased",
-        "Accept: application/json"
+        "Accept: application/octet-stream"
     })
+    @Streaming
     ListenableFuture<ResponseBody> getAliasedRawData(
             @Header("Authorization") AuthHeader authHeader,
             @Path("datasetRid") ResourceIdentifier datasetRid);
@@ -91,10 +93,15 @@ public interface TestServiceRetrofit {
             @Path("datasetRid") ResourceIdentifier datasetRid);
 
     @POST("./catalog/datasets/upload-raw")
-    @Headers("hr-path-template: /catalog/datasets/upload-raw")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw", "Accept: application/json"})
     ListenableFuture<Void> uploadRawData(
             @Header("Authorization") AuthHeader authHeader, @Body RequestBody input);
 
+    @POST("./catalog/datasets/upload-raw-aliased")
+    @Headers({"hr-path-template: /catalog/datasets/upload-raw-aliased", "Accept: application/json"})
+    ListenableFuture<Void> uploadAliasedRawData(
+            @Header("Authorization") AuthHeader authHeader, @Body NestedAliasedBinary input);
+
     @GET("./catalog/datasets/{datasetRid}/branches")
     @Headers({
         "hr-path-template: /catalog/datasets/{datasetRid}/branches",
@@ -150,7 +157,10 @@ public interface TestServiceRetrofit {
             @Query("optionalEnd") Optional<ResourceIdentifier> optionalEnd);
 
     @POST("./catalog/test-no-response-query-params")
-    @Headers("hr-path-template: /catalog/test-no-response-query-params")
+    @Headers({
+        "hr-path-template: /catalog/test-no-response-query-params",
+        "Accept: application/json"
+    })
     ListenableFuture<Void> testNoResponseQueryParams(
             @Header("Authorization") AuthHeader authHeader,
             @Body String query,
@@ -178,7 +188,7 @@ public interface TestServiceRetrofit {
             @Header("Authorization") AuthHeader authHeader, @Body Optional<String> maybeString);
 
     @GET("./catalog/optional-integer-double")
-    @Headers("hr-path-template: /catalog/optional-integer-double")
+    @Headers({"hr-path-template: /catalog/optional-integer-double", "Accept: application/json"})
     ListenableFuture<Void> testOptionalIntegerAndDouble(
             @Header("Authorization") AuthHeader authHeader,
             @Query("maybeInteger") OptionalInt maybeInteger,