vigiles 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c7da56eb222eab7028b219abca2ba0e58d07e6ea839e8cf128e2f06899e8369
-  data.tar.gz: 5cf3f8e95434d3db95d2fecf235e9887f13418999d67419428714054b5971816
+  metadata.gz: '08d13600f7b4174e33a7e521448bf0e4f0ef47558e71a7efb7ce981a116f70da'
+  data.tar.gz: cf7c0fa969ae7583ee17ce277446dd1767277b3bb36af16b2fec807c411ef3b8
 SHA512:
-  metadata.gz: 0fab3769857951735aa3d586eb6cb1de7793f2687396cac8503d2804f22a75b6e786d96f68ecfff112f15ce7f7e152362c146f9c14f9af77f370d671918848c5
-  data.tar.gz: 7751d30f849eb16247aa8a23c7c7d07825b10080fa5689954d2493d2a9602fdfd2436c94ba64bacee1d455af9edfd9333a7fe6a11bd17d8dd583f6465cd6c2e8
+  metadata.gz: 1a5320beaccd2f32fd8d622e7561a2230f001a7f551561fb01f6eb94bfba092369af3690c0dd5728d5d1118072e9e42c41e50f39f1dace9aafab0af74c1cdc2c
+  data.tar.gz: 6cbab6e02ee4513c9b9755779fc935d230989e789a9610dc9a0bd10cd882afd31c7a4f328a7461c123d951df534025d2e8f67f4a769a61bf7a0891a0461de574

data/.rubocop.yml

@@ -4,7 +4,7 @@ require:
   - rubocop-sorbet
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 3.3
   Exclude:
     - "**/generators/**/*"
     - "**/sorbet/**/*"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/lib/vigiles/archive/extras.rb

@@ -8,7 +8,7 @@ module Vigiles
 
       sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Extras) }
       def self.from(request_env)
-        Extras.new(request_env: request_env)
+        Extras.new(request_env:)
       end
     end
   end

data/lib/vigiles/archive/metadata.rb

@@ -8,7 +8,7 @@ module Vigiles
 
       sig { params(request_env: T::Hash[T.untyped, T.untyped]).returns(Metadata) }
       def self.from(request_env)
-        Metadata.new(request_env: request_env)
+        Metadata.new(request_env:)
       end
     end
   end

data/lib/vigiles/archive/response.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Vigiles
@@ -10,6 +10,33 @@ module Vigiles
       const :payload,      Types::Payload
       const :status,       Integer
 
+      class ResponseBodyTooDeepError < StandardError
+        sig { returns(Integer) }
+        attr_reader :max_stack_depth
+
+        sig { returns(Integer) }
+        attr_reader :stack_depth
+
+        sig { params(stack_depth: Integer, max_stack_depth: Integer).void }
+        def initialize(stack_depth, max_stack_depth)
+          @max_stack_depth = max_stack_depth
+          @stack_depth     = stack_depth
+
+          super
+        end
+      end
+
+      sig { params(body: Rack::BodyProxy, stack_depth: Integer).returns(String) }
+      private_class_method def self.extract_body_from_rack_body_proxy(body, stack_depth = 1)
+        raise ResponseBodyTooDeepError.new(stack_depth, 5) unless stack_depth < 5
+
+        case (inner_body = body.instance_variable_get(:@body))
+        when Rack::BodyProxy then extract_body_from_rack_body_proxy(inner_body, stack_depth + 1)
+        when Array           then inner_body[0] || "null"
+        else raise
+        end
+      end
+
       sig { params(rack_response: Rack::Response).returns(Types::Payload) }
       private_class_method def self.extract_payload(rack_response)
         case (body = rack_response.body)
@@ -18,12 +45,11 @@ module Vigiles
 
           { __false_body: :not_empty_handle_later }
         when Rack::BodyProxy
-          body_proxy = body
-          body_proxy = body_proxy.instance_variable_get(:@body) until body_proxy.is_a?(Array)
+          extracted_body = extract_body_from_rack_body_proxy(body)
           begin
-            JSON.parse(body_proxy[0])
+            JSON.parse(extracted_body)
           rescue StandardError
-            { __false_body: body_proxy[0] }
+            { __false_body: extracted_body }
           end
         else
           { __false_body: :unknown_response_payload_type }

data/lib/vigiles/archive.rb

@@ -15,7 +15,7 @@ module Vigiles
         super
       end
     end
-    
+
     sig { params(req: ActionDispatch::Request, res: Rack::Response).returns(T.nilable(Conversation)) }
     def self.record_conversation(req:, res:)
       content_type = req.content_type

data/lib/vigiles/constants.rb

@@ -8,7 +8,7 @@ module Vigiles
         %w[
           application/json
         ]
-      ), T::Set[String]
+      ).freeze, T::Set[String]
     )
 
     DEFAULT_CONTENT_TYPE_RECORDERS = T.let(

data/lib/vigiles/conversation_recorder.rb

@@ -20,6 +20,9 @@ module Vigiles
 
     abstract!
 
+    sig { abstract.params(req: ActionDispatch::Request).void }
+    def ensure_content_type_matches!(req); end
+
     sig { abstract.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
     def record(req:, res:); end
   end

data/lib/vigiles/conversation_recorders/application_json.rb

@@ -14,14 +14,19 @@ module Vigiles
       Request              = Vigiles::Archive::Request
       Extras               = Vigiles::Archive::Extras
 
+      sig { override.params(req: ActionDispatch::Request).void }
+      private def ensure_content_type_matches!(req)
+        return if req.content_type == ContentType::ApplicationJson.serialize
+
+        raise ConversationRecorder::MisconfiguredRecorderError.new(
+          expected: ContentType::ApplicationJson.serialize,
+          actual: req.content_type
+        )
+      end
+
       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
+        ensure_content_type_matches!(req)
 
         response = Response.from(res)
         request  = Request.from(req)

data/lib/vigiles/conversation_recorders/unknown.rb

@@ -6,6 +6,9 @@ module Vigiles
     class Unknown < ConversationRecorder
       include Singleton
 
+      sig { override.params(req: ActionDispatch::Request).void }
+      def ensure_content_type_matches!(req); end
+
       sig { override.params(req: ActionDispatch::Request, res: Rack::Response).returns(Archive::Conversation) }
       def record(req:, res:) = Archive::Conversation.new
     end

data/lib/vigiles/middleware/record_conversation.rb

@@ -13,7 +13,7 @@ module Vigiles
         to: :options
 
       sig { params(app: T.untyped, options: Vigiles::Options).void }
-      def initialize(app, options=Vigiles::Options.make_default_options)
+      def initialize(app, options = Vigiles::Options.make_default_options)
         @app     = app
         @options = options
       end
@@ -36,7 +36,7 @@ module Vigiles
             "[vigiles] conversation recorder: " \
             "conversation=#{convo.nil? ? "not_recorded" : convo.id} " \
             "request=#{req.request_id}"
-        rescue => e
+        rescue StandardError => e
           capture_exception.call(e)
           logger.warn \
             "[vigiles] conversation recorder error: " \

data/lib/vigiles/utilities/json.rb

@@ -3,14 +3,12 @@
 
 require "json"
 
-module Vigies
+module Vigiles
   module Utilities
     module JSON
       extend T::Sig
 
-      UntypedHash = Vigiles::Types::UntypedHash
-
-      sig { params(text: String).returns(T.any(String, UntypedHash)) }
+      sig { params(text: String).returns(T.any(String, Vigiles::Types::UntypedHash)) }
       def self.parse_benignly(text)
         ::JSON.parse(text)
       rescue StandardError

data/lib/vigiles/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Vigiles
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end