make PartitionKey "backward-compatible"

pongad · pongad · commit 9d1f090dafd0 · 2017-03-30T17:29:42.000+11:00
This change is still a breaking change,
but it is just compatible enough that GAPIC-generated clients
will compile and work properly.

Toolkit will be updated to take advantage of the new PartitionKey
endpoint.
Once all clients are migrated, we can get rid of the old String endpoint.
diff --git a/src/main/java/com/google/api/gax/batching/PartitionKey.java b/src/main/java/com/google/api/gax/batching/PartitionKey.java
@@ -31,7 +31,14 @@
 package com.google.api.gax.batching;
 
 import com.google.common.collect.ImmutableList;
+import java.util.Map;
 
+/**
+ * Requests with the same {@code PartitionKey} can be batched together in one RPC call.
+ *
+ * Instances of this class may be used as keys in {@link Map}s. Consequently, arguments to the
+ * constructor of this class should not be modified.
+ */
 public final class PartitionKey {
   private final ImmutableList<Object> keys;
   private final int hash;
diff --git a/src/main/java/com/google/api/gax/grpc/BatchExecutor.java b/src/main/java/com/google/api/gax/grpc/BatchExecutor.java
@@ -63,7 +63,7 @@ public BatchExecutor(
 
   @Override
   public void validateBatch(Batch<RequestT, ResponseT> item) {
-    PartitionKey itemPartitionKey = batchingDescriptor.getBatchPartitionKey(item.getRequest());
+    PartitionKey itemPartitionKey = batchingDescriptor.getPartitionKey(item.getRequest());
     if (!itemPartitionKey.equals(partitionKey)) {
       String requestClassName = item.getRequest().getClass().getSimpleName();
       throw new IllegalArgumentException(
diff --git a/src/main/java/com/google/api/gax/grpc/BatchingCallable.java b/src/main/java/com/google/api/gax/grpc/BatchingCallable.java
@@ -66,7 +66,7 @@ public ApiFuture<ResponseT> futureCall(RequestT request, CallContext context) {
           UnaryCallable.<RequestT, ResponseT>create(callable).bind(context.getChannel());
       Batch<RequestT, ResponseT> batchableMessage =
           new Batch<RequestT, ResponseT>(batchingDescriptor, request, unaryCallable, result);
-      PartitionKey partitionKey = batchingDescriptor.getBatchPartitionKey(request);
+      PartitionKey partitionKey = batchingDescriptor.getPartitionKey(request);
       ThresholdBatcher<Batch<RequestT, ResponseT>> batcher =
           batcherFactory.getPushingBatcher(partitionKey);
       try {
diff --git a/src/main/java/com/google/api/gax/grpc/BatchingDescriptor.java b/src/main/java/com/google/api/gax/grpc/BatchingDescriptor.java
@@ -43,37 +43,44 @@
  * <p>
  * This is public only for technical reasons, for advanced usage.
  */
-public interface BatchingDescriptor<RequestT, ResponseT> {
+public abstract class BatchingDescriptor<RequestT, ResponseT> {
 
   /**
    * Returns the value of the partition key for the given request.
    */
-  PartitionKey getBatchPartitionKey(RequestT request);
+  protected String getBatchPartitionKey(RequestT request) {
+    throw new UnsupportedOperationException(
+        "Implementors of BatchingDescriptor must override either getBatchPartitionKey or getPartitionKey");
+  }
+
+  public PartitionKey getPartitionKey(RequestT request) {
+    return new PartitionKey(getBatchPartitionKey(request));
+  }
 
   /** Get the Builder object for the request type RequestT. */
-  RequestBuilder<RequestT> getRequestBuilder();
+  public abstract RequestBuilder<RequestT> getRequestBuilder();
 
   /**
    * Splits the result from a batched call into an individual setResponse call on each
    * RequestIssuer.
    */
-  void splitResponse(
+  public abstract void splitResponse(
       ResponseT batchResponse, Collection<? extends BatchedRequestIssuer<ResponseT>> batch);
 
   /**
    * Splits the exception that resulted from a batched call into an individual setException call on
    * each RequestIssuer.
    */
-  void splitException(
+  public abstract void splitException(
       Throwable throwable, Collection<? extends BatchedRequestIssuer<ResponseT>> batch);
 
   /**
    * Returns the number of elements contained in this request.
    */
-  long countElements(RequestT request);
+  public abstract long countElements(RequestT request);
 
   /**
    * Returns the size in bytes of this request.
    */
-  long countBytes(RequestT request);
+  public abstract long countBytes(RequestT request);
 }
diff --git a/src/test/java/com/google/api/gax/grpc/BatchExecutorTest.java b/src/test/java/com/google/api/gax/grpc/BatchExecutorTest.java
@@ -42,7 +42,7 @@ public class BatchExecutorTest {
       new BatchingDescriptor<List<Integer>, Integer>() {
 
         @Override
-        public PartitionKey getBatchPartitionKey(List<Integer> request) {
+        public PartitionKey getPartitionKey(List<Integer> request) {
           return new PartitionKey(request.get(0) % 2);
         }
 
diff --git a/src/test/java/com/google/api/gax/grpc/UnaryCallableTest.java b/src/test/java/com/google/api/gax/grpc/UnaryCallableTest.java
@@ -188,7 +188,7 @@ public void pagedBind() {
       new BatchingDescriptor<List<Integer>, List<Integer>>() {
 
         @Override
-        public PartitionKey getBatchPartitionKey(List<Integer> request) {
+        public PartitionKey getPartitionKey(List<Integer> request) {
           return new PartitionKey();
         }
 
@@ -586,7 +586,7 @@ public ApiFuture<List<Integer>> futureCall(LabeledIntList request, CallContext c
       new BatchingDescriptor<LabeledIntList, List<Integer>>() {
 
         @Override
-        public PartitionKey getBatchPartitionKey(LabeledIntList request) {
+        public PartitionKey getPartitionKey(LabeledIntList request) {
           return new PartitionKey(request.label);
         }
 
@@ -709,7 +709,7 @@ public void batchingWithFlowControl() throws Exception {
     Truth.assertThat(f2.get()).isEqualTo(Arrays.asList(9, 16));
 
     batcherFactory
-        .getPushingBatcher(SQUARER_BATCHING_DESC.getBatchPartitionKey(requestA))
+        .getPushingBatcher(SQUARER_BATCHING_DESC.getPartitionKey(requestA))
         .pushCurrentBatch()
         .get();
 
@@ -727,8 +727,8 @@ public void batchingWithFlowControl() throws Exception {
       new BatchingDescriptor<LabeledIntList, List<Integer>>() {
 
         @Override
-        public PartitionKey getBatchPartitionKey(LabeledIntList request) {
-          Assert.fail("getBatchPartitionKey should not be invoked while batching is disabled.");
+        public PartitionKey getPartitionKey(LabeledIntList request) {
+          Assert.fail("getPartitionKey should not be invoked while batching is disabled.");
           return null;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public class BatchExecutorTest {`
`42`	`42`	`new BatchingDescriptor<List<Integer>, Integer>() {`
`43`	`43`
`44`	`44`	`@Override`
`45`		`- public PartitionKey getBatchPartitionKey(List<Integer> request) {`
	`45`	`+ public PartitionKey getPartitionKey(List<Integer> request) {`
`46`	`46`	`return new PartitionKey(request.get(0) % 2);`
`47`	`47`	`}`
`48`	`48`