Merge pull request #1037 from iRevive/feature/seal-public-traits

Author: iRevive

benchmarks/src/main/scala/org/typelevel/otel4s/benchmarks/BatchSpanProcessorBenchmark.scala

@@ -155,7 +155,7 @@ object BatchSpanProcessorBenchmark {
       import org.typelevel.otel4s.sdk.trace.exporter.SpanExporter
       import org.typelevel.otel4s.sdk.trace.processor.BatchSpanProcessor
 
-      val exporter: SpanExporter[IO] = new SpanExporter[IO] {
+      val exporter: SpanExporter[IO] = new SpanExporter.Unsealed[IO] {
         def name: String = s"DelayExporter($delay)"
         def exportSpans[G[_]: Foldable](spans: G[SpanData]): IO[Unit] = IO.sleep(delay)
         def flush: IO[Unit] = IO.unit

benchmarks/src/main/scala/org/typelevel/otel4s/benchmarks/MultiSpanProcessorBenchmark.scala

@@ -109,10 +109,10 @@ object MultiSpanProcessorBenchmark {
       import org.typelevel.otel4s.sdk.trace.data.{SpanData, StatusData}
       import org.typelevel.otel4s.sdk.trace.processor.SpanProcessor
 
-      val processor: SpanProcessor[IO] = new SpanProcessor[IO] {
+      val processor: SpanProcessor[IO] = new SpanProcessor.Unsealed[IO] {
         def name: String = "Noop"
-        val onStart: SpanProcessor.OnStart[IO] = (_, _) => IO.unit
-        val onEnd: SpanProcessor.OnEnd[IO] = _ => IO.unit
+        val onStart: SpanProcessor.OnStart[IO] = SpanProcessor.OnStart((_, _) => IO.unit)
+        val onEnd: SpanProcessor.OnEnd[IO] = SpanProcessor.OnEnd(_ => IO.unit)
         def forceFlush: IO[Unit] = IO.unit
       }
 

buildscripts/semantic-convention/templates/registry/otel4s/metrics/SemanticMetrics.scala.j2

@@ -166,7 +166,7 @@ object {{ object_name }} {
   {%- elif params.stable_only == false and metric is stable %}
   @deprecated("Use stable `{{ stableRef(metric) }}` instead.", "")
   {%- endif %}
-  object {{ objectName(metric) }} extends MetricSpec {
+  object {{ objectName(metric) }} extends MetricSpec.Unsealed {
     {%- if params.stable_only == false -%}
     {%- set metric_attributes = metric.attributes %}
     {% else %}

core/all/src/main/scala/org/typelevel/otel4s/Otel4s.scala

@@ -22,7 +22,7 @@ import org.typelevel.otel4s.context.propagation.ContextPropagators
 import org.typelevel.otel4s.metrics.MeterProvider
 import org.typelevel.otel4s.trace.TracerProvider
 
-trait Otel4s[F[_]] {
+sealed trait Otel4s[F[_]] {
 
   /** The type of context used by telemetry components. */
   type Ctx
@@ -42,3 +42,7 @@ trait Otel4s[F[_]] {
   /** A utility for accessing and modifying [[baggage.Baggage `Baggage`]]. */
   def baggageManager: BaggageManager[F]
 }
+
+object Otel4s {
+  private[otel4s] trait Unsealed[F[_]] extends Otel4s[F]
+}

core/common/src/main/scala/org/typelevel/otel4s/baggage/BaggageManager.scala

@@ -34,7 +34,7 @@ import cats.mtl.Local
   * BaggageManager[F].modifiedScope(_.updated("user_id", "uid"))(io)
   *   }}}
   */
-trait BaggageManager[F[_]] {
+sealed trait BaggageManager[F[_]] {
 
   // TODO: remove after finishing migrating away from Local
   protected def applicative: Applicative[F]
@@ -73,6 +73,8 @@ trait BaggageManager[F[_]] {
 }
 
 object BaggageManager {
+  private[otel4s] trait Unsealed[F[_]] extends BaggageManager[F]
+
   def apply[F[_]](implicit ev: BaggageManager[F]): BaggageManager[F] = ev
 
   @deprecated("BaggageManager no longer extends Local", since = "otel4s 0.13.0")

core/common/src/main/scala/org/typelevel/otel4s/context/Contextual.scala

@@ -17,7 +17,7 @@
 package org.typelevel.otel4s
 package context
 
-trait Contextual[C] { outer =>
+sealed trait Contextual[C] { outer =>
 
   /** The type of [[context.Key `Key`]] used by contexts of type `C`. */
   type Key[A] <: context.Key[A]
@@ -60,6 +60,7 @@ trait Contextual[C] { outer =>
 }
 
 object Contextual {
+  private[otel4s] trait Unsealed[C] extends Contextual[C]
 
   /** A type alias for a [[`Contextual`]] explicitly parameterized by its [[Contextual.Key `Key`]] type.
     */

core/common/src/main/scala/org/typelevel/otel4s/context/Key.scala

@@ -24,7 +24,7 @@ import cats.Show
   * @note
   *   Implementations MUST treat different instances as non-equal.
   */
-trait Key[A] {
+sealed trait Key[A] {
 
   /** The debug name of the key. */
   val name: String
@@ -33,19 +33,21 @@ trait Key[A] {
 }
 
 object Key {
+  private[otel4s] trait Unsealed[A] extends Key[A]
 
   /** Something that provides context keys.
     *
     * @tparam K
     *   the type of keys
     */
-  trait Provider[F[_], K[X] <: Key[X]] {
+  sealed trait Provider[F[_], K[X] <: Key[X]] {
 
     /** Creates a unique key with the given (debug) name. */
     def uniqueKey[A](name: String): F[K[A]]
   }
 
   object Provider {
+    private[otel4s] trait Unsealed[F[_], K[X] <: Key[X]] extends Provider[F, K]
 
     /** Summons a [[`Provider`]] that is available implicitly. */
     def apply[F[_], K[X] <: Key[X]](implicit

core/common/src/main/scala/org/typelevel/otel4s/context/LocalProvider.scala

@@ -49,14 +49,15 @@ val provider = LocalProvider[${F}, ${Ctx}]
 
 val provider = LocalProvider[IO, ${Ctx}]
 """)
-trait LocalProvider[F[_], Ctx] {
+sealed trait LocalProvider[F[_], Ctx] {
 
   /** Creates a [[cats.mtl.Local Local]] instance. The method is invoked once per creation of the Otel4s instance.
     */
   def local: F[Local[F, Ctx]]
 }
 
 object LocalProvider extends LocalProviderLowPriority {
+  private[otel4s] trait Unsealed[F[_], Ctx] extends LocalProvider[F, Ctx]
 
   def apply[F[_], C](implicit ev: LocalProvider[F, C]): LocalProvider[F, C] = ev
 

core/common/src/main/scala/org/typelevel/otel4s/context/propagation/PassThroughPropagator.scala

@@ -23,7 +23,7 @@ import org.typelevel.otel4s.context.syntax._
 /** A [[TextMapPropagator]] that extracts a specified collection of fields and stores them in a context, and extracts
   * them from a context later for injection. It does not interact with telemetry.
   */
-final class PassThroughPropagator[Ctx, K[X] <: Key[X]] private (
+private final class PassThroughPropagator[Ctx, K[X] <: Key[X]] private (
     val fields: Iterable[String],
     entriesKey: K[List[(String, String)]]
 )(implicit c: Contextual.Keyed[Ctx, K])

core/common/src/test/scala/org/typelevel/otel4s/context/vault/VaultContext.scala

@@ -51,7 +51,7 @@ object VaultContext {
   final class Key[A] private (
       val name: String,
       private[VaultContext] val underlying: VaultKey[A]
-  ) extends context.Key[A]
+  ) extends context.Key.Unsealed[A]
 
   object Key {
 
@@ -60,15 +60,15 @@ object VaultContext {
       VaultKey.newKey[F, A].map(new Key[A](name, _))
 
     implicit def provider[F[_]: Functor: Unique]: context.Key.Provider[F, Key] =
-      new context.Key.Provider[F, Key] {
+      new context.Key.Provider.Unsealed[F, Key] {
         def uniqueKey[A](name: String): F[Key[A]] = unique(name)
       }
   }
 
   /** The root [[`VaultContext`]], from which all other contexts are derived. */
   val root: VaultContext = new VaultContext(Vault.empty)
 
-  implicit object Contextual extends context.Contextual[VaultContext] {
+  implicit object Contextual extends context.Contextual.Unsealed[VaultContext] {
     type Key[A] = VaultContext.Key[A]
 
     def get[A](ctx: VaultContext)(key: Key[A]): Option[A] =