luna_park 0.11.7 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f27391a9cf68f27141e6cf1c408abf3d62e68914252311fb2ee9542ec14704
-  data.tar.gz: c434508390a2ae07e71ad5578c5e82f251051b7e2008c8d0383609de5c399dca
+  metadata.gz: 14e20ec6fc8a3a6e96958a184503dbc5850dbf74e14c8d5943514c32c264337b
+  data.tar.gz: 6b3860177c18140dc5ea8c3a1e5e26577a952597d6f9c8f820499b6128b29d97
 SHA512:
-  metadata.gz: 2d806ea403698a4cbcbae094abd3257418e2920d9ba1cb793ef92d250380594c89e71f6e24d0e583b2ef87074bd0e8b7a15c06c8252da8d379726ab1a1aee9dc
-  data.tar.gz: d777a213dfd32208477d1af5291a357c3639df8e3d6dd1d4c586d4b19d2c3221cdaab045928245ef7a97308141b8bbede2d7cf55a49f85dca0fcae4b908cebf5
+  metadata.gz: 509321c66abc91c03bfd78cad59f8201c0961a064facf057bdd3db339747a4adb7eb227e09228bb486e8aa7261348d64fe554e034ba2d07b438d963ced03f004
+  data.tar.gz: 6c95a9de22724e65fd6afccc731b671aec2853e15bc7948a3ea395ac2735e1b30d0130773a8fccb9d6d714537cc0bd2ed44e3301b1e72de25f9cbab3ca4d4486

data/.github/workflows/gem-push.yml

@@ -13,11 +13,11 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Ruby 2.5
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.5.x
+          ruby-version: '2.5'
 
       - name: Publish to GPR
         run: |

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 /.idea/
 /.bundle/
 /.yardoc

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.12.0] - 2023-02-23
+Changed
+- Added `TaggedLog`
+
 ## [0.11.7] - 2022-10-07
 Changed
 - Added `formatter` to `Notifiers::Log`. Using `format` in initializer is now deprecated.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    luna_park (0.11.6)
+    luna_park (0.12.0)
 
 GEM
   remote: https://rubygems.org/
@@ -69,6 +69,29 @@ GEM
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
     faraday-net_http (1.0.1)
+    ffi (1.15.5)
+    formatador (1.1.0)
+    guard (2.18.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (3.0.1)
+      bundler (>= 2.1, < 3)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.5.0)
+      guard (~> 2.0)
+      rubocop (< 2.0)
     hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.3)
@@ -77,12 +100,20 @@ GEM
       concurrent-ruby (~> 1.0)
     iniparse (1.5.0)
     json (2.3.1)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
     multipart-post (2.1.1)
+    nenv (0.3.0)
     netrc (0.11.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     overcommit (0.55.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -98,6 +129,9 @@ GEM
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.1)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (1.7.1)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -139,10 +173,12 @@ GEM
     sentry-ruby-core (4.2.1)
       concurrent-ruby
       faraday
+    shellany (0.0.1)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.2)
+    thor (1.2.1)
     timecop (0.9.1)
     unf (0.1.4)
       unf_ext
@@ -163,6 +199,10 @@ DEPENDENCIES
   byebug (~> 11.1)
   codecov (~> 0.2)
   dry-validation (~> 1.1)
+  guard
+  guard-bundler
+  guard-rspec
+  guard-rubocop
   i18n (~> 1.8)
   luna_park!
   overcommit (~> 0.55)

data/Guardfile

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+ignore(/
+  bin | public | node_modules | tmp | .git
+/x)
+
+guard :bundler do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+end
+
+group :specs, halt_on_fail: true do
+  guard :rspec,
+        cmd: 'bundle exec rspec --color --format documentation',
+        all_after_pass: false,
+        all_on_start: false,
+        failed_mode: :keep do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+
+    watch(%r{^config/(.+)\.rb$})
+
+    watch(%r{^spec/factories/(.+)\.rb$})
+  end
+
+  guard :rubocop, all_on_start: false, keep_failed: false do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/lib/luna_park/http/response.rb

@@ -113,6 +113,13 @@ module LunaPark
       # @return Hash
       attr_reader :cookies
 
+      # Exception of failed request
+      # Can be raised after call (without bang)
+      # Will be raised after call! (with bang)
+      #
+      # @return LunaPark::Errors::Http
+      attr_reader :exception
+
       # The request that actually initializes the current response
       #
       # @example
@@ -344,7 +351,7 @@ module LunaPark
       end
 
       # @example
-      #   request.to_h # => {
+      #   response.to_h # => {
       #     :code=>200,
       #     :body=>"John Doe, Marry Ann",
       #     :headers=>{}, :cookies=>{},

data/lib/luna_park/http/send.rb

@@ -62,7 +62,7 @@ module LunaPark
       # @return [LunaPark::Http::Response]
       def call!
         call.tap do |response|
-          raise Errors::Http.new(response.status, response: response) unless response.success?
+          raise response.exception unless response.exception.nil?
         end
       end
 
@@ -82,7 +82,7 @@ module LunaPark
       end
 
       def build_original_response(rest_response)
