getaround_utils 0.2.7 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b223cad8498dfd12507f6ab773df8a1faf022100f7d853ca5460f4b6777c7182
-  data.tar.gz: fee4b3c9d00bae73b4e6dcb9e03bc41873d322dbade354526e66eb3f86442f14
+  metadata.gz: b5fb2e983311d51793f19b40c1650fa338bac50c97570af7c8155ed9d0d3e604
+  data.tar.gz: cca129082b35867980ad77bba62bf50cc4b8915ee202c41e861f66cc943d069d
 SHA512:
-  metadata.gz: 48b823c75460cacf812d6b08adc733821a8cbe8e488441f5ee53ecc3681467d50589195cf8f0781e8c3dcac4a37f6decd56cbb981d6c886f18558e69e72075ad
-  data.tar.gz: ddcc92a0093cb1a6dd63b5510a3c5db012ce0099e43262a8fc5f475bbc722795f42c0e1c411624b5fd5dd1a240434f7b15bed65c47c390345a839fbe487e40fe
+  metadata.gz: '097c3b06d8f9da62c1d831474d69dcff2950a4920fdff0a9a75a9e8c42c14466f63ed399ef27fe9c8344967445dcfd5251840c48b69dd1038d2769e6d560832b'
+  data.tar.gz: edd536e5ffad5d30980d1de0f3b5a0d5ebf42da09c0f5d7e58651af541202292c70501a1992a03849676811c0db7c74116bd75306a766a086859b0e738752571

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    getaround_utils (0.2.7)
+    getaround_utils (0.2.14)
 
 GEM
   remote: https://rubygems.org/
@@ -103,7 +103,7 @@ GEM
     minitest (5.13.0)
     multipart-post (2.1.1)
     nio4r (2.5.2)
-    nokogiri (1.10.5)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     oj (3.10.14)
     ougai (1.8.5)
@@ -115,7 +115,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (4.0.2)
-    rack (2.0.7)
+    rack (2.2.3)
     rack-protection (2.0.7)
       rack
     rack-test (1.1.0)
@@ -147,7 +147,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.3)
     redis (4.1.3)
     relaxed-rubocop (2.4)
     request_store (1.4.1)
@@ -209,7 +209,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
+    websocket-extensions (0.1.5)
     zeitwerk (2.2.1)
 
 PLATFORMS
@@ -224,7 +224,7 @@ DEPENDENCIES
   ougai (~> 1.8)
   pry (~> 0.12.2)
   rails (~> 6.0)
-  rake (~> 10.0)
+  rake (~> 12.3)
   request_store_rails (~> 2.0)
   rspec (~> 3.9, >= 3.9.0)
   rspec-rails (~> 3.9)

data/getaround_utils.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'lograge', '~> 0.11.2'
   gem.add_development_dependency 'pry', '~> 0.12.2'
   gem.add_development_dependency 'rails', '~> 6.0'
-  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rake", "~> 12.3"
   gem.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
   gem.add_development_dependency 'rspec-rails', '~> 3.9'
   gem.add_development_dependency 'rubocop', '~> 0.75', '>= 0.75.0'

data/lib/getaround_utils/mixins/loggable.rb

@@ -14,26 +14,16 @@ module GetaroundUtils::Mixins::Loggable
     append_infos_to_loggable(payload)
   end
 
-  def base_loggable_logger
-    @base_loggable_logger ||= if respond_to?(:logger) && !logger.nil?
-      logger
-    elsif defined?(Rails)
-      Rails.logger
-    else
-      Logger.new(STDOUT)
-    end
+  def loggable_logger_fallback
+    @loggable_logger_fallback ||= Logger.new(STDOUT)
   end
 
-  def loggable(severity, message, payload = {})
-    base_loggable_logger.send(
-      :warn,
-      "Deprecated usage of GetaroundUtils::Mixins::Loggable#loggable(*args). Please use GetaroundUtils::Mixins::Loggable#loggable_log(*args) instead"
-    )
-    loggable_log(severity, message, payload)
+  def loggable_logger
+    (logger if respond_to?(:logger)) || (Rails.logger if defined?(Rails)) || loggable_logger_fallback
   end
 
   def loggable_log(severity, message, payload = {})
     base_append_infos_to_loggable(payload)
-    base_loggable_logger.send(severity.to_sym, msg: message, **payload)
+    loggable_logger.send(severity.to_sym, msg: message, **payload)
   end
 end

