http_instrumentation 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2df5ce2bdf71e28c9a3c95afa298ef3d1d035d17dbc5b8afb8deced97b1d336c
-  data.tar.gz: debfebac778a078bb34ccaa213389e1785bae0f02f116ba8d4aa2e1584dc26cb
+  metadata.gz: 1457b4d97046d8c0a41e99aa0825386e3540eb67ac5603fb0ecc80e2fca77e92
+  data.tar.gz: 78b242f2f2821f22d8abddd754e641a271232da63e8218b2492ecd0907e43eca
 SHA512:
-  metadata.gz: b268d25d6e6a7e948b68e47d0e08762e3c4708a78feaa17821ebe65ae06d7f675c1ae26a45afb27c983fe5d625f47c4f4cdfa4023ef33b7d71deda6e163d5385
-  data.tar.gz: 4fc09ff4a26388982f0f2b877c7827cd629bfd0f4905f71e6f31a1ab3c5dbd565b39da5cd96b185319daea8fc445b3b4cc58ef0a3744fe08c0a5eebe2d8e5fe3
+  metadata.gz: 6aab6fde374e4f00c40509e32950fc8d3ab3b18666a8c5be593f1fc2d58a1907ab19ea1ba2a309d1728a6c3611aaeae54f8873a2e25b7450a55dbe9952358811
+  data.tar.gz: a22576c8eb6253c18c3705211c09764df2c1221c65797fcb944c8f3a62f31c7b7f5f6aec1abe607393c98ebd9bc90792662e609673a1f4bdea86f3b33030e132

data/CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 1.0.0 (unreleased)
+## 1.0.1
+
+### Fixed
+- Added detection for other gems that may be instrumenting these same libraries and ensuring that the method of injecting the instrumentation call is compatible. This fixes issues caused by the fundamental incompatibility in Ruby between `alias_method` and `prepend` on the same method. Aliasing is now the default method for injection since this is the most compatible. However if another library has already prepended behavior on a method, then `prepend` will be used instead.
+- `HTTPInstrumentation.client` properly returns the block return value if it was called with a block.
+
+## 1.0.0
 
 ### Added
 - Initial release.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/http_instrumentation/instrumentation/curb_hook.rb

@@ -11,17 +11,23 @@ module HTTPInstrumentation
     module CurbHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Curl::Easy, self) if defined?(::Curl::Easy)
+          Instrumentation.instrument!(::Curl::Easy, self, :http) if defined?(::Curl::Easy)
         end
 
         def installed?
           !!(defined?(::Curl::Easy) && ::Curl::Easy.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
-      def http(method, *)
+      def http(method, *args)
         HTTPInstrumentation.instrument("curb") do |payload|
-          retval = super
+          retval = if HTTPInstrumentation::Instrumentation::CurbHook.aliased
+            http_without_http_instrumentation(method, *args)
+          else
+            super
+          end
 
           payload[:http_method] = method
           begin

data/lib/http_instrumentation/instrumentation/ethon_hook.rb

@@ -11,8 +11,8 @@ module HTTPInstrumentation
     module EthonHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Ethon::Easy, Easy) if defined?(::Ethon::Easy)
-          Instrumentation.instrument!(::Ethon::Multi, Multi) if defined?(::Ethon::Multi)
+          Instrumentation.instrument!(::Ethon::Easy, Easy, [:http_request, :perform]) if defined?(::Ethon::Easy)
+          Instrumentation.instrument!(::Ethon::Multi, Multi, :perform) if defined?(::Ethon::Multi)
         end
 
         def installed?
@@ -24,31 +24,51 @@ module HTTPInstrumentation
       end
 
       module Multi
-        def perform(*)
+        class << self
+          attr_accessor :aliased
+        end
+
+        def perform(*args)
           HTTPInstrumentation.instrument("ethon") do |payload|
             begin
               payload[:count] = easy_handles.size
             rescue
             end
 
