rack_request_blocker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd8daaa9167b20955f101d46c2cd3704662bbd0d
+  data.tar.gz: 76ef0f2690f361bd96a8eb120203290b0f16b041
+SHA512:
+  metadata.gz: fcb945a9a11eafa3890f62e97a51b1c9b40e51f0ad4e10ab368638ad5102af9def9255fc5710b07568d36597cfe1f7a67028ab0f773e27c93827ff6788ce4f4d
+  data.tar.gz: e1108cb8c063a3a1f5c6857f284f1fc5c6a7cb0d7845aa7d083a0f8bedea15e3df60a2868133075df9cfd71606a0da068a12840afbce246c25a6a4dee6563d4f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jonathan Rochkind
+
+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,71 @@
+# RackRequestBlocker
+
+Handle race conditions in Rails JS feature tests caused by outstanding overlapping actions in your app, with rack middleware to let you wait for pending feature test actions to finish.
+
+For background on why this might be a problem you want to handle, see:
+* http://blog.salsify.com/engineering/tearing-capybara-ajax-tests
+* https://bibwild.wordpress.com/2016/02/18/struggling-towards-reliable-capybara-javascript-testing/
+
+This gem is based on a concept and code [originally by Joel Turkel](http://blog.salsify.com/engineering/tearing-capybara-ajax-tests), but updated to use [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby) as a dependency, with signal/wait logic instead of polling.
+
+**WARNING**: This code is somewhat experimental, concurrency is hard, it may have bugs. It currently
+has no automated tests (testing concurrency is painful). But it's working for me, and you
+only use it in test environment anyway, so if you're suffering from horrible race
+conditions in test, it's worth a shot to see if it helps, and entails little risk.
+It's also only a few dozen lines of code in one class, please do look at the source. 
+
+## Installation/Usage
+
+1. Add this line to your application's Gemfile:
+
+    ```ruby
+    gem 'rack_request_blocker'
+    ```
+
+    And then execute:
+
+        $ bundle
+
+    Or install it yourself as:
+
+        $ gem install rack_request_blocker
+
+2. Add this to your `./config/environments/test.rb`, to add the custom middleware in test env:
+
+    ~~~ruby
+    require 'rack_request_blocker'
+    config.middleware.insert_before 0, RackRequestBlocker
+    ~~~
+
+3. Add this to your `spec_helper.rb`/`rails_helper.rb`
+
+    Add _before_ your `DatabaseCleaner.clean` command, probably in a `before(:each)`:
+
+    ~~~ruby
+    if example.metadata[:js] || example.metadata[:driver] != :rack_test
+      RackRequestBlocker.wait_for_no_active_requests(for_example: example)
+    end
+    ~~~
+
+    This says for each JS test, block incoming requests to the embedded dummy Rails app,
+    and then wait until any in-progress request actions are complete, before proceeding
+    (to your `DatabaseCleaner.clean`, and then on to the next test. ) It relies on the
+    custom middleware to be able to do so.
+
+## Will this take care of all my unreliable test issues?
+
+I found I **also** needed to stop using transactional testing *entirely*.
+No `:transaction` strategy for DatabaseCleaner *at all*, in *addition* to this
+middle-ware, to get reliable tests.
+
+I can't explain why: Using transactional strategy for *non-JS tests*, as
+DatabaseCleaner recommends *ought* to work. But it didn't, and I even got
+some segfaults(!) with only the middleware but still transactional strategy
+for non-JS tests.  Could be a bug in MRI or the pg or poltegeist gems (segfault, really?),
+or capybara, databasecleaner, or the test_after_commit gem we were using
+with transactional testing strategy. I dunno, debugging this stuff
+is *hard*... but this seems to have finally worked.
+
+If you are still having problems, I recommend consulting
+[my essay on an overview of the issues](https://bibwild.wordpress.com/2016/02/18/struggling-towards-reliable-capybara-javascript-testing/) for background and more ideas.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rack_request_blocker"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rack_request_blocker.rb

@@ -0,0 +1,84 @@
+require "rack_request_blocker/version"
+require 'concurrent'
+
+# Rack middleware that keeps track of the number of active requests and can block new requests.
+# http://blog.salsify.com/engineering/tearing-capybara-ajax-tests
+class RackRequestBlocker
+  @@num_active_requests = Concurrent::AtomicFixnum.new(0)
+  @@allowing_requests = Concurrent::Event.new.tap { |e| e.set }
+
+  # Returns the number of requests the server is currently processing.
+  def self.num_active_requests
+    @@num_active_requests.value
+  end
+
+  # Prevents the server from accepting new requests. Any new requests will return an HTTP
+  # 503 status.
+  def self.block_requests!
+    @@allowing_requests.reset
+  end
+
+  # Allows the server to accept requests again.
+  def self.allow_requests!
+    @@allowing_requests.set
+  end
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    increment_active_requests
+    if block_requests?
+      block_request(env)
+    else
+      @app.call(env)
+    end
+  ensure
+    decrement_active_requests
+  end
+
+
+
+  def self.wait_for_no_active_requests(max_wait_time: 10, for_example: nil, diagnostic_log: true)
+    RackRequestBlocker.block_requests!
+
+    unless num_active_requests == 0 || diagnostic_log == false
+      msg = "Waiting on #{num_active_requests} active requests"
+      msg += " for #{for_example.location}" if for_example
+      log msg
+    end
+
+    obtained = (num_active_requests == 0) || @@allowing_requests.wait(max_wait_time)
+    unless obtained
+      raise Timeout::Error, "rack_request_blocker gave up waiting #{max_wait_time}s for pending AJAX requests complete"
+    end
+  ensure
+    RackRequestBlocker.allow_requests!
+  end
+
+  private
+
+  def self.log(msg)
+    $stderr.puts "\nrack_request_blocker: #{msg}"
+  end
+
+  def block_requests?
+    ! @@allowing_requests.set?
+  end
+
+  def block_request(env)
+    [503, {}, ['Blocked by rack_request_blocker, requests blocked while waiting for in-progress requests to complete']]
+  end
+
+  def increment_active_requests
+    @@num_active_requests.increment
+  end
+
+  def decrement_active_requests
+    new_value = @@num_active_requests.decrement
+    if new_value == 0
+      RackRequestBlocker.allow_requests!
+    end
+  end
+end

data/lib/rack_request_blocker/version.rb

@@ -0,0 +1,3 @@
+class RackRequestBlocker
+  VERSION = "1.0.0"
+end

data/rack_request_blocker.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack_request_blocker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack_request_blocker"
+  spec.version       = RackRequestBlocker::VERSION
+  spec.authors       = ["Jonathan Rochkind"]
+  spec.email         = ["jonathan@dnil.net"]
+
+  spec.summary       = %q{Rack middleware to let you wait for pending feature test actions to finish}
+  spec.description   = %q{Handle race conditions in Rails JS feature tests caused by outstanding overlapping actions in your app, with rack middleware to let you wait for pending feature test actions to finish}
+  spec.homepage      = "https://github.com/friendsoftheweb/rack_request_blocker"
+  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 "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "concurrent-ruby", "~> 1.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: rack_request_blocker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Rochkind
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Handle race conditions in Rails JS feature tests caused by outstanding
+  overlapping actions in your app, with rack middleware to let you wait for pending
+  feature test actions to finish
+email:
+- jonathan@dnil.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack_request_blocker.rb
+- lib/rack_request_blocker/version.rb
+- rack_request_blocker.gemspec
+homepage: https://github.com/friendsoftheweb/rack_request_blocker
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rack middleware to let you wait for pending feature test actions to finish
+test_files: []