memolog 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bd5031cdc39d67fc6409bbe9d71028129040f13abd8f30445e5b0c4f090a005
-  data.tar.gz: 8d5e0699f794abd16aa2a2e11562085d538581c567af030bf7d3bd0e3e9bd304
+  metadata.gz: e99e3c68b6d46dff6769d0526a9b9638d6ddf479665929a8e03dddb5eeddf618
+  data.tar.gz: f7221b929323ff44066403d01a3f02eefb6dd8302c882a2a78df43776acdc03b
 SHA512:
-  metadata.gz: a894bc14c69acadbacd0dded2ea7ce4d04f2e607e19ecec70c570160976a0c79b8a9513b1024e305066bf4490e84ac8cc2927cf7a096e9df80cde82fe5f2fabe
-  data.tar.gz: 0415da3006d84de2b1804d3b2ac7e26d8f793617861a22c0a6eb71291c2d1071ff021b4859b9ee53d23b609bf66aaa4e7cef5e338d6fb9e6fb708fa874f5f197
+  metadata.gz: 35f308119cb2c44d09974ce1f9fda973e648212aefb36d6256678d0b281de6784be265bc87781b55f3aa05d5a3d6ddfdd60beb86e77420f629fab02e72e87be7
+  data.tar.gz: 3a82f19378b63f47ffcd9ad512ee44a2daa4769ffdaed6b01cd90e867e3cea31c200d264820f91af8307f0e43bb3a2c03944aa0d107bd2beeb6e6464a46cb8c7

data/.gitignore

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

data/CHANGELOG.md

@@ -1,5 +1,24 @@
-## [Unreleased]
+## 0.3.0
 
-## [0.1.0] - 2021-09-27
+- 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)
+- Add initializers config option, available initializers are [rails, sentry, sidekiq].
+- Move debug option to config.
+
+## 0.1.0
 
 - Test version for publish and test workflow.

data/Gemfile

@@ -4,3 +4,12 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in memolog.gemspec
 gemspec
+
+gem "pry"
+gem "rails"
+gem "rake"
+gem "rspec"
+gem "rubocop-config-umbrellio"
+gem "sentry-ruby"
+gem "sentry-sidekiq"
+gem "sidekiq"

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    memolog (0.1.0)
-      logger
-      securerandom
+    memolog (0.3.0)
+      logger (~> 1.4.3)
+      securerandom (~> 0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -98,7 +98,7 @@ GEM
       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)
@@ -110,9 +110,9 @@ GEM
     minitest (5.14.4)
     multipart-post (2.1.1)
     nio4r (2.5.8)
-    nokogiri (1.12.4-x86_64-darwin)
+    nokogiri (1.12.5-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.12.4-x86_64-linux)
+    nokogiri (1.12.5-x86_64-linux)
       racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.2.0)
@@ -177,7 +177,7 @@ GEM
       rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.11.0)
+    rubocop-ast (1.12.0)
       parser (>= 3.0.1.1)
     rubocop-config-umbrellio (1.17.0.53)
       rubocop (= 1.17.0)