-            super
+            if HTTPInstrumentation::Instrumentation::EthonHook::Multi.aliased
+              perform_without_http_instrumentation(*args)
+            else
+              super
+            end
           end
         end
       end
 
       module Easy
-        def http_request(url, action_name, *)
-          @http_method = action_name
-          @http_url = url
-          super
+        class << self
+          attr_accessor :aliased
         end
 
-        def perform(*)
+        def http_request(url, action_name, *args)
+          @http_instrumentation_method = action_name
+          @http_instrumentation_url = url
+          if HTTPInstrumentation::Instrumentation::EthonHook::Easy.aliased
+            http_request_without_http_instrumentation(url, action_name, *args)
+          else
+            super
+          end
+        end
+
+        def perform(*args)
           HTTPInstrumentation.instrument("ethon") do |payload|
-            retval = super
+            retval = if HTTPInstrumentation::Instrumentation::EthonHook::Easy.aliased
+              perform_without_http_instrumentation(*args)
+            else
+              super
+            end
 
-            payload[:http_method] = @http_method
-            payload[:url] = @http_url
+            payload[:http_method] = @http_instrumentation_method
+            payload[:url] = @http_instrumentation_url
             begin
               payload[:status_code] = response_code
             rescue

data/lib/http_instrumentation/instrumentation/excon_hook.rb

@@ -11,17 +11,23 @@ module HTTPInstrumentation
     module ExconHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Excon::Connection, self) if defined?(::Excon::Connection)
+          Instrumentation.instrument!(::Excon::Connection, self, :request) if defined?(::Excon::Connection)
         end
 
         def installed?
           !!(defined?(::Excon::Connection) && ::Excon::Connection.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
-      def request(params = {}, *)
+      def request(params = {})
         HTTPInstrumentation.instrument("excon") do |payload|
-          response = super
+          response = if HTTPInstrumentation::Instrumentation::ExconHook.aliased
+            request_without_http_instrumentation(params)
+          else
+            super
+          end
 
           begin
             info = params

data/lib/http_instrumentation/instrumentation/http_hook.rb

@@ -11,17 +11,23 @@ module HTTPInstrumentation
     module HTTPHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::HTTP::Client, self) if defined?(::HTTP::Client)
