vigiles 0.1.0.pre.beta8 → 0.1.0.pre.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ae2f2c7a8b3a0642d0fb228264821c882b9b98cf7a59380dcf139e1a514221c
-  data.tar.gz: 7ca651c0579f55907094ade6d43825cae72627fef6c8e995fd621d7f94e9acc4
+  metadata.gz: cceedc075f3779ec0c77cc04a35058734cd2d2396ea67b95c6b1117763caa719
+  data.tar.gz: 3ea39ba08de23e8b51b66bc0e4b4cc38ca52e467ccdf671d49cdb52e7ff98453
 SHA512:
-  metadata.gz: a942ca1c61aefdb02f843b7d3defd046ebce9935b47d406e8193c2c54b7befd360b19f974618f24f42c23278e8c313be513d25b68fece32985d2272f504b8c2e
-  data.tar.gz: 2a70d2be56a5c86fa4f30f881b6b9002e6967cfe6cd04339f1bb4f70f1a6f8bd28b6ae34281a19b5504ad82a594fa8b0660591ff0ab28e9ad3fdd94214c26d78
+  metadata.gz: a884ac729b71b8351aae48ce0515d2a803f6358f03d03cc3efbbdb5304c2d811de6401eea203329fbea433c9d3896d77fc2f25bb0947226a689c1e466f64b8fd
+  data.tar.gz: 8a2b120ce179764649389ce270a45015e8e67379f70cb40035cef4f58cf321c6e81a376b62482842825599d7c101fec4ee69aa60aa9889146f6ed2f1daa15297

data/lib/vigiles/archive/request.rb

@@ -35,12 +35,21 @@ module Vigiles
       const :url,          T.any(URI::HTTPS, URI::HTTP)
       const :id,           String
 
+      sig { params(header_key: String).returns(String) }
+      private_class_method def self.best_effort_unfuck_http_header(header_key)
+        (header_key.starts_with?("HTTP_") ? T.must(header_key[5..]) : header_key)
+          .split(/_/)
+          .map(&:titlecase)
+          .join("-")
+      end
+
       sig { params(request: ActionDispatch::Request).returns(Request) }
       def self.from(request)
         preferred_headers = Vigiles.spec.request_headers
         available_headers = request.original_headers
         recorded_headers  = (available_headers if preferred_headers.empty?)
