ddtrace 0.46.0 → 0.47.0

data/lib/ddtrace/configuration/options.rb

@@ -14,10 +14,8 @@ module Datadog
       # Class behavior for a configuration object with options
       module ClassMethods
         def options
-          @options ||= begin
-            # Allows for class inheritance of option definitions
-            superclass <= Options ? superclass.options.dup : OptionDefinitionSet.new
-          end
+          # Allows for class inheritance of option definitions
+          @options ||= superclass <= Options ? superclass.options.dup : OptionDefinitionSet.new
         end
 
         protected

data/lib/ddtrace/context_provider.rb

@@ -55,8 +55,6 @@ module Datadog
 
     # Return the thread-local context.
     def local(thread = Thread.current)
-      raise ArgumentError, '\'thread\' must be a Thread.' unless thread.is_a?(Thread)
-
       thread[@key] ||= Datadog::Context.new
     end
   end

data/lib/ddtrace/contrib/active_record/configuration/resolver.rb

@@ -6,48 +6,119 @@ module Datadog
     module ActiveRecord
       module Configuration
         # Converts Symbols, Strings, and Hashes to a normalized connection settings Hash.
+        #
+        # When matching using a Hash, these are the valid fields:
+        # ```
+        # {
+        #   adapter: ...,
+        #   host: ...,
+        #   port: ...,
+        #   database: ...,
+        #   username: ...,
+        #   role: ...,
+        # }
+        # ```
+        #
+        # Partial matching is supported: not including certain fields or setting them to `nil`
+        # will cause them to matching all values for that field. For example: `database: nil`
+        # will match any database, given the remaining fields match.
+        #
+        # Any fields not listed above are discarded.
+        #
+        # When more than one configuration could be matched, the last one to match is selected,
+        # based on addition order (`#add`).
         class Resolver < Contrib::Configuration::Resolver
-          def initialize(configurations = nil)
-            @configurations = configurations
+          def initialize(active_record_configuration = nil)
+            super()
+
+            @active_record_configuration = active_record_configuration
           end
 
-          def resolve(key)
-            normalize(resolve_connection_key(key).symbolize_keys)
+          def active_record_configuration
+            @active_record_configuration || ::ActiveRecord::Base.configurations
           end
 
-          def resolve_connection_key(key)
-            result = connection_resolver.resolve(key)
+          def add(matcher, value)
+            parsed = parse_matcher(matcher)
 
-            if result.respond_to?(:configuration_hash) # Rails >= 6.1
-              result.configuration_hash
-            else # Rails < 6.1
-              result
+            # In case of error parsing, don't store `nil` key
+            # as it wouldn't be useful for matching configuration
+            # hashes in `#resolve`.
+            super(parsed, value) if parsed
+          end
+
+          def resolve(db_config)
+            active_record_config = resolve_connection_key(db_config).symbolize_keys
+
+            hash = normalize(active_record_config)
+
+            # Hashes in Ruby maintain insertion order
+            _, config = @configurations.reverse_each.find do |matcher, _|
+              matcher.none? do |key, value|
+                value != hash[key]
+              end
             end
