Smithy4s integration (#58)

Co-authored-by: ghostbuster91 <[email protected]>
Co-authored-by: Jakub Kozłowski <[email protected]>
Co-authored-by: Olivier Mélois <[email protected]>

Author: 3 people

.envrc

@@ -0,0 +1 @@
+use flake

.scalafmt.conf

@@ -1,6 +1,22 @@
 version = "3.8.0"
 runner.dialect = scala213
 maxColumn = 120
+
+rewrite {
+  rules = [
+    ExpandImportSelectors,
+    Imports
+  ]
+
+  imports {
+    groups = [
+      ["[a-z].*"],
+      ["java\\..*", "scala\\..*"]
+    ]
+    sort = original
+  }
+}
+
 fileOverride {
   "glob:**/fs2/src/**" {
      runner.dialect = scala213source3

README.md

@@ -39,3 +39,27 @@ override def ivyDeps = super.ivyDeps() ++ Agg(ivy"tech.neander::jsonrpclib-fs2::
 **/!\ Please be aware that this library is in its early days and offers strictly no guarantee with regards to backward compatibility**
 
 See the modules/examples folder.
+
+## Smithy Integration
+
+You can now use `jsonrpclib` directly with [Smithy](https://smithy.io/) and [smithy4s](https://disneystreaming.github.io/smithy4s/), enabling type-safe, 
+schema-first JSON-RPC APIs with minimal boilerplate.
+
+This integration is supported by the following modules:
+
+```scala
+// Defines the Smithy protocol for JSON-RPC
+libraryDependencies += "tech.neander" % "jsonrpclib-smithy" % <version>
+
+// Provides smithy4s client/server bindings for JSON-RPC
+libraryDependencies += "tech.neander" %%% "jsonrpclib-smithy4s" % <version>
+```
+
+With these modules, you can:
+
+- Annotate your Smithy operations with `@jsonRpcRequest` or `@jsonRpcNotification`
+- Generate client and server interfaces using smithy4s
+- Use ClientStub to invoke remote services over JSON-RPC
+- Use ServerEndpoints to expose service implementations via a Channel
+
+This allows you to define your API once in Smithy and interact with it as a fully typed JSON-RPC service—without writing manual encoders, decoders, or dispatch logic.

build.sbt

@@ -16,33 +16,46 @@ inThisBuild(
 )
 
 val scala213 = "2.13.16"
-val scala3 = "3.3.5"
+val scala3 = "3.3.6"
+val jdkVersion = 11
 val allScalaVersions = List(scala213, scala3)
 val jvmScalaVersions = allScalaVersions
 val jsScalaVersions = allScalaVersions
 val nativeScalaVersions = allScalaVersions
 
 val fs2Version = "3.12.0"
 
+ThisBuild / versionScheme := Some("early-semver")
 ThisBuild / tpolecatOptionsMode := DevMode
 
 val commonSettings = Seq(
   libraryDependencies ++= Seq(
     "com.disneystreaming" %%% "weaver-cats" % "0.8.4" % Test
   ),
   mimaPreviousArtifacts := Set(
-    organization.value %%% name.value % "0.0.7"
+    // organization.value %%% name.value % "0.0.7"
   ),
-  scalacOptions += "-java-output-version:8"
+  scalacOptions ++= {
+    CrossVersion.partialVersion(scalaVersion.value) match {
+      case Some((2, _)) => Seq(s"-release:$jdkVersion")
+      case _            => Seq(s"-java-output-version:$jdkVersion")
+    }
+  },
+)
+
+val commonJvmSettings = Seq(
+  javacOptions ++= Seq("--release", jdkVersion.toString)
 )
 
 val core = projectMatrix
   .in(file("modules") / "core")
   .jvmPlatform(
     jvmScalaVersions,
-    Test / unmanagedSourceDirectories ++= Seq(
-      (projectMatrixBaseDirectory.value / "src" / "test" / "scalajvm-native").getAbsoluteFile
-    )
+    Seq(
+      Test / unmanagedSourceDirectories ++= Seq(
+        (projectMatrixBaseDirectory.value / "src" / "test" / "scalajvm-native").getAbsoluteFile
+      )
+    ) ++ commonJvmSettings
   )
   .jsPlatform(jsScalaVersions)
   .nativePlatform(
@@ -56,13 +69,13 @@ val core = projectMatrix
     name := "jsonrpclib-core",
     commonSettings,
     libraryDependencies ++= Seq(
-      "com.github.plokhotnyuk.jsoniter-scala" %%% "jsoniter-scala-macros" % "2.30.2"
+      "com.github.plokhotnyuk.jsoniter-scala" %%% "jsoniter-scala-circe" % "2.30.2"
     )
   )
 
 val fs2 = projectMatrix
   .in(file("modules") / "fs2")
-  .jvmPlatform(jvmScalaVersions)
+  .jvmPlatform(jvmScalaVersions, commonJvmSettings)
   .jsPlatform(jsScalaVersions)
   .nativePlatform(nativeScalaVersions)
   .disablePlugins(AssemblyPlugin)
@@ -71,19 +84,97 @@ val fs2 = projectMatrix
     name := "jsonrpclib-fs2",
     commonSettings,
     libraryDependencies ++= Seq(
-      "co.fs2" %%% "fs2-core" % fs2Version
+      "co.fs2" %%% "fs2-core" % fs2Version,
+      "io.circe" %%% "circe-generic" % "0.14.7" % Test
     )
   )
 
+val smithy = projectMatrix
+  .in(file("modules") / "smithy")
+  .jvmPlatform(false)
+  .disablePlugins(AssemblyPlugin, MimaPlugin)
+  .enablePlugins(SmithyTraitCodegenPlugin)
+  .settings(
+    name := "jsonrpclib-smithy",
+    commonJvmSettings,
+    smithyTraitCodegenDependencies := List(Dependencies.alloy.core),
+    smithyTraitCodegenJavaPackage := "jsonrpclib",
+    smithyTraitCodegenNamespace := "jsonrpclib"
+  )
+
+val smithyTests = projectMatrix
+  .in(file("modules/smithy-tests"))
+  .jvmPlatform(Seq(scala213))
+  .dependsOn(smithy)
+  .settings(
+    publish / skip := true,
+    libraryDependencies ++= Seq(
+      "com.disneystreaming" %%% "weaver-cats" % "0.8.4" % Test
+    )
+  )
+  .disablePlugins(MimaPlugin)
+
+lazy val buildTimeProtocolDependency =
+  /** By default, smithy4sInternalDependenciesAsJars doesn't contain the jars in the "smithy4s" configuration. We have
+    * to add them manually - this is the equivalent of a "% Smithy4s"-scoped dependency.
+    *
+    * Ideally, this would be
+    * {{{
+    * (Compile / smithy4sInternalDependenciesAsJars) ++=
+    *   Smithy4s / smithy4sInternalDependenciesAsJars).value.map(_.data)
+    * }}}
+    *
+    * but that doesn't work because the Smithy4s configuration doesn't extend from Compile so it doesn't have the
+    * `internalDependencyAsJars` setting.
+    */
+  Compile / smithy4sInternalDependenciesAsJars ++=
+    (smithy.jvm(autoScalaLibrary = false) / Compile / fullClasspathAsJars).value.map(_.data)
+
+val smithy4s = projectMatrix
+  .in(file("modules") / "smithy4s")
+  .jvmPlatform(jvmScalaVersions, commonJvmSettings)
+  .jsPlatform(jsScalaVersions)
+  .nativePlatform(Seq(scala3))
+  .disablePlugins(AssemblyPlugin)
+  .enablePlugins(Smithy4sCodegenPlugin)
+  .dependsOn(core)
+  .settings(
+    name := "jsonrpclib-smithy4s",
+    commonSettings,
+    mimaPreviousArtifacts := Set.empty,
+    libraryDependencies ++= Seq(
+      "com.disneystreaming.smithy4s" %%% "smithy4s-json" % smithy4sVersion.value
+    ),
+    buildTimeProtocolDependency
+  )
+
+val smithy4sTests = projectMatrix
+  .in(file("modules") / "smithy4s-tests")
+  .jvmPlatform(jvmScalaVersions, commonJvmSettings)
+  .jsPlatform(jsScalaVersions)
+  .nativePlatform(Seq(scala3))
+  .disablePlugins(AssemblyPlugin)
+  .enablePlugins(Smithy4sCodegenPlugin)
+  .dependsOn(smithy4s, fs2 % Test)
+  .settings(
+    commonSettings,
+    publish / skip := true,
+    libraryDependencies ++= Seq(
+      "io.circe" %%% "circe-generic" % "0.14.7"
+    ),
+    buildTimeProtocolDependency
+  )
+
 val exampleServer = projectMatrix
   .in(file("modules") / "examples/server")
-  .jvmPlatform(List(scala213))
+  .jvmPlatform(List(scala213), commonJvmSettings)
   .dependsOn(fs2)
   .settings(
     commonSettings,
     publish / skip := true,
     libraryDependencies ++= Seq(
-      "co.fs2" %%% "fs2-io" % fs2Version
+      "co.fs2" %%% "fs2-io" % fs2Version,
+      "io.circe" %%% "circe-generic" % "0.14.7"
     )
   )
   .disablePlugins(MimaPlugin)
@@ -95,38 +186,93 @@ val exampleClient = projectMatrix
     Seq(
       fork := true,
       envVars += "SERVER_JAR" -> (exampleServer.jvm(scala213) / assembly).value.toString
-    )
+    ) ++ commonJvmSettings
   )
   .disablePlugins(AssemblyPlugin)
   .dependsOn(fs2)
   .settings(
     commonSettings,
     publish / skip := true,
     libraryDependencies ++= Seq(
-      "co.fs2" %%% "fs2-io" % fs2Version
+      "co.fs2" %%% "fs2-io" % fs2Version,
+      "io.circe" %%% "circe-generic" % "0.14.7"
     )
   )
   .disablePlugins(MimaPlugin)
 
+val exampleSmithyShared = projectMatrix
+  .in(file("modules") / "examples/smithyShared")
+  .jvmPlatform(List(scala213), commonJvmSettings)
+  .dependsOn(smithy4s, fs2)
+  .enablePlugins(Smithy4sCodegenPlugin)
+  .settings(
+    commonSettings,
+    publish / skip := true,
+    buildTimeProtocolDependency
+  )
+  .disablePlugins(MimaPlugin)
+
+val exampleSmithyServer = projectMatrix
+  .in(file("modules") / "examples/smithyServer")
+  .jvmPlatform(List(scala213), commonJvmSettings)
+  .dependsOn(exampleSmithyShared)
+  .settings(
+    commonSettings,
+    publish / skip := true,
+    libraryDependencies ++= Seq(
+      "co.fs2" %%% "fs2-io" % fs2Version
+    ),
+    assembly / assemblyMergeStrategy := {
+      case PathList("META-INF", "smithy", _*)           => MergeStrategy.concat
+      case PathList("jsonrpclib", "package.class")      => MergeStrategy.first
+      case PathList("META-INF", xs @ _*) if xs.nonEmpty => MergeStrategy.discard
+      case x                                            => MergeStrategy.first
+    }
+  )
+  .disablePlugins(MimaPlugin)
+
+val exampleSmithyClient = projectMatrix
+  .in(file("modules") / "examples/smithyClient")
+  .jvmPlatform(
+    List(scala213),
+    Seq(
+      fork := true,
+      envVars += "SERVER_JAR" -> (exampleSmithyServer.jvm(scala213) / assembly).value.toString
+    ) ++ commonJvmSettings
+  )
+  .dependsOn(exampleSmithyShared)
+  .settings(
+    commonSettings,
+    publish / skip := true,
+    libraryDependencies ++= Seq(
+      "co.fs2" %%% "fs2-io" % fs2Version
+    )
+  )
+  .disablePlugins(MimaPlugin, AssemblyPlugin)
+
 val root = project
   .in(file("."))
   .settings(
     publish / skip := true
   )
   .disablePlugins(MimaPlugin, AssemblyPlugin)
-  .aggregate(List(core, fs2, exampleServer, exampleClient).flatMap(_.projectRefs): _*)
-
-// The core compiles are a workaround for https://github.com/plokhotnyuk/jsoniter-scala/issues/564
-// when we switch to SN 0.5, we can use `makeWithSkipNestedOptionValues` instead: https://github.com/plokhotnyuk/jsoniter-scala/issues/564#issuecomment-2787096068
-val compileCoreModules = {
-  for {
-    scalaVersionSuffix <- List("", "3")
-    platformSuffix <- List("", "JS", "Native")
-    task <- List("compile", "package")
-  } yield s"core$platformSuffix$scalaVersionSuffix/$task"
-}.mkString(";")
+  .aggregate(
+    List(
+      core,
+      fs2,
+      exampleServer,
+      exampleClient,
+      smithy,
+      smithyTests,
+      smithy4s,
+      smithy4sTests,
+      exampleSmithyShared,
+      exampleSmithyServer,
+      exampleSmithyClient
+    ).flatMap(_.projectRefs): _*
+  )
 
 addCommandAlias(
   "ci",
-  s"$compileCoreModules;test;scalafmtCheckAll;mimaReportBinaryIssues"
+  s"compile;test;scalafmtCheckAll;mimaReportBinaryIssues"
 )