cypress-rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10c202bcac81adf32af13a29cdbfde32a2d944682d8861697974315d93b9736
-  data.tar.gz: 6bbbe194f98a68083eed91f9afe9f8d3ffb2b7614e5693729a6d850f1b2fb443
+  metadata.gz: b33dbd1979a98b1861627988fa032b18348f43c6f38844437026db52b2aa3811
+  data.tar.gz: 90f192c528beda78245b68791e58ee91f7d0d24a4821d0dcd9a54f471ca00540
 SHA512:
-  metadata.gz: 81e80ecb7397220ed6f4ab28d8d61136ebfc942c21499b6b0baea4b11ecf63d7b316b51d1cf91c5d44dbd6be00160dace8dcd2b1a1a4018d5fabe44934ab3c36
-  data.tar.gz: 0f74877fc5882dddfe2deec98f22d20296a2db572a83bd162649a13f64d4767810f52da1abd923c87ea849662b3e82ab04c8c4dba0a6457379a1c1f35bb067e4
+  metadata.gz: 80b6ac651dd318df4f95d243b50116e1a28db6afdde2c78fbb4d9b21c7e83785c6777afb346d24cae3a5f69baa1149dabe72e8fa227e118487b10fadba88c414
+  data.tar.gz: e3b3a56a658d0f74c89011a1aa193b0e449c9db6ace90daf9cfcfa93f31b473497e6af9f6e3f5ef0e2a25f7869e14b5189be9b16298edbdc7d8f5aa3cbe83e65

data/.circleci/config.yml

@@ -33,9 +33,9 @@ jobs:
       # Yarn dependencies
       - restore_cache:
           keys:
-            - v1-yarn-{{ checksum "example/an_app/package.json" }}
+            - v2-yarn-{{ checksum "example/an_app/package.json" }}
             # fallback to using the latest cache if no exact match is found
-            - v1-yarn-
+            - v2-yarn-
 
       - run: |
           cd example/an_app
@@ -45,7 +45,7 @@ jobs:
           paths:
             - example/an_app/node_modules
             - ~/.cache
-          key: v1-yarn-{{ checksum "example/an_app/package.json" }}
+          key: v2-yarn-{{ checksum "example/an_app/package.json" }}
 
       - run: bundle exec rake
       - run: ./script/test_example_app

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 0.1.2
+
+* Drop the hard deps on capybara and selenium-webdrivers (instead inlining
+  portions of the Capybara server logic). Additionally, add a hard dep on puma
+  since this gem is useless without it
+
+## 0.1.1
+
+* Fix the `before_server_stop` hook by rolling back transactions first so that
+  it can clean out test data
+
 ## 0.1.0
 
 * **[Breaking]** Remove `CypressRails::TestCase`. Use `rake cypress:run` instead

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    cypress-rails (0.1.1)
-      capybara
+    cypress-rails (0.1.2)
+      puma (>= 3.8.0)
       railties (>= 5.2.0)
-      selenium-webdriver
 
 GEM
   remote: https://rubygems.org/
@@ -28,19 +27,8 @@ GEM
       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.4)
-    capybara (3.31.0)
-      addressable
-      mini_mime (>= 0.1.3)
-      nokogiri (~> 1.8)
-      rack (>= 1.6.0)
-      rack-test (>= 0.6.3)
-      regexp_parser (~> 1.5)
-      xpath (~> 3.2)
-    childprocess (3.0.0)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     erubi (1.9.0)
@@ -51,15 +39,16 @@ GEM
       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.14.0)
+    nio4r (2.5.2)
     nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.1)
     parser (2.7.0.4)
       ast (~> 2.4.0)
-    public_suffix (4.0.3)
+    puma (4.3.3)
+      nio4r (~> 2.0)
     rack (2.2.2)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -76,7 +65,6 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (13.0.1)
-    regexp_parser (1.7.0)
     rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -87,11 +75,7 @@ GEM
     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.2.0)
+    standard (0.2.1)
       rubocop (~> 0.79.0)
       rubocop-performance (~> 1.5.1)
     thor (1.0.1)
