logster 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eadf4ac198a2256f98ce3bfcb70be74dbe2056eb
-  data.tar.gz: c85f2dac78f07d7cc0b77eedcafd1572942e9ebe
+  metadata.gz: ffac6b3153b63a23916214aa819293b81483ce41
+  data.tar.gz: 3750f61bc3cddfd46bf8069d6a35ac27349cd59c
 SHA512:
-  metadata.gz: caee98bce33d83120e194452898da0533a1ffcd180c05f8c893563b0039d453b3cd6620cf9a5ffa333722ee1cabc17eefb1c2c61acddfb31afb739f61642b2c9
-  data.tar.gz: 7b35e552e33df43b0d3e513f68cc380b21064b48df88b82f5aaa333345844b457f7f677a0ef79a1492e4049cf9bb5d2d91b1333bb42fdc6abaf73a2c60723c85
+  metadata.gz: a5099353cb310d52c6095703370c29538c20fae71855b9d4c840cfb0f445c97a7d7805a730eb185b88f92b1374cb48995b05233cb291ba2b8800d7bda5c28d53
+  data.tar.gz: 4b0f69413fa4fd45f1d328298aac52232d0578204332263c5b279d64c017c2d09bc9a1d6169095f1e69a5e6c311a0c41742a109e96766d9d44a4df05ee3c3a1e

data/README.md

@@ -17,7 +17,15 @@ And then execute:
 
     $ bundle
 
