vigiles 0.1.0.pre.beta9 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c95b320d216c89bd72c728b2b0402cae897d984554fd6c41e66739eac544e9b
-  data.tar.gz: 55bd64c8191703e6d5b6aac98945c54fd9d06a65b5b094e2c338ad64c9641fb8
+  metadata.gz: aa4d66607b27003c6f7aa0e7a2371d97e2b982ca63d829791d7cc2b042aa75a1
+  data.tar.gz: c2a5a05744d8ef06ba60ee4185e8fa80b9c7f76f35d2dbfd0f4503e3abe70539
 SHA512:
-  metadata.gz: e98f9cf83934a297eed7ac621f0200b118610690ccd1c9f51279759edce9bfa0db23bd4161adcd762a891b7a3aad6c3606d3e2d66b5ae566615c971ee3bd6460
-  data.tar.gz: 8b90d7d720d5104d3280aefbf6065892f24d677489ae6c096bab31a887fbc4237ac76765f0425a16ed011aaee2dba4c2828f90a6411d6cc6dff95e761eddf943
+  metadata.gz: 77578a9fce6e3acb35e99c0d4d8323ec6485681a80f0236de6960d8e52cb1f6c501b065fa96447f6c09e6cddd5d011eaa9475806d96544236b15a0336e9dc7a1
+  data.tar.gz: 7496e7124c6f4511893d5299fa4918913203d060ba946c109e0eb712bc4f685a6e74c1ea440b902097fd8dcff053f73e929ae6e019ec887c86028e6a3ddf44c4

data/lib/vigiles/archive/request.rb

@@ -48,7 +48,7 @@ module Vigiles
         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(
@@ -59,7 +59,7 @@ module Vigiles
           protocol: request.protocol,
           headers: unfucked_headers,
           origin: request.origin || "unknown_origin_url",
-          payload: request.body.read,
+          payload: Utilities::JSON.parse_benignly(request.body.read),
           http_method: Types::HttpMethod.deserialize(request.method),
           path: request.path,
           url: Utilities::URI.parse_into_http_or_https(request.url),

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

@@ -1,16 +1,24 @@
 # typed: strict
 # 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 +28,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/types.rb

@@ -24,10 +24,12 @@ module Vigiles
       end
     end
 
-    Headers     = T.type_alias { T::Hash[String, T.untyped] }
-    JsonPayload = T.type_alias { T::Hash[T.untyped, T.untyped] }
     HtmlPayload = String
+
+    UntypedHash = T.type_alias { T::Hash[T.untyped, T.untyped] }
+    JsonPayload = T.type_alias { UntypedHash }
     Payload     = T.type_alias { T.any(JsonPayload, HtmlPayload) }
+    Headers     = T.type_alias { T::Hash[String, T.untyped] }
 
     ContentTypeRecorder = T.type_alias do
       T::Hash[String, T.proc.params(arg0: ActionDispatch::Response).returns(Vigiles::Archive::Conversation)]

data/lib/vigiles/utilities/json.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "json"
+
+module Vigies
+  module Utilities
+    module JSON
+      sig { params(text: String).returns(T.any(String, Vigiles::Types::UntypedHash)) }
+      def self.parse_benignly(text)
+        ::JSON.parse(text)
+      rescue StandardError
+        text
+      end
+    end
+  end
+end

data/lib/vigiles/version.rb

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

data/lib/vigiles.rb

@@ -3,11 +3,11 @@
 
 require "zeitwerk"
 require "sorbet-runtime"
-require_relative "core_ext"
 require "action_dispatch"
+require_relative "core_ext"
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
-loader.inflector.inflect("uri" => "URI")
+loader.inflector.inflect("uri" => "URI", "json" => "JSON")
 loader.ignore("#{__dir__}/generators")
 loader.ignore("#{__dir__}/core_ext.rb")
 loader.ignore("#{__dir__}/core_ext")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vigiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.beta9
+  version: 0.1.1
 platform: ruby
 authors:
 - Yaw Boakye
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-26 00:00:00.000000000 Z
+date: 2024-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -225,8 +225,10 @@ 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/json.rb
 - lib/vigiles/utilities/uri.rb
 - lib/vigiles/version.rb
 - sorbet/config