ddtrace 0.13.0 → 0.47.0

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

@@ -0,0 +1,45 @@
+module Datadog
+  module Utils
+    # Common database-related utility functions.
+    module Time
+      PROCESS_TIME_SUPPORTED = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.1.0')
+
+      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) : 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
+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/active_record/connection_specification.rb

@@ -0,0 +1,301 @@
+require 'uri'
+
+# NOTE: This code is copied directly from ActiveRecord.
+#       Its purpose is to resolve connection information.
+#       It exists here only because it doesn't exist in Rails 3.2.
+#       When support for Rails 3.2 is dropped, this can be removed.
+module Datadog
+  module Vendor
+    module ActiveRecord
+      # Copy/paste from:
+      # https://github.com/rails/rails/blob/5-2-stable/activerecord/lib/active_record/connection_handling.rb
+      module ConnectionHandling
+        RAILS_ENV = -> { (Rails.env if defined?(Rails) && defined?(Rails.env)) || ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence }
+      end
+
+      # Copy/paste from:
+      # https://github.com/rails/rails/blob/5-2-stable/activerecord/lib/active_record/connection_adapters/connection_specification.rb
+      module ConnectionAdapters
+        class ConnectionSpecification
+          attr_reader :name, :config, :adapter_method
+
+          def initialize(name, config, adapter_method)
+            @name, @config, @adapter_method = name, config, adapter_method
+          end
+
+          def initialize_dup(original)
+            @config = original.config.dup
+          end
+
+          def to_hash
+            @config.merge(name: @name)
+          end
+
+          # Expands a connection string into a hash.
+          class ConnectionUrlResolver # :nodoc:
+            # == Example
+            #
+            #   url = "postgresql://foo:bar@localhost:9000/foo_test?pool=5&timeout=3000"
+            #   ConnectionUrlResolver.new(url).to_hash
+            #   # => {
+            #     "adapter"  => "postgresql",
+            #     "host"     => "localhost",
+            #     "port"     => 9000,
+            #     "database" => "foo_test",
+            #     "username" => "foo",
+            #     "password" => "bar",
+            #     "pool"     => "5",
+            #     "timeout"  => "3000"
+            #   }
+            def initialize(url)
+              raise "Database URL cannot be empty" if url.blank?
+              @uri     = uri_parser.parse(url)
+              @adapter = @uri.scheme && @uri.scheme.tr("-", "_")
+              @adapter = "postgresql" if @adapter == "postgres"
+
+              if @uri.opaque
+                @uri.opaque, @query = @uri.opaque.split("?", 2)
+              else
+                @query = @uri.query
+              end
+            end
+
+            # Converts the given URL to a full connection hash.
+            def to_hash
+              config = raw_config.reject { |_, value| value.blank? }
+              config.map { |key, value| config[key] = uri_parser.unescape(value) if value.is_a? String }
+              config
+            end
+
+            private
+
+              def uri
+                @uri
+              end
+
+              def uri_parser
+                @uri_parser ||= URI::Parser.new
+              end
+
+              # Converts the query parameters of the URI into a hash.
+              #
+              #   "localhost?pool=5&reaping_frequency=2"
+              #   # => { "pool" => "5", "reaping_frequency" => "2" }
+              #
+              # returns empty hash if no query present.
+              #
+              #   "localhost"
+              #   # => {}
+              def query_hash
+                Hash[(@query || "").split("&").map { |pair| pair.split("=") }]
+              end
+
+              def raw_config
+                if uri.opaque
+                  query_hash.merge(
+                    "adapter"  => @adapter,
+                    "database" => uri.opaque)
+                else
+                  query_hash.merge(
+                    "adapter"  => @adapter,
+                    "username" => uri.user,
+                    "password" => uri.password,
+                    "port"     => uri.port,
+                    "database" => database_from_path,
+                    "host"     => uri.hostname)
+                end
+              end
+
+              # Returns name of the database.
+              def database_from_path
+                if @adapter == "sqlite3"
+                  # 'sqlite3:/foo' is absolute, because that makes sense. The
+                  # corresponding relative version, 'sqlite3:foo', is handled
+                  # elsewhere, as an "opaque".
+
+                  uri.path
+                else
+                  # Only SQLite uses a filename as the "database" name; for
+                  # anything else, a leading slash would be silly.
+
+                  uri.path.sub(%r{^/}, "")
+                end
+              end
+          end
+
+          ##
+          # Builds a ConnectionSpecification from user input.
+          class Resolver # :nodoc:
+            attr_reader :configurations
+
+            # Accepts a hash two layers deep, keys on the first layer represent
+            # environments such as "production". Keys must be strings.
+            def initialize(configurations)
+              @configurations = configurations
+            end
+
+            # Returns a hash with database connection information.
+            #
+            # == Examples
+            #
+            # Full hash Configuration.
+            #
+            #   configurations = { "production" => { "host" => "localhost", "database" => "foo", "adapter" => "sqlite3" } }
+            #   Resolver.new(configurations).resolve(:production)
+            #   # => { "host" => "localhost", "database" => "foo", "adapter" => "sqlite3"}
+            #
+            # Initialized with URL configuration strings.
+            #
+            #   configurations = { "production" => "postgresql://localhost/foo" }
+            #   Resolver.new(configurations).resolve(:production)
+            #   # => { "host" => "localhost", "database" => "foo", "adapter" => "postgresql" }
+            #
+            def resolve(config)
+              if config
+                resolve_connection config
+              elsif env = ConnectionHandling::RAILS_ENV.call
+                resolve_symbol_connection env.to_sym
+              else
+                raise AdapterNotSpecified
+              end
+            end
+
+            # Expands each key in @configurations hash into fully resolved hash
+            def resolve_all
+              config = configurations.dup
+
+              if env = ConnectionHandling::DEFAULT_ENV.call
+                env_config = config[env] if config[env].is_a?(Hash) && !(config[env].key?("adapter") || config[env].key?("url"))
+              end
+
+              config.reject! { |k, v| v.is_a?(Hash) && !(v.key?("adapter") || v.key?("url")) }
+              config.merge! env_config if env_config
+
+              config.each do |key, value|
+                config[key] = resolve(value) if value
+              end
+
+              config
+            end
+
+            # Returns an instance of ConnectionSpecification for a given adapter.
+            # Accepts a hash one layer deep that contains all connection information.
+            #
+            # == Example
+            #
+            #   config = { "production" => { "host" => "localhost", "database" => "foo", "adapter" => "sqlite3" } }
+            #   spec = Resolver.new(config).spec(:production)
+            #   spec.adapter_method
+            #   # => "sqlite3_connection"
+            #   spec.config
+            #   # => { "host" => "localhost", "database" => "foo", "adapter" => "sqlite3" }
+            #
+            def spec(config)
+              spec = resolve(config).symbolize_keys
+
+              raise(AdapterNotSpecified, "database configuration does not specify adapter") unless spec.key?(:adapter)
+
+              # Require the adapter itself and give useful feedback about
+              #   1. Missing adapter gems and
+              #   2. Adapter gems' missing dependencies.
+              path_to_adapter = "active_record/connection_adapters/#{spec[:adapter]}_adapter"
+              begin
+                require path_to_adapter
+              rescue LoadError => e
+                # We couldn't require the adapter itself. Raise an exception that
+                # points out config typos and missing gems.
+                if e.path == path_to_adapter
+                  # We can assume that a non-builtin adapter was specified, so it's
+                  # either misspelled or missing from Gemfile.
+                  raise e.class, "Could not load the '#{spec[:adapter]}' Active Record adapter. Ensure that the adapter is spelled correctly in config/database.yml and that you've added the necessary adapter gem to your Gemfile.", e.backtrace
+
+                # Bubbled up from the adapter require. Prefix the exception message
+                # with some guidance about how to address it and reraise.
+                else
+                  raise e.class, "Error loading the '#{spec[:adapter]}' Active Record adapter. Missing a gem it depends on? #{e.message}", e.backtrace
+                end
+              end
+
+              adapter_method = "#{spec[:adapter]}_connection"
+
+              unless ::ActiveRecord::Base.respond_to?(adapter_method)
+                raise AdapterNotFound, "database configuration specifies nonexistent #{spec.config[:adapter]} adapter"
+              end
+
+              ConnectionSpecification.new(spec.delete(:name) || "primary", spec, adapter_method)
+            end
+
+            private
+
+              # Returns fully resolved connection, accepts hash, string or symbol.
+              # Always returns a hash.
+              #
+              # == Examples
+              #
+              # Symbol representing current environment.
+              #
+              #   Resolver.new("production" => {}).resolve_connection(:production)
+              #   # => {}
+              #
+              # One layer deep hash of connection values.
+              #
+              #   Resolver.new({}).resolve_connection("adapter" => "sqlite3")
+              #   # => { "adapter" => "sqlite3" }
+              #
+              # Connection URL.
+              #
+              #   Resolver.new({}).resolve_connection("postgresql://localhost/foo")
+              #   # => { "host" => "localhost", "database" => "foo", "adapter" => "postgresql" }
+              #
+              def resolve_connection(spec)
+                case spec
+                when Symbol
+                  resolve_symbol_connection spec
+                when String
+                  resolve_url_connection spec
+                when Hash
+                  resolve_hash_connection spec
+                end
+              end
+
+              # Takes the environment such as +:production+ or +:development+.
+              # This requires that the @configurations was initialized with a key that
+              # matches.
+              #
+              #   Resolver.new("production" => {}).resolve_symbol_connection(:production)
+              #   # => {}
+              #
+              def resolve_symbol_connection(spec)
+                if config = configurations[spec.to_s]
+                  resolve_connection(config).merge("name" => spec.to_s)
+                else
+                  raise(AdapterNotSpecified, "'#{spec}' database is not configured. Available: #{configurations.keys.inspect}")
+                end
+              end
+
+              # Accepts a hash. Expands the "url" key that contains a
+              # URL database connection to a full connection
+              # hash and merges with the rest of the hash.
+              # Connection details inside of the "url" key win any merge conflicts
+              def resolve_hash_connection(spec)
+                if spec["url"] && spec["url"] !~ /^jdbc:/
+                  connection_hash = resolve_url_connection(spec.delete("url"))
+                  spec.merge!(connection_hash)
+                end
+                spec
+              end
+
+              # Takes a connection URL.
+              #
+              #   Resolver.new({}).resolve_url_connection("postgresql://localhost/foo")
+              #   # => { "host" => "localhost", "database" => "foo", "adapter" => "postgresql" }
+              #
+              def resolve_url_connection(url)
+                ConnectionUrlResolver.new(url).to_hash
+              end
+          end
+        end
+      end
+    end
+  end
+end