omniai 3.7.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7464f0580c8f8392155996aa7b4675491bec1fe62b48ff9b12e53264952a50e5
-  data.tar.gz: 3ef5570bd7eac6ed72a9826c90313565dc0fd00b6ec52745fe02a04ce2855264
+  metadata.gz: e22534811cc346b74927ec47382420e86faee449ff730cbb0665d30a714cd872
+  data.tar.gz: 1c3e58ad36506a2564563c46a700e8be04731b7266d8008bbd63bcc22d9cfa64
 SHA512:
-  metadata.gz: e5ab80ba78ab316ca74e46dffb0bdea26ed13b83f4ec4ff7c5e985580c5460d926366d71bf547ac905273968db44cf1949eb57c56b0560077f1b805f52a4c93d
-  data.tar.gz: bd453f4fd6355066833db225b771b1078fd8d916138213a1f0d4d18f37316cae7b60f47a215c46d7a76fb096eeece2e6d887a8dc9a4819c8c54dd65f3ece731f
+  metadata.gz: ea3efdf811897d5fff8f55b0e4051b71f151d077230518b139fde0ef38656c6b784f9aafcfccb43c692fe85a102b47d0ca41c8696af767294b1a2270dfeee5fa
+  data.tar.gz: f3e87e1dd51ca72ec1d8706d3833a06c10b65947fdaf1e9a375518ca2b3d78f03a43af1c2869de1e84fb1c5cd77226ecbd5aa45fa7092f84691f0ea5f5afd183

data/lib/omniai/instrumentation.rb

@@ -8,27 +8,78 @@ module OmniAI
       @logger = logger
     end
 
+    # ActiveSupport::Notifications-compatible instrument.
+    #
+    # On http 6 the instrumentation feature drives every request through
+    # `around_request`, which (per http's own feature docs) "emits two events on
+    # every request: `start_request.http` before the request is made [and]
+    # `request.http` after the response is received". Both are delivered here as
+    # `instrument(name) { ... }` calls: the start event carries an empty block,
+    # and the request event's block wraps the exchange and returns the response.
+    # The block of the request event MUST be yielded and its value returned,
+    # otherwise the response is lost as `nil` (http uses the return value as the
+    # response). We log the request on the start event and the response on the
+    # request event. The event namespace is caller-configurable (the names are
+    # `start_request.#{namespace}` / `request.#{namespace}`), so #start_event?
+    # prefix-matches rather than comparing the full name.
+    #
+    # On http 5 this is only ever called without a block (for the start and
+    # error events); request/response logging there happens via #start / #finish.
+    #
     # @param name [String]
     # @param payload [Hash]
+    # @option payload [HTTP::Request] :request
+    # @option payload [HTTP::Response] :response
     # @option payload [Exception] :error
     def instrument(name, payload = {})
       error = payload[:error]
-      return unless error
+      @logger.error("#{name}: #{error.message}") if error
 
-      @logger.error("#{name}: #{error.message}")
+      return unless block_given?
+
+      if start_event?(name)
+        log_request(payload[:request])
+        yield payload
+      else
+        response = yield payload
+        log_response(payload[:response] || response)
+        response
+      end
     end
 
     # @param payload [Hash]
     # @option payload [HTTP::Request] :request
     def start(_, payload)
-      request = payload[:request]
-      @logger.info("#{request.verb.upcase} #{request.uri}")
+      log_request(payload[:request])
     end
 
     # @param payload [Hash]
     # @option payload [HTTP::Response] :response
     def finish(_, payload)
-      response = payload[:response]
+      log_response(payload[:response])
+    end
+
+  private
+
+    # @param name [String] the http instrumentation event name, e.g.
+    #   "start_request.http" (pre-flight) or "request.http" (the exchange).
+    #
+    # @return [Boolean] true for the pre-flight "start_..." event
+    def start_event?(name)
+      name.to_s.start_with?("start_")
+    end
+
+    # @param request [HTTP::Request, nil]
+    def log_request(request)
+      return unless request
+
+      @logger.info("#{request.verb.upcase} #{request.uri}")
+    end
+
+    # @param response [HTTP::Response, nil]
+    def log_response(response)
+      return unless response
+
       @logger.info("#{response.status.code} #{response.status.reason}")
     end
   end

data/lib/omniai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OmniAI
-  VERSION = "3.7.0"
+  VERSION = "3.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniai
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Kevin Sylvestre