faktory_worker_ruby 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7739220174ff556abdf6a357cbcd260b6290c732628b27c8dc01ad00be727dd9
-  data.tar.gz: 3c87db6e71078419a761c6b34dbdcdd3914d5551f4b42f04140a1621c6568b50
+  metadata.gz: 8ba3a7a6dbf71b034a2e9a209830f3049132c72b12105262b6ce971df9e602e6
+  data.tar.gz: f0adb0757fdaed227ec36d13786dadf7a9e39b6854589f4c25e65a8c9101cf86
 SHA512:
-  metadata.gz: b2fc14441abfab58c7cde5401e42adcfe3bb558cd5d5dbf8f6a5db6b176cf2b1d9057370dd0b1daf3d3ca629bb829495bc53167e56e02f0543ec4f89556792ba
-  data.tar.gz: 12b5d2fc13701e3c221b9ef8301bdb5b43806b1058336298393b66fc3f8020eb01d9569a43884a9f789a5df754bd24e987a340a74f12f055ae71a244d0d0763d
+  metadata.gz: 89471fb1dfd8624f9b562c773909378b4c40a4b52fd7dd198b7d2808199b2057a760b2cbcd919b8aa4494569979092c53762dd24e57be6ecfe7143a97540521d
+  data.tar.gz: 734b8145a57e435ecac307006723608998958bd9952a194c804fe033681579530d0ccc84ed591ffe8cfbbc5393abe4bd6b95045c49d02ceb3c87f742f6027905

data/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.5, 2.6, 2.7, '3.0']
+    runs-on: ubuntu-latest
+    services:
+      faktory:
+        image: contribsys/faktory:latest
+        ports:
+            - 7419:7419
+            - 7420:7420
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle install
+      - run: bundle exec rake

data/Changes.md

@@ -1,5 +1,23 @@
 # Changes
 
