logster 2.4.2 → 2.5.0

data/test/logster/test_defer_logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/defer_logger'
 require 'logster/logger'

data/test/logster/test_group.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require_relative '../test_helper'
+require 'logster/group'
+require 'logster/message'
+
+class TestGroup < MiniTest::Test
+  def test_changed_is_true_for_new_instances
+    assert Logster::Group.new("/somekey/").changed?
+  end
+
+  def test_from_json_works_correctly
+    time = (Time.new.to_f * 1000).to_i - 5000
+    json = JSON.generate(
+      key: '/somekey/',
+      messages_keys: [111, 222, 333].map(&:to_s),
+      timestamp: time
+    )
+    group = Logster::Group.from_json(json)
+    refute group.changed?
+    assert_equal 3, group.count
+    assert_equal time, group.timestamp
+  end
+
+  def test_doesnt_add_duplicate_messages
+    group = get_group
+    msg1 = get_message
+    assert_equal 0, group.count
+    group.add_message(msg1)
+    assert_equal 1, group.count
+    assert_equal msg1.timestamp, group.timestamp
+    group.add_message(msg1)
+    assert_equal 1, group.count
+
+    msg2 = get_message
+    msg2.timestamp -= 10000
+    group.add_message(msg2)
+    assert_equal 2, group.count
+    assert_equal msg1.timestamp, group.timestamp
+  end
+
+  def test_adding_multiple_messages_works_correctly
+    group = get_group
+    messages = [
+      get_message(10),
+      get_message(5),
+      get_message(74),
+      get_message(26)
+    ]
+    messages << messages[0]
+    group.messages = messages
+    assert_equal 4, group.count
+    assert_equal 74, group.timestamp
+    expected = messages.uniq(&:key).sort_by(&:timestamp).map(&:key).reverse
+    assert_equal expected, group.messages_keys
+  end
+
+  def test_doesnt_exceed_max_size
+    Logster::Group.instance_variable_set(:@max_size, 5)
+    group = get_group
+    messages = [
+      get_message(10),
+      get_message(5),
+      get_message(74),
+      get_message(26),
+      get_message(44),
+      get_message(390)
+    ]
+    messages.each { |m| group.add_message(m) }
+    assert_equal 5, group.count
+    assert_equal 390, group.timestamp
+    refute_includes group.messages_keys, messages.find { |m| m.timestamp == 10 }.key
+
+    group = get_group
+    group.messages = messages
+    assert_equal 5, group.count
+    assert_equal 390, group.timestamp
+    refute_includes group.messages.map(&:timestamp), 5
+  ensure
+    Logster::Group.remove_instance_variable(:@max_size)
+  end
+
+  private
+
+  def get_group
+    Logster::Group.new("/groupkey/")
+  end
+
+  def get_message(timestamp = nil)
+    Logster::Message.new(0, '', 'testmessage', timestamp)
+  end
+end

data/test/logster/test_ignore_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/ignore_pattern'
 

data/test/logster/test_logger.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/logger'
 require 'logger'
 
-class TestStore
+class TestStore < Logster::BaseStore
   attr_accessor :calls
 
   def report(*args)

data/test/logster/test_message.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/message'
 

data/test/logster/test_pattern.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/redis_store'
 require 'logster/pattern'
@@ -9,8 +11,6 @@ class TestPattern < Minitest::Test
     end
   end
 
-  Logster::PATTERNS << FakePattern
-
   class TestRedisStore < Logster::BaseStore
     def get_patterns(set_name)
       ["/differentstore/"]

data/test/logster/test_redis_rate_limiter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/redis_store'
 require 'rack'

data/test/logster/test_redis_store.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../test_helper'
 require 'logster/redis_store'
 require 'rack'
@@ -23,6 +25,55 @@ class TestRedisStore < Minitest::Test
     assert_nil(@store.get_env(msg.key))
   end
 
+  def test_delete_with_custom_grouping_patterns
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/delete/, store: @store).save
+    msg1 = @store.report(Logger::WARN, '', 'this will be deleted')
+    msg2 = @store.report(Logger::WARN, '', 'delete this plz')
+
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal [msg2.key, msg1.key], groups[0].messages_keys
+
+    @store.delete(msg1)
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal [msg2.key], groups[0].messages_keys
+
+    @store.delete(msg2)
+    groups = @store.find_pattern_groups
+    assert_equal 0, groups.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_bulk_delete_with_custom_grouping_patterns
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/delete/, store: @store).save
+    keys = []
+    gkeys = []
+    6.times do |n|
+      m = @store.report(Logger::WARN, '', "#{n} delete")
+      keys << m.key
+      gkeys << m.grouping_key
+    end
+
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal keys.reverse, groups[0].messages_keys
+
+    @store.bulk_delete(keys[0..2], gkeys[0..2])
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal keys[3..5].reverse, groups[0].messages_keys
+
+    @store.bulk_delete(keys, gkeys)
+    groups = @store.find_pattern_groups
+    assert_equal 0, groups.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
   def test_latest
     @store.report(Logger::WARN, "test", "IGNORE")
     @store.report(Logger::WARN, "test", "This is a warning")