@@ -202,7 +202,7 @@ GEM
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
-    securerandom (0.1.0)
+    securerandom (0.1.1)
     sentry-ruby (4.7.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       faraday (>= 1.0)
@@ -210,6 +210,9 @@ GEM
     sentry-ruby-core (4.7.3)
       concurrent-ruby
       faraday
+    sentry-sidekiq (4.7.3)
+      sentry-ruby-core (~> 4.7.0)
+      sidekiq (>= 3.0)
     sidekiq (6.2.2)
       connection_pool (>= 2.2.2)
       rack (~> 2.0)
@@ -242,6 +245,7 @@ DEPENDENCIES
   rspec
   rubocop-config-umbrellio
   sentry-ruby
+  sentry-sidekiq
   sidekiq
 
 BUNDLED WITH

data/README.md

@@ -20,10 +20,40 @@ Or install it yourself as:
 
     $ gem install memolog
 
+## Configuration
+
+Use this example during application initialization process (this example implement default values):
+
+```ruby
+Memolog.configure do |config|
+  config.debug = false
+  config.formatter = ::Memolog::Formatter.new
+  config.initializers = %i[rails sentry sidekiq]
+  config.log_size_limit = 50_000
+  config.sentry_key = :memolog
+  config.uuid_callable = -> { SecureRandom.uuid }
+end
+
+Memolog.init!
+```
+
+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.
+- `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.
+
 Memolog has init code for Rails (Middleware), Sentry (Extension) and Sidekiq (Middleware).
-It implement all hacks on the load process.
+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

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

data/lib/memolog/init.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
-if defined?(Rails::Railtie)
-  require "memolog/railtie"
-end
+class Memolog::Init
+  def call
+    init_rails!
+    init_sentry!
+    init_sidekiq!
+  end
 
-if defined?(Sentry::Scope)
-  Sentry::Scope.prepend(Memolog::SentryScopeExtension)
-end
+  private
+
+  def init_rails!
+    return unless Memolog.config.initializers.include?(:rails)
+    return unless Object.const_defined?("Rails")
+    return if Object.const_defined?("Sidekiq") && Sidekiq.server?
+
+    Rails.application.middleware.insert_before(0, Memolog::Middleware)
+  end
+
+  def init_sentry!
+    return unless Memolog.config.initializers.include?(:sentry)
+    return unless Object.const_defined?("Sentry::Scope")
+
+    Sentry::Scope.prepend(Memolog::SentryScopeExtension)
+  end
+
+  def init_sidekiq!
+    return unless Memolog.config.initializers.include?(:sidekiq)
+    return unless Object.const_defined?("Sentry::Sidekiq::SentryContextServerMiddleware")
 
-if defined?(Sidekiq)
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.prepend(Memolog::SentrySidekiqMiddleware)
-    end
+    Sentry::Sidekiq::SentryContextServerMiddleware.prepend(
+      Memolog::SentrySidekiqMiddlewareExtension,
+    )
   end
 end

data/lib/memolog/sentry_scope_extension.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Memolog::SentryScopeExtension
-  def extra
+  def apply_to_event(scope, hint = nil)
     memolog_dump = Memolog.dump
-    memolog_dump.present? ? super.merge!(Memolog.config.sentry_key => memolog_dump) : super
+    set_extras(Memolog.config.sentry_key => memolog_dump) if memolog_dump
+
+    super
   end
 end

data/lib/memolog/sentry_sidekiq_middleware_extension.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Memolog::SentrySidekiqMiddlewareExtension
+  def call(worker, job, queue)
+    Memolog.run { super }
+  end
+end

data/lib/memolog/version.rb

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

data/lib/memolog.rb

@@ -2,52 +2,55 @@
 
 require "logger"
 require "securerandom"
+require "stringio"
+
+require "memolog/version"
+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_extension"
 
 module Memolog
   extend self
 
-  autoload :VERSION, "memolog/version"
-  autoload :Config, "memolog/config"
-  autoload :Extension, "memolog/extension"
-  autoload :Formatter, "memolog/formatter"
-  autoload :Middleware, "memolog/middleware"
-  autoload :SentryScopeExtension, "memolog/sentry_scope_extension"
-  autoload :SentrySidekiqMiddleware, "memolog/sentry_sidekiq_middleware"
+  attr_accessor :config, :logdevs
 
-  attr_accessor :debug, :logdevs
-
-  self.debug = false
-  self.logdevs = []
+  @config = Memolog::Config.new
+  @logdevs = []
 
   def configure
-    @config ||= Memolog::Config.new
-    yield(@config) if block_given?
-    @config
+    yield(config) if block_given?
+  end
+
+  def init!
+    Memolog::Init.new.call
   end
-  alias config configure
 
   def extend_logger(other_logger)
     other_logger.extend(Memolog::Extension)
     other_logger.formatter = config.formatter
   end
 
-  def logger
-    Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
-  end
-
   def uuid
     Thread.current[:memolog_uuid]
   end
 
+  def logger
+    Thread.current[:memolog_logger] ||= Logger.new(nil, formatter: config.formatter)
+  end
+
   def run
-    Thread.current[:memolog_uuid] = Memolog.config.uuid_callable.call
+    Thread.current[:memolog_uuid] = config.uuid_callable.call
 
     logdevs.push(StringIO.new)
     logger.instance_variable_set(:@logdev, logdevs.last)
 
     yield
   ensure
-    logdevs.pop unless debug
+    logdevs.pop unless config.debug
   end
 
   def dump
@@ -56,8 +59,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
-
-require "memolog/init"

metadata

@@ -1,141 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: memolog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stepan Kirushkin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.3
 - !ruby/object:Gem::Dependency
   name: securerandom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-config-umbrellio
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sentry-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 description: |2
       Memolog is an in-memory logger, which extend any other logger.
       Designed to work with Sentry.
@@ -163,9 +65,8 @@ files:
 - lib/memolog/formatter.rb
 - lib/memolog/init.rb
 - lib/memolog/middleware.rb
-- lib/memolog/railtie.rb
 - lib/memolog/sentry_scope_extension.rb
-- lib/memolog/sentry_sidekiq_middleware.rb
+- lib/memolog/sentry_sidekiq_middleware_extension.rb
 - lib/memolog/version.rb
 homepage: https://github.com/skirushkin/memolog
 licenses:
@@ -173,7 +74,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/skirushkin/memolog
   source_code_uri: https://github.com/skirushkin/memolog
-  changelog_uri: https://github.com/skirushkin/memolog
+  changelog_uri: https://github.com/skirushkin/memolog/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/memolog/railtie.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-class Memolog::Railtie < Rails::Railtie
-  initializer "memolog.configure_rails_initialization" do |app|
-    app.middleware.insert_before(0, Memolog::Middleware)
-  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