cypress-rails 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67672b89666277b05b54d43d809daf48bd66c4c3d4b24bc52792994c378ffc6a
-  data.tar.gz: 20559b13133e2e32c777bb41b88607d7250ecd2281458fc60cc3ea5dee95cebf
+  metadata.gz: 681b1824ae1ff6588b7c118c9887e57a16e86ea4d2b09b0ba732074790a9c6c5
+  data.tar.gz: d41e3c0ff8e1a3ea9dcbd3532d70b5939520592bc5de5c9efdcb0bfb30901173
 SHA512:
-  metadata.gz: 918352bf0a54236e1fafad16ab19d5f4a9a787278bd82e1386361076b1ba6f189ef2ccafd59d8f2545c4e32b0e34aa80ba33065a15ae2958df48e8078e1b685f
-  data.tar.gz: eccdf2b27a8f41d2e158060596856ec455d2d66f2c59b114db70aa47265a5f8ba3030fd435fafe5c8d78cc4390f5a26ef2cbd05f8916fb6a66ae4a761085f4e7
+  metadata.gz: 36a951154b585e565a47d3f90132f10c060b03a7e232e6c7e93a5b71779b902e655577afa1d8826f1522eadc559aee64b8f9afd1c0ccd766295a81c3bbe0c1aa
+  data.tar.gz: 750298885263db32dd288eeaa693157e9cd4e1777c7e2f3843020d4d3827dff51d44c33e81451e4af7ace3e5e5cb5283dfd64f5b347e5b9d71bacf2baac4659a

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# CHANGELOG
+
+## 0.1.0
+
+* **[Breaking]** Remove `CypressRails::TestCase`. Use `rake cypress:run` instead
+* **[Breaking]** cypress-rails now starts a transaction immediately after
+  launching the server, which could result in other processes not being able
+  to observe your changes. To revert to the old behavior, set the env var
+  `CYPRESS_RAILS_TRANSACTIONAL_SERVER=false`
+* Add configuration variables `CYPRESS_RAILS_DIR`,
+  `CYPRESS_RAILS_TRANSACTIONAL_SERVER`. Rename port and Cypress CLI forwarding
+  to `CYPRESS_RAILS_PORT` and `CYPRESS_RAILS_CYPRESS_OPTS`
+* Add test data configuration hooks (to be run in an initializer):
+  * `CypressRails.hooks.before_server_start`
+  * `CypressRails.hooks.after_transaction_start`
+  * `CypressRails.hooks.after_state_reset` - after a transaction rollback
+  * `CypressRails.hooks.before_server_stop` - called in an `at_exit` hook
+
+## 0.0.4
+
+* Started a changelog

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cypress-rails (0.0.4)
+    cypress-rails (0.1.0)
       capybara
       railties (>= 5.2.0)
       selenium-webdriver
@@ -9,29 +9,30 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
+    actionpack (6.0.2.1)
+      actionview (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.2.1)
+      activesupport (= 6.0.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.3)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
-    builder (3.2.3)
-    capybara (3.29.0)
+    builder (3.2.4)
+    capybara (3.31.0)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
@@ -40,66 +41,67 @@ GEM
       regexp_parser (~> 1.5)
       xpath (~> 3.2)
     childprocess (3.0.0)
-    concurrent-ruby (1.1.5)
-    crass (1.0.5)
-    erubi (1.8.0)
-    i18n (1.6.0)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    loofah (2.3.1)
+    jaro_winkler (1.5.4)
+    loofah (2.4.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.8)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    parallel (1.17.0)
-    parser (2.6.4.1)
+    parallel (1.19.1)
+    parser (2.7.0.4)
       ast (~> 2.4.0)
