ddtrace 0.45.0 → 0.47.0

data/lib/ddtrace/transport/traces.rb

@@ -123,7 +123,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 +156,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/compression.rb

@@ -0,0 +1,27 @@
+require 'zlib'
+
+module Datadog
+  module Utils
+    # Common database-related utility functions.
+    module Compression
+      module_function
+
+      def gzip(string, level: nil, strategy: nil)
+        sio = StringIO.new
+        sio.binmode
+        gz = Zlib::GzipWriter.new(sio, level, strategy)
+        gz.write(string)
+        gz.close
+        sio.string
+      end
+
+      def gunzip(string, encoding = ::Encoding::ASCII_8BIT)
+        sio = StringIO.new(string)
+        gz = Zlib::GzipReader.new(sio, encoding: encoding)
+        gz.read
+      ensure
+        gz && gz.close
+      end
+    end
+  end
+end

data/lib/ddtrace/utils/object_set.rb

@@ -0,0 +1,41 @@
+require 'ddtrace/utils/sequence'
+
+module Datadog
+  module Utils
+    # Acts as a unique dictionary of objects
+    class ObjectSet
+      # You can provide a block that defines how the key
+      # for this message type is resolved.
+      def initialize(seed = 0, &block)
+        @sequence = Utils::Sequence.new(seed)
+        @items = {}
+        @key_block = block
+      end
+
+      # Submit an array of arguments that define the message.
+      # If they match an existing message, it will return the
+      # matching object. If it doesn't match, it will yield to
+      # the block with the next ID & args given.
+      def fetch(*args, &block)
+        key = @key_block ? @key_block.call(*args) : args.hash
+        # TODO: Ruby 2.0 doesn't like yielding here... switch when 2.0 is dropped.
+        # rubocop:disable Performance/RedundantBlockCall
+        @items[key] ||= block.call(@sequence.next, *args)
+        # rubocop:enable Performance/RedundantBlockCall
+      end
+
+      def length
+        @items.length
+      end
+
+      def objects
+        @items.values
+      end
+
+      def freeze
+        super
+        @items.freeze
+      end
+    end
+  end
+end

data/lib/ddtrace/utils/only_once.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Utils
+    # Helper class to execute something only once such as not repeating warning logs, and instrumenting classes
+    # only once.
+    #
+    # Thread-safe when used correctly (e.g. be careful of races when lazily initializing instances of this class).
+    #
+    # Note: In its current state, this class is not Ractor-safe.
+    # In https://github.com/DataDog/dd-trace-rb/pull/1398#issuecomment-797378810 we have a discussion of alternatives,
+    # including an alternative implementation that is Ractor-safe once spent.
+    class OnlyOnce
+      def initialize
+        @mutex = Mutex.new
+        @ran_once = false
+      end
+
+      def run
+        @mutex.synchronize do
+          return if @ran_once
+
+          @ran_once = true
+
+          yield
+        end
+      end
+
+      def ran?
+        @mutex.synchronize { @ran_once }
+      end
+
+      private
+
+      def reset_ran_once_state_for_tests
+        @mutex.synchronize { @ran_once = false }
+      end
+    end
+  end
+end

data/lib/ddtrace/utils/sequence.rb

@@ -0,0 +1,17 @@
+module Datadog
+  module Utils
+    # Generates values from a consistent sequence
+    class Sequence
+      def initialize(seed = 0, &block)
+        @current = seed
+        @next_item = block
+      end
+
+      def next
+        next_item = @next_item ? @next_item.call(@current) : @current
+        @current += 1
+        next_item
+      end
+    end
+  end
+end

data/lib/ddtrace/utils/string_table.rb

@@ -0,0 +1,45 @@
+require 'ddtrace/utils/sequence'
+
+module Datadog
+  module Utils
+    # Tracks strings and returns IDs
+    class StringTable
+      def initialize
+        @sequence = Sequence.new
+        @ids = { ''.freeze => @sequence.next }
+      end
+
+      # Returns an ID for the string
+      def fetch(string)
+        @ids[string.to_s] ||= @sequence.next
+      end
+
+      # Returns the canonical copy of this string
+      # Typically used for psuedo interning; reduce
+      # identical copies of a string to one object.
+      def fetch_string(string)
+        return nil if string.nil?
+
+        # Co-erce to string
+        string = string.to_s
+
+        # Add to string table if no match
+        @ids[string] = @sequence.next unless @ids.key?(string)
+
+        # Get and return matching string in table
+        # NOTE: Have to resolve the key and retrieve from table again
+        #       because "string" argument is not same object as string key.
+        id = @ids[string]
+        @ids.key(id)
+      end
+
+      def [](id)
+        @ids.key(id)
+      end
+
+      def strings
+        @ids.keys
+      end
+    end
+  end
+end

data/lib/ddtrace/utils/time.rb

@@ -6,8 +6,39 @@ 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
+
+      def measure
+        before = get_time
+        yield
+        after = get_time
+        after - before
       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/vendor/multipart-post/LICENSE

@@ -0,0 +1,11 @@
+Released under the MIT license.
+
+Copyright, 2007-2013, by Nick Sieger.
+Copyright, 2017, by Samuel G. D. Williams.
+Copyright, 2019, by Patrick Davey.
+
+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/vendor/multipart-post/multipart.rb

@@ -0,0 +1,12 @@
+#--
+# Copyright (c) 2007-2013 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+module Datadog
+  module Vendor
+    module Multipart
+    end
+  end
+end

data/lib/ddtrace/vendor/multipart-post/multipart/post.rb

@@ -0,0 +1,8 @@
+module Datadog
+  module Vendor
+    module Multipart
+      module Post
+      end
+    end
+  end
+end

data/lib/ddtrace/vendor/multipart-post/multipart/post/composite_read_io.rb

@@ -0,0 +1,116 @@
+#--
+# Copyright (c) 2007-2012 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+# Concatenate together multiple IO objects into a single, composite IO object
+# for purposes of reading as a single stream.
+#
+# @example
+#     crio = CompositeReadIO.new(StringIO.new('one'),
+#                                StringIO.new('two'),
+#                                StringIO.new('three'))
+#     puts crio.read # => "onetwothree"
+module Datadog
+  module Vendor
+    module Multipart
+      module Post
+        class CompositeReadIO
+          # Create a new composite-read IO from the arguments, all of which should
+          # respond to #read in a manner consistent with IO.
+          def initialize(*ios)
+            @ios = ios.flatten
+            @index = 0
+          end
+
+          # Read from IOs in order until `length` bytes have been received.
+          def read(length = nil, outbuf = nil)
+            got_result = false
+            outbuf = outbuf ? outbuf.replace("") : ""
+
+            while io = current_io
+              if result = io.read(length)
+                got_result ||= !result.nil?
+                result.force_encoding("BINARY") if result.respond_to?(:force_encoding)
+                outbuf << result
+                length -= result.length if length
+                break if length == 0
+              end
+              advance_io
+            end
+            (!got_result && length) ? nil : outbuf
+          end
+
+          def rewind
+            @ios.each { |io| io.rewind }
+            @index = 0
+          end
+
+          private
+
+          def current_io
+            @ios[@index]
+          end
+
+          def advance_io
+            @index += 1
+          end
+        end
+
+        # Convenience methods for dealing with files and IO that are to be uploaded.
+        class UploadIO
+          attr_reader :content_type, :original_filename, :local_path, :io, :opts
+
+          # Create an upload IO suitable for including in the params hash of a
+          # Net::HTTP::Post::Multipart.
+          #
+          # Can take two forms. The first accepts a filename and content type, and
+          # opens the file for reading (to be closed by finalizer).
+          #
+          # The second accepts an already-open IO, but also requires a third argument,
+          # the filename from which it was opened (particularly useful/recommended if
+          # uploading directly from a form in a framework, which often save the file to
+          # an arbitrarily named RackMultipart file in /tmp).
+          #
+          # @example
+          #     UploadIO.new("file.txt", "text/plain")
+          #     UploadIO.new(file_io, "text/plain", "file.txt")
+          def initialize(filename_or_io, content_type, filename = nil, opts = {})
+            io = filename_or_io
+            local_path = ""
+            if io.respond_to? :read
+              # in Ruby 1.9.2, StringIOs no longer respond to path
+              # (since they respond to :length, so we don't need their local path, see parts.rb:41)
+              local_path = filename_or_io.respond_to?(:path) ? filename_or_io.path : "local.path"
+            else
+              io = File.open(filename_or_io)
+              local_path = filename_or_io
+            end
+            filename ||= local_path
+
+            @content_type = content_type
+            @original_filename = File.basename(filename)
+            @local_path = local_path
+            @io = io
+            @opts = opts
+          end
+
+          def self.convert!(io, content_type, original_filename, local_path)
+            raise ArgumentError, "convert! has been removed. You must now wrap IOs " \
+              "using:\nUploadIO.new(filename_or_io, content_type, " \
+              "filename=nil)\nPlease update your code."
+          end
+
+          def method_missing(*args)
+            @io.send(*args)
+          end
+
+          def respond_to?(meth, include_all = false)
+            @io.respond_to?(meth, include_all) || super(meth, include_all)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ddtrace/vendor/multipart-post/multipart/post/multipartable.rb

@@ -0,0 +1,57 @@
+#--
+# Copyright (c) 2007-2013 Nick Sieger.
+# See the file README.txt included with the distribution for
+# software license details.
+#++
+
+require 'ddtrace/vendor/multipart-post/multipart/post/parts'
+require 'ddtrace/vendor/multipart-post/multipart/post/composite_read_io'
+require 'securerandom'
+
+module Datadog
+  module Vendor
+    module Multipart
+      module Post
+        module Multipartable
+          def self.secure_boundary
+            # https://tools.ietf.org/html/rfc7230
+            #      tchar          = "!" / "#" / "$" / "%" / "&" / "'" / "*"
+            #                     / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~"
+            #                     / DIGIT / ALPHA
+
+            # https://tools.ietf.org/html/rfc2046
+            #      bcharsnospace := DIGIT / ALPHA / "'" / "(" / ")" /
+            #                       "+" / "_" / "," / "-" / "." /
+            #                       "/" / ":" / "=" / "?"
+
+            "--#{SecureRandom.uuid}"
+          end
+
+          def initialize(path, params, headers={}, boundary = Multipartable.secure_boundary)
+            headers = headers.clone # don't want to modify the original variable
+            parts_headers = headers.delete(:parts) || {}
+            super(path, headers)
+            parts = params.map do |k,v|
+              case v
+              when Array
+                v.map {|item| Parts::Part.new(boundary, "#{k}[]", item, parts_headers[k]) }
+              else
+                Parts::Part.new(boundary, k, v, parts_headers[k])
+              end
+            end.flatten
+            parts << Parts::EpiloguePart.new(boundary)
+            ios = parts.map {|p| p.to_io }
+            self.set_content_type(headers["Content-Type"] || "multipart/form-data",
+                                  { "boundary" => boundary })
+            self.content_length = parts.inject(0) {|sum,i| sum + i.length }
+            self.body_stream = CompositeReadIO.new(*ios)
+
+            @boundary = boundary
+          end
+
+          attr :boundary
+        end
+      end
+    end
+  end
+end