e2e 0.6.1 → 0.7.1

data/lib/e2e/minitest.rb

@@ -44,4 +44,5 @@ end
 
 Minitest.after_run do
   E2E.session.quit if E2E.instance_variable_get(:@session)
+  E2E.stop_server!
 end

data/lib/e2e/rails.rb

@@ -2,25 +2,86 @@
 
 module E2E
   module Rails
-    # This module allows the test thread and the server thread to share the same
-    # ActiveRecord connection. This is crucial for running tests in transactions
-    # which is much faster than using truncation.
+    class << self
+      attr_accessor :shared_connection
+      attr_reader :shared_connection_enabled
+
+      def shared_connection_enabled?
+        @shared_connection_enabled
+      end
+
+      def enable_shared_connection!
+        return unless defined?(ActiveRecord::Base)
+        return if @shared_connection_enabled
+
+        ActiveRecord::Base.singleton_class.prepend(ActiveRecordSharedConnection)
+        @shared_connection_enabled = true
+        # #connection (unlike #lease_connection/#with_connection, added in
+        # Rails 7.2) exists on every supported Rails version, so it's the only
+        # safe way to bootstrap the very first shared connection.
+        self.shared_connection = ActiveRecord::Base.connection
+      end
+
+      # Yields while the example thread is not holding a sticky AR lease.
+      # Needed when the pool has a single connection and the server thread
+      # must check it out during a blocking Playwright navigation/action.
+      def with_released_connection
+        return yield unless shared_connection_enabled?
+        return yield unless defined?(ActiveRecord::Base)
+
+        pool = ActiveRecord::Base.connection_pool
+        pool.release_connection if pool.active_connection?
+        yield
+      ensure
+        if shared_connection_enabled? && defined?(ActiveRecord::Base)
+          # Keep the shared handle pointing at a live leased connection for
+          # post-navigation assertions in the example thread.
+          self.shared_connection = ActiveRecord::Base.connection
+        end
+      end
+    end
+
+    # Shares one ActiveRecord connection between the example thread and the
+    # in-process server thread so transactional fixtures remain visible.
+    #
+    # Rails 7.2+/8 prefer +lease_connection+ / +with_connection+ over
+    # +connection+. Overriding only +connection+ (pre-0.7.1) left those
+    # APIs on the pool's thread-local lease and caused intermittent
+    # deadlocks: the example thread blocked in Playwright while holding
+    # the only connection, and the server sat idle in an open transaction.
     module ActiveRecordSharedConnection
       def connection
-        @shared_connection || retrieve_connection
+        E2E::Rails.shared_connection || super
+      end
+
+      # lease_connection/with_connection don't exist before Rails 7.2, so
+      # `super` isn't always callable -- fall back to the always-available
+      # #connection instead of blowing up with a NoMethodError.
+      def lease_connection
+        E2E::Rails.shared_connection || (defined?(super) ? super : connection)
+      end
+
+      def with_connection(prevent_permanent_checkout: false)
+        if (conn = E2E::Rails.shared_connection)
+          yield conn
+        elsif defined?(super)
+          super
+        else
+          yield connection
+        end
       end
 
       def shared_connection=(connection)
-        @shared_connection = connection
+        E2E::Rails.shared_connection = connection
+      end
+
+      def shared_connection
+        E2E::Rails.shared_connection
       end
     end
   end
 end
 
-# We only want to apply this when Rails is present and we want to enable it.
 def E2E.enable_shared_connection!
-  return unless defined?(ActiveRecord::Base)
-
-  ActiveRecord::Base.extend(E2E::Rails::ActiveRecordSharedConnection)
-  ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
+  E2E::Rails.enable_shared_connection!
 end

data/lib/e2e/rspec.rb

@@ -33,5 +33,6 @@ RSpec.configure do |config|
 
   config.after(:suite) do
     E2E.session.quit if E2E.instance_variable_get(:@session)
+    E2E.stop_server!
   end
 end

data/lib/e2e/server.rb

@@ -17,24 +17,44 @@ module E2E
 
     def start
       @thread = Thread.new do