@@ -99,17 +83,13 @@ GEM
     tzinfo (1.2.6)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.1)
-    xpath (3.2.0)
-      nokogiri (~> 1.8)
     zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack
   bundler (~> 1.17)
-  capybara
   cypress-rails!
   minitest (~> 5.0)
   rake (~> 13.0)

data/LICENSE.txt

@@ -1,6 +1,10 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Test Double, LLC
+Copyright (c) 2019-2020 Test Double, LLC
+
+Portions of the CypressRails::Server component:
+Copyright (c) 2009-2018 Thomas Walpole, Jonas Nicklas
+
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -7,6 +7,14 @@ This is a simple gem to make it easier to start writing browser tests with
 regardless of whether your app is server-side rendered HTML, completely
 client-side JavaScript, or something in-between.
 
+## Installation
+
+**tl;dr**:
+
+1. Install the npm package `cypress`
+2. Install this gem `cypress-rails`
+3. Run `rake cypress:init`
+
 ### Installing Cypress itself
 
 The first step is making sure Cypress is installed (that's up to you, this
@@ -297,12 +305,5 @@ adopting Cypress and writing a bunch of browser tests for every application.
 But, if the above points sound like solutions to problems you experience, you
 might consider trying it out.
 
-## Installation
-
-**tl;dr**:
-
-1. Install the npm package `cypress`
-2. Install this gem `cypress-rails`
-3. Run `rake cypress:init`
 
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "cypress/rails"
+require "cypress-rails"
 
 # 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.

data/cypress-rails.gemspec

@@ -22,13 +22,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.2.0"
-  spec.add_dependency "capybara"
-  spec.add_dependency "selenium-webdriver"
+  spec.add_dependency "puma", ">= 3.8.0"
 
   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.2.0"
-  spec.add_development_dependency "actionpack"
-  spec.add_development_dependency "capybara"
 end

data/lib/cypress-rails/launches_cypress.rb

@@ -19,7 +19,7 @@ module CypressRails
       if config.transactional_server
         @manages_transactions.begin_transaction
       end
-      @starts_rails_server.call(
+      server = @starts_rails_server.call(
         port: config.port,
         transactional_server: config.transactional_server
       )
@@ -32,7 +32,7 @@ module CypressRails
       end
 
       system <<~EXEC
-        CYPRESS_BASE_URL=http://#{Capybara.server_host}:#{Capybara.server_port} #{bin} #{command} --project "#{config.dir}" #{config.cypress_cli_opts}
+        CYPRESS_BASE_URL=http://#{server.host}:#{server.port} #{bin} #{command} --project "#{config.dir}" #{config.cypress_cli_opts}
       EXEC
     end
   end

data/lib/cypress-rails/server/checker.rb

@@ -0,0 +1,42 @@
+module CypressRails
+  class Server
+    class Checker
+      TRY_HTTPS_ERRORS = [EOFError, Net::ReadTimeout, Errno::ECONNRESET].freeze
+
+      def initialize(host, port)
+        @host, @port = host, port
+        @ssl = false
+      end
+
+      def request(&block)
+        ssl? ? https_request(&block) : http_request(&block)
+      rescue *TRY_HTTPS_ERRORS
+        res = https_request(&block)
+        @ssl = true
+        res
+      end
+
+      def ssl?
+        @ssl
+      end
+
+      private
+
+      def http_request(&block)
+        make_request(read_timeout: 2, &block)
+      end
+
+      def https_request(&block)
+        make_request(**ssl_options, &block)
+      end
+
+      def make_request(**options, &block)
+        Net::HTTP.start(@host, @port, options.merge(max_retries: 0), &block)
+      end
+
+      def ssl_options
+        {use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE}
+      end
+    end
+  end
+end

data/lib/cypress-rails/server/middleware.rb

@@ -0,0 +1,67 @@
+module CypressRails
+  class Server
+    class Middleware
+      class Counter
+        def initialize
+          @value = []
+          @mutex = Mutex.new
+        end
+
+        def increment(uri)
+          @mutex.synchronize { @value.push(uri) }
+        end
+
+        def decrement(uri)
+          @mutex.synchronize { @value.delete_at(@value.index(uri) || @value.length) }
+        end
+
+        def positive?
+          @mutex.synchronize { @value.length.positive? }
+        end
+
+        def value
+          @mutex.synchronize { @value.dup }
+        end
+      end
+
+      attr_reader :error
+
+      def initialize(app, server_errors, extra_middleware = [])
+        @app = app
+        @extended_app = extra_middleware.inject(@app) { |ex_app, klass|
+          klass.new(ex_app)
+        }
+        @counter = Counter.new
+        @server_errors = server_errors
+      end
+
+      def pending_requests
+        @counter.value
+      end
+
+      def pending_requests?
+        @counter.positive?
+      end
+
+      def clear_error
+        @error = nil
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, [@app.object_id.to_s]]
+        else
+          @counter.increment(env["REQUEST_URI"])
+          begin
+            @extended_app.call(env)
+          rescue *@server_errors => e
+            @error ||= e
+            raise e
+          ensure
+            @counter.decrement(env["REQUEST_URI"])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cypress-rails/server/puma.rb

@@ -0,0 +1,30 @@
+module CypressRails
+  class Server
+    module Puma
+      def self.create(app, port, host)
+        require "rack/handler/puma"
+
+        # If we just run the Puma Rack handler it installs signal handlers which prevent us from being able to interrupt tests.
+        # Therefore construct and run the Server instance ourselves.
+        # Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
+        default_options = {Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false}
+        options = default_options # .merge(options)
+
+        conf = Rack::Handler::Puma.config(app, options)
+        events = ::Puma::Events.stdio
+
+        puma_ver = Gem::Version.new(::Puma::Const::PUMA_VERSION)
+        require_relative "patches/puma_ssl" if (Gem::Version.new("4.0.0")...Gem::Version.new("4.1.0")).cover? puma_ver
+
+        events.log "Starting Puma..."
+        events.log "* Version #{::Puma::Const::PUMA_VERSION} , codename: #{::Puma::Const::CODE_NAME}"
+        events.log "* Min threads: #{conf.options[:min_threads]}, max threads: #{conf.options[:max_threads]}"
+
+        ::Puma::Server.new(conf.app, events, conf.options).tap do |s|
+          s.binder.parse conf.options[:binds], s.events
+          s.min_threads, s.max_threads = conf.options[:min_threads], conf.options[:max_threads]
+        end.run.join
+      end
+    end
+  end
+end

data/lib/cypress-rails/server/timer.rb

@@ -0,0 +1,24 @@
+module CypressRails
+  class Server
+    class Timer
+      def initialize(expire_in)
+        @start = current
+        @expire_in = expire_in
+      end
+
+      def expired?
+        current - @start >= @expire_in
+      end
+
+      def stalled?
+        @start == current
+      end
+
+      private
+
+      def current
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/cypress-rails/server.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "rack"
+require_relative "server/middleware"
+require_relative "server/checker"
+require_relative "server/timer"
+require_relative "server/puma"
+
+module CypressRails
+  class Server
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :port, :host
+
+    def initialize(app,
+      port:,
+      host: "127.0.0.1",
+      reportable_errors: [Exception],
+      extra_middleware: [])
+      @app = app
+      @extra_middleware = extra_middleware
+      @server_thread = nil # suppress warnings
+      @host = host
+      @reportable_errors = reportable_errors
+      @port = port
+      @port ||= Server.ports[port_key]
+      @port ||= find_available_port(host)
+      @checker = Checker.new(@host, @port)
+    end
+
+    def reset_error!
+      middleware.clear_error
+    end
+
+    def error
+      middleware.error
+    end
+
+    def using_ssl?
+      @checker.ssl?
+    end
+
+    def responsive?
+      return false if @server_thread&.join(0)
+
+      res = @checker.request { |http| http.get("/__identify__") }
+
+      return res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
+    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
+      false
+    end
+
+    def wait_for_pending_requests
+      timer = Timer.new(60)
+      while pending_requests?
+        raise "Requests did not finish in 60 seconds: #{middleware.pending_requests}" if timer.expired?
+
+        sleep 0.01
+      end
+    end
+
+    def boot
+      unless responsive?
+        Server.ports[port_key] = port
+
+        @server_thread = Thread.new {
+          Puma.create(middleware, port, host)
+        }
+
+        timer = Timer.new(60)
+        until responsive?
+          raise "Rack application timed out during boot" if timer.expired?
+
+          @server_thread.join(0.1)
+        end
+      end
+
+      self
+    end
+
+    def base_url
+      "http#{"s" if using_ssl?}://#{host}:#{port}"
+    end
+
+    private
+
+    def middleware
+      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)
+    end
+
+    def port_key
+      app.object_id # as opposed to middleware.object_id if multiple instances
+    end
+
+    def pending_requests?
+      middleware.pending_requests?
+    end
+
+    def find_available_port(host)
+      server = TCPServer.new(host, 0)
+      port = server.addr[1]
+      server.close
+
+      # Workaround issue where some platforms (mac, ???) when passed a host
+      # of '0.0.0.0' will return a port that is only available on one of the
+      # ip addresses that resolves to, but the next binding to that port requires
+      # that port to be available on all ips
+      server = TCPServer.new(host, port)
+      port
+    rescue Errno::EADDRINUSE
+      retry
+    ensure
+      server&.close
+    end
+  end
+end

