freekiqs 5.0.0 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 44594d919a76aa86c249eb5fe88a9af8f95ba253
-  data.tar.gz: b788548a59466399a3e58ed192cd4344b6d37df4
+SHA256:
+  metadata.gz: d6b06dcd42bf69b36943cb98073500edaa179251c807284ac1520788f4f9b868
+  data.tar.gz: 7d273e8393c7f4ec61b2bc3488daaa3a8e7c4d2c3c4e323d0787f3217a1ec772
 SHA512:
-  metadata.gz: fbeab3d19cea8a86adf9e8a47e9cfab8e3739da4d53157fe82418bd838550736c77a414e81b505ccb7dba7663292058bc63b133fabebc2f4048dda0f8ed79f41
-  data.tar.gz: f0e33f9fc4851bfbfb1f4ff1b6f09cdc14dd4ba282e413b8c8e3c69366a4006f63af5edc63eda77b970660d9baa91d17da57468b06f9c5820a625bdb68ebdff0
+  metadata.gz: beeb49dbe17a46885ab99ff7c2128645fb739496a7636a2a0b8f041c7b1099dfd42e291f23d15bf49b0ff4b1da09d01da8a8f8d2cb9ed482db09982143d64d65
+  data.tar.gz: 1ce3a30d1d569967f3c0b3fe6941baf00cfaa6c99da09436e87481b29e8dfa1412cef2ede6853ae4c9e6099aa547149b01c943ac613891cb7b39d0020c7b44e1

data/.gitignore

@@ -6,3 +6,5 @@ pkg
 /.bundle
 /.vagrant
 /ubuntu-*-console.log
+/vendor
+dump.rdb

data/Procfile

@@ -0,0 +1 @@
+redis: redis-server development/redis/redis.conf --bind $HOST

data/README.md

@@ -5,6 +5,21 @@ by failed jobs and wrapping them with a `FreekiqException` exception class
 that can be filtered by monitoring tools such as New Relic and
 Rollbar.
 