-    public_suffix (4.0.1)
-    rack (2.0.8)
+    public_suffix (4.0.3)
+    rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.2.0)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.1)
+      actionpack (= 6.0.2.1)
+      activesupport (= 6.0.2.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.6.0)
-    rubocop (0.72.0)
+    regexp_parser (1.7.0)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-performance (1.4.1)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
     ruby-progressbar (1.10.1)
     rubyzip (2.2.0)
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
-    standard (0.1.3)
-      rubocop (~> 0.72.0)
-      rubocop-performance (~> 1.4.0)
+    standard (0.2.0)
+      rubocop (~> 0.79.0)
+      rubocop-performance (~> 1.5.1)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.6)
       thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.6.1)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -111,7 +113,7 @@ DEPENDENCIES
   cypress-rails!
   minitest (~> 5.0)
   rake (~> 13.0)
-  standard (~> 0.1.3)
+  standard (>= 0.2.0)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -129,16 +129,16 @@ So, by running either:
 $ cypress-rails open
 ```
 
-Or, if you don't mind the extra cost of loading rake just so it can call
-`system`:
+Or:
 
 ```
 $ rake cypress:open
 ```
 
-Add tests to `cypress/integration`. Simply click a test file in the Cypress
-application window to launch the test in a browser. Each time you save the test
-file, it will re-run itself.
+Any JavaScript files added to `cypress/integration` will be identified by
+Cypress as tests. Simply click a test file in the Cypress application window to
+launch the test in a browser. Each time you save the test file, it will re-run
+itself.
 
 ### Run tests headlessly with `cypress run`
 
@@ -155,50 +155,116 @@ Or, with rake:
 $ rake cypress:run
 ```
 
-### Pass options to cypress run or open
+## Managing your test data
 
-Options can be provided to `cypress run` and `cypress open` using the
-`CYPRESS_OPTS` environment variable
+The tricky thing about browser tests is that they usually depend on some test
+data being available with which to exercise the app efficiently. Because cypress
+is a JavaScript-based tool and can't easily manipulate your Rails app directly,
+cypress-rails provides a number of hooks that you can use to manage your test
+data.
 
-```
-rake cypress:run CYPRESS_OPTS="--record --key=abc123 --parallel"
-```
+Here's what a `config/initializers/cypress_rails.rb` initializer might look
+like:
 
-### Write Ruby tests that wrap and invoke your cypress tests
+```ruby
+return unless Rails.env.test?
 
-You can also extend a provided `CypressRails::TestCase`, which itself inherits
-from Rails' built-in `ActionDispatch::SystemTestCase`.
+CypressRails.hooks.before_server_start do
+  # Called once, before ether the transaction or the server is started
+end
 
-That means you can add a test named `test/system/cypress_test.rb`:
+CypressRails.hooks.after_transaction_start do
+  # Called after the transaction is started (at launch and after each reset)
+end
 
-```ruby
-require "test_helper"
+CypressRails.hooks.after_state_reset do
+  # Triggered after `/cypress_rails_reset_state` is called
+end
 
-class CypressTest < CypressRails::TestCase
-  test_locator "cypress/integration/**/*.js"
+CypressRails.hooks.before_server_stop do
+  # Called once, at_exit
 end
 ```
 
-And it will run alongside all the rest of your system tests. Because this would
-be invoked by your existing test scripts, you can benefit from whatever custom
-test helpers (e.g. database setup, test coverage, etc.) your other full-stack
-tests need, as well as specifying custom `setup` and `teardown` directives.
+(You can find [an
+example
+initializer](/example/an_app/config/initializers/cypress_rails_initializer.rb)
+in this repo.)
 
-Each Cypress file matched by the `test_locator` is translated to a single test
-case, which—while slightly inefficient, as it spools Cypress up and down
-multiple times—also makes it easy to handle each Cypress file as you would any
-other Ruby test. It also allows for CLI usage like this (where the test name is
-an expansion of the file location with the path separators replaced with `_`):
+The gem also provides a special route on the test server:
+`/cypress_rails_reset_state`. Each time it's called, cypress-rails will do
+two things at the beginning of the next request received by the Rails app:
 
+* If `CYPRESS_RAILS_TRANSACTIONAL_SERVER` is enabled, roll back the transaction,
+effectively resetting the application state to whatever it was at the start of
+the test run
+
+* Trigger any `after_state_reset` hooks you've configured (regardless of the
+  transactional server setting)
+
+This way, you can easily instruct the server to reset its test state from your
+Cypress tests like so:
+
+```js
+beforeEach(() =>
+  cy.request('/cypress_rails_reset_state')
+)
 ```
-$ rails test test/system --name test_cypress_integration_send_invoice_js
-```
 
