faktory_worker_ruby 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d427c1c0dc267c3debcf7fd725fab9a628f7d0d
-  data.tar.gz: 92c6b2099292bc46e2eaf22ba3be5c9f3dadf6b0
+  metadata.gz: 5ffc1c6d5392fd64f4463ae4a47972f7d2c13ebc
+  data.tar.gz: cc1e0294bc5c333f7ce684f112ee1182e20d2095
 SHA512:
-  metadata.gz: e856cbcb98527d2b38c000d87cfbced657f42b7956a7090014946c9131b4771f239683df586c084ad17b4e2f07f2e7f9560c62f7f438db99c523e276136540a6
-  data.tar.gz: 44ce04a5b7346b1e8965b917ac9ecaad179936b62fb7dc4107e1cd9fe2155da0ff549c2ef91551c5f18b75daeec5f87a5aa8b38b4b628c3ab9ef4ba0147eb776
+  metadata.gz: 9f2a3b5f59d0a50c77f0f22ec86f291289762ba5e27dc012fa9cce34807883aee616b7ca9b7a937139b67137725f450c0e7fc504909f0a84136ebd4b6e67586e
+  data.tar.gz: 7ef1fd93ff1d803bb7d895d63749a3deb9cd4fe4000936df5b8e1facfca884e22e439574979b821972936b16b1ea15ef31f97c3db306b90b4d7514ea214d1437

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: required
+
+language: ruby
+
+services:
+  - docker
+
+before_install:
+  - docker pull contribsys/faktory:latest
+  - docker run -d -p 127.0.0.1:7419:7419 -p 127.0.0.1:7420:7420 contribsys/faktory:latest /faktory -b :7419 -w :7420
+  - docker ps -a

data/Changes.md

@@ -1,10 +1,13 @@
 # Changes
 