-        Response.new(
+        build_response(
           body: rest_response&.body,
           code: rest_response&.code || 0,
           headers: rest_response&.headers,
@@ -92,11 +92,20 @@ module LunaPark
       end
 
       def build_timeout_response
-        Response.new(code: 408, request: original_request)
+        build_response code: 408, request: original_request
       end
 
+      # ! 503 != ECONNREFUSED (https://www.rfc-editor.org/rfc/rfc7231#section-6.6.4)
       def build_unavailable_response
-        Response.new(code: 503, request: original_request)
+        build_response code: 503, request: original_request
+      end
+
+      def build_response(code:, request:, **opts)
+        Response
+          .new(code: code, request: request, **opts)
+          .tap do |response|
+            response.exception = Errors::Http.new(response.status, response: response) unless response.success?
+          end
       end
     end
   end

data/lib/luna_park/notifiers/tagged_log/options.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: false
+
+require 'luna_park/values/compound'
+
+module LunaPark
+  module Notifiers
+    module TaggedLog
+      class Options < LunaPark::Values::Compound
+        attr_reader :default_tag, :app, :app_env, :instance, :min_lvl
+
+        def initialize(attrs = {})
+          logger_conf_error if config_incorrect?(attrs)
+          set_attributes attrs
+        end
+
+        # @param [Notifiers::Log::Options, Hash] other
+        # @return [Notifiers::Log::Options]
+        def merge!(other)
+          other = self.class.wrap(other)
+
+          self.default_tag ||= other.default_tag
+          self.app ||= other.app
+          self.app_env ||= other.app_env
+          self.instance ||= other.instance
+          self.min_lvl ||= other.min_lvl
+
+          self
+        end
+
+        def merge(other)
+          dup.merge!(other)
+        end
+
+        def to_h
+          {
+            default_tag: default_tag,
+            app: app,
+            app_env: app_env,
+            instance: instance,
+            min_lvl: min_lvl
+          }
+        end
+
+        private
+
+        def config_incorrect?(attrs)
+          return true if attrs.empty?
+
+          !%i[default_tag app app_env instance min_lvl].all? do |required_key|
+            attrs.keys.include?(required_key)
+          end
+        end
+
+        def logger_conf_error
+          raise ArgumentError, 'TaggedLog not properly configured'
+        end
+
+        def default_tag=(val)
+          logger_conf_error if val.nil? || val.empty?
+          logger_conf_error unless val.is_a?(String) || val.is_a?(Symbol)
+          @default_tag = val
+        end
+
+        def app=(val)
+          logger_conf_error if val.nil? || val.empty? || !val.is_a?(String)
+          @app = val
+        end
+
+        def app_env=(val)
+          logger_conf_error if val.nil? || val.empty? || !val.is_a?(String)
+          @app_env = val
+        end
+
+        def instance=(val)
+          logger_conf_error if val.nil? || val.empty? || !val.is_a?(String)
+          @instance = val
+        end
+
+        def min_lvl=(val)
+          logger_conf_error if val.nil? || val.empty?
+          logger_conf_error unless val.is_a?(String) || val.is_a?(Symbol)
+          @min_lvl = val.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/luna_park/notifiers/tagged_log/tagged_formatter.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: false
+
+require 'json'
+
+module LunaPark
+  module Notifiers
+    module TaggedLog
+      class TaggedFormatter < Logger::Formatter
+        attr_accessor :config
+
+        def call(severity, timestamp, _, msg, tags = nil)
+          payload = common_payload(severity, timestamp, tags)
+            .merge(msg_payload(msg[:original_msg]))
+
+          deep_merge!(payload, details_payload(msg[:details]))
+
+          ::JSON.generate(payload) << "\n"
+        end
+
+        private
+
+        def details_payload(hash)
+          details = hash.delete(:details)
+          payload = { details: hash }
+          deep_merge!(payload, { details: details }) unless details.nil?
+          payload
+        end
+
+        def common_payload(severity, timestamp, tags)
+          {
+            tags: [@config.default_tag, tags].join(' ').strip,
+            app: @config.app,
+            app_env: @config.app_env,
+            instance: @config.instance,
+            created_at: timestamp.iso8601(3),
+            ok: !%w[FATAL ERROR].include?(severity)
+          }
+        end
+
+        def msg_payload(msg)
+          case msg
+          when ::Exception
+            error_payload(msg)
+          when Hash
+            hash_payload(msg)
+          else
+            { details: { message: try_to_json(msg) } }
+          end
+        end
+
+        def error_payload(e)
+          error_hash = {
+            class: e.class,
+            message: e.message
+          }
+          error_hash.merge!(backtrace: "\n" + e.backtrace.join("\n") + "\n") if e.backtrace
+          payload = {
+            error: error_hash,
+            ok: false
+          }
+          payload.merge!(details: e.details) if e.respond_to?(:details)
+          payload
+        end
+
+        def hash_payload(msg)
+          details = msg.delete(:details)
+          payload = { details: msg }
+          deep_merge!(payload, { details: details }) unless details.nil?
+          payload
+        end
+
+        def try_to_json(str)
+          ::JSON.parse(str)
+        rescue ::JSON::ParserError
+          str
+        end
+
+        def deep_merge!(hash, other_hash)
+          hash.merge!(other_hash) do |_, this_val, other_val|
+            if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+              deep_merge!(this_val, other_val)
+            else
+              other_val
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/luna_park/notifiers/tagged_log.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: false
+
+require 'logger'
+require 'forwardable'
+require 'luna_park/extensions/severity_levels'
+require 'luna_park/notifiers/tagged_log/options'
+require 'luna_park/notifiers/tagged_log/tagged_formatter'
+
+module LunaPark
+  module Notifiers
+    module TaggedLog
+      include Extensions::SeverityLevels
+      extend Forwardable
+
+      SEVERITY_LEVELS = {
+        unknown: Logger::Severity::UNKNOWN,
+        fatal: Logger::Severity::FATAL,
+        error: Logger::Severity::ERROR,
+        warning: Logger::Severity::WARN,
+        info: Logger::Severity::INFO,
+        debug: Logger::Severity::DEBUG
+      }.freeze
+
+      private_constant :SEVERITY_LEVELS
+
+      def_delegators :formatter, :push_tags, :clear_tags!
+      attr_accessor :output
+
+      module Formatter
+        def call(severity, timestamp, progname, msg)
+          super(severity, timestamp, progname, msg, tags_text)
+        end
+
+        def tagged(*tags)
+          new_tags = push_tags(*tags)
+          yield self
+        ensure
+          pop_tags(new_tags.size)
+        end
+
+        def push_tags(*tags)
+          tags.flatten!
+          tags.reject! { |t| t.respond_to?(:empty?) ? !!t.empty? : !t }
+          current_tags.concat tags
+          tags
+        end
+
+        def pop_tags(size = 1)
+          current_tags.pop(size)
+        end
+
+        def clear_tags!
+          current_tags.clear
+        end
+
+        def current_tags
+          thread_key = @thread_key ||= "tagged_log_tag_store_tags:#{object_id}"
+          Thread.current[thread_key] ||= []
+        end
+
+        def tags_text
+          current_tags.join(' ').strip
+        end
+      end
+
+      def tagged(*tags)
+        if block_given?
+          formatter.tagged(*tags) { yield self }
+        else
+          logger = LunaPark::Notifiers::TaggedLog.new(
+            output, **formatter.config.to_h
+          )
+          logger.push_tags(*formatter.current_tags, *tags)
+          logger
+        end
+      end
+
+      def post(msg, lvl: :error, **details)
+        severity = severity(lvl)
+        message = { original_msg: msg, details: details }
+        add severity, message
+      end
+
+      def severity(lvl)
+        severity = SEVERITY_LEVELS[lvl]
+        raise ArgumentError, "Unknown level #{lvl}" if severity.nil?
+
+        severity
+      end
+
+      def self.new(output = $stdout, **options)
+        config = LunaPark::Notifiers::TaggedLog::Options.wrap(options)
+
+        logger = Logger.new(output)
+        logger.formatter = LunaPark::Notifiers::TaggedLog::TaggedFormatter.new
+        logger.formatter.config = config
+        logger.formatter.extend(Formatter)
+        logger.extend(self)
+        logger.output = output
+        logger.min_lvl = config.min_lvl
+        logger
+      end
+    end
+  end
+end

data/lib/luna_park/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LunaPark
-  VERSION = '0.11.7'
+  VERSION = '0.12.0'
 end

data/luna_park.gemspec

@@ -39,6 +39,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'byebug', '~> 11.1'
   spec.add_development_dependency 'codecov', '~> 0.2'
   spec.add_development_dependency 'dry-validation', '~> 1.1'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-bundler'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'i18n', '~> 1.8'
   spec.add_development_dependency 'overcommit', '~> 0.55'
   spec.add_development_dependency 'pry', '~> 0.13'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: luna_park
 version: !ruby/object:Gem::Version
-  version: 0.11.7
+  version: 0.12.0
 platform: ruby
 authors:
 - Alexander Kudrin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bugsnag
@@ -81,6 +81,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-bundler
+  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: guard-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: guard-rubocop
+  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: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -270,7 +326,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/gem-push.yml"
 - ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".overcommit.yml"
@@ -282,6 +337,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -377,6 +433,9 @@ files:
 - lib/luna_park/notifiers/log.rb
 - lib/luna_park/notifiers/log/formatters.rb
 - lib/luna_park/notifiers/sentry.rb
+- lib/luna_park/notifiers/tagged_log.rb
+- lib/luna_park/notifiers/tagged_log/options.rb
+- lib/luna_park/notifiers/tagged_log/tagged_formatter.rb
 - lib/luna_park/repositories/postgres.rb
 - lib/luna_park/repositories/sequel.rb
 - lib/luna_park/repository.rb

data/.github/gem-push.yml

@@ -1,43 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      packages: write
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby 2.6
-        uses: actions/setup-ruby@v1
-        with:
-          ruby-version: 2.5.x
-
-      - name: Publish to GPR
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-        env:
-          GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
-          OWNER: ${{ github.repository_owner }}
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"