logster 2.12.1 → 2.13.0

data/lib/logster/pattern.rb

@@ -4,7 +4,8 @@ module Logster
   class Pattern
     @child_classes = []
 
-    class PatternError < StandardError; end
+    class PatternError < StandardError
+    end
 
     def self.inherited(subclass)
       @child_classes << subclass
@@ -23,7 +24,7 @@ module Logster
       return string if Regexp === string
       return unless String === string
       if string[0] == "/"
-        return unless string =~ /\/(.+)\/(.*)/
+        return unless string =~ %r{/(.+)/(.*)}
         string = $1
         flag = Regexp::IGNORECASE if $2 && $2.include?("i")
       end
@@ -34,11 +35,7 @@ module Logster
 
     def self.find_all(raw: false, store: Logster.store)
       patterns = store.get_patterns(set_name) || []
-      unless raw
-        patterns.map! do |p|
-          parse_pattern(p)
-        end
-      end
+      patterns.map! { |p| parse_pattern(p) } unless raw
       patterns.compact!
       patterns
     end

data/lib/logster/rails/railtie.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Logster::Rails
-
   # this magically registers logster.js in the asset pipeline
   class Engine < Rails::Engine
   end
@@ -9,14 +8,14 @@ module Logster::Rails
   def self.set_logger(config)
     return unless Logster.config.environments.include?(Rails.env.to_sym)
 
-    require 'logster/middleware/debug_exceptions'
-    require 'logster/middleware/reporter'
+    require "logster/middleware/debug_exceptions"
+    require "logster/middleware/reporter"
 
     store = Logster.store ||= Logster::RedisStore.new
     store.level = Logger::Severity::WARN if Rails.env.production?
 
     if Rails.env.development?
-      require 'logster/defer_logger'
+      require "logster/defer_logger"
       logger = Logster::DeferLogger.new(store)
     else
       logger = Logster::Logger.new(store)
@@ -37,9 +36,12 @@ module Logster::Rails
       end
 
       if Rails::VERSION::MAJOR == 3
-        app.middleware.insert_before ActionDispatch::DebugExceptions, Logster::Middleware::DebugExceptions
+        app.middleware.insert_before ActionDispatch::DebugExceptions,
+                                     Logster::Middleware::DebugExceptions
       else
-        app.middleware.insert_before ActionDispatch::DebugExceptions, Logster::Middleware::DebugExceptions, Rails.application
+        app.middleware.insert_before ActionDispatch::DebugExceptions,
+                                     Logster::Middleware::DebugExceptions,
+                                     Rails.application
       end
 
       app.middleware.delete ActionDispatch::DebugExceptions
@@ -47,18 +49,13 @@ module Logster::Rails
 
       unless Logster.config.application_version
         git_version = `cd #{Rails.root} && git rev-parse --short HEAD 2> /dev/null`
-        if git_version.present?
-          Logster.config.application_version = git_version.strip
-        end
+        Logster.config.application_version = git_version.strip if git_version.present?
       end
     end
   end
 
   class Railtie < ::Rails::Railtie
-
-    config.before_initialize do
-      Logster::Rails.set_logger(config)
-    end
+    config.before_initialize { Logster::Rails.set_logger(config) }
 
     initializer "logster.configure_rails_initialization" do |app|
       Logster::Rails.initialize!(app)

data/lib/logster/redis_rate_limiter.rb

@@ -81,12 +81,7 @@ module Logster
     private
 
     def self.key_prefix(redis_prefix)
-      if redis_prefix
-        "#{redis_prefix.call}:#{PREFIX}"
-      else
-        PREFIX
-      end
-
+      redis_prefix ? "#{redis_prefix.call}:#{PREFIX}" : PREFIX
     end
 
     def key_prefix
@@ -96,7 +91,7 @@ module Logster
     def mget_keys(bucket_num)
       keys = @mget_keys.dup
       keys.delete_at(bucket_num)
