Use Fs2GrpcRenderContextAsImplicit code generator option

iRevive · iRevive · commit 393791868d72 · 2025-10-30T07:51:15.000+02:00
diff --git a/build.sbt b/build.sbt
@@ -152,19 +152,20 @@ lazy val e2e = (projectMatrix in file("e2e"))
         val output = (Compile / sourceManaged).value / "fs2-grpc" / "disable-trailers"
       }
 
-      val ctxAsImplicitParam = new {
+      val renderContextAsImplicit = new {
         val args = Seq(
-          "serviceSuffix=Fs2GrpcCtxAsImplicitParam",
-          "ctxAsImplicitParam=true"
+          "serviceSuffix=Fs2GrpcRenderContextAsImplicit",
+          "fs2_grpc:render_context_as_implicit"
         ) ++ (if (tlIsScala3.value) Seq("scala3_sources") else Nil)
 
-        val output = (Compile / sourceManaged).value / "fs2-grpc" / "ctx-as-implicit-param"
+        val output = (Compile / sourceManaged).value / "fs2-grpc" / "render-context-as-implicit"
       }
 
       Seq(
         scalapb.gen() -> (Compile / sourceManaged).value / "scalapb",
         genModule(codegenFullName + "$") -> (Compile / sourceManaged).value / "fs2-grpc",
-        (genModule(codegenFullName + "$"), disableTrailers.args) -> disableTrailers.output
+        (genModule(codegenFullName + "$"), disableTrailers.args) -> disableTrailers.output,
+        (genModule(codegenFullName + "$"), renderContextAsImplicit.args) -> renderContextAsImplicit.output
       )
     },
     buildInfoPackage := "fs2.grpc.e2e.buildinfo",
diff --git a/codegen/src/main/scala/fs2/grpc/codegen/Fs2AbstractServicePrinter.scala b/codegen/src/main/scala/fs2/grpc/codegen/Fs2AbstractServicePrinter.scala
@@ -32,7 +32,7 @@ abstract class Fs2AbstractServicePrinter extends Fs2ServicePrinter {
   val service: ServiceDescriptor
   val serviceSuffix: String
   val di: DescriptorImplicits
-  protected[this] val ctxAsImplicitParam: Boolean = false
+  protected[this] val renderContextAsImplicit: Boolean = false
   protected[this] val scala3Sources: Boolean = false
 
   import di._
@@ -58,7 +58,7 @@ abstract class Fs2AbstractServicePrinter extends Fs2ServicePrinter {
   }
 
   protected[this] def renderCtxParameter(): String = {
-    if (ctxAsImplicitParam) {
+    if (renderContextAsImplicit) {
       if (scala3Sources) {
         s")(using ctx: $Ctx"
       } else {
@@ -93,7 +93,7 @@ abstract class Fs2AbstractServicePrinter extends Fs2ServicePrinter {
     val handler = s"$Fs2ServerCallHandler[G](dispatcher, serverOptions).${handleMethod(method)}[$inType, $outType]"
 
     val serviceCall = s"serviceImpl.${method.name}"
-    val invoke = if (ctxAsImplicitParam) {
+    val invoke = if (renderContextAsImplicit) {
       if (scala3Sources) {
         s"$serviceCall(r)(using m)"
       } else {
diff --git a/codegen/src/main/scala/fs2/grpc/codegen/Fs2CodeGenerator.scala b/codegen/src/main/scala/fs2/grpc/codegen/Fs2CodeGenerator.scala
@@ -65,7 +65,7 @@ object Fs2Params {
       copy(disableTrailers = value)
 
     def withRenderContextAsImplicit(value: Boolean): Fs2Params =
-      copy(ctxAsImplicitParam = value)
+      copy(renderContextAsImplicit = value)
 
     def withScala3Sources(value: Boolean): Fs2Params =
       copy(scala3Sources = value)
diff --git a/codegen/src/main/scala/fs2/grpc/codegen/Fs2GrpcExhaustiveTrailersServicePrinter.scala b/codegen/src/main/scala/fs2/grpc/codegen/Fs2GrpcExhaustiveTrailersServicePrinter.scala
@@ -27,7 +27,7 @@ import scalapb.compiler.{DescriptorImplicits, StreamType}
 class Fs2GrpcExhaustiveTrailersServicePrinter(
     val service: ServiceDescriptor,
     val serviceSuffix: String,
-    override val ctxAsImplicitParam: Boolean,
+    override val renderContextAsImplicit: Boolean,
     override val scala3Sources: Boolean,
     val di: DescriptorImplicits
 ) extends Fs2AbstractServicePrinter {
diff --git a/codegen/src/main/scala/fs2/grpc/codegen/Fs2GrpcServicePrinter.scala b/codegen/src/main/scala/fs2/grpc/codegen/Fs2GrpcServicePrinter.scala
@@ -27,7 +27,7 @@ import scalapb.compiler.{DescriptorImplicits, StreamType}
 class Fs2GrpcServicePrinter(
     val service: ServiceDescriptor,
     val serviceSuffix: String,
-    override val ctxAsImplicitParam: Boolean,
+    override val renderContextAsImplicit: Boolean,
     override val scala3Sources: Boolean,
     val di: DescriptorImplicits
 ) extends Fs2AbstractServicePrinter {
diff --git a/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicit.scala.txt b/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicit.scala.txt
@@ -5,7 +5,7 @@ import _root_.cats.syntax.all._
 /** TestService: Example gRPC service used in e2e tests
   * It demonstrates all four RPC shapes.
   */
-trait TestServiceFs2GrpcCtxAsImplicitParam[F[_], A] {
+trait TestServiceFs2GrpcRenderContextAsImplicit[F[_], A] {
   /** Unary RPC: no streaming in either direction
     */
   def noStreaming(request: hello.world.TestMessage)(implicit ctx: A): F[hello.world.TestMessage]
@@ -20,7 +20,7 @@ trait TestServiceFs2GrpcCtxAsImplicitParam[F[_], A] {
   def bothStreaming(request: _root_.fs2.Stream[F, hello.world.TestMessage])(implicit ctx: A): _root_.fs2.Stream[F, hello.world.TestMessage]
 }
 
-object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParam] {
+object TestServiceFs2GrpcRenderContextAsImplicit extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicit] {
   
   def serviceDescriptor: _root_.io.grpc.ServiceDescriptor = hello.world.TestServiceGrpc.SERVICE
   
@@ -29,7 +29,7 @@ object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCom
     channel: _root_.io.grpc.Channel,
     clientAspect: _root_.fs2.grpc.client.ClientAspect[F, G, A],
     clientOptions: _root_.fs2.grpc.client.ClientOptions
-  ): TestServiceFs2GrpcCtxAsImplicitParam[F, A] = new TestServiceFs2GrpcCtxAsImplicitParam[F, A] {
+  ): TestServiceFs2GrpcRenderContextAsImplicit[F, A] = new TestServiceFs2GrpcRenderContextAsImplicit[F, A] {
     def noStreaming(request: hello.world.TestMessage)(implicit ctx: A): F[hello.world.TestMessage] =
       clientAspect.visitUnaryToUnaryCall[hello.world.TestMessage, hello.world.TestMessage](
         _root_.fs2.grpc.client.ClientCallContext(ctx, hello.world.TestServiceGrpc.METHOD_NO_STREAMING),
@@ -58,7 +58,7 @@ object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCom
   
   protected def serviceBindingFull[F[_], G[_]: _root_.cats.effect.Async, A](
     dispatcher: _root_.cats.effect.std.Dispatcher[G],
-    serviceImpl: TestServiceFs2GrpcCtxAsImplicitParam[F, A],
+    serviceImpl: TestServiceFs2GrpcRenderContextAsImplicit[F, A],
     serviceAspect: _root_.fs2.grpc.server.ServiceAspect[F, G, A],
     serverOptions: _root_.fs2.grpc.server.ServerOptions
   ) = {
diff --git a/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitScala3.scala.txt b/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitScala3.scala.txt
@@ -5,7 +5,7 @@ import _root_.cats.syntax.all.*
 /** TestService: Example gRPC service used in e2e tests
   * It demonstrates all four RPC shapes.
   */
-trait TestServiceFs2GrpcCtxAsImplicitParam[F[_], A] {
+trait TestServiceFs2GrpcRenderContextAsImplicit[F[_], A] {
   /** Unary RPC: no streaming in either direction
     */
   def noStreaming(request: hello.world.TestMessage)(using ctx: A): F[hello.world.TestMessage]
@@ -20,7 +20,7 @@ trait TestServiceFs2GrpcCtxAsImplicitParam[F[_], A] {
   def bothStreaming(request: _root_.fs2.Stream[F, hello.world.TestMessage])(using ctx: A): _root_.fs2.Stream[F, hello.world.TestMessage]
 }
 
-object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParam] {
+object TestServiceFs2GrpcRenderContextAsImplicit extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicit] {
   
   def serviceDescriptor: _root_.io.grpc.ServiceDescriptor = hello.world.TestServiceGrpc.SERVICE
   
@@ -29,7 +29,7 @@ object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCom
     channel: _root_.io.grpc.Channel,
     clientAspect: _root_.fs2.grpc.client.ClientAspect[F, G, A],
     clientOptions: _root_.fs2.grpc.client.ClientOptions
-  ): TestServiceFs2GrpcCtxAsImplicitParam[F, A] = new TestServiceFs2GrpcCtxAsImplicitParam[F, A] {
+  ): TestServiceFs2GrpcRenderContextAsImplicit[F, A] = new TestServiceFs2GrpcRenderContextAsImplicit[F, A] {
     def noStreaming(request: hello.world.TestMessage)(using ctx: A): F[hello.world.TestMessage] =
       clientAspect.visitUnaryToUnaryCall[hello.world.TestMessage, hello.world.TestMessage](
         _root_.fs2.grpc.client.ClientCallContext(ctx, hello.world.TestServiceGrpc.METHOD_NO_STREAMING),
@@ -58,7 +58,7 @@ object TestServiceFs2GrpcCtxAsImplicitParam extends _root_.fs2.grpc.GeneratedCom
   
   protected def serviceBindingFull[F[_], G[_]: _root_.cats.effect.Async, A](
     dispatcher: _root_.cats.effect.std.Dispatcher[G],
-    serviceImpl: TestServiceFs2GrpcCtxAsImplicitParam[F, A],
+    serviceImpl: TestServiceFs2GrpcRenderContextAsImplicit[F, A],
     serviceAspect: _root_.fs2.grpc.server.ServiceAspect[F, G, A],
     serverOptions: _root_.fs2.grpc.server.ServerOptions
   ) = {
diff --git a/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitTrailers.scala.txt b/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitTrailers.scala.txt
@@ -5,7 +5,7 @@ import _root_.cats.syntax.all._
 /** TestService: Example gRPC service used in e2e tests
   * It demonstrates all four RPC shapes.
   */
-trait TestServiceFs2GrpcCtxAsImplicitParamTrailers[F[_], A] {
+trait TestServiceFs2GrpcRenderContextAsImplicitTrailers[F[_], A] {
   /** Unary RPC: no streaming in either direction
     */
   def noStreaming(request: hello.world.TestMessage)(implicit ctx: A): F[(hello.world.TestMessage, _root_.io.grpc.Metadata)]
@@ -20,7 +20,7 @@ trait TestServiceFs2GrpcCtxAsImplicitParamTrailers[F[_], A] {
   def bothStreaming(request: _root_.fs2.Stream[F, hello.world.TestMessage])(implicit ctx: A): _root_.fs2.Stream[F, hello.world.TestMessage]
 }
 
-object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParamTrailers] {
+object TestServiceFs2GrpcRenderContextAsImplicitTrailers extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicitTrailers] {
   
   def serviceDescriptor: _root_.io.grpc.ServiceDescriptor = hello.world.TestServiceGrpc.SERVICE
   
@@ -29,7 +29,7 @@ object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.Gene
     channel: _root_.io.grpc.Channel,
     clientAspect: _root_.fs2.grpc.client.ClientAspect[F, G, A],
     clientOptions: _root_.fs2.grpc.client.ClientOptions
-  ): TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A] = new TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A] {
+  ): TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A] = new TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A] {
     def noStreaming(request: hello.world.TestMessage)(implicit ctx: A): F[(hello.world.TestMessage, _root_.io.grpc.Metadata)] =
       clientAspect.visitUnaryToUnaryCallTrailers[hello.world.TestMessage, hello.world.TestMessage](
         _root_.fs2.grpc.client.ClientCallContext(ctx, hello.world.TestServiceGrpc.METHOD_NO_STREAMING),
@@ -58,7 +58,7 @@ object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.Gene
   
   protected def serviceBindingFull[F[_], G[_]: _root_.cats.effect.Async, A](
     dispatcher: _root_.cats.effect.std.Dispatcher[G],
-    serviceImpl: TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A],
+    serviceImpl: TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A],
     serviceAspect: _root_.fs2.grpc.server.ServiceAspect[F, G, A],
     serverOptions: _root_.fs2.grpc.server.ServerOptions
   ) = {
diff --git a/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitTrailersScala3.scala.txt b/e2e/src/test/resources/TestServiceFs2GrpcRenderContextAsImplicitTrailersScala3.scala.txt
@@ -5,7 +5,7 @@ import _root_.cats.syntax.all.*
 /** TestService: Example gRPC service used in e2e tests
   * It demonstrates all four RPC shapes.
   */
-trait TestServiceFs2GrpcCtxAsImplicitParamTrailers[F[_], A] {
+trait TestServiceFs2GrpcRenderContextAsImplicitTrailers[F[_], A] {
   /** Unary RPC: no streaming in either direction
     */
   def noStreaming(request: hello.world.TestMessage)(using ctx: A): F[(hello.world.TestMessage, _root_.io.grpc.Metadata)]
@@ -20,7 +20,7 @@ trait TestServiceFs2GrpcCtxAsImplicitParamTrailers[F[_], A] {
   def bothStreaming(request: _root_.fs2.Stream[F, hello.world.TestMessage])(using ctx: A): _root_.fs2.Stream[F, hello.world.TestMessage]
 }
 
-object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParamTrailers] {
+object TestServiceFs2GrpcRenderContextAsImplicitTrailers extends _root_.fs2.grpc.GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicitTrailers] {
   
   def serviceDescriptor: _root_.io.grpc.ServiceDescriptor = hello.world.TestServiceGrpc.SERVICE
   
@@ -29,7 +29,7 @@ object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.Gene
     channel: _root_.io.grpc.Channel,
     clientAspect: _root_.fs2.grpc.client.ClientAspect[F, G, A],
     clientOptions: _root_.fs2.grpc.client.ClientOptions
-  ): TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A] = new TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A] {
+  ): TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A] = new TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A] {
     def noStreaming(request: hello.world.TestMessage)(using ctx: A): F[(hello.world.TestMessage, _root_.io.grpc.Metadata)] =
       clientAspect.visitUnaryToUnaryCallTrailers[hello.world.TestMessage, hello.world.TestMessage](
         _root_.fs2.grpc.client.ClientCallContext(ctx, hello.world.TestServiceGrpc.METHOD_NO_STREAMING),
@@ -58,7 +58,7 @@ object TestServiceFs2GrpcCtxAsImplicitParamTrailers extends _root_.fs2.grpc.Gene
   
   protected def serviceBindingFull[F[_], G[_]: _root_.cats.effect.Async, A](
     dispatcher: _root_.cats.effect.std.Dispatcher[G],
-    serviceImpl: TestServiceFs2GrpcCtxAsImplicitParamTrailers[F, A],
+    serviceImpl: TestServiceFs2GrpcRenderContextAsImplicitTrailers[F, A],
     serviceAspect: _root_.fs2.grpc.server.ServiceAspect[F, G, A],
     serverOptions: _root_.fs2.grpc.server.ServerOptions
   ) = {
diff --git a/e2e/src/test/scala/fs2/grpc/e2e/Fs2CodeGeneratorRenderContextAsImplicitSpec.scala b/e2e/src/test/scala/fs2/grpc/e2e/Fs2CodeGeneratorRenderContextAsImplicitSpec.scala
@@ -29,13 +29,13 @@ import hello.world._
 
 import scala.io.Source
 
-class Fs2CodeGeneratorCtxAsImplicitParamSpec extends munit.FunSuite {
+class Fs2CodeGeneratorRenderContextAsImplicitSpec extends munit.FunSuite {
 
-  val sourcesGenerated = new File(sourceManaged.getAbsolutePath, "ctx-as-implicit-param/hello/world")
+  val sourcesGenerated = new File(sourceManaged.getAbsolutePath, "render-context-as-implicit/hello/world")
   val suffix = if (scalaVersion.startsWith("3")) "Scala3" else ""
 
   test("code generator outputs correct service file") {
-    val fileName = "TestServiceFs2GrpcCtxAsImplicitParam"
+    val fileName = "TestServiceFs2GrpcRenderContextAsImplicit"
     val testFileName = s"$fileName.scala"
     val referenceName = s"$fileName$suffix.scala"
     val reference = Source.fromResource(s"$referenceName.txt").getLines().mkString("\n")
@@ -45,7 +45,7 @@ class Fs2CodeGeneratorCtxAsImplicitParamSpec extends munit.FunSuite {
   }
 
   test("code generator outputs correct service file for trailers") {
-    val fileName = s"TestServiceFs2GrpcCtxAsImplicitParamTrailers"
+    val fileName = s"TestServiceFs2GrpcRenderContextAsImplicitTrailers"
     val testFileName = s"$fileName.scala"
     val referenceName = s"$fileName$suffix.scala"
     val reference = Source.fromResource(s"$referenceName.txt").getLines().mkString("\n")
@@ -55,11 +55,11 @@ class Fs2CodeGeneratorCtxAsImplicitParamSpec extends munit.FunSuite {
   }
 
   test("implicit of companion resolves") {
-    implicitly[GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParam]]
+    implicitly[GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicit]]
   }
 
   test("implicit of companion resolves trailers") {
-    implicitly[GeneratedCompanion[TestServiceFs2GrpcCtxAsImplicitParamTrailers]]
+    implicitly[GeneratedCompanion[TestServiceFs2GrpcRenderContextAsImplicitTrailers]]
   }
 
 }
diff --git a/plugin/src/main/scala/fs2/grpc/codegen/Fs2GrpcPlugin.scala b/plugin/src/main/scala/fs2/grpc/codegen/Fs2GrpcPlugin.scala
@@ -74,6 +74,22 @@ object Fs2GrpcPlugin extends AutoPlugin {
       case object Fs2GrpcDisableTrailers extends CodeGeneratorOption {
         override def toString: String = "fs2_grpc:disable_trailers"
       }
+
+      /** Renders context in the implicit position.
+        *
+        * Scala 2:
+        * {{{
+        *   def noStreaming(request: Req)(implicit ctx: A): F[Resp]
+        * }}}
+        *
+        * Scala 3, when `Scala3Sources` code generator is used:
+        * {{{
+        *   def noStreaming(request: Req)(using ctx: A): F[Resp]
+        * }}}
+        */
+      case object Fs2GrpcRenderContextAsImplicit extends CodeGeneratorOption {
+        override def toString: String = "fs2_grpc:disable_trailers"
+      }
     }
 
     val scalapbCodeGeneratorOptions =
@@ -90,9 +106,6 @@ object Fs2GrpcPlugin extends AutoPlugin {
         "Suffix used for generated service, e.g. service `Foo` with suffix `Fs2Grpc` results in `FooFs2Grpc`"
       )
 
-    val fs2GrpcRenderContextAsImplicitParam =
-      settingKey[Boolean]("Generate context as an implicit parameter of service methods")
-
     val fs2GrpcOutputPath =
       settingKey[File]("Directory for sources generated by fs2-grpc")
   }
@@ -118,7 +131,6 @@ object Fs2GrpcPlugin extends AutoPlugin {
   override def projectSettings: Seq[Def.Setting[_]] =
     List(
       fs2GrpcServiceSuffix := "Fs2Grpc",
-      fs2GrpcRenderContextAsImplicitParam := false,
       fs2GrpcOutputPath := (Compile / sourceManaged).value / "fs2-grpc",
       scalapbProtobufDirectory := (Compile / sourceManaged).value / "scalapb",
       scalapbCodeGenerators := {
@@ -140,8 +152,7 @@ object Fs2GrpcPlugin extends AutoPlugin {
                   Nil
                 ),
                 scalapbCodeGeneratorOptions.value.filterNot(_ == CodeGeneratorOption.Fs2Grpc).map(_.toString) :+
-                  s"serviceSuffix=${fs2GrpcServiceSuffix.value}" +
-                  s"ctxAsImplicitParam=${fs2GrpcRenderContextAsImplicitParam.value}"
+                  s"serviceSuffix=${fs2GrpcServiceSuffix.value}"
               ),
               fs2GrpcOutputPath.value
             )
