sidekiq-haron 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a9131278d68746096c17ea16bd644f4dd043afcae8d20904e960a0d6d7cb7bc
+  data.tar.gz: b5894f6abb499eb92aaac11ab7c7b1acd62f7da1ac1f42681a8693b6fbc64572
+SHA512:
+  metadata.gz: cd25ecc4856efaa674bf4855cdf417ce66c173d8d520ca94d63c9ea9d343d4e0947db93b5e2300c63b84ee985bf8877ba74c6eb1affc5b23afbe6a5b7e04c853
+  data.tar.gz: 5ec609ea9aaec81c856ea477956ec3df8f73a99b7885d622d4a501bc97482aa5dd528235a411741ac5b0092ec7b162caf8bc7df38834d3768af63a177712f466

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-haron.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Serg F
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+# Sidekiq::Haron
+
+Transfer some metadata to sidekiq job, can tag sidekiq logs and add logging job args. Example request_id or other request info.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-haron'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-haron
+
+## Usage
+
+Аdd to project class  inheriting from `Sidekiq::Haron::Transmitter` like this:
+
+```ruby
+class HaronTransmitter < Sidekiq::Haron::Transmitter
+
+  def saved_data *args
+    {
+      request_id: Current.request_id,
+      parent_request_id: Current.parent_request_id
+    }
+  end
+
+  def load_data hash
+    Current.request_id = hash['request_id'].presence || SecureRandom.hex
+    Current.parent_request_id = hash['parent_request_id']
+  end
+
+  def tags
+    [Current.parent_request_id]
+  end
+
+end
+```
+
+Аdd to `config/initializers/sidekiq.rb`:
+
+```ruby
+Sidekiq::Haron.install(HaronTransmitter)
+```
+
+Now all your sidekiq log have `Current.parent_request_id` value as tag and log job args too:
+
+```
+2020-01-14T14:22:09.035Z  TestWorker JID-940645f14b345b3b4031d1cc I: [4f445354] with args [1, {"q"=>2}]
+2020-01-14T14:22:09.035Z  TestWorker JID-940645f14b345b3b4031d1cc I: [4f445354] start
+2020-01-14T14:22:09.041Z  TestWorker JID-940645f14b345b3b4031d1cc I: [4f445354] done: 0.006 sec
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Rnd-Soft/sidekiq-haron.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tttt"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/haron.rb

@@ -0,0 +1,59 @@
+require 'sidekiq'
+require 'sidekiq/haron/formatter'
+require 'sidekiq/haron/storage'
+require 'sidekiq/haron/transmitter'
+require 'sidekiq/haron/job_logger'
+require 'sidekiq/haron/exception_logger'
+require 'sidekiq/haron/client_middleware'
+require 'sidekiq/haron/server_middleware'
+require 'sidekiq/haron/version'
+
+module Sidekiq
+  module Haron
+
+    def self.transmitter
+      Sidekiq.options[:transmitter]
+    end
+
+    def self.transmitter= v
+      Sidekiq.options[:transmitter] = v
+    end
+
+    def self.install transmitter_class
+      Sidekiq::Haron.transmitter = transmitter_class.new
+      set_loggers
+      Sidekiq.configure_server do |c|
+        configure_client_middleware(c)
+        configure_server_middleware(c)
+      end
+      Sidekiq.configure_client do |c|
+        configure_client_middleware(c)
+      end
+    end
+
+    def self.set_loggers
+      Sidekiq.options[:job_logger] = Sidekiq::Haron::JobLogger
+      Sidekiq.logger.formatter = Sidekiq::Haron::Formatter.new
+      Sidekiq.logger = ActiveSupport::TaggedLogging.new(Sidekiq.logger)
+      Sidekiq::Haron::ExceptionLogger.install
+    end
+
+    def self.configure_client_middleware(sidekiq_config)
+      sidekiq_config.client_middleware do |chain|
+        chain.add Sidekiq::Haron::ClientMiddleware
+      end
+    end
+
+    def self.configure_server_middleware(sidekiq_config)
+      sidekiq_config.server_middleware do |chain|
+        if Sidekiq.major_version < 5
+          chain.insert_after Sidekiq::Middleware::Server::Logging,
+            Sidekiq::Haron::ServerMiddleware
+        else
+          chain.add Sidekiq::Haron::ServerMiddleware
+        end
+      end
+    end
+
+  end
+end

data/lib/sidekiq/haron/client_middleware.rb

@@ -0,0 +1,14 @@
+module Sidekiq
+  module Haron
+    class ClientMiddleware
+
+      def call(worker_class, msg, queue, redis_pool=nil)
+        if msg['retry_count'].blank? # don't store on retry
+          Sidekiq::Haron.transmitter.save(worker_class, msg, queue, redis_pool)
+        end
+        yield
+      end
+
+    end
+  end
+end

data/lib/sidekiq/haron/exception_logger.rb

@@ -0,0 +1,19 @@
+require 'sidekiq/exception_handler'
+module Sidekiq
+  module Haron
+    class ExceptionLogger < Sidekiq::ExceptionHandler::Logger
+
+      def self.install
+        Sidekiq.error_handlers.delete_if{|eh| eh.is_a? Sidekiq::ExceptionHandler::Logger }
+        Sidekiq.error_handlers.unshift Sidekiq::Haron::ExceptionLogger.new
+      end
+
+      def call(ex, ctxHash)
+        jid = ctxHash.present? && ctxHash[:job]['jid']
+        Sidekiq::Haron.transmitter.load(jid) if jid.present?
+        Sidekiq::Haron.transmitter.tagged{ super(ex, ctxHash) }
+      end
+
+    end
+  end
+end

data/lib/sidekiq/haron/formatter.rb

@@ -0,0 +1,16 @@
+module Sidekiq
+  module Haron
+    class Formatter < Sidekiq::Logging::Pretty
+  
+      def call(severity, time, program_name, message)
+        result = "#{context} #{severity.to_s[0]}: #{message}\n"
+        if ENV['RAILS_LOG_TO_STDOUT'].present?
+          result
+        else
+          "#{time.utc.iso8601(3)} #{result}"
+        end
+      end
+      
+    end
+  end
+end

data/lib/sidekiq/haron/job_logger.rb

@@ -0,0 +1,16 @@
+require 'sidekiq/job_logger'
+module Sidekiq
+  module Haron
+    class JobLogger < Sidekiq::JobLogger
+
+      def call(item, queue)
+        Sidekiq::Haron.transmitter.load(item['jid'])
+        Sidekiq::Haron.transmitter.tagged do 
+          Sidekiq.logger.info("with args #{item['args'].inspect}")
+          super
+        end
+      end
+      
+    end
+  end
+end

data/lib/sidekiq/haron/server_middleware.rb

@@ -0,0 +1,12 @@
+module Sidekiq
+  module Haron
+    class ServerMiddleware
+
+      def call(worker, msg, queue)
+        Sidekiq::Haron.transmitter.load(msg['jid'])
+        yield
+      end
+
+    end
+  end
+end

data/lib/sidekiq/haron/storage.rb

@@ -0,0 +1,43 @@
+module Sidekiq
+  module Haron
+    module Storage
+
+      DEFAULT_EXPIRY = 30 * 24 * 60 * 60 # 30 days
+
+      protected
+
+      def store_for_id(id, data, redis_pool=nil)
+        redis_connection(redis_pool) do |conn|
+          conn.multi do
+            conn.hmset  key(id), *(data.to_a.flatten(1))
+            conn.expire key(id), DEFAULT_EXPIRY
+          end[0]
+        end
+      end
+
+      def read_for_id(id)
+        Sidekiq.redis do |conn|
+          conn.hgetall(key(id))
+        end
+      end
+
+      private
+
+      def redis_connection(redis_pool=nil)
+        if redis_pool
+          redis_pool.with do |conn|
+            yield conn
+          end
+        else
+          Sidekiq.redis do |conn|
+            yield conn
+          end
+        end
+      end
+
+      def key(id)
+        "sidekiq:haron:#{id}"
+      end
+    end
+  end
+end

data/lib/sidekiq/haron/transmitter.rb

@@ -0,0 +1,43 @@
+module Sidekiq
+  module Haron
+    class Transmitter
+      include Sidekiq::Haron::Storage
+
+      def save worker_class, msg, queue, redis_pool
+        data = saved_data(worker_class, msg, queue)
+        store_for_id msg['jid'], data, redis_pool
+      end
+
+      def load jid
+        load_data read_for_id(jid)
+      rescue => e
+        Sidekiq.logger.error "loading data error - #{e.to_s}"
+        {}
+      end
+
+      def tagged
+        Rails.logger.tagged(tags) do 
+          Sidekiq.logger.tagged(tags) do 
+            yield
+          end
+        end
+
+      end
+
+      def tags
+        []
+      end
+
+      private
+
+      def saved_data
+        raise NotImplemented
+      end
+
+      def load_data
+        raise NotImplemented
+      end
+
+    end
+  end
+end

data/lib/sidekiq/haron/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Haron
+    VERSION = "0.1.2"
+  end
+end

data/sidekiq-haron.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/haron/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-haron"
+  spec.version       = Sidekiq::Haron::VERSION
+  spec.authors       = ["Serg F"]
+  spec.email         = ["wolferingys@gmail.com"]
+
+  spec.summary       = %q{Transfer some data to sidekiq job and can tag sidekiq logs}
+  spec.description   = %q{Transfer some metadata to sidekiq job, can tag sidekiq logs and add logging job args}
+  spec.homepage      = "https://github.com/Rnd-Soft/sidekiq-haron"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq", "~> 5.2"
+  spec.add_dependency "rails"
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-haron
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Serg F
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+description: Transfer some metadata to sidekiq job, can tag sidekiq logs and add logging
+  job args
+email:
+- wolferingys@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/haron.rb
+- lib/sidekiq/haron/client_middleware.rb
+- lib/sidekiq/haron/exception_logger.rb
+- lib/sidekiq/haron/formatter.rb
+- lib/sidekiq/haron/job_logger.rb
+- lib/sidekiq/haron/server_middleware.rb
+- lib/sidekiq/haron/storage.rb
+- lib/sidekiq/haron/transmitter.rb
+- lib/sidekiq/haron/version.rb
+- sidekiq-haron.gemspec
+homepage: https://github.com/Rnd-Soft/sidekiq-haron
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Transfer some data to sidekiq job and can tag sidekiq logs
+test_files: []