data/lib/getaround_utils/ougai/json_formatter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'ougai'
 require 'json'
 
 module GetaroundUtils; end

data/lib/getaround_utils/railties/lograge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/railtie'
 require 'lograge'
 
@@ -8,13 +10,12 @@ class GetaroundUtils::Railties::Lograge < Rails::Railtie
   module LogrageActionController
     def append_info_to_payload(payload)
       super
-      payload[:lograge] ||= {}
+      payload[:lograge] = {}
       payload[:lograge][:host] = request.host
       payload[:lograge][:params] = request.filtered_parameters.except(:action, :controller)
       payload[:lograge][:remote_ip] = request.remote_ip
       payload[:lograge][:user_agent] = request.user_agent
       payload[:lograge][:referer] = request.referer
-      payload[:lograge][:controller_action] = "#{params[:controller]}##{params[:action]}" if defined?(params)
       payload[:lograge][:session_id] = session.is_a?(Hash) ? session[:id] : session.id if defined?(session)
       payload[:lograge][:user_id] = current_user&.id if defined?(current_user)
     end
@@ -24,6 +25,15 @@ class GetaroundUtils::Railties::Lograge < Rails::Railtie
     ActionController::Base.prepend LogrageActionController
   end
 
+  HTTP_PARAMS = [:method, :path, :host, :remote_ip,
+                 :status, :duration, :location,
+                 :user_agent, :referer].freeze
+
   config.lograge.enabled = true
-  config.lograge.custom_options = ->(event) { event.payload[:lograge] }
+  config.lograge.custom_options = ->(event) {
+    event.payload[:lograge]
+  }
+  config.lograge.before_format = ->(data, _) {
+    data.except(*HTTP_PARAMS).merge(http: data.slice(*HTTP_PARAMS))
+  }
 end

data/lib/getaround_utils/railties/ougai.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'getaround_utils/ougai/deep_key_value_formatter'
+require 'getaround_utils/ougai/json_formatter'
 require 'request_store'
 require 'rails/railtie'
 require 'ougai'
@@ -19,9 +19,13 @@ end
 # https://github.com/tilfin/ougai/wiki/Use-as-Rails-logger#with-activesupporttaggedlogging
 module OugaiTaggedLoggingFormatter
   def call(severity, time, progname, data)
-    data = { msg: data.to_s } unless data.is_a?(Hash)
-    data[:tags] = current_tags if current_tags.any?
-    _call(severity, time, progname, data)
+    if is_a?(Ougai::Formatters::Base)
+      data = { msg: data.to_s } unless data.is_a?(Hash)
+      data[:tags] = current_tags if current_tags.any?
+      _call(severity, time, progname, data)
+    else
+      super
+    end
   end
 end
 
@@ -34,7 +38,7 @@ class OugaiRequestStoreMiddleware
   end
 
   def call(env)
-    RequestStore.store[:ougai] = { request_id: env['action_dispatch.request_id'] }
+    RequestStore.store[:ougai] = { http: { request_id: env['action_dispatch.request_id'] } }
     @app.call(env)
   end
 end
@@ -42,10 +46,10 @@ end
 class GetaroundUtils::Railties::Ougai < Rails::Railtie
   config.ougai_logger = OugaiRailsLogger.new(STDOUT)
   config.ougai_logger.after_initialize if Rails::VERSION::MAJOR < 6
-  config.ougai_logger.formatter = GetaroundUtils::Ougai::DeepKeyValueFormatter.new
+  config.ougai_logger.formatter = GetaroundUtils::Ougai::JsonFormatter.new
   config.ougai_logger.before_log = lambda do |data|
     request_store = RequestStore.store[:ougai] || {}
-    data.merge!(request_store) if request_store&.any?
+    data.deep_merge!(request_store) if request_store&.any?
 
     sidekiq_context = Thread.current[:sidekiq_context] || {}
     data.merge!(sidekiq: sidekiq_context) if sidekiq_context&.any?
@@ -77,9 +81,13 @@ class GetaroundUtils::Railties::Ougai < Rails::Railtie
     Sidekiq.logger = config.ougai_logger
 
     Sidekiq.configure_server do |config|
-      config.error_handlers.shift
+      original_handler = config.error_handlers.shift
       config.error_handlers << lambda do |ex, ctx|
