ddtrace 1.12.1 → 1.13.0

data/lib/datadog/appsec/extensions.rb

@@ -8,136 +8,7 @@ module Datadog
     module Extensions
       # Inject AppSec into global objects.
       def self.activate!
-        Core::Configuration::Settings.include(Settings)
-      end
-
-      # Global Datadog configuration mixin
-      module Settings
-        # Exposes AppSec settings through the
-        # `Datadog.configure {|c| c.appsec._option_ }`
-        # configuration path.
-        def appsec
-          @appsec ||= AppSecAdapter.new(AppSec.settings)
-        end
-      end
-
-      # Merges {Datadog::AppSec::Configuration::Settings} and {Datadog::AppSec::Configuration::DSL}
-      # into a single read/write object.
-      class AppSecAdapter
-        def initialize(settings)
-          @settings = settings
-        end
-
-        # Writer methods
-
-        def instrument(name, _unused = {})
-          dsl = AppSec::Configuration::DSL.new
-          dsl.instrument(name)
-          @settings.merge(dsl)
-        end
-
-        def enabled=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.enabled = arg
-          @settings.merge(dsl)
-        end
-
-        def ruleset=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.ruleset = arg
-          @settings.merge(dsl)
-        end
-
-        def ip_denylist=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.ip_denylist = arg
-          @settings.merge(dsl)
-        end
-
-        def user_id_denylist=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.user_id_denylist = arg
-          @settings.merge(dsl)
-        end
-
-        def waf_timeout=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.waf_timeout = arg
-          @settings.merge(dsl)
-        end
-
-        def waf_debug=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.waf_debug = arg
-          @settings.merge(dsl)
-        end
-
-        def trace_rate_limit=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.trace_rate_limit = arg
-          @settings.merge(dsl)
-        end
-
-        def obfuscator_key_regex=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.obfuscator_key_regex = arg
-          @settings.merge(dsl)
-        end
-
-        def obfuscator_value_regex=(arg)
-          dsl = AppSec::Configuration::DSL.new
-          dsl.obfuscator_value_regex = arg
-          @settings.merge(dsl)
-        end
-
-        # Reader methods
-
-        def enabled
-          @settings.enabled
-        end
-
-        def ruleset
-          @settings.ruleset
-        end
-
-        def ip_denylist
-          @settings.ip_denylist
-        end
-
-        def user_id_denylist
-          @settings.user_id_denylist
-        end
-
-        def waf_timeout
-          @settings.waf_timeout
-        end
-
-        def waf_debug
-          @settings.waf_debug
-        end
-
-        def trace_rate_limit
-          @settings.trace_rate_limit
-        end
-
-        def obfuscator_key_regex
-          @settings.obfuscator_key_regex
-        end
-
-        def obfuscator_value_regex
-          @settings.obfuscator_key_regex
-        end
-
-        def merge(arg)
-          @settings.merge(arg)
-        end
-
-        private
-
-        # Restore to original state, for testing only.
-        def reset!
-          @settings.send(:reset!)
-        end
+        Core::Configuration::Settings.extend(Configuration::Settings)
       end
     end
   end

data/lib/datadog/appsec/monitor/reactive/set_user.rb

@@ -29,7 +29,7 @@ module Datadog
                 'usr.id' => user_id,
               }
 
-              waf_timeout = Datadog::AppSec.settings.waf_timeout
+              waf_timeout = Datadog.configuration.appsec.waf_timeout
               result = waf_context.run(waf_args, waf_timeout)
 
               Datadog.logger.debug { "WAF TIMEOUT: #{result.inspect}" } if result.timeout

data/lib/datadog/appsec/processor.rb

@@ -48,7 +48,7 @@ module Datadog
       def initialize(ruleset:)
         @ruleset_info = nil
         @addresses = []
-        settings = Datadog::AppSec.settings
+        settings = Datadog.configuration.appsec
 
         unless load_libddwaf && create_waf_handle(settings, ruleset)
           Datadog.logger.warn { 'AppSec is disabled, see logged errors above' }

data/lib/datadog/appsec/rate_limiter.rb

@@ -50,7 +50,7 @@ module Datadog
         end
 
         def trace_rate_limit
