sidekiq_backgrounder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '034091fb511933785bf520755a47ab8be12f4e3aeba2edb456f3af968ce6c29b'
+  data.tar.gz: b0fb911f79a14146738b407253e08cfad6ac3ef57fccb9d36180f3b61a4a3381
+SHA512:
+  metadata.gz: 22ebfe46d4dbd4decd9a0abe27ba2d761ac3633f11a557ba15689ef8a58bc219c08e1b538f06c3ea5854c15a895b9aa07d02bb575231fda469a1c35a151a1c18
+  data.tar.gz: e96f76c547dd0a074d06502abb7d8e2df51ae14c001c17318a3ba9e9c5c076901624ee65a2704f2d01c3612c3205f3a1f781406fd0eb8bbc09bc10f9230cf741

data/.ruby-gemset

@@ -0,0 +1 @@
+sidekiq-backgrounder

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in backgrounder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "awesome_print"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    sidekiq_backgrounder (0.1.0)
+      error_extractor (~> 0.1.0)
+      globalid
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.7.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    awesome_print (1.9.2)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    error_extractor (0.1.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.19.0)
+    rack (3.0.8)
+    rake (13.0.6)
+    redis-client (0.16.0)
+      connection_pool
+    sidekiq (7.1.2)
+      concurrent-ruby (< 2)
+      connection_pool (>= 2.3.0)
+      rack (>= 2.2.4)
+      redis-client (>= 0.14.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  awesome_print
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  sidekiq_backgrounder!
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Daniel P Zepeda
+
+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,105 @@
+# SidekiqBackgrounder
+
+SidekiqBackgrounder is a simple utility that abstracts the creation of a background job into a single class. The 
+worker class takes a GlobalID string or class name, finds or instantiates the object as appropriate, then runs
+a given method on the instance. 
+
+This approach is appropriate when your application has classes that have operations that should work in the background.
+The advantage is that a class's background processing code can be included in the class, rather than spread out 
+over separately defined worker classes. This increases cohesiveness in the codebase. This approach also 
+cuts down on boilerplate code needed to define workers. 
+
+## Installation
+
+### Bundler
+
+    gem "sidekiq_backgrounder", "~> 0.1.0"
+
+### Gem install
+
+    $ gem install sidekiq_backgrounder
+
+### Configuration
+
+There is a configuration generator included in this gem for use in a rails project 
+
+    $ rails generate sidekiq_backgrounder_initializer
+
+If using outside of rails, configuration must be included manually: 
+
+```
+      SidekiqBackgrounder.configure do |config|
+        config.logger = Rails.logger
+        config.queue = "default"
+        config.retry = false
+        config.backtrace = true
+        config.use_honeybadger = false
+        # config.pool = "some_pool_name"
+      end
+```
+
+#### Configuration options 
+
+* `logger` - required. A logging object that responds to `:info` and `:debug`
+* `queue` - Sidekiq queue option, required. A sidekiq queue name to queue a job to. Can be overridden in method call. 
+* `retry` - Sidekiq queue option, required. Whether to retry failed jobs by default. Can be overridden in method call.
+* `backtrace` - Sidekiq queue option, required. Whether to provide a backtrace when a job fails. Can be overridden in method call.
+* `pool` - Sidekiq queue option, optional. A sidekiq pool name to use to point a job to a particular redis shard. 
+   Can be overridden in method call. 
+* `use_honeybadger` - required. If you use Honeybadger, enabling this option will force a Honeybadger notification.
+
+## Usage
+
+SidekiqBackgrounder uses [GlobalID](https://github.com/rails/globalid) to reference models backed a by database table.
+If you are not using ActiveRecord, take a look at the tests to see hints on how to set up a class to use GlobalID 
+manually. If the target instance is a plain ruby object, simply provide the class name.
+
+This invocation will call the `run` method on the instance of the `Mock` class in a Sidekiq job:
+
+    SidekiqBackgrounder.queue.perform_async("gid://sidekiq-backgrounder/Mock/1", "run")
+
+This invocation will call the `run` method on an instance of the `BareMock` class in a Sidekiq job: 
+
+    SidekiqBackgrounder.queue.perform_async("BareMock", "run")
+
+### Sidekiq Queue Options 
+
+All of the default Sidekiq queue options can be overridden in the queue method, an example:
+
+    SidekiqBackgrounder.queue(queue: "priority1", pool: "us-east").perform_async("BareMock", "run")
+
+### Full method signature for perform
+
+    SidekiqBackgrounder.queue.perform_async(
+        "class name | GlobalID", 
+        "method", 
+        method_args = nil,
+        raise_exception = true,
+        exception_handler_method = nil
+    )
+
+* `method_args` - Optionally pass arguments to the method. These must follow the rules of passing method arguments
+                  to Sidekiq jobs. 
+* `raise_exception` - Use this option to force the run not to raise an exception. 
+* `exception_handler_method` - If provided, this method will be called on the object if an exception occurs instead
+                               of the default actions for exceptions. 
+
+## Testing/Debugging 
+
+In case you want to test/debug your invocation directly, call `new` directly on the worker class, skipping the call to
+`queue`:
+
+    SidekiqBackgrounder::Worker.new.perform("Mock", "run")
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/duskhacker/backgrounder.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/generators/sidekiq_backgrounder_initializer_generator.rb

@@ -0,0 +1,15 @@
+class SidekiqBackgrounderInitializerGenerator < Rails::Generators::Base
+  # :logger, :use_honeybadger, :queue, :retry, :backtrace, :pool, :raise_exception
+  def create_initializer_file
+    create_file "config/initializers/sidekiq_backgrounder.rb", <<~RUBY
+      SidekiqBackgrounder.configure do |config|
+        config.logger = Rails.logger
+        config.queue = "default"
+        config.retry = false
+        config.backtrace = true
+        config.use_honeybadger = false
+        # config.pool = "some_pool_name"
+      end
+    RUBY
+  end
+end

data/lib/sidekiq_backgrounder/version.rb

@@ -0,0 +1,3 @@
+module SidekiqBackgrounder
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_backgrounder.rb

@@ -0,0 +1,92 @@
+require "sidekiq_backgrounder/version"
+require "globalid"
+require "sidekiq"
+require "active_support"
+require "error_extractor"
+
+module SidekiqBackgrounder
+  class Error < StandardError; end
+
+  class Worker
+    include Sidekiq::Worker
+
+    attr_reader :object, :method, :gid_str, :exception_handler_method, :logger, :config
+
+    def initialize
+      @config = SidekiqBackgrounder.configuration
+      @logger = config.logger
+    end
+
+    def perform(identifier, method, method_args = nil, raise_exception = true, exception_handler_method = nil)
+      @object = if identifier.match(/gid:/)
+                  GlobalID.new(identifier).find rescue nil
+                else
+                  identifier.constantize.new
+                end
+      logger.debug("#{object.class}: found/instantiated object ")
+
+      if object.blank?
+        logger.error "#{identifier.inspect} not found to call #{method.to_s.inspect} on, exiting..."
+        return
+      end
+      @exception_handler_method = exception_handler_method
+
+      begin
+        logger.info "#{self.class}: running: #{object.class rescue object.inspect}##{method}, " +
+          "method_args: #{method_args.inspect}"
+        object.public_send(method, *method_args)
+      rescue Exception => e
+        if exception_handler_method.present?
+          object.public_send(exception_handler_method, e)
+        else
+          msg = "class: \"#{object.to_gid.to_str rescue object.class.to_s || "N/A"}\", method: \"#{method}\" " +
+            "method_args: #{method_args.inspect} encountered_error: #{extract_errors_with_backtrace(e)}"
+
+          if defined?(:Honeybadger) && config.use_honeybadger
+            Honeybadger.notify(
+              msg,
+              force: true,
+              fingerprint: Digest::SHA1.hexdigest(msg),
+              error_class: "SideKiqBackgrounder::Worker Error",
+            )
+          end
+
+          unless raise_exception
+            logger.error msg
+            return
+          end
+          raise SidekiqBackgrounder::Error.new(msg)
+        end
+      end
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def queue(options = {})
+      c = SidekiqBackgrounder.configuration
+      options.symbolize_keys!
+
+      opts = %i(queue retry backtrace).inject({}) do |m, opt|
+        m[opt] = c.public_send(opt)
+        m[opt] = options[opt] if options.has_key?(opt)
+        m
+      end
+
+      opts[:pool] = c.pool if c.pool.present?
+      opts[:pool] = options[:pool] if options.has_key?(:pool).present?
+
+      Worker.set(opts)
+    end
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :logger, :use_honeybadger, :queue, :retry, :backtrace, :pool
+  end
+end

data/sidekiq_backgrounder.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/sidekiq_backgrounder/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sidekiq_backgrounder"
+  spec.version = SidekiqBackgrounder::VERSION
+  spec.authors = ["Daniel P Zepeda"]
+  spec.email = ["daniel@zepeda.ws"]
+
+  spec.summary = "Simple Abstraction for executing background jobs in Sidekiq"
+  spec.description = "Simple Abstraction for executing background jobs in Sidekiq"
+  spec.homepage = "https://github.com/duskhacker/sidekiq-backgrounder"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sidekiq"
+  spec.add_dependency "error_extractor", "~> 0.1.0"
+  spec.add_dependency "globalid"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_backgrounder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel P Zepeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: error_extractor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: globalid
+  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'
+description: Simple Abstraction for executing background jobs in Sidekiq
+email:
+- daniel@zepeda.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/sidekiq_backgrounder_initializer_generator.rb
+- lib/sidekiq_backgrounder.rb
+- lib/sidekiq_backgrounder/version.rb
+- sidekiq_backgrounder.gemspec
+homepage: https://github.com/duskhacker/sidekiq-backgrounder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/duskhacker/sidekiq-backgrounder
+  source_code_uri: https://github.com/duskhacker/sidekiq-backgrounder
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Simple Abstraction for executing background jobs in Sidekiq
+test_files: []