logster 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cfda323f9ee2749181b885b462d4e6b6398f03b
-  data.tar.gz: d9cf1b6ce77e9c7d74745c253047d39c992a1855
+  metadata.gz: 817153c3885fd064575528496f299e302802edff
+  data.tar.gz: 2adf2a219859d1d5a1b7163fa98714a3e0d353fc
 SHA512:
-  metadata.gz: bef73cfac1f6232793744b1fcb1807da74088a271bba04b0ad7ad6bca95de46a9d39ed73e23371970afd0c7e045a93c8d538c056b4434fddbed44946fb37064f
-  data.tar.gz: 8bcab70e33821609e020ad951e2453394eafbe2fb11607d3cdb63563898656e0b48aa8227b1edb97e0eef471ef09f4f93a6c802db745676bffd714d7ca6eb2ac
+  metadata.gz: 40a5c76579e0f5145e3cdb490daab9550dd30e12d3e6be4609774aa045f46d33f3465ba20bcd0a1fe350de3000f92a9bff54c94cdb7032cbc1eccabb88765ea4
+  data.tar.gz: 33401bae4031a18e2d0e40f22679acfc1ebf0cb8515df2ea9084ca06e0eccb82a781ee34abeadf5dc4a5592c3327c77f246623b7724a40959ea330a6f4768df8

data/assets/javascript/app.js

@@ -45,7 +45,7 @@ App.preloadOrAjax = function(url, settings) {
   }
 };
 
-App.Router.map(function(){
+App.Router.map(function() {
   this.route("index", { path: "/" });
   this.route("show", { path: "/show/:id" });
 });
@@ -67,7 +67,7 @@ App.Message = Ember.Object.extend({
     return App.ajax("/unprotect/" + this.get('key'), { type: "DELETE" });
   },
 
-  hasMore: function(){
+  hasMore: function() {
     var message = this.get("message");
     var expanded = this.get("expanded");
 
@@ -82,32 +82,37 @@ App.Message = Ember.Object.extend({
     return Logger.rootPath + (this.get('protected') ? '/unprotect/' : '/protect/') + this.get('key');
   }.property("key"),
 
-  displayMessage: function(){
+  displayMessage: function() {
     var message = this.get("message");
     var expanded = this.get("expanded");
 
-    if(!expanded && message.length > this.MAX_LEN){
-      message = message.substr(0,this.MAX_LEN);
+    if (!expanded && message.length > this.MAX_LEN) {
+      message = message.substr(0, this.MAX_LEN);
     }
     return message;
-  }.property("message","expanded"),
+  }.property("message", "expanded"),
 
-  envDebug: function(){
+  envDebug: function() {
     var env = this.get("env");
-    if(env){
-      var buffer = [];
-      _.each(env, function(v,k){
-        if(k !== "params"){
+    if (env) {
+      var buffer = [],
+          hashes = [];
+      _.each(env, function(v, k) {
+        if (typeof v === "object") {
+          hashes.push(k);
+        } else {
           buffer.push(k + ": " + v);
         }
       });
 
-      buffer.push("");
-      if(_.size(env.params) > 0){
-        buffer.push("Params:");
-        buffer.push("");
-        _.each(env.params, function(v,k){
-          buffer.push("  " + k + ": " + v);
+      if (_.size(hashes) > 0) {
+        _.each(hashes, function(k1) {
+          v1 = env[k1];
+          buffer.push("");
+          buffer.push(k1 + ":");
+          _.each(v1, function(v2, k2) {
+            buffer.push("  " + k2 + ": " + v2);
+          })
         });
       }
       return buffer.join("\n");
@@ -116,7 +121,7 @@ App.Message = Ember.Object.extend({
   }.property("env"),
 
   rowClass: function() {
-    switch(this.get("severity")){
+    switch (this.get("severity")) {
       case 0:
         return "debug";
       case 1:
@@ -130,8 +135,8 @@ App.Message = Ember.Object.extend({
     }
   }.property("severity"),
 
-  glyph: function(){
-    switch(this.get("severity")){
+  glyph: function() {
+    switch (this.get("severity")) {
       case 0:
         return "";
       case 1:
@@ -151,7 +156,7 @@ App.MessageCollection = Em.Object.extend({
   messages: Em.A(),
   total: 0,
 
-  load: function(opts){
+  load: function(opts) {
     var self = this;
     opts = opts || {};
 

data/lib/logster/base_store.rb

@@ -0,0 +1,80 @@
+
+module Logster
+  class BaseStore
+
+    attr_accessor :level, :max_retention, :skip_empty, :ignore
+
+    def initialize
+      @dedup = false
+      @max_retention = 60 * 60 * 24 * 7
+      @skip_empty = true
+    end
+
+    def save(message)
+      not_implemented
+    end
+
+    def count
+      not_implemented
+    end
+
+    def clear
+      not_implemented
+    end
+
+    def clear_all
+      not_implemented
+    end
+
+    def get(message_key)
+      not_implemented
+    end
+
+    def protect(message_key)
+      not_implemented
+    end
+
+    def unprotect(message_key)
+      not_implemented
+    end
+
+    def report(severity, progname, message, opts = {})
+      return if (!message || (String === message && message.empty?)) && skip_empty
+      return if level && severity < level
+      return if ignore && ignore.any? { |pattern| message =~ pattern}
+
+      message = Logster::Message.new(severity, progname, message, opts[:timestamp])
+
+      env = opts[:env]
+      backtrace = opts[:backtrace]
+
+      if env
+        if env[:backtrace]
+          # Special - passing backtrace through env
+          backtrace = env.delete(:backtrace)
+        end
+
+        message.populate_from_env(env)
+      end
+
+      if backtrace
+        if backtrace.respond_to? :join
+          backtrace = backtrace.join("\n")
+        end
+        message.backtrace = backtrace
+      else
+        message.backtrace = caller.join("\n")
+      end
+
+      save message
+
+      message
+    end
+
+    private
+
+    def not_implemented
+      raise "Not Implemented"
+    end
+  end
+end

data/lib/logster/redis_store.rb

@@ -1,38 +1,18 @@
 require 'json'
+require 'logster/base_store'
 
 module Logster
-  class RedisStore
+  class RedisStore < BaseStore
 
-    attr_accessor :level, :redis, :max_backlog,
-                  :dedup, :max_retention, :skip_empty,
-                  :ignore
+    attr_accessor :redis, :max_backlog
 
     def initialize(redis = nil)
+      super()
       @redis = redis || Redis.new
       @max_backlog = 1000
-      @dedup = false
-      @max_retention = 60 * 60 * 24 * 7
-      @skip_empty = true
     end
 
-
-    def report(severity, progname, message, opts = nil)
-      return if (!message || (String === message && message.empty?)) && skip_empty
-      return if level && severity < level
-      return if @ignore && @ignore.any?{|pattern| message =~ pattern}
-
-      message = Logster::Message.new(severity, progname, message, (opts && opts[:timestamp]))
-
-      if opts && backtrace = opts[:backtrace]
-        message.backtrace = backtrace
-      else
-        message.backtrace = caller.join("\n")
-      end
-
-      if opts && env = opts[:env]
-        message.populate_from_env(env)
-      end
-
+    def save(message)
       # multi for integrity
       @redis.multi do
         @redis.hset(hash_key, message.key, message.to_json)
@@ -40,14 +20,12 @@ module Logster
       end
 
       # TODO make it atomic
-      if @redis.llen(list_key) > @max_backlog
+      if @redis.llen(list_key) > max_backlog
         removed_key = @redis.lpop(list_key)
         if removed_key && !@redis.sismember(protected_key, removed_key)
           @redis.hdel(hash_key, removed_key)
         end
       end
-
-      message
     end
 
     def count

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/examples/test_sidekiq_reporter_example.rb

@@ -1,13 +1,19 @@
 require_relative '../test_helper'
 require 'logster/logger'
+require 'logster/redis_store'
 require 'logger'
 require 'examples/sidekiq_logster_reporter'
 
 class TestSidekiqReporter < MiniTest::Test
 
   def setup
-    Logster.store = @store = Logster::TestStore.new
+    Logster.store = @store = Logster::RedisStore.new(Redis.new)
     Logster.logger = @logger = Logster::Logger.new(Logster.store)
+    @store.clear_all
+  end
+
+  def teardown
+    @store.clear_all
   end
 
   def test_sidekiq_handler_example
@@ -18,14 +24,23 @@ class TestSidekiqReporter < MiniTest::Test
     rescue => e
       error = e
     end
+    trace = error.backtrace
 
     handler.call(error, code: "Test", something_important: "Foo", params: { article_id: 20 })
 
-    error = Logster.store.reported[0]
+    report = @store.latest[0]
+
+    # Message is right format
+    assert_equal("Job exception: TypeError\n", report.message)
+
+    # A backtrace is joined()
+    assert_equal(trace.join("\n"), report.backtrace)
+    # The backtrace is deleted from the env
+    assert_nil(report.env['backtrace'])
+    assert_nil(report.env[:backtrace])
 
-    assert(error.backtrace != nil)
-    assert_equal("Job exception: TypeError\n", error.message)
-    assert_equal("Test", error.env[:code])
-    assert_equal(20, error.env[:params][:article_id])
+    # The env is in the report
+    assert_equal("Test", report.env['code'])
+    assert_equal(20, report.env['params']['article_id'])
   end
 end

data/test/logster/middleware/test_reporter.rb

@@ -14,7 +14,7 @@ class TestReporter < Minitest::Test
     status, = reporter.call(env)
 
     assert_equal(200, status)
-    assert_equal(1, Logster.store.reported.length)
+    assert_equal(1, Logster.store.count)
   end
 
 end

data/test/logster/test_base_store.rb

@@ -0,0 +1,94 @@
+require_relative '../test_helper'
+require 'logster/base_store'
+
+class TestBaseStore < Minitest::Test
+
+  def setup
+    @store = Logster::TestStore.new
+    @store.clear_all
+  end
+
+  def teardown
+    @store.clear_all
+  end
+
+  def test_report_skip_empty
+    @store.skip_empty = true
+    @store.report(Logger::WARN, "test", nil)
+    @store.report(Logger::WARN, "test", '')
+    @store.report(Logger::WARN, "test", "foo") #
+    @store.skip_empty = false
+    @store.report(Logger::WARN, "test", nil) #
+
+    assert_equal(2, @store.count)
+  end
+
+  def test_report_skip_level
+    @store.level = nil
+    @store.report(Logger::DEBUG, "test", "A") #
+    @store.level = Logger::WARN
+    @store.report(Logger::DEBUG, "test", "A")
+    @store.report(Logger::INFO, "test", "B")
+    @store.report(Logger::WARN, "test", "C") #
+    @store.report(Logger::ERROR, "test", "D") #
+    assert_equal(3, @store.count)
+  end
+
+  def test_report_skip_ignore
+    @store.report(Logger::WARN, "test", "Can't verify CSRF token authenticity")
+    @store.report(Logger::FATAL, "test", "ActiveRecord::RecordNotFound (Couldn't find Upload with 'id'=9947)")
+    @store.report(Logger::WARN, "test", "B")
+    @store.ignore = [
+        /^ActiveRecord::RecordNotFound \(Couldn't find Upload/,
+        /^Can't verify CSRF token authenticity/
+    ]
+    @store.report(Logger::WARN, "test", "Can't verify CSRF token authenticity")
+    @store.report(Logger::FATAL, "test", "ActiveRecord::RecordNotFound (Couldn't find Upload with 'id'=9947)")
+    @store.report(Logger::FATAL, "test", "ActiveRecord::RecordNotFound (Couldn't find Upload with 'id'=9489+78946947)")
+    @store.report(Logger::WARN, "test", "B")
+
+    assert_equal(4, @store.count)
+  end
+
+  def test_timestamp
+    time = Time.now - 24*60*60
+    message = @store.report(Logger::WARN, "test", "B", timestamp: time)
+
+    assert_equal(time, message.timestamp)
+  end
+
+  def test_backtrace
+    # Create an error with a backtrace
+    error = TypeError.new
+    begin
+      raise error
+    rescue => e
+      error = e
+    end
+
+    # Backtrace can be passed via backtrace param or env
+    message = @store.report(Logger::WARN, "test", "A", backtrace: error.backtrace)
+    assert_equal(error.backtrace.join("\n"), message.backtrace)
+    message = @store.report(Logger::WARN, "test", "B", env: {backtrace: error.backtrace})
+    assert_equal(error.backtrace.join("\n"), message.backtrace)
+
+    # Via env takes priority
+    message = @store.report(Logger::WARN, "test", "C", backtrace: "Garbage", env: {backtrace: error.backtrace})
+    assert_equal(error.backtrace.join("\n"), message.backtrace)
+
+    # Backtrace is always a string
+    # Cannot do an equal assert here, because it uses `caller` when not provided
+    message = @store.report(Logger::WARN, "test", "D", backtrace: nil)
+    assert_kind_of(String, message.backtrace)
+    message = @store.report(Logger::WARN, "test", "E", env: {backtrace: nil})
+    assert_kind_of(String, message.backtrace)
+    message = @store.report(Logger::WARN, "test", "F", backtrace: nil, env: {backtrace: nil})
+    assert_kind_of(String, message.backtrace)
+    message = @store.report(Logger::WARN, "test", "G")
+    assert_kind_of(String, message.backtrace)
+
+    # Arrays are turned into strings via join \n
+    message = @store.report(Logger::WARN, "test", "H", backtrace: ["Foo", "Bar"])
+    assert_equal("Foo\nBar", message.backtrace)
+  end
+end

data/test/logster/test_redis_store.rb

@@ -6,7 +6,7 @@ class TestRedisStore < Minitest::Test
 
   def setup
     @store = Logster::RedisStore.new(Redis.new)
-    @store.clear
+    @store.clear_all
   end
 
   def teardown

data/test/test_helper.rb

@@ -4,36 +4,29 @@ require 'minitest/autorun'
 require 'minitest/pride'
 require 'logster'
 require 'redis'
+require 'logster/base_store'
 
-
-class Logster::TestStore
+class Logster::TestStore < Logster::BaseStore
   attr_accessor :reported
   def initialize
     @reported = []
   end
 
-  def report(severity, progname, message, opts = nil)
-    opts ||= {}
-    env = opts[:env]
-    backtrace = opts[:backtrace]
-    if env && !backtrace
-      backtrace = env[:backtrace]
-    end
-
-    message = Logster::Message.new(severity, progname, message)
-
-    if backtrace
-      message.backtrace = backtrace
-    else
-      message.backtrace = caller.join("\n")
-    end
+  def save(message)
+    @reported << message
+  end
 
-    if env
-      message.populate_from_env(env)
-    end
+  def count
+    @reported.count
+  end
 
-    @reported << message
+  def clear
+    @reported = []
+  end
 
-    message
+  def clear_all
+    @reported = []
   end
+
+  # get, protect, unprotect: unimplemented
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - UI for viewing logs in Rack
@@ -126,6 +126,7 @@ files:
 - bower.json
 - lib/examples/sidekiq_logster_reporter.rb
 - lib/logster.rb
+- lib/logster/base_store.rb
 - lib/logster/configuration.rb
 - lib/logster/logger.rb
 - lib/logster/message.rb
@@ -140,6 +141,7 @@ files:
 - test/examples/test_sidekiq_reporter_example.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
+- test/logster/test_base_store.rb
 - test/logster/test_logger.rb
 - test/logster/test_redis_store.rb
 - test/test_helper.rb
@@ -172,6 +174,7 @@ test_files:
 - test/examples/test_sidekiq_reporter_example.rb
 - test/logster/middleware/test_reporter.rb
 - test/logster/middleware/test_viewer.rb
+- test/logster/test_base_store.rb
 - test/logster/test_logger.rb
 - test/logster/test_redis_store.rb
 - test/test_helper.rb