ddtrace 1.10.1 → 1.11.0

data/lib/datadog/core/remote/configuration/target.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative 'path'
+require_relative 'digest'
+
+module Datadog
+  module Core
+    module Remote
+      class Configuration
+        # TargetMap stores information regarding Configuration::Path and Configuration::Target
+        class TargetMap < Hash
+          class << self
+            def parse(hash)
+              opaque_backend_state = hash['signed']['custom']['opaque_backend_state']
+              version = hash['signed']['version']
+
+              map = new
+
+              map.instance_eval do
+                @opaque_backend_state = opaque_backend_state
+                @version = version
+              end
+
+              hash['signed']['targets'].each_with_object(map) do |(p, t), m|
+                path = Configuration::Path.parse(p)
+                target = Configuration::Target.parse(t)
+
+                m[path] = target
+              end
+            end
+          end
+
+          attr_reader :opaque_backend_state, :version
+
+          def initialize
+            super
+
+            @opaque_backend_state = nil
+            @version = nil
+          end
+
+          private_class_method :new
+        end
+
+        # Target stores digest information
+        class Target
+          class << self
+            def parse(hash)
+              length = Integer(hash['length'])
+              digests = Configuration::DigestList.parse(hash['hashes'])
+              version = Integer(hash['custom']['v'])
+
+              new(digests: digests, length: length, version: version)
+            end
+          end
+
+          attr_reader :length, :digests, :version
+
+          def initialize(digests:, length:, version:)
+            @digests = digests
+            @length = length
+            @version = version
+          end
+
+          private_class_method :new
+
+          def check(content)
+            digests.check(content)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'configuration/path'
+require_relative 'configuration/content'
+require_relative 'configuration/target'
+require_relative 'configuration/repository'
+
+module Datadog
+  module Core
+    module Remote
+      # Configuration
+      # rubocop:disable Lint/EmptyClass
+      class Configuration
+      end
+      # rubocop:enable Lint/EmptyClass
+    end
+  end
+end

