logster 2.1.2 → 2.2.0

data/lib/logster/scheduler.rb

@@ -1,54 +1,54 @@
-module Logster
-  module Deferer
-    attr_reader :queue, :thread
-    def initialize
-      @queue = Queue.new
-      @mutex = Mutex.new
-      @thread = nil
-      @enabled = true
-    end
-
-    def disable
-      @enabled = false
-    end
-
-    def enable
-      @enabled = true
-    end
-
-    def schedule(&blk)
-      if @enabled
-        start_thread if !@thread&.alive?
-        @queue << blk
-      else
-        return if blk == :terminate
-        blk.call
-      end
-    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
+module Logster
+  module Deferer
+    attr_reader :queue, :thread
+    def initialize
+      @queue = Queue.new
+      @mutex = Mutex.new
+      @thread = nil
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def enable
+      @enabled = true
+    end
+
+    def schedule(&blk)
+      if @enabled
+        start_thread if !@thread&.alive?
+        @queue << blk
+      else
+        return if blk == :terminate
+        blk.call
+      end
+    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/suppression_pattern.rb

@@ -0,0 +1,17 @@
+module Logster
+  class SuppressionPattern < Pattern
+    def self.set_name
+      "__LOGSTER__suppression_patterns_set".freeze
+    end
+
+    def save
+      super
+      @store.clear_suppression_patterns_cache
+    end
+
+    def destroy(clear_cache: true) # arg used in tests
+      super()
+      @store.clear_suppression_patterns_cache if clear_cache
+    end
+  end
+end

data/lib/logster/version.rb

@@ -1,3 +1,3 @@
-module Logster
-  VERSION = "2.1.2"
-end
+module Logster
+  VERSION = "2.2.0"
+end

data/lib/logster/web.rb

@@ -1,14 +1,14 @@
-require 'logster/middleware/viewer'
-
-class Logster::Web
-  class FourOhFour
-    def call(env)
-      [404, {}, ["not found"]]
-    end
-  end
-
-  def self.call(env)
-    @middleware ||= Logster::Middleware::Viewer.new(FourOhFour.new)
-    @middleware.call(env)
-  end
-end
+require 'logster/middleware/viewer'
+
+class Logster::Web
+  class FourOhFour
+    def call(env)
+      [404, {}, ["not found"]]
+    end
+  end
+
+  def self.call(env)
+    @middleware ||= Logster::Middleware::Viewer.new(FourOhFour.new)
+    @middleware.call(env)
+  end
+end

data/logster.gemspec

@@ -1,35 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'logster/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "logster"
-  spec.version       = Logster::VERSION
-  spec.authors       = ["UI for viewing logs in Rack"]
-  spec.email         = ["sam.saffron@gmail.com"]
-  spec.summary       = %q{UI for viewing logs in Rack}
-  spec.description   = %q{UI for viewing logs in Rack}
-  spec.homepage      = "https://github.com/discourse/logster"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.start_with?("bower_components") || f.start_with?("website") || f.start_with?("bin")
-  end
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  # NOTE dependency on rack is not explicit, this enables us to use
-  # logster outside of rack (for reporting)
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rack"
-  spec.add_development_dependency "redis"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-minitest"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "rubocop", "~> 0.61.1"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logster/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logster"
+  spec.version       = Logster::VERSION
+  spec.authors       = ["UI for viewing logs in Rack"]
+  spec.email         = ["sam.saffron@gmail.com"]
+  spec.summary       = %q{UI for viewing logs in Rack}
+  spec.description   = %q{UI for viewing logs in Rack}
+  spec.homepage      = "https://github.com/discourse/logster"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.start_with?("bower_components") || f.start_with?("website") || f.start_with?("bin")
+  end
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # NOTE dependency on rack is not explicit, this enables us to use
+  # logster outside of rack (for reporting)
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "redis"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "timecop"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rubocop", "~> 0.61.1"
+end

data/test/examples/test_sidekiq_reporter_example.rb

@@ -1,46 +1,46 @@
-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::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
-    handler = SidekiqLogsterReporter.new
-    error = nil
-    begin
-      raise TypeError.new
-    rescue => e
-      error = e
-    end
-    trace = error.backtrace
-
-    handler.call(error, code: "Test", something_important: "Foo", params: { article_id: 20 })
-
-    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])
-
-    # The env is in the report
-    assert_equal("Test", report.env['code'])
-    assert_equal(20, report.env['params']['article_id'])
-  end
-end
+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::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
+    handler = SidekiqLogsterReporter.new
+    error = nil
+    begin
+      raise TypeError.new
+    rescue => e
+      error = e
+    end
+    trace = error.backtrace
+
+    handler.call(error, code: "Test", something_important: "Foo", params: { article_id: 20 })
+
+    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])
+
+    # The env is in the report
+    assert_equal("Test", report.env['code'])
+    assert_equal(20, report.env['params']['article_id'])
+  end
+end

