Merge pull request #89 from typelevel/method-names-match-java-sdk

Rename client methods

Author: averymcnab

README.md

@@ -35,7 +35,7 @@ A thin wrapper for the [Launch Darkly Java server SDK](https://github.com/launch
         _ <- IO.println(s"Double Variation: ${double}")
 
         // JSON Variant
-        json <- client.jsonVariation("JSON-FLAG", new LDContext("context-name"), defaultValue = LDValue.of("{}"))
+        json <- client.jsonValueVariation("JSON-FLAG", new LDContext("context-name"), defaultValue = LDValue.of("{}"))
         _ <- IO.println(s"JSON Variation: ${json}")
       } yield ()
     }

build.sbt

@@ -1,5 +1,5 @@
 // https://typelevel.org/sbt-typelevel/faq.html#what-is-a-base-version-anyway
-ThisBuild / tlBaseVersion := "0.4" // your current series x.y
+ThisBuild / tlBaseVersion := "0.5" // your current series x.y
 
 ThisBuild / organization := "org.typelevel"
 ThisBuild / organizationName := "Typelevel"

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

@@ -81,19 +81,35 @@ trait LaunchDarklyClient[F[_]] {
     * @return the flag value, suspended in the `F` effect. If evaluation fails for any reason, returns the default value.
     * @see [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/server/interfaces/LDClientInterface.html#jsonValueVariation(java.lang.String,com.launchdarkly.sdk.LDContext,com.launchdarkly.sdk.LDValue) LDClientInterface#jsonValueVariation]]
     */
-  def jsonVariation[Ctx: ContextEncoder](
+  def jsonValueVariation[Ctx: ContextEncoder](
       featureKey: String,
       context: Ctx,
       defaultValue: LDValue,
   ): F[LDValue]
 
+  @deprecated("use jsonValueVariation", "0.5.0")
+  final def jsonVariation[Ctx: ContextEncoder](
+      featureKey: String,
+      context: Ctx,
+      defaultValue: LDValue,
+  ): F[LDValue] = jsonValueVariation(featureKey, context, defaultValue)
+
   /** @param featureKey   the key of the flag to be evaluated
     * @param context      the context against which the flag is being evaluated
     * @tparam Ctx the type representing the context; this can be [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/LDContext.html LDContext]], [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/LDUser.html LDUser]], or any type with a [[ContextEncoder]] instance in scope.
     * @return A `Stream` of [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/server/interfaces/FlagValueChangeEvent.html FlagValueChangeEvent]] instances representing changes to the value of the flag in the provided context. Note: if the flag value changes multiple times in quick succession, some intermediate values may be missed; for example, a change from 1` to `2` to `3` may be represented only as a change from `1` to `3`
     * @see [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/server/interfaces/FlagTracker.html FlagTracker]]
     */
-  def listen[Ctx: ContextEncoder](featureKey: String, context: Ctx): Stream[F, FlagValueChangeEvent]
+  def trackFlagValueChanges[Ctx: ContextEncoder](
+      featureKey: String,
+      context: Ctx,
+  ): Stream[F, FlagValueChangeEvent]
+
+  @deprecated("use trackFlagValueChanges", "0.5.0")
+  final def listen[Ctx: ContextEncoder](
+      featureKey: String,
+      context: Ctx,
+  ): Stream[F, FlagValueChangeEvent] = trackFlagValueChanges(featureKey, context)
 
   /** @see [[https://javadoc.io/doc/com.launchdarkly/launchdarkly-java-server-sdk/latest/com/launchdarkly/sdk/server/interfaces/LDClientInterface.html#flush() LDClientInterface#flush]]
     */
@@ -131,7 +147,7 @@ object LaunchDarklyClient {
       override def unsafeWithJavaClient[A](f: LDClient => A): F[A] =
         F.blocking(f(ldClient))
 
-      override def listen[Ctx](
+      override def trackFlagValueChanges[Ctx](
           featureKey: String,
           context: Ctx,
       )(implicit ctxEncoder: ContextEncoder[Ctx]): Stream[F, FlagValueChangeEvent] =
@@ -188,7 +204,7 @@ object LaunchDarklyClient {
     )(implicit ctxEncoder: ContextEncoder[Ctx]): F[Double] =
       unsafeWithJavaClient(_.doubleVariation(featureKey, ctxEncoder.encode(context), default))
 
-    override def jsonVariation[Ctx](
+    override def jsonValueVariation[Ctx](
         featureKey: String,
         context: Ctx,
         default: LDValue,
@@ -202,10 +218,10 @@ object LaunchDarklyClient {
         self.unsafeWithJavaClient(f)
       )
 
-      override def listen[Ctx](featureKey: String, context: Ctx)(implicit
+      override def trackFlagValueChanges[Ctx](featureKey: String, context: Ctx)(implicit
           ctxEncoder: ContextEncoder[Ctx]
       ): Stream[G, FlagValueChangeEvent] =
-        self.listen(featureKey, context).translate(fk)
+        self.trackFlagValueChanges(featureKey, context).translate(fk)
 
       override def flush: G[Unit] = fk(self.flush)
     }

testkit/src/test/scala/org/typelevel/catapult/VariationTests.scala

@@ -52,7 +52,7 @@ object VariationTests extends SimpleIOSuite {
           received <- IO.ref[Chain[FlagValueChangeEvent]](Chain.empty)
           _ <- sup.supervise(
             client
-              .listen("foo", LDContext.create("testContext"))
+              .trackFlagValueChanges("foo", LDContext.create("testContext"))
               .evalTap(event => received.update(_.append(event)))
               .compile
               .drain