Move Span to Sentry.Interfaces

Author: solnic

lib/sentry/interfaces.ex

@@ -267,4 +267,47 @@ defmodule Sentry.Interfaces do
       :stacktrace
     ]
   end
+
+  defmodule Span do
+    @moduledoc """
+    The struct for the **span** interface.
+
+    See <https://develop.sentry.dev/sdk/event-payloads/spans>.
+    """
+
+    @moduledoc since: "11.0.0"
+
+    @typedoc since: "11.0.0"
+    @type t() :: %__MODULE__{
+            trace_id: String.t(),
+            span_id: String.t(),
+            start_timestamp: String.t(),
+            timestamp: String.t(),
+            parent_span_id: String.t(),
+            description: String.t(),
+            op: String.t(),
+            status: String.t(),
+            tags: map(),
+            data: map(),
+            origin: String.t()
+          }
+
+    @enforce_keys [:trace_id, :span_id, :start_timestamp, :timestamp]
+
+    defstruct @enforce_keys ++
+                [
+                  :parent_span_id,
+                  :description,
+                  :op,
+                  :status,
+                  :tags,
+                  :data,
+                  :origin
+                ]
+
+    @doc false
+    def to_map(%__MODULE__{} = span) do
+      Map.from_struct(span)
+    end
+  end
 end

lib/sentry/transaction.ex

@@ -1,7 +1,25 @@
 defmodule Sentry.Transaction do
-  @type t() :: %__MODULE__{}
+  @moduledoc """
+  The struct for the **transaction** interface.
 
-  alias Sentry.{Config, UUID}
+  See <https://develop.sentry.dev/sdk/event-payloads/transactions>.
+  """
+
+  @moduledoc since: "11.0.0"
+
+  @typedoc since: "11.0.0"
+
+  @type t() :: %__MODULE__{
+          event_id: String.t(),
+          environment: String.t(),
+          transaction: String.t(),
+          transaction_info: map(),
+          contexts: map(),
+          measurements: map(),
+          type: String.t()
+        }
+
+  alias Sentry.{Config, UUID, Interfaces.Span}
 
   @enforce_keys [:event_id, :span_id, :spans, :environment]
 
@@ -24,7 +42,6 @@ defmodule Sentry.Transaction do
     )
   end
 
-  # Used to then encode the returned map to JSON.
   @doc false
   def to_map(%__MODULE__{} = transaction) do
     transaction_attrs =
@@ -41,32 +58,9 @@ defmodule Sentry.Transaction do
     {[root_span], child_spans} = Enum.split_with(transaction.spans, &is_nil(&1.parent_span_id))
 
     root_span
-    |> Sentry.Span.to_map()
-    |> Map.put(:spans, Enum.map(child_spans, &Sentry.Span.to_map/1))
+    |> Span.to_map()
+    |> Map.put(:spans, Enum.map(child_spans, &Span.to_map/1))
     |> Map.drop([:description])
     |> Map.merge(transaction_attrs)
   end
 end
-
-defmodule Sentry.Span do
-  @moduledoc false
-
-  @enforce_keys [:trace_id, :span_id, :start_timestamp, :timestamp]
-
-  defstruct @enforce_keys ++
-              [
-                :parent_span_id,
-                :description,
-                :op,
-                :status,
-                :tags,
-                :data,
-                :origin
-              ]
-
-  # Used to then encode the returned map to JSON.
-  @doc false
-  def to_map(%__MODULE__{} = span) do
-    Map.from_struct(span)
-  end
-end

test/envelope_test.exs

@@ -118,7 +118,7 @@ defmodule Sentry.EnvelopeTest do
       put_test_config(environment_name: "test")
 
       root_span =
-        %Sentry.Span{
+        %Sentry.Interfaces.Span{
           start_timestamp: 1_588_601_261.481_961,
           timestamp: 1_588_601_261.488_901,
           description: "GET /sockjs-node/info",
@@ -137,7 +137,7 @@ defmodule Sentry.EnvelopeTest do
 
       child_spans =
         [
-          %Sentry.Span{
+          %Sentry.Interfaces.Span{
             start_timestamp: 1_588_601_261.535_386,
             timestamp: 1_588_601_261.544_196,
             description: "Vue <App>",

test/sentry/client_report/sender_test.exs

@@ -4,7 +4,7 @@ defmodule Sentry.ClientReportTest do
   import Sentry.TestHelpers
 
   alias Sentry.ClientReport.Sender
-  alias Sentry.{Event, Transaction, Span}
+  alias Sentry.{Event, Transaction, Interfaces.Span}
 
   setup do
     original_retries =

test/sentry_test.exs

@@ -243,7 +243,7 @@ defmodule SentryTest do
           span_id: "root-span",
           transaction: "test-transaction",
           spans: [
-            %Sentry.Span{
+            %Sentry.Interfaces.Span{
               span_id: "root-span",
               trace_id: "trace-id",
               start_timestamp: 1_234_567_891.123_456,