feat: provide base WeaviateException class for ergonomics

Author: bevzzz

src/it/java/io/weaviate/integration/PaginationITest.java

@@ -16,10 +16,11 @@
 
 import io.weaviate.ConcurrentTest;
 import io.weaviate.client6.v1.api.WeaviateClient;
+import io.weaviate.client6.v1.api.WeaviateException;
 import io.weaviate.client6.v1.api.collections.Property;
 import io.weaviate.client6.v1.api.collections.WeaviateMetadata;
 import io.weaviate.client6.v1.api.collections.WeaviateObject;
-import io.weaviate.client6.v1.api.collections.pagination.WeaviatePaginationException;
+import io.weaviate.client6.v1.api.collections.pagination.PaginationException;
 import io.weaviate.containers.Container;
 
 public class PaginationITest extends ConcurrentTest {
@@ -160,13 +161,13 @@ public void testAsyncPaginator() throws IOException, InterruptedException, Execu
     }
   }
 
-  @Test(expected = WeaviatePaginationException.class)
+  @Test(expected = PaginationException.class)
   public void testFailedPagination() throws IOException {
     var things = client.collections.use("Unknown");
     things.paginate().forEach(System.out::println);
   }
 
-  @Test(expected = WeaviatePaginationException.class)
+  @Test(expected = PaginationException.class)
   public void testFailedAsyncPagination_forEach() throws Throwable {
     try (final var async = client.async()) {
       var things = async.collections.use("Unknown");
@@ -178,7 +179,7 @@ public void testFailedAsyncPagination_forEach() throws Throwable {
     }
   }
 
-  @Test(expected = WeaviatePaginationException.class)
+  @Test(expected = WeaviateException.class)
   public void testFailedAsyncPagination_forPage() throws Throwable {
     try (final var async = client.async()) {
       var things = async.collections.use("Unknown");

src/main/java/io/weaviate/client6/v1/api/WeaviateApiException.java

@@ -5,7 +5,7 @@
  * server, but the operation did not complete successfully either either due to
  * a bad request or a server error.
  */
-public class WeaviateApiException extends RuntimeException {
+public class WeaviateApiException extends WeaviateException {
   private final String errorMessage;
   private final Source source;
   private final String endpoint;

src/main/java/io/weaviate/client6/v1/api/WeaviateException.java

@@ -0,0 +1,38 @@
+package io.weaviate.client6.v1.api;
+
+/**
+ * WeaviateException is the base class for other library exceptions
+ * to provide an ergonomic way of handling any Weaviate-related exceptions.
+ *
+ * <p>
+ * Some parts of the API may still throw other standard exceptions, like
+ * {@link java.io.IOException} or {@link java.lang.IllegalArgumentException},
+ * which will not be wrapped into a WeaviateException.
+ *
+ * <p>
+ * Usage:
+ *
+ * <pre>{@code
+ *  var thigns = client.collections.use("Things");
+ *  try {
+ *    things.paginate(...)
+ *    things.query.bm25(...);
+ *    things.aggregate.overAll(...);
+ *  } catch (WeaviateException e) {
+ *    System.out.println(e);
+ *  }
+ * }</pre>
+ */
+public abstract class WeaviateException extends RuntimeException {
+  public WeaviateException(String message) {
+    super(message);
+  }
+
+  public WeaviateException(Throwable cause) {
+    super(cause);
+  }
+
+  public WeaviateException(String message, Throwable cause) {
+    super(message, cause);
+  }
+}

src/main/java/io/weaviate/client6/v1/api/collections/pagination/AsyncPaginator.java

@@ -36,7 +36,7 @@ public AsyncPaginator(Builder<PropertiesT> builder) {
           return this.query.fetchObjects(fn)
               .handle((response, ex) -> {
                 if (ex != null) {
-                  throw WeaviatePaginationException.after(cursor, pageSize, ex);
+                  throw PaginationException.after(cursor, pageSize, ex);
                 }
                 return response;
               })

src/main/java/io/weaviate/client6/v1/api/collections/pagination/WeaviatePaginationException.java renamed to src/main/java/io/weaviate/client6/v1/api/collections/pagination/PaginationException.java

@@ -1,20 +1,22 @@
 package io.weaviate.client6.v1.api.collections.pagination;
 
+import io.weaviate.client6.v1.api.WeaviateException;
+
 /**
  * WeaviatePaginationException is thrown then the client encouters an exception
  * while fetching the next page. This exception preserves the original exception
  * (see {@link #getCause} and the information about the last cursor and page
  * size used (see {@link #cursor()} and {@link #pageSize()} respectively).
  */
-public class WeaviatePaginationException extends RuntimeException {
+public class PaginationException extends WeaviateException {
   private final String cursor;
   private final int pageSize;
 
-  public static WeaviatePaginationException after(String cursor, int pageSize, Throwable cause) {
-    return new WeaviatePaginationException(cursor, pageSize, cause);
+  public static PaginationException after(String cursor, int pageSize, Throwable cause) {
+    return new PaginationException(cursor, pageSize, cause);
   }
 
-  private WeaviatePaginationException(String cursor, int pageSize, Throwable cause) {
+  private PaginationException(String cursor, int pageSize, Throwable cause) {
     super("fetch next page, page_size=%d cursor=%s".formatted(pageSize, cursor), cause);
     this.cursor = cursor;
     this.pageSize = pageSize;

src/main/java/io/weaviate/client6/v1/api/collections/pagination/Paginator.java

@@ -40,7 +40,7 @@ public Spliterator<WeaviateObject<PropertiesT, Object, QueryMetadata>> spliterat
           try {
             return query.fetchObjects(fn).objects();
           } catch (Exception e) {
-            throw WeaviatePaginationException.after(cursor, pageSize, e);
+            throw PaginationException.after(cursor, pageSize, e);
           }
         });
   }