-          Datadog::AppSec.settings.trace_rate_limit
+          Datadog.configuration.appsec.trace_rate_limit
         end
       end
     end

data/lib/datadog/appsec/remote.rb

@@ -105,7 +105,7 @@ module Datadog
         private
 
         def remote_features_enabled?
-          Datadog::AppSec.send(:default_setting?, :ruleset)
+          Datadog.configuration.appsec.using_default?(:ruleset)
         end
 
         def parse_content(content)

data/lib/datadog/appsec.rb

@@ -8,8 +8,6 @@ require_relative 'appsec/ext'
 module Datadog
   # Namespace for Datadog AppSec instrumentation
   module AppSec
-    include Configuration
-
     class << self
       def enabled?
         Datadog.configuration.appsec.enabled
@@ -57,5 +55,6 @@ end
 require_relative 'appsec/contrib/rack/integration'
 require_relative 'appsec/contrib/sinatra/integration'
 require_relative 'appsec/contrib/rails/integration'
+require_relative 'appsec/contrib/devise/integration'
 
 require_relative 'appsec/autoload'

data/lib/datadog/ci/configuration/settings.rb

@@ -16,8 +16,9 @@ module Datadog
           base.class_eval do
             settings :ci do
               option :enabled do |o|
-                o.default { env_to_bool(CI::Ext::Settings::ENV_MODE_ENABLED, false) }
-                o.lazy
+                o.type :bool
+                o.env CI::Ext::Settings::ENV_MODE_ENABLED
+                o.default false
               end
 
               # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
@@ -35,14 +36,11 @@ module Datadog
               # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
               alias_method :use, :instrument
 
-              option :trace_flush do |o|
-                o.default { nil }
-                o.lazy
-              end
+              option :trace_flush
 
               option :writer_options do |o|
-                o.default { {} }
-                o.lazy
+                o.type :hash
+                o.default({})
               end
             end
           end

data/lib/datadog/ci/contrib/cucumber/configuration/settings.rb

@@ -12,18 +12,20 @@ module Datadog
           # TODO: mark as `@public_api` when GA
           class Settings < Datadog::Tracing::Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
             option :service_name do |o|
+              o.type :string
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
-              o.lazy
             end
 
             option :operation_name do |o|
-              o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-              o.lazy
+              o.type :string
+              o.env Ext::ENV_OPERATION_NAME
+              o.default Ext::OPERATION_NAME
             end
           end
         end

data/lib/datadog/ci/contrib/cucumber/ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module CI
     module Contrib
@@ -5,14 +7,14 @@ module Datadog
         # Cucumber integration constants
         # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
         module Ext
-          APP = 'cucumber'.freeze
-          ENV_ENABLED = 'DD_TRACE_CUCUMBER_ENABLED'.freeze
-          ENV_OPERATION_NAME = 'DD_TRACE_CUCUMBER_OPERATION_NAME'.freeze
-          FRAMEWORK = 'cucumber'.freeze
-          OPERATION_NAME = 'cucumber.test'.freeze
-          SERVICE_NAME = 'cucumber'.freeze
-          STEP_SPAN_TYPE = 'step'.freeze
-          TEST_TYPE = 'test'.freeze
+          APP = 'cucumber'
+          ENV_ENABLED = 'DD_TRACE_CUCUMBER_ENABLED'
+          ENV_OPERATION_NAME = 'DD_TRACE_CUCUMBER_OPERATION_NAME'
+          FRAMEWORK = 'cucumber'
+          OPERATION_NAME = 'cucumber.test'
+          SERVICE_NAME = 'cucumber'
+          STEP_SPAN_TYPE = 'step'
+          TEST_TYPE = 'test'
         end
       end
     end

