datadog-ci 1.0.0.beta4 → 1.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 035d75d50e0e09c7895bc0e434c5ac1e0655618763ac724a94989833e0c07d61
-  data.tar.gz: bfbd5d6ff101ef51e59d3546d110f906f178c23602241f85b3a8b413524a9900
+  metadata.gz: 8d82afa69ce303c4d7652a9455b4f19c6e89fe5afda868a10bf2b42c765bc06d
+  data.tar.gz: 5b2c939c277b4f0b712fcdd3d361cef50302e9947feac333b49bfcea5cd83e4d
 SHA512:
-  metadata.gz: c1b6463b913cbff1e20a2c3f4fcaa6c47814ba693eee5682fa41c3baa74f9e92414b4e554ec8407807d6eeb1744f0c76d87bb0889bd0e639c6ebdc3de1dcd180
-  data.tar.gz: dca4568f30dbaef22e8fac94389e682beb21ba6f92f0578553ff01d2ad289f38d33f899c79bef604f3f83906d6c31b9e64a9495cc3dc986fb321bd810430780d
+  metadata.gz: f315f6d11021a34dc32815ffa1fea4ffddd4e894253aa8c69225d40fb10930e50949a5bd11237aa9f15f60bca171e4781efbf24e1edce24f239b513819c41741
+  data.tar.gz: 80df3261fb5fbb357d4bdcec7b530de26ece4316ba5f289e9254b1e8fcc6129d58e9cf2cada61e81a98500c2aea03aa6410e0a25696148c782c74e99da44fc95

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [1.0.0.beta5] - 2024-05-23
+
+### Changed
+
+* accept gzipped responses from API ([#170][])
+
+### Fixed
+
+* Fix Knapsack Pro integration ([#180][])
+
 ## [1.0.0.beta4] - 2024-05-14
 
 ### Added
@@ -238,7 +248,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 
 - Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta4...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta5...main
+[1.0.0.beta5]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta4...v1.0.0.beta5
 [1.0.0.beta4]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta3...v1.0.0.beta4
 [1.0.0.beta3]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta2...v1.0.0.beta3
 [1.0.0.beta2]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta1...v1.0.0.beta2
@@ -334,7 +345,9 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#166]: https://github.com/DataDog/datadog-ci-rb/issues/166
 [#167]: https://github.com/DataDog/datadog-ci-rb/issues/167
 [#168]: https://github.com/DataDog/datadog-ci-rb/issues/168
+[#170]: https://github.com/DataDog/datadog-ci-rb/issues/170
 [#172]: https://github.com/DataDog/datadog-ci-rb/issues/172
 [#173]: https://github.com/DataDog/datadog-ci-rb/issues/173
 [#174]: https://github.com/DataDog/datadog-ci-rb/issues/174
-[#175]: https://github.com/DataDog/datadog-ci-rb/issues/175
+[#175]: https://github.com/DataDog/datadog-ci-rb/issues/175
+[#180]: https://github.com/DataDog/datadog-ci-rb/issues/180

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

@@ -17,6 +17,7 @@ module Datadog
 
           module InstanceMethods
             def run(*)
+              return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 
               test_name = full_description.strip

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

@@ -16,6 +16,7 @@ module Datadog
           # Instance methods for configuration
           module ClassMethods
             def run(reporter = ::RSpec::Core::NullReporter)
+              return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
               return super unless top_level?
 

data/lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb

@@ -8,7 +8,6 @@ module Datadog
   module CI
     module Contrib
       module RSpec
-        # Instrument RSpec::Core::Example
         module KnapsackPro
           module Extension
             def self.included(base)

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        module KnapsackPro
+          module Patcher
+            def self.patch
+              if defined?(::KnapsackPro::Extensions::RSpecExtension::Runner) &&
+                  ::RSpec::Core::Runner.ancestors.include?(::KnapsackPro::Extensions::RSpecExtension::Runner)
+                # knapsack already patched rspec runner
+                require_relative "runner"
+                ::RSpec::Core::Runner.include(KnapsackPro::Runner)
+              else
+                # knapsack didn't patch rspec runner yet
+                require_relative "extension"
+                ::KnapsackPro::Extensions::RSpecExtension.include(KnapsackPro::Extension)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb

@@ -15,6 +15,7 @@ module Datadog
 
             module InstanceMethods
               def knapsack__run_specs(*)
+                return super if ::RSpec.configuration.dry_run?
                 return super unless datadog_configuration[:enabled]
 
                 test_session = CI.start_test_session(

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

@@ -27,14 +27,16 @@ module Datadog
               ::RSpec::Queue::Runner.include(Runner)
             end
 
-            # Knapsack Pro test runner instrumentation
-            # https://github.com/KnapsackPro/knapsack_pro-ruby
             if knapsack_pro?
-              require_relative "knapsack_pro/extension"
-              ::KnapsackPro::Extensions::RSpecExtension.include(KnapsackPro::Extension)
+              # Knapsack Pro test runner instrumentation
+              # https://github.com/KnapsackPro/knapsack_pro-ruby
+              require_relative "knapsack_pro/patcher"
+              Datadog::CI::Contrib::RSpec::KnapsackPro::Patcher.patch
             end
 
+            # default rspec test runner instrumentation
             ::RSpec::Core::Runner.include(Runner)
+
             ::RSpec::Core::Example.include(Example)
             ::RSpec::Core::ExampleGroup.include(ExampleGroup)
           end

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

@@ -15,6 +15,7 @@ module Datadog
 
           module InstanceMethods
             def run_specs(*)
+              return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 
               test_session = CI.start_test_session(

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

@@ -7,6 +7,7 @@ module Datadog
         DEFAULT_DD_SITE = "datadoghq.com"
 
         HEADER_DD_API_KEY = "DD-API-KEY"
+        HEADER_ACCEPT_ENCODING = "Accept-Encoding"
         HEADER_CONTENT_TYPE = "Content-Type"
         HEADER_CONTENT_ENCODING = "Content-Encoding"
         HEADER_EVP_SUBDOMAIN = "X-Datadog-EVP-Subdomain"
@@ -48,6 +49,8 @@ module Datadog
         CONTENT_TYPE_JSON = "application/json"
         CONTENT_TYPE_MULTIPART_FORM_DATA = "multipart/form-data"
         CONTENT_ENCODING_GZIP = "gzip"
+
+        GZIP_MAGIC_NUMBER = "\x1F\x8B".b
       end
     end
   end

data/lib/datadog/ci/transport/api/agentless.rb

@@ -26,7 +26,14 @@ module Datadog
           def api_request(path:, payload:, headers: {}, verb: "post")
             super
 
-            perform_request(@api_http, path: path, payload: payload, headers: headers, verb: verb)
+            perform_request(
+              @api_http,
+              path: path,
+              payload: payload,
+              headers: headers,
+              verb: verb,
+              accept_compressed_response: true
+            )
           end
 
           def citestcov_request(path:, payload:, headers: {}, verb: "post")
@@ -37,12 +44,13 @@ module Datadog
 
           private
 
-          def perform_request(http_client, path:, payload:, headers:, verb:)
+          def perform_request(http_client, path:, payload:, headers:, verb:, accept_compressed_response: false)
             http_client.request(
               path: path,
               payload: payload,
               headers: headers_with_default(headers),
-              verb: verb
+              verb: verb,
+              accept_compressed_response: accept_compressed_response
             )
           end
 

data/lib/datadog/ci/transport/gzip.rb

@@ -16,6 +16,18 @@ module Datadog
           gzip_writer.close
           sio.string
         end
+
+        def decompress(input)
+          sio = StringIO.new(input)
+          gzip_reader = Zlib::GzipReader.new(
+            sio,
+            external_encoding: Encoding::UTF_8,
+            internal_encoding: Encoding::UTF_8
+          )
+          gzip_reader.read || ""
+        ensure
+          gzip_reader&.close
+        end
       end
     end
   end

data/lib/datadog/ci/transport/http.rb

@@ -32,12 +32,24 @@ module Datadog
           @compress = compress.nil? ? false : compress
         end
 
-        def request(path:, payload:, headers:, verb: "post", retries: MAX_RETRIES, backoff: INITIAL_BACKOFF)
+        def request(
+          path:,
+          payload:,
+          headers:,
+          verb: "post",
+          retries: MAX_RETRIES,
+          backoff: INITIAL_BACKOFF,
+          accept_compressed_response: false
+        )
           if compress
             headers[Ext::Transport::HEADER_CONTENT_ENCODING] = Ext::Transport::CONTENT_ENCODING_GZIP
             payload = Gzip.compress(payload)
           end
 
+          if accept_compressed_response
+            headers[Ext::Transport::HEADER_ACCEPT_ENCODING] = Ext::Transport::CONTENT_ENCODING_GZIP
+          end
+
           Datadog.logger.debug do
             "Sending #{verb} request: host=#{host}; port=#{port}; ssl_enabled=#{ssl}; " \
               "compression_enabled=#{compress}; path=#{path}; payload_size=#{payload.size}"
@@ -91,12 +103,32 @@ module Datadog
           @adapter ||= Datadog::Core::Transport::HTTP::Adapters::Net.new(settings)
         end
 
-        # this is needed because Datadog::Tracing::Writer is not fully compatiple with Datadog::Core::Transport
-        # TODO: remove when CI implements its own worker
+        # adds compatibility with Datadog::Tracing transport and
+        # provides ungzipping capabilities
         class ResponseDecorator < ::SimpleDelegator
+          def payload
+            return @decompressed_payload if defined?(@decompressed_payload)
+
+            if gzipped?(__getobj__.payload)
+              Datadog.logger.debug("Decompressing gzipped response payload")
+              @decompressed_payload = Gzip.decompress(__getobj__.payload)
+            else
+              __getobj__.payload
+            end
+          end
+
           def trace_count
             0
           end
+
+          def gzipped?(payload)
+            return false if payload.nil? || payload.empty?
+
+            first_bytes = payload[0, 2]
+            return false if first_bytes.nil? || first_bytes.empty?
+
+            first_bytes.b == Datadog::CI::Ext::Transport::GZIP_MAGIC_NUMBER
+          end
         end
 
         class AdapterSettings

data/lib/datadog/ci/version.rb

@@ -6,7 +6,7 @@ module Datadog
       MAJOR = "1"
       MINOR = "0"
       PATCH = "0"
-      PRE = "beta4"
+      PRE = "beta5"
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta4
+  version: 1.0.0.beta5
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -89,6 +89,7 @@ files:
 - lib/datadog/ci/contrib/rspec/ext.rb
 - lib/datadog/ci/contrib/rspec/integration.rb
 - lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb
+- lib/datadog/ci/contrib/rspec/knapsack_pro/patcher.rb
 - lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb
 - lib/datadog/ci/contrib/rspec/patcher.rb
 - lib/datadog/ci/contrib/rspec/runner.rb