akita-har_logger 0.2.9 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1366b8824f9cd610742238604c0d162845132a67dd67e9763542ae271cf0b7d
-  data.tar.gz: 2ca5e09f1f65045405ce549b194fa4a51573663f43e1f3ecdde5c73d930538c2
+  metadata.gz: a3b611831d6f7988fe3b4bdbd3b1f23cf3e7943b64d982359efe3479e5ccae89
+  data.tar.gz: 5f13ca181485730ee97ce59135189f42b6239ca1dfd7ac5149dfc0b77fbccd16
 SHA512:
-  metadata.gz: 82b07817b21e2e05c0f5c5139370c7bdd9b712dcd02e134b9d52be1d1ce95a00e4ff200067c0797a9be1a1f2b56a0518a2fac0526696bb3de3700f8f58c9bd44
-  data.tar.gz: 45ea9d1c479cb47f481c1b3fb7eba1dc8032dc692dc69d478e8cba98b2abb14d94e685efff5d5591785a871ddecc787166c99f70ceb2d99fc5f6961803f27a49
+  metadata.gz: '00192467492c3d4faeec67d204f87c19f898004d202d52c40ea56e44b4eca30b6f3f22718000e592fdec5f4b74673c13aecf23f13a668ec87fd02e0e15041948'
+  data.tar.gz: fb3e2004d5b971cbd081e690afebdffb904491de368f44d703635ba7b5c2aeeddae32fb7612fe4bbdef804dee930bd596005002ae2a2d5a1abdbf5195588b8cc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    akita-har_logger (0.2.9)
+    akita-har_logger (0.2.13)
 
 GEM
   remote: https://rubygems.org/

data/lib/akita/har_logger.rb

@@ -33,22 +33,60 @@ module Akita
         end
 
         @entry_queue = HarLogger.get_queue(out_file_name)
+      rescue => e
+        HarLogger.logException("initializing middleware", e)
+        raise
       end
 
       def call(env)
         start_time = Time.now
+
+        # Read the request body here, in case there is non-Rack-compliant
+        # middleware in the stack that closes the request-body stream on us.
+        request_body = env['rack.input'].read
+        env['rack.input'].rewind  # Be kind.
+
         status, headers, body = @app.call(env)
         end_time = Time.now
 
         wait_time_ms = ((end_time.to_f - start_time.to_f) * 1000).round
 
+        # Patch env with our saved request body.
+        saved_input = env['rack.input']
+        env['rack.input'] = StringIO.new request_body
+
+        # Buffer the response body in case it's not a rewindable stream.
+        body = HarLogger.bufferBody(body)
+
         @entry_queue << (HarEntry.new start_time, wait_time_ms, env, status,
                                       headers, body)
 
+        # Be kind and restore the original request-body stream.
+        env['rack.input'] = saved_input
+
         [ status, headers, body ]
+      rescue => e
+        HarLogger.logException("handling request", e)
+        raise
       end
     end
 
+    # Logs the given exception.
+    def self.logException(context, e)
+      Rails.logger.debug "AKITA: Exception while #{context}: #{e.message} "\
+                         "(#{e.class.name})"
+      e.backtrace.each { |frame|
+        Rails.logger.debug "AKITA:   #{frame}"
+      }
+    end
+
+    # Reads the given body into an array and returns the result.
+    def self.bufferBody(body)
+      result = []
+      body.each { |part| result << part }
+      result
+    end
+
     # Logging filter for `ActionController`s.
     # TODO: Some amount of code duplication here. Should refactor.
     class Filter
@@ -58,6 +96,9 @@ module Akita
         end
 
         @entry_queue = HarLogger.get_queue(out_file_name)
+      rescue => e
+        HarLogger.logException("initializing filter", e)
+        raise
       end
 
       # Registers an `on_load` initializer to add a logging filter to any
@@ -72,6 +113,11 @@ module Akita
       def around(controller)
         start_time = Time.now
 
+        # Read the request body here, in case there is non-Rack-compliant
+        # middleware in the stack that closes the request-body stream on us.
+        request_body = controller.response.request.env['rack.input'].read
+        controller.response.request.env['rack.input'].rewind  # Be kind.
+
         yield
 
         end_time = Time.now
@@ -80,9 +126,19 @@ module Akita
         response = controller.response
         request = response.request
 
+        # Patch env with our saved request body.
+        saved_input = request.env['rack.input']
+        request.env['rack.input'] = StringIO.new request_body
+
         @entry_queue << (HarEntry.new start_time, wait_time_ms, request.env,
                                       response.status, response.headers,
                                       [response.body])
+
+        # Be kind and restore the original request-body stream.
+        request.env['rack.input'] = saved_input
+      rescue => e
+        HarLogger.logException("handling request", e)
+        raise
       end
     end
 
@@ -103,13 +159,23 @@ module Akita
     # queue.
     def self.get_queue(out_file_name)
       queue = nil
