activerecord-pgtimeout 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8aa74a8beb7f744fbd2f5d64a7ff91d690beae0
+  data.tar.gz: 498a0a1f244c35fc1adb30d4a1d4239a782de6f1
+SHA512:
+  metadata.gz: f50d3ec09d7ca11a2f5603e613010ba4dddbeab55e9a5051cb0979c7c962614dab785a8e7de465dcabd3bb488267632664b431bde88bf742bd8a6a8e5d7d3456
+  data.tar.gz: 64ffcfa9c824b57e87195c86cb3f1f0cd1f6a00514c99c3b3b7750717551bc92256950c314f2ea3baa8a10bc136b83309b1cf08b93b24d5162672d8f25026edf

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,51 @@
+# ActiveRecord::PgTimeout
+
+This provides a way to wrap one action in a database transaction that will timeout in a pre-configured time. When the operation times out the transaction is cancelled and a custom handler is executed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pgtimeout'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-pgtimeout
+
+## Usage
+
+Given that there is an ActiveRecord model called `User`, and I want to fetch all users under 10 seconds:
+
+```ruby 
+timeoutable_executor = new ActiveRecord::PgTimeout.new(10_000)
+users = timeoutable_executor.execute(->{ User.all }, ->{ puts "Timed out user loading"; [] })
+```
+
+The threshold is defined in milliseconds, if the users cannot be fecthed in the configured time the timeout handler lambda will be evaluated and returned.
+In the example above whenever the timeout occurs we display a message in the console and return an empty collection.
+
+
+In most use cases we want to handle the timeout case, but whenever we have a global timeout defined, it might be useful to disable the timeout inside our block and ignore the timeout handler. Consider a database with a default timeout of 60 seconds, and we want to execute a long running migration that need to run for as long as it is needed.
+We could write such migration like this:
+
+```ruby 
+timeoutable_executor = new ActiveRecord::PgTimeout.new(0)
+timeoutable_executor.execute(->{ execute "CREATE TABLE long_running AS SELECT * FROM pg_sleep(90);" })
+```
+
+## 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. Please always provide concrete use cases with any feature request or bug report.
+

data/Rakefile

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

data/activerecord-pgtimeout.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/pgtimeout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-pgtimeout"
+  spec.version       = ActiveRecord::PgTimeout::VERSION
+  spec.authors       = ["Diogo Biazus", "Marios Koulakis"]
+  spec.email         = ["diogob@nulogy.com", "mariosk@nulogy.com"]
+
+  spec.summary       = %q{Allows the use of custom timeout settings within the context of a PostgreSQL transaction.}
+  spec.description   = %q{This gem provides a very simple interface where one can wrap a lambda within a timeoutable transaction and pass a custom handler along it}
+  spec.homepage      = "https://gitlab.hq.nulogy.com/diogob/activerecord-pg-timeout"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0"
+  spec.add_dependency "pg"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/pgtimeout"
+
+# 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/activerecord/pgtimeout/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class PgTimeout
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/pgtimeout.rb

@@ -0,0 +1,26 @@
+require "active_record"
+
+module ActiveRecord
+  class PgTimeout
+    attr_reader :timeout
+
+    def initialize(timeout, connection = ActiveRecord::Base.connection)
+      @connection = connection
+      @timeout = timeout
+    end
+
+    def execute(timeoutable_action, on_timeout)
+      @connection.transaction do
+        @connection.execute("set local statement_timeout to '#{timeout.to_i}ms'")
+        timeoutable_action.()
+      end
+
+    rescue ActiveRecord::StatementInvalid => e
+      if e.original_exception.result.error_field(PG::Result::PG_DIAG_SQLSTATE) == "57014"
+        on_timeout.()
+      else
+        raise e
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pgtimeout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Diogo Biazus
+- Marios Koulakis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem provides a very simple interface where one can wrap a lambda
+  within a timeoutable transaction and pass a custom handler along it
+email:
+- diogob@nulogy.com
+- mariosk@nulogy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-pgtimeout.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord/pgtimeout.rb
+- lib/activerecord/pgtimeout/version.rb
+homepage: https://gitlab.hq.nulogy.com/diogob/activerecord-pg-timeout
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Allows the use of custom timeout settings within the context of a PostgreSQL
+  transaction.
+test_files: []