getaround_utils 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 482b5de4b125e852c88c47c579abf2fc0b1dc3cb529cfae3297867bd9230dd77
-  data.tar.gz: 10aa0c47f8f1c8c2fb121364b04106f3d301616976fee63a8328be497edafe65
+SHA1:
+  metadata.gz: b8b08a78e3737d628b9e809bb89c670252fc37ba
+  data.tar.gz: 34aa0786e2093c01af30981539cf971c275e5f14
 SHA512:
-  metadata.gz: 903d6190ddd4afb07c60807aaf0ad4d027ec631ec71c2df264ce4cc288cfd103e0d22417f672fd996e1cd0d1556ec7f92a78b0f3f10ebe2cf9e511808392de5e
-  data.tar.gz: eb1428e5f52272c858d54413155177a6d8f1c87fad418a67efa3012ed27489444b15f5f71cd6e79c9c617446d22173353d1c5a09d63ffd79cc335b7c09464312
+  metadata.gz: 96e165d62becbae525d2c717b2fa503149745ec3d8ca74ca70677d373dded88acdcdd67aadb05aa1474c89dff88ed2e4e34b2ceef2a001d2b13f391c0deecc50
+  data.tar.gz: 92a70522d2ba91b312bf5c985d3394f18a54d2dd7e2217ab1fbf973b5f666cafc26c309be3ee11287cf3f604a22bc903b666404b6068823307b2983ebf328940

data/.rubocop.yml

@@ -5,3 +5,15 @@ inherit_gem:
   getaround-rubocop:
     - .rubocop.yml
     - .rubocop-rspec.yml
+
+Layout/MultilineAssignmentLayout:
+  Description: Vertical alignment results in awkward diffs.
+  EnforcedStyle: same_line
+
+Layout/ElseAlignment:
+  Description: Vertical alignment results in awkward diffs.
+  Enabled: false
+
+Layout/EndAlignment:
+  Description: Vertical alignment results in awkward diffs.
+  EnforcedStyleAlignWith: start_of_line

data/README.md

@@ -14,6 +14,31 @@ require 'getaround_utils/railties/lograge'
 
 For more details, [read the spec](spec/getaround_utils/railties/lograge_spec.rb)
 
+## Mixins
+
+### GetaroundUtils::Mixins::Loggable
+
+Enables lograge (http logs) with favored default.
+```
+class MyClass
+  include Getaround::Mixins::Loggable
+
+  def append_infos_to_loggable(payload)
+    payload[:static] = 'value'
+  end
+
+  def action
+    loggable(:info, dynamic: 'value')
+  end
+end
+
+MyClass.new.action # :info { origin: 'MyClass', static: 'value', dynamic: 'value' }
+
+```
+
+For more details, [read the spec](spec/getaround_utils/mixins/loggable.rb)
+
+
 ## Patches
 
 ### GetaroundUtils::Patches::KeyValueLogTags

data/lib/getaround_utils/log_formatters/deep_key_value.rb

@@ -1,62 +1,55 @@
 module GetaroundUtils; end
 module GetaroundUtils::LogFormatters; end
 
-module GetaroundUtils::LogFormatters
-  class DeepKeyValue
-    def serialize(data)
-      case data
-      when Array
-        flattify(data).map { |key, value| "#{key}=#{value}" }.join(' ')
-      when Hash
-        flattify(data).map { |key, value| "#{key}=#{value}" }.join(' ')
-      when Numeric
-        data.to_s
-      when String
-        data =~ /^".*"$/ ? data : data.inspect
-      else
-        data.to_s.inspect
-      end
+require 'getaround_utils/utils/deep_key_value_serializer'
+
+##
+# Format logs using key=value notation
+#
+# This logger leverage the fact that ruby Logger does not especially expect message to be string
+# It will attempt to serialize message it is a string otherwise adding it as message=value
+
+class GetaroundUtils::LogFormatters::DeepKeyValue < GetaroundUtils::Utils::DeepKeyValueSerializer
+  def call(severity, _datetime, appname, message)
+    payload = { severity: severity, appname: appname }
+    if message.is_a?(Hash)
+      "#{serialize(payload.merge(message).compact)}\n"
+    else
+      "#{serialize(payload.merge(message: message.to_s).compact)}\n"
     end
+  end
 
-    # https://stackoverflow.com/questions/48836464/how-to-flatten-a-hash-making-each-key-a-unique-value
-    def flattify(value, result = {}, path = [])
-      case value
-      when Array
-        value.each.with_index(0) do |v, i|
-          flattify(v, result, path + [i])
-        end
-      when Hash
-        value.each do |k, v|
-          flattify(v, result, path + [k])
-        end
-      when Numeric
-        result[path.join(".")] = value.to_s
-      when String
-        result[path.join(".")] = value =~ /^".*"$/ ? value : value.inspect
-      else
-        result[path.join(".")] = value.to_s.inspect
-      end
-      result
+  module Lograge
+    def call(data)
+      data.compact! if data.is_a?(Hash)
+      serialize(data)
     end