+          Instrumentation.instrument!(::HTTP::Client, self, :perform) if defined?(::HTTP::Client)
         end
 
         def installed?
           !!(defined?(::HTTP::Client) && ::HTTP::Client.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
-      def perform(request, *)
+      def perform(request, *args)
         HTTPInstrumentation.instrument("http") do |payload|
-          response = super
+          response = if HTTPInstrumentation::Instrumentation::HTTPHook.aliased
+            perform_without_http_instrumentation(request, *args)
+          else
+            super
+          end
 
           begin
             payload[:http_method] = request.verb

data/lib/http_instrumentation/instrumentation/httpclient_hook.rb

@@ -11,17 +11,23 @@ module HTTPInstrumentation
       # This module is responsible for instrumenting the httpclient gem.
       class << self
         def instrument!
-          Instrumentation.instrument!(::HTTPClient, self) if defined?(::HTTPClient)
+          Instrumentation.instrument!(::HTTPClient, self, :do_get_block) if defined?(::HTTPClient)
         end
 
         def installed?
           !!(defined?(::HTTPClient) && ::HTTPClient.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
-      def do_get_block(request, *)
+      def do_get_block(request, *args)
         HTTPInstrumentation.instrument("httpclient") do |payload|
-          response = super
+          response = if HTTPInstrumentation::Instrumentation::HTTPClientHook.aliased
+            do_get_block_without_http_instrumentation(request, *args)
+          else
+            super
+          end
 
           begin
             payload[:http_method] = request.header.request_method

data/lib/http_instrumentation/instrumentation/httpx_hook.rb

@@ -11,19 +11,25 @@ module HTTPInstrumentation
     module HTTPXHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::HTTPX::Session, self) if defined?(::HTTPX::Session)
+          Instrumentation.instrument!(::HTTPX::Session, self, :send_requests) if defined?(::HTTPX::Session)
         end
 
         def installed?
           !!(defined?(::HTTPX::Session) && ::HTTPX::Session.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
       private
 
       def send_requests(*requests)
         HTTPInstrumentation.instrument("httpx") do |payload|
-          responses = super
+          responses = if HTTPInstrumentation::Instrumentation::HTTPXHook.aliased
+            send_requests_without_http_instrumentation(*requests)
+          else
+            super
+          end
 
           if requests.size == 1
             begin

data/lib/http_instrumentation/instrumentation/net_http_hook.rb

@@ -11,19 +11,31 @@ module HTTPInstrumentation
     module NetHTTPHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Net::HTTP, self) if defined?(::Net::HTTP)
+          Instrumentation.instrument!(::Net::HTTP, self, :request) if defined?(::Net::HTTP)
         end
 
         def installed?
           !!(defined?(::Net::HTTP) && ::Net::HTTP.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
-      def request(req, *)
-        return super unless started?
+      def request(req, *args, &block)
+        unless started?
+          if HTTPInstrumentation::Instrumentation::NetHTTPHook.aliased
+            return request_without_http_instrumentation(req, *args, &block)
+          else
+            return super
+          end
+        end
 
         HTTPInstrumentation.instrument("net/http") do |payload|
-          response = super
+          response = if HTTPInstrumentation::Instrumentation::NetHTTPHook.aliased
+            request_without_http_instrumentation(req, *args, &block)
+          else
+            super
+          end
 
           default_port = (use_ssl? ? 443 : 80)
           scheme = (use_ssl? ? "https" : "http")

data/lib/http_instrumentation/instrumentation/patron_hook.rb

@@ -11,19 +11,25 @@ module HTTPInstrumentation
     module PatronHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Patron::Session, self) if defined?(::Patron::Session)
+          Instrumentation.instrument!(::Patron::Session, self, :request) if defined?(::Patron::Session)
         end
 
         def installed?
           !!(defined?(::Patron::Session) && ::Patron::Session.include?(self))
         end
+
+        attr_accessor :aliased
       end
 
       private
 
-      def request(action, url, *)
+      def request(action, url, *args)
         HTTPInstrumentation.instrument("patron") do |payload|
-          response = super
+          response = if HTTPInstrumentation::Instrumentation::PatronHook.aliased
+            request_without_http_instrumentation(action, url, *args)
+          else
+            super
+          end
 
           payload[:http_method] = action
           payload[:url] = url

data/lib/http_instrumentation/instrumentation/typhoeus_hook.rb

@@ -11,8 +11,8 @@ module HTTPInstrumentation
     module TyphoeusHook
       class << self
         def instrument!
-          Instrumentation.instrument!(::Typhoeus::Request, Easy) if defined?(::Typhoeus::Request)
-          Instrumentation.instrument!(::Typhoeus::Hydra, Multi) if defined?(::Typhoeus::Hydra)
+          Instrumentation.instrument!(::Typhoeus::Request, Easy, :run) if defined?(::Typhoeus::Request)
+          Instrumentation.instrument!(::Typhoeus::Hydra, Multi, :run) if defined?(::Typhoeus::Hydra)
         end
 
         def installed?
@@ -24,22 +24,38 @@ module HTTPInstrumentation
       end
 
       module Multi
-        def run(*)
+        class << self
+          attr_accessor :aliased
+        end
+
+        def run(*args)
           HTTPInstrumentation.instrument("typhoeus") do |payload|
             begin
               payload[:count] = queued_requests.size
             rescue
             end
 
-            super
+            if HTTPInstrumentation::Instrumentation::TyphoeusHook::Multi.aliased
+              run_without_http_instrumentation(*args)
+            else
+              super
+            end
           end
         end
       end
 
       module Easy
-        def run(*)
+        class << self
+          attr_accessor :aliased
+        end
+
+        def run(*args)
           HTTPInstrumentation.instrument("typhoeus") do |payload|
-            retval = super
+            retval = if HTTPInstrumentation::Instrumentation::TyphoeusHook::Easy.aliased
+              run_without_http_instrumentation(*args)
+            else
+              super
+            end
 
             begin
               payload[:http_method] = options[:method]

data/lib/http_instrumentation/instrumentation.rb

@@ -13,9 +13,53 @@ require_relative "instrumentation/typhoeus_hook"
 module HTTPInstrumentation
   module Instrumentation
     class << self
-      # Helper method to prepend an instrumentation module to a class.
-      def instrument!(klass, instrumentation_module)
-        klass.prepend(instrumentation_module) unless klass.include?(instrumentation_module)
+      # Helper method to add an instrumentation module to methods on a class. The
+      # methods must be defined in the instrumentation module.
+      #
+      # If the methods have already been prepended on the class, then module will
+      # be prepended to the class. Otherwise, the methods will be aliased and the
+      # module will be included in the class. This is because prepending and aliasing
+      # methods are not compatible with each other and other instrumentation libraries
+      # may have already prepended the methods. Aliasing is the default strategy because
+      # prepending after aliasing will work, but aliasing after prepending will not.
+      def instrument!(klass, instrumentation_module, methods)
+        return if klass.include?(instrumentation_module)
+
+        methods = Array(methods).collect(&:to_sym)
+
+        if HTTPInstrumentation.force_prepend? || methods_prepended?(klass, methods)
+          klass.prepend(instrumentation_module)
+          instrumentation_module.aliased = false
+        else
+          Array(methods).each do |method|
+            instrumentation_module.alias_method("#{method}_with_http_instrumentation", method)
+          end
+
+          klass.include(instrumentation_module)
+
+          Array(methods).each do |method|
+            klass.alias_method("#{method}_without_http_instrumentation", method)
+            klass.alias_method(method, "#{method}_with_http_instrumentation")
+          end
+
+          instrumentation_module.aliased = true
+        end
+      end
+
+      private
+
+      def methods_prepended?(klass, methods)
+        prepended = false
+
+        klass.ancestors.each do |mod|
+          next unless mod.is_a?(Module) && !mod.is_a?(Class)
+
+          module_methods = mod.instance_methods(false) + mod.private_instance_methods(false)
+          prepended = (module_methods & methods).any?
+          break if prepended
+        end
+
+        prepended
       end
     end
   end

data/lib/http_instrumentation.rb

@@ -60,18 +60,20 @@ module HTTPInstrumentation
     # block. If no block is given, then return the current HTTP client name.
     #
     # @param name [String, Symbol, nil] The name of the client to set
-    # @return [String, Symbol, nil] The current name of the client
+    # @return [String, Symbol, nil] If a block is given, then the return value of the block. Otherwise
+    #   the current client name.
     def client(name = nil)
       save_val = Thread.current[:http_instrumentation_client]
       if block_given?
         begin
-          Thread.current[:http_instrumentation_client] = name
+          Thread.current[:http_instrumentation_client] = name&.to_s
           yield
         ensure
           Thread.current[:http_instrumentation_client] = save_val
         end
+      else
+        save_val
       end
-      save_val
     end
 
     # Returns true if instrumentation is currently silenced.
@@ -121,6 +123,14 @@ module HTTPInstrumentation
       end
     end
 
+    # Returns true if instrumentation should always use module prepend rather than method aliasing.
+    # The default is to use method aliasing since that is more compatible with other libraries.
+    # Prepending can be forced by setting the HTTP_INSTRUMENTATION_FORCE_PREPEND environment variable
+    # to "true".
+    def force_prepend?
+      ENV.fetch("HTTP_INSTRUMENTATION_FORCE_PREPEND", nil) == "true"
+    end
+
     private
 
     # Turn the given value into a lowercase symbol.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: http_instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: ActiveSupoprt instrumentation for a variety of Ruby HTTP client libraries.