vigiles 0.1.0.pre.beta7 → 0.1.0.pre.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce9b4330b1d4ad0334d37f23d154149d01580c47f3f3c32d012f4b094244fac
-  data.tar.gz: 11aa9a2571cf62454937a3e61b01b7de70bb702255b952d46f533d8831572ccd
+  metadata.gz: 7c95b320d216c89bd72c728b2b0402cae897d984554fd6c41e66739eac544e9b
+  data.tar.gz: 55bd64c8191703e6d5b6aac98945c54fd9d06a65b5b094e2c338ad64c9641fb8
 SHA512:
-  metadata.gz: 07be4f5abcbfae46edd0c480a6b3766924979990c065b7833c41c50ff6ff6401ab8b0798a643d5da339cb3a71e885be62af6034d774a2d400befb6cdf9db3e61
-  data.tar.gz: dfe33dbe27d11e5ac0604538c803158315e5fcdd61726ef0107734dc61aa53eff04f7e6e769c2dae6d1fa5d534682d0d8895eec90ef1cd5d8e8d926157474a56
+  metadata.gz: e98f9cf83934a297eed7ac621f0200b118610690ccd1c9f51279759edce9bfa0db23bd4161adcd762a891b7a3aad6c3606d3e2d66b5ae566615c971ee3bd6460
+  data.tar.gz: 8b90d7d720d5104d3280aefbf6065892f24d677489ae6c096bab31a887fbc4237ac76765f0425a16ed011aaee2dba4c2828f90a6411d6cc6dff95e761eddf943

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.specification.request_headers
+        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]] }
+        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

@@ -18,66 +18,14 @@ module Vigiles
     
     sig { params(req: ActionDispatch::Request, res: Rack::Response).returns(T.nilable(Conversation)) }
     def self.record_conversation(req:, res:)
-        # preferring to call `response.request` instead of preparing a new
-        # request (via `ActionDispatch::Request.new(env)` and passing it
-        # as an argument to this method because we can always recover the
-        # specific request that elicited a given response, according to
-        # https://github.com/rails/rails/blob/cacb8475a9d4373c0db437e7be4905685f03cefa/actionpack/lib/action_dispatch/http/response.rb#L53
-      response   = Response.from(res)
-      metadata   = Metadata.from(req.env)
-      request    = Request.from(req)
-      extras     = Extras.from(req.env)
-
-      case (content_type = request.content_type)
-      when ContentType::ApplicationJson.serialize then record_json_conversation(request:, response:, metadata:, extras:)
-      when ContentType::TextHtml.serialize        then record_html_conversation(request:, response:, metadata:, extras:)
-      else record_conversation_with_unknown_content_type(request:, response:, metadata:, extras:)
+      content_type = req.content_type
+      if (recorder = Vigiles.spec.recorders[content_type]).nil?
+        raise \
+          UnrecordableRequestError,
+          "no recorder configured for content type: #{content_type}"
       end
-    rescue Request::InvalidParameterError => e
-      raise UnrecordableRequestError, "#{e.parameter} considered invalid"
-    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:
-    )
+      recorder.record(req:, res:)
     end
   end
 end

data/lib/vigiles/conversation_recorder.rb

@@ -3,9 +3,24 @@
 
 module Vigiles
   class ConversationRecorder
+    class MisconfiguredRecorderError < StandardError
+      sig { returns(String) }
+      attr_reader :expected
+
+      sig { returns(String) }
+      attr_reader :actual
+
+      sig { params(expected: String, actual: String).void }
+      def initialize(expected:, actual:)
+        @expected = expected
+        @actual = actual
+        super
+      end
+    end
+
     abstract!
 