+  end
+
+  ##
+  # Return a lograge-style LogFormatter
+  #
+  # This formatter will only take one argument and serialize it
 
+  def self.for_lograge
+    new.extend(Lograge)
+  end
+
+  module Sidekiq
     def call(severity, datetime, appname, message)
-      payload = { severity: severity, datetime: datetime, appname: appname }
-      if message.is_a?(Hash)
-        payload.merge!(message)
-      else
-        payload[:message] = message.to_s
-      end
-      serialize(payload)
+      payload = { tid: Thread.current['sidekiq_tid'] }
+      payload.merge!(Thread.current[:sidekiq_context] || {})
+      "#{super.chomp} #{serialize(sidekiq: payload.compact)}\n"
     end
+  end
 
-    module Lograge
-      def call(data)
-        serialize(data)
-      end
-    end
+  ##
+  # Return a sidekiq-style LogFormatter
+  #
+  # This formatter replicates the default Sidekiq LogFormatter behavior of merging context
+  # values from the current Thread's store
 
-    def self.for_lograge
-      new.extend(Lograge)
-    end
+  def self.for_sidekiq
+    new.extend(Sidekiq)
   end
 end

data/lib/getaround_utils/mixins/loggable.rb

@@ -0,0 +1,33 @@
+require 'logger'
+module GetaroundUtils; end
+module GetaroundUtils::Mixins; end
+
+module GetaroundUtils::Mixins::Loggable
+  def class_name
+    @class_name ||= is_a?(Class) ? name : self.class.name
+  end
+
+  def base_append_infos_to_loggable(payload)
+    payload[:origin] = class_name
+    return unless respond_to?(:append_infos_to_loggable)
+
+    append_infos_to_loggable(payload)
+  end
+
+  def base_loggable_logger
+    @base_loggable_logger ||= if respond_to?(:logger)
+      logger
+    elsif defined?(Rails)
+      Rails.logger
+    else
+      Logger.new(STDOUT)
+    end
+  end
+
+  def loggable(severity, payload)
+    extra_infos = {}
+    base_append_infos_to_loggable(extra_infos)
+    payload = payload.merge(extra_infos).compact
+    base_loggable_logger.send(severity.to_sym, payload)
+  end
+end

data/lib/getaround_utils/mixins.rb

@@ -0,0 +1,3 @@
+module GetaroundUtils::Mixins
+  autoload :Loggable, 'getaround_utils/mixins/loggable'
+end

data/lib/getaround_utils/patches/fix_tagged_logging_string_coercion.rb

@@ -0,0 +1,32 @@
+require 'rails/railtie'
+module GetaroundUtils; end
+module GetaroundUtils::Patches; end
+
+##
+# Fixes the ActiveSupport::TaggedLogging::Formatter string coercion
+#
+# Ruby Logger and child classes don't necessarilly expect message to be string.
+# In theory, they should preserve the message value intact until it is passed to the formatter.
+#
+# ActiveSupport::TaggedLogging breaks this by injecting the tags via string concatenation,
+# which coerces messages of any type into String.
+# This patches works around this by instead appending the tags to the result of the
+# original formatter result, which is garanteed to be a string
+
+class GetaroundUtils::Patches::FixTaggedLoggingStringCoercion
+  module TaggedLoggingFormatter
+    def fixed_tags_text
+      " #{tags_text.strip}" if tags_text
+    end
+
+    def call(severity, datetime, appname, message)
+      original_method = method(__method__).super_method.super_method
+      payload = original_method.call(severity, datetime, appname, message)
+      "#{payload.chomp}#{fixed_tags_text}\n"
+    end
+  end
+
+  def self.enable
+    ActiveSupport::TaggedLogging::Formatter.prepend TaggedLoggingFormatter
+  end
+end

data/lib/getaround_utils/patches/key_value_log_tags.rb

@@ -1,9 +1,22 @@
 require 'rails/railtie'
-require 'getaround_utils/log_formatters/deep_key_value'
+require 'getaround_utils/utils/deep_key_value_serializer'
 
 module GetaroundUtils; end
 module GetaroundUtils::Patches; end
 
+##
+# Augment the ActiveRecord::TaggedLogging tag formatting
+#
+# Tags are defined either as String, Proc or a property of request
+#
+# Originally they will be formatted as `[tag_value]`
+# This patch will instead attempt to serialize the tag with GetaroundUtils::DeepKeyValueSerializer
+#
+# ie:
+#  - for a String `value` it would yield `"value"`
+#  - for a Symbol `:request_id` it would yield `request_id="request_id_value"`
+#  - for a Proc `-> {key: :val}` it would yield `key="value"`
+
 class GetaroundUtils::Patches::KeyValueLogTags
   module TaggedLoggingFormatter
     def tags_text
@@ -12,16 +25,19 @@ class GetaroundUtils::Patches::KeyValueLogTags
   end
 
   module RackLogger
