memolog 0.2.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134c4cf9a9a91e26cf1f1280c21abbb99fb77d61de5dd903ddf494a1ac6e1fa8
-  data.tar.gz: 9e2ba57e7a020156bca7bbcbdf93d4e13a7d99405fafcc6816fef2375887ce0a
+  metadata.gz: 97630c7e390e26c97872776f9c6b142fcb18cafaf05ceb937a8ee4a10537212c
+  data.tar.gz: 568faf40b03bc8488d651b7e09eda247f5f22e399d583d97b671868618b91e4c
 SHA512:
-  metadata.gz: 8b69825936175cf15595e4b116853eb3053c852a944c8d77316571ea43c1df8cb61873aea67bc611e583ffebcfa6fa87012dc64681e9d7a3656111cfbdfbee94
-  data.tar.gz: 454194e823302aa15f4a215fa844d60a0f5096d64bee54a2c8931fdd7e507ca0f2e729d7deafffd680b714123375a056fde7e197e2b961f708998c5986bcc726
+  metadata.gz: fb3b455425fa4e68c68620248e1cf3493e1888e7023e62cb1179b31b1a316def07c0b918ae1fa4ba3b3ff6b23c339a9f481a340fcd784a712405622ad87a77b1
+  data.tar.gz: 8cde0d72453487d056a4e507a06943bc21d2a5c5d52a8c6298b85bdc81375c189fd39904be27fb5304757cbba70493650b9a14ec4f0482846ae7ae587fe11572

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+memolog-*.gem

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.3.0
+
+- Apply a prepend patch with `Sentry::Scope#apply_to_event` method.
+- Check constant definition via `Object.const_defined?`
+- Moving `Sentry::Sidekiq` scheme to monkey patch `Sentry::Sidekiq::SentryContextServerMiddleware`
+- More specs
+
+## 0.2.2
+
+- Do not init Rails middleware in Sidekiq server.
+
+## 0.2.1
+
+- Better Rails middleware initialization.
+
 ## 0.2.0
 
 - Uprade gem due [CVE-2021-41098](https://github.com/advisories/GHSA-2rr5-8q37-2w7h)

data/Gemfile

@@ -10,5 +10,4 @@ gem "rails"
 gem "rake"
 gem "rspec"
 gem "rubocop-config-umbrellio"
-gem "sentry-ruby"
 gem "sidekiq"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    memolog (0.2.1)
+    memolog (0.3.2)
       logger (~> 1.4.3)
       securerandom (~> 0.1.0)
 
@@ -75,30 +75,11 @@ GEM
     crass (1.0.6)
     diff-lcs (1.4.4)
     erubi (1.10.0)
-    faraday (1.8.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
     globalid (0.5.2)
       activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    logger (1.4.3)
+    logger (1.4.4)
     loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -108,7 +89,6 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.1)
     minitest (5.14.4)
-    multipart-post (2.1.1)
     nio4r (2.5.8)
     nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
@@ -201,15 +181,7 @@ GEM
     rubocop-sequel (0.2.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    securerandom (0.1.0)
-    sentry-ruby (4.7.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      faraday (>= 1.0)
-      sentry-ruby-core (= 4.7.3)
-    sentry-ruby-core (4.7.3)
-      concurrent-ruby
-      faraday
+    securerandom (0.1.1)
     sidekiq (6.2.2)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
@@ -241,7 +213,6 @@ DEPENDENCIES
   rake
   rspec
   rubocop-config-umbrellio
-  sentry-ruby
   sidekiq
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,7 @@
 # Memolog
 
 Memolog is an in-memory logger, which extend any other logger.
-Designed to work with [Sentry](https://github.com/getsentry/sentry-ruby).
-It adds `memolog` extra section to Sentry errors.
+Designed to work with [Sentry](https://github.com/getsentry/sentry-ruby) but it's not necessary.
 
 ## Installation
 
@@ -28,9 +27,8 @@ Use this example during application initialization process (this example impleme
 Memolog.configure do |config|
   config.debug = false
   config.formatter = ::Memolog::Formatter.new
-  config.initializers = %i[rails sentry sidekiq]
+  config.initializers = %i[rails sidekiq]
   config.log_size_limit = 50_000
-  config.sentry_key = :memolog
   config.uuid_callable = -> { SecureRandom.uuid }
 end
 
@@ -41,18 +39,17 @@ Available options are:
 - `debug` - set it to true if you need to leave Memolog.dump result outside `Memolog.run {}` block.
 - `formatter` - setup your own formatter.
 - `initializers` - define here what you want to initialize in `#init!` call.
-- `log_size_limit` - max log length in Sentry event.
-- `sentry_key` - key name in Sentry extra object.
+- `log_size_limit` - max log length in `#dump`.
 - `uuid_callable` - Memolog add unique value to logs, here you can redefine uuid generation.
 
 ## Usage
 
 Please call `Memolog.extend_logger(Rails.logger)` or any other logger you want to collect.
-After that when error occured you can check your Sentry report and see `memolog` section with all
-logs collected before error. Also there will be unique identifier to find logs behaviour on your
-server or log collection system.
+After that when error occured you can call `Memolog.dump` in your code and get log from
+`Rails.logger` so you can collect it to another place (Sentry or etc). Also there will be unique
+identifier to find logs behaviour on your server or log collection system.
 
-Memolog has init code for Rails (Middleware), Sentry (Extension) and Sidekiq (Middleware).
+Memolog has init code for Rails (Middleware) and Sidekiq (Middleware).
 It implement all hacks on the `Memolog.init!` call.
 Also you can add `Memolog.run {}` around logs you want to collect and release it with `Memolog.dump`
 inside this block.

data/lib/memolog/config.rb

@@ -5,15 +5,13 @@ Memolog::Config = Struct.new(
   :formatter,
   :initializers,
   :log_size_limit,
-  :sentry_key,
   :uuid_callable,
 ) do
   def initialize
     self.debug = false
     self.formatter = ::Memolog::Formatter.new
-    self.initializers = %i[rails sentry sidekiq]
+    self.initializers = %i[rails sidekiq]
     self.log_size_limit = 50_000
-    self.sentry_key = :memolog
     self.uuid_callable = -> { SecureRandom.uuid }
   end
 end

data/lib/memolog/init.rb

@@ -2,29 +2,27 @@
 
 class Memolog::Init
   def call
-    init_rails!
-    init_sentry!
-    init_sidekiq!
+    init_rails_middleware!
+    init_sidekiq_middleware!
   end
 
   private
 
-  def init_rails!
-    return unless defined?(Rails) && Memolog.config.initializers.include?(:rails)
-    Rails.application.middleware.insert_before(0, Memolog::Middleware)
-  end
+  def init_rails_middleware!
+    return unless Memolog.config.initializers.include?(:rails)
+    return unless Object.const_defined?("Rails")
+    return if Object.const_defined?("Sidekiq") && Sidekiq.server?
 
-  def init_sentry!
-    return unless defined?(Sentry::Scope) && Memolog.config.initializers.include?(:sentry)
-    Sentry::Scope.prepend(Memolog::SentryScopeExtension)
+    Rails.application.middleware.insert_before(0, Memolog::RailsMiddleware)
   end
 
-  def init_sidekiq!
-    return unless defined?(Sidekiq) && Memolog.config.initializers.include?(:sidekiq)
+  def init_sidekiq_middleware!
+    return unless Memolog.config.initializers.include?(:sidekiq)
+    return unless Object.const_defined?("Sidekiq")
 
     Sidekiq.configure_server do |config|
       config.server_middleware do |chain|
-        chain.prepend(Memolog::SentrySidekiqMiddleware)
+        chain.prepend(Memolog::SidekiqMiddleware)
       end
     end
   end

data/lib/memolog/{middleware.rb → rails_middleware.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Memolog::Middleware
+class Memolog::RailsMiddleware
   def initialize(app)
     @app = app
   end

data/lib/memolog/sentry_extension.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Memolog::SentryExtension
+  def self.prepended(base)
+    base.singleton_class.send(:prepend, ClassMethods)
+  end
+
+  module ClassMethods
+    def capture_exception(exception, **options, &block)
+      set_extras_memolog!
+      super
+    end
+
+    def capture_message(message, **options, &block)
+      set_extras_memolog!
+      super
+    end
+
+    def set_extras_memolog!
+      return unless get_current_scope
+      set_extras(Memolog.config.sentry_key => Memolog.dump)
+    end
+  end
+end

data/lib/memolog/sidekiq_middleware.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Memolog::SidekiqMiddleware
+  def call(*)
+    Memolog.run { yield } # rubocop:disable Style/ExplicitBlockArgument
+  end
+end

data/lib/memolog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Memolog
-  VERSION = "0.2.1"
+  VERSION = "0.3.2"
 end

data/lib/memolog.rb

@@ -9,17 +9,16 @@ require "memolog/config"
 require "memolog/extension"
 require "memolog/formatter"
 require "memolog/init"
-require "memolog/middleware"
-require "memolog/sentry_scope_extension"
-require "memolog/sentry_sidekiq_middleware"
+require "memolog/rails_middleware"
+require "memolog/sentry_extension"
+require "memolog/sidekiq_middleware"
 
 module Memolog
   extend self
 
-  attr_accessor :config, :logdevs
+  attr_accessor :config
 
   @config = Memolog::Config.new
-  @logdevs = []
 
   def configure
     yield(config) if block_given?
@@ -42,6 +41,10 @@ module Memolog
     Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
   end
 
+  def logdevs
+    Thread.current[:memolog_logdevs] ||= []
+  end
+
   def run
     Thread.current[:memolog_uuid] = config.uuid_callable.call
 
@@ -59,6 +62,6 @@ module Memolog
     beginning = logdevs.last.string.length - config.log_size_limit
     beginning = 0 if beginning.negative?
 
-    logdevs.last.string.slice(beginning, config.log_size_limit)
+    logdevs.last.string.slice(beginning, config.log_size_limit).presence
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memolog
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -64,9 +64,9 @@ files:
 - lib/memolog/extension.rb
 - lib/memolog/formatter.rb
 - lib/memolog/init.rb
-- lib/memolog/middleware.rb
-- lib/memolog/sentry_scope_extension.rb
-- lib/memolog/sentry_sidekiq_middleware.rb
+- lib/memolog/rails_middleware.rb
+- lib/memolog/sentry_extension.rb
+- lib/memolog/sidekiq_middleware.rb
 - lib/memolog/version.rb
 homepage: https://github.com/skirushkin/memolog
 licenses:

data/lib/memolog/sentry_scope_extension.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Memolog::SentryScopeExtension
-  def extra
-    memolog_dump = Memolog.dump
-    memolog_dump.present? ? super.merge!(Memolog.config.sentry_key => memolog_dump) : super
-  end
-end

data/lib/memolog/sentry_sidekiq_middleware.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-class Memolog::SentrySidekiqMiddleware
-  def call(*)
-    Memolog.run do
-      yield
-    rescue => error
-      memolog_dump = Memolog.dump
-      Sentry.set_extras(Memolog.config.sentry_key => memolog_dump) if memolog_dump
-      raise error
-    end
-  end
-end