+#### Implementation Details
+
+This relies on Sidekiq's built-in retry handling. Specifically, its
+`retry_count` value. When a job first fails, its `retry_count` value
+is nil (because it hasn't actually been retried yet). That exception,
+along with subsequent exceptions from retries, are caught and wrapped
+with the `FreekiqException` exception.
+Cases where Freekiqs does NOT wrap the exception:
+ - The `retry` option is false
+ - The `freekiqs` option is not set on the worker nor globally
+ - The `freekiqs` option is not set on worker and set to `false` globally
+ - The `freekiqs` option is set to `false` on the worker
+ - The job threw an exception that is not a StandardError (nor a subclass)
+ - The number of thrown exceptions is more than specified freekiqs
+
 Configuration example (in config/initializers/sidekiq.rb):
 ``` ruby
   Sidekiq.configure_server do |config|
@@ -101,26 +116,4 @@ If MyWorker throws a SubMyError or MyError, it will get freekiq'd.
 Version 5 of this gem only works with Sidekiq 5 and higher. If you are using
 an older version of Sidekiq, you'll need to use version [4.1.0](https://github.com/BookBub/freekiqs/tree/v4.1.0).
 
-## Overview
-
-Up to the configured number of "freekiqs", catch exceptions thrown
-from job and wrap them with the `FreekiqException` exception (which is a
-`RuntimeError`). That exception type can be ignored by monitoring
-tools. If job fails more times than configured "freekiqs", thrown
-exception will not be wrapped. That should result in normal operation
-and the exception showing up in monitoring tools.
-
-#### Implementation Details
-
-This relies on Sidekiq's built-in retry handling. Specifically, its
-`retry_count` value. When a job first fails, its `retry_count` value
-is nil (because it hasn't actually been retried yet). That exception,
-along with subsequent exceptions from retries, are caught and wrapped
-with the `FreekiqException` exception.
-Cases where Freekiqs does NOT wrap the exception:
- - The `retry` option is false
- - The `freekiqs` option is not set on the worker nor globally
- - The `freekiqs` option is not set on worker and set to `false` globally
- - The `freekiqs` option is set to `false` on the worker
- - The job threw an exception that is not a StandardError (nor a subclass)
- - The number of thrown exceptions is more than specified freekiqs
+Version 6.5.0 of this gem works with Sidekiq 6.5 and higher.

data/development/redis/redis.conf

@@ -0,0 +1,49 @@
+protected-mode yes
+port 6379
+tcp-backlog 511
+timeout 0
+tcp-keepalive 300
+daemonize no
+supervised no
+pidfile development/redis/redis_6379.pid
+loglevel warning
+logfile ""
+databases 16
+save 900 1
+save 300 10
+save 60 10000
+stop-writes-on-bgsave-error yes
+rdbcompression yes
+rdbchecksum yes
+dbfilename dump.rdb
+dir development/redis
+slave-serve-stale-data yes
+slave-read-only yes
+repl-diskless-sync no
+repl-diskless-sync-delay 5
+repl-disable-tcp-nodelay no
+slave-priority 100
+appendonly no
+appendfilename "appendonly.aof"
+appendfsync no
+no-appendfsync-on-rewrite no
+auto-aof-rewrite-percentage 100
+auto-aof-rewrite-min-size 64mb
+aof-load-truncated yes
+lua-time-limit 5000
+latency-monitor-threshold 0
+notify-keyspace-events ""
+hash-max-ziplist-entries 512
+hash-max-ziplist-value 64
+list-max-ziplist-size -2
+list-compress-depth 0
+set-max-intset-entries 512
+zset-max-ziplist-entries 128
+zset-max-ziplist-value 64
+hll-sparse-max-bytes 3000
+activerehashing yes
+client-output-buffer-limit normal 0 0 0
+client-output-buffer-limit slave 256mb 64mb 60
+client-output-buffer-limit pubsub 32mb 8mb 60
+hz 10
+aof-rewrite-incremental-fsync yes

data/freekiqs.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name                  = 'freekiqs'
-  gem.version               = '5.0.0'
+  gem.version               = '6.5.0'
   gem.authors               = ['Rob Lewis']
   gem.email                 = ['rob@bookbub.com']
   gem.summary               = 'Sidekiq middleware extending RetryJobs to allow silient errors.'
@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.require_paths         = ['lib']
   gem.required_ruby_version = '>= 2.2.2'
 
-  gem.add_dependency             'sidekiq', '>= 5.0.0'
+  gem.add_dependency             'sidekiq', '>= 6.5.0'
   gem.add_development_dependency 'rspec', '>= 3.6.0'
 end

data/lib/sidekiq/middleware/server/freekiqs.rb

@@ -1,5 +1,5 @@
 require 'sidekiq'
-require 'sidekiq/util'
+require 'sidekiq/middleware/modules'
 
 module Sidekiq
   class FreekiqException < RuntimeError; end
@@ -7,7 +7,7 @@ module Sidekiq
   module Middleware
     module Server
       class Freekiqs
-        include Sidekiq::Util
+        include Sidekiq::ServerMiddleware
         @@callback = nil
 
         def initialize(opts={})
@@ -25,12 +25,12 @@ module Sidekiq
               begin
                 @@callback.call(worker, msg, queue) if @@callback
               rescue => callback_exception
-                Sidekiq.logger.info { "Freekiq callback failed for #{msg['class']} job #{msg['jid']}" }
+                logger.info { "Freekiq callback failed for #{msg['class']} job #{msg['jid']}" }
               ensure
                 raise FreekiqException, ex.message
               end
             else
-              Sidekiq.logger.info { "Out of freekiqs for #{msg['class']} job #{msg['jid']}" }
+              logger.info { "Out of freekiqs for #{msg['class']} job #{msg['jid']}" }
             end
           end
           raise ex

data/shell.nix

@@ -0,0 +1,42 @@
+{ system ? builtins.currentSystem }:
+
+with (import (fetchTarball {
+  name = "nixpkgs-21.11";
+  url = "https://github.com/nixos/nixpkgs/archive/21.11.tar.gz";
+  sha256 = "162dywda2dvfj1248afxc45kcrg83appjd0nmdb541hl7rnncf02";
+}) { inherit system; });
+
+
+let
+  requiredNixVersion = "2.3";
+
+  pwd = builtins.getEnv "PWD";
+in
+
+if lib.versionOlder builtins.nixVersion requiredNixVersion == true then
+  abort "This project requires Nix >= ${requiredNixVersion}, please run 'nix-channel --update && nix-env -i nix'."
+else
+
+  mkShell {
+    buildInputs = [
+      stdenv
+      git
+      cacert
+
+      # Ruby and Rails dependencies
+      ruby_2_7.devEnv
+      bundler
+
+      # Services
+      overmind
+      redis
+
+    ] ++ lib.optional (!stdenv.isDarwin) [
+      # linux-only packages
+      glibcLocales
+    ];
+
+    HOST = "127.0.0.24";
+    REDIS_URL="redis://127.0.0.24:6379/1";
+    BUNDLE_PATH = "vendor/bundle";
+  }

data/spec/freekiqs_spec.rb

@@ -1,3 +1,5 @@
+require 'sidekiq'
+require 'sidekiq/api'
 require 'sidekiq/processor'
 
 RSpec.describe Sidekiq::Middleware::Server::Freekiqs do
@@ -15,8 +17,7 @@ RSpec.describe Sidekiq::Middleware::Server::Freekiqs do
   end
 
   def process_job(job_hash)
-    mgr = instance_double('Manager', options: {:queues => ['default']})
-    processor = ::Sidekiq::Processor.new(mgr)
+    processor = Sidekiq::Processor.new(Sidekiq)
     job_msg = Sidekiq.dump_json(job_hash)
     processor.process(Sidekiq::BasicFetch::UnitOfWork.new('queue:default', job_msg))
   end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'freekiqs'
 
 $TESTING = true
 
-Sidekiq::Logging.logger = nil
+Sidekiq.logger = nil
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freekiqs
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.5.0
 platform: ruby
 authors:
 - Rob Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2022-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,13 +50,16 @@ files:
 - ".rspec"
 - Gemfile
 - MIT-LICENSE
+- Procfile
 - README.md
 - Rakefile
 - Vagrantfile
 - circle.yml
+- development/redis/redis.conf
 - freekiqs.gemspec
 - lib/freekiqs.rb
 - lib/sidekiq/middleware/server/freekiqs.rb
+- shell.nix
 - spec/freekiqs_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/BookBub/freekiqs
@@ -78,8 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Sidekiq middleware extending RetryJobs to allow silient errors.