datadog 2.8.0 → 2.39.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'path'
-require_relative 'digest'
+require_relative "path"
+require_relative "digest"
 
 module Datadog
   module Core
@@ -22,6 +22,18 @@ module Datadog
           attr_accessor :version
 
           def initialize(path:, data:)
+            if data.nil?
+              # +data+ is passed to Digest calculation and also is
+              # unconditionally taken length of by +length+ method.
+              # As such, the class is not written to expect +data+ to be nil.
+              # Detect bad incoming values here to provide earlier diagnostics
+              # when developing tests, for example.
+              raise ArgumentError, "data must not be nil"
+            end
+            unless String === data
+              raise ArgumentError, "Invalid type for data: #{data.class}: expected String"
+            end
+
             @path = path
             @data = data
             @apply_state = ApplyState::UNACKNOWLEDGED
@@ -72,8 +84,9 @@ module Datadog
           private_class_method :new
         end
 
-        # ContentList stores a list of Conetnt instances
-        # It provides convinient methods for finding content base on Configuration::Path and Configuration::Target
+        # ContentList stores a list of Content instances.
+        # It provides convenient methods for finding content based on
+        # Configuration::Path and Configuration::Target.
         class ContentList < Array
           class << self
             def parse(array)

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'digest'
+require "digest"
 
 module Datadog
   module Core
@@ -24,26 +24,33 @@ module Datadog
           class InvalidHashTypeError < StandardError; end
           attr_reader :type, :hexdigest
 
-          DIGEST_CHUNK = 1024
-
           class << self
             def hexdigest(type, data)
+              unless String === data
+                # This class (Digest) passes +data+ to the Ruby standard
+                # library Digest routines without validating its type.
+                # The stdlib Digest requires a String, and the previous
+                # implementation of this class that used StringIO
+                # unconditionally read from +data+ without validating the
+                # type. Meaning, passing +nil+ as +data+ has never worked.
+                # It still doesn't work in the present implementation.
+                # Flag the nil data now to get earlier diagnostics when
+                # developing tests for example.
+                raise ArgumentError, "Invalid type for data: #{data.class}: expected String"
+              end
+
               d = case type
-                  when :sha256
-                    ::Digest::SHA256.new
-                  when :sha512
-                    ::Digest::SHA512.new
-                  else
-                    raise InvalidHashTypeError, type
-                  end
-
-              while (buf = data.read(DIGEST_CHUNK))
-                d.update(buf)
+              when :sha256
+                ::Digest::SHA256.new
+              when :sha512
+                ::Digest::SHA512.new
+              else
+                raise InvalidHashTypeError, type
               end
 
+              d.update(data)
+
               d.hexdigest
-            ensure
-              data.rewind
             end
           end
 

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

@@ -30,21 +30,21 @@ module Datadog
 
               raise ParseError, "could not parse: #{path.inspect}" if m.nil?
 
-              org_id = m['org_id'] ? m['org_id'].to_i : nil
+              org_id = m["org_id"]&.to_i
 
-              source = m['source']
-              raise ParseError, 'missing source value' unless source
+              source = m["source"]
+              raise ParseError, "missing source value" unless source
 
               source = source.delete("/#{org_id}") if org_id
 
-              product = m['product']
-              raise ParseError, 'missing product value' unless product
+              product = m["product"]
+              raise ParseError, "missing product value" unless product
 
-              config_id = m['config_id']
-              raise ParseError, 'missing config_id value' unless config_id
+              config_id = m["config_id"]
+              raise ParseError, "missing config_id value" unless config_id
 
-              name = m['name']
-              raise ParseError, 'missing name value' unless name
+              name = m["name"]
+              raise ParseError, "missing name value" unless name
 
               new(source: source, org_id: org_id, product: product, config_id: config_id, name: name)
             end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'content'
+require_relative "content"
 
 module Datadog
   module Core
@@ -80,7 +80,7 @@ module Datadog
               @targets_version = repository.targets_version
               @config_states = contents_to_config_states(repository.contents)
               @has_error = false
-              @error = ''
+              @error = ""
               @opaque_backend_state = repository.opaque_backend_state
               @cached_target_files = contents_to_cached_target_files(repository.contents)
             end
@@ -185,7 +185,7 @@ module Datadog
               end
             end
 
