Merge pull request #66 from cequence-io/feature/refactor-out-ws-client

Feature/refactor out ws client

Author: peterbanda

.scalafmt.conf

@@ -13,6 +13,10 @@ newlines {
  implicitParamListModifierForce = [before]
 }
 
+//rewrite {
+// trailingCommas.style = always
+//}
+
 verticalMultiline {
  atDefnSite = true
  arityThreshold = 2

anthropic-client/build.sbt

@@ -1,3 +1,9 @@
+import Dependencies.Versions._
+
 name := "openai-scala-anthropic-client"
 
 description := "Scala client for Anthropic API implemented using Play WS lib."
+
+libraryDependencies += "org.scalactic" %% "scalactic" % "3.2.18"
+libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.18" % Test
+libraryDependencies += "org.scalamock" %% "scalamock" % scakaMock % Test

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/JsonFormats.scala

@@ -1,6 +1,6 @@
 package io.cequence.openaiscala.anthropic
 
-import io.cequence.openaiscala.JsonUtil
+import io.cequence.wsclient.JsonUtil
 import io.cequence.openaiscala.anthropic.domain.Content.ContentBlock.{ImageBlock, TextBlock}
 import io.cequence.openaiscala.anthropic.domain.Content.{
  ContentBlock,

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/domain/ChatRole.scala

@@ -1,6 +1,6 @@
 package io.cequence.openaiscala.anthropic.domain
 
-import io.cequence.openaiscala.domain.EnumValue
+import io.cequence.wsclient.domain.EnumValue
 
 sealed trait ChatRole extends EnumValue {
  override def toString: String = super.toString.toLowerCase

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/domain/response/CreateMessageResponse.scala

@@ -3,7 +3,7 @@ package io.cequence.openaiscala.anthropic.domain.response
 import io.cequence.openaiscala.anthropic.domain.ChatRole
 import io.cequence.openaiscala.anthropic.domain.Content.ContentBlocks
 import io.cequence.openaiscala.anthropic.domain.response.CreateMessageResponse.UsageInfo
-import io.cequence.openaiscala.domain.NamedEnumValue
+import io.cequence.wsclient.domain.NamedEnumValue
 
 final case class CreateMessageResponse(
  id: String,

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/service/AnthropicScalaClientException.scala

@@ -0,0 +1,66 @@
+package io.cequence.openaiscala.anthropic.service
+
+import io.cequence.wsclient.domain.CequenceWSException
+
+class AnthropicScalaClientException(
+ message: String,
+ cause: Throwable
+) extends CequenceWSException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaClientTimeoutException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaClientUnknownHostException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaTokenCountExceededException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaUnauthorizedException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaNotFoundException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaRateLimitException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaServerErrorException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}
+
+class AnthropicScalaEngineOverloadedException(
+ message: String,
+ cause: Throwable
+) extends AnthropicScalaClientException(message, cause) {
+ def this(message: String) = this(message, null)
+}

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/service/AnthropicService.scala

@@ -8,7 +8,7 @@ import io.cequence.openaiscala.anthropic.domain.response.{
  CreateMessageResponse
 }
 import io.cequence.openaiscala.anthropic.domain.settings.AnthropicCreateMessageSettings
-import io.cequence.openaiscala.service.CloseableService
+import io.cequence.wsclient.service.CloseableService
 
 import scala.concurrent.Future
 

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/service/AnthropicServiceFactory.scala

@@ -5,9 +5,9 @@ import io.cequence.openaiscala.anthropic.service.impl.{
  AnthropicServiceImpl,
  OpenAIAnthropicChatCompletionService
 }
-import io.cequence.openaiscala.service.OpenAIChatCompletionService
 import io.cequence.openaiscala.service.StreamedServiceTypes.OpenAIChatCompletionStreamedService
-import io.cequence.openaiscala.service.ws.Timeouts
+import io.cequence.wsclient.domain.WsRequestContext
+import io.cequence.wsclient.service.ws.Timeouts
 
 import scala.concurrent.ExecutionContext
 
@@ -17,8 +17,8 @@ import scala.concurrent.ExecutionContext
  */
 object AnthropicServiceFactory extends AnthropicServiceConsts {
 
- private val apiVersion = "2023-06-01"
- private val envAPIKey = "ANTHROPIC_API_KEY"
+ private def apiVersion = "2023-06-01"
+ private def envAPIKey = "ANTHROPIC_API_KEY"
 
  /**
  * Create a new instance of the [[OpenAIChatCompletionService]] wrapping the AnthropicService
@@ -84,6 +84,7 @@ object AnthropicServiceFactory extends AnthropicServiceConsts {
  implicit val ec: ExecutionContext,
  val materializer: Materializer
  ) extends AnthropicServiceImpl {
- override protected val extraParams: Seq[(String, String)] = Nil
+ override protected val requestContext: WsRequestContext =
+ WsRequestContext(authHeaders = authHeaders, explTimeouts = explTimeouts)
  }
 }

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/service/HandleAnthropicErrorCodes.scala

@@ -0,0 +1,45 @@
+package io.cequence.openaiscala.anthropic.service
+
+import io.cequence.openaiscala._
+import io.cequence.wsclient.service.ws.WSRequestHelper
+
+/**
+ * Handle error codes for the Anthropic service.
+ *
+ * @since March
+ * 2024
+ */
+trait HandleAnthropicErrorCodes extends WSRequestHelper {
+
+ override protected def handleErrorCodes(
+ httpCode: Int,
+ message: String
+ ): Nothing = {
+ val errorMessage = s"Code ${httpCode} : ${message}"
+ httpCode match {
+
+ // 401 - authentication_error: There’s an issue with your API key.
+ case 401 => throw new AnthropicScalaUnauthorizedException(errorMessage)
+
+ // 403 - permission_error: Your API key does not have permission to use the specified resource.
+ case 403 => throw new AnthropicScalaUnauthorizedException(errorMessage)
+
+ // 404 - not_found_error: The requested resource was not found.
+ case 404 => throw new AnthropicScalaNotFoundException(errorMessage)
+
+ // 429 - rate_limit_error: Your account has hit a rate limit.
+ case 429 => throw new AnthropicScalaRateLimitException(errorMessage)
+
+ // 500 - api_error: An unexpected error has occurred internal to Anthropic’s systems.
+ case 500 => throw new AnthropicScalaServerErrorException(errorMessage)
+
+ // 529 - overloaded_error: Anthropic’s API is temporarily overloaded.
+ case 529 => throw new AnthropicScalaEngineOverloadedException(errorMessage)
+
+ // 400 - invalid_request_error: There was an issue with the format or content of your request. We may also use this error type for other 4XX status codes not listed below.
+ case 400 => throw new AnthropicScalaClientException(errorMessage)
+
+ case _ => throw new AnthropicScalaClientException(errorMessage)
+ }
+ }
+}

anthropic-client/src/main/scala/io/cequence/openaiscala/anthropic/service/impl/AnthropicServiceImpl.scala

@@ -2,7 +2,6 @@ package io.cequence.openaiscala.anthropic.service.impl
 
 import akka.NotUsed
 import akka.stream.scaladsl.Source
-import io.cequence.openaiscala.JsonUtil.JsonOps
 import io.cequence.openaiscala.OpenAIScalaClientException
 import io.cequence.openaiscala.anthropic.JsonFormats
 import io.cequence.openaiscala.anthropic.domain.response.{
@@ -11,20 +10,21 @@ import io.cequence.openaiscala.anthropic.domain.response.{
 }
 import io.cequence.openaiscala.anthropic.domain.settings.AnthropicCreateMessageSettings
 import io.cequence.openaiscala.anthropic.domain.{ChatRole, Message}
-import io.cequence.openaiscala.anthropic.service.AnthropicService
-import io.cequence.openaiscala.service.OpenAIWSRequestHelper
-import io.cequence.openaiscala.service.impl.OpenAIWSStreamRequestHelper
+import io.cequence.openaiscala.anthropic.service.{AnthropicService, HandleAnthropicErrorCodes}
+import io.cequence.wsclient.JsonUtil.JsonOps
+import io.cequence.wsclient.service.ws.stream.WSStreamRequestHelper
 import play.api.libs.json.{JsValue, Json}
 
 import scala.concurrent.Future
 
-// TODO: Introduce Anthropic specific exception and handle error codes
-// Shouldn't use OpenAIWSRequestHelper and OpenAIWSStreamRequestHelper
-private[service] trait AnthropicServiceImpl
+trait Anthropic
  extends AnthropicService
- with OpenAIWSRequestHelper
- with OpenAIWSStreamRequestHelper
- with JsonFormats {
+ with WSStreamRequestHelper
+ with HandleAnthropicErrorCodes
+ with JsonFormats
+
+// Shouldn't use OpenAIWSRequestHelper and OpenAIWSStreamRequestHelper
+private[service] trait AnthropicServiceImpl extends Anthropic {
 
  override protected type PEP = EndPoint
  override protected type PT = Param