ddtrace 0.45.0 → 0.46.0

data/lib/ddtrace/sync_writer.rb

@@ -5,6 +5,10 @@ require 'ddtrace/runtime/metrics'
 module Datadog
   # SyncWriter flushes both services and traces synchronously
   # DEV: To be replaced by Datadog::Workers::TraceWriter.
+  #
+  # Note: If you're wondering if this class is used at all, since there are no other references to it on the codebase,
+  # the separate `datadog-lambda` uses it as of February 2021:
+  # <https://github.com/DataDog/datadog-lambda-rb/blob/c15f0f0916c90123416dc44e7d6800ef4a7cfdbf/lib/datadog/lambda.rb#L38>
   class SyncWriter
     attr_reader \
       :priority_sampler,
@@ -29,9 +33,7 @@ module Datadog
         end
       end
 
-      perform_concurrently(
-        proc { flush_trace(trace) }
-      )
+      flush_trace(trace)
     rescue => e
       Datadog.logger.debug(e)
     end
@@ -44,13 +46,10 @@ module Datadog
 
     private
 
-    def perform_concurrently(*tasks)
-      tasks.map { |task| Thread.new(&task) }.each(&:join)
-    end
-
     def flush_trace(trace)
       processed_traces = Pipeline.process!([trace])
       return if processed_traces.empty?
+
       inject_hostname!(processed_traces.first) if Datadog.configuration.report_hostname
       transport.send_traces(processed_traces)
     end
@@ -58,9 +57,7 @@ module Datadog
     def inject_hostname!(trace)
       unless trace.first.nil?
         hostname = Datadog::Runtime::Socket.hostname
-        unless hostname.nil? || hostname.empty?
-          trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname)
-        end
+        trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
       end
     end
   end

data/lib/ddtrace/tracer.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'logger'
 require 'pathname'
 
@@ -144,6 +143,7 @@ module Datadog
     # a service would be invalid and rejected.
     def default_service
       return @default_service if instance_variable_defined?(:@default_service) && @default_service
+
       begin
         @default_service = File.basename($PROGRAM_NAME, '.*')
       rescue StandardError => e

data/lib/ddtrace/transport/http.rb

@@ -69,9 +69,7 @@ module Datadog
         }.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
+          headers[Datadog::Ext::Transport::HTTP::HEADER_CONTAINER_ID] = container_id unless container_id.nil?
         end
       end
 

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

@@ -19,7 +19,7 @@ module Datadog
             @timeout = options[:timeout] || DEFAULT_TIMEOUT
           end
 
-          def open
+          def open(&block)
             # DEV Initializing +Net::HTTP+ directly help us avoid expensive
             # options processing done in +Net::HTTP.start+:
             # https://github.com/ruby/ruby/blob/b2d96abb42abbe2e01f010ffc9ac51f0f9a50002/lib/net/http.rb#L614-L618
@@ -27,9 +27,7 @@ module Datadog
 
             req.open_timeout = req.read_timeout = timeout
 
-            req.start do |http|
-              yield(http)
-            end
+            req.start(&block)
           end
 
           def call(env)
@@ -82,36 +80,43 @@ module Datadog
 
             def payload
               return super if http_response.nil?
+
               http_response.body
             end
 
             def code
               return super if http_response.nil?
+
               http_response.code.to_i
             end
 
             def ok?
               return super if http_response.nil?
+
               code.between?(200, 299)
             end
 
             def unsupported?
               return super if http_response.nil?
+
               code == 415
             end
 
             def not_found?
               return super if http_response.nil?
+
               code == 404
             end
 
             def client_error?
               return super if http_response.nil?
+
               code.between?(400, 499)
             end
 
             def server_error?
               return super if http_response.nil?
+
               code.between?(500, 599)
             end
 

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

@@ -15,6 +15,7 @@ module Datadog
           def set(klass, name = nil)
             name ||= klass.to_s
             return if name.nil?
+
             @adapters[name] = klass
           end
         end

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

@@ -18,7 +18,7 @@ module Datadog
             @timeout = options.fetch(:timeout, DEFAULT_TIMEOUT)
           end
 
-          def open
+          def open(&block)
             # Open connection
             connection = HTTP.new(
               filepath,
@@ -26,9 +26,7 @@ module Datadog
               continue_timeout: timeout
             )
 
-            connection.start do |http|
-              yield(http)
-            end
+            connection.start(&block)
           end
 
           def url

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

@@ -36,6 +36,7 @@ module Datadog
           @default_adapter = if type.is_a?(Symbol)
                                registry_klass = REGISTRY.get(type)
                                raise UnknownAdapterError, type if registry_klass.nil?
+
                                registry_klass.new(*args)
                              else
                                type
@@ -67,6 +68,7 @@ module Datadog
 
         def default_api=(key)
           raise UnknownApiError, key unless @apis.key?(key)
+
           @default_api = key
         end
 

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

@@ -41,6 +41,7 @@ module Datadog
 
             def send_traces(env, &block)
               raise NoTraceEndpointDefinedError, self if traces.nil?
+
               traces.call(env, &block)
             end
 
@@ -121,9 +122,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
 

data/lib/ddtrace/transport/io.rb

@@ -17,7 +17,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/traces.rb

@@ -142,17 +142,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

data/lib/ddtrace/utils/time.rb

@@ -6,8 +6,32 @@ module Datadog
 
       module_function
 
+      # Current monotonic time.
+      # Falls back to `now` if monotonic clock
+      # is not available.
+      #
+      # @return [Float] in seconds, since some unspecified starting point
       def get_time
