sidekiq-pg_helpers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1eaac68cf5c30be590862792b0705d8ab2b28a1
-  data.tar.gz: 7852938737b6d12159cd2525ab831400696bddd7
+  metadata.gz: 3e90d0e136330ed77dd238bc06b42e755be2a8d5
+  data.tar.gz: 5b91a433916c0452ad1d7163e4ec5173c5a9f5c8
 SHA512:
-  metadata.gz: cf647b1a83fbf45cbb17bba3715516da88e0c36c8d8092199ba16601ef29ac222e3be89771c42b8a4d7260863e7961add49f1475e362b2bf16ad7e814af80cde
-  data.tar.gz: 4dea9cf55cd9d47203fa2f3424883923bf108364ec15ac9dc909cddfbe0e2c42f874e40fed1ffd1f4f927f40b1b435178a3e80b596f8e2137c40c68cfb3a8070
+  metadata.gz: 456e0c81e83ef896f80d13dc0abeecc25f0bc06a322321b000b196d5c9fc267b5e083d710a5b7fd68fce10de47b480ee928dce599dec467c19c917475975716a
+  data.tar.gz: 8707c1869c2e43671e6debc6dee1410b230e131f055657c032b361b8d94beeaf633b461f18087cb54373c3831273e4d26bafc0700aa356f26569ed32a9f9897c

data/README.md

@@ -1,4 +1,16 @@
-sidekiq-pg_helpers
-==================
+# sidekiq-pg_helpers
 
 Helper code for using Sidekiq with Postgres. Extracted from our production code.
+
+### ConnectionRecovery
+
+This middleware helps Sidekiq bad Postgres connections on the fly, whenever they fail:
+```ruby
+require "sidekiq/pg_helpers/middleware/connection_recovery"
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.insert_after Sidekiq::Middleware::Server::ActiveRecord, Sidekiq::PgHelpers::Middleware::ConnectionRecovery
+  end
+end
+```

data/lib/sidekiq/pg_helpers/middleware/connection_recovery.rb

@@ -4,15 +4,29 @@ require "sidekiq"
 require "pg"
 
 module Sidekiq::PgHelpers::Middleware
+  # Helps keep ActiveRecord's connection pool healthy by detecting common Postgres errors
   class ConnectionRecovery
     def initialize
       @reconnection_attempts = 0
     end
 
-    def call(*args)
+    # Detects commons problems with Postgres connections and forces ActiveRecord to close and re-open
+    # the offending connection, then automatically retries the error
+    def call(*)
       yield
-    rescue PG::ConnectionBad, PG::UnableToSend => e
-      if @reconnection_attempts >= 4
+    rescue *PG_CONNECTION_ERRORS => e
+      clean_up_connection(e)
+      retry
+    rescue ActiveRecord::StatementInvalid => e
+      raise unless PG_CONNECTION_ERRORS.include?(e.original_exception.class)
+      clean_up_connection(e)
+      retry
+    end
+
+    private
+
+    def clean_up_connection(e)
+      if reconnection_attempts >= 4
         Sidekiq.logger.error "Unable to re-establish Postgres connection after five attempts, giving up"
         raise
       end
@@ -28,8 +42,11 @@ module Sidekiq::PgHelpers::Middleware
       # Ensure we get a fresh connection the next time we access an activerecord object
       ActiveRecord::Base.clear_active_connections!
 
-      @reconnection_attempts += 1
-      retry
+      self.reconnection_attempts = reconnection_attempts + 1
     end
+
+    attr_accessor :reconnection_attempts
+
+    PG_CONNECTION_ERRORS = [PG::ConnectionBad, PG::UnableToSend].freeze
   end
 end

data/lib/sidekiq/pg_helpers/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module PgHelpers
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/lib/middleware/connection_recovery_spec.rb

@@ -57,6 +57,13 @@ describe Sidekiq::PgHelpers::Middleware::ConnectionRecovery do
     it_behaves_like "helpful middleware"
   end
 
+  context "with ActiveRecord::StatementInvalid wrapping PG::ConnectionBad" do
+    let(:exception) do
+      ActiveRecord::StatementInvalid.new("ugh",PG::ConnectionBad.new)
+    end
+    it_behaves_like "helpful middleware"
+  end
+
   context "with an unrecoverable problem" do
     let(:exception) { PG::ConnectionBad.new("server closed the connection unexpectedly") }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-pg_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mike Subelsky
@@ -14,98 +14,98 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -138,17 +138,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Helper code for using Sidekiq with Postgres. Extracted from our production
@@ -156,3 +156,4 @@ summary: Helper code for using Sidekiq with Postgres. Extracted from our product
 test_files:
 - spec/lib/middleware/connection_recovery_spec.rb
 - spec/spec_helper.rb
+has_rdoc: