ddtrace 0.42.0 → 0.54.2

data/lib/ddtrace/transport/http/adapters/unix_socket.rb

@@ -1,4 +1,6 @@
+# typed: false
 require 'net/http'
+require 'ddtrace/ext/transport'
 require 'ddtrace/transport/http/adapters/net'
 
 module Datadog
@@ -7,32 +9,38 @@ module Datadog
       module Adapters
         # Adapter for Unix sockets
         class UnixSocket < Adapters::Net
-          DEFAULT_TIMEOUT = 1
-
           attr_reader \
-            :filepath,
+            :filepath, # DEV(1.0): Rename to `uds_path`
             :timeout
 
-          def initialize(filepath, options = {})
-            @filepath = filepath
-            @timeout = options.fetch(:timeout, DEFAULT_TIMEOUT)
+          alias_method :uds_path, :filepath
+
+          # @deprecated Positional parameters are deprecated. Use named parameters instead.
+          def initialize(uds_path = nil, **options)
+            @filepath = uds_path || options.fetch(:uds_path)
+            @timeout = options[:timeout] || Ext::Transport::UnixSocket::DEFAULT_TIMEOUT_SECONDS
           end
 
-          def open
+          def self.build(agent_settings)
+            new(
+              uds_path: agent_settings.uds_path,
+              timeout: agent_settings.timeout_seconds,
+            )
+          end
+
+          def open(&block)
             # Open connection
             connection = HTTP.new(
-              filepath,
+              uds_path,
               read_timeout: timeout,
               continue_timeout: timeout
             )
 
-            connection.start do |http|
-              yield(http)
-            end
+            connection.start(&block)
           end
 
           def url
-            "http+unix://#{filepath}?timeout=#{timeout}"
+            "http+unix://#{uds_path}?timeout=#{timeout}"
           end
 
           # Re-implements Net:HTTP with underlying Unix socket
@@ -40,19 +48,21 @@ module Datadog
             DEFAULT_TIMEOUT = 1
 
             attr_reader \
-              :filepath,
+              :filepath, # DEV(1.0): Rename to `uds_path`
               :unix_socket
 
-            def initialize(filepath, options = {})
+            alias_method :uds_path, :filepath
+
+            def initialize(uds_path, options = {})
               super('localhost', 80)
-              @filepath = filepath
+              @filepath = uds_path
               @read_timeout = options.fetch(:read_timeout, DEFAULT_TIMEOUT)
               @continue_timeout = options.fetch(:continue_timeout, DEFAULT_TIMEOUT)
               @debug_output = options[:debug_output] if options.key?(:debug_output)
             end
 
             def connect
-              @unix_socket = UNIXSocket.open(filepath)
+              @unix_socket = UNIXSocket.open(uds_path)
               @socket = ::Net::BufferedIO.new(@unix_socket).tap do |socket|
                 socket.read_timeout = @read_timeout
                 socket.continue_timeout = @continue_timeout

data/lib/ddtrace/transport/http/api/endpoint.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'json'
 
 module Datadog

data/lib/ddtrace/transport/http/api/fallbacks.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api/instance.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api/map.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/api/fallbacks'
 
 module Datadog

data/lib/ddtrace/transport/http/api/spec.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP

data/lib/ddtrace/transport/http/api.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/encoding'
 
 require 'ddtrace/transport/http/api/map'

data/lib/ddtrace/transport/http/builder.rb

@@ -1,3 +1,5 @@
+# typed: true
+require 'ddtrace/configuration/agent_settings_resolver'
 require 'ddtrace/transport/http/adapters/registry'
 require 'ddtrace/transport/http/api/map'
 require 'ddtrace/transport/http/api/instance'
@@ -32,13 +34,20 @@ module Datadog
           yield(self) if block_given?
         end
 