-**WARNING**: keep in mind that any custom Ruby code you add before or after each
-Cypress test is run in the context of a `CypressRails::TestCase` will _not_ be
-run when developing with `cypress open`! That means this is probably not the
-most rock-solid strategy for consistent test behavior when it comes to things
-like test data management.
+(Remember, in Cypress, `before` is a before-all hook and `beforeEach` is run
+between each test case!)
+
+## Configuration
+
+### Environment variables
+
+The cypress-rails gem is configured entirely via environment variables. If you
+find yourself repeating a number of verbose environment variables as you run
+your tests, consider invoking the gem from a custom script or setting your
+preferred environment variables project-wide using a tool like
+[dotenv](https://github.com/bkeepers/dotenv).
+
+
+* **CYPRESS_RAILS_DIR** (default: `Dir.pwd`) the directory of your project
+* **CYPRESS_RAILS_PORT** (default: _a random available port_) the port to run
+  the Rails test server on
+* **CYPRESS_RAILS_TRANSACTIONAL_SERVER** (default: `true`) when true, will start
+  a transaction on all database connections before launching the server. In
+  general this means anything done during `cypress open` or `cypress run` will
+  be rolled back on exit (similar to running a Rails System test)
+* **CYPRESS_RAILS_CYPRESS_OPTS** (default: _none_) any options you want to
+  forward to the Cypress CLI when running its `open` or `run` commands
+
+### Initializer hooks
+
+### before_server_start
+
+Pass a block to `CypressRails.hooks.before_server_start` to register a hook that
+will execute before the server or any transaction has been started. If you use
+Rails fixtures, it may make sense to load them here, so they don't need to be
+re-inserted for each request
+
+### after_transaction_start
+
+If there's any custom behavior or state management you want to do inside the
+transaction (so that it's also rolled back each time a reset is triggered),
+pass a block to `CypressRails.hooks.after_transaction_start`.
+
+### after_state_reset
+
+Every time the test server receives an HTTP request at
+`/cypress_rails_reset_state`, the transaction will be rolled back (if
+`CYPRESS_RAILS_TRANSACTIONAL_SERVER` is enabled) and the `after_state_reset`
+hook will be triggered. To set up the hook, pass a block to
+`CypressRails.hooks.after_state_reset`.
+
+### before_server_stop
+
+In case you've made any permanent changes to your test database that could
+pollute other test suites or scripts, you can use the `before_server_stop` to
+(assuming everything exits gracefully) clean things up and restore the state
+of your test database. To set up the hook, pass a block to
+`CypressRails.hooks.before_server_stop`.
 
 ### Setting up continuous integration
 
@@ -251,9 +317,3 @@ jobs:
       - run: bin/rake cypress:run
 ```
 
-## Configuration
-
-You can change the behavior of this gem by setting these environment variables:
-
-* **RAILS_CYPRESS_PORT**: the port to run the Rails test server on (defaults to
-  a random available port

data/cypress-rails.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "standard", "~> 0.1.3"
+  spec.add_development_dependency "standard", ">= 0.2.0"
   spec.add_development_dependency "actionpack"
   spec.add_development_dependency "capybara"
 end

data/exe/cypress-rails

@@ -2,8 +2,8 @@
 
 ENV["RAILS_ENV"] = "test"
 require "pathname"
-require Pathname.new(Dir.pwd).join("config/environment")
 require "cypress-rails"
+require Pathname.new(CypressRails::Config.new.dir).join("config/environment")
 
 command = ARGV[0]
 case command

data/lib/cypress-rails/config.rb

@@ -0,0 +1,27 @@
+require_relative "env"
+
+module CypressRails
+  class Config < Struct.new(:dir, :port, :transactional_server, :cypress_cli_opts, keyword_init: true)
+    def initialize(
+      dir: Env.fetch("CYPRESS_RAILS_DIR", default: Dir.pwd),
+      port: Env.fetch("CYPRESS_RAILS_PORT"),
+      transactional_server: Env.fetch("CYPRESS_RAILS_TRANSACTIONAL_SERVER", type: :boolean, default: true),
+      cypress_cli_opts: Env.fetch("CYPRESS_RAILS_CYPRESS_OPTS", default: "")
+    )
+      super
+    end
+
+    def to_s
+      <<~DESC
+
+        cypress-rails configuration:
+        ============================
+         CYPRESS_RAILS_DIR.....................#{dir.inspect}
+         CYPRESS_RAILS_PORT....................#{port.inspect}
+         CYPRESS_RAILS_TRANSACTIONAL_SERVER....#{transactional_server.inspect}
+         CYPRESS_RAILS_CYPRESS_OPTS............#{cypress_cli_opts.inspect}
+
+      DESC
+    end
+  end
+end

data/lib/cypress-rails/configures_test_server.rb

@@ -1,6 +1,6 @@
 module CypressRails
   class ConfiguresTestServer
-    def call(port: ENV["RAILS_CYPRESS_PORT"])
+    def call(port:)
       require "capybara"
       require "selenium-webdriver"
       Capybara.server_port = port || find_available_port

data/lib/cypress-rails/env.rb

@@ -0,0 +1,17 @@
+module CypressRails
+  module Env
+    def self.fetch(name, type: :string, default: nil)
+      return default unless ENV.key?(name)
+
+      if type == :boolean
+        if ["", "0", "n", "no", "false"].include?(ENV.fetch(name))
+          false
+        else
+          true
+        end
+      else
+        ENV.fetch(name)
+      end
+    end
+  end
+end

data/lib/cypress-rails/init.rb

@@ -3,7 +3,7 @@ module CypressRails
     DEFAULT_CONFIG = {
       "screenshotsFolder" => "tmp/cypress_screenshots",
       "videosFolder" => "tmp/cypress_videos",
-      "trashAssetsBeforeRuns" => false,
+      "trashAssetsBeforeRuns" => false
     }
 
     def call(dir = Dir.pwd)

data/lib/cypress-rails/initializer_hooks.rb

@@ -0,0 +1,49 @@
+module CypressRails
+  def self.hooks
+    InitializerHooks.instance
+  end
+
+  class InitializerHooks
+    def self.instance
+      @instance ||= new
+    end
+
+    def before_server_start(&blk)
+      register(:before_server_start, blk)
+    end
+
+    def after_transaction_start(&blk)
+      register(:after_transaction_start, blk)
+    end
+
+    def after_state_reset(&blk)
+      register(:after_state_reset, blk)
+    end
+
+    def before_server_stop(&blk)
+      register(:before_server_stop, blk)
+    end
+
+    def reset!
+      @hooks = {}
+    end
+
+    def run(name)
+      return unless @hooks[name]
+      @hooks[name].each do |blk|
+        blk.call
+      end
+    end
+
+    private
+
+    def register(name, blk)
+      @hooks[name] ||= []
+      @hooks[name] << blk
+    end
+
+    def initialize
+      reset!
+    end
+  end
+end

data/lib/cypress-rails/launches_cypress.rb

@@ -0,0 +1,36 @@
+require_relative "finds_bin"
+require_relative "config"
+require_relative "initializer_hooks"
+require_relative "manages_transactions"
+require_relative "starts_rails_server"
+
+module CypressRails
+  class LaunchesCypress
+    def initialize
+      @initializer_hooks = InitializerHooks.instance
+      @manages_transactions = ManagesTransactions.instance
+      @starts_rails_server = StartsRailsServer.new
+      @finds_bin = FindsBin.new
+    end
+
+    def call(command, config)
+      puts config.to_s
+      @initializer_hooks.run(:before_server_start)
+      if config.transactional_server
+        @manages_transactions.begin_transaction
+      end
+      @starts_rails_server.call(
+        port: config.port,
+        transactional_server: config.transactional_server
+      )
+      bin = @finds_bin.call(config.dir)
+      at_exit do
+        @initializer_hooks.run(:before_server_stop)
+      end
+
+      system <<~EXEC
+        CYPRESS_BASE_URL=http://#{Capybara.server_host}:#{Capybara.server_port} #{bin} #{command} --project "#{config.dir}" #{config.cypress_cli_opts}
+      EXEC
+    end
+  end
+end

data/lib/cypress-rails/manages_transactions.rb

@@ -0,0 +1,85 @@
+require_relative "initializer_hooks"
+
+module CypressRails
+  class ManagesTransactions
+    def self.instance
+      @instance ||= new
+    end
+
+    def begin_transaction
+      @connections = gather_connections
+      @connections.each do |connection|
+        connection.begin_transaction joinable: false, _lazy: false
+        connection.pool.lock_thread = true
+      end
+
+      # When connections are established in the future, begin a transaction too
+      @connection_subscriber = ActiveSupport::Notifications.subscribe("!connection.active_record") { |_, _, _, _, payload|
+        if payload.key?(:spec_name) && (spec_name = payload[:spec_name])
+          setup_shared_connection_pool
+
+          begin
+            connection = ActiveRecord::Base.connection_handler.retrieve_connection(spec_name)
+          rescue ConnectionNotEstablished
+            connection = nil
+          end
+
+          if connection && !@connections.include?(connection)
+            connection.begin_transaction joinable: false, _lazy: false
+            connection.pool.lock_thread = true
+            @connections << connection
+          end
+        end
+      }
+
+      @initializer_hooks.run(:after_transaction_start)
+    end
+
+    def rollback_transaction
+      return unless @connections.present?
+
+      ActiveSupport::Notifications.unsubscribe(@connection_subscriber) if @connection_subscriber
+
+      @connections.each do |connection|
+        connection.rollback_transaction if connection.transaction_open?
+        connection.pool.lock_thread = false
+      end
+      @connections.clear
+
+      ActiveRecord::Base.clear_active_connections!
+    end
+
+    private
+
+    def initialize
+      @initializer_hooks = InitializerHooks.instance
+    end
+
+    def gather_connections
+      setup_shared_connection_pool
+
+      ActiveRecord::Base.connection_handler.connection_pool_list.map(&:connection)
+    end
+
+    # Shares the writing connection pool with connections on
+    # other handlers.
+    #
+    # In an application with a primary and replica the test fixtures
+    # need to share a connection pool so that the reading connection
+    # can see data in the open transaction on the writing connection.
+    def setup_shared_connection_pool
+      writing_handler = ActiveRecord::Base.connection_handler
+
+      ActiveRecord::Base.connection_handlers.values.each do |handler|
+        if handler != writing_handler
+          handler.connection_pool_list.each do |pool|
+            name = pool.spec.name
+            writing_connection = writing_handler.retrieve_connection_pool(name)
+            return nil unless writing_connection
+            handler.send(:owner_to_pool)[name] = writing_connection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cypress-rails/open.rb

@@ -1,20 +1,14 @@
-require_relative "finds_bin"
-require_relative "starts_rails_server"
+require_relative "launches_cypress"
+require_relative "config"
 
 module CypressRails
   class Open
     def initialize
-      @starts_rails_server = StartsRailsServer.new
-      @finds_bin = FindsBin.new
+      @launches_cypress = LaunchesCypress.new
     end
 
-    def call(dir: Dir.pwd, port: ENV["RAILS_CYPRESS_PORT"], opts: ENV["CYPRESS_OPTS"])
-      @starts_rails_server.call(dir: dir, port: port)
-      bin = @finds_bin.call(dir)
-
-      system <<~EXEC
-        CYPRESS_BASE_URL=http://#{Capybara.server_host}:#{Capybara.server_port} #{bin} open --project "#{dir}" #{opts}
-      EXEC
+    def call(config = Config.new)
+      @launches_cypress.call("open", config)
     end
   end
 end

data/lib/cypress-rails/rake.rb

@@ -8,6 +8,10 @@ end
 
 desc "Open interactive Cypress app for developing tests"
 task :"cypress:open" do
+  trap("SIGINT") do
+    puts "Exiting cypress:open"
+    exit
+  end
   system "#{CLI} open"
 end
 

data/lib/cypress-rails/resets_state.rb

@@ -0,0 +1,20 @@
+require_relative "config"
+require_relative "manages_transactions"
+require_relative "initializer_hooks"
+
+module CypressRails
+  class ResetsState
+    def initialize
+      @manages_transactions = ManagesTransactions.instance
+      @initializer_hooks = InitializerHooks.instance
+    end
+
+    def call(transactional_server:)
+      if transactional_server
+        @manages_transactions.rollback_transaction
+        @manages_transactions.begin_transaction
+      end
+      @initializer_hooks.run(:after_state_reset)
+    end
+  end
+end

data/lib/cypress-rails/run.rb

@@ -1,20 +1,14 @@
-require_relative "finds_bin"
-require_relative "starts_rails_server"
+require_relative "launches_cypress"
+require_relative "config"
 
 module CypressRails
   class Run
     def initialize
-      @starts_rails_server = StartsRailsServer.new
-      @finds_bin = FindsBin.new
+      @launches_cypress = LaunchesCypress.new
     end
 
-    def call(dir: Dir.pwd, port: ENV["RAILS_CYPRESS_PORT"], opts: ENV["CYPRESS_OPTS"])
-      @starts_rails_server.call(dir: dir, port: port)
-      bin = @finds_bin.call(dir)
-
-      system <<~EXEC
-        CYPRESS_BASE_URL=http://#{Capybara.server_host}:#{Capybara.server_port} #{bin} run --project "#{dir}" #{opts}
-      EXEC
+    def call(config = Config.new)
+      @launches_cypress.call("run", config)
     end
   end
 end

data/lib/cypress-rails/starts_rails_server.rb

@@ -1,4 +1,5 @@
 require_relative "configures_test_server"
+require_relative "tracks_resets"
 
 module CypressRails
   class StartsRailsServer
@@ -6,27 +7,51 @@ module CypressRails
       @configures_test_server = ConfiguresTestServer.new
     end
 
-    def call(dir:, port:)
+    def call(port:, transactional_server:)
       @configures_test_server.call(port: port)
+      configure_driver!
+      configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
+      Capybara.app = create_capybara_rack_app
+      start_system_testing_server!
+      Capybara.current_session
+    end
+
+    private
 
+    def configure_driver!
+      # this is only necessary b/c we're piggybacking on the capybara server
       require "action_dispatch/system_testing/driver"
       require "action_dispatch/system_testing/browser"
       ActionDispatch::SystemTesting::Driver.new(:selenium, {
         using: :headless_chrome,
         screen_size: [1400, 1400],
-        options: {},
+        options: {}
       }).use
+    end
 
-      Capybara.app = Rack::Builder.new do
+    def configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
+      Rails.application.executor.to_run do
+        TracksResets.instance.reset_state_if_needed(transactional_server)
+      end
+    end
+
+    def create_capybara_rack_app
+      Rack::Builder.new do
+        map "/cypress_rails_reset_state" do
+          run lambda { |env|
+            TracksResets.instance.reset_needed!
+            [202, {"Content-Type" => "text/plain"}, ["Accepted"]]
+          }
+        end
         map "/" do
           run Rails.application
         end
       end
+    end
 
+    def start_system_testing_server!
       require "action_dispatch/system_testing/server"
       ActionDispatch::SystemTesting::Server.new.run
-
-      Capybara.current_session
     end
   end
 end

data/lib/cypress-rails/tracks_resets.rb

@@ -0,0 +1,26 @@
+require_relative "resets_state"
+
+module CypressRails
+  class TracksResets
+    def self.instance
+      @instance ||= new
+    end
+
+    def reset_needed!
+      @reset_needed = true
+    end
+
+    def reset_state_if_needed(transactional_server)
+      if @reset_needed
+        ResetsState.new.call(transactional_server: transactional_server)
+        @reset_needed = false
+      end
+    end
+
+    private
+
+    def initialize
+      @reset_needed = false
+    end
+  end
+end

data/lib/cypress-rails/version.rb

@@ -1,3 +1,3 @@
 module CypressRails
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/lib/cypress-rails.rb

@@ -6,5 +6,6 @@ end
 require "cypress-rails/init"
 require "cypress-rails/open"
 require "cypress-rails/run"
-require "cypress-rails/test_case"
+require "cypress-rails/resets_state"
+require "cypress-rails/initializer_hooks"
 require "cypress-rails/railtie" if defined?(Rails)

data/script/test_example_app

@@ -12,7 +12,7 @@ yarn install
 bundle exec rake cypress:run
 
 # test that passing options works (by printing help)
-if ! bundle exec rake cypress:run CYPRESS_OPTS="-h" | grep -q "Usage: run \[options\]"; then
+if ! bundle exec rake cypress:run CYPRESS_RAILS_CYPRESS_OPTS="-h" | grep -q "Usage: cypress run \[options\]"; then
   echo "Failed to pass options to cypress run"
   exit 1
 fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-01 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -98,16 +98,16 @@ dependencies:
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +148,7 @@ files:
 - ".gitignore"
 - ".standard.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -158,15 +159,21 @@ files:
 - cypress-rails.gemspec
 - exe/cypress-rails
 - lib/cypress-rails.rb
+- lib/cypress-rails/config.rb
 - lib/cypress-rails/configures_test_server.rb
+- lib/cypress-rails/env.rb
 - lib/cypress-rails/finds_bin.rb
 - lib/cypress-rails/init.rb
+- lib/cypress-rails/initializer_hooks.rb
+- lib/cypress-rails/launches_cypress.rb
+- lib/cypress-rails/manages_transactions.rb
 - lib/cypress-rails/open.rb
 - lib/cypress-rails/railtie.rb
 - lib/cypress-rails/rake.rb
+- lib/cypress-rails/resets_state.rb
 - lib/cypress-rails/run.rb
 - lib/cypress-rails/starts_rails_server.rb
-- lib/cypress-rails/test_case.rb
+- lib/cypress-rails/tracks_resets.rb
 - lib/cypress-rails/version.rb
 - script/test_example_app
 homepage: https://github.com/testdouble/cypress-rails

data/lib/cypress-rails/test_case.rb

@@ -1,34 +0,0 @@
-require "action_dispatch/system_test_case"
-
-require_relative "configures_test_server"
-
-module CypressRails
-  class TestCase < ActionDispatch::SystemTestCase
-    driven_by :selenium_headless
-
-    def setup
-      @@__cypress_rails_configures_test_server ||= ConfiguresTestServer.new.call
-    ensure
-      super
-    end
-
-    def self.test_locator(path_or_globs)
-      Dir[path_or_globs].map do |path|
-        test_name = "test_#{path.gsub(/[\/\.:\\]/, "_")}"
-        define_method test_name do
-          bin = FindsBin.new.call
-          command = "CYPRESS_BASE_URL=http://#{Capybara.server_host}:#{Capybara.server_port} #{bin} run --spec \"#{path}\""
-          unless system(command)
-            raise <<~ERROR
-              Cypress test failed. Try again with:
-                $ rails test test/system --name #{test_name}
-
-              Underlying Cypress command run was:
-                $ #{command}
-            ERROR
-          end
-        end
-      end
-    end
-  end
-end