Migration for WS client engine (Play based) + Version 0.1.4

Author: peterbanda

README.md

@@ -1,5 +1,5 @@
 # Pinecone Scala Client 🗂️
-[![version](https://img.shields.io/badge/version-0.1.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
+[![version](https://img.shields.io/badge/version-0.1.4-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
 
 This is an intuitive async Scala client for Pinecone API supporting all the available vector and index/collection operations/endpoints, provided in two convenient services called [PineconeVectorService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala). The supported calls are: 
 
@@ -22,7 +22,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "pinecone-scala-client" % "0.1.3"
+"io.cequence" %% "pinecone-scala-client" % "0.1.4"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -31,7 +31,7 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>pinecone-scala-client_2.12</artifactId>
-    <version>0.1.3</version>
+    <version>0.1.4</version>
 </dependency>
 ```
 
@@ -428,7 +428,7 @@ pinecone-scala-client {
 }
 ```
 
-2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.3/pinecone-scala-client_2.13-0.1.3.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_
+2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.4/pinecone-scala-client_2.13-0.1.4.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_
 
    Set the env. variable `PINECONE_SCALA_CLIENT_API_KEY`. If you don't have one register [here](https://app.pinecone.io/?sessionType=signup).
 

build.sbt

@@ -8,7 +8,7 @@ val scala33 = "3.3.1"
 
 ThisBuild / organization := "io.cequence"
 ThisBuild / scalaVersion := scala212
-ThisBuild / version := "0.1.3"
+ThisBuild / version := "0.1.4"
 ThisBuild / isSnapshot := false
 
 lazy val core = (project in file("pinecone-core"))

pinecone-client/src/main/scala/io/cequence/pineconescala/service/PineconeIndexServiceImpl.scala

@@ -6,16 +6,15 @@ import io.cequence.pineconescala.JsonFormats._
 import io.cequence.pineconescala.PineconeScalaClientException
 import io.cequence.pineconescala.domain.IndexEnv.PodEnv
 import io.cequence.pineconescala.domain.response._
-import io.cequence.pineconescala.domain.settings.IndexSettings.{
-  CreatePodBasedIndexSettings,
-  CreateServerlessIndexSettings
-}
+import io.cequence.pineconescala.domain.settings.IndexSettings.{CreatePodBasedIndexSettings, CreateServerlessIndexSettings}
 import io.cequence.pineconescala.domain.settings._
 import io.cequence.pineconescala.domain.{Metric, PodType}
 import io.cequence.wsclient.JsonUtil.JsonOps
 import io.cequence.wsclient.ResponseImplicits._
 import io.cequence.wsclient.domain.{RichResponse, WsRequestContext}
-import io.cequence.wsclient.service.ws.{Timeouts, WSRequestHelper}
+import io.cequence.wsclient.service.{WSClientEngine, WSClientWithEngineBase}
+import io.cequence.wsclient.service.WSClientWithEngineTypes.WSClientWithEngine
+import io.cequence.wsclient.service.ws.{PlayWSClientEngine, Timeouts}
 import play.api.libs.json.JsValue
 
 import scala.concurrent.{ExecutionContext, Future}
@@ -29,13 +28,11 @@ private final class ServerlessIndexServiceImpl(
 ) extends PineconeIndexServiceImpl[CreateServerlessIndexSettings](
       apiKey,
       None,
+      coreUrl = "https://api.pinecone.io/",
       explTimeouts
     )(ec, materializer)
     with PineconeServerlessIndexService {
 
-  override protected val coreUrl: String =
-    "https://api.pinecone.io/"
-
   override protected def indexesEndpoint: EndPoint = EndPoint.indexes
 
   /**
@@ -90,13 +87,11 @@ private final class PineconePodPineconeBasedImpl(
 ) extends PineconeIndexServiceImpl[CreatePodBasedIndexSettings](
       apiKey,
       Some(environment),
+      coreUrl = s"https://controller.${environment.environment}.pinecone.io/",
       explTimeouts
     )(ec, materializer)
     with PineconePodBasedIndexService {
 
-  override protected val coreUrl =
-    s"https://controller.${environment.environment}.pinecone.io/"
-
   override protected def indexesEndpoint: EndPoint = EndPoint.databases
 
   /**
@@ -198,19 +193,24 @@ private final class PineconePodPineconeBasedImpl(
 abstract class PineconeIndexServiceImpl[S <: IndexSettings](
   apiKey: String,
   environment: Option[PodEnv],
+  coreUrl: String,
   explicitTimeouts: Option[Timeouts] = None
 )(
   implicit val ec: ExecutionContext,
   val materializer: Materializer
 ) extends PineconeIndexService[S]
-    with WSRequestHelper {
+    with WSClientWithEngine {
 
   override protected type PEP = EndPoint
   override protected type PT = Tag
 
-  override protected val requestContext = WsRequestContext(
-    authHeaders = Seq(("Api-Key", apiKey)),
-    explTimeouts = explicitTimeouts
+  // we use play-ws backend
+  override protected val engine: WSClientEngine = PlayWSClientEngine(
+    coreUrl,
+    requestContext =  WsRequestContext(
+      authHeaders = Seq(("Api-Key", apiKey)),
+      explTimeouts = explicitTimeouts
+    )
   )
 
   def isPodBasedIndex: Boolean = environment.isDefined

pinecone-client/src/main/scala/io/cequence/pineconescala/service/PineconeInferenceServiceImpl.scala

@@ -3,12 +3,14 @@ package io.cequence.pineconescala.service
 import akka.stream.Materializer
 import com.typesafe.config.Config
 import io.cequence.pineconescala.domain.response.GenerateEmbeddingsResponse
-import io.cequence.pineconescala.domain.settings.{GenerateEmbeddingsSettings, IndexSettings}
+import io.cequence.pineconescala.domain.settings.GenerateEmbeddingsSettings
 import io.cequence.wsclient.ResponseImplicits._
-import io.cequence.wsclient.service.ws.{Timeouts, WSRequestHelper}
+import io.cequence.wsclient.service.ws.{PlayWSClientEngine, Timeouts}
 import io.cequence.pineconescala.JsonFormats._
 import io.cequence.pineconescala.PineconeScalaClientException
 import io.cequence.wsclient.domain.WsRequestContext
+import io.cequence.wsclient.service.WSClientEngine
+import io.cequence.wsclient.service.WSClientWithEngineTypes.WSClientWithEngine
 
 import scala.concurrent.{ExecutionContext, Future}
 
@@ -19,18 +21,21 @@ private class PineconeInferenceServiceImpl(
   implicit val ec: ExecutionContext,
   val materializer: Materializer
 ) extends PineconeInferenceService
-    with WSRequestHelper {
+    with WSClientWithEngine {
 
   override protected type PEP = EndPoint
   override protected type PT = Tag
-  override val coreUrl: String = "https://api.pinecone.io/"
 
-  override protected val requestContext = WsRequestContext(
-    authHeaders = Seq(
-      ("Api-Key", apiKey),
-      ("X-Pinecone-API-Version", "2024-07")
-    ),
-    explTimeouts = explicitTimeouts
+  // we use play-ws backend
+  override protected val engine: WSClientEngine = PlayWSClientEngine(
+    coreUrl = "https://api.pinecone.io/",
+    requestContext =  WsRequestContext(
+      authHeaders = Seq(
+        ("Api-Key", apiKey),
+        ("X-Pinecone-API-Version", "2024-07")
+      ),
+      explTimeouts = explicitTimeouts
+    )
   )
 
   /**

pinecone-client/src/main/scala/io/cequence/pineconescala/service/PineconeVectorServiceImpl.scala

@@ -10,7 +10,9 @@ import io.cequence.pineconescala.domain.{PVector, SparseVector}
 import io.cequence.wsclient.JsonUtil.JsonOps
 import io.cequence.wsclient.ResponseImplicits._
 import io.cequence.wsclient.domain.WsRequestContext
-import io.cequence.wsclient.service.ws.{Timeouts, WSRequestHelper}
+import io.cequence.wsclient.service.WSClientEngine
+import io.cequence.wsclient.service.WSClientWithEngineTypes.WSClientWithEngine
+import io.cequence.wsclient.service.ws.{PlayWSClientEngine, Timeouts}
 import play.api.libs.json.Json
 
 import scala.concurrent.{ExecutionContext, Future}
@@ -26,20 +28,24 @@ import scala.concurrent.{ExecutionContext, Future}
  */
 private class PineconeVectorServiceImpl(
   apiKey: String,
-  override val coreUrl: String,
+  coreUrl: String,
   explicitTimeouts: Option[Timeouts] = None
 )(
   implicit val ec: ExecutionContext,
   val materializer: Materializer
 ) extends PineconeVectorService
-    with WSRequestHelper {
+    with WSClientWithEngine {
 
   override protected type PEP = EndPoint
   override protected type PT = Tag
 
-  override protected val requestContext = WsRequestContext(
-    authHeaders = Seq(("Api-Key", apiKey)),
-    explTimeouts = explicitTimeouts
+  // we use play-ws backend
+  override protected val engine: WSClientEngine = PlayWSClientEngine(
+    coreUrl,
+    requestContext =  WsRequestContext(
+      authHeaders = Seq(("Api-Key", apiKey)),
+      explTimeouts = explicitTimeouts
+    )
   )
 
   override def describeIndexStats: Future[IndexStats] =

pinecone-client/src/test/scala/io/cequence/pineconescala/service/ServerlessPineconeVectorServiceImplSpec.scala

@@ -59,9 +59,9 @@ class ServerlessPineconeVectorServiceImplSpec
           vectors = Seq(vector1, vector2),
           namespace = namespace
         )
-        _ = Thread.sleep(1000)
-        _ = Thread.sleep(1000)
-        _ = Thread.sleep(1000)
+
+        _ = Thread.sleep(5000)
+
         fetchedVector <- service.fetch(
           ids = testIds,
           namespace = namespace

project/Dependencies.scala

@@ -1,6 +1,6 @@
 object Dependencies {
 
   object Versions {
-    val wsClient = "0.4.2"
+    val wsClient = "0.5.0"
   }
 }