data/lib/cypress-rails/starts_rails_server.rb

@@ -1,32 +1,14 @@
-require_relative "configures_test_server"
 require_relative "tracks_resets"
+require_relative "server"
 
 module CypressRails
   class StartsRailsServer
-    def initialize
-      @configures_test_server = ConfiguresTestServer.new
-    end
-
     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: {}
-      }).use
+      app = create_rack_app
+      Server.new(app, port: port).tap do |server|
+        server.boot
+      end
     end
 
     def configure_rails_to_run_our_state_reset_on_every_request!(transactional_server)
@@ -35,7 +17,7 @@ module CypressRails
       end
     end
 
-    def create_capybara_rack_app
+    def create_rack_app
       Rack::Builder.new do
         map "/cypress_rails_reset_state" do
           run lambda { |env|
@@ -48,10 +30,5 @@ module CypressRails
         end
       end
     end
-
-    def start_system_testing_server!
-      require "action_dispatch/system_testing/server"
-      ActionDispatch::SystemTesting::Server.new.run
-    end
   end
 end

data/lib/cypress-rails/version.rb

@@ -1,3 +1,3 @@
 module CypressRails
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cypress-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -25,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.0
 - !ruby/object:Gem::Dependency
-  name: capybara
+  name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: selenium-webdriver
-  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'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,34 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.0
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  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: capybara
-  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: 
 email:
 - searls@gmail.com
@@ -160,7 +118,6 @@ files:
 - 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
@@ -172,6 +129,11 @@ files:
 - lib/cypress-rails/rake.rb
 - lib/cypress-rails/resets_state.rb
 - lib/cypress-rails/run.rb
+- lib/cypress-rails/server.rb
+- lib/cypress-rails/server/checker.rb
+- lib/cypress-rails/server/middleware.rb
+- lib/cypress-rails/server/puma.rb
+- lib/cypress-rails/server/timer.rb
 - lib/cypress-rails/starts_rails_server.rb
 - lib/cypress-rails/tracks_resets.rb
 - lib/cypress-rails/version.rb

data/lib/cypress-rails/configures_test_server.rb

@@ -1,23 +0,0 @@
-module CypressRails
-  class ConfiguresTestServer
-    def call(port:)
-      require "capybara"
-      require "selenium-webdriver"
-      Capybara.server_port = port || find_available_port
-      Capybara.always_include_port = true
-      Capybara.server = :puma, {Silent: false}
-      Capybara.current_session
-
-      true
-    end
-
-    private
-
-    def find_available_port
-      server = TCPServer.new(Capybara.server_host, 0)
-      server.addr[1]
-    ensure
-      server&.close
-    end
-  end
-end