data/lib/datadog/ci/contrib/minitest/configuration/settings.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../../../../tracing/contrib/configuration/settings'
+require_relative '../ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Configuration
+          # Custom settings for the Minitest integration
+          # TODO: mark as `@public_api` when GA
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :service_name do |o|
+              o.type :string
+              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
+            end
+
+            option :operation_name do |o|
+              o.type :string
+              o.env Ext::ENV_OPERATION_NAME
+              o.default Ext::OPERATION_NAME
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/ext.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Minitest integration constants
+        # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
+        module Ext
+          APP = 'minitest'
+          ENV_ENABLED = 'DD_TRACE_MINITEST_ENABLED'
+          ENV_OPERATION_NAME = 'DD_TRACE_MINITEST_OPERATION_NAME'
+          FRAMEWORK = 'minitest'
+          OPERATION_NAME = 'minitest.test'
+          SERVICE_NAME = 'minitest'
+          TEST_TYPE = 'test'
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/integration.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../../../tracing/contrib/integration'
+
+require_relative 'configuration/settings'
+require_relative 'patcher'
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Description of Minitest integration
+        class Integration
+          include Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new('5.0.0')
+
+          register_as :minitest, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs['minitest'] \
+              && Gem.loaded_specs['minitest'].version
+          end
+
+          def self.loaded?
+            !defined?(::Minitest).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # test environments should not auto instrument test libraries
+          def auto_instrument?
+            false
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/patcher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../../tracing/contrib/patcher'
+require_relative 'test_helper'
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Patcher enables patching of 'minitest' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Minitest::Test.include(TestHelper)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/test_helper.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative 'ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Instrument Minitest::Test
+        module TestHelper
+          def before_setup
+            super
+            return unless configuration[:enabled]
+
+            test_name = "#{class_name}##{name}"
+
+            path, = method(name).source_location
+            test_suite = Pathname.new(path).relative_path_from(Pathname.pwd).to_s
+
+            span = CI::Test.trace(
+              configuration[:operation_name],
+              {
+                span_options: {
+                  resource: test_name,
+                  service: configuration[:service_name],
+                },
+                framework: Ext::FRAMEWORK,
+                framework_version: CI::Contrib::Minitest::Integration.version.to_s,
+                test_name: test_name,
+                test_suite: test_suite,
+                test_type: Ext::TEST_TYPE,
+              },
+            )
+
+            Thread.current[:_datadog_test_span] = span
+          end
+
+          def after_teardown
+            span = Thread.current[:_datadog_test_span]
+            return super unless span
+
+            Thread.current[:_datadog_test_span] = nil
+
+            case result_code
+            when '.'
+              CI::Test.passed!(span)
+            when 'E', 'F'
+              CI::Test.failed!(span, failure)
+            when 'S'
+              CI::Test.skipped!(span)
+              span.set_tag(CI::Ext::Test::TAG_SKIP_REASON, failure.message)
+            end
+
+            span.finish
+
+            super
+          end
+
+          private
+
+          def configuration
+            ::Datadog.configuration.ci[:minitest]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/configuration/settings.rb

@@ -12,18 +12,20 @@ module Datadog
           # TODO: mark as `@public_api` when GA
           class Settings < Datadog::Tracing::Contrib::Configuration::Settings
             option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
             end
 
             option :service_name do |o|
+              o.type :string
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
-              o.lazy
             end
 
             option :operation_name do |o|
-              o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-              o.lazy
+              o.type :string
+              o.env Ext::ENV_OPERATION_NAME
+              o.default Ext::OPERATION_NAME
             end
           end
         end

data/lib/datadog/ci/contrib/rspec/ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module CI
     module Contrib
@@ -5,13 +7,13 @@ module Datadog
         # RSpec integration constants
         # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
         module Ext
-          APP = 'rspec'.freeze
-          ENV_ENABLED = 'DD_TRACE_RSPEC_ENABLED'.freeze
-          ENV_OPERATION_NAME = 'DD_TRACE_RSPEC_OPERATION_NAME'.freeze
-          FRAMEWORK = 'rspec'.freeze
-          OPERATION_NAME = 'rspec.example'.freeze
-          SERVICE_NAME = 'rspec'.freeze
-          TEST_TYPE = 'test'.freeze
+          APP = 'rspec'
+          ENV_ENABLED = 'DD_TRACE_RSPEC_ENABLED'
+          ENV_OPERATION_NAME = 'DD_TRACE_RSPEC_OPERATION_NAME'
+          FRAMEWORK = 'rspec'
+          OPERATION_NAME = 'rspec.example'
+          SERVICE_NAME = 'rspec'
+          TEST_TYPE = 'test'
         end
       end
     end

data/lib/datadog/ci.rb

@@ -14,6 +14,7 @@ end
 # Integrations
 require_relative 'ci/contrib/cucumber/integration'
 require_relative 'ci/contrib/rspec/integration'
+require_relative 'ci/contrib/minitest/integration'
 
 # Extensions
 require_relative 'ci/extensions'

data/lib/datadog/core/backport.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    # This module is used to provide features from Ruby 2.5+ to older Rubies
+    module BackportFrom25
+      if ::String.method_defined?(:delete_prefix)
+        def self.string_delete_prefix(string, prefix)
+          string.delete_prefix(prefix)
+        end
+      else
+        def self.string_delete_prefix(string, prefix)
+          prefix = prefix.to_s
+          if string.start_with?(prefix)
+            string[prefix.length..-1] || raise('rbs-guard: String#[] is non-nil as `prefix` is guaranteed present')
+          else
+            string.dup
+          end
+        end
+      end
+    end
+
+    # This module is used to provide features from Ruby 2.4+ to older Rubies
+    module BackportFrom24
+      if RUBY_VERSION < '2.4'
+        def self.dup(value)
+          case value
+          when NilClass, TrueClass, FalseClass, Numeric
+            value
+          else
+            value.dup
+          end
+        end
+      else
+        def self.dup(value)
+          value.dup
+        end
+      end
+
+      if ::Hash.method_defined?(:compact!)
+        def self.hash_compact!(hash)
+          hash.compact!
+        end
+      else
+        def self.hash_compact!(hash)
+          hash.reject! { |_key, value| value.nil? }
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/configuration/base.rb

@@ -25,25 +25,25 @@ module Datadog
           # e.g. `settings :foo { option :bar }` --> `config.foo.bar`
           # @param [Symbol] name option name. Methods will be created based on this name.
           def settings(name, &block)
-            settings_class = new_settings_class(&block)
+            settings_class = new_settings_class(name, &block)
 
             option(name) do |o|
               o.default { settings_class.new }
-              o.lazy
 
               o.resetter do |value|
                 value.reset! if value.respond_to?(:reset!)
                 value
               end
-
-              o.type settings_class
             end
+
+            settings_class
           end
 
           private
 
-          def new_settings_class(&block)
+          def new_settings_class(name, &block)
             Class.new { include Configuration::Base }.tap do |klass|
+              klass.instance_variable_set(:@settings_name, name)
               klass.instance_eval(&block) if block
             end
           end

data/lib/datadog/core/configuration/components.rb

@@ -59,10 +59,15 @@ module Datadog
               logger.debug { "Telemetry disabled. Agent network adapter not supported: #{agent_settings.adapter}" }
             end
 
-            Telemetry::Client.new(enabled: enabled)
+            Telemetry::Client.new(
+              enabled: enabled,
+              heartbeat_interval_seconds: settings.telemetry.heartbeat_interval_seconds
+            )
           end
         end
 
+        include Datadog::Tracing::Component::InstanceMethods
+
         attr_reader \
           :health_metrics,
           :logger,

data/lib/datadog/core/configuration/ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Configuration
@@ -6,17 +8,17 @@ module Datadog
       module Ext
         # @public_api
         module Diagnostics
-          ENV_DEBUG_ENABLED = 'DD_TRACE_DEBUG'.freeze
-          ENV_HEALTH_METRICS_ENABLED = 'DD_HEALTH_METRICS_ENABLED'.freeze
-          ENV_STARTUP_LOGS_ENABLED = 'DD_TRACE_STARTUP_LOGS'.freeze
+          ENV_DEBUG_ENABLED = 'DD_TRACE_DEBUG'
+          ENV_HEALTH_METRICS_ENABLED = 'DD_HEALTH_METRICS_ENABLED'
+          ENV_STARTUP_LOGS_ENABLED = 'DD_TRACE_STARTUP_LOGS'
         end
 
         module Metrics
-          ENV_DEFAULT_PORT = 'DD_METRIC_AGENT_PORT'.freeze
+          ENV_DEFAULT_PORT = 'DD_METRIC_AGENT_PORT'
         end
 
         module Transport
-          ENV_DEFAULT_HOST = 'DD_AGENT_HOST'.freeze
+          ENV_DEFAULT_HOST = 'DD_AGENT_HOST'
         end
       end
     end