Merge pull request #10 from CJCrafter/exception-wrappers

wrap the json error with Error classes

Author: CJCrafter

build.gradle.kts

@@ -22,6 +22,7 @@ dependencies {
     implementation("com.google.code.gson:gson:2.10.1")
 
     testImplementation("io.github.cdimascio:dotenv-kotlin:6.4.1")
+    testImplementation("org.junit.jupiter:junit-jupiter:5.9.2")
 }
 
 java {
@@ -43,6 +44,10 @@ tasks {
     }
 }
 
+tasks.test {
+    useJUnitPlatform()
+}
+
 // Create javadocJar and sourcesJar tasks
 val javadocJar by tasks.registering(Jar::class) {
     archiveClassifier.set("javadoc")

src/main/kotlin/com/cjcrafter/openai/OpenAI.kt

@@ -4,6 +4,8 @@ import com.cjcrafter.openai.chat.ChatRequest
 import com.cjcrafter.openai.chat.ChatResponse
 import com.cjcrafter.openai.chat.ChatResponseChunk
 import com.cjcrafter.openai.chat.ChatUser
+import com.cjcrafter.openai.exception.OpenAIError
+import com.cjcrafter.openai.exception.WrappedIOError
 import com.google.gson.Gson
 import com.google.gson.GsonBuilder
 import com.google.gson.JsonObject
@@ -61,10 +63,9 @@ class OpenAI @JvmOverloads constructor(
      *
      * @param request The input information for ChatGPT.
      * @return The returned response.
-     * @throws IOException              If an IO Exception occurs.
-     * @throws IllegalArgumentException If the input arguments are invalid.
+     * @throws OpenAIError Invalid request/timeout/io/etc.
      */
-    @Throws(IOException::class)
+    @Throws(OpenAIError::class)
     fun createChatCompletion(request: ChatRequest): ChatResponse {
         request.stream = false // use streamResponse for stream=true
         val httpRequest = buildRequest(request)
@@ -77,11 +78,12 @@ class OpenAI @JvmOverloads constructor(
                 // Servers respond to API calls with json blocks. Since raw JSON isn't
                 // very developer friendly, we wrap for easy data access.
                 rootObject = JsonParser.parseString(response.body!!.string()).asJsonObject
-                require(!rootObject!!.has("error")) { rootObject!!.get("error").asJsonObject["message"].asString }
+                if (rootObject!!.has("error"))
+                    throw OpenAIError.fromJson(rootObject!!.get("error").asJsonObject)
                 return ChatResponse(rootObject!!)
             }
-        } catch (ex: Throwable) {
-            throw ex
+        } catch (ex: IOException) {
+            throw WrappedIOError(ex)
         }
     }
 

src/main/kotlin/com/cjcrafter/openai/chat/ChatBot.kt

@@ -1,13 +1,11 @@
 package com.cjcrafter.openai.chat
 
+import com.cjcrafter.openai.exception.OpenAIError
 import com.google.gson.*
 import okhttp3.*
 import okhttp3.MediaType.Companion.toMediaType
-import okhttp3.OkHttpClient.Builder
 import okhttp3.RequestBody.Companion.toRequestBody
 import java.io.IOException
-import java.lang.IllegalArgumentException
-import java.util.concurrent.TimeUnit
 import java.util.function.Consumer
 
 /**
@@ -66,8 +64,6 @@ class ChatBot @JvmOverloads constructor(
      *
      * @param request The input information for ChatGPT.
      * @return The returned response.
-     * @throws IOException              If an IO Exception occurs.
-     * @throws IllegalArgumentException If the input arguments are invalid.
      */
     @Throws(IOException::class)
     fun generateResponse(request: ChatRequest): ChatResponse {
@@ -79,13 +75,14 @@ class ChatBot @JvmOverloads constructor(
         try {
             client.newCall(httpRequest).execute().use { response ->
 
-                // Servers respond to API calls with json blocks. Since raw JSON isn't
-                // very developer friendly, we wrap for easy data access.
                 rootObject = JsonParser.parseString(response.body!!.string()).asJsonObject
-                require(!rootObject!!.has("error")) { rootObject!!.get("error").asJsonObject["message"].asString }
+                if (rootObject!!.has("error"))
+                    throw OpenAIError.fromJson(rootObject!!["error"].asJsonObject)
+
                 return ChatResponse(rootObject!!)
             }
         } catch (ex: Throwable) {
+            println(rootObject)
             throw ex
         }
     }

src/main/kotlin/com/cjcrafter/openai/exception/InvalidRequestError.kt

@@ -0,0 +1,5 @@
+package com.cjcrafter.openai.exception
+
+import com.google.gson.JsonElement
+
+class InvalidRequestError(param: JsonElement?, code: String?, message: String) : OpenAIError(param, code, message)

src/main/kotlin/com/cjcrafter/openai/exception/OpenAIError.kt

@@ -0,0 +1,43 @@
+package com.cjcrafter.openai.exception
+
+import com.google.gson.JsonElement
+import com.google.gson.JsonObject
+
+// TODO docs
+abstract class OpenAIError : Exception {
+
+    val param: JsonElement?
+    val code: String?
+
+    constructor(param: JsonElement?, code: String?, message: String) : super(message) {
+        this.param = param
+        this.code = code
+    }
+
+    constructor(param: JsonElement?, code: String?, message: String, cause: Throwable?) : super(message, cause) {
+        this.param = param
+        this.code = code
+    }
+
+    constructor(param: JsonElement?, code: String?, cause: Throwable?) : super(cause) {
+        this.param = param
+        this.code = code
+    }
+
+    companion object {
+
+        @JvmStatic
+        fun fromJson(json: JsonObject) : OpenAIError {
+            val message = json["message"].asString
+            val type = if (json["type"].isJsonNull) null else json["type"].asString
+            val param = if (json["param"].isJsonNull) null else json["param"]
+            val code = if (json["code"].isJsonNull) null else json["code"].asString
+
+            // TODO add more error types
+            return when (json["type"].asString) {
+                "invalid_request_error" -> InvalidRequestError(param, code, message)
+                else -> UnknownError(param, code, message, type)
+            }
+        }
+    }
+}

src/main/kotlin/com/cjcrafter/openai/exception/OpenAIException.kt

@@ -0,0 +1,5 @@
+package com.cjcrafter.openai.exception
+
+import com.google.gson.JsonElement
+
+class UnknownError(param: JsonElement?, code: String?, message: String, val type: String?) : OpenAIError(param, code, message)

src/main/kotlin/com/cjcrafter/openai/exception/UnknownError.kt

@@ -0,0 +1,5 @@
+package com.cjcrafter.openai.exception
+
+import java.io.IOException
+
+class WrappedIOError(val exception: IOException) : OpenAIError(null, null, exception.message ?: "")

src/main/kotlin/com/cjcrafter/openai/exception/WrappedIOError.kt

@@ -1,5 +1,6 @@
 import com.cjcrafter.openai.OpenAI;
 import com.cjcrafter.openai.chat.*;
+import com.cjcrafter.openai.exception.OpenAIError;
 import io.github.cdimascio.dotenv.Dotenv;
 
 import java.io.IOException;
@@ -9,7 +10,7 @@
 
 public class JavaChatTest {
 
-    public static void main(String[] args) throws IOException {
+    public static void main(String[] args) throws OpenAIError {
         Scanner scan = new Scanner(System.in);
 
         // This is the prompt that the bot will refer back to for every message.

src/test/java/JavaChatTest.java

@@ -0,0 +1,38 @@
+package com.cjcrafter.openai;
+
+import com.cjcrafter.openai.chat.*;
+import com.cjcrafter.openai.exception.InvalidRequestError;
+import io.github.cdimascio.dotenv.Dotenv;
+import org.junit.jupiter.api.Test;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class ExceptionTests {
+
+    @Test
+    void test_invalidModel() {
+        String key = Dotenv.load().get("OPENAI_TOKEN");
+
+        String initialPrompt = "Just say hi";
+        List<ChatMessage> messages = new ArrayList<>(List.of(new ChatMessage(ChatUser.SYSTEM, initialPrompt)));
+        ChatRequest request = new ChatRequest("gpt-238974-invalid-model", messages);
+        OpenAI openai = new OpenAI(key);
+
+        assertThrows(InvalidRequestError.class, () -> openai.createChatCompletion(request));
+    }
+
+    @Test
+    void test_invalidToken() {
+        String key = "sk-Thisisaninvalidtoken";
+
+        String initialPrompt = "Just say hi";
+        List<ChatMessage> messages = new ArrayList<>(List.of(new ChatMessage(ChatUser.SYSTEM, initialPrompt)));
+        ChatRequest request = new ChatRequest("gpt-3.5-turbo", messages);
+        OpenAI openai = new OpenAI(key);
+
+        assertThrows(InvalidRequestError.class, () -> openai.createChatCompletion(request));
+    }
+}