-        recorded_headers ||= preferred_headers.to_h { |h| [h, available_headers[h]] }
+        recorded_headers ||= preferred_headers.to_h { [_1, available_headers[_1]] }
+        unfucked_headers = recorded_headers.transform_keys { best_effort_unfuck_http_header _1 }
 
         Request.new(
           content_type: request.content_type || (raise InvalidParameterError, "content_type"),
@@ -48,7 +57,7 @@ module Vigiles
           timestamp: DateTime.now,
           remote_ip: IPAddr.new(request.remote_ip),
           protocol: request.protocol,
-          headers: recorded_headers,
+          headers: unfucked_headers,
           origin: request.origin || "unknown_origin_url",
           payload: request.body.read,
           http_method: Types::HttpMethod.deserialize(request.method),

data/lib/vigiles/archive.rb

@@ -27,48 +27,5 @@ module Vigiles
 
       recorder.record(req:, res:)
     end
-
-    sig do
-      params(
-        request: Request,
-        response: Response,
-        metadata: Metadata,
-        extras: Extras
-      )
-        .returns(T.nilable(Conversation))
-    end
-    private_class_method def self.record_json_conversation(request:, response:, metadata:, extras:)
-      Conversation.create!(
-        request_content_type: request.content_type,
-        request_user_agent: request.user_agent,
-        request_timestamp: request.timestamp,
-        request_remote_ip: request.remote_ip,
-        request_protocol: request.protocol,
-        request_headers: request.headers,
-        request_origin: request.origin,
-        request_payload: request.payload,
-        request_method: request.http_method.serialize,
-        request_path: request.path,
-        request_url: request.url,
-        request_id: request.id,
-        response_content_type: response.content_type,
-        response_headers: response.headers,
-        response_payload: response.payload,
-        response_status: response.status
-      )
-    rescue => e
-    end
-    
-    sig { params(request: Request, response: Response, metadata: Metadata, extras: Extras).returns(T.nilable(Conversation)) }
-    private_class_method def self.record_html_conversation(request:, response:, metadata:, extras:); end
-
-    sig { params(request: Request, response: Response, metadata: Metadata, extras: Extras).returns(T.nilable(Conversation)) }
-    private_class_method def self.record_conversation_with_unknown_content_type(
-      request:,
-      response:,
-      metadata:,
-      extras:
-    )
-    end
   end
 end

data/lib/vigiles/conversation_recorders/application_json.rb

@@ -25,7 +25,6 @@ module Vigiles
 
         response = Response.from(res)
         request  = Request.from(req)
-
         Conversation.create!(
           request_content_type: request.content_type,
           request_user_agent: request.user_agent,

data/lib/vigiles/middleware/record_conversation.rb

@@ -2,15 +2,25 @@
 # frozen_string_literal: true
 
 require "logger"
+
 module Vigiles
   module Middleware
     class RecordConversation
-      sig { params(app: T.untyped).void }
-      def initialize(app)
-        @app = app
+      sig { returns(Vigiles::Options) }
+      attr_reader :options
+
+      delegate \
+        :capture_exception,
+        :logger,
+        to: :options
+
+      sig { params(app: T.untyped, options: Vigiles::Options).void }
+      def initialize(app, options=Vigiles::Options.make_default_options)
+        @app     = app
+        @options = options
       end
 
-      sig { params(env: T.untyped).returns(T.untyped) }
+      sig { params(env: T::Hash[T.untyped, T.untyped]).returns(T.untyped) }
       def call(env)
         req = ActionDispatch::Request.new(env)
         record_conversation(req) do
@@ -20,11 +30,29 @@ module Vigiles
 
       sig { params(req: ActionDispatch::Request, blk: T.proc.returns(T.untyped)).returns(T.untyped) }
       private def record_conversation(req, &blk)
-        res = Rack::Response[*blk.call]
-        Vigiles.maybe_record_conversation(req:, res:)
-        res.to_a
-      ensure
-        res.to_a
+        rack_response = blk.call
+        begin
+          res = Rack::Response[*rack_response]
+          convo = Vigiles.maybe_record_conversation(req:, res:)
+          logger.info \
+            "[vigiles] conversation recorder: " \
+            "conversation=#{convo.nil? ? "not_recorded" : convo.id} " \
+            "request=#{req.request_id}"
+        rescue => e
+          capture_exception.call(e)
+          logger.warn \
+            "[vigiles] conversation recorder error: " \
+            "error_message=#{e.message} " \
+            "error_class=#{e.class}"
+        ensure
+          # no matter what happens we shouldn't prevent the rack
+          # response from being returned. at this point, the only
+          # thing that could throw execution into this branch is
+          # an exception when the `capture_exception` proc is
+          # invoked.
+          rack_response
+        end
+        rack_response
       end
     end
   end

data/lib/vigiles/options.rb

@@ -0,0 +1,19 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "logger"
+
+module Vigiles
+  class Options < T::Struct
+    const :capture_exception, T.proc.params(a0: StandardError).void
+    const :logger,            ::Logger
+
+    sig { returns(Options) }
+    def self.make_default_options
+      Options.new(
+        logger: T.unsafe(Rails).logger, # you should be using this within rails.
+        capture_exception: ->(e) { e }  # a no-op exception capturer.
+      )
+    end
+  end
+end

data/lib/vigiles/spec.rb

@@ -3,9 +3,9 @@
 
 module Vigiles
   class Spec < T::Struct
-    const :request_content_types,  T::Set[String]
-    const :request_headers,        T::Set[String]
-    const :recorders,              T::Hash[String, ConversationRecorder]
+    const :request_content_types, T::Set[String]
+    const :request_headers,       T::Set[String]
+    const :recorders,             T::Hash[String, ConversationRecorder]
 
     sig { returns(Spec) }
     def self.make_default_spec

data/lib/vigiles/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Vigiles
-  VERSION = "0.1.0-beta8"
+  VERSION = "0.1.0-beta10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vigiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta8
+  version: 0.1.0.pre.beta10
 platform: ruby
 authors:
 - Yaw Boakye
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -225,6 +225,7 @@ files:
 - lib/vigiles/conversation_recorders/application_json.rb
 - lib/vigiles/conversation_recorders/unknown.rb
 - lib/vigiles/middleware/record_conversation.rb
+- lib/vigiles/options.rb
 - lib/vigiles/spec.rb
 - lib/vigiles/types.rb
 - lib/vigiles/utilities/uri.rb