+
+            config
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{db_config.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
+
+            nil
           end
 
-          def configurations
-            @configurations || ::ActiveRecord::Base.configurations
+          protected
+
+          def parse_matcher(matcher)
+            resolved_pattern = resolve_connection_key(matcher).symbolize_keys
+            normalized = normalize(resolved_pattern)
+
+            # Remove empty fields to allow for partial matching
+            normalized.reject! { |_, v| v.nil? }
+
+            normalized
+          rescue => e
+            Datadog.logger.error(
+              "Failed to resolve ActiveRecord configuration key #{matcher.inspect}. " \
+              "Cause: #{e.message} Source: #{e.backtrace.first}"
+            )
           end
 
           def connection_resolver
-            @resolver ||= begin
-              if defined?(::ActiveRecord::Base.configurations.resolve)
-                ::ActiveRecord::DatabaseConfigurations.new(configurations)
-              elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
-                ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
-              else
-                ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(configurations)
-              end
+            @resolver ||= if defined?(::ActiveRecord::Base.configurations.resolve)
+                            ::ActiveRecord::DatabaseConfigurations.new(active_record_configuration)
+                          elsif defined?(::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver)
+                            ::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          else
+                            ::Datadog::Vendor::ActiveRecord::ConnectionAdapters::ConnectionSpecification::Resolver.new(
+                              active_record_configuration
+                            )
+                          end
+          end
+
+          def resolve_connection_key(key)
+            result = connection_resolver.resolve(key)
+
+            if result.respond_to?(:configuration_hash) # Rails >= 6.1
+              result.configuration_hash
+            else # Rails < 6.1
+              result
             end
           end
 
-          def normalize(hash)
+          # Extract only fields we'd like to match
+          # from the ActiveRecord configuration.
+          def normalize(active_record_config)
             {
-              adapter: hash[:adapter],
-              host: hash[:host],
-              port: hash[:port],
-              database: hash[:database],
-              username: hash[:username]
+              adapter: active_record_config[:adapter],
+              host: active_record_config[:host],
+              port: active_record_config[:port],
+              database: active_record_config[:database],
+              username: active_record_config[:username]
             }
           end
         end

data/lib/ddtrace/contrib/aws/services.rb

@@ -99,6 +99,7 @@ module Datadog
         STS
         SWF
         ServiceCatalog
+        Schemas
         Shield
         SimpleDB
         Snowball

data/lib/ddtrace/contrib/configurable.rb

@@ -3,7 +3,11 @@ require 'ddtrace/contrib/configuration/settings'
 
 module Datadog
   module Contrib
-    # Defines configurable behavior for integrations
+    # Defines configurable behavior for integrations.
+    #
+    # This module is responsible for coordination between
+    # the configuration resolver and default configuration
+    # fallback.
     module Configurable
       def self.included(base)
         base.send(:include, InstanceMethods)
@@ -11,66 +15,86 @@ module Datadog
 
       # Configurable instance behavior for integrations
       module InstanceMethods
+        # Provides a new configuration instance for this integration.
+        #
+        # This method normally needs to be overridden for each integration
+        # as their settings, defaults and environment variables are
+        # specific for each integration.
+        #
+        # DEV(1.0): Rename to `new_configuration`, make it protected.
+        # DEV(1.0):
+        # DEV(1.0): This method always provides a new instance of the configuration object for
+        # DEV(1.0): the current integration, not the currently effective default configuration.
+        # DEV(1.0): This is a misnomer of its function.
+        # DEV(1.0):
+        # DEV(1.0): Unfortunately, change this would be a breaking change for all custom integrations,
+        # DEV(1.0): thus we have to be very intentional with the right time to make this change.
+        # DEV(1.0): Currently marking this for a 1.0 milestone.
         def default_configuration
           Configuration::Settings.new
         end
 
-        def reset_configuration!
-          @configurations = nil
-          @resolver = nil
-        end
+        # Get matching configuration by matcher.
+        # If no match, returns the default configuration instance.
+        def configuration(matcher = :default)
+          return default_configuration_instance if matcher == :default
 
-        # Get matching configuration for key.
-        # If no match, returns default configuration.
-        def configuration(key = :default)
-          configurations[configuration_key(key)]
+          resolver.get(matcher) || default_configuration_instance
         end
 
-        # If the key has matching configuration explicitly defined for it,
-        # then return true. Otherwise return false.
-        # Note: a resolver's resolve method should not return a fallback value
-        # See: https://github.com/DataDog/dd-trace-rb/issues/1204
-        def configuration_for?(key)
-          key = resolver.resolve(key) unless key == :default
-          configurations.key?(key)
+        # Resolves the matching configuration for integration-specific value.
+        # If no match, returns the default configuration instance.
+        def resolve(value)
+          return default_configuration_instance if value == :default
+
+          resolver.resolve(value) || default_configuration_instance
         end
 
+        # Returns all registered matchers and their respective configurations.
         def configurations
-          @configurations ||= {
-            default: default_configuration
-          }
+          resolver.configurations.merge(default: default_configuration_instance)
         end
 
-        # Create or update configuration with provided settings.
-        def configure(key, options = {}, &block)
-          key ||= :default
-
-          # Get or add the configuration
-          config = configuration_for?(key) ? configuration(key) : add_configuration(key)
+        # Create or update configuration associated with `matcher` with
+        # the provided `options` and `&block`.
+        def configure(matcher = :default, options = {}, &block)
+          config = if matcher == :default
+                     default_configuration_instance
+                   else
+                     # Get or add the configuration
+                     resolver.get(matcher) || resolver.add(matcher, default_configuration)
+                   end
 
           # Apply the settings
           config.configure(options, &block)
           config
         end
 
-        protected
-
-        def resolver
-          @resolver ||= Configuration::Resolver.new
+        # Resets all configuration options
+        def reset_configuration!
+          @resolver = nil
+          @default_configuration = nil
         end
 
-        def add_configuration(key)
-          resolver.add(key)
-          config_key = resolver.resolve(key)
-          configurations[config_key] = default_configuration
-        end
+        protected
 
-        def configuration_key(key)
-          return :default if key.nil? || key == :default
+        # DEV(1.0): Rename to `default_configuration`, make it public.
+        # DEV(1.0): See comment on `default_configuration` for more information.
+        def default_configuration_instance
+          @default_configuration ||= default_configuration # rubocop:disable Naming/MemoizedInstanceVariableName
+        end
 
-          key = resolver.resolve(key)
-          key = :default unless configurations.key?(key)
-          key
+        # Overridable configuration resolver.
+        #
+        # This resolver is responsible for performing the matching
+        # of `#configure(matcher)` `matcher`s with `value`s provided
+        # in subsequent calls to `#resolve(value)`.
+        #
+        # By default, the `value` in `#resolve(value)` must be equal
+        # to the `matcher` object provided in `#configure(matcher)`
+        # to retrieve the associated configuration.
+        def resolver
+          @resolver ||= Configuration::Resolver.new
         end
       end
     end

data/lib/ddtrace/contrib/configuration/resolver.rb

@@ -1,14 +1,79 @@
 module Datadog
   module Contrib
     module Configuration
-      # Resolves a configuration key to a Datadog::Contrib::Configuration:Settings object
+      # Resolves an integration-specific matcher to an associated
+      # object.
+      #
+      # Integrations that perform any configuration matching
+      # based on patterns might want to override this class
+      # to provide richer matching. For example, match configuration
+      # based on: HTTP request parameters, request headers,
+      # async queue name.
+      #
+      # When overriding this class, for simple use cases, only
+      # overriding `#parse_matcher` might suffice. See
+      # `#parse_matcher`'s documentation for more information.
       class Resolver
-        def resolve(key)
-          key
+        attr_reader :configurations
+
+        def initialize
+          @configurations = {}
+        end
+
+        # Adds a new `matcher`, associating with it a `value`.
+        #
+        # This `value` is returned when `#resolve` is called
+        # with a matching value for this matcher. When multiple
+        # matchers would match, `#resolve` returns the latest
+        # added one.
+        #
+        # The `matcher` can be transformed internally by the
+        # `#parse_matcher` method before being stored.
+        #
+        # The `value` can also be retrieved by calling `#get`
+        # with the same `matcher` added by this method.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @param [Object] value arbitrary value to be associated with `matcher`
+        def add(matcher, value)
+          @configurations[parse_matcher(matcher)] = value
+        end
+
+        # Retrieves the stored value for a `matcher`
+        # previously stored by `#add`.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @return [Object] previously stored `value` from `#add`, or `nil` if not found
+        def get(matcher)
+          @configurations[parse_matcher(matcher)]
+        end
+
+        # Matches an arbitrary value against the configured
+        # matchers previously set with `#add`.
+        #
+        # If multiple matchers would match, returns the latest one.
+        #
+        # @param [Object] value integration-specific value
+        # @return [Object] matching `value` configured at `#add`, or `nil` if none match
+        def resolve(value)
+          @configurations[value]
         end
 
-        def add(key)
-          key
+        protected
+
+        # Converts `matcher` into an appropriate key
+        # for the internal Hash storage.
+        #
+        # It's recommended to override this method,
+        # instead of the public methods, if the
+        # integration can simply convert both
+        # `matcher` (provided to `#add`) and `value`
+        # (provided to `#resolve`) to the same value.
+        #
+        # @param [Object] matcher integration-specific matcher
+        # @return [Object] processed matcher
+        def parse_matcher(matcher)
+          matcher
         end
       end
     end

data/lib/ddtrace/contrib/configuration/resolvers/pattern_resolver.rb

@@ -5,30 +5,32 @@ module Datadog
     module Configuration
       # Resolves a value to a configuration key
       module Resolvers
-        # Matches strings against Regexps.
-        class PatternResolver < Datadog::Contrib::Configuration::Resolver
-          def resolve(name)
-            return if patterns.empty?
+        # Matches Strings and Regexps against `object.to_s` objects
+        # and Procs against plain objects.
+        class PatternResolver < Contrib::Configuration::Resolver
+          def resolve(value)
+            return if configurations.empty?
 
             # Try to find a matching pattern
-            patterns.find do |pattern|
-              if pattern.is_a?(Proc)
-                (pattern === name)
-              else
-                (pattern === name.to_s) ||
-                  (pattern == name) # Only required during configuration time.
-              end
+            _, config = configurations.reverse_each.find do |matcher, _|
+              matcher === if matcher.is_a?(Proc)
+                            value
+                          else
+                            value.to_s
+                          end
             end
-          end
 
-          def add(pattern)
-            patterns << (pattern.is_a?(Regexp) || pattern.is_a?(Proc) ? pattern : pattern.to_s)
+            config
           end
 
-          private
+          protected
 
-          def patterns
-            @patterns ||= Set.new
+          def parse_matcher(matcher)
+            if matcher.is_a?(Regexp) || matcher.is_a?(Proc)
+              matcher
+            else
+              matcher.to_s
+            end
           end
         end
       end