activerecord-forbid_implicit_connection_checkout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9786df26344782e9e8a5ca2607ba495cc57030c
+  data.tar.gz: ab51e4fde2ab702654bde3dacab719c13208b8b2
+SHA512:
+  metadata.gz: afb3b97d2012c8551e627f7caeab6b40f1daa65cab09b74ed6b63719c3103de1f608535f83fed5c334e8a3210fcb4729bc1344fefcd5aea1da4bcf232ba29e1c
+  data.tar.gz: 7e7594613c1c1c7dd01682cbc66900e454eccd417450c8fc0891b37dbb6777701d4279bb986e9b0aa3c8e468f132e1e27d8ae4a5c38304af37b8c8c98f834075

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/log/
+/tmp/

data/.overcommit.yml

@@ -0,0 +1,13 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    required: false
+    on_warn: fail
+
+  HardTabs:
+    enabled: true
+    required: false
+
+CommitMsg:
+  TrailingPeriod:
+    enabled: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  salsify_rubocop: conf/rubocop.yml
+
+Style/FileName:
+  Exclude:
+    - lib/active_record-forbid_implicit_connection_checkout.rb

data/.ruby-gemset

@@ -0,0 +1 @@
+activerecord-forbid_implicit_checkout

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+env:
+  matrix:
+    - RAILS_VERSION="~> 5.0.6"
+    - RAILS_VERSION="~> 5.1.4"
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.3
+before_install: gem install bundler -v 1.12.4
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# activerecord-forbid_implicit_checkout
+
+## v0.1.0
+- Initial version

data/Gemfile

@@ -0,0 +1,9 @@
+
+source 'https://rubygems.org'
+
+
+# override the :github shortcut to be secure by using HTTPS
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}.git" }
+
+# Specify your gem's dependencies in activerecord-forbid_implicit_checkout.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Salsify, Inc
+
+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,126 @@
+# ActiveRecord-ForbidImplicitCheckout
+
+This gem allows a `Thread` to prevent itself from checking out out an ActiveRecord connection. This can be useful
+in preventing your application from accidentally checking out more connections than the database can handle.
+
+Inspired by this blog post: https://bibwild.wordpress.com/2014/07/17/activerecord-concurrency-in-rails4-avoid-leaked-connections/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-forbid_implicit_checkout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-forbid_implicit_checkout
+
+## Usage
+
+```ruby
+require 'active_record-forbid_implicit_connection_checkout'
+
+Thread.new do
+  ActiveRecord::Base.forbid_implicit_connection_checkout_for_thread!
+  # Code that doesn't require ActiveRecord
+end
+```
+
+If your thread needs a connection at some point
+```ruby
+Thread.new do
+  ActiveRecord::Base.forbid_implicit_connection_checkout_for_thread!
+  # Code that doesn't require ActiveRecord
+
+  ActiveRecord::Base.connection_pool.with_connection do
+    # Allow the thread to take a connection within this block
+    ActiveRecord::Base.connection
+  end
+
+  # Code that doesn't require ActiveRecord
+end
+```
+
+## Why
+Consider the following initially:
+
+```ruby
+require 'active_record-forbid_implicit_connection_checkout'
+
+class Foo
+  def self.download(id)
+    Net::HTTP.get(URI("http://example.com/products/#{URI.encode(id)}"))
+  end
+end
+
+class Downloader
+  def download_all(ids)
+    threads = ids.map do |id|
+      Thread.new do
+        ActiveRecord::Base.forbid_implicit_connection_checkout_for_thread!
+        Foo.download
+      end
+    end
+    threads.each(&:join)
+  end
+end
+
+Downloader.download_all([1,2,3,4,5])
+```
+
+The developer initially designed this parallel downloading to not be dependent on the database, so the developer feels confident in running
+many parallel processes of `Downloader.download_all`.
+
+However, `Foo.download` might be subject to change.
+
+```ruby
+class SomeModel < ApplicationRecord
+  # ...
+end
+
+class Foo
+  def self.download(id)
+    id = SomeModel.find(id).alias_id
+    Net::HTTP.get(URI("http://example.com/products/#{URI.encode(id)}"))
+  end
+end
+```
+
+After this modification to `Foo.download`, each thread will checkout a new connection to the database. Which could
+overwhelm the database if there are many parallel processes executing `Downloader.download_all`. While this violates,
+the initial assumption about `Downloader.download_all` using the database, it would have been useful to have a safeguard to prevent
+this situation from occurring.
+
+The error generated by setting `ActiveRecord::Base.forbid_implicit_connection_checkout_for_thread!` could have detected
+ this situation during testing which should have failed with `ActiveRecord::ImplicitConnectionForbiddenError`. In the
+ worst case, the production code running this would have failed with `ActiveRecord::ImplicitConnectionForbiddenError`,
+ but it would have prevented the database from being overwhelmed and have protected the rest of the application.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org)
+.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/salsify/activerecord-forbid_implicit_checkout.## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/activerecord-forbid_implicit_connection_checkout.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/forbid_implicit_connection_checkout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-forbid_implicit_connection_checkout'
+  spec.version       = ActiveRecord::ForbidImplicitConnectionCheckout::VERSION
+  spec.authors       = ['Salsify, Inc']
+  spec.email         = ['engineering@salsify.com']
+
+  spec.summary       = 'Optionally prevents threads from checking out activerecord connections.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/salsify/activerecord-forbid_implicit_connection_checkout'
+
+  spec.license       = 'MIT'
+
+
+  # Set 'allowed_push_post' to control where this gem can be published.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_dependency 'activerecord', ['>= 5', '< 5.1']
+  spec.add_dependency 'activemodel', ['>= 5', '< 5.1']
+  spec.add_dependency 'activesupport', ['>= 5', '< 5.1']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'salsify_rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'overcommit'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'pg', '~> 0.18'
+  spec.add_development_dependency 'with_model'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'activerecord-forbid_implicit_checkout'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -v
+
+bundle update
+
+overcommit --install

data/lib/active_record-forbid_implicit_connection_checkout.rb

@@ -0,0 +1,9 @@
+require 'active_record'
+require 'active_record/forbid_implicit_connection_checkout/version'
+require 'active_record/implicit_connection_forbidden_error'
+
+require 'active_record/forbid_implicit_connection_checkout/prevent_connection_checkout'
+require 'active_record/forbid_implicit_connection_checkout/connection_override'
+
+ActiveRecord::Base.include(ActiveRecord::ForbidImplicitConnectionCheckout::PreventConnectionCheckout)
+ActiveRecord::Base.singleton_class.prepend(ActiveRecord::ForbidImplicitConnectionCheckout::ConnectionOverride)

data/lib/active_record/forbid_implicit_connection_checkout/connection_override.rb

@@ -0,0 +1,15 @@
+require 'active_record/implicit_connection_forbidden_error'
+
+module ActiveRecord
+  module ForbidImplicitConnectionCheckout
+    module ConnectionOverride
+      def connection(*args, &block)
+        if Thread.current[:active_record_forbid_implicit_connections] &&
+          !connection_handler.retrieve_connection_pool(connection_specification_name).active_connection?
+          raise ActiveRecord::ImplicitConnectionForbiddenError.new
+        end
+        super
+      end
+    end
+  end
+end

data/lib/active_record/forbid_implicit_connection_checkout/prevent_connection_checkout.rb

@@ -0,0 +1,13 @@
+module ActiveRecord
+  module ForbidImplicitConnectionCheckout
+    module PreventConnectionCheckout
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def forbid_implicit_connection_checkout_for_thread!
+          Thread.current[:active_record_forbid_implicit_connections] = true
+        end
+      end
+    end
+  end
+end

data/lib/active_record/forbid_implicit_connection_checkout/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module ForbidImplicitConnectionCheckout
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/active_record/implicit_connection_forbidden_error.rb

@@ -0,0 +1,13 @@
+# This is needed because of https://github.com/rails/rails/blob/5-0-stable/activerecord/lib/active_record/errors.rb#L221
+require 'active_model/errors'
+require 'active_record/errors'
+
+module ActiveRecord
+  class ImplicitConnectionForbiddenError < ActiveRecord::ConnectionNotEstablished
+    MESSAGE = 'Implicit ActiveRecord checkout attempted when Thread :active_record_forbid_implicit_connections set!'.freeze
+
+    def initialize
+      super(MESSAGE)
+    end
+  end
+end

metadata

@@ -0,0 +1,239 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-forbid_implicit_connection_checkout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Salsify, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: salsify_rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  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: database_cleaner
+  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: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  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: Optionally prevents threads from checking out activerecord connections.
+email:
+- engineering@salsify.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-forbid_implicit_connection_checkout.gemspec
+- bin/console
+- bin/setup
+- lib/active_record-forbid_implicit_connection_checkout.rb
+- lib/active_record/forbid_implicit_connection_checkout/connection_override.rb
+- lib/active_record/forbid_implicit_connection_checkout/prevent_connection_checkout.rb
+- lib/active_record/forbid_implicit_connection_checkout/version.rb
+- lib/active_record/implicit_connection_forbidden_error.rb
+homepage: https://github.com/salsify/activerecord-forbid_implicit_connection_checkout
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Optionally prevents threads from checking out activerecord connections.
+test_files: []