-            # Update existimng repository's contents
+            # Update existing repository's contents
             class Update
               attr_reader :path, :target, :content
 
@@ -237,6 +237,10 @@ module Datadog
                 @path = path
                 @previous = previous
               end
+
+              def type
+                :delete
+              end
             end
 
             # Insert change
@@ -247,6 +251,10 @@ module Datadog
                 @path = path
                 @content = content
               end
+
+              def type
+                :insert
+              end
             end
 
             # Update change
@@ -258,6 +266,10 @@ module Datadog
                 @content = content
                 @previous = previous
               end
+
+              def type
+                :update
+              end
             end
           end
 
@@ -272,7 +284,8 @@ module Datadog
 
               return deleted(path, previous) if previous && content.nil?
               return inserted(path, content) if content && previous.nil?
-              return updated(path, content, previous) if content && previous
+
+              updated(path, content, previous) if content && previous
             end
 
             def deleted(path, previous)

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'path'
-require_relative 'digest'
+require_relative "path"
+require_relative "digest"
 
 module Datadog
   module Core
@@ -11,8 +11,15 @@ module Datadog
         class TargetMap < Hash
           class << self
             def parse(hash)
-              opaque_backend_state = hash['signed']['custom']['opaque_backend_state']
-              version = hash['signed']['version']
+              signed = hash.fetch("signed")
+              # Note that the +dig+ call permits +hash['signed']+ to be
+              # missing the +custom+ subtree entirely.
+              # Previously the subtree was required but +opaque_backend_state+
+              # could still be missing (and obtained here as nil).
+              opaque_backend_state = signed.dig("custom", "opaque_backend_state")
+              # The version appears to be optional to the rest of this class,
+              # and we have tests that do not provide it.
+              version = signed["version"]
 
               map = new
 
@@ -21,7 +28,7 @@ module Datadog
                 @version = version
               end
 
-              hash['signed']['targets'].each_with_object(map) do |(p, t), m|
+              signed.fetch("targets").each_with_object(map) do |(p, t), m|
                 path = Configuration::Path.parse(p)
                 target = Configuration::Target.parse(t)
 
@@ -46,9 +53,9 @@ module Datadog
         class Target
           class << self
             def parse(hash)
-              length = Integer(hash['length'])
-              digests = Configuration::DigestList.parse(hash['hashes'])
-              version = Integer(hash['custom']['v'])
+              length = Integer(hash.fetch("length"))
+              digests = Configuration::DigestList.parse(hash.fetch("hashes"))
+              version = Integer(hash.dig("custom", "v"))
 
               new(digests: digests, length: length, version: version)
             end

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'configuration/path'
-require_relative 'configuration/content'
-require_relative 'configuration/target'
-require_relative 'configuration/repository'
+require_relative "configuration/path"
+require_relative "configuration/content"
+require_relative "configuration/target"
+require_relative "configuration/repository"
 
 module Datadog
   module Core

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

@@ -4,9 +4,9 @@ module Datadog
   module Core
     module Remote
       module Ext
-        ENV_ENABLED = 'DD_REMOTE_CONFIGURATION_ENABLED'
-        ENV_POLL_INTERVAL_SECONDS = 'DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS'
-        ENV_BOOT_TIMEOUT_SECONDS = 'DD_REMOTE_CONFIG_BOOT_TIMEOUT_SECONDS'
+        ENV_ENABLED = "DD_REMOTE_CONFIGURATION_ENABLED"
+        ENV_POLL_INTERVAL_SECONDS = "DD_REMOTE_CONFIG_POLL_INTERVAL_SECONDS"
+        ENV_BOOT_TIMEOUT_SECONDS = "DD_REMOTE_CONFIG_BOOT_TIMEOUT_SECONDS"
       end
     end
   end

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

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
-require_relative 'transport/http'
+require_relative "transport/http"
 
 module Datadog
   module Core
     module Remote
       # Endpoint negotiation
       class Negotiation
-        def initialize(_settings, agent_settings, suppress_logging: {})
-          transport_options = {}
-          transport_options[:agent_settings] = agent_settings if agent_settings
+        attr_reader :logger
 
-          @transport_root = Datadog::Core::Remote::Transport::HTTP.root(**transport_options.dup)
+        def initialize(_settings, agent_settings, logger: Datadog.logger, suppress_logging: {})
+          @logger = logger
+          @transport_root = Datadog::Core::Remote::Transport::HTTP.root(agent_settings: agent_settings, logger: logger)
           @logged = suppress_logging
         end
 
@@ -20,7 +20,7 @@ module Datadog
 
           if res.internal_error? && network_error?(res.error)
             unless @logged[:agent_unreachable]
-              Datadog.logger.warn { "agent unreachable: cannot negotiate #{path}" }
+              logger.warn { "agent unreachable: cannot negotiate #{path}" }
               @logged[:agent_unreachable] = true
             end
 
@@ -29,7 +29,7 @@ module Datadog
 
           if res.not_found?
             unless @logged[:no_info_endpoint]
-              Datadog.logger.warn { "agent reachable but has no /info endpoint: cannot negotiate #{path}" }
+              logger.warn { "agent reachable but has no /info endpoint: cannot negotiate #{path}" }
               @logged[:no_info_endpoint] = true
             end
 
@@ -38,7 +38,7 @@ module Datadog
 
           unless res.ok?
             unless @logged[:unexpected_response]
-              Datadog.logger.warn { "agent reachable but unexpected response: cannot negotiate #{path}" }
+              logger.warn { "agent reachable but unexpected response: cannot negotiate #{path}" }
               @logged[:unexpected_response] = true
             end
 
@@ -47,14 +47,14 @@ module Datadog
 
           unless res.endpoints.include?(path)
             unless @logged[:no_config_endpoint]
-              Datadog.logger.warn { "agent reachable but does not report #{path}" }
+              logger.warn { "agent reachable but does not report #{path}" }
               @logged[:no_config_endpoint] = true
             end
 
             return false
           end
 
-          Datadog.logger.debug { "agent reachable and reports #{path}" }
+          logger.debug { "agent reachable and reports #{path}" }
 
           true
         end

data/lib/datadog/core/remote/tie/tracing.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../tie'
+require_relative "../tie"
 
 module Datadog
   module Core
@@ -17,18 +17,18 @@ module Datadog
 
             # TODO: this is not thread-consistent
             ready = Datadog::Core::Remote.active_remote.healthy
-            status = ready ? 'ready' : 'disconnected'
+            status = ready ? "ready" : "disconnected"
 
-            span.set_tag('_dd.rc.client_id', Datadog::Core::Remote.active_remote.client.id)
-            span.set_tag('_dd.rc.status', status)
+            span.set_tag("_dd.rc.client_id", Datadog::Core::Remote.active_remote.client.id)
+            span.set_tag("_dd.rc.status", status)
 
             if boot.barrier != :pass
-              span.set_tag('_dd.rc.boot.time', boot.time)
+              span.set_tag("_dd.rc.boot.time", boot.time)
 
               if boot.barrier == :timeout
-                span.set_tag('_dd.rc.boot.timeout', true)
+                span.set_tag("_dd.rc.boot.timeout", true)
               else
-                span.set_tag('_dd.rc.boot.ready', ready)
+                span.set_tag("_dd.rc.boot.ready", ready)
               end
             end
           end

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

@@ -1,56 +1,30 @@
 # frozen_string_literal: true
 
-require_relative '../../../core/transport/request'
-require_relative '../../../core/transport/parcel'
+require_relative "../../../core/transport/request"
+require_relative "../../../core/transport/parcel"
+require_relative "../../../core/transport/transport"
+require_relative "http/config"
 
 module Datadog
   module Core
     module Remote
       module Transport
         module Config
-          # Data transfer object for encoded traces
-          class EncodedParcel
-            include Datadog::Core::Transport::Parcel
-
-            def count
-              data.length
-            end
-          end
-
           # Config request
           class Request < Datadog::Core::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!
+          class Transport < Core::Transport::Transport
             def send_config(payload)
-              json = JSON.dump(payload)
-              parcel = EncodedParcel.new(json)
+              encoder = Core::Encoding::JSONEncoder
+              parcel = Core::Transport::Parcel.new(
+                encoder.encode(payload),
+                content_type: encoder.content_type,
+              )
               request = Request.new(parcel)
 
-              @client.send_config_payload(request)
-            end
-
-            def current_api
-              @apis[HTTP::API::V7]
+              @client.send_request(:config, request)
             end
           end
         end