Change contract of Config for JsonToGrpc filter

Author: dsyer

docs/modules/ROOT/pages/spring-cloud-gateway-server-webflux/gatewayfilter-factories/jsontogrpc-factory.adoc

@@ -5,6 +5,10 @@ The JSONToGRPC GatewayFilter Factory converts a JSON payload to a gRPC request.
 
 The filter takes the following arguments:
 
+* `service`: Short name of the service that handles the request.
+
+* `method`: Method name in the service that handles the request.
+
 * `protoDescriptor`: Proto descriptor file.
 
 This file can be generated using `protoc` and specifying the `--descriptor_set_out` flag:
@@ -16,12 +20,6 @@ protoc --proto_path=src/main/resources/proto/ \
 src/main/resources/proto/hello.proto
 ----
 
-* `protoFile`: Proto definition file.
-
-* `service`: Short name of the service that handles the request.
-
-* `method`: Method name in the service that handles the request.
-
 NOTE: `streaming` is not supported.
 
 
@@ -33,11 +31,10 @@ NOTE: `streaming` is not supported.
 public RouteLocator routes(RouteLocatorBuilder builder) {
     return builder.routes()
             .route("json-grpc", r -> r.path("/json/hello").filters(f -> {
-                String protoDescriptor = "file:src/main/proto/hello.pb";
-                String protoFile = "file:src/main/proto/hello.proto";
                 String service = "HelloService";
                 String method = "hello";
-                return f.jsonToGRPC(protoDescriptor, protoFile, service, method);
+                String protoDescriptor = "file:src/main/proto/hello.pb";
+                return f.jsonToGRPC(service, method, protoDescriptor);
             }).uri(uri))
 ----
 
@@ -48,17 +45,15 @@ spring:
     gateway:
       routes:
         - id: json-grpc
-          uri: https://localhost:6565/testhello
+          uri: https://localhost:6565
           predicates:
             - Path=/json/**
           filters:
             - name: JsonToGrpc
               args:
-                protoDescriptor: file:proto/hello.pb
-                protoFile: file:proto/hello.proto
                 service: HelloService
                 method: hello
-
+                protoDescriptor: file:proto/hello.pb
 ----
 
 When a request is made through the gateway to `/json/hello`, the request is transformed by using the definition provided in `hello.proto`, sent to `HelloService/hello`, and the response back is transformed to JSON.

spring-cloud-gateway-integration-tests/grpc/src/test/java/org/springframework/cloud/gateway/tests/grpc/JsonToGrpcApplicationTests.java

@@ -68,7 +68,7 @@ public void shouldConvertFromJSONToGRPC() {
 		final RouteConfigurer configurer = new RouteConfigurer(gatewayPort);
 		int grpcServerPort = gatewayPort + 1;
 		configurer.addRoute(grpcServerPort, "/json/hello",
-				"JsonToGrpc=file:src/main/proto/hello.pb,none:,HelloService,hello");
+				"JsonToGrpc=HelloService,hello,file:src/main/proto/hello.pb");
 
 		String response = restTemplate
 			.postForEntity("https://localhost:" + this.gatewayPort + "/json/hello",

spring-cloud-gateway-integration-tests/grpc/src/test/resources/application.yml

@@ -10,7 +10,7 @@ server:
 management:
   endpoint:
     health:
-      show-details: when_authorized
+      show-details: when-authorized
     gateway:
       enabled: true
   endpoints:

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/filter/factory/JsonToGrpcGatewayFilterFactory.java

@@ -16,8 +16,9 @@
 
 package org.springframework.cloud.gateway.filter.factory;
 
+import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
+
 import java.io.IOException;
-import java.io.InputStream;
 import java.net.URI;
 import java.util.Arrays;
 import java.util.List;
@@ -27,6 +28,23 @@
 
 import javax.net.ssl.SSLException;
 
+import org.reactivestreams.Publisher;
+import org.springframework.cloud.gateway.config.GrpcSslConfigurer;
+import org.springframework.cloud.gateway.filter.GatewayFilter;
+import org.springframework.cloud.gateway.filter.GatewayFilterChain;
+import org.springframework.cloud.gateway.filter.NettyWriteResponseFilter;
+import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
+import org.springframework.cloud.gateway.route.Route;
+import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
+import org.springframework.core.ResolvableType;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.core.io.buffer.DataBuffer;
+import org.springframework.core.io.buffer.NettyDataBufferFactory;
+import org.springframework.http.codec.json.Jackson2JsonDecoder;
+import org.springframework.http.server.reactive.ServerHttpResponseDecorator;
+import org.springframework.web.server.ServerWebExchange;
+
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -42,6 +60,7 @@
 import com.google.protobuf.DynamicMessage;
 import com.google.protobuf.ProtocolStringList;
 import com.google.protobuf.util.JsonFormat;
+
 import io.grpc.CallOptions;
 import io.grpc.Channel;
 import io.grpc.ClientCall;
@@ -51,28 +70,9 @@
 import io.grpc.protobuf.ProtoUtils;
 import io.grpc.stub.ClientCalls;
 import io.netty.buffer.PooledByteBufAllocator;
-import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
-import org.springframework.cloud.gateway.config.GrpcSslConfigurer;
-import org.springframework.cloud.gateway.filter.GatewayFilter;
-import org.springframework.cloud.gateway.filter.GatewayFilterChain;
-import org.springframework.cloud.gateway.filter.NettyWriteResponseFilter;
-import org.springframework.cloud.gateway.filter.OrderedGatewayFilter;
-import org.springframework.cloud.gateway.route.Route;
-import org.springframework.cloud.gateway.support.ServerWebExchangeUtils;
-import org.springframework.core.ResolvableType;
-import org.springframework.core.io.Resource;
-import org.springframework.core.io.ResourceLoader;
-import org.springframework.core.io.buffer.DataBuffer;
-import org.springframework.core.io.buffer.NettyDataBufferFactory;
-import org.springframework.http.codec.json.Jackson2JsonDecoder;
-import org.springframework.http.server.reactive.ServerHttpResponseDecorator;
-import org.springframework.web.server.ServerWebExchange;
-
-import static org.springframework.cloud.gateway.support.GatewayToStringStyler.filterToStringCreator;
-
 /**
  * This filter takes a JSON payload, transform it into a protobuf object, send
  * it to a
@@ -99,7 +99,7 @@ public JsonToGrpcGatewayFilterFactory(GrpcSslConfigurer grpcSslConfigurer, Resou
 
 	@Override
 	public List<String> shortcutFieldOrder() {
-		return Arrays.asList("protoDescriptor", "protoFile", "service", "method");
+		return Arrays.asList("service", "method", "protoDescriptor");
 	}
 
 	@Override
@@ -128,8 +128,6 @@ public static class Config {
 
 		private String protoDescriptor;
 
-		private String protoFile;
-
 		private String service;
 
 		private String method;
@@ -143,15 +141,6 @@ public Config setProtoDescriptor(String protoDescriptor) {
 			return this;
 		}
 
-		public String getProtoFile() {
-			return protoFile;
-		}
-
-		public Config setProtoFile(String protoFile) {
-			this.protoFile = protoFile;
-			return this;
-		}
-
 		public String getService() {
 			return service;
 		}

spring-cloud-gateway-server/src/main/java/org/springframework/cloud/gateway/route/builder/GatewayFilterSpec.java

@@ -284,15 +284,13 @@ public GatewayFilterSpec circuitBreaker(Consumer<SpringCloudCircuitBreakerFilter
 
 	/**
 	 * A filter that transforms a JSON request into a gRPC one.
-	 * @param protoDescriptor relative path to the proto descriptor file.
-	 * @param protoFile relative path to the proto definition file.
 	 * @param service fully qualified name of the service that will handle the request.
 	 * @param method method name in the service that will handle the request.
+	 * @param protoDescriptor relative path to the proto descriptor file.
 	 */
-	public GatewayFilterSpec jsonToGRPC(String protoDescriptor, String protoFile, String service, String method) {
+	public GatewayFilterSpec jsonToGRPC(String service, String method, String protoDescriptor) {
 		return filter(getBean(JsonToGrpcGatewayFilterFactory.class).apply(c -> c.setMethod(method)
 			.setProtoDescriptor(protoDescriptor)
-			.setProtoFile(protoFile)
 			.setService(service)));
 	}