DEBUG-3535 DRY transport Instance and Spec classes

p · p · commit 0f78cf7b96b0 · 2025-02-20T19:46:36.000-05:00
diff --git a/lib/datadog/core/remote/transport/http.rb b/lib/datadog/core/remote/transport/http.rb
@@ -20,8 +20,6 @@
 # require_relative '../../transport/http/api'
 require_relative 'http/api'
 
-require_relative 'http/api/instance'
-
 # TODO: Decouple transport/http
 #
 # Because a new transport is required for every (API, Client, Transport)
diff --git a/lib/datadog/core/remote/transport/http/api.rb b/lib/datadog/core/remote/transport/http/api.rb
@@ -2,24 +2,9 @@
 
 require_relative '../../../encoding'
 require_relative '../../../transport/http/api/map'
-
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/traces includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/spec'
-require_relative 'api/spec'
-
-# TODO: only needed for Negotiation::API::Endpoint
+require_relative '../../../transport/http/api/instance'
+require_relative '../../../transport/http/api/spec'
 require_relative 'negotiation'
-
-# TODO: only needed for Config::API::Endpoint
 require_relative 'config'
 
 module Datadog
@@ -36,7 +21,7 @@ module API
             module_function
 
             def defaults
-              Datadog::Core::Transport::HTTP::API::Map[
+              Core::Transport::HTTP::API::Map[
                 ROOT => Spec.new do |s|
                   s.info = Negotiation::API::Endpoint.new(
                     '/info',
@@ -50,6 +35,16 @@ def defaults
                 end,
               ]
             end
+
+            class Instance < Core::Transport::HTTP::API::Instance
+              include Config::API::Instance
+              include Negotiation::API::Instance
+            end
+
+            class Spec < Core::Transport::HTTP::API::Spec
+              include Config::API::Spec
+              include Negotiation::API::Spec
+            end
           end
         end
       end
diff --git a/lib/datadog/core/remote/transport/http/api/instance.rb b/lib/datadog/core/remote/transport/http/api/instance.rb
diff --git a/lib/datadog/core/remote/transport/http/api/spec.rb b/lib/datadog/core/remote/transport/http/api/spec.rb
diff --git a/lib/datadog/core/remote/transport/http/config.rb b/lib/datadog/core/remote/transport/http/config.rb
@@ -8,22 +8,6 @@
 require_relative '../../../transport/http/response'
 require_relative '../../../transport/http/api/endpoint'
 
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/trace includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../core/transport/http/api/instance'
-require_relative 'api/instance'
-# Below should be:
-# require_relative '../../../core/transport/http/api/spec'
-require_relative 'api/spec'
-
 module Datadog
   module Core
     module Remote
@@ -270,8 +254,6 @@ def call(env, &block)
             # Add remote configuration behavior to transport components
             ###### overrides send_payload! which calls send_<endpoint>! kills any other possible endpoint!
             HTTP::Client.include(Config::Client)
-            HTTP::API::Spec.include(Config::API::Spec)
-            HTTP::API::Instance.include(Config::API::Instance)
           end
         end
       end
diff --git a/lib/datadog/core/remote/transport/http/negotiation.rb b/lib/datadog/core/remote/transport/http/negotiation.rb
@@ -7,22 +7,6 @@
 require_relative '../../../transport/http/response'
 require_relative '../../../transport/http/api/endpoint'
 
-# TODO: Decouple standard transport/http/api/instance
-#
-# Separate classes are needed because transport/http/trace includes
-# Trace::API::Instance which closes over and uses a single spec, which is
-# negotiated as either /v3 or /v4 for the whole API at the spec level, but we
-# need an independent toplevel path at the endpoint level.
-#
-# Separate classes are needed because of `include Trace::API::Instance`.
-#
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/instance'
-require_relative 'api/instance'
-# Below should be:
-# require_relative '../../../../datadog/core/transport/http/api/spec'
-require_relative 'api/spec'
-
 module Datadog
   module Core
     module Remote
@@ -137,8 +121,6 @@ def call(env, &block)
 
             # Add negotiation behavior to transport components
             HTTP::Client.include(Negotiation::Client)
-            HTTP::API::Spec.include(Negotiation::API::Spec)
-            HTTP::API::Instance.include(Negotiation::API::Instance)
           end
         end
       end
diff --git a/lib/datadog/core/transport/http/api/instance.rb b/lib/datadog/core/transport/http/api/instance.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Tracing
+  module Core
     module Transport
       module HTTP
         module API
diff --git a/lib/datadog/core/transport/http/api/spec.rb b/lib/datadog/core/transport/http/api/spec.rb
@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Datadog
-  module Tracing
+  module Core
     module Transport
       module HTTP
         module API
diff --git a/lib/datadog/tracing/transport/http.rb b/lib/datadog/tracing/transport/http.rb
@@ -10,7 +10,6 @@
 require_relative '../../core/transport/http/adapters/unix_socket'
 require_relative '../../core/transport/http/builder'
 require_relative 'http/api'
-require_relative 'http/api/instance'
 require_relative '../../../datadog/version'
 
 module Datadog
diff --git a/lib/datadog/tracing/transport/http/api.rb b/lib/datadog/tracing/transport/http/api.rb
@@ -3,7 +3,8 @@
 require_relative '../../../core/encoding'
 
 require_relative '../../../core/transport/http/api/map'
-require_relative 'api/spec'
+require_relative '../../../core/transport/http/api/instance'
+require_relative '../../../core/transport/http/api/spec'
 
 require_relative 'traces'
 
@@ -20,7 +21,7 @@ module API
           module_function
 
           def defaults
-            Datadog::Core::Transport::HTTP::API::Map[
+            Core::Transport::HTTP::API::Map[
               V4 => Spec.new do |s|
                 s.traces = Traces::API::Endpoint.new(
                   '/v0.4/traces',
@@ -36,6 +37,14 @@ def defaults
               end,
             ].with_fallbacks(V4 => V3)
           end
+
+          class Instance < Core::Transport::HTTP::API::Instance
+            include Traces::API::Instance
+          end
+
+          class Spec < Core::Transport::HTTP::API::Spec
+            include Traces::API::Spec
+          end
         end
       end
     end
diff --git a/lib/datadog/tracing/transport/http/traces.rb b/lib/datadog/tracing/transport/http/traces.rb
@@ -6,7 +6,6 @@
 require_relative 'client'
 require_relative '../../../core/transport/http/response'
 require_relative '../../../core/transport/http/api/endpoint'
-require_relative 'api/instance'
 
 module Datadog
   module Tracing
@@ -143,8 +142,6 @@ def call(env, &block)
 
           # Add traces behavior to transport components
           HTTP::Client.include(Traces::Client)
-          HTTP::API::Spec.include(Traces::API::Spec)
-          HTTP::API::Instance.include(Traces::API::Instance)
         end
       end
     end
diff --git a/sig/datadog/core/remote/transport/http/api/instance.rbs b/sig/datadog/core/remote/transport/http/api/instance.rbs
@@ -4,18 +4,7 @@ module Datadog
       module Transport
         module HTTP
           module API
-            class Instance
-              attr_reader adapter: untyped
-
-              attr_reader headers: untyped
-
-              attr_reader spec: untyped
-
-              def initialize: (untyped spec, untyped adapter, ?::Hash[untyped, untyped] options) -> void
-
-              def encoder: () -> untyped
-
-              def call: (untyped env) -> untyped
+            class Instance < Datadog::Core::Transport::HTTP::API::Instance
             end
           end
         end
diff --git a/sig/datadog/core/remote/transport/http/api/spec.rbs b/sig/datadog/core/remote/transport/http/api/spec.rbs
@@ -4,8 +4,7 @@ module Datadog
       module Transport
         module HTTP
           module API
-            class Spec
-              def initialize: () { (untyped) -> untyped } -> void
+            class Spec < Datadog::Core::Transport::HTTP::API::Spec
             end
           end
         end
diff --git a/sig/datadog/core/transport/http/api/instance.rbs b/sig/datadog/core/transport/http/api/instance.rbs
@@ -0,0 +1,23 @@
+module Datadog
+  module Core
+    module Transport
+      module HTTP
+        module API
+          class Instance
+            attr_reader adapter: untyped
+
+            attr_reader headers: untyped
+
+            attr_reader spec: untyped
+
+            def initialize: (untyped spec, untyped adapter, ?::Hash[untyped, untyped] options) -> void
+
+            def encoder: () -> untyped
+
+            def call: (untyped env) -> untyped
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/sig/datadog/core/transport/http/api/spec.rbs b/sig/datadog/core/transport/http/api/spec.rbs
@@ -0,0 +1,13 @@
+module Datadog
+  module Core
+    module Transport
+      module HTTP
+        module API
+          class Spec
+            def initialize: () { (untyped) -> untyped } -> void
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/sig/datadog/tracing/transport/http/api/instance.rbs b/sig/datadog/tracing/transport/http/api/instance.rbs
@@ -3,19 +3,8 @@ module Datadog
     module Transport
       module HTTP
         module API
-          class Instance
-            attr_reader adapter: untyped
-
-            attr_reader headers: untyped
-
-            attr_reader spec: untyped
-
-            def initialize: (untyped spec, untyped adapter, ?::Hash[untyped, untyped] options) -> void
-
-            def encoder: () -> untyped
-
-            def call: (untyped env) -> untyped
-          end
+          class Instance < Datadog::Core::Transport::HTTP::API::Instance
+	  end
         end
       end
     end
diff --git a/sig/datadog/tracing/transport/http/api/spec.rbs b/sig/datadog/tracing/transport/http/api/spec.rbs
@@ -3,8 +3,7 @@ module Datadog
     module Transport
       module HTTP
         module API
-          class Spec
-            def initialize: () { (untyped) -> untyped } -> void
+          class Instance < Datadog::Core::Transport::HTTP::API::Instance
           end
         end
       end
diff --git a/spec/datadog/core/transport/http/api/instance_spec.rb b/spec/datadog/core/transport/http/api/instance_spec.rb
@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-require 'datadog/tracing/transport/http/api/instance'
+require 'datadog/core/transport/http/api/instance'
 
-RSpec.describe Datadog::Tracing::Transport::HTTP::API::Instance do
+RSpec.describe Datadog::Core::Transport::HTTP::API::Instance do
   subject(:instance) { described_class.new(spec, adapter, options) }
 
-  let(:spec) { double(Datadog::Tracing::Transport::HTTP::API::Spec, encoder: encoder) }
+  let(:spec) { double(Datadog::Core::Transport::HTTP::API::Spec, encoder: encoder) }
   let(:encoder) { double }
   let(:adapter) { spy('adapter') }
   let(:options) { {} }
diff --git a/spec/datadog/core/transport/http/api/spec_spec.rb b/spec/datadog/core/transport/http/api/spec_spec.rb
@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-require 'datadog/tracing/transport/http/api/spec'
+require 'datadog/core/transport/http/api/spec'
 
-RSpec.describe Datadog::Tracing::Transport::HTTP::API::Spec do
+RSpec.describe Datadog::Core::Transport::HTTP::API::Spec do
   subject(:spec) { described_class.new }
 
   describe '#initialize' do

Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,6 @@`
`20`	`20`	`# require_relative '../../transport/http/api'`
`21`	`21`	`require_relative 'http/api'`
`22`	`22`
`23`		`-require_relative 'http/api/instance'`
`24`		`-`
`25`	`23`	`# TODO: Decouple transport/http`
`26`	`24`	`#`
`27`	`25`	`# Because a new transport is required for every (API, Client, Transport)`