data/lib/datadog/core/remote/dispatcher.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Remote
+      # Repository update dispatcher
+      class Dispatcher
+        attr_reader :receivers
+
+        def initialize
+          @receivers = []
+        end
+
+        def dispatch(changes, repository)
+          receivers.each do |receiver|
+            matching_changes = changes.select { |c| receiver.match?(c.path) }
+
+            receiver.call(repository, matching_changes) if matching_changes.any?
+          end
+        end
+
+        # Store Matcher and block to be executed on a match
+        class Receiver
+          def initialize(matcher, &block)
+            @block = block
+            @matcher = matcher
+          end
+
+          def match?(path)
+            @matcher.match?(path)
+          end
+
+          def call(repository, changes)
+            @block.call(repository, changes)
+          end
+        end
+
+        # Matcher checks if the path matches
+        class Matcher
+          def initialize(&block)
+            @block = block
+          end
+
+          def match?(path)
+            @block.call(path)
+          end
+
+          # Matches on the produc's path
+          class Product < Matcher
+            def initialize(products)
+              block = ->(path) { products.include?(path.product) }
+              super(&block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Remote
+      module Ext
+        ENV_ENABLED = 'DD_REMOTE_CONFIGURATION_ENABLED'
+        ENV_POLL_INTERVAL_SECONDS = 'DD_REMOTE_CONFIGURATION_POLL_INTERVAL_SECONDS'
+      end
+    end
+  end
+end

data/lib/datadog/core/remote/negotiation.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative '../transport/http'
+
+module Datadog
+  module Core
+    module Remote
+      # Endpoint negotiation
+      class Negotiation
+        def initialize(_settings, agent_settings)
+          transport_options = {}
+          transport_options[:agent_settings] = agent_settings if agent_settings
+
+          @transport_root = Datadog::Core::Transport::HTTP.root(**transport_options.dup)
+        end
+
+        def endpoint?(path)
+          res = @transport_root.send_info
+
+          if res.internal_error? && network_error?(res.error)
+            Datadog.logger.error { "agent unreachable: cannot negotiate #{path}" }
+
+            return false
+          end
+
+          if res.not_found?
+            Datadog.logger.error { "agent reachable but has no /info endpoint: cannot negotiate #{path}" }
+
+            return false
+          end
+
+          unless res.ok?
+            Datadog.logger.error { "agent reachable but unexpected response: cannot negotiate #{path}" }
+
+            return false
+          end
+
+          unless res.endpoints.include?(path)
+            Datadog.logger.error { "agent reachable but does not report #{path}" }
+
+            return false
+          end
+
+          Datadog.logger.debug { "agent reachable and reports #{path}" }
+
+          true
+        end
+
+        private
+
+        def network_error?(error)
+          error.is_a?(Errno::ECONNREFUSED)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/remote/worker.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    module Remote
+      # Worker executes a block every interval on a separate Thread
+      class Worker
+        def initialize(interval:, &block)
+          @mutex = Mutex.new
+          @thr = nil
+
+          @starting = false
+          @stopping = false
+          @started = false
+
+          @interval = interval
+          raise ArgumentError, 'can not initialize a worker without a block' unless block
+
+          @block = block
+        end
+
+        def start
+          Datadog.logger.debug { 'remote worker starting' }
+
+          acquire_lock
+
+          return if @starting || @started
+
+          @starting = true
+
+          @thr = Thread.new { poll(@interval) }
+
+          @started = true
+          @starting = false
+
+          Datadog.logger.debug { 'remote worker started' }
+        ensure
+          release_lock
+        end
+
+        def stop
+          Datadog.logger.debug { 'remote worker stopping' }
+
+          acquire_lock
+
+          @stopping = true
+
+          thread = @thr
+
+          if thread
+            thread.kill
+            thread.join
+          end
+
+          @started = false
+          @stopping = false
+          @thr = nil
+
+          Datadog.logger.debug { 'remote worker stopped' }
+        ensure
+          release_lock
+        end
+
+        def started?
+          @started
+        end
+
+        private
+
+        def acquire_lock
+          @mutex.lock
+        end
+
+        def release_lock
+          @mutex.unlock
+        end
+
+        def poll(interval)
+          loop do
+            break unless @mutex.synchronize { @starting || @started }
+
+            call
+
+            sleep(interval)
+          end
+        end
+
+        def call
+          Datadog.logger.debug { 'remote worker perform' }
+
+          @block.call
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/remote.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Datadog
+  module Core
+    # Module to interact with core remote component
+    module Remote
+      class << self
+        def active_remote
+          remote
+        end
+
+        private
+
+        def components
+          Datadog.send(:components)
+        end
+
+        def remote
+          components.remote
+        end
+      end
+    end
+  end
+end

data/lib/datadog/core/telemetry/collector.rb

@@ -5,6 +5,7 @@ require 'etc'
 require_relative '../configuration/agent_settings_resolver'
 require_relative '../environment/ext'
 require_relative '../environment/platform'
+require_relative '../utils/hash'
 require_relative 'v1/application'
 require_relative 'v1/dependency'
 require_relative 'v1/host'
@@ -18,6 +19,7 @@ module Datadog
       # Module defining methods for collecting metadata for telemetry
       module Collector
         include Datadog::Core::Configuration
+        using Core::Utils::Hash::Refinement
 
         # Forms a hash of configuration key value pairs to be sent in the additional payload
         def additional_payload
@@ -41,12 +43,13 @@ module Datadog
 
         # Forms a hash of standard key value pairs to be sent in the app-started event configuration
         def configurations
-          configurations = {
+          hash = {
             DD_AGENT_HOST: Datadog.configuration.agent.host,
             DD_AGENT_TRANSPORT: agent_transport,
             DD_TRACE_SAMPLE_RATE: format_configuration_value(Datadog.configuration.tracing.sampling.default_rate),
           }
-          compact_hash(configurations)
+          hash.compact!
+          hash
         end
 
         # Forms a telemetry app-started dependencies object
@@ -134,7 +137,8 @@ module Datadog
           options['logger.instance'] = configuration.logger.instance.class.to_s
           options['appsec.enabled'] = configuration.dig('appsec', 'enabled') if configuration.respond_to?('appsec')
           options['tracing.opentelemetry.enabled'] = !defined?(Datadog::OpenTelemetry::LOADED).nil?
-          compact_hash(options)
+          options.compact!
+          options
         end
 
         def format_configuration_value(value)
@@ -147,11 +151,6 @@ module Datadog
           end
         end
 
-        # Manual implementation of hash.compact used because it is unsupported by older Ruby versions (<2.4)
-        def compact_hash(hash)
-          hash.delete_if { |_k, v| v.nil? }
-        end
-
         def env
           Datadog.configuration.env
         end
@@ -222,7 +221,7 @@ module Datadog
             desc += ", Patchable? #{integration.klass.class.patchable?}"
             desc
           else
-            patch_error_result.to_s
+            patch_error_result.compact.to_s
           end
         end
       end

data/lib/datadog/core/telemetry/heartbeat.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../worker'
 require_relative '../workers/polling'
 

data/lib/datadog/core/telemetry/http/env.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Telemetry

data/lib/datadog/core/telemetry/http/transport.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../configuration/settings'
 require_relative 'env'
 require_relative 'ext'

data/lib/datadog/core/telemetry/v1/app_event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datadog
   module Core
     module Telemetry

data/lib/datadog/core/telemetry/v1/application.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for application environment object
         class Application
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_LANGUAGE_NAME_MESSAGE = ':language_name must not be nil'.freeze
           ERROR_NIL_LANGUAGE_VERSION_MESSAGE = ':language_version must not be nil'.freeze
           ERROR_NIL_SERVICE_NAME_MESSAGE = ':service_name must not be nil'.freeze
@@ -54,7 +58,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               env: @env,
               language_name: @language_name,
               language_version: @language_version,
@@ -66,6 +70,8 @@ module Datadog
               service_version: @service_version,
               tracer_version: @tracer_version
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/telemetry/v1/dependency.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for dependency object
         class Dependency
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_NAME_MESSAGE = ':name must not be nil'.freeze
 
           attr_reader \
@@ -23,11 +27,13 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               hash: @hash,
               name: @name,
               version: @version
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/host.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for host object
         class Host
+          using Core::Utils::Hash::Refinement
+
           attr_reader \
             :container_id,
             :hostname,
@@ -34,7 +40,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               container_id: @container_id,
               hostname: @hostname,
               kernel_name: @kernel_name,
@@ -43,6 +49,8 @@ module Datadog
               os: @os,
               os_version: @os_version,
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/integration.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for integration object
         class Integration
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_ENABLED_MESSAGE = ':enabled must not be nil'.freeze
           ERROR_NIL_NAME_MESSAGE = ':name must not be nil'.freeze
 
@@ -32,7 +36,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               auto_enabled: @auto_enabled,
               compatible: @compatible,
               enabled: @enabled,
@@ -40,6 +44,8 @@ module Datadog
               name: @name,
               version: @version
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/telemetry/v1/product.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for products object
         class Product
+          using Core::Utils::Hash::Refinement
+
           attr_reader \
             :appsec,
             :profiler
@@ -16,10 +22,12 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               appsec: @appsec,
               profiler: @profiler
             }
+            hash.compact!
+            hash
           end
         end
       end

data/lib/datadog/core/telemetry/v1/telemetry_request.rb

@@ -1,9 +1,13 @@
+require_relative '../../utils/hash'
+
 module Datadog
   module Core
     module Telemetry
       module V1
         # Describes attributes for telemetry API request
         class TelemetryRequest
+          using Core::Utils::Hash::Refinement
+
           ERROR_NIL_API_VERSION_MESSAGE = ':api_version must not be nil'.freeze
           ERROR_NIL_APPLICATION_MESSAGE = ':application must not be nil'.freeze
           ERROR_NIL_HOST_MESSAGE = ':host must not be nil'.freeze
@@ -64,7 +68,7 @@ module Datadog
           end
 
           def to_h
-            {
+            hash = {
               api_version: @api_version,
               application: @application.to_h,
               debug: @debug,
@@ -76,6 +80,8 @@ module Datadog
               session_id: @session_id,
               tracer_time: @tracer_time
             }
+            hash.compact!
+            hash
           end
 
           private

data/lib/datadog/core/transport/config.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative '../../../ddtrace/transport/request'
+require_relative '../../../ddtrace/transport/parcel'
+
+module Datadog
+  module Core
+    module Transport
+      module Config
+        # Data transfer object for encoded traces
+        class EncodedParcel
+          include Datadog::Transport::Parcel
+
+          def count
+            data.length
+          end
+        end
+
+        # Config request
+        class Request < Datadog::Transport::Request
+        end
+
+        # Config response
+        module Response
+          attr_reader :roots, :targets, :target_files, :client_configs
+
+          def empty?
+            @empty
+          end
+        end
+
+        # Config transport
+        class Transport
+          attr_reader :client, :apis, :default_api, :current_api_id
+
+          def initialize(apis, default_api)
+            @apis = apis
+
+            @client = HTTP::Client.new(current_api)
+          end
+
+          ##### there is only one transport! it's negotiation!
+          def send_config(payload)
+            json = JSON.dump(payload)
+            parcel = EncodedParcel.new(json)
+            request = Request.new(parcel)
+
+            @client.send_config_payload(request)
+          end
+
+          def current_api
+            @apis[HTTP::API::V7]
+          end
+        end
+      end
+    end
+  end
+end