+## 1.1.1
+
+- Fix OpenSSL error [#59]
+
+## 1.1.0
+
+- Send process RSS to Faktory for /Busy page
+- Implement QUEUE PAUSE/RESUME client commands
+- Fix broken `complete` callback with batches
+
+## 1.0.3
+
+- Fix corruption in `custom` hash elements [#55]
+
+## 1.0.2
+
+- Fix "batch not open" errors
+
 ## 1.0.1
 
 - Run client middleware before pushing a job to Faktory [#48]

data/Gemfile.lock

@@ -1,40 +1,41 @@
 PATH
   remote: .
   specs:
-    faktory_worker_ruby (1.0.1)
+    faktory_worker_ruby (1.1.0)
       connection_pool (~> 2.2, >= 2.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activejob (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
       globalid (>= 0.3.6)
-    activesupport (6.0.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    concurrent-ruby (1.1.6)
-    connection_pool (2.2.3)
-    docile (1.3.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.9)
+    connection_pool (2.2.5)
+    docile (1.4.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
+    minitest (5.14.4)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    rake (13.0.1)
-    simplecov (0.18.5)
+    rake (13.0.3)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.4.0)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,6 +1,6 @@
 # faktory\_worker\_ruby
 
-![travis](https://travis-ci.org/contribsys/faktory_worker_ruby.svg?branch=master)
+![CI status](https://github.com/contribsys/faktory_worker_ruby/actions/workflows/ci.yml/badge.svg)
 
 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/faktory_worker_ruby.gemspec

@@ -16,6 +16,14 @@ Gem::Specification.new do |gem|
   gem.version       = Faktory::VERSION
   gem.required_ruby_version = ">= 2.5.0"
 
+  gem.metadata = {
+    "homepage_uri" => "https://contribsys.com/faktory",
+    "bug_tracker_uri" => "https://github.com/contribsys/faktory_worker_ruby/issues",
+    "documentation_uri" => "https://github.com/contribsys/faktory_worker_ruby/wiki",
+    "changelog_uri" => "https://github.com/contribsys/faktory_worker_ruby/blob/master/Changes.md",
+    "source_code_uri" => "https://github.com/contribsys/faktory_worker_ruby",
+  }
+
   gem.add_dependency                  'connection_pool', '~> 2.2', ">= 2.2.2"
   gem.add_development_dependency      'activejob', '>= 5.2.0'
   gem.add_development_dependency      'minitest', '~> 5'

data/lib/faktory/batch.rb

@@ -98,7 +98,7 @@ module Faktory
 
     def complete=(val)
       raise "Batch cannot be modified once created" if bid
-      @success = to_callback(val)
+      @complete = to_callback(val)
     end
 
     def jobs(&block)

data/lib/faktory/cli.rb

@@ -212,7 +212,7 @@ module Faktory
       if !File.exist?(options[:require]) ||
          (File.directory?(options[:require]) && !File.exist?("#{options[:require]}/config/application.rb"))
         logger.info "=================================================================="
-        logger.info "  Please point Faktory to a Rails 5 application or a Ruby file  "
+        logger.info "  Please point Faktory to a Rails application or a Ruby file  "
         logger.info "  to load your worker classes with -r [DIR|FILE]."
         logger.info "=================================================================="
         logger.info @parser

data/lib/faktory/client.rb

@@ -80,9 +80,9 @@ module Faktory
       end
       batch.instance_variable_set(:@bid, bid)
 
-      old = Thread.current["faktory_batch"]
-      Thread.current["faktory_batch"] = batch
+      old = Thread.current[:faktory_batch]
       begin
+        Thread.current[:faktory_batch] = batch
         # any jobs pushed in this block will implicitly have
         # their `bid` attribute set so they are associated
         # with the current batch.
@@ -110,8 +110,8 @@ module Faktory
         ok
       end
       old = Thread.current[:faktory_batch]
-      Thread.current[:faktory_batch] = b
       begin
+        Thread.current[:faktory_batch] = b
         # any jobs pushed in this block will implicitly have
         # their `bid` attribute set so they are associated
         # with the current batch.
@@ -141,6 +141,22 @@ module Faktory
       end
     end
 
+    def pause_queues(queues)
+      qs = Array(queues)
+      transaction do
+        command "QUEUE PAUSE", qs.join(" ")
+        ok
+      end
+    end
+
+    def resume_queues(queues)
+      qs = Array(queues)
+      transaction do
+        command "QUEUE RESUME", qs.join(" ")
+        ok
+      end
+    end
+
     # Push a hash corresponding to a job payload to Faktory.
     # Hash must contain "jid", "jobtype" and "args" elements at minimum.
     # Returned value will either be the JID String if successful OR
@@ -188,13 +204,11 @@ module Faktory
     # Return a string signal to process, legal values are "quiet" or "terminate".
     # The quiet signal is informative: the server won't allow this process to FETCH
     # any more jobs anyways.
-    def beat(current_state = nil)
+    def beat(current_state = nil, hash)
       transaction do
-        if current_state.nil?
-          command("BEAT", %Q[{"wid":"#{@@random_process_wid}"}])
-        else
-          command("BEAT", %Q[{"wid":"#{@@random_process_wid}", "current_state":"#{current_state}"}])
-        end
+        hash["wid"] = @@random_process_wid
+        hash["current_state"] = current_state if current_state
+        command("BEAT", Faktory.dump_json(hash))
 
         str = result!
         if str == "OK"
@@ -227,6 +241,7 @@ module Faktory
 
     def open(timeout = DEFAULT_TIMEOUT)
       if tls?
+        require 'openssl'
         sock = TCPSocket.new(@location.hostname, @location.port)
         sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
 
@@ -248,6 +263,7 @@ module Faktory
         "hostname": Socket.gethostname,
         "pid": $$,
         "labels": Faktory.options[:labels] || ["ruby-#{RUBY_VERSION}"],
+        "username": @location.user,
         "v": 2,
       }
 

data/lib/faktory/io.rb

@@ -37,9 +37,9 @@ module Faktory
       loop do
         result = @sock.read_nonblock(nbytes, exception: false)
         if result == :wait_readable
-          raise Faktory::TimeoutError unless @sock.wait_readable(@timeout)
+          raise Faktory::TimeoutError unless @sock.to_io.wait_readable(@timeout)
         elsif result == :wait_writable
-          raise Faktory::TimeoutError unless @sock.wait_writeable(@timeout)
+          raise Faktory::TimeoutError unless @sock.to_io.wait_writeable(@timeout)
         elsif result == nil
           raise Errno::ECONNRESET
         else

data/lib/faktory/job.rb

@@ -56,6 +56,11 @@ module Faktory
         @opts = opts
       end
 
+      def set(opts)
+        @opts = Util.deep_merge(@opts, opts)
+        self
+      end
+
       def perform_async(*args)
         client_push(@opts.merge('args'.freeze => args))
       end
@@ -88,6 +93,11 @@ module Faktory
         pool = Thread.current[:faktory_via_pool] || item["pool"] || Faktory.server_pool
         item.delete("pool")
 
+        # the payload hash is shallow copied by `merge` calls BUT we don't deep clone
+        # the 'custom' child hash which can be problematic if we mutate it within middleware.
+        # Proactively dup it first.
+        item["custom"] = item["custom"].dup if item["custom"]
+
         Faktory.client_middleware.invoke(item, pool) do
           pool.with do |c|
             c.push(item)
@@ -99,7 +109,7 @@ module Faktory
     module ClassMethods
 
       def set(options)
-        Setter.new(options.merge!('jobtype'.freeze => self))
+        Setter.new(Util.deep_merge(get_faktory_options, options, 'jobtype'.freeze => self))
       end
 
       def perform_async(*args)
@@ -188,5 +198,23 @@ module Faktory
       end
 
     end
+
+    module Util
+      def deep_merge(*hashes)
+        initial = hashes.shift.transform_keys(&:to_s)
+        hashes.reduce(initial) do |acc, other_hash|
+          other_hash.transform_keys!(&:to_s)
+          acc.merge(other_hash) do |_key, this_val, other_val|
+            if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+              deep_merge(this_val, other_val)
+            else
+              other_val
+            end
+          end
+        end
+      end
+      module_function :deep_merge
+    end
+
   end
 end

data/lib/faktory/launcher.rb

@@ -60,7 +60,7 @@ module Faktory
         $0 = PROCTITLES.map {|p| p.call }.join(" ")
 
         begin
-          result = Faktory.server {|c| c.beat(@current_state) }
+          result = Faktory.server {|c| c.beat(@current_state, "rss_kb" => memory_usage(::Process.pid)) }
           case result
           when "OK"
             # all good
@@ -78,5 +78,26 @@ module Faktory
       end
     end
 
+    MEMORY_GRABBER = case RUBY_PLATFORM
+    when /linux/
+      ->(pid) {
+        IO.readlines("/proc/#{$$}/status").each do |line|
+          next unless line.start_with?("VmRSS:")
+          break line.split[1].to_i
+        end
+      }
+    when /darwin|bsd/
+      ->(pid) {
+        `ps -o pid,rss -p #{pid}`.lines.last.split.last.to_i
+      }
+    else
+      ->(pid) { 0 }
+    end
+
+    def memory_usage(pid)
+      MEMORY_GRABBER.call(pid)
+    end
+
+
   end
 end

data/lib/faktory/middleware/batch.rb

@@ -5,7 +5,7 @@
 module Faktory::Middleware::Batch
   class Client
     def call(payload, pool)
-      b = Thread.current["faktory_batch"]
+      b = Thread.current[:faktory_batch]
       if b
         payload["custom"] ||= {}
         payload["custom"]["bid"] = b.bid

data/lib/faktory/mutate.rb

@@ -1,5 +1,11 @@
 require 'faktory/client'
 
+##
+#
+# Faktory's MUTATE API allows you to scan the sorted sets
+# within Redis (retries, scheduled, dead) and take action
+# (delete, enqueue, kill) on entries.
+#
 # require 'faktory/mutate'
 # cl = Faktory::Client.new
 # cl.discard(Faktory::RETRIES) do |filter|

data/lib/faktory/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faktory_worker_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Mike Perham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -94,8 +94,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Changes.md
 - Gemfile
 - Gemfile.lock
@@ -132,7 +132,12 @@ files:
 homepage: https://github.com/contribsys/faktory_worker_ruby
 licenses:
 - LGPL-3.0
-metadata: {}
+metadata:
+  homepage_uri: https://contribsys.com/faktory
+  bug_tracker_uri: https://github.com/contribsys/faktory_worker_ruby/issues
+  documentation_uri: https://github.com/contribsys/faktory_worker_ruby/wiki
+  changelog_uri: https://github.com/contribsys/faktory_worker_ruby/blob/master/Changes.md
+  source_code_uri: https://github.com/contribsys/faktory_worker_ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -148,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Ruby worker for Faktory

data/.travis.yml

@@ -1,11 +0,0 @@
-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