Merge branch 'main' into method-names-match-java-sdk

Author: averymcnab

.github/workflows/ci.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Setup Java (temurin@8)
         id: setup-java-temurin-8
         if: matrix.java == 'temurin@8'
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 8
@@ -103,7 +103,7 @@ jobs:
       - name: Setup Java (temurin@8)
         id: setup-java-temurin-8
         if: matrix.java == 'temurin@8'
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 8
@@ -174,7 +174,7 @@ jobs:
       - name: Setup Java (temurin@8)
         id: setup-java-temurin-8
         if: matrix.java == 'temurin@8'
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 8
@@ -195,7 +195,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        java: [temurin@8]
+        java: [temurin@11]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout current branch (full)
@@ -206,7 +206,7 @@ jobs:
       - name: Setup Java (temurin@8)
         id: setup-java-temurin-8
         if: matrix.java == 'temurin@8'
-        uses: actions/setup-java@v3
+        uses: actions/setup-java@v4
         with:
           distribution: temurin
           java-version: 8
@@ -216,6 +216,19 @@ jobs:
         if: matrix.java == 'temurin@8' && steps.setup-java-temurin-8.outputs.cache-hit == 'false'
         run: sbt +update
 
+      - name: Setup Java (temurin@11)
+        id: setup-java-temurin-11
+        if: matrix.java == 'temurin@11'
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 11
+          cache: sbt
+
+      - name: sbt update
+        if: matrix.java == 'temurin@11' && steps.setup-java-temurin-11.outputs.cache-hit == 'false'
+        run: sbt +update
+
       - name: Generate site
         run: sbt docs/tlSite
 

.scalafmt.conf

@@ -1,4 +1,4 @@
-version = 3.7.15
+version = 3.8.0
 
 style = default
 

CODE_OF_CONDUCT.md