-    sig { abstract.params(response: ActionDispatch::Response).returns(Archive::Conversation) }
-    def record(response); end
+    sig { abstract.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
+    def record(req:, res:); end
   end
 end

data/lib/vigiles/conversation_recorders/application_json.rb

@@ -6,8 +6,45 @@ module Vigiles
     class ApplicationJson < ConversationRecorder
       include Singleton
 
-      sig { override.params(_response: ActionDispatch::Response).returns(Archive::Conversation) }
-      def record(_response) = Archive::Conversation.new
+      ConversationRecorder = Vigiles::ConversationRecorder
+      ContentType          = Vigiles::Types::ContentType
+      Conversation         = Vigiles::Archive::Conversation
+      Response             = Vigiles::Archive::Response
+      Metadata             = Vigiles::Archive::Metadata
+      Request              = Vigiles::Archive::Request
+      Extras               = Vigiles::Archive::Extras
+
+      sig { override.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
+      def record(req:, res:)
+        unless req.content_type == ContentType::ApplicationJson.serialize
+          raise ConversationRecorder::MisconfiguredRecorderError.new(
+            expected: ContentType::ApplicationJson.serialize,
+            actual: req.content_type
+          )
+        end
+
+        response = Response.from(res)
+        request  = Request.from(req)
+
+        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
+        )
+      end
     end
   end
 end

data/lib/vigiles/conversation_recorders/unknown.rb

@@ -4,8 +4,10 @@
 module Vigiles
   module ConversationRecorders
     class Unknown < ConversationRecorder
-      sig { override.params(_response: ActionDispatch::Response).returns(Archive::Conversation) }
-      def record(_response) = Archive::Conversation.new
+      include Singleton
+
+      sig { override.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
+      def record(req:, res:) = Archive::Conversation.new
     end
   end
 end

data/lib/vigiles/spec.rb

@@ -3,16 +3,16 @@
 
 module Vigiles
   class Spec < T::Struct
-    const :content_type_recorders, T::Hash[String, ConversationRecorder]
-    const :request_content_types,  T::Set[String]
-    const :request_headers,        T::Set[String]
+    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
       Spec.new(
-        content_type_recorders: Constants::DEFAULT_CONTENT_TYPE_RECORDERS,
         request_content_types: Constants::DEFAULT_CONTENT_TYPES,
-        request_headers: Set[]
+        request_headers: Set[].freeze,
+        recorders: Constants::DEFAULT_CONTENT_TYPE_RECORDERS
       )
     end
   end

data/lib/vigiles/version.rb

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

data/lib/vigiles.rb

@@ -17,16 +17,16 @@ module Vigiles
   extend T::Sig
 
   sig { returns(Vigiles::Spec) }
-  def self.specification
-    @specification ||= T.let(
+  def self.spec
+    @spec ||= T.let(
       Vigiles::Spec.make_default_spec,
       T.nilable(Vigiles::Spec)
     )
   end
 
   sig { params(spec: Vigiles::Spec).returns(Vigiles::Spec) }
-  def self.specification=(spec)
-    @specification = spec
+  def self.spec=(spec)
+    @spec = spec
   end
 
   sig { params(req: ActionDispatch::Request, res: Rack::Response).returns(T.nilable(Archive::Conversation)) }
@@ -40,9 +40,9 @@ module Vigiles
 
   sig { params(blk: T.untyped).void }
   def self.configure(&blk)
-    blk.call(specification)
+    blk.call(spec)
 
-    # TODO(yaw, 2024-06-15): ensure that the specification is valid.
+    # TODO(yaw, 2024-06-15): ensure that the spec is valid.
     # ensure that for every content type a recorder is configured. otherwise
     # assign the general recorder for unknown content types.
   end

data/sorbet/tapioca/require.rb

@@ -3,10 +3,10 @@
 
 require "action_dispatch"
 require "active_record"
+require "logger"
 require "minitest/autorun"
 require "rails/generators"
 require "rails/generators/active_record"
 require "securerandom"
 require "sorbet-runtime"
-require "uri"
 require "zeitwerk"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vigiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta7
+  version: 0.1.0.pre.beta9
 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