+      Rails.logger.debug "AKITA: About to acquire entry-queue mutex "\
+                         "#{@@entry_queues_mutex} in #{Thread.current}. "\
+                         "Self-owned? #{@@entry_queues_mutex.owned?}"
       @@entry_queues_mutex.synchronize {
-        if @@entry_queues.has_key?(out_file_name) then
-          return @@entry_queues[out_file_name]
+        begin
+          Rails.logger.debug "AKITA: Acquired entry-queue mutex "\
+                             "#{@@entry_queues_mutex} in #{Thread.current}."
+          if @@entry_queues.has_key?(out_file_name) then
+            return @@entry_queues[out_file_name]
+          end
+
+          queue = Queue.new
+          @@entry_queues[out_file_name] = queue
+        ensure
+          Rails.logger.debug "AKITA: About to release entry-queue mutex "\
+                             "#{@@entry_queues_mutex} in #{Thread.current}."
         end
-
-        queue = Queue.new
-        @@entry_queues[out_file_name] = queue
       }
 
       WriterThread.new out_file_name, queue

data/lib/akita/har_logger/http_request.rb

@@ -122,7 +122,7 @@ module Akita
             # encoding and characters that have no UTF-8 representation by
             # replacing with '?'. Log a warning when this happens.
             sourceCharset = getPostDataCharSet(env)
-            source = String.new(req.body.string).force_encoding(sourceCharset)
+            source = String.new(req.body.read).force_encoding(sourceCharset)
             utf8EncodingSuccessful = false
             if source.valid_encoding? then
               begin

data/lib/akita/har_logger/http_response.rb

@@ -159,7 +159,9 @@ module Akita
 
       def getBodySize(body)
         length = 0
-        body.each { |part| length += part.bytesize }
+        # Convert each body part into a string in case we're dealing with
+        # non-Rack-compliant components.
+        body.each { |part| length += part.to_s.bytesize }
         length
       end
     end

data/lib/akita/har_logger/version.rb

@@ -2,6 +2,6 @@
 
 module Akita
   module HarLogger
-    VERSION = "0.2.9"
+    VERSION = "0.2.13"
   end
 end

data/lib/akita/har_logger/writer_thread.rb

@@ -15,42 +15,57 @@ module Akita
         shutdown_mutex = Mutex.new
 
         Thread.new do
+          Rails.logger.debug "AKITA: About to acquire shutdown mutex "\
+                             "#{shutdown_mutex} for file #{out_file_name} "\
+                             "in writer thread #{Thread.current}. "\
+                             "Self-owned? #{shutdown_mutex.owned?}"
           shutdown_mutex.synchronize {
-            File.open(out_file_name, 'w') { |f|
-              # Produce a preamble.
-              f.write <<~EOF.chomp
-                {
-                  "log": {
-                    "version": "1.2",
-                    "creator": {
-                      "name": "Akita HAR logger for Ruby",
-                      "version": "1.0.0"
-                    },
-                    "entries": [
-              EOF
+            begin
+              Rails.logger.debug "AKITA: Acquired shutdown mutex "\
+                                 "#{shutdown_mutex} for file "\
+                                 "#{out_file_name} in writer thread "\
+                                 "#{Thread.current}."
+              File.open(out_file_name, 'w') { |f|
+                # Produce a preamble.
+                f.write <<~EOF.chomp
+                  {
+                    "log": {
+                      "version": "1.2",
+                      "creator": {
+                        "name": "Akita HAR logger for Ruby",
+                        "version": "1.0.0"
+                      },
+                      "entries": [
+                EOF
 
-              first_entry = true
+                first_entry = true
 
-              loop do
-                entry = entry_queue.pop
-                if entry == nil then break end
+                loop do
+                  entry = entry_queue.pop
+                  if entry == nil then break end
 
-                # Emit comma separator if needed.
-                f.puts (first_entry ? '' : ',')
-                first_entry = false
+                  # Emit comma separator if needed.
+                  f.puts (first_entry ? '' : ',')
+                  first_entry = false
 
-                # Emit the dequeued entry.
-                f.write JSON.generate(entry)
-              end
+                  # Emit the dequeued entry.
+                  f.write JSON.generate(entry)
+                end
 
-              # Produce the epilogue.
-              f.write <<~EOF
+                # Produce the epilogue.
+                f.write <<~EOF
 
-                    ]
+                      ]
+                    }
                   }
-                }
-              EOF
-            }
+                EOF
+              }
+            ensure
+              Rails.logger.debug "AKITA: About to release shutdown mutex "\
+                                 "#{shutdown_mutex} for file "\
+                                 "#{out_file_name} in writer thread "\
+                                 "#{Thread.current}."
+            end
           }
         end
 
@@ -59,7 +74,18 @@ module Akita
           # Signal to the consumer that this is the end of the entry stream and
           # wait for the consumer to terminate.
           entry_queue << nil
-          shutdown_mutex.synchronize {}
+          Rails.logger.debug "AKITA: About to acquire shutdown mutex "\
+                             "#{shutdown_mutex} for file #{out_file_name} "\
+                             "while shutting down in #{Thread.current}. "\
+                             "Self-owned? #{shutdown_mutex.owned?}"
+          shutdown_mutex.synchronize {
+            Rails.logger.debug "AKITA: Acquired shutdown mutex "\
+                               "#{shutdown_mutex} for file #{out_file_name} "\
+                               "while shutting down in #{Thread.current}."
+            Rails.logger.debug "AKITA: About to release shutdown mutex "\
+                               "#{shutdown_mutex} for file #{out_file_name} "\
+                               "while shutting down in #{Thread.current}."
+          }
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akita-har_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.13
 platform: ruby
 authors:
 - Jed Liu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec