JAVA-1738: Make WriteType pluggable

olim7t · olim7t · commit bbd2d530055c · 2018-02-08T14:14:53.000-08:00
diff --git a/changelog/README.md b/changelog/README.md
@@ -4,6 +4,7 @@
 
 ### 4.0.0-alpha3 (in progress)
 
+- [improvement] JAVA-1738: Convert enums to allow extensibility
 - [bug] JAVA-1727: Override DefaultUdtValue.equals
 - [bug] JAVA-1729: Override DefaultTupleValue.equals
 - [improvement] JAVA-1720: Merge Cluster and Session into a single interface
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/ConsistencyLevel.java b/core/src/main/java/com/datastax/oss/driver/api/core/ConsistencyLevel.java
@@ -24,7 +24,7 @@
  */
 public interface ConsistencyLevel {
 
-  /** The numerical value that the level is encoded to. */
+  /** The numerical value that the level is encoded to in protocol frames. */
   int getProtocolCode();
 
   /** The textual representation of the level in configuration files. */
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicy.java b/core/src/main/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicy.java
@@ -20,8 +20,10 @@
 import com.datastax.oss.driver.api.core.connection.HeartbeatException;
 import com.datastax.oss.driver.api.core.context.DriverContext;
 import com.datastax.oss.driver.api.core.servererrors.CoordinatorException;
+import com.datastax.oss.driver.api.core.servererrors.CoreWriteType;
 import com.datastax.oss.driver.api.core.servererrors.ReadFailureException;
 import com.datastax.oss.driver.api.core.servererrors.WriteFailureException;
+import com.datastax.oss.driver.api.core.servererrors.WriteType;
 import com.datastax.oss.driver.api.core.session.Request;
 
 /**
@@ -82,7 +84,7 @@ public RetryDecision onWriteTimeout(
       int received,
       int retryCount) {
 
-    return (retryCount == 0 && writeType == WriteType.BATCH_LOG)
+    return (retryCount == 0 && writeType == CoreWriteType.BATCH_LOG)
         ? RetryDecision.RETRY_SAME
         : RetryDecision.RETHROW;
   }
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/retry/RetryPolicy.java b/core/src/main/java/com/datastax/oss/driver/api/core/retry/RetryPolicy.java
@@ -30,6 +30,7 @@
 import com.datastax.oss.driver.api.core.servererrors.ServerError;
 import com.datastax.oss.driver.api.core.servererrors.TruncateException;
 import com.datastax.oss.driver.api.core.servererrors.WriteFailureException;
+import com.datastax.oss.driver.api.core.servererrors.WriteType;
 import com.datastax.oss.driver.api.core.session.Request;
 
 /**
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/CoreWriteType.java b/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/CoreWriteType.java
@@ -13,15 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.datastax.oss.driver.api.core.retry;
+package com.datastax.oss.driver.api.core.servererrors;
+
+/** A default write type supported by the driver out of the box. */
+public enum CoreWriteType implements WriteType {
 
-/**
- * The type of a Cassandra write query.
- *
- * <p>This information is returned by Cassandra when a write timeout is raised, to indicate what
- * type of write timed out. It is useful to decide which retry decision to adopt.
- */
-public enum WriteType {
   /** A write to a single partition key. Such writes are guaranteed to be atomic and isolated. */
   SIMPLE,
   /**
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteFailureException.java b/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteFailureException.java
@@ -20,7 +20,6 @@
 import com.datastax.oss.driver.api.core.DriverException;
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.retry.RetryPolicy;
-import com.datastax.oss.driver.api.core.retry.WriteType;
 import com.datastax.oss.driver.api.core.session.Request;
 import java.net.InetAddress;
 import java.util.Map;
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteTimeoutException.java b/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteTimeoutException.java
@@ -20,7 +20,6 @@
 import com.datastax.oss.driver.api.core.DriverException;
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.retry.RetryPolicy;
-import com.datastax.oss.driver.api.core.retry.WriteType;
 import com.datastax.oss.driver.api.core.session.Request;
 
 /**
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteType.java b/core/src/main/java/com/datastax/oss/driver/api/core/servererrors/WriteType.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.api.core.servererrors;
+
+/**
+ * The type of a Cassandra write query.
+ *
+ * <p>This information is returned by Cassandra when a write timeout is raised, to indicate what
+ * type of write timed out. It is useful to decide which retry decision to adopt.
+ *
+ * <p>The only reason to model this as an interface (as opposed to an enum type) is to accommodate
+ * for custom protocol extensions. If you're connecting to a standard Apache Cassandra cluster, all
+ * {@code WriteType}s are {@link CoreWriteType} instances.
+ */
+public interface WriteType {
+
+  /** The textual representation that the write type is encoded to in protocol frames. */
+  String name();
+}
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java b/core/src/main/java/com/datastax/oss/driver/internal/core/context/DefaultDriverContext.java
@@ -52,6 +52,8 @@
 import com.datastax.oss.driver.internal.core.metadata.token.TokenFactoryRegistry;
 import com.datastax.oss.driver.internal.core.pool.ChannelPoolFactory;
 import com.datastax.oss.driver.internal.core.protocol.ByteBufPrimitiveCodec;
+import com.datastax.oss.driver.internal.core.servererrors.DefaultWriteTypeRegistry;
+import com.datastax.oss.driver.internal.core.servererrors.WriteTypeRegistry;
 import com.datastax.oss.driver.internal.core.session.PoolManager;
 import com.datastax.oss.driver.internal.core.session.RequestProcessorRegistry;
 import com.datastax.oss.driver.internal.core.ssl.JdkSslHandlerFactory;
@@ -119,6 +121,8 @@ public class DefaultDriverContext implements InternalDriverContext {
   private final LazyReference<ConsistencyLevelRegistry> consistencyLevelRegistryRef =
       new LazyReference<>(
           "consistencyLevelRegistry", this::buildConsistencyLevelRegistry, cycleDetector);
+  private final LazyReference<WriteTypeRegistry> writeTypeRegistryRef =
+      new LazyReference<>("writeTypeRegistry", this::buildWriteTypeRegistry, cycleDetector);
   private final LazyReference<NettyOptions> nettyOptionsRef =
       new LazyReference<>("nettyOptions", this::buildNettyOptions, cycleDetector);
   private final LazyReference<WriteCoalescer> writeCoalescerRef =
@@ -262,6 +266,10 @@ protected ConsistencyLevelRegistry buildConsistencyLevelRegistry() {
     return new DefaultConsistencyLevelRegistry();
   }
 
+  protected WriteTypeRegistry buildWriteTypeRegistry() {
+    return new DefaultWriteTypeRegistry();
+  }
+
   protected NettyOptions buildNettyOptions() {
     return new DefaultNettyOptions(this);
   }
@@ -419,6 +427,11 @@ public ConsistencyLevelRegistry consistencyLevelRegistry() {
     return consistencyLevelRegistryRef.get();
   }
 
+  @Override
+  public WriteTypeRegistry writeTypeRegistry() {
+    return writeTypeRegistryRef.get();
+  }
+
   @Override
   public NettyOptions nettyOptions() {
     return nettyOptionsRef.get();
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/context/InternalDriverContext.java b/core/src/main/java/com/datastax/oss/driver/internal/core/context/InternalDriverContext.java
@@ -30,6 +30,7 @@
 import com.datastax.oss.driver.internal.core.metadata.token.ReplicationStrategyFactory;
 import com.datastax.oss.driver.internal.core.metadata.token.TokenFactoryRegistry;
 import com.datastax.oss.driver.internal.core.pool.ChannelPoolFactory;
+import com.datastax.oss.driver.internal.core.servererrors.WriteTypeRegistry;
 import com.datastax.oss.driver.internal.core.session.PoolManager;
 import com.datastax.oss.driver.internal.core.session.RequestProcessorRegistry;
 import com.datastax.oss.driver.internal.core.ssl.SslHandlerFactory;
@@ -51,6 +52,8 @@ public interface InternalDriverContext extends DriverContext {
 
   ConsistencyLevelRegistry consistencyLevelRegistry();
 
+  WriteTypeRegistry writeTypeRegistry();
+
   NettyOptions nettyOptions();
 
   WriteCoalescer writeCoalescer();
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/cql/Conversions.java b/core/src/main/java/com/datastax/oss/driver/internal/core/cql/Conversions.java
@@ -33,7 +33,6 @@
 import com.datastax.oss.driver.api.core.cql.Statement;
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.metadata.token.Token;
-import com.datastax.oss.driver.api.core.retry.WriteType;
 import com.datastax.oss.driver.api.core.servererrors.AlreadyExistsException;
 import com.datastax.oss.driver.api.core.servererrors.BootstrappingException;
 import com.datastax.oss.driver.api.core.servererrors.CoordinatorException;
@@ -393,7 +392,7 @@ static CoordinatorException toThrowable(
             context.consistencyLevelRegistry().fromCode(writeTimeout.consistencyLevel),
             writeTimeout.received,
             writeTimeout.blockFor,
-            WriteType.valueOf(writeTimeout.writeType));
+            context.writeTypeRegistry().fromName(writeTimeout.writeType));
       case ProtocolConstants.ErrorCode.READ_TIMEOUT:
         ReadTimeout readTimeout = (ReadTimeout) errorMessage;
         return new ReadTimeoutException(
@@ -421,7 +420,7 @@ static CoordinatorException toThrowable(
             context.consistencyLevelRegistry().fromCode(writeFailure.consistencyLevel),
             writeFailure.received,
             writeFailure.blockFor,
-            WriteType.valueOf(writeFailure.writeType),
+            context.writeTypeRegistry().fromName(writeFailure.writeType),
             writeFailure.numFailures,
             writeFailure.reasonMap);
       case ProtocolConstants.ErrorCode.SYNTAX_ERROR:
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/servererrors/DefaultWriteTypeRegistry.java b/core/src/main/java/com/datastax/oss/driver/internal/core/servererrors/DefaultWriteTypeRegistry.java
@@ -0,0 +1,36 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.internal.core.servererrors;
+
+import com.datastax.oss.driver.api.core.servererrors.CoreWriteType;
+import com.datastax.oss.driver.api.core.servererrors.WriteType;
+import com.google.common.collect.ImmutableList;
+
+public class DefaultWriteTypeRegistry implements WriteTypeRegistry {
+
+  private static final ImmutableList<WriteType> values =
+      ImmutableList.<WriteType>builder().add(CoreWriteType.values()).build();
+
+  @Override
+  public WriteType fromName(String name) {
+    return CoreWriteType.valueOf(name);
+  }
+
+  @Override
+  public ImmutableList<WriteType> getValues() {
+    return values;
+  }
+}
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/servererrors/WriteTypeRegistry.java b/core/src/main/java/com/datastax/oss/driver/internal/core/servererrors/WriteTypeRegistry.java
@@ -0,0 +1,25 @@
+/*
+ * Copyright DataStax, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.datastax.oss.driver.internal.core.servererrors;
+
+import com.datastax.oss.driver.api.core.servererrors.WriteType;
+
+public interface WriteTypeRegistry {
+  WriteType fromName(String name);
+
+  /** @return all the values known to this driver instance. */
+  Iterable<WriteType> getValues();
+}
diff --git a/core/src/test/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicyTest.java b/core/src/test/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicyTest.java
@@ -19,8 +19,8 @@
 import static com.datastax.oss.driver.api.core.retry.RetryDecision.RETHROW;
 import static com.datastax.oss.driver.api.core.retry.RetryDecision.RETRY_NEXT;
 import static com.datastax.oss.driver.api.core.retry.RetryDecision.RETRY_SAME;
-import static com.datastax.oss.driver.api.core.retry.WriteType.BATCH_LOG;
-import static com.datastax.oss.driver.api.core.retry.WriteType.SIMPLE;
+import static com.datastax.oss.driver.api.core.servererrors.CoreWriteType.BATCH_LOG;
+import static com.datastax.oss.driver.api.core.servererrors.CoreWriteType.SIMPLE;
 
 import com.datastax.oss.driver.api.core.connection.ClosedConnectionException;
 import com.datastax.oss.driver.api.core.connection.HeartbeatException;
diff --git a/core/src/test/java/com/datastax/oss/driver/api/core/retry/RetryPolicyTestBase.java b/core/src/test/java/com/datastax/oss/driver/api/core/retry/RetryPolicyTestBase.java
@@ -19,6 +19,7 @@
 
 import com.datastax.oss.driver.api.core.ConsistencyLevel;
 import com.datastax.oss.driver.api.core.servererrors.CoordinatorException;
+import com.datastax.oss.driver.api.core.servererrors.WriteType;
 import com.datastax.oss.driver.api.core.session.Request;
 import org.assertj.core.api.Assert;
 import org.junit.runner.RunWith;
diff --git a/core/src/test/java/com/datastax/oss/driver/internal/core/cql/CqlRequestHandlerRetryTest.java b/core/src/test/java/com/datastax/oss/driver/internal/core/cql/CqlRequestHandlerRetryTest.java
@@ -29,8 +29,8 @@
 import com.datastax.oss.driver.api.core.metadata.Node;
 import com.datastax.oss.driver.api.core.retry.RetryDecision;
 import com.datastax.oss.driver.api.core.retry.RetryPolicy;
-import com.datastax.oss.driver.api.core.retry.WriteType;
 import com.datastax.oss.driver.api.core.servererrors.BootstrappingException;
+import com.datastax.oss.driver.api.core.servererrors.CoreWriteType;
 import com.datastax.oss.driver.api.core.servererrors.InvalidQueryException;
 import com.datastax.oss.driver.api.core.servererrors.ReadTimeoutException;
 import com.datastax.oss.driver.api.core.servererrors.ServerError;
@@ -336,7 +336,7 @@ public void mockRetryPolicyDecision(RetryPolicy policy, RetryDecision decision)
                     policy.onWriteTimeout(
                         any(SimpleStatement.class),
                         eq(CoreConsistencyLevel.LOCAL_ONE),
-                        eq(WriteType.SIMPLE),
+                        eq(CoreWriteType.SIMPLE),
                         eq(2),
                         eq(1),
                         eq(0)))
diff --git a/core/src/test/java/com/datastax/oss/driver/internal/core/cql/RequestHandlerTestHarness.java b/core/src/test/java/com/datastax/oss/driver/internal/core/cql/RequestHandlerTestHarness.java
@@ -39,6 +39,7 @@
 import com.datastax.oss.driver.internal.core.context.NettyOptions;
 import com.datastax.oss.driver.internal.core.metadata.LoadBalancingPolicyWrapper;
 import com.datastax.oss.driver.internal.core.pool.ChannelPool;
+import com.datastax.oss.driver.internal.core.servererrors.DefaultWriteTypeRegistry;
 import com.datastax.oss.driver.internal.core.session.DefaultSession;
 import com.datastax.oss.driver.internal.core.type.codec.registry.DefaultCodecRegistry;
 import com.datastax.oss.driver.internal.core.util.concurrent.ScheduledTaskCapturingEventLoop;
@@ -144,6 +145,8 @@ private RequestHandlerTestHarness(Builder builder) {
 
     Mockito.when(context.consistencyLevelRegistry())
         .thenReturn(new DefaultConsistencyLevelRegistry());
+
+    Mockito.when(context.writeTypeRegistry()).thenReturn(new DefaultWriteTypeRegistry());
   }
 
   public DefaultSession getSession() {
diff --git a/integration-tests/src/test/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicyIT.java b/integration-tests/src/test/java/com/datastax/oss/driver/api/core/retry/DefaultRetryPolicyIT.java
@@ -33,6 +33,7 @@
 import com.datastax.oss.driver.api.core.cql.ResultSet;
 import com.datastax.oss.driver.api.core.cql.SimpleStatement;
 import com.datastax.oss.driver.api.core.metadata.Node;
+import com.datastax.oss.driver.api.core.servererrors.CoreWriteType;
 import com.datastax.oss.driver.api.core.servererrors.ReadTimeoutException;
 import com.datastax.oss.driver.api.core.servererrors.ServerError;
 import com.datastax.oss.driver.api.core.servererrors.UnavailableException;
@@ -277,7 +278,7 @@ public void should_retry_on_write_timeout_if_write_type_batch_log() {
       assertThat(wte.getConsistencyLevel()).isEqualTo(CoreConsistencyLevel.LOCAL_QUORUM);
       assertThat(wte.getReceived()).isEqualTo(1);
       assertThat(wte.getBlockFor()).isEqualTo(3);
-      assertThat(wte.getWriteType()).isEqualTo(WriteType.BATCH_LOG);
+      assertThat(wte.getWriteType()).isEqualTo(CoreWriteType.BATCH_LOG);
     }
 
     // there should have been a retry, and it should have been executed on the same host.
@@ -341,7 +342,7 @@ public void should_not_retry_on_write_timeout_if_write_type_batch_log_but_non_id
       assertThat(wte.getConsistencyLevel()).isEqualTo(CoreConsistencyLevel.LOCAL_QUORUM);
       assertThat(wte.getReceived()).isEqualTo(1);
       assertThat(wte.getBlockFor()).isEqualTo(3);
-      assertThat(wte.getWriteType()).isEqualTo(WriteType.BATCH_LOG);
+      assertThat(wte.getWriteType()).isEqualTo(CoreWriteType.BATCH_LOG);
     }
 
     // should not have been retried.