data/test/fake_data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-gem 'redis'
-gem 'logster', path: '../../'
+source 'https://rubygems.org'
+
+gem 'redis'
+gem 'logster', path: '../../'

data/test/fake_data/generate.rb

@@ -1,10 +1,10 @@
-require 'redis'
-require 'logster'
-
-Logster.config.allow_grouping = true
-Logster.config.application_version = "ABC123"
-Logster.store = Logster::RedisStore.new
-
-10.times do
-  Logster.store.report(Logger::WARN, "application", "test warning", backtrace: "method1\nmethod2", env: { something: ["hello world", "hello places"], another: { thing: "something else" } })
-end
+require 'redis'
+require 'logster'
+
+Logster.config.allow_grouping = true
+Logster.config.application_version = "ABC123"
+Logster.store = Logster::RedisStore.new
+
+10.times do
+  Logster.store.report(Logger::WARN, "application", "test warning", backtrace: "method1\nmethod2", env: { something: ["hello world", "hello places"], another: { thing: "something else" } })
+end

data/test/logster/middleware/test_reporter.rb

@@ -1,19 +1,19 @@
-require_relative '../../test_helper'
-require 'rack'
-require 'logster/redis_store'
-require 'logster/middleware/reporter'
-
-class TestReporter < Minitest::Test
-
-  def test_logs_errors
-    Logster.store = Logster::TestStore.new
-
-    reporter = Logster::Middleware::Reporter.new(nil)
-    env = Rack::MockRequest.env_for("/logs/report_js_error?message=hello")
-    status, = reporter.call(env)
-
-    assert_equal(200, status)
-    assert_equal(1, Logster.store.count)
-  end
-
-end
+require_relative '../../test_helper'
+require 'rack'
+require 'logster/redis_store'
+require 'logster/middleware/reporter'
+
+class TestReporter < Minitest::Test
+
+  def test_logs_errors
+    Logster.store = Logster::TestStore.new
+
+    reporter = Logster::Middleware::Reporter.new(nil)
+    env = Rack::MockRequest.env_for("/logs/report_js_error?message=hello")
+    status, = reporter.call(env)
+
+    assert_equal(200, status)
+    assert_equal(1, Logster.store.count)
+  end
+
+end

data/test/logster/middleware/test_viewer.rb