@@ -76,7 +127,58 @@ class TestRedisStore < Minitest::Test
     messages = @store.latest(limit: 10, before: messages[0].key)
     assert_equal("A", messages[0].message)
     assert_equal(10, messages.length)
+  end
+
+  def test_latest_with_custom_grouping
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/group 1/, store: @store).save
+    Logster::GroupingPattern.new(/group 2/, store: @store).save
+    msg1 = @store.report(Logger::WARN, '', 'first message')
+    group_1_keys = []
+    3.times { |n| group_1_keys << @store.report(Logger::WARN, '', "group 1 #{n}").key }
+    msg2 = @store.report(Logger::WARN, '', 'second message')
+    group_1_keys << @store.report(Logger::WARN, '', "group 1 3").key
+    msg3 = @store.report(Logger::WARN, '', 'third message')
+    group_2_keys = []
+    3.times { |n| group_2_keys << @store.report(Logger::WARN, '', "group 2 #{n}").key }
+    msg4 = @store.report(Logger::WARN, '', 'fourth message')
+
+    results = @store.latest
+    assert_equal [msg1.key, msg2.key, "/group 1/", msg3.key, "/group 2/", msg4.key], results.map(&:key)
+    groups = results.select { |r| r.class == Logster::Group::GroupWeb }
+    assert_equal(
+      [group_1_keys.last, group_2_keys.last],
+      groups.map(&:row_id)
+    )
+    assert_equal 4, groups[0].messages.size
+    assert_equal 3, groups[1].messages.size
 
+    results = @store.latest(before: groups[0].row_id, known_groups: groups.map(&:key))
+    assert_equal [msg1.key, msg2.key], results.map(&:key)
+
+    results = @store.latest(before: groups[1].row_id, known_groups: [groups[1].key])
+    assert_equal [msg1.key, msg2.key, "/group 1/", msg3.key], results.map(&:key)
+
+    results = @store.latest(before: msg2.key, known_groups: groups.map(&:key))
+    assert_equal [msg1.key], results.map(&:key)
+
+    results = @store.latest(after: groups[0].row_id)
+    assert_equal [msg3.key, "/group 2/", msg4.key], results.map(&:key)
+
+    results = @store.latest(after: msg2.key)
+    assert_equal ["/group 1/", msg3.key, "/group 2/", msg4.key], results.map(&:key)
+    assert_equal 4, results[0].messages.size
+
+    results = @store.latest(after: msg4.key)
+    assert_equal 0, results.size
+
+    group_2_keys << @store.report(Logger::WARN, '', "group 2 3").key
+    results = @store.latest(after: msg4.key)
+    assert_equal ["/group 2/"], results.map(&:key)
+    assert_equal group_2_keys.last, results[0].row_id
+    assert_equal 4, results[0].messages.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
   end
 
   def test_get
@@ -261,6 +363,32 @@ class TestRedisStore < Minitest::Test
     assert(env <= latest[1].env)
   end
 
+  def test_clear_deletes_pattern_groups_if_not_protected
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster.config.allow_grouping = true
+    Logster::GroupingPattern.new(/discourse/, store: @store).save
+    Logster::GroupingPattern.new(/logster/, store: @store).save
+    msg = @store.report(Logger::WARN, '', 'discourse')
+    @store.protect(msg.key)
+    @store.report(Logger::WARN, '', 'logster')
+    groups = @store.find_pattern_groups
+    assert_equal 2, groups.size
+
+    @store.clear
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal msg.key, groups[0].messages_keys[0]
+    assert_equal '/discourse/', groups[0].key
+
+    @store.unprotect(msg.key)
+    @store.clear
+    groups = @store.find_pattern_groups
+    assert_equal 0, groups.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+    Logster.config.allow_grouping = false
+  end
+
   def test_hash_cleanup
     @store.max_backlog = 2
     a_message = @store.report(Logger::WARN, "test", "A")
@@ -720,6 +848,131 @@ class TestRedisStore < Minitest::Test
     Logster.config.maximum_message_size_bytes = default
   end
 
