akita-har_logger 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3da46a0fcf41a0f5f1f1d88261e7345713fe9487d7a7c4485d85e0ee808c8717
-  data.tar.gz: 8857a59375d849bf4c94b47a131c90a950f5bc06da6979c75815d3a6f1c0c4d9
+  metadata.gz: 8337c88eacb3b48aa2190bb12b2bc406d1140b6e7d7c9c5ed921b5e92fe557c3
+  data.tar.gz: d6621fcf152e604396634a0614cb9fd66205e95be39be8e46142da90283af8a6
 SHA512:
-  metadata.gz: a2a17be7f105d38c3f75b70bd42dd8982c189a129895ca887333fc3609d2e3f1c362fddffd7a77f97bd43358bc907982ea6b718f96515297cf9b65c437073a0d
-  data.tar.gz: 1919850a9c0be28cd22610699a17caec16bafa2b8bf9485ab4b0f7646fbf77a2b4c3294f676033ab6c14258bf52a7ffa08dd9fe3c7e0fe729c90fa228d2acfa2
+  metadata.gz: 9efe412f404f5e56abac9af2e79b7d186ab895ceccf40cf369841563f86f5b78eb9ee7fe0cb561b20b7de93a9284343ffa50a355894fe62f6cf3e5d4193ea7d0
+  data.tar.gz: b251114f5be749a02d8d198e2dbce71ff98845085cdb48324c66e1791d3d6acd7252205cce6f5358f4e3a25fbabfecbba392094e21c56a88e8b0d89528beb408

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    akita-har_logger (0.2.0)
+    akita-har_logger (0.2.1)
       json (~> 2.3)
 
 GEM
@@ -33,4 +33,4 @@ DEPENDENCIES
   rspec (~> 3.10)
 
 BUNDLED WITH
-   2.2.15
+   2.2.16

data/README.md

@@ -48,6 +48,8 @@ Here is a sample configuration for a test environment that just adds the
 instrumentation.
 
 ```ruby
+# config/environments/test.rb
+
 Rails.application.configure.do
   # Other configuration for the Rails application...
 
@@ -61,11 +63,30 @@ end
 ### `ActionController` filter
 
 To instrument with a filter, add an instance of `Akita::HarLogger::Filter` as
-an `around_action` filter to your `ActionController` implementation. Here is an
-example of a bare-bones `app/controllers/application_controller.rb` with this
-instrumentation.
+an `around_action` filter to your `ActionController` implementation.
+
+For convenience, you can call `Akita::HarLogger::Filter.install` to do this for
+all `ActionController`s in your application. We recommend adding this call to a
+configuration initializer. For example, this initializer adds the filter only
+in the test environment:
 
 ```ruby
+# config/initializers/har_logging.rb
+
+# Add the HAR logger as an `around_action` filter to all `ActionControllers`
+# that are loaded by the application in the test environment. Optionally give
+# an output HAR file to save your trace. If not specified, this defaults to
+# `akita_trace_{timestamp}.har`.
+Akita::HarLogger::Filter.install("akita_trace.har") if Rails.env.test?
+```
+
+You can also selectively instrument your `ActionController` implementations by
+adding the filter manually. Here is a bare-bones `ActionController`
+implementation that adds the filter only in the test environment.
+
+```ruby
+# app/controllers/application_controller.rb
+
 class ApplicationController < ActionController::API
   include Response
   include ExceptionHandler
@@ -73,7 +94,7 @@ class ApplicationController < ActionController::API
   # Add the HAR logger as an `around_action` filter. Optionally give an output
   # HAR file to save your trace. If not specified, this defaults to
   # `akita_trace_{timestamp}.har`.
-  around_action Akita::HarLogger::Filter.new("akita_trace.har")
+  around_action Akita::HarLogger::Filter.new("akita_trace.har") if Rails.env.test?
 end
 ```
 

data/lib/akita/har_logger.rb

@@ -29,14 +29,10 @@ module Akita
         @app = app
 
         if out_file_name == nil then
-          out_file_name = "akita_trace_#{Time.now.to_i}.har"
+          out_file_name = HarLogger.default_file_name
         end
 
-        # This queue is used to ensure that event logging is thread-safe. The
-        # main thread will enqueue HarEntry objects. The HAR writer thread
-        # below dequeues these objects and writes them to the output file.
-        @entry_queue = Queue.new
-        WriterThread.new out_file_name, @entry_queue
+        @entry_queue = HarLogger.get_queue(out_file_name)
       end
 
       def call(env)
@@ -58,16 +54,21 @@ module Akita
     class Filter
       def initialize(out_file_name = nil)
         if out_file_name == nil then
-          out_file_name = "akita_trace_#{Time.now.to_i}.har"
+          out_file_name = HarLogger.default_file_name
         end
 
-        # This queue is used to ensure that event logging is thread-safe. The
-        # main thread will enqueue HarEntry objects. The HAR writer thread
-        # below dequeues these objects and writes them to the output file.
-        @entry_queue = Queue.new
-        WriterThread.new out_file_name, @entry_queue
+        @entry_queue = HarLogger.get_queue(out_file_name)
       end
 
+      # Registers an `on_load` initializer to add a logging filter to any
+      # ActionController that is created.
+      def self.install(out_file_name = nil, hook_name = :action_controller)
+        ActiveSupport.on_load(hook_name) do
+          around_action Filter.new(out_file_name)
+        end
+      end
+
+      # Implements the actual `around` filter.
       def around(controller)
         start_time = Time.now
 
@@ -84,5 +85,35 @@ module Akita
                                       [response.body])
       end
     end
+
+    @@default_file_name = "akita_trace_#{Time.now.to_i}.har"
+    def self.default_file_name
+      @@default_file_name
+    end
+
+    # Maps the name of each output file to a queue of entries to be logged to
+    # that file. The queue is used to ensure that event logging is thread-safe.
+    # The main thread will enqueue HarEntry objects. A HAR writer thread
+    # dequeues these objects and writes them to the output file.
+    @@entry_queues = {}
+    @@entry_queues_mutex = Mutex.new
+
+    # Returns the entry queue for the given file. If an entry queue doesn't
+    # already exist, one is created and a HAR writer thread is started for the
+    # queue.
+    def self.get_queue(out_file_name)
+      queue = nil
+      @@entry_queues_mutex.synchronize {
+        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
+      }
+
+      WriterThread.new out_file_name, queue
+      return queue
+    end
   end
 end

data/lib/akita/har_logger/version.rb

@@ -2,6 +2,6 @@
 
 module Akita
   module HarLogger
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akita-har_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jed Liu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-17 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE