sidekiq-web_custom 0.2.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Matt Taylor
+
+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/Makefile

@@ -0,0 +1,40 @@
+.PHONY: bash build bundle rspec
+
+APP_NAME?=app
+SIDEKIQ_NAME?=sidekiq
+
+build: #: Build the containers that we'll need
+	docker-compose build --pull
+
+bash: #: Get a bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=development $(APP_NAME) bash
+
+bash_test: #: Get a test bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=test $(APP_NAME) bash
+
+s develop server start: clear_pid kill_sidekiq #: Start the web app server and restart the sidekiq session
+	docker-compose -f docker-compose.yml run --rm --service-ports $(APP_NAME)
+
+c: #: Get a bash prompt on the core container
+	docker-compose run --rm -e RAILS_ENV=development $(APP_NAME) bin/rails c
+
+clear_pid: #: clear pid in the event of a crash
+	rm -f dummy_rails/tmp/pids/server.pid
+
+kill_sidekiq:
+	docker-compose stop $(SIDEKIQ_NAME)
+
+sidekiq: kill_sidekiq # start a detached version of sidekiq
+	docker-compose -f docker-compose.yml run -d --rm $(SIDEKIQ_NAME)
+
+down: #: Bring down the service -- Destroys everything in redis and all containers
+	docker-compose down
+
+clean: #: Clean up stopped/exited containers
+	docker-compose rm -f
+
+add_jobs: #: Randomly add jobs to every queue defined in dummy app
+	docker-compose run --rm $(APP_NAME) bin/rails runner 'lib/load_random_workers.rb'
+
+bundle: #: install gems for Dummy App with
+	docker-compose run --rm $(APP_NAME) bundle install

data/README.md

