sidekiq_publisher 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91e1f28973451bbee0a4b0d099e417707d0413ba475c2f7530d07d34f9e74b1f
-  data.tar.gz: a9dd797b6193ef3a183f318afcc7582c375c0b2d374eac688203ac3eb3cf3f48
+  metadata.gz: bbd6a68303b5c42905e58ee64d231331265fbbbdb11316470e5fa8e83966de7e
+  data.tar.gz: 6773cbea5ae5010a4d9771d043b5210f65fe21d064097dfbbf76d0ed936ad3ac
 SHA512:
-  metadata.gz: 434a5f016d1ab9a082c6d786d002a8b1bacac7cc3ed4832d60ffa47678f9e81112e7ff0bb8bd3002a50cba4a3c99ba803a7e2fdbbc93e9805008a6a04073228f
-  data.tar.gz: 202cb6eaf93e710379917e421167ba8bc1a3dc40634404f83595e8f3519956ea03e177ffb5e92407cfa61ce49a11a9748bdc3571eb4684a20cdbd2eace5080bf
+  metadata.gz: af0eced6cc6b0343ae91ad8d8c80b6e02fd004aa95b1e3fa10fe2072656e737af195601c316c074a74be0012c7e00e21216f778017b227b44015a290211ee3c7
+  data.tar.gz: 53127db49e7925d0878ebf65a61251c44d63ffc8abf4c3a7c79ffa2f0a0c2b510c8d177093a8a6a29eac29b56a0335551e20ed9327ff72d9681ada72afd88f55

data/Appraisals

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-appraise "rails-5.1" do
-  gem "activejob", "~> 5.1.6"
-  gem "activesupport", "~> 5.1.6"
-end
-
 appraise "rails-5.2-sidekiq-5.0" do
   gem "activejob", "~> 5.2.0"
   gem "activesupport", "~> 5.2.0"
@@ -52,3 +47,21 @@ appraise "rails-6.0-sidekiq-6.1" do
   gem "activesupport", "~> 6.0.0"
   gem "sidekiq", "~> 6.1.0"
 end
+
+appraise "rails-6.1-sidekiq-5.2" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 5.2.0"
+end
+
+appraise "rails-6.1-sidekiq-6.0" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 6.0.1"
+end
+
+appraise "rails-6.1-sidekiq-6.1" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 6.1.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # sidekiq_publisher
 