+    def kv_formatter
+      @kv_formatter ||= GetaroundUtils::Utils::DeepKeyValueSerializer.new
+    end
+
     def compute_tags(request)
-      @kv_formatter ||= GetaroundUtils::LogFormatters::DeepKeyValue.new
       @taggers.collect do |tag|
         case tag
         when Proc
-          @kv_formatter.serialize(tag.call(request))
+          kv_formatter.serialize(tag.call(request))
         when Symbol
-          @kv_formatter.serialize(tag => request.send(tag))
+          kv_formatter.serialize(tag => request.send(tag))
         else
-          @kv_formatter.serialize(tag => tag)
+          kv_formatter.serialize(tag)
         end
       end
     end

data/lib/getaround_utils/patches.rb

@@ -0,0 +1,4 @@
+module GetaroundUtils::Patches
+  autoload :FixTaggedLoggingStringCoercion, 'getaround_utils/patches/fix_tagged_logging_string_coercion'
+  autoload :KeyValueLogTags, 'getaround_utils/patches/key_value_log_tags'
+end

data/lib/getaround_utils/railties/lograge.rb

@@ -27,7 +27,5 @@ class GetaroundUtils::Railties::Lograge < Rails::Railtie
 
   config.lograge.enabled = true
   config.lograge.formatter = GetaroundUtils::LogFormatters::DeepKeyValue.for_lograge
-  config.lograge.custom_options = lambda do |event|
-    event.payload[:lograge].compact
-  end
+  config.lograge.custom_options = ->(event) { event.payload[:lograge] }
 end

data/lib/getaround_utils/utils/deep_key_value_serializer.rb

@@ -0,0 +1,40 @@
+module GetaroundUtils; end
+module GetaroundUtils::Utils; end
+
+class GetaroundUtils::Utils::DeepKeyValueSerializer
+  def serialize(data)
+    case data
+    when Array
+      flattify(data).map { |key, value| "#{key}=#{value}" }.join(' ')
+    when Hash
+      flattify(data).map { |key, value| "#{key}=#{value}" }.join(' ')
+    when Numeric
+      data.to_s
+    when String
+      data =~ /^".*"$/ ? data : data.inspect
+    else
+      data.to_s.inspect
+    end
+  end
+
+  # https://stackoverflow.com/questions/48836464/how-to-flatten-a-hash-making-each-key-a-unique-value
+  def flattify(value, result = {}, path = [])
+    case value
+    when Array
+      value.each.with_index(0) do |v, i|
+        flattify(v, result, path + [i])
+      end
+    when Hash
+      value.each do |k, v|
+        flattify(v, result, path + [k])
+      end
+    when Numeric
+      result[path.join(".")] = value.to_s
+    when String
+      result[path.join(".")] = value =~ /^".*"$/ ? value : value.inspect
+    else
+      result[path.join(".")] = value.to_s.inspect
+    end
+    result
+  end
+end

data/lib/getaround_utils/utils.rb

@@ -0,0 +1,3 @@
+module GetaroundUtils::Utils
+  autoload :DeepKeyValueSerializer, 'getaround_utils/utils/deep_key_value_serializer'
+end

data/lib/getaround_utils/version.rb

@@ -1,3 +1,3 @@
 module GetaroundUtils
-  VERSION = '0.1.6'.freeze
+  VERSION = '0.1.7'.freeze
 end

data/lib/getaround_utils.rb

@@ -2,4 +2,7 @@ require 'getaround_utils/version'
 
 module GetaroundUtils
   autoload :LogFormatters, 'getaround_utils/log_formatters'
+  autoload :Mixins, 'getaround_utils/mixins'
+  autoload :Patches, 'getaround_utils/patches'
+  autoload :Utils, 'getaround_utils/utils'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: getaround_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Drivy
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -29,20 +29,20 @@ dependencies:
   name: getaround-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.0
 - !ruby/object:Gem::Dependency
@@ -105,22 +105,22 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.9.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -139,42 +139,42 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.75.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.75.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.75'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.75.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.36.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.36'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.36.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.36.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.36'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.36.0
 description: Shared base utility classes for Getaround Backend Applications.
 email:
 - oss@drivy.com
@@ -190,8 +190,14 @@ files:
 - lib/getaround_utils.rb
 - lib/getaround_utils/log_formatters.rb
 - lib/getaround_utils/log_formatters/deep_key_value.rb
+- lib/getaround_utils/mixins.rb
+- lib/getaround_utils/mixins/loggable.rb
+- lib/getaround_utils/patches.rb
+- lib/getaround_utils/patches/fix_tagged_logging_string_coercion.rb
 - lib/getaround_utils/patches/key_value_log_tags.rb
 - lib/getaround_utils/railties/lograge.rb
+- lib/getaround_utils/utils.rb
+- lib/getaround_utils/utils/deep_key_value_serializer.rb
 - lib/getaround_utils/version.rb
 homepage: https://github.com/drivy
 licenses:
@@ -212,7 +218,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Backend shared utility classes