-        PROCESS_TIME_SUPPORTED ? Process.clock_gettime(Process::CLOCK_MONOTONIC) : ::Time.now.to_f
+        PROCESS_TIME_SUPPORTED ? Process.clock_gettime(Process::CLOCK_MONOTONIC) : now.to_f
+      end
+
+      # Current wall time.
+      #
+      # @return [Time] current time object
+      def now
+        ::Time.now
+      end
+
+      # Overrides the implementation of `#now
+      # with the provided callable.
+      #
+      # Overriding the method `#now` instead of
+      # indirectly calling `block` removes
+      # one level of method call overhead.
+      #
+      # @param block [Proc] block that returns a `Time` object representing the current wall time
+      def now_provider=(block)
+        define_singleton_method(:now, &block)
       end
     end
   end

data/lib/ddtrace/vendor/active_record/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005-2018 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ddtrace/version.rb

@@ -1,7 +1,7 @@
 module Datadog
   module VERSION
     MAJOR = 0
-    MINOR = 45
+    MINOR = 46
     PATCH = 0
     PRE = nil
 

data/lib/ddtrace/workers.rb

@@ -67,9 +67,13 @@ module Datadog
       def start
         @mutex.synchronize do
           return if @run
+
           @run = true
           Datadog.logger.debug("Starting thread in the process: #{Process.pid}")
           @worker = Thread.new { perform }
+          @worker.name = self.class.name unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
+
+          nil
         end
       end
 
@@ -108,6 +112,7 @@ module Datadog
 
           @mutex.synchronize do
             return if !@run && @trace_buffer.empty?
+
             @shutdown.wait(@mutex, @back_off) if @run # do not wait when shutting down
           end
         end

data/lib/ddtrace/workers/async.rb

@@ -31,11 +31,13 @@ module Datadog
 
         def join(timeout = nil)
           return true unless running?
+
           !worker.join(timeout).nil?
         end
 
         def terminate
           return false unless running?
+
           @run_async = false
           worker.terminate
           true
@@ -43,6 +45,7 @@ module Datadog
 
         def run_async?
           return false unless instance_variable_defined?(:@run_async)
+
           @run_async == true
         end
 
@@ -56,6 +59,7 @@ module Datadog
 
         def error?
           return false unless instance_variable_defined?(:@error)
+
           !@error.nil?
         end
 
@@ -104,6 +108,7 @@ module Datadog
         def start(&block)
           mutex.synchronize do
             return if running?
+
             if forked?
               case fork_policy
               when FORK_POLICY_STOP
@@ -133,6 +138,9 @@ module Datadog
               raise
             end
           end
+          @worker.name = self.class.name unless Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.3')
+
+          nil
         end
 
         def stop_fork

data/lib/ddtrace/workers/loop.rb

@@ -21,6 +21,7 @@ module Datadog
       def stop_loop
         mutex.synchronize do
           return false unless run_loop?
+
           @run_loop = false
           shutdown.signal
         end
@@ -34,6 +35,7 @@ module Datadog
 
       def run_loop?
         return false unless instance_variable_defined?(:@run_loop)
+
         @run_loop == true
       end
 
@@ -92,6 +94,7 @@ module Datadog
           # Wait for an interval, unless shutdown has been signaled.
           mutex.synchronize do
             return unless run_loop? || work_pending?
+
             shutdown.wait(mutex, loop_wait_time) if run_loop?
           end
         end

data/lib/ddtrace/workers/polling.rb

@@ -35,6 +35,7 @@ module Datadog
 
       def enabled?
         return true unless instance_variable_defined?(:@enabled)
+
         @enabled
       end
 

data/lib/ddtrace/workers/trace_writer.rb

@@ -16,9 +16,7 @@ module Datadog
       def initialize(options = {})
         transport_options = options.fetch(:transport_options, {})
 
-        if transport_options.is_a?(Proc)
-          transport_options = { on_build: transport_options }
-        end
+        transport_options = { on_build: transport_options } if transport_options.is_a?(Proc)
 
         transport_options[:hostname] = options[:hostname] if options.key?(:hostname)
         transport_options[:port] = options[:port] if options.key?(:port)
@@ -66,9 +64,7 @@ module Datadog
           next if trace.first.nil?
 
           hostname = Datadog::Runtime::Socket.hostname
-          unless hostname.nil? || hostname.empty?
-            trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname)
-          end
+          trace.first.set_tag(Ext::NET::TAG_HOSTNAME, hostname) unless hostname.nil? || hostname.empty?
         end
       end
 
@@ -84,10 +80,6 @@ module Datadog
         def initialize
           super(:flush_completed)
         end
-
-        def publish(response)
-          super(response)
-        end
       end
     end
 
@@ -127,10 +119,15 @@ module Datadog
 
       # NOTE: #perform is wrapped by other modules:
       #       Polling --> Async --> IntervalLoop --> AsyncTraceWriter --> TraceWriter
+      #
+      # WARNING: This method breaks the Liskov Substitution Principle -- TraceWriter#perform is spec'd to return the
+      # result from the writer, whereas this method always returns nil.
       def perform(traces)
         super(traces).tap do |responses|
           loop_back_off! if responses.find(&:server_error?)
         end
+
+        nil
       end
 
       def stop(*args)
@@ -187,6 +184,8 @@ module Datadog
         @async = false if @writer_fork_policy == FORK_POLICY_SYNC
       end
 
+      # WARNING: This method breaks the Liskov Substitution Principle -- TraceWriter#write is spec'd to return the
+      # result from the writer, whereas this method returns something else when running in async mode.
       def write(trace)
         # Start worker thread. If the process has forked, it will trigger #after_fork to
         # reconfigure the worker accordingly.