-        # Use Rackup handler for Rack 3 compatibility
-        Rackup::Handler::WEBrick.run(
+        webrick_handler.run(
           @app,
           Host: @host,
           Port: @port,
           AccessLog: [],
           Logger: WEBrick::Log.new(nil, 0) # Silence logs
-        )
+        ) do |server|
+          @webrick = server
+        end
       end
       wait_for_boot
     end
 
+    def stop
+      @webrick&.shutdown
+      @thread&.join(5)
+      @thread = nil
+      @webrick = nil
+    end
+
     def base_url
       "http://#{@host}:#{@port}"
     end
 
     private
 
+    # rackup 2.x (the version paired with Rack 3) exposes Rackup::Handler.
+    # Older stacks that pin Rack 2.x (e.g. Rails 7.0/7.1 via this gem's own
+    # Appraisal matrix) resolve `rackup` down to its 1.x line, which has no
+    # Handler module at all -- there, the handler lives on Rack::Handler.
+    def webrick_handler
+      if defined?(Rackup::Handler)
+        Rackup::Handler.get(:webrick)
+      else
+        Rack::Handler.get(:webrick)
+      end
+    end
+
     def find_available_port
       server = TCPServer.new("127.0.0.1", 0)
       port = server.addr[1]
@@ -45,6 +65,11 @@ module E2E
     def wait_for_boot
       start_time = Time.now
       loop do
+        if @thread && !@thread.alive?
+          @thread.join # re-raises whatever exception killed the server thread
+          raise "Server thread exited before boot completed"
+        end
+
         socket = TCPSocket.new("127.0.0.1", @port)
         socket.close
         break

data/lib/e2e/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module E2E
-  VERSION = "0.6.1"
+  VERSION = "0.7.1"
 end

data/lib/e2e.rb

@@ -37,6 +37,11 @@ module E2E
         srv
       end
     end
+
+    def stop_server!
+      @server&.stop
+      @server = nil
+    end
   end
 
   # Retry a block until it returns truthy or timeout is reached
@@ -61,7 +66,8 @@ module E2E
       alert: "[role='alert'], [data-flash-type='alert'], [data-flash='alert'], .flash.alert, .flash-error, .alert"
     }.freeze
 
-    attr_accessor :driver, :headless, :app, :browser_type, :wait_timeout, :flash_selectors
+    attr_accessor :driver, :headless, :app, :browser_type, :wait_timeout, :flash_selectors,
+      :navigation_timeout, :navigation_wait_until
 
     def initialize
       @driver = :playwright
@@ -69,6 +75,10 @@ module E2E
       @headless = ENV.fetch("HEADLESS", "true") == "true"
       @app = nil
       @wait_timeout = 5
+      # Full "load" waits for every subframe (YouTube/Vimeo/etc.) and can hang
+      # navigations indefinitely when those resources never settle.
+      @navigation_wait_until = "domcontentloaded"
+      @navigation_timeout = 30
       @flash_selectors = DEFAULT_FLASH_SELECTORS.dup
     end
   end

data/mise.toml

@@ -0,0 +1,14 @@
+[tools]
+ruby = "4.0.6"
+
+[tasks.test]
+description = "Run RSpec and Minitest suites"
+run = "bundle exec rake spec test"
+
+[tasks.lint]
+description = "Run RuboCop"
+run = "bundle exec rubocop"
+
+[tasks.release]
+description = "Build and publish the gem (rake release)"
+run = "bundle exec rake release"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: e2e
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - Alexey Poimtsev
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +191,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: standard
   requirement: !ruby/object:Gem::Requirement
@@ -199,6 +227,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - Appraisals
 - CHANGELOG.md
 - LICENSE.txt
@@ -233,6 +262,7 @@ files:
 - lib/generators/e2e/templates/minitest_test.rb.erb
 - lib/generators/e2e/templates/rspec_test.rb.erb
 - lib/generators/e2e/test_generator.rb
+- mise.toml
 - sig/e2e.rbs
 homepage: https://github.com/alec-c4/e2e
 licenses:
@@ -248,14 +278,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.18
 specification_version: 4
 summary: Unified E2E testing framework for Ruby.
 test_files: []