@@ -0,0 +1,92 @@
+# Sidekiq::WebCustom
+
+Sidekiq::WebCustom adds additional flexibility to your Sidekiq UI.
+- What happens if you do not have a Sidekiq Server?
+- What happens if your Sidekiq Server does not bind to a queue that is ever growing?
+
+This Custom add on to the Sidekiq Web framework allows you to continue to drain your queue's even when Sidekiq is not bound to them
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+Working on Adding a gem source. For now directly pull it from git
+```ruby
+gem 'sidekiq-web_custom', source: 'https://github.com/matt-taylor/sidekiq-web_custom'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sidekiq-web_custom
+
+## Usage
+
+### Configuration
+#### Initializer
+Add an intilizer file to boot SidekiqUI with the expected plugins `config/initializers/sidekiq-web_custom.rb`. When not providing a block, this will use the default configuration values.
+```ruby
+# config/initializers/sidekiq-web_custom.rb
+
+require 'sidekiq/web_custom'
+Sidekiq::WebCustom.configure
+```
+
+#### Options
+```ruby
+require 'sidekiq/web_custom'
+Sidekiq::WebCustom.configure do |config|
+    # Max number to attempt to drain from a queue at a time
+    # Warning: A high number or long runnnig job will potentially block the process for longer
+    config.drain_rate = 10 # default is 10 seconds
+
+    # Max time to allow for execution of draining
+    # If time exceeds this number, the process will violently quit.
+    # Set warning time wisely
+    config.max_execution_time = 6 # default is 6 second
+
+    # Max time before we attempt to send warning to halt execution.
+    # This will prevent the process from trying to attempt work on another job
+    # If a long running job is occuring, this will not stop the job. It will meet a violent end
+    config.warn_execution_time = 5  # default is 5 second
+
+
+    # To redefine a local erb like queues, retries, dead, add a new erb like this
+    params = { queues: "#{absolute_path}/queues.erb" }
+    config.merge(base: :local_erbs, params: params)
+
+    # To add additional actions to a specific local_erb
+    # Note Actions that are not attached to an ERB will raise an error
+    params = {
+        schedule_later: "#{absolute_path}/schedule_later.erb" ,
+        delete: "#{absolute_path}/delete.erb" ,
+    }
+    config.merge(base: :local_erbs, params: params, action_type: :queues)
+end
+```
+
+## Development
+
+After checking out the repo, run `make build && make bundle` to install dependencies. Then, you can bash into a docker container by using `make bash`.
+
+Similarly, a local dummy app is included with the gem. This allows running `make s` to load a local version of the gem in a isolated ENV.
+
+Please note that changes to the code will require a restart of the server.
+Consult the [Makefile](https://github.com/matt-taylor/sidekiq-web_custom/blob/main/Makefile) for additional commands.
+
+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 the created tag, 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/matt-taylor/sidekiq-web_custom. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/matt-taylor/sidekiq-web_custom/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Web::Custom project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/matt-taylor/sidekiq-web_custom/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/all_workers

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+APP_PATH = File.expand_path('../dummy_rails', __dir__)
+ENV['BUNDLE_GEMFILE'] = File.expand_path('../Gemfile', __dir__)
+
+
+if File.exist?(ENV['BUNDLE_GEMFILE'])
+  require 'bundler/setup'
+else
+  raise ArgumentError, "ENV['BUNDLE_GEMFILE'] not found at [#{ENV['BUNDLE_GEMFILE']}]"
+end
+
+require 'sidekiq'
+require 'sidekiq/cli'
+
+def assign_configs!
+  worker_files = Dir["#{APP_PATH}/app/workers/**/*_worker.rb"]
+  bind_queues = worker_files.map { |path| File.basename(path, '.rb') }
+  Sidekiq.configure_server do |config|
+    options = {
+      require: APP_PATH,
+      environment: ENV['RAILS_ENV'] || 'development',
+      queues: bind_queues.select { |c| !c.include?('exclude') },
+      strict: false,
+      concurrency: 10,
+    }
+    config.options = config.options.merge(options)
+  end
+end
+
+def integrate_with_systemd
+  return unless ENV["NOTIFY_SOCKET"]
+
+  Sidekiq.configure_server do |config|
+    Sidekiq.logger.info "Enabling systemd notification integration"
+    require "sidekiq/sd_notify"
+    config.on(:startup) do
+      Sidekiq::SdNotify.ready
+    end
+    config.on(:shutdown) do
+      Sidekiq::SdNotify.stopping
+    end
+    Sidekiq.start_watchdog if Sidekiq::SdNotify.watchdog?
+  end
+end
+
+begin
+  cli = Sidekiq::CLI.instance
+  assign_configs!
+  cli.parse
+  assign_configs!
+
+  integrate_with_systemd
+
+  cli.run
+rescue => e
+  raise e if $DEBUG
+  if Sidekiq.error_handlers.length == 0
+    STDERR.puts e.message
+    STDERR.puts e.backtrace.join("\n")
+  else
+    cli.handle_exception e
+  end
+
+  exit 1
+end
+

data/bin/bundle

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+  module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||=
+      env_var_version || cli_arg_version ||
+        lockfile_version
+  end
+
+  def bundler_requirement
+    return "#{Gem::Requirement.default}.a" unless bundler_version
+
+    bundler_gem_version = Gem::Version.new(bundler_version)
+
+    requirement = bundler_gem_version.approximate_recommendation
+
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
+
+    requirement += ".a" if bundler_gem_version.prerelease?
+
+    requirement
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    activate_bundler
+  end
+
+  def activate_bundler
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_requirement
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/publish

@@ -0,0 +1,40 @@
+#!/bin/bash -e
+
+if [ -z "$GEMFURY_TOKEN" ]; then
+  echo 'Environment variable GEMFURY_TOKEN is not present'
+  exit 1
+fi
+
+
+VERSION=$(bin/rails runner 'Sidekiq::WebCustom.get_version')
+PACKAGE=sidekiq-web_custom-${VERSION}.gem
+
+if [ $(git tag -l "$VERSION") ]; then
+  echo "Pre existing version $VERSION, not tagging."
+  echo "Pre existing version $VERSION, not pushing to gemfury."
+  exit 0
+fi
+
+# Build and publish to Gemfury
+gem build sidekiq-web_custom.gemspec
+FILE=$(pwd)/${PACKAGE}
+echo "Finished building $FILE"
+
+# push to gemfury
+curl --fail -F package=@${FILE} https://${GEMFURY_TOKEN}@push.fury.io/${GEMFURY_USER}/
+echo "Finished Pushing to Gemfury"
+
+# create tag in repo
+git tag -a $VERSION -m "$VERSION"
+git push https://${GITHUB_TOKEN}@github.com/${GITHUB_USER}/sidekiq-web_custom.git $VERSION
+echo "Finished Tagging to git"
+
+
+# send artifacts to git
+SHA=$(git rev-parse HEAD)
+./$GHRLOCATION -soft -t ${GITHUB_TOKEN} -u ${GITHUB_USER} -r sidekiq-web_custom -c ${SHA} ${VERSION} *.gem
+
+echo "Finished Pushing artificat to Git"
+
+# start fresh
+rm sidekiq-web_custom.gemspec

data/bin/publish_git

@@ -0,0 +1,38 @@
+#!/bin/bash -e
+
+GEM_NAME="sidekiq-web_custom"
+if [ -z "$GITHUB_TOKEN" ]; then
+  echo 'Environment variable GITHUB_TOKEN is not present'
+  exit 1
+fi
+
+if [ -z "$GITHUB_USER" ]; then
+  echo 'Environment variable GITHUB_USER is not present'
+  exit 1
+fi
+
+
+VERSION=$(bin/rails runner 'Sidekiq::WebCustom.get_version')
+PACKAGE=${GEM_NAME}-${VERSION}.gem
+
+if [ $(git tag -l "$VERSION") ]; then
+  echo "Pre existing version $VERSION, not tagging."
+  exit 0
+fi
+
+gem build ${GEM_NAME}.gemspec
+FILE=$(pwd)/${PACKAGE}
+echo "Finished building $FILE"
+
+# create tag in repo
+git tag -a $VERSION -m "$VERSION"
+git push https://${GITHUB_TOKEN}@github.com/${GITHUB_USER}/${GEM_NAME}.git $VERSION
+echo "Finished Tagging to git"
+
+
+# send artifacts to git
+SHA=$(git rev-parse HEAD)
+./$GHRLOCATION -soft -t ${GITHUB_TOKEN} -u ${GITHUB_USER} -r timeoutable -c ${SHA} ${VERSION} *.gem
+echo "Finished Pushing artificat to Git"
+
+rm $

data/bin/publish_ruby_gems

@@ -0,0 +1,22 @@
+#!/bin/bash -e
+
+BASE="sidekiq-web_custom"
+if [ -z "$GEM_HOST_API_KEY" ]; then
+  echo 'Environment variable GEM_HOST_API_KEY is not present'
+  exit 1
+fi
+
+VERSION=$(bin/rails runner 'Sidekiq::WebCustom.get_version')
+PACKAGE=${BASE}-${VERSION}.gem
+
+# Build Gem
+gem build ${BASE}.gemspec
+FILE=$(pwd)/${PACKAGE}
+echo "Finished building $FILE"
+
+# push to Ruby Gems
+gem push ${FILE}
+
+echo "Finished pushing to Gemfury"
+
+rm ${FILE}