@@ -1,96 +1,267 @@
-require_relative '../../test_helper'
-require 'rack'
-require 'logster/redis_store'
-require 'logster/middleware/viewer'
-
-class TestViewer < Minitest::Test
-
-  class BrokenApp
-    def call(env)
-      [500, {}, ["broken"]]
-    end
-  end
-
-  def setup
-    Logster.config.subdirectory = "/logsie"
-    Logster.store = Logster::RedisStore.new
-  end
-
-  def teardown
-    Logster.config.subdirectory = nil
-    Logster.store = nil
-  end
-
-  def viewer
-    @viewer ||= Logster::Middleware::Viewer.new(nil)
-  end
-
-  def request
-    @request ||= Rack::MockRequest.new(Rack::Lint.new(viewer))
-  end
-
-  def test_path_resolution
-    assert_nil(viewer.send(:resolve_path, "/logs"))
-    assert_nil(viewer.send(:resolve_path, "/admin/logsie"))
-    assert_nil(viewer.send(:resolve_path, "/admin/logsie/bla"))
-    assert_equal("/", viewer.send(:resolve_path, "/logsie"))
-    assert_equal("/", viewer.send(:resolve_path, "/logsie/"))
-    assert_equal("/hello/world", viewer.send(:resolve_path, "/logsie/hello/world"))
-  end
-
-  def test_search_raceguard_s
-    response = request.get('/logsie/messages.json?search=searchkey')
-    result = JSON.parse(response.body)
-    assert_equal('searchkey', result['search'])
-  end
-
-  def test_search_raceguard_sr
-    response = request.get('/logsie/messages.json?search=/regex/&regex_search=true')
-    result = JSON.parse(response.body)
-    assert_equal('/regex/', result['search'])
-  end
-
-  def test_search_raceguard_f
-    response = request.get("/logsie/messages.json?filter=0_1_2_3_4")
-    result = JSON.parse(response.body)
-    assert_equal([0, 1, 2, 3, 4], result['filter'])
-  end
-
-  def test_regex_parse
-    assert_equal(/hello/i, viewer.send(:parse_regex, '/hello/i'))
-  end
-
-  def test_linking_to_a_valid_js_files
-    %w(
-      /logsie/javascript/client-app.js
-      /logsie/javascript/vendor.js
-    ).each do |path|
-      response = request.get(path)
-      assert_equal(200, response.status)
-      assert_equal('application/javascript', response.headers['Content-Type'])
-    end
-  end
-
-  def test_linking_to_a_valid_css_files
-    %w(
-      /logsie/stylesheets/client-app.css
-      /logsie/stylesheets/vendor.css
-    ).each do |path|
-      response = request.get(path)
-      assert_equal(200, response.status)
-      assert_equal('text/css', response.headers['Content-Type'])
-    end
-  end
-
-  def test_linking_to_an_invalid_ember_component_or_template
-    %w(
-      /logsie/javascript/templates/application.hbs
-      /logsie/javascript/templates/does_not_exist.js
-      /logsie/javascript/components/does_not_exist.js
-      /logsie/javascript/templates/../../app.js
-    ).each do |path|
-      response = request.get(path)
-      assert_equal(404, response.status, "#{path} should have 404'ed")
-    end
-  end
-end
+require_relative '../../test_helper'
+require 'rack'
+require 'logster/redis_store'
+require 'logster/middleware/viewer'
+
+class TestViewer < Minitest::Test
+
+  class BrokenApp
+    def call(env)
+      [500, {}, ["broken"]]
+    end
+  end
+
+  def setup
+    Logster.config.subdirectory = "/logsie"
+    Logster.store = Logster::RedisStore.new
+    Logster.store.clear_all
+  end
+
+  def teardown
+    Logster.config.subdirectory = nil
+    Logster.store.clear_all
+    Logster.store = nil
+  end
+
+  def viewer
+    @viewer ||= Logster::Middleware::Viewer.new(nil)
+  end
+
+  def request
+    @request ||= Rack::MockRequest.new(Rack::Lint.new(viewer))
+  end
+
+  def test_path_resolution
+    assert_nil(viewer.send(:resolve_path, "/logs"))
+    assert_nil(viewer.send(:resolve_path, "/admin/logsie"))
+    assert_nil(viewer.send(:resolve_path, "/admin/logsie/bla"))
+    assert_equal("/", viewer.send(:resolve_path, "/logsie"))
+    assert_equal("/", viewer.send(:resolve_path, "/logsie/"))
+    assert_equal("/hello/world", viewer.send(:resolve_path, "/logsie/hello/world"))
+  end
+
+  def test_search_raceguard_s
+    response = request.get('/logsie/messages.json?search=searchkey')
+    result = JSON.parse(response.body)
+    assert_equal('searchkey', result['search'])
+  end
+
+  def test_search_raceguard_sr
+    response = request.get('/logsie/messages.json?search=/regex/&regex_search=true')
+    result = JSON.parse(response.body)
+    assert_equal('/regex/', result['search'])
+  end
+
+  def test_search_raceguard_f
+    response = request.get("/logsie/messages.json?filter=0_1_2_3_4")
+    result = JSON.parse(response.body)
+    assert_equal([0, 1, 2, 3, 4], result['filter'])
+  end
+
+  def test_regex_parse
+    assert_equal(/hello/i, viewer.send(:parse_regex, '/hello/i'))
+  end
+
+  def test_settings_page_responds_with_json
+    Logster.store.ignore = [/somepattern/, /anotherpattern/]
+    record = Logster::SuppressionPattern.new("custompattern")
+    record.save
+
+    response = request.get("/logsie/settings.json")
+    assert_equal(200, response.status)
+    assert_includes(response.content_type, "application/json")
+    json = JSON.parse(response.body)
+    custom_patterns = json["custom_patterns"]
+    coded_patterns = json["coded_patterns"]
+    assert_includes(custom_patterns, "/custompattern/")
+    assert_includes(coded_patterns, "/somepattern/")
+    assert_includes(coded_patterns, "/anotherpattern/")
+
+    Logster.store.ignore = nil
+    record.destroy
+
+    response = request.get("/logsie/settings.json")
+    assert_equal(200, response.status)
+    json = JSON.parse(response.body)
+    assert_equal([], json["custom_patterns"])
+    assert_equal([], json["coded_patterns"])
+  end
+
+  def test_settings_page_responds_with_html
+    response = request.get("/logsie/settings")
+    assert_equal(200, response.status)
+    assert_includes(response.content_type, "text/html")
+  end
+
+  def test_patterns_endpoint_doesnt_accept_GETs
+    Logster.config.enable_custom_patterns_via_ui = true
+
+    response = request.get("/logsie/patterns/suppression.json",
+      params: { pattern: "patternfromuser" }
+    )
+    assert_equal(405, response.status)
+    assert_equal(0, Logster::SuppressionPattern.find_all.size)
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_patterns_endpoint_doesnt_work_when_its_disabled_from_config
+    Logster.config.enable_custom_patterns_via_ui = false
+
+    response = request.post("/logsie/patterns/suppression.json",
+      params: { pattern: "patternfromuser" }
+    )
+    assert_equal(403, response.status)
+    assert_equal(0, Logster::SuppressionPattern.find_all.size)
+  end
+
+  def test_patterns_endpoint_doesnt_work_with_undefined_set
+    Logster.config.enable_custom_patterns_via_ui = true
+
+    response = request.post("/logsie/patterns/weirdset.json",
+      params: { pattern: "disallowedpattern" }
+    )
+    assert_equal(404, response.status)
+    Logster::PATTERNS.each do |klass|
+      assert_equal(0, klass.find_all.size)
+    end
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_creating_patterns_works
+    Logster.config.enable_custom_patterns_via_ui = true
+
+    response = request.post("/logsie/patterns/suppression.json",
+      params: { pattern: "newpattern" }
+    )
+    assert_equal(200, response.status)
+    assert_equal(/newpattern/, Logster::SuppressionPattern.find_all.first)
+
+    json = JSON.parse(response.body)
+    assert_equal("/newpattern/", json["pattern"])
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_modifying_patterns_returns_404_for_non_existing_patterns
+    Logster.config.enable_custom_patterns_via_ui = true
+
+    response = request.put("/logsie/patterns/suppression.json",
+      params: { new_pattern: "doesntexists", pattern: "doesntexisttoo" }
+    )
+
+    assert_equal(404, response.status)
+    assert_equal(0, Logster::SuppressionPattern.find_all.size)
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_modifying_doesnt_accept_empty_regexp
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::SuppressionPattern.new("goodcitizen").save
+
+    response = request.put("/logsie/patterns/suppression.json",
+      params: { new_pattern: "", pattern: "goodcitizen" }
+    )
+
+    assert_equal(400, response.status)
+    patterns = Logster::SuppressionPattern.find_all
+    assert_equal(1, patterns.size)
+    assert_equal(/goodcitizen/, patterns.first)
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_modifying_patterns_works
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::SuppressionPattern.new("oldpattern").save
+    Logster::SuppressionPattern.new("notgoinganywhere").save
+
+    response = request.put("/logsie/patterns/suppression.json",
+      params: { pattern: "oldpattern", new_pattern: "brandnewpattern" }
+    )
+
+    assert_equal(200, response.status)
+    patterns = Logster::SuppressionPattern.find_all
+    assert_equal(2, patterns.size)
+    assert_includes(patterns, /brandnewpattern/)
+    assert_includes(patterns, /notgoinganywhere/)
+
+    json = JSON.parse(response.body)
+    assert_equal("/brandnewpattern/", json["pattern"])
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_removing_patterns_works
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::SuppressionPattern.new("tobedeleted").save
+    Logster::SuppressionPattern.new("notgoinganywhere").save
+
+    response = request.delete("/logsie/patterns/suppression.json",
+      params: { pattern: "tobedeleted" }
+    )
+    assert_equal(200, response.status)
+
+    response = request.delete("/logsie/patterns/suppression.json",
+      params: { pattern: "doesntexistanymore" }
+    )
+    assert_equal(404, response.status)
+
+    patterns = Logster::SuppressionPattern.find_all
+    assert_equal(1, patterns.size)
+    assert_includes(patterns, /notgoinganywhere/)
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_clear_all_button_shouldnt_clear_custom_patterns
+    Logster::SuppressionPattern.new("testpattern").save
+
+    Logster.store.report(Logger::INFO, "test", "mysmalltest")
+    Logster.store.report(Logger::INFO, "test", "another test")
+
+    response = request.post("/logsie/clear")
+
+    assert_equal(200, response.status)
+    assert_equal(0, Logster.store.latest.size)
+    records = Logster::SuppressionPattern.find_all
+    assert_equal(1, records.size)
+    assert_equal(/testpattern/, records.first)
+  end
+
+  def test_linking_to_a_valid_js_files
+    %w(
+      /logsie/javascript/client-app.js
+      /logsie/javascript/vendor.js
+    ).each do |path|
+      response = request.get(path)
+      assert_equal(200, response.status)
+      assert_equal('application/javascript', response.headers['Content-Type'])
+    end
+  end
+
+  def test_linking_to_a_valid_css_files
+    %w(
+      /logsie/stylesheets/client-app.css
+      /logsie/stylesheets/vendor.css
+    ).each do |path|
+      response = request.get(path)
+      assert_equal(200, response.status)
+      assert_equal('text/css', response.headers['Content-Type'])
+    end
+  end
+
+  def test_linking_to_an_invalid_ember_component_or_template
+    %w(
+      /logsie/javascript/templates/application.hbs
+      /logsie/javascript/templates/does_not_exist.js
+      /logsie/javascript/components/does_not_exist.js
+      /logsie/javascript/templates/../../app.js
+    ).each do |path|
+      response = request.get(path)
+      assert_equal(404, response.status, "#{path} should have 404'ed")
+    end
+  end
+end