JAVA-2995: CodecNotFoundException doesn't extend DriverException (#1598)

Co-authored-by: Alexandre Dutra <[email protected]>

Author: smiklosovic

core/revapi.json

@@ -6817,6 +6817,13 @@
         "new": "method void com.fasterxml.jackson.databind.type.TypeBase::serialize(com.fasterxml.jackson.core.JsonGenerator, com.fasterxml.jackson.databind.SerializerProvider) throws java.io.IOException",
         "exception": "com.fasterxml.jackson.core.JsonProcessingException",
         "justification": "Upgrade deps around JAVA-2977 to address outstanding CVEs"
+      },
+      {
+        "code": "java.class.nonFinalClassInheritsFromNewClass",
+        "old": "class com.datastax.oss.driver.api.core.type.codec.CodecNotFoundException",
+        "new": "class com.datastax.oss.driver.api.core.type.codec.CodecNotFoundException",
+        "superClass": "com.datastax.oss.driver.api.core.DriverException",
+        "justification": "Make CodecNotFoundException to extend DriverException as all other driver exceptions do"
       }
     ]
   }

core/src/main/java/com/datastax/oss/driver/api/core/type/codec/CodecNotFoundException.java

@@ -15,14 +15,15 @@
  */
 package com.datastax.oss.driver.api.core.type.codec;
 
+import com.datastax.oss.driver.api.core.DriverException;
 import com.datastax.oss.driver.api.core.type.DataType;
 import com.datastax.oss.driver.api.core.type.codec.registry.CodecRegistry;
 import com.datastax.oss.driver.api.core.type.reflect.GenericType;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
 
 /** Thrown when a suitable {@link TypeCodec} cannot be found by the {@link CodecRegistry}. */
-public class CodecNotFoundException extends RuntimeException {
+public class CodecNotFoundException extends DriverException {
 
   private final DataType cqlType;
 
@@ -48,7 +49,7 @@ public CodecNotFoundException(
 
   private CodecNotFoundException(
       String msg, Throwable cause, DataType cqlType, GenericType<?> javaType) {
-    super(msg, cause);
+    super(msg, null, cause, true);
     this.cqlType = cqlType;
     this.javaType = javaType;
   }
@@ -62,4 +63,10 @@ public DataType getCqlType() {
   public GenericType<?> getJavaType() {
     return javaType;
   }
+
+  @NonNull
+  @Override
+  public DriverException copy() {
+    return new CodecNotFoundException(getMessage(), getCause(), getCqlType(), getJavaType());
+  }
 }

upgrade_guide/README.md

@@ -1,5 +1,45 @@
 ## Upgrade guide
 
+### 4.15.0
+
+#### CodecNotFoundException now extends DriverException
+
+Before [JAVA-2995](https://datastax-oss.atlassian.net/browse/JAVA-2959), `CodecNotFoundException`
+was extending `RuntimeException`. This is a discrepancy as all other exceptions extend
+`DriverException`, which in turn extends `RuntimeException`.
+
+This was causing integrators to do workarounds in order to react on all exceptions correctly.
+
+The change introduced by JAVA-2995 shouldn't be a problem for most users. But if your code was using
+a logic such as below, it won't compile anymore:
+
+```java
+try {
+  doSomethingWithDriver();
+} catch(DriverException e) {
+} catch(CodecNotFoundException e) { 
+}
+```
+
+You need to either reverse the catch order and catch `CodecNotFoundException` first:
+
+```java
+try {
+  doSomethingWithDriver();
+} catch(CodecNotFoundException e) { 
+} catch(DriverException e) {
+}
+```
+
+Or catch only `DriverException`:
+
+```java
+try {
+  doSomethingWithDriver();
+} catch(DriverException e) { 
+}
+```
+
 ### 4.14.0
 
 #### AllNodesFailedException instead of NoNodeAvailableException in certain cases