ddtrace 1.0.0.beta1 → 1.0.0.beta2

data/lib/datadog/appsec/contrib/sinatra/request_middleware.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Datadog
   module AppSec
     module Contrib

data/lib/datadog/appsec/event.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 require 'datadog/appsec/contrib/rack/request'
 require 'datadog/appsec/contrib/rack/response'
 require 'datadog/appsec/rate_limiter'
@@ -41,26 +43,20 @@ module Datadog
       end
 
       # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
       def self.record_via_span(*events)
-        events.group_by { |e| e[:root_span] }.each do |root_span, event_group|
-          unless root_span
-            Datadog.logger.debug { "{ error: 'no root span: cannot record', event_group: #{event_group.inspect}}" }
+        events.group_by { |e| e[:trace] }.each do |trace, event_group|
+          unless trace
+            Datadog.logger.debug { "{ error: 'no trace: cannot record', event_group: #{event_group.inspect}}" }
             next
           end
 
-          # TODO: this is a hack but there is no API to do that
-          root_span_tags = root_span.send(:meta).keys
+          trace.keep!
 
           # prepare and gather tags to apply
-          root_tags = event_group.each_with_object({}) do |event, tags|
+          trace_tags = event_group.each_with_object({}) do |event, tags|
             span = event[:span]
-            trace = event[:trace]
 
-            if span
-              span.set_tag('appsec.event', 'true')
-              trace.keep!
-            end
+            span.set_tag('appsec.event', 'true') if span
 
             request = event[:request]
             response = event[:response]
@@ -96,16 +92,15 @@ module Datadog
           # apply tags to root span
 
           # complex types are unsupported, we need to serialize to a string
-          triggers = root_tags.delete('_dd.appsec.triggers')
-          root_span.set_tag('_dd.appsec.json', JSON.dump({ triggers: triggers }))
+          triggers = trace_tags.delete('_dd.appsec.triggers')
+          trace.set_tag('_dd.appsec.json', JSON.dump({ triggers: triggers }))
 
-          root_tags.each do |key, value|
-            root_span.set_tag(key, value.is_a?(String) ? value.encode('UTf-8') : value) unless root_span_tags.include?(key)
+          trace_tags.each do |key, value|
+            trace.set_tag(key, value)
           end
         end
       end
       # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/datadog/appsec/extensions.rb

@@ -1,4 +1,5 @@
-# typed: true
+# typed: false
+
 require 'forwardable'
 require 'datadog/appsec/configuration'
 

data/lib/datadog/appsec/instrumentation/gateway.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Datadog
   module AppSec
     # Instrumentation for AppSec

data/lib/datadog/appsec/processor.rb

@@ -0,0 +1,121 @@
+# typed: ignore
+
+require 'datadog/appsec/assets'
+
+module Datadog
+  module AppSec
+    # Processor integrates libddwaf into datadog/appsec
+    class Processor
+      # Interface object to check using case .. when
+      module IOLike
+        def read; end
+        def rewind; end
+
+        def self.===(other)
+          instance_methods.all? { |meth| other.respond_to?(meth) }
+        end
+      end
+
+      def initialize
+        @ruleset = nil
+        @handle = nil
+
+        unless load_libddwaf && load_ruleset && create_waf_handle
+          Datadog.logger.warn { 'AppSec is disabled, see logged errors above' }
+        end
+      end
+
+      def ready?
+        !@ruleset.nil? && !@handle.nil?
+      end
+
+      def new_context
+        Datadog::AppSec::WAF::Context.new(@handle)
+      end
+
+      private
+
+      def load_libddwaf
+        Processor.require_libddwaf && Processor.libddwaf_provides_waf?
+      end
+
+      def load_ruleset
+        ruleset_setting = Datadog::AppSec.settings.ruleset
+
+        begin
+          @ruleset = case ruleset_setting
+                     when :recommended, :risky, :strict
+                       JSON.parse(Datadog::AppSec::Assets.waf_rules(ruleset_setting))
+                     when String
+                       JSON.parse(File.read(ruleset_setting))
+                     when IOLike
+                       JSON.parse(ruleset_setting.read).tap { ruleset_setting.rewind }
+                     when Hash
+                       ruleset_setting
+                     else
+                       raise ArgumentError, "unsupported value for ruleset setting: #{ruleset_setting.inspect}"
+                     end
+
+          true
+        rescue StandardError => e
+          Datadog.logger.error do
+            "libddwaf ruleset failed to load, ruleset: #{ruleset_setting.inspect} error: #{e.inspect}"
+          end
+
+          false
+        end
+      end
+
+      def create_waf_handle
+        # TODO: this may need to be reset if the main Datadog logging level changes after initialization
+        Datadog::AppSec::WAF.logger = Datadog.logger if Datadog.logger.debug? && Datadog::AppSec.settings.waf_debug
+
+        @handle = Datadog::AppSec::WAF::Handle.new(@ruleset)
+
+        true
+      rescue StandardError => e
+        Datadog.logger.error do
+          "libddwaf failed to initialize, error: #{e.inspect}"
+        end
+
+        false
+      end
+
+      class << self
+        # check whether libddwaf is required *and* able to provide the needed feature
+        def libddwaf_provides_waf?
+          defined?(Datadog::AppSec::WAF) ? true : false
+        end
+
+        # libddwaf raises a LoadError on unsupported platforms; it may at some
+        # point succeed in being required yet not provide a specific needed feature.
+        def require_libddwaf
+          Datadog.logger.debug { "libddwaf platform: #{libddwaf_platform}" }
+
+          require 'libddwaf'
+
+          true
+        rescue LoadError => e
+          Datadog.logger.error do
+            'libddwaf failed to load,' \
+              "installed platform: #{libddwaf_platform} ruby platforms: #{ruby_platforms} error: #{e.inspect}"
+          end
+
+          false
+        end
+
+        def libddwaf_spec
+          Gem.loaded_specs['libddwaf']
+        end
+
+        def libddwaf_platform
+          libddwaf_spec ? libddwaf_spec.platform.to_s : 'unknown'
+        end
+
+        def ruby_platforms
+          Gem.platforms.map(&:to_s)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/appsec/rate_limiter.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Datadog
   module AppSec
     # Simple per-thread rate limiter