+## v2.0.0 (unreleased)
+- Transition from defining a Railtie to becoming a Rails Engine
+  [(#44)](https://github.com/ezcater/sidekiq_publisher/pull/44). This change was
+  made to better support Ruby 3.0 and Rails 6.1. The change is *not* expected to
+  be breaking but it does represent a major change in the gem's implementation
+  and that is the reason for the major version bump.
+- Require Ruby 2.6 or later.
+
+## v1.8.0
+- Extend support to Rails 6.1.
+
+## v1.7.1
+- Gracefully handle database connection errors in ReportUnpublishedCount by attempting to reconnect.
+
 ## v1.7.0
 - Add instrumentation using `ActiveSupport::Notifications`.
 - Reimplement `metrics_reporter` and `exception_reporter` support using

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ezcater-production.jfrog.io/ruby:f08726283c
+FROM ezcater-production.jfrog.io/ruby:90790156c4
 RUN mkdir /usr/src/gem
 WORKDIR /usr/src/gem
 ADD . /usr/src/gem

data/README.md

@@ -136,6 +136,21 @@ class MyJob < ApplicationJob
 end
 ```
 
+#### ActiveJob Exception Reporting
+
+Many exception monitoring service (e.g. Sentry, Airbrake, Honeybadger, etc) already provide basic integration support for `Sidekiq`. 
+These integration should also work with `SidekiqPublisher`. 
+However, you may need to explicitly include 
+`ActiveJob::QueueAdapters::SidekiqPublisherAdapter` as a compatible adapter for this to work properly.
+
+Alternatively, you can manually report the exception:
+
+ ```ruby
+retry_on SomeError, attempts: 10 do |_job, exception|
+  Raven.capture_exception(exception, extra: { custom: :foo }) # Reporting using the Sentry gem 
+end
+```
+
 ### SidekiqPublisher::Worker
 
 Sidekiq workers are usually defined by including `Sidekiq::Worker` in a class.

data/{lib → app/models}/sidekiq_publisher/job.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "active_record"
-
 module SidekiqPublisher
   class Job < ActiveRecord::Base
     self.table_name = "sidekiq_publisher_jobs"

data/docker-compose.yml

@@ -7,6 +7,7 @@ x-environment: &default-environment
   BUNDLE_IGNORE_CONFIG: 1
   BUNDLE_DISABLE_SHARED_GEMS: "true"
   PGUSER: postgres
+  PGPASSWORD: postgres
   PGHOST: sidekiq-publisher-postgres
   PGPORT: 5432
   PGDATABASE: sidekiq_publisher_test
@@ -28,9 +29,10 @@ services:
     image: redis:5.0.9-alpine
   sidekiq-publisher-postgres:
     container_name: sidekiq-publisher-postgres_1
-    image: postgres:11.6
+    image: postgres:12.6
     environment:
       POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
       POSTGRES_DB: sidekiq_publisher_test
   sidekiq-publisher-console:
     <<: *default-service

data/gemfiles/{rails_5.1.gemfile → rails_6.1_sidekiq_5.2.gemfile}

@@ -2,7 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "activejob", "~> 5.1.6"
-gem "activesupport", "~> 5.1.6"
+gem "activejob", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "sidekiq", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/rails_6.1_sidekiq_6.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "sidekiq", "~> 6.0.1"
+
+gemspec path: "../"

data/gemfiles/rails_6.1_sidekiq_6.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "sidekiq", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/active_job/queue_adapters/sidekiq_publisher_adapter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_job/queue_adapters/sidekiq_adapter"
+require "active_support/core_ext/object/blank"
 
 module ActiveJob
   module QueueAdapters

data/lib/sidekiq_publisher.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require "active_support"
+require "active_support/core_ext/numeric/time"
 require "sidekiq_publisher/version"
 require "sidekiq_publisher/instrumenter"
 require "sidekiq_publisher/metrics_reporter"
 require "sidekiq_publisher/exception_reporter"
 require "sidekiq_publisher/report_unpublished_count"
-require "sidekiq_publisher/job"
 require "sidekiq_publisher/worker"
 require "sidekiq_publisher/publisher"
 require "sidekiq_publisher/runner"
-require "sidekiq_publisher/railtie" if defined?(Rails)
+require "sidekiq_publisher/engine" if defined?(Rails)
 
 module SidekiqPublisher
   DEFAULT_BATCH_SIZE = 100

data/lib/sidekiq_publisher/{railtie.rb → engine.rb}

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      load "sidekiq_publisher/tasks.rake"
-    end
+  class Engine < Rails::Engine
+    isolate_namespace SidekiqPublisher
 
     initializer "sidekiq_publisher.configure" do
       SidekiqPublisher.logger = Rails.logger

data/lib/sidekiq_publisher/metrics_reporter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/subscriber"
+require "active_support/core_ext/object/try"
 
 module SidekiqPublisher
   module MetricsReporter

data/lib/sidekiq_publisher/publisher.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "sidekiq_publisher/client"
-require "active_support/core_ext/object/try"
+require "active_support/core_ext/object/blank"
 
 module SidekiqPublisher
   class Publisher

data/lib/sidekiq_publisher/report_unpublished_count.rb

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
 
+require "active_record"
+require "pg"
+
 module SidekiqPublisher
   module ReportUnpublishedCount
     def self.call(instrumenter: Instrumenter.new)
       instrumenter.instrument("unpublished.reporter",
                               unpublished_count: SidekiqPublisher::Job.unpublished.count)
+    rescue ActiveRecord::StatementInvalid, PG::UnableToSend, PG::ConnectionBad => e
+      ActiveRecord::Base.clear_active_connections! if db_connection_error?(e)
+      raise
+    end
+
+    def self.db_connection_error?(error)
+      cause = error.is_a?(ActiveRecord::StatementInvalid) ? error.cause : error
+      cause.is_a?(PG::UnableToSend) || cause.is_a?(PG::ConnectionBad)
     end
+    private_class_method :db_connection_error?
   end
 end

data/lib/sidekiq_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  VERSION = "1.7.0"
+  VERSION = "2.0.0"
 end

data/lib/{sidekiq_publisher/tasks.rake → tasks/sidekiq_publisher.rake}

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 namespace :sidekiq_publisher do
+  desc "Start the Sidekiq Publisher runner"
   task publish: [:environment] do
     Signal.trap("INT") { exit(0) }
     Signal.trap("TERM") { exit(0) }

data/sidekiq_publisher.gemspec

@@ -41,6 +41,8 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_development_dependency "activejob"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler", "~> 1.12"
@@ -58,6 +60,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov", "< 0.18"
 
   spec.add_runtime_dependency "activerecord-postgres_pub_sub", ">= 0.4.0"
-  spec.add_runtime_dependency "activesupport", ">= 5.1", "< 6.1"
+  spec.add_runtime_dependency "activesupport", ">= 5.1", "< 6.2"
   spec.add_runtime_dependency "sidekiq", ">= 5.0.4", "< 7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 2.0.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-07 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -243,7 +243,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -253,7 +253,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -289,8 +289,8 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- app/models/sidekiq_publisher/job.rb
 - docker-compose.yml
-- gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_5.0.gemfile
 - gemfiles/rails_5.2_sidekiq_5.1.gemfile
@@ -300,24 +300,26 @@ files:
 - gemfiles/rails_6.0_sidekiq_5.2.gemfile
 - gemfiles/rails_6.0_sidekiq_6.0.gemfile
 - gemfiles/rails_6.0_sidekiq_6.1.gemfile
+- gemfiles/rails_6.1_sidekiq_5.2.gemfile
+- gemfiles/rails_6.1_sidekiq_6.0.gemfile
+- gemfiles/rails_6.1_sidekiq_6.1.gemfile
 - lib/active_job/queue_adapters/sidekiq_publisher_adapter.rb
 - lib/generators/sidekiq_publisher/install_generator.rb
 - lib/generators/sidekiq_publisher/templates/create_sidekiq_publisher_jobs.rb
 - lib/sidekiq_publisher.rb
 - lib/sidekiq_publisher/client.rb
 - lib/sidekiq_publisher/datadog_apm.rb
+- lib/sidekiq_publisher/engine.rb
 - lib/sidekiq_publisher/exception_reporter.rb
 - lib/sidekiq_publisher/instrumenter.rb
-- lib/sidekiq_publisher/job.rb
 - lib/sidekiq_publisher/metrics_reporter.rb
 - lib/sidekiq_publisher/publisher.rb
-- lib/sidekiq_publisher/railtie.rb
 - lib/sidekiq_publisher/report_unpublished_count.rb
 - lib/sidekiq_publisher/runner.rb
-- lib/sidekiq_publisher/tasks.rake
 - lib/sidekiq_publisher/testing.rb
 - lib/sidekiq_publisher/version.rb
 - lib/sidekiq_publisher/worker.rb
+- lib/tasks/sidekiq_publisher.rake
 - log/.gitkeep
 - sidekiq_publisher.gemspec
 homepage: https://github.com/ezcater/sidekiq_publisher
@@ -333,7 +335,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="