feat: Implement SentryModule and PureConfig integration (#192)

Author: jakubjanecek

build.sbt

@@ -44,6 +44,8 @@ lazy val root = project
     monixCatnapMicrometer,
     monixCatnapPureConfig,
     pureConfig,
+    sentry,
+    sentryPureConfig,
     sslConfig
   )
   .settings(
@@ -374,6 +376,23 @@ lazy val pureConfig = project
     libraryDependencies += Dependencies.pureConfig
   )
 
+lazy val sentry = project
+  .in(file("sentry"))
+  .settings(BuildSettings.common)
+  .settings(
+    name := "sst-sentry",
+    libraryDependencies += Dependencies.sentry
+  )
+
+lazy val sentryPureConfig = project
+  .in(file("sentry-pureconfig"))
+  .dependsOn(sentry)
+  .settings(BuildSettings.common)
+  .settings(
+    name := "sst-sentry-pureconfig",
+    libraryDependencies += Dependencies.pureConfig
+  )
+
 lazy val site = project
   .in(file("site"))
   .enablePlugins(
@@ -395,6 +414,7 @@ lazy val site = project
     http4sClientMonixCatnap,
     monixCatnapPureConfig,
     micrometerJmxPureConfig,
+    sentry,
     sslConfig
   )
   .settings(BuildSettings.common)

http4s-server-blaze/src/main/scala/com/avast/sst/http4s/server/Http4sBlazeServerModule.scala

@@ -9,6 +9,7 @@ import org.http4s.server.blaze.BlazeServerBuilder
 
 import scala.concurrent.ExecutionContext
 import scala.concurrent.duration.Duration