@@ -15,42 +15,33 @@ A thin wrapper for the [Launch Darkly Java server SDK](https://github.com/launch
     val sdkKey = "my-sdk-key"
     val config: LDConfig = new LDConfig.Builder().build()
     val launchDarklyClientResource: Resource[IO, LaunchDarklyClient[IO]] = LaunchDarklyClient.resource[IO](sdkKey, config)
-
+  
     override def run: IO[Unit] = launchDarklyClientResource.use { client =>
       for {
         // Boolean Variant
-        bool <- client.boolVariation[LDUser]("BOOL-FLAG", new LDUser("user-identifier"), defaultValue = false)
+        bool <- client.boolVariation("BOOL-FLAG", new LDContext("context-name"), defaultValue = false)
         _ <- IO.println(s"Boolean Variation: ${bool}")
-
+  
         // String Variant
-        string <- client.stringVariation[LDUser]("STRING-FLAG", new LDUser("user-identifier"), defaultValue = "default-string")
+        string <- client.stringVariation("STRING-FLAG", new LDContext("context-name"), defaultValue = "default-string")
         _ <- IO.println(s"String Variation: ${string}")
-
+  
         // Integer Variant
-        int <- client.intVariation[LDUser]("INTEGER-FLAG", new LDUser("user-identifier"), defaultValue = 0)
+        int <- client.intVariation("INTEGER-FLAG", new LDContext("context-name"), defaultValue = 0)
         _ <- IO.println(s"Integer Variation: ${int}")
-
+  
         // Double Variant
-        double <- client.doubleVariation[LDUser]("DOUBLE-FLAG", new LDUser("user-identifier"), defaultValue = 0.00D)
+        double <- client.doubleVariation("DOUBLE-FLAG", new LDContext("context-name"), defaultValue = 0.00D)
         _ <- IO.println(s"Double Variation: ${double}")
-
+  
         // JSON Variant
-        json <- client.jsonValueVariation[LDUser]("JSON-FLAG", new LDUser("user-identifier"), defaultValue = LDValue.of("{}"))
+        json <- client.jsonValueVariation("JSON-FLAG", new LDContext("context-name"), defaultValue = LDValue.of("{}"))
         _ <- IO.println(s"JSON Variation: ${json}")
       } yield ()
     }
   }
 ```
 
-### LDUser versus LDContext
-
-From the LaunchDarkly [documentation](https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/LDContext.html):
-
-> LDContext is the newer replacement for the previous, less flexible LDUser type. The current LaunchDarkly SDK still supports LDUser, but
-LDContext is now the preferred model and may entirely replace LDUser in the future.
-
-A typeclass exists within Catapult for converting between `LDUser` and `LDContext`, so the variation methods can be called using either, hence the typed variation methods.
-
 ### Flush the buffered event queue
 
 Specifies that any buffered events should be sent as soon as possible, rather than waiting for the next flush interval. 

README.md

@@ -18,7 +18,7 @@ ThisBuild / tlSonatypeUseLegacyHost := false
 ThisBuild / tlSitePublishBranch := Some("main")
 
 val Scala213 = "2.13.12"
-ThisBuild / crossScalaVersions := Seq(Scala213, "3.3.1")
+ThisBuild / crossScalaVersions := Seq(Scala213, "3.3.3")
 ThisBuild / scalaVersion := Scala213 // the default Scala
 
 lazy val root = tlCrossRootProject.aggregate(core, testkit)
@@ -44,8 +44,8 @@ lazy val core = crossProject(JVMPlatform)
     libraryDependencies ++= Seq(
       "org.typelevel" %%% "cats-core" % "2.10.0",
       "org.typelevel" %%% "cats-effect" % "3.5.2",
-      "co.fs2" %%% "fs2-core" % "3.9.2",
-      "com.launchdarkly" % "launchdarkly-java-server-sdk" % "6.2.1",
+      "co.fs2" %%% "fs2-core" % "3.9.4",
+      "com.launchdarkly" % "launchdarkly-java-server-sdk" % "7.1.1",
     ),
   )
 

build.sbt

@@ -41,5 +41,6 @@ object ContextEncoder {
 
   implicit val catapultContextEncoderForLdContext: ContextEncoder[LDContext] = identity(_)
 
+  @deprecated("Use LDContext instead of LDUser", "0.5.0")
   implicit val catapultContextEncoderForLdUser: ContextEncoder[LDUser] = LDContext.fromUser(_)
 }

core/src/main/scala/org.typelevel/catapult/ContextEncoder.scala

@@ -119,21 +119,29 @@ trait LaunchDarklyClient[F[_]] {
 }
 
 object LaunchDarklyClient {
+
+  /** @return a Catapult [[LaunchDarklyClient]] wrapped in [[cats.effect.Resource]], created using the given SDK key and config
+    */
   def resource[F[_]](sdkKey: String, config: LDConfig)(implicit
       F: Async[F]
   ): Resource[F, LaunchDarklyClient[F]] =
     Resource
       .fromAutoCloseable(F.blocking(new LDClient(sdkKey, config)))
-      .map(ldClient => defaultLaunchDarklyClient(ldClient))
+      .map(ldClient => unsafeFromJava(ldClient))
 
+  /** @return a Catapult [[LaunchDarklyClient]] wrapped in [[cats.effect.Resource]], created using the given SDK key and default config
+    */
   def resource[F[_]](sdkKey: String)(implicit F: Async[F]): Resource[F, LaunchDarklyClient[F]] =
     Resource
       .fromAutoCloseable(F.blocking(new LDClient(sdkKey)))
-      .map(ldClient => defaultLaunchDarklyClient(ldClient))
+      .map(ldClient => unsafeFromJava(ldClient))
 
-  private def defaultLaunchDarklyClient[F[_]](
+  /** @return a Catapult [[LaunchDarklyClient]] created using the provided `LDClient`.
+    *         It is the caller's responsibility to close the underlying `LDClient`.
+    */
+  def unsafeFromJava[F[_]](
       ldClient: LDClient
-  )(implicit F: Async[F]): LaunchDarklyClient.Default[F] =
+  )(implicit F: Async[F]): LaunchDarklyClient[F] =
     new LaunchDarklyClient.Default[F] {
 
       override def unsafeWithJavaClient[A](f: LDClient => A): F[A] =
@@ -166,7 +174,7 @@ object LaunchDarklyClient {
         }
     }
 
-  trait Default[F[_]] extends LaunchDarklyClient[F] {
+  private trait Default[F[_]] extends LaunchDarklyClient[F] {
     self =>
     protected def unsafeWithJavaClient[A](f: LDClient => A): F[A]
 

core/src/main/scala/org.typelevel/catapult/LaunchDarklyClient.scala

@@ -1 +1 @@
-sbt.version=1.9.7
+sbt.version=1.9.8

project/build.properties

@@ -1,3 +1,3 @@
-addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.6.1")
-addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.6.1")
-addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.14.0")
+addSbtPlugin("org.typelevel" % "sbt-typelevel" % "0.6.4")
+addSbtPlugin("org.typelevel" % "sbt-typelevel-site" % "0.6.4")
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "1.15.0")

project/plugins.sbt

@@ -17,15 +17,23 @@
 package org.typelevel.catapult
 
 import cats.effect.{Async, Resource}
-import cats.syntax.all._
-import com.launchdarkly.sdk.server.LDConfig
+import cats.syntax.all.*
+import com.launchdarkly.sdk.server.{Components, LDConfig}
 import com.launchdarkly.sdk.server.integrations.TestData
 
 package object testkit {
   def testClient[F[_]](implicit F: Async[F]): Resource[F, (TestData, LaunchDarklyClient[F])] =
     Resource.eval(F.delay(TestData.dataSource())).flatMap { td =>
       LaunchDarklyClient
-        .resource("fake-key", new LDConfig.Builder().dataSource(td).build)
+        .resource(
+          "fake-key",
+          new LDConfig.Builder()
+            .dataSource(td)
+            .events(
+              Components.noEvents() // prevent client from attempting to send events to LD servers
+            )
+            .build,
+        )
         .tupleLeft(td)
     }
 }