logster 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6bb693026c9bc6da3cae18d09fd0c1fcc13194530d6f43623ae7f424bb9da33
-  data.tar.gz: 6b453201f1188f132ee731e80a6f4a529a9fcb4a675b8f113d91c0ce445ccc83
+  metadata.gz: 484138ca4f1b5b9212316516f8aca1ea2c062f658da58d0f39556780407f9515
+  data.tar.gz: f341af6a072b39c1ce7d2b1ed33c0971cc2797509db10a88205566f60c30df96
 SHA512:
-  metadata.gz: 146b861272b627ff3f43237529e5efd9e9a4d22a7fc94306bd7147e871f3f79ca74fdf1787aeb76d209ab8de97b611a8fed7f1a5d780b64c8ceb1d3bb88333e0
-  data.tar.gz: 05ea4da3f3a9165eb8eca96c3449ef3169e410669970b6a3c11cc5132f5d0c2d8747f2a183d2c4cb734835da5651049a118b45d0c874be462379d9eeb8c7d4ee
+  metadata.gz: f0037037f85b24ffb9b668555b262114b17d1b8eb9c40132030db9e641401384de993d7c6b31fad715c62d6c5b655f746f9504de2400b16e37c15733e4cb65c8
+  data.tar.gz: 86671e65478cc95e12dd6babb49bfd37cf0a919d8a4e7b7f73c981ead3e3b93b4fb37756330359ad914983f2ee526c36ad2e158897ad13f64b910a40f590e55f

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # CHANGELOG
 
+- 2019-02-13: Version 2.1.0
+  - FEATURE/DEV: adds a defer logger that will do logging asynchronously only in dev environments. It should speed things up a little in dev.
+
 - 2019-02-05: Version 2.0.1
   - FIX: env line height issue on iOS
 

data/lib/logster/defer_logger.rb

@@ -0,0 +1,14 @@
+require 'logster/scheduler'
+
+module Logster
+  class DeferLogger < ::Logster::Logger
+    private
+
+    def report_to_store(severity, progname, message, opts = {})
+      opts[:backtrace] ||= caller
+      Logster::Scheduler.schedule do
+        super(severity, progname, message, opts)
+      end
+    end
+  end
+end

data/lib/logster/logger.rb

@@ -98,11 +98,16 @@ module Logster
       opts ||= {}
       opts[:env] ||= Thread.current[LOGSTER_ENV]
 
-      @store.report(severity, progname, message, opts)
-
+      report_to_store(severity, progname, message, opts)
     rescue => e
       # don't blow up if STDERR is somehow closed
       STDERR.puts "Failed to report error: #{e} #{severity} #{message} #{progname}" rescue nil
     end
+
+    private
+
+    def report_to_store(severity, progname, message, opts = {})
+      @store.report(severity, progname, message, opts)
+    end
   end
 end

data/lib/logster/rails/railtie.rb

@@ -13,7 +13,13 @@ module Logster::Rails
     store = Logster.store ||= Logster::RedisStore.new
     store.level = Logger::Severity::WARN if Rails.env.production?
 
-    logger = Logster::Logger.new(store)
+    if Rails.env.development?
+      require 'logster/defer_logger'
+      logger = Logster::DeferLogger.new(store)
+    else
+      logger = Logster::Logger.new(store)
+    end
+
     logger.chain(::Rails.logger)
     logger.level = ::Rails.logger.level
 

data/lib/logster/scheduler.rb

@@ -0,0 +1,40 @@
+module Logster
+  module Deferer
+    attr_reader :queue, :thread
+    def initialize
+      @queue = Queue.new
+      @mutex = Mutex.new
+      @thread = nil
+    end
+
+    def schedule(&blk)
+      start_thread if !@thread&.alive?
+      @queue << blk
+    end
+
+    private
+
+    def start_thread
+      @mutex.synchronize do
+        if !@thread&.alive?
+          @thread = Thread.new { do_work }
+        end
+      end
+    end
+
+    def do_work
+      while true
+        blk = @queue.pop
+        # we need to be able to break the loop so that the new
+        # thread "finishes" and let us test this code.
+        break if blk == :terminate
+        blk.call
+      end
+    end
+  end
+
+  class Scheduler
+    extend Deferer
+    initialize
+  end
+end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/test/logster/test_defer_logger.rb

@@ -0,0 +1,34 @@
+require_relative '../test_helper'
+require 'logster/defer_logger'
+require 'logster/logger'
+
+class TestDeferLogger < Minitest::Test
+  def setup
+    @store = TestStore.new
+    @defer_logger = Logster::DeferLogger.new(@store)
+  end
+
+  def test_defer_logger_inherits_logger
+    assert(Logster::Logger === @defer_logger)
+  end
+
+  def test_work_is_done_async
+    queue = Logster::Scheduler.queue
+    assert_equal(0, queue.size)
+
+    @defer_logger.add(4, "hi this a test", "prog")
+
+    assert_equal(1, queue.size)
+    queue << :terminate
+    Logster::Scheduler.thread.join
+    assert_equal(1, @store.calls.size)
+
+    # we need to make sure the backtrace is passed from the main thread.
+    # Otherwise we'd only get a partial backtrace from
+    # the point the new thread was spawned
+    backtrace = @store.calls.first[3][:backtrace]
+    assert_instance_of(Array, backtrace)
+
+    assert_equal(0, queue.size)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -237,6 +237,7 @@ files:
 - lib/logster.rb
 - lib/logster/base_store.rb
 - lib/logster/configuration.rb
+- lib/logster/defer_logger.rb
 - lib/logster/ignore_pattern.rb
 - lib/logster/logger.rb
 - lib/logster/message.rb
@@ -245,6 +246,7 @@ files:
 - lib/logster/middleware/viewer.rb
 - lib/logster/rails/railtie.rb
 - lib/logster/redis_store.rb
+- lib/logster/scheduler.rb
 - lib/logster/version.rb
 - lib/logster/web.rb
 - logster.gemspec
@@ -254,6 +256,7 @@ files:
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_base_store.rb
+- test/logster/test_defer_logger.rb
 - test/logster/test_ignore_pattern.rb
 - test/logster/test_logger.rb
 - test/logster/test_message.rb
@@ -291,6 +294,7 @@ test_files:
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
 - test/logster/test_base_store.rb
+- test/logster/test_defer_logger.rb
 - test/logster/test_ignore_pattern.rb
 - test/logster/test_logger.rb
 - test/logster/test_message.rb