+  def test_custom_grouping_patterns
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/delete/, store: @store).save
+    msg1 = @store.report(Logger::WARN, '', 'delete this plz', timestamp: 1)
+    msg2 = @store.report(Logger::WARN, '', 'delete that plz', timestamp: 2)
+    group = @store.find_pattern_groups(load_messages: true)[0]
+    assert_equal 2, group.count
+    assert_equal "/delete/", group.key
+    assert_equal [msg2.key, msg1.key], group.messages_keys
+    assert_equal msg2.timestamp, group.timestamp
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_custom_grouping_patterns_with_similar_messages_grouping
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster.config.allow_grouping = true
+    Logster::GroupingPattern.new(/delete/, store: @store).save
+    backtrace = caller
+    @store.report(Logger::WARN, '', 'delete this plz', backtrace: backtrace, timestamp: 1)
+    msg2 = @store.report(Logger::WARN, '', 'delete that plz', backtrace: backtrace, timestamp: 2)
+    msg3 = @store.report(Logger::WARN, '', 'delete this plz', backtrace: backtrace, timestamp: 3)
+    group = @store.find_pattern_groups(load_messages: false)[0]
+    assert_equal 2, group.count
+    assert_equal [msg3.key, msg2.key], group.messages_keys
+    assert_equal msg3.timestamp, group.timestamp
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+    Logster.config.allow_grouping = false
+  end
+
+  def test_a_single_message_can_be_in_one_grouping_pattern
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/delete/, store: @store).save
+    Logster::GroupingPattern.new(/env/, store: @store).save
+    @store.report(Logger::WARN, '', 'delete and env')
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_includes ["/delete/", "/env/"], groups[0].key
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_find_pattern_groups_works_correctly
+    Logster.config.enable_custom_patterns_via_ui = true
+    with_search = Logster::GroupingPattern.new(/with search/, store: @store)
+    with_search.save
+    Logster::GroupingPattern.new(/pattern group/, store: @store).save
+
+    groups = @store.find_pattern_groups
+    assert_equal 0, groups.size # because there are no messages yet
+
+    2.times do |n|
+      @store.report(Logger::WARN, '', "with search #{n}")
+      @store.report(Logger::WARN, '', "pattern group #{n}")
+    end
+    groups = @store.find_pattern_groups
+    assert_equal 2, groups.size
+    groups.each do |g|
+      assert_equal 2, g.count
+      assert_nil g.messages
+    end
+
+    groups = @store.find_pattern_groups(load_messages: true)
+    assert_equal 2, groups.size
+    groups.each do |g|
+      assert_equal 2, g.count
+      assert_equal 2, g.messages.size
+      g.messages.each { |m| assert Logster::Message === m }
+    end
+
+    groups = @store.find_pattern_groups(load_messages: true) { |pat| pat == with_search.pattern }
+    assert_equal 1, groups.size
+    assert_equal 2, groups[0].count
+    assert groups[0].messages.all? { |m| m.message =~ /with search/ }
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_trimming_backlog_removes_messages_from_custom_grouping
+    prev_max_backlog = @store.max_backlog
+    @store.max_backlog = 4
+    Logster.config.enable_custom_patterns_via_ui = true
+    Logster::GroupingPattern.new(/trim/, store: @store).save
+    keys = []
+    5.times do |n|
+      keys << @store.report(Logger::WARN, '', "trim backlog #{n}").key
+    end
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+    assert_equal 4, groups[0].count
+    assert_equal keys[1..-1].reverse, groups[0].messages_keys
+  ensure
+    @store.max_backlog = prev_max_backlog
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_adding_grouping_pattern_works_retroactively
+    Logster.config.enable_custom_patterns_via_ui = true
+    @store.report(Logger::WARN, '', 'trim this plz')
+    @store.report(Logger::WARN, '', 'trim that plz')
+    Logster::GroupingPattern.new(/trim/, store: @store).save
+    results = @store.latest
+    assert_equal 1, results.size
+    assert_equal 2, results[0].messages.size
+
+    @store.report(Logger::WARN, '', 'trim this more plz')
+    results = @store.latest
+    assert_equal 1, results.size
+    assert_equal 3, results[0].messages.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
+  def test_adding_grouping_pattern_doesnt_add_a_message_to_more_than_one_group
+    Logster.config.enable_custom_patterns_via_ui = true
+    @store.report(Logger::WARN, '', 'trim this plz')
+    Logster::GroupingPattern.new(/trim/, store: @store).save
+    Logster::GroupingPattern.new(/this/, store: @store).save
+    groups = @store.find_pattern_groups
+    assert_equal 1, groups.size
+  ensure
+    Logster.config.enable_custom_patterns_via_ui = false
+  end
+
   private
 
   def reset_redis

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'minitest'
 require 'minitest/unit'
 require 'minitest/autorun'
@@ -11,6 +13,7 @@ require 'byebug'
 class Logster::TestStore < Logster::BaseStore
   attr_accessor :reported
   def initialize
+    super
     @reported = []
   end
 
@@ -34,5 +37,8 @@ class Logster::TestStore < Logster::BaseStore
     # Do nothing
   end
 
+  def increment_ignore_count(pattern)
+  end
+
   # get, protect, unprotect: unimplemented
 end