-        def adapter(type, *args)
-          @default_adapter = if type.is_a?(Symbol)
-                               registry_klass = REGISTRY.get(type)
-                               raise UnknownAdapterError, type if registry_klass.nil?
-                               registry_klass.new(*args)
+        def adapter(config, *args, **kwargs)
+          @default_adapter = case config
+                             when Configuration::AgentSettingsResolver::AgentSettings
+                               registry_klass = REGISTRY.get(config.adapter)
+                               raise UnknownAdapterError, config.adapter if registry_klass.nil?
+
+                               registry_klass.build(config)
+                             when Symbol
+                               registry_klass = REGISTRY.get(config)
+                               raise UnknownAdapterError, config if registry_klass.nil?
+
+                               registry_klass.new(*args, **kwargs)
                              else
-                               type
+                               config
                              end
         end
 
@@ -67,6 +76,7 @@ module Datadog
 
         def default_api=(key)
           raise UnknownApiError, key unless @apis.key?(key)
+
           @default_api = key
         end
 
@@ -93,7 +103,7 @@ module Datadog
               api_options[:headers] = @default_headers.merge((api_options[:headers] || {}))
 
               # Add API::Instance with all settings
-              instances[key] = API::Instance.new(
+              instances[key] = api_instance_class.new(
                 spec,
                 adapter,
                 api_options
@@ -105,6 +115,10 @@ module Datadog
           end
         end
 
+        def api_instance_class
+          API::Instance
+        end
+
         # Raised when the API key does not match known APIs.
         class UnknownApiError < StandardError
           attr_reader :key

data/lib/ddtrace/transport/http/client.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/http/statistics'
 require 'ddtrace/transport/http/env'
 
@@ -26,7 +27,8 @@ module Datadog
 
           response
         rescue StandardError => e
-          message = "Internal error during HTTP transport request. Cause: #{e.message} Location: #{e.backtrace.first}"
+          message =
+            "Internal error during HTTP transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0

data/lib/ddtrace/transport/http/env.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     module HTTP
@@ -42,6 +43,14 @@ module Datadog
         def headers=(value)
           self[:headers] = value
         end
+
+        def form
+          self[:form] ||= {}
+        end
+
+        def form=(value)
+          self[:form] = value
+        end
       end
     end
   end

data/lib/ddtrace/transport/http/response.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'forwardable'
 require 'ddtrace/transport/response'
 

data/lib/ddtrace/transport/http/statistics.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/statistics'
 
 module Datadog
@@ -6,8 +7,8 @@ module Datadog
       # Tracks statistics for HTTP transports
       module Statistics
         def self.included(base)
-          base.send(:include, Datadog::Transport::Statistics)
-          base.send(:include, InstanceMethods)
+          base.include(Datadog::Transport::Statistics)
+          base.include(InstanceMethods)
         end
 
         # Instance methods for HTTP statistics

data/lib/ddtrace/transport/http/traces.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'json'
 
 require 'ddtrace/transport/traces'
@@ -41,6 +42,7 @@ module Datadog
 
             def send_traces(env, &block)
               raise NoTraceEndpointDefinedError, self if traces.nil?
+
               traces.call(env, &block)
             end
 
@@ -121,9 +123,7 @@ module Datadog
                 # Parse service rates, if configured to do so.
                 if service_rates? && !http_response.payload.to_s.empty?
                   body = JSON.parse(http_response.payload)
-                  if body.is_a?(Hash) && body.key?(SERVICE_RATE_KEY)
-                    options[:service_rates] = body[SERVICE_RATE_KEY]
-                  end
+                  options[:service_rates] = body[SERVICE_RATE_KEY] if body.is_a?(Hash) && body.key?(SERVICE_RATE_KEY)
                 end
               end
 
@@ -134,9 +134,9 @@ module Datadog
         end
 
         # Add traces behavior to transport components
-        HTTP::Client.send(:include, Traces::Client)
-        HTTP::API::Spec.send(:include, Traces::API::Spec)
-        HTTP::API::Instance.send(:include, Traces::API::Instance)
+        HTTP::Client.include(Traces::Client)
+        HTTP::API::Spec.include(Traces::API::Spec)
+        HTTP::API::Instance.include(Traces::API::Instance)
       end
     end
   end

data/lib/ddtrace/transport/http.rb

@@ -1,8 +1,9 @@
+# typed: true
 require 'ddtrace/version'
-require 'ddtrace/ext/runtime'
+require 'datadog/core/environment/ext'
 require 'ddtrace/ext/transport'
 
-require 'ddtrace/runtime/container'
+require 'datadog/core/environment/container'
 
 require 'ddtrace/transport/http/builder'
 require 'ddtrace/transport/http/api'
@@ -16,6 +17,8 @@ module Datadog
   module Transport
     # Namespace for HTTP transport components
     module HTTP
+      include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
       module_function
 
       # Builds a new Transport::HTTP::Client
@@ -25,11 +28,17 @@ module Datadog
 
       # Builds a new Transport::HTTP::Client with default settings
       # Pass a block to override any settings.
-      def default(options = {})
+      def default(agent_settings: Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS, **options)
         new do |transport|
-          transport.adapter :net_http, default_hostname, default_port
+          transport.adapter(agent_settings)
           transport.headers default_headers
 
+          if agent_settings.deprecated_for_removal_transport_configuration_options
+            # The deprecated_for_removal_transport_configuration_options take precedence over any options the caller
+            # specifies
+            options = options.merge(**agent_settings.deprecated_for_removal_transport_configuration_options)
+          end
+
           apis = API.defaults
 
           transport.api API::V4, apis[API::V4], fallback: API::V3, default: true
@@ -38,69 +47,67 @@ module Datadog
 
           # Apply any settings given by options
           unless options.empty?
-            # Change hostname/port
-            if options.key?(:hostname) || options.key?(:port)
-              hostname = options.fetch(:hostname, default_hostname)
-              port = options.fetch(:port, default_port)
-              transport.adapter :net_http, hostname, port
-            end
-
-            # Change default API
             transport.default_api = options[:api_version] if options.key?(:api_version)
-
-            # Add headers
             transport.headers options[:headers] if options.key?(:headers)
+          end
 
-            # Execute on_build callback
-            options[:on_build].call(transport) if options[:on_build].is_a?(Proc)
+          if agent_settings.deprecated_for_removal_transport_configuration_proc
+            agent_settings.deprecated_for_removal_transport_configuration_proc.call(transport)
           end
 
-          # Call block to apply any customization, if provided.
+          # Call block to apply any customization, if provided
           yield(transport) if block_given?
         end
       end
 
       def default_headers
         {
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Ext::Runtime::LANG,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Ext::Runtime::LANG_VERSION,
-          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Ext::Runtime::LANG_INTERPRETER,
-          Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Ext::Runtime::TRACER_VERSION
+          Datadog::Ext::Transport::HTTP::HEADER_META_LANG => Datadog::Core::Environment::Ext::LANG,
+          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_VERSION => Datadog::Core::Environment::Ext::LANG_VERSION,
+          Datadog::Ext::Transport::HTTP::HEADER_META_LANG_INTERPRETER => Datadog::Core::Environment::Ext::LANG_INTERPRETER,
+          Datadog::Ext::Transport::HTTP::HEADER_META_TRACER_VERSION => Datadog::Core::Environment::Ext::TRACER_VERSION
         }.tap do |headers|
           # Add container ID, if present.
-          container_id = Datadog::Runtime::Container.container_id
-          unless container_id.nil?
-            headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id
-          end
+          container_id = Datadog::Core::Environment::Container.container_id
+          headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
 
-      def default_hostname
-        return default_url.hostname if default_url
-
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_HOST, Datadog::Ext::Transport::HTTP::DEFAULT_HOST)
+      def default_adapter
+        Ext::Transport::HTTP::ADAPTER
       end
 
-      def default_port
-        return default_url.port if default_url
+      def default_hostname(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
 
-        ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_PORT, Datadog::Ext::Transport::HTTP::DEFAULT_PORT).to_i
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.hostname
       end
 
-      def default_url
-        url_env = ENV.fetch(Datadog::Ext::Transport::HTTP::ENV_DEFAULT_URL, nil)
+      def default_port(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_hostname for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
 
-        if url_env
-          uri_parsed = URI.parse(url_env)
+        Datadog::Configuration::AgentSettingsResolver::ENVIRONMENT_AGENT_SETTINGS.port
+      end
 
-          uri_parsed if %w[http https].include?(uri_parsed.scheme)
-        end
+      def default_url(logger: Datadog.logger)
+        logger.warn(
+          'Deprecated for removal: Using #default_url for configuration is deprecated and will ' \
+          'be removed on a future ddtrace release.'
+        )
+
+        nil
       end
 
       # Add adapters to registry
-      Builder::REGISTRY.set(Adapters::Net, :net_http)
-      Builder::REGISTRY.set(Adapters::Test, :test)
-      Builder::REGISTRY.set(Adapters::UnixSocket, :unix)
+      Builder::REGISTRY.set(Adapters::Net, Ext::Transport::HTTP::ADAPTER)
+      Builder::REGISTRY.set(Adapters::Test, Ext::Transport::Test::ADAPTER)
+      Builder::REGISTRY.set(Adapters::UnixSocket, Ext::Transport::UnixSocket::ADAPTER)
     end
   end
 end

data/lib/ddtrace/transport/io/client.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/statistics'
 require 'ddtrace/transport/io/response'
 
@@ -12,19 +13,24 @@ module Datadog
           :encoder,
           :out
 
-        def initialize(out, encoder)
+        def initialize(out, encoder, options = {})
           @out = out
           @encoder = encoder
+
+          @request_block = options.fetch(:request, method(:send_default_request))
+          @encode_block = options.fetch(:encode, method(:encode_data))
+          @write_block = options.fetch(:write, method(:write_data))
+          @response_block = options.fetch(:response, method(:build_response))
         end
 
         def send_request(request)
           # Write data to IO
           # If block is given, allow it to handle writing
-          # Otherwise use default encoding.
+          # Otherwise do a standard encode/write/response.
           response = if block_given?
                        yield(out, request)
                      else
-                       send_default_request(out, request)
+                       @request_block.call(out, request)
                      end
 
           # Update statistics
@@ -33,7 +39,7 @@ module Datadog
           # Return response
           response
         rescue StandardError => e
-          message = "Internal error during IO transport request. Cause: #{e.message} Location: #{e.backtrace.first}"
+          message = "Internal error during IO transport request. Cause: #{e.message} Location: #{Array(e.backtrace).first}"
 
           # Log error
           if stats.consecutive_errors > 0
@@ -48,8 +54,6 @@ module Datadog
           InternalErrorResponse.new(e)
         end
 
-        protected
-
         def encode_data(encoder, request)
           request.parcel.encode_with(encoder)
         end
@@ -58,17 +62,21 @@ module Datadog
           out.puts(data)
         end
 
+        def build_response(_request, _data, result)
+          IO::Response.new(result)
+        end
+
         private
 
         def send_default_request(out, request)
           # Encode data
-          data = encode_data(encoder, request)
+          data = @encode_block.call(encoder, request)
 
           # Write to IO
-          result = write_data(out, data)
+          result = @write_block.call(out, data)
 
           # Generate a response
-          IO::Response.new(result)
+          @response_block.call(request, data, result)
         end
       end
     end

data/lib/ddtrace/transport/io/response.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/response'
 
 module Datadog
@@ -6,14 +7,12 @@ module Datadog
       # Response from HTTP transport for traces
       class Response
         include Transport::Response
-        include Transport::Traces::Response
 
         attr_reader \
           :result
 
-        def initialize(result, trace_count = 1)
+        def initialize(result)
           @result = result
-          @trace_count = trace_count
         end
 
         def ok?

data/lib/ddtrace/transport/io/traces.rb

@@ -1,3 +1,4 @@
+# typed: false
 require 'ddtrace/transport/traces'
 
 require 'ddtrace/transport/io/response'
@@ -10,10 +11,18 @@ module Datadog
       module Traces
         # Response from HTTP transport for traces
         class Response < IO::Response
+          include Transport::Traces::Response
+
+          def initialize(result, trace_count = 1)
+            super(result)
+            @trace_count = trace_count
+          end
         end
 
         # Extensions for HTTP client
         module Client
+          include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
           def send_traces(traces)
             # Build a request
             req = Transport::Traces::Request.new(Parcel.new(traces))
@@ -84,7 +93,7 @@ module Datadog
         end
 
         # Add traces behavior to transport components
-        IO::Client.send(:include, Traces::Client)
+        IO::Client.include(Traces::Client)
       end
     end
   end

data/lib/ddtrace/transport/io.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/encoding'
 require 'ddtrace/transport/io/client'
 require 'ddtrace/transport/io/traces'
@@ -17,7 +18,7 @@ module Datadog
       # Pass options to override any settings.
       def default(options = {})
         new(
-          options.fetch(:out, STDOUT),
+          options.fetch(:out, $stdout),
           options.fetch(:encoder, Encoding::JSONEncoder)
         )
       end

data/lib/ddtrace/transport/parcel.rb

@@ -1,13 +1,20 @@
+# typed: true
 module Datadog
   module Transport
     # Data transfer object for generic data
     module Parcel
+      include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
       attr_reader \
         :data
 
       def initialize(data)
         @data = data
       end
+
+      def encode_with(encoder)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/ddtrace/transport/request.rb

@@ -1,3 +1,4 @@
+# typed: true
 module Datadog
   module Transport
     # Defines request for transport operations

data/lib/ddtrace/transport/response.rb

@@ -1,3 +1,4 @@
+# typed: false
 module Datadog
   module Transport
     # Defines abstract response for transport operations

data/lib/ddtrace/transport/statistics.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/diagnostics/health'
 
 module Datadog

data/lib/ddtrace/transport/traces.rb

@@ -1,3 +1,4 @@
+# typed: true
 require 'ddtrace/transport/parcel'
 require 'ddtrace/transport/request'
 require 'ddtrace/chunker'
@@ -7,7 +8,7 @@ module Datadog
     module Traces
       # Data transfer object for encoded traces
       class EncodedParcel
-        include Transport::Parcel
+        include Datadog::Transport::Parcel
 
         attr_reader :trace_count
 
@@ -22,7 +23,7 @@ module Datadog
       end
 
       # Traces request
-      class Request < Transport::Request
+      class Request < Datadog::Transport::Request
       end
 
       # Traces response
@@ -123,7 +124,21 @@ module Datadog
                 return send_traces(traces)
               end
             end
-          end.force
+          end
+
+          # Force resolution of lazy enumerator.
+          #
+          # The "correct" method to call here would be `#force`,
+          # as this method was created to force the eager loading
+          # of a lazy enumerator.
+          #
+          # Unfortunately, JRuby < 9.2.9.0 erroneously eagerly loads
+          # the lazy Enumerator during intermediate steps.
+          # This forces us to use `#to_a`, as this method works for both
+          # lazy and regular Enumerators.
+          # Using `#to_a` can mask the fact that we expect a lazy
+          # Enumerator.
+          responses = responses.to_a
 
           Datadog.health_metrics.transport_chunked(responses.size)
 
@@ -142,17 +157,20 @@ module Datadog
 
         def downgrade?(response)
           return false unless apis.fallbacks.key?(@current_api_id)
+
           response.not_found? || response.unsupported?
         end
 
         def downgrade!
           downgrade_api_id = apis.fallbacks[@current_api_id]
           raise NoDowngradeAvailableError, @current_api_id if downgrade_api_id.nil?
+
           change_api!(downgrade_api_id)
         end
 
         def change_api!(api_id)
           raise UnknownApiVersionError, api_id unless apis.key?(api_id)
+
           @current_api_id = api_id
           @client = HTTP::Client.new(current_api)
         end