-        Sidekiq.logger.warn(ex, job: ctx[:job])
+        if Sidekiq.logger.is_a?(Ougai::Logger)
+          Sidekiq.logger.warn(ex, job: ctx[:job])
+        else
+          original_handler.call(ex, ctx)
+        end
       end
     end
   end

data/lib/getaround_utils/utils.rb

@@ -1,4 +1 @@
-require 'getaround_utils/utils/async_queue'
 require 'getaround_utils/utils/deep_key_value'
-require 'getaround_utils/utils/http_reporter'
-require 'getaround_utils/utils/captur_reporter'

data/lib/getaround_utils/version.rb

@@ -1,3 +1,3 @@
 module GetaroundUtils
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.2.14'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.14
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,14 +93,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -211,10 +211,7 @@ files:
 - lib/getaround_utils/railties/lograge.rb
 - lib/getaround_utils/railties/ougai.rb
 - lib/getaround_utils/utils.rb
-- lib/getaround_utils/utils/async_queue.rb
-- lib/getaround_utils/utils/captur_reporter.rb
 - lib/getaround_utils/utils/deep_key_value.rb
-- lib/getaround_utils/utils/http_reporter.rb
 - lib/getaround_utils/version.rb
 homepage: https://github.com/drivy
 licenses:

data/lib/getaround_utils/utils/async_queue.rb

@@ -1,49 +0,0 @@
-module GetaroundUtils; end
-module GetaroundUtils::Utils; end
-
-class GetaroundUtils::Utils::AsyncQueue
-  include GetaroundUtils::Mixins::Loggable
-
-  MAX_QUEUE_SIZE = 1000
-  BUFFER_SIZE = 50
-
-  def initialize
-    @queue = []
-    @mutex = Mutex.new
-    @closed = false
-    @worker = Thread.new(&method(:thread_run))
-    at_exit { terminate }
-  end
-
-  def perform
-    raise NotImplementedError
-  end
-
-  def push(payload)
-    @mutex.synchronize do
-      if @queue.size >= MAX_QUEUE_SIZE
-        loggable_log(:error, 'queue overflow')
-      else
-        @queue.push(payload)
-      end
-    end
-  end
-
-  def thread_run
-    loop do
-      buffer = @mutex.synchronize { @queue.shift(BUFFER_SIZE) }
-      loggable_log(:debug, 'thread_run', buffer_size: buffer.size)
-      return if @closed && buffer.empty?
-
-      perform(buffer) unless buffer.empty?
-      sleep(1) unless @mutex.synchronize { @queue.any? }
-    rescue StandardError => e
-      loggable_log(:error, e.message, class: e.class.to_s, backtrace: e.backtrace)
-    end
-  end
-
-  def terminate
-    @mutex.synchronize { @closed = true }
-    @worker&.join
-  end
-end

data/lib/getaround_utils/utils/captur_reporter.rb

@@ -1,32 +0,0 @@
-require 'json'
-require 'faraday'
-require 'getaround_utils/utils/async_queue'
-
-class GetaroundUtils::Utils::CapturReporter < GetaroundUtils::Utils::AsyncQueue
-  CAPTUR_URL = ENV['CAPTUR_URL']
-
-  def perform(events)
-    return unless CAPTUR_URL&.match('^https?://')
-
-    Faraday.post(CAPTUR_URL) do |req|
-      req.options[:open_timeout] = 1
-      req.options[:timeout] = 1
-      req.headers = { 'Content-Type': 'application/json' }
-      req.body = JSON.generate(events: events, metas: metas)
-    end
-  end
-
-  def metas
-    {}
-  end
-
-  def push(uuid:, type:, anonymous_id:, timestamp: nil, attributes: {})
-    super(
-      uuid: uuid,
-      type: type,
-      timestamp: timestamp || Time.now.iso8601,
-      anonymous_id: anonymous_id,
-      attributes: attributes,
-    )
-  end
-end

data/lib/getaround_utils/utils/http_reporter.rb

@@ -1,11 +0,0 @@
-class GetaroundUtils::Utils::HttpReporter
-  include GetaroundUtils::Mixins::Loggable
-
-  def initialize(_)
-    loggable_log(:warn, 'use of deprecated class')
-  end
-
-  def report(_)
-    loggable_log(:warn, 'use of deprecated class')
-  end
-end