-      keys.map { |key| "'#{key}'" }.join(', ')
+      keys.map { |key| "'#{key}'" }.join(", ")
     end
 
     def bucket_number(time)

data/lib/logster/redis_store.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'set'
-require 'logster/base_store'
-require 'logster/redis_rate_limiter'
+require "json"
+require "set"
+require "logster/base_store"
+require "logster/redis_rate_limiter"
 
 module Logster
   class RedisStore < BaseStore
@@ -22,9 +22,7 @@ module Logster
 
     def save(message)
       if keys = message.solved_keys
-        keys.each do |solved|
-          return false if @redis.hget(solved_key, solved)
-        end
+        keys.each { |solved| return false if @redis.hget(solved_key, solved) }
       end
 
       @redis.multi do |pipeline|
@@ -97,9 +95,7 @@ module Logster
     def solve(message_key)
       if (message = get(message_key)) && (keys = message.solved_keys)
         # add a time so we can expire it
-        keys.each do |s_key|
-          @redis.hset(solved_key, s_key, Time.now.to_f.to_i)
-        end
+        keys.each { |s_key| @redis.hset(solved_key, s_key, Time.now.to_f.to_i) }
       end
       clear_solved
     end
@@ -179,19 +175,22 @@ module Logster
         @redis.mapped_hmset(hash_key, protected_messages)
         (all_keys - protected_keys).each { |k| delete_env(k) }
 
-        sorted = protected_messages
-          .values
-          .map { |string|
-            Message.from_json(string) rescue nil
-          }
-          .compact
-          .sort
-          .map(&:key)
+        sorted =
+          protected_messages
+            .values
+            .map do |string|
+              begin
+                Message.from_json(string)
+              rescue StandardError
+                nil
+              end
+            end
+            .compact
+            .sort
+            .map(&:key)
 
         @redis.pipelined do |pipeline|
-          sorted.each do |message_key|
-            pipeline.rpush(list_key, message_key)
-          end
+          sorted.each { |message_key| pipeline.rpush(list_key, message_key) }
         end
 
         find_pattern_groups(load_messages: true).each do |group|
@@ -212,9 +211,7 @@ module Logster
       @redis.del(solved_key)
       @redis.del(ignored_logs_count_key)
       @redis.del(pattern_groups_key)
-      Logster::Pattern.child_classes.each do |klass|
-        @redis.del(klass.set_name)
-      end
+      Logster::Pattern.child_classes.each { |klass| @redis.del(klass.set_name) }
       @redis.keys.each do |key|
         @redis.del(key) if key.include?(Logster::RedisRateLimiter::PREFIX)
         @redis.del(key) if key.start_with?(ip_rate_limit_key(""))
@@ -226,9 +223,7 @@ module Logster
       return nil unless json
 
       message = Message.from_json(json)
-      if load_env
-        message.env = get_env(message_key) || {}
-      end
+      message.env = get_env(message_key) || {} if load_env
       message
     end
 
@@ -249,26 +244,30 @@ module Logster
       envs = nil
       if with_env
         envs = {}
-        @redis.eval(
-          BULK_ENV_GET_LUA,
-          keys: message_keys.map { |k| env_prefix(k, with_namespace: true) }
-        ).to_h.each do |k, v|
-          next if v.size == 0
-          parsed = v.size == 1 ? JSON.parse(v[0]) : v.map { |e| JSON.parse(e) }
-          envs[env_unprefix(k, with_namespace: true)] = parsed
-        end
-      end
-      messages = @redis.hmget(hash_key, message_keys).map! do |json|
-        next if !json || json.size == 0
-        message = Message.from_json(json)
-        if with_env && envs
-          env = envs[message.key]
-          if !message.env || message.env.size == 0
-            message.env = env || {}
+        @redis
+          .eval(
+            BULK_ENV_GET_LUA,
+            keys: message_keys.map { |k| env_prefix(k, with_namespace: true) },
+          )
+          .to_h
+          .each do |k, v|
+            next if v.size == 0
+            parsed = v.size == 1 ? JSON.parse(v[0]) : v.map { |e| JSON.parse(e) }
+            envs[env_unprefix(k, with_namespace: true)] = parsed
           end
-        end
-        message
       end
+      messages =
+        @redis
+          .hmget(hash_key, message_keys)
+          .map! do |json|
+            next if !json || json.size == 0
+            message = Message.from_json(json)
+            if with_env && envs
+              env = envs[message.key]
+              message.env = env || {} if !message.env || message.env.size == 0
+            end
+            message
+          end
       messages.compact!
       messages
     end
@@ -308,7 +307,7 @@ module Logster
     end
 
     def redis_prefix
-      return 'default'.freeze if !@redis_prefix
+      return "default".freeze if !@redis_prefix
       @prefix_is_proc ||= @redis_prefix.respond_to?(:call)
       @prefix_is_proc ? @redis_prefix.call : @redis_prefix
     end
@@ -345,28 +344,26 @@ module Logster
       key = ip_rate_limit_key(ip_address)
 
       limited = @redis.call([:exists, key])
-      if Integer === limited
-        limited = limited != 0
-      end
+      limited = limited != 0 if Integer === limited
 
-      if perform && !limited
-        @redis.setex key, limit, ""
-      end
+      @redis.setex key, limit, "" if perform && !limited
 
       limited
     end
 
     def find_pattern_groups(load_messages: false)
-      patterns = @patterns_cache.fetch(Logster::GroupingPattern::CACHE_KEY) do
-        Logster::GroupingPattern.find_all(store: self)
-      end
-      patterns = patterns.select do |pattern|
-        if block_given?
-          yield(pattern)
-        else
-          true
+      patterns =
+        @patterns_cache.fetch(Logster::GroupingPattern::CACHE_KEY) do
+          Logster::GroupingPattern.find_all(store: self)
+        end
+      patterns =
+        patterns.select do |pattern|
+          if block_given?
+            yield(pattern)
+          else
+            true
+          end
         end
-      end
       return [] if patterns.size == 0
       mapped = patterns.map(&:inspect)
       jsons = @redis.hmget(pattern_groups_key, mapped)
@@ -374,9 +371,7 @@ module Logster
         if json && json.size > 0
           group = Logster::Group.from_json(json)
           group.pattern = patterns[mapped.index(group.key)]
-          if load_messages
-            group.messages = bulk_get(group.messages_keys, with_env: false)
-          end
+          group.messages = bulk_get(group.messages_keys, with_env: false) if load_messages
           group
         end
       end
@@ -405,9 +400,7 @@ module Logster
         message_keys = @redis.lrange(list_key, 0, -1) || []
 
         bulk_get(message_keys).each do |message|
-          unless (ignores & (message.solved_keys || [])).empty?
-            delete message
-          end
+          delete message unless (ignores & (message.solved_keys || [])).empty?
         end
       end
     end
@@ -424,9 +417,7 @@ module Logster
             removed_keys << removed_key
           end
         end
-        removed_keys.reverse.each do |key|
-          @redis.lpush(list_key, key)
-        end
+        removed_keys.reverse.each { |key| @redis.lpush(list_key, key) }
       end
     end
 
@@ -465,7 +456,7 @@ module Logster
       start = -limit
       finish = -1
 
-      return [start, finish] unless before || after
+      return start, finish unless before || after
 
       found = nil
       find = before || after
@@ -527,11 +518,7 @@ module Logster
       if Array === message.env
         array_env_matches?(message, search, exclude)
       else
-        if exclude
-          !env_matches?(message.env, search)
-        else
-          env_matches?(message.env, search)
-        end
+        exclude ? !env_matches?(message.env, search) : env_matches?(message.env, search)
       end
     end
 
@@ -547,7 +534,7 @@ module Logster
             value.to_s =~ search
           when String
             value.to_s =~ Regexp.new(search, Regexp::IGNORECASE)
-            else
+          else
             false
           end
         end
@@ -555,13 +542,10 @@ module Logster
     end
 
     def array_env_matches?(message, search, exclude)
-      matches = message.env.select do |env|
-        if exclude
-          !env_matches?(env, search)
-        else
-          env_matches?(env, search)
+      matches =
+        message.env.select do |env|
+          exclude ? !env_matches?(env, search) : env_matches?(env, search)
         end
-      end
       return false if matches.empty?
       message.env = matches
       message.count = matches.size
@@ -619,22 +603,22 @@ module Logster
       # when you hit load more and the first row is a group.
       # The server uses this info (row_id) to know where it needs to
       # start scanning messages when looking up older messages.
-      Logster::Group::GroupWeb.new(
-        group.key,
-        group.count,
-        group.timestamp,
-        group.messages,
-        row_id
-      )
+      Logster::Group::GroupWeb.new(group.key, group.count, group.timestamp, group.messages, row_id)
     end
 
     def register_rate_limit(severities, limit, duration, callback)
       severities = [severities] unless severities.is_a?(Array)
       redis = (@redis_raw_connection && @redis_prefix) ? @redis_raw_connection : @redis
 
-      rate_limiter = RedisRateLimiter.new(
-        redis, severities, limit, duration, Proc.new { redis_prefix }, callback
-      )
+      rate_limiter =
+        RedisRateLimiter.new(
+          redis,
+          severities,
+          limit,
+          duration,
+          Proc.new { redis_prefix },
+          callback,
+        )
 
       rate_limits[self.redis_prefix] ||= []
       rate_limits[self.redis_prefix] << rate_limiter
@@ -654,17 +638,13 @@ module Logster
 
     def env_unprefix(key, with_namespace: false)
       prefix = ENV_PREFIX
-      if with_namespace && namespace
-        prefix = "#{namespace}:#{prefix}"
-      end
+      prefix = "#{namespace}:#{prefix}" if with_namespace && namespace
       key.sub(prefix, "")
     end
 
     def env_prefix(key, with_namespace: false)
       prefix = ENV_PREFIX
-      if with_namespace && namespace
-        prefix = "#{namespace}:#{prefix}"
-      end
+      prefix = "#{namespace}:#{prefix}" if with_namespace && namespace
       prefix + key
     end
 

data/lib/logster/scheduler.rb

@@ -31,11 +31,7 @@ module Logster
     private
 
     def start_thread
-      @mutex.synchronize do
-        if !@thread&.alive?
-          @thread = Thread.new { do_work }
-        end
-      end
+      @mutex.synchronize { @thread = Thread.new { do_work } if !@thread&.alive? }
     end
 
     def do_work

data/lib/logster/suppression_pattern.rb

@@ -24,12 +24,14 @@ module Logster
     def retro_delete_messages
       keys = []
       grouping_keys = []
-      @store.get_all_messages(with_env: false).each do |message|
-        if message =~ self.pattern
-          keys << message.key
-          grouping_keys << message.grouping_key
+      @store
+        .get_all_messages(with_env: false)
+        .each do |message|
+          if message =~ self.pattern
+            keys << message.key
+            grouping_keys << message.grouping_key
+          end
         end
-      end
       @store.bulk_delete(keys, grouping_keys) if keys.size > 0 && grouping_keys.size > 0
     end
   end

data/lib/logster/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logster
-  VERSION = "2.12.1"
+  VERSION = "2.13.0"
 end

data/lib/logster/web.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'logster/middleware/viewer'
+require "logster/middleware/viewer"
 
 class Logster::Web
   class FourOhFour

data/lib/logster.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'logster/version'
-require 'logster/logger'
-require 'logster/message'
-require 'logster/configuration'
-require 'logster/web'
-require 'logster/ignore_pattern'
-require 'logster/pattern'
-require 'logster/suppression_pattern'
-require 'logster/grouping_pattern'
-require 'logster/group'
-require 'logster/cache'
-
-if defined? Redis
-  require 'logster/redis_store'
+require "logster/version"
+require "logster/logger"
+require "logster/message"
+require "logster/configuration"
+require "logster/web"
+require "logster/ignore_pattern"
+require "logster/pattern"
+require "logster/suppression_pattern"
+require "logster/grouping_pattern"
+require "logster/group"
+require "logster/cache"
+
+if defined?(Redis)
+  require "logster/redis_store"
 else
   STDERR.puts "ERROR: Redis is not loaded, ensure redis gem is required before logster"
   exit
@@ -57,6 +57,4 @@ end
 # check logster/configuration.rb for config options
 # Logster.config.environments << :staging
 
-if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3
-  require 'logster/rails/railtie'
-end
+require "logster/rails/railtie" if defined?(::Rails) && ::Rails::VERSION::MAJOR.to_i >= 3

data/logster.gemspec

@@ -1,30 +1,29 @@
 # coding: utf-8
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'logster/version'
+require "logster/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "logster"
-  spec.version       = Logster::VERSION
-  spec.authors       = ["Sam Saffron"]
-  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.name = "logster"
+  spec.version = Logster::VERSION
+  spec.authors = ["Sam Saffron"]
+  spec.email = ["sam.saffron@gmail.com"]
+  spec.summary = "UI for viewing logs in Rack"
+  spec.description = "UI for viewing logs in Rack"
+  spec.homepage = "https://github.com/discourse/logster"
+  spec.license = "MIT"
 
   spec.required_ruby_version = ">= 2.5.0"
 
-  files =
-    `git ls-files -z`.split("\x0").reject { |f| f.start_with?(/website|bin/) }
+  files = `git ls-files -z`.split("\x0").reject { |f| f.start_with?(/website|bin/) }
   files += Dir.glob("assets/javascript/*")
   files += Dir.glob("assets/stylesheets/*")
   spec.files = files
 
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  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
@@ -39,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "byebug", "~> 11.1.0"
   spec.add_development_dependency "rubocop-discourse", "~> 2.4.1"
+  spec.add_development_dependency "syntax_tree"
 end

data/test/examples/test_sidekiq_reporter_example.rb

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../test_helper'
-require 'logster/logger'
-require 'logster/redis_store'
-require 'logger'
-require 'examples/sidekiq_logster_reporter'
+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)
@@ -38,11 +37,11 @@ class TestSidekiqReporter < MiniTest::Test
     # 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_nil(report.env[:backtrace])
 
     # The env is in the report
-    assert_equal("Test", report.env['code'])
-    assert_equal(20, report.env['params']['article_id'])
+    assert_equal("Test", report.env["code"])
+    assert_equal(20, report.env["params"]["article_id"])
   end
 end

data/test/fake_data/generate.rb

@@ -1,12 +1,23 @@
 # frozen_string_literal: true
 
-require 'redis'
-require 'logster'
+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" } })
+  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,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative '../../test_helper'
-require 'rack'
-require 'logster/redis_store'
-require 'logster/middleware/reporter'
+require_relative "../../test_helper"
+require "rack"
+require "logster/redis_store"
+require "logster/middleware/reporter"
 
 class TestReporter < Minitest::Test
-
   def setup
     Logster.store = Logster::RedisStore.new
     Logster.store.clear_all
@@ -72,11 +71,14 @@ class TestReporter < Minitest::Test
     assert_equal(1, Logster.store.count)
 
     reporter = Logster::Middleware::Reporter.new(nil)
-    env = Rack::MockRequest.env_for("/logs/report_js_error?message=hello2", "REMOTE_ADDR" => "100.1.1.2")
+    env =
+      Rack::MockRequest.env_for(
+        "/logs/report_js_error?message=hello2",
+        "REMOTE_ADDR" => "100.1.1.2",
+      )
     status, = reporter.call(env)
 
     assert_equal(200, status)
     assert_equal(2, Logster.store.count)
   end
-
 end