-## 0.7.1
+## 0.8.0
+
+- Add `-l LABEL` argument for adding labels to a process [#27, jpwinans]
+- Support the quiet and shutdown heartbeat signals from the server [#28]
 
-- Add an ActiveJob adapter for Faktory.
+## 0.7.1
 
-  [#17, jagthedrummer]
+- Add an ActiveJob adapter for FWR. [#17, jagthedrummer]
 
 ## 0.7.0
 

data/Gemfile.lock

@@ -1,29 +1,30 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (0.7.1)
+    faktory_worker_ruby (0.8.0)
       connection_pool (~> 2.2, >= 2.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (5.1.5)
-      activesupport (= 5.1.5)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
       globalid (>= 0.3.6)
-    activesupport (5.1.5)
+    activesupport (5.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     concurrent-ruby (1.0.5)
-    connection_pool (2.2.1)
+    connection_pool (2.2.2)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
-    i18n (0.9.5)
+    i18n (1.1.0)
       concurrent-ruby (~> 1.0)
-    minitest (5.10.3)
-    minitest-hooks (1.4.2)
-    rake (12.1.0)
+    minitest (5.11.3)
+    minitest-hooks (1.5.0)
+      minitest (> 5.3)
+    rake (12.3.1)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
@@ -39,4 +40,4 @@ DEPENDENCIES
   rake (~> 12)
 
 BUNDLED WITH
-   1.16.0
+   1.16.3

data/README.md

@@ -1,5 +1,7 @@
 # faktory\_worker\_ruby
 
+![travis](https://travis-ci.org/contribsys/faktory_worker_ruby.svg?branch=master)
+
 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).
 

data/lib/active_job/queue_adapters/faktory_adapter.rb

@@ -11,34 +11,29 @@ module ActiveJob
     #   Rails.application.config.active_job.queue_adapter = :faktory
     class FaktoryAdapter
       def enqueue(job) #:nodoc:
-        jid = SecureRandom.hex(12)
-        job.provider_job_id = jid
-        # Faktory::Client does not support symbols as keys
-        Faktory::Client.new.push \
-          "jid"     => jid,
-          "jobtype" => JobWrapper,
-          "custom"  => {
-            "wrapped" => job.class.to_s,
-          },
-          "priority" => job.priority,
-          "queue"   => job.queue_name,
-          "args"    => [ job.serialize ]
+        enqueue_at(job, nil)
       end
 
       def enqueue_at(job, timestamp) #:nodoc:
         jid = SecureRandom.hex(12)
         job.provider_job_id = jid
-        # Faktory::Client does not support symbols as keys
-        Faktory::Client.new.push \
+        hash = {
           "jid"     => jid,
-          "jobtype" => JobWrapper,
+          "jobtype" => JobWrapper.to_s,
           "custom"  => {
-            "wrapped" => job.class.to_s
+            "wrapped" => job.class.to_s,
           },
-          "priority" => job.priority,
           "queue"   => job.queue_name,
           "args"    => [ job.serialize ],
-          "at"      => Time.at(timestamp).utc.to_datetime.rfc3339(9)
+        }
+        opts = job.faktory_options_hash.dup
+        hash["at"] = Time.at(timestamp).utc.to_datetime.rfc3339(9) if timestamp
+        if opts.size > 0
+          hash["retry"] = opts.delete("retry") if opts.has_key?("retry")
+          hash["custom"] = opts.merge(hash["custom"])
+        end
+        # Faktory::Client does not support symbols as keys
+        Faktory::Client.new.push(hash)
       end
 
       class JobWrapper #:nodoc:
@@ -50,4 +45,13 @@ module ActiveJob
       end
     end
   end
+
+  class Base
+    class_attribute :faktory_options_hash
+    self.faktory_options_hash = {}
+
+    def self.faktory_options(hsh)
+      self.faktory_options_hash = self.faktory_options_hash.stringify_keys.merge(hsh.stringify_keys)
+    end
+  end
 end

data/lib/faktory/cli.rb

@@ -235,6 +235,10 @@ module Faktory
           opts[:tag] = arg
         end
 
+        o.on '-l', '--label LABEL', "Process label to use in Faktory UI" do |arg|
+          (opts[:labels] ||= []) << arg
+        end
+
         o.on "-q", "--queue QUEUE[,WEIGHT]", "Queues to process with optional weights" do |arg|
           queue, weight = arg.split(",")
           parse_queue opts, queue, weight

data/lib/faktory/client.rb

@@ -1,6 +1,7 @@
 require 'socket'
 require 'json'
 require 'uri'
+require 'digest'
 require 'securerandom'
 
 module Faktory
@@ -148,7 +149,7 @@ module Faktory
         "wid": @@random_process_wid,
         "hostname": Socket.gethostname,
         "pid": $$,
-        "labels": ["ruby-#{RUBY_VERSION}"],
+        "labels": Faktory.options[:labels] || ["ruby-#{RUBY_VERSION}"],
         "v": 2,
       }
 

data/lib/faktory/launcher.rb

@@ -55,7 +55,17 @@ module Faktory
         $0 = PROCTITLES.map {|p| p.call }.join(" ")
 
         begin
-          Faktory.server {|c| c.beat }
+          result = Faktory.server {|c| c.beat }
+          case result
+          when "OK"
+            # all good
+          when "terminate"
+            ::Process.kill('TERM', $$)
+          when "quiet"
+            ::Process.kill('TSTP', $$)
+          else
+            Faktory.logger.warn "Got unexpected BEAT: #{result}"
+          end
         rescue => ex
           # best effort, try again in a few secs
         end

data/lib/faktory/logging.rb

@@ -29,8 +29,8 @@ module Faktory
     def self.job_hash_context(job_hash)
       # If we're using a wrapper class, like ActiveJob, use the "wrapped"
       # attribute to expose the underlying thing.
-      klass = job_hash['wrapped'.freeze] || job_hash["jobtype".freeze]
-      "#{klass} JID-#{job_hash['jid'.freeze]}"
+      klass = job_hash['custom']['wrapped'] || job_hash["jobtype"]
+      "#{klass} JID-#{job_hash['jid']}"
     end
 
     def self.with_job_hash_context(job_hash, &block)

data/lib/faktory/middleware/i18n.rb

@@ -19,10 +19,8 @@ module Faktory::Middleware::I18n
   # Pull the msg locale out and set the current thread to use it.
   class Worker
     def call(jobinst, payload)
-      I18n.locale = payload.dig("custom", "locale") || I18n.default_locale
-      yield
-    ensure
-      I18n.locale = I18n.default_locale
+      locale = payload.dig("custom", "locale") || I18n.default_locale
+      I18n.with_locale(locale) { yield }
     end
   end
 end

data/lib/faktory/rails.rb

@@ -20,6 +20,10 @@ module Faktory
       # None of this matters on the client-side, only within the Faktory executor itself.
       #
       Faktory.configure_worker do |_|
+        if ::Rails::VERSION::MAJOR < 5
+          raise "Your current version of Rails, #{::Rails::VERSION::STRING}, is not supported"
+        end
+        
         Faktory.options[:reloader] = Faktory::Rails::Reloader.new
       end
     end
@@ -40,4 +44,11 @@ module Faktory
       end
     end
   end if defined?(::Rails)
+
+  if defined?(::Rails) && ::Rails::VERSION::MAJOR < 5
+    $stderr.puts("**************************************************")
+    $stderr.puts("🚫 ERROR: Faktory Worker does not support Rails versions under 5.x - please ensure your workers are updated")
+    $stderr.puts("**************************************************")
+    $stderr.puts("")
+  end
 end

data/lib/faktory/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Faktory
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Mike Perham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -95,6 +95,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Changes.md
 - Gemfile
 - Gemfile.lock
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby worker for Faktory