sidekiq-pg_helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d2ed31b9d675454a85214492b86ba39c0f1611e
+  data.tar.gz: 5f90b834f777c70a8ee6eb6496d5d82b9f6a4ab7
+SHA512:
+  metadata.gz: 1fe4ad87cf9adff11778f7735a2eecadd84fc09148dec9b4f688fe31b78647cba34cd1467db5aefca875ac3f7f0f34b8114f9eecb9f702db28950a24e292349a
+  data.tar.gz: f87aceb8d9d592cbe7b262fd63dec9ce44859678a85639a18276a4f2ce0f295a14b1fc3bdc95a8e5d4395773110782c3fdcfbbb384863f9759c23d42fa7280dd

data/.gitignore

@@ -0,0 +1,19 @@
+Gemfile.lock
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-pg_helpers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Staq
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Subelsky
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+sidekiq-pg_helpers
+==================
+
+Helper code for using Sidekiq with Postgres. Extracted from our production code.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+#http://erniemiller.org/2014/02/05/7-lines-every-gems-rakefile-should-have/
+task :console do
+  require "irb"
+  require "irb/completion"
+  require "sidekiq/pg_helpers"
+  ARGV.clear
+  IRB.start
+end

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

@@ -0,0 +1,35 @@
+require "sidekiq/pg_helpers"
+require "active_record"
+require "sidekiq"
+require "pg"
+
+module Sidekiq::PgHelpers
+  class ConnectionRecovery
+    def initialize
+      @reconnection_attempts = 0
+    end
+
+    def call(worker_class,msg,queue)
+      yield
+    rescue PG::ConnectionBad, PG::UnableToSend => e
+      if @reconnection_attempts >= 4
+        Sidekiq.logger.error "Unable to re-establish Postgres connection after five attempts, giving up"
+        raise
+      end
+
+      Sidekiq.logger.warn "Received #{e.class}, disconnecting and cleaning up our Postgres connection before re-trying"
+
+      # Probably due to an abrupt disconnection: https://devcenter.heroku.com/articles/postgres-logs-errors#pgerror-ssl-syscall-error-eof-detected
+      # The next time we access an ActiveRecord connection, it should automatically check out a fresh connection to replace this one
+      connection = ActiveRecord::Base.connection
+      connection.disconnect!
+      ActiveRecord::Base.connection_pool.remove(connection)
+
+      # Ensure we get a fresh connection the next time we access an activerecord object
+      ActiveRecord::Base.clear_active_connections!
+
+      @reconnection_attempts += 1
+      retry
+    end
+  end
+end

data/lib/sidekiq/pg_helpers/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module PgHelpers
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/pg_helpers.rb

@@ -0,0 +1,6 @@
+require "sidekiq/pg_helpers/version"
+
+module Sidekiq
+  module PgHelpers
+  end
+end

data/sidekiq-pg_helpers.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/pg_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-pg_helpers"
+  spec.version       = Sidekiq::PgHelpers::VERSION
+  spec.authors       = ["Mike Subelsky"]
+  spec.email         = ["github@mikeshop.net"]
+  spec.summary       = %q{Helper code for using Sidekiq with Postgres. Extracted from our production code.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/staqapp/sidekiq-pg_helpers"
+  spec.license       = "MIT"
+  spec.date          = "2014-02-21"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "pg"
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "sidekiq"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/spec/lib/middleware/connection_recovery_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+require "sidekiq/pg_helpers/middleware/connection_recovery"
+
+shared_examples "helpful middleware" do
+  before do
+    subject.call(:worker_class,:msg,:queue,&block)
+  end
+
+  it "logs the issue" do
+    expect(logger).to have_received(:warn).with(an_instance_of(String))
+  end
+
+  it "disconnects the bad connection" do
+    expect(connection).to have_received(:disconnect!)
+  end
+
+  it "removes the bad connection from ActiveRecord's connection pool" do
+    expect(connection_pool).to have_received(:remove).with(connection)
+  end
+
+  it "clears active connections, just in case" do
+    expect(ActiveRecord::Base).to have_received(:clear_active_connections!)
+  end
+end
+
+describe Sidekiq::PgHelpers::ConnectionRecovery do
+  let(:connection) { double(:connection,disconnect!: nil) }
+  let(:connection_pool) { double(:connection_pool,remove: nil) }
+  let(:logger) { double(:logger,warn: nil,error: nil) }
+  let(:block) do
+    lambda do
+      next if @_times_called == 1
+      @_times_called += 1
+      raise exception
+    end
+  end
+
+  before do
+    @_times_called = 0
+
+    ActiveRecord::Base.stub(connection: connection,connection_pool: connection_pool)
+    ActiveRecord::Base.stub(:clear_active_connections!)
+    Sidekiq.stub(logger: logger)
+  end
+
+  it "yields to a block" do
+    expect { |b| subject.call(:worker_class,:msg,:queue,&b) }.to yield_control
+  end
+
+  context "with PG::ConnectionBad" do
+    let(:exception) { PG::ConnectionBad.new("could not connect to server: Connection refused") }
+    it_behaves_like "helpful middleware"
+  end
+
+  context "with PG::UnableToSend" do
+    let(:exception) { PG::ConnectionBad.new("server closed the connection unexpectedly") }
+    it_behaves_like "helpful middleware"
+  end
+
+  context "with an unrecoverable problem" do
+    let(:exception) { PG::ConnectionBad.new("server closed the connection unexpectedly") }
+
+    let(:block) do
+      lambda do
+        @_times_called += 1
+        next if @_times_called > 5 # prevent looping forever if the retry code breaks
+        raise exception
+      end
+    end
+
+    before do
+      @_times_called = 0
+    end
+
+    it "gives up after 5 attempts" do
+      subject.call(:worker_class,:msg,:queue,&block) rescue PG::ConnectionBad
+      expect(@_times_called).to eq(5)
+    end
+
+    it "re-raises the exception after 5 attempts" do
+      expect { subject.call(:worker_class,:msg,:queue,&block) }.to raise_error(exception)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "bundler"
+
+Bundler.setup(:default,:test)
+require "rspec"
+require "pp"
+require "pry"
+
+$:.unshift("#{__dir__}/../lib/staq_rendering")
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-pg_helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Subelsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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: ''
+email:
+- github@mikeshop.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq/pg_helpers.rb
+- lib/sidekiq/pg_helpers/middleware/connection_recovery.rb
+- lib/sidekiq/pg_helpers/version.rb
+- sidekiq-pg_helpers.gemspec
+- spec/lib/middleware/connection_recovery_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/staqapp/sidekiq-pg_helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Helper code for using Sidekiq with Postgres. Extracted from our production
+  code.
+test_files:
+- spec/lib/middleware/connection_recovery_spec.rb
+- spec/spec_helper.rb
+has_rdoc: