migration_timeouts 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b3919c73d8291c27d7a9e0c3709a332a8d9dde02d9839ec0f6ab46f21c85937
+  data.tar.gz: 01513e814fce20aa0c7ffc324fe069d94c911453dda646189dfd69ff89d77699
+SHA512:
+  metadata.gz: 4ba69c9eb637358b3b2c834e1650c3fc418f58a27c1ba804b3855c88288f6dd2f17c93148a12d760788cee203a7b25998552f0edc7e0c5f4e15cda173b9ec23d
+  data.tar.gz: 29e05d1f60b15de0d66251b70299e1e175a92bde915598ab33f4997b50355c127be346a4772ff7830dafe570f8522b83c4a8980e1f8d38332d10bb12e4b84523

data/.editorconfig

@@ -0,0 +1,22 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Base rule, applies to everything
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+
+# some languages make syntactical use of trailing whitespace,
+# so it should not be stripped
+[*.md]
+trim_trailing_whitespace = false
+
+# Custom rules for specific file types:
+# [*.ext]
+# write some custom rules

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+/gemfiles/*.gemfile.lock

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  spicerack-styleguide:
+    - rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [1.2.0]
+### Added
+- Support for using with the [strong_migrations](https://github.com/ankane/strong_migrations) gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at opensource@procore.com All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,98 @@
+# Migration Timeouts
+
+Migration Timeouts is a Ruby gem that adds timeouts, explicitly or implicitly, to ActiveRecord migrations.
+
+A **lock_timeout** sets a timeout on how long PostgreSQL will wait to acquire a lock on tables being altered before failing and rolling back. This prevents lock contention, and long-running migrations.
+
+A **statement_timeout** sets timeout on how long a single DB statement can run. If a badly constructed migration tries to lock a table for too long, this will fail the migration and trigger a rollback.
+
+This gem provides config options for app-wide settings, and class methods for specifying or disabling timeouts for a single migration.
+
+Migration Timeouts currently only supports [PostgreSQL](https://www.postgresql.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'migration_timeouts'
+```
+
+## Usage
+
+Configure the default lock timeout in a Rails initializer
+
+```ruby
+#config/initializers/migration_timeouts.rb
+
+MigrationTimeouts.configure do |config|
+  config.default_lock_timeout = 3.seconds
+  config.default_statement_timeout = 5.seconds
+end
+```
+
+And that's all! Now every `up` migration will execute
+```psql
+SET LOCAL statement_timeout = 5000;
+SET LOCAL lock_timeout = 3000;
+```
+inside the migration transaction before your migration code runs. No lock
+timeout will be used for the `down` migration.
+
+## Disabling
+
+If you set app-wide timeout settings, you can disable them for single migrations.
+
+Here are the available helper methods:
+```ruby
+  class AddFoo < ActiveRecord::Migration
+
+    disable_lock_timeout!
+    disable_statement_timeout!
+    disable_timeouts!
+
+    def change
+      create_table :foo do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+
+## Custom lock timeout
+
+You can change the duration of the timeouts by using:
+```ruby
+  class AddBar < ActiveRecord::Migration
+
+    lock_timeout 10.seconds
+    statement_timeout 15.seconds
+
+    def change
+      create_table :bar do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+Additionally, if you have not set app-wide timeouts, you can use this to
+set a timeout for a particular migration.
+
+## disable_ddl_transaction!
+
+If you use `disable_ddl_transaction!`, no timeouts will occur
+```ruby
+  class AddMonkey < ActiveRecord::Migration
+
+    disable_ddl_transaction!
+
+    def change
+      create_table :monkey do |t|
+        t.timestamps
+      end
+    end
+  end
+```
+
+## Thanks and alternatives
+Originally forked from https://github.com/procore/migration-lock-timeout :heart:

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "migration_timeouts"
+
+# 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 -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/migration_timeouts.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_record"
+
+module MigrationTimeouts
+end
+
+Dir[File.join(File.dirname(__FILE__), "migration_timeouts", "*.rb")].each { |file| require file }
+
+::ActiveRecord::Migration.prepend(MigrationTimeouts::TimeoutManager)
+::ActiveRecord::Migration.extend(MigrationTimeouts::MigrationExtensions)

data/lib/migration_timeouts/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module MigrationTimeouts
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configurator.new
+    end
+  end
+
+  class Configurator
+    attr_accessor :default_lock_timeout, :default_statement_timeout
+  end
+end

data/lib/migration_timeouts/migration_extensions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MigrationTimeouts
+  module MigrationExtensions
+    attr_accessor(
+      :lock_timeout_disabled,
+      :statement_timeout_disabled,
+      :lock_timeout_override,
+      :statement_timeout_override,
+    )
+
+    def disable_lock_timeout!
+      self.lock_timeout_disabled = true
+    end
+
+    def disable_statement_timeout!
+      self.statement_timeout_disabled = true
+    end
+
+    def disable_timeouts!
+      self.lock_timeout_disabled = true
+      self.statement_timeout_disabled = true
+    end
+
+    def lock_timeout(seconds)
+      self.lock_timeout_override = seconds
+    end
+
+    def statement_timeout(seconds)
+      self.statement_timeout_override = seconds
+    end
+  end
+end

data/lib/migration_timeouts/timeout_manager.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/numeric"
+
+module MigrationTimeouts
+  module TimeoutManager
+    def migrate(direction)
+      return super unless direction == :up && !disable_ddl_transaction
+
+      issue_lock_timeout if lock_timeout_configured?
+      issue_statement_timeout if statement_timeout_configured?
+
+      super
+    end
+
+    private
+
+    def issue_lock_timeout
+      execute "SET LOCAL lock_timeout = #{lock_timeout.in_milliseconds}"
+    end
+
+    def issue_statement_timeout
+      execute "SET LOCAL statement_timeout = #{statement_timeout.in_milliseconds}"
+    end
+
+    def lock_timeout_configured?
+      !self.class.lock_timeout_disabled && lock_timeout&.try(:positive?)
+    end
+
+    def statement_timeout_configured?
+      !self.class.statement_timeout_disabled && statement_timeout&.try(:positive?)
+    end
+
+    def lock_timeout
+      self.class.lock_timeout_override || MigrationTimeouts.config.default_lock_timeout
+    end
+
+    def statement_timeout
+      self.class.statement_timeout_override || MigrationTimeouts.config.default_statement_timeout
+    end
+  end
+end

data/lib/migration_timeouts/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MigrationTimeouts
+  VERSION = "0.0.1"
+end

data/migration_timeouts.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "migration_timeouts/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "migration_timeouts"
+  spec.version       = MigrationTimeouts::VERSION
+  spec.authors       = [ "Jordan Minneti" ]
+  spec.email         = [ "jordan.minneti@freshly.com" ]
+
+  spec.summary       = "Ruby gem that adds configurable statement and lock timeouts to Active Record migrations"
+  spec.description   = "Ruby gem that automatically adds configurable statement and lock timeouts to all Active Record migrations"
+  spec.homepage      = "http://github.com/Freshly/migration_timeouts"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = [ "lib" ]
+
+  spec.add_development_dependency "pg", "< 1.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 11.2.2"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "activerecord", ">= 4.0", "< 7.0"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: migration_timeouts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Minneti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: Ruby gem that automatically adds configurable statement and lock timeouts
+  to all Active Record migrations
+email:
+- jordan.minneti@freshly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/migration_timeouts.rb
+- lib/migration_timeouts/config.rb
+- lib/migration_timeouts/migration_extensions.rb
+- lib/migration_timeouts/timeout_manager.rb
+- lib/migration_timeouts/version.rb
+- migration_timeouts.gemspec
+homepage: http://github.com/Freshly/migration_timeouts
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Ruby gem that adds configurable statement and lock timeouts to Active Record
+  migrations
+test_files: []