-Logster will wire up `/logs` path in your Rails app in **development** mode only. To wire up in production you will need to set
+Make Logster available in your development environment by adding the following to your routes.rb:
+
+```
+if Rails.env == "development"
+  mount Logster::Web => "/logs"
+end
+```
+
+Logster will be available in your Rails app in **development** mode only. To wire up in production you will need to set
 
 ```
 Logster.config.authorize_callback = lambda{|env| your_own_can_see_logs? }

data/assets/javascript/app.js

@@ -27,17 +27,44 @@ App.ajax =  function(url, settings) {
   return $.ajax(Logger.rootPath + url, settings);
 };
 
+App.preloadOrAjax = function(url, settings) {
+  var preloaded = Logger.preload[url];
+  if (preloaded) {
+    // return a pseudo-XHR
+    return {
+      success: function(callback) {
+        setTimeout(function() {
+          callback(preloaded);
+        }, 0);
+        return this;
+      },
+      error: function() { return this; }
+    };
+  } else {
+    return App.ajax(url, settings);
+  }
+};
 
 App.Router.map(function(){
   this.route("index", { path: "/" });
+  this.route("show", { path: "/show/:id" });
 });
 
 App.Message = Ember.Object.extend({
 
   MAX_LEN: 200,
 
-  expand: function(){
-    this.set("expanded",true);
+  expand: function() {
+    this.set("expanded", true);
+  },
+
+  protect: function() {
+    this.set('saved', true);
+    return App.ajax("/protect/" + this.get('key'), { type: "PUT" });
+  },
+  unprotect: function() {
+    this.set('saved', false);
+    return App.ajax("/protect/" + this.get('key'), { type: "DELETE" });
   },
 
   hasMore: function(){
@@ -47,6 +74,10 @@ App.Message = Ember.Object.extend({
     return !expanded && message.length > this.MAX_LEN;
   }.property("message", "expanded"),
 
+  shareUrl: function() {
+    return Logger.rootPath + "/show/" + this.get('key');
+  }.property("key"),
+
   displayMessage: function(){
     var message = this.get("message");
     var expanded = this.get("expanded");
@@ -143,17 +174,17 @@ App.MessageCollection = Em.Object.extend({
 
     App.ajax("/messages.json", {
       data: data
-    }).success(function(data){
-        if(data.messages.length > 0) {
+    }).success(function(data) {
+        if (data.messages.length > 0) {
           var newRows = self.toMessages(data.messages);
           var messages = self.get("messages");
-          if(opts.before) {
+          if (opts.before) {
             messages.unshiftObjects(newRows);
           } else {
             messages.addObjects(newRows);
           }
         }
-        self.set("total",data.total);
+        self.set("total", data.total);
      });
   },
 
@@ -221,10 +252,11 @@ App.MessageCollection = Em.Object.extend({
 
 App.IndexRoute = Em.Route.extend({
   model: function(){
+    // TODO from preload json?
     return App.MessageCollection.create();
   },
 
-  setupController: function(controller, model){
+  setupController: function(controller, model) {
     this._super(controller, model);
     controller.setProperties({
       "showDebug": true,
@@ -239,6 +271,27 @@ App.IndexRoute = Em.Route.extend({
   }
 });
 
+App.ShowRoute = Em.Route.extend({
+  model: function(params) {
+    var self = this;
+    return new Promise(function(resolve, reject) {
+      App.preloadOrAjax("/show/" + params.id + ".json").success(function(json) {
+        resolve(App.Message.create(json));
+      }).error(reject);
+    });
+  },
+
+  actions: {
+    protect: function(message) {
+      this.get('model').protect();
+    },
+
+    unprotect: function(message) {
+      this.get('model').unprotect();
+    }
+  }
+});
+
 App.IndexController = Em.Controller.extend({
   actions: {
     expandMessage: function(message){
@@ -251,6 +304,16 @@ App.IndexController = Em.Controller.extend({
 
     loadMore: function(){
       return this.get('model').loadMore();
+    },
+
+    protect: function(message) {
+      this.get('currentMessage').protect().success(function() {
+        self.transitionToRoute("show", {id: self.get('key')});
+      });
+    },
+
+    unprotect: function(message) {
+      this.get('currentMessage').unprotect();
     }
   },
 
@@ -417,10 +480,11 @@ App.ApplicationView = Em.View.extend({
       $('.auto-update-time').each(function(){
         var newTime = moment(
             parseInt(this.getAttribute('data-timestamp'),10)
-          ).fromNow();
+          ).fromNow(),
+            elem = this;
 
-        if(newTime != this.innerText) {
-          this.innerText = newTime;
+        if(newTime != elem.innerText) {
+          elem.innerText = newTime;
         }
 
       });
@@ -439,26 +503,29 @@ Handlebars.registerHelper('timeAgo', function(prop, options){
   return new Handlebars.SafeString(formatted);
 });
 
-
 App.TabbedSectionComponent = Ember.Component.extend({
   tabs: Em.A(),
-  selectTab: function(view){
+  selectTab: function(view) {
+    if (view.get('isLink')) {
+      this.triggerAction(view.get('action'));
+      return;
+    }
+
     var selected = this.get("selected");
-    if(selected){
-      selected.set("active",false);
+    if (selected) {
+      selected.set("active", false);
     }
     this.set("selected", view);
     view.set("active", true);
   },
-  addTab: function(tab){
+  addTab: function(tab) {
     this.get("tabs").addObject(tab);
-    if(!this.get("selected")){
+    if (!this.get("selected") && !tab.get('isLink')) {
       this.selectTab(tab);
     }
   },
-  removeTab: function(tab){
-
-    if(this.get("selected") === tab){
+  removeTab: function(tab) {
+    if (this.get("selected") === tab) {
       this.set("selected", null);
     }
     this.get("tabs").removeObject(tab);
@@ -467,21 +534,26 @@ App.TabbedSectionComponent = Ember.Component.extend({
 
 App.TabContentsComponent = Ember.Component.extend({
   classNameBindings: ["active", ":content"],
+  isLink: false,
 
-  invokeParent: function(name){
+  invokeParent: function(name) {
     var current = this.get("parentView");
-    while(current && !current[name]) {
+    while (current && !current[name]) {
       current = current.get("parentView");
     }
-    if(current){
+    if (current) {
       current[name](this);
     }
   },
 
-  didInsertElement: function(){
+  didInsertElement: function() {
     this.invokeParent("addTab");
   },
-  willDestroyElement: function(){
+  willDestroyElement: function() {
     this.invokeParent("removeTab");
   }
 });
+
+App.TabLinkComponent = App.TabContentsComponent.extend({
+  isLink: true
+});

data/assets/javascript/components/message-info.handlebars

@@ -0,0 +1,19 @@
+<div class="message-info">
+  {{#tabbed-section}}
+    {{#tab-contents name="info" hint="show info"}}
+      <pre>{{currentMessage.message}}</pre>
+      {{#if currentMessage}}
+        <a {{bind-attr href=currentMessage.shareUrl}} class="share">Share</a>
+        {{#if currentMessage.saved}}
+            <a {{action unprotect currentMessage}} href class="save">Unprotect</a>
+        {{else}}
+            <a {{action protect currentMessage}} href class="save">Protect</a>
+        {{/if}}
+      {{/if}}
+    {{/tab-contents}}
+    {{#tab-contents name="backtrace" hint="show backtrace"}}<pre>{{currentMessage.backtrace}}</pre>{{/tab-contents}}
+    {{#if currentMessage.env}}
+      {{#tab-contents name="env" hint="show environment"}}<pre>{{currentMessage.envDebug}}</pre>{{/tab-contents}}
+    {{/if}}
+  {{/tabbed-section}}
+</div>

data/assets/javascript/components/tab-link.handlebars

@@ -0,0 +1 @@
+{{yield}}

data/assets/javascript/components/tabbed-section.handlebars

@@ -1,6 +1,6 @@
 {{yield}}
 <ul class="tabs">
   {{#each tab in tabs}}
-    <li><a {{bind-attr title="tab.hint"}} href="#" {{bind-attr class="tab.active"}} {{action selectTab tab}}>{{tab.name}}</a></li>
+    <li><a title="{{unbound tab.hint}}" href="#" {{bind-attr class="tab.active"}} {{action selectTab tab}}>{{unbound tab.name}}</a></li>
   {{/each}}
 </ul>

data/assets/javascript/templates/index.handlebars

@@ -19,15 +19,7 @@
 </div>
 <div id="divider"></div>
 <div id="bottom-panel">
-  <div class="message-info">
-    {{#tabbed-section}}
-      {{#tab-contents name="info" hint="show info"}}<pre>{{currentMessage.message}}</pre>{{/tab-contents}}
-      {{#tab-contents name="backtrace" hint="show backtrace"}}<pre>{{currentMessage.backtrace}}</pre>{{/tab-contents}}
-      {{#if currentMessage.env}}
-      {{#tab-contents name="env" hint="show environment"}}<pre>{{currentMessage.envDebug}}</pre>{{/tab-contents}}
-      {{/if}}
-    {{/tabbed-section}}
-  </div>
+  {{message-info currentMessage=currentMessage}}
 
   <div class="action-panel">
     <label class="debug">
@@ -54,4 +46,4 @@
       {{input type="textfield" placeholder="Search" value=search}}
     </label>
   </div>
-</div>
+</div>

data/assets/javascript/templates/show.handlebars

@@ -0,0 +1,5 @@
+<div id='top-panel'></div>
+<div id="divider"></div>
+<div id="bottom-panel">
+    {{message-info currentMessage=model}}
+</div>

data/assets/stylesheets/app.css

@@ -100,6 +100,17 @@ tr.show-more {
   font-size: 12px;
 }
 
+.share {
+    position: fixed;
+    bottom: 70px;
+    right: 10px;
+}
+.save {
+    position: fixed;
+    bottom: 70px;
+    right: 50px;
+}
+
 #divider {
   position: fixed;
   bottom: 310px;

data/lib/logster/message.rb

@@ -12,7 +12,7 @@ module Logster
       HTTP_X_REAL_IP
     }
 
-    attr_accessor :timestamp, :severity, :progname, :message, :key, :backtrace, :env
+    attr_accessor :timestamp, :severity, :progname, :message, :key, :backtrace, :count, :env
 
     def initialize(severity, progname, message, timestamp = nil, key = nil)
       @timestamp = timestamp || get_timestamp
@@ -21,6 +21,7 @@ module Logster
       @message = message
       @key = key || SecureRandom.hex
       @backtrace = nil
+      @count = 1
     end
 
     def to_h
@@ -31,12 +32,13 @@ module Logster
         timestamp: @timestamp,
         key: @key,
         backtrace: @backtrace,
+        count: @count,
         env: @env
       }
     end
 
-    def to_json(opts=nil)
-      JSON.fast_generate(to_h,opts)
+    def to_json(opts = nil)
+      JSON.fast_generate(to_h, opts)
     end
 
     def self.from_json(json)
@@ -48,6 +50,7 @@ module Logster
             parsed["key"] )
       msg.backtrace = parsed["backtrace"]
       msg.env = parsed["env"]
+      msg.count = parsed["count"]
       msg
     end
 

data/lib/logster/middleware/viewer.rb

@@ -6,6 +6,7 @@ module Logster
 
       PATH_INFO = "PATH_INFO".freeze
       SCRIPT_NAME = "SCRIPT_NAME".freeze
+      REQUEST_METHOD = "REQUEST_METHOD".freeze
 
       def initialize(app)
         @app = app
@@ -28,13 +29,42 @@ module Logster
 
         if resource = resolve_path(path)
 
-          return @app.call(env) if !Logster.config.authorize_callback.call(env)
+          # easier to debug, call per line
+          unless Logster.config.authorize_callback.call(env)
+            return @app.call(env)
+          end
 
           if resource =~ /\.js$|\.handlebars$|\.css$/
             env[PATH_INFO] = resource
             @fileserver.call(env)
           elsif resource.start_with?("/messages.json")
             serve_messages(Rack::Request.new(env))
+          elsif resource =~ /\/protect\/([0-9a-f]+)$/
+            key = $1
+            if env[REQUEST_METHOD] == "PUT"
+              Logster.store.protect(key)
+              return [200, {"Content-Type" => "text/plain; charset=utf-8"}, ["OK"]]
+            elsif env[REQUEST_METHOD] == "DELETE"
+              Logster.store.unprotect(key)
+              return [200, {"Content-Type" => "text/plain; charset=utf-8"}, ["OK"]]
+            else
+              return [405, {}, ["Only PUT and DELETE are supported for this URL"]]
+            end
+          elsif resource =~ /\/show\/([0-9a-f]+)(\.json)?$/
+            key = $1
+            json = $2 == ".json"
+
+            message = Logster.store.get(key)
+            unless message
+              return [404, {}, ["Message not found"]]
+            end
+
+            if json
+              [200, {"Content-Type" => "application/json; charset=utf-8"}, [message.to_json]]
+            else
+              preload = preload_json({"/show/#{key}.json" => message})
+              [200, {"Content-Type" => "text/html; charset=utf-8"}, [body(preload)]]
+            end
           elsif resource == "/"
             [200, {"Content-Type" => "text/html; charset=utf-8"}, [body(preload_json)]]
           else
@@ -86,7 +116,9 @@ module Logster
         end
       end
 
-      def preload_json
+      def preload_json(extra={})
+        values = {}
+        values.merge!(extra)
       end
 
       def css(name, attrs={})
@@ -132,16 +164,26 @@ JS
   #{handlebars("application")}
   #{handlebars("index")}
   #{handlebars("message")}
+  #{handlebars("show")}
+  #{component("message-info")}
   #{component("tabbed-section")}
   #{component("tab-contents")}
+  #{component("tab-link")}
   <script>
     window.Logger = {
-       rootPath: "#{@logs_path}"
+       rootPath: "#{@logs_path}",
+       preload: #{JSON.fast_generate(preload)}
     };
   </script>
 </head>
 <body>
   #{script("app.js")}
+  <script>
+    App.Router.reopen({
+      rootURL: Logger.rootPath,
+      location: 'history'
+    });
+  </script>
 </body>
 </html>
 HTML

data/lib/logster/redis_store.rb

@@ -21,7 +21,7 @@ module Logster
       return if level && severity < level
       return if @ignore && @ignore.any?{|pattern| message =~ pattern}
 
-      message = Message.new(severity, progname, message)
+      message = Logster::Message.new(severity, progname, message)
 
       if opts && backtrace = opts[:backtrace]
         message.backtrace = backtrace
@@ -33,14 +33,21 @@ module Logster
         message.populate_from_env(env)
       end
 
-      @redis.rpush(list_key, message.to_json)
+      # multi for integrity
+      @redis.multi do
+        @redis.hset(hash_key, message.key, message.to_json)
+        @redis.rpush(list_key, message.key)
+      end
 
       # TODO make it atomic
       if @redis.llen(list_key) > @max_backlog
-        @redis.lpop(list_key)
+        removed_key = @redis.lpop(list_key)
+        if removed_key && !@redis.sismember(protected_key, removed_key)
+          @redis.hdel(hash_key, removed_key)
+        end
       end
 
-      nil
+      message
     end
 
     def count
@@ -63,7 +70,9 @@ module Logster
       direction = after ? 1 : -1
 
       begin
-        rows = @redis.lrange(list_key, start, finish) || []
+        keys = @redis.lrange(list_key, start, finish) || []
+        break unless keys and keys.count > 0
+        rows = @redis.hmget(hash_key, keys)
 
         temp = []
 
@@ -91,19 +100,85 @@ module Logster
       results
     end
 
-    def clear(severities=nil)
+    def clear
       @redis.del(list_key)
+      keys = @redis.smembers(protected_key) || []
+      if keys.empty?
+        @redis.del(hash_key)
+      else
+        protected = @redis.mapped_hmget(hash_key, *keys)
+        @redis.del(hash_key)
+        @redis.mapped_hmset(hash_key, protected)
+      end
+    end
+
+    def clear_all
+      @redis.del(list_key)
+      @redis.del(protected_key)
+      @redis.del(hash_key)
+    end
+
+    def get(message_key)
+      json = @redis.hget(hash_key, message_key)
+      return nil unless json
+
+      Message.from_json(json)
+    end
+
+    def protect(message_key)
+      index = find_message(list_key, message_key)
+      # can't save something we already lost
+      return false unless index
+
+      @redis.sadd(protected_key, message_key)
+      true
+    end
+
+    def unprotect(message_key)
+      value = @redis.hget(hash_key, message_key)
+      # this is a failure of retention
+      raise "Message already deleted?" unless value
+
+      @redis.srem(protected_key, message_key)
+
+      index = find_message(list_key, message_key)
+      if index == nil
+        # Message fell off list - delete
+        @redis.hdel(hash_key, message_key)
+      end
+
+      true
     end
 
     protected
 
+    def find_message(list, message_key)
+      limit = 50
+      start = 0
+      finish = limit - 1
+
+      found = nil
+      while found == nil
+        items = @redis.lrange(list, start, finish)
+
+        break unless items && items.length > 0
+
+        found = items.index(message_key)
+        break if found
+
+        start += limit
+        finish += limit
+      end
+
+      found
+    end
+
     def find_location(before, after, limit)
       start = -limit
       finish = -1
 
       return [start,finish] unless before || after
 
-      # inefficient may change to sorted list, also timing issues
       found = nil
       find = before || after
 
@@ -112,9 +187,7 @@ module Logster
 
         break unless items && items.length > 0
 
-        found = items.index do |i|
-          Message.from_json(i).key == find
-        end
+        found = items.index(find)
 
         if items.length < limit
           found += limit - items.length if found
@@ -155,8 +228,15 @@ module Logster
 
 
     def list_key
-      @list_key ||= "__LOGSTER__LOG"
+      @list_key ||= "__LOGSTER__LATEST"
+    end
+
+    def hash_key
+      @hash_key ||= "__LOGSTER__MAP"
     end
 
+    def protected_key
+      @saved_key ||= "__LOGSTER__SAVED"
+    end
   end
 end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
 module Logster
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/test/logster/middleware/test_viewer.rb

@@ -51,6 +51,10 @@ class TestViewer < Minitest::Test
   end
 
   def test_assets
+    Logster.config.authorize_callback = lambda{ |env|
+      true
+    }
+
     env = {}
     env["PATH_INFO"] = "/logsie/javascript/external/jquery.min.js"
     env["REQUEST_METHOD"] = "GET"

data/test/logster/test_redis_store.rb

@@ -69,9 +69,20 @@ class TestRedisStore < Minitest::Test
 
   end
 
+  def test_get
+    a_message = @store.report(Logger::WARN, "test", "A")
+    b_message = @store.report(Logger::WARN, "test", "B")
+    @store.report(Logger::WARN, "test", "C")
+
+    assert_equal("A", @store.get(a_message.key).message)
+    assert_equal("B", @store.get(b_message.key).message)
+  end
+
   def test_backlog
     @store.max_backlog = 1
     @store.report(Logger::WARN, "test", "A")
+    @store.report(Logger::WARN, "test", "A")
+    @store.report(Logger::WARN, "test", "A")
     @store.report(Logger::WARN, "test", "B")
 
     latest = @store.latest
@@ -80,6 +91,65 @@ class TestRedisStore < Minitest::Test
     assert_equal("B", latest[0].message)
   end
 
+  def test_save_unsave
+    @store.max_backlog = 2
+    @store.report(Logger::WARN, "test", "A")
+    b_message = @store.report(Logger::WARN, "test", "B")
+    @store.protect b_message.key
+    c_message = @store.report(Logger::WARN, "test", "C")
+    @store.protect c_message.key
+    @store.report(Logger::WARN, "test", "D")
+
+    latest = @store.latest
+
+    assert_equal(2, latest.length)
+    assert_equal("C", latest[0].message)
+    assert_equal("D", latest[1].message)
+
+    # Saved messages still accessible by key
+    assert_equal("B", @store.get(b_message.key).message)
+
+    # Unsave does not delete message if still recent
+    @store.unprotect c_message.key
+    assert_equal("C", @store.get(c_message.key).message)
+
+    # Unsave *does* delete message if not recent
+    @store.unprotect b_message.key
+    assert_nil(@store.get(b_message.key))
+  end
+
+  def test_clear
+    10.times do
+      @store.report(Logger::WARN, "test", "A")
+    end
+    # Protected messages are not deleted
+    b_message = @store.report(Logger::WARN, "test", "B")
+    @store.protect b_message.key
+    c_message = @store.report(Logger::WARN, "test", "C")
+    10.times do
+      @store.report(Logger::WARN, "test", "D")
+    end
+
+    latest = @store.latest
+    assert_equal(22, latest.length)
+
+    @store.clear
+
+    latest = @store.latest
+    assert_equal(0, latest.length)
+    assert_equal("B", @store.get(b_message.key).message)
+    assert_nil(@store.get(c_message.key))
+  end
+
+  def test_hash_cleanup
+    @store.max_backlog = 2
+    a_message = @store.report(Logger::WARN, "test", "A")
+    @store.report(Logger::WARN, "test", "B")
+    @store.report(Logger::WARN, "test", "C")
+
+    assert_nil(@store.get(a_message.key))
+  end
+
   def test_filter_latest
     @store.report(Logger::INFO, "test", "A")
     @store.report(Logger::WARN, "test", "B")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logster
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - UI for viewing logs in Rack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-24 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,9 @@ files:
 - README.md
 - Rakefile
 - assets/javascript/app.js
+- assets/javascript/components/message-info.handlebars
 - assets/javascript/components/tab-contents.handlebars
+- assets/javascript/components/tab-link.handlebars
 - assets/javascript/components/tabbed-section.handlebars
 - assets/javascript/external/ember.js
 - assets/javascript/external/ember.min.js
@@ -119,6 +121,7 @@ files:
 - assets/javascript/templates/application.handlebars
 - assets/javascript/templates/index.handlebars
 - assets/javascript/templates/message.handlebars
+- assets/javascript/templates/show.handlebars
 - assets/stylesheets/app.css
 - bower.json
 - lib/logster.rb