data/lib/datadog/appsec/reactive/address_hash.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Datadog
   module AppSec
     module Reactive

data/lib/datadog/appsec/reactive/engine.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'datadog/appsec/reactive/address_hash'
 require 'datadog/appsec/reactive/subscriber'
 

data/lib/datadog/appsec/reactive/operation.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 require 'datadog/appsec'
 require 'datadog/appsec/reactive/engine'
 

data/lib/datadog/appsec/reactive/subscriber.rb

@@ -1,3 +1,5 @@
+# typed: true
+
 module Datadog
   module AppSec
     module Reactive

data/lib/datadog/appsec.rb

@@ -1,3 +1,5 @@
+# typed: false
+
 require 'datadog/appsec/configuration'
 require 'datadog/appsec/extensions'
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/ci/flush'
 
 module Datadog

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/ci/ext/settings'
 
 module Datadog
@@ -20,9 +21,15 @@ module Datadog
               end
 
               # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
-              # DEV: Should be removed when `c.ci.instrument` namespacing is complete.
+              # DEV: Should be removed when CI implement its own `c.ci.instrument`.
               define_method(:instrument) do |integration_name, options = {}, &block|
-                Datadog.configuration.send(:instrument, integration_name, options, &block)
+                Datadog.configuration.tracing.instrument(integration_name, options, &block)
+              end
+
+              # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
+              # DEV: Should be removed when CI implement its own `c.ci[]`.
+              define_method(:[]) do |integration_name, key = :default|
+                Datadog.configuration.tracing[integration_name, key]
               end
 
               # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/ci/contrib/cucumber/ext'
 

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module CI
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/ci/test'
 require 'datadog/ci/ext/app_types'
 require 'datadog/ci/ext/environment'
@@ -84,7 +85,7 @@ module Datadog
           private
 
           def configuration
-            Datadog.configuration[:cucumber]
+            Datadog.configuration.ci[:cucumber]
           end
         end
       end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/ci/contrib/cucumber/formatter'
 
 module Datadog

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 
 require 'datadog/ci/contrib/cucumber/configuration/settings'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/contrib/patcher'
 require 'datadog/ci/contrib/cucumber/instrumentation'
 

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/configuration/settings'
 require 'datadog/ci/contrib/rspec/ext'
 

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/ci/test'
 
 require 'datadog/ci/ext/app_types'
@@ -37,7 +38,7 @@ module Datadog
                   framework: Ext::FRAMEWORK,
                   framework_version: CI::Contrib::RSpec::Integration.version.to_s,
                   test_name: test_name,
-                  test_suite: file_path,
+                  test_suite: metadata[:example_group][:file_path],
                   test_type: Ext::TEST_TYPE
                 }
               ) do |span|
@@ -59,7 +60,7 @@ module Datadog
             private
 
             def configuration
-              Datadog.configuration[:rspec]
+              Datadog.configuration.ci[:rspec]
             end
           end
         end

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module CI
     module Contrib

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

@@ -1,4 +1,5 @@
 # typed: false
+
 require 'datadog/tracing/contrib/integration'
 
 require 'datadog/ci/contrib/rspec/configuration/settings'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/contrib/patcher'
 require 'datadog/ci/contrib/rspec/example'
 

data/lib/datadog/ci/ext/app_types.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module CI
     module Ext

data/lib/datadog/ci/ext/environment.rb

@@ -1,6 +1,7 @@
-# typed: true
 # frozen_string_literal: true
 
+# typed: true
+
 require 'datadog/core/git/ext'
 
 require 'open3'

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

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module CI
     module Ext

data/lib/datadog/ci/ext/test.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 module Datadog
   module CI
     module Ext

data/lib/datadog/ci/extensions.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/configuration/settings'
 require 'datadog/core/configuration/components'
 

data/lib/datadog/ci/flush.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/tracing/metadata/ext'
 require 'datadog/tracing/flush'
 

data/lib/datadog/ci/test.rb

@@ -1,6 +1,7 @@
-# typed: false
 # frozen_string_literal: true
 
+# typed: false
+
 require 'datadog/tracing/contrib/analytics'
 
 require 'datadog/ci/ext/app_types'

data/lib/datadog/ci.rb

@@ -1,6 +1,8 @@
-# typed: false
+# typed: strict
+
 require 'datadog/core'
 require 'datadog/tracing'
+require 'datadog/tracing/contrib'
 
 module Datadog
   # Namespace for Datadog CI instrumentation:

data/lib/datadog/core/buffer/cruby.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/buffer/random'
 
 module Datadog

data/lib/datadog/core/buffer/thread_safe.rb

@@ -1,4 +1,5 @@
 # typed: true
+
 require 'datadog/core/buffer/random'
 
 module Datadog