+
 object Http4sBlazeServerModule {
 
   /** Makes [[org.http4s.server.Server]] (Blaze) initialized with the given config and [[org.http4s.HttpApp]].

project/Dependencies.scala

@@ -29,6 +29,7 @@ object Dependencies {
   val scalafixScaluzzi = "com.github.vovapolu" %% "scaluzzi" % "0.1.3"
   val scalafixSortImports = "com.nequissimus" %% "sort-imports" % "0.3.2"
   val scalaTest = "org.scalatest" %% "scalatest" % "3.1.1"
+  val sentry = "io.sentry" % "sentry" % "1.7.30"
   val silencer = "com.github.ghik" % "silencer-plugin" % Versions.silencer cross CrossVersion.full
   val silencerLib = "com.github.ghik" % "silencer-lib" % Versions.silencer cross CrossVersion.full
   val slf4jApi = "org.slf4j" % "slf4j-api" % "1.7.30"

sentry-pureconfig/src/main/scala/com/avast/sst/sentry/pureconfig/ConfigReaders.scala

@@ -0,0 +1,14 @@
+package com.avast.sst.sentry.pureconfig
+
+import com.avast.sst.sentry.SentryConfig
+import pureconfig.ConfigReader
+import pureconfig.generic.ProductHint
+import pureconfig.generic.semiauto.deriveReader
+
+trait ConfigReaders {
+
+  implicit protected def hint[T]: ProductHint[T] = ProductHint.default
+
+  implicit val sentryConfigReader: ConfigReader[SentryConfig] = deriveReader
+
+}

sentry-pureconfig/src/main/scala/com/avast/sst/sentry/pureconfig/implicits.scala

@@ -0,0 +1,20 @@
+package com.avast.sst.sentry.pureconfig
+
+import pureconfig.ConfigFieldMapping
+import pureconfig.generic.ProductHint
+
+/** Contains [[pureconfig.ConfigReader]] instances with default "kebab-case" naming convention. */
+object implicits extends ConfigReaders {
+
+  /** Contains [[pureconfig.ConfigReader]] instances with "kebab-case" naming convention.
+    *
+    * This is alias for the default `implicits._` import.
+    */
+  object KebabCase extends ConfigReaders
+
+  /** Contains [[pureconfig.ConfigReader]] instances with "camelCase" naming convention. */
+  object CamelCase extends ConfigReaders {
+    implicit override protected def hint[T]: ProductHint[T] = ProductHint(ConfigFieldMapping(pureconfig.CamelCase, pureconfig.CamelCase))
+  }
+
+}

sentry/src/main/scala/com/avast/sst/sentry/SentryConfig.scala

@@ -0,0 +1,11 @@
+package com.avast.sst.sentry
+
+final case class SentryConfig(
+    dsn: String,
+    release: Option[String] = None,
+    environment: Option[String] = None,
+    distribution: Option[String] = None,
+    serverName: Option[String] = None,
+    tags: Map[String, String] = Map.empty,
+    stacktraceAppPackages: List[String] = List.empty
+)

sentry/src/main/scala/com/avast/sst/sentry/SentryModule.scala

@@ -0,0 +1,45 @@
+package com.avast.sst.sentry
+
+import cats.effect.{Resource, Sync}
+import io.sentry.{SentryClient, SentryClientFactory}
+
+import scala.jdk.CollectionConverters._
+import scala.reflect.ClassTag
+
+object SentryModule {
+
+  /** Makes [[io.sentry.SentryClient]] initialized with the given config. */
+  def make[F[_]: Sync](config: SentryConfig): Resource[F, SentryClient] = {
+    Resource.make {
+      Sync[F].delay {
+        val dsnCustomizations = s"${config.stacktraceAppPackages.mkString("stacktrace.app.packages=", ",", "")}"
+        val finalDsn = if (dsnCustomizations.nonEmpty) s"${config.dsn}?$dsnCustomizations" else config.dsn
+        val sentryClient = SentryClientFactory.sentryClient(finalDsn)
+        config.release.foreach(sentryClient.setRelease)
+        config.environment.foreach(sentryClient.setEnvironment)
+        config.distribution.foreach(sentryClient.setDist)
+        config.serverName.foreach(sentryClient.setServerName)
+        sentryClient.setTags(config.tags.asJava)
+        sentryClient
+      }
+    }(sentry => Sync[F].delay(sentry.closeConnection()))
+  }
+
+  /** Makes [[io.sentry.SentryClient]] initialized with the given config and overrides the `release` property
+    * with `Implementation-Version` from the `MANIFEST.MF` file inside the same JAR (package) as the `Main` class.
+    */
+  def makeWithReleaseFromPackage[F[_]: Sync, Main: ClassTag](config: SentryConfig): Resource[F, SentryClient] = {
+    for {
+      customizedConfig <- Resource.liftF {
+        Sync[F].delay {
+          for {
+            pkg <- Option(implicitly[ClassTag[Main]].runtimeClass.getPackage)
+            v <- Option(pkg.getImplementationVersion)
+          } yield config.copy(release = Some(v))
+        }
+      }
+      sentryClient <- make[F](customizedConfig.getOrElse(config))
+    } yield sentryClient
+  }
+
+}

site/docs/subprojects/sentry.md

@@ -0,0 +1,23 @@
+---
+layout: docs
+title: "Sentry"
+---
+
+# Sentry
+
+`libraryDependencies += "com.avast" %% "sst-sentry" % "@VERSION@"`
+
+This subproject allows you to initialize `SentryClient` from a configuration case class. There are two `make*` methods. The one called `make`
+does everything according to the configuration. The one called `makeWithReleaseFromPackage` adds a bit of clever behavior because it reads
+the `Implementation-Version` property from the `MANIFEST.MF` file from the JAR (package) of the respective `Main` class and uses it to override
+the `release` property of Sentry. This allows you to automatically propage the version of your application to Sentry.
+
+Initialization of the `SentryClient` is side-effectful so it is wrapped in `Resource[F, SentryClient]` and `F` is `Sync`.
+
+```scala mdoc:silent
+import com.avast.sst.sentry._
+import zio.interop.catz._
+import zio.Task
+
+val sentry = SentryModule.make[Task](SentryConfig("<dsn>"))
+```

site/menu.yml

@@ -28,3 +28,5 @@ options:
         url: subprojects/flyway
       - title: monix-catnap - Circuit Breaker
         url: subprojects/monix-catnap
+      - title: Sentry
+        url: subprojects/sentry