faktory_worker_ruby 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 601942270c2185c3d6950e04d9cffcfa03256689
+  data.tar.gz: 51254887f57c7338d086ff07a7e76e9b511fcc53
+SHA512:
+  metadata.gz: 8f22aa99ebfa7d4e79d4b3157561cc14716355716e257c05252539b2ef23ce811f7531d2802722629905427a83e6670c934d8eab977bde9e8bc93737db65ca46
+  data.tar.gz: b0e723333032496197fd07a5a90441836885d2fb408860e0292a354abbb89d043aca27cfba4ad4d592d1225def1a5e24e7ff747405834cd5448ad417cd04bd1b

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    faktory_worker_ruby (0.5.0)
+      connection_pool (~> 2.2, >= 2.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.2.1)
+    minitest (5.10.3)
+    minitest-hooks (1.4.2)
+    rake (12.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faktory_worker_ruby!
+  minitest (~> 5)
+  minitest-hooks
+  rake (~> 12)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,91 @@
+# faktory\_worker\_ruby
+
+Faktory\_worker\_ruby is the official Ruby client and worker process for the
+Faktory background job server.  It is similar to [Sidekiq](http://sidekiq.org).
+
+```
+                       +--------------------+
+                       |                    |
+                       |     Faktory        |
+                       |     Server         |
+        +---------->>>>|                    +>>>>--------+
+        |              |                    |            |
+        |              |                    |            |
+        |              +--------------------+            |
++-----------------+                            +-------------------+
+|                 |                            |                   |
+|    Client       |                            |     Worker        |
+|    pushes       |                            |     pulls         |
+|     jobs        |                            |      jobs         |
+|                 |                            |                   |
+|                 |                            |                   |
++-----------------+                            +-------------------+
+```
+
+* Client - an API any process can use to push jobs to the Faktory server.
+* Worker - a process that pulls jobs from Faktory and executes them.
+* Server - the Faktory daemon which stores background jobs in
+  queues to be processed by Workers.
+
+This gem contains only the client and worker parts.  The
+server part is [here](https://github.com/contribsys/faktory/)
+
+## Installation
+
+First, make sure you have the [Faktory server](https://github.com/contribsys/faktory/#installation) installed.
+
+Next, install this gem:
+
+    gem install faktory_worker_ruby
+
+## Your First Job
+
+Your Jobs should include the Faktory::Job module and have a `perform`
+method.
+
+```ruby
+class SomeJob
+  include Faktory::Job
+
+  def perform(...)
+  end
+end
+```
+
+then just call `SomeJob.perform_async(...)` to create a job.
+
+Arguments to the perform method must be simple types supported
+by JSON, exactly like Sidekiq.
+
+## Start the worker
+
+Once you've created a job, you need to start a Worker process to execute
+those jobs.
+
+```ruby
+bundle exec faktory-worker
+```
+
+## Why not Sidekiq?
+
+Sidekiq is awesome; it's stable and useful. It suffers from two design limitations:
+
+1. Sidekiq uses Redis and Redis is dumb datastore, all Sidekiq features are
+   implemented in Ruby and have to travel over the network to access data.
+2. Because of (1), Sidekiq is limited to Ruby.  You can't execute jobs
+   with, e.g., Python and get the same Sidekiq features.
+
+Instead Faktory is a "smart" server that implements all major features
+within the server itself; the worker process can be dumb and rely on
+the server for job retries, reservation, Web UI, etc.  This also means
+we can create workers in any programming language.
+
+If your organization is 100% Ruby, Sidekiq will serve you well.  If your
+organization is polyglot, Faktory will be a better fit.
+
+faktory\_worker\_ruby tries to be Sidekiq API compatible where possible (and
+PRs to improve this are very welcome).
+
+## Author
+
+Mike Perham, @mperham, mike @ contribsys.com

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs += ["test"]
+  test.warning = true
+  test.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/bin/faktory-worker

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# Quiet some warnings we see when running in warning mode:
+# RUBYOPT=-w bundle exec faktory
+$TESTING = false
+
+require_relative '../lib/faktory/cli'
+
+begin
+  cli = Faktory::CLI.instance
+  cli.parse
+  cli.run
+rescue => e
+  raise e if $DEBUG
+  STDERR.puts e.message
+  STDERR.puts e.backtrace.join("\n")
+  exit 1
+end

data/faktory_worker_ruby.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/faktory/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "faktory_worker_ruby"
+  gem.authors       = ["Mike Perham"]
+  gem.email         = ["mike@contribsys.com"]
+  gem.summary       = "Ruby worker for Faktory"
+  gem.description   = "Ruby worker for Faktory."
+  gem.homepage      = "http://contribsys.com"
+  gem.license       = "LGPL-3.0"
+
+  gem.executables   = ['faktory-worker']
+  gem.files         = `git ls-files | grep -Ev '^(test|myapp|examples)'`.split("\n")
+  gem.test_files    = []
+  gem.require_paths = ["lib"]
+  gem.version       = Faktory::VERSION
+  gem.required_ruby_version = ">= 2.2.2"
+
+  gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.1"
+  gem.add_development_dependency      'minitest', '~> 5'
+  gem.add_development_dependency      'minitest-hooks'
+  gem.add_development_dependency      'rake', '~> 12'
+end

data/lib/faktory.rb

@@ -0,0 +1,166 @@
+# encoding: utf-8
+# frozen_string_literal: true
+require 'faktory/version'
+
+require 'faktory/logging'
+require 'faktory/client'
+require 'faktory/middleware/chain'
+require 'faktory/job'
+require 'faktory/connection'
+
+require 'json'
+
+module Faktory
+  NAME = 'Faktory'.freeze
+  LICENSE = 'See LICENSE and the LGPL-3.0 for licensing details.'
+
+  DEFAULTS = {
+    queues: ['default'],
+    concurrency: 10,
+    require: '.',
+    environment: 'development',
+    # As of 2017, Heroku's process timeout is 30 seconds.
+    # After 30 seconds, processes are KILLed so assume 25
+    # seconds to gracefully shutdown and 5 seconds to hard
+    # shutdown.
+    timeout: 25,
+    error_handlers: [],
+    lifecycle_events: {
+      startup: [],
+      quiet: [],
+      shutdown: [],
+    },
+    reloader: proc { |&block| block.call },
+  }
+
+  DEFAULT_JOB_OPTIONS = {
+    'retry' => 25,
+    'queue' => 'default'
+  }
+
+  def self.options
+    @options ||= DEFAULTS.dup
+  end
+  def self.options=(opts)
+    @options = opts
+  end
+
+  ##
+  # Configuration for Faktory executor, use like:
+  #
+  #   Faktory.configure_worker do |config|
+  #     config.worker_middleware do |chain|
+  #       chain.add MyServerHook
+  #     end
+  #   end
+  def self.configure_worker
+    yield self if worker?
+  end
+
+  ##
+  # Configuration for Faktory client, use like:
+  #
+  #   Faktory.configure_client do |config|
+  #     config.faktory = { :size => 1, :url => 'myhost:7419' }
+  #   end
+  def self.configure_client
+    yield self unless worker?
+  end
+
+  def self.worker?
+    defined?(Faktory::CLI)
+  end
+
+  def self.server
+    raise ArgumentError, "requires a block" unless block_given?
+    server_pool.with do |conn|
+      yield conn
+    end
+  end
+
+  def self.server_pool
+    @pool ||= Faktory::Connection.create
+  end
+
+  def self.faktory=(hash)
+    @pool = Faktory::Connection.create(hash)
+  end
+
+  def self.client_middleware
+    @client_chain ||= Middleware::Chain.new
+    yield @client_chain if block_given?
+    @client_chain
+  end
+
+  def self.worker_middleware
+    @worker_chain ||= Middleware::Chain.new
+    yield @worker_chain if block_given?
+    @worker_chain
+  end
+
+  def self.default_job_options=(hash)
+    # stringify
+    @default_job_options = default_job_options.merge(Hash[hash.map{|k, v| [k.to_s, v]}])
+  end
+  def self.default_job_options
+    defined?(@default_job_options) ? @default_job_options : DEFAULT_JOB_OPTIONS
+  end
+
+  def self.load_json(string)
+    JSON.parse(string)
+  end
+  def self.dump_json(object)
+    JSON.generate(object)
+  end
+
+  def self.logger
+    Faktory::Logging.logger
+  end
+  def self.logger=(log)
+    Faktory::Logging.logger = log
+  end
+
+  def self.💃🕺(io = $stdout)
+    colors = (31..37).to_a
+    sz = colors.size
+    "DANCE MODE ACTIVATED".chars.each_with_index do |chr, idx|
+      io.print("\e[#{colors[rand(sz)]};1m#{chr}")
+    end
+    io.print("\e[0m\n")
+  end
+
+  # Register a proc to handle any error which occurs within the Faktory process.
+  #
+  #   Faktory.configure_worker do |config|
+  #     config.error_handlers << proc {|ex,ctx_hash| MyErrorService.notify(ex, ctx_hash) }
+  #   end
+  #
+  # The default error handler logs errors to Faktory.logger.
+  def self.error_handlers
+    self.options[:error_handlers]
+  end
+
+  # Register a block to run at a point in the Faktory lifecycle.
+  # :startup, :quiet or :shutdown are valid events.
+  #
+  #   Faktory.configure_worker do |config|
+  #     config.on(:shutdown) do
+  #       puts "Goodbye cruel world!"
+  #     end
+  #   end
+  def self.on(event, &block)
+    raise ArgumentError, "Symbols only please: #{event}" unless event.is_a?(Symbol)
+    raise ArgumentError, "Invalid event name: #{event}" unless options[:lifecycle_events].key?(event)
+    options[:lifecycle_events][event] << block
+  end
+
+  # We are shutting down Faktory but what about workers that
+  # are working on some long job?  This error is
+  # raised in workers that have not finished within the hard
+  # timeout limit.  This is needed to rollback db transactions,
+  # otherwise Ruby's Thread#kill will commit.
+  # DO NOT RESCUE THIS ERROR IN YOUR WORKERS
+  class Shutdown < Interrupt; end
+end
+
+require